@artisan-commerce/types 0.14.0-canary.38 → 0.14.0-canary.4

package/build/types/banner.types.d.ts

@@ -0,0 +1,97 @@
+import { CDNImage } from "./image.types";
+/**
+ * Representation of a Commerce Banner.
+ *
+ * @interface Banner
+ * @since 0.5.14
+ */
+export interface Banner {
+    /** Banner category id */
+    banner_category_id: number;
+    /** Banner description */
+    banner_description: string;
+    /** Banner qr code */
+    banner_qr_code: string;
+    /** Banner title */
+    banner_title: string;
+    /** Banner type, see {@link BannerType} */
+    banner_type: BannerType;
+    /** Banner image url */
+    banner_url: string | null;
+    /** Banner's benefits */
+    benefits: null;
+    /** Banner category id */
+    category_id: number;
+    /** Banner category name */
+    category_name: string;
+    /** Banner channel's id */
+    channel_id: number;
+    /** Banner coupon's code */
+    coupon: null;
+    /** Banner coupon's id */
+    coupon_id: string | null;
+    /** The base 64 image value, see {@link CDNImage} */
+    image_base64: CDNImage["base64"];
+    /** The bucket where the image is saved */
+    image_bucket: string | null;
+    /** he cloud where the banner is saved, see {@link CDNImage} */
+    image_cloud_front_url: CDNImage["cloudFrontUrl"];
+    /** Banner image's filename */
+    image_file_name: string;
+    /** The directory where the banner image is saved */
+    image_key: string;
+    /** The url where the banner image is saved */
+    image_url: string;
+    /** An array of banner images, see {@link BannerImage}  */
+    images: BannerImage[];
+    /** Banner product's id */
+    product_id: null;
+    /** Banner product's name */
+    product_name: null;
+    /** Banner's section */
+    section: null;
+    /** Banner's scope, see {@link BannerScope} */
+    scope: BannerScope;
+    /** Banner stores array */
+    stores: unknown[];
+    /** Banner vendor's id */
+    vendor_id: number;
+    /** Banner vendor's name */
+    vendor_name: string;
+}
+/**
+ * The possible values of the banner's type.
+ *
+ * @typedef BannerType
+ * @since 0.5.14
+ */
+export declare type BannerType = "INFO" | "URL" | "PRODUCT" | "COUPON";
+/**
+ * The possible values of the banner's scope.
+ *
+ * @typedef BannerScope
+ * @since 0.5.14
+ */
+export declare type BannerScope = "WEB" | "GLOBAL" | "APP";
+/**
+ * Representation of a Banner image.
+ *
+ * @interface BannerImage
+ * @since 0.5.14
+ */
+export interface BannerImage {
+    /** Banner's id */
+    id: number;
+    /** Banner image's filename */
+    file_name: string;
+    /** Banner image's filename */
+    image_file_name: string;
+    /** Banner image's directory */
+    image_key: string;
+    /** The url where the banner image is saved */
+    image_url: string;
+    /** Banner's position inside the banner images array */
+    position: number;
+    /** The url where the banner image is saved */
+    url: string;
+}

package/build/types/banner.types.js

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

package/build/types/banner.types.js.map

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

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

@@ -0,0 +1,39 @@
+import { CountrySummary } from "./common.types";
+import { DocumentType } from "./common.types";
+/**
+ * Representation of a Commerce Billing Data.
+ *
+ * @interface BillingData
+ * @since 0.5.14
+ */
+export interface BaseBillingData {
+    /** Billing's nickname */
+    nickname: string;
+    /** Billing's associated user complete name */
+    name: string;
+    /** Billing's associated document type, see {@link DocumentType} */
+    documentType: DocumentType;
+    /** Billing's associated document */
+    document: string;
+    /** Billing's associated user address */
+    address: string;
+    /** Billing's associated user phone without country calling code */
+    phone: string;
+    /** Billing's associated user email */
+    email: string;
+    /** Whether or not the billing is default */
+    default: boolean;
+    /** It contains country id and country name, see {@link CountrySummary} */
+    country: CountrySummary;
+}
+/**
+ * Representation of a billing data saved on a database.
+ *
+ * @interface BillingData
+ * @since 0.5.14
+ * @extends {{@link BaseBillingData}
+ */
+export interface BillingData extends BaseBillingData {
+    /** Billing's auto generated id */
+    id: number;
+}

package/build/types/billingData.types.js

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

package/build/types/billingData.types.js.map

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

package/build/types/catalogue.types.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Representation of a Commerce Catalogue.
+ *
+ * @interface Catalogue
+ * @since 0.5.14
+ */
+export interface Catalogue {
+    /** Catalogue's id */
+    catalogueId: string;
+    /** Catalogue's name */
+    name: string;
+    /** Whether or not the catalogue is active */
+    active: boolean;
+    /** Catalogue's friendly name to use on front end */
+    friendlyName?: string;
+}

package/build/types/catalogue.types.js

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

package/build/types/catalogue.types.js.map

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

package/build/types/category.types.d.ts

@@ -0,0 +1,33 @@
+import { CDNImage } from "./image.types";
+import { BaseProduct } from "./product.types";
+/**
+ * Representation of a Commerce Category.
+ *
+ * @interface Category
+ * @since 0.5.14
+ */
+export interface Category {
+    /** Category's id */
+    categoryId: number;
+    /** Category's name */
+    name: string;
+    /** Category image's array, see {@link CDNImage} */
+    images: CDNImage[];
+    /** Whether or not to display the category */
+    displayInMenu: boolean;
+    /** Whether or not the category should be reloaded */
+    reload: boolean;
+    /** Whether or not the category has subcategories */
+    subcategories: boolean;
+}
+/**
+ * Representation of a category which contains several base products.
+ *
+ * @interface CategoryWithProducts
+ * @since 0.5.14
+ * @extends {{@link Category}
+ */
+export interface CategoryWithProducts extends Category {
+    /** Array of base products associated with a category, see {@link BaseProduct} */
+    products: BaseProduct[];
+}

package/build/types/category.types.js

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

package/build/types/category.types.js.map

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

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

@@ -0,0 +1,36 @@
+/**
+ * Representation of a generic object.
+ *
+ * @interface Objectify<T>
+ * @since 0.5.14
+ * @property {T} [key: string] object key
+ */
+export interface Objectify<T> {
+    [key: string]: T;
+}
+/**
+ * The possible values of a document type.
+ *
+ * @typedef DocumentType
+ * @since 0.5.14
+ */
+export declare type DocumentType = "CI" | "RUC" | "PASSPORT";
+/**
+ * Representation of the country's summary.
+ *
+ * @interface CountrySummary
+ * @since 0.5.14
+ */
+export interface CountrySummary {
+    /** Country's id */
+    id: number;
+    /** Country's name */
+    name: string;
+}
+/**
+ * The possible values of a week day.
+ *
+ * @typedef BaseWeekDay
+ * @since 0.5.14
+ */
+export declare type BaseWeekDay = "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY";

package/build/types/common.types.js

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

package/build/types/common.types.js.map

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

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

@@ -0,0 +1,59 @@
+/**
+ * Representation of a Commerce Country.
+ *
+ * @interface Country
+ * @since 0.5.14
+ */
+export interface Country {
+    /** Country's id */
+    countryId: string;
+    /** Country's name */
+    name: string;
+    /** Country ISO code, see {@link CountryCode} */
+    code: CountryCode;
+    /** Whether or not the country is active */
+    active: boolean;
+    /**
+     * Object which contains information about country's currency,
+     *  see {@link CountryCurrency}
+     */
+    currency: CountryCurrency;
+    /** Array of taxes usually applied on the country, see {@link CountryTax} */
+    taxes: CountryTax[];
+}
+/**
+ * Representation of a country's currency.
+ *
+ * @interface CountryCurrency
+ * @since 0.5.14
+ */
+export interface CountryCurrency {
+    /** Currency's id */
+    currencyId: string;
+    /**  Currency's name */
+    name: string;
+    /** Currency's symbol */
+    sign: string;
+}
+/**
+ * Representation of a country's tax.
+ *
+ * @interface CountryTax
+ * @since 0.5.14
+ */
+export interface CountryTax {
+    /** Tax name */
+    tax: string;
+    /** Value added tax rate */
+    vatRate: string;
+    /** Tax percentage */
+    percentage: number;
+}
+/**
+ * List of country codes currently supported.
+ *
+ * @typedef CountryCode
+ * @since 0.1.0
+ * @see https://www.nationsonline.org/oneworld/country_code_list.htm for reference
+ */
+export declare type CountryCode = "AR" | "BO" | "BR" | "CL" | "CO" | "EC" | "PY" | "PE" | "UY" | "VE" | "US";

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/coupon.types.d.ts

@@ -0,0 +1,112 @@
+import { ArtisnDBCollectionReference } from "./artisnDB.types";
+import { ArtisnDBQueryDocumentSnapshot } from "./artisnDB.types";
+import { ArtisnDBDocumentData } from "./artisnDB.types";
+import { CDNImage } from "./image.types";
+/**
+ * Wallet user information.
+ *
+ * @interface Wallet
+ * @since 0.5.14
+ */
+export interface Wallet {
+    /** {@link Benefit}'s array from firestore user wallet */
+    benefits: Benefit[];
+}
+/**
+ * Benefit information.
+ *
+ * @interface Benefit
+ * @since 0.5.14
+ */
+export interface Benefit {
+    /** The user wallet id */
+    hash: string;
+    /** The benefit awards, see {@link Award} */
+    award: Award;
+    /** Benefit id */
+    benefitId: number;
+    /** Benefit wallet id */
+    benefitWalletId: number;
+    /** Benefit code in back-end */
+    code: null;
+    /** Combined */
+    combined: string;
+    /** Benefit creation date */
+    createdAt: string;
+    /** Benefit description */
+    description: string;
+    /** Benefit discount percentage */
+    discountPercentage: number;
+    /** Benefit expiration date */
+    expirationDate: string;
+    /** External benefit id */
+    externalId: null;
+    /** Benefit images, see {@link CDNImage} */
+    image: CDNImage[];
+    /** The award limit */
+    limitAward: null;
+    /** The benefit limit */
+    limitBenefit: number;
+    /** The logic operator of the benefit */
+    logicOperator: string;
+    /** Benefit stock */
+    quantity: number;
+    /** The rules of the benefit */
+    rules: any[];
+    /** The benefit title */
+    title: string;
+    /** Benefit type, see {@link BenefitTypes} */
+    type: BenefitTypes;
+    /** Benefit update date */
+    updatedAt: string;
+    /** The channel id of the benefit */
+    channelId: number;
+    /** The vendor id of the benefit */
+    vendorId: number;
+    /** The account id of the benefit */
+    accountId: number;
+}
+/**
+ * Award information.
+ *
+ * @interface Award
+ * @since 0.5.14
+ */
+export interface Award {
+    /** The id of the award */
+    id: number;
+    /** The id of the benefit */
+    benefitId: number;
+    /** Benefit discount percentage */
+    discountPercentage: number;
+    /** Benefit discount value */
+    discountValue: null;
+}
+/**
+ * Applied benefit array in shopping cart.
+ *
+ * @typedef ShoppingCartBenefits
+ * @since 0.5.14
+ */
+export declare type ShoppingCartBenefits = Benefit[];
+/**
+ * A benefit DB node from a user.
+ *
+ * @typedef BenefitsByUserNode
+ * @since 0.5.14
+ */
+export declare type BenefitsByUserNode = ArtisnDBQueryDocumentSnapshot<ArtisnDBDocumentData>;
+/**
+ * The complete collection of benefits DB nodes from a user.
+ *
+ * @typedef BenefitsByUserNodes
+ * @since 0.5.14
+ */
+export declare type BenefitsByUserNodes = ArtisnDBCollectionReference<ArtisnDBDocumentData>;
+/**
+ * The possible values of the benefit type.
+ *
+ * @typedef BenefitTypes
+ * @since 0.5.14
+ */
+export declare type BenefitTypes = "ALTER_DELIVERY" | "PRODUCT" | "DISCOUNT";

package/build/types/coupon.types.js

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

package/build/types/coupon.types.js.map

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

package/build/types/currency.types.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Artisn's supported currency codes.
+ *
+ * @typedef CurrencyCodes
+ * @since 0.5.14
+ */
+export declare type CurrencyCodes = "USD" | "ARS" | "COP" | "CLP" | "VES";

package/build/types/currency.types.js

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

package/build/types/currency.types.js.map

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