@appsemble/types 0.20.6 → 0.20.9

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.
      *
@@ -229,41 +284,7 @@ export interface Remappers {
     /**
      * 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;
-    };
+    ics: DurationICSRemapper | EndTimeICSRemapper;
     /**
      * Checks if condition results in a truthy value.
      *
@@ -288,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.
      */
@@ -310,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.
      */
@@ -431,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.
@@ -480,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.
      */
@@ -775,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> {

package/package.json

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