@artisan-commerce/builders 0.7.0-canary.39 → 0.7.0-canary.4

package/CHANGELOG.md

@@ -3,312 +3,6 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [0.7.0-canary.39](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.38...@artisan-commerce/builders@0.7.0-canary.39) (2022-03-07)
-
-**Note:** Version bump only for package @artisan-commerce/builders
-
-
-
-
-
-## [0.7.0-canary.38](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.37...@artisan-commerce/builders@0.7.0-canary.38) (2022-02-03)
-
-
-### Features
-
-* **benefit:** add handle to discount_fixed ([b2f2381](https://bitbucket.org/tradesystem/artisn_sdk/commit/b2f23811e8a54018f4056f9d8593d035f86dd499))
-* **benefit:** update applyBenefit service ([d393665](https://bitbucket.org/tradesystem/artisn_sdk/commit/d393665edd5de83002d95e7e52a301c1e3631704))
-
-
-
-## [0.7.0-canary.37](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.36...@artisan-commerce/builders@0.7.0-canary.37) (2022-01-14)
-
-
-### Bug Fixes
-
-* **artisn:** delete base64 key ([95cda3c](https://bitbucket.org/tradesystem/artisn_sdk/commit/95cda3c4209f6057c4fe6a8aa847e750faf68a21))
-
-
-
-## [0.7.0-canary.36](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.35...@artisan-commerce/builders@0.7.0-canary.36) (2022-01-06)
-
-
-### Bug Fixes
-
-* **artisn:** fix order builder ([99de539](https://bitbucket.org/tradesystem/artisn_sdk/commit/99de53900afcfb09ee45eb26a7a8ac0dc38c2078))
-
-
-
-## [0.7.0-canary.35](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.34...@artisan-commerce/builders@0.7.0-canary.35) (2021-12-28)
-
-**Note:** Version bump only for package @artisan-commerce/builders
-
-
-
-
-
-## [0.7.0-canary.34](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.33...@artisan-commerce/builders@0.7.0-canary.34) (2021-12-15)
-
-**Note:** Version bump only for package @artisan-commerce/builders
-
-
-
-
-
-## [0.7.0-canary.33](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.32...@artisan-commerce/builders@0.7.0-canary.33) (2021-12-13)
-
-
-### Bug Fixes
-
-* **global:** fix types and builder for order store ([35286a9](https://bitbucket.org/tradesystem/artisn_sdk/commit/35286a92e5e3df2fe5b3cfa5f289a0e321a24128))
-
-
-
-## [0.7.0-canary.32](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.31...@artisan-commerce/builders@0.7.0-canary.32) (2021-12-01)
-
-
-### Features
-
-* **global:** update and add types and builders for notifications ([5d6902b](https://bitbucket.org/tradesystem/artisn_sdk/commit/5d6902ba54a84d14a783b5bcda3381ec68a1e636))
-
-
-
-## [0.7.0-canary.31](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.30...@artisan-commerce/builders@0.7.0-canary.31) (2021-11-09)
-
-
-### Bug Fixes
-
-* **builders:** add width and height to coupon detail ([4c63fa0](https://bitbucket.org/tradesystem/artisn_sdk/commit/4c63fa08ad450d22cfc6f31c5783e850b12570e2))
-
-
-
-## [0.7.0-canary.30](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.29...@artisan-commerce/builders@0.7.0-canary.30) (2021-11-05)
-
-
-### Features
-
-* **global:** fix types and builders for store coupon and add condition to shipping cost ([2800a87](https://bitbucket.org/tradesystem/artisn_sdk/commit/2800a87a326c9f0ca5e0f1fbe202e15768fc32c9))
-
-
-
-## [0.7.0-canary.29](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.28...@artisan-commerce/builders@0.7.0-canary.29) (2021-10-27)
-
-
-### Bug Fixes
-
-* **global:** move buffer dependency from global to builders package ([6ce5afd](https://bitbucket.org/tradesystem/artisn_sdk/commit/6ce5afd67002b617845089885a0e139ec821ef6d))
-
-
-
-## [0.7.0-canary.28](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.27...@artisan-commerce/builders@0.7.0-canary.28) (2021-10-22)
-
-
-### Bug Fixes
-
-* **builders:** remove warning when using random from faker ([b914f7c](https://bitbucket.org/tradesystem/artisn_sdk/commit/b914f7cd501649bcfc7846efc1b38b279becb975))
-
-
-
-## [0.7.0-canary.27](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.26...@artisan-commerce/builders@0.7.0-canary.27) (2021-10-22)
-
-
-### Features
-
-* **global:** add interfaces, functions and services for store coupons ([7e8a959](https://bitbucket.org/tradesystem/artisn_sdk/commit/7e8a95998982e8c8b892b61eb709e98ac7671a09))
-* **global:** add missing interface and docs ([e7fca2f](https://bitbucket.org/tradesystem/artisn_sdk/commit/e7fca2f5a608a592380b8cd9aafab04cc32ce13d))
-
-
-
-## [0.7.0-canary.26](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.25...@artisan-commerce/builders@0.7.0-canary.26) (2021-10-21)
-
-**Note:** Version bump only for package @artisan-commerce/builders
-
-
-
-
-
-## [0.7.0-canary.25](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.24...@artisan-commerce/builders@0.7.0-canary.25) (2021-10-21)
-
-**Note:** Version bump only for package @artisan-commerce/builders
-
-
-
-
-
-## [0.7.0-canary.24](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.23...@artisan-commerce/builders@0.7.0-canary.24) (2021-10-20)
-
-**Note:** Version bump only for package @artisan-commerce/builders
-
-
-
-
-
-## [0.7.0-canary.23](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.22...@artisan-commerce/builders@0.7.0-canary.23) (2021-10-19)
-
-
-### Bug Fixes
-
-* **global:** add interfaces and builders for order ([53d18b0](https://bitbucket.org/tradesystem/artisn_sdk/commit/53d18b07c53fa54f9af69a0751b94a95452bfdc3))
-* **global:** fix tax calculation builder ([3f7698f](https://bitbucket.org/tradesystem/artisn_sdk/commit/3f7698f1cfdf97e2b8d8fa4040b70a7cfa150b74))
-
-
-
-## [0.7.0-canary.22](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.21...@artisan-commerce/builders@0.7.0-canary.22) (2021-10-18)
-
-
-### Bug Fixes
-
-* **global:** fix aritsn-rn package ([b18d632](https://bitbucket.org/tradesystem/artisn_sdk/commit/b18d632d539bf1e748c1d5f83e4bc73747a7e467))
-
-
-
-## [0.7.0-canary.21](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.20...@artisan-commerce/builders@0.7.0-canary.21) (2021-10-14)
-
-
-### Bug Fixes
-
-* **global:** make export not module by default ([4e701b1](https://bitbucket.org/tradesystem/artisn_sdk/commit/4e701b1b59df89cf8358cf500984b1c2c4f42c60))
-
-
-
-## [0.7.0-canary.20](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.19...@artisan-commerce/builders@0.7.0-canary.20) (2021-10-14)
-
-
-### Bug Fixes
-
-* **global:** fix some payment types ([8000970](https://bitbucket.org/tradesystem/artisn_sdk/commit/80009700cd8664828b1236e8ad7cc90ce2fcb3e7))
-
-
-
-## [0.7.0-canary.19](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.18...@artisan-commerce/builders@0.7.0-canary.19) (2021-10-14)
-
-**Note:** Version bump only for package @artisan-commerce/builders
-
-
-
-
-
-## [0.7.0-canary.18](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.17...@artisan-commerce/builders@0.7.0-canary.18) (2021-10-13)
-
-
-### Features
-
-* **global:** fix builder and types to adjust better to reality ([11cdb93](https://bitbucket.org/tradesystem/artisn_sdk/commit/11cdb93199d5a57d12f5aa6f7ece17f0c38c0521))
-* **global:** fix unnecessary params on functions and add docs ([3830d7d](https://bitbucket.org/tradesystem/artisn_sdk/commit/3830d7d8b0044ca580bcbcc4acd0b0ea5a8b0266))
-
-
-
-## [0.7.0-canary.17](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.16...@artisan-commerce/builders@0.7.0-canary.17) (2021-10-05)
-
-
-### Bug Fixes
-
-* **global:** fix ProductDetail builder and update its types ([cdc6cf9](https://bitbucket.org/tradesystem/artisn_sdk/commit/cdc6cf9ed2e7ff1a340bc691b0dc1156bc682d38))
-
-
-
-## [0.7.0-canary.16](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.15...@artisan-commerce/builders@0.7.0-canary.16) (2021-10-01)
-
-**Note:** Version bump only for package @artisan-commerce/builders
-
-
-
-
-
-## [0.7.0-canary.15](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.14...@artisan-commerce/builders@0.7.0-canary.15) (2021-09-30)
-
-**Note:** Version bump only for package @artisan-commerce/builders
-
-
-
-
-
-## [0.7.0-canary.14](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.13...@artisan-commerce/builders@0.7.0-canary.14) (2021-09-30)
-
-**Note:** Version bump only for package @artisan-commerce/builders
-
-
-
-
-
-## [0.7.0-canary.13](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.12...@artisan-commerce/builders@0.7.0-canary.13) (2021-09-23)
-
-
-### Bug Fixes
-
-* **global:** update types of CDNImage, reduce the depth of product questions ([82dba32](https://bitbucket.org/tradesystem/artisn_sdk/commit/82dba324457455e6cd2d76091aaffaef5f540d9f))
-
-
-
-## [0.7.0-canary.12](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.11...@artisan-commerce/builders@0.7.0-canary.12) (2021-09-21)
-
-
-### Bug Fixes
-
-* **global:** fix product details and settings builders ([5452fc9](https://bitbucket.org/tradesystem/artisn_sdk/commit/5452fc9d70ff3fa9f859ed4a665fd933e133c7ce))
-
-
-
-## [0.7.0-canary.11](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.10...@artisan-commerce/builders@0.7.0-canary.11) (2021-09-17)
-
-
-### Features
-
-* **global:** add categories property to product details interface ([0d95d09](https://bitbucket.org/tradesystem/artisn_sdk/commit/0d95d093383673322369b0870af290182bb57cb8))
-
-
-
-## [0.7.0-canary.10](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.9...@artisan-commerce/builders@0.7.0-canary.10) (2021-08-25)
-
-**Note:** Version bump only for package @artisan-commerce/builders
-
-
-
-
-
-## [0.7.0-canary.9](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.8...@artisan-commerce/builders@0.7.0-canary.9) (2021-08-25)
-
-**Note:** Version bump only for package @artisan-commerce/builders
-
-
-
-
-
-## [0.7.0-canary.8](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.7...@artisan-commerce/builders@0.7.0-canary.8) (2021-08-24)
-
-**Note:** Version bump only for package @artisan-commerce/builders
-
-
-
-
-
-## [0.7.0-canary.7](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.6...@artisan-commerce/builders@0.7.0-canary.7) (2021-08-23)
-
-
-### Bug Fixes
-
-* **global:** add missing properties to order interfaces and types ([757157f](https://bitbucket.org/tradesystem/artisn_sdk/commit/757157fbb2dd25d04efc791cd9b9511e41685471))
-
-
-
-## [0.7.0-canary.6](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.5...@artisan-commerce/builders@0.7.0-canary.6) (2021-08-23)
-
-
-### Bug Fixes
-
-* **global:** add missing properties to shipping address and complete document type ([c9156f6](https://bitbucket.org/tradesystem/artisn_sdk/commit/c9156f6db3e55f23479484577760f5196e112afc))
-
-
-
-## [0.7.0-canary.5](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.4...@artisan-commerce/builders@0.7.0-canary.5) (2021-08-12)
-
-
-### Bug Fixes
-
-* **global:** add CountryCode type and update user builder ([f94eb5d](https://bitbucket.org/tradesystem/artisn_sdk/commit/f94eb5d38e0725bd157398e3c51b3bb8b2592abc))
-
-
-
 ## [0.7.0-canary.4](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.3...@artisan-commerce/builders@0.7.0-canary.4) (2021-08-12)
 
 

package/build/builders/account.builder.d.ts

@@ -0,0 +1,17 @@
+import { Account } from "@artisan-commerce/types";
+/**
+ * Generates Account object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<Account>} overrides Properties to override a {@link Account}
+ * @returns {Account} A {@link Account} object
+ */
+export declare const buildAccount: (overrides?: Partial<Account>) => Account;
+/**
+ * Generates a list of Account objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Account[]} An array of {@link Account}s objects
+ */
+export declare const genAccounts: (quantity?: number | undefined) => Account[];

package/build/builders/banner.builder.d.ts

@@ -0,0 +1,35 @@
+import { BannerImage } from "@artisan-commerce/types";
+import { Banner } from "@artisan-commerce/types";
+/**
+ * Generates banner object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<Banner>} overrides Properties to override a {@link Banner}
+ * @returns {Banner} A {@link Banner} object
+ */
+export declare const buildBanner: (overrides?: Partial<Banner>) => Banner;
+/**
+ * Generates a list of Banner objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Banner[]} An array of {@link Banner}s objects
+ */
+export declare const genBanners: (quantity?: number | undefined) => Banner[];
+/**
+ * Generates BannerImage object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<BannerImage>} overrides Properties to override
+ * a {@link BannerImage}
+ * @returns {BannerImage} A {@link BannerImage} object
+ */
+export declare const buildBannerImage: (overrides?: Partial<BannerImage>) => BannerImage;
+/**
+ * Generates a list of banner image objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {BannerImage[]} An array of banner images, see {@link BannerImage}
+ */
+export declare const genBannerImages: (quantity?: number | undefined) => BannerImage[];

package/build/builders/billingData.builder.d.ts

@@ -0,0 +1,18 @@
+import { BillingData } from "@artisan-commerce/types";
+/**
+ * Generates BillingData object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<BillingData>} overrides Properties to override
+ * a {@link BillingData}
+ * @returns {BillingData} A {@link BillingData} object
+ */
+export declare const buildBillingData: (overrides?: Partial<BillingData>) => BillingData;
+/**
+ * Generates a list of Billing Data objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {BillingData[]} An array of {@link BillingData}s objects
+ */
+export declare const genBillingData: (quantity?: number | undefined) => BillingData[];

package/build/builders/catalogue.builder.d.ts

@@ -0,0 +1,18 @@
+import { Catalogue } from "@artisan-commerce/types";
+/**
+ * Generates Catalogue object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<Catalogue>} overrides Properties to override
+ * a {@link Catalogue}
+ * @returns {Catalogue} A {@link Catalogue} object
+ */
+export declare const buildCatalogue: (overrides?: Partial<Catalogue>) => Catalogue;
+/**
+ * Generates a list of Catalogue objects with custom data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Catalogue[]} An array of {@link Catalogue}s objects
+ */
+export declare const genCatalogues: (quantity?: number | undefined) => Catalogue[];

package/build/builders/category.builder.d.ts

@@ -0,0 +1,36 @@
+import { Category, CategoryWithProducts } from "@artisan-commerce/types";
+/**
+ * Generates Category object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<Category>} overrides Properties to override
+ * a {@link Category}
+ * @returns {Category} A {@link Category} object
+ */
+export declare const buildCategory: (overrides?: Partial<Category>) => Category;
+/**
+ * Generates a list of Category objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Category[]} An array of categories objects, see {@link Category}
+ */
+export declare const genCategories: (quantity?: number | undefined) => Category[];
+/**
+ * Generates CategoryWithProducts object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<CategoryWithProducts>} overrides Properties to override
+ * a {@link CategoryWithProducts}
+ * @returns {CategoryWithProducts} A {@link CategoryWithProducts} object
+ */
+export declare const buildCategoryWithProducts: (overrides?: Partial<CategoryWithProducts>) => CategoryWithProducts;
+/**
+ * Generates a list of CategoryWithProducts objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {CategoryWithProducts[]} An array of products by categories,
+ * see {@link CategoryWithProducts}
+ */
+export declare const genCategoryWithProducts: (quantity?: number | undefined) => CategoryWithProducts[];

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

@@ -0,0 +1,204 @@
+import { DocumentType } from "@artisan-commerce/types";
+import { CountrySummary, RandomImageConfig } from "@artisan-commerce/types";
+/**
+ * Generates a random password.
+ *
+ * @since 0.5.14
+ * @param {any[]} args An array of arguments to be passed when
+ * generating the password
+ * @returns A random password
+ */
+export declare const getPassword: (...args: any[]) => string;
+/**
+ * Generates a random username.
+ *
+ * @since 0.5.14
+ */
+export declare const getUsername: (firstName?: string | undefined, lastName?: string | undefined) => string;
+/**
+ * Generates a random unique identifier.
+ *
+ * @since 0.5.14
+ */
+export declare const genId: () => string;
+/**
+ * Generates a random id of type number.
+ *
+ * @since 0.5.14
+ */
+export declare const genNumericId: () => number;
+/**
+ * Generates a random word.
+ *
+ * @since 0.5.14
+ */
+export declare const genWord: () => string;
+/**
+ * Generates a random address.
+ *
+ * @since 0.5.14
+ */
+export declare const genAddress: (useFullAddress?: boolean | undefined) => string;
+/**
+ * Generates a random name.
+ *
+ * @since 0.5.14
+ */
+export declare const genName: (firstName?: string | undefined, lastName?: string | undefined, gender?: number | undefined) => string;
+/**
+ * Generates a random email.
+ *
+ * @since 0.5.14
+ */
+export declare const genEmail: (firstName?: string | undefined, lastName?: string | undefined, provider?: string | undefined) => string;
+/**
+ * Generates a random company name.
+ *
+ * @since 0.5.14
+ */
+export declare const genCompanyName: (format?: number | undefined) => string;
+/**
+ * Generates a random paragraph.
+ *
+ * @since 0.5.14
+ */
+export declare const genParagraph: (sentenceCount?: number | undefined) => string;
+/**
+ * Generates a random title containing 3 words.
+ *
+ * @since 0.5.14
+ */
+export declare const genTitle: () => string;
+/**
+ * Generates a random number.
+ *
+ * @since 0.5.14
+ */
+export declare const genNumber: {
+    (max?: number | undefined): number;
+    (options?: {
+        min?: number | undefined;
+        max?: number | undefined;
+        precision?: number | undefined;
+    } | undefined): number;
+};
+/**
+ * Generates a random boolean value.
+ *
+ * @since 0.5.14
+ */
+export declare const getBoolean: () => boolean;
+/**
+ * Generates a random country name.
+ *
+ * @since 0.5.14
+ */
+export declare const genCountryName: () => string;
+/**
+ * Generates a random image based on custom configuration.
+ *
+ * @since 0.5.15
+ * @param {RandomImageConfig} randomImageConfig Configuration
+ * to generate a random image
+ * @returns {string} An url of the image generated
+ */
+export declare const genRandomImage: (randomImageConfig?: RandomImageConfig | undefined) => string;
+/** Generates random words.
+ *
+ * @since 0.5.14
+ * @param {number} words The quantity of words to be generated
+ */
+export declare const genWords: (words?: number | undefined) => string;
+/**
+ * Generates a random internet url.
+ *
+ * @since 0.5.14
+ */
+export declare const genURL: () => string;
+/**
+ * Generates a random date in ISO format.
+ *
+ * @since 0.5.14
+ */
+export declare const genDate: () => string;
+/**
+ * Generates a random base64 value.
+ *
+ * @since 0.5.14
+ */
+export declare const genBase64: () => string;
+/**
+ * Generates a random boolean value.
+ *
+ * @since 0.5.14
+ * @param {number} bias A number between 0 and 1 which will be used
+ * to generate a boolean
+ * @throws Error if bias is not between 0 and 1
+ * @returns {boolean} A boolean value
+ */
+export declare const genBiasBoolean: (bias: number) => boolean;
+/**
+ * Generates a random document.
+ *
+ * @since 0.5.14
+ * @param {number} digits The number of digits with which the document
+ * will be generated
+ * @returns {string} A random document
+ */
+export declare const genDocument: (digits: number) => string;
+/**
+ * Generates a random document type.
+ *
+ * @since 0.5.14
+ */
+export declare const genDocumentType: () => DocumentType;
+/**
+ * Generates a random mobile phone with the country code provided.
+ *
+ * @since 0.5.14
+ * @param {string} countryCode Country calling code
+ * @returns {string} A string like a mobile phone
+ */
+export declare const genMobilPhone: (countryCode: string) => string;
+/**
+ * Generates a Country Summary object with random data.
+ *
+ * @since 0.5.14
+ * @param {number} id Country specific id
+ * @param {string} name Country specific name
+ * @returns {CountrySummary} A {@link CountrySummary} object
+ */
+export declare const genCountry: (id?: number | undefined, name?: string | undefined) => CountrySummary;
+/**
+ * Fills a number of type string with characters.
+ *
+ * @since 0.5.14
+ * @param {string} num A string, the length of it will
+ * be used to fill the number
+ * @param {number} max A number, the length of it will
+ * be used to fill the number
+ * @returns {string} A string filled with the data passed
+ */
+export declare const fillNumber: (num: string, max?: number | undefined) => string;
+/**
+ * Chooses a random item inside the array provided.
+ *
+ * @since 0.5.14
+ * @param {T[]} arr An array of generic items
+ * @returns {T} A random item of the array passed as param
+ */
+export declare const chooseRandom: <T>(arr: T[]) => T;
+/**
+ * Chooses a random enum value of the enum provided.
+ *
+ * @since 0.5.14
+ * @param {T} anEnum An enum
+ * @returns {T[keyof T]} A random item of the enum passed as param
+ */
+export declare const chooseRandomEnum: <T>(anEnum: T) => T[keyof T];
+/**
+ * Generates a random currency symbol.
+ *
+ * @since 0.5.14
+ */
+export declare const genSymbol: string;

package/build/builders/country.builder.d.ts

@@ -0,0 +1,44 @@
+import { Country, CountryCurrency, CountryTax } from "@artisan-commerce/types";
+/**
+ * Generates CountryCurrency object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<CountryCurrency>} overrides Properties to override
+ * a {@link CountryCurrency}
+ * @returns {CountryCurrency} A {@link CountryCurrency} object
+ */
+export declare const buildCountryCurrency: (overrides?: Partial<CountryCurrency>) => CountryCurrency;
+/**
+ * Generates CountryTax object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<CountryTax>} overrides Properties to override a
+ * {@link CountryTax}
+ * @returns {CountryTax} A {@link CountryTax} object
+ */
+export declare const buildCountryTax: (overrides?: Partial<CountryTax>) => CountryTax;
+/**
+ * Generates a list of CountryTax objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {CountryTax[]} An array of categories objects,
+ * see {@link CountryTax}
+ */
+export declare const genCountryTax: (quantity?: number | undefined) => CountryTax[];
+/**
+ * Generates Country object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<Country>} overrides Properties to override a {@link Country}
+ * @returns {Country} A {@link Country} object
+ */
+export declare const buildCountry: (overrides?: Partial<Country>) => Country;
+/**
+ * Generates a list of countries objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns An array of countries objects, see {@link Country}
+ */
+export declare const genCountries: (quantity?: number | undefined) => Country[];