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

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

@@ -0,0 +1,161 @@
+import { BaseProduct } from "@artisan-commerce/types";
+import { CartProductAnswer } from "@artisan-commerce/types";
+import { CartProductQuestion } from "@artisan-commerce/types";
+import { CartProduct, ProductQuestion } from "@artisan-commerce/types";
+import { ProductAnswer, ProductDetails } from "@artisan-commerce/types";
+import { PriceCategory, PriceCategoryTax } from "@artisan-commerce/types";
+/**
+ * Generates PriceCategoryTax object with random data.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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
+ *
+ * @since 0.5.14
+ */
+export declare const MODIFIER_TYPES: string[];
+/**
+ * Generates ProductAnswer object with random data.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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/settings.builder.d.ts

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

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

@@ -0,0 +1,108 @@
+import { ShippingAddress, LivingPlace, Field } from "@artisan-commerce/types";
+import { Rule, Message } from "@artisan-commerce/types";
+/**
+ * Generates a random street name.
+ *
+ * @since 0.5.14
+ */
+export declare const genStreetName: () => string;
+/**
+ * Generates a random street number.
+ *
+ * @since 0.5.14
+ */
+export declare const genStreetNumber: (format?: string | undefined) => string;
+/**
+ * Generates a random latitude.
+ *
+ * @since 0.5.14
+ */
+export declare const genLatitude: () => string;
+/**
+ * Generates a random longitude.
+ *
+ * @since 0.5.14
+ */
+export declare const genLongitude: () => string;
+/**
+ * Generates Field object with random data.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @param {Partial<Rule>} overrides Properties to override a {@link Rule}
+ * @returns {Rule} A {@link Rule} object
+ */
+export declare const buildRule: (overrides?: Partial<Rule> | undefined) => Rule;
+/**
+ * Generates Message object with random data.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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.
+ *
+ * @since 0.5.14
+ * @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[];

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

@@ -0,0 +1,76 @@
+import { ShippingCostTax } from "@artisan-commerce/types";
+import { BillTotal, BillTotalCategory } from "@artisan-commerce/types";
+import { ShoppingCart, ShippingCost } from "@artisan-commerce/types";
+import { CartStore, Objectify } from "@artisan-commerce/types";
+/**
+ * Generates BillTotalCategory object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<BillTotalCategory>} overrides Properties to override
+ * a {@link BillTotalCategory}
+ * @returns {BillTotalCategory} A {@link BillTotalCategory} object
+ */
+export declare const buildBillTotalNormalCategory: (overrides?: Partial<BillTotalCategory>) => BillTotalCategory;
+/**
+ * Generates BillTotal object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<BillTotal>} overrides Properties to override
+ * a {@link BillTotal}
+ * @returns {BillTotal} A {@link BillTotal} object
+ */
+export declare const buildBillTotal: (overrides?: Partial<BillTotal>) => BillTotal;
+/**
+ * Generates CartStore object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<CartStore>} overrides Properties to override
+ * a {@link CartStore}
+ * @returns {CartStore} A {@link CartStore} object
+ */
+export declare const buildCartStore: (overrides?: Partial<CartStore>) => CartStore;
+/**
+ * Generates a CartStore object where the key is the store id
+ * and the value is the cart store object
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Objectify<CartStore>} An Objectify<{@link CartStore}>
+ */
+export declare const genCartStores: (quantity?: number | undefined) => Objectify<CartStore>;
+/**
+ * Generates ShoppingCart object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<ShoppingCart>} overrides Properties to override
+ * a {@link ShoppingCart}
+ * @returns {ShoppingCart} A {@link ShoppingCart} object
+ */
+export declare const buildShoppingCart: (overrides?: Partial<ShoppingCart>) => ShoppingCart;
+/**
+ * Generates ShippingCost object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<ShippingCost>} overrides Properties to override
+ * a {@link ShippingCost}
+ * @returns {ShippingCost} A {@link ShippingCost} object
+ */
+export declare const buildShippingCost: (overrides?: Partial<ShippingCost>) => ShippingCost;
+/**
+ * Generates ShippingCostTax object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<ShippingCostTax>} overrides Properties to override
+ * a {@link ShippingCostTax}
+ * @returns {ShippingCostTax} A {@link ShippingCostTax} object
+ */
+export declare const buildShippingCostTax: (overrides?: Partial<ShippingCostTax>) => ShippingCostTax;
+/**
+ * Generates a list of ShippingCostTax objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {ShippingCostTax[]} An array of shipping cost taxes objects,
+ * see {@link ShippingCostTax}
+ */
+export declare const genShippingCostTaxes: (quantity?: number | undefined) => ShippingCostTax[];

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

@@ -0,0 +1,106 @@
+import { Service, Delivery, Schedule } from "@artisan-commerce/types";
+import { Store, AdditionalStoreInformation } from "@artisan-commerce/types";
+import { GenericStoreLocation, StoreLocation } from "@artisan-commerce/types";
+/**
+ * Generates Store object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<Store>} overrides Properties to override a {@link Store}
+ * @returns {Store} A {@link Store} object
+ */
+export declare const buildStore: (overrides?: Partial<Store>) => Store;
+/**
+ * Generates AdditionalStoreInformation object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<AdditionalStoreInformation>} overrides Properties to
+ * override a {@link AdditionalStoreInformation}
+ * @returns {AdditionalStoreInformation} A
+ * {@link AdditionalStoreInformation} object
+ */
+export declare const buildAdditionalStoreInformation: (overrides?: Partial<AdditionalStoreInformation>) => AdditionalStoreInformation;
+/**
+ * Generates Delivery object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<Delivery>} overrides Properties to override
+ * a {@link Delivery}
+ * @returns {Delivery} A {@link Delivery} object
+ */
+export declare const buildDelivery: (overrides?: Partial<Delivery>) => Delivery;
+/**
+ * Generates Schedule object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<Schedule>} overrides Properties to override
+ * a {@link Schedule}
+ * @returns {Schedule} A {@link Schedule} object
+ */
+export declare const buildSchedule: (overrides?: Partial<Schedule>) => Schedule;
+/**
+ * Generates Service object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<Service>} overrides Properties to override a {@link Service}
+ * @returns {Service} A {@link Service} object
+ */
+export declare const buildService: (overrides?: Partial<Service>) => Service;
+/**
+ * Generates a list of Service objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Service[]} An array of {@link Service}s objects
+ */
+export declare const genServices: (quantity?: number | undefined) => Service[];
+/**
+ * Generates a list of Schedule objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Schedule[]} An array of {@link Schedule}s objects
+ */
+export declare const genSchedules: (quantity?: number | undefined) => Schedule[];
+/**
+ * Generates a list of Store objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Store[]} An array of {@link Store}s objects
+ */
+export declare const genStores: (quantity?: number | undefined) => Store[];
+/**
+ * Generates GenericStoreLocation object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<GenericStoreLocation>} overrides Properties to override
+ * a {@link GenericStoreLocation}
+ * @returns {GenericStoreLocation} A {@link GenericStoreLocation} object
+ */
+export declare const buildGenericStoreLocation: (overrides?: Partial<GenericStoreLocation>) => GenericStoreLocation;
+/**
+ * Generates a list of GenericStoreLocation objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {GenericStoreLocation[]} An array of {@link GenericStoreLocation}s
+ * objects
+ */
+export declare const genGenericStoreLocation: (quantity?: number | undefined) => GenericStoreLocation[];
+/**
+ * Generates StoreLocation object with random data.
+ *
+ * @since 0.5.14
+ * @param {Partial<StoreLocation>} overrides Properties to override
+ * a {@link StoreLocation}
+ * @returns {StoreLocation} A {@link StoreLocation} object
+ */
+export declare const buildStoreLocation: (overrides?: Partial<StoreLocation>) => StoreLocation;
+/**
+ * Generates a list of StoreLocation objects with random data.
+ *
+ * @since 0.5.14
+ * @param {number} quantity The number of objects to be generated
+ * @returns {StoreLocation[]} An array of {@link StoreLocation}s objects
+ */
+export declare const genStoreLocation: (quantity?: number | undefined) => StoreLocation[];

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

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

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

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

package/build/config/constants.d.ts

@@ -0,0 +1,2 @@
+declare const CONSTANTS: {};
+export default CONSTANTS;

package/build/data/products.data.d.ts

@@ -0,0 +1,4 @@
+import { ProductFixedData } from "../types/product.types";
+export declare const foodShopProducts: ProductFixedData[];
+export declare const electronicsProducts: ProductFixedData[];
+export declare const products: ProductFixedData[];

package/build/index.d.ts

@@ -0,0 +1,23 @@
+import * as accountBuilders from "./builders/account.builder";
+import * as bannerBuilders from "./builders/banner.builder";
+import * as billingDataBuilders from "./builders/billingData.builder";
+import * as catalogueBuilders from "./builders/catalogue.builder";
+import * as categoryBuilders from "./builders/category.builder";
+import * as common from "./builders/common.builder";
+import * as countryBuilders from "./builders/country.builder";
+import * as couponBuilders from "./builders/coupon.builder";
+import * as fulfillmentBuilders from "./builders/fulfillment.builder";
+import * as imageBuilders from "./builders/image.builder";
+import * as notificationBuilders from "./builders/notification.builder";
+import * as orderBuilders from "./builders/order.builder";
+import * as paymentBuilders from "./builders/payment.builder";
+import * as productBuilders from "./builders/product.builder";
+import * as settingsBuilders from "./builders/settings.builder";
+import * as shippingAddressBuilders from "./builders/shippingAddress.builder";
+import * as shoppingCartBuilders from "./builders/shoppingCart.builder";
+import * as storeBuilders from "./builders/store.builder";
+import * as userBuilders from "./builders/user.builder";
+import * as vendorBuilders from "./builders/vendor.builder";
+import ArtisnData from "./lib/artisn";
+export { common, accountBuilders, bannerBuilders, billingDataBuilders, categoryBuilders, catalogueBuilders, countryBuilders, couponBuilders, fulfillmentBuilders, imageBuilders, notificationBuilders, orderBuilders, productBuilders, paymentBuilders, settingsBuilders, shippingAddressBuilders, shoppingCartBuilders, vendorBuilders, storeBuilders, userBuilders };
+export default ArtisnData;

package/build/lib/artisn.d.ts

@@ -0,0 +1,5 @@
+import { ECOMMERCE_TYPES } from "../types/artisn.types";
+declare class ArtisnData {
+    constructor(ecommerceType: ECOMMERCE_TYPES);
+}
+export default ArtisnData;