@appsemble/utils 0.29.10 → 0.30.1

package/api/components/parameters/$team.d.ts

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

package/api/components/parameters/$team.js

@@ -1,8 +0,0 @@
-import { TeamRole } from '../../../constants/index.js';
-export const $team = {
-    name: '$team',
-    in: 'query',
-    description: 'A custom filter for filtering the query by teams the requesting user is a member of.',
-    schema: { enum: Object.values(TeamRole) },
-};
-//# sourceMappingURL=$team.js.map

package/api/components/parameters/appServiceId.d.ts

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

package/api/components/parameters/memberEmail.d.ts

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

package/api/components/parameters/memberEmail.js

@@ -1,8 +0,0 @@
-export const memberEmail = {
-    name: 'memberEmail',
-    in: 'path',
-    description: 'The email of the member on which to perform an operation',
-    required: true,
-    schema: { $ref: '#/components/schemas/OrganizationMember/properties/primaryEmail' },
-};
-//# sourceMappingURL=memberEmail.js.map

package/api/components/schemas/TeamInviteActionDefinition.d.ts

@@ -1 +0,0 @@
-export declare const TeamInviteActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/TeamJoinActionDefinition.d.ts

@@ -1 +0,0 @@
-export declare const TeamJoinActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/TeamJoinActionDefinition.js

@@ -1,14 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const TeamJoinActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type'],
-    properties: {
-        type: {
-            enum: ['team.join'],
-            description: 'Allow a user to join a team.',
-        },
-    },
-});
-//# sourceMappingURL=TeamJoinActionDefinition.js.map

package/api/components/schemas/TeamListActionDefinition.d.ts

@@ -1 +0,0 @@
-export declare const TeamListActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/TeamListActionDefinition.js

@@ -1,14 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const TeamListActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type'],
-    properties: {
-        type: {
-            enum: ['team.list'],
-            description: 'Get a list of all of the teams in an app.',
-        },
-    },
-});
-//# sourceMappingURL=TeamListActionDefinition.js.map

package/api/components/schemas/TeamMembersActionDefinition.d.ts

@@ -1 +0,0 @@
-export declare const TeamMembersActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/TeamsDefinition.d.ts

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

package/api/components/schemas/TeamsDefinition.js

@@ -1,28 +0,0 @@
-export const TeamsDefinition = {
-    type: 'object',
-    additionalProperties: false,
-    description: 'This defines how teams are handled by an app.',
-    required: ['join', 'invite'],
-    properties: {
-        join: {
-            enum: ['anyone', 'invite'],
-            description: 'If this is set to `anyone`, any logged in user may join a team. If this is set to `invite`, only users may join who have been invited.',
-        },
-        create: {
-            type: 'array',
-            description: `A list of app roles which may create a team.
-
-By default teams can only be created from Appsemble Studio.`,
-            items: { type: 'string' },
-            default: [],
-        },
-        invite: {
-            type: 'array',
-            description: `The roles here determine which users may invite a team member.
-
-The special roles \`$team:member\` and \`$team:manager\` mean that users who are already member of manager of the team may also invite new members.`,
-            items: { type: 'string' },
-        },
-    },
-};
-//# sourceMappingURL=TeamsDefinition.js.map

package/api/components/schemas/UserCreateActionDefinition.d.ts

@@ -1 +0,0 @@
-export declare const UserCreateActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/UserCreateActionDefinition.js

@@ -1,33 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const UserCreateActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['email', 'password'],
-    properties: {
-        type: {
-            enum: ['user.create'],
-            description: `Allows the user to create a new account using an email address and a password.
-
-Does nothing if the user is already logged in.`,
-        },
-        name: {
-            description: 'The display name of the user.',
-        },
-        email: {
-            description: 'The email to login with.',
-        },
-        password: {
-            description: 'The password to login with.',
-        },
-        properties: {
-            description: `The custom properties for the user.
-
-Values will be validated based on \`user.properties\`, if defined in the app definition.`,
-        },
-        role: {
-            description: "The role for the created account. Defaults to the default role in the app's security definition.",
-        },
-    },
-});
-//# sourceMappingURL=UserCreateActionDefinition.js.map

package/api/components/schemas/UserLoginActionDefinition.d.ts

@@ -1 +0,0 @@
-export declare const UserLoginActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/UserLoginActionDefinition.js

@@ -1,22 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const UserLoginActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type'],
-    properties: {
-        type: {
-            enum: ['user.login'],
-            description: `Allows the user to login using an email address and a password.
-
-Does nothing if the user is already logged in.`,
-        },
-        password: {
-            description: 'The password to login with.',
-        },
-        email: {
-            description: 'The email to login with.',
-        },
-    },
-});
-//# sourceMappingURL=UserLoginActionDefinition.js.map

package/api/components/schemas/UserLogoutActionDefinition.d.ts

@@ -1 +0,0 @@
-export declare const UserLogoutActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/UserPropertyDefinition.d.ts

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

package/api/components/schemas/UserQueryActionDefinition.d.ts

@@ -1 +0,0 @@
-export declare const UserQueryActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/UserQueryActionDefinition.js

@@ -1,20 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const UserQueryActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: [],
-    properties: {
-        type: {
-            enum: ['user.query'],
-            description: `Allows the user to fetch a list of accounts by their roles.
-
-Does nothing if the user isn’t logged in.`,
-        },
-        roles: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The roles of the accounts that would be fetched.',
-        },
-    },
-});
-//# sourceMappingURL=UserQueryActionDefinition.js.map

package/api/components/schemas/UserRegisterActionDefinition.d.ts

@@ -1 +0,0 @@
-export declare const UserRegisterActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/UserRegisterActionDefinition.js

@@ -1,37 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const UserRegisterActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['email', 'password'],
-    properties: {
-        type: {
-            enum: ['user.register'],
-            description: `Allows the user to register a new account using an email address and a password.
-
-Does nothing if the user is already logged in.`,
-        },
-        password: {
-            description: 'The password to login with.',
-        },
-        email: {
-            description: 'The email to login with.',
-        },
-        displayName: {
-            description: 'The display name of the user.',
-        },
-        picture: {
-            description: 'The image to use for the profile picture of the user.',
-        },
-        properties: {
-            description: `The custom properties for the user.
-
-Values will be validated based on \`user.properties\`, if defined in the app definition.`,
-        },
-        login: {
-            description: 'Whether to login after registering.',
-            default: true,
-        },
-    },
-});
-//# sourceMappingURL=UserRegisterActionDefinition.js.map

package/api/components/schemas/UserRemoveActionDefinition.d.ts

@@ -1 +0,0 @@
-export declare const UserRemoveActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/UserRemoveActionDefinition.js

@@ -1,20 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const UserRemoveActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['email'],
-    properties: {
-        type: {
-            enum: ['user.remove'],
-            description: `Allows the user to delete an existing account.
-
-Does nothing if the user isn’t logged in.`,
-        },
-        email: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The email of the account to be deleted.',
-        },
-    },
-});
-//# sourceMappingURL=UserRemoveActionDefinition.js.map

package/api/components/schemas/UserUpdateActionDefinition.d.ts

@@ -1 +0,0 @@
-export declare const UserUpdateActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/UserUpdateActionDefinition.js

@@ -1,36 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const UserUpdateActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: [],
-    properties: {
-        type: {
-            enum: ['user.update'],
-            description: `Allows the user to update their existing account.
-
-Does nothing if the user isn’t logged in.`,
-        },
-        name: {
-            description: 'The new display name of the user.',
-        },
-        currentEmail: {
-            description: 'The current email address of the user.',
-        },
-        newEmail: {
-            description: 'The new email address.',
-        },
-        password: {
-            description: 'The new password.',
-        },
-        properties: {
-            description: `The custom properties for the user.
-
-Values will be validated based on \`user.properties\`, if defined in the app definition.`,
-        },
-        role: {
-            description: "The role for the updated account. Defaults to the default role in the app's security definition.",
-        },
-    },
-});
-//# sourceMappingURL=UserUpdateActionDefinition.js.map

package/api/components/schemas/UsersDefinition.d.ts

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

package/api/components/schemas/UsersDefinition.js

@@ -1,17 +0,0 @@
-export const UsersDefinition = {
-    type: 'object',
-    description: 'Definition for user properties.',
-    required: [],
-    additionalProperties: false,
-    properties: {
-        properties: {
-            type: 'object',
-            description: 'The properties object configuring users in the app',
-            additionalProperties: {
-                description: 'A single user property definition.',
-                $ref: '#/components/schemas/UserPropertyDefinition',
-            },
-        },
-    },
-};
-//# sourceMappingURL=UsersDefinition.js.map

package/api/paths/appMessages.d.ts

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

package/api/paths/appMessages.js

@@ -1,120 +0,0 @@
-export const paths = {
-    '/api/apps/{appId}/messages': {
-        parameters: [
-            { $ref: '#/components/parameters/appId' },
-            { name: 'merge', in: 'query', schema: { type: 'boolean' } },
-            { name: 'includeMessages', in: 'query', schema: { type: 'boolean' } },
-        ],
-        get: {
-            tags: ['language'],
-            description: 'Get a list of all languages with messages.',
-            responses: {
-                200: {
-                    description: 'The list of supported languages',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'array',
-                                items: {
-                                    oneOf: [{ type: 'string' }, { $ref: '#/components/schemas/AppMessages' }],
-                                },
-                            },
-                        },
-                    },
-                },
-            },
-            operationId: 'getLanguages',
-        },
-        post: {
-            tags: ['language'],
-            description: 'Upload messages for the given language.',
-            operationId: 'createMessages',
-            requestBody: {
-                required: true,
-                content: {
-                    'application/json': {
-                        schema: {
-                            oneOf: [
-                                { $ref: '#/components/schemas/AppMessages' },
-                                {
-                                    type: 'array',
-                                    items: {
-                                        $ref: '#/components/schemas/AppMessages',
-                                    },
-                                },
-                            ],
-                        },
-                    },
-                },
-            },
-            responses: {
-                201: {
-                    description: 'The translation was created.',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                oneOf: [
-                                    { $ref: '#/components/schemas/AppMessages' },
-                                    {
-                                        type: 'array',
-                                        items: {
-                                            $ref: '#/components/schemas/AppMessages',
-                                        },
-                                    },
-                                ],
-                            },
-                        },
-                    },
-                },
-            },
-            security: [{ studio: [] }, { cli: ['apps:write'] }],
-        },
-    },
-    '/api/apps/{appId}/messages/{language}': {
-        parameters: [
-            { $ref: '#/components/parameters/appId' },
-            { $ref: '#/components/parameters/language' },
-            {
-                in: 'query',
-                name: 'merge',
-                description: 'Whether the language’s messages should be merged with its base language.',
-                schema: { type: 'string' },
-            },
-            {
-                in: 'query',
-                name: 'override',
-                description: 'Whether the app’s language overrides should be included and merged.',
-                schema: { type: 'string', default: 'true' },
-            },
-        ],
-        get: {
-            tags: ['language'],
-            description: 'Get the app’s messages for this language.',
-            operationId: 'getMessages',
-            responses: {
-                200: {
-                    description: 'The app messages for the selected language.',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                $ref: '#/components/schemas/AppMessages',
-                            },
-                        },
-                    },
-                },
-            },
-        },
-        delete: {
-            tags: ['language'],
-            description: 'Delete the app’s messages for this language.',
-            operationId: 'deleteMessages',
-            responses: {
-                204: {
-                    description: 'The messages have successfully been deleted.',
-                },
-            },
-            security: [{ studio: [] }],
-        },
-    },
-};
-//# sourceMappingURL=appMessages.js.map

package/api/paths/appOAuth2Secrets.d.ts

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

package/api/paths/appOAuth2Secrets.js

@@ -1,161 +0,0 @@
-export const paths = {
-    '/api/apps/{appId}/secrets/oauth2': {
-        parameters: [{ $ref: '#/components/parameters/appId' }],
-        post: {
-            tags: ['secret'],
-            operationId: 'createAppOAuth2Secret',
-            requestBody: {
-                content: {
-                    'application/json': {
-                        schema: { $ref: '#/components/schemas/AppOAuth2Secret' },
-                    },
-                },
-            },
-            security: [{ studio: [] }, { cli: ['apps:write'] }],
-            responses: {
-                201: {
-                    description: 'A list of the OAuth2 secrets for the app.',
-                    content: {
-                        'application/json': {
-                            schema: { $ref: '#/components/schemas/AppOAuth2Secret' },
-                        },
-                    },
-                },
-            },
-        },
-        get: {
-            tags: ['secret'],
-            operationId: 'getAppOAuth2Secrets',
-            security: [{ studio: [] }],
-            responses: {
-                200: {
-                    description: 'A list of the OAuth2 secrets for the app.',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'array',
-                                items: { $ref: '#/components/schemas/AppOAuth2Secret' },
-                            },
-                        },
-                    },
-                },
-            },
-        },
-        delete: {
-            tags: ['secret'],
-            operationId: 'deleteAppOAuth2Secrets',
-            security: [{ studio: [] }, { cli: ['apps:write'] }],
-            responses: {
-                204: {
-                    description: 'The deleted app OAuth2 secrets.',
-                },
-            },
-        },
-    },
-    '/api/apps/{appId}/secrets/oauth2/{appOAuth2SecretId}': {
-        parameters: [
-            { $ref: '#/components/parameters/appId' },
-            { $ref: '#/components/parameters/appOAuth2SecretId' },
-        ],
-        get: {
-            tags: ['secret'],
-            operationId: 'getAppOAuth2Secret',
-            responses: {
-                200: {
-                    description: `
-            Get a partial app OAuth2 secret
-
-            Only public facing values are output on this endpoint.
-          `,
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'array',
-                                items: { $ref: '#/components/schemas/AppOAuth2Secret' },
-                            },
-                        },
-                    },
-                },
-            },
-        },
-        put: {
-            tags: ['secret'],
-            operationId: 'updateAppOAuth2Secret',
-            requestBody: {
-                content: {
-                    'application/json': {
-                        schema: { $ref: '#/components/schemas/AppOAuth2Secret' },
-                    },
-                },
-            },
-            security: [{ studio: [] }],
-            responses: {
-                200: {
-                    description: 'The updated OAuth2 secret.',
-                    content: {
-                        'application/json': {
-                            schema: { $ref: '#/components/schemas/AppOAuth2Secret' },
-                        },
-                    },
-                },
-            },
-        },
-        delete: {
-            tags: ['secret'],
-            operationId: 'deleteAppOAuth2Secret',
-            security: [{ studio: [] }],
-            responses: {
-                204: {
-                    description: 'The deleted OAuth2 secret.',
-                },
-            },
-        },
-    },
-    '/api/apps/{appId}/secrets/oauth2/{appOAuth2SecretId}/verify': {
-        parameters: [
-            { $ref: '#/components/parameters/appId' },
-            { $ref: '#/components/parameters/appOAuth2SecretId' },
-        ],
-        post: {
-            tags: ['secret'],
-            operationId: 'verifyAppOAuth2SecretCode',
-            security: [{ studio: [] }, {}],
-            requestBody: {
-                content: {
-                    'application/json': {
-                        schema: {
-                            type: 'object',
-                            required: ['code', 'scope', 'redirectUri', 'timezone'],
-                            properties: {
-                                code: { type: 'string' },
-                                scope: { type: 'string' },
-                                redirectUri: { type: 'string' },
-                                zimezone: { type: 'string' },
-                            },
-                        },
-                    },
-                },
-            },
-            responses: {
-                200: {
-                    description: `
-            Get a partial app OAuth2 secret
-
-            Only public facing values are output on this endpoint.
-          `,
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'object',
-                                properties: {
-                                    code: { type: 'string' },
-                                },
-                            },
-                        },
-                    },
-                },
-            },
-        },
-    },
-};
-//# sourceMappingURL=appOAuth2Secrets.js.map

package/api/paths/appQuotas.d.ts

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