@artisan-commerce/types 0.12.2-canary.0 → 0.12.2-canary.1

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+### [0.12.2-canary.1](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/types@0.12.2-canary.0...@artisan-commerce/types@0.12.2-canary.1) (2021-03-18)
+
+**Note:** Version bump only for package @artisan-commerce/types
+
+
+
+
+
 ### [0.12.2-canary.0](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/types@0.12.1...@artisan-commerce/types@0.12.2-canary.0) (2021-03-12)
 
 **Note:** Version bump only for package @artisan-commerce/types

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

@@ -1,3 +1,12 @@
+/**
+ * Representation of a Customer Account
+ *
+ * @interface Account
+ * @author Luis Eduardo Andrade
+ * @since 0.5.14
+ * @property {number} accountId artisan's account unique identifier.
+ * @property {string} name account's name.
+ */
 export interface Account {
     accountId: number;
     name: string;

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

@@ -1,35 +1,110 @@
 import firebase from "firebase";
+/**
+ * The ArtisanApp orchestrate the connections of the app with the DB, server and its settings.
+ *
+ * @interface ArtisanApp
+ * @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 {
+    name: firebase.app.App["name"];
     apiURL: string;
+    settings: ArtisanSettings;
     __internals__: firebase.app.App;
     __instance__: typeof firebase;
-    settings: ArtisanSettings;
-    name: firebase.app.App["name"];
 }
+/**
+ * Settings to configure the Artisan app.
+ *
+ * @interface ArtisanSettings
+ * @author Luis Eduardo Andrade
+ * @since 0.5.14
+ * @property {number} accountId artisan's account unique identifier
+ * @property {ArtisanPlatform} platform app's running on platform
+ * @property {string} projectId app's project id
+ * @property {string} apiKey app's API key
+ * @property {string} appId app's external app id
+ * @property {string} authDomain app's auth domain url
+ */
 export interface ArtisanSettings {
+    accountId?: number;
+    platform?: ArtisanPlatform;
     projectId: string;
     apiKey: string;
-    authDomain: string;
     appId?: string;
-    platform?: ArtisanPlatform;
-    accountId?: number;
+    authDomain: string;
 }
+/**
+ * Artisan app's allowed platforms to run on.
+ *
+ * @type ArtisanPlatform
+ * @author Luis Eduardo Andrade
+ * @since 0.5.14
+ */
+export declare type ArtisanPlatform = "web" | "ios" | "android" | "windows" | "macos" | "call center";
+/**
+ * Artisan's auth instance is the intance of the internal auth object.
+ *
+ * @type AritsanInstanceAuth
+ * @author Luis Eduardo Andrade
+ * @since 0.5.14
+ */
 export declare type AritsanInstanceAuth = typeof firebase.auth;
+/**
+ * Artisan's auth object to handle providers authentication.
+ *
+ * @type ArtisanAuth
+ * @author Luis Eduardo Andrade
+ * @since 0.5.14
+ */
 export interface ArtisanAuth extends firebase.auth.Auth {
 }
+/**
+ * Main artisan commerce filters.
+ *
+ * @interface ArtisanHints
+ * @author Luis Eduardo Andrade
+ * @since 0.5.14
+ * @property {string|number} accountId artisan's account unique identifier
+ * @property {string|number} vendorId vendor's id
+ * @property {string|number} catalogueId catalogue's id
+ * @property {number} storeId store's id
+ * @property {string|number} categoryId category's id
+ * @property {string|number} productId product's id
+ */
 export interface ArtisanHints {
     accountId: string | number;
     vendorId?: string | number;
-    storeId?: number;
     catalogueId?: string | number;
+    storeId?: number;
     categoryId?: string | number;
     productId?: string | number;
 }
-export declare type ArtisanPlatform = "web" | "ios" | "android" | "windows" | "macos" | "call center";
+/**
+ * Unrestricted allowed Artisan SDK rest api headers.
+ *
+ * @interface ArtisanHeaders
+ * @author Luis Eduardo Andrade
+ * @since 0.5.14
+ * @property {ArtisanPlatform} Platform app's running on platform
+ * @property {string|number} account account's id
+ */
 export interface ArtisanHeaders {
     Platform: ArtisanPlatform;
     account: string;
 }
+/**
+ * Restricted allowed Artisan SDK rest api headers.
+ *
+ * @interface ArtisanRestrictedHeaders
+ * @extends ArtisanHeaders
+ * @author Luis Eduardo Andrade
+ * @since 0.5.14
+ * @property {ArtisanPlatform} Authorization app's authentication token
+ */
 export interface ArtisanRestrictedHeaders extends ArtisanHeaders {
     Authorization: string;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/types",
   "description": "Artisan's types and interfaces library",
-  "version": "0.12.2-canary.0",
+  "version": "0.12.2-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": "1776047e27a0b93ef9921a8d0d468bc9a0693e5b"
+  "gitHead": "feb13f015606740820d59ec65b8b4a91163c79dd"
 }