@artisan-commerce/types 0.13.0-canary.6 → 0.13.0-canary.8

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.13.0-canary.8](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/types@0.13.0-canary.7...@artisan-commerce/types@0.13.0-canary.8) (2021-06-10)
+
+
+### Features
+
+* **global:** coupons functionality ([6a538c4](https://bitbucket.org/tradesystem/artisan_monorepo/commit/6a538c40d7e0eb380c6bbb274bd640b591787bc8))
+* **global:** coupons functionality ([33117c2](https://bitbucket.org/tradesystem/artisan_monorepo/commit/33117c27c0e9f2d5e28705934abd1597fc92092e))
+* **global:** coupons functionality ([2202f0d](https://bitbucket.org/tradesystem/artisan_monorepo/commit/2202f0dd41a393eca7697d056df6f75f80748bb1))
+
+
+
+## [0.13.0-canary.7](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/types@0.13.0-canary.6...@artisan-commerce/types@0.13.0-canary.7) (2021-04-22)
+
+
+### Features
+
+* **types:** add country types and interfaces ([f73fabd](https://bitbucket.org/tradesystem/artisan_monorepo/commit/f73fabd5615ae1bb39c9ca59a8b79a5437eca9d1))
+
+
+
 ## [0.13.0-canary.6](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/types@0.13.0-canary.5...@artisan-commerce/types@0.13.0-canary.6) (2021-04-21)
 
 

package/build/index.d.ts

@@ -5,6 +5,7 @@ export * from "./types/category.types";
 export * from "./types/channel.types";
 export * from "./types/common.types";
 export * from "./types/coupons.types";
+export * from "./types/country.types";
 export * from "./types/currency.types";
 export * from "./types/image.types";
 export * from "./types/product.types";

package/build/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./types/category.types"), exports);
 __exportStar(require("./types/channel.types"), exports);
 __exportStar(require("./types/common.types"), exports);
 __exportStar(require("./types/coupons.types"), exports);
+__exportStar(require("./types/country.types"), exports);
 __exportStar(require("./types/currency.types"), exports);
 __exportStar(require("./types/image.types"), exports);
 __exportStar(require("./types/product.types"), exports);

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO;AACP,oDAAkC;AAClC,wDAAsC;AACtC,0DAAwC;AACxC,yDAAuC;AACvC,wDAAsC;AACtC,uDAAqC;AACrC,wDAAsC;AACtC,yDAAuC;AACvC,sDAAoC;AACpC,wDAAsC;AACtC,6DAA2C;AAC3C,6DAA2C;AAC3C,sDAAoC;AACpC,uDAAqC;AACrC,qDAAmC;AACnC,qDAAmC;AACnC,4DAA0C;AAC1C,4DAA0C;AAC1C,gEAA8C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO;AACP,oDAAkC;AAClC,wDAAsC;AACtC,0DAAwC;AACxC,yDAAuC;AACvC,wDAAsC;AACtC,uDAAqC;AACrC,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,sDAAoC;AACpC,wDAAsC;AACtC,6DAA2C;AAC3C,6DAA2C;AAC3C,sDAAoC;AACpC,uDAAqC;AACrC,qDAAmC;AACnC,qDAAmC;AACnC,4DAA0C;AAC1C,4DAA0C;AAC1C,gEAA8C"}

package/build/types/billingData.types.d.ts

@@ -1,4 +1,4 @@
-import { Country } from "./common.types";
+import { CountrySummary } from "./common.types";
 import { DocumentType } from "./common.types";
 export interface BaseBillingData {
     nickname: string;
@@ -9,7 +9,7 @@ export interface BaseBillingData {
     phone: string;
     email: string;
     default: boolean;
-    country: Country;
+    country: CountrySummary;
 }
 export interface BillingData extends BaseBillingData {
     id: number;

package/build/types/common.types.d.ts

@@ -2,7 +2,7 @@ export interface Objectify<T> {
     [key: string]: T;
 }
 export declare type DocumentType = "CI" | "RUC" | "PASSPORT";
-export interface Country {
+export interface CountrySummary {
     id: number;
     name: string;
 }

package/build/types/country.types.d.ts

@@ -0,0 +1,18 @@
+export interface Country {
+    countryId: string;
+    name: string;
+    code: string;
+    active: boolean;
+    currency: CountryCurrency;
+    taxes: CountryTax[];
+}
+export interface CountryCurrency {
+    currencyId: string;
+    name: string;
+    sign: string;
+}
+export interface CountryTax {
+    tax: string;
+    vatRate: string;
+    percentage: string;
+}

package/build/types/country.types.js

@@ -0,0 +1,4 @@
+"use strict";
+// Country types and interfaces
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=country.types.js.map

package/build/types/country.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"country.types.js","sourceRoot":"","sources":["../../src/types/country.types.ts"],"names":[],"mappings":";AAAA,+BAA+B"}

package/build/types/coupons.types.d.ts

@@ -2,14 +2,47 @@ import { ArtisanDBCollectionReference } from "./artisanDB.types";
 import { ArtisanDBQueryDocumentSnapshot } from "./artisanDB.types";
 import { ArtisanDBDocumentData } from "./artisanDB.types";
 import { Image } from "./image.types";
+/**
+ * Walllet user information.
+ *
+ * @interface Wallet
+ * @since 0.5.14
+ * @property {Benefit[]} benefits Benefit's array from firestore user wallet
+ *
+ */
 export interface Wallet {
     benefits: Benefit[];
-    usedBenefits: Benefit[];
-    unusedBenefits: Benefit[];
 }
+/**
+ * Benefit information.
+ *
+ * @interface Benefit
+ * @since 0.5.14
+ * @property {string} hash The user wallet id
+ * @property {Award} award The benefit awards
+ * @property {number} benefitId Benefit id
+ * @property {number} benefitWalletId Benefit wallet id
+ * @property {null} code Benefit code in back-end
+ * @property {string} combined Combined
+ * @property {string} createdAt Benefit creation date
+ * @property {string} description Benefit description
+ * @property {number} discountPercentage Benefit discount percentage
+ * @property {string} expirationDate Benefit expiration date
+ * @property {null} externalId External benefit id
+ * @property {Image[]} image Benefit images
+ * @property {null} limitAward The award limit
+ * @property {number} limitBenefit The benefit limit
+ * @property {string} logicOperator The logic operator of the benefit
+ * @property {number} quantity Benefit stock
+ * @property {any[]} rules The rules of the benefit
+ * @property {string} title The benefit title
+ * @property {BenefitTypes} type Benefit type
+ * @property {string} updatedAt Benefit update date
+ *
+ */
 export interface Benefit {
     hash: string;
-    award: Award[];
+    award: Award;
     benefitId: number;
     benefitWalletId: number;
     code: null;
@@ -26,18 +59,32 @@ export interface Benefit {
     quantity: number;
     rules: any[];
     title: string;
-    type: string;
+    type: BenefitTypes;
     updatedAt: string;
 }
+/**
+ * Award information.
+ *
+ * @interface Award
+ * @since 0.5.14
+ * @property {number} id The id of the award
+ * @property {number} benefitId The id of the benefit
+ * @property {number} discountPercentage Benefit discount percentage
+ * @property {null} discountValue Benefit discount value
+ *
+ */
 export interface Award {
     id: number;
     benefitId: number;
     discountPercentage: number;
     discountValue: null;
 }
-export interface ShoppingCartBenefits {
-    [key: string]: Benefit;
-}
+/**
+ * Applied benefit array in shopping cart
+ *
+ * @type ShoppingCartBenefits
+ **/
+export declare type ShoppingCartBenefits = Benefit[];
 export declare type BenefitsByUserNode = ArtisanDBQueryDocumentSnapshot<ArtisanDBDocumentData>;
 export declare type BenefitsByUserNodes = ArtisanDBCollectionReference<ArtisanDBDocumentData>;
 export declare type BenefitTypes = "ALTER_DELIVERY" | "PRODUCT" | "DISCOUNT";

package/build/types/product.types.d.ts

@@ -1,16 +1,38 @@
 import { Image } from "./image.types";
 import { Alert } from "./shoppingCart.types";
 export declare type Product = BaseProduct | ProductDetails | CartProduct;
+/**
+ * Base product attributes.
+ *
+ * @interface BaseProduct
+ * @since 0.5.14
+ * @property {string} productId The product id
+ * @property {string} name The name of the product
+ * @property {string} description The description of the product
+ * @property {ProductType} type The type of the product
+ * @property {string} coverUrl The cover url of the product
+ * @property {ProductPrices} prices The prices object of the product
+ * @property {boolean} addDirectlyToCart Indicates if a product can be added directly to cart
+ * @property {boolean} outOfService Inidicates if a product is out of service
+ * @property {boolean} outOfStock Inidicates if a product is out of stock
+ * @property {number} outOfStock The stock of the product
+ * @property {string} measure The measure of the product
+ * @property {ProductAttributes} attributes The attributes of the product
+ * @property {string} suggestedPrice The suggested price of the product
+ * @property {boolean} available Indicates if a product is available
+ * @property {Image[]} images The images of the product
+ * @property {string} standardTime The standard time of the product
+ * @property {boolean} sponsored Indicates if a product is sponsored
+ * @property {ProductStatus} status The status of the product
+ *
+ */
 export interface BaseProduct {
     productId: string;
     name: string;
     description: string;
     type: ProductType;
     coverUrl: string;
-    prices: {
-        NORMAL: PriceCategory;
-        POINTS: PriceCategory;
-    };
+    prices: ProductPrices;
     addDirectlyToCart: boolean;
     outOfService: boolean;
     outOfStock: boolean;
@@ -22,7 +44,20 @@ export interface BaseProduct {
     images: Image[];
     standardTime: string;
     sponsored: boolean;
-    status: "ACTIVE" | "INACTIVE";
+    status: ProductStatus;
+}
+/**
+ * Product prices attributes.
+ *
+ * @interface ProductPrices
+ * @since 0.5.14
+ * @property {PriceCategory} NORMAL Normal price cotegory
+ * @property {PriceCategory} POINTS Points price category
+ *
+ */
+export interface ProductPrices {
+    NORMAL: PriceCategory;
+    POINTS: PriceCategory;
 }
 export interface PriceCategory {
     category: PriceCategoryType;
@@ -47,6 +82,13 @@ export interface ProductAttributes {
     externalId: string;
     showInMenu: boolean;
 }
+/**
+ * The product status
+ *
+ * @since 0.5.14
+ * @type ProductStatus
+ **/
+export declare type ProductStatus = "ACTIVE" | "INACTIVE";
 export declare enum ProductType {
     PRODUCT = "PRODUCT",
     MODIFIER = "MODIFIER"
@@ -83,12 +125,26 @@ export interface ProductQuestion {
     images: Image[] | undefined;
 }
 declare type CommonProductAndAnswersProps = "name" | "prices" | "attributes" | "productId" | "type" | "images";
+/**
+ * Product details attributes.
+ *
+ * @interface ProductDetails
+ * @since 0.5.14
+ * @property {boolean} isPriceVip Indicates if a product has a price vip
+ * @property {string[]} manufacturer The manufacturer of the product
+ * @property {number} maxAmountForSale The mas amount for sale of the product
+ * @property {DayOfWeek[]} schedule The schedule of the product
+ * @property {ProductQuestion[]} questions The questions of the product
+ * @property {number} benefitId The benefit id of the product
+ *
+ */
 export interface ProductDetails extends BaseProduct {
     isPriceVip: boolean;
     manufacturer: string[];
     maxAmountForSale: number;
     schedule: DayOfWeek[];
     questions: ProductQuestion[];
+    benefitId?: number;
 }
 export interface ProductAnswer extends Pick<Product, CommonProductAndAnswersProps> {
     questions: ProductDetails["questions"];

package/build/types/product.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"product.types.js","sourceRoot":"","sources":["../../src/types/product.types.ts"],"names":[],"mappings":";;;AAwDA,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,oCAAqB,CAAA;AACvB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AACD,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,sCAAiB,CAAA;IACjB,sCAAiB,CAAA;AACnB,CAAC,EAHW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAG5B;AACD,IAAY,OAEX;AAFD,WAAY,OAAO;IACjB,sBAAW,CAAA;AACb,CAAC,EAFW,OAAO,GAAP,eAAO,KAAP,eAAO,QAElB;AAQD,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,wCAAuB,CAAA;IACvB,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;IACjB,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;AACnB,CAAC,EARW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAQxB"}
+{"version":3,"file":"product.types.js","sourceRoot":"","sources":["../../src/types/product.types.ts"],"names":[],"mappings":";;;AAoGA,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,oCAAqB,CAAA;AACvB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AACD,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,sCAAiB,CAAA;IACjB,sCAAiB,CAAA;AACnB,CAAC,EAHW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAG5B;AACD,IAAY,OAEX;AAFD,WAAY,OAAO;IACjB,sBAAW,CAAA;AACb,CAAC,EAFW,OAAO,GAAP,eAAO,KAAP,eAAO,QAElB;AAQD,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,wCAAuB,CAAA;IACvB,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;IACjB,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;AACnB,CAAC,EARW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAQxB"}

package/build/types/shippingAddress.types.d.ts

@@ -1,4 +1,4 @@
-import { Country } from "./common.types";
+import { CountrySummary } from "./common.types";
 import { LivingPlace, LivingPlaceToSave } from "./livingPlace.types";
 export interface BaseShippingAddress {
     default: boolean;
@@ -9,7 +9,7 @@ export interface BaseShippingAddress {
     number: string;
     secondaryStreet: string;
     addressReference: string;
-    country: Country;
+    country: CountrySummary;
 }
 export interface ShippingAddress extends BaseShippingAddress {
     id: number;

package/build/types/shoppingCart.types.d.ts

@@ -7,6 +7,27 @@ import { ShoppingCartBenefits } from "./coupons.types";
 import { ArtisanDBCollectionReference } from "./artisanDB.types";
 import { ArtisanDBQueryDocumentSnapshot } from "./artisanDB.types";
 import { ArtisanDBDocumentData } from "./artisanDB.types";
+/**
+ * ShoppingCart attributes.
+ *
+ * @interface ShoppingCart
+ * @since 0.5.14
+ * @property {string} id The id of the shopping cart
+ * @property {string} name The name of the shopping cart
+ * @property {number} latitude The latitude of the shopping cart
+ * @property {number} longitude The longitude of the shopping cart
+ * @property {PriceCategoryType} priceCategory The priceCategory of the shopping cart
+ * @property {string} createdAt Shopping cart creation date
+ * @property {string} updatedAt Shopping cart update date
+ * @property {number} channelId The channel id of he shopping cart
+ * @property {Objectify<CartStore>} stores The stores of the shopping cart
+ * @property {ShippingCost} shippingCost The shipping cost of the shopping cart
+ * @property {Record<string, any>} additional_info The additional info of the shopping cart
+ * @property {BillTotal} billTotal The bill total of the shopping cart
+ * @property {ShoppingCartBenefits} benefits The applied benefits of the shopping cart
+ * @property {string} benefitsHash The user wallet id of the shopping cart
+ *
+ */
 export interface ShoppingCart {
     id: string;
     name: string;
@@ -21,7 +42,7 @@ export interface ShoppingCart {
     additional_info?: Record<string, any>;
     billTotal: BillTotal;
     benefits?: ShoppingCartBenefits;
-    benefitHash?: string;
+    benefitsHash?: string;
 }
 export interface Alert {
     errorLevel: number;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/types",
   "description": "Artisan's types and interfaces library",
-  "version": "0.13.0-canary.6",
+  "version": "0.13.0-canary.8",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
   "files": [
@@ -42,5 +42,5 @@
     "prettier": "^2.1.2",
     "webpack-bundle-analyzer": "^3.9.0"
   },
-  "gitHead": "abb51980630496cead2a6960fb525aa393599aeb"
+  "gitHead": "d1b6289c5e717daec9c4675d822c1b29c850bb9e"
 }