@appsemble/lang-sdk 0.33.7

package/schemas/AppDefinition.js

@@ -0,0 +1,126 @@
+import { defaultLocale } from '../constants/locale.js';
+export const AppDefinition = {
+    type: 'object',
+    required: ['name', 'defaultPage', 'pages'],
+    additionalProperties: false,
+    description: 'An app definition describes what an Appsemble app looks like.',
+    properties: {
+        name: {
+            type: 'string',
+            minLength: 1,
+            maxLength: 30,
+            description: `The human readable name of the app.
+
+This will be displayed for example on the home screen or in the browser tab.
+`,
+        },
+        description: {
+            type: 'string',
+            maxLength: 80,
+            description: `A short description describing the app.
+
+This will be displayed on the app store.
+`,
+        },
+        layout: {
+            $ref: '#/components/schemas/AppLayoutDefinition',
+            description: 'Properties related to the layout of the app.',
+        },
+        notifications: {
+            enum: ['login', 'opt-in', 'startup'],
+            description: `The strategy to use for apps to subscribe to push notifications.
+
+If specified, push notifications can be sent to subscribed users via the _Notifications_ tab in the
+app details page in Appsemble Studio. Setting this to \`opt-in\` allows for users to opt into
+receiving push notifications by pressing the subscribe button in the App settings page. Setting this
+to \`startup\` will cause Appsemble to immediately request for the permission upon opening the app.
+If this is set to \`login\`, the app will request permissions for push notification once the user
+logs in.
+
+> **Note**: Setting \`notifications\` to \`startup\` is not recommended, due to its invasive nature.
+`,
+        },
+        defaultPage: {
+            type: 'string',
+            description: `The name of the page that should be displayed when the app is initially loaded.
+
+This **must** match the name of a page defined for the app.
+`,
+        },
+        defaultLanguage: {
+            type: 'string',
+            default: defaultLocale,
+            minLength: 2,
+            description: 'The default language for the app.',
+        },
+        controller: {
+            $ref: '#/components/schemas/ControllerDefinition',
+        },
+        members: {
+            $ref: '#/components/schemas/AppMembersDefinition',
+        },
+        resources: {
+            type: 'object',
+            description: `Resources define how Appsemble can store data for an app.
+
+The most basic resource has a \`schema\` property and defines the minimal security rules.
+`,
+            additionalProperties: {
+                description: 'A single resource definition.',
+                $ref: '#/components/schemas/ResourceDefinition',
+            },
+        },
+        security: {
+            $ref: '#/components/schemas/SecurityDefinition',
+            description: 'Role and guest definitions that may be used by the app.',
+        },
+        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' },
+                ],
+            },
+        },
+        theme: {
+            $ref: '#/components/schemas/Theme',
+        },
+        cron: {
+            type: 'object',
+            minProperties: 1,
+            description: 'A list of cron jobs that are associated with this app.',
+            additionalProperties: { $ref: '#/components/schemas/CronDefinition' },
+        },
+        webhooks: {
+            type: 'object',
+            minProperties: 1,
+            description: 'A list of callable webhooks that are associated with this app.',
+            additionalProperties: { $ref: '#/components/schemas/WebhookDefinition' },
+        },
+        anchors: {
+            type: 'array',
+            minItems: 1,
+            description: 'Helper property that can be used to store YAML anchors.',
+            items: {},
+        },
+        containers: {
+            type: 'array',
+            minItems: 1,
+            additionalProperties: false,
+            description: 'Definition of the companion containers to be created.',
+            items: { $ref: '#/components/schemas/ContainerDefinition' },
+        },
+        registry: {
+            type: 'string',
+            default: null,
+            description: 'The default registry used to pull images for companion containers.',
+        },
+    },
+};
+//# sourceMappingURL=AppDefinition.js.map

package/schemas/AppLayoutDefinition.d.ts

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

package/schemas/AppLayoutDefinition.js

@@ -0,0 +1,59 @@
+export const AppLayoutDefinition = {
+    type: 'object',
+    description: 'The layout definition allows you to tweak several layout elements of the app.',
+    additionalProperties: false,
+    minProperties: 1,
+    properties: {
+        login: {
+            enum: ['navbar', 'navigation', 'hidden'],
+            default: 'navbar',
+            description: 'The location of the login button.',
+        },
+        settings: {
+            enum: ['navbar', 'navigation', 'hidden'],
+            default: 'navbar',
+            description: `The location of the settings button.
+
+If set to \`navigation\`, it will only be visible if \`login\` is also visible in \`navigation\`.
+`,
+        },
+        feedback: {
+            enum: ['navbar', 'navigation', 'hidden'],
+            default: 'navigation',
+            description: `The location of the feedback button.
+
+If set to \`navigation\`, it will only be visible if \`login\` is also visible in \`navigation\`.
+`,
+        },
+        install: {
+            enum: ['navbar', 'navigation', 'hidden'],
+            default: 'navigation',
+            description: `The location of the install button.
+
+If set to \`navigation\`, it will only be visible if \`login\` is also visible in \`navigation\`.
+`,
+        },
+        navigation: {
+            enum: ['bottom', 'left-menu', 'hidden'],
+            default: 'left-menu',
+            description: `The navigation type to use.
+
+If this is omitted, a collapsable side navigation menu will be rendered on the left.
+`,
+        },
+        logo: {
+            type: 'object',
+            description: 'The settings of the app logo.',
+            additionalProperties: false,
+            properties: {
+                position: {
+                    enum: ['navbar', 'hidden'],
+                    default: 'navbar',
+                    description: 'The location of the app logo.',
+                },
+                asset: { type: 'string' },
+            },
+        },
+    },
+};
+//# sourceMappingURL=AppLayoutDefinition.js.map

package/schemas/AppMemberPropertyDefinition.d.ts

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

package/schemas/AppMemberPropertyDefinition.js

@@ -0,0 +1,49 @@
+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/schemas/AppMembersDefinition.d.ts

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

package/schemas/AppMembersDefinition.js

@@ -0,0 +1,17 @@
+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/schemas/ArrayRemapperDefinition.d.ts

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

package/schemas/ArrayRemapperDefinition.js

@@ -0,0 +1,22 @@
+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/schemas/BasePageDefinition.d.ts

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

package/schemas/BasePageDefinition.js

@@ -0,0 +1,92 @@
+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/schemas/BlockDefinition.d.ts

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

package/schemas/BlockDefinition.js

@@ -0,0 +1,94 @@
+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/schemas/ContainerDefinition.d.ts

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

package/schemas/ContainerDefinition.js

@@ -0,0 +1,52 @@
+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/schemas/ContainerPageDefinition.d.ts

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

package/schemas/ContainerPageDefinition.js

@@ -0,0 +1,56 @@
+import { BasePageDefinition } from './BasePageDefinition.js';
+import { extendJSONSchema } from './utils/extendJSONSchema.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/schemas/ControllerDefinition.d.ts

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

package/schemas/ControllerDefinition.js

@@ -0,0 +1,17 @@
+export const ControllerDefinition = {
+    type: 'object',
+    description: 'A controller for application logic.',
+    required: [],
+    additionalProperties: false,
+    properties: {
+        actions: {
+            type: 'object',
+            description: 'A mapping of actions that can be fired by the controller to action handlers.',
+            additionalProperties: {
+                $ref: '#/components/schemas/ActionDefinition',
+            },
+        },
+        events: { $ref: '#/components/schemas/EventsDefinition' },
+    },
+};
+//# sourceMappingURL=ControllerDefinition.js.map

package/schemas/CronDefinition.d.ts

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

package/schemas/CronDefinition.js

@@ -0,0 +1,20 @@
+export const CronDefinition = {
+    type: 'object',
+    required: ['schedule'],
+    description: 'A cron definition defines tasks that Appsemble will run periodically for the app.',
+    additionalProperties: false,
+    properties: {
+        schedule: {
+            description: `A crontab string to define when the action should be run.
+
+See [Crontab guru](https://crontab.guru) for details
+`,
+            type: 'string',
+        },
+        action: {
+            description: 'The action to run when the cronjob is triggered.',
+            $ref: '#/components/schemas/ActionDefinition',
+        },
+    },
+};
+//# sourceMappingURL=CronDefinition.js.map

package/schemas/CustomFontDefinition.d.ts

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