@appsemble/types 0.20.7 → 0.20.8

package/dist/index.d.ts

@@ -309,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.
      */
@@ -331,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.
      */
@@ -452,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.
@@ -501,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.
      */
@@ -796,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.7",
+  "version": "0.20.8",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",
@@ -30,7 +30,7 @@
     "test": "jest"
   },
   "dependencies": {
-    "@appsemble/sdk": "0.20.7",
+    "@appsemble/sdk": "0.20.8",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "jsonschema": "^1.0.0",
     "openapi-types": "^11.0.0",