@appsemble/lang-sdk 0.33.7

package/schemas/CustomFontDefinition.js

@@ -0,0 +1,20 @@
+export const CustomFontDefinition = {
+    type: 'object',
+    description: 'A custom font definition.',
+    additionalProperties: false,
+    required: ['source', 'family'],
+    properties: {
+        source: {
+            description: 'Use a custom font.',
+            enum: ['custom'],
+        },
+        family: {
+            type: 'string',
+            description: `The font family to use in the app.
+
+Make sure the font is available using custom CSS.
+`,
+        },
+    },
+};
+//# sourceMappingURL=CustomFontDefinition.js.map

package/schemas/EventsDefinition.d.ts

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

package/schemas/EventsDefinition.js

@@ -0,0 +1,29 @@
+export const EventsDefinition = {
+    type: 'object',
+    description: 'An object describing the names of the events the block can listen and emit to.',
+    additionalProperties: false,
+    minProperties: 1,
+    properties: {
+        listen: {
+            type: 'object',
+            description: `This property defines the events this block will listen on.
+
+The key is the name of the event will listen on. The value is a user defined event name which should
+match the name of an emitted event on the same page.
+`,
+            minProperties: 1,
+            additionalProperties: { type: 'string' },
+        },
+        emit: {
+            type: 'object',
+            description: `This property defines the events this block will emit.
+
+The key is the name of the event will emit. The value is a user defined event name which should
+match the name of a event on the same page that’s being listened on.
+`,
+            minProperties: 1,
+            additionalProperties: { type: 'string' },
+        },
+    },
+};
+//# sourceMappingURL=EventsDefinition.js.map

package/schemas/FilterParametersDefinition.d.ts

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

package/schemas/FilterParametersDefinition.js

@@ -0,0 +1,15 @@
+export const FilterParametersDefinition = {
+    type: 'object',
+    description: 'An object describing the comparison that should be applied to the key in an OData filter.',
+    additionalProperties: false,
+    properties: {
+        type: {
+            enum: ['Boolean', 'String', 'Number', 'Date', 'Guid'],
+        },
+        value: { $ref: '#/components/schemas/RemapperDefinition' },
+        comparator: {
+            enum: ['eq', 'ge', 'gt', 'le', 'lt', 'ne'],
+        },
+    },
+};
+//# sourceMappingURL=FilterParametersDefinition.js.map

package/schemas/FlowPageActionsDefinition.d.ts

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

package/schemas/FlowPageActionsDefinition.js

@@ -0,0 +1,23 @@
+export const FlowPageActionsDefinition = {
+    type: 'object',
+    description: 'These actions are fired on a flow page.',
+    additionalProperties: false,
+    properties: {
+        onFlowCancel: {
+            $ref: '#/components/schemas/ActionDefinition',
+            description: 'This action gets triggered when `flow.cancel` gets called.',
+        },
+        onFlowFinish: {
+            $ref: '#/components/schemas/ActionDefinition',
+            description: `This action gets triggered when a flow is finished.
+
+A flow is finished when \`flow.finish\` gets called, or when \`flow.next\` gets called on the final
+subpage. This action has a special property in which the cumulative input data from each previous subpage gets sent, instead of the individual block that triggered this action.`,
+        },
+        onLoad: {
+            $ref: '#/components/schemas/ActionDefinition',
+            description: 'This action is fired when a page loads, highly helpful in loading data for the page',
+        },
+    },
+};
+//# sourceMappingURL=FlowPageActionsDefinition.js.map

package/schemas/FlowPageDefinition.d.ts

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

package/schemas/FlowPageDefinition.js

@@ -0,0 +1,37 @@
+import { BasePageDefinition } from './BasePageDefinition.js';
+import { extendJSONSchema } from './utils/extendJSONSchema.js';
+export const FlowPageDefinition = extendJSONSchema(BasePageDefinition, {
+    type: 'object',
+    description: 'Shows a set of sub pages in a certain order which the user can navigate through.',
+    required: ['type', 'steps'],
+    additionalProperties: false,
+    properties: {
+        type: {
+            enum: ['flow'],
+        },
+        steps: {
+            type: 'array',
+            minItems: 2,
+            description: "Steps belonging to this page's flow.",
+            items: {
+                $ref: '#/components/schemas/SubPage',
+            },
+        },
+        actions: {
+            $ref: '#/components/schemas/FlowPageActionsDefinition',
+        },
+        progress: {
+            description: 'The method that should be used to display the status of flow pages.',
+            enum: ['corner-dots', 'hidden'],
+        },
+        retainFlowData: {
+            type: 'boolean',
+            description: `Whether to retain the flow data when navigating away to another page outside the flow.
+
+By default the flow page retains it's data after navigating once. Set to false to clear it.
+`,
+            default: true,
+        },
+    },
+});
+//# sourceMappingURL=FlowPageDefinition.js.map

package/schemas/GoogleFontDefinition.d.ts

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

package/schemas/GoogleFontDefinition.js

@@ -0,0 +1,22 @@
+import { baseTheme, googleFonts } from '../constants/index.js';
+export const GoogleFontDefinition = {
+    type: 'object',
+    description: 'A Google font definition.',
+    additionalProperties: false,
+    required: ['family'],
+    properties: {
+        source: {
+            description: 'Use a font from [Google Fonts](https://fonts.google.com).',
+            enum: ['google'],
+        },
+        family: {
+            enum: googleFonts,
+            description: `The font to use in the app.
+
+Any font available on [Google Fonts](https://fonts.google.com) may be used.
+`,
+            default: baseTheme.font,
+        },
+    },
+};
+//# sourceMappingURL=GoogleFontDefinition.js.map

package/schemas/LoopPageActionsDefinition.d.ts

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

package/schemas/LoopPageActionsDefinition.js

@@ -0,0 +1,24 @@
+export const LoopPageActionsDefinition = {
+    type: 'object',
+    description: 'These actions are fired on a loop page.',
+    required: ['onLoad'],
+    additionalProperties: false,
+    properties: {
+        onLoad: {
+            $ref: '#/components/schemas/ActionDefinition',
+            description: 'This action is used to define the data to pass onto the loop type array',
+        },
+        onFlowCancel: {
+            $ref: '#/components/schemas/ActionDefinition',
+            description: 'This action gets triggered when `flow.cancel` gets called.',
+        },
+        onFlowFinish: {
+            $ref: '#/components/schemas/ActionDefinition',
+            description: `This action gets triggered when a flow is finished.
+
+A flow is finished when \`flow.finish\` gets called, or when \`flow.next\` gets called on the final
+subpage. This action has a special property in which the cumulative input data from each previous subpage gets sent, instead of the individual block that triggered this action.`,
+        },
+    },
+};
+//# sourceMappingURL=LoopPageActionsDefinition.js.map

package/schemas/LoopPageDefinition.d.ts

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

package/schemas/LoopPageDefinition.js

@@ -0,0 +1,32 @@
+import { BasePageDefinition } from './BasePageDefinition.js';
+import { extendJSONSchema } from './utils/extendJSONSchema.js';
+export const LoopPageDefinition = extendJSONSchema(BasePageDefinition, {
+    type: 'object',
+    description: 'Generates sub pages dynamically based on data and display in a flow page.',
+    required: ['type', 'foreach', 'actions'],
+    additionalProperties: false,
+    properties: {
+        type: {
+            enum: ['loop'],
+        },
+        actions: {
+            $ref: '#/components/schemas/LoopPageActionsDefinition',
+        },
+        foreach: {
+            $ref: '#/components/schemas/SubPage',
+        },
+        progress: {
+            description: 'The method that should be used to display the status of flow pages.',
+            enum: ['corner-dots', 'hidden'],
+        },
+        retainFlowData: {
+            type: 'boolean',
+            description: `Whether to retain the flow data when navigating away to another page outside the flow.
+
+By default the flow page retains it's data after navigating once. Set to false to clear it.
+`,
+            default: true,
+        },
+    },
+});
+//# sourceMappingURL=LoopPageDefinition.js.map

package/schemas/NotificationHookDataDefinition.d.ts

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

package/schemas/NotificationHookDataDefinition.js

@@ -0,0 +1,24 @@
+export const NotificationHookDataDefinition = {
+    type: 'object',
+    description: 'The data used to display the content of the notification.',
+    additionalProperties: true,
+    minProperties: 1,
+    properties: {
+        title: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The title of the notification.',
+        },
+        content: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The body of the notification.',
+        },
+        link: {
+            type: 'string',
+            description: `The URL of the page the user gets redirected to after being clicked.
+
+If the URL is relative, it will be relative to the app.
+`,
+        },
+    },
+};
+//# sourceMappingURL=NotificationHookDataDefinition.js.map

package/schemas/NotificationHookDefinition.d.ts

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

package/schemas/NotificationHookDefinition.js

@@ -0,0 +1,32 @@
+export const NotificationHookDefinition = {
+    type: 'object',
+    description: 'The strategy used to notify users.',
+    additionalProperties: false,
+    minProperties: 1,
+    properties: {
+        to: {
+            type: 'array',
+            description: `The list of roles to notify.
+
+Aside from roles, \`$author\` can also be used to notify the author of the resource.
+`,
+            minItems: 1,
+            items: {
+                type: 'string',
+            },
+        },
+        subscribe: {
+            description: `If set, allows users to manually subscribe for notifications for this resource regardless of roles.
+
+The following values are allowed:
+- \`all\`: Allows users to be notified about actions on all of the resources of this type.
+- \`single\`: Allows users to be notified about actions a single instance of a resource of this
+  type.
+- \`both\`: Allows users to be notified about all resources or a single resource of this type.
+`,
+            enum: ['all', 'single', 'both'],
+        },
+        data: { $ref: '#/components/schemas/NotificationHookDataDefinition' },
+    },
+};
+//# sourceMappingURL=NotificationHookDefinition.js.map

package/schemas/ObjectRemapperDefinition.d.ts

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

package/schemas/ObjectRemapperDefinition.js

@@ -0,0 +1,17 @@
+import * as remapperSchemas from '../reference-schemas/remappers/index.js';
+const remapperList = {};
+for (const section of Object.values(remapperSchemas)) {
+    Object.assign(remapperList, section);
+}
+export const ObjectRemapperDefinition = {
+    type: 'object',
+    description: `An object based remapper is defined by a specific implementation
+
+Object based remappers may only define 1 key. The allowed value depends on the remapper.
+`,
+    minProperties: 1,
+    maxProperties: 1,
+    additionalProperties: false,
+    properties: remapperList,
+};
+//# sourceMappingURL=ObjectRemapperDefinition.js.map

package/schemas/PageActionsDefinition.d.ts

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

package/schemas/PageActionsDefinition.js

@@ -0,0 +1,12 @@
+export const PageActionsDefinition = {
+    type: 'object',
+    description: 'Action fired on page events',
+    additionalProperties: false,
+    properties: {
+        onLoad: {
+            $ref: '#/components/schemas/ActionDefinition',
+            description: 'This action is fired when a page loads, highly helpful in loading data for the page',
+        },
+    },
+};
+//# sourceMappingURL=PageActionsDefinition.js.map

package/schemas/PageDefinition.d.ts

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

package/schemas/PageDefinition.js

@@ -0,0 +1,26 @@
+import { BasePageDefinition } from './BasePageDefinition.js';
+import { extendJSONSchema } from './utils/extendJSONSchema.js';
+export const PageDefinition = extendJSONSchema(BasePageDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    description: `The list of blocks that are displayed on the page.
+
+Each page requires at least one block. Blocks are displayed in the order that they are defined in
+the list.
+`,
+    required: ['blocks'],
+    properties: {
+        blocks: {
+            type: 'array',
+            minItems: 1,
+            description: 'The blocks that make up a page.',
+            items: {
+                $ref: '#/components/schemas/BlockDefinition',
+            },
+        },
+        actions: {
+            $ref: '#/components/schemas/PageActionsDefinition',
+        },
+    },
+});
+//# sourceMappingURL=PageDefinition.js.map

package/schemas/RemapperDefinition.d.ts

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

package/schemas/RemapperDefinition.js

@@ -0,0 +1,27 @@
+export const RemapperDefinition = {
+    anyOf: [
+        {
+            type: 'boolean',
+            description: 'A boolean remapper is always returned directly.',
+        },
+        {
+            enum: [null],
+            description: 'A null remapper is always returned directly.',
+        },
+        {
+            type: 'number',
+            description: 'A numeric remapper is always returned directly.',
+        },
+        {
+            type: 'string',
+            description: 'A string remapper is always returned directly.',
+        },
+        {
+            $ref: '#/components/schemas/ObjectRemapperDefinition',
+        },
+        {
+            $ref: '#/components/schemas/ArrayRemapperDefinition',
+        },
+    ],
+};
+//# sourceMappingURL=RemapperDefinition.js.map

package/schemas/ResourceDefinition.d.ts

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