@appsemble/lang-sdk 0.33.7

package/types/container.d.ts

@@ -0,0 +1,46 @@
+export interface CompanionContainerDefinition {
+    /**
+     * Alias of the container in the app.
+     */
+    name: string;
+    /**
+     * Image to use for the container.
+     */
+    image: string;
+    /**
+     * Port exposed by the provided image.
+     *
+     * E.g., if the Dockerfile of the image contains `EXPOSE 3000`
+     * then `port` should be 3000 as well.
+     */
+    port: number;
+    /**
+     * Limits the resources used and required by companion containers
+     *
+     */
+    resources?: ContainerResources;
+    /**
+     * Environment within the container
+     */
+    env?: ContainerEnvVar[];
+    /**
+     * Additional properties e.g., labels, annotations
+     *
+     */
+    metadata?: Record<string, any>;
+}
+export interface ContainerResources {
+    /**
+     * Maximum amount of resources allowed
+     */
+    limits: ContainerResourceProps;
+}
+export interface ContainerResourceProps {
+    cpu: string;
+    memory: string;
+}
+export interface ContainerEnvVar {
+    name: string;
+    value: string;
+    useValueFromSecret?: boolean;
+}

package/types/container.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=container.js.map

package/types/core.d.ts

@@ -0,0 +1,322 @@
+import { type IconName } from '@fortawesome/fontawesome-common-types';
+import { type OpenAPIV3 } from 'openapi-types';
+import { type ActionDefinition } from './actionDefinition.js';
+import { type BlockDefinition, type ControllerDefinition } from './block.js';
+import { type CompanionContainerDefinition } from './container.js';
+import { type LayoutPosition, type Navigation } from './layout.js';
+import { type Remapper } from './remapper.js';
+import { type ResourceDefinition } from './resource.js';
+import { type ViewRole } from './roles.js';
+import { type Security } from './security.js';
+import { type Theme } from './theme.js';
+export interface AppDefinition {
+    /**
+     * The name of the app.
+     *
+     * This determines the default path of the app.
+     */
+    name: string;
+    /**
+     * The description of the app.
+     */
+    description?: string;
+    /**
+     * The default language of the app.
+     *
+     * @default 'en'
+     */
+    defaultLanguage?: string;
+    /**
+     * The security definition of the app.
+     *
+     * This determines user roles and login behavior.
+     */
+    security?: Security;
+    /**
+     * The default page of the app.
+     */
+    defaultPage: string;
+    /**
+     * The settings for the layout of the app.
+     */
+    layout?: {
+        /**
+         * The location of the login button.
+         *
+         * @default 'navbar'
+         */
+        login?: LayoutPosition;
+        /**
+         * The location of the settings button.
+         *
+         * If set to `navigation`, it will only be visible if `login` is also visible in `navigation`.
+         *
+         * @default 'navbar'
+         */
+        settings?: LayoutPosition;
+        /**
+         * The location of the feedback button
+         *
+         * If set to `navigation`, it will only be visible if `login` is also visible in `navigation`.
+         *
+         * @default 'navbar'
+         */
+        feedback?: LayoutPosition;
+        /**
+         * The location of the install button.
+         *
+         * If set to `navigation`, it will only be visible if `login` is also visible in `navigation`.
+         *
+         * @default 'navbar'
+         */
+        install?: LayoutPosition;
+        /**
+         * The navigation type to use.
+         *
+         * If this is omitted, a collapsible side navigation menu will be rendered on the left.
+         *
+         * @default 'left-menu'
+         */
+        navigation?: Navigation;
+        /**
+         * The settings for displaying the app logo.
+         */
+        logo?: AppLogo;
+    };
+    /**
+     * The strategy to use for apps to subscribe to push notifications.
+     *
+     * If this is omitted, push notifications can not be sent.
+     */
+    notifications?: 'login' | 'opt-in' | 'startup';
+    /**
+     * The pages of the app.
+     */
+    pages: PageDefinition[];
+    controller?: ControllerDefinition;
+    members?: {
+        properties: Record<string, AppMemberPropertyDefinition>;
+    };
+    /**
+     * Resource definitions that may be used by the app.
+     */
+    resources?: Record<string, ResourceDefinition>;
+    /**
+     * The global theme for the app.
+     */
+    theme?: Partial<Theme>;
+    /**
+     * Helper property that can be used to store YAML anchors.
+     *
+     * This is omitted any time the API serves the app definition.
+     */
+    anchors?: any[];
+    /**
+     * Cron jobs associated with the app.
+     */
+    cron?: Record<string, CronDefinition>;
+    /**
+     * Webhooks associated with the app.
+     */
+    webhooks?: Record<string, WebhookDefinition>;
+    /**
+     * Companion containers of the app.
+     */
+    containers?: CompanionContainerDefinition[];
+    /**
+     * Default registry to use when creating app companion containers.
+     * Used to avoid writing the registry name in front of every image.
+     */
+    registry?: string;
+}
+/**
+ * This describes what a page will look like in the app.
+ */
+export interface BasePageDefinition {
+    /**
+     * The name of the page.
+     *
+     * This will be displayed at the *app bar* of each page and in the side menu,
+     * unless @see navTitle is set.
+     *
+     * The name of the page is used to determine the URL path of the page.
+     */
+    name: string;
+    /**
+     * Whether or not the page name should be displayed in the *app bar*.
+     */
+    hideName?: boolean;
+    /**
+     * The name of the page when displayed in the navigation menu.
+     *
+     * Context property `name` can be used to access the name of the page.
+     */
+    navTitle?: Remapper;
+    /**
+     * Whether or not the page should be displayed in navigational menus.
+     */
+    hideNavTitle?: boolean;
+    /**
+     * The navigation type to use for the page.
+     * Setting this will override the default navigation for the app.
+     */
+    navigation?: Navigation;
+    /**
+     * A list of roles that may view the page.
+     */
+    roles?: ViewRole[];
+    /**
+     * An optional icon from the fontawesome icon set
+     *
+     * This will be displayed in the navigation menu.
+     */
+    icon?: IconName;
+    /**
+     * Page parameters can be used for linking to a page that should display a single resource.
+     */
+    parameters?: string[];
+    /**
+     * The global theme for the page.
+     */
+    theme?: Partial<Theme>;
+    /**
+     * A Remapper that resolves to a number to be visible in the side-menu.
+     */
+    badgeCount?: Remapper;
+    /**
+     * A mapping of actions that can be fired by the page to action handlers.
+     */
+    actions?: {
+        onLoad?: ActionDefinition;
+    };
+}
+/**
+ * A subset of page for use within flow pages and tab pages.
+ */
+export interface SubPageDefinition {
+    name: Remapper;
+    roles?: ViewRole[];
+    blocks: BlockDefinition[];
+}
+export interface BasicPageDefinition extends BasePageDefinition {
+    type?: 'page';
+    blocks: BlockDefinition[];
+}
+export interface ContainerPageDefinition extends BasePageDefinition {
+    type: 'container';
+    pages: PageDefinition[];
+}
+export interface FlowPageDefinition extends Omit<BasePageDefinition, 'actions'> {
+    type: 'flow';
+    steps: SubPageDefinition[];
+    /**
+     * A mapping of actions that can be fired by the page to action handlers.
+     */
+    actions?: {
+        onLoad?: ActionDefinition;
+        onFlowCancel?: ActionDefinition;
+        onFlowFinish?: ActionDefinition;
+    };
+    /**
+     * The method used to display the progress of the flow page.
+     *
+     * @default 'corner-dots'
+     */
+    progress?: 'corner-dots' | 'hidden';
+    /**
+     * 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
+     */
+    retainFlowData?: boolean;
+}
+export interface LoopPageDefinition extends BasePageDefinition {
+    type: 'loop';
+    /**
+     * Template step that the loop will pass data onto
+     */
+    foreach: SubPageDefinition;
+    /**
+     * A mapping of actions that can be fired by the page to action handlers.
+     */
+    actions?: {
+        onFlowCancel?: ActionDefinition;
+        onFlowFinish?: ActionDefinition;
+        onLoad: ActionDefinition;
+    };
+    /**
+     * The method used to display the progress of the flow page.
+     *
+     * @default 'corner-dots'
+     */
+    progress?: 'corner-dots' | 'hidden';
+    /**
+     * 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
+     */
+    retainFlowData?: boolean;
+}
+export interface AlternateTabsDefinition {
+    foreach: SubPageDefinition;
+    events: {
+        listen?: Record<string, string>;
+        emit?: Record<string, string>;
+    };
+}
+export interface TabsPageDefinition extends BasePageDefinition {
+    type: 'tabs';
+    tabs?: SubPageDefinition[];
+    definition?: AlternateTabsDefinition;
+    /**
+     * A mapping of actions that can be fired by the page to action handlers.
+     */
+    actions?: {
+        onLoad?: ActionDefinition;
+    };
+}
+export type PageDefinition = BasicPageDefinition | ContainerPageDefinition | FlowPageDefinition | LoopPageDefinition | TabsPageDefinition;
+/**
+ * The definition of a cron job for an app.
+ */
+export interface CronDefinition {
+    schedule: string;
+    action: ActionDefinition;
+}
+/**
+ * The definition of a webhook for an app.
+ */
+export interface WebhookDefinition {
+    schema: OpenAPIV3.SchemaObject;
+    action: ActionDefinition;
+}
+export interface AppMemberPropertyDefinition {
+    /**
+     * The JSON schema to validate user properties against before sending it to the backend.
+     */
+    schema: OpenAPIV3.SchemaObject;
+    /**
+     * The resource that is referenced by this user property.
+     */
+    reference?: {
+        resource: string;
+    };
+}
+export interface AppLogo {
+    /**
+     * The location of the logo
+     *
+     * @default navbar
+     */
+    position?: 'hidden' | 'navbar';
+    /**
+     * The id or name of the app asset to use for the logo
+     *
+     * @default logo
+     */
+    asset?: string;
+}

package/types/core.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=core.js.map

package/types/http.d.ts

@@ -0,0 +1,6 @@
+type Methods = 'delete' | 'get' | 'patch' | 'post' | 'put';
+/**
+ * Common HTTP methods, but either all upper case or all lower case.
+ */
+export type HTTPMethods = Methods | Uppercase<Methods>;
+export {};

package/types/http.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=http.js.map

package/types/index.d.ts

@@ -0,0 +1,115 @@
+import { type Schema } from 'jsonschema';
+export * from './actionDefinition.js';
+export * from './ActionError.js';
+export * from './action.js';
+export * from './block.js';
+export * from './bulma.js';
+export * from './container.js';
+export * from './core.js';
+export * from './http.js';
+export * from './layout.js';
+export * from './permission.js';
+export * from './remapper.js';
+export * from './resource.js';
+export * from './roles.js';
+export * from './security.js';
+export * from './theme.js';
+export * from './member.js';
+export interface ActionType {
+    /**
+     * Whether or not app creators are required to define this action.
+     */
+    required?: boolean;
+    /**
+     * The description of the action.
+     */
+    description?: string;
+}
+export interface EventType {
+    /**
+     * The description of the action.
+     */
+    description?: string;
+}
+export interface ProjectConfig {
+    /**
+     * The name of the project.
+     */
+    name: string;
+    /**
+     * The description of the project.
+     */
+    description?: string;
+    /**
+     * The long description of the project.
+     *
+     * This is displayed when rendering documentation and supports Markdown.
+     */
+    longDescription?: string;
+    /**
+     * A [semver](https://semver.org) representation of the project version.
+     *
+     * Pattern:
+     * ^\d+\.\d+\.\d+$
+     */
+    version: string;
+}
+export interface ProjectImplementations {
+    /**
+     * The actions that are supported by a project.
+     */
+    actions?: Record<string, ActionType>;
+    /**
+     * The events that are supported by a project.
+     */
+    events?: {
+        listen?: Record<string, EventType>;
+        emit?: Record<string, EventType>;
+    };
+    /**
+     * The messages that are supported by a project.
+     */
+    messages?: Record<string, Record<string, any> | never>;
+    /**
+     * A JSON schema to validate project parameters.
+     */
+    parameters?: Schema;
+}
+export interface ProjectManifest extends ProjectConfig, ProjectImplementations {
+    /**
+     * Array of urls associated to the files of the project.
+     */
+    files: string[];
+}
+export interface BlockManifest extends ProjectManifest {
+    /**
+     * The URL that can be used to fetch this block’s icon.
+     */
+    iconUrl?: string | null;
+    /**
+     * The languages that are supported by the block by default.
+     *
+     * If the block has no messages, this property is `null`.
+     */
+    languages: string[] | null;
+    examples?: string[];
+    /**
+     * Whether the block should be listed publicly
+     * for users who aren’t part of the block’s organization.
+     *
+     * - **`public`**: The block is visible for everyone.
+     * - **`unlisted`**: The block will only be visible if the user is
+     * logged in and is part of the block’s organization.
+     */
+    visibility?: 'public' | 'unlisted';
+    /**
+     * Whether action validation for wildcard action is skipped.
+     *
+     * If true, ignore unused actions that fall under '$any'.
+     */
+    wildcardActions?: boolean;
+    /**
+     * The type of layout to be used for the block.
+     */
+    layout?: 'float' | 'grow' | 'hidden' | 'static' | null;
+}

package/types/index.js

@@ -0,0 +1,17 @@
+export * from './actionDefinition.js';
+export * from './ActionError.js';
+export * from './action.js';
+export * from './block.js';
+export * from './bulma.js';
+export * from './container.js';
+export * from './core.js';
+export * from './http.js';
+export * from './layout.js';
+export * from './permission.js';
+export * from './remapper.js';
+export * from './resource.js';
+export * from './roles.js';
+export * from './security.js';
+export * from './theme.js';
+export * from './member.js';
+//# sourceMappingURL=index.js.map

package/types/layout.d.ts

@@ -0,0 +1,2 @@
+export type Navigation = 'bottom' | 'hidden' | 'left-menu';
+export type LayoutPosition = 'hidden' | 'navbar' | 'navigation';

package/types/layout.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=layout.js.map

package/types/member.d.ts

@@ -0,0 +1,43 @@
+import { type AppRole } from './roles.js';
+export interface AppMemberInfo {
+    /**
+     * The subject (end-user) identifier. This member is always present in a claims set.
+     */
+    sub: string;
+    /**
+     * The full name of the end-user, with optional language tag.
+     */
+    name: string;
+    /**
+     * The end-user's preferred email address.
+     */
+    email: string;
+    /**
+     * True if the end-user's email address has been verified, else false.
+     */
+    email_verified: boolean;
+    /**
+     * The URL of the profile picture for the end-user.
+     */
+    picture?: string;
+    /**
+     * The end-user’s locale, represented as a BCP47 language tag.
+     */
+    locale?: string;
+    /**
+     * The end-user’s time zone.
+     */
+    zoneinfo?: string;
+    /**
+     * The role of the app member.
+     */
+    role: AppRole;
+    /**
+     * The end-user's additional properties
+     */
+    properties?: Record<string, any>;
+    /**
+     * Whether this app member is used for demonstration purposes
+     */
+    demo: boolean;
+}

package/types/member.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=member.js.map

package/types/permission.d.ts

@@ -0,0 +1,102 @@
+export declare enum AppPermission {
+    /**
+     * The permission to create app invites.
+     */
+    CreateAppInvites = "$member:invite",
+    /**
+     * The permission to query app members.
+     */
+    QueryAppMembers = "$member:query",
+    /**
+     * The permission to query app members.
+     */
+    DeleteAppMembers = "$member:delete",
+    /**
+     * The permission to update the role of app members.
+     */
+    UpdateAppMemberRoles = "$member:role:update",
+    /**
+     * The permission to patch the properties of app members.
+     */
+    PatchAppMemberProperties = "$member:properties:patch",
+    /**
+     * The permission to query app groups.
+     */
+    QueryGroups = "$group:query",
+    /**
+     * The permission to create app groups.
+     */
+    CreateGroups = "$group:create",
+    /**
+     * The permission to update app groups.
+     */
+    UpdateGroups = "$group:update",
+    /**
+     * The permission to create app groups.
+     */
+    DeleteGroups = "$group:delete",
+    /**
+     * The permission to create group invites.
+     */
+    CreateGroupInvites = "$group:member:invite",
+    /**
+     * The permission to query app members.
+     */
+    QueryGroupMembers = "$group:member:query",
+    /**
+     * The permission to delete group members.
+     */
+    RemoveGroupMembers = "$group:member:delete",
+    /**
+     * The permission to change the role of members in a group.
+     */
+    UpdateGroupMemberRoles = "$group:member:role:update",
+    /**
+     * The permission to create any app resources.
+     */
+    CreateResources = "$resource:all:create",
+    /**
+     * The permission to fetch history of a resource.
+     */
+    GetResourceHistory = "$resource:all:history:get",
+    /**
+     * The permission to query app resources.
+     */
+    QueryResources = "$resource:all:query",
+    /**
+     * The permission to get app resources.
+     */
+    GetResources = "$resource:all:get",
+    /**
+     * The permission to update app resources.
+     */
+    UpdateResources = "$resource:all:update",
+    /**
+     * The permission to patch app resources.
+     */
+    PatchResources = "$resource:all:patch",
+    /**
+     * The permission to delete app resources.
+     */
+    DeleteResources = "$resource:all:delete",
+    /**
+     * The permission to query own app resources.
+     */
+    QueryOwnResources = "$resource:all:own:query",
+    /**
+     * The permission to get own app resources.
+     */
+    GetOwnResources = "$resource:all:own:get",
+    /**
+     * The permission to update own app resources.
+     */
+    UpdateOwnResources = "$resource:all:own:update",
+    /**
+     * The permission to patch own app resources.
+     */
+    PatchOwnResources = "$resource:all:own:patch",
+    /**
+     * The permission to delete own app resources.
+     */
+    DeleteOwnResources = "$resource:all:own:delete"
+}