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

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

@@ -1,69 +1,198 @@
+import { Image } 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;
-    avatarUrl: string;
+    /** 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;
-    cookTime: number;
+    /** Store available services, see {@link Service} */
     services: Service[];
-    totalItems: number;
-    totalPages: number;
-    page: number;
-    size: number;
+    /** 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 Image}*/
+    images: Image[];
+    /** 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;
-    deliveryTimeValue: number;
+    /** 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;
-    status: ServiceStatus;
+    /** Whether or not the service is active on the store */
+    active: boolean;
+    /** Service image url */
     url: string;
 }
-export declare enum DeliveryTimeUnit {
-    MIN = "min"
-}
-export declare enum Days {
-    MONDAY = "MONDAY",
-    TUESDAY = "TUESDAY",
-    WEDNESDAY = "WEDNESDAY",
-    THURSDAY = "THURSDAY",
-    FRIDAY = "FRIDAY",
-    SATURDAY = "SATURDAY",
-    SUNDAY = "SUNDAY",
-    SPECIAL = "SPECIAL"
-}
-export declare enum ServiceStatus {
-    INACTIVE = "INACTIVE",
-    ACTIVE = "ACTIVE"
-}
+/**
+ * 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

@@ -1,24 +1,4 @@
 "use strict";
+// Store types and interfaces
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServiceStatus = exports.Days = exports.DeliveryTimeUnit = void 0;
-var DeliveryTimeUnit;
-(function (DeliveryTimeUnit) {
-    DeliveryTimeUnit["MIN"] = "min";
-})(DeliveryTimeUnit = exports.DeliveryTimeUnit || (exports.DeliveryTimeUnit = {}));
-var Days;
-(function (Days) {
-    Days["MONDAY"] = "MONDAY";
-    Days["TUESDAY"] = "TUESDAY";
-    Days["WEDNESDAY"] = "WEDNESDAY";
-    Days["THURSDAY"] = "THURSDAY";
-    Days["FRIDAY"] = "FRIDAY";
-    Days["SATURDAY"] = "SATURDAY";
-    Days["SUNDAY"] = "SUNDAY";
-    Days["SPECIAL"] = "SPECIAL";
-})(Days = exports.Days || (exports.Days = {}));
-var ServiceStatus;
-(function (ServiceStatus) {
-    ServiceStatus["INACTIVE"] = "INACTIVE";
-    ServiceStatus["ACTIVE"] = "ACTIVE";
-})(ServiceStatus = exports.ServiceStatus || (exports.ServiceStatus = {}));
 //# sourceMappingURL=store.types.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"store.types.js","sourceRoot":"","sources":["../../src/types/store.types.ts"],"names":[],"mappings":";;;AA2DA,IAAY,gBAEX;AAFD,WAAY,gBAAgB;IAC1B,+BAAW,CAAA;AACb,CAAC,EAFW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAE3B;AAED,IAAY,IASX;AATD,WAAY,IAAI;IACd,yBAAiB,CAAA;IACjB,2BAAmB,CAAA;IACnB,+BAAuB,CAAA;IACvB,6BAAqB,CAAA;IACrB,yBAAiB,CAAA;IACjB,6BAAqB,CAAA;IACrB,yBAAiB,CAAA;IACjB,2BAAmB,CAAA;AACrB,CAAC,EATW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QASf;AAED,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;AACnB,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB"}
+{"version":3,"file":"store.types.js","sourceRoot":"","sources":["../../src/types/store.types.ts"],"names":[],"mappings":";AAAA,6BAA6B"}

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

@@ -1,46 +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;
 }
-export declare enum MaritalStatus {
-    MARRIED = "MARRIED",
-    DIVORCED = "DIVORCED",
-    SINGLE = "SINGLE"
-}
-export declare enum Gender {
-    MALE = "MALE",
-    FEMALE = "FEMALE"
-}
+/**
+ * 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

@@ -1,15 +1,4 @@
 "use strict";
+// User types and interfaces
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Gender = exports.MaritalStatus = void 0;
-var MaritalStatus;
-(function (MaritalStatus) {
-    MaritalStatus["MARRIED"] = "MARRIED";
-    MaritalStatus["DIVORCED"] = "DIVORCED";
-    MaritalStatus["SINGLE"] = "SINGLE";
-})(MaritalStatus = exports.MaritalStatus || (exports.MaritalStatus = {}));
-var Gender;
-(function (Gender) {
-    Gender["MALE"] = "MALE";
-    Gender["FEMALE"] = "FEMALE";
-})(Gender = exports.Gender || (exports.Gender = {}));
 //# sourceMappingURL=user.types.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"user.types.js","sourceRoot":"","sources":["../../src/types/user.types.ts"],"names":[],"mappings":";;;AA2CA,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;AACnB,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAED,IAAY,MAGX;AAHD,WAAY,MAAM;IAChB,uBAAa,CAAA;IACb,2BAAiB,CAAA;AACnB,CAAC,EAHW,MAAM,GAAN,cAAM,KAAN,cAAM,QAGjB"}
+{"version":3,"file":"user.types.js","sourceRoot":"","sources":["../../src/types/user.types.ts"],"names":[],"mappings":";AAAA,4BAA4B"}

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

@@ -1,7 +1,23 @@
 import { Image } from "./image.types";
+/**
+ * Representation of a Commerce Vendor.
+ *
+ * @interface Vendor
+ * @since 0.5.14
+ */
 export interface Vendor {
+    /** Artisan's vendor unique identifier */
     id: number;
+    /** Vendor's images, see {@link Image} */
     images: Image[];
+    /** 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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/types",
   "description": "Artisan's types and interfaces library",
-  "version": "0.13.0-canary.8",
+  "version": "0.13.0",
   "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": "d1b6289c5e717daec9c4675d822c1b29c850bb9e"
+  "gitHead": "67d5892dc7a40d6ba5f1c7bbbdf6423d97899ac3"
 }

package/build/types/channel.types.d.ts

@@ -1,5 +0,0 @@
-export interface Channel {
-    id: number;
-    name: string;
-    friendlyName: string;
-}

package/build/types/channel.types.js.map

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

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

@@ -1,90 +0,0 @@
-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[];
-}
-/**
- * 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;
-    benefitId: number;
-    benefitWalletId: number;
-    code: null;
-    combined: string;
-    createdAt: string;
-    description: string;
-    discountPercentage: number;
-    expirationDate: string;
-    externalId: null;
-    image: Image[];
-    limitAward: null;
-    limitBenefit: number;
-    logicOperator: string;
-    quantity: number;
-    rules: any[];
-    title: 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;
-}
-/**
- * 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/coupons.types.js.map

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