@appsemble/utils 0.33.5 → 0.33.7

package/api/components/schemas/SubPage.js

@@ -1,36 +0,0 @@
-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/api/components/schemas/TabsPageDefinition.d.ts

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

package/api/components/schemas/TabsPageDefinition.js

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

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

package/api/components/schemas/Theme.js

@@ -1,80 +0,0 @@
-import { baseTheme, hexColor } from '../../../constants/index.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/api/components/schemas/ThrowActionDefinition.d.ts

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

package/api/components/schemas/ThrowActionDefinition.js

@@ -1,17 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const ThrowActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type'],
-    properties: {
-        type: {
-            enum: ['throw'],
-            description: `This action throws a new exception based on the data that is passed through.
-
-This can be used to create a custom error that ends up in the error action handler.
-`,
-        },
-    },
-});
-//# sourceMappingURL=ThrowActionDefinition.js.map

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

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

package/api/components/schemas/WebhookDefinition.js

@@ -1,17 +0,0 @@
-export const WebhookDefinition = {
-    type: 'object',
-    required: ['schema', 'action'],
-    description: 'A webhook definition defines app specific callable endpoints that Appsemble can handle.',
-    additionalProperties: false,
-    properties: {
-        schema: {
-            $ref: '#/components/schemas/JSONSchemaRoot',
-            description: 'JSON schema definition of the payload.',
-        },
-        action: {
-            description: 'The action to run when the webhook is triggered.',
-            $ref: '#/components/schemas/ActionDefinition',
-        },
-    },
-};
-//# sourceMappingURL=WebhookDefinition.js.map

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

@@ -1,13 +0,0 @@
-import { type OpenAPIV3 } from 'openapi-types';
-/**
- * Extend a JSON schema by copying its properties.
- *
- * This creates a new schema based on the input schema, where `required` and `properties` are
- * inherited from the `base` schema.
- *
- * @param base The base schema whose properties to inherit.
- * @param schema The schema overriding the base schema.
- * @param omit Properties to omit from the base schema.
- * @returns The schema which extends the base schema.
- */
-export declare function extendJSONSchema(base: OpenAPIV3.SchemaObject, schema: OpenAPIV3.SchemaObject, omit?: string[]): OpenAPIV3.SchemaObject;

package/api/components/schemas/utils.js

@@ -1,34 +0,0 @@
-import { has } from '../../../has.js';
-/**
- * Extend a JSON schema by copying its properties.
- *
- * This creates a new schema based on the input schema, where `required` and `properties` are
- * inherited from the `base` schema.
- *
- * @param base The base schema whose properties to inherit.
- * @param schema The schema overriding the base schema.
- * @param omit Properties to omit from the base schema.
- * @returns The schema which extends the base schema.
- */
-export function extendJSONSchema(base, schema, omit = []) {
-    const result = { ...schema };
-    const required = Array.isArray(schema.required) ? [...schema.required] : [];
-    if (Array.isArray(base.required)) {
-        for (const name of base.required) {
-            if (!required.includes(name) && !omit.includes(name)) {
-                required.push(name);
-            }
-        }
-    }
-    if (required.length) {
-        result.required = required;
-    }
-    result.properties = { ...schema.properties };
-    for (const [name, property] of Object.entries(base.properties ?? {})) {
-        if (!omit.includes(name) && !has(result.properties, name)) {
-            result.properties[name] = property;
-        }
-    }
-    return result;
-}
-//# sourceMappingURL=utils.js.map

package/appMembers.d.ts

@@ -1 +0,0 @@
-export declare function assignAppMemberProperties(properties: any, formData: FormData): void;

package/appMembers.js

@@ -1,9 +0,0 @@
-export function assignAppMemberProperties(properties, formData) {
-    if (properties && typeof properties === 'object' && !Array.isArray(properties)) {
-        formData.append('properties', JSON.stringify(Object.fromEntries(Object.entries(properties).map(([key, value]) => [
-            key,
-            typeof value === 'string' ? value : JSON.stringify(value),
-        ]))));
-    }
-}
-//# sourceMappingURL=appMembers.js.map

package/blockUtils.d.ts

@@ -1,31 +0,0 @@
-import { type AppDefinition, type BlockDefinition } from '@appsemble/types';
-export type IdentifiableBlock = Pick<BlockDefinition, 'type' | 'version'>;
-/**
- * Normalize a block name by prefixing it with `@appsemble` if necessary.
- *
- * @param name The input block name.
- * @returns The normalized block name.
- */
-export declare function normalizeBlockName(name: string): string;
-/**
- * Return a block name without the organization prefix.
- *
- * @param name The input block name.
- * @returns The prettified block name.
- */
-export declare function stripBlockName(name: string): string;
-/**
- * Parse a block name into a tuple of organization id and block id.
- *
- * @param name The block name to parse.
- * @returns A tuple containing the organization id and block id.
- */
-export declare function parseBlockName(name: string): [string, string] | undefined;
-/**
- * Find unique block types in an app.
- *
- * @param definition The app definition to find unique blocks for.
- * @returns Partial unique blocks. Only the type and version are returned.
- */
-export declare function getAppBlocks(definition: AppDefinition): IdentifiableBlock[];
-export declare function prefixBlockURL(block: IdentifiableBlock, url: string): string;

package/blockUtils.js

@@ -1,65 +0,0 @@
-import { blockNamePattern } from './constants/index.js';
-import { iterApp } from './iterApp.js';
-const prefix = '@appsemble/';
-/**
- * Normalize a block name by prefixing it with `@appsemble` if necessary.
- *
- * @param name The input block name.
- * @returns The normalized block name.
- */
-export function normalizeBlockName(name) {
-    if (name.startsWith('@')) {
-        return name;
-    }
-    return `${prefix}${name}`;
-}
-/**
- * Return a block name without the organization prefix.
- *
- * @param name The input block name.
- * @returns The prettified block name.
- */
-export function stripBlockName(name) {
-    if (name.startsWith(prefix)) {
-        return name.slice(prefix.length);
-    }
-    return name;
-}
-/**
- * Parse a block name into a tuple of organization id and block id.
- *
- * @param name The block name to parse.
- * @returns A tuple containing the organization id and block id.
- */
-export function parseBlockName(name) {
-    // TODO: should this not throw an error? Most call sites are not well-prepared for undefined.
-    const match = blockNamePattern.exec(normalizeBlockName(name));
-    if (match) {
-        return match.slice(1, 3);
-    }
-}
-/**
- * Find unique block types in an app.
- *
- * @param definition The app definition to find unique blocks for.
- * @returns Partial unique blocks. Only the type and version are returned.
- */
-export function getAppBlocks(definition) {
-    const visited = new Set();
-    const result = [];
-    iterApp(definition, {
-        onBlock({ type, version }) {
-            const name = normalizeBlockName(type);
-            const asString = `${name}@${version}`;
-            if (!visited.has(asString)) {
-                result.push({ type: name, version });
-            }
-            visited.add(asString);
-        },
-    });
-    return result;
-}
-export function prefixBlockURL(block, url) {
-    return `/api/blocks/${normalizeBlockName(block.type)}/versions/${block.version}/${url}`;
-}
-//# sourceMappingURL=blockUtils.js.map

package/constants/baseTheme.d.ts

@@ -1,2 +0,0 @@
-import { type Theme } from '@appsemble/types';
-export declare const baseTheme: Theme;

package/constants/baseTheme.js

@@ -1,16 +0,0 @@
-export const baseTheme = {
-    primaryColor: '#5393ff',
-    linkColor: '#0440ad',
-    infoColor: '#a7d0ff',
-    successColor: '#1fd25b',
-    warningColor: '#fed719',
-    dangerColor: '#ff2800',
-    splashColor: '#ffffff',
-    themeColor: '#ffffff',
-    tileLayer: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
-    font: {
-        family: 'Open Sans',
-        source: 'google',
-    },
-};
-//# sourceMappingURL=baseTheme.js.map

package/constants/fonts.d.ts

@@ -1,6 +0,0 @@
-/**
- * A list of all available Google font names.
- *
- * This has been generated from https://developers.google.com/fonts/docs/developer_api.
- */
-export declare const googleFonts: string[];