@artisan-commerce/types 0.14.0-canary.0 → 0.14.0-canary.1
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 +9 -0
- package/build/types/account.types.d.ts +3 -3
- package/build/types/category.types.d.ts +3 -3
- package/build/types/coupon.types.d.ts +3 -3
- package/build/types/order.types.d.ts +0 -18
- package/build/types/payment.types.d.ts +16 -0
- package/build/types/product.types.d.ts +5 -5
- package/build/types/store.types.d.ts +3 -3
- package/build/types/vendor.types.d.ts +3 -3
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,15 @@
|
|
|
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.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)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Features
|
|
10
|
+
|
|
11
|
+
* **builders:** add missing builders and delete unused type ([361abac](https://bitbucket.org/tradesystem/artisan_sdk/commit/361abac9996fef1b0c308b1bd940f19379f8842a))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
6
15
|
## [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
16
|
|
|
8
17
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CDNImage } from "./image.types";
|
|
2
2
|
/**
|
|
3
3
|
* Representation of a Commerce Account.
|
|
4
4
|
*
|
|
@@ -12,6 +12,6 @@ export interface Account {
|
|
|
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,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,7 +1,7 @@
|
|
|
1
1
|
import { ArtisanDBCollectionReference } from "./artisanDB.types";
|
|
2
2
|
import { ArtisanDBQueryDocumentSnapshot } from "./artisanDB.types";
|
|
3
3
|
import { ArtisanDBDocumentData } from "./artisanDB.types";
|
|
4
|
-
import {
|
|
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 */
|
|
@@ -155,21 +155,3 @@ export interface OrderDetailShippingCost {
|
|
|
155
155
|
* @since 0.5.15
|
|
156
156
|
*/
|
|
157
157
|
export declare type Order = BaseOrder | OrderDetails;
|
|
158
|
-
/**
|
|
159
|
-
* Order payload that will be created.
|
|
160
|
-
*
|
|
161
|
-
* @interface PostOrderDetailsPayload
|
|
162
|
-
* @since 0.5.15
|
|
163
|
-
*/
|
|
164
|
-
export interface PostOrderDetailsPayload {
|
|
165
|
-
/** Order unique identifier */
|
|
166
|
-
orderId: number;
|
|
167
|
-
/** Order payment method unique identifier */
|
|
168
|
-
paymentMethodId: number;
|
|
169
|
-
/** Order payment amount */
|
|
170
|
-
paymentAmount: string;
|
|
171
|
-
/** Order customer cash amount */
|
|
172
|
-
customerCashAmount: string;
|
|
173
|
-
/** Order comment */
|
|
174
|
-
comment: string;
|
|
175
|
-
}
|
|
@@ -79,3 +79,19 @@ export declare type PaymentMethodName = "CREDIT_CARD" | "CASH";
|
|
|
79
79
|
* @since 0.5.14
|
|
80
80
|
*/
|
|
81
81
|
export declare type CardName = "Diners" | "Discover" | "American Express" | "Visa" | "MasterCard";
|
|
82
|
+
/**
|
|
83
|
+
* Representation of a card inscription.
|
|
84
|
+
*
|
|
85
|
+
* @interface CardInscription
|
|
86
|
+
* @since 0.5.15
|
|
87
|
+
*/
|
|
88
|
+
export interface CardInscription {
|
|
89
|
+
id: number;
|
|
90
|
+
uid: string;
|
|
91
|
+
number: string;
|
|
92
|
+
type: string;
|
|
93
|
+
authCode?: string;
|
|
94
|
+
bin: string;
|
|
95
|
+
paymentToken: string;
|
|
96
|
+
createdAt?: string;
|
|
97
|
+
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { BaseWeekDay } from "./common.types";
|
|
2
|
-
import {
|
|
2
|
+
import { CDNImage } from "./image.types";
|
|
3
3
|
import { Alert } from "./shoppingCart.types";
|
|
4
4
|
/**
|
|
5
5
|
* Representation of a Commerce Product.
|
|
@@ -43,8 +43,8 @@ export interface BaseProduct {
|
|
|
43
43
|
suggestedPrice: string;
|
|
44
44
|
/** Indicates if a product is available */
|
|
45
45
|
available: boolean;
|
|
46
|
-
/** Array of product images, see {@link
|
|
47
|
-
images:
|
|
46
|
+
/** Array of product images, see {@link CDNImage} */
|
|
47
|
+
images: CDNImage[];
|
|
48
48
|
/** The standard time of the product */
|
|
49
49
|
standardTime: string;
|
|
50
50
|
/** Indicates if a product is sponsored */
|
|
@@ -192,8 +192,8 @@ export interface ProductQuestion {
|
|
|
192
192
|
* see {@link ProductAnswer}
|
|
193
193
|
*/
|
|
194
194
|
answers: ProductAnswer[];
|
|
195
|
-
/** Array of product question images to display, see {@link
|
|
196
|
-
images:
|
|
195
|
+
/** Array of product question images to display, see {@link CDNImage} */
|
|
196
|
+
images: CDNImage[] | undefined;
|
|
197
197
|
}
|
|
198
198
|
/**
|
|
199
199
|
* Common props for products and answers.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CDNImage } from "./image.types";
|
|
2
2
|
import { Vendor } from "./vendor.types";
|
|
3
3
|
import { Catalogue } from "./catalogue.types";
|
|
4
4
|
import { BaseWeekDay } from "./common.types";
|
|
@@ -78,8 +78,8 @@ export interface Store {
|
|
|
78
78
|
location: StoreLocation;
|
|
79
79
|
/** Array of catalogues, see {@link Catalogue} */
|
|
80
80
|
catalogues: Catalogue[];
|
|
81
|
-
/** Array of store images, see {@link
|
|
82
|
-
images:
|
|
81
|
+
/** Array of store images, see {@link CDNImage}*/
|
|
82
|
+
images: CDNImage[];
|
|
83
83
|
/** The distance between the user and the store, roughly in metres */
|
|
84
84
|
distance: number;
|
|
85
85
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CDNImage } from "./image.types";
|
|
2
2
|
/**
|
|
3
3
|
* Representation of a Commerce Vendor.
|
|
4
4
|
*
|
|
@@ -8,8 +8,8 @@ import { Image } from "./image.types";
|
|
|
8
8
|
export interface Vendor {
|
|
9
9
|
/** Artisan's vendor unique identifier */
|
|
10
10
|
id: number;
|
|
11
|
-
/** Vendor's images, see {@link
|
|
12
|
-
images:
|
|
11
|
+
/** Vendor's images, see {@link CDNImage} */
|
|
12
|
+
images: CDNImage[];
|
|
13
13
|
/** Vendor's name */
|
|
14
14
|
name: string;
|
|
15
15
|
/** Vendor's maximum purchase value */
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@artisan-commerce/types",
|
|
3
3
|
"description": "Artisan's types and interfaces library",
|
|
4
|
-
"version": "0.14.0-canary.
|
|
4
|
+
"version": "0.14.0-canary.1",
|
|
5
5
|
"main": "./build/index.js",
|
|
6
6
|
"types": "./build/index.d.ts",
|
|
7
7
|
"files": [
|
|
@@ -42,5 +42,5 @@
|
|
|
42
42
|
"prettier": "^2.1.2",
|
|
43
43
|
"webpack-bundle-analyzer": "^3.9.0"
|
|
44
44
|
},
|
|
45
|
-
"gitHead": "
|
|
45
|
+
"gitHead": "caa730307125598ed71f2a24e10c7843a06e600d"
|
|
46
46
|
}
|