@appsemble/types 0.27.11 → 0.28.0
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 +3 -3
- package/index.d.ts +30 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
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.28.0)
|
|
7
7
|
[](https://prettier.io)
|
|
8
8
|
|
|
9
9
|
## Table of Contents
|
|
@@ -26,5 +26,5 @@ not guaranteed.
|
|
|
26
26
|
|
|
27
27
|
## License
|
|
28
28
|
|
|
29
|
-
[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.
|
|
29
|
+
[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.28.0/LICENSE.md) ©
|
|
30
30
|
[Appsemble](https://appsemble.com)
|
package/index.d.ts
CHANGED
|
@@ -269,6 +269,10 @@ export interface Remappers {
|
|
|
269
269
|
* - `name`: Get the name of the user associated with AppMember object.
|
|
270
270
|
*/
|
|
271
271
|
appMember: keyof AppMember;
|
|
272
|
+
/**
|
|
273
|
+
* Get a predefined app variable by name.
|
|
274
|
+
*/
|
|
275
|
+
variable: string;
|
|
272
276
|
/**
|
|
273
277
|
* Get page metadata.
|
|
274
278
|
*
|
|
@@ -439,7 +443,7 @@ export interface Remappers {
|
|
|
439
443
|
*
|
|
440
444
|
* If the prop is an array, nested properties will be retrieved in sequence.
|
|
441
445
|
*/
|
|
442
|
-
prop: number[] |
|
|
446
|
+
prop: number[] | Remapper | string[];
|
|
443
447
|
/**
|
|
444
448
|
* Recursively strip all nullish values from an object or array.
|
|
445
449
|
*/
|
|
@@ -1579,6 +1583,10 @@ export interface App {
|
|
|
1579
1583
|
* Whether the app is currently locked.
|
|
1580
1584
|
*/
|
|
1581
1585
|
locked: AppLock;
|
|
1586
|
+
/**
|
|
1587
|
+
* Whether the app is a template.
|
|
1588
|
+
*/
|
|
1589
|
+
template?: boolean;
|
|
1582
1590
|
/**
|
|
1583
1591
|
* Whether to apply service secrets to outgoing request even without a security definition.
|
|
1584
1592
|
*/
|
|
@@ -1875,12 +1883,24 @@ export interface OAuth2Provider {
|
|
|
1875
1883
|
*/
|
|
1876
1884
|
scope: string;
|
|
1877
1885
|
}
|
|
1878
|
-
export type
|
|
1879
|
-
export
|
|
1886
|
+
export type ValueFromDefinition = boolean | number | string | null | undefined;
|
|
1887
|
+
export type ValueFromProcess = boolean | number | string | undefined;
|
|
1888
|
+
export interface AppConfigEntryDefinition {
|
|
1889
|
+
name: string;
|
|
1890
|
+
value: ValueFromDefinition;
|
|
1891
|
+
}
|
|
1892
|
+
export interface AppConfigEntry extends AppConfigEntryDefinition {
|
|
1880
1893
|
/**
|
|
1881
1894
|
* An autogenerated ID.
|
|
1882
1895
|
*/
|
|
1883
|
-
id
|
|
1896
|
+
id: number;
|
|
1897
|
+
/**
|
|
1898
|
+
* The parsed value of the config entry.
|
|
1899
|
+
*/
|
|
1900
|
+
value: ValueFromProcess;
|
|
1901
|
+
}
|
|
1902
|
+
export type ServiceAuthenticationMethod = 'client-certificate' | 'client-credentials' | 'cookie' | 'custom-header' | 'http-basic' | 'query-parameter';
|
|
1903
|
+
export interface AppServiceSecretDefinition {
|
|
1884
1904
|
/**
|
|
1885
1905
|
* An optional name to give extra clarity what the secret is used for.
|
|
1886
1906
|
*/
|
|
@@ -1906,6 +1926,12 @@ export interface AppServiceSecret {
|
|
|
1906
1926
|
*/
|
|
1907
1927
|
tokenUrl?: string;
|
|
1908
1928
|
}
|
|
1929
|
+
export interface AppServiceSecret extends AppServiceSecretDefinition {
|
|
1930
|
+
/**
|
|
1931
|
+
* An autogenerated ID.
|
|
1932
|
+
*/
|
|
1933
|
+
id: number;
|
|
1934
|
+
}
|
|
1909
1935
|
export interface AppOAuth2Secret extends OAuth2Provider {
|
|
1910
1936
|
/**
|
|
1911
1937
|
* An autogenerated ID.
|