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

package/build/types/product.types.js

@@ -0,0 +1,4 @@
+"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

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

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

@@ -0,0 +1,23 @@
+/**
+ * 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

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

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

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

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

@@ -0,0 +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

@@ -0,0 +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

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

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

@@ -0,0 +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/shippingCost.types.js

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

package/build/types/shippingCost.types.js.map

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

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

@@ -0,0 +1,124 @@
+import { Store } from "./store.types";
+import { Objectify } from "./common.types";
+import { CartProduct } from "./product.types";
+import { PriceCategoryType } from "./product.types";
+import { ShippingCost } from "./shippingCost.types";
+import { ShoppingCartBenefits } from "./coupon.types";
+import { ArtisnDBDocumentData } from "./artisnDB.types";
+import { ArtisnDBCollectionReference } from "./artisnDB.types";
+import { ArtisnDBQueryDocumentSnapshot } from "./artisnDB.types";
+/**
+ * Representation of a Commerce Shopping Cart.
+ *
+ * @interface ShoppingCart
+ * @since 0.5.14
+ */
+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>;
+    /** 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 = ArtisnDBQueryDocumentSnapshot<ArtisnDBDocumentData>;
+/**
+ * The complete collection of shopping carts DB nodes from a user.
+ *
+ * @typedef ShoppingCartNodes
+ * @since 0.5.14
+ */
+export declare type ShoppingCartNodes = ArtisnDBCollectionReference<ArtisnDBDocumentData>;

package/build/types/shoppingCart.types.js

@@ -0,0 +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

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

package/build/types/store.types.d.ts

@@ -0,0 +1,198 @@
+import { CDNImage } from "./image.types";
+import { Vendor } from "./vendor.types";
+import { Catalogue } from "./catalogue.types";
+import { BaseWeekDay } from "./common.types";
+/**
+ * Representation of a Commerce Store.
+ *
+ * @interface Store
+ * @since 0.5.14
+ */
+export interface Store {
+    /** Store unique identifier */
+    storeId: number;
+    /** Store name */
+    storeName: string;
+    /** Store address */
+    address: string;
+    /** The vendor associated with the store, see {@link Vendor} */
+    vendor: Vendor;
+    /**
+     * Additional store information, see
+     * {@link AdditionalStoreInformation} for further information
+     */
+    additionalInfo: AdditionalStoreInformation;
+    /** Whether or not the store is within coverage */
+    coverage: boolean;
+    /** Store cover url */
+    coverUrl: string;
+    /** Store delivery detailed information  */
+    delivery: Delivery;
+    /** Store description */
+    description: string | null;
+    /** Whether or not the store is open */
+    isOpen: boolean;
+    /** Order maximum amount allowed */
+    maxOrderAmount: number;
+    /** Order minimum amount allowed */
+    minOrderAmount: number;
+    /** Order currency's symbol */
+    orderSymbol: string;
+    /** Store phone */
+    phone: string;
+    /** Whether or not the store is sponsored */
+    sponsored: boolean;
+    /** Store latitude */
+    latitude: number;
+    /** Store longitude */
+    longitude: number;
+    /** Store schedules, see {@link Schedule} for further information */
+    schedules: Schedule[];
+    /** Store timezone */
+    timezone: string;
+    /** Store available services, see {@link Service} */
+    services: Service[];
+    /** Estimated store cook time */
+    cookTime: string;
+    /**
+     * Generic store location in regards to the city,
+     *  see {@link GenericStoreLocation}
+     */
+    city: GenericStoreLocation;
+    /** Whether or not the store is out of service */
+    outOfService: boolean;
+    /** Whether or not the store is default */
+    isDefault: boolean;
+    /** Whether or not the store is active */
+    active: boolean;
+    /** The value of the allowed minimum order */
+    minOrder: number;
+    /** Minimum order currency's symbol */
+    minOrderSymbol: string;
+    /**
+     * Generic store location in regards to the country,
+     * see {@link GenericStoreLocation} for further information
+     */
+    country: GenericStoreLocation;
+    /** Store location, see {@link StoreLocation} for further information */
+    location: StoreLocation;
+    /** Array of catalogues, see {@link Catalogue} */
+    catalogues: Catalogue[];
+    /** Array of store images, see {@link CDNImage}*/
+    images: CDNImage[];
+    /** The distance between the user and the store, roughly in metres */
+    distance: number;
+}
+/**
+ * Store location.
+ *
+ * @interface StoreLocation
+ * @since 0.5.14
+ */
+export interface StoreLocation {
+    /** Store location latitude */
+    lat: number;
+    /** Store location longitude */
+    lon: number;
+    /** The geo hash associated with the store */
+    geohash: string;
+    /** Whether or not the store is a fragment */
+    fragment: boolean;
+}
+/**
+ * Store generic location.
+ *
+ * @interface GenericStoreLocation
+ * @since 0.5.14
+ */
+export interface GenericStoreLocation {
+    /** Generic store location unique identifier */
+    id: string;
+    /** Generic store location name */
+    name: string;
+    /** Whether or not the generic store location is active */
+    active: boolean;
+}
+/**
+ * Additional store information.
+ *
+ * @interface AdditionalStoreInformation
+ * @since 0.5.14
+ */
+export interface AdditionalStoreInformation {
+    /** Store external id */
+    externalId: string;
+    /** Store external code */
+    externalCode: string;
+    /** Delivery unique identifier */
+    idDeliveryKfc: string;
+    /** Whether or not the store has a drinks store */
+    isDrinksStore: boolean;
+    /** Whether or not to show the drinks store */
+    showDrinksStore: boolean;
+}
+/**
+ * Store delivery modality information.
+ *
+ * @interface Delivery
+ * @since 0.5.14
+ */
+export interface Delivery {
+    /** Time unit for delivery, see {@link DeliveryTimeUnit} */
+    deliveryTimeUnit: DeliveryTimeUnit;
+    /** Time value for delivery as string */
+    deliveryTimeValue: string;
+    /** Whether or not the store has a express delivery */
+    express: boolean;
+    /** Whether or not the store has free delivery */
+    freeDelivery: boolean;
+}
+/**
+ * Store schedules.
+ *
+ * @interface Schedule
+ * @since 0.5.14
+ */
+export interface Schedule {
+    /** Week day in uppercase, see {@link Days} */
+    day: Days;
+    /**
+     * `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;
+    /** Store catalogue unique identifier */
+    catalogueId: string;
+}
+/**
+ * The services available on the store.
+ *
+ * @interface Service
+ * @since 0.5.14
+ */
+export interface Service {
+    /** Service name */
+    name: string;
+    /** Whether or not the service is active on the store */
+    active: boolean;
+    /** Service image url */
+    url: string;
+}
+/**
+ * Time unit for delivery.
+ *
+ * @typedef DeliveryTimeUnit
+ * @since 0.5.14
+ */
+export declare type DeliveryTimeUnit = "min";
+/**
+ * Allowed days for schedules.
+ *
+ * @typedef Days
+ * @since 0.5.14
+ */
+export declare type Days = BaseWeekDay | "SPECIAL";

package/build/types/store.types.js

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

package/build/types/store.types.js.map

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

package/build/types/user.types.d.ts

@@ -0,0 +1,114 @@
+import { DocumentType } from "./common.types";
+/**
+ * Representation of a Commerce User.
+ *
+ * @interface BaseUser
+ * @since 0.5.14
+ */
+export interface BaseUser {
+    /** User's unique identifier */
+    uid: string;
+    /** User's first name */
+    name: string;
+    /** User's middle name */
+    middleName?: string;
+    /** User's last name */
+    lastname: string;
+    /** User's second surname */
+    secondLastname?: string;
+    /** User's email */
+    email: string;
+    /** User's birthdate, e.g: 1991-05-02 */
+    birthdate?: string;
+    /** The vendor which the user was created */
+    vendorId?: number;
+    /** The platform where the user was generated */
+    origin?: string;
+    /** User's document */
+    document?: string;
+    /**User's document type, see {@link DocumentType} */
+    documentType?: DocumentType;
+    /** User's gender, see {@link Gender} */
+    gender?: Gender;
+    /** User's country object, see {@link UserCountry} */
+    country: UserCountry;
+    /** User's phone detailed information, see {@link Phone} */
+    phone?: Phone;
+    /** User's type, see {@link UserType} */
+    type?: UserType;
+    /** User's externalId */
+    externalId?: string;
+    /** User's marital status, see {@link MaritalStatus} */
+    maritalStatus?: MaritalStatus;
+    /** Whether or not the user is active */
+    active?: boolean;
+    /** User's additional info, see {@link AdditionalInfo} */
+    additionalInfo?: AdditionalInfo;
+}
+/**
+ * Representation of a user saved on a database.
+ *
+ * @interface User
+ * @since 0.5.14
+ * @extends {{@link BaseUser}
+ */
+export interface User extends BaseUser {
+    /** User's auto generated id */
+    idInt: number;
+}
+/**
+ * The possible values for the user's type.
+ *
+ * @typedef UserType
+ * @since 0.5.14
+ */
+export declare type UserType = "NORMAL" | "DEPENDENT";
+/**
+ * Representation of a phone.
+ *
+ * @interface UserCountry
+ * @since 0.5.14
+ */
+export interface UserCountry {
+    /** User's country id */
+    id: number;
+}
+/**
+ * Representation of the user's additional info,
+ * commonly used to save user's images urls.
+ *
+ * @interface AdditionalInfo
+ * @since 0.5.14
+ * @property {any} `[key: string]` Property with key value pairs
+ */
+export interface AdditionalInfo {
+    [key: string]: any;
+}
+/**
+ * Representation of a phone.
+ *
+ * @interface Phone
+ * @since 0.5.14
+ */
+export interface Phone {
+    /** User's phone number */
+    number: string;
+    /** User's country calling code, e.g.: +593 */
+    countryCode: string;
+    /** User's country ISO code, e.g.: EC */
+    countryIsoCode: string;
+}
+/**
+ * The possible values for the user's marital status.
+ *
+ * @typedef MaritalStatus
+ * @since 0.5.14
+ */
+export declare type MaritalStatus = "MARRIED" | "DIVORCED" | "SINGLE";
+/**
+ * The possible values for the user's gender.
+ *
+ * @typedef Gender
+ * @since 0.5.14
+ */
+export declare type Gender = "MALE" | "FEMALE";

package/build/types/user.types.js

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

package/build/types/user.types.js.map

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

package/build/types/vendor.types.d.ts

@@ -0,0 +1,23 @@
+import { CDNImage } from "./image.types";
+/**
+ * Representation of a Commerce Vendor.
+ *
+ * @interface Vendor
+ * @since 0.5.14
+ */
+export interface Vendor {
+    /** Artisn's vendor unique identifier */
+    id: number;
+    /** Vendor's images, see {@link CDNImage} */
+    images: CDNImage[];
+    /** Vendor's name */
+    name: string;
+    /** Vendor's maximum purchase value */
+    maxPurchaseValue: number;
+    /** Vendor's description */
+    description: string;
+    /** Whether or not the vendor is sponsored */
+    sponsored: boolean;
+    /** Whether or not the vendor is active */
+    active: boolean;
+}

package/build/types/vendor.types.js

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

package/build/types/vendor.types.js.map

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

package/build/vendors.d.ts

@@ -0,0 +1 @@
+export {};