@appsemble/types 0.20.20 → 0.20.22
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/README.md +4 -4
- package/action.d.ts +8 -8
- package/action.ts +4 -0
- package/app.d.ts +1 -1
- package/bulma.d.ts +2 -2
- package/http.d.ts +1 -1
- package/index.d.ts +111 -22
- package/index.ts +110 -2
- package/package.json +1 -1
- package/ssl.d.ts +2 -2
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
#  Appsemble Types
|
|
2
2
|
|
|
3
3
|
> Reusable TypeScript types
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/@appsemble/types)
|
|
6
|
-
[](https://gitlab.com/appsemble/appsemble/-/releases/0.20.22)
|
|
7
|
+
[](https://codecov.io/gl/appsemble/appsemble)
|
|
8
8
|
[](https://prettier.io)
|
|
9
9
|
|
|
10
10
|
## Installation
|
|
@@ -21,5 +21,5 @@ not guaranteed.
|
|
|
21
21
|
|
|
22
22
|
## License
|
|
23
23
|
|
|
24
|
-
[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.
|
|
24
|
+
[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.22/LICENSE.md) ©
|
|
25
25
|
[Appsemble](https://appsemble.com)
|
package/action.d.ts
CHANGED
|
@@ -32,15 +32,15 @@ interface RequestLikeAction<T extends Action['type']> extends BaseAction<T> {
|
|
|
32
32
|
*/
|
|
33
33
|
url: Remapper;
|
|
34
34
|
}
|
|
35
|
-
export
|
|
36
|
-
export
|
|
37
|
-
export
|
|
38
|
-
export
|
|
39
|
-
export
|
|
40
|
-
export
|
|
41
|
-
export
|
|
35
|
+
export type RequestAction = RequestLikeAction<'request'>;
|
|
36
|
+
export type ResourceCreateAction = RequestLikeAction<'resource.create'>;
|
|
37
|
+
export type ResourceDeleteAction = RequestLikeAction<'resource.delete'>;
|
|
38
|
+
export type ResourceGetAction = RequestLikeAction<'resource.get'>;
|
|
39
|
+
export type ResourceQueryAction = RequestLikeAction<'resource.query'>;
|
|
40
|
+
export type ResourceCountAction = RequestLikeAction<'resource.count'>;
|
|
41
|
+
export type ResourceUpdateAction = RequestLikeAction<'resource.update'>;
|
|
42
42
|
/**
|
|
43
43
|
* An action that can be called from within a block.
|
|
44
44
|
*/
|
|
45
|
-
export
|
|
45
|
+
export type Action = BaseAction<'analytics'> | BaseAction<'condition'> | BaseAction<'dialog.error'> | BaseAction<'dialog.ok'> | BaseAction<'dialog'> | BaseAction<'download'> | BaseAction<'each'> | BaseAction<'email'> | BaseAction<'event'> | BaseAction<'flow.back'> | BaseAction<'flow.cancel'> | BaseAction<'flow.finish'> | BaseAction<'flow.next'> | BaseAction<'flow.to'> | BaseAction<'link.back'> | BaseAction<'link.next'> | BaseAction<'message'> | BaseAction<'noop'> | BaseAction<'resource.subscription.status'> | BaseAction<'resource.subscription.subscribe'> | BaseAction<'resource.subscription.toggle'> | BaseAction<'resource.subscription.unsubscribe'> | BaseAction<'share'> | BaseAction<'static'> | BaseAction<'storage.append'> | BaseAction<'storage.delete'> | BaseAction<'storage.read'> | BaseAction<'storage.subtract'> | BaseAction<'storage.update'> | BaseAction<'storage.write'> | BaseAction<'team.invite'> | BaseAction<'team.join'> | BaseAction<'team.list'> | BaseAction<'throw'> | BaseAction<'user.login'> | BaseAction<'user.register'> | BaseAction<'user.update'> | LinkAction | LogAction | RequestAction | ResourceCountAction | ResourceCreateAction | ResourceDeleteAction | ResourceGetAction | ResourceQueryAction | ResourceUpdateAction;
|
|
46
46
|
export {};
|
package/action.ts
CHANGED
|
@@ -74,7 +74,11 @@ export type Action =
|
|
|
74
74
|
| BaseAction<'resource.subscription.unsubscribe'>
|
|
75
75
|
| BaseAction<'share'>
|
|
76
76
|
| BaseAction<'static'>
|
|
77
|
+
| BaseAction<'storage.append'>
|
|
78
|
+
| BaseAction<'storage.delete'>
|
|
77
79
|
| BaseAction<'storage.read'>
|
|
80
|
+
| BaseAction<'storage.subtract'>
|
|
81
|
+
| BaseAction<'storage.update'>
|
|
78
82
|
| BaseAction<'storage.write'>
|
|
79
83
|
| BaseAction<'team.invite'>
|
|
80
84
|
| BaseAction<'team.join'>
|
package/app.d.ts
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
* Appsemble app store.
|
|
9
9
|
* - **private**: The app is only visible to people who are part of the organization.
|
|
10
10
|
*/
|
|
11
|
-
export
|
|
11
|
+
export type AppVisibility = 'private' | 'public' | 'unlisted';
|
|
12
12
|
/**
|
|
13
13
|
* This defines how teams are handled by an app.
|
|
14
14
|
*/
|
package/bulma.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* A color known to Bulma.
|
|
3
3
|
*/
|
|
4
|
-
export
|
|
5
|
-
export
|
|
4
|
+
export type BulmaColor = 'danger' | 'dark' | 'info' | 'link' | 'primary' | 'success' | 'warning' | 'white';
|
|
5
|
+
export type BulmaSize = 'large' | 'medium' | 'normal' | 'small';
|
package/http.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Common HTTP methods, but either all upper case or all lower case.
|
|
3
3
|
*/
|
|
4
|
-
export
|
|
4
|
+
export type HTTPMethods = 'DELETE' | 'delete' | 'GET' | 'get' | 'PATCH' | 'patch' | 'POST' | 'post' | 'PUT' | 'put';
|
package/index.d.ts
CHANGED
|
@@ -322,11 +322,13 @@ export interface Remappers {
|
|
|
322
322
|
*/
|
|
323
323
|
'array.append': Remapper[];
|
|
324
324
|
/**
|
|
325
|
-
* Remove item(s) from an array given a predefined array of indices.
|
|
325
|
+
* Remove item(s) from an array given a predefined array of remappable indices.
|
|
326
|
+
*
|
|
327
|
+
* Only the remapped values that are turned into numbers are applied.
|
|
326
328
|
*
|
|
327
329
|
* If the input is not an array an empty array is returned.
|
|
328
330
|
*/
|
|
329
|
-
'array.omit':
|
|
331
|
+
'array.omit': Remapper[];
|
|
330
332
|
/**
|
|
331
333
|
* Create a new object given some predefined mapper keys.
|
|
332
334
|
*/
|
|
@@ -402,6 +404,21 @@ export interface Remappers {
|
|
|
402
404
|
* 0 is the index of the first item in the history stack.
|
|
403
405
|
*/
|
|
404
406
|
history: number;
|
|
407
|
+
/**
|
|
408
|
+
* Create a new object with properties from the history stack at a certain index.
|
|
409
|
+
*/
|
|
410
|
+
'from.history': {
|
|
411
|
+
/**
|
|
412
|
+
* The index of the history stack item to apply.
|
|
413
|
+
*
|
|
414
|
+
* 0 is the index of the first item in the history stack.
|
|
415
|
+
*/
|
|
416
|
+
index: number;
|
|
417
|
+
/**
|
|
418
|
+
* Predefined mapper keys to choose what properties to apply.
|
|
419
|
+
*/
|
|
420
|
+
props: Record<string, Remapper>;
|
|
421
|
+
};
|
|
405
422
|
/**
|
|
406
423
|
* Assign properties from the history stack at a certain index to an existing object.
|
|
407
424
|
*/
|
|
@@ -477,7 +494,7 @@ export interface Remappers {
|
|
|
477
494
|
translate: string;
|
|
478
495
|
user: keyof UserInfo;
|
|
479
496
|
}
|
|
480
|
-
export
|
|
497
|
+
export type Remapper = RequireExactlyOne<Remappers> | RequireExactlyOne<Remappers>[] | boolean | number | string;
|
|
481
498
|
export interface SubscriptionResponseResource {
|
|
482
499
|
create: boolean;
|
|
483
500
|
update: boolean;
|
|
@@ -488,7 +505,7 @@ export interface SubscriptionResponseResource {
|
|
|
488
505
|
delete: boolean;
|
|
489
506
|
}>;
|
|
490
507
|
}
|
|
491
|
-
export
|
|
508
|
+
export type SubscriptionResponse = Record<string, SubscriptionResponseResource>;
|
|
492
509
|
export interface RoleDefinition {
|
|
493
510
|
description?: string;
|
|
494
511
|
inherits?: string[];
|
|
@@ -505,8 +522,8 @@ export interface Security {
|
|
|
505
522
|
*/
|
|
506
523
|
teams?: TeamsDefinition;
|
|
507
524
|
}
|
|
508
|
-
export
|
|
509
|
-
export
|
|
525
|
+
export type Navigation = 'bottom' | 'hidden' | 'left-menu';
|
|
526
|
+
export type LayoutPosition = 'hidden' | 'navbar' | 'navigation';
|
|
510
527
|
export interface NotificationDefinition {
|
|
511
528
|
to?: string[];
|
|
512
529
|
subscribe?: 'all' | 'both' | 'single';
|
|
@@ -804,7 +821,67 @@ export interface ShareActionDefinition extends BaseActionDefinition<'share'> {
|
|
|
804
821
|
*/
|
|
805
822
|
title?: Remapper;
|
|
806
823
|
}
|
|
807
|
-
|
|
824
|
+
type StorageType = 'indexedDB' | 'localStorage' | 'sessionStorage';
|
|
825
|
+
export interface StorageAppendActionDefinition extends BaseActionDefinition<'storage.append'> {
|
|
826
|
+
/**
|
|
827
|
+
* The key of the entry to write to the app’s storage.
|
|
828
|
+
*/
|
|
829
|
+
key: Remapper;
|
|
830
|
+
/**
|
|
831
|
+
* The data to write to the app’s storage.
|
|
832
|
+
*/
|
|
833
|
+
value: Remapper;
|
|
834
|
+
/**
|
|
835
|
+
* The mechanism used to read the data from.
|
|
836
|
+
*
|
|
837
|
+
* @default 'indexedDB'
|
|
838
|
+
*/
|
|
839
|
+
storage?: StorageType;
|
|
840
|
+
}
|
|
841
|
+
export interface StorageDeleteActionDefinition extends BaseActionDefinition<'storage.delete'> {
|
|
842
|
+
/**
|
|
843
|
+
* The key of the entry to delete from the app’s storage.
|
|
844
|
+
*/
|
|
845
|
+
key: Remapper;
|
|
846
|
+
/**
|
|
847
|
+
* The mechanism used to delete the data from.
|
|
848
|
+
*
|
|
849
|
+
* @default 'indexedDB'
|
|
850
|
+
*/
|
|
851
|
+
storage?: StorageType;
|
|
852
|
+
}
|
|
853
|
+
export interface StorageSubtractActionDefinition extends BaseActionDefinition<'storage.subtract'> {
|
|
854
|
+
/**
|
|
855
|
+
* The key of the entry to subtract the last entry from
|
|
856
|
+
*/
|
|
857
|
+
key: Remapper;
|
|
858
|
+
/**
|
|
859
|
+
* The mechanism used to read the data from.
|
|
860
|
+
*
|
|
861
|
+
* @default 'indexedDB'
|
|
862
|
+
*/
|
|
863
|
+
storage?: StorageType;
|
|
864
|
+
}
|
|
865
|
+
export interface StorageUpdateActionDefinition extends BaseActionDefinition<'storage.update'> {
|
|
866
|
+
/**
|
|
867
|
+
* The key of the entry to write to the app’s storage.
|
|
868
|
+
*/
|
|
869
|
+
key: Remapper;
|
|
870
|
+
/**
|
|
871
|
+
* The key of the item to update.
|
|
872
|
+
*/
|
|
873
|
+
item: Remapper;
|
|
874
|
+
/**
|
|
875
|
+
* The data to update the specified item with.
|
|
876
|
+
*/
|
|
877
|
+
value: Remapper;
|
|
878
|
+
/**
|
|
879
|
+
* The mechanism used to read the data from.
|
|
880
|
+
*
|
|
881
|
+
* @default 'indexedDB'
|
|
882
|
+
*/
|
|
883
|
+
storage?: StorageType;
|
|
884
|
+
}
|
|
808
885
|
export interface StorageReadActionDefinition extends BaseActionDefinition<'storage.read'> {
|
|
809
886
|
/**
|
|
810
887
|
* The key of the entry to read from the app’s storage.
|
|
@@ -947,13 +1024,13 @@ interface ViewResourceDefinition {
|
|
|
947
1024
|
*/
|
|
948
1025
|
view?: string;
|
|
949
1026
|
}
|
|
950
|
-
export
|
|
951
|
-
export
|
|
952
|
-
export
|
|
953
|
-
export
|
|
954
|
-
export
|
|
955
|
-
export
|
|
956
|
-
export
|
|
1027
|
+
export type RequestActionDefinition = RequestLikeActionDefinition<'request'>;
|
|
1028
|
+
export type ResourceCreateActionDefinition = ResourceActionDefinition<'resource.create'>;
|
|
1029
|
+
export type ResourceDeleteActionDefinition = ResourceActionDefinition<'resource.delete'>;
|
|
1030
|
+
export type ResourceGetActionDefinition = ResourceActionDefinition<'resource.get'> & ViewResourceDefinition;
|
|
1031
|
+
export type ResourceQueryActionDefinition = ResourceActionDefinition<'resource.query'> & ViewResourceDefinition;
|
|
1032
|
+
export type ResourceCountActionDefinition = ResourceActionDefinition<'resource.count'>;
|
|
1033
|
+
export type ResourceUpdateActionDefinition = ResourceActionDefinition<'resource.update'>;
|
|
957
1034
|
export interface BaseResourceSubscribeActionDefinition<T extends Action['type']> extends BaseActionDefinition<T> {
|
|
958
1035
|
/**
|
|
959
1036
|
* The name of the resource.
|
|
@@ -964,10 +1041,10 @@ export interface BaseResourceSubscribeActionDefinition<T extends Action['type']>
|
|
|
964
1041
|
*/
|
|
965
1042
|
action?: 'create' | 'delete' | 'update';
|
|
966
1043
|
}
|
|
967
|
-
export
|
|
968
|
-
export
|
|
969
|
-
export
|
|
970
|
-
export
|
|
1044
|
+
export type ResourceSubscriptionSubscribeActionDefinition = BaseResourceSubscribeActionDefinition<'resource.subscription.subscribe'>;
|
|
1045
|
+
export type ResourceSubscriptionUnsubscribeActionDefinition = BaseResourceSubscribeActionDefinition<'resource.subscription.unsubscribe'>;
|
|
1046
|
+
export type ResourceSubscriptionToggleActionDefinition = BaseResourceSubscribeActionDefinition<'resource.subscription.toggle'>;
|
|
1047
|
+
export type ResourceSubscriptionStatusActionDefinition = Omit<BaseResourceSubscribeActionDefinition<'resource.subscription.status'>, 'action'>;
|
|
971
1048
|
export interface EventActionDefinition extends BaseActionDefinition<'event'> {
|
|
972
1049
|
/**
|
|
973
1050
|
* The name of the event to emit to.
|
|
@@ -1006,13 +1083,13 @@ export interface BaseMessage {
|
|
|
1006
1083
|
*/
|
|
1007
1084
|
dismissable?: boolean;
|
|
1008
1085
|
}
|
|
1009
|
-
export
|
|
1086
|
+
export type MessageActionDefinition = BaseActionDefinition<'message'> & BaseMessage & {
|
|
1010
1087
|
/**
|
|
1011
1088
|
* The content of the message to display.
|
|
1012
1089
|
*/
|
|
1013
1090
|
body: Remapper;
|
|
1014
1091
|
};
|
|
1015
|
-
export
|
|
1092
|
+
export 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 | EachActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | LinkActionDefinition | LogActionDefinition | MessageActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageAppendActionDefinition | StorageDeleteActionDefinition | StorageReadActionDefinition | StorageSubtractActionDefinition | StorageUpdateActionDefinition | StorageWriteActionDefinition | TeamInviteActionDefinition | UserLoginAction | UserRegisterAction | UserUpdateAction;
|
|
1016
1093
|
export interface ActionType {
|
|
1017
1094
|
/**
|
|
1018
1095
|
* Whether or not app creators are required to define this action.
|
|
@@ -1118,6 +1195,10 @@ export interface BasePageDefinition {
|
|
|
1118
1195
|
* The name of the page is used to determine the URL path of the page.
|
|
1119
1196
|
*/
|
|
1120
1197
|
name: string;
|
|
1198
|
+
/**
|
|
1199
|
+
* Whether or not the page name should be displayed in the *app bar*.
|
|
1200
|
+
*/
|
|
1201
|
+
hideName?: boolean;
|
|
1121
1202
|
/**
|
|
1122
1203
|
* The name of the page when displayed in the navigation menu.
|
|
1123
1204
|
*
|
|
@@ -1179,12 +1260,20 @@ export interface FlowPageDefinition extends BasePageDefinition {
|
|
|
1179
1260
|
* @default 'corner-dots'
|
|
1180
1261
|
*/
|
|
1181
1262
|
progress?: 'corner-dots' | 'hidden';
|
|
1263
|
+
/**
|
|
1264
|
+
* Whether to retain the flow data when navigating away to another page outside the flow.
|
|
1265
|
+
*
|
|
1266
|
+
* By default the flow page retains it's data after navigating once. Set to false to clear it.
|
|
1267
|
+
*
|
|
1268
|
+
* @default true
|
|
1269
|
+
*/
|
|
1270
|
+
retainFlowData?: boolean;
|
|
1182
1271
|
}
|
|
1183
1272
|
export interface TabsPageDefinition extends BasePageDefinition {
|
|
1184
1273
|
type: 'tabs';
|
|
1185
1274
|
tabs: SubPage[];
|
|
1186
1275
|
}
|
|
1187
|
-
export
|
|
1276
|
+
export type PageDefinition = BasicPageDefinition | FlowPageDefinition | TabsPageDefinition;
|
|
1188
1277
|
export interface AppDefinition {
|
|
1189
1278
|
/**
|
|
1190
1279
|
* The name of the app.
|
|
@@ -1654,7 +1743,7 @@ export interface AppSamlSecret extends WritableAppSamlSecret {
|
|
|
1654
1743
|
*/
|
|
1655
1744
|
spCertificate?: string;
|
|
1656
1745
|
}
|
|
1657
|
-
export
|
|
1746
|
+
export type SAMLStatus = 'badsignature' | 'emailconflict' | 'invalidrelaystate' | 'invalidsecret' | 'invalidstatuscode' | 'invalidsubjectconfirmation' | 'missingnameid' | 'missingsubject';
|
|
1658
1747
|
/**
|
|
1659
1748
|
* The block configuration that’s used by the CLI when building a block.
|
|
1660
1749
|
*
|
package/index.ts
CHANGED
|
@@ -378,11 +378,13 @@ export interface Remappers {
|
|
|
378
378
|
'array.append': Remapper[];
|
|
379
379
|
|
|
380
380
|
/**
|
|
381
|
-
* Remove item(s) from an array given a predefined array of indices.
|
|
381
|
+
* Remove item(s) from an array given a predefined array of remappable indices.
|
|
382
|
+
*
|
|
383
|
+
* Only the remapped values that are turned into numbers are applied.
|
|
382
384
|
*
|
|
383
385
|
* If the input is not an array an empty array is returned.
|
|
384
386
|
*/
|
|
385
|
-
'array.omit':
|
|
387
|
+
'array.omit': Remapper[];
|
|
386
388
|
|
|
387
389
|
/**
|
|
388
390
|
* Create a new object given some predefined mapper keys.
|
|
@@ -467,6 +469,23 @@ export interface Remappers {
|
|
|
467
469
|
*/
|
|
468
470
|
history: number;
|
|
469
471
|
|
|
472
|
+
/**
|
|
473
|
+
* Create a new object with properties from the history stack at a certain index.
|
|
474
|
+
*/
|
|
475
|
+
'from.history': {
|
|
476
|
+
/**
|
|
477
|
+
* The index of the history stack item to apply.
|
|
478
|
+
*
|
|
479
|
+
* 0 is the index of the first item in the history stack.
|
|
480
|
+
*/
|
|
481
|
+
index: number;
|
|
482
|
+
|
|
483
|
+
/**
|
|
484
|
+
* Predefined mapper keys to choose what properties to apply.
|
|
485
|
+
*/
|
|
486
|
+
props: Record<string, Remapper>;
|
|
487
|
+
};
|
|
488
|
+
|
|
470
489
|
/**
|
|
471
490
|
* Assign properties from the history stack at a certain index to an existing object.
|
|
472
491
|
*/
|
|
@@ -955,6 +974,77 @@ export interface ShareActionDefinition extends BaseActionDefinition<'share'> {
|
|
|
955
974
|
|
|
956
975
|
type StorageType = 'indexedDB' | 'localStorage' | 'sessionStorage';
|
|
957
976
|
|
|
977
|
+
export interface StorageAppendActionDefinition extends BaseActionDefinition<'storage.append'> {
|
|
978
|
+
/**
|
|
979
|
+
* The key of the entry to write to the app’s storage.
|
|
980
|
+
*/
|
|
981
|
+
key: Remapper;
|
|
982
|
+
|
|
983
|
+
/**
|
|
984
|
+
* The data to write to the app’s storage.
|
|
985
|
+
*/
|
|
986
|
+
value: Remapper;
|
|
987
|
+
|
|
988
|
+
/**
|
|
989
|
+
* The mechanism used to read the data from.
|
|
990
|
+
*
|
|
991
|
+
* @default 'indexedDB'
|
|
992
|
+
*/
|
|
993
|
+
storage?: StorageType;
|
|
994
|
+
}
|
|
995
|
+
|
|
996
|
+
export interface StorageDeleteActionDefinition extends BaseActionDefinition<'storage.delete'> {
|
|
997
|
+
/**
|
|
998
|
+
* The key of the entry to delete from the app’s storage.
|
|
999
|
+
*/
|
|
1000
|
+
key: Remapper;
|
|
1001
|
+
|
|
1002
|
+
/**
|
|
1003
|
+
* The mechanism used to delete the data from.
|
|
1004
|
+
*
|
|
1005
|
+
* @default 'indexedDB'
|
|
1006
|
+
*/
|
|
1007
|
+
storage?: StorageType;
|
|
1008
|
+
}
|
|
1009
|
+
|
|
1010
|
+
export interface StorageSubtractActionDefinition extends BaseActionDefinition<'storage.subtract'> {
|
|
1011
|
+
/**
|
|
1012
|
+
* The key of the entry to subtract the last entry from
|
|
1013
|
+
*/
|
|
1014
|
+
key: Remapper;
|
|
1015
|
+
|
|
1016
|
+
/**
|
|
1017
|
+
* The mechanism used to read the data from.
|
|
1018
|
+
*
|
|
1019
|
+
* @default 'indexedDB'
|
|
1020
|
+
*/
|
|
1021
|
+
storage?: StorageType;
|
|
1022
|
+
}
|
|
1023
|
+
|
|
1024
|
+
export interface StorageUpdateActionDefinition extends BaseActionDefinition<'storage.update'> {
|
|
1025
|
+
/**
|
|
1026
|
+
* The key of the entry to write to the app’s storage.
|
|
1027
|
+
*/
|
|
1028
|
+
key: Remapper;
|
|
1029
|
+
|
|
1030
|
+
/**
|
|
1031
|
+
* The key of the item to update.
|
|
1032
|
+
*/
|
|
1033
|
+
item: Remapper;
|
|
1034
|
+
|
|
1035
|
+
/**
|
|
1036
|
+
* The data to update the specified item with.
|
|
1037
|
+
*/
|
|
1038
|
+
value: Remapper;
|
|
1039
|
+
|
|
1040
|
+
/**
|
|
1041
|
+
* The mechanism used to read the data from.
|
|
1042
|
+
*
|
|
1043
|
+
* @default 'indexedDB'
|
|
1044
|
+
*/
|
|
1045
|
+
storage?: StorageType;
|
|
1046
|
+
}
|
|
1047
|
+
|
|
958
1048
|
export interface StorageReadActionDefinition extends BaseActionDefinition<'storage.read'> {
|
|
959
1049
|
/**
|
|
960
1050
|
* The key of the entry to read from the app’s storage.
|
|
@@ -1252,7 +1342,11 @@ export type ActionDefinition =
|
|
|
1252
1342
|
| ResourceUpdateActionDefinition
|
|
1253
1343
|
| ShareActionDefinition
|
|
1254
1344
|
| StaticActionDefinition
|
|
1345
|
+
| StorageAppendActionDefinition
|
|
1346
|
+
| StorageDeleteActionDefinition
|
|
1255
1347
|
| StorageReadActionDefinition
|
|
1348
|
+
| StorageSubtractActionDefinition
|
|
1349
|
+
| StorageUpdateActionDefinition
|
|
1256
1350
|
| StorageWriteActionDefinition
|
|
1257
1351
|
| TeamInviteActionDefinition
|
|
1258
1352
|
| UserLoginAction
|
|
@@ -1383,6 +1477,11 @@ export interface BasePageDefinition {
|
|
|
1383
1477
|
*/
|
|
1384
1478
|
name: string;
|
|
1385
1479
|
|
|
1480
|
+
/**
|
|
1481
|
+
* Whether or not the page name should be displayed in the *app bar*.
|
|
1482
|
+
*/
|
|
1483
|
+
hideName?: boolean;
|
|
1484
|
+
|
|
1386
1485
|
/**
|
|
1387
1486
|
* The name of the page when displayed in the navigation menu.
|
|
1388
1487
|
*
|
|
@@ -1455,6 +1554,15 @@ export interface FlowPageDefinition extends BasePageDefinition {
|
|
|
1455
1554
|
* @default 'corner-dots'
|
|
1456
1555
|
*/
|
|
1457
1556
|
progress?: 'corner-dots' | 'hidden';
|
|
1557
|
+
|
|
1558
|
+
/**
|
|
1559
|
+
* Whether to retain the flow data when navigating away to another page outside the flow.
|
|
1560
|
+
*
|
|
1561
|
+
* By default the flow page retains it's data after navigating once. Set to false to clear it.
|
|
1562
|
+
*
|
|
1563
|
+
* @default true
|
|
1564
|
+
*/
|
|
1565
|
+
retainFlowData?: boolean;
|
|
1458
1566
|
}
|
|
1459
1567
|
|
|
1460
1568
|
export interface TabsPageDefinition extends BasePageDefinition {
|
package/package.json
CHANGED
package/ssl.d.ts
CHANGED
|
@@ -7,8 +7,8 @@
|
|
|
7
7
|
* - `ready` means the SSL certificate is ready to serve.
|
|
8
8
|
* - `unknown` means the status is unknown, probably due to an unexpected state.
|
|
9
9
|
*/
|
|
10
|
-
export
|
|
10
|
+
export type SSLStatus = 'error' | 'missing' | 'pending' | 'ready' | 'unknown';
|
|
11
11
|
/**
|
|
12
12
|
* A mapping of domain names to an SSL certificate status.
|
|
13
13
|
*/
|
|
14
|
-
export
|
|
14
|
+
export type SSLStatusMap = Record<string, SSLStatus>;
|