@artisan-commerce/types 0.14.0-canary.11 → 0.14.0-canary.13

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.14.0-canary.13](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.12...@artisan-commerce/types@0.14.0-canary.13) (2021-09-30)
+
+**Note:** Version bump only for package @artisan-commerce/types
+
+
+
+
+
+## [0.14.0-canary.12](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.11...@artisan-commerce/types@0.14.0-canary.12) (2021-09-30)
+
+**Note:** Version bump only for package @artisan-commerce/types
+
+
+
+
+
 ## [0.14.0-canary.11](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.10...@artisan-commerce/types@0.14.0-canary.11) (2021-09-23)
 
 

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

@@ -1,16 +1,20 @@
 import firebase from "firebase";
+import { ReactNativeFirebase } from "@react-native-firebase/app";
+import authRN, { FirebaseAuthTypes } from "@react-native-firebase/auth";
+import "@react-native-firebase/firestore";
 /**
  * The ArtisnApp controls the app connection with the DBs and its settings.
  *
  * @typedef ArtisnApp
- * @since 0.5.14
+ * @since 0.1.0
  */
 export declare type ArtisnApp = ArtisnAppWeb | ArtisnAppRN;
 /**
- * The ArtisnAppWeb orchestrate the connections of the app with the DB, server and its settings.
+ * The ArtisnAppWeb orchestrate the connections of the app with the DB, server
+ * and its settings.
  *
  * @interface ArtisnAppWeb
- * @since 0.5.14
+ * @since 0.1.0
  */
 export interface ArtisnAppWeb {
     /** App's name */
@@ -19,46 +23,35 @@ export interface ArtisnAppWeb {
     apiURL: string;
     /** Artisn app settings configuration, see {@link ArtisnSettings} */
     settings: ArtisnSettings;
-    /** Internal configuration of App and databases  */
+    /** 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.
+ * The ArtisnAppRN orchestrate the connections of the app with the DB, server
+ * and its settings.
  *
  * @interface ArtisnAppRN
- * @since 0.5.14
+ * @since 0.1.0
  */
 export interface ArtisnAppRN {
+    /** App's name */
+    name: ReactNativeFirebase.FirebaseApp["name"];
     /** Artisn's account API URL */
     apiURL: string;
+    /** Artisn app settings configuration, see {@link ArtisnSettings} */
+    settings: ArtisnSettingsRN;
     /** Internal configuration of App and databases */
-    __internals__: RNFirebaseInstance;
+    __internals__: ReactNativeFirebase.FirebaseApp;
     /** 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;
+    __instance__: ReactNativeFirebase.Module;
 }
 /**
  * Settings to configure the Artisn app.
  *
  * @interface ArtisnSettings
- * @since 0.5.14
+ * @since 0.1.0
  */
 export interface ArtisnSettings {
     /** Artisn's account unique identifier */
@@ -78,7 +71,7 @@ export interface ArtisnSettings {
  * Settings to configure the Artisn app react-native.
  *
  * @interface ArtisnSettingsRN
- * @since 0.5.14
+ * @since 0.1.0
  */
 export interface ArtisnSettingsRN {
     /** Platform where the app is running, see {@link ArtisnPlatform} */
@@ -90,29 +83,61 @@ export interface ArtisnSettingsRN {
  * Artisn app's allowed platforms to run on.
  *
  * @typedef ArtisnPlatform
- * @since 0.5.14
+ * @since 0.1.0
  */
 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
+ * @typedef ArtisnAuthInstance
+ * @since 0.1.0
  */
-export declare type ArtisnInstanceAuth = typeof firebase.auth;
+export declare type ArtisnAuthInstance = ArtisnAuthInstanceWeb | ArtisnAuthInstanceRN;
+/**
+ * Artisn's auth instance is the instance of the internal auth object.
+ *
+ * @typedef ArtisnAuthInstanceWeb
+ * @since 0.1.0
+ */
+export declare type ArtisnAuthInstanceWeb = typeof firebase.auth;
+/**
+ * Artisn's auth instance is the instance of the internal auth object for react
+ * native.
+ *
+ * @typedef ArtisnAuthInstanceRN
+ * @since 0.1.0
+ */
+export declare type ArtisnAuthInstanceRN = typeof authRN;
 /**
  * Artisn's auth object to handle providers authentication.
  *
  * @typedef ArtisnAuth
- * @since 0.5.14
+ * @since 0.1.0
+ */
+export declare type ArtisnAuth = ArtisnAuthWeb | ArtisnAuthRN;
+/**
+ * Artisn's auth object to handle providers authentication.
+ *
+ * @interface ArtisnAuthWeb
+ * @since 0.1.0
+ * @extends {{@link firebase.auth.Auth}
+ */
+export interface ArtisnAuthWeb extends firebase.auth.Auth {
+}
+/**
+ * Artisn's auth object to handle providers authentication for react native.
+ *
+ * @interface ArtisnAuthRN
+ * @since 0.1.0
+ * @extends {{@link FirebaseAuthTypes.Module}
  */
-export interface ArtisnAuth extends firebase.auth.Auth {
+export interface ArtisnAuthRN extends FirebaseAuthTypes.Module {
 }
 /**
  * Main artisn commerce filters.
  *
  * @interface ArtisnHints
- * @since 0.5.14
+ * @since 0.1.0
  */
 export interface ArtisnHints {
     /** Artisn's account unique identifier */
@@ -132,7 +157,7 @@ export interface ArtisnHints {
  * Unrestricted allowed Artisn SDK rest api headers.
  *
  * @interface ArtisnHeaders
- * @since 0.5.14
+ * @since 0.1.0
  */
 export interface ArtisnHeaders {
     /** Platform where the app is running, see {@link ArtisnPlatform} */
@@ -144,7 +169,7 @@ export interface ArtisnHeaders {
  * Restricted allowed Artisn SDK rest api headers.
  *
  * @interface ArtisnRestrictedHeaders
- * @since 0.5.14
+ * @since 0.1.0
  * @extends {{@link ArtisnHeaders}
  */
 export interface ArtisnRestrictedHeaders extends ArtisnHeaders {

package/build/types/app.types.js

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

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

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

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

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

package/build/types/artisnDB.types.js

@@ -1,4 +1,3 @@
 "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 +1 @@
-{"version":3,"file":"artisnDB.types.js","sourceRoot":"","sources":["../../src/types/artisnDB.types.ts"],"names":[],"mappings":";AAAA,iCAAiC"}
+{"version":3,"file":"artisnDB.types.js","sourceRoot":"","sources":["../../src/types/artisnDB.types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/types",
   "description": "Artisn's types and interfaces library",
-  "version": "0.14.0-canary.11",
+  "version": "0.14.0-canary.13",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
   "files": [
@@ -23,6 +23,9 @@
   "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",
     "@types/node": "^14.0.24",
     "@typescript-eslint/eslint-plugin": "^3.7.0",
     "@typescript-eslint/parser": "^3.7.0",
@@ -42,5 +45,5 @@
     "prettier": "^2.1.2",
     "webpack-bundle-analyzer": "^3.9.0"
   },
-  "gitHead": "335bd3e5dcdd26e3a6f96e3904d47d4eb4a9ca4e"
+  "gitHead": "8156f9f4ae00ef214142c0e1be802f7c77b436ec"
 }