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

package/package.json

@@ -1,16 +1,22 @@
 {
   "name": "@artisan-commerce/types",
   "description": "Artisn's types and interfaces library",
-  "version": "0.14.0-canary.2",
-  "main": "./build/index.js",
-  "types": "./build/index.d.ts",
+  "version": "0.14.0-canary.21",
+  "main": "./dist/bundle.d.ts",
+  "module": "./dist/bundle.d.ts",
+  "types": "./dist/bundle.d.ts",
   "files": [
-    "build/",
-    "LICENSE",
-    "README.md"
+    "dist"
   ],
+  "sideEffects": false,
+  "exports": {
+    "default": "./dist/bundle.esm.js"
+  },
   "scripts": {
-    "compile": "tsc --declaration",
+    "compile": "rollup -c",
+    "dev": "yarn compile -w",
+    "clean": "rimraf dist",
+    "prebuild": "yarn clean",
     "build": "yarn compile",
     "check-types": "tsc --noEmit",
     "lint": "eslint --ignore-path .gitignore --ext .ts,.tsx .",
@@ -23,7 +29,9 @@
   "author": "Luis Eduardo Andrade",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^14.0.24",
+    "@react-native-firebase/app": "^12.8.0",
+    "@react-native-firebase/auth": "^12.8.0",
+    "@react-native-firebase/firestore": "^12.8.0",
     "@typescript-eslint/eslint-plugin": "^3.7.0",
     "@typescript-eslint/parser": "^3.7.0",
     "eslint": "^7.5.0",
@@ -37,10 +45,8 @@
     "eslint-plugin-react": "^7.20.3",
     "eslint-plugin-react-hooks": "^4.0.8",
     "firebase": "^8.1.1",
-    "jest-extended": "^0.11.5",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.1.2",
-    "webpack-bundle-analyzer": "^3.9.0"
+    "prettier": "^2.1.2"
   },
-  "gitHead": "61cd421cf586b967fe48a7502e1f3841c0877f0e"
+  "gitHead": "f59a7400808aed99f5f80a9bdaa71289ef3a3e34"
 }

package/build/index.d.ts

@@ -1,26 +0,0 @@
-export * from "./types/account.types";
-export * from "./types/app.types";
-export * from "./types/artisnDB.types";
-export * from "./types/banner.types";
-export * from "./types/billingData.types";
-export * from "./types/catalogue.types";
-export * from "./types/category.types";
-export * from "./types/common.types";
-export * from "./types/country.types";
-export * from "./types/coupon.types";
-export * from "./types/currency.types";
-export * from "./types/fulfillment.types";
-export * from "./types/http.types";
-export * from "./types/image.types";
-export * from "./types/livingPlace.types";
-export * from "./types/notification.types";
-export * from "./types/order.types";
-export * from "./types/payment.types";
-export * from "./types/product.types";
-export * from "./types/settings.types";
-export * from "./types/shippingAddress.types";
-export * from "./types/shippingCost.types";
-export * from "./types/shoppingCart.types";
-export * from "./types/store.types";
-export * from "./types/vendor.types";
-export * from "./types/user.types";

package/build/index.js

@@ -1,40 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-// Main
-__exportStar(require("./types/account.types"), exports);
-__exportStar(require("./types/app.types"), exports);
-__exportStar(require("./types/artisnDB.types"), exports);
-__exportStar(require("./types/banner.types"), exports);
-__exportStar(require("./types/billingData.types"), exports);
-__exportStar(require("./types/catalogue.types"), exports);
-__exportStar(require("./types/category.types"), exports);
-__exportStar(require("./types/common.types"), exports);
-__exportStar(require("./types/country.types"), exports);
-__exportStar(require("./types/coupon.types"), exports);
-__exportStar(require("./types/currency.types"), exports);
-__exportStar(require("./types/fulfillment.types"), exports);
-__exportStar(require("./types/http.types"), exports);
-__exportStar(require("./types/image.types"), exports);
-__exportStar(require("./types/livingPlace.types"), exports);
-__exportStar(require("./types/notification.types"), exports);
-__exportStar(require("./types/order.types"), exports);
-__exportStar(require("./types/payment.types"), exports);
-__exportStar(require("./types/product.types"), exports);
-__exportStar(require("./types/settings.types"), exports);
-__exportStar(require("./types/shippingAddress.types"), exports);
-__exportStar(require("./types/shippingCost.types"), exports);
-__exportStar(require("./types/shoppingCart.types"), exports);
-__exportStar(require("./types/store.types"), exports);
-__exportStar(require("./types/vendor.types"), exports);
-__exportStar(require("./types/user.types"), exports);
-//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO;AACP,wDAAsC;AACtC,oDAAkC;AAClC,yDAAuC;AACvC,uDAAqC;AACrC,4DAA0C;AAC1C,0DAAwC;AACxC,yDAAuC;AACvC,uDAAqC;AACrC,wDAAsC;AACtC,uDAAqC;AACrC,yDAAuC;AACvC,4DAA0C;AAC1C,qDAAmC;AACnC,sDAAoC;AACpC,4DAA0C;AAC1C,6DAA2C;AAC3C,sDAAoC;AACpC,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,gEAA8C;AAC9C,6DAA2C;AAC3C,6DAA2C;AAC3C,sDAAoC;AACpC,uDAAqC;AACrC,qDAAmC"}

package/build/types/account.types.d.ts

@@ -1,17 +0,0 @@
-import { CDNImage } from "./image.types";
-/**
- * Representation of a Commerce Account.
- *
- * @interface Account
- * @since 0.5.14
- */
-export interface Account {
-    /** Artisn's account unique identifier */
-    accountId: number;
-    /** Account's name */
-    name: string;
-    /** Account's description */
-    description?: string;
-    /** Account's images, see {@link CDNImage} for further information */
-    images: CDNImage[];
-}

package/build/types/account.types.js

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

package/build/types/account.types.js.map

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

package/build/types/app.types.d.ts

@@ -1,153 +0,0 @@
-import firebase from "firebase";
-/**
- * The ArtisnApp controls the app connection with the DBs and its settings.
- *
- * @typedef ArtisnApp
- * @since 0.5.14
- */
-export declare type ArtisnApp = ArtisnAppWeb | ArtisnAppRN;
-/**
- * The ArtisnAppWeb orchestrate the connections of the app with the DB, server and its settings.
- *
- * @interface ArtisnAppWeb
- * @since 0.5.14
- */
-export interface ArtisnAppWeb {
-    /** App's name */
-    name: firebase.app.App["name"];
-    /** Artisn's account API URL */
-    apiURL: string;
-    /** Artisn app settings configuration, see {@link ArtisnSettings} */
-    settings: ArtisnSettings;
-    /** Internal configuration of App and databases  */
-    __internals__: firebase.app.App;
-    /** ArtisnApp object internal instance */
-    __instance__: typeof firebase;
-}
-/**
- * The ArtisnAppRN orchestrate the connections of the app with the DB, server and its settings.
- *
- * @interface ArtisnAppRN
- * @since 0.5.14
- */
-export interface ArtisnAppRN {
-    /** Artisn's account API URL */
-    apiURL: string;
-    /** Internal configuration of App and databases */
-    __internals__: RNFirebaseInstance;
-    /** ArtisnApp object internal instance */
-    __instance__: RNFirebaseInstance;
-    /** Artisn app settings configuration, see {@link ArtisnSettings} */
-    settings: ArtisnSettings;
-    /** App's name */
-    name: string;
-}
-/**
- * Settings to configure the Firebase Instance.
- *
- * @interface RNFirebaseInstance
- * @since 0.5.14
- */
-export interface RNFirebaseInstance {
-    /** Auth package from react-native-auth */
-    auth: any;
-    /**  Firestore package from react-native-auth */
-    firestore: any;
-}
-/**
- * Settings to configure the Artisn app.
- *
- * @interface ArtisnSettings
- * @since 0.5.14
- */
-export interface ArtisnSettings {
-    /** Artisn's account unique identifier */
-    accountId?: number;
-    /** Platform where the app is running, see {@link ArtisnPlatform} */
-    platform?: ArtisnPlatform;
-    /** App's project id */
-    projectId: string;
-    /** App's API key */
-    apiKey: string;
-    /** App's external app id */
-    appId?: string;
-    /** App's auth domain url */
-    authDomain: string;
-}
-/**
- * Settings to configure the Artisn app react-native.
- *
- * @interface ArtisnSettingsRN
- * @since 0.5.14
- */
-export interface ArtisnSettingsRN {
-    /** Platform where the app is running, see {@link ArtisnPlatform} */
-    platform: ArtisnPlatform;
-    /** Artisn's account unique identifier */
-    accountId?: number;
-}
-/**
- * Artisn app's allowed platforms to run on.
- *
- * @typedef ArtisnPlatform
- * @since 0.5.14
- */
-export declare type ArtisnPlatform = "web" | "ios" | "android" | "windows" | "macos" | "call center";
-/**
- * Artisn's auth instance is the instance of the internal auth object.
- *
- * @typedef ArtisnInstanceAuth
- * @since 0.5.14
- */
-export declare type ArtisnInstanceAuth = typeof firebase.auth;
-/**
- * Artisn's auth object to handle providers authentication.
- *
- * @typedef ArtisnAuth
- * @since 0.5.14
- */
-export interface ArtisnAuth extends firebase.auth.Auth {
-}
-/**
- * Main artisn commerce filters.
- *
- * @interface ArtisnHints
- * @since 0.5.14
- */
-export interface ArtisnHints {
-    /** Artisn's account unique identifier */
-    accountId: string | number;
-    /** Artisn's vendor unique identifier */
-    vendorId?: string | number;
-    /** Artisn's catalogue unique identifier  */
-    catalogueId?: string | number;
-    /** Artisn's store unique identifier  */
-    storeId?: number;
-    /** Artisn's category unique identifier  */
-    categoryId?: string | number;
-    /** Artisn's productId unique identifier  */
-    productId?: string | number;
-}
-/**
- * Unrestricted allowed Artisn SDK rest api headers.
- *
- * @interface ArtisnHeaders
- * @since 0.5.14
- */
-export interface ArtisnHeaders {
-    /** Platform where the app is running, see {@link ArtisnPlatform} */
-    Platform: ArtisnPlatform;
-    /** Artisn's account unique identifier */
-    account: string;
-}
-/**
- * Restricted allowed Artisn SDK rest api headers.
- *
- * @interface ArtisnRestrictedHeaders
- * @since 0.5.14
- * @extends {{@link ArtisnHeaders}
- */
-export interface ArtisnRestrictedHeaders extends ArtisnHeaders {
-    /** Authorization app's authentication token */
-    Authorization: string;
-}

package/build/types/app.types.js

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

package/build/types/app.types.js.map

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

package/build/types/artisnDB.types.d.ts

@@ -1,29 +0,0 @@
-import firebase from "firebase";
-/**
- * Artisn database object.
- *
- * @typedef ArtisnDB
- * @since 0.5.14
- */
-export declare type ArtisnDB = firebase.firestore.Firestore;
-/**
- * Artisn database document data object.
- *
- * @typedef ArtisnDBDocumentData
- * @since 0.5.14
- */
-export declare type ArtisnDBDocumentData = firebase.firestore.DocumentData;
-/**
- * The current state of a node from the Artisn DB.
- *
- * @typedef ArtisnDBQueryDocumentSnapshot
- * @since 0.5.14
- */
-export declare type ArtisnDBQueryDocumentSnapshot<T = ArtisnDBDocumentData> = firebase.firestore.QueryDocumentSnapshot<T>;
-/**
- * An Artisn DB collection of nodes.
- *
- * @typedef ArtisnDBCollectionReference
- * @since 0.5.14
- */
-export declare type ArtisnDBCollectionReference<T = ArtisnDBDocumentData> = firebase.firestore.CollectionReference<T>;

package/build/types/artisnDB.types.js

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

package/build/types/artisnDB.types.js.map

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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