@appsemble/types 0.19.9 → 0.19.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -504,6 +504,12 @@ export interface EmailActionDefinition extends BaseActionDefinition<'email'> {
504
504
  * The recipient of the email.
505
505
  */
506
506
  to?: Remapper;
507
+ /**
508
+ * The name of the sender.
509
+ *
510
+ * The default value depends on the email server.
511
+ */
512
+ from?: Remapper;
507
513
  /**
508
514
  * The recipients to CC the email to.
509
515
  */
@@ -563,11 +569,18 @@ export interface ShareActionDefinition extends BaseActionDefinition<'share'> {
563
569
  */
564
570
  title?: Remapper;
565
571
  }
572
+ declare type StorageType = 'indexedDB' | 'localStorage' | 'sessionStorage';
566
573
  export interface StorageReadActionDefinition extends BaseActionDefinition<'storage.read'> {
567
574
  /**
568
575
  * The key of the entry to read from the app’s storage.
569
576
  */
570
577
  key: Remapper;
578
+ /**
579
+ * The mechanism used to read the data from.
580
+ *
581
+ * @default 'indexedDB'
582
+ */
583
+ storage?: StorageType;
571
584
  }
572
585
  export interface StorageWriteActionDefinition extends BaseActionDefinition<'storage.write'> {
573
586
  /**
@@ -578,6 +591,12 @@ export interface StorageWriteActionDefinition extends BaseActionDefinition<'stor
578
591
  * The data to write to the app’s storage.
579
592
  */
580
593
  value: Remapper;
594
+ /**
595
+ * The mechanism used to read the data from.
596
+ *
597
+ * @default 'indexedDB'
598
+ */
599
+ storage?: StorageType;
581
600
  }
582
601
  export interface UserLoginAction extends BaseActionDefinition<'user.login'> {
583
602
  /**
@@ -995,6 +1014,10 @@ export interface App {
995
1014
  */
996
1015
  id?: number;
997
1016
  domain?: string;
1017
+ /**
1018
+ * The name used for emails
1019
+ */
1020
+ emailName?: string;
998
1021
  /**
999
1022
  * The id of the organization this app belongs to.
1000
1023
  */
@@ -1,12 +1,42 @@
1
1
  export interface Resource {
2
+ /**
3
+ * The unique ID of the resource
4
+ */
2
5
  id: number;
6
+ /**
7
+ * A boolean indicating whether or not the resource will be cloned with the app.
8
+ *
9
+ * This only applies to template apps.
10
+ */
3
11
  $clonable: boolean;
12
+ /**
13
+ * When the resource was first created as an ISO 8601 formatted string.
14
+ */
4
15
  $created: string;
16
+ /**
17
+ * When the resource was last updated as an ISO 8601 formatted string.
18
+ */
5
19
  $updated: string;
20
+ /**
21
+ * The user who initially created the resource.
22
+ */
6
23
  $author?: ResourceAuthor;
24
+ /**
25
+ * The user who last updated the resource.
26
+ */
27
+ $editor?: ResourceAuthor;
28
+ /**
29
+ * Any non-reserved properties are allowed on the resource as defined in the app definition.
30
+ */
7
31
  [key: string]: unknown;
8
32
  }
9
33
  export interface ResourceAuthor {
34
+ /**
35
+ * The user ID of the author.
36
+ */
10
37
  id: string;
38
+ /**
39
+ * The display name of the user.
40
+ */
11
41
  name: string;
12
42
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@appsemble/types",
3
- "version": "0.19.9",
3
+ "version": "0.19.13",
4
4
  "description": "TypeScript definitions reused within Appsemble internally",
5
5
  "keywords": [
6
6
  "app",
@@ -30,10 +30,10 @@
30
30
  "test": "jest"
31
31
  },
32
32
  "dependencies": {
33
- "@appsemble/sdk": "0.19.9",
33
+ "@appsemble/sdk": "0.19.13",
34
34
  "@fortawesome/fontawesome-common-types": "^0.2.0",
35
35
  "jsonschema": "^1.0.0",
36
- "openapi-types": "^9.0.0",
36
+ "openapi-types": "^10.0.0",
37
37
  "type-fest": "^2.0.0"
38
38
  }
39
39
  }