@artisan-commerce/products 0.0.2

package/README.md

@@ -0,0 +1,93 @@
+## Node Library Boilerplate
+
+This boilerplate was made to facilitate the creation of server-side or client-side node application. It comes with a powerful webpack & typescript configuration out of the box.
+
+## New Project Configuration steps:
+
+1. Change your project name and description in package.json.
+1. Change default constants value in `src/config/constants.ts`.
+1. In .env.[ENV] change the ENV variable to the environment you are currently developing for.
+1. If you want to support the require syntax instead of import, change the module field in the tsconfig.json file to commonjs
+1. Update the readme.md file
+
+## File Structure
+
+General representation of the building pieces
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.<br>
+
+### `npm dev`
+
+Alias of npm start, for some developers convinience.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.<br>
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run test:all`
+
+Run every test in a none interactive mode and create a coverage report.
+
+This command is perfect for pre push hooks.
+
+### `npm run test:ci`
+
+Simulates a CI environment before running all tests
+
+### `npm run check-types`
+
+Will attempt to compile the whole project including test files that are normally excluded.
+
+This command is perfect for verifing the project's integrity before commiting changes
+
+### `npm run lint`
+
+Runs the configured linter to check for any lints in your code before deploying, developers must clean any lint before commiting or commints will not go through.
+
+### `npm run prettier`
+
+Configure prettier, the files that should be included and excluded. This command should not be used by itself.
+
+### `npm run format`
+
+Uses the prettier configuration to run prettier in write mode to all selected files. It will fix all format errors.
+
+### `npm run check-format`
+
+Uses the prettier configuration to run prettier in read mode to all selected files. If any is bad formated, it will display a warning.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.<br>
+It correctly bundles the project in production mode and optimizes the build for the best performance.
+
+### `npm run validate`
+
+It validates the integrity of the project by running many of the static testing, unit/integration testing and e2e testing commands.
+
+### `npm run validate:ci`
+
+Run a different series of commands than validate, the selected commands that are run are the ones appropiate to be run on CI. This command is not met to be run locally.
+
+## Publishing your library
+
+To publish your library you will only need to run `npm publish`. We will take care of the rest. Things like creating a new build of your code will be done automatically. Just take into consideration to bump the project version following the semver methodology.
+
+## Previewing your library
+
+When you are in the middle of the development of your new library, you find your self needing to test the current features you are developing. We recommend using `npm link` and a separte project for those purposes.
+
+If you want to test your app on a real app, then we recommend using `npm publish`. This method should be avoided during development.
+
+> ### Hope you are enjoying this boilerplate
+>
+> We are happy to add/update any additional request you may have. For intering ideas, please submit a new issue and we will take care of it.
+>
+> Happy coding! 🚀

package/build/main.bundle.js

@@ -0,0 +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=13)}([function(e,t,r){"use strict";var n=this&&this.__createBinding||(Object.create?function(e,t,r,n){void 0===n&&(n=r),Object.defineProperty(e,n,{enumerable:!0,get:function(){return t[r]}})}:function(e,t,r,n){void 0===n&&(n=r),e[n]=t[r]}),o=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||t.hasOwnProperty(r)||n(t,e,r)};Object.defineProperty(t,"__esModule",{value:!0}),o(r(1),t),o(r(2),t),o(r(3),t),o(r(4),t),o(r(5),t),o(r(6),t),o(r(7),t),o(r(8),t),o(r(9),t),o(r(10),t),o(r(11),t)},function(e,t,r){"use strict";Object.defineProperty(t,"__esModule",{value:!0})},function(e,t,r){"use strict";Object.defineProperty(t,"__esModule",{value:!0})},function(e,t,r){"use strict";Object.defineProperty(t,"__esModule",{value:!0})},function(e,t,r){"use strict";Object.defineProperty(t,"__esModule",{value:!0})},function(e,t,r){"use strict";Object.defineProperty(t,"__esModule",{value:!0})},function(e,t,r){"use strict";Object.defineProperty(t,"__esModule",{value:!0})},function(e,t,r){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.QuestionTypes=t.DayOfWeekName=t.TaxType=t.PriceCategoryType=t.ProductType=void 0,function(e){e.PRODUCT="PRODUCT",e.MODIFIER="MODIFIER"}(t.ProductType||(t.ProductType={})),function(e){e.NORMAL="NORMAL",e.POINTS="POINTS"}(t.PriceCategoryType||(t.PriceCategoryType={})),function(e){e.IVA="IVA"}(t.TaxType||(t.TaxType={})),function(e){e.MONDAY="MONDAY",e.TUESDAY="TUESDAY",e.WEDNESDAY="WEDNESDAY",e.THURSDAY="THURSDAY",e.FRIDAY="FRIDAY",e.SATURDAY="SATURDAY",e.SUNDAY="SUNDAY"}(t.DayOfWeekName||(t.DayOfWeekName={})),function(e){e.BOOLEAN="BOOLEAN",e.RADIO="RADIO",e.CHECKBOX="CHECKBOX",e.QUANTITY="QUANTITY"}(t.QuestionTypes||(t.QuestionTypes={}))},function(e,t,r){"use strict";Object.defineProperty(t,"__esModule",{value:!0})},function(e,t,r){"use strict";Object.defineProperty(t,"__esModule",{value:!0})},function(e,t,r){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.ServiceStatus=t.Days=t.DeliveryTimeUnit=void 0,function(e){e.MIN="min"}(t.DeliveryTimeUnit||(t.DeliveryTimeUnit={})),function(e){e.MONDAY="MONDAY",e.TUESDAY="TUESDAY",e.WEDNESDAY="WEDNESDAY",e.THURSDAY="THURSDAY",e.FRIDAY="FRIDAY",e.SATURDAY="SATURDAY",e.SUNDAY="SUNDAY",e.SPECIAL="SPECIAL"}(t.Days||(t.Days={})),function(e){e.INACTIVE="INACTIVE",e.ACTIVE="ACTIVE"}(t.ServiceStatus||(t.ServiceStatus={}))},function(e,t,r){"use strict";Object.defineProperty(t,"__esModule",{value:!0})},,function(e,t,r){"use strict";r.r(t),r.d(t,"getProductTotals",(function(){return l})),r.d(t,"transformers",(function(){return o})),r.d(t,"assertions",(function(){return n}));var n={};r.r(n),r.d(n,"isBaseProduct",(function(){return c})),r.d(n,"isProductDetails",(function(){return s})),r.d(n,"isCartProduct",(function(){return a}));var o={};r.r(o),r.d(o,"toCartProduct",(function(){return d}));var u=r(0),i=function(e){return Object.keys(e)},c=function(e){var t=e.attributes,r=e.available,n=e.description,o=e.name,c=e.images,s=e.prices,a=e.productId,f=e.sponsored,d=e.status,y=e.type;return"boolean"==typeof t.showInMenu&&("boolean"==typeof r&&("boolean"==typeof f&&("string"==typeof n&&("string"==typeof o&&("number"==typeof a&&(!("object"!=typeof s||"object"==typeof s&&Object.keys(s).length<1)&&(!!Array.isArray(c)&&(("ACTIVE"===d||"INACTIVE"===d)&&!!i(u.ProductType).includes(y)))))))))},s=function(e){if(!c(e))return!1;var t=e.isPriceVip,r=e.manufacturer,n=e.maxAmountForSale,o=e.schedule,u=e.questions;return"boolean"==typeof t&&(!!Array.isArray(r)&&("number"==typeof n&&(!!Array.isArray(o)&&!!Array.isArray(u))))},a=function(e){if(!s(e))return!1;var t=e.hash,r=e.createdAt,n=e.updatedAt,o=e.alerts,c=e.amount,a=e.priceCategory,f=e.comment,d=e.questionsAndAnswers;return"string"==typeof t&&("string"==typeof r&&("string"==typeof n&&(!!Array.isArray(o)&&("number"==typeof c&&("string"==typeof f&&(!!i(u.PriceCategoryType).includes(a)&&!!Array.isArray(d)))))))},f=function(){return(f=Object.assign||function(e){for(var t,r=1,n=arguments.length;r<n;r++)for(var o in t=arguments[r])Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o]);return e}).apply(this,arguments)},d=function(e,t){if(void 0===t&&(t={}),a(e))return f(f({},e),t);if(s(e))return y(e,t);var r=p(e);return y(r,t)},y=function(e,t){return void 0===t&&(t={}),f(f(f({},e),{questionsAndAnswers:[],amount:0,priceCategory:u.PriceCategoryType.NORMAL,comment:"",alerts:[],hash:"",createdAt:"",updatedAt:""}),t)},p=function(e,t){return void 0===t&&(t={}),f(f(f({},e),{isPriceVip:!1,manufacturer:[],maxAmountForSale:0,questions:[],schedule:[]}),t)},l=function(e){return{grossPrice:O(e),totalDiscounts:T(e),totalTaxes:A(e),netPrice:v(e)}},A=function(e){var t=d(e),r=t.prices,n=t.amount,o=t.priceCategory,u=r[o],i=u.taxes,c=u.grossPrice,s=P(i,c);return t.questionsAndAnswers.reduce((function(e,t){return e+t.answers.reduce((function(e,t){var r=t.prices,n=t.amount,u=r[o],i=u.taxes,c=u.grossPrice;return e+n*P(i,c)}),0)}),0)+s*n},O=function(e){return D(e,"grossPrice")},T=function(e){return 0},v=function(e){return D(e,"netPrice")},D=function(e,t){var r=d(e),n=r.prices,o=r.amount,u=r.priceCategory,i=n[u][t];return r.questionsAndAnswers.reduce((function(e,r){return e+r.answers.reduce((function(e,r){var n=r.prices;return e+r.amount*n[u][t]}),0)}),0)+i*o},P=function(e,t){return e.reduce((function(e,r){return e+r.percentage/100*t}),0)}}])}));

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

@@ -0,0 +1,23 @@
+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

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

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

@@ -0,0 +1,13 @@
+declare const CONSTANTS: {
+    CLIENT_NAME: string;
+    DEFAULT_REQUEST_TIMEOUT: number;
+    EXCLUDED_LOGGER_STATUS_CODES: number[];
+    INCLUDED_LOGGER_ENVS: string[];
+    INCLUDED_INTL_LOG_ENVS: string[];
+    COUNTRY: {
+        NAME: string;
+        CODE: string;
+        LANGUAGE: string;
+    };
+};
+export default CONSTANTS;

package/build/src/index.d.ts

@@ -0,0 +1,4 @@
+import * as transformers from "./utils/transformers/transformers.utils";
+import * as assertions from "./utils/assertions/assertions.utils";
+export { getProductTotals } from "./utils/caculations/calculations.utils";
+export { transformers, assertions };

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

@@ -0,0 +1 @@
+export declare const sum: (a: number, b: number) => number;

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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,12 @@
+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/assertions/assertions.utils.d.ts

@@ -0,0 +1,6 @@
+import { BaseProduct } from "@artisan-commerce/types";
+import { ProductDetails } from "@artisan-commerce/types";
+import { CartProduct } from "@artisan-commerce/types";
+export declare const isBaseProduct: (product: BaseProduct) => boolean;
+export declare const isProductDetails: (product: ProductDetails) => boolean;
+export declare const isCartProduct: (product: CartProduct) => boolean;

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

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

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

@@ -0,0 +1,2 @@
+declare let bugsnagClient: any;
+export default bugsnagClient;

package/build/src/utils/caculations/calculations.utils.d.ts

@@ -0,0 +1,17 @@
+import { Product, PriceCategoryTax } from "@artisan-commerce/types";
+import { ProductTotals } from "./calculations.utils.types";
+/**
+ * Get a summary of all price totals of a given product
+ *
+ * @author Luis Eduardo Andrade, John Arias
+ * @since 1.0
+ * @param product the product that will be calculated
+ * @returns an object with a summary of the prodcut totals
+ */
+export declare const getProductTotals: (product: Product) => ProductTotals;
+export declare const getProductTotalTaxes: (product: Product) => number;
+export declare const getProductGrossPrice: (product: Product) => number;
+export declare const getProductTotalDiscounts: (product: Product) => number;
+export declare const getProductNetPrice: (product: Product) => number;
+export declare const getProductFieldPrice: (product: Product, field: "grossPrice" | "netPrice") => number;
+export declare const getTaxTotal: (taxes: PriceCategoryTax[], grossPrice: number) => number;

package/build/src/utils/caculations/calculations.utils.test.d.ts

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

package/build/src/utils/caculations/calculations.utils.types.d.ts

@@ -0,0 +1,6 @@
+export interface ProductTotals {
+    grossPrice: number;
+    totalDiscounts: number;
+    totalTaxes: number;
+    netPrice: number;
+}

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

@@ -0,0 +1,2 @@
+export declare const stringIsNumber: (value: string) => boolean;
+export declare const enumToArray: (enumObj: any) => string[];

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

@@ -0,0 +1,2 @@
+import { Product, CartProduct } from "@artisan-commerce/types";
+export declare const toCartProduct: (product: Product, overrides?: Partial<CartProduct>) => CartProduct;

package/build/src/vendors.d.ts

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

package/build/vendors.bundle.js

@@ -0,0 +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){}})}));

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "@artisan-commerce/products",
+  "description": "Artisan's product management library",
+  "version": "0.0.2",
+  "main": "./build/main.bundle.js",
+  "types": "./build/src/index.d.ts",
+  "files": [
+    "build/",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "start": "webpack --config webpack.dev.js",
+    "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:all": "npm run test -- --watchAll=false --coverage",
+    "test:ci": "cross-env CI=true jest --runInBand --passWithNoTests",
+    "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 .",
+    "lint:staged": "npm run lint --max-warnings=0",
+    "prettier": "prettier --ignore-path .gitignore \"**/*.+(js|jsx|ts|tsx|json|css|scss|html)\"",
+    "format": "npm run prettier -- --write",
+    "check-format": "npm run prettier -- --list-different",
+    "validate": "cross-env CI=true npm-run-all --parallel test:ci check-types check-format lint build",
+    "validate:ci": "npm-run-all --parallel check-types check-format lint",
+    "prepare": "npm run build"
+  },
+  "author": "Luis Eduardo Andrade",
+  "license": "MIT",
+  "dependencies": {
+    "@artisan-commerce/builders": "^0.1.1",
+    "@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"
+  },
+  "devDependencies": {
+    "@artisan-commerce/types": "^0.2.0",
+    "@babel/core": "^7.10.5",
+    "@babel/preset-env": "^7.10.4",
+    "@babel/preset-react": "^7.10.4",
+    "@types/faker": "^4.1.12",
+    "@types/jest": "^26.0.5",
+    "@types/jest-in-case": "^1.0.2",
+    "@types/node": "^14.0.24",
+    "@typescript-eslint/eslint-plugin": "^3.7.0",
+    "@typescript-eslint/parser": "^3.7.0",
+    "avn": "^0.2.4",
+    "avn-nvm": "^0.2.2",
+    "clean-webpack-plugin": "^3.0.0",
+    "cross-env": "^7.0.2",
+    "dotenv-webpack": "^2.0.0",
+    "env-cmd": "^10.1.0",
+    "eslint": "^7.5.0",
+    "eslint-config-prettier": "^6.11.0",
+    "eslint-config-react-app": "^5.2.1",
+    "eslint-config-universe": "^4.0.0",
+    "eslint-plugin-cypress": "^2.11.1",
+    "eslint-plugin-flowtype": "^5.2.0",
+    "eslint-plugin-import": "^2.22.0",
+    "eslint-plugin-jsx-a11y": "^6.3.1",
+    "eslint-plugin-react": "^7.20.3",
+    "eslint-plugin-react-hooks": "^4.0.8",
+    "is-ci-cli": "^2.1.2",
+    "jest": "^24.9.0",
+    "jest-axe": "^3.5.0",
+    "jest-in-case": "^1.0.2",
+    "jest-styled-components": "^7.0.2",
+    "nodemon": "^2.0.4",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.1.2",
+    "start-server-and-test": "^1.11.2",
+    "test-data-bot": "^0.8.0",
+    "ts-jest": "^26.1.4",
+    "ts-loader": "^8.0.2",
+    "typescript": "^3.9.7",
+    "webpack": "^4.43.0",
+    "webpack-cli": "^3.3.12",
+    "webpack-dev-server": "^3.11.0",
+    "webpack-merge": "^5.0.9"
+  },
+  "gitHead": "720bb9d861c9897cbe82400f4b8a1847b840c958"
+}