@artisan-commerce/types 0.13.0-canary.9 → 0.13.0

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

@@ -1,49 +1,55 @@
+import { BaseWeekDay } from "./common.types";
 import { Image } from "./image.types";
 import { Alert } from "./shoppingCart.types";
+/**
+ * Representation of a Commerce Product.
+ *
+ * @typedef Product
+ * @since 0.5.14
+ */
 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 {
+    /** Product unique identifier */
     productId: string;
+    /** The name of the product */
     name: string;
+    /** The description of the product */
     description: string;
+    /** The type of the product, see {@link ProductType} */
     type: ProductType;
+    /** The cover url of the product */
     coverUrl: string;
+    /** Product prices, see {@link ProductPrices} */
     prices: ProductPrices;
+    /** Indicates if a product can be added directly to cart */
     addDirectlyToCart: boolean;
+    /** Indicates if a product is out of service */
     outOfService: boolean;
+    /** Indicates if a product is out of stock */
     outOfStock: boolean;
+    /** The stock of the product */
     stock: number;
+    /** The measure of the product */
     measure: string;
+    /** Product attributes, see {@link ProductAttributes} */
     attributes: ProductAttributes;
+    /** The suggested price of the product */
     suggestedPrice: string;
+    /**  Indicates if a product is available */
     available: boolean;
+    /** Array of product images, see {@link Image} */
     images: Image[];
+    /** The standard time of the product */
     standardTime: string;
+    /** Indicates if a product is sponsored */
     sponsored: boolean;
+    /** The status of the product, see {@link ProductStatus} */
     status: ProductStatus;
 }
 /**
@@ -51,123 +57,243 @@ export interface BaseProduct {
  *
  * @interface ProductPrices
  * @since 0.5.14
- * @property {PriceCategory} NORMAL Normal price cotegory
- * @property {PriceCategory} POINTS Points price category
- *
  */
 export interface ProductPrices {
+    /** Normal price category, see {@link PriceCategory} */
     NORMAL: PriceCategory;
+    /** Points price category, see {@link PriceCategory} */
     POINTS: PriceCategory;
 }
+/**
+ * Price category attributes.
+ *
+ * @interface PriceCategory
+ * @since 0.5.14
+ */
 export interface PriceCategory {
+    /** Price category type, see {@link PriceCategoryType} */
     category: PriceCategoryType;
+    /** Price category without taxes */
     grossPrice: number;
+    /** Price category with taxes */
     netPrice: number;
+    /** Currency' symbol */
     symbol: string;
+    /** Array of price category' taxes, see {@link PriceCategoryTax} */
     taxes: PriceCategoryTax[];
+    /** Array of discounts applied to the price category */
     discounts: any[];
+    /** Total discounts without taxes */
     discountGrossPrice: number;
+    /** Total discounts with taxes */
     discountNetPrice: number;
+    /** Total discounts applied to the price category */
     discount: number;
 }
+/**
+ * Price category tax attributes.
+ *
+ * @interface PriceCategoryTax
+ * @since 0.5.14
+ */
 export interface PriceCategoryTax {
+    /** Price category' tax percentage */
     percentage: number;
+    /** Price category' tax name, see {@link TaxType} */
     name: TaxType;
+    /** Price category' value added tax rate */
     vatRateCode: number;
+    /** Price category' tax code */
     code: number;
+    /** Price category' value added tax */
     vatRate: string;
 }
+/**
+ * Additional product attributes.
+ *
+ * @interface ProductAttributes
+ * @since 0.5.14
+ */
 export interface ProductAttributes {
+    /** Product's quantity, the attribute is not in camel case purposefully */
     Cantidad: string;
+    /** Product external id */
     externalId: string;
+    /** Whether or not to show product in menu */
     showInMenu: boolean;
 }
 /**
- * The product status
+ * The product status.
  *
+ * @typedef ProductStatus
  * @since 0.5.14
- * @type ProductStatus
  **/
 export declare type ProductStatus = "ACTIVE" | "INACTIVE";
-export declare enum ProductType {
-    PRODUCT = "PRODUCT",
-    MODIFIER = "MODIFIER"
-}
-export declare enum PriceCategoryType {
-    NORMAL = "NORMAL",
-    POINTS = "POINTS"
-}
-export declare enum TaxType {
-    IVA = "IVA"
-}
+/**
+ * Product type's possible values.
+ *
+ * @typedef ProductType
+ * @since 0.5.14
+ **/
+export declare type ProductType = "PRODUCT" | "MODIFIER";
+/**
+ * Price category's possible values.
+ *
+ * @typedef PriceCategoryType
+ * @since 0.5.14
+ **/
+export declare type PriceCategoryType = "NORMAL" | "POINTS";
+/**
+ * Tax's possible values.
+ *
+ * @typedef TaxType
+ * @since 0.5.14
+ **/
+export declare type TaxType = "IVA";
+/**
+ * Weekday product's schedule.
+ *
+ * @interface DayOfWeek
+ * @since 0.5.14
+ */
 export interface DayOfWeek {
-    day: DayOfWeekName;
+    /** Week day in uppercase, see {@link BaseWeekDay} */
+    day: BaseWeekDay;
+    /**
+     * `Date` value representing the start time in which
+     * the product is available */
     from: number;
+    /**
+     * `Date` value representing the end time in which
+     *  the product is available */
     to: number;
 }
-export declare enum DayOfWeekName {
-    MONDAY = "MONDAY",
-    TUESDAY = "TUESDAY",
-    WEDNESDAY = "WEDNESDAY",
-    THURSDAY = "THURSDAY",
-    FRIDAY = "FRIDAY",
-    SATURDAY = "SATURDAY",
-    SUNDAY = "SUNDAY"
-}
+/**
+ * The representation of a product question.
+ *
+ * @interface ProductQuestion
+ * @since 0.5.14
+ */
 export interface ProductQuestion {
+    /** Product question id */
     questionId: string;
+    /** Product question name */
     name: string;
+    /** Product question description */
     description: string | null;
+    /** Product question minimum number of allowed answers */
     min: number;
+    /** Product question maximum  number of allowed answers */
     max: number;
+    /** Product question type */
     type: string | null;
+    /**
+     * Array of possible answers to a product question,
+     * see {@link ProductAnswer}
+     */
     answers: ProductAnswer[];
+    /** Array of product question images to display, see {@link Image} */
     images: Image[] | undefined;
 }
+/**
+ * Common props for products and answers.
+ *
+ * @typedef CommonProductAndAnswersProps
+ * @since 0.5.14
+ */
 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
- *
+ * @extends {{@link BaseProduct}
  */
 export interface ProductDetails extends BaseProduct {
+    /** Indicates if a product has a price vip */
     isPriceVip: boolean;
+    /** Manufacturer The manufacturer of the product */
     manufacturer: string[];
+    /** The max amount for sale of the product */
     maxAmountForSale: number;
+    /** Array of product schedules, see {@link DayOfWeek} */
     schedule: DayOfWeek[];
+    /** Array of product questions, see {@link ProductQuestion} */
     questions: ProductQuestion[];
+    /** The benefit id of the product */
     benefitId?: number;
 }
+/**
+ * Representation of a Commerce Product Answer.
+ *
+ * @interface ProductAnswer
+ * @since 0.5.14
+ * @extends Pick<Product,CommonProductAndAnswersProps>, see
+ * {@link Product} and {@link CommonProductAndAnswersProps}
+ * for further information
+ */
 export interface ProductAnswer extends Pick<Product, CommonProductAndAnswersProps> {
+    /**
+     * Array of questions associated with the answer,
+     * see {@link ProductDetails}
+     */
     questions: ProductDetails["questions"];
+    /** Type of question to render */
     renderType: string | null;
 }
+/**
+ * Representation of a Commerce Cart Product Question.
+ *
+ * @interface CartProductQuestion
+ * @since 0.5.14
+ * @extends {{@link ProductQuestion}
+ */
 export interface CartProductQuestion extends ProductQuestion {
+    /** Array of possible answers to the question */
     answers: CartProductAnswer[];
 }
+/**
+ * Representation of a Commerce Cart Product Answer.
+ *
+ * @interface CartProductAnswer
+ * @since 0.5.14
+ * @extends {{@link ProductAnswer}
+ */
 export interface CartProductAnswer extends ProductAnswer {
+    /** Question unique identifier */
     questionId: string;
+    /** Quantity of allowed cart product answers */
     amount: number;
+    /** Price category value of a product answer */
     priceCategory: PriceCategoryType;
+    /** Comment associated with the product answer  */
     comment: string;
+    /** Array of possible questions and answers */
     questionsAndAnswers: CartProductQuestion[];
 }
+/**
+ * Representation of a Commerce Cart Product.
+ *
+ * @interface CartProduct
+ * @since 0.5.14
+ * @extends {{@link ProductDetails}
+ */
 export interface CartProduct extends ProductDetails {
+    /** Quantity of allowed cart products */
     amount: number;
+    /** Cart product price category */
     priceCategory: PriceCategoryType;
+    /** Comment associated with the cart product  */
     comment: string;
+    /** Array of possible questions and answers associated with the product*/
     questionsAndAnswers: CartProductQuestion[];
+    /** Cart product unique identifier */
     hash: string;
+    /** Cart product creation date */
     createdAt: string;
+    /** Cart product updating date */
     updatedAt: string;
+    /** Array of alerts associated with the cart product */
     alerts: Alert[];
 }
 export {};

package/build/types/product.types.js

@@ -1,28 +1,4 @@
 "use strict";
+// Product and product details types and interfaces
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DayOfWeekName = exports.TaxType = exports.PriceCategoryType = exports.ProductType = void 0;
-var ProductType;
-(function (ProductType) {
-    ProductType["PRODUCT"] = "PRODUCT";
-    ProductType["MODIFIER"] = "MODIFIER";
-})(ProductType = exports.ProductType || (exports.ProductType = {}));
-var PriceCategoryType;
-(function (PriceCategoryType) {
-    PriceCategoryType["NORMAL"] = "NORMAL";
-    PriceCategoryType["POINTS"] = "POINTS";
-})(PriceCategoryType = exports.PriceCategoryType || (exports.PriceCategoryType = {}));
-var TaxType;
-(function (TaxType) {
-    TaxType["IVA"] = "IVA";
-})(TaxType = exports.TaxType || (exports.TaxType = {}));
-var DayOfWeekName;
-(function (DayOfWeekName) {
-    DayOfWeekName["MONDAY"] = "MONDAY";
-    DayOfWeekName["TUESDAY"] = "TUESDAY";
-    DayOfWeekName["WEDNESDAY"] = "WEDNESDAY";
-    DayOfWeekName["THURSDAY"] = "THURSDAY";
-    DayOfWeekName["FRIDAY"] = "FRIDAY";
-    DayOfWeekName["SATURDAY"] = "SATURDAY";
-    DayOfWeekName["SUNDAY"] = "SUNDAY";
-})(DayOfWeekName = exports.DayOfWeekName || (exports.DayOfWeekName = {}));
 //# sourceMappingURL=product.types.js.map

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"product.types.js","sourceRoot":"","sources":["../../src/types/product.types.ts"],"names":[],"mappings":";AAAA,mDAAmD"}

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

@@ -1,25 +1,73 @@
 import { CountrySummary } from "./common.types";
 import { LivingPlace, LivingPlaceToSave } from "./livingPlace.types";
+/**
+ * Representation of a basic Shipping Address.
+ *
+ * @interface BaseShippingAddress
+ * @since 0.5.14
+ */
 export interface BaseShippingAddress {
+    /** Whether or not the shipping address is default */
     default: boolean;
+    /** Shipping address' latitude */
     lat: number;
+    /** Shipping address' longitude */
     lng: number;
+    /** Shipping address' reference */
     reference: string;
+    /** Shipping address' main street */
     mainStreet: string;
+    /** Shipping address' living place number */
     number: string;
+    /** Shipping address' secondary street */
     secondaryStreet: string;
+    /** Shipping address' reference */
     addressReference: string;
+    /** It contains country id and country name, see {@link CountrySummary} */
     country: CountrySummary;
 }
+/**
+ * Representation of a Commerce Shipping Address.
+ *
+ * @interface ShippingAddress
+ * @since 0.5.14
+ * @extends {{@link BaseShippingAddress}
+ */
 export interface ShippingAddress extends BaseShippingAddress {
+    /** Shipping address unique identifier */
     id: number;
+    /** Object which contains the living place, see {@link LivingPlace} */
     livingPlace: LivingPlace;
 }
+/**
+ * A shipping address object used when it needs to be created.
+ *
+ * @interface NewShippingAddress
+ * @since 0.5.14
+ * @extends {{@link BaseShippingAddress}
+ */
 export interface NewShippingAddress extends BaseShippingAddress {
+    /** Shipping address unique identifier */
     id?: number;
+    /**
+     * Object which contains the living place to save,
+     * see {@link LivingPlaceToSave}
+     */
     livingPlace: LivingPlaceToSave;
 }
+/**
+ * A shipping address object used when it needs to be updated.
+ *
+ * @interface UpdatedShippingAddress
+ * @since 0.5.14
+ * @extends {{@link BaseShippingAddress}
+ */
 export interface UpdatedShippingAddress extends BaseShippingAddress {
+    /** Shipping address unique identifier */
     id: number;
+    /**
+     * Object which contains the living place to update,
+     * see {@link LivingPlaceToSave}
+     */
     livingPlace: LivingPlaceToSave;
 }

package/build/types/shippingAddress.types.js

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

package/build/types/shippingAddress.types.js.map

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

package/build/types/shippingCost.types.d.ts

@@ -1,23 +1,54 @@
+/**
+ * Representation of a Commerce Shipping Cost.
+ *
+ * @interface ShippingCost
+ * @since 0.5.14
+ */
 export interface ShippingCost {
+    /** Shipping cost product's id */
     productId: number;
+    /** Shipping cost's name */
     name: string;
+    /** Shipping cost's amount */
     amount: number;
+    /** Currency's symbol */
     symbol: string;
+    /** Array of shipping cost's taxes, see {@link ShippingCostTax} */
     taxes: ShippingCostTax[];
+    /** Shipping cost's price without taxes */
     grossPrice: number;
+    /** Shipping cost's price */
     netPrice: number;
+    /** Shipping cost's subtotal without taxes */
     subtotalBeforeTaxes: number;
+    /** Shipping cost's tax total */
     taxTotal: number;
+    /** Shipping cost's discount */
     discounts: any[];
+    /** Shipping cost's discount total amount */
     discountTotal: number;
+    /** Shipping cost's total */
     total: number;
 }
+/**
+ * Representation of a shipping cost tax.
+ *
+ * @interface ShippingCostTax
+ * @since 0.5.14
+ */
 export interface ShippingCostTax {
+    /** Tax percentage to be applied */
     percentage: number;
+    /** Tax name */
     name: string;
+    /** Value added tax rate code */
     vatRateCode: number;
+    /** Tax code */
     code: number;
+    /** Value added tax rate */
     vatRate: string;
+    /** Tax base value */
     taxBase: number;
+    /** Tax value */
     value: string;
 }

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

@@ -1,70 +1,124 @@
+import { Store } from "./store.types";
+import { Objectify } from "./common.types";
 import { CartProduct } from "./product.types";
 import { PriceCategoryType } from "./product.types";
-import { Objectify } from "./common.types";
-import { Store } from "./store.types";
 import { ShippingCost } from "./shippingCost.types";
-import { ShoppingCartBenefits } from "./coupons.types";
+import { ShoppingCartBenefits } from "./coupon.types";
+import { ArtisanDBDocumentData } from "./artisanDB.types";
 import { ArtisanDBCollectionReference } from "./artisanDB.types";
 import { ArtisanDBQueryDocumentSnapshot } from "./artisanDB.types";
-import { ArtisanDBDocumentData } from "./artisanDB.types";
 /**
- * ShoppingCart attributes.
+ * Representation of a Commerce Shopping Cart.
  *
  * @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 {
+    /** Shopping cart unique identifier */
     id: string;
+    /** Shopping cart name */
     name: string;
+    /** Shopping cart latitude */
     latitude: number;
+    /** Shopping cart longitude */
     longitude: number;
+    /** Shopping cart price category, see {@link PriceCategoryType}*/
     priceCategory?: PriceCategoryType;
+    /** Shopping cart creation date */
     createdAt: string;
+    /** Shopping cart update date */
     updatedAt: string;
+    /** Shopping cart channel unique identifier */
     channelId: number;
+    /** Shopping cart stores, see Objectify<{@link CartStore}> */
     stores: Objectify<CartStore>;
-    shippingCost?: ShippingCost;
+    /** Shopping cart shipping cost */
+    shippingCost: ShippingCost | null;
+    /** Shopping cart additional info */
     additional_info?: Record<string, any>;
+    /** Shopping cart bill total */
     billTotal: BillTotal;
+    /** Shopping cart applied benefits */
     benefits?: ShoppingCartBenefits;
+    /** Shopping cart user wallet id */
     benefitsHash?: string;
 }
+/**
+ * Representation of a Alert.
+ *
+ * @interface Alert
+ * @since 0.5.14
+ */
 export interface Alert {
+    /** Alert error level */
     errorLevel: number;
+    /** Alert message */
     message: string;
+    /** Alert type */
     type: string;
 }
+/**
+ * Representation of a Cart Store.
+ *
+ * @interface CartStore
+ * @since 0.5.14
+ * @extends {{@link Store}
+ */
 export interface CartStore extends Store {
+    /** The products that belong to the store, see {@link CartProduct} */
     products: Objectify<CartProduct>;
+    /** Cart store's alerts */
     alerts: [];
 }
+/**
+ * The possible values of a Bill Total.
+ *
+ * @typedef BillTotal
+ * @since 0.5.14
+ */
 export declare type BillTotal = {
+    /** Normal bill total category */
     NORMAL?: BillTotalCategory;
+    /** Points bill total category */
     POINTS?: BillTotalCategory;
 };
+/**
+ * Representation of a Bill Total Category.
+ *
+ * @interface BillTotalCategory
+ * @since 0.5.14
+ */
 export interface BillTotalCategory {
+    /** Bill total category subtotal without taxes */
     subtotalBeforeTaxes: number;
+    /** Bill total category total taxes */
     taxTotal: number;
+    /** Bill total category total */
     total: number;
 }
+/**
+ * Representation of a Cart Totals.
+ *
+ * @interface CartTotals
+ * @since 0.5.14
+ */
 export interface CartTotals {
+    /** Cart totals subtotal */
     subtotal: number;
+    /** Cart totals shipping cost */
     shippingCost: number;
 }
+/**
+ * A shopping cart DB node from a user.
+ *
+ * @typedef ShoppingCartNode
+ * @since 0.5.14
+ */
 export declare type ShoppingCartNode = ArtisanDBQueryDocumentSnapshot<ArtisanDBDocumentData>;
+/**
+ * The complete collection of shopping carts DB nodes from a user.
+ *
+ * @typedef ShoppingCartNodes
+ * @since 0.5.14
+ */
 export declare type ShoppingCartNodes = ArtisanDBCollectionReference<ArtisanDBDocumentData>;

package/build/types/shoppingCart.types.js

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

package/build/types/shoppingCart.types.js.map

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