@artisan-commerce/products 0.9.0-canary.28 → 0.9.0-canary.3

package/CHANGELOG.md

@@ -3,211 +3,6 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [0.9.0-canary.28](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.27...@artisan-commerce/products@0.9.0-canary.28) (2021-10-21)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.27](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.26...@artisan-commerce/products@0.9.0-canary.27) (2021-10-21)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.26](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.25...@artisan-commerce/products@0.9.0-canary.26) (2021-10-20)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.25](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.24...@artisan-commerce/products@0.9.0-canary.25) (2021-10-19)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.24](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.23...@artisan-commerce/products@0.9.0-canary.24) (2021-10-18)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.23](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.22...@artisan-commerce/products@0.9.0-canary.23) (2021-10-14)
-
-
-### Bug Fixes
-
-* **global:** make export not module by default ([4e701b1](https://bitbucket.org/tradesystem/artisn_sdk/commit/4e701b1b59df89cf8358cf500984b1c2c4f42c60))
-
-
-
-## [0.9.0-canary.22](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.21...@artisan-commerce/products@0.9.0-canary.22) (2021-10-14)
-
-
-### Bug Fixes
-
-* **global:** fix some payment types ([8000970](https://bitbucket.org/tradesystem/artisn_sdk/commit/80009700cd8664828b1236e8ad7cc90ce2fcb3e7))
-
-
-
-## [0.9.0-canary.21](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.20...@artisan-commerce/products@0.9.0-canary.21) (2021-10-14)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.20](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.19...@artisan-commerce/products@0.9.0-canary.20) (2021-10-13)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.19](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.18...@artisan-commerce/products@0.9.0-canary.19) (2021-10-05)
-
-
-### Bug Fixes
-
-* **global:** fix ProductDetail builder and update its types ([cdc6cf9](https://bitbucket.org/tradesystem/artisn_sdk/commit/cdc6cf9ed2e7ff1a340bc691b0dc1156bc682d38))
-
-
-
-## [0.9.0-canary.18](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.17...@artisan-commerce/products@0.9.0-canary.18) (2021-10-04)
-
-
-### Features
-
-* **global:** update registerModifiersForm function, control state error ([c3534cf](https://bitbucket.org/tradesystem/artisn_sdk/commit/c3534cf2eac5f7d90176888ad5b6dd575998e2f1))
-
-
-
-## [0.9.0-canary.17](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.16...@artisan-commerce/products@0.9.0-canary.17) (2021-10-01)
-
-
-### Bug Fixes
-
-* **global:** fix firebase related types ([efa5081](https://bitbucket.org/tradesystem/artisn_sdk/commit/efa5081a844be033ac9135ac65bf8f56184b71b0))
-
-
-
-## [0.9.0-canary.16](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.15...@artisan-commerce/products@0.9.0-canary.16) (2021-09-30)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.15](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.14...@artisan-commerce/products@0.9.0-canary.15) (2021-09-30)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.14](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.13...@artisan-commerce/products@0.9.0-canary.14) (2021-09-23)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.13](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.12...@artisan-commerce/products@0.9.0-canary.13) (2021-09-21)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.12](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.11...@artisan-commerce/products@0.9.0-canary.12) (2021-09-17)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.11](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.10...@artisan-commerce/products@0.9.0-canary.11) (2021-08-25)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.10](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.9...@artisan-commerce/products@0.9.0-canary.10) (2021-08-25)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.9](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.8...@artisan-commerce/products@0.9.0-canary.9) (2021-08-24)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.8](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.7...@artisan-commerce/products@0.9.0-canary.8) (2021-08-23)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.7](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.6...@artisan-commerce/products@0.9.0-canary.7) (2021-08-23)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.6](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.5...@artisan-commerce/products@0.9.0-canary.6) (2021-08-12)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.5](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.4...@artisan-commerce/products@0.9.0-canary.5) (2021-08-12)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
-## [0.9.0-canary.4](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.3...@artisan-commerce/products@0.9.0-canary.4) (2021-08-12)
-
-**Note:** Version bump only for package @artisan-commerce/products
-
-
-
-
-
 ## [0.9.0-canary.3](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/products@0.9.0-canary.2...@artisan-commerce/products@0.9.0-canary.3) (2021-08-12)
 
 

package/build/config/constants.d.ts

@@ -0,0 +1,12 @@
+import { Filters } from "../types/http.types";
+declare const CONSTANTS: {
+    HEADERS: string[];
+    FILTERS: (keyof Filters)[];
+    GROUPS: "category"[];
+    ORDER_FIELDS: string[];
+    ORDER_TYPES: (import("../types/http.types").ORDER_TYPES | undefined)[];
+    ORDER_METHODS: ("asc" | "desc" | undefined)[];
+    PAGINATION: string[];
+    ADDITIONAL_FILTERS: string[];
+};
+export default CONSTANTS;

package/build/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/index.d.ts

@@ -0,0 +1,17 @@
+import * as transformers from "./utils/transformers/transformers.utils";
+import * as assertions from "./utils/assertions/assertions.utils";
+import * as modifierUtils from "./utils/questionsAndAnswers/questionsAndAnswers.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 { registerModifiersForm } from "./lib/registerModifiersForm/registerModifiersForm";
+export { validateProduct } from "./lib/validateProduct/validateProduct";
+export { initProducts, closeProducts } from "./lib/initProducts/initProducts";
+export { getProductTotals } from "./utils/calculations/calculations.utils";
+export { transformers, assertions, modifierUtils };
+export type { ModifierGroupRenderer } from "./types/modifiers.types";
+export type { ModifierRenderer } from "./types/modifiers.types";
+export type { ModifiersForm } from "./lib/registerModifiersForm/registerModifiersForm.types";

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

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

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

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

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

@@ -0,0 +1,10 @@
+import { FetchProductDetailsConfig } from "./getProductDetails.types";
+export declare const getProductDetails: (productId: number | string, config: FetchProductDetailsConfig) => Promise<{
+    pagination: import("../../types/http.types").PaginationResponse;
+    data: unknown;
+    error: string | import("@artisan-commerce/cache/build/types/http.types").ResponseError | undefined;
+    hints: {
+        [key: string]: string | number | undefined;
+    };
+    config: import("@artisan-commerce/types").ArtisnRequest;
+}>;

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

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

package/build/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/lib/getProducts/getProducts.d.ts

@@ -0,0 +1,11 @@
+import { FetchProductsConfig } from "./getProducts.types";
+import { BaseProduct, CategoryWithProducts } from "@artisan-commerce/types";
+export declare const getProducts: <R extends BaseProduct[] | CategoryWithProducts[] = BaseProduct[]>(config: FetchProductsConfig) => Promise<{
+    pagination: import("../../types/http.types").PaginationResponse;
+    data: unknown;
+    error: string | import("@artisan-commerce/cache/build/types/http.types").ResponseError | undefined;
+    hints: {
+        [key: string]: string | number | undefined;
+    };
+    config: import("@artisan-commerce/types").ArtisnRequest;
+}>;

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,16 @@
+import { FetchStoreDetailsConfig } from "./getStoreDetails.types";
+/**
+ * Fetches all categories and products from the given store
+ *
+ * @param config config to fetch the store details
+ * @deprecated
+ */
+export declare const getStoreDetails: (config: FetchStoreDetailsConfig) => Promise<{
+    pagination: import("../../types/http.types").PaginationResponse;
+    data: unknown;
+    error: string | import("@artisan-commerce/cache/build/types/http.types").ResponseError | undefined;
+    hints: {
+        [key: string]: string | number | undefined;
+    };
+    config: import("@artisan-commerce/types").ArtisnRequest;
+}>;

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

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

package/build/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/lib/initProducts/initProducts.d.ts

@@ -0,0 +1,14 @@
+import { ArtisnApp } from "@artisan-commerce/types";
+import { InitProductsConfig } from "../../types/common.types";
+/**
+ * Initialize products metadata, stores initial global state for future needs.
+ * @since 1.0
+ * @param artisnApp: An artisn initialized app.
+ * @param config: Global products state that can be configure at the function call level
+ */
+export declare const initProducts: (artisnApp: ArtisnApp, config?: InitProductsConfig) => void;
+/**
+ * Closes all conections and resets the library to its default state
+ * @since 1.0
+ */
+export declare const closeProducts: () => void;

package/build/lib/registerModifiersForm/registerModifiersForm.d.ts

@@ -0,0 +1,21 @@
+import { Product } from "@artisan-commerce/types";
+import { ModifiersFormCallback } from "./registerModifiersForm.types";
+import { ModifiersFormUnsuscriber } from "./registerModifiersForm.types";
+/**
+ * Creates a product modifiers form listener that handles the input change
+ * events automatically.
+ *
+ * @param {Product} product The product that will be listened
+ * @param {ModifiersFormCallback} callback Returns a snapshot of the current
+ * state of the form
+ * @returns {ModifiersFormUnsuscriber} Returns a function that when called it
+ * stops listening to the form
+ */
+export declare const registerModifiersForm: (product: Product, callback: ModifiersFormCallback) => ModifiersFormUnsuscriber;
+/**
+ * Function that when called it stops listening to the form.
+ *
+ * @param {string} productId The id of the product that will be deleted from the
+ * form
+ */
+export declare const unsuscriber: (productId: Product["productId"]) => void;

package/build/lib/registerModifiersForm/registerModifiersForm.test.d.ts

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

package/build/lib/registerModifiersForm/registerModifiersForm.types.d.ts

@@ -0,0 +1,34 @@
+import { CartProduct } from "@artisan-commerce/types";
+import { ValidateRenderer } from "../validateProduct/validateProduct.types";
+import { ModifierTypes, RendererStatus } from "../../types/modifiers.types";
+import { ModifierGroupRenderer } from "../../types/modifiers.types";
+export interface ModifiersForm {
+    renderer: ModifierGroupRenderer[];
+    product: CartProduct;
+    validate: ValidateRenderer;
+    status: RendererStatus;
+}
+export interface ModifiersFormInternal extends ModifiersForm {
+    callback: ModifiersFormCallback;
+}
+export declare type ModifiersFormCallback = (form: ModifiersForm) => void;
+export declare type ModifiersFormUnsuscriber = () => void;
+export declare type HandleChangeFunction = (amount: number) => void;
+export interface BuildModifierRendererConfig {
+    rootId: string;
+    min: number;
+    max: number;
+    type: ModifierTypes;
+    modifiersCount: number;
+    amount: number;
+    path: string[];
+}
+export interface BuildModifierGroupConfig {
+    amount: number;
+    rootId: string;
+    path: string[];
+}
+export interface BuildRendererConfig {
+    rootId: string;
+    path: string[];
+}

package/build/lib/validateProduct/validateProduct.d.ts

@@ -0,0 +1,7 @@
+import { Product } from "@artisan-commerce/types";
+import { RendererStatus } from "../../types/modifiers.types";
+import { ModifierGroupRenderer } from "../../types/modifiers.types";
+import { ModifierRenderer } from "../../types/modifiers.types";
+export declare const validateProduct: (productId: Product["productId"]) => RendererStatus;
+export declare const validateChildModifiers: (group: ModifierGroupRenderer, renderer: ModifierGroupRenderer[], productId: Product["productId"], path: string[]) => ModifierGroupRenderer[];
+export declare const validateChildGroups: (modifier: ModifierRenderer, renderer: ModifierGroupRenderer[], productId: Product["productId"], path: string[]) => ModifierGroupRenderer[];

package/build/lib/validateProduct/validateProduct.test.d.ts

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

package/build/lib/validateProduct/validateProduct.types.d.ts

@@ -0,0 +1,2 @@
+import { RendererStatus } from "../../types/modifiers.types";
+export declare type ValidateRenderer = () => RendererStatus;