@artisan-commerce/products 0.0.2 → 0.1.3

package/build/src/config/constants.d.ts

@@ -1,3 +1,4 @@
+import { GROUPS as Groups } from "../types/http.types";
 declare const CONSTANTS: {
     CLIENT_NAME: string;
     DEFAULT_REQUEST_TIMEOUT: number;
@@ -9,5 +10,14 @@ declare const CONSTANTS: {
         CODE: string;
         LANGUAGE: string;
     };
+    DEFAULT_API_TIMEOUT: number;
+    HEADERS: string[];
+    FILTERS: ("productId" | "vendorId" | "storeId" | "catalogueId" | "categoryId")[];
+    GROUPS: Groups[];
+    ORDER_FIELDS: string[];
+    ORDER_TYPES: ("ALPHABETIC" | "PRICE" | "PREDEFINED" | undefined)[];
+    ORDER_SORTS: ("ASC" | "DESC" | undefined)[];
+    PAGINATION: string[];
+    ADDITIONAL_FILTERS: string[];
 };
 export default CONSTANTS;

package/build/src/errors/api.errors.d.ts

@@ -0,0 +1,7 @@
+import { ProductHints } from "../types/common.types";
+import { ID, ProductsHTTPConfig, RequestData } from "../types/http.types";
+export declare const checkAccountId: (accountId: ProductHints["accountId"] | undefined, message?: string) => void;
+export declare const checkVendorId: (vendorId: ID | undefined, message?: string) => void;
+export declare const checkStoreId: (storeId: ID | undefined, message?: string) => void;
+export declare const checkCatalogueId: (catalogueId: ID | undefined, message?: string) => void;
+export declare const checkHTTPMinimumConfig: (config: ProductsHTTPConfig, data: RequestData, message?: string) => void;

package/build/src/index.d.ts

@@ -1,4 +1,11 @@
 import * as transformers from "./utils/transformers/transformers.utils";
 import * as assertions from "./utils/assertions/assertions.utils";
+export { getCategories } from "./lib/getCategories/getCategories";
+export { getProductDetails } from "./lib/getProductDetails/getProductDetails";
+export { getProducts } from "./lib/getProducts/getProducts";
+export { getRecommendedProducts } from "./lib/getRecommendedProducts/getRecommendedProducts";
+export { getRelatedProducts } from "./lib/getRelatedProducts/getRelatedProducts";
+export { getStoreDetails } from "./lib/getStoreDetails/getStoreDetails";
+export { initProducts } from "./lib/initProducts/initProducts";
 export { getProductTotals } from "./utils/caculations/calculations.utils";
 export { transformers, assertions };

package/build/src/lib/common.d.ts

@@ -0,0 +1,15 @@
+import { GlobalState } from "../types/common.types";
+export declare const initialState: GlobalState;
+export declare const setState: (overrides: Partial<GlobalState>) => void;
+export declare const getState: () => {
+    artisanApp: import("../../../types/build").ArtisanApp | undefined;
+    apiCache: import("../types/common.types").ApiCache;
+    expiresAt: number;
+    timeout?: number | undefined;
+    accountId?: string | number | undefined;
+    productId?: string | number | undefined;
+    vendorId?: string | number | undefined;
+    storeId?: string | number | undefined;
+    catalogueId?: string | number | undefined;
+    categoryId?: string | number | undefined;
+};

package/build/src/lib/getCategories/getCategories.d.ts

@@ -0,0 +1 @@
+export declare const getCategories: () => void;

package/build/src/lib/getCategories/getCategories.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/getProductDetails/getProductDetails.d.ts

@@ -0,0 +1,9 @@
+import { FetchProductDetailsConfig } from "./getProductDetails.types";
+export declare const getProductDetails: (productId: number | string, config: FetchProductDetailsConfig) => Promise<import("../../../../types/build").BaseProduct | {
+    data: any;
+    hints: {
+        [x: string]: string | number | boolean;
+    };
+    config: import("../../../../types/build").ArtisanRequest;
+    error: string | undefined;
+} | import("../../../../types/build").Product[]>;

package/build/src/lib/getProductDetails/getProductDetails.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/getProductDetails/getProductDetails.types.d.ts

@@ -0,0 +1,7 @@
+import { ProductsHTTPConfig } from "../../types/http.types";
+export interface FetchProductDetailsConfig extends ProductsHTTPConfig {
+    groupBy?: undefined;
+    orderBy?: undefined;
+    pagination?: undefined;
+    additionalFilters?: undefined;
+}

package/build/src/lib/getProducts/getProducts.d.ts

@@ -0,0 +1,9 @@
+import { FetchProductsConfig } from "./getProducts.types";
+export declare const getProducts: (config: FetchProductsConfig) => Promise<import("../../../../types/build").BaseProduct | {
+    data: any;
+    hints: {
+        [x: string]: string | number | boolean;
+    };
+    config: import("../../../../types/build").ArtisanRequest;
+    error: string | undefined;
+} | import("../../../../types/build").Product[]>;

package/build/src/lib/getProducts/getProducts.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/getProducts/getProducts.types.d.ts

@@ -0,0 +1,3 @@
+import { ProductsHTTPConfig } from "../../types/http.types";
+export interface FetchProductsConfig extends ProductsHTTPConfig {
+}

package/build/src/lib/getRecommendedProducts/getRecommendedProducts.d.ts

@@ -0,0 +1 @@
+export declare const getRecommendedProducts: () => void;

package/build/src/lib/getRecommendedProducts/getRecommendedProducts.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/getRelatedProducts/getRelatedProducts.d.ts

@@ -0,0 +1 @@
+export declare const getRelatedProducts: () => void;

package/build/src/lib/getRelatedProducts/getRelatedProducts.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/getStoreDetails/getStoreDetails.d.ts

@@ -0,0 +1,9 @@
+import { FetchStoreDetailsConfig } from "./getStoreDetails.types";
+export declare const getStoreDetails: (config: FetchStoreDetailsConfig) => Promise<import("../../../../types/build").BaseProduct | {
+    data: any;
+    hints: {
+        [x: string]: string | number | boolean;
+    };
+    config: import("../../../../types/build").ArtisanRequest;
+    error: string | undefined;
+} | import("../../../../types/build").Product[]>;

package/build/src/lib/getStoreDetails/getStoreDetails.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/getStoreDetails/getStoreDetails.types.d.ts

@@ -0,0 +1,7 @@
+import { ProductsHTTPConfig } from "../../types/http.types";
+export interface FetchStoreDetailsConfig extends ProductsHTTPConfig {
+    groupBy?: undefined;
+    orderBy?: undefined;
+    pagination?: undefined;
+    additionalFilters?: undefined;
+}

package/build/src/lib/initProducts/initProducts.d.ts

@@ -0,0 +1,10 @@
+import { ArtisanApp } from "@artisan-commerce/types";
+import { InitProductsConfig } from "../../types/common.types";
+/**
+ * Initialize products metadata, stores initial global state for future needs.
+ * @author Luis Eduardo Andrade
+ * @since 1.0
+ * @param artisanApp: An artisan initialized app.
+ * @param config: Global products state that can be configure at the function call level
+ */
+export declare const initProducts: (artisanApp: ArtisanApp, config?: InitProductsConfig) => void;

package/build/src/services/fetchProductDetails/fetchProductDetails.service.d.ts

@@ -0,0 +1,2 @@
+import { ArtisanRequest, ProductDetails } from "@artisan-commerce/types";
+export declare const fetchProductDetails: (request: ArtisanRequest) => Promise<ProductDetails>;

package/build/src/services/fetchProductDetails/fetchProductDetails.service.mock.d.ts

@@ -0,0 +1,2 @@
+import { ProductDetails, ArtisanRequest } from "@artisan-commerce/types";
+export declare const fetchProductDetails: (request: ArtisanRequest) => Promise<ProductDetails>;

package/build/src/services/fetchProductDetails/fetchProductDetails.service.types.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/services/fetchProducts/fetchPRoducts.service.mock.d.ts

@@ -0,0 +1,2 @@
+import { BaseProduct, ArtisanRequest } from "@artisan-commerce/types";
+export declare const fetchProductDetails: (request: ArtisanRequest) => Promise<BaseProduct[]>;

package/build/src/services/fetchProducts/fetchProducts.service.d.ts

@@ -0,0 +1,2 @@
+import { ArtisanRequest, BaseProduct } from "@artisan-commerce/types";
+export declare const fetchProducts: (request: ArtisanRequest) => Promise<BaseProduct[]>;

package/build/src/services/fetchProducts/fetchProducts.service.types.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/services/fetchStoreDetails/fetchStoreDetails.service.d.ts

@@ -0,0 +1,2 @@
+import { ArtisanRequest, BaseProduct } from "@artisan-commerce/types";
+export declare const fetchStoreDetails: (request: ArtisanRequest) => Promise<BaseProduct[]>;

package/build/src/services/fetchStoreDetails/fetchStoreDetails.service.types.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/tests/exports.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,15 @@
+import { ArtisanApp, ArtisanHints, Product } from "@artisan-commerce/types";
+export interface ProductHints extends Omit<ArtisanHints, "accountId"> {
+    accountId?: ArtisanHints["accountId"];
+}
+export interface InitProductsConfig extends ProductHints {
+    timeout?: number;
+}
+export interface GlobalState extends InitProductsConfig {
+    artisanApp: ArtisanApp | undefined;
+    apiCache: ApiCache;
+    expiresAt: number;
+}
+export interface ApiCache {
+    [key: string]: Product | Product[];
+}

package/build/src/types/http.types.d.ts

@@ -0,0 +1,66 @@
+import { ArtisanRequestHeaders } from "@artisan-commerce/types";
+export interface ProductsHTTPConfig {
+    filterBy: Filters;
+    groupBy?: GROUPS;
+    orderBy?: Order;
+    pagination?: Pagination;
+    additionalFilters?: AdditionalFilters;
+}
+export declare type ID = string | number | (string | number)[];
+export interface Filters {
+    vendorId: ID;
+    storeId: ID;
+    catalogueId: ID;
+    categoryId?: ID;
+    productId?: ID;
+}
+export declare type GROUPS = "CATEGORIES" | "TAGS";
+export declare type ORDER_TYPES = "ALPHABETIC" | "PRICE" | "PREDEFINED";
+export interface Order {
+    type?: ORDER_TYPES;
+    sort?: "ASC" | "DESC";
+}
+export interface Pagination {
+    page?: number;
+    vendor?: {
+        size: number;
+    };
+    store?: {
+        size: number;
+    };
+    catalogue?: {
+        size: number;
+    };
+    category?: {
+        size: number;
+    };
+    product?: {
+        size: number;
+    };
+}
+export interface AdditionalFilters {
+    price?: {
+        type?: "NORMAL" | "POINTS";
+        from?: number;
+        to?: number;
+    };
+    query?: string;
+    tags?: string[];
+    manufacturerId?: number | number[];
+    weigth?: {
+        unit: string;
+        value: number;
+    };
+    dimensions?: {
+        unit: string;
+        width: number;
+        height: number;
+        depth: number;
+    };
+}
+export interface RequestData {
+    headers: ArtisanRequestHeaders;
+    params: Record<string, string | number>;
+    query: Record<string, string | number | boolean>;
+    body: Record<string, any>;
+}

package/build/src/utils/http/cache.utils.d.ts

@@ -0,0 +1,4 @@
+export declare const getCacheKey: (hash: string) => import("../../../../types/build").BaseProduct | import("../../../../types/build").ProductDetails | import("../../../../types/build").CartProduct | import("../../../../types/build").Product[];
+export declare const setCacheKey: (hash: string, data: any) => void;
+export declare const isCacheExpired: () => boolean;
+export declare const flushCache: () => void;

package/build/src/utils/http/http.utils.d.ts

@@ -0,0 +1,11 @@
+import { ArtisanRequest } from "@artisan-commerce/types";
+import { ProductsHTTPConfig, RequestData } from "../../types/http.types";
+export declare const handleHTTPCall: <T extends ProductsHTTPConfig>(path: string, config: T, data: RequestData, callback: (request: ArtisanRequest) => any) => Promise<import("../../../../types/build").BaseProduct | {
+    data: any;
+    hints: {
+        [x: string]: string | number | boolean;
+    };
+    config: ArtisanRequest;
+    error: string | undefined;
+} | import("../../../../types/build").Product[]>;
+export declare const fetchHandler: <T>(request: ArtisanRequest) => Promise<T>;

package/build/src/utils/http/purge.utils.d.ts

@@ -0,0 +1,38 @@
+import { ProductsHTTPConfig } from "../../types/http.types";
+/**
+ * Purge all invalid fields and values from the products http config
+ */
+export declare const purgeHTTPConfig: <T extends ProductsHTTPConfig>(config: T) => T;
+/**
+ * Purge invalid Filters
+ */
+export declare const purgeFilters: <T extends ProductsHTTPConfig>(config: ProductsHTTPConfig) => T;
+export declare const purgeGroup: <T extends ProductsHTTPConfig>(config: ProductsHTTPConfig) => T;
+/**
+ * Purge Order invalid values
+ */
+export declare const purgeOrder: <T extends ProductsHTTPConfig>(config: ProductsHTTPConfig) => T;
+/**
+ * Purge pagination invalid keys
+ */
+export declare const purgePagination: <T extends ProductsHTTPConfig>(config: ProductsHTTPConfig) => T;
+/**
+ * Purge AdditionalFilters invalid keys
+ */
+export declare const purgeAdditionalFilters: <T extends ProductsHTTPConfig>(config: ProductsHTTPConfig) => T;
+/**
+ * Remove object field
+ */
+export declare const purgeObject: (obj: Record<string, any>, validKeys: string[], field: string) => {
+    [x: string]: any;
+};
+/**
+ * Remove field value
+ */
+export declare const purgeField: (obj: Record<string, any>, validKeys: string[], fieldName: string) => {
+    [x: string]: any;
+};
+export declare const purgeNotID: (obj: Record<string, any>) => {
+    [x: string]: any;
+};
+export declare const isNumberOrString: (data: any) => boolean;

package/build/src/utils/http/request.utils.d.ts

@@ -0,0 +1,6 @@
+import { ArtisanRequest } from "@artisan-commerce/types";
+import { ProductsHTTPConfig, RequestData } from "../../types/http.types";
+export declare const buildHTTPRequest: (path: string, config: ProductsHTTPConfig, data: RequestData) => ArtisanRequest;
+export declare const filtersToQuery: (filters: ProductsHTTPConfig["filterBy"]) => {};
+export declare const parseRoute: (path: string, params: RequestData["params"]) => string;
+export declare const getRequestHash: (url: string) => string;

package/build/src/utils/transformers/api.transformer.d.ts

@@ -0,0 +1,9 @@
+import { ArtisanRequest } from "@artisan-commerce/types";
+export declare const transformResponse: (data: any, error: Error | undefined, req: ArtisanRequest) => {
+    data: any;
+    hints: {
+        [x: string]: string | number | boolean;
+    };
+    config: ArtisanRequest;
+    error: string | undefined;
+};

package/build/vendors.bundle.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define("products",[],t):"object"==typeof exports?exports.products=t():e.products=t()}(this,(function(){return function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}return r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=12)}({12:function(e,t){}})}));
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define("products",[],t):"object"==typeof exports?exports.products=t():e.products=t()}(this,(function(){return function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}return r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=21)}({21:function(e,t){}})}));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/products",
   "description": "Artisan's product management library",
-  "version": "0.0.2",
+  "version": "0.1.3",
   "main": "./build/main.bundle.js",
   "types": "./build/src/index.d.ts",
   "files": [
@@ -14,9 +14,9 @@
     "dev": "webpack --watch --config webpack.dev.js",
     "build": "webpack --config webpack.prod.js",
     "start:build": "nodemon ./build/main.bundle.js",
-    "test": "jest  --watchAll --passWithNoTests",
+    "test": "jest  --watchAll",
     "test:all": "npm run test -- --watchAll=false --coverage",
-    "test:ci": "cross-env CI=true jest --runInBand --passWithNoTests",
+    "test:ci": "cross-env CI=true jest --runInBand",
     "test:staged": "npm run test:ci --findRelatedTests",
     "check-types": "tsc --noEmit",
     "lint": "eslint --ignore-path .gitignore --ignore-pattern !cypress/.eslintrc.js --ext .js,jsx,.ts,.tsx .",
@@ -31,15 +31,16 @@
   "author": "Luis Eduardo Andrade",
   "license": "MIT",
   "dependencies": {
-    "@artisan-commerce/builders": "^0.1.1",
+    "@artisan-commerce/builders": "^0.1.2",
     "@bugsnag/js": "^7.2.0",
     "axios": "^0.19.2",
     "i18next": "^19.6.2",
     "i18next-browser-languagedetector": "^5.0.0",
-    "i18next-xhr-backend": "^3.2.2"
+    "i18next-xhr-backend": "^3.2.2",
+    "sha1": "^1.1.1"
   },
   "devDependencies": {
-    "@artisan-commerce/types": "^0.2.0",
+    "@artisan-commerce/types": "^0.3.0",
     "@babel/core": "^7.10.5",
     "@babel/preset-env": "^7.10.4",
     "@babel/preset-react": "^7.10.4",
@@ -47,6 +48,7 @@
     "@types/jest": "^26.0.5",
     "@types/jest-in-case": "^1.0.2",
     "@types/node": "^14.0.24",
+    "@types/sha1": "^1.1.2",
     "@typescript-eslint/eslint-plugin": "^3.7.0",
     "@typescript-eslint/parser": "^3.7.0",
     "avn": "^0.2.4",
@@ -68,6 +70,7 @@
     "is-ci-cli": "^2.1.2",
     "jest": "^24.9.0",
     "jest-axe": "^3.5.0",
+    "jest-extended": "^0.11.5",
     "jest-in-case": "^1.0.2",
     "jest-styled-components": "^7.0.2",
     "nodemon": "^2.0.4",
@@ -79,9 +82,10 @@
     "ts-loader": "^8.0.2",
     "typescript": "^3.9.7",
     "webpack": "^4.43.0",
+    "webpack-bundle-analyzer": "^3.9.0",
     "webpack-cli": "^3.3.12",
     "webpack-dev-server": "^3.11.0",
     "webpack-merge": "^5.0.9"
   },
-  "gitHead": "720bb9d861c9897cbe82400f4b8a1847b840c958"
+  "gitHead": "2e06658726110f5744ea05e7e68dcc9a908f8902"
 }

package/build/src/builders/common.builder.d.ts

@@ -1,23 +0,0 @@
-export declare const getPassword: (...args: any[]) => string;
-export declare const getUsername: (firstName?: string | undefined, lastName?: string | undefined) => string;
-export declare const genId: () => string;
-export declare const genName: (firstName?: string | undefined, lastName?: string | undefined, gender?: number | undefined) => string;
-export declare const genEmail: (firstName?: string | undefined, lastName?: string | undefined, provider?: string | undefined) => string;
-export declare const genCompanyName: (format?: number | undefined) => string;
-export declare const genParagraph: (sentenceCount?: number | undefined) => string;
-export declare const genTitle: () => string;
-export declare const genNumber: {
-    (max?: number | undefined): number;
-    (options?: {
-        min?: number | undefined;
-        max?: number | undefined;
-        precision?: number | undefined;
-    } | undefined): number;
-};
-export declare const getBoolean: () => boolean;
-export declare const genBiasBoolean: (bias: number) => boolean;
-export declare const genDocument: (digits: number) => string;
-export declare const genMobilPhone: (countryCode: string) => string;
-export declare const fillNumber: (num: string, max?: number | undefined) => string;
-export declare const chooseRandom: <T>(arr: T[]) => T;
-export declare const chooseRandomEnum: <T>(anEnum: T) => T[keyof T];

package/build/src/builders/user.builder.d.ts

@@ -1,2 +0,0 @@
-import { User } from "../types/user.types";
-export declare const buildUser: (overrides?: Partial<User>) => User;

package/build/src/services/auth/auth.service.d.ts

@@ -1,6 +0,0 @@
-import { LogInByTokenRes, LogInByCredentials } from "./auth.service.types";
-import { User } from "../../types/user.types";
-export declare const fetchAuthToken: (token: string | null) => Promise<LogInByTokenRes>;
-export declare const logInUser: (email: string, password: string) => Promise<LogInByCredentials>;
-export declare const updateUserService: (user: User) => Promise<User>;
-export declare const logOutService: (authToken: string) => Promise<unknown>;

package/build/src/services/auth/auth.service.types.d.ts

@@ -1,8 +0,0 @@
-import { User } from "../../types/user.types";
-declare type LogInRes = {
-    token: string;
-    user: User;
-};
-export declare type LogInByTokenRes = LogInRes;
-export declare type LogInByCredentials = LogInRes;
-export {};

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

@@ -1,12 +0,0 @@
-export interface User {
-    id: string;
-    name: string;
-    lastName: string;
-    email: string;
-    phone?: string;
-    rol: UserRol;
-}
-export declare enum UserRol {
-    ADMIN = "Admin",
-    VIEWER = "Viewer"
-}

package/build/src/utils/axios.d.ts

@@ -1,2 +0,0 @@
-declare const axiosDefault: import("axios").AxiosInstance;
-export default axiosDefault;