@artisan-commerce/types 0.13.0 → 0.14.0-canary.0

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.14.0-canary.0](https://bitbucket.org/tradesystem/artisan_sdk/compare/@artisan-commerce/types@0.13.0...@artisan-commerce/types@0.14.0-canary.0) (2021-08-04)
+
+
+### Features
+
+* **global:** add and export missing builders and types ([67ad6ac](https://bitbucket.org/tradesystem/artisan_sdk/commit/67ad6ac8e563aa53c2c62dac86b65f3435a0b16a))
+
+
+
 ## [0.13.0](https://bitbucket.org/tradesystem/artisan_sdk/compare/@artisan-commerce/types@0.13.0-canary.10...@artisan-commerce/types@0.13.0) (2021-07-30)
 
 

package/build/index.d.ts

@@ -1,19 +1,23 @@
-export * from "./types/app.types";
 export * from "./types/account.types";
+export * from "./types/app.types";
 export * from "./types/artisanDB.types";
 export * from "./types/banner.types";
 export * from "./types/billingData.types";
-export * from "./types/category.types";
 export * from "./types/catalogue.types";
+export * from "./types/category.types";
 export * from "./types/common.types";
-export * from "./types/coupon.types";
 export * from "./types/country.types";
+export * from "./types/coupon.types";
 export * from "./types/currency.types";
+export * from "./types/fulfillment.types";
 export * from "./types/http.types";
 export * from "./types/image.types";
 export * from "./types/livingPlace.types";
+export * from "./types/notification.types";
+export * from "./types/order.types";
 export * from "./types/payment.types";
 export * from "./types/product.types";
+export * from "./types/settings.types";
 export * from "./types/shippingAddress.types";
 export * from "./types/shippingCost.types";
 export * from "./types/shoppingCart.types";

package/build/index.js

@@ -11,22 +11,26 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 // Main
-__exportStar(require("./types/app.types"), exports);
 __exportStar(require("./types/account.types"), exports);
+__exportStar(require("./types/app.types"), exports);
 __exportStar(require("./types/artisanDB.types"), exports);
 __exportStar(require("./types/banner.types"), exports);
 __exportStar(require("./types/billingData.types"), exports);
-__exportStar(require("./types/category.types"), exports);
 __exportStar(require("./types/catalogue.types"), exports);
+__exportStar(require("./types/category.types"), exports);
 __exportStar(require("./types/common.types"), exports);
-__exportStar(require("./types/coupon.types"), exports);
 __exportStar(require("./types/country.types"), exports);
+__exportStar(require("./types/coupon.types"), exports);
 __exportStar(require("./types/currency.types"), exports);
+__exportStar(require("./types/fulfillment.types"), exports);
 __exportStar(require("./types/http.types"), exports);
 __exportStar(require("./types/image.types"), exports);
 __exportStar(require("./types/livingPlace.types"), exports);
+__exportStar(require("./types/notification.types"), exports);
+__exportStar(require("./types/order.types"), exports);
 __exportStar(require("./types/payment.types"), exports);
 __exportStar(require("./types/product.types"), exports);
+__exportStar(require("./types/settings.types"), exports);
 __exportStar(require("./types/shippingAddress.types"), exports);
 __exportStar(require("./types/shippingCost.types"), exports);
 __exportStar(require("./types/shoppingCart.types"), exports);

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO;AACP,oDAAkC;AAClC,wDAAsC;AACtC,0DAAwC;AACxC,uDAAqC;AACrC,4DAA0C;AAC1C,yDAAuC;AACvC,0DAAwC;AACxC,uDAAqC;AACrC,uDAAqC;AACrC,wDAAsC;AACtC,yDAAuC;AACvC,qDAAmC;AACnC,sDAAoC;AACpC,4DAA0C;AAC1C,wDAAsC;AACtC,wDAAsC;AACtC,gEAA8C;AAC9C,6DAA2C;AAC3C,6DAA2C;AAC3C,sDAAoC;AACpC,uDAAqC;AACrC,qDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO;AACP,wDAAsC;AACtC,oDAAkC;AAClC,0DAAwC;AACxC,uDAAqC;AACrC,4DAA0C;AAC1C,0DAAwC;AACxC,yDAAuC;AACvC,uDAAqC;AACrC,wDAAsC;AACtC,uDAAqC;AACrC,yDAAuC;AACvC,4DAA0C;AAC1C,qDAAmC;AACnC,sDAAoC;AACpC,4DAA0C;AAC1C,6DAA2C;AAC3C,sDAAoC;AACpC,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,gEAA8C;AAC9C,6DAA2C;AAC3C,6DAA2C;AAC3C,sDAAoC;AACpC,uDAAqC;AACrC,qDAAmC"}

package/build/types/fulfillment.types.d.ts

@@ -0,0 +1,218 @@
+/**
+ * Fulfillment workflow.
+ *
+ * @interface Workflow
+ * @since 0.5.15
+ */
+export interface Workflow {
+    /** Workflow description */
+    description: string;
+    /** Workflow unique identifier */
+    id: number;
+    /** Workflow name */
+    name: string;
+    /** An array of workflow steps, see {@link StepWorkflow}  */
+    steps: StepWorkflow[];
+    /** An array of webhook workflows, see {@link WebhookWorkflow} */
+    webhooks: WebhookWorkflow[];
+}
+/**
+ * The possible values of the step category.
+ *
+ * @typedef StepCategory
+ * @since 0.5.15
+ */
+export declare type StepCategory = "TO_DO" | "PAYMENT_IN_PROGRESS" | "IN_PROGRESS" | "DONE";
+/**
+ * The possible values of the step code.
+ *
+ * @typedef StepCode
+ * @since 0.5.15
+ */
+export declare type StepCode = "START" | "IN_PROGRESS" | "ORDERED" | "RECEIVED" | "TO_ASSIGN" | "ASSIGNED" | "ON_ROUTE" | "DISPATCHED" | "CANCELED" | "ERROR";
+/**
+ * The notification associated with the step.
+ *
+ * @interface StepNotification
+ * @since 0.5.15
+ */
+export interface StepNotification {
+    /** Whether or not to send mail when reaching this step */
+    send_mail: boolean;
+    /** Whether or not to send push when reaching this step */
+    send_push: boolean;
+}
+/**
+ * The step where the workflow is located.
+ *
+ * @interface StepWorkflow
+ * @since 0.5.15
+ */
+export interface StepWorkflow {
+    /** Step workflow additional info, see {@link StepWorkflowAdditionalInfo} */
+    additional_info: StepWorkflowAdditionalInfo;
+    /** Step workflow category, , see {@link StepCategory} */
+    category: StepCategory;
+    /** Step workflow code, , see {@link StepCode} */
+    code: StepCode;
+    /** Step workflow color */
+    color: string;
+    /** Step workflow description */
+    description: string;
+    /** Step workflow description to use on front end */
+    description_frontend: string | null;
+    /** Step workflow id */
+    id: number;
+    /** Step workflow name */
+    name: string;
+    /** Step workflow subtitle to use on front end */
+    subtitle_frontend: string | null;
+    /** Step workflow title to use on front end */
+    title_frontend: string | null;
+    /** Step workflow transitions, see {@link TransitionWorkflow} */
+    transitions: TransitionWorkflow[];
+    /** Step notification, see {@link StepNotification} */
+    notification: StepNotification;
+}
+/**
+ * Step workflow additional info.
+ *
+ * @interface StepWorkflowAdditionalInfo
+ * @since 0.5.15
+ */
+export interface StepWorkflowAdditionalInfo {
+    /** Whether or not to use the step workflow client on front end */
+    client_frontend: boolean;
+    /** Step workflow group, see {@link StepWorkflowGroup} */
+    group: StepWorkflowGroup;
+    /** Whether or not to use the step workflow operators to use on front end */
+    operators_frontend: boolean;
+}
+/**
+ * Step workflow group.
+ *
+ * @interface StepWorkflowGroup
+ * @since 0.5.15
+ */
+export interface StepWorkflowGroup {
+    /** Group code, see {@link StepCode} */
+    code: StepCode;
+    /** Group description */
+    description: string;
+    /** Group type */
+    type: "default";
+    /** Group weight */
+    weight: string;
+}
+/**
+ * The possible transitions of the workflow.
+ *
+ * @interface TransitionWorkflow
+ * @since 0.5.15
+ */
+export interface TransitionWorkflow {
+    /** Channel unique identifier */
+    channel_id: number;
+    /** Transition workflow conditions  */
+    conditions: any[];
+    /** Transition workflow description */
+    description: string;
+    /** The step id where the transition comes from */
+    from_step_id: number;
+    /** Transition workflow unique identifier */
+    id: number;
+    /** Transition workflow name */
+    name: string;
+    /** The step id where the transition can go */
+    to_step_id: number;
+    /** Vendor unique identifier */
+    vendor_id: number;
+}
+/**
+ * Workflow webhook.
+ *
+ * @interface WebhookWorkflow
+ * @since 0.5.15
+ */
+export interface WebhookWorkflow {
+    /** Webhook workflow unique identifier */
+    id: number;
+    /** Webhook workflow method type  */
+    method: string;
+    /** Webhook workflow url */
+    url: string;
+}
+/**
+ * Representation of a Issue object.
+ *
+ * @interface Issue
+ * @since 0.5.15
+ */
+export interface IssueAdditionalInfo {
+    /** User unique identifier */
+    uid: string;
+    /** Array of stores id */
+    stores: number[];
+}
+/**
+ * Representation of a Issue history.
+ *
+ * @interface Issue
+ * @since 0.5.15
+ */
+export interface IssueHistory {
+    /** History unique identifier */
+    id: number;
+    /** Transition unique identifier  */
+    transition_id: number;
+    /** Step unique identifier */
+    step_id: number;
+    /** Step name */
+    step_name: string;
+    /** History additional info, see {@link IssueAdditionalInfo} */
+    additional_info: IssueAdditionalInfo;
+    /** History conditions  */
+    conditions: any[];
+    /** History creation Date */
+    created_at: string;
+    /** History finished Date */
+    finished_at: string;
+}
+/**
+ * Representation of a Issue object.
+ *
+ * @interface Issue
+ * @since 0.5.15
+ */
+export interface Issue {
+    /** Issue unique identifier */
+    id: number;
+    /** Client issue unique identifier */
+    client_issue_id: string;
+    /** Workflow unique identifier */
+    workflow_id: number;
+    /** Parent issue unique identifier */
+    parent_issue_id: null;
+    /** Related issue unique identifier */
+    related_issue_id: null;
+    /** Step unique identifier */
+    step_id: number;
+    /** The step where the issue is located */
+    step: StepWorkflow;
+    /** Account unique identifier */
+    account_id: number;
+    /** Vendor unique identifier */
+    vendor_id: number;
+    /** Children issues */
+    children: any[];
+    /** Related issues */
+    related: any[];
+    /** Issue conditions */
+    conditions: any[];
+    /** Issue additional info, see {@link IssueAdditionalInfo} */
+    additional_info: IssueAdditionalInfo;
+    /** Issue history, see {@link IssueHistory} */
+    history: IssueHistory[];
+    /** Transaction unique identifier  */
+    transaction_id: number | null;
+}

package/build/types/fulfillment.types.js

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

package/build/types/fulfillment.types.js.map

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

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

@@ -66,3 +66,17 @@ export declare type ImageFit = "fill" | "cover" | "contain" | "inside" | "outsid
  * @since 0.5.14
  */
 export declare type ImageToFormat = "jpg" | "jpeg" | "png" | "svg";
+/**
+ * Random image configuration.
+ *
+ * @since 0.5.15
+ * @interface RandomImageConfig
+ */
+export interface RandomImageConfig {
+    /** A word which will be used to generate the random image */
+    query?: string | undefined;
+    /** The width to be used to generate the random image */
+    width?: number;
+    /** The height to be used to generate the random image */
+    height?: number;
+}

package/build/types/notification.types.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Notification object.
+ *
+ * @interface Notification
+ * @since 0.5.15
+ */
+export interface Notification {
+    /** Notification unique identifier */
+    id: number;
+    /** Notification title */
+    title: string;
+    /** Notification description */
+    description: string;
+    /**
+     * Whether or not the notification was read. Purposefully
+     * has a string type.
+     */
+    read: string;
+    /** Notification creation date */
+    creationDate: string;
+}

package/build/types/notification.types.js

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

package/build/types/notification.types.js.map

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

package/build/types/order.types.d.ts

@@ -0,0 +1,175 @@
+import { BillTotalCategory } from "./shoppingCart.types";
+import { ShippingAddress } from "./shippingAddress.types";
+import { BillingData } from "./billingData.types";
+/**
+ * Representation of common properties of the order.
+ *
+ * @interface BaseOrder
+ * @since 0.5.15
+ */
+export interface BaseOrder {
+    /** Order unique identifier */
+    id: number;
+    /** Order additional info */
+    additionalInfo: any[];
+    /** Order additional messages */
+    additionalMessage: string | null;
+    /** Order allocation */
+    allocation: string;
+    /** Channel unique identifier */
+    channelId: number;
+    /** Order date, e.g.: `02 Aug 2021` */
+    orderDate: string;
+    /** Order time, e.g.: `17:00 am` */
+    orderTime: string;
+    /** Pick up date, e.g.: `01 Aug 2021` */
+    pickupDate: string | null;
+    /** Pick up time, e.g.: `09:00 am` */
+    pickupTime: string | null;
+    /** Order sequence id */
+    seq_id: string;
+    /** Shopping cart associated with the order, see {@link OrderShoppingCart} */
+    shoppingCart: OrderShoppingCart;
+    /** Order step, see {@link OrderStep} */
+    step: OrderStep;
+    /** Step category */
+    stepCategory: string;
+    /** Step code */
+    stepCode: string;
+    /** Step unique identifier */
+    stepId: number;
+    /** Step name */
+    stepName: string;
+    /** Order transaction unique identifier */
+    transactionId: number | null;
+    /** Vendor unique identifier */
+    vendorId: number;
+}
+/**
+ * The shopping cart associated with the order.
+ *
+ * @interface OrderShoppingCart
+ * @since 0.5.15
+ */
+export interface OrderShoppingCart {
+    /** Order bill total category, see {@link BillTotalCategory} */
+    billTotal: BillTotalCategory;
+    /**
+     * An array of the order paid payment methods,
+     * see {@link OrderPaidPaymentMethod}
+     */
+    paidPaymentMethods: OrderPaidPaymentMethod[];
+    /** An array of order stores, see {@link OrderStore} */
+    stores: OrderStore[];
+}
+/**
+ * Store associated with the order.
+ *
+ * @interface OrderStore
+ * @since 0.5.15
+ */
+export interface OrderStore {
+    /**
+     * An array of products associated with the order,
+     * see {@link OrderProduct}
+     */
+    products: OrderProduct[];
+    /** Store name */
+    storeName: string;
+}
+/**
+ * Product associated with the order.
+ *
+ * @interface OrderProduct
+ * @since 0.5.15
+ */
+export interface OrderProduct {
+    /** Product unique identifier */
+    productId: number;
+    /** Product name */
+    productName: string;
+}
+/**
+ * Paid payment methods associated with the order.
+ *
+ * @interface OrderPaidPaymentMethod
+ * @since 0.5.15
+ */
+export interface OrderPaidPaymentMethod {
+    /** Order paid payment methods */
+    payment_method_name: string;
+    /** Order last retry, see {@link OrderLastRetry} */
+    lastRetry: OrderLastRetry;
+}
+/**
+ * The last retry of the order.
+ *
+ * @interface OrderLastRetry
+ * @since 0.5.15
+ */
+export interface OrderLastRetry {
+    /** Order last retry step */
+    step: OrderStep;
+}
+/**
+ * The step where the order is located.
+ *
+ * @interface OrderStep
+ * @since 0.5.15
+ */
+export interface OrderStep {
+    /** Step title to use on front end */
+    title_frontend: string;
+    /** Step description to use on front end */
+    description_frontend: string;
+}
+/**
+ * The details of the order.
+ *
+ * @interface OrderDetails
+ * @since 0.5.15
+ * @extends {{@link BaseOrder}
+ */
+export interface OrderDetails extends BaseOrder {
+    /** Order details' shipping address */
+    shippingAddress: ShippingAddress;
+    /** Order details' shipping cost, see {@link OrderDetailShippingCost} */
+    shippingCost: OrderDetailShippingCost;
+    /** Order details' billing data */
+    billingData: BillingData;
+}
+/**
+ * The shipping cost associated with the order.
+ *
+ * @interface OrderDetailShippingCost
+ * @since 0.5.15
+ */
+export interface OrderDetailShippingCost {
+    /** Shipping cost net price */
+    net_price: number;
+}
+/**
+ * Representation of a Commerce Order.
+ *
+ * @typedef Order
+ * @since 0.5.15
+ */
+export declare type Order = BaseOrder | OrderDetails;
+/**
+ * Order payload that will be created.
+ *
+ * @interface PostOrderDetailsPayload
+ * @since 0.5.15
+ */
+export interface PostOrderDetailsPayload {
+    /** Order unique identifier */
+    orderId: number;
+    /** Order payment method unique identifier */
+    paymentMethodId: number;
+    /** Order payment amount */
+    paymentAmount: string;
+    /** Order customer cash amount  */
+    customerCashAmount: string;
+    /** Order comment */
+    comment: string;
+}

package/build/types/order.types.js

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

package/build/types/order.types.js.map

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

package/build/types/settings.types.d.ts

@@ -0,0 +1,23 @@
+/**
+ * User preferences.
+ *
+ * @interface UserSettings
+ * @since 0.5.15
+ */
+export interface UserSettings {
+    /** Individual settings, see {@link Settings} */
+    settings: Settings;
+    /** User unique identifier */
+    uid: string;
+}
+/**
+ * Individual user settings.
+ *
+ * @typedef Settings
+ * @since 0.5.15
+ * @property {boolean} `[key: string]` An object where its key is a string
+ * and its value is a boolean
+ */
+export declare type Settings = {
+    [key: string]: boolean;
+};

package/build/types/settings.types.js

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

package/build/types/settings.types.js.map

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/types",
   "description": "Artisan's types and interfaces library",
-  "version": "0.13.0",
+  "version": "0.14.0-canary.0",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
   "files": [
@@ -42,5 +42,5 @@
     "prettier": "^2.1.2",
     "webpack-bundle-analyzer": "^3.9.0"
   },
-  "gitHead": "67d5892dc7a40d6ba5f1c7bbbdf6423d97899ac3"
+  "gitHead": "67a0e97fc13da2a0ea8fc7bc40440b4f4e6e115a"
 }