@artisan-commerce/types 0.14.0-canary.2 → 0.14.0-canary.21

package/build/types/notification.types.d.ts

@@ -1,21 +0,0 @@
-/**
- * Notification object.
- *
- * @interface Notification
- * @since 0.5.15
- */
-export interface Notification {
-    /** Notification unique identifier */
-    id: number;
-    /** Notification title */
-    title: string;
-    /** Notification description */
-    description: string;
-    /**
-     * Whether or not the notification was read. Purposefully
-     * has a string type.
-     */
-    read: string;
-    /** Notification creation date */
-    creationDate: string;
-}

package/build/types/notification.types.js

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

package/build/types/notification.types.js.map

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

package/build/types/order.types.d.ts

@@ -1,157 +0,0 @@
-import { BillTotalCategory } from "./shoppingCart.types";
-import { ShippingAddress } from "./shippingAddress.types";
-import { BillingData } from "./billingData.types";
-/**
- * Representation of common properties of the order.
- *
- * @interface BaseOrder
- * @since 0.5.15
- */
-export interface BaseOrder {
-    /** Order unique identifier */
-    id: number;
-    /** Order additional info */
-    additionalInfo: any[];
-    /** Order additional messages */
-    additionalMessage: string | null;
-    /** Order allocation */
-    allocation: string;
-    /** Channel unique identifier */
-    channelId: number;
-    /** Order date, e.g.: `02 Aug 2021` */
-    orderDate: string;
-    /** Order time, e.g.: `17:00 am` */
-    orderTime: string;
-    /** Pick up date, e.g.: `01 Aug 2021` */
-    pickupDate: string | null;
-    /** Pick up time, e.g.: `09:00 am` */
-    pickupTime: string | null;
-    /** Order sequence id */
-    seq_id: string;
-    /** Shopping cart associated with the order, see {@link OrderShoppingCart} */
-    shoppingCart: OrderShoppingCart;
-    /** Order step, see {@link OrderStep} */
-    step: OrderStep;
-    /** Step category */
-    stepCategory: string;
-    /** Step code */
-    stepCode: string;
-    /** Step unique identifier */
-    stepId: number;
-    /** Step name */
-    stepName: string;
-    /** Order transaction unique identifier */
-    transactionId: number | null;
-    /** Vendor unique identifier */
-    vendorId: number;
-}
-/**
- * The shopping cart associated with the order.
- *
- * @interface OrderShoppingCart
- * @since 0.5.15
- */
-export interface OrderShoppingCart {
-    /** Order bill total category, see {@link BillTotalCategory} */
-    billTotal: BillTotalCategory;
-    /**
-     * An array of the order paid payment methods,
-     * see {@link OrderPaidPaymentMethod}
-     */
-    paidPaymentMethods: OrderPaidPaymentMethod[];
-    /** An array of order stores, see {@link OrderStore} */
-    stores: OrderStore[];
-}
-/**
- * Store associated with the order.
- *
- * @interface OrderStore
- * @since 0.5.15
- */
-export interface OrderStore {
-    /**
-     * An array of products associated with the order,
-     * see {@link OrderProduct}
-     */
-    products: OrderProduct[];
-    /** Store name */
-    storeName: string;
-}
-/**
- * Product associated with the order.
- *
- * @interface OrderProduct
- * @since 0.5.15
- */
-export interface OrderProduct {
-    /** Product unique identifier */
-    productId: number;
-    /** Product name */
-    productName: string;
-}
-/**
- * Paid payment methods associated with the order.
- *
- * @interface OrderPaidPaymentMethod
- * @since 0.5.15
- */
-export interface OrderPaidPaymentMethod {
-    /** Order paid payment methods */
-    payment_method_name: string;
-    /** Order last retry, see {@link OrderLastRetry} */
-    lastRetry: OrderLastRetry;
-}
-/**
- * The last retry of the order.
- *
- * @interface OrderLastRetry
- * @since 0.5.15
- */
-export interface OrderLastRetry {
-    /** Order last retry step */
-    step: OrderStep;
-}
-/**
- * The step where the order is located.
- *
- * @interface OrderStep
- * @since 0.5.15
- */
-export interface OrderStep {
-    /** Step title to use on front end */
-    title_frontend: string;
-    /** Step description to use on front end */
-    description_frontend: string;
-}
-/**
- * The details of the order.
- *
- * @interface OrderDetails
- * @since 0.5.15
- * @extends {{@link BaseOrder}
- */
-export interface OrderDetails extends BaseOrder {
-    /** Order details' shipping address */
-    shippingAddress: ShippingAddress;
-    /** Order details' shipping cost, see {@link OrderDetailShippingCost} */
-    shippingCost: OrderDetailShippingCost;
-    /** Order details' billing data */
-    billingData: BillingData;
-}
-/**
- * The shipping cost associated with the order.
- *
- * @interface OrderDetailShippingCost
- * @since 0.5.15
- */
-export interface OrderDetailShippingCost {
-    /** Shipping cost net price */
-    net_price: number;
-}
-/**
- * Representation of a Commerce Order.
- *
- * @typedef Order
- * @since 0.5.15
- */
-export declare type Order = BaseOrder | OrderDetails;

package/build/types/order.types.js

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

package/build/types/order.types.js.map

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

package/build/types/payment.types.d.ts

@@ -1,97 +0,0 @@
-/**
- * Basic payment method object.
- *
- * @interface BasePaymentMethod
- * @since 0.5.14
- */
-export interface BasePaymentMethod {
-    /** Payment method's id */
-    id: number;
-    /** Payment method's created date */
-    created_at: string | null;
-    /** Payment method's updated date */
-    updated_at: string | null;
-    /** Payment method's deleted date */
-    deleted_at: string | null;
-}
-/**
- * Representation of a Commerce Payment method.
- *
- * @interface PaymentMethod
- * @since 0.5.14
- * @extends {{@link BasePaymentMethod}
- */
-export interface PaymentMethod extends BasePaymentMethod {
-    /** Payment method's name, see {@link PaymentMethodName} */
-    name: PaymentMethodName;
-    /** Payment method image's url, commonly used to save image cards */
-    image_url: string;
-    /** Whether or not the payment method is default */
-    default: boolean;
-    /** Payment method's external id */
-    external_id: string | null;
-    /** Payment method's external code */
-    external_code: number;
-    /** Payment method's parent id */
-    parent_id: string | null;
-    /** Payment method cards' allowed brands, see {@link CreditCardBrand} */
-    methods: CreditCardBrand[];
-}
-/**
- * Representation of a credit card brand.
- *
- * @interface CreditCardBrand
- * @since 0.5.14
- * @extends {{@link PaymentMethod}
- */
-export interface CreditCardBrand extends PaymentMethod {
-    /** Payment method cards' allowed brands, see {@link CreditCardMappings}*/
-    cc_brands: CreditCardMapping[];
-}
-/**
- * Representation of a credit card brand.
- *
- * @interface CreditCardMapping
- * @since 0.5.14
- * @extends {{@link BasePaymentMethod}
- */
-export interface CreditCardMapping extends BasePaymentMethod {
-    /** Credit card mapping unique identifier */
-    id: number;
-    /** Credit card mapping name, see {@link CardName} */
-    name: CardName;
-    /** Payment method image's url, commonly used to save image cards */
-    image_url: string;
-    /** Mapping of credit cards */
-    cc_brands_mapping: unknown[];
-}
-/**
- * Payment method common names.
- *
- * @typedef PaymentMethodName
- * @since 0.5.14
- */
-export declare type PaymentMethodName = "CREDIT_CARD" | "CASH";
-/**
- * Cards common names.
- *
- * @typedef CardName
- * @since 0.5.14
- */
-export declare type CardName = "Diners" | "Discover" | "American Express" | "Visa" | "MasterCard";
-/**
- * Representation of a card inscription.
- *
- * @interface CardInscription
- * @since 0.5.15
- */
-export interface CardInscription {
-    id: number;
-    uid: string;
-    number: string;
-    type: string;
-    authCode?: string;
-    bin: string;
-    paymentToken: string;
-    createdAt?: string;
-}

package/build/types/payment.types.js

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

package/build/types/payment.types.js.map

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

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

@@ -1,299 +0,0 @@
-import { BaseWeekDay } from "./common.types";
-import { CDNImage } 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
- */
-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 CDNImage} */
-    images: CDNImage[];
-    /** 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;
-}
-/**
- * Product prices attributes.
- *
- * @interface ProductPrices
- * @since 0.5.14
- */
-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.
- *
- * @typedef ProductStatus
- * @since 0.5.14
- **/
-export declare type ProductStatus = "ACTIVE" | "INACTIVE";
-/**
- * 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 {
-    /** 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;
-}
-/**
- * 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 CDNImage} */
-    images: CDNImage[] | 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
- * @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,4 +0,0 @@
-"use strict";
-// Product and product details types and interfaces
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=product.types.js.map

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

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

package/build/types/settings.types.d.ts

@@ -1,23 +0,0 @@
-/**
- * User preferences.
- *
- * @interface UserSettings
- * @since 0.5.15
- */
-export interface UserSettings {
-    /** Individual settings, see {@link Settings} */
-    settings: Settings;
-    /** User unique identifier */
-    uid: string;
-}
-/**
- * Individual user settings.
- *
- * @typedef Settings
- * @since 0.5.15
- * @property {boolean} `[key: string]` An object where its key is a string
- * and its value is a boolean
- */
-export declare type Settings = {
-    [key: string]: boolean;
-};

package/build/types/settings.types.js

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

package/build/types/settings.types.js.map

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