@appsemble/utils 0.29.11 → 0.30.2

package/api/paths/apps/appId/assets/count.js

@@ -0,0 +1,22 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['common', 'app', 'asset'],
+        description: 'Get the number of assets in the app.',
+        operationId: 'countAppAssets',
+        responses: {
+            200: {
+                description: 'The number of assets in the app.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'number',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
+    },
+};
+//# sourceMappingURL=count.js.map

package/api/paths/apps/appId/assets.d.ts

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

package/api/paths/apps/appId/assets.js

@@ -0,0 +1,96 @@
+import { normalized } from '../../../../constants/index.js';
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['common', 'app', 'asset'],
+        description: 'Get all of the app’s assets.',
+        operationId: 'queryAppAssets',
+        parameters: [
+            { $ref: '#/components/parameters/$skip' },
+            { $ref: '#/components/parameters/$top' },
+            { $ref: '#/components/parameters/seed' },
+        ],
+        responses: {
+            200: {
+                description: 'The assets associated with the app.',
+                content: {
+                    'application/json': {
+                        schema: { $ref: '#/components/schemas/Asset' },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, {}],
+    },
+    post: {
+        tags: ['common', 'app', 'asset'],
+        description: 'Upload a new asset.',
+        operationId: 'createAppAsset',
+        parameters: [{ $ref: '#/components/parameters/seed' }],
+        requestBody: {
+            description: 'The asset to upload.',
+            content: {
+                'multipart/form-data': {
+                    schema: {
+                        type: 'object',
+                        description: 'The request body for creating an asset.',
+                        additionalProperties: false,
+                        required: ['file'],
+                        properties: {
+                            file: {
+                                type: 'string',
+                                format: 'binary',
+                                writeOnly: true,
+                                description: 'The binary data of the asset. This may include a filename.',
+                            },
+                            name: {
+                                type: 'string',
+                                pattern: normalized.source,
+                                description: 'The given name of the asset. Assets may be referenced by their name or ID in the API.',
+                            },
+                            clonable: {
+                                type: 'boolean',
+                                description: 'Whether the asset should be transferable when cloning the app they are in.',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'The asset that was created.',
+                content: {
+                    'application/json': {
+                        schema: { $ref: '#/components/schemas/Asset' },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { cli: ['assets:write'] }, {}],
+    },
+    delete: {
+        tags: ['common', 'app', 'asset'],
+        description: 'Delete multiple app assets.',
+        operationId: 'deleteAppAssets',
+        parameters: [{ $ref: '#/components/parameters/seed' }],
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'array',
+                        description: 'An array of asset IDs to remove.',
+                        items: { $ref: '#/components/schemas/Asset/properties/id' },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The app assets have been deleted successfully.',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+};
+//# sourceMappingURL=assets.js.map

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

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

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

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

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

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

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

@@ -0,0 +1,52 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['app', 'auth', 'email'],
+        description: 'Register a new app account using an email address and a password.',
+        operationId: 'registerAppMemberWithEmail',
+        requestBody: {
+            description: 'The user account to register.',
+            required: true,
+            content: {
+                'multipart/form-data': {
+                    schema: {
+                        type: 'object',
+                        required: ['email', 'password', 'timezone'],
+                        properties: {
+                            name: {
+                                type: 'string',
+                            },
+                            email: {
+                                type: 'string',
+                                format: 'email',
+                            },
+                            password: {
+                                type: 'string',
+                                minLength: 8,
+                            },
+                            picture: {
+                                type: 'string',
+                                format: 'binary',
+                                description: 'The account’s profile picture.',
+                            },
+                            properties: {
+                                type: 'object',
+                                additionalProperties: { type: 'string' },
+                                description: 'The member’s custom properties.',
+                            },
+                            timezone: {
+                                enum: Intl.supportedValuesOf('timeZone'),
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'The account that was created.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=register.js.map

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

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

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

@@ -0,0 +1,31 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['app', 'auth', 'email'],
+        description: 'Request a reset token for resetting passwords.',
+        operationId: 'requestAppMemberPasswordReset',
+        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/apps/appId/auth/email/resendVerification.d.ts

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

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

@@ -0,0 +1,32 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['app', 'auth', 'email'],
+        description: 'Resend the verification code for a registered email.',
+        operationId: 'resendAppMemberEmailVerification',
+        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: [{ app: ['email'] }],
+    },
+};
+//# sourceMappingURL=resendVerification.js.map

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

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

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

@@ -0,0 +1,34 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['app', 'auth', 'email'],
+        description: 'Reset a password using a password reset token.',
+        operationId: 'resetAppMemberPassword',
+        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/apps/appId/auth/email/verify.d.ts

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

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

@@ -0,0 +1,31 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['app', 'auth', 'email'],
+        description: 'Verify the email address of a registered user.',
+        operationId: 'verifyAppMemberEmail',
+        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/apps/appId/broadcast.d.ts

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

package/api/paths/apps/appId/broadcast.js

@@ -0,0 +1,36 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['main', 'app'],
+        description: 'Broadcast a push notification to every subscriber of the app.',
+        operationId: 'sendAppNotifications',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        description: 'The data to include in the notification',
+                        required: ['body'],
+                        properties: {
+                            title: {
+                                description: 'The title of the notification. This defaults to the name of the app if not otherwise specified.',
+                                type: 'string',
+                            },
+                            body: {
+                                description: 'The content of the notification',
+                                type: 'string',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The notification has been successfully broadcasted.',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=broadcast.js.map

package/api/paths/apps/appId/demo-groups.d.ts

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

package/api/paths/apps/appId/demo-groups.js

@@ -0,0 +1,29 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['common', 'app', 'demo-group'],
+        description: 'Get a list of app groups.',
+        operationId: 'getAppDemoGroups',
+        responses: {
+            200: {
+                description: 'The list of all groups.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                description: 'An app demo group',
+                                type: 'object',
+                                properties: {
+                                    id: { type: 'number' },
+                                    name: { type: 'string' },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=demo-groups.js.map

package/api/paths/apps/appId/demo-members.d.ts

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

package/api/paths/apps/appId/demo-members.js

@@ -0,0 +1,27 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/roles' },
+    ],
+    get: {
+        tags: ['common', 'app', 'demo-member'],
+        description: 'Fetch all demo members of an app.',
+        operationId: 'queryAppDemoMembers',
+        responses: {
+            200: {
+                description: 'The list of app demo members.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/AppMemberInfo',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=demo-members.js.map

package/api/paths/apps/appId/email.d.ts

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

package/api/paths/apps/appId/email.js

@@ -0,0 +1,48 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app'],
+        description: 'Get the app’s email settings.',
+        operationId: 'getAppEmailSettings',
+        responses: {
+            200: {
+                description: 'The current app email settings',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                emailName: {
+                                    type: 'string',
+                                    description: 'The name used for emails.',
+                                },
+                                emailHost: {
+                                    type: 'string',
+                                    description: 'The hostname of the SMTP server.',
+                                },
+                                emailPassword: {
+                                    type: 'boolean',
+                                    description: 'Whether a password is set.',
+                                },
+                                emailUser: {
+                                    type: 'string',
+                                    description: 'The username used to authenticate against the SMTP server.',
+                                },
+                                emailPort: {
+                                    type: 'string',
+                                    description: 'The port used for the SMTP server.',
+                                },
+                                emailSecure: {
+                                    type: 'boolean',
+                                    description: 'Whether TLS is being used.',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=email.js.map

package/api/paths/apps/appId/export.d.ts

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

package/api/paths/apps/appId/export.js

@@ -0,0 +1,41 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app'],
+        description: 'Export an app as a zip file',
+        operationId: 'exportApp',
+        parameters: [
+            {
+                name: 'resources',
+                schema: { type: 'boolean' },
+                description: 'Whether to include resources for an app.',
+                in: 'query',
+            },
+            {
+                name: 'assets',
+                schema: { type: 'boolean' },
+                description: 'Whether to include assets in the export file',
+                in: 'query',
+            },
+            {
+                name: 'screenshots',
+                schema: { type: 'boolean' },
+                description: 'Whether to include screenshots in the export file',
+                in: 'query',
+            },
+            {
+                name: 'readmes',
+                schema: { type: 'boolean' },
+                description: 'Whether to include readmes in the export file',
+                in: 'query',
+            },
+        ],
+        responses: {
+            200: {
+                description: 'App exported successfully.',
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:export'] }],
+    },
+};
+//# sourceMappingURL=export.js.map

package/api/paths/apps/appId/groups.d.ts

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

package/api/paths/apps/appId/groups.js

@@ -0,0 +1,79 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['common', 'app', 'group'],
+        description: 'Get a list of app groups.',
+        operationId: 'getAppGroups',
+        responses: {
+            200: {
+                description: 'The list of all groups.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                description: 'An app group',
+                                type: 'object',
+                                properties: {
+                                    id: { type: 'number' },
+                                    name: { type: 'string' },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { app: ['groups:read'] }, {}],
+    },
+    post: {
+        tags: ['common', 'app', 'group'],
+        description: 'Create a new group.',
+        operationId: 'createAppGroup',
+        parameters: [{ $ref: '#/components/parameters/selectedGroupId' }],
+        requestBody: {
+            description: 'The group to create.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['name'],
+                        properties: {
+                            name: {
+                                type: 'string',
+                            },
+                            annotations: {
+                                type: 'object',
+                                additionalProperties: { type: 'string' },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'The created group',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                id: { type: 'number' },
+                                name: { type: 'string' },
+                                role: {
+                                    type: 'string',
+                                    description: 'The role of the user who created the group',
+                                    enum: ['member'],
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ app: ['groups:write'] }, { studio: [] }, { cli: ['groups:write'] }],
+    },
+};
+//# sourceMappingURL=groups.js.map

package/api/paths/apps/appId/icon.d.ts

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