@artisan-commerce/types 0.14.0-canary.0 → 0.14.0-canary.10
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/CHANGELOG.md +88 -0
- package/build/index.d.ts +1 -1
- package/build/index.js +1 -1
- package/build/index.js.map +1 -1
- package/build/types/account.types.d.ts +4 -4
- package/build/types/app.types.d.ts +57 -57
- package/build/types/app.types.js +1 -1
- package/build/types/app.types.js.map +1 -1
- package/build/types/artisnDB.types.d.ts +29 -0
- package/build/types/artisnDB.types.js +4 -0
- package/build/types/artisnDB.types.js.map +1 -0
- package/build/types/category.types.d.ts +3 -3
- package/build/types/common.types.d.ts +8 -2
- package/build/types/common.types.js +1 -1
- package/build/types/common.types.js.map +1 -1
- package/build/types/country.types.d.ts +94 -2
- package/build/types/coupon.types.d.ts +8 -8
- package/build/types/currency.types.d.ts +1 -1
- package/build/types/http.types.d.ts +27 -27
- package/build/types/image.types.d.ts +1 -1
- package/build/types/order.types.d.ts +476 -60
- package/build/types/payment.types.d.ts +16 -0
- package/build/types/product.types.d.ts +7 -5
- package/build/types/settings.types.d.ts +8 -7
- package/build/types/settings.types.js +1 -1
- package/build/types/settings.types.js.map +1 -1
- package/build/types/shippingAddress.types.d.ts +8 -2
- package/build/types/shoppingCart.types.d.ts +5 -5
- package/build/types/store.types.d.ts +3 -3
- package/build/types/user.types.d.ts +2 -1
- package/build/types/vendor.types.d.ts +4 -4
- package/package.json +5 -5
- package/build/types/artisanDB.types.d.ts +0 -29
- package/build/types/artisanDB.types.js +0 -4
- package/build/types/artisanDB.types.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,94 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [0.14.0-canary.10](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.9...@artisan-commerce/types@0.14.0-canary.10) (2021-09-21)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* **global:** fix product details and settings builders ([5452fc9](https://bitbucket.org/tradesystem/artisn_sdk/commit/5452fc9d70ff3fa9f859ed4a665fd933e133c7ce))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## [0.14.0-canary.9](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.8...@artisan-commerce/types@0.14.0-canary.9) (2021-09-17)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Features
|
|
19
|
+
|
|
20
|
+
* **global:** add categories property to product details interface ([0d95d09](https://bitbucket.org/tradesystem/artisn_sdk/commit/0d95d093383673322369b0870af290182bb57cb8))
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
## [0.14.0-canary.8](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.7...@artisan-commerce/types@0.14.0-canary.8) (2021-08-25)
|
|
25
|
+
|
|
26
|
+
**Note:** Version bump only for package @artisan-commerce/types
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
## [0.14.0-canary.7](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.6...@artisan-commerce/types@0.14.0-canary.7) (2021-08-24)
|
|
33
|
+
|
|
34
|
+
**Note:** Version bump only for package @artisan-commerce/types
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
## [0.14.0-canary.6](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.5...@artisan-commerce/types@0.14.0-canary.6) (2021-08-23)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
### Bug Fixes
|
|
44
|
+
|
|
45
|
+
* **global:** add missing properties to order interfaces and types ([757157f](https://bitbucket.org/tradesystem/artisn_sdk/commit/757157fbb2dd25d04efc791cd9b9511e41685471))
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
## [0.14.0-canary.5](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.4...@artisan-commerce/types@0.14.0-canary.5) (2021-08-23)
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
### Bug Fixes
|
|
53
|
+
|
|
54
|
+
* **global:** add missing properties to shipping address and complete document type ([c9156f6](https://bitbucket.org/tradesystem/artisn_sdk/commit/c9156f6db3e55f23479484577760f5196e112afc))
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
## [0.14.0-canary.4](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.3...@artisan-commerce/types@0.14.0-canary.4) (2021-08-12)
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### Bug Fixes
|
|
62
|
+
|
|
63
|
+
* **global:** add CountryCode type and update user builder ([f94eb5d](https://bitbucket.org/tradesystem/artisn_sdk/commit/f94eb5d38e0725bd157398e3c51b3bb8b2592abc))
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
## [0.14.0-canary.3](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.2...@artisan-commerce/types@0.14.0-canary.3) (2021-08-12)
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### Bug Fixes
|
|
71
|
+
|
|
72
|
+
* **image-builders:** make bucket not use undefined ([5f7e95d](https://bitbucket.org/tradesystem/artisn_sdk/commit/5f7e95d6b0b4d4d1e47e38400b126a0ee9aa3478))
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
## [0.14.0-canary.2](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.1...@artisan-commerce/types@0.14.0-canary.2) (2021-08-11)
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
### Features
|
|
80
|
+
|
|
81
|
+
* **global:** rebrand artisan-commerce to artisn ([b2688b1](https://bitbucket.org/tradesystem/artisn_sdk/commit/b2688b107757ed82791c0be49439e9fb28f78b6d))
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
## [0.14.0-canary.1](https://bitbucket.org/tradesystem/artisan_sdk/compare/@artisan-commerce/types@0.14.0-canary.0...@artisan-commerce/types@0.14.0-canary.1) (2021-08-06)
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
### Features
|
|
89
|
+
|
|
90
|
+
* **builders:** add missing builders and delete unused type ([361abac](https://bitbucket.org/tradesystem/artisan_sdk/commit/361abac9996fef1b0c308b1bd940f19379f8842a))
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
6
94
|
## [0.14.0-canary.0](https://bitbucket.org/tradesystem/artisan_sdk/compare/@artisan-commerce/types@0.13.0...@artisan-commerce/types@0.14.0-canary.0) (2021-08-04)
|
|
7
95
|
|
|
8
96
|
|
package/build/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export * from "./types/account.types";
|
|
2
2
|
export * from "./types/app.types";
|
|
3
|
-
export * from "./types/
|
|
3
|
+
export * from "./types/artisnDB.types";
|
|
4
4
|
export * from "./types/banner.types";
|
|
5
5
|
export * from "./types/billingData.types";
|
|
6
6
|
export * from "./types/catalogue.types";
|
package/build/index.js
CHANGED
|
@@ -13,7 +13,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
13
13
|
// Main
|
|
14
14
|
__exportStar(require("./types/account.types"), exports);
|
|
15
15
|
__exportStar(require("./types/app.types"), exports);
|
|
16
|
-
__exportStar(require("./types/
|
|
16
|
+
__exportStar(require("./types/artisnDB.types"), exports);
|
|
17
17
|
__exportStar(require("./types/banner.types"), exports);
|
|
18
18
|
__exportStar(require("./types/billingData.types"), exports);
|
|
19
19
|
__exportStar(require("./types/catalogue.types"), exports);
|
package/build/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO;AACP,wDAAsC;AACtC,oDAAkC;AAClC,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO;AACP,wDAAsC;AACtC,oDAAkC;AAClC,yDAAuC;AACvC,uDAAqC;AACrC,4DAA0C;AAC1C,0DAAwC;AACxC,yDAAuC;AACvC,uDAAqC;AACrC,wDAAsC;AACtC,uDAAqC;AACrC,yDAAuC;AACvC,4DAA0C;AAC1C,qDAAmC;AACnC,sDAAoC;AACpC,4DAA0C;AAC1C,6DAA2C;AAC3C,sDAAoC;AACpC,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,gEAA8C;AAC9C,6DAA2C;AAC3C,6DAA2C;AAC3C,sDAAoC;AACpC,uDAAqC;AACrC,qDAAmC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CDNImage } from "./image.types";
|
|
2
2
|
/**
|
|
3
3
|
* Representation of a Commerce Account.
|
|
4
4
|
*
|
|
@@ -6,12 +6,12 @@ import { Image } from "./image.types";
|
|
|
6
6
|
* @since 0.5.14
|
|
7
7
|
*/
|
|
8
8
|
export interface Account {
|
|
9
|
-
/**
|
|
9
|
+
/** Artisn's account unique identifier */
|
|
10
10
|
accountId: number;
|
|
11
11
|
/** Account's name */
|
|
12
12
|
name: string;
|
|
13
13
|
/** Account's description */
|
|
14
14
|
description?: string;
|
|
15
|
-
/** Account's images, see {@link
|
|
16
|
-
images:
|
|
15
|
+
/** Account's images, see {@link CDNImage} for further information */
|
|
16
|
+
images: CDNImage[];
|
|
17
17
|
}
|
|
@@ -1,44 +1,44 @@
|
|
|
1
1
|
import firebase from "firebase";
|
|
2
2
|
/**
|
|
3
|
-
* The
|
|
3
|
+
* The ArtisnApp controls the app connection with the DBs and its settings.
|
|
4
4
|
*
|
|
5
|
-
* @typedef
|
|
5
|
+
* @typedef ArtisnApp
|
|
6
6
|
* @since 0.5.14
|
|
7
7
|
*/
|
|
8
|
-
export declare type
|
|
8
|
+
export declare type ArtisnApp = ArtisnAppWeb | ArtisnAppRN;
|
|
9
9
|
/**
|
|
10
|
-
* The
|
|
10
|
+
* The ArtisnAppWeb orchestrate the connections of the app with the DB, server and its settings.
|
|
11
11
|
*
|
|
12
|
-
* @interface
|
|
12
|
+
* @interface ArtisnAppWeb
|
|
13
13
|
* @since 0.5.14
|
|
14
14
|
*/
|
|
15
|
-
export interface
|
|
15
|
+
export interface ArtisnAppWeb {
|
|
16
16
|
/** App's name */
|
|
17
17
|
name: firebase.app.App["name"];
|
|
18
|
-
/**
|
|
18
|
+
/** Artisn's account API URL */
|
|
19
19
|
apiURL: string;
|
|
20
|
-
/**
|
|
21
|
-
settings:
|
|
20
|
+
/** Artisn app settings configuration, see {@link ArtisnSettings} */
|
|
21
|
+
settings: ArtisnSettings;
|
|
22
22
|
/** Internal configuration of App and databases */
|
|
23
23
|
__internals__: firebase.app.App;
|
|
24
|
-
/**
|
|
24
|
+
/** ArtisnApp object internal instance */
|
|
25
25
|
__instance__: typeof firebase;
|
|
26
26
|
}
|
|
27
27
|
/**
|
|
28
|
-
* The
|
|
28
|
+
* The ArtisnAppRN orchestrate the connections of the app with the DB, server and its settings.
|
|
29
29
|
*
|
|
30
|
-
* @interface
|
|
30
|
+
* @interface ArtisnAppRN
|
|
31
31
|
* @since 0.5.14
|
|
32
32
|
*/
|
|
33
|
-
export interface
|
|
34
|
-
/**
|
|
33
|
+
export interface ArtisnAppRN {
|
|
34
|
+
/** Artisn's account API URL */
|
|
35
35
|
apiURL: string;
|
|
36
36
|
/** Internal configuration of App and databases */
|
|
37
37
|
__internals__: RNFirebaseInstance;
|
|
38
|
-
/**
|
|
38
|
+
/** ArtisnApp object internal instance */
|
|
39
39
|
__instance__: RNFirebaseInstance;
|
|
40
|
-
/**
|
|
41
|
-
settings:
|
|
40
|
+
/** Artisn app settings configuration, see {@link ArtisnSettings} */
|
|
41
|
+
settings: ArtisnSettings;
|
|
42
42
|
/** App's name */
|
|
43
43
|
name: string;
|
|
44
44
|
}
|
|
@@ -55,16 +55,16 @@ export interface RNFirebaseInstance {
|
|
|
55
55
|
firestore: any;
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
|
-
* Settings to configure the
|
|
58
|
+
* Settings to configure the Artisn app.
|
|
59
59
|
*
|
|
60
|
-
* @interface
|
|
60
|
+
* @interface ArtisnSettings
|
|
61
61
|
* @since 0.5.14
|
|
62
62
|
*/
|
|
63
|
-
export interface
|
|
64
|
-
/**
|
|
63
|
+
export interface ArtisnSettings {
|
|
64
|
+
/** Artisn's account unique identifier */
|
|
65
65
|
accountId?: number;
|
|
66
|
-
/** Platform where the app is running, see {@link
|
|
67
|
-
platform?:
|
|
66
|
+
/** Platform where the app is running, see {@link ArtisnPlatform} */
|
|
67
|
+
platform?: ArtisnPlatform;
|
|
68
68
|
/** App's project id */
|
|
69
69
|
projectId: string;
|
|
70
70
|
/** App's API key */
|
|
@@ -75,79 +75,79 @@ export interface ArtisanSettings {
|
|
|
75
75
|
authDomain: string;
|
|
76
76
|
}
|
|
77
77
|
/**
|
|
78
|
-
* Settings to configure the
|
|
78
|
+
* Settings to configure the Artisn app react-native.
|
|
79
79
|
*
|
|
80
|
-
* @interface
|
|
80
|
+
* @interface ArtisnSettingsRN
|
|
81
81
|
* @since 0.5.14
|
|
82
82
|
*/
|
|
83
|
-
export interface
|
|
84
|
-
/** Platform where the app is running, see {@link
|
|
85
|
-
platform:
|
|
86
|
-
/**
|
|
83
|
+
export interface ArtisnSettingsRN {
|
|
84
|
+
/** Platform where the app is running, see {@link ArtisnPlatform} */
|
|
85
|
+
platform: ArtisnPlatform;
|
|
86
|
+
/** Artisn's account unique identifier */
|
|
87
87
|
accountId?: number;
|
|
88
88
|
}
|
|
89
89
|
/**
|
|
90
|
-
*
|
|
90
|
+
* Artisn app's allowed platforms to run on.
|
|
91
91
|
*
|
|
92
|
-
* @typedef
|
|
92
|
+
* @typedef ArtisnPlatform
|
|
93
93
|
* @since 0.5.14
|
|
94
94
|
*/
|
|
95
|
-
export declare type
|
|
95
|
+
export declare type ArtisnPlatform = "web" | "ios" | "android" | "windows" | "macos" | "call center";
|
|
96
96
|
/**
|
|
97
|
-
*
|
|
97
|
+
* Artisn's auth instance is the instance of the internal auth object.
|
|
98
98
|
*
|
|
99
|
-
* @typedef
|
|
99
|
+
* @typedef ArtisnInstanceAuth
|
|
100
100
|
* @since 0.5.14
|
|
101
101
|
*/
|
|
102
|
-
export declare type
|
|
102
|
+
export declare type ArtisnInstanceAuth = typeof firebase.auth;
|
|
103
103
|
/**
|
|
104
|
-
*
|
|
104
|
+
* Artisn's auth object to handle providers authentication.
|
|
105
105
|
*
|
|
106
|
-
* @typedef
|
|
106
|
+
* @typedef ArtisnAuth
|
|
107
107
|
* @since 0.5.14
|
|
108
108
|
*/
|
|
109
|
-
export interface
|
|
109
|
+
export interface ArtisnAuth extends firebase.auth.Auth {
|
|
110
110
|
}
|
|
111
111
|
/**
|
|
112
|
-
* Main
|
|
112
|
+
* Main artisn commerce filters.
|
|
113
113
|
*
|
|
114
|
-
* @interface
|
|
114
|
+
* @interface ArtisnHints
|
|
115
115
|
* @since 0.5.14
|
|
116
116
|
*/
|
|
117
|
-
export interface
|
|
118
|
-
/**
|
|
117
|
+
export interface ArtisnHints {
|
|
118
|
+
/** Artisn's account unique identifier */
|
|
119
119
|
accountId: string | number;
|
|
120
|
-
/**
|
|
120
|
+
/** Artisn's vendor unique identifier */
|
|
121
121
|
vendorId?: string | number;
|
|
122
|
-
/**
|
|
122
|
+
/** Artisn's catalogue unique identifier */
|
|
123
123
|
catalogueId?: string | number;
|
|
124
|
-
/**
|
|
124
|
+
/** Artisn's store unique identifier */
|
|
125
125
|
storeId?: number;
|
|
126
|
-
/**
|
|
126
|
+
/** Artisn's category unique identifier */
|
|
127
127
|
categoryId?: string | number;
|
|
128
|
-
/**
|
|
128
|
+
/** Artisn's productId unique identifier */
|
|
129
129
|
productId?: string | number;
|
|
130
130
|
}
|
|
131
131
|
/**
|
|
132
|
-
* Unrestricted allowed
|
|
132
|
+
* Unrestricted allowed Artisn SDK rest api headers.
|
|
133
133
|
*
|
|
134
|
-
* @interface
|
|
134
|
+
* @interface ArtisnHeaders
|
|
135
135
|
* @since 0.5.14
|
|
136
136
|
*/
|
|
137
|
-
export interface
|
|
138
|
-
/** Platform where the app is running, see {@link
|
|
139
|
-
Platform:
|
|
140
|
-
/**
|
|
137
|
+
export interface ArtisnHeaders {
|
|
138
|
+
/** Platform where the app is running, see {@link ArtisnPlatform} */
|
|
139
|
+
Platform: ArtisnPlatform;
|
|
140
|
+
/** Artisn's account unique identifier */
|
|
141
141
|
account: string;
|
|
142
142
|
}
|
|
143
143
|
/**
|
|
144
|
-
* Restricted allowed
|
|
144
|
+
* Restricted allowed Artisn SDK rest api headers.
|
|
145
145
|
*
|
|
146
|
-
* @interface
|
|
146
|
+
* @interface ArtisnRestrictedHeaders
|
|
147
147
|
* @since 0.5.14
|
|
148
|
-
* @extends {{@link
|
|
148
|
+
* @extends {{@link ArtisnHeaders}
|
|
149
149
|
*/
|
|
150
|
-
export interface
|
|
150
|
+
export interface ArtisnRestrictedHeaders extends ArtisnHeaders {
|
|
151
151
|
/** Authorization app's authentication token */
|
|
152
152
|
Authorization: string;
|
|
153
153
|
}
|
package/build/types/app.types.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"app.types.js","sourceRoot":"","sources":["../../src/types/app.types.ts"],"names":[],"mappings":";AAAA,
|
|
1
|
+
{"version":3,"file":"app.types.js","sourceRoot":"","sources":["../../src/types/app.types.ts"],"names":[],"mappings":";AAAA,kCAAkC"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import firebase from "firebase";
|
|
2
|
+
/**
|
|
3
|
+
* Artisn database object.
|
|
4
|
+
*
|
|
5
|
+
* @typedef ArtisnDB
|
|
6
|
+
* @since 0.5.14
|
|
7
|
+
*/
|
|
8
|
+
export declare type ArtisnDB = firebase.firestore.Firestore;
|
|
9
|
+
/**
|
|
10
|
+
* Artisn database document data object.
|
|
11
|
+
*
|
|
12
|
+
* @typedef ArtisnDBDocumentData
|
|
13
|
+
* @since 0.5.14
|
|
14
|
+
*/
|
|
15
|
+
export declare type ArtisnDBDocumentData = firebase.firestore.DocumentData;
|
|
16
|
+
/**
|
|
17
|
+
* The current state of a node from the Artisn DB.
|
|
18
|
+
*
|
|
19
|
+
* @typedef ArtisnDBQueryDocumentSnapshot
|
|
20
|
+
* @since 0.5.14
|
|
21
|
+
*/
|
|
22
|
+
export declare type ArtisnDBQueryDocumentSnapshot<T = ArtisnDBDocumentData> = firebase.firestore.QueryDocumentSnapshot<T>;
|
|
23
|
+
/**
|
|
24
|
+
* An Artisn DB collection of nodes.
|
|
25
|
+
*
|
|
26
|
+
* @typedef ArtisnDBCollectionReference
|
|
27
|
+
* @since 0.5.14
|
|
28
|
+
*/
|
|
29
|
+
export declare type ArtisnDBCollectionReference<T = ArtisnDBDocumentData> = firebase.firestore.CollectionReference<T>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"artisnDB.types.js","sourceRoot":"","sources":["../../src/types/artisnDB.types.ts"],"names":[],"mappings":";AAAA,iCAAiC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CDNImage } from "./image.types";
|
|
2
2
|
import { BaseProduct } from "./product.types";
|
|
3
3
|
/**
|
|
4
4
|
* Representation of a Commerce Category.
|
|
@@ -11,8 +11,8 @@ export interface Category {
|
|
|
11
11
|
categoryId: number;
|
|
12
12
|
/** Category's name */
|
|
13
13
|
name: string;
|
|
14
|
-
/** Category image's array, see {@link
|
|
15
|
-
images:
|
|
14
|
+
/** Category image's array, see {@link CDNImage} */
|
|
15
|
+
images: CDNImage[];
|
|
16
16
|
/** Whether or not to display the category */
|
|
17
17
|
displayInMenu: boolean;
|
|
18
18
|
/** Whether or not the category should be reloaded */
|
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
import { ARDocumentType, BODocumentType } from "./country.types";
|
|
2
|
+
import { BRDocumentType, CLDocumentType } from "./country.types";
|
|
3
|
+
import { CODocumentType, ECDocumentType } from "./country.types";
|
|
4
|
+
import { PYDocumentType, PEDocumentType } from "./country.types";
|
|
5
|
+
import { UYDocumentType, VEDocumentType } from "./country.types";
|
|
6
|
+
import { USDocumentType } from "./country.types";
|
|
1
7
|
/**
|
|
2
8
|
* Representation of a generic object.
|
|
3
9
|
*
|
|
@@ -12,9 +18,9 @@ export interface Objectify<T> {
|
|
|
12
18
|
* The possible values of a document type.
|
|
13
19
|
*
|
|
14
20
|
* @typedef DocumentType
|
|
15
|
-
* @since 0.
|
|
21
|
+
* @since 0.1.0
|
|
16
22
|
*/
|
|
17
|
-
export declare type DocumentType =
|
|
23
|
+
export declare type DocumentType = ARDocumentType | BODocumentType | BRDocumentType | CLDocumentType | CODocumentType | ECDocumentType | PYDocumentType | PEDocumentType | UYDocumentType | VEDocumentType | USDocumentType;
|
|
18
24
|
/**
|
|
19
25
|
* Representation of the country's summary.
|
|
20
26
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"common.types.js","sourceRoot":"","sources":["../../src/types/common.types.ts"],"names":[],"mappings":";AAAA,
|
|
1
|
+
{"version":3,"file":"common.types.js","sourceRoot":"","sources":["../../src/types/common.types.ts"],"names":[],"mappings":";AAAA,yCAAyC"}
|
|
@@ -9,8 +9,8 @@ export interface Country {
|
|
|
9
9
|
countryId: string;
|
|
10
10
|
/** Country's name */
|
|
11
11
|
name: string;
|
|
12
|
-
/** Country ISO code,
|
|
13
|
-
code:
|
|
12
|
+
/** Country ISO code, see {@link CountryCode} */
|
|
13
|
+
code: CountryCode;
|
|
14
14
|
/** Whether or not the country is active */
|
|
15
15
|
active: boolean;
|
|
16
16
|
/**
|
|
@@ -49,3 +49,95 @@ export interface CountryTax {
|
|
|
49
49
|
/** Tax percentage */
|
|
50
50
|
percentage: number;
|
|
51
51
|
}
|
|
52
|
+
/**
|
|
53
|
+
* List of country codes currently supported.
|
|
54
|
+
*
|
|
55
|
+
* @typedef CountryCode
|
|
56
|
+
* @since 0.1.0
|
|
57
|
+
* @see https://www.nationsonline.org/oneworld/country_code_list.htm for reference
|
|
58
|
+
*/
|
|
59
|
+
export declare type CountryCode = "AR" | "BO" | "BR" | "CL" | "CO" | "EC" | "PY" | "PE" | "UY" | "VE" | "US";
|
|
60
|
+
/**
|
|
61
|
+
* Default documents for all countries.
|
|
62
|
+
*
|
|
63
|
+
* @typedef CommonDocumentType
|
|
64
|
+
* @since 0.1.0
|
|
65
|
+
*/
|
|
66
|
+
export declare type CommonDocumentType = "PASSPORT";
|
|
67
|
+
/**
|
|
68
|
+
* Argentina supported document types.
|
|
69
|
+
*
|
|
70
|
+
* @typedef ARDocumentType
|
|
71
|
+
* @since 0.1.0
|
|
72
|
+
*/
|
|
73
|
+
export declare type ARDocumentType = CommonDocumentType;
|
|
74
|
+
/**
|
|
75
|
+
* Bolivia supported document types.
|
|
76
|
+
*
|
|
77
|
+
* @typedef BODocumentType
|
|
78
|
+
* @since 0.1.0
|
|
79
|
+
*/
|
|
80
|
+
export declare type BODocumentType = CommonDocumentType;
|
|
81
|
+
/**
|
|
82
|
+
* Brasil supported document types.
|
|
83
|
+
*
|
|
84
|
+
* @typedef BRDocumentType
|
|
85
|
+
* @since 0.1.0
|
|
86
|
+
*/
|
|
87
|
+
export declare type BRDocumentType = CommonDocumentType;
|
|
88
|
+
/**
|
|
89
|
+
* Chile supported document types.
|
|
90
|
+
*
|
|
91
|
+
* @typedef CLDocumentType
|
|
92
|
+
* @since 0.1.0
|
|
93
|
+
*/
|
|
94
|
+
export declare type CLDocumentType = CommonDocumentType;
|
|
95
|
+
/**
|
|
96
|
+
* Colombia supported document types.
|
|
97
|
+
*
|
|
98
|
+
* @typedef CODocumentType
|
|
99
|
+
* @since 0.1.0
|
|
100
|
+
*/
|
|
101
|
+
export declare type CODocumentType = CommonDocumentType | "RUT" | "NIT" | "CE" | "CC";
|
|
102
|
+
/**
|
|
103
|
+
* Ecuador supported document types.
|
|
104
|
+
*
|
|
105
|
+
* @typedef ECDocumentType
|
|
106
|
+
* @since 0.1.0
|
|
107
|
+
*/
|
|
108
|
+
export declare type ECDocumentType = CommonDocumentType | "CI" | "RUC";
|
|
109
|
+
/**
|
|
110
|
+
* Paraguay supported document types.
|
|
111
|
+
*
|
|
112
|
+
* @typedef PYDocumentType
|
|
113
|
+
* @since 0.1.0
|
|
114
|
+
*/
|
|
115
|
+
export declare type PYDocumentType = CommonDocumentType;
|
|
116
|
+
/**
|
|
117
|
+
* Perú supported document types.
|
|
118
|
+
*
|
|
119
|
+
* @typedef PEDocumentType
|
|
120
|
+
* @since 0.1.0
|
|
121
|
+
*/
|
|
122
|
+
export declare type PEDocumentType = CommonDocumentType;
|
|
123
|
+
/**
|
|
124
|
+
* Uruguay supported document types.
|
|
125
|
+
*
|
|
126
|
+
* @typedef UYDocumentType
|
|
127
|
+
* @since 0.1.0
|
|
128
|
+
*/
|
|
129
|
+
export declare type UYDocumentType = CommonDocumentType;
|
|
130
|
+
/**
|
|
131
|
+
* Venezuela supported document types.
|
|
132
|
+
*
|
|
133
|
+
* @typedef VEDocumentType
|
|
134
|
+
* @since 0.1.0
|
|
135
|
+
*/
|
|
136
|
+
export declare type VEDocumentType = CommonDocumentType;
|
|
137
|
+
/**
|
|
138
|
+
* United States supported document types.
|
|
139
|
+
*
|
|
140
|
+
* @typedef USDocumentType
|
|
141
|
+
* @since 0.1.0
|
|
142
|
+
*/
|
|
143
|
+
export declare type USDocumentType = CommonDocumentType;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
1
|
+
import { ArtisnDBCollectionReference } from "./artisnDB.types";
|
|
2
|
+
import { ArtisnDBQueryDocumentSnapshot } from "./artisnDB.types";
|
|
3
|
+
import { ArtisnDBDocumentData } from "./artisnDB.types";
|
|
4
|
+
import { CDNImage } from "./image.types";
|
|
5
5
|
/**
|
|
6
6
|
* Wallet user information.
|
|
7
7
|
*
|
|
@@ -41,8 +41,8 @@ export interface Benefit {
|
|
|
41
41
|
expirationDate: string;
|
|
42
42
|
/** External benefit id */
|
|
43
43
|
externalId: null;
|
|
44
|
-
/** Benefit images, see {@link
|
|
45
|
-
image:
|
|
44
|
+
/** Benefit images, see {@link CDNImage} */
|
|
45
|
+
image: CDNImage[];
|
|
46
46
|
/** The award limit */
|
|
47
47
|
limitAward: null;
|
|
48
48
|
/** The benefit limit */
|
|
@@ -95,14 +95,14 @@ export declare type ShoppingCartBenefits = Benefit[];
|
|
|
95
95
|
* @typedef BenefitsByUserNode
|
|
96
96
|
* @since 0.5.14
|
|
97
97
|
*/
|
|
98
|
-
export declare type BenefitsByUserNode =
|
|
98
|
+
export declare type BenefitsByUserNode = ArtisnDBQueryDocumentSnapshot<ArtisnDBDocumentData>;
|
|
99
99
|
/**
|
|
100
100
|
* The complete collection of benefits DB nodes from a user.
|
|
101
101
|
*
|
|
102
102
|
* @typedef BenefitsByUserNodes
|
|
103
103
|
* @since 0.5.14
|
|
104
104
|
*/
|
|
105
|
-
export declare type BenefitsByUserNodes =
|
|
105
|
+
export declare type BenefitsByUserNodes = ArtisnDBCollectionReference<ArtisnDBDocumentData>;
|
|
106
106
|
/**
|
|
107
107
|
* The possible values of the benefit type.
|
|
108
108
|
*
|