@appsemble/types 0.20.3 → 0.20.6

package/dist/index.d.ts

@@ -226,6 +226,44 @@ 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: {
+        /**
+         * The start of the icalendar event.
+         */
+        start: Remapper;
+        /**
+         * The duration of the event.
+         *
+         * @example '1w 3d 10h 30m'
+         */
+        duration: 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;
+    };
     /**
      * Checks if condition results in a truthy value.
      *
@@ -449,7 +487,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 +552,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 +586,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:
+     *
+     * - \`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.
      *
-     * Should result in an array of URLs or asset IDs.
+     * If the attachment is a string, it will be treated as the target.
      */
     attachments?: Remapper;
 }
@@ -766,7 +820,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.3",
+  "version": "0.20.6",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",
@@ -30,7 +30,7 @@
     "test": "jest"
   },
   "dependencies": {
-    "@appsemble/sdk": "0.20.3",
+    "@appsemble/sdk": "0.20.6",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "jsonschema": "^1.0.0",
     "openapi-types": "^10.0.0",