@artisan-commerce/types 0.13.0-canary.9 → 0.13.0

package/build/types/country.types.d.ts

@@ -1,18 +1,51 @@
+/**
+ * Representation of a Commerce Country.
+ *
+ * @interface Country
+ * @since 0.5.14
+ */
 export interface Country {
+    /** Country's id */
     countryId: string;
+    /** Country's name */
     name: string;
+    /** Country ISO code, e.g.: EC */
     code: string;
+    /** Whether or not the country is active */
     active: boolean;
+    /**
+     * Object which contains information about country's currency,
+     *  see {@link CountryCurrency}
+     */
     currency: CountryCurrency;
+    /** Array of taxes usually applied on the country, see {@link CountryTax} */
     taxes: CountryTax[];
 }
+/**
+ * Representation of a country's currency.
+ *
+ * @interface CountryCurrency
+ * @since 0.5.14
+ */
 export interface CountryCurrency {
+    /** Currency's id */
     currencyId: string;
+    /**  Currency's name */
     name: string;
+    /** Currency's symbol */
     sign: string;
 }
+/**
+ * Representation of a country's tax.
+ *
+ * @interface CountryTax
+ * @since 0.5.14
+ */
 export interface CountryTax {
+    /** Tax name */
     tax: string;
+    /** Value added tax rate */
     vatRate: string;
-    percentage: string;
+    /** Tax percentage */
+    percentage: number;
 }

package/build/types/coupon.types.d.ts

@@ -0,0 +1,112 @@
+import { ArtisanDBCollectionReference } from "./artisanDB.types";
+import { ArtisanDBQueryDocumentSnapshot } from "./artisanDB.types";
+import { ArtisanDBDocumentData } from "./artisanDB.types";
+import { Image } from "./image.types";
+/**
+ * Wallet user information.
+ *
+ * @interface Wallet
+ * @since 0.5.14
+ */
+export interface Wallet {
+    /** {@link Benefit}'s array from firestore user wallet */
+    benefits: Benefit[];
+}
+/**
+ * Benefit information.
+ *
+ * @interface Benefit
+ * @since 0.5.14
+ */
+export interface Benefit {
+    /** The user wallet id */
+    hash: string;
+    /** The benefit awards, see {@link Award} */
+    award: Award;
+    /** Benefit id */
+    benefitId: number;
+    /** Benefit wallet id */
+    benefitWalletId: number;
+    /** Benefit code in back-end */
+    code: null;
+    /** Combined */
+    combined: string;
+    /** Benefit creation date */
+    createdAt: string;
+    /** Benefit description */
+    description: string;
+    /** Benefit discount percentage */
+    discountPercentage: number;
+    /** Benefit expiration date */
+    expirationDate: string;
+    /** External benefit id */
+    externalId: null;
+    /** Benefit images, see {@link Image} */
+    image: Image[];
+    /** The award limit */
+    limitAward: null;
+    /** The benefit limit */
+    limitBenefit: number;
+    /** The logic operator of the benefit */
+    logicOperator: string;
+    /** Benefit stock */
+    quantity: number;
+    /** The rules of the benefit */
+    rules: any[];
+    /** The benefit title */
+    title: string;
+    /** Benefit type, see {@link BenefitTypes} */
+    type: BenefitTypes;
+    /** Benefit update date */
+    updatedAt: string;
+    /** The channel id of the benefit */
+    channelId: number;
+    /** The vendor id of the benefit */
+    vendorId: number;
+    /** The account id of the benefit */
+    accountId: number;
+}
+/**
+ * Award information.
+ *
+ * @interface Award
+ * @since 0.5.14
+ */
+export interface Award {
+    /** The id of the award */
+    id: number;
+    /** The id of the benefit */
+    benefitId: number;
+    /** Benefit discount percentage */
+    discountPercentage: number;
+    /** Benefit discount value */
+    discountValue: null;
+}
+/**
+ * Applied benefit array in shopping cart.
+ *
+ * @typedef ShoppingCartBenefits
+ * @since 0.5.14
+ */
+export declare type ShoppingCartBenefits = Benefit[];
+/**
+ * A benefit DB node from a user.
+ *
+ * @typedef BenefitsByUserNode
+ * @since 0.5.14
+ */
+export declare type BenefitsByUserNode = ArtisanDBQueryDocumentSnapshot<ArtisanDBDocumentData>;
+/**
+ * The complete collection of benefits DB nodes from a user.
+ *
+ * @typedef BenefitsByUserNodes
+ * @since 0.5.14
+ */
+export declare type BenefitsByUserNodes = ArtisanDBCollectionReference<ArtisanDBDocumentData>;
+/**
+ * The possible values of the benefit type.
+ *
+ * @typedef BenefitTypes
+ * @since 0.5.14
+ */
+export declare type BenefitTypes = "ALTER_DELIVERY" | "PRODUCT" | "DISCOUNT";

package/build/types/{channel.types.js → coupon.types.js}

@@ -1,4 +1,4 @@
 "use strict";
-// Channel types and interfaces
+// Coupons types and interfaces
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=channel.types.js.map
+//# sourceMappingURL=coupon.types.js.map

package/build/types/coupon.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coupon.types.js","sourceRoot":"","sources":["../../src/types/coupon.types.ts"],"names":[],"mappings":";AAAA,+BAA+B"}

package/build/types/http.types.d.ts

@@ -1,19 +1,64 @@
+/**
+ * Representation of a Artisan request.
+ *
+ * @interface ArtisanRequest
+ * @since 0.5.14
+ */
 export interface ArtisanRequest {
+    /** Request's url */
     url: string;
+    /** Request's headers, see {@link ArtisanRequestHeaders} */
     headers: ArtisanRequestHeaders;
+    /** Request's body, see {@link ArtisanRequestBody} */
     body: ArtisanRequestBody;
+    /** Request's query, see {@link ArtisanQuery} */
     query: ArtisanQuery;
+    /** Request's params, see {@link ArtisanParams} */
     params: ArtisanParams;
+    /** Request's method, see {@link ArtisanRequestMethod} */
     method?: ArtisanRequestMethod;
 }
+/**
+ * Artisan request headers based on the fetch API.
+ *
+ * @typedef ArtisanRequestHeaders
+ * @since 0.5.14
+ */
 export declare type ArtisanRequestHeaders = Headers;
+/**
+ * Allowed methods for requests.
+ *
+ * @typedef ArtisanRequestMethod
+ * @since 0.5.14
+ */
 export declare type ArtisanRequestMethod = "POST" | "GET" | "PUT" | "DELETE" | "PATCH";
+/**
+ * Artisan request's body.
+ *
+ * @interface ArtisanRequestBody
+ * @since 0.5.14
+ * @property {any} [key:string] Object with key-value pairs
+ */
 export interface ArtisanRequestBody {
     [key: string]: any;
 }
+/**
+ * Artisan request's body.
+ *
+ * @interface ArtisanQuery
+ * @since 0.5.14
+ * @property {string | number | boolean} [key:string] Object with key-value pairs
+ */
 export interface ArtisanQuery {
     [key: string]: string | number | boolean;
 }
+/**
+ * Artisan request's params.
+ *
+ * @interface ArtisanParams
+ * @since 0.5.14
+ * @property {string | number} [key:string] Object with key-value pairs
+ */
 export interface ArtisanParams {
     [key: string]: string | number;
 }

package/build/types/image.types.d.ts

@@ -1,16 +1,68 @@
+/**
+ * Representation of a image allocated in a CDN.
+ *
+ * @interface CDNImage
+ * @since 0.5.14
+ */
 export interface CDNImage {
+    /** The bucket where the image is located */
     bucket?: string;
+    /** The cloud where the image is saved */
     cloudFrontUrl?: string;
+    /** The directory where the image is saved */
     key?: string;
+    /** Image's name */
     name: string;
+    /** The url where the image is saved */
     url: string;
+    /** The base 64 image value */
     base64?: string;
 }
+/**
+ * A image url.
+ *
+ * @typedef URLImage
+ * @since 0.5.14
+ */
 export declare type URLImage = string;
+/**
+ * Configuration on how to setup the cloudfront image manipulation.
+ *
+ * @since 0.5.14
+ * @interface ImageManipulationConfig
+ */
 export interface ImageManipulationConfig {
+    /** Image's width */
     width?: number;
+    /** Image's height */
     height?: number;
-    fit?: "fill" | "cover" | "contain" | "inside" | "outside";
-    toFormat?: "jpg" | "jpeg" | "png" | "svg";
+    /** Determines how to resize the image, see {@link ImageFit} */
+    fit?: ImageFit;
+    /**
+     * Determines in which format the resulting image must be,
+     * see {@link ImageToFormat}
+     */
+    toFormat?: ImageToFormat;
 }
+/**
+ * Representation of a Commerce Image which could be a
+ * {@link CDNImage} or a {@link URLImage}.
+ *
+ * @typedef Image
+ * @since 0.5.14
+ */
 export declare type Image = CDNImage | URLImage;
+/**
+ * Contains different properties on how to resize the image.
+ *
+ * @typedef ImageFit
+ * @since 0.5.14
+ */
+export declare type ImageFit = "fill" | "cover" | "contain" | "inside" | "outside";
+/**
+ * Contains different image formats.
+ *
+ * @typedef ImageToFormat
+ * @since 0.5.14
+ */
+export declare type ImageToFormat = "jpg" | "jpeg" | "png" | "svg";

package/build/types/livingPlace.types.d.ts

@@ -1,31 +1,92 @@
+/**
+ * Representation of a living place base object.
+ *
+ * @interface BaseLivingPlace
+ * @since 0.5.14
+ */
 export interface BaseLivingPlace {
+    /** Living place's id */
     id: number;
 }
+/**
+ * Representation of a living place.
+ *
+ * @interface LivingPlace
+ * @since 0.5.14
+ * @extends {{@link BaseLivingPlace}
+ */
 export interface LivingPlace extends BaseLivingPlace {
+    /** Living place's name  */
     name: string;
+    /** Whether or not the living place is active */
     active: number;
+    /** Country unique identifier */
     countryId: number;
+    /** Array of fields required to save a living place, see {@link Field} */
     fields: Field[];
 }
+/**
+ * Representation of a living place which will be saved.
+ *
+ * @interface LivingPlaceToSave
+ * @since 0.5.14
+ * @extends {{@link BaseLivingPlace}
+ */
 export interface LivingPlaceToSave extends BaseLivingPlace {
+    /** Array of fields to be saved, see {@link FieldRecord} */
     fields: FieldRecord[];
 }
+/**
+ * Representation of a field object.
+ *
+ * @interface Field
+ * @since 0.5.14
+ */
 export interface Field {
+    /** Field's id */
     id: string;
+    /** Field's label */
     label: string;
-    rules: Rules;
-    messages: Messages;
+    /** Field's rules, see {@link Rules} */
+    rules: Rule;
+    /** Field's messages based on rules, see {@link Messages} */
+    messages: Message;
+    /** Field's value */
     value?: string;
 }
+/**
+ * Representation of a field record.
+ *
+ * @interface FieldRecord
+ * @since 0.5.14
+ */
 export interface FieldRecord {
+    /** Field record's id */
     id: string;
+    /** Field record's value */
     value: string;
 }
-export interface Messages {
+/**
+ * Messages for living places.
+ *
+ * @interface Message
+ * @since 0.5.14
+ */
+export interface Message {
+    /** The maximum number's message of allowed living places */
     max: string;
+    /** The minimum number's message of allowed living places */
     min: string;
 }
-export interface Rules {
+/**
+ * Rules for living places.
+ *
+ * @interface Rule
+ * @since 0.5.14
+ */
+export interface Rule {
+    /** The maximum number of allowed living places */
     max: number;
+    /** The minimum number of allowed living places */
     min: number;
 }

package/build/types/livingPlace.types.js

@@ -1,3 +1,4 @@
 "use strict";
+// Living place types and interfaces
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=livingPlace.types.js.map

package/build/types/livingPlace.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"livingPlace.types.js","sourceRoot":"","sources":["../../src/types/livingPlace.types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"livingPlace.types.js","sourceRoot":"","sources":["../../src/types/livingPlace.types.ts"],"names":[],"mappings":";AAAA,oCAAoC"}

package/build/types/payment.types.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Basic payment method object.
+ *
+ * @interface BasePaymentMethod
+ * @since 0.5.14
+ */
+export interface BasePaymentMethod {
+    /** Payment method's id */
+    id: number;
+    /** Payment method's created date */
+    created_at: string | null;
+    /** Payment method's updated date */
+    updated_at: string | null;
+    /** Payment method's deleted date */
+    deleted_at: string | null;
+}
+/**
+ * Representation of a Commerce Payment method.
+ *
+ * @interface PaymentMethod
+ * @since 0.5.14
+ * @extends {{@link BasePaymentMethod}
+ */
+export interface PaymentMethod extends BasePaymentMethod {
+    /** Payment method's name, see {@link PaymentMethodName} */
+    name: PaymentMethodName;
+    /** Payment method image's url, commonly used to save image cards */
+    image_url: string;
+    /** Whether or not the payment method is default */
+    default: boolean;
+    /** Payment method's external id */
+    external_id: string | null;
+    /** Payment method's external code */
+    external_code: number;
+    /** Payment method's parent id */
+    parent_id: string | null;
+    /** Payment method cards' allowed brands, see {@link CreditCardBrand} */
+    methods: CreditCardBrand[];
+}
+/**
+ * Representation of a credit card brand.
+ *
+ * @interface CreditCardBrand
+ * @since 0.5.14
+ * @extends {{@link PaymentMethod}
+ */
+export interface CreditCardBrand extends PaymentMethod {
+    /** Payment method cards' allowed brands, see {@link CreditCardMappings}*/
+    cc_brands: CreditCardMapping[];
+}
+/**
+ * Representation of a credit card brand.
+ *
+ * @interface CreditCardMapping
+ * @since 0.5.14
+ * @extends {{@link BasePaymentMethod}
+ */
+export interface CreditCardMapping extends BasePaymentMethod {
+    /** Credit card mapping unique identifier */
+    id: number;
+    /** Credit card mapping name, see {@link CardName} */
+    name: CardName;
+    /** Payment method image's url, commonly used to save image cards */
+    image_url: string;
+    /** Mapping of credit cards */
+    cc_brands_mapping: unknown[];
+}
+/**
+ * Payment method common names.
+ *
+ * @typedef PaymentMethodName
+ * @since 0.5.14
+ */
+export declare type PaymentMethodName = "CREDIT_CARD" | "CASH";
+/**
+ * Cards common names.
+ *
+ * @typedef CardName
+ * @since 0.5.14
+ */
+export declare type CardName = "Diners" | "Discover" | "American Express" | "Visa" | "MasterCard";

package/build/types/payment.types.js

@@ -0,0 +1,4 @@
+"use strict";
+// Payment types and interfaces
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=payment.types.js.map

package/build/types/payment.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment.types.js","sourceRoot":"","sources":["../../src/types/payment.types.ts"],"names":[],"mappings":";AAAA,+BAA+B"}