tapimo 0.10.2 → 0.12.0

package/src/apps/management/routes/invite-links.test.ts

@@ -47,7 +47,7 @@ async function createLink(
   { client }: ReturnType<typeof createApp>,
   orgId: string,
   cookie: string,
-  body: z.input<typeof InviteLinks.schema.CreateBody> = { name: 'Community' },
+  body: z.input<typeof InviteLinks.schema.CreateInviteLinkRequest> = { name: 'Community' },
 ) {
   const response = await client.v1.orgs[':orgId{org_[A-Za-z0-9_-]+}']['invite-links'].$post(
     { json: body, param: { orgId } },
@@ -62,6 +62,268 @@ const unavailable = {
   error: { code: 'invite_link_not_found', message: 'Invite link not found' },
 }
 
+test('publishes generator-ready OpenAPI contracts', async () => {
+  const { app } = createApp()
+  const spec = await (await app.request('/openapi.json')).json()
+  const collection = spec.paths['/v1/orgs/{orgId}/invite-links']
+  const detail = spec.paths['/v1/orgs/{orgId}/invite-links/{inviteLinkId}']
+  const redemptions = spec.paths['/v1/orgs/{orgId}/invite-links/{inviteLinkId}/redemptions'].get
+  const resolve = spec.paths['/v1/invite-links/resolve'].post
+  const accept = spec.paths['/v1/invite-links/accept'].post
+
+  expect({
+    components: [
+      'AcceptInviteLinkResponse',
+      'CreateInviteLinkRequest',
+      'DeleteInviteLinkResponse',
+      'InviteLink',
+      'InviteLinkList',
+      'InviteLinkRedemption',
+      'InviteLinkRedemptionList',
+      'InviteLinkTokenRequest',
+      'ResolveInviteLinkResponse',
+      'UpdateInviteLinkRequest',
+    ].filter((name) => spec.components.schemas[name]),
+    create: {
+      errors: {
+        400: collection.post.responses[400].content['application/json'].schema,
+        403: collection.post.responses[403].content['application/json'].schema,
+        404: collection.post.responses[404].content['application/json'].schema,
+      },
+      operationId: collection.post.operationId,
+      request: collection.post.requestBody.content['application/json'].schema,
+      response: collection.post.responses[200].content['application/json'].schema,
+    },
+    formats: {
+      createdAt: spec.components.schemas.InviteLink.properties.createdAt.format,
+      expiresAt: spec.components.schemas.InviteLink.properties.expiresAt.anyOf[0].format,
+      lastUsedAt: spec.components.schemas.InviteLink.properties.lastUsedAt.anyOf[0].format,
+      redemptionCreatedAt: spec.components.schemas.InviteLinkRedemption.properties.createdAt.format,
+      redemptionEmail: spec.components.schemas.InviteLinkRedemption.properties.email.format,
+      updatedAt: spec.components.schemas.InviteLink.properties.updatedAt.format,
+    },
+    list: {
+      errors: {
+        400: collection.get.responses[400].content['application/json'].schema,
+        403: collection.get.responses[403].content['application/json'].schema,
+        404: collection.get.responses[404].content['application/json'].schema,
+      },
+      operationId: collection.get.operationId,
+      response: collection.get.responses[200].content['application/json'].schema,
+    },
+    recipientActions: {
+      accept: {
+        errors: {
+          400: accept.responses[400].content['application/json'].schema,
+          403: accept.responses[403].content['application/json'].schema,
+          404: accept.responses[404].content['application/json'].schema,
+        },
+        operationId: accept.operationId,
+        request: accept.requestBody.content['application/json'].schema,
+        response: accept.responses[200].content['application/json'].schema,
+      },
+      resolve: {
+        errors: {
+          400: resolve.responses[400].content['application/json'].schema,
+          403: resolve.responses[403].content['application/json'].schema,
+          404: resolve.responses[404].content['application/json'].schema,
+        },
+        operationId: resolve.operationId,
+        request: resolve.requestBody.content['application/json'].schema,
+        response: resolve.responses[200].content['application/json'].schema,
+      },
+    },
+    redemptions: {
+      errors: {
+        400: redemptions.responses[400].content['application/json'].schema,
+        403: redemptions.responses[403].content['application/json'].schema,
+        404: redemptions.responses[404].content['application/json'].schema,
+      },
+      operationId: redemptions.operationId,
+      response: redemptions.responses[200].content['application/json'].schema,
+    },
+    updateAndDelete: {
+      delete: {
+        errors: {
+          400: detail.delete.responses[400].content['application/json'].schema,
+          403: detail.delete.responses[403].content['application/json'].schema,
+          404: detail.delete.responses[404].content['application/json'].schema,
+        },
+        operationId: detail.delete.operationId,
+        response: detail.delete.responses[200].content['application/json'].schema,
+      },
+      update: {
+        errors: {
+          400: detail.patch.responses[400].content['application/json'].schema,
+          403: detail.patch.responses[403].content['application/json'].schema,
+          404: detail.patch.responses[404].content['application/json'].schema,
+        },
+        operationId: detail.patch.operationId,
+        request: detail.patch.requestBody.content['application/json'].schema,
+        response: detail.patch.responses[200].content['application/json'].schema,
+      },
+    },
+  }).toMatchInlineSnapshot(`
+    {
+      "components": [
+        "AcceptInviteLinkResponse",
+        "CreateInviteLinkRequest",
+        "DeleteInviteLinkResponse",
+        "InviteLink",
+        "InviteLinkList",
+        "InviteLinkRedemption",
+        "InviteLinkRedemptionList",
+        "InviteLinkTokenRequest",
+        "ResolveInviteLinkResponse",
+        "UpdateInviteLinkRequest",
+      ],
+      "create": {
+        "errors": {
+          "400": {
+            "$ref": "#/components/schemas/ApiKeyMalformedOrBodyInvalidOrParamInvalidError",
+          },
+          "403": {
+            "$ref": "#/components/schemas/ForbiddenError",
+          },
+          "404": {
+            "$ref": "#/components/schemas/OrganizationNotFoundError",
+          },
+        },
+        "operationId": "createInviteLink",
+        "request": {
+          "$ref": "#/components/schemas/CreateInviteLinkRequest",
+        },
+        "response": {
+          "$ref": "#/components/schemas/InviteLink",
+        },
+      },
+      "formats": {
+        "createdAt": "date-time",
+        "expiresAt": "date-time",
+        "lastUsedAt": "date-time",
+        "redemptionCreatedAt": "date-time",
+        "redemptionEmail": "email",
+        "updatedAt": "date-time",
+      },
+      "list": {
+        "errors": {
+          "400": {
+            "$ref": "#/components/schemas/ApiKeyMalformedOrParamInvalidError",
+          },
+          "403": {
+            "$ref": "#/components/schemas/ForbiddenError",
+          },
+          "404": {
+            "$ref": "#/components/schemas/OrganizationNotFoundError",
+          },
+        },
+        "operationId": "listInviteLinks",
+        "response": {
+          "$ref": "#/components/schemas/InviteLinkList",
+        },
+      },
+      "recipientActions": {
+        "accept": {
+          "errors": {
+            "400": {
+              "$ref": "#/components/schemas/ApiKeyMalformedOrBodyInvalidError",
+            },
+            "403": {
+              "$ref": "#/components/schemas/ApiKeyForbiddenOrApiKeyIpForbiddenOrForbiddenOrInviteLinkEmailForbiddenError",
+            },
+            "404": {
+              "$ref": "#/components/schemas/InviteLinkNotFoundError",
+            },
+          },
+          "operationId": "acceptInviteLink",
+          "request": {
+            "$ref": "#/components/schemas/InviteLinkTokenRequest",
+          },
+          "response": {
+            "$ref": "#/components/schemas/AcceptInviteLinkResponse",
+          },
+        },
+        "resolve": {
+          "errors": {
+            "400": {
+              "$ref": "#/components/schemas/ApiKeyMalformedOrBodyInvalidError",
+            },
+            "403": {
+              "$ref": "#/components/schemas/ForbiddenError",
+            },
+            "404": {
+              "$ref": "#/components/schemas/InviteLinkNotFoundError",
+            },
+          },
+          "operationId": "resolveInviteLink",
+          "request": {
+            "$ref": "#/components/schemas/InviteLinkTokenRequest",
+          },
+          "response": {
+            "$ref": "#/components/schemas/ResolveInviteLinkResponse",
+          },
+        },
+      },
+      "redemptions": {
+        "errors": {
+          "400": {
+            "$ref": "#/components/schemas/ApiKeyMalformedOrParamInvalidError",
+          },
+          "403": {
+            "$ref": "#/components/schemas/ForbiddenError",
+          },
+          "404": {
+            "$ref": "#/components/schemas/InviteLinkNotFoundOrOrganizationNotFoundError",
+          },
+        },
+        "operationId": "listInviteLinkRedemptions",
+        "response": {
+          "$ref": "#/components/schemas/InviteLinkRedemptionList",
+        },
+      },
+      "updateAndDelete": {
+        "delete": {
+          "errors": {
+            "400": {
+              "$ref": "#/components/schemas/ApiKeyMalformedOrParamInvalidError",
+            },
+            "403": {
+              "$ref": "#/components/schemas/ForbiddenError",
+            },
+            "404": {
+              "$ref": "#/components/schemas/InviteLinkNotFoundOrOrganizationNotFoundError",
+            },
+          },
+          "operationId": "deleteInviteLink",
+          "response": {
+            "$ref": "#/components/schemas/DeleteInviteLinkResponse",
+          },
+        },
+        "update": {
+          "errors": {
+            "400": {
+              "$ref": "#/components/schemas/ApiKeyMalformedOrBodyInvalidOrParamInvalidError",
+            },
+            "403": {
+              "$ref": "#/components/schemas/ForbiddenError",
+            },
+            "404": {
+              "$ref": "#/components/schemas/InviteLinkNotFoundOrOrganizationNotFoundError",
+            },
+          },
+          "operationId": "updateInviteLink",
+          "request": {
+            "$ref": "#/components/schemas/UpdateInviteLinkRequest",
+          },
+          "response": {
+            "$ref": "#/components/schemas/InviteLink",
+          },
+        },
+      },
+    }
+  `)
+})
+
 describe('inviteLinks', () => {
   test('admins manage org-scoped links that outlive their creator', async () => {
     const db = TestApp.database()