@8medusa/utils 2.7.0

package/dist/feature-flags/publishable-api-keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publishable-api-keys.js","sourceRoot":"","sources":["../../src/feature-flags/publishable-api-keys.ts"],"names":[],"mappings":";;;AAEa,QAAA,6BAA6B,GAAkC;IAC1E,GAAG,EAAE,sBAAsB;IAC3B,WAAW,EAAE,IAAI;IACjB,OAAO,EAAE,gCAAgC;IACzC,WAAW,EAAE,+CAA+C;CAC7D,CAAA"}

package/dist/feature-flags/sales-channels.d.ts

@@ -0,0 +1,3 @@
+import { FeatureFlagTypes } from "@8medusa/types";
+export declare const SalesChannelFeatureFlag: FeatureFlagTypes.FlagSettings;
+//# sourceMappingURL=sales-channels.d.ts.map

package/dist/feature-flags/sales-channels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sales-channels.d.ts","sourceRoot":"","sources":["../../src/feature-flags/sales-channels.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAEjD,eAAO,MAAM,uBAAuB,EAAE,gBAAgB,CAAC,YAKtD,CAAA"}

package/dist/feature-flags/sales-channels.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SalesChannelFeatureFlag = void 0;
+exports.SalesChannelFeatureFlag = {
+    key: "sales_channels",
+    default_val: true,
+    env_key: "MEDUSA_FF_SALES_CHANNELS",
+    description: "[WIP] Enable the sales channels feature",
+};
+//# sourceMappingURL=sales-channels.js.map

package/dist/feature-flags/sales-channels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sales-channels.js","sourceRoot":"","sources":["../../src/feature-flags/sales-channels.ts"],"names":[],"mappings":";;;AAEa,QAAA,uBAAuB,GAAkC;IACpE,GAAG,EAAE,gBAAgB;IACrB,WAAW,EAAE,IAAI;IACjB,OAAO,EAAE,0BAA0B;IACnC,WAAW,EAAE,yCAAyC;CACvD,CAAA"}

package/dist/feature-flags/tax-inclusive-pricing.d.ts

@@ -0,0 +1,3 @@
+import { FeatureFlagTypes } from "@8medusa/types";
+export declare const TaxInclusivePricingFeatureFlag: FeatureFlagTypes.FlagSettings;
+//# sourceMappingURL=tax-inclusive-pricing.d.ts.map

package/dist/feature-flags/tax-inclusive-pricing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-inclusive-pricing.d.ts","sourceRoot":"","sources":["../../src/feature-flags/tax-inclusive-pricing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAEjD,eAAO,MAAM,8BAA8B,EAAE,gBAAgB,CAAC,YAK7D,CAAA"}

package/dist/feature-flags/tax-inclusive-pricing.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaxInclusivePricingFeatureFlag = void 0;
+exports.TaxInclusivePricingFeatureFlag = {
+    key: "tax_inclusive_pricing",
+    default_val: false,
+    env_key: "MEDUSA_FF_TAX_INCLUSIVE_PRICING",
+    description: "[WIP] Enable tax inclusive pricing",
+};
+//# sourceMappingURL=tax-inclusive-pricing.js.map

package/dist/feature-flags/tax-inclusive-pricing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-inclusive-pricing.js","sourceRoot":"","sources":["../../src/feature-flags/tax-inclusive-pricing.ts"],"names":[],"mappings":";;;AAEa,QAAA,8BAA8B,GAAkC;IAC3E,GAAG,EAAE,uBAAuB;IAC5B,WAAW,EAAE,KAAK;IAClB,OAAO,EAAE,iCAAiC;IAC1C,WAAW,EAAE,oCAAoC;CAClD,CAAA"}

package/dist/feature-flags/utils/flag-router.d.ts

@@ -0,0 +1,32 @@
+import { FeatureFlagTypes } from "@8medusa/types";
+export declare class FlagRouter implements FeatureFlagTypes.IFlagRouter {
+    private readonly flags;
+    constructor(flags: Record<string, boolean | Record<string, boolean>>);
+    /**
+     * Check if a feature flag is enabled.
+     * There are two ways of using this method:
+     * 1. `isFeatureEnabled("myFeatureFlag")`
+     * 2. `isFeatureEnabled({ myNestedFeatureFlag: "someNestedFlag" })`
+     * We use 1. for top-level feature flags and 2. for nested feature flags. Almost all flags are top-level.
+     * An example of a nested flag is workflows. To use it, you would do:
+     * `isFeatureEnabled({ workflows: Workflows.CreateCart })`
+     * @param flag - The flag to check
+     * @return {boolean} - Whether the flag is enabled or not
+     */
+    isFeatureEnabled(flag: string | string[] | Record<string, string>): boolean;
+    /**
+     * Sets a feature flag.
+     * Flags take two shapes:
+     * `setFlag("myFeatureFlag", true)`
+     * `setFlag("myFeatureFlag", { nestedFlag: true })`
+     * These shapes are used for top-level and nested flags respectively, as explained in isFeatureEnabled.
+     * @param key - The key of the flag to set.
+     * @param value - The value of the flag to set.
+     * @return {void} - void
+     */
+    setFlag(key: string, value: boolean | {
+        [key: string]: boolean;
+    }): void;
+    listFlags(): FeatureFlagTypes.FeatureFlagsResponse;
+}
+//# sourceMappingURL=flag-router.d.ts.map

package/dist/feature-flags/utils/flag-router.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flag-router.d.ts","sourceRoot":"","sources":["../../../src/feature-flags/utils/flag-router.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAGjD,qBAAa,UAAW,YAAW,gBAAgB,CAAC,WAAW;IAC7D,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAwD;gBAElE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAIpE;;;;;;;;;;OAUG;IACI,gBAAgB,CACrB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/C,OAAO;IAkBV;;;;;;;;;OASG;IACI,OAAO,CACZ,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAC1C,IAAI;IAgBA,SAAS,IAAI,gBAAgB,CAAC,oBAAoB;CAM1D"}

package/dist/feature-flags/utils/flag-router.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlagRouter = void 0;
+const common_1 = require("../../common");
+class FlagRouter {
+    constructor(flags) {
+        this.flags = {};
+        this.flags = flags;
+    }
+    /**
+     * Check if a feature flag is enabled.
+     * There are two ways of using this method:
+     * 1. `isFeatureEnabled("myFeatureFlag")`
+     * 2. `isFeatureEnabled({ myNestedFeatureFlag: "someNestedFlag" })`
+     * We use 1. for top-level feature flags and 2. for nested feature flags. Almost all flags are top-level.
+     * An example of a nested flag is workflows. To use it, you would do:
+     * `isFeatureEnabled({ workflows: Workflows.CreateCart })`
+     * @param flag - The flag to check
+     * @return {boolean} - Whether the flag is enabled or not
+     */
+    isFeatureEnabled(flag) {
+        if ((0, common_1.isObject)(flag)) {
+            const [nestedFlag, value] = Object.entries(flag)[0];
+            if (typeof this.flags[nestedFlag] === "boolean") {
+                return this.flags[nestedFlag];
+            }
+            return !!this.flags[nestedFlag]?.[value];
+        }
+        const flags = (Array.isArray(flag) ? flag : [flag]);
+        return flags.every((flag_) => {
+            if (!(0, common_1.isString)(flag_)) {
+                throw Error("Flag must be a string an array of string or an object");
+            }
+            return !!this.flags[flag_];
+        });
+    }
+    /**
+     * Sets a feature flag.
+     * Flags take two shapes:
+     * `setFlag("myFeatureFlag", true)`
+     * `setFlag("myFeatureFlag", { nestedFlag: true })`
+     * These shapes are used for top-level and nested flags respectively, as explained in isFeatureEnabled.
+     * @param key - The key of the flag to set.
+     * @param value - The value of the flag to set.
+     * @return {void} - void
+     */
+    setFlag(key, value) {
+        if ((0, common_1.isObject)(value)) {
+            const existing = this.flags[key];
+            if (!existing) {
+                this.flags[key] = value;
+                return;
+            }
+            this.flags[key] = { ...this.flags[key], ...value };
+            return;
+        }
+        this.flags[key] = value;
+    }
+    listFlags() {
+        return Object.entries(this.flags || {}).map(([key, value]) => ({
+            key,
+            value,
+        }));
+    }
+}
+exports.FlagRouter = FlagRouter;
+//# sourceMappingURL=flag-router.js.map

package/dist/feature-flags/utils/flag-router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flag-router.js","sourceRoot":"","sources":["../../../src/feature-flags/utils/flag-router.ts"],"names":[],"mappings":";;;AACA,yCAAiD;AAEjD,MAAa,UAAU;IAGrB,YAAY,KAAwD;QAFnD,UAAK,GAAsD,EAAE,CAAA;QAG5E,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAED;;;;;;;;;;OAUG;IACI,gBAAgB,CACrB,IAAgD;QAEhD,IAAI,IAAA,iBAAQ,EAAC,IAAI,CAAC,EAAE,CAAC;YACnB,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;YACnD,IAAI,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,SAAS,EAAE,CAAC;gBAChD,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAY,CAAA;YAC1C,CAAC;YACD,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,CAAC,CAAA;QAC1C,CAAC;QAED,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAa,CAAA;QAC/D,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3B,IAAI,CAAC,IAAA,iBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,MAAM,KAAK,CAAC,uDAAuD,CAAC,CAAA;YACtE,CAAC;YACD,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,OAAO,CACZ,GAAW,EACX,KAA2C;QAE3C,IAAI,IAAA,iBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;YACpB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAEhC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;gBACvB,OAAM;YACR,CAAC;YAED,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,GAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAY,EAAE,GAAG,KAAK,EAAE,CAAA;YAC9D,OAAM;QACR,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IACzB,CAAC;IAEM,SAAS;QACd,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;YAC7D,GAAG;YACH,KAAK;SACN,CAAC,CAAC,CAAA;IACL,CAAC;CACF;AAzED,gCAyEC"}

package/dist/feature-flags/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./flag-router";
+//# sourceMappingURL=index.d.ts.map

package/dist/feature-flags/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/feature-flags/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA"}

package/dist/feature-flags/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./flag-router"), exports);
+//# sourceMappingURL=index.js.map

package/dist/feature-flags/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/feature-flags/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA6B"}

package/dist/feature-flags/workflows.d.ts

@@ -0,0 +1,3 @@
+import { FeatureFlagTypes } from "@8medusa/types";
+export declare const WorkflowsFeatureFlag: FeatureFlagTypes.FlagSettings;
+//# sourceMappingURL=workflows.d.ts.map

package/dist/feature-flags/workflows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.d.ts","sourceRoot":"","sources":["../../src/feature-flags/workflows.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAEjD,eAAO,MAAM,oBAAoB,EAAE,gBAAgB,CAAC,YAKnD,CAAA"}

package/dist/feature-flags/workflows.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowsFeatureFlag = void 0;
+exports.WorkflowsFeatureFlag = {
+    key: "workflows",
+    default_val: false,
+    env_key: "MEDUSA_FF_WORKFLOWS",
+    description: "[WIP] Enable workflows",
+};
+//# sourceMappingURL=workflows.js.map

package/dist/feature-flags/workflows.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.js","sourceRoot":"","sources":["../../src/feature-flags/workflows.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAkC;IACjE,GAAG,EAAE,WAAW;IAChB,WAAW,EAAE,KAAK;IAClB,OAAO,EAAE,qBAAqB;IAC9B,WAAW,EAAE,wBAAwB;CACtC,CAAA"}

package/dist/file/abstract-file-provider.d.ts

@@ -0,0 +1,160 @@
+import { FileTypes, IFileProvider } from "@8medusa/types";
+/**
+ * ### constructor
+ *
+ * The constructor allows you to access resources from the module's container using the first parameter,
+ * and the module's options using the second parameter.
+ *
+ * If you're creating a client or establishing a connection with a third-party service, do it in the constructor.
+ *
+ * #### Example
+ *
+ * ```ts
+ * import { Logger } from "@8medusa/framework/types"
+ * import { AbstractFileProviderService } from "@8medusa/framework/utils"
+ *
+ * type InjectedDependencies = {
+ *   logger: Logger
+ * }
+ *
+ * type Options = {
+ *   apiKey: string
+ * }
+ *
+ * class MyFileProviderService extends AbstractFileProviderService {
+ *   protected logger_: Logger
+ *   protected options_: Options
+ *   static identifier = "my-file"
+ *   // assuming you're initializing a client
+ *   protected client
+ *
+ *   constructor (
+ *     { logger }: InjectedDependencies,
+ *     options: Options
+ *   ) {
+ *     super()
+ *
+ *     this.logger_ = logger
+ *     this.options_ = options
+ *
+ *     // assuming you're initializing a client
+ *     this.client = new Client(options)
+ *   }
+ * }
+ *
+ * export default MyFileProviderService
+ * ```
+ */
+export declare class AbstractFileProviderService implements IFileProvider {
+    /**
+     * Each file provider has a unique ID used to identify it. The provider's ID
+     * will be stored as `fs_{identifier}_{id}`, where `{id}` is the provider's `id`
+     * property in the `medusa-config.ts`.
+     *
+     * @example
+     * class MyFileProviderService extends AbstractFileProviderService {
+     *   static identifier = "my-file"
+     *   // ...
+     * }
+     */
+    static identifier: string;
+    /**
+     * This method validates the options of the provider set in `medusa-config.ts`.
+     * Implementing this method is optional. It's useful if your provider requires custom validation.
+     *
+     * If the options aren't valid, throw an error.
+     *
+     * @param options - The provider's options.
+     *
+     * @example
+     * class MyFileProviderService extends AbstractFileProviderService {
+     *   static validateOptions(options: Record<any, any>) {
+     *     if (!options.apiKey) {
+     *       throw new MedusaError(
+     *         MedusaError.Types.INVALID_DATA,
+     *         "API key is required in the provider's options."
+     *       )
+     *     }
+     *   }
+     * }
+     */
+    static validateOptions(options: Record<any, any>): void | never;
+    /**
+     * @ignore
+     */
+    getIdentifier(): any;
+    /**
+     * This method uploads a file using your provider's custom logic. In this method, you can upload the file
+     * into your provider's storage, and return the uploaded file's details.
+     *
+     * This method will be used when uploading product images, CSV files for imports, or other
+     * custom file uploads.
+     *
+     * @param {FileTypes.ProviderUploadFileDTO} file - The file to upload.
+     * @returns {Promise<FileTypes.ProviderFileResultDTO>} The uploaded file's details.
+     *
+     * @example
+     * class MyFileProviderService extends AbstractFileProviderService {
+     *   // ...
+     *   async upload(
+     *     file: ProviderUploadFileDTO
+     *   ): Promise<ProviderFileResultDTO> {
+     *     // TODO upload file to third-party provider
+     *     // or using custom logic
+     *     // for example:
+     *     this.client.upload(file)
+     *
+     *     return {
+     *       url: "some-url.com",
+     *       key: "file-name-or-id"
+     *     }
+     *   }
+     * }
+     */
+    upload(file: FileTypes.ProviderUploadFileDTO): Promise<FileTypes.ProviderFileResultDTO>;
+    /**
+     * This method deletes the file from storage. It's used when an admin user deletes a product image,
+     * or other custom file deletions.
+     *
+     * @param {FileTypes.ProviderDeleteFileDTO} file - The details of the file to delete.
+     * @returns {Promise<void>} Resolves when the file is deleted.
+     *
+     * @example
+     * class MyFileProviderService extends AbstractFileProviderService {
+     *   // ...
+     *   async delete(file: ProviderDeleteFileDTO): Promise<void> {
+     *     // TODO logic to remove the file from storage
+     *     // Use the `file.fileKey` to delete the file
+     *     // for example:
+     *     this.client.delete(file.fileKey)
+     *   }
+     * }
+     */
+    delete(file: FileTypes.ProviderDeleteFileDTO): Promise<void>;
+    /**
+     * This method is used to retrieve a download URL of the file. For some providers,
+     * such as S3, a presigned URL indicates a temporary URL to get access to a file.
+     *
+     * If your provider doesn’t perform or offer a similar functionality, you can
+     * return the URL to download the file.
+     *
+     * @param {FileTypes.ProviderGetFileDTO} fileData - The details of the file to get its
+     * presigned URL.
+     * @returns {Promise<string>} The file's presigned URL.
+     *
+     * @example
+     * class MyFileProviderService extends AbstractFileProviderService {
+     *   // ...
+     *   async getPresignedDownloadUrl(
+     *     fileData: ProviderGetFileDTO
+     *   ): Promise<string> {
+     *     // TODO logic to get the presigned URL
+     *     // Use the `file.fileKey` to delete the file
+     *     // for example:
+     *     return this.client.getPresignedUrl(fileData.fileKey)
+     *   }
+     * }
+     */
+    getPresignedDownloadUrl(fileData: FileTypes.ProviderGetFileDTO): Promise<string>;
+}
+//# sourceMappingURL=abstract-file-provider.d.ts.map

package/dist/file/abstract-file-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-file-provider.d.ts","sourceRoot":"","sources":["../../src/file/abstract-file-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,qBAAa,2BAA4B,YAAW,aAAa;IAC/D;;;;;;;;;;OAUG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,GAAG,KAAK;IAE/D;;OAEG;IACH,aAAa;IAIb;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,GACpC,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC;IAI3C;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,uBAAuB,CAC3B,QAAQ,EAAE,SAAS,CAAC,kBAAkB,GACrC,OAAO,CAAC,MAAM,CAAC;CAGnB"}

package/dist/file/abstract-file-provider.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractFileProviderService = void 0;
+/**
+ * ### constructor
+ *
+ * The constructor allows you to access resources from the module's container using the first parameter,
+ * and the module's options using the second parameter.
+ *
+ * If you're creating a client or establishing a connection with a third-party service, do it in the constructor.
+ *
+ * #### Example
+ *
+ * ```ts
+ * import { Logger } from "@8medusa/framework/types"
+ * import { AbstractFileProviderService } from "@8medusa/framework/utils"
+ *
+ * type InjectedDependencies = {
+ *   logger: Logger
+ * }
+ *
+ * type Options = {
+ *   apiKey: string
+ * }
+ *
+ * class MyFileProviderService extends AbstractFileProviderService {
+ *   protected logger_: Logger
+ *   protected options_: Options
+ *   static identifier = "my-file"
+ *   // assuming you're initializing a client
+ *   protected client
+ *
+ *   constructor (
+ *     { logger }: InjectedDependencies,
+ *     options: Options
+ *   ) {
+ *     super()
+ *
+ *     this.logger_ = logger
+ *     this.options_ = options
+ *
+ *     // assuming you're initializing a client
+ *     this.client = new Client(options)
+ *   }
+ * }
+ *
+ * export default MyFileProviderService
+ * ```
+ */
+class AbstractFileProviderService {
+    /**
+     * This method validates the options of the provider set in `medusa-config.ts`.
+     * Implementing this method is optional. It's useful if your provider requires custom validation.
+     *
+     * If the options aren't valid, throw an error.
+     *
+     * @param options - The provider's options.
+     *
+     * @example
+     * class MyFileProviderService extends AbstractFileProviderService {
+     *   static validateOptions(options: Record<any, any>) {
+     *     if (!options.apiKey) {
+     *       throw new MedusaError(
+     *         MedusaError.Types.INVALID_DATA,
+     *         "API key is required in the provider's options."
+     *       )
+     *     }
+     *   }
+     * }
+     */
+    static validateOptions(options) { }
+    /**
+     * @ignore
+     */
+    getIdentifier() {
+        return this.constructor.identifier;
+    }
+    /**
+     * This method uploads a file using your provider's custom logic. In this method, you can upload the file
+     * into your provider's storage, and return the uploaded file's details.
+     *
+     * This method will be used when uploading product images, CSV files for imports, or other
+     * custom file uploads.
+     *
+     * @param {FileTypes.ProviderUploadFileDTO} file - The file to upload.
+     * @returns {Promise<FileTypes.ProviderFileResultDTO>} The uploaded file's details.
+     *
+     * @example
+     * class MyFileProviderService extends AbstractFileProviderService {
+     *   // ...
+     *   async upload(
+     *     file: ProviderUploadFileDTO
+     *   ): Promise<ProviderFileResultDTO> {
+     *     // TODO upload file to third-party provider
+     *     // or using custom logic
+     *     // for example:
+     *     this.client.upload(file)
+     *
+     *     return {
+     *       url: "some-url.com",
+     *       key: "file-name-or-id"
+     *     }
+     *   }
+     * }
+     */
+    async upload(file) {
+        throw Error("upload must be overridden by the child class");
+    }
+    /**
+     * This method deletes the file from storage. It's used when an admin user deletes a product image,
+     * or other custom file deletions.
+     *
+     * @param {FileTypes.ProviderDeleteFileDTO} file - The details of the file to delete.
+     * @returns {Promise<void>} Resolves when the file is deleted.
+     *
+     * @example
+     * class MyFileProviderService extends AbstractFileProviderService {
+     *   // ...
+     *   async delete(file: ProviderDeleteFileDTO): Promise<void> {
+     *     // TODO logic to remove the file from storage
+     *     // Use the `file.fileKey` to delete the file
+     *     // for example:
+     *     this.client.delete(file.fileKey)
+     *   }
+     * }
+     */
+    async delete(file) {
+        throw Error("delete must be overridden by the child class");
+    }
+    /**
+     * This method is used to retrieve a download URL of the file. For some providers,
+     * such as S3, a presigned URL indicates a temporary URL to get access to a file.
+     *
+     * If your provider doesn’t perform or offer a similar functionality, you can
+     * return the URL to download the file.
+     *
+     * @param {FileTypes.ProviderGetFileDTO} fileData - The details of the file to get its
+     * presigned URL.
+     * @returns {Promise<string>} The file's presigned URL.
+     *
+     * @example
+     * class MyFileProviderService extends AbstractFileProviderService {
+     *   // ...
+     *   async getPresignedDownloadUrl(
+     *     fileData: ProviderGetFileDTO
+     *   ): Promise<string> {
+     *     // TODO logic to get the presigned URL
+     *     // Use the `file.fileKey` to delete the file
+     *     // for example:
+     *     return this.client.getPresignedUrl(fileData.fileKey)
+     *   }
+     * }
+     */
+    async getPresignedDownloadUrl(fileData) {
+        throw Error("getPresignedDownloadUrl must be overridden by the child class");
+    }
+}
+exports.AbstractFileProviderService = AbstractFileProviderService;
+//# sourceMappingURL=abstract-file-provider.js.map

package/dist/file/abstract-file-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-file-provider.js","sourceRoot":"","sources":["../../src/file/abstract-file-provider.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAa,2BAA2B;IActC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,eAAe,CAAC,OAAyB,IAAiB,CAAC;IAElE;;OAEG;IACH,aAAa;QACX,OAAQ,IAAI,CAAC,WAAmB,CAAC,UAAU,CAAA;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,MAAM,CACV,IAAqC;QAErC,MAAM,KAAK,CAAC,8CAA8C,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CAAC,IAAqC;QAChD,MAAM,KAAK,CAAC,8CAA8C,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,uBAAuB,CAC3B,QAAsC;QAEtC,MAAM,KAAK,CAAC,+DAA+D,CAAC,CAAA;IAC9E,CAAC;CACF;AAhID,kEAgIC"}

package/dist/file/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./abstract-file-provider";
+//# sourceMappingURL=index.d.ts.map

package/dist/file/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/file/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA"}

package/dist/file/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./abstract-file-provider"), exports);
+//# sourceMappingURL=index.js.map

package/dist/file/index.js.map

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

package/dist/fulfillment/events.d.ts

@@ -0,0 +1,71 @@
+export declare const FulfillmentEvents: {
+    SHIPMENT_CREATED: string;
+    DELIVERY_CREATED: string;
+    FULFILLMENT_CREATED: "fulfillment.created";
+    FULFILLMENT_SET_CREATED: "fulfillment-set.created";
+    SERVICE_ZONE_CREATED: "service-zone.created";
+    GEO_ZONE_CREATED: "geo-zone.created";
+    SHIPPING_OPTION_CREATED: "shipping-option.created";
+    SHIPPING_OPTION_TYPE_CREATED: "shipping-option-type.created";
+    SHIPPING_PROFILE_CREATED: "shipping-profile.created";
+    SHIPPING_OPTION_RULE_CREATED: "shipping-option-rule.created";
+    FULFILLMENT_ADDRESS_CREATED: "fulfillment-address.created";
+    FULFILLMENT_ITEM_CREATED: "fulfillment-item.created";
+    FULFILLMENT_LABEL_CREATED: "fulfillment-label.created";
+    FULFILLMENT_UPDATED: "fulfillment.updated";
+    FULFILLMENT_SET_UPDATED: "fulfillment-set.updated";
+    SERVICE_ZONE_UPDATED: "service-zone.updated";
+    GEO_ZONE_UPDATED: "geo-zone.updated";
+    SHIPPING_OPTION_UPDATED: "shipping-option.updated";
+    SHIPPING_OPTION_TYPE_UPDATED: "shipping-option-type.updated";
+    SHIPPING_PROFILE_UPDATED: "shipping-profile.updated";
+    SHIPPING_OPTION_RULE_UPDATED: "shipping-option-rule.updated";
+    FULFILLMENT_ADDRESS_UPDATED: "fulfillment-address.updated";
+    FULFILLMENT_ITEM_UPDATED: "fulfillment-item.updated";
+    FULFILLMENT_LABEL_UPDATED: "fulfillment-label.updated";
+    FULFILLMENT_DELETED: "fulfillment.deleted";
+    FULFILLMENT_SET_DELETED: "fulfillment-set.deleted";
+    SERVICE_ZONE_DELETED: "service-zone.deleted";
+    GEO_ZONE_DELETED: "geo-zone.deleted";
+    SHIPPING_OPTION_DELETED: "shipping-option.deleted";
+    SHIPPING_OPTION_TYPE_DELETED: "shipping-option-type.deleted";
+    SHIPPING_PROFILE_DELETED: "shipping-profile.deleted";
+    SHIPPING_OPTION_RULE_DELETED: "shipping-option-rule.deleted";
+    FULFILLMENT_ADDRESS_DELETED: "fulfillment-address.deleted";
+    FULFILLMENT_ITEM_DELETED: "fulfillment-item.deleted";
+    FULFILLMENT_LABEL_DELETED: "fulfillment-label.deleted";
+    FULFILLMENT_RESTORED: "fulfillment.restored";
+    FULFILLMENT_SET_RESTORED: "fulfillment-set.restored";
+    SERVICE_ZONE_RESTORED: "service-zone.restored";
+    GEO_ZONE_RESTORED: "geo-zone.restored";
+    SHIPPING_OPTION_RESTORED: "shipping-option.restored";
+    SHIPPING_OPTION_TYPE_RESTORED: "shipping-option-type.restored";
+    SHIPPING_PROFILE_RESTORED: "shipping-profile.restored";
+    SHIPPING_OPTION_RULE_RESTORED: "shipping-option-rule.restored";
+    FULFILLMENT_ADDRESS_RESTORED: "fulfillment-address.restored";
+    FULFILLMENT_ITEM_RESTORED: "fulfillment-item.restored";
+    FULFILLMENT_LABEL_RESTORED: "fulfillment-label.restored";
+    FULFILLMENT_ATTACHED: "fulfillment.attached";
+    FULFILLMENT_SET_ATTACHED: "fulfillment-set.attached";
+    SERVICE_ZONE_ATTACHED: "service-zone.attached";
+    GEO_ZONE_ATTACHED: "geo-zone.attached";
+    SHIPPING_OPTION_ATTACHED: "shipping-option.attached";
+    SHIPPING_OPTION_TYPE_ATTACHED: "shipping-option-type.attached";
+    SHIPPING_PROFILE_ATTACHED: "shipping-profile.attached";
+    SHIPPING_OPTION_RULE_ATTACHED: "shipping-option-rule.attached";
+    FULFILLMENT_ADDRESS_ATTACHED: "fulfillment-address.attached";
+    FULFILLMENT_ITEM_ATTACHED: "fulfillment-item.attached";
+    FULFILLMENT_LABEL_ATTACHED: "fulfillment-label.attached";
+    FULFILLMENT_DETACHED: "fulfillment.detached";
+    FULFILLMENT_SET_DETACHED: "fulfillment-set.detached";
+    SERVICE_ZONE_DETACHED: "service-zone.detached";
+    GEO_ZONE_DETACHED: "geo-zone.detached";
+    SHIPPING_OPTION_DETACHED: "shipping-option.detached";
+    SHIPPING_OPTION_TYPE_DETACHED: "shipping-option-type.detached";
+    SHIPPING_PROFILE_DETACHED: "shipping-profile.detached";
+    SHIPPING_OPTION_RULE_DETACHED: "shipping-option-rule.detached";
+    FULFILLMENT_ADDRESS_DETACHED: "fulfillment-address.detached";
+    FULFILLMENT_ITEM_DETACHED: "fulfillment-item.detached";
+    FULFILLMENT_LABEL_DETACHED: "fulfillment-label.detached";
+};
+//# sourceMappingURL=events.d.ts.map

package/dist/fulfillment/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/fulfillment/events.ts"],"names":[],"mappings":"AA6BA,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAI7B,CAAA"}