@artisan-commerce/builders 0.6.0-canary.8 → 0.6.0

package/CHANGELOG.md

@@ -3,6 +3,44 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.6.0](https://bitbucket.org/tradesystem/artisan_sdk/compare/@artisan-commerce/builders@0.6.0-canary.11...@artisan-commerce/builders@0.6.0) (2021-07-30)
+
+
+### Features
+
+* **global:** fix percentage type on country ([b4920f2](https://bitbucket.org/tradesystem/artisan_sdk/commit/b4920f2021d4b3e5e1ea9cfd2423d98c122ae5ea))
+
+
+### Bug Fixes
+
+* **global:** reuse shopping cart config and fix builder name ([21f9526](https://bitbucket.org/tradesystem/artisan_sdk/commit/21f952680ca38a8579053d65e5795aa184eafcb2))
+
+
+
+## [0.6.0-canary.11](https://bitbucket.org/tradesystem/artisan_sdk/compare/@artisan-commerce/builders@0.6.0-canary.10...@artisan-commerce/builders@0.6.0-canary.11) (2021-07-26)
+
+**Note:** Version bump only for package @artisan-commerce/builders
+
+
+
+
+
+## [0.6.0-canary.10](https://bitbucket.org/tradesystem/artisan_sdk/compare/@artisan-commerce/builders@0.6.0-canary.9...@artisan-commerce/builders@0.6.0-canary.10) (2021-06-18)
+
+**Note:** Version bump only for package @artisan-commerce/builders
+
+
+
+
+
+## [0.6.0-canary.9](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/builders@0.6.0-canary.8...@artisan-commerce/builders@0.6.0-canary.9) (2021-06-10)
+
+**Note:** Version bump only for package @artisan-commerce/builders
+
+
+
+
+
 ## [0.6.0-canary.8](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/builders@0.6.0-canary.7...@artisan-commerce/builders@0.6.0-canary.8) (2021-04-22)
 
 

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

@@ -1,3 +1,15 @@
 import { Account } from "@artisan-commerce/types";
+/**
+ * Generates Account object with random data.
+ *
+ * @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.
+ *
+ * @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,30 @@
+import { BannerImage } from "@artisan-commerce/types";
+import { Banner } from "@artisan-commerce/types";
+/**
+ * Generates banner object with random data.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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

@@ -1,2 +1,15 @@
 import { BillingData } from "@artisan-commerce/types";
+/**
+ * Generates BillingData object with random data.
+ *
+ * @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.
+ *
+ * @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,15 @@
+import { Catalogue } from "@artisan-commerce/types";
+/**
+ * Generates Catalogue object with random data.
+ *
+ * @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.
+ *
+ * @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

@@ -1,5 +1,29 @@
-import { Category, ProductsByCategory } from "@artisan-commerce/types";
+import { Category, CategoryWithProducts } from "@artisan-commerce/types";
+/**
+ * Generates Category object with random data.
+ *
+ * @param {Partial<Category>} overrides Properties to override a {@link Category}
+ * @returns {Category} A {@link Category} object
+ */
 export declare const buildCategory: (overrides?: Partial<Category>) => Category;
-export declare const genCategorys: (quantity?: number | undefined) => Category[];
-export declare const buildProductsByCategory: (overrides?: Partial<ProductsByCategory>) => ProductsByCategory;
-export declare const genProductsByCategories: (quantity?: number | undefined) => ProductsByCategory[];
+/**
+ * Generates a list of Category objects with random data.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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

@@ -1,15 +1,33 @@
-import { DocumentType, CountrySummary } from "@artisan-commerce/types";
+import { CountrySummary, URLImage } from "@artisan-commerce/types";
+import { DocumentType, CDNImage } from "@artisan-commerce/types";
+/**
+ * Generates a random password.
+ *
+ * @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. */
 export declare const getUsername: (firstName?: string | undefined, lastName?: string | undefined) => string;
+/** Generates a random unique identifier. */
 export declare const genId: () => string;
+/** Generates a random id of type number. */
 export declare const genNumericId: () => number;
+/** Generates a random word. */
 export declare const genWord: () => string;
+/** Generates a random address. */
 export declare const genAddress: (useFullAddress?: boolean | undefined) => string;
+/** Generates a random name. */
 export declare const genName: (firstName?: string | undefined, lastName?: string | undefined, gender?: number | undefined) => string;
+/** Generates a random email. */
 export declare const genEmail: (firstName?: string | undefined, lastName?: string | undefined, provider?: string | undefined) => string;
+/** Generates a random company name. */
 export declare const genCompanyName: (format?: number | undefined) => string;
+/** Generates a random paragraph. */
 export declare const genParagraph: (sentenceCount?: number | undefined) => string;
+/** Generates a random title containing 3 words. */
 export declare const genTitle: () => string;
+/** Generates a random number. */
 export declare const genNumber: {
     (max?: number | undefined): number;
     (options?: {
@@ -18,13 +36,99 @@ export declare const genNumber: {
         precision?: number | undefined;
     } | undefined): number;
 };
+/** Generates a random boolean value. */
 export declare const getBoolean: () => boolean;
+/** Generates a random country name. */
 export declare const genCountryName: () => string;
+/** Generates a random image. */
+export declare const genRandomImage: string;
+/** Generates random words.
+ *
+ * @param {number} words The quantity of words to be generated
+ */
+export declare const genWords: (words?: number | undefined) => string;
+/** Generates a random internet url. */
+export declare const genURL: string;
+/** Generates a random date in ISO format. */
+export declare const genDate: string;
+/** Generates a random base64 value. */
+export declare const genBase64: string;
+/**
+ * Generates a random boolean value.
+ *
+ * @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.
+ *
+ * @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. */
 export declare const genDocumentType: () => DocumentType;
+/**
+ * Generates a random mobile phone with the country code provided.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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. */
+export declare const genSymbol: string;
+/** Generates a random image url. */
+export declare const buildURLImage: string;
+/**
+ * Generates a list of URLImage.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {URLImage} An array of {@link URLImage}
+ */
+export declare const genURLImages: (quantity?: number | undefined) => URLImage[];
+/**
+ * Generates CDNImage object with random data.
+ *
+ * @param {Partial<CDNImage>} overrides Properties to override a {@link CDNImage}
+ * @returns {CDNImage} A {@link CDNImage} object
+ */
+export declare const buildCDNImage: (overrides?: Partial<CDNImage>) => CDNImage;
+/**
+ * Generates a list of CDNImage objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {CDNImage[]} An array of CDNImage objects, see {@link CDNImage}
+ */
+export declare const genCDNImages: (quantity?: number | undefined) => CDNImage[];

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

@@ -1,5 +1,36 @@
 import { Country, CountryCurrency, CountryTax } from "@artisan-commerce/types";
+/**
+ * Generates CountryCurrency object with random data.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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[];

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

@@ -0,0 +1,44 @@
+import { Wallet } from "@artisan-commerce/types";
+import { Benefit, Award } from "@artisan-commerce/types";
+/**
+ * Generates Benefit object with random data.
+ *
+ * @param {Partial<Benefit>} overrides Properties to override a {@link Benefit}
+ * @returns {Benefit} A {@link Benefit} object
+ */
+export declare const buildBenefit: (overrides?: Partial<Benefit>) => Benefit;
+/**
+ * Generates a list of Benefit objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Benefit[]} An array of Benefit objects, see {@link Benefit}
+ */
+export declare const genBenefits: (quantity?: number | undefined) => Benefit[];
+/**
+ * Generates Award object with random data.
+ *
+ * @param {Partial<>} overrides Properties to override a {@link Award}
+ * @returns {Award} A {@link Award} object
+ */
+export declare const buildAward: (overrides?: Partial<Award>) => Award;
+/**
+ * Generates a list of Award objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Award[]} An array of Award objects, see {@link Award}
+ */
+export declare const genAwards: (quantity?: number | undefined) => Award[];
+/**
+ * Generates Wallet object with random data.
+ *
+ * @param {Partial<Wallet>} overrides Properties to override a {@link Wallet}
+ * @returns {Wallet} A {@link Wallet} object
+ */
+export declare const buildWallet: (overrides?: Partial<Wallet>) => Wallet;
+/**
+ * Generates a list of Wallet objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Wallet[]} An array of Wallet objects, see {@link Wallet}
+ */
+export declare const genWallets: (quantity?: number | undefined) => Wallet[];

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

@@ -0,0 +1,44 @@
+import { BasePaymentMethod, PaymentMethod } from "@artisan-commerce/types";
+import { CreditCardBrand, CreditCardMapping } from "@artisan-commerce/types";
+/**
+ * Generates BasePaymentMethod object with random data.
+ *
+ * @param {Partial<BasePaymentMethod>} overrides Properties to override a {@link BasePaymentMethod}
+ * @returns {BasePaymentMethod} A {@link BasePaymentMethod} object
+ */
+export declare const buildBasePaymentMethod: (overrides?: Partial<BasePaymentMethod>) => BasePaymentMethod;
+/**
+ * Generates PaymentMethod object with random data.
+ *
+ * @param {Partial<PaymentMethod>} overrides Properties to override a {@link PaymentMethod}
+ * @returns {PaymentMethod} A {@link PaymentMethod} object
+ */
+export declare const buildPaymentMethod: (overrides?: Partial<PaymentMethod>) => PaymentMethod;
+/**
+ * Generates CreditCardBrand object with random data.
+ *
+ * @param {Partial<CreditCardBrand>} overrides Properties to override a {@link CreditCardBrand}
+ * @returns {CreditCardBrand} A {@link CreditCardBrand} object
+ */
+export declare const buildCreditCardBrand: (overrides?: Partial<CreditCardBrand>) => CreditCardBrand;
+/**
+ * Generates a list of CreditCardBrand objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {CreditCardBrand[]} An array of credit card brands, see {@link CreditCardBrand}
+ */
+export declare const genCreditCardBrands: (quantity?: number | undefined) => CreditCardBrand[];
+/**
+ * Generates CreditCardMapping object with random data.
+ *
+ * @param {Partial<CreditCardMapping>} overrides Properties to override a {@link CreditCardMapping}
+ * @returns {CreditCardMapping} A {@link CreditCardMapping} object
+ */
+export declare const buildCreditCardMapping: (overrides?: Partial<CreditCardMapping>) => CreditCardMapping;
+/**
+ * Generates a list of CreditCardMapping objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {CreditCardMapping[]} An array of credit card mappings, see {@link CreditCardMapping}
+ */
+export declare const genCreditCardMappings: (quantity?: number | undefined) => CreditCardMapping[];

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

@@ -1,25 +1,125 @@
-import { CartProductQuestion } from "@artisan-commerce/types";
+import { BaseProduct } from "@artisan-commerce/types";
 import { CartProductAnswer } from "@artisan-commerce/types";
-import { ProductAnswer } from "@artisan-commerce/types";
+import { CartProductQuestion } from "@artisan-commerce/types";
 import { CartProduct, ProductQuestion } from "@artisan-commerce/types";
-import { PriceCategoryTax } from "@artisan-commerce/types";
-import { BaseProduct } from "@artisan-commerce/types";
-import { PriceCategory } from "@artisan-commerce/types";
-import { ProductDetails } from "@artisan-commerce/types";
+import { ProductAnswer, ProductDetails } from "@artisan-commerce/types";
+import { PriceCategory, PriceCategoryTax } from "@artisan-commerce/types";
+/**
+ * Generates PriceCategoryTax object with random data.
+ *
+ * @param {Partial<PriceCategoryTax>} overrides Properties to override a {@link PriceCategoryTax}
+ * @returns {PriceCategoryTax} A {@link PriceCategoryTax} object
+ */
 export declare const buildPriceCategoryTax: (overrides?: Partial<PriceCategoryTax>) => PriceCategoryTax;
+/**
+ * Generates a list of PriceCategoryTax objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {PriceCategoryTax[]} An array of price category taxes objects, see {@link PriceCategoryTax}
+ */
 export declare const genPriceCategoryTaxes: (quantity?: number | undefined) => PriceCategoryTax[];
+/**
+ * Generates PriceCategory object with random data.
+ *
+ * @param {Partial<PriceCategory>} overrides Properties to override a {@link PriceCategory}
+ * @returns {PriceCategory} A {@link PriceCategory} object
+ */
 export declare const buildPriceCategory: (overrides?: Partial<PriceCategory>) => PriceCategory;
+/**
+ * Generates BaseProduct object with random data.
+ *
+ * @param {Partial<BaseProduct>} overrides Properties to override a {@link BaseProduct}
+ * @returns {BaseProduct} A {@link BaseProduct} object
+ */
 export declare const buildBaseProduct: (overrides?: Partial<BaseProduct>) => BaseProduct;
+/**
+ * Generates a list of BaseProduct objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {BaseProduct[]} An array of BaseProduct objects, see {@link BaseProduct}
+ */
 export declare const genBaseProducts: (quantity?: number | undefined) => BaseProduct[];
+/** Render type for product answers  */
 export declare const MODIFIER_TYPES: string[];
+/**
+ * Generates ProductAnswer object with random data.
+ *
+ * @param {Partial<ProductAnswer>} overrides Properties to override a {@link ProductAnswer}
+ * @param {number} loop The quantity of loops the function will be run
+ * @returns {ProductAnswer} A {@link ProductAnswer} object
+ */
 export declare const buildProductAnswer: (overrides?: Partial<ProductAnswer>, loop?: number) => ProductAnswer;
+/**
+ * Generates a list of ProductAnswer objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @param {number} loop The quantity of loops the function will be run
+ * @returns {ProductAnswer[]} An array of ProductAnswer objects, see {@link ProductAnswer}
+ */
 export declare const genProductAnswers: (quantity?: number | undefined, loop?: number) => ProductAnswer[];
+/**
+ * Generates ProductQuestion object with random data.
+ *
+ * @param {Partial<ProductQuestion>} overrides Properties to override a {@link ProductQuestion}
+ * @param {number} loop The quantity of loops the function will be run
+ * @returns {ProductQuestion} A {@link ProductQuestion} object
+ */
 export declare const buildProductQuestion: (overrides?: Partial<ProductQuestion>, loop?: number) => ProductQuestion;
+/**
+ * Generates a list of ProductQuestion objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @param {number} loop The quantity of loops the function will be run
+ * @returns {ProductQuestion[]} An array of ProductQuestion objects, see {@link ProductQuestion}
+ */
 export declare const genProductQuestions: (quantity?: number | undefined, loop?: number) => ProductQuestion[];
+/**
+ * Generates ProductDetails object with random data.
+ *
+ * @param {Partial<ProductDetails>} overrides Properties to override a {@link ProductDetails}
+ * @returns {ProductDetails} A {@link ProductDetails} object
+ */
 export declare const buildProductDetails: (overrides?: Partial<ProductDetails>) => ProductDetails;
+/**
+ * Generates a list of ProductDetails objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {ProductDetails[]} An array of ProductDetails objects, see {@link ProductDetails}
+ */
 export declare const genProductDetails: (quantity?: number | undefined) => ProductDetails[];
+/**
+ * Generates CartProductAnswer object with random data.
+ *
+ * @param questionId The question id associated with the answer
+ * @param {Partial<CartProductAnswer>} overrides Properties to override a {@link CartProductAnswer}
+ * @returns {CartProductAnswer} A {@link CartProductAnswer} object
+ */
 export declare const buildCartProductAnswer: (questionId: string, overrides?: Partial<CartProductAnswer>) => CartProductAnswer;
+/**
+ * Generates a list of CartProductAnswer objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {CartProductAnswer[]} An array of CartProductAnswer objects, see {@link CartProductAnswer}
+ */
 export declare const genCartProductAnswers: (quantity?: number | undefined) => CartProductAnswer[];
+/**
+ * Generates CartProductQuestion object with random data.
+ *
+ * @param {Partial<CartProductQuestion>} overrides Properties to override a {@link CartProductQuestion}
+ * @returns {CartProductQuestion} A {@link CartProductQuestion} object
+ */
 export declare const buildCartProductQuestion: (overrides?: Partial<CartProductQuestion>) => CartProductQuestion;
+/**
+ * Generates a list of CartProductQuestion objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {CartProductQuestion[]} An array of CartProductQuestion objects, see {@link CartProductQuestion}
+ */
 export declare const genCartProductQuestions: (quantity?: number | undefined) => CartProductQuestion[];
+/**
+ * Generates CartProduct object with random data.
+ *
+ * @param {Partial<CartProduct>} overrides Properties to override a {@link CartProduct}
+ * @returns {CartProduct} A {@link CartProduct} object
+ */
 export declare const buildCartProduct: (overrides?: Partial<CartProduct>) => CartProduct;

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

@@ -1,28 +1,80 @@
-import { ShippingAddress, LivingPlace } from "@artisan-commerce/types";
+import { ShippingAddress, LivingPlace, Field } from "@artisan-commerce/types";
+import { Rule, Message } from "@artisan-commerce/types";
+/** Generates a random street name. */
 export declare const genStreetName: () => string;
+/** Generates a random street number. */
 export declare const genStreetNumber: (format?: string | undefined) => string;
+/** Generates a random latitude. */
 export declare const genLatitude: () => string;
+/** Generates a random longitude. */
 export declare const genLongitude: () => string;
-export declare const genFields: (quantity?: number | undefined) => {
-    id: string;
-    value: string;
-    label: string;
-    rules: {
-        max: number;
-        min: number;
-    };
-    messages: {
-        max: string;
-        min: string;
-    };
-}[];
-export declare const genRules: () => {
-    max: number;
-    min: number;
-};
-export declare const genMessages: () => {
-    max: string;
-    min: string;
-};
+/**
+ * Generates Field object with random data.
+ *
+ * @param {Partial<Field>} overrides Properties to override a {@link Field}
+ * @returns {Field} A {@link Field} object
+ */
+export declare const buildField: (overrides?: Partial<Field>) => Field;
+/**
+ * Generates a list of Field objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Field[]} A list of {@link Field} objects
+ */
+export declare const genFields: (quantity?: number | undefined) => Field[];
+/**
+ * Generates Rule object with random data.
+ *
+ * @param {Partial<Rule>} overrides Properties to override a {@link Message}
+ * @returns {Rule} A {@link Rule} object
+ */
+export declare const buildRule: (overrides?: Partial<Rule> | undefined) => Rule;
+/**
+ * Generates Message object with random data.
+ *
+ * @param {Partial<Message>} overrides Properties to override a {@link Message}
+ * @returns {Message} A {@link Message} object
+ */
+export declare const buildMessage: (overrides?: Partial<Message> | undefined) => Message;
+/**
+ * Generates a list of Rules objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Rule[]} A list of {@link Rule} objects
+ */
+export declare const genRules: (quantity?: number | undefined) => Rule[];
+/**
+ * Generates a list of Messages objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Message[]} A list of {@link Message} objects
+ */
+export declare const genMessages: (quantity?: number | undefined) => Message[];
+/**
+ * Generates LivingPlace object with random data.
+ *
+ * @param {Partial<LivingPlace>} overrides Properties to override a {@link LivingPlace}
+ * @returns {LivingPlace} A {@link LivingPlace} object
+ */
 export declare const buildLivingPlace: (overrides?: Partial<LivingPlace>) => LivingPlace;
+/**
+ * Generates a list of LivingPlaces objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {LivingPlace[]} A list of {@link LivingPlace} objects
+ */
+export declare const genLivingPlaces: (quantity?: number | undefined) => LivingPlace[];
+/**
+ * Generates ShippingAddress object with random data.
+ *
+ * @param {Partial<ShippingAddress>} overrides Properties to override a {@link ShippingAddress}
+ * @returns {ShippingAddress} A {@link ShippingAddress} object
+ */
 export declare const buildShippingAddress: (overrides?: Partial<ShippingAddress>) => ShippingAddress;
+/**
+ * Generates a list of ShippingAddresses objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {ShippingAddress[]} A list of {@link ShippingAddress} objects
+ */
+export declare const genShippingAddress: (quantity?: number | undefined) => ShippingAddress[];