@artisan-commerce/types 0.12.2-canary.2 → 0.13.0-canary.1

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.13.0-canary.1](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/types@0.13.0-canary.0...@artisan-commerce/types@0.13.0-canary.1) (2021-03-19)
+
+
+### Features
+
+* **types:** add init-rn types ([e4f44c4](https://bitbucket.org/tradesystem/artisan_monorepo/commit/e4f44c484e8d223a1716daf4cf0ec098dfde620a))
+
+
+
+## [0.13.0-canary.0](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/types@0.12.2-canary.2...@artisan-commerce/types@0.13.0-canary.0) (2021-03-18)
+
+
+### Features
+
+* **artisa-commerce:** added code documentation for users lib and types refactor ([1d0acf7](https://bitbucket.org/tradesystem/artisan_monorepo/commit/1d0acf703c6a9b6e4c7cb157ef045c49e6579d3a))
+* **artisan-commerce:** merge branch 'canary' into feature/document-users-code ([e18fe40](https://bitbucket.org/tradesystem/artisan_monorepo/commit/e18fe401542d38afd0599bc98b0924d6b44bd74a))
+
+
+
 ### [0.12.2-canary.2](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/types@0.12.2-canary.1...@artisan-commerce/types@0.12.2-canary.2) (2021-03-18)
 
 

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

@@ -1,21 +1,53 @@
 import firebase from "firebase";
+export declare type ArtisanApp = ArtisanAppWeb | ArtisanAppRN;
 /**
- * The ArtisanApp orchestrate the connections of the app with the DB, server and its settings.
+ * The ArtisanAppWeb orchestrate the connections of the app with the DB, server and its settings.
  *
- * @interface ArtisanApp
+ * @interface ArtisanAppWeb
  * @author Luis Eduardo Andrade
  * @since 0.5.14
  * @property {string} name app's name
  * @property {string} apiURL artisan's account API URL
  * @property {ArtisanSettings} settings artisan app settings configuration
  */
-export interface ArtisanApp {
+export interface ArtisanAppWeb {
     name: firebase.app.App["name"];
     apiURL: string;
     settings: ArtisanSettings;
     __internals__: firebase.app.App;
     __instance__: typeof firebase;
 }
+/**
+ * The ArtisanAppRN orchestrate the connections of the app with the DB, server and its settings.
+ *
+ * @interface ArtisanAppRN
+ * @author John Arias
+ * @since 0.5.14
+ * @property {string} name app's name
+ * @property {string} apiURL artisan's account API URL
+ * @property {ArtisanSettings} settings artisan app settings configuration
+ */
+export interface ArtisanAppRN {
+    apiURL: string;
+    __internals__: RNFirebaseInstance;
+    __instance__: RNFirebaseInstance;
+    settings: ArtisanSettings;
+    name: string;
+}
+/**
+ * Settings to configure the Firabse Instance.
+ *
+ * @interface RNFirebaseInstance
+ * @author John Arias
+ * @since 0.5.14
+ * @property {aut} auth auth package from react-native-auth
+ * @property {firestore} firestore firestore package from react-native-auth
+ * @property {ArtisanSettings} settings artisan app settings configuration
+ */
+export interface RNFirebaseInstance {
+    auth: any;
+    firestore: any;
+}
 /**
  * Settings to configure the Artisan app.
  *
@@ -37,6 +69,10 @@ export interface ArtisanSettings {
     appId?: string;
     authDomain: string;
 }
+export interface ArtisanSettingsRN {
+    platform: ArtisanPlatform;
+    accountId?: number;
+}
 /**
  * Artisan app's allowed platforms to run on.
  *

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

@@ -1,7 +1,6 @@
 import { Country } from "./common.types";
 import { DocumentType } from "./common.types";
-export interface BillingData {
-    id: number;
+export interface BaseBillingData {
     nickname: string;
     name: string;
     documentType: DocumentType;
@@ -12,3 +11,6 @@ export interface BillingData {
     default: boolean;
     country: Country;
 }
+export interface BillingData extends BaseBillingData {
+    id: number;
+}

package/build/types/livingPlace.types.d.ts

@@ -1,17 +1,23 @@
-export interface LivingPlace {
+export interface BaseLivingPlace {
     id: number;
+}
+export interface LivingPlace extends BaseLivingPlace {
     name: string;
     active: number;
-    fields: Field[] | FilledField[];
     countryId: number;
+    fields: Field[];
+}
+export interface LivingPlaceToSave extends BaseLivingPlace {
+    fields: FieldRecord[];
 }
 export interface Field {
     id: string;
     label: string;
     rules: Rules;
     messages: Messages;
+    value?: string;
 }
-export interface FilledField {
+export interface FieldRecord {
     id: string;
     value: string;
 }

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

@@ -1,7 +1,6 @@
 import { Country } from "./common.types";
-import { LivingPlace } from "./livingPlace.types";
-export interface ShippingAddress {
-    id: number;
+import { LivingPlace, LivingPlaceToSave } from "./livingPlace.types";
+export interface BaseShippingAddress {
     default: boolean;
     lat: number;
     lng: number;
@@ -10,6 +9,17 @@ export interface ShippingAddress {
     number: string;
     secondaryStreet: string;
     addressReference: string;
-    livingPlace: Partial<LivingPlace>;
     country: Country;
 }
+export interface ShippingAddress extends BaseShippingAddress {
+    id: number;
+    livingPlace: LivingPlace;
+}
+export interface NewShippingAddress extends BaseShippingAddress {
+    id?: number;
+    livingPlace: LivingPlaceToSave;
+}
+export interface UpdatedShippingAddress extends BaseShippingAddress {
+    id: number;
+    livingPlace: LivingPlaceToSave;
+}

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

@@ -1,25 +1,27 @@
 import { DocumentType } from "./common.types";
-export interface User {
+export interface BaseUser {
     uid: string;
     name: string;
-    middleName: string;
+    middleName?: string;
     lastname: string;
-    secondLastname: string;
+    secondLastname?: string;
     email: string;
-    birthdate: string;
-    vendorId: number;
-    origin: string;
-    document: string;
-    documentType: DocumentType;
-    gender: Gender;
+    birthdate?: string;
+    vendorId?: number;
+    origin?: string;
+    document?: string;
+    documentType?: DocumentType;
+    gender?: Gender;
     country: UserCountry;
-    phone: Phone;
-    idInt: number;
-    type: UserType | undefined;
+    phone?: Phone;
+    type?: UserType;
     externalId?: string;
     maritalStatus?: MaritalStatus;
     active?: boolean;
-    additionalInfo: AdditionalInfo;
+    additionalInfo?: AdditionalInfo;
+}
+export interface User extends BaseUser {
+    idInt: number;
 }
 export declare type UserType = "NORMAL" | "DEPENDENT";
 export interface UserCountry {

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

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/types",
   "description": "Artisan's types and interfaces library",
-  "version": "0.12.2-canary.2",
+  "version": "0.13.0-canary.1",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
   "files": [
@@ -44,5 +44,5 @@
     "typescript": "^3.9.7",
     "webpack-bundle-analyzer": "^3.9.0"
   },
-  "gitHead": "ad89147223346d3d1db97d3fa3db50c80b4beb17"
+  "gitHead": "16fd34386acfecedb853c838ad41944fdce1ac22"
 }