@appsemble/utils 0.29.11 → 0.30.1

package/api/paths/auth/email/login.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/auth/email/login.js

@@ -0,0 +1,10 @@
+export const pathItems = {
+    post: {
+        tags: ['main', 'auth', 'email'],
+        description: 'Login using the Appsemble studio.',
+        operationId: 'loginUserWithEmail',
+        responses: { 200: { description: 'Logged in successfully.' } },
+        security: [{ basic: [] }],
+    },
+};
+//# sourceMappingURL=login.js.map

package/api/paths/auth/email/register.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/auth/email/register.js

@@ -0,0 +1,45 @@
+export const pathItems = {
+    post: {
+        tags: ['main', 'auth', 'email'],
+        description: 'Register a new studio account using an email address and a password.',
+        operationId: 'registerUserWithEmail',
+        requestBody: {
+            description: 'The user account to register.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['email', 'password'],
+                        properties: {
+                            name: {
+                                type: 'string',
+                            },
+                            email: {
+                                type: 'string',
+                                format: 'email',
+                            },
+                            password: {
+                                type: 'string',
+                                minLength: 8,
+                            },
+                            timezone: {
+                                enum: Intl.supportedValuesOf('timeZone'),
+                            },
+                            subscribed: {
+                                type: 'boolean',
+                                default: false,
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'The account that was created.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=register.js.map

package/api/paths/auth/email/requestResetPassword.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/auth/email/requestResetPassword.js

@@ -0,0 +1,30 @@
+export const pathItems = {
+    post: {
+        tags: ['main', 'auth', 'email'],
+        description: 'Request a reset token for resetting passwords.',
+        operationId: 'requestUserPasswordReset',
+        requestBody: {
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['email'],
+                        properties: {
+                            email: {
+                                type: 'string',
+                                format: 'email',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The request has been received and an email was sent if it exists.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=requestResetPassword.js.map

package/api/paths/auth/email/resendVerification.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/auth/email/resendVerification.js

@@ -0,0 +1,31 @@
+export const pathItems = {
+    post: {
+        tags: ['main', 'auth', 'email'],
+        description: 'Resend the verification code for a registered email.',
+        operationId: 'resendUserEmailVerification',
+        requestBody: {
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['email'],
+                        properties: {
+                            email: {
+                                type: 'string',
+                                format: 'email',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The verification email was sent if an account was found in the database.',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=resendVerification.js.map

package/api/paths/auth/email/resetPassword.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/auth/email/resetPassword.js

@@ -0,0 +1,33 @@
+export const pathItems = {
+    post: {
+        tags: ['main', 'auth', 'email'],
+        description: 'Reset a password using a password reset token.',
+        operationId: 'resetUserPassword',
+        requestBody: {
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['password', 'token'],
+                        properties: {
+                            password: {
+                                type: 'string',
+                                minLength: 8,
+                            },
+                            token: {
+                                type: 'string',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The password has been reset.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=resetPassword.js.map

package/api/paths/auth/email/verify.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/auth/email/verify.js

@@ -0,0 +1,30 @@
+export const pathItems = {
+    post: {
+        tags: ['main', 'auth', 'email'],
+        description: 'Verify the email address of a registered user.',
+        operationId: 'verifyUserEmail',
+        requestBody: {
+            description: 'The user account to register.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['token'],
+                        properties: {
+                            token: {
+                                type: 'string',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'The account was successfully verified.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=verify.js.map

package/api/paths/auth/oauth2/authorizations/connect.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/auth/oauth2/authorizations/connect.js

@@ -0,0 +1,45 @@
+export const pathItems = {
+    post: {
+        description: 'Create an account using an OAuth2 authorization.',
+        tags: ['main', 'auth', 'oauth2', 'authorization'],
+        operationId: 'connectOAuth2Authorization',
+        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: [] }, {}],
+    },
+};
+//# sourceMappingURL=connect.js.map

package/api/paths/auth/oauth2/authorizations/register.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/auth/oauth2/authorizations/register.js

@@ -0,0 +1,32 @@
+export const pathItems = {
+    post: {
+        tags: ['main', 'auth', 'oauth2', 'authorization'],
+        operationId: 'registerOAuth2Authorization',
+        description: 'asd',
+        requestBody: {
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['authorizationUrl', 'code'],
+                        properties: {
+                            authorizationUrl: {
+                                type: 'string',
+                            },
+                            code: {
+                                type: 'string',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: '',
+            },
+        },
+    },
+};
+//# sourceMappingURL=register.js.map

package/api/paths/auth/refreshToken.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/auth/refreshToken.js

@@ -0,0 +1,26 @@
+export const pathItems = {
+    post: {
+        tags: ['main', 'auth'],
+        description: 'Refresh an access token using the Appsemble studio',
+        operationId: 'refreshToken',
+        requestBody: {
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['refresh_token'],
+                        properties: {
+                            refresh_token: {
+                                type: 'string',
+                                description: 'The refresh token to use for refreshing the session.',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: { 200: { description: 'The token has been refreshed successfully.' } },
+    },
+};
+//# sourceMappingURL=refreshToken.js.map

package/api/paths/blocks/organizationId/blockId/versions/list.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/blocks/organizationId/blockId/versions/list.js

@@ -0,0 +1,27 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/organizationId' },
+        { $ref: '#/components/parameters/blockId' },
+    ],
+    get: {
+        tags: ['main', 'block', 'version'],
+        description: 'Retrieve a string list of all versions of a block.',
+        operationId: 'getBlockVersionsList',
+        responses: {
+            200: {
+                description: 'String list of all versions of a block.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                type: 'string',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=list.js.map

package/api/paths/blocks/organizationId/blockId/versions/version/asset.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/blocks/organizationId/blockId/versions/version/asset.js

@@ -0,0 +1,24 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/organizationId' },
+        { $ref: '#/components/parameters/blockId' },
+        { $ref: '#/components/parameters/blockVersion' },
+        {
+            name: 'filename',
+            in: 'query',
+            description: 'The file name of the block asset to download',
+            schema: { type: 'string' },
+        },
+    ],
+    get: {
+        tags: ['common', 'block', 'version', 'asset'],
+        description: 'Download a single block asset',
+        operationId: 'getBlockVersionAsset',
+        responses: {
+            200: {
+                description: 'The asset that has been requested.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=asset.js.map

package/api/paths/blocks/organizationId/blockId/versions/version/icon.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/blocks/organizationId/blockId/versions/version/icon.js

@@ -0,0 +1,18 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/organizationId' },
+        { $ref: '#/components/parameters/blockId' },
+        { $ref: '#/components/parameters/blockVersion' },
+    ],
+    get: {
+        tags: ['common', 'block', 'version'],
+        description: 'Get the icon of a block version.',
+        operationId: 'getBlockVersionIcon',
+        responses: {
+            200: {
+                description: 'The icon that represents the block.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=icon.js.map

package/api/paths/blocks/organizationId/blockId/versions/version/messages/language.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/blocks/organizationId/blockId/versions/version/messages/language.js

@@ -0,0 +1,37 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/organizationId' },
+        { $ref: '#/components/parameters/blockId' },
+        { $ref: '#/components/parameters/blockVersion' },
+        {
+            in: 'path',
+            name: 'language',
+            schema: { type: 'string' },
+            description: 'The language to get messages for.',
+            required: true,
+        },
+    ],
+    get: {
+        tags: ['common', 'block', 'version', 'translation'],
+        description: 'Get internationalized messages for a block.',
+        operationId: 'getBlockVersionMessages',
+        responses: {
+            200: {
+                description: 'A key/value mapping of block messages.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            description: 'A key/value mapping of block messages.',
+                            additionalProperties: {
+                                type: 'string',
+                                description: 'A translated block message.',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=language.js.map

package/api/paths/blocks/organizationId/blockId/versions/version.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/blocks/organizationId/blockId/versions/version.js

@@ -0,0 +1,29 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/organizationId' },
+        { $ref: '#/components/parameters/blockId' },
+        { $ref: '#/components/parameters/blockVersion' },
+    ],
+    get: {
+        tags: ['common', 'block', 'version'],
+        description: 'Retrieve a single block version.',
+        operationId: 'getBlockVersion',
+        responses: {
+            200: {
+                $ref: '#/components/responses/blockVersion',
+            },
+        },
+    },
+    delete: {
+        tags: ['main', 'block', 'version'],
+        description: 'Delete a single block version.',
+        operationId: 'deleteBlockVersion',
+        responses: {
+            204: {
+                description: 'Block version has successfully been deleted',
+            },
+        },
+        security: [{ cli: ['blocks:delete'] }],
+    },
+};
+//# sourceMappingURL=version.js.map

package/api/paths/blocks/organizationId/blockId/versions.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/blocks/organizationId/blockId/versions.js

@@ -0,0 +1,27 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/organizationId' },
+        { $ref: '#/components/parameters/blockId' },
+    ],
+    get: {
+        tags: ['common', 'block', 'version'],
+        description: 'Retrieves all available versions of a block.',
+        operationId: 'getBlockVersions',
+        responses: {
+            200: {
+                description: 'A list of versions of a block.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/BlockVersion',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=versions.js.map

package/api/paths/blocks/organizationId/blockId.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/blocks/organizationId/blockId.js

@@ -0,0 +1,18 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/organizationId' },
+        { $ref: '#/components/parameters/blockId' },
+    ],
+    get: {
+        tags: ['common', 'block'],
+        description: 'Get a single block',
+        operationId: 'getBlock',
+        responses: {
+            200: {
+                description: 'The latest version of the block that matches the given id.',
+                $ref: '#/components/responses/blockVersion',
+            },
+        },
+    },
+};
+//# sourceMappingURL=blockId.js.map

package/api/paths/blocks/versions/blockVersion.js

@@ -0,0 +1,21 @@
+export const paths = {
+    '/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}': {
+        parameters: [
+            { $ref: '#/components/parameters/organizationId' },
+            { $ref: '#/components/parameters/blockId' },
+            { $ref: '#/components/parameters/blockVersion' },
+        ],
+        delete: {
+            tags: ['main', 'block', 'version'],
+            description: 'Delete a single block version.',
+            operationId: 'deleteBlockVersion',
+            responses: {
+                204: {
+                    description: 'Block version has successfully been deleted',
+                },
+            },
+            security: [{ cli: ['blocks:delete'] }],
+        },
+    },
+};
+//# sourceMappingURL=blockVersion.js.map

package/api/paths/blocks.d.ts

@@ -1,2 +1,2 @@
 import { type OpenAPIV3 } from 'openapi-types';
-export declare const paths: OpenAPIV3.PathsObject;
+export declare const pathItems: OpenAPIV3.PathItemObject;