feat: application endpoints, nesting, open API (#243)

* create `/application` CRUD endpoints + openAPI specs
* nest all mgmt routes under `/applications/{application_id}`
* regenerate types + SDK

Author: Ryan Liu

apps/api/routes/crm/index.ts

@@ -1,8 +1,10 @@
+import { connectionHeaderMiddleware } from '@/middleware/connection';
 import { Router } from 'express';
 import v1 from './v1';
 
 export default function init(app: Router): void {
   const crmRouter = Router();
+  crmRouter.use(connectionHeaderMiddleware);
 
   v1(crmRouter);
 

apps/api/routes/index.ts

@@ -1,4 +1,3 @@
-import { connectionHeaderMiddleware } from '@/middleware/connection';
 import { Router } from 'express';
 import crm from './crm';
 import mgmt from './mgmt';
@@ -7,10 +6,5 @@ import oauth from './oauth';
 export default function initRoutes(app: Router): void {
   oauth(app);
   mgmt(app);
-
-  const crmRouter = Router();
-  crmRouter.use(connectionHeaderMiddleware);
-  crm(crmRouter);
-
-  app.use(crmRouter);
+  crm(app);
 }

apps/api/routes/mgmt/v1/customer/connection/index.ts renamed to apps/api/routes/mgmt/v1/application/customer/connection/index.ts

@@ -67,7 +67,10 @@ export default function init(app: Router): void {
     }
   );
 
-  connection(customerRouter);
-
   app.use('/customers', customerRouter);
+
+  const perCustomerRouter = Router({ mergeParams: true });
+
+  connection(perCustomerRouter);
+  customerRouter.use('/:customer_id', perCustomerRouter);
 }

apps/api/routes/mgmt/v1/customer/index.ts renamed to apps/api/routes/mgmt/v1/application/customer/index.ts

@@ -0,0 +1,98 @@
+import { getDependencyContainer } from '@/dependency_container';
+import { camelcaseKeys } from '@/lib/camelcase';
+import { snakecaseKeys } from '@/lib/snakecase';
+import {
+  CreateApplicationPathParams,
+  CreateApplicationRequest,
+  CreateApplicationResponse,
+  DeleteApplicationPathParams,
+  DeleteApplicationRequest,
+  DeleteApplicationResponse,
+  GetApplicationPathParams,
+  GetApplicationRequest,
+  GetApplicationResponse,
+  GetApplicationsPathParams,
+  GetApplicationsRequest,
+  GetApplicationsResponse,
+  UpdateApplicationPathParams,
+  UpdateApplicationRequest,
+  UpdateApplicationResponse,
+} from '@supaglue/schemas/mgmt';
+import { Request, Response, Router } from 'express';
+import customer from './customer';
+import integration from './integration';
+
+const { applicationService } = getDependencyContainer();
+
+export default function init(app: Router): void {
+  const applicationRouter = Router();
+
+  applicationRouter.get(
+    '/',
+    async (
+      req: Request<GetApplicationsPathParams, GetApplicationsResponse, GetApplicationsRequest>,
+      res: Response<GetApplicationsResponse>
+    ) => {
+      const applications = await applicationService.list();
+      // TODO: Figure out why typing doesn't work here
+      return res.status(200).send(applications.map(snakecaseKeys) as GetApplicationsResponse);
+    }
+  );
+
+  applicationRouter.post(
+    '/',
+    async (
+      req: Request<CreateApplicationPathParams, CreateApplicationResponse, CreateApplicationRequest>,
+      res: Response<CreateApplicationResponse>
+    ) => {
+      const application = await applicationService.create(camelcaseKeys(req.body));
+      // TODO: Figure out why typing doesn't work here
+      return res.status(201).send(snakecaseKeys(application) as CreateApplicationResponse);
+    }
+  );
+
+  applicationRouter.get(
+    '/:application_id',
+    async (
+      req: Request<GetApplicationPathParams, GetApplicationResponse, GetApplicationRequest>,
+      res: Response<GetApplicationResponse>
+    ) => {
+      const application = await applicationService.getById(req.params.application_id);
+      // TODO: Figure out why typing doesn't work here
+      return res.status(200).send(snakecaseKeys(application) as GetApplicationResponse);
+    }
+  );
+
+  applicationRouter.put(
+    '/:application_id',
+    async (
+      req: Request<UpdateApplicationPathParams, UpdateApplicationResponse, UpdateApplicationRequest>,
+      res: Response<UpdateApplicationResponse>
+    ) => {
+      const application = await applicationService.update(req.params.application_id, camelcaseKeys(req.body));
+      // TODO: Figure out why typing doesn't work here
+      return res.status(200).send(snakecaseKeys(application) as UpdateApplicationResponse);
+    }
+  );
+
+  applicationRouter.delete(
+    '/:application_id',
+    async (
+      req: Request<DeleteApplicationPathParams, DeleteApplicationResponse, DeleteApplicationRequest>,
+      res: Response<DeleteApplicationResponse>
+    ) => {
+      const application = await applicationService.delete(req.params.application_id);
+      // TODO: Figure out why typing doesn't work here
+      return res.status(200).send(snakecaseKeys(application) as DeleteApplicationResponse);
+    }
+  );
+
+  app.use('/applications', applicationRouter);
+
+  const perApplicationRouter = Router({ mergeParams: true });
+
+  customer(perApplicationRouter);
+  integration(perApplicationRouter);
+
+  applicationRouter.use(`/:application_id`, perApplicationRouter);
+}

apps/api/routes/mgmt/v1/application/index.ts

@@ -1,15 +1,13 @@
 import { openapiMiddleware } from '@/middleware/openapi';
 import { Router } from 'express';
-import customer from './customer';
-import integration from './integration';
+import application from './application';
 
 export default function init(app: Router): void {
   const v1Router = Router();
 
   v1Router.use(openapiMiddleware('mgmt'));
 
-  customer(v1Router);
-  integration(v1Router);
+  application(v1Router);
 
   app.use('/v1', v1Router);
 }

apps/api/routes/mgmt/v1/integration/index.ts renamed to apps/api/routes/mgmt/v1/application/integration/index.ts

@@ -0,0 +1,10 @@
+type: object
+properties:
+  name:
+    type: string
+    example: my-app
+  config:
+    $ref: ./objects/application_config.yaml
+required:
+  - name
+  - config

apps/api/routes/mgmt/v1/index.ts

@@ -0,0 +1,14 @@
+type: object
+properties:
+  id:
+    type: string
+    example: e888cedf-e9d0-42c5-9485-2d72984faef2
+  name:
+    type: string
+    example: my-app
+  config:
+    $ref: ./application_config.yaml
+required:
+  - id
+  - name
+  - config

openapi/mgmt/components/schemas/create_update_application.yaml

@@ -0,0 +1,36 @@
+type: object
+properties:
+  webhook:
+    type: object
+    nullable: true
+    properties:
+      url:
+        type: string
+      request_type:
+        type: string
+        enum:
+          - GET
+          - POST
+          - PUT
+          - DELETE
+          - PATCH
+      notify_on_sync_success:
+        type: boolean
+      notify_on_sync_error:
+        type: boolean
+      notify_on_connection_success:
+        type: boolean
+      notify_on_connection_error:
+        type: boolean
+      headers:
+        type: object
+        additionalProperties: true
+    required:
+      - url
+      - request_type
+      - notify_on_sync_success
+      - notify_on_sync_error
+      - notify_on_connection_success
+      - notify_on_connection_error
+required:
+  - webhook

openapi/mgmt/components/schemas/objects/application.yaml

@@ -30,7 +30,7 @@ required:
 #   auth_type: oauth2
 #   provider_name: hubspot
 #   config:
-#   - remote_provider_app_id: my_app_id
+#   - provider_app_id: my_app_id
 #     oauth:
 #     - oauth_scopes:
 #       - crm.objects.contacts.read

openapi/mgmt/components/schemas/objects/application_config.yaml

@@ -1,6 +1,6 @@
 type: object
 properties:
-  remote_provider_app_id:
+  provider_app_id:
     type: string
     example: my_app_id
   oauth:
@@ -35,11 +35,11 @@ properties:
     required:
       - period_ms
 required:
-  - remote_provider_app_id
+  - provider_app_id
   - oauth
   - sync
 example:
-  - remote_provider_app_id: my_app_id
+  - provider_app_id: my_app_id
   - oauth:
     - oauth_scopes:
       - crm.objects.contacts.read