@artisan-commerce/builders 0.7.0-canary.48 → 0.7.0-canary.6

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

@@ -0,0 +1,283 @@
+import { CountryCode, DocumentType } from "@artisan-commerce/types";
+import { ARDocumentType, BODocumentType } from "@artisan-commerce/types";
+import { BRDocumentType, CLDocumentType } from "@artisan-commerce/types";
+import { CODocumentType, ECDocumentType } from "@artisan-commerce/types";
+import { PYDocumentType, PEDocumentType } from "@artisan-commerce/types";
+import { UYDocumentType, VEDocumentType } from "@artisan-commerce/types";
+import { USDocumentType, CommonDocumentType } from "@artisan-commerce/types";
+import { CountrySummary, RandomImageConfig } from "@artisan-commerce/types";
+/**
+ * Default document types for all countries.
+ *
+ * @since 0.1.0
+ */
+export declare const commonDocumentTypes: CommonDocumentType[];
+/**
+ * Argentina supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const ARDocumentTypes: ARDocumentType[];
+/**
+ * Bolivia supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const BODocumentTypes: BODocumentType[];
+/**
+ * Brasil supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const BRDocumentTypes: BRDocumentType[];
+/**
+ * Chile supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const CLDocumentTypes: CLDocumentType[];
+/**
+ * Colombia supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const CODocumentTypes: CODocumentType[];
+/**
+ * Ecuador supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const ECDocumentTypes: ECDocumentType[];
+/**
+ * Paraguay supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const PYDocumentTypes: PYDocumentType[];
+/**
+ * Perú supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const PEDocumentTypes: PEDocumentType[];
+/**
+ * Uruguay supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const UYDocumentTypes: UYDocumentType[];
+/**
+ * Venezuela supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const VEDocumentTypes: VEDocumentType[];
+/**
+ * United States supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const USDocumentTypes: USDocumentType[];
+/**
+ * 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
+ * @param {string} countryISOCode Country calling code
+ */
+export declare const genDocumentType: (countryISOCode?: CountryCode) => 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,51 @@
+import { Country, CountryCode } from "@artisan-commerce/types";
+import { CountryCurrency, CountryTax } from "@artisan-commerce/types";
+/**
+ * All values of CountryCode.
+ *
+ * @since 0.1.0
+ */
+export declare const countriesCodes: CountryCode[];
+/**
+ * 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[];

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

@@ -0,0 +1,50 @@
+import { Wallet } from "@artisan-commerce/types";
+import { Benefit, Award } from "@artisan-commerce/types";
+/**
+ * Generates Benefit object with random data.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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/fulfillment.builder.d.ts

@@ -0,0 +1,187 @@
+import { Workflow, StepWorkflow } from "@artisan-commerce/types";
+import { StepWorkflowAdditionalInfo } from "@artisan-commerce/types";
+import { StepWorkflowGroup } from "@artisan-commerce/types";
+import { Issue } from "@artisan-commerce/types";
+import { StepNotification } from "@artisan-commerce/types";
+import { IssueAdditionalInfo, IssueHistory } from "@artisan-commerce/types";
+import { WebhookWorkflow, TransitionWorkflow } from "@artisan-commerce/types";
+/**
+ * Generates Issue object with random data.
+ *
+ * @since 0.5.15
+ * @param {Partial<Issue>} overrides Properties to override
+ * a {@link Issue}
+ * @returns {Issue} A {@link Issue} object
+ */
+export declare const buildIssue: (overrides?: Partial<Issue>) => Issue;
+/**
+ * Generates a list of Issue objects with random data.
+ *
+ * @since 0.5.15
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Issue[]} An array of Issue objects,
+ * see {@link Issue}
+ */
+export declare const genIssues: (quantity?: number | undefined) => Issue[];
+/**
+ * Generates IssueAdditionalInfo object with random data.
+ *
+ * @since 0.5.15
+ * @param {Partial<IssueAdditionalInfo>} overrides Properties to override
+ * a {@link IssueAdditionalInfo}
+ * @returns {IssueAdditionalInfo} A {@link IssueAdditionalInfo} object
+ */
+export declare const buildIssueAdditionalInfo: (overrides?: Partial<IssueAdditionalInfo>) => IssueAdditionalInfo;
+/**
+ * Generates a list of IssueAdditionalInfo objects with random data.
+ *
+ * @since 0.5.15
+ * @param {number} quantity The number of objects to be generated
+ * @returns {IssueAdditionalInfo[]} An array of IssueAdditionalInfo objects,
+ * see {@link IssueAdditionalInfo}
+ */
+export declare const genIssueAdditionalInfo: (quantity?: number | undefined) => IssueAdditionalInfo[];
+/**
+ * Generates IssueHistory object with random data.
+ *
+ * @since 0.5.15
+ * @param {Partial<IssueHistory>} overrides Properties to override
+ * a {@link IssueHistory}
+ * @returns {IssueHistory} A {@link IssueHistory} object
+ */
+export declare const buildIssueHistory: (overrides?: Partial<IssueHistory>) => IssueHistory;
+/**
+ * Generates a list of IssueHistory objects with random data.
+ *
+ * @since 0.5.15
+ * @param {number} quantity The number of objects to be generated
+ * @returns {IssueHistory[]} An array of IssueHistory objects,
+ * see {@link IssueHistory}
+ */
+export declare const genIssueHistory: (quantity?: number | undefined) => IssueHistory[];
+/**
+ * Generates Workflow object with random data.
+ *
+ * @since 0.5.15
+ * @param {Partial<Workflow>} overrides Properties to override
+ * a {@link Workflow}
+ * @returns {Workflow} A {@link Workflow} object
+ */
+export declare const buildWorkflow: (overrides?: Partial<Workflow>) => Workflow;
+/**
+ * Generates a list of Workflow objects with random data.
+ *
+ * @since 0.5.15
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Workflow[]} An array of Workflow objects, see {@link Workflow}
+ */
+export declare const genWorkflows: (quantity?: number | undefined) => Workflow[];
+/**
+ * Generates StepNotification object with random data.
+ *
+ * @since 0.5.15
+ * @param {Partial<StepNotification>} overrides Properties to override
+ * a {@link StepNotification}
+ * @returns {StepNotification} A {@link StepNotification} object
+ */
+export declare const buildStepNotification: (overrides?: Partial<StepNotification>) => StepNotification;
+/**
+ * Generates a list of StepNotification objects with random data.
+ *
+ * @since 0.5.15
+ * @param {number} quantity The number of objects to be generated
+ * @returns {StepNotification[]} An array of StepNotification objects,
+ * see {@link StepNotification}
+ */
+export declare const genStepNotifications: (quantity?: number | undefined) => StepNotification[];
+/**
+ * Generates StepWorkflow object with random data.
+ *
+ * @since 0.5.15
+ * @param {Partial<StepWorkflow>} overrides Properties to override
+ * a {@link StepWorkflow}
+ * @returns {StepWorkflow} A {@link StepWorkflow} object
+ */
+export declare const buildStepWorkflow: (overrides?: Partial<StepWorkflow>) => StepWorkflow;
+/**
+ * Generates a list of StepWorkflow objects with random data.
+ *
+ * @since 0.5.15
+ * @param {number} quantity The number of objects to be generated
+ * @returns {StepWorkflow[]} An array of StepWorkflow objects,
+ * see {@link StepWorkflow}
+ */
+export declare const genStepWorkflows: (quantity?: number | undefined) => StepWorkflow[];
+/**
+ * Generates WebhookWorkflow object with random data.
+ *
+ * @since 0.5.15
+ * @param {Partial<WebhookWorkflow>} overrides Properties to override
+ * a {@link WebhookWorkflow}
+ * @returns {WebhookWorkflow} A {@link WebhookWorkflow} object
+ */
+export declare const buildWebhookWorkflow: (overrides?: Partial<WebhookWorkflow>) => WebhookWorkflow;
+/**
+ * Generates a list of WebhookWorkflow objects with random data.
+ *
+ * @since 0.5.15
+ * @param {number} quantity The number of objects to be generated
+ * @returns {WebhookWorkflow[]} An array of WebhookWorkflow objects,
+ * see {@link WebhookWorkflow}
+ */
+export declare const genWebhookWorkflows: (quantity?: number | undefined) => WebhookWorkflow[];
+/**
+ * Generates StepWorkflowAdditionalInfo object with random data.
+ *
+ * @since 0.5.15
+ * @param {Partial<StepWorkflowAdditionalInfo>} overrides Properties to
+ * override a {@link StepWorkflowAdditionalInfo}
+ * @returns {StepWorkflowAdditionalInfo} A
+ * {@link StepWorkflowAdditionalInfo} object
+ */
+export declare const buildStepWorkflowAdditionalInfo: (overrides?: Partial<StepWorkflowAdditionalInfo>) => StepWorkflowAdditionalInfo;
+/**
+ * Generates a list of StepWorkflowAdditionalInfo objects with random data.
+ *
+ * @since 0.5.15
+ * @param {number} quantity The number of objects to be generated
+ * @returns {StepWorkflowAdditionalInfo[]} An array of
+ * StepWorkflowAdditionalInfo objects, see {@link StepWorkflowAdditionalInfo}
+ */
+export declare const genStepWorkflowAdditionalInfos: (quantity?: number | undefined) => StepWorkflowAdditionalInfo[];
+/**
+ * Generates StepWorkflowGroup object with random data.
+ *
+ * @since 0.5.15
+ * @param {Partial<StepWorkflowGroup>} overrides Properties to override
+ * a {@link StepWorkflowGroup}
+ * @returns {StepWorkflowGroup} A {@link StepWorkflowGroup} object
+ */
+export declare const buildStepWorkflowGroup: (overrides?: Partial<StepWorkflowGroup>) => StepWorkflowGroup;
+/**
+ * Generates a list of StepWorkflowGroup objects with random data.
+ *
+ * @since 0.5.15
+ * @param {number} quantity The number of objects to be generated
+ * @returns {StepWorkflowGroup[]} An array of StepWorkflowGroup objects,
+ * see {@link StepWorkflowGroup}
+ */
+export declare const genStepWorkflowGroups: (quantity?: number | undefined) => StepWorkflowGroup[];
+/**
+ * Generates TransitionWorkflow object with random data.
+ *
+ * @since 0.5.15
+ * @param {Partial<TransitionWorkflow>} overrides Properties to override
+ * a {@link TransitionWorkflow}
+ * @returns {TransitionWorkflow} A {@link TransitionWorkflow} object
+ */
+export declare const buildTransitionWorkflow: (overrides?: Partial<TransitionWorkflow>) => TransitionWorkflow;
+/**
+ * Generates a list of TransitionWorkflow objects with random data.
+ *
+ * @since 0.5.15
+ * @param {number} quantity The number of objects to be generated
+ * @returns {TransitionWorkflow[]} An array of TransitionWorkflow objects,
+ * see {@link TransitionWorkflow}
+ */
+export declare const genTransitionWorkflows: (quantity?: number | undefined) => TransitionWorkflow[];

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

@@ -0,0 +1,34 @@
+import { CDNImage, URLImage, RandomImageConfig } from "@artisan-commerce/types";
+/**
+ * Generates a random image url.
+ *
+ * @since 0.5.15
+ */
+export declare const buildURLImage: (randomImageConfig?: RandomImageConfig | undefined) => string;
+/**
+ * Generates a list of URLImage.
+ *
+ * @since 0.5.15
+ * @param {number} quantity The number of objects to be generated
+ * @returns {URLImage} An array of {@link URLImage}
+ */
+export declare const genURLImages: (quantity?: number | undefined, overrides?: RandomImageConfig | undefined) => URLImage[];
+/**
+ * Generates CDNImage object with random data.
+ *
+ * @since 0.5.15
+ * @param {Partial<CDNImage>} overrides Properties to override
+ * a {@link CDNImage}
+ * @param {RandomImageConfig} options image request options{{@link RandomImageConfig}
+ * @returns {CDNImage} A {@link CDNImage} object
+ */
+export declare const buildCDNImage: (overrides?: Partial<CDNImage>, options?: RandomImageConfig | undefined) => CDNImage;
+/**
+ * Generates a list of CDNImage objects with random data.
+ *
+ * @since 0.5.15
+ * @param {number} quantity The number of objects to be generated
+ * @param {RandomImageConfig} options image request options{{@link RandomImageConfig}
+ * @returns {CDNImage[]} An array of CDNImage objects, see {@link CDNImage}
+ */
+export declare const genCDNImages: (quantity?: number | undefined, options?: RandomImageConfig | undefined) => CDNImage[];

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

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