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

package/dist/bundle.d.ts

@@ -1,8 +1,3 @@
-import firebase from 'firebase';
-import { ReactNativeFirebase } from '@react-native-firebase/app';
-import authRN, { FirebaseAuthTypes } from '@react-native-firebase/auth';
-import { FirebaseFirestoreTypes } from '@react-native-firebase/firestore';
-
 /**
  * Representation of a Commerce Country.
  *
@@ -176,6 +171,13 @@ declare type BaseWeekDay = "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FR
  * @since 0.1.0
  */
 declare type AdditionalInfo = Record<string, any>;
+/**
+ * Artisn app's allowed platforms to run on.
+ *
+ * @typedef ArtisnPlatform
+ * @since 0.1.0
+ */
+declare type ArtisnPlatform = "web" | "ios" | "android" | "windows" | "macos" | "call center";
 
 /**
  * Representation of a image allocated in a CDN.
@@ -277,196 +279,6 @@ interface Account<T extends AdditionalInfo = AdditionalInfo> {
     additionalInfo?: T;
 }
 
-/**
- * The ArtisnApp controls the app connection with the DBs and its settings.
- *
- * @typedef ArtisnApp
- * @since 0.1.0
- */
-declare type ArtisnApp = ArtisnWebApp | ArtisnRNApp;
-/**
- * The ArtisnWebApp orchestrate the connections of the app with the DB, server
- * and its settings.
- *
- * @interface ArtisnWebApp
- * @since 0.1.0
- */
-interface ArtisnWebApp {
-    /** App's name */
-    name: firebase.app.App["name"];
-    /** Artisn's account API URL */
-    apiURL: string;
-    /** Artisn app settings configuration, see {@link ArtisnWebSettings} */
-    settings: ArtisnWebSettings;
-    /** Internal configuration of App and databases */
-    __internals__: firebase.app.App;
-    /** ArtisnApp object internal instance */
-    __instance__: typeof firebase;
-}
-/**
- * The ArtisnRNApp orchestrate the connections of the app with the DB, server
- * and its settings.
- *
- * @interface ArtisnRNApp
- * @since 0.1.0
- */
-interface ArtisnRNApp {
-    /** App's name */
-    name: ReactNativeFirebase.FirebaseApp["name"];
-    /** Artisn's account API URL */
-    apiURL: string;
-    /** Artisn app settings configuration, see {@link ArtisnRNSettings} */
-    settings: ArtisnRNSettings;
-    /** Internal configuration of App and databases */
-    __internals__: ReactNativeFirebase.FirebaseApp;
-    /** ArtisnApp object internal instance */
-    __instance__: ReactNativeFirebase.Module;
-}
-/**
- * Settings to configure the Artisn app.
- *
- * @interface ArtisnWebSettings
- * @since 0.1.0
- */
-interface ArtisnWebSettings {
-    /** 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 ArtisnRNSettings
- * @since 0.1.0
- */
-interface ArtisnRNSettings {
-    /** 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.1.0
- */
-declare type ArtisnPlatform = "web" | "ios" | "android" | "windows" | "macos" | "call center";
-/**
- * Artisn's auth instance is the instance of the internal auth object.
- *
- * @typedef ArtisnWebAuthInstance
- * @since 0.1.0
- */
-declare type ArtisnWebAuthInstance = typeof firebase.auth;
-/**
- * Artisn's auth instance is the instance of the internal auth object for react
- * native.
- *
- * @typedef ArtisnRNAuthInstance
- * @since 0.1.0
- */
-declare type ArtisnRNAuthInstance = typeof authRN;
-/**
- * Artisn's auth object to handle providers authentication.
- *
- * @interface ArtisnWebAuth
- * @since 0.1.0
- * @extends {{@link firebase.auth.Auth}
- */
-interface ArtisnWebAuth extends firebase.auth.Auth {
-}
-/**
- * Artisn's auth object to handle providers authentication for react native.
- *
- * @interface ArtisnRNAuth
- * @since 0.1.0
- * @extends {{@link FirebaseAuthTypes.Module}
- */
-interface ArtisnRNAuth extends FirebaseAuthTypes.Module {
-}
-/**
- * Main artisn commerce filters.
- *
- * @interface ArtisnHints
- * @since 0.1.0
- */
-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.1.0
- */
-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.1.0
- * @extends {{@link ArtisnHeaders}
- */
-interface ArtisnRestrictedHeaders extends ArtisnHeaders {
-    /** Authorization app's authentication token */
-    Authorization: string;
-}
-
-/**
- * Artisn database object.
- *
- * @typedef ArtisnDB
- * @since 0.1.0
- */
-declare type ArtisnDB = firebase.firestore.Firestore | FirebaseFirestoreTypes.Module;
-/**
- * Artisn database document data object.
- *
- * @typedef ArtisnDBDocumentData
- * @since 0.1.0
- */
-declare type ArtisnDBDocumentData = firebase.firestore.DocumentData | FirebaseFirestoreTypes.DocumentData;
-/**
- * The current state of a node from the Artisn DB.
- *
- * @typedef ArtisnDBQueryDocumentSnapshot
- * @since 0.1.0
- */
-declare type ArtisnDBQueryDocumentSnapshot<T = ArtisnDBDocumentData> = firebase.firestore.QueryDocumentSnapshot<T> | FirebaseFirestoreTypes.QueryDocumentSnapshot<T>;
-/**
- * An Artisn DB collection of nodes.
- *
- * @typedef ArtisnDBCollectionReference
- * @since 0.1.0
- */
-declare type ArtisnDBCollectionReference<T = ArtisnDBDocumentData> = firebase.firestore.CollectionReference<T> | FirebaseFirestoreTypes.CollectionReference<T>;
-
 /**
  * Representation of a Commerce Category.
  *
@@ -942,20 +754,6 @@ interface CartTotals {
     /** Cart totals shipping cost */
     shippingCost: number;
 }
-/**
- * A shopping cart DB node from a user.
- *
- * @typedef ShoppingCartNode
- * @since 0.1.0
- */
-declare type ShoppingCartNode = ArtisnDBQueryDocumentSnapshot<ArtisnDBDocumentData>;
-/**
- * The complete collection of shopping carts DB nodes from a user.
- *
- * @typedef ShoppingCartNodes
- * @since 0.1.0
- */
-declare type ShoppingCartNodes = ArtisnDBCollectionReference<ArtisnDBDocumentData>;
 
 /**
  * Representation of a Commerce Product.
@@ -1373,20 +1171,6 @@ interface Award {
  * @since 0.1.0
  */
 declare type ShoppingCartBenefits = Benefit[];
-/**
- * A benefit DB node from a user.
- *
- * @typedef BenefitsByUserNode
- * @since 0.1.0
- */
-declare type BenefitsByUserNode = ArtisnDBQueryDocumentSnapshot<ArtisnDBDocumentData>;
-/**
- * The complete collection of benefits DB nodes from a user.
- *
- * @typedef BenefitsByUserNodes
- * @since 0.1.0
- */
-declare type BenefitsByUserNodes = ArtisnDBCollectionReference<ArtisnDBDocumentData>;
 /**
  * The possible values of the benefit type.
  *
@@ -2271,7 +2055,7 @@ interface BaseUser<T extends AdditionalInfo = AdditionalInfo> {
     /** User's birthdate, e.g: 1991-05-02 */
     birthdate?: string;
     /** The vendor which the user was created */
-    vendorId?: number;
+    vendorId?: Vendor["id"];
     /** The platform where the user was generated */
     origin?: string;
     /** User's document */
@@ -3474,4 +3258,4 @@ interface CardInscription {
     createdAt?: string;
 }
 
-export { ARDocumentType, Account, AdditionalInfo, Alert, Allocation, ArtisnApp, ArtisnDB, ArtisnDBCollectionReference, ArtisnDBDocumentData, ArtisnDBQueryDocumentSnapshot, ArtisnHeaders, ArtisnHints, ArtisnParams, ArtisnPlatform, ArtisnQuery, ArtisnRNApp, ArtisnRNAuth, ArtisnRNAuthInstance, ArtisnRNSettings, ArtisnRequest, ArtisnRequestBody, ArtisnRequestHeaders, ArtisnRequestMethod, ArtisnRestrictedHeaders, ArtisnWebApp, ArtisnWebAuth, ArtisnWebAuthInstance, ArtisnWebSettings, Award, BODocumentType, BRDocumentType, Banner, BannerBenefits, BannerCoupon, BannerImage, BannerScope, BannerType, BaseBillingData, BaseField, BaseLivingPlace, BaseOrder, BasePaymentMethod, BaseProduct, BaseShippingAddress, BaseUser, BaseWeekDay, Benefit, BenefitData, BenefitTypes, BenefitsByUserNode, BenefitsByUserNodes, BillTotal, BillTotalCategory, BillingData, CDNImage, CLDocumentType, CODocumentType, CardInscription, CardName, CartProduct, CartProductAnswer, CartProductQuestion, CartStore, CartTotals, Catalogue, Category, CategoryWithProducts, Code, CommonDocumentType, Country, CountryCode, CountryCurrency, CountrySummary, Coupon, CouponCategory, CouponType, CreditCardMapping, CurrencyCodes, DayOfWeek, Days, Delivery, DeliveryTimeUnit, Discount, DocumentType, ECDocumentType, Field, FieldRecord, Gender, GenericStoreLocation, Image, ImageFit, ImageManipulationConfig, ImageToFormat, Injection, InjectionDetail, IntegrationMessage, Issue, IssueAdditionalInfo, IssueHistory, LivingPlace, LivingPlaceToSave, MaritalStatus, Message, MetadataShipping, NewShippingAddress, Notification, NotificationAdditionalInfo, NotificationExtraData, NotificationListItem, NotificationPriority, NotificationStep, NotificationStore, NotificationUser, NotificationVendor, Objectify, OperatorInformation, Order, OrderBillProduct, OrderBillProductAdditionalInfo, OrderBillTotal, OrderCommonFields, OrderDetailShippingCost, OrderDetails, OrderPaymentMethod, OrderProduct, OrderProductAdditionalInfo, OrderProductAttributes, OrderProductBillTotal, OrderProductImage, OrderProductPriceCategory, OrderRetry, OrderRetryPaymentMethod, OrderShoppingCart, OrderStatus, OrderStep, OrderStepAdditionalInfo, OrderStepAdditionalInfoGroup, OrderStore, OrderStoreAdditionalInfo, OrderStoreDelivery, OrderUser, PEDocumentType, PYDocumentType, PaymentMethod, PaymentMethodByOrder, PaymentMethodName, PaymentProvider, PaymentStatus, Phone, PriceCategory, PriceCategoryTax, PriceCategoryType, Product, ProductAnswer, ProductAttributes, ProductCoupon, ProductDetails, ProductPrices, ProductQuestion, ProductStatus, ProductType, RandomImageConfig, ReadValue, Rule, Schedule, Service, Settings, ShippingAddress, ShippingCost, ShippingCostTax, ShoppingCart, ShoppingCartBenefits, ShoppingCartNode, ShoppingCartNodes, Status, StepCategory, StepCode, StepNotification, StepWorkflow, StepWorkflowAdditionalInfo, StepWorkflowGroup, Store, StoreCoupon, StoreCouponDetail, StoreLocation, StorePolygons, Suborder, TaxCalculation, TaxCalculations, TaxType, Token, TransitionWorkflow, URLImage, USDocumentType, UYDocumentType, UpdatedShippingAddress, User, UserCountry, UserSettings, UserType, VEDocumentType, Vendor, Wallet, WebhookWorkflow, Workflow, ZipCodeField };
+export { ARDocumentType, Account, AdditionalInfo, Alert, Allocation, ArtisnParams, ArtisnPlatform, ArtisnQuery, ArtisnRequest, ArtisnRequestBody, ArtisnRequestHeaders, ArtisnRequestMethod, Award, BODocumentType, BRDocumentType, Banner, BannerBenefits, BannerCoupon, BannerImage, BannerScope, BannerType, BaseBillingData, BaseField, BaseLivingPlace, BaseOrder, BasePaymentMethod, BaseProduct, BaseShippingAddress, BaseUser, BaseWeekDay, Benefit, BenefitData, BenefitTypes, BillTotal, BillTotalCategory, BillingData, CDNImage, CLDocumentType, CODocumentType, CardInscription, CardName, CartProduct, CartProductAnswer, CartProductQuestion, CartStore, CartTotals, Catalogue, Category, CategoryWithProducts, Code, CommonDocumentType, Country, CountryCode, CountryCurrency, CountrySummary, Coupon, CouponCategory, CouponType, CreditCardMapping, CurrencyCodes, DayOfWeek, Days, Delivery, DeliveryTimeUnit, Discount, DocumentType, ECDocumentType, Field, FieldRecord, Gender, GenericStoreLocation, Image, ImageFit, ImageManipulationConfig, ImageToFormat, Injection, InjectionDetail, IntegrationMessage, Issue, IssueAdditionalInfo, IssueHistory, LivingPlace, LivingPlaceToSave, MaritalStatus, Message, MetadataShipping, NewShippingAddress, Notification, NotificationAdditionalInfo, NotificationExtraData, NotificationListItem, NotificationPriority, NotificationStep, NotificationStore, NotificationUser, NotificationVendor, Objectify, OperatorInformation, Order, OrderBillProduct, OrderBillProductAdditionalInfo, OrderBillTotal, OrderCommonFields, OrderDetailShippingCost, OrderDetails, OrderPaymentMethod, OrderProduct, OrderProductAdditionalInfo, OrderProductAttributes, OrderProductBillTotal, OrderProductImage, OrderProductPriceCategory, OrderRetry, OrderRetryPaymentMethod, OrderShoppingCart, OrderStatus, OrderStep, OrderStepAdditionalInfo, OrderStepAdditionalInfoGroup, OrderStore, OrderStoreAdditionalInfo, OrderStoreDelivery, OrderUser, PEDocumentType, PYDocumentType, PaymentMethod, PaymentMethodByOrder, PaymentMethodName, PaymentProvider, PaymentStatus, Phone, PriceCategory, PriceCategoryTax, PriceCategoryType, Product, ProductAnswer, ProductAttributes, ProductCoupon, ProductDetails, ProductPrices, ProductQuestion, ProductStatus, ProductType, RandomImageConfig, ReadValue, Rule, Schedule, Service, Settings, ShippingAddress, ShippingCost, ShippingCostTax, ShoppingCart, ShoppingCartBenefits, Status, StepCategory, StepCode, StepNotification, StepWorkflow, StepWorkflowAdditionalInfo, StepWorkflowGroup, Store, StoreCoupon, StoreCouponDetail, StoreLocation, StorePolygons, Suborder, TaxCalculation, TaxCalculations, TaxType, Token, TransitionWorkflow, URLImage, USDocumentType, UYDocumentType, UpdatedShippingAddress, User, UserCountry, UserSettings, UserType, VEDocumentType, Vendor, Wallet, WebhookWorkflow, Workflow, ZipCodeField };

package/package.json

@@ -1,17 +1,12 @@
 {
   "name": "@artisan-commerce/types",
   "description": "Artisn's types and interfaces library",
-  "version": "0.14.0-canary.36",
-  "main": "./dist/bundle.d.ts",
-  "module": "./dist/bundle.d.ts",
+  "version": "0.14.0-canary.38",
   "types": "./dist/bundle.d.ts",
   "files": [
     "dist"
   ],
   "sideEffects": false,
-  "exports": {
-    "default": "./dist/bundle.esm.js"
-  },
   "scripts": {
     "compile": "rollup -c",
     "dev": "yarn compile -w",
@@ -28,13 +23,7 @@
   },
   "author": "Luis Eduardo Andrade",
   "license": "MIT",
-  "devDependencies": {
-    "@react-native-firebase/app": "^12.8.0",
-    "@react-native-firebase/auth": "^12.8.0",
-    "@react-native-firebase/firestore": "^12.8.0",
-    "firebase": "^8.1.1"
-  },
-  "gitHead": "cc68af5a1e959069cee7b835d367f319db416241",
+  "gitHead": "3ae7512fd09b7e59227b159b7e0e3853964a03c0",
   "nx": {
     "targets": {
       "build": {