@appsemble/types 0.20.5 → 0.20.8

package/dist/index.d.ts

@@ -165,6 +165,49 @@ export interface TokenResponse {
     refresh_token?: string;
     token_type: 'bearer';
 }
+interface BaseICSRemapper {
+    /**
+     * The start of the icalendar event.
+     */
+    start: Remapper;
+    /**
+     * The title of the event.
+     */
+    title: Remapper;
+    /**
+     * An optional description of the event.
+     */
+    description?: Remapper;
+    /**
+     * An optional link to attach to the event.
+     */
+    url?: Remapper;
+    /**
+     * An optional location description to attach to the event.
+     */
+    location?: Remapper;
+    /**
+     * An optional geolocation description to attach to the event.
+     *
+     * This must be an object with the properties `lat` or `latitude`, and `lon`, `lng` or
+     * `longitude`.
+     */
+    coordinates?: Remapper;
+}
+interface DurationICSRemapper extends BaseICSRemapper {
+    /**
+     * The duration of the event.
+     *
+     * @example '1w 3d 10h 30m'
+     */
+    duration: Remapper;
+}
+interface EndTimeICSRemapper extends BaseICSRemapper {
+    /**
+     * The end time of the event as a date or a date string.
+     */
+    end: Remapper;
+}
 export interface Remappers {
     /**
      * Get app metadata.
@@ -207,6 +250,18 @@ export interface Remappers {
      * Returns `true` if all entries are equal, otherwise `false`.
      */
     equals: Remapper[];
+    /**
+     * Compares the first computed remapper value with the second computed remapper value.
+     *
+     * Returns `true` of the first entry is greater than the second entry.
+     */
+    gt: [Remapper, Remapper];
+    /**
+     * Compares the first computed remapper value with the second computed remapper value.
+     *
+     * Returns `true` of the first entry is less than the second entry.
+     */
+    lt: [Remapper, Remapper];
     /**
      * Builds an array based on the given data and remappers.
      *
@@ -226,6 +281,10 @@ export interface Remappers {
      * If the input is not an array, the input is returned without any modifications.
      */
     'array.unique': Remapper;
+    /**
+     * Create an icalendar event.
+     */
+    ics: DurationICSRemapper | EndTimeICSRemapper;
     /**
      * Checks if condition results in a truthy value.
      *
@@ -250,6 +309,20 @@ export interface Remappers {
      * Assign properties to an existing object given some predefined mapper keys.
      */
     'object.assign': Record<string, Remapper>;
+    /**
+     * Remove properties from an existing object based on the given the object keys.
+     *
+     * Nested properties can be removed using arrays of keys.
+     *
+     * @example
+     * ```yaml
+     * object.omit:
+     *   - foo   # Removes the property foo
+     *   - - bar # Removes the property baz inside of bar
+     *     - baz
+     * ```
+     */
+    'object.omit': (string[] | string)[];
     /**
      * Use a static value.
      */
@@ -272,6 +345,27 @@ export interface Remappers {
      * If the input is not an array, the input is returned as-is.
      */
     'random.choice': null;
+    /**
+     * Pick and return a random entry from an array.
+     *
+     * If the input is not an array, the input is returned as-is.
+     */
+    'random.integer': [number, number];
+    /**
+     * Pick and return a random entry from an array.
+     *
+     * If the input is not an array, the input is returned as-is.
+     */
+    'random.float': [number, number];
+    /**
+     * Pick and return a random entry from an array.
+     *
+     * If the input is not an array, the input is returned as-is.
+     */
+    'random.string': {
+        choice: string;
+        length: number;
+    };
     /**
      * Get the input data as it was initially passed to the remap function.
      */
@@ -393,6 +487,16 @@ export interface ResourceHistoryDefinition {
      */
     data: boolean;
 }
+export interface ResourceView {
+    /**
+     * The roles required to use this view.
+     */
+    roles: string[];
+    /**
+     * The remappers used to transform the output.
+     */
+    remap: Remapper;
+}
 export interface ResourceDefinition {
     /**
      * The default list of roles used for permission checks for each action.
@@ -442,6 +546,10 @@ export interface ResourceDefinition {
      * @default autogenerated for use with the Appsemble resource API.
      */
     url?: string;
+    /**
+     * The alternate views of this resource.
+     */
+    views?: Record<string, ResourceView>;
     /**
      * The references this resources has to other resources.
      */
@@ -449,7 +557,7 @@ export interface ResourceDefinition {
     /**
      * A time string representing when a resource should expire.
      *
-     * Example: 1d 8h 30m
+     * @example '1d 8h 30m'
      */
     expires?: string;
 }
@@ -514,6 +622,12 @@ export interface DialogActionDefinition extends BaseActionDefinition<'dialog'> {
      */
     title?: Remapper;
 }
+export interface DownloadActionDefinition extends BaseActionDefinition<'download'> {
+    /**
+     * The filename to download the file as. It must include a file extension.
+     */
+    filename: string;
+}
 export interface EmailActionDefinition extends BaseActionDefinition<'email'> {
     /**
      * The recipient of the email.
@@ -542,9 +656,19 @@ export interface EmailActionDefinition extends BaseActionDefinition<'email'> {
      */
     body: Remapper;
     /**
-     * The attachments that should be attached to the email
+     * The attachments to include in the email.
+     *
+     * The remapper must resolve to an object containing the following properties:
      *
-     * Should result in an array of URLs or asset IDs.
+     * - \`target\`: The asset ID or link to download contents from to add as an attachment. This is
+     * mutually exclusive with \`content\`.
+     * - \`content\`: The raw content to include as the file content. This is mutually exclusive with
+     * \`target\`.
+     * - \`filename\`: The filename to include the attachment as.
+     * - \`accept\` If the target is a URL, this will be set as the HTTP \`Accept\` header when
+     * downloading the file.
+     *
+     * If the attachment is a string, it will be treated as the target.
      */
     attachments?: Remapper;
 }
@@ -721,11 +845,17 @@ interface ResourceActionDefinition<T extends Action['type']> extends RequestLike
      */
     resource: string;
 }
+interface ViewResourceDefinition {
+    /**
+     * The view to use for the request.
+     */
+    view?: string;
+}
 export declare type RequestActionDefinition = RequestLikeActionDefinition<'request'>;
 export declare type ResourceCreateActionDefinition = ResourceActionDefinition<'resource.create'>;
 export declare type ResourceDeleteActionDefinition = ResourceActionDefinition<'resource.delete'>;
-export declare type ResourceGetActionDefinition = ResourceActionDefinition<'resource.get'>;
-export declare type ResourceQueryActionDefinition = ResourceActionDefinition<'resource.query'>;
+export declare type ResourceGetActionDefinition = ResourceActionDefinition<'resource.get'> & ViewResourceDefinition;
+export declare type ResourceQueryActionDefinition = ResourceActionDefinition<'resource.query'> & ViewResourceDefinition;
 export declare type ResourceCountActionDefinition = ResourceActionDefinition<'resource.count'>;
 export declare type ResourceUpdateActionDefinition = ResourceActionDefinition<'resource.update'>;
 export interface BaseResourceSubscribeActionDefinition<T extends Action['type']> extends BaseActionDefinition<T> {
@@ -766,7 +896,7 @@ export declare type MessageActionDefinition = BaseActionDefinition<'message'> &
      */
     body: Remapper;
 };
-export declare type ActionDefinition = AnalyticsAction | BaseActionDefinition<'dialog.error'> | BaseActionDefinition<'dialog.ok'> | BaseActionDefinition<'flow.back'> | BaseActionDefinition<'flow.cancel'> | BaseActionDefinition<'flow.finish'> | BaseActionDefinition<'flow.next'> | BaseActionDefinition<'link.back'> | BaseActionDefinition<'link.next'> | BaseActionDefinition<'noop'> | BaseActionDefinition<'team.join'> | BaseActionDefinition<'team.list'> | BaseActionDefinition<'throw'> | ConditionActionDefinition | DialogActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | LinkActionDefinition | LogActionDefinition | MessageActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageReadActionDefinition | StorageWriteActionDefinition | TeamInviteActionDefinition | UserLoginAction | UserRegisterAction | UserUpdateAction;
+export declare type ActionDefinition = AnalyticsAction | BaseActionDefinition<'dialog.error'> | BaseActionDefinition<'dialog.ok'> | BaseActionDefinition<'flow.back'> | BaseActionDefinition<'flow.cancel'> | BaseActionDefinition<'flow.finish'> | BaseActionDefinition<'flow.next'> | BaseActionDefinition<'link.back'> | BaseActionDefinition<'link.next'> | BaseActionDefinition<'noop'> | BaseActionDefinition<'team.join'> | BaseActionDefinition<'team.list'> | BaseActionDefinition<'throw'> | ConditionActionDefinition | DialogActionDefinition | DownloadActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | LinkActionDefinition | LogActionDefinition | MessageActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageReadActionDefinition | StorageWriteActionDefinition | TeamInviteActionDefinition | UserLoginAction | UserRegisterAction | UserUpdateAction;
 export interface ActionType {
     /**
      * Whether or not app creators are required to define this action.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.20.5",
+  "version": "0.20.8",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",
@@ -30,10 +30,10 @@
     "test": "jest"
   },
   "dependencies": {
-    "@appsemble/sdk": "0.20.5",
+    "@appsemble/sdk": "0.20.8",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "jsonschema": "^1.0.0",
-    "openapi-types": "^10.0.0",
+    "openapi-types": "^11.0.0",
     "type-fest": "^2.0.0"
   }
 }