@appsemble/lang-sdk 0.33.7

package/schemas/ResourceDefinition.js

@@ -0,0 +1,263 @@
+const query = {
+    type: 'object',
+    description: 'The query parameters to use in the request.',
+    additionalProperties: { type: 'string' },
+};
+const referenceActionTrigger = {
+    type: 'object',
+    additionalProperties: false,
+    description: 'Defines the type of trigger and the cascading strategy for it',
+    required: ['type'],
+    properties: {
+        type: {
+            enum: ['create', 'update', 'delete'],
+        },
+        cascade: {
+            description: `Defines the cascading strategy.
+
+If 'update' is specified, the referencing property of the referencing resource is set to null.
+
+If 'delete' is specified, the referencing resource is deleted.
+
+If not specified, the referenced resource cannot be deleted
+without deleting the referencing resource first.`,
+            enum: ['update', 'delete'],
+        },
+    },
+};
+const referenceAction = {
+    type: 'object',
+    additionalProperties: false,
+    description: 'Defines what happens when the specified action is executed on the referenced resource.',
+    properties: {
+        triggers: {
+            type: 'array',
+            items: referenceActionTrigger,
+            minItems: 1,
+            uniqueItems: true,
+        },
+    },
+};
+export const ResourceDefinition = {
+    type: 'object',
+    additionalProperties: false,
+    description: 'A definition of how this resource works.',
+    required: ['schema'],
+    properties: {
+        expires: {
+            type: 'string',
+            description: `A time string representing when a resource should expire.
+
+Example: 1d 8h 30m
+`,
+            pattern: /^(\d+(y|yr|years))?\s*(\d+months)?\s*(\d+(w|wk|weeks))?\s*(\d+(d|days))?\s*(\d+(h|hr|hours))?\s*(\d+(m|min|minutes))?\s*(\d+(s|sec|seconds))?$/
+                .source,
+        },
+        clonable: {
+            type: 'boolean',
+            description: 'Whether the resource should be able to be transferred when cloning the app it belongs to',
+        },
+        schema: {
+            $ref: '#/components/schemas/JSONSchemaRoot',
+            description: 'JSON schema definitions that may be used by the app.',
+        },
+        references: {
+            type: 'object',
+            description: `References to other resources.
+
+The key is the property that references the other resource. The value is an object describing the
+name of the resource and how it should behave.
+`,
+            minProperties: 1,
+            additionalProperties: {
+                type: 'object',
+                description: 'A reference to between two resource types.',
+                additionalProperties: false,
+                properties: {
+                    resource: { type: 'string' },
+                    create: referenceAction,
+                    patch: referenceAction,
+                    update: referenceAction,
+                    delete: referenceAction,
+                },
+            },
+        },
+        positioning: {
+            type: 'boolean',
+            default: false,
+            description: 'Whether to enable position column for the instances of this resource. This is used for keeping an ordered list to enable custom sorting of the data using drag and drop features.',
+        },
+        enforceOrderingGroupByFields: {
+            type: 'array',
+            pattern: '^[a-zA-Z0-9]*$',
+            description: 'Group resources by fields when handling resource positions',
+            items: {
+                type: 'string',
+            },
+            minItems: 1,
+        },
+        url: {
+            type: 'string',
+            default: '/api/apps/{appId}/{resource}',
+            description: 'URL to use if not otherwise specified.',
+        },
+        id: {
+            type: 'string',
+            default: 'id',
+            description: 'Name of the field used when accessing singular entities.',
+        },
+        history: {
+            description: 'A definition of how versioning should happen for instances of this resource.',
+            default: false,
+            oneOf: [
+                {
+                    type: 'boolean',
+                    description: 'Setting this to `true` is the same as using an object with the property `data` set to `true`.',
+                },
+                { $ref: '#/components/schemas/ResourceHistoryDefinition' },
+            ],
+        },
+        query: {
+            type: 'object',
+            description: "Overrides for 'query' requests.",
+            additionalProperties: false,
+            properties: {
+                query,
+                method: {
+                    type: 'string',
+                    default: 'GET',
+                    description: 'HTTP method to use for this type of request.',
+                },
+                url: {
+                    type: 'string',
+                    default: '/api/apps/{appId}/{resource}',
+                    description: 'URL to use for this type of request.',
+                },
+            },
+        },
+        get: {
+            type: 'object',
+            description: "Overrides for 'get' requests.",
+            additionalProperties: false,
+            properties: {
+                query,
+                method: {
+                    type: 'string',
+                    default: 'GET',
+                    description: 'HTTP method to use for this type of request.',
+                },
+                url: {
+                    type: 'string',
+                    default: '/api/apps/{appId}/{resource}/{id}',
+                    description: 'URL to use for this type of request.',
+                },
+            },
+        },
+        count: {
+            type: 'object',
+            description: "Overrides for 'count' requests.",
+            additionalProperties: false,
+            properties: {
+                query,
+                method: {
+                    type: 'string',
+                    default: 'GET',
+                    description: 'HTTP method to use for this type of request.',
+                },
+                url: {
+                    type: 'string',
+                    default: '/api/apps/{appId}/{resource}/$count',
+                    description: 'URL to use for this type of request.',
+                },
+            },
+        },
+        create: {
+            type: 'object',
+            description: "Overrides for 'create' requests.",
+            additionalProperties: false,
+            properties: {
+                query,
+                method: {
+                    type: 'string',
+                    default: 'POST',
+                    description: 'HTTP method to use for this type of request.',
+                },
+                url: {
+                    type: 'string',
+                    default: '/api/apps/{appId}/{resource}/{id}',
+                    description: 'URL to use for this type of request.',
+                },
+                hooks: {
+                    $ref: '#/components/schemas/ResourceHooksDefinition',
+                },
+            },
+        },
+        patch: {
+            type: 'object',
+            description: "Overrides for 'patch' requests.",
+            additionalProperties: false,
+            properties: {
+                query,
+                method: {
+                    type: 'string',
+                    default: 'PATCH',
+                    description: 'HTTP method to use for this type of request.',
+                },
+                url: {
+                    type: 'string',
+                    default: '/api/apps/{appId}/{resource}/{id}',
+                    description: 'URL to use for this type of request.',
+                },
+                hooks: {
+                    $ref: '#/components/schemas/ResourceHooksDefinition',
+                },
+            },
+        },
+        update: {
+            type: 'object',
+            description: "Overrides for 'update' requests.",
+            additionalProperties: false,
+            properties: {
+                query,
+                method: {
+                    type: 'string',
+                    default: 'PUT',
+                    description: 'HTTP method to use for this type of request.',
+                },
+                url: {
+                    type: 'string',
+                    default: '/api/apps/{appId}/{resource}/{id}',
+                    description: 'URL to use for this type of request.',
+                },
+                hooks: {
+                    $ref: '#/components/schemas/ResourceHooksDefinition',
+                },
+            },
+        },
+        delete: {
+            type: 'object',
+            description: "Overrides for 'delete' requests.",
+            additionalProperties: false,
+            properties: {
+                query,
+                method: {
+                    type: 'string',
+                    default: 'DELETE',
+                    description: 'HTTP method to use for this type of request.',
+                },
+                url: {
+                    type: 'string',
+                    default: '/api/apps/{appId}/{resource}/{id}',
+                    description: 'URL to use for this type of request.',
+                },
+                hooks: {
+                    $ref: '#/components/schemas/ResourceHooksDefinition',
+                },
+            },
+        },
+        views: {
+            $ref: '#/components/schemas/ResourceViewDefinition',
+        },
+    },
+};
+//# sourceMappingURL=ResourceDefinition.js.map

package/schemas/ResourceHistoryDefinition.d.ts

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

package/schemas/ResourceHistoryDefinition.js

@@ -0,0 +1,14 @@
+export const ResourceHistoryDefinition = {
+    type: 'object',
+    additionalProperties: false,
+    description: 'A definition of how versioning works for instances of this resource',
+    required: ['data'],
+    properties: {
+        data: {
+            type: 'boolean',
+            default: true,
+            description: 'If set to `false`, edits are still tracked, but exactly what changed is lost.',
+        },
+    },
+};
+//# sourceMappingURL=ResourceHistoryDefinition.js.map

package/schemas/ResourceHooksDefinition.d.ts

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

package/schemas/ResourceHooksDefinition.js

@@ -0,0 +1,10 @@
+export const ResourceHooksDefinition = {
+    type: 'object',
+    description: 'Hooks that are triggered upon calling a resource action.',
+    additionalProperties: false,
+    minProperties: 1,
+    properties: {
+        notification: { $ref: '#/components/schemas/NotificationHookDefinition' },
+    },
+};
+//# sourceMappingURL=ResourceHooksDefinition.js.map

package/schemas/ResourceViewDefinition.d.ts

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

package/schemas/ResourceViewDefinition.js

@@ -0,0 +1,24 @@
+export const ResourceViewDefinition = {
+    type: 'object',
+    minProperties: 1,
+    description: 'Alternative views of a resource that are modified using remappers and support different sets of roles.',
+    additionalProperties: {
+        type: 'object',
+        additionalProperties: false,
+        description: 'A custom view for a resource.',
+        properties: {
+            roles: {
+                type: 'array',
+                description: 'The list of roles that are allowed to use this view.',
+                items: {
+                    type: 'string',
+                },
+            },
+            remap: {
+                $ref: '#/components/schemas/RemapperDefinition',
+                description: 'The modified view.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=ResourceViewDefinition.js.map

package/schemas/SecurityCronDefinition.d.ts

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

package/schemas/SecurityCronDefinition.js

@@ -0,0 +1,26 @@
+export const SecurityCronDefinition = {
+    type: 'object',
+    description: 'This describes the permissions that unauthenticated users have.',
+    additionalProperties: false,
+    properties: {
+        inherits: {
+            type: 'array',
+            minItems: 1,
+            description: `The name of the role to inherit from.
+
+Note that this role must exist.
+`,
+            items: {
+                type: 'string',
+            },
+        },
+        permissions: {
+            type: 'array',
+            description: 'Specific permissions within the app, which unauthenticated users should have',
+            items: {
+                type: 'string',
+            },
+        },
+    },
+};
+//# sourceMappingURL=SecurityCronDefinition.js.map

package/schemas/SecurityDefaultDefinition.d.ts

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

package/schemas/SecurityDefaultDefinition.js

@@ -0,0 +1,34 @@
+export const SecurityDefaultDefinition = {
+    type: 'object',
+    required: ['role'],
+    description: 'The default role to apply to members.',
+    additionalProperties: false,
+    properties: {
+        policy: {
+            enum: ['everyone', 'organization', 'invite'],
+            default: 'everyone',
+            description: `How the \`default\` role gets applied to users.
+
+The following values are allowed:
+- \`everyone\`: Every authenticated user gets the default role.
+- \`organization\`: Every authenticated user gets the default role if they are in the same organization as the app.
+- \`invite\`: The app member has to be invited to the app with a specific role.
+
+> **Important**: When [OAuth2](../guides/oauth2) or [SAML2.0](../guides/saml) is used in the
+> app, you must set the policy to \`everyone\`. This will specifically allow every configured
+> authentication method on the secrets page to be used as login method. If you do not want other
+> Appsemble user accounts to be able to log in, you must \`disable\` the \`appsemble login\` options
+> (including the Appsemble OAuth2 option) in the secrets page. If this option is enabled, any
+> Appsemble user account is able to log in to the app and will receive the default role.
+`,
+        },
+        role: {
+            type: 'string',
+            description: `The default role to apply to members.
+
+This must match with one of the roles defined within the security definition.
+`,
+        },
+    },
+};
+//# sourceMappingURL=SecurityDefaultDefinition.js.map

package/schemas/SecurityDefinition.d.ts

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

package/schemas/SecurityDefinition.js

@@ -0,0 +1,17 @@
+export const SecurityDefinition = {
+    type: 'object',
+    description: 'This describes how the app is secured.',
+    additionalProperties: false,
+    properties: {
+        default: { $ref: '#/components/schemas/SecurityDefaultDefinition' },
+        guest: { $ref: '#/components/schemas/SecurityGuestDefinition' },
+        cron: { $ref: '#/components/schemas/SecurityCronDefinition' },
+        roles: {
+            type: 'object',
+            description: 'This property defines the app roles that are available within the app.',
+            minProperties: 1,
+            additionalProperties: { $ref: '#/components/schemas/SecurityRoleDefinition' },
+        },
+    },
+};
+//# sourceMappingURL=SecurityDefinition.js.map

package/schemas/SecurityGuestDefinition.d.ts

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

package/schemas/SecurityGuestDefinition.js

@@ -0,0 +1,26 @@
+export const SecurityGuestDefinition = {
+    type: 'object',
+    description: 'This describes the permissions that unauthenticated users have.',
+    additionalProperties: false,
+    properties: {
+        inherits: {
+            type: 'array',
+            minItems: 1,
+            description: `The name of the role to inherit from.
+
+Note that this role must exist.
+`,
+            items: {
+                type: 'string',
+            },
+        },
+        permissions: {
+            type: 'array',
+            description: 'Specific permissions within the app, which unauthenticated users should have',
+            items: {
+                type: 'string',
+            },
+        },
+    },
+};
+//# sourceMappingURL=SecurityGuestDefinition.js.map

package/schemas/SecurityRoleDefinition.d.ts

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

package/schemas/SecurityRoleDefinition.js

@@ -0,0 +1,35 @@
+export const SecurityRoleDefinition = {
+    type: 'object',
+    description: 'This describes a security role.',
+    additionalProperties: false,
+    properties: {
+        description: {
+            type: 'string',
+            description: 'The description of the role.',
+        },
+        defaultPage: {
+            type: 'string',
+            description: 'The default page to redirect users with this role to.',
+        },
+        inherits: {
+            type: 'array',
+            minItems: 1,
+            description: `The name of the role to inherit from.
+
+Note that this role must exist and can not inherit itself via this field or the \`inherits\` field
+of the referenced role.
+`,
+            items: {
+                type: 'string',
+            },
+        },
+        permissions: {
+            type: 'array',
+            description: 'Specific permissions within the app, which this role should have',
+            items: {
+                type: 'string',
+            },
+        },
+    },
+};
+//# sourceMappingURL=SecurityRoleDefinition.js.map

package/schemas/SubPage.d.ts

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

package/schemas/SubPage.js

@@ -0,0 +1,36 @@
+export const SubPage = {
+    type: 'object',
+    description: 'This describes what a sub page will look like in the app.',
+    required: ['blocks'],
+    additionalProperties: false,
+    properties: {
+        name: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The name of the sub page.',
+        },
+        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',
+            },
+        },
+        blocks: {
+            type: 'array',
+            minItems: 1,
+            description: 'The blocks that make up a page.',
+            items: {
+                $ref: '#/components/schemas/BlockDefinition',
+            },
+        },
+    },
+};
+//# sourceMappingURL=SubPage.js.map

package/schemas/TabsPageDefinition.d.ts

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

package/schemas/TabsPageDefinition.js

@@ -0,0 +1,46 @@
+import { BasePageDefinition } from './BasePageDefinition.js';
+import { extendJSONSchema } from './utils/extendJSONSchema.js';
+export const TabsPageDefinition = extendJSONSchema(BasePageDefinition, {
+    type: 'object',
+    description: 'Shows a set of subpages as tabs at the top of the page.',
+    oneOf: [
+        {
+            required: ['type', 'tabs'],
+        },
+        {
+            required: ['type', 'definition'],
+        },
+    ],
+    additionalProperties: true,
+    properties: {
+        type: {
+            enum: ['tabs'],
+        },
+        tabs: {
+            type: 'array',
+            minItems: 1,
+            description: 'Each of the available tabs for the tabs page.',
+            items: {
+                $ref: '#/components/schemas/SubPage',
+            },
+        },
+        definition: {
+            type: 'object',
+            additionalProperties: false,
+            description: 'Generate tabs dynamically',
+            required: ['events', 'foreach'],
+            properties: {
+                events: {
+                    $ref: '#/components/schemas/EventsDefinition',
+                },
+                foreach: {
+                    $ref: '#/components/schemas/SubPage',
+                },
+            },
+        },
+        actions: {
+            $ref: '#/components/schemas/PageActionsDefinition',
+        },
+    },
+});
+//# sourceMappingURL=TabsPageDefinition.js.map

package/schemas/Theme.d.ts

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

package/schemas/Theme.js

@@ -0,0 +1,81 @@
+import { baseTheme } from '../constants/baseTheme.js';
+import { hexColor } from '../constants/patterns.js';
+export const Theme = {
+    type: 'object',
+    description: 'A generic theme definition.',
+    additionalProperties: false,
+    minProperties: 1,
+    properties: {
+        themeColor: {
+            type: 'string',
+            pattern: hexColor.source,
+            default: baseTheme.themeColor,
+            description: `The generic theme color of the app.
+
+This is used for example in the URL bar on Android.
+`,
+        },
+        splashColor: {
+            type: 'string',
+            pattern: hexColor.source,
+            default: baseTheme.splashColor,
+            description: `The background color of the PWA splash screen.
+
+This defaults to the theme color.
+`,
+        },
+        primaryColor: {
+            type: 'string',
+            pattern: hexColor.source,
+            default: baseTheme.primaryColor,
+            description: `The primary color used within the app.
+
+This is used in various elements like the navbar.
+`,
+        },
+        linkColor: {
+            type: 'string',
+            pattern: hexColor.source,
+            default: baseTheme.linkColor,
+            description: 'The color used for links.',
+        },
+        infoColor: {
+            type: 'string',
+            pattern: hexColor.source,
+            default: baseTheme.infoColor,
+            description: 'The color used for informational messages.',
+        },
+        successColor: {
+            type: 'string',
+            pattern: hexColor.source,
+            default: baseTheme.successColor,
+            description: 'The color used for successful actions.',
+        },
+        warningColor: {
+            type: 'string',
+            pattern: hexColor.source,
+            default: baseTheme.warningColor,
+            description: 'The color used for warning messages.',
+        },
+        dangerColor: {
+            type: 'string',
+            pattern: hexColor.source,
+            default: baseTheme.dangerColor,
+            description: 'The color used for error messages.',
+        },
+        tileLayer: {
+            type: 'string',
+            format: 'uri',
+            default: baseTheme.tileLayer,
+            description: 'The tileLayer to use for Leaflet maps.',
+        },
+        font: {
+            description: 'The font to use in the app.',
+            anyOf: [
+                { $ref: '#/components/schemas/CustomFontDefinition' },
+                { $ref: '#/components/schemas/GoogleFontDefinition' },
+            ],
+        },
+    },
+};
+//# sourceMappingURL=Theme.js.map

package/schemas/WebhookDefinition.d.ts

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