@artisan-commerce/types 0.14.0-canary.13 → 0.14.0-canary.15
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 +18 -0
- package/build/types/app.types.d.ts +23 -37
- package/build/types/country.types.d.ts +6 -22
- package/build/types/product.types.d.ts +2 -2
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,24 @@
|
|
|
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.15](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.14...@artisan-commerce/types@0.14.0-canary.15) (2021-10-05)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* **global:** fix ProductDetail builder and update its types ([cdc6cf9](https://bitbucket.org/tradesystem/artisn_sdk/commit/cdc6cf9ed2e7ff1a340bc691b0dc1156bc682d38))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## [0.14.0-canary.14](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.13...@artisan-commerce/types@0.14.0-canary.14) (2021-10-01)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Bug Fixes
|
|
19
|
+
|
|
20
|
+
* **global:** fix firebase related types ([efa5081](https://bitbucket.org/tradesystem/artisn_sdk/commit/efa5081a844be033ac9135ac65bf8f56184b71b0))
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
6
24
|
## [0.14.0-canary.13](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.12...@artisan-commerce/types@0.14.0-canary.13) (2021-09-30)
|
|
7
25
|
|
|
8
26
|
**Note:** Version bump only for package @artisan-commerce/types
|
|
@@ -8,40 +8,40 @@ import "@react-native-firebase/firestore";
|
|
|
8
8
|
* @typedef ArtisnApp
|
|
9
9
|
* @since 0.1.0
|
|
10
10
|
*/
|
|
11
|
-
export declare type ArtisnApp =
|
|
11
|
+
export declare type ArtisnApp = ArtisnWebApp | ArtisnRNApp;
|
|
12
12
|
/**
|
|
13
|
-
* The
|
|
13
|
+
* The ArtisnWebApp orchestrate the connections of the app with the DB, server
|
|
14
14
|
* and its settings.
|
|
15
15
|
*
|
|
16
|
-
* @interface
|
|
16
|
+
* @interface ArtisnWebApp
|
|
17
17
|
* @since 0.1.0
|
|
18
18
|
*/
|
|
19
|
-
export interface
|
|
19
|
+
export interface ArtisnWebApp {
|
|
20
20
|
/** App's name */
|
|
21
21
|
name: firebase.app.App["name"];
|
|
22
22
|
/** Artisn's account API URL */
|
|
23
23
|
apiURL: string;
|
|
24
|
-
/** Artisn app settings configuration, see {@link
|
|
25
|
-
settings:
|
|
24
|
+
/** Artisn app settings configuration, see {@link ArtisnWebSettings} */
|
|
25
|
+
settings: ArtisnWebSettings;
|
|
26
26
|
/** Internal configuration of App and databases */
|
|
27
27
|
__internals__: firebase.app.App;
|
|
28
28
|
/** ArtisnApp object internal instance */
|
|
29
29
|
__instance__: typeof firebase;
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
|
-
* The
|
|
32
|
+
* The ArtisnRNApp orchestrate the connections of the app with the DB, server
|
|
33
33
|
* and its settings.
|
|
34
34
|
*
|
|
35
|
-
* @interface
|
|
35
|
+
* @interface ArtisnRNApp
|
|
36
36
|
* @since 0.1.0
|
|
37
37
|
*/
|
|
38
|
-
export interface
|
|
38
|
+
export interface ArtisnRNApp {
|
|
39
39
|
/** App's name */
|
|
40
40
|
name: ReactNativeFirebase.FirebaseApp["name"];
|
|
41
41
|
/** Artisn's account API URL */
|
|
42
42
|
apiURL: string;
|
|
43
|
-
/** Artisn app settings configuration, see {@link
|
|
44
|
-
settings:
|
|
43
|
+
/** Artisn app settings configuration, see {@link ArtisnRNSettings} */
|
|
44
|
+
settings: ArtisnRNSettings;
|
|
45
45
|
/** Internal configuration of App and databases */
|
|
46
46
|
__internals__: ReactNativeFirebase.FirebaseApp;
|
|
47
47
|
/** ArtisnApp object internal instance */
|
|
@@ -50,10 +50,10 @@ export interface ArtisnAppRN {
|
|
|
50
50
|
/**
|
|
51
51
|
* Settings to configure the Artisn app.
|
|
52
52
|
*
|
|
53
|
-
* @interface
|
|
53
|
+
* @interface ArtisnWebSettings
|
|
54
54
|
* @since 0.1.0
|
|
55
55
|
*/
|
|
56
|
-
export interface
|
|
56
|
+
export interface ArtisnWebSettings {
|
|
57
57
|
/** Artisn's account unique identifier */
|
|
58
58
|
accountId?: number;
|
|
59
59
|
/** Platform where the app is running, see {@link ArtisnPlatform} */
|
|
@@ -70,10 +70,10 @@ export interface ArtisnSettings {
|
|
|
70
70
|
/**
|
|
71
71
|
* Settings to configure the Artisn app react-native.
|
|
72
72
|
*
|
|
73
|
-
* @interface
|
|
73
|
+
* @interface ArtisnRNSettings
|
|
74
74
|
* @since 0.1.0
|
|
75
75
|
*/
|
|
76
|
-
export interface
|
|
76
|
+
export interface ArtisnRNSettings {
|
|
77
77
|
/** Platform where the app is running, see {@link ArtisnPlatform} */
|
|
78
78
|
platform: ArtisnPlatform;
|
|
79
79
|
/** Artisn's account unique identifier */
|
|
@@ -89,49 +89,35 @@ export declare type ArtisnPlatform = "web" | "ios" | "android" | "windows" | "ma
|
|
|
89
89
|
/**
|
|
90
90
|
* Artisn's auth instance is the instance of the internal auth object.
|
|
91
91
|
*
|
|
92
|
-
* @typedef
|
|
92
|
+
* @typedef ArtisnWebAuthInstance
|
|
93
93
|
* @since 0.1.0
|
|
94
94
|
*/
|
|
95
|
-
export declare type
|
|
96
|
-
/**
|
|
97
|
-
* Artisn's auth instance is the instance of the internal auth object.
|
|
98
|
-
*
|
|
99
|
-
* @typedef ArtisnAuthInstanceWeb
|
|
100
|
-
* @since 0.1.0
|
|
101
|
-
*/
|
|
102
|
-
export declare type ArtisnAuthInstanceWeb = typeof firebase.auth;
|
|
95
|
+
export declare type ArtisnWebAuthInstance = typeof firebase.auth;
|
|
103
96
|
/**
|
|
104
97
|
* Artisn's auth instance is the instance of the internal auth object for react
|
|
105
98
|
* native.
|
|
106
99
|
*
|
|
107
|
-
* @typedef
|
|
108
|
-
* @since 0.1.0
|
|
109
|
-
*/
|
|
110
|
-
export declare type ArtisnAuthInstanceRN = typeof authRN;
|
|
111
|
-
/**
|
|
112
|
-
* Artisn's auth object to handle providers authentication.
|
|
113
|
-
*
|
|
114
|
-
* @typedef ArtisnAuth
|
|
100
|
+
* @typedef ArtisnRNAuthInstance
|
|
115
101
|
* @since 0.1.0
|
|
116
102
|
*/
|
|
117
|
-
export declare type
|
|
103
|
+
export declare type ArtisnRNAuthInstance = typeof authRN;
|
|
118
104
|
/**
|
|
119
105
|
* Artisn's auth object to handle providers authentication.
|
|
120
106
|
*
|
|
121
|
-
* @interface
|
|
107
|
+
* @interface ArtisnWebAuth
|
|
122
108
|
* @since 0.1.0
|
|
123
109
|
* @extends {{@link firebase.auth.Auth}
|
|
124
110
|
*/
|
|
125
|
-
export interface
|
|
111
|
+
export interface ArtisnWebAuth extends firebase.auth.Auth {
|
|
126
112
|
}
|
|
127
113
|
/**
|
|
128
114
|
* Artisn's auth object to handle providers authentication for react native.
|
|
129
115
|
*
|
|
130
|
-
* @interface
|
|
116
|
+
* @interface ArtisnRNAuth
|
|
131
117
|
* @since 0.1.0
|
|
132
118
|
* @extends {{@link FirebaseAuthTypes.Module}
|
|
133
119
|
*/
|
|
134
|
-
export interface
|
|
120
|
+
export interface ArtisnRNAuth extends FirebaseAuthTypes.Module {
|
|
135
121
|
}
|
|
136
122
|
/**
|
|
137
123
|
* Main artisn commerce filters.
|
|
@@ -5,21 +5,17 @@
|
|
|
5
5
|
* @since 0.5.14
|
|
6
6
|
*/
|
|
7
7
|
export interface Country {
|
|
8
|
-
/** Country's
|
|
9
|
-
|
|
8
|
+
/** Country's identifier */
|
|
9
|
+
id: number;
|
|
10
10
|
/** Country's name */
|
|
11
11
|
name: string;
|
|
12
12
|
/** Country ISO code, see {@link CountryCode} */
|
|
13
13
|
code: CountryCode;
|
|
14
|
-
/** Whether or not the country is active */
|
|
15
|
-
active: boolean;
|
|
16
14
|
/**
|
|
17
15
|
* Object which contains information about country's currency,
|
|
18
16
|
* see {@link CountryCurrency}
|
|
19
17
|
*/
|
|
20
18
|
currency: CountryCurrency;
|
|
21
|
-
/** Array of taxes usually applied on the country, see {@link CountryTax} */
|
|
22
|
-
taxes: CountryTax[];
|
|
23
19
|
}
|
|
24
20
|
/**
|
|
25
21
|
* Representation of a country's currency.
|
|
@@ -28,26 +24,14 @@ export interface Country {
|
|
|
28
24
|
* @since 0.5.14
|
|
29
25
|
*/
|
|
30
26
|
export interface CountryCurrency {
|
|
31
|
-
/** Currency's
|
|
32
|
-
|
|
27
|
+
/** Currency's identifier */
|
|
28
|
+
id: number;
|
|
33
29
|
/** Currency's name */
|
|
34
30
|
name: string;
|
|
35
31
|
/** Currency's symbol */
|
|
36
32
|
sign: string;
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
* Representation of a country's tax.
|
|
40
|
-
*
|
|
41
|
-
* @interface CountryTax
|
|
42
|
-
* @since 0.5.14
|
|
43
|
-
*/
|
|
44
|
-
export interface CountryTax {
|
|
45
|
-
/** Tax name */
|
|
46
|
-
tax: string;
|
|
47
|
-
/** Value added tax rate */
|
|
48
|
-
vatRate: string;
|
|
49
|
-
/** Tax percentage */
|
|
50
|
-
percentage: number;
|
|
33
|
+
/** Currency's external identifier */
|
|
34
|
+
external_id: string;
|
|
51
35
|
}
|
|
52
36
|
/**
|
|
53
37
|
* List of country codes currently supported.
|
|
@@ -222,8 +222,8 @@ export interface ProductDetails extends BaseProduct {
|
|
|
222
222
|
/** Array of product questions, see {@link ProductQuestion} */
|
|
223
223
|
questions: ProductQuestion[];
|
|
224
224
|
/** The benefit id of the product */
|
|
225
|
-
benefitId
|
|
226
|
-
categories
|
|
225
|
+
benefitId: number | null;
|
|
226
|
+
categories: Category[] | null;
|
|
227
227
|
}
|
|
228
228
|
/**
|
|
229
229
|
* Representation of a Commerce Product Answer.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@artisan-commerce/types",
|
|
3
3
|
"description": "Artisn's types and interfaces library",
|
|
4
|
-
"version": "0.14.0-canary.
|
|
4
|
+
"version": "0.14.0-canary.15",
|
|
5
5
|
"main": "./build/index.js",
|
|
6
6
|
"types": "./build/index.d.ts",
|
|
7
7
|
"files": [
|
|
@@ -45,5 +45,5 @@
|
|
|
45
45
|
"prettier": "^2.1.2",
|
|
46
46
|
"webpack-bundle-analyzer": "^3.9.0"
|
|
47
47
|
},
|
|
48
|
-
"gitHead": "
|
|
48
|
+
"gitHead": "3dd98531bbced6940b68711bfc3246163339ed61"
|
|
49
49
|
}
|