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

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

@@ -1,8 +1,61 @@
+import { ShippingCostTax } from "@artisan-commerce/types";
 import { BillTotal, BillTotalCategory } from "@artisan-commerce/types";
-import { ShoppingCart } from "@artisan-commerce/types";
+import { ShoppingCart, ShippingCost } from "@artisan-commerce/types";
 import { CartStore, Objectify } from "@artisan-commerce/types";
+/**
+ * Generates BillTotalCategory object with random data.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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

@@ -1,11 +1,87 @@
-import { Service } from "@artisan-commerce/types";
+import { Service, Delivery, Schedule } from "@artisan-commerce/types";
 import { Store, AdditionalStoreInformation } from "@artisan-commerce/types";
-import { Delivery, Schedule } from "@artisan-commerce/types";
+import { GenericStoreLocation, StoreLocation } from "@artisan-commerce/types";
+/**
+ * Generates Store object with random data.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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

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

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

@@ -1,15 +1,16 @@
-import * as common from "./builders/common.builder";
 import * as accountBuilders from "./builders/account.builder";
-import * as productBuilders from "./builders/product.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 vendorBuilders from "./builders/vendor.builder";
+import * as couponBuilders from "./builders/coupon.builder";
+import * as productBuilders from "./builders/product.builder";
+import * as shippingAddressBuilders from "./builders/shippingAddress.builder";
 import * as shoppingCartBuilders from "./builders/shoppingCart.builder";
 import * as storeBuilders from "./builders/store.builder";
-import * as channelBuilders from "./builders/channel.builder";
 import * as userBuilders from "./builders/user.builder";
-import * as billingDataBuilders from "./builders/billingData.builder";
-import * as shippingAddressBuilders from "./builders/shippingAddress.builder";
+import * as vendorBuilders from "./builders/vendor.builder";
 import ArtisanData from "./lib/artisan";
-export { common, accountBuilders, productBuilders, categoryBuilders, countryBuilders, vendorBuilders, shoppingCartBuilders, storeBuilders, channelBuilders, userBuilders, billingDataBuilders, shippingAddressBuilders };
+export { common, accountBuilders, productBuilders, categoryBuilders, countryBuilders, vendorBuilders, shoppingCartBuilders, storeBuilders, catalogueBuilders, couponBuilders, userBuilders, billingDataBuilders, shippingAddressBuilders };
 export default ArtisanData;