@appsemble/utils 0.33.5 → 0.33.9

package/api/components/schemas/AppMemberPropertiesPatchActionDefinition.js

@@ -1,26 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const AppMemberPropertiesPatchActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'sub'],
-    properties: {
-        type: {
-            enum: ['app.member.properties.patch'],
-            description: `Allows the app member to patch the properties of another app member account.
-
-Does nothing if the app member isn’t logged in.`,
-        },
-        sub: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The new full name name of the app member.',
-        },
-        properties: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: `The updated custom properties for the app member.
-
-Values will be validated based on \`members.properties\`, if defined in the app definition.`,
-        },
-    },
-});
-//# sourceMappingURL=AppMemberPropertiesPatchActionDefinition.js.map

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

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

package/api/components/schemas/AppMemberPropertyDefinition.js

@@ -1,49 +0,0 @@
-export const AppMemberPropertyDefinition = {
-    anyOf: [
-        {
-            type: 'object',
-            description: 'Definition for an app member custom property.',
-            required: ['schema'],
-            additionalProperties: false,
-            properties: {
-                schema: {
-                    anyOf: [
-                        { $ref: '#/components/schemas/JSONSchemaInteger' },
-                        { $ref: '#/components/schemas/JSONSchemaArray' },
-                    ],
-                },
-                reference: {
-                    type: 'object',
-                    additionalProperties: false,
-                    description: 'The object for the reference to another resource',
-                    properties: {
-                        resource: {
-                            type: 'string',
-                            description: 'The resource referenced by this app member property.',
-                        },
-                    },
-                },
-            },
-        },
-        {
-            type: 'object',
-            description: 'Definition for an app member property.',
-            required: ['schema'],
-            additionalProperties: false,
-            properties: {
-                schema: {
-                    anyOf: [
-                        { $ref: '#/components/schemas/JSONSchemaInteger' },
-                        { $ref: '#/components/schemas/JSONSchemaArray' },
-                        { $ref: '#/components/schemas/JSONSchemaString' },
-                        { $ref: '#/components/schemas/JSONSchemaNumber' },
-                        { $ref: '#/components/schemas/JSONSchemaEnum' },
-                        { $ref: '#/components/schemas/JSONSchemaBoolean' },
-                        { $ref: '#/components/schemas/JSONSchemaObject' },
-                    ],
-                },
-            },
-        },
-    ],
-};
-//# sourceMappingURL=AppMemberPropertyDefinition.js.map

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

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

package/api/components/schemas/AppMemberQueryActionDefinition.js

@@ -1,24 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const AppMemberQueryActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type'],
-    properties: {
-        type: {
-            enum: ['app.member.query'],
-            description: `Allows the currently logged in app member to fetch a list of app members by their roles.
-
-Does nothing if the app member isn’t logged in.`,
-        },
-        roles: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The roles of the app members that would be fetched.',
-        },
-        query: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'Additional filters to fetch members based on properties and other fields',
-        },
-    },
-});
-//# sourceMappingURL=AppMemberQueryActionDefinition.js.map

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

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

package/api/components/schemas/AppMemberRegisterActionDefinition.js

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

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

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

package/api/components/schemas/AppMemberRoleUpdateActionDefinition.js

@@ -1,27 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const AppMemberRoleUpdateActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'sub'],
-    properties: {
-        type: {
-            enum: ['app.member.role.update'],
-            description: `Allows the app member to update the role of another app member account.
-
-Does nothing if the app member isn’t logged in.`,
-        },
-        sub: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The id of the app member.',
-        },
-        role: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: `The updated role of the app member.
-
-The role must exist in the roles property of the app's security definition or in the predefined app roles in the system -
-\`Member\`, \`MembersManager\`, \`GroupMembersManager\`, \`GroupsManager\`, \`ResourcesManager\` and \`Owner\``,
-        },
-    },
-});
-//# sourceMappingURL=AppMemberRoleUpdateActionDefinition.js.map

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

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

package/api/components/schemas/AppMembersDefinition.js

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

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

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

package/api/components/schemas/ArrayRemapperDefinition.js

@@ -1,22 +0,0 @@
-export const ArrayRemapperDefinition = {
-    type: 'array',
-    description: `If a remapper is an array, it represents a chain of remappers.
-
-Each item represents a remapper which is called with the result of the remapper before it.
-
-If an array is nested, it will be flattened. This allows you to create reusable remappers and
-reference them using YAML anchors.
-`,
-    minItems: 1,
-    items: {
-        anyOf: [
-            {
-                $ref: '#/components/schemas/ObjectRemapperDefinition',
-            },
-            {
-                $ref: '#/components/schemas/ArrayRemapperDefinition',
-            },
-        ],
-    },
-};
-//# sourceMappingURL=ArrayRemapperDefinition.js.map

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

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

package/api/components/schemas/BaseActionDefinition.js

@@ -1,10 +0,0 @@
-export const BaseActionDefinition = {
-    type: 'object',
-    properties: {
-        remapBefore: {},
-        remapAfter: {},
-        onSuccess: {},
-        onError: {},
-    },
-};
-//# sourceMappingURL=BaseActionDefinition.js.map

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

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

package/api/components/schemas/BaseJSONSchema.js

@@ -1,24 +0,0 @@
-export const BaseJSONSchema = {
-    type: 'object',
-    properties: {
-        title: {
-            type: 'string',
-            minLength: 1,
-            maxLength: 50,
-            description: `A short title of the instance.
-
-This is used in various places inside Appsemble Studio.
-`,
-        },
-        description: {
-            type: 'string',
-            minLength: 1,
-            maxLength: 5000,
-            description: `A description of the instance.
-
-This is used in various places inside Appsemble Studio.
-`,
-        },
-    },
-};
-//# sourceMappingURL=BaseJSONSchema.js.map

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

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

package/api/components/schemas/BasePageDefinition.js

@@ -1,92 +0,0 @@
-export const BasePageDefinition = {
-    type: 'object',
-    additionalProperties: false,
-    required: ['name'],
-    properties: {
-        name: {
-            type: 'string',
-            maxLength: 50,
-            description: `The name of an app.
-
-This field is always required and must be unique within the app, meaning that it is not possible to
-have two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.
-
-> **Note**: The URL used to navigate to pages is determined by this property.
-`,
-        },
-        hideName: {
-            type: 'boolean',
-            description: 'Whether or not the page name should be displayed in the *app bar*.',
-        },
-        navTitle: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: `The name of the page when displayed in the navigation menu.
-
-  Context property \`name\` can be used to access the name of the page.
-  `,
-        },
-        hideNavTitle: {
-            type: 'boolean',
-            description: `Whether or not the page should be displayed in navigational menus.
-
-  By default all pages without parameters are added to navigational menus. Set to \`true\` to hide the
-  page from menus.
-  `,
-            default: false,
-        },
-        navigation: {
-            $ref: '#/components/schemas/AppLayoutDefinition/properties/navigation',
-            description: `The type of navigation displayed on the page.
-
-This overrides the navigation property of the app itself. Defaults to \`left-menu\` if navigation or
-App navigation are not set.
-
-Set to \`bottom\` to use a navigation pane at the bottom of the screen instead of the default side
-menu. Set to \`hidden\` to display no navigational menus at all.
-`,
-        },
-        icon: {
-            type: 'string',
-            description: `An optional icon from the fontawesome icon set
-
-This will be displayed in the navigation menu.
-`,
-        },
-        parameters: {
-            type: 'array',
-            description: `Page parameters can be used for linking to a page that should display a single resource.
-
-This defined as a list of strings representing the properties to pass through. More often than not
-passing \`id\` through is sufficient, depending on the block.
-`,
-            items: {
-                type: 'string',
-                minLength: 1,
-                maxLength: 30,
-            },
-        },
-        roles: {
-            type: 'array',
-            description: `The list of roles that are allowed to view this page.
-
-If the user doesn’t have any of the roles in the list the page will be unavailable to them. An empty
-list can be used to specify that users need to log in but do not need a specific role.
-
-Users trying to visit a page without having the correct roles will be redirected to the first page
-that they are allowed to view. If there aren’t any accessible pages, the user will be logged out and
-instructed to contact the app owner to get permissions.
-`,
-            items: {
-                type: 'string',
-            },
-        },
-        theme: {
-            $ref: '#/components/schemas/Theme',
-        },
-        badgeCount: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'A Remapper that resolves to a number to be visibile in the side-menu.',
-        },
-    },
-};
-//# sourceMappingURL=BasePageDefinition.js.map

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

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

package/api/components/schemas/BlockDefinition.js

@@ -1,94 +0,0 @@
-import { partialNormalized, semver } from '../../../constants/index.js';
-export const BlockDefinition = {
-    type: 'object',
-    description: 'A block that is displayed on a page.',
-    required: ['type', 'version'],
-    additionalProperties: false,
-    properties: {
-        theme: {
-            $ref: '#/components/schemas/Theme',
-        },
-        type: {
-            type: 'string',
-            pattern: `^(@${partialNormalized.source}/)?${partialNormalized.source}$`,
-            description: `The type of the block.
-
-A block type follows the format \`@organization/name\`. If the organization is _appsemble_, it may
-be omitted.
-
-Some examples:
-
-- \`form\`
-- \`@amsterdam/splash\`
-`,
-        },
-        version: {
-            type: 'string',
-            pattern: semver.source,
-            description: `The version of the block to use.
-
-Since blocks may change over time, a version must be specified in order to ensure that the block
-will remain the same until it is manually updated.
-`,
-        },
-        layout: {
-            description: `An override of the block’s default layout.
-
-\`float\` sets the block position to float on the page and does not collide with other blocks.
-Layout float can be combined with the \`position\` property to place the block on the desired location.
-\`grow\` adds space between blocks so the page is filled.
-\`static\` on the contrary, does not add extra space between blocks.
-`,
-            enum: ['float', 'grow', 'static'],
-        },
-        hide: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'Whether to render the block or not',
-        },
-        header: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'An optional header to render above the block.',
-        },
-        roles: {
-            type: 'array',
-            description: `The list of roles that are allowed to view this block.
-
-If a user does not have the right role, the block is not rendered.
-`,
-            items: {
-                type: 'string',
-            },
-        },
-        position: {
-            description: 'For floating blocks this property defines where the block should float.',
-            default: 'bottom right',
-            enum: [
-                'top left',
-                'top',
-                'top right',
-                'left',
-                'right',
-                'bottom left',
-                'bottom',
-                'bottom right',
-            ],
-        },
-        parameters: {
-            type: 'object',
-            description: `A free form mapping of named parameters.
-
-The exact meaning of the parameters depends on the block type.
-`,
-            additionalProperties: true,
-        },
-        actions: {
-            type: 'object',
-            description: 'A mapping of actions that can be fired by the block to action handlers.',
-            additionalProperties: {
-                $ref: '#/components/schemas/ActionDefinition',
-            },
-        },
-        events: { $ref: '#/components/schemas/EventsDefinition' },
-    },
-};
-//# sourceMappingURL=BlockDefinition.js.map

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

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

package/api/components/schemas/ConditionActionDefinition.js

@@ -1,30 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const ConditionActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'if'],
-    properties: {
-        type: {
-            enum: ['condition'],
-            description: 'Run another action if a certain contition is met.',
-        },
-        if: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: `A remapper to determine the condition to check.
-
-If this yields a truthy value, the \`then\` action is called. Otherwise the \`else\` action is
-called.
-`,
-        },
-        then: {
-            description: 'This action is called if the `if` remapper yields a truthy value.',
-            $ref: '#/components/schemas/ActionDefinition',
-        },
-        else: {
-            description: 'This action is called if the `if` remapper yields a falsy value.',
-            $ref: '#/components/schemas/ActionDefinition',
-        },
-    },
-});
-//# sourceMappingURL=ConditionActionDefinition.js.map

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

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

package/api/components/schemas/ContainerDefinition.js

@@ -1,52 +0,0 @@
-export const ContainerDefinition = {
-    type: 'object',
-    additionalProperties: false,
-    description: 'An object describing a companion container',
-    required: ['name', 'image', 'port'],
-    properties: {
-        name: {
-            type: 'string',
-            description: 'Alias used to reference the container',
-        },
-        image: {
-            type: 'string',
-            description: 'Name of the image used for the container',
-        },
-        port: {
-            type: 'number',
-            description: 'Port used by the image provided',
-        },
-        resources: {
-            type: 'object',
-            additionalProperties: true,
-            description: 'Maximum amount of resources the container can use. Deafult: 1 CPU and 512Mi memory',
-        },
-        env: {
-            type: 'array',
-            description: 'Environment variables that will be used within the container',
-            items: {
-                type: 'object',
-                additionalProperties: false,
-                description: 'Each item is an environment variable. `useValueFromSecret` property determines whether the value is taken literally or from and existing secret',
-                required: ['name', 'value'],
-                properties: {
-                    name: { type: 'string', description: 'Name of the environment variable' },
-                    useValueFromSecret: {
-                        type: 'boolean',
-                        description: 'If set to true, will retrieve the value from the Kubernetes secret, the value property will refer to the secret key. If false, will take the value literally',
-                    },
-                    value: {
-                        type: 'string',
-                        description: "The value of the environment variable. If `useValueFromSecret` is true, this property will refer to the Kubernetes secret's key",
-                    },
-                },
-            },
-        },
-        metadata: {
-            type: 'object',
-            additionalProperties: true,
-            description: 'Metadata including labels and annotations to be added to the container',
-        },
-    },
-};
-//# sourceMappingURL=ContainerDefinition.js.map

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

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

package/api/components/schemas/ContainerPageDefinition.js

@@ -1,56 +0,0 @@
-import { BasePageDefinition } from './BasePageDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const ContainerPageDefinition = extendJSONSchema(BasePageDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    description: `Groups pages together under a collapsible parent page. Following is an example of
-how this can be used:
-\`\`\`yaml
-pages:
-  - name: Page 1
-    type: container
-    pages:
-      - name: Contained page 1
-        blocks:
-          - type: action-button
-            version: 0.29.8
-            parameters:
-              icon: git-alt
-            actions:
-              onClick:
-                type: link
-                to: Contained page 2
-      - name: Contained page 2
-        blocks:
-          - type: action-button
-            version: 0.29.8
-            parameters:
-              icon: git-alt
-            actions:
-              onClick:
-                type: link
-                to: Contained page 1
-\`\`\`
-`,
-    required: ['type', 'pages'],
-    properties: {
-        type: {
-            enum: ['container'],
-        },
-        pages: {
-            type: 'array',
-            minItems: 1,
-            description: 'The pages of the app.',
-            items: {
-                anyOf: [
-                    { $ref: '#/components/schemas/PageDefinition' },
-                    { $ref: '#/components/schemas/TabsPageDefinition' },
-                    { $ref: '#/components/schemas/FlowPageDefinition' },
-                    { $ref: '#/components/schemas/LoopPageDefinition' },
-                    { $ref: '#/components/schemas/ContainerPageDefinition' },
-                ],
-            },
-        },
-    },
-});
-//# sourceMappingURL=ContainerPageDefinition.js.map

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

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

package/api/components/schemas/ControllerActionDefinition.js

@@ -1,18 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const ControllerActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'handler'],
-    properties: {
-        type: {
-            enum: ['controller'],
-            description: 'Use the controller to handle the action.',
-        },
-        handler: {
-            type: 'string',
-            description: 'The name of the function in the controller that will handle the action',
-        },
-    },
-});
-//# sourceMappingURL=ControllerActionDefinition.js.map

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

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