@appsemble/types 0.30.14-test.5 → 0.32.1-test.14

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.30.14-test.5/config/assets/logo.svg) Appsemble Types
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.32.1-test.14/config/assets/logo.svg) Appsemble Types
 
 > Reusable TypeScript types
 
 [![npm](https://img.shields.io/npm/v/@appsemble/types)](https://www.npmjs.com/package/@appsemble/types)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.30.14-test.5/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.30.14-test.5)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.32.1-test.14/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.32.1-test.14)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.30.14-test.5/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.32.1-test.14/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/action.d.ts

@@ -35,6 +35,9 @@ interface RequestLikeAction<T extends Action['type']> extends BaseAction<T> {
 export type RequestAction = RequestLikeAction<'request'>;
 export type ResourceCreateAction = RequestLikeAction<'resource.create'>;
 export type ResourceDeleteAction = RequestLikeAction<'resource.delete'>;
+export type ResourceUpdatePositionsAction = RequestLikeAction<'resource.update.positions'>;
+export type ResourceDeleteAllAction = RequestLikeAction<'resource.delete.all'>;
+export type ResourceDeleteBulkAction = RequestLikeAction<'resource.delete.bulk'>;
 export type ResourceGetAction = RequestLikeAction<'resource.get'>;
 export type ResourceHistoryGetAction = RequestLikeAction<'resource.history.get'>;
 export type ResourceQueryAction = RequestLikeAction<'resource.query'>;
@@ -44,7 +47,7 @@ export type ResourcePatchAction = RequestLikeAction<'resource.patch'>;
 /**
  * An action that can be called from within a block.
  */
-export type Action = BaseAction<'analytics'> | BaseAction<'app.member.current.patch'> | BaseAction<'app.member.delete'> | BaseAction<'app.member.invite'> | BaseAction<'app.member.login'> | BaseAction<'app.member.logout'> | BaseAction<'app.member.properties.patch'> | BaseAction<'app.member.query'> | BaseAction<'app.member.register'> | BaseAction<'app.member.role.update'> | BaseAction<'condition'> | BaseAction<'controller'> | BaseAction<'dialog.error'> | BaseAction<'dialog.ok'> | BaseAction<'dialog'> | BaseAction<'download'> | BaseAction<'each'> | BaseAction<'email'> | BaseAction<'event'> | BaseAction<'flow.back'> | BaseAction<'flow.cancel'> | BaseAction<'flow.finish'> | BaseAction<'flow.next'> | BaseAction<'flow.to'> | BaseAction<'group.member.delete'> | BaseAction<'group.member.invite'> | BaseAction<'group.member.query'> | BaseAction<'group.member.role.update'> | BaseAction<'group.query'> | BaseAction<'link.back'> | BaseAction<'link.next'> | BaseAction<'match'> | BaseAction<'message'> | BaseAction<'noop'> | BaseAction<'notify'> | BaseAction<'resource.subscription.status'> | BaseAction<'resource.subscription.subscribe'> | BaseAction<'resource.subscription.toggle'> | BaseAction<'resource.subscription.unsubscribe'> | BaseAction<'share'> | BaseAction<'static'> | BaseAction<'storage.append'> | BaseAction<'storage.delete'> | BaseAction<'storage.read'> | BaseAction<'storage.subtract'> | BaseAction<'storage.update'> | BaseAction<'storage.write'> | BaseAction<'throw'> | LinkAction | LogAction | RequestAction | ResourceCountAction | ResourceCreateAction | ResourceDeleteAction | ResourceGetAction | ResourceHistoryGetAction | ResourcePatchAction | ResourceQueryAction | ResourceUpdateAction;
+export type Action = BaseAction<'analytics'> | BaseAction<'app.member.current.patch'> | BaseAction<'app.member.delete'> | BaseAction<'app.member.invite'> | BaseAction<'app.member.login'> | BaseAction<'app.member.logout'> | BaseAction<'app.member.properties.patch'> | BaseAction<'app.member.query'> | BaseAction<'app.member.register'> | BaseAction<'app.member.role.update'> | BaseAction<'condition'> | BaseAction<'controller'> | BaseAction<'dialog.error'> | BaseAction<'dialog.ok'> | BaseAction<'dialog'> | BaseAction<'download'> | BaseAction<'each'> | BaseAction<'email'> | BaseAction<'event'> | BaseAction<'flow.back'> | BaseAction<'flow.cancel'> | BaseAction<'flow.finish'> | BaseAction<'flow.next'> | BaseAction<'flow.to'> | BaseAction<'group.member.delete'> | BaseAction<'group.member.invite'> | BaseAction<'group.member.query'> | BaseAction<'group.member.role.update'> | BaseAction<'group.query'> | BaseAction<'link.back'> | BaseAction<'link.next'> | BaseAction<'match'> | BaseAction<'message'> | BaseAction<'noop'> | BaseAction<'notify'> | BaseAction<'resource.subscription.status'> | BaseAction<'resource.subscription.subscribe'> | BaseAction<'resource.subscription.toggle'> | BaseAction<'resource.subscription.unsubscribe'> | BaseAction<'share'> | BaseAction<'static'> | BaseAction<'storage.append'> | BaseAction<'storage.delete'> | BaseAction<'storage.read'> | BaseAction<'storage.subtract'> | BaseAction<'storage.update'> | BaseAction<'storage.write'> | BaseAction<'throw'> | LinkAction | LogAction | RequestAction | ResourceCountAction | ResourceCreateAction | ResourceDeleteAction | ResourceDeleteAllAction | ResourceDeleteBulkAction | ResourceGetAction | ResourceHistoryGetAction | ResourcePatchAction | ResourceQueryAction | ResourceUpdateAction | ResourceUpdatePositionsAction;
 interface ActionErrorOptions<D extends ActionDefinition> {
     /**
      * What caused the error to be thrown.

package/index.d.ts

@@ -25,6 +25,7 @@ export * from './ssl.js';
 export * from './template.js';
 export * from './theme.js';
 export * from './oauth2.js';
+export * from './training.js';
 export * from './quota.js';
 export * from './permissions.js';
 export * from './roles.js';
@@ -155,6 +156,7 @@ export interface UserInfo extends BaseUserInfo {
      * If the user is subscribed to the newsletter
      */
     subscribed?: boolean;
+    hasPassword?: boolean;
 }
 export interface AppMemberInfo extends BaseUserInfo {
     /**
@@ -267,6 +269,22 @@ interface EndTimeICSRemapper extends BaseICSRemapper {
      */
     end: Remapper;
 }
+export interface SubstringCaseType {
+    /**
+     * Whether to match the case of the substring.
+     */
+    strict?: boolean;
+    /**
+     * Substring to match.
+     */
+    substring: string;
+}
+type FilterParams = Record<string, {
+    type: 'Boolean' | 'Date' | 'Guid' | 'Number' | 'String';
+    value: Remapper;
+    comparator: 'eq' | 'ge' | 'gt' | 'le' | 'lt' | 'ne';
+}>;
+type OrderParams = Record<string, 'asc' | 'desc'>;
 export interface Remappers {
     /**
      * Get app metadata.
@@ -353,6 +371,22 @@ export interface Remappers {
      * If only one remapper or none is passed, the remapper value gets computed and then inverted.
      */
     not: Remapper[];
+    /**
+     * Compare all computed remapper values against each other.
+     *
+     * Returns `true` if all entries are true, otherwise `false`.
+     *
+     * If only one remapper is passed, the remapper is returned.
+     */
+    and: Remapper[];
+    /**
+     * Compare all computed remapper values against each other.
+     *
+     * Returns `false` if all entries are false, otherwise `true`.
+     *
+     * If only one remapper is passed, the remapper is returned.
+     */
+    or: Remapper[];
     /**
      * Get data stored at the current flow page step
      */
@@ -437,7 +471,7 @@ export interface Remappers {
      *
      * Returns nothing if array.map’s context isn’t set.
      */
-    array: 'index' | 'item' | 'length';
+    array: 'index' | 'item' | 'length' | 'nextItem' | 'prevItem';
     /**
      *
      * Returns an array containing the items matching the specified conditions.
@@ -487,6 +521,85 @@ export interface Remappers {
      * ```
      */
     'object.omit': (string[] | string)[];
+    /**
+     * Compare two objects to each other and get an array of differences
+     *
+     * Nested object keys are returned as a path array.
+     *
+     * @example
+     * ```yaml
+     * object.compare:
+     *   - object.from:
+     *       name: Alice
+     *       age: 25
+     *       address:
+     *         object.from:
+     *           city: Paris
+     *           zip: 7500
+     *   - object.from:
+     *       name: Alice
+     *       age: 26
+     *       address:
+     *         object.from:
+     *           city: Lyon
+     *           country: France
+     * ```
+     *
+     * Returns:
+     * ```javascript
+     * [
+     *   { path: ['age'], type: 'changed', from: 25, to: 26 },
+     *   { path: ['address', 'city'], type: 'changed', from: 'Paris', to: 'Lyon' },
+     *   { path: ['address', 'zip'], type: 'removed', value: 7500 },
+     *   { path: ['address', 'country'], type: 'added', value: 'France' }
+     * ]
+     * ```
+     */
+    'object.compare': [Remapper, Remapper];
+    /**
+     * Takes an object with an array property and transforms it into an array of objects.
+     *
+     * Each object in the resulting array contains all the entries of the original object
+     * plus all the entries of the corresponding array item from the array property.
+     *
+     * > **Note**
+     * > If one of the items in the array contains a key, which exists in the original object
+     * > it will overwrite the original key
+     *
+     * > **Note**
+     * > Nested arrays or objects are not exploded
+     *
+     * @example
+     * Input:
+     * ```javascript
+     * {
+     *   ownerName: 'John',
+     *   country: 'USA',
+     *   pets: [
+     *     { name: 'Milka' },
+     *     { name: 'Sven', country: 'Sweden' },
+     *     { name: 'Tom', likes: ['mice', 'fish'] },
+     *     { name: 'Jerry', looks: { color: 'brown' } }
+     *   ]
+     * }
+     * ```
+     *
+     * Remapper:
+     * ```yaml
+     * object.explode: pets
+     * ```
+     *
+     * Returns:
+     * ```javascript
+     * [
+     *   { ownerName: 'John', name: 'Milka', country: 'USA' },
+     *   { ownerName: 'John', name: 'Sven', country: 'Sweden' },
+     *   { ownerName: 'John', name: 'Tom', country: 'USA', likes: ['mice', 'fish'] },
+     *   { ownerName: 'John', name: 'Jerry', country: 'USA', looks: { color: 'brown' } }
+     * ]
+     * ```
+     */
+    'object.explode': string;
     /**
      * Use a static value.
      */
@@ -530,6 +643,11 @@ export interface Remappers {
         choice: string;
         length: number;
     };
+    /**
+     * This remapper returns the length of the input array or a string, this remapper
+     * doesn't require array to be in the context unlike `{ array: length }` remapper.
+     */
+    len: null;
     /**
      * Get the input data as it was initially passed to the remap function.
      */
@@ -601,6 +719,18 @@ export interface Remappers {
      * Convert an input to lower or upper case.
      */
     'string.case': 'lower' | 'upper';
+    /**
+     * Check if the initial characters of the string matches with the input string.
+     */
+    'string.startsWith': SubstringCaseType | string;
+    /**
+     * Check if the last characters of the string matches with the input string.
+     */
+    'string.endsWith': SubstringCaseType | string;
+    /**
+     * Extract a section of the string or an array.
+     */
+    slice: number | [number, number];
     /**
      * Format a string using remapped input variables.
      */
@@ -629,10 +759,32 @@ export interface Remappers {
      */
     translate: string;
     container: string;
+    /**
+     * Construct an OData $filter
+     */
+    'filter.from': FilterParams;
+    /**
+     * Construct an OData $orderby
+     */
+    'order.from': OrderParams;
+    /**
+     * Parse an xml string to a JavaScript object
+     */
+    'xml.parse': Remapper;
+    /**
+     * Check if the value is defined
+     *
+     * @example
+     * "" -> true
+     * 0 -> true
+     * null -> false
+     * undefined -> false
+     */
+    defined: Remapper;
 }
 export type ObjectRemapper = RequireExactlyOne<Remappers>;
 export type ArrayRemapper = (ArrayRemapper | ObjectRemapper)[];
-export type Remapper = ArrayRemapper | ObjectRemapper | boolean | number | string;
+export type Remapper = ArrayRemapper | ObjectRemapper | boolean | number | string | null;
 export interface SubscriptionResponseResource {
     create: boolean;
     update: boolean;
@@ -648,7 +800,7 @@ export declare const resourceSubscribableAction: readonly ["create", "update", "
 export type ResourceSubscribableAction = (typeof resourceSubscribableAction)[number];
 export type ResourceViewAction = 'get' | 'query';
 export type OwnResourceAction = ResourceViewAction | 'delete' | 'patch' | 'update';
-export type ResourceAction = ResourceViewAction | 'create' | 'delete' | 'history.get' | 'patch' | 'update';
+export type ResourceAction = ResourceViewAction | 'create' | 'delete' | 'history.get' | 'patch' | 'update.positions' | 'update';
 export type CustomAppResourcePermission = `$resource:${string}:${ResourceAction}`;
 export type CustomAppOwnResourcePermission = `$resource:${string}:own:${OwnResourceAction}`;
 export type CustomAppResourceViewPermission = `$resource:${string}:${ResourceViewAction}:${string}`;
@@ -658,6 +810,10 @@ export interface GuestDefinition {
     permissions?: CustomAppPermission[];
     inherits?: AppRole[];
 }
+export interface CronSecurityDefinition {
+    permissions?: CustomAppPermission[];
+    inherits?: AppRole[];
+}
 export interface RoleDefinition {
     description?: string;
     defaultPage?: string;
@@ -667,6 +823,7 @@ export interface RoleDefinition {
 export type SecurityPolicy = 'everyone' | 'invite' | 'organization';
 export interface MinimalSecurity {
     guest: GuestDefinition;
+    cron?: CronSecurityDefinition;
     default?: {
         role: AppRole;
         policy?: SecurityPolicy;
@@ -675,6 +832,7 @@ export interface MinimalSecurity {
 }
 export interface StrictSecurity {
     guest?: GuestDefinition;
+    cron?: CronSecurityDefinition;
     default: {
         role: AppRole;
         policy?: SecurityPolicy;
@@ -762,6 +920,11 @@ export interface ResourceDefinition {
      * A definition of how versioning should happen for instances of this resource.
      */
     history?: ResourceHistoryDefinition | boolean;
+    /**
+     * 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.
+     */
+    positioning?: boolean;
     /**
      * The definition for the `resource.create` action.
      */
@@ -1121,6 +1284,10 @@ export interface StorageWriteActionDefinition extends BaseActionDefinition<'stor
      * @default 'indexedDB'
      */
     storage?: StorageType;
+    /**
+     * Expiry of the data stored, to be used with `localStorage`.
+     */
+    expiry?: '1d' | '3d' | '7d' | '12h';
 }
 export interface GroupMemberInviteActionDefinition extends BaseActionDefinition<'group.member.invite'> {
     /**
@@ -1317,18 +1484,27 @@ interface OwnResourceDefinition {
      */
     own?: boolean;
 }
+interface ResourceActionWithIdDefinition {
+    /**
+     * Id of the resource to fetch
+     */
+    id?: Remapper;
+}
 export interface ControllerActionDefinition extends BaseActionDefinition<'controller'> {
     handler: string;
 }
 export type RequestActionDefinition = RequestLikeActionDefinition<'request'>;
 export type ResourceCreateActionDefinition = ResourceActionDefinition<'resource.create'>;
 export type ResourceDeleteActionDefinition = ResourceActionDefinition<'resource.delete'>;
+export type ResourceDeleteAllActionDefinition = ResourceActionDefinition<'resource.delete.all'>;
+export type ResourceDeleteBulkActionDefinition = ResourceActionDefinition<'resource.delete.bulk'>;
 export type ResourceHistoryGetActionDefinition = ResourceActionDefinition<'resource.history.get'>;
-export type ResourceGetActionDefinition = ResourceActionDefinition<'resource.get'> & ViewResourceDefinition;
+export type ResourceGetActionDefinition = ResourceActionDefinition<'resource.get'> & ResourceActionWithIdDefinition & ViewResourceDefinition;
 export type ResourceQueryActionDefinition = OwnResourceDefinition & ResourceActionDefinition<'resource.query'> & ViewResourceDefinition;
 export type ResourceCountActionDefinition = OwnResourceDefinition & ResourceActionDefinition<'resource.count'>;
 export type ResourceUpdateActionDefinition = ResourceActionDefinition<'resource.update'>;
-export type ResourcePatchActionDefinition = ResourceActionDefinition<'resource.patch'>;
+export type ResourceUpdatePositionsActionDefinition = ResourceActionDefinition<'resource.update.positions'> & ResourceActionWithIdDefinition;
+export type ResourcePatchActionDefinition = ResourceActionDefinition<'resource.patch'> & ResourceActionWithIdDefinition;
 export type AppMemberLogoutAction = BaseActionDefinition<'app.member.logout'>;
 export interface BaseResourceSubscribeActionDefinition<T extends Action['type']> extends BaseActionDefinition<T> {
     /**
@@ -1394,7 +1570,7 @@ export type MessageActionDefinition = BaseActionDefinition<'message'> & BaseMess
      */
     body: Remapper;
 };
-export type ActionDefinition = AnalyticsAction | AppMemberCurrentPatchAction | AppMemberDeleteAction | AppMemberInviteAction | AppMemberLoginAction | AppMemberLogoutAction | AppMemberPropertiesPatchAction | AppMemberQueryAction | AppMemberRegisterAction | AppMemberRoleUpdateAction | BaseActionDefinition<'dialog.error'> | BaseActionDefinition<'dialog.ok'> | BaseActionDefinition<'flow.back'> | BaseActionDefinition<'flow.cancel'> | BaseActionDefinition<'flow.finish'> | BaseActionDefinition<'flow.next'> | BaseActionDefinition<'group.query'> | BaseActionDefinition<'link.back'> | BaseActionDefinition<'link.next'> | BaseActionDefinition<'noop'> | BaseActionDefinition<'throw'> | ConditionActionDefinition | ControllerActionDefinition | DialogActionDefinition | DownloadActionDefinition | EachActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | GroupMemberDeleteActionDefinition | GroupMemberInviteActionDefinition | GroupMemberQueryActionDefinition | GroupMemberRoleUpdateActionDefinition | LinkActionDefinition | LogActionDefinition | MatchActionDefinition | MessageActionDefinition | NotifyActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourceHistoryGetActionDefinition | ResourcePatchActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageAppendActionDefinition | StorageDeleteActionDefinition | StorageReadActionDefinition | StorageSubtractActionDefinition | StorageUpdateActionDefinition | StorageWriteActionDefinition;
+export type ActionDefinition = AnalyticsAction | AppMemberCurrentPatchAction | AppMemberDeleteAction | AppMemberInviteAction | AppMemberLoginAction | AppMemberLogoutAction | AppMemberPropertiesPatchAction | AppMemberQueryAction | AppMemberRegisterAction | AppMemberRoleUpdateAction | BaseActionDefinition<'dialog.error'> | BaseActionDefinition<'dialog.ok'> | BaseActionDefinition<'flow.back'> | BaseActionDefinition<'flow.cancel'> | BaseActionDefinition<'flow.finish'> | BaseActionDefinition<'flow.next'> | BaseActionDefinition<'group.query'> | BaseActionDefinition<'link.back'> | BaseActionDefinition<'link.next'> | BaseActionDefinition<'noop'> | BaseActionDefinition<'throw'> | ConditionActionDefinition | ControllerActionDefinition | DialogActionDefinition | DownloadActionDefinition | EachActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | GroupMemberDeleteActionDefinition | GroupMemberInviteActionDefinition | GroupMemberQueryActionDefinition | GroupMemberRoleUpdateActionDefinition | LinkActionDefinition | LogActionDefinition | MatchActionDefinition | MessageActionDefinition | NotifyActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceDeleteAllActionDefinition | ResourceDeleteBulkActionDefinition | ResourceGetActionDefinition | ResourceHistoryGetActionDefinition | ResourcePatchActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ResourceUpdatePositionsActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageAppendActionDefinition | StorageDeleteActionDefinition | StorageReadActionDefinition | StorageSubtractActionDefinition | StorageUpdateActionDefinition | StorageWriteActionDefinition;
 export interface ActionType {
     /**
      * Whether or not app creators are required to define this action.
@@ -1519,14 +1695,14 @@ export interface LoopPageDefinition extends BasePageDefinition {
     /**
      * Template step that the loop will pass data onto
      */
-    foreach?: SubPageDefinition;
+    foreach: SubPageDefinition;
     /**
      * A mapping of actions that can be fired by the page to action handlers.
      */
     actions?: {
         onFlowCancel?: ActionDefinition;
         onFlowFinish?: ActionDefinition;
-        onLoad?: ActionDefinition;
+        onLoad: ActionDefinition;
     };
     /**
      * The method used to display the progress of the flow page.
@@ -1568,7 +1744,7 @@ export interface AppDefinition {
      *
      * This determines the default path of the app.
      */
-    name?: string;
+    name: string;
     /**
      * The description of the app.
      */
@@ -1615,6 +1791,14 @@ export interface AppDefinition {
          * @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.
          *
@@ -1656,6 +1840,10 @@ export interface AppDefinition {
      * Cron jobs associated with the app.
      */
     cron?: Record<string, CronDefinition>;
+    /**
+     * Webhooks associated with the app.
+     */
+    webhooks?: Record<string, WebhookDefinition>;
     /**
      * Companion containers of the app.
      */
@@ -1673,6 +1861,13 @@ 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 App {
     /**
      * The unique identifier for the app.
@@ -1683,7 +1878,7 @@ export interface App {
     /**
      * A domain name on which this app should be served.
      */
-    domain?: string;
+    domain?: string | null;
     /**
      * The name used for emails
      */
@@ -1691,7 +1886,7 @@ export interface App {
     /**
      * The id of the organization this app belongs to.
      */
-    OrganizationId?: string;
+    OrganizationId: string;
     /**
      * The name of the organization this app belongs to.
      */
@@ -1728,6 +1923,14 @@ export interface App {
      * Whether the Appsemble password login method should be shown.
      */
     showAppsembleLogin: boolean;
+    /**
+     * Whether to display App member's name in the title bar.
+     */
+    displayAppMemberName: boolean;
+    /**
+     * Whether to display the installation prompt to the app members.
+     */
+    displayInstallationPrompt: boolean;
     /**
      * Whether the Appsemble OAuth2 login method should be shown.
      */
@@ -1739,11 +1942,11 @@ export interface App {
     /**
      * The Sentry DSN of the app.
      */
-    sentryDsn: string;
+    sentryDsn?: string;
     /**
      * The Sentry environment associated with the Sentry DSN.
      */
-    sentryEnvironment: string;
+    sentryEnvironment?: string;
     /**
      * The app definition.
      */
@@ -1751,7 +1954,7 @@ export interface App {
     /**
      * The app definition formatted as YAML.
      */
-    yaml: string;
+    yaml?: string;
     /**
      * An app rating.
      */
@@ -2030,7 +2233,7 @@ export interface Messages {
     /**
      * A mapping of message id to message content.
      */
-    messages: AppsembleMessages;
+    messages?: AppsembleMessages;
 }
 export interface AppMessages {
     /**
@@ -2128,6 +2331,13 @@ export interface AppServiceSecretDefinition {
      * The custom certificate authority used for client-certificate method.
      */
     ca?: string;
+    /**
+     * If a secret is marked public, it can be applied to the unauthenticated users, e.g. in the
+     * requests originating in a custom sign up or login page.
+     *
+     * @default false
+     */
+    public: boolean;
 }
 export interface AppServiceSecret extends AppServiceSecretDefinition {
     /**
@@ -2135,6 +2345,22 @@ export interface AppServiceSecret extends AppServiceSecretDefinition {
      */
     id: number;
 }
+export interface AppWebhookSecretDefinition {
+    /**
+     * The name of the webhook this secret is tied to.
+     */
+    webhookName: string;
+    /**
+     * An optional name to give extra clarity what the secret is used for.
+     */
+    name?: string;
+}
+export interface AppWebhookSecret extends AppWebhookSecretDefinition {
+    /**
+     * An autogenerated ID.
+     */
+    id: string;
+}
 export interface AppOAuth2Secret extends OAuth2Provider {
     /**
      * An autogenerated ID.
@@ -2201,66 +2427,6 @@ export interface AppSamlSecret extends WritableAppSamlSecret {
      */
     spCertificate?: string;
 }
-export interface Training {
-    /**
-     * Id of the training
-     */
-    id: number;
-    /**
-     * Title of the training.
-     */
-    title: string;
-    /**
-     * A brief overview of what the training is about.
-     */
-    description: string;
-    /**
-     * Tags related to competence of the training.
-     */
-    competences: string[];
-    /**
-     * Difficulty level of the training.
-     */
-    difficultyLevel: number;
-    /**
-     * The creation date of the training.
-     */
-    $created?: string;
-    /**
-     * The date when the training was last updated.
-     */
-    $updated?: string;
-}
-export interface TrainingBlock {
-    /**
-     * ID of the training block
-     */
-    id: string;
-    /**
-     * Title of the block.
-     */
-    title: string;
-    /**
-     * Id of the parent training.
-     */
-    trainingId: number;
-    /**
-     * A link pointing to the documentation of Appsemble.
-     */
-    documentationLink?: string;
-    /**
-     * A link pointing to a video regarding the topic.
-     */
-    videoLink?: string;
-    /**
-     * Link to an external resource.
-     */
-    externalResource?: string;
-    /**
-     * Example code for the user to try out.
-     */
-    exampleCode?: string;
-}
 export type SAMLStatus = 'badsignature' | 'emailconflict' | 'invalidrelaystate' | 'invalidsecret' | 'invalidstatuscode' | 'invalidsubjectconfirmation' | 'missingnameid' | 'missingsubject';
 export interface ProjectConfig {
     /**
@@ -2327,7 +2493,7 @@ export interface BlockManifest extends ProjectManifest {
     /**
      * The URL that can be used to fetch this block’s icon.
      */
-    iconUrl?: string;
+    iconUrl?: string | null;
     /**
      * The languages that are supported by the block by default.
      *

package/index.js

@@ -14,6 +14,7 @@ export * from './ssl.js';
 export * from './template.js';
 export * from './theme.js';
 export * from './oauth2.js';
+export * from './training.js';
 export * from './quota.js';
 export * from './permissions.js';
 export * from './roles.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.30.14-test.5",
+  "version": "0.32.1-test.14",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",
@@ -23,14 +23,16 @@
   "sideEffects": false,
   "type": "module",
   "exports": {
-    ".": [
-      "./index.js",
-      "./index.ts"
-    ]
+    ".": {
+      "ts-source": "./index.ts",
+      "default": "./index.js"
+    }
   },
   "files": [
     "**/*.d.ts",
     "**/*.js",
+    "!**/*.test.js",
+    "!**/*.test.d.ts",
     "!*.config.js"
   ],
   "scripts": {
@@ -39,8 +41,9 @@
   },
   "dependencies": {
     "@fortawesome/fontawesome-common-types": "^6.0.0",
-    "jsonschema": "^1.0.0",
+    "jsonschema": "~1.4.1",
     "openapi-types": "^12.0.0",
+    "react": "^18.0.0",
     "type-fest": "^4.0.0"
   }
 }

package/permissions.d.ts

@@ -370,31 +370,7 @@ export declare enum OrganizationPermission {
     /**
      * The permission to send manual push notifications for an app.
      */
-    PushAppNotifications = 65,
-    /**
-     * The permission to create trainings.
-     */
-    CreateTrainings = 66,
-    /**
-     * The permission to update trainings.
-     */
-    UpdateTrainings = 67,
-    /**
-     * The permission to delete trainings.
-     */
-    DeleteTrainings = 68,
-    /**
-     * The permission to create training blocks.
-     */
-    CreateTrainingBlocks = 69,
-    /**
-     * The permission to update training blocks.
-     */
-    UpdateTrainingBlocks = 70,
-    /**
-     * The permission to delete training blocks.
-     */
-    DeleteTrainingBlocks = 71
+    PushAppNotifications = 65
 }
 export declare const appOrganizationPermissionMapping: {
     [key in AppPermission]: OrganizationPermission;

package/permissions.js

@@ -373,30 +373,6 @@ export var OrganizationPermission;
      * The permission to send manual push notifications for an app.
      */
     OrganizationPermission[OrganizationPermission["PushAppNotifications"] = 65] = "PushAppNotifications";
-    /**
-     * The permission to create trainings.
-     */
-    OrganizationPermission[OrganizationPermission["CreateTrainings"] = 66] = "CreateTrainings";
-    /**
-     * The permission to update trainings.
-     */
-    OrganizationPermission[OrganizationPermission["UpdateTrainings"] = 67] = "UpdateTrainings";
-    /**
-     * The permission to delete trainings.
-     */
-    OrganizationPermission[OrganizationPermission["DeleteTrainings"] = 68] = "DeleteTrainings";
-    /**
-     * The permission to create training blocks.
-     */
-    OrganizationPermission[OrganizationPermission["CreateTrainingBlocks"] = 69] = "CreateTrainingBlocks";
-    /**
-     * The permission to update training blocks.
-     */
-    OrganizationPermission[OrganizationPermission["UpdateTrainingBlocks"] = 70] = "UpdateTrainingBlocks";
-    /**
-     * The permission to delete training blocks.
-     */
-    OrganizationPermission[OrganizationPermission["DeleteTrainingBlocks"] = 71] = "DeleteTrainingBlocks";
 })(OrganizationPermission || (OrganizationPermission = {}));
 export const appOrganizationPermissionMapping = {
     [AppPermission.CreateAppInvites]: OrganizationPermission.CreateAppInvites,

package/resource.d.ts

@@ -51,7 +51,7 @@ export interface ResourceAuthor {
     /**
      * The display name of the user.
      */
-    name: string;
+    name?: string;
 }
 export interface ResourceGroup {
     /**
@@ -66,5 +66,5 @@ export interface ResourceGroup {
 export interface ResourceVersion {
     created: string;
     data: Record<string, unknown>;
-    author: ResourceAuthor;
+    author?: ResourceAuthor;
 }

package/roles.js

@@ -85,20 +85,10 @@ const OrganizationBlockManagerPermissions = [
     OrganizationPermission.PublishBlocks,
     OrganizationPermission.DeleteBlocks,
 ];
-const OrganizationTrainingManagerPermissions = [
-    ...OrganizationMemberPermissions,
-    OrganizationPermission.CreateTrainings,
-    OrganizationPermission.UpdateTrainings,
-    OrganizationPermission.DeleteTrainings,
-    OrganizationPermission.CreateTrainingBlocks,
-    OrganizationPermission.UpdateTrainingBlocks,
-    OrganizationPermission.DeleteTrainingBlocks,
-];
 const OrganizationMaintainerPermissions = [
     ...OrganizationAppManagerPermissions,
     ...OrganizationAppCollectionManagerPermissions,
     ...OrganizationBlockManagerPermissions,
-    ...OrganizationTrainingManagerPermissions,
     OrganizationPermission.CreateApps,
     OrganizationPermission.DeleteApps,
     OrganizationPermission.CreateOrganizationInvites,

package/training.d.ts

@@ -0,0 +1,60 @@
+import { type ComponentType } from 'react';
+export type TrainingStatus = 'available' | 'blocked' | 'completed' | 'in progress';
+export interface TrainingChapter {
+    /**
+     * ID of the chapter.
+     */
+    id: string;
+    /**
+     * Title of the chapter
+     */
+    title: string;
+    /**
+     * List of trainings that make up this chapter.
+     */
+    trainings: Training[];
+    /**
+     * The ID of the chapter that has to be completed before this one can be accessed.
+     */
+    blockedBy?: string;
+    /**
+     * The status of the chapter
+     */
+    status: TrainingStatus;
+}
+export interface Training {
+    /**
+     * Id of the training.
+     */
+    id: string;
+    /**
+     * Title of the training
+     */
+    title: string;
+    /**
+     * The path of the training page to route to.
+     */
+    path: string;
+    /**
+     * The content of the training to render.
+     */
+    content?: ComponentType;
+    /**
+     * The status of the training
+     */
+    status: TrainingStatus;
+}
+export interface TrainingChapterProperties {
+    /**
+     * The ID of the chapter that has to be completed before this one can be accessed.
+     */
+    blockedBy: string;
+    /**
+     * Title of the chapter
+     */
+    title: string;
+    /**
+     * The order in which the trainings must be completed
+     */
+    trainingOrder: string[];
+}

package/training.js

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