@appsemble/types 0.19.11 → 0.19.15

package/dist/index.d.ts

@@ -382,11 +382,21 @@ interface ResourceReference {
     update?: ResourceReferenceAction;
     delete?: ResourceReferenceAction;
 }
+export interface ResourceHistoryDefinition {
+    /**
+     * If set to `false`, edits are still tracked, but exactly what changed is lost.
+     */
+    data: boolean;
+}
 export interface ResourceDefinition {
     /**
      * The default list of roles used for permission checks for each action.
      */
     roles?: string[];
+    /**
+     * A definition of how versioning should happen for instances of this resource.
+     */
+    history?: ResourceHistoryDefinition | boolean;
     /**
      * The definition for the `resource.create` action.
      */
@@ -569,11 +579,18 @@ export interface ShareActionDefinition extends BaseActionDefinition<'share'> {
      */
     title?: Remapper;
 }
+declare type StorageType = 'indexedDB' | 'localStorage' | 'sessionStorage';
 export interface StorageReadActionDefinition extends BaseActionDefinition<'storage.read'> {
     /**
      * The key of the entry to read from the app’s storage.
      */
     key: Remapper;
+    /**
+     * The mechanism used to read the data from.
+     *
+     * @default 'indexedDB'
+     */
+    storage?: StorageType;
 }
 export interface StorageWriteActionDefinition extends BaseActionDefinition<'storage.write'> {
     /**
@@ -584,6 +601,12 @@ export interface StorageWriteActionDefinition extends BaseActionDefinition<'stor
      * The data to write to the app’s storage.
      */
     value: Remapper;
+    /**
+     * The mechanism used to read the data from.
+     *
+     * @default 'indexedDB'
+     */
+    storage?: StorageType;
 }
 export interface UserLoginAction extends BaseActionDefinition<'user.login'> {
     /**

package/dist/resource.d.ts

@@ -1,12 +1,47 @@
 export interface Resource {
+    /**
+     * The unique ID of the resource
+     */
     id: number;
+    /**
+     * A boolean indicating whether or not the resource will be cloned with the app.
+     *
+     * This only applies to template apps.
+     */
     $clonable: boolean;
+    /**
+     * When the resource was first created as an ISO 8601 formatted string.
+     */
     $created: string;
+    /**
+     * When the resource was last updated as an ISO 8601 formatted string.
+     */
     $updated: string;
+    /**
+     * The user who initially created the resource.
+     */
     $author?: ResourceAuthor;
+    /**
+     * The user who last updated the resource.
+     */
+    $editor?: ResourceAuthor;
+    /**
+     * Any non-reserved properties are allowed on the resource as defined in the app definition.
+     */
     [key: string]: unknown;
 }
 export interface ResourceAuthor {
+    /**
+     * The user ID of the author.
+     */
     id: string;
+    /**
+     * The display name of the user.
+     */
     name: string;
 }
+export interface ResourceVersion {
+    created: string;
+    data: Record<string, unknown>;
+    author: ResourceAuthor;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.19.11",
+  "version": "0.19.15",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",
@@ -30,7 +30,7 @@
     "test": "jest"
   },
   "dependencies": {
-    "@appsemble/sdk": "0.19.11",
+    "@appsemble/sdk": "0.19.15",
     "@fortawesome/fontawesome-common-types": "^0.2.0",
     "jsonschema": "^1.0.0",
     "openapi-types": "^10.0.0",