@appsemble/utils 0.20.10 → 0.20.13

package/api/paths/oauth2Login.ts

@@ -0,0 +1,120 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const paths: OpenAPIV3.PathsObject = {
+  '/api/oauth2/connect/register': {
+    post: {
+      operationId: 'registerOAuth2Connection',
+      description: 'asd',
+      requestBody: {
+        required: true,
+        content: {
+          'application/json': {
+            schema: {
+              type: 'object',
+              required: ['authorizationUrl', 'code'],
+              properties: {
+                authorizationUrl: {
+                  type: 'string',
+                },
+                code: {
+                  type: 'string',
+                },
+              },
+            },
+          },
+        },
+      },
+      responses: {
+        200: {
+          description: '',
+        },
+      },
+    },
+  },
+  '/api/oauth2/connect/pending': {
+    post: {
+      description: 'Create an account using an OAuth2 authorization.',
+      tags: ['oauth2'],
+      operationId: 'connectPendingOAuth2Profile',
+      requestBody: {
+        description: 'The OAuth2 client credentials',
+        required: true,
+        content: {
+          'application/json': {
+            schema: {
+              type: 'object',
+              additionalProperties: false,
+              required: ['code', 'authorizationUrl', 'timezone'],
+              properties: {
+                code: {
+                  type: 'string',
+                },
+                authorizationUrl: {
+                  type: 'string',
+                },
+                timezone: {
+                  type: 'string',
+                },
+              },
+            },
+          },
+        },
+      },
+      responses: {
+        200: {
+          description: 'An access token response.',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+              },
+            },
+          },
+        },
+      },
+      security: [{ studio: [] }, {}],
+    },
+  },
+  '/api/oauth2/connected': {
+    get: {
+      description: 'Get a list of the user’s connected OAuth2 accounts.',
+      tags: ['oauth2'],
+      operationId: 'getConnectedAccounts',
+      responses: {
+        200: {
+          description: 'An access token response.',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'array',
+                items: {
+                  type: 'object',
+                  properties: {
+                    authorizationUrl: {
+                      type: 'string',
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+      security: [{ studio: [] }],
+    },
+    delete: {
+      description: 'Unlink a linked account from the logged in user.',
+      tags: ['oauth2'],
+      operationId: 'unlinkConnectedAccount',
+      parameters: [
+        { in: 'query', name: 'authorizationUrl', required: true, schema: { type: 'string' } },
+      ],
+      responses: {
+        204: {
+          description: 'The account was unlinked successfully.',
+        },
+      },
+      security: [{ studio: [] }],
+    },
+  },
+};

package/api/paths/oauth2Provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oauth2Provider.js","sourceRoot":"","sources":["oauth2Provider.ts"],"names":[],"mappings":";;;AAEa,QAAA,KAAK,GAA0B;IAC1C,uBAAuB,EAAE;QACvB,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;YACxB,WAAW,EAAE;;;;OAIZ;YACD,WAAW,EAAE,aAAa;YAC1B,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/C,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,oCAAoC;oBACjD,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,GAAG,EAAE;wCACH,IAAI,EAAE,QAAQ;wCACd,WAAW,EAAE,qCAAqC;qCACnD;oCACD,IAAI,EAAE;wCACJ,IAAI,EAAE,QAAQ;wCACd,WAAW,EAAE,+BAA+B;qCAC7C;oCACD,OAAO,EAAE;wCACP,IAAI,EAAE,QAAQ;wCACd,MAAM,EAAE,KAAK;wCACb,WAAW,EAAE,+CAA+C;qCAC7D;oCACD,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,MAAM,EAAE,OAAO;wCACf,WAAW,EAAE,yCAAyC;qCACvD;oCACD,cAAc,EAAE;wCACd,IAAI,EAAE,SAAS;wCACf,WAAW,EACT,qEAAqE;qCACxE;iCACF;6BACF;yBACF;qBACF;iBACF;aACF;SACF;KACF;IACD,4BAA4B,EAAE;QAC5B,IAAI,EAAE;YACJ,WAAW,EAAE,2EAA2E;YACxF,IAAI,EAAE,CAAC,QAAQ,CAAC;YAChB,WAAW,EAAE,qBAAqB;YAClC,WAAW,EAAE,EAAE,IAAI,EAAE,0CAA0C,EAAE;YACjE,SAAS,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,gDAAgD,EAAE,EAAE;YAC9E,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;SAC3B;KACF;IACD,2BAA2B,EAAE;QAC3B,IAAI,EAAE;YACJ,WAAW,EAAE,8BAA8B;YAC3C,IAAI,EAAE,CAAC,QAAQ,CAAC;YAChB,WAAW,EAAE,oBAAoB;YACjC,WAAW,EAAE,EAAE,IAAI,EAAE,0CAA0C,EAAE;YACjE,SAAS,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,gDAAgD,EAAE,EAAE;YAC9E,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;SAC3B;KACF;CACF,CAAC"}

package/api/paths/oauth2Provider.ts

@@ -0,0 +1,73 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const paths: OpenAPIV3.PathsObject = {
+  '/api/connect/userinfo': {
+    get: {
+      tags: ['openid', 'user'],
+      description: `
+        Get the user information formatted as OpenID user info.
+
+        See https://connect2id.com/products/server/docs/api/userinfo
+      `,
+      operationId: 'getUserInfo',
+      security: [{ studio: [] }, { app: ['openid'] }],
+      responses: {
+        200: {
+          description: 'OpenID compatible user information',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  sub: {
+                    type: 'string',
+                    description: 'The subject (end-user) identifier. ',
+                  },
+                  name: {
+                    type: 'string',
+                    description: 'The full name of the end-user',
+                  },
+                  picture: {
+                    type: 'string',
+                    format: 'url',
+                    description: 'The URL of the profile page for the end-user.',
+                  },
+                  email: {
+                    type: 'string',
+                    format: 'email',
+                    description: 'The end-user’s preferred email address.',
+                  },
+                  email_verified: {
+                    type: 'boolean',
+                    description:
+                      'True if the end-user’s email address has been verified, else false.',
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+  '/api/oauth2/consent/verify': {
+    post: {
+      description: 'Verify if the user has previously agreed to the requested OAuth2 consent.',
+      tags: ['oauth2'],
+      operationId: 'verifyOAuth2Consent',
+      requestBody: { $ref: '#/components/requestBodies/oauth2Consent' },
+      responses: { 200: { $ref: '#/components/responses/oauth2AuthorizationCode' } },
+      security: [{ studio: [] }],
+    },
+  },
+  '/api/oauth2/consent/agree': {
+    post: {
+      description: 'Create a new OAuth2 consent.',
+      tags: ['oauth2'],
+      operationId: 'agreeOAuth2Consent',
+      requestBody: { $ref: '#/components/requestBodies/oauth2Consent' },
+      responses: { 201: { $ref: '#/components/responses/oauth2AuthorizationCode' } },
+      security: [{ studio: [] }],
+    },
+  },
+};

package/api/paths/organizations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"organizations.js","sourceRoot":"","sources":["organizations.ts"],"names":[],"mappings":";;;AAEA,+CAAwC;AAE3B,QAAA,KAAK,GAA0B;IAC1C,oBAAoB,EAAE;QACpB,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,kCAAkC;YAC/C,WAAW,EAAE,kBAAkB;YAC/B,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,8BAA8B;oBAC3C,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,OAAO;gCACb,KAAK,EAAE;oCACL,IAAI,EAAE,mCAAmC;iCAC1C;6BACF;yBACF;qBACF;iBACF;aACF;SACF;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,4BAA4B;YACzC,WAAW,EAAE,oBAAoB;YACjC,WAAW,EAAE;gBACX,WAAW,EAAE,4BAA4B;gBACzC,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,qBAAqB,EAAE;wBACrB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,EAAE,EAAE;oCACF,IAAI,EAAE,iDAAiD;iCACxD;gCACD,IAAI,EAAE;oCACJ,IAAI,EAAE,mDAAmD;iCAC1D;gCACD,WAAW,EAAE;oCACX,IAAI,EAAE,0DAA0D;iCACjE;gCACD,KAAK,EAAE;oCACL,IAAI,EAAE,oDAAoD;iCAC3D;gCACD,OAAO,EAAE;oCACP,IAAI,EAAE,sDAAsD;iCAC7D;gCACD,IAAI,EAAE;oCACJ,IAAI,EAAE,QAAQ;oCACd,MAAM,EAAE,QAAQ;oCAChB,WAAW,EAAE,wBAAwB;iCACtC;6BACF;yBACF;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE;gCACJ,WAAW,EAAE,4CAA4C;6BAC1D;yBACF;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,IAAI,EAAE,qCAAqC;iBAC5C;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,qBAAqB,CAAC,EAAE,CAAC;SAC7D;KACF;IACD,qCAAqC,EAAE;QACrC,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,wCAAwC,EAAE,CAAC;QAChE,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,4BAA4B;YACzC,WAAW,EAAE,iBAAiB;YAC9B,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,IAAI,EAAE,qCAAqC;iBAC5C;aACF;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,wBAAwB;YACrC,WAAW,EAAE,mBAAmB;YAChC,WAAW,EAAE;gBACX,OAAO,EAAE;oBACP,qBAAqB,EAAE;wBACrB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,IAAI,EAAE;oCACJ,IAAI,EAAE,mDAAmD;iCAC1D;gCACD,WAAW,EAAE;oCACX,IAAI,EAAE,0DAA0D;iCACjE;gCACD,KAAK,EAAE;oCACL,IAAI,EAAE,oDAAoD;iCAC3D;gCACD,OAAO,EAAE;oCACP,IAAI,EAAE,sDAAsD;iCAC7D;gCACD,IAAI,EAAE;oCACJ,IAAI,EAAE,QAAQ;oCACd,MAAM,EAAE,QAAQ;oCAChB,WAAW,EAAE,wBAAwB;iCACtC;6BACF;yBACF;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE;gCACJ,WAAW,EAAE,4CAA4C;6BAC1D;yBACF;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,GAAG,EAAE,EAAE,IAAI,EAAE,qCAAqC,EAAE;aACrD;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,qBAAqB,CAAC,EAAE,CAAC;SAC7D;KACF;IACD,0CAA0C,EAAE;QAC1C,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,wCAAwC,EAAE,CAAC;QAChE,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,4BAA4B;YACzC,WAAW,EAAE,qBAAqB;YAClC,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,4CAA4C;iBAC1D;aACF;SACF;KACF;IACD,6CAA6C,EAAE;QAC7C,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,wCAAwC,EAAE,CAAC;QAChE,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,qCAAqC;YAClD,WAAW,EAAE,YAAY;YACzB,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,0BAA0B;oBACvC,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,OAAO;gCACb,KAAK,EAAE;oCACL,IAAI,EAAE,6BAA6B;iCACpC;6BACF;yBACF;qBACF;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;SAC3B;KACF;IACD,oDAAoD,EAAE;QACpD,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,wCAAwC,EAAE,CAAC;QAChE,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,kCAAkC;YAC/C,WAAW,EAAE,kBAAkB;YAC/B,WAAW,EAAE;gBACX,WAAW,EAAE,sDAAsD;gBACnE,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,QAAQ,EAAE,CAAC,OAAO,CAAC;4BACnB,UAAU,EAAE;gCACV,KAAK,EAAE;oCACL,IAAI,EAAE,QAAQ;iCACf;6BACF;yBACF;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,2BAA2B;iBACzC;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;SAC3B;KACF;IACD,0CAA0C,EAAE;QAC1C,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,wCAAwC,EAAE,CAAC;QAChE,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,gCAAgC;YAC7C,WAAW,EAAE,mBAAmB;YAChC,WAAW,EAAE;gBACX,WAAW,EAAE;;4IAEuH;gBACpI,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,QAAQ,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC;4BAC/B,UAAU,EAAE;gCACV,QAAQ,EAAE;oCACR,IAAI,EAAE,SAAS;iCAChB;gCACD,KAAK,EAAE;oCACL,IAAI,EAAE,QAAQ;iCACf;6BACF;yBACF;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,kCAAkC;iBAChD;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;SAC3B;KACF;IACD,6CAA6C,EAAE;QAC7C,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,wCAAwC,EAAE,CAAC;QAChE,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,6CAA6C;YAC1D,WAAW,EAAE,YAAY;YACzB,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,0BAA0B;oBACvC,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,OAAO;gCACb,KAAK,EAAE;oCACL,IAAI,EAAE,QAAQ;oCACd,UAAU,EAAE;wCACV,KAAK,EAAE;4CACL,IAAI,EAAE,QAAQ;4CACd,MAAM,EAAE,OAAO;yCAChB;wCACD,IAAI,EAAE;4CACJ,IAAI,EAAE,QAAQ;4CACd,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,iBAAK,CAAC;yCACzB;qCACF;iCACF;6BACF;yBACF;qBACF;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;SAC3B;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,oEAAoE;YACjF,WAAW,EAAE,eAAe;YAC5B,WAAW,EAAE;gBACX,WAAW,EAAE,uBAAuB;gBACpC,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE;gCACL,IAAI,EAAE,QAAQ;gCACd,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;gCAC3B,UAAU,EAAE;oCACV,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,MAAM,EAAE,OAAO;qCAChB;oCACD,IAAI,EAAE;wCACJ,IAAI,EAAE,QAAQ;wCACd,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,iBAAK,CAAC;qCACzB;iCACF;6BACF;yBACF;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,2BAA2B;oBACxC,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,2BAA2B;6BAClC;yBACF;qBACF;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;SAC3B;QACD,MAAM,EAAE;YACN,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,6BAA6B;YAC1C,WAAW,EAAE,cAAc;YAC3B,WAAW,EAAE;gBACX,WAAW,EAAE,4CAA4C;gBACzD,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,QAAQ,EAAE,CAAC,OAAO,CAAC;4BACnB,UAAU,EAAE;gCACV,KAAK,EAAE;oCACL,IAAI,EAAE,QAAQ;oCACd,MAAM,EAAE,OAAO;iCAChB;6BACF;yBACF;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,+CAA+C;iBAC7D;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;SAC3B;KACF;IACD,wDAAwD,EAAE;QACxD,UAAU,EAAE;YACV,EAAE,IAAI,EAAE,wCAAwC,EAAE;YAClD;gBACE,IAAI,EAAE,UAAU;gBAChB,EAAE,EAAE,MAAM;gBACV,WAAW,EAAE,gCAAgC;gBAC7C,QAAQ,EAAE,IAAI;gBACd,MAAM,EAAE,EAAE,IAAI,EAAE,yCAAyC,EAAE;aAC5D;SACF;QACD,MAAM,EAAE;YACN,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EACT,0IAA0I;YAC5I,WAAW,EAAE,cAAc;YAC3B,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,2CAA2C;iBACzD;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;SAC3B;KACF;IACD,6DAA6D,EAAE;QAC7D,UAAU,EAAE;YACV,EAAE,IAAI,EAAE,wCAAwC,EAAE;YAClD;gBACE,IAAI,EAAE,UAAU;gBAChB,EAAE,EAAE,MAAM;gBACV,WAAW,EAAE,sBAAsB;gBACnC,QAAQ,EAAE,IAAI;gBACd,MAAM,EAAE,EAAE,IAAI,EAAE,yCAAyC,EAAE;aAC5D;SACF;QACD,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,qDAAqD;YAClE,WAAW,EAAE,SAAS;YACtB,WAAW,EAAE;gBACX,WAAW,EAAE,kBAAkB;gBAC/B,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,QAAQ,EAAE,CAAC,MAAM,CAAC;4BAClB,UAAU,EAAE;gCACV,IAAI,EAAE;oCACJ,IAAI,EAAE,QAAQ;oCACd,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,iBAAK,CAAC;iCACzB;6BACF;yBACF;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,kDAAkD;oBAC/D,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,6BAA6B;6BACpC;yBACF;qBACF;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;SAC3B;KACF;IACD,0CAA0C,EAAE;QAC1C,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,wCAAwC,EAAE,CAAC;QAChE,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,UAAU,EAAE;gBACV;oBACE,IAAI,EAAE,UAAU;oBAChB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC1B,WAAW,EAAE,2DAA2D;oBACxE,EAAE,EAAE,OAAO;iBACZ;aACF;YACD,WAAW,EACT,yGAAyG;YAC3G,WAAW,EAAE,qBAAqB;YAClC,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,uCAAuC;oBACpD,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,OAAO;gCACb,KAAK,EAAE;oCACL,IAAI,EAAE,0BAA0B;iCACjC;6BACF;yBACF;qBACF;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;SAC/B;KACF;IACD,4CAA4C,EAAE;QAC5C,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,wCAAwC,EAAE,CAAC;QAChE,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,yCAAyC;YACtD,WAAW,EAAE,uBAAuB;YACpC,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,yCAAyC;oBACtD,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,OAAO;gCACb,KAAK,EAAE;oCACL,IAAI,EAAE,mCAAmC;iCAC1C;6BACF;yBACF;qBACF;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;SAC/B;KACF;CACF,CAAC"}

package/api/paths/organizations.ts

@@ -0,0 +1,471 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+import { roles } from '../../constants';
+
+export const paths: OpenAPIV3.PathsObject = {
+  '/api/organizations': {
+    get: {
+      tags: ['organization'],
+      description: 'Fetch the list of organizations.',
+      operationId: 'getOrganizations',
+      responses: {
+        200: {
+          description: 'The list of of organizations',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'array',
+                items: {
+                  $ref: '#/components/schemas/Organization',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+    post: {
+      tags: ['organization'],
+      description: 'Create a new organization.',
+      operationId: 'createOrganization',
+      requestBody: {
+        description: 'The organization to create',
+        required: true,
+        content: {
+          'multipart/form-data': {
+            schema: {
+              type: 'object',
+              properties: {
+                id: {
+                  $ref: '#/components/schemas/Organization/properties/id',
+                },
+                name: {
+                  $ref: '#/components/schemas/Organization/properties/name',
+                },
+                description: {
+                  $ref: '#/components/schemas/Organization/properties/description',
+                },
+                email: {
+                  $ref: '#/components/schemas/Organization/properties/email',
+                },
+                website: {
+                  $ref: '#/components/schemas/Organization/properties/website',
+                },
+                icon: {
+                  type: 'string',
+                  format: 'binary',
+                  description: 'The organization icon.',
+                },
+              },
+            },
+            encoding: {
+              icon: {
+                contentType: 'image/png,image/jpeg,image/tiff,image/webp',
+              },
+            },
+          },
+        },
+      },
+      responses: {
+        201: {
+          $ref: '#/components/responses/organization',
+        },
+      },
+      security: [{ studio: [] }, { cli: ['organizations:write'] }],
+    },
+  },
+  '/api/organizations/{organizationId}': {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    get: {
+      tags: ['organization'],
+      description: 'Get a single organization.',
+      operationId: 'getOrganization',
+      responses: {
+        200: {
+          $ref: '#/components/responses/organization',
+        },
+      },
+    },
+    patch: {
+      tags: ['organization'],
+      description: 'Update an organization',
+      operationId: 'patchOrganization',
+      requestBody: {
+        content: {
+          'multipart/form-data': {
+            schema: {
+              type: 'object',
+              properties: {
+                name: {
+                  $ref: '#/components/schemas/Organization/properties/name',
+                },
+                description: {
+                  $ref: '#/components/schemas/Organization/properties/description',
+                },
+                email: {
+                  $ref: '#/components/schemas/Organization/properties/email',
+                },
+                website: {
+                  $ref: '#/components/schemas/Organization/properties/website',
+                },
+                icon: {
+                  type: 'string',
+                  format: 'binary',
+                  description: 'The organization icon.',
+                },
+              },
+            },
+            encoding: {
+              icon: {
+                contentType: 'image/png,image/jpeg,image/tiff,image/webp',
+              },
+            },
+          },
+        },
+      },
+      responses: {
+        200: { $ref: '#/components/responses/organization' },
+      },
+      security: [{ studio: [] }, { cli: ['organizations:write'] }],
+    },
+  },
+  '/api/organizations/{organizationId}/icon': {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    get: {
+      tags: ['organization'],
+      description: 'Get the organization icon.',
+      operationId: 'getOrganizationIcon',
+      responses: {
+        200: {
+          description: 'The icon that represents the organization.',
+        },
+      },
+    },
+  },
+  '/api/organizations/{organizationId}/members': {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    get: {
+      tags: ['organization'],
+      description: 'Get a list of organization members.',
+      operationId: 'getMembers',
+      responses: {
+        200: {
+          description: 'The list of all members.',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'array',
+                items: {
+                  $ref: '#/components/schemas/Member',
+                },
+              },
+            },
+          },
+        },
+      },
+      security: [{ studio: [] }],
+    },
+  },
+  '/api/organizations/{organizationId}/invites/resend': {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    post: {
+      tags: ['organization'],
+      description: 'Request to resend an invitation.',
+      operationId: 'resendInvitation',
+      requestBody: {
+        description: 'The email of the person to resend the invitation to.',
+        required: true,
+        content: {
+          'application/json': {
+            schema: {
+              type: 'object',
+              required: ['email'],
+              properties: {
+                email: {
+                  type: 'string',
+                },
+              },
+            },
+          },
+        },
+      },
+      responses: {
+        204: {
+          description: 'The invite has been sent.',
+        },
+      },
+      security: [{ studio: [] }],
+    },
+  },
+  '/api/organizations/{organizationId}/join': {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    post: {
+      tags: ['organization'],
+      description: 'Respond to a given invitation.',
+      operationId: 'respondInvitation',
+      requestBody: {
+        description: `The response of the invitation.
+
+        If response is true, user will join the organization. If response is false, the user declines the invite and the invite is removed.`,
+        required: true,
+        content: {
+          'application/json': {
+            schema: {
+              type: 'object',
+              required: ['response', 'token'],
+              properties: {
+                response: {
+                  type: 'boolean',
+                },
+                token: {
+                  type: 'string',
+                },
+              },
+            },
+          },
+        },
+      },
+      responses: {
+        204: {
+          description: 'The response has been processed.',
+        },
+      },
+      security: [{ studio: [] }],
+    },
+  },
+  '/api/organizations/{organizationId}/invites': {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    get: {
+      tags: ['organization'],
+      description: 'Get a list of invited organization members.',
+      operationId: 'getInvites',
+      responses: {
+        200: {
+          description: 'The list of all invites.',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'array',
+                items: {
+                  type: 'object',
+                  properties: {
+                    email: {
+                      type: 'string',
+                      format: 'email',
+                    },
+                    role: {
+                      type: 'string',
+                      enum: Object.keys(roles),
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+      security: [{ studio: [] }],
+    },
+    post: {
+      tags: ['organization'],
+      description: 'Invite a new member to the organization that matches the given id.',
+      operationId: 'inviteMembers',
+      requestBody: {
+        description: 'The member to invite.',
+        required: true,
+        content: {
+          'application/json': {
+            schema: {
+              type: 'array',
+              items: {
+                type: 'object',
+                required: ['email', 'role'],
+                properties: {
+                  email: {
+                    type: 'string',
+                    format: 'email',
+                  },
+                  role: {
+                    type: 'string',
+                    enum: Object.keys(roles),
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+      responses: {
+        201: {
+          description: 'The newly invited member.',
+          content: {
+            'application/json': {
+              schema: {
+                $ref: '#/components/schemas/User',
+              },
+            },
+          },
+        },
+      },
+      security: [{ studio: [] }],
+    },
+    delete: {
+      tags: ['organization'],
+      description: 'Revoke a member invitation.',
+      operationId: 'removeInvite',
+      requestBody: {
+        description: 'The email address to revoke the invite of.',
+        required: true,
+        content: {
+          'application/json': {
+            schema: {
+              type: 'object',
+              required: ['email'],
+              properties: {
+                email: {
+                  type: 'string',
+                  format: 'email',
+                },
+              },
+            },
+          },
+        },
+      },
+      responses: {
+        204: {
+          description: 'The invitation has been successfully revoked.',
+        },
+      },
+      security: [{ studio: [] }],
+    },
+  },
+  '/api/organizations/{organizationId}/members/{memberId}': {
+    parameters: [
+      { $ref: '#/components/parameters/organizationId' },
+      {
+        name: 'memberId',
+        in: 'path',
+        description: 'The ID of the member to remove',
+        required: true,
+        schema: { $ref: '#/components/schemas/User/properties/id' },
+      },
+    ],
+    delete: {
+      tags: ['organization'],
+      description:
+        'Remove a member from the organization that matches the given id, or leave the organization if the member id matches the user’s member id',
+      operationId: 'removeMember',
+      responses: {
+        204: {
+          description: 'The member has been successfully removed.',
+        },
+      },
+      security: [{ studio: [] }],
+    },
+  },
+  '/api/organizations/{organizationId}/members/{memberId}/role': {
+    parameters: [
+      { $ref: '#/components/parameters/organizationId' },
+      {
+        name: 'memberId',
+        in: 'path',
+        description: 'The ID of the member',
+        required: true,
+        schema: { $ref: '#/components/schemas/User/properties/id' },
+      },
+    ],
+    put: {
+      tags: ['organization'],
+      description: 'Set the role of the member within the organization.',
+      operationId: 'setRole',
+      requestBody: {
+        description: 'The role to set.',
+        required: true,
+        content: {
+          'application/json': {
+            schema: {
+              type: 'object',
+              required: ['role'],
+              properties: {
+                role: {
+                  type: 'string',
+                  enum: Object.keys(roles),
+                },
+              },
+            },
+          },
+        },
+      },
+      responses: {
+        200: {
+          description: 'The member’s role has been successfully updated.',
+          content: {
+            'application/json': {
+              schema: {
+                $ref: '#/components/schemas/Member',
+              },
+            },
+          },
+        },
+      },
+      security: [{ studio: [] }],
+    },
+  },
+  '/api/organizations/{organizationId}/apps': {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    get: {
+      tags: ['organization'],
+      parameters: [
+        {
+          name: 'language',
+          schema: { type: 'string' },
+          description: 'The language to include the translations of, if available',
+          in: 'query',
+        },
+      ],
+      description:
+        'Get a list of an organization’s apps. Private apps are excluded unless the user is in the organization.',
+      operationId: 'getOrganizationApps',
+      responses: {
+        200: {
+          description: 'The list of this organization’s apps.',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'array',
+                items: {
+                  $ref: '#/components/schemas/App',
+                },
+              },
+            },
+          },
+        },
+      },
+      security: [{ studio: [] }, {}],
+    },
+  },
+  '/api/organizations/{organizationId}/blocks': {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    get: {
+      tags: ['organization'],
+      description: 'Get a list of an organization’s blocks.',
+      operationId: 'getOrganizationBlocks',
+      responses: {
+        200: {
+          description: 'The list of this organization’s blocks.',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'array',
+                items: {
+                  $ref: '#/components/schemas/BlockVersion',
+                },
+              },
+            },
+          },
+        },
+      },
+      security: [{ studio: [] }, {}],
+    },
+  },
+};