@kshon/loyalty-plugin 2.14.2

package/.medusa/server/src/types/store-credit/service.d.ts

@@ -0,0 +1,325 @@
+import { RestoreReturn } from "@medusajs/framework/types";
+import { BaseFilterable, Context, FindConfig, IModuleService } from "@medusajs/types";
+import { ModuleAccountStats, ModuleAccountTransaction, ModuleCreateStoreCreditAccount, ModuleCreditAccount, ModuleDebitAccount, ModuleRetrieveAccountStats, ModuleStoreCreditAccount, ModuleUpdateStoreCreditAccount } from "./module";
+/**
+ * The filters to apply when retrieving store credit accounts.
+ */
+export interface ModuleStoreCreditAccountFilters extends BaseFilterable<ModuleStoreCreditAccountFilters> {
+    /**
+     * A search term to filter store credit accounts by.
+     */
+    q?: string;
+    /**
+     * Filter by store credit account ID(s).
+     */
+    id?: string | string[];
+    /**
+     * Filter by currency code(s).
+     */
+    currency_code?: string | string[];
+    /**
+     * Filter by customer ID(s).
+     */
+    customer_id?: string | string[];
+    /**
+     * The field to order results by.
+     */
+    order?: string;
+}
+/**
+ * The filters to apply when listing account transactions.
+ */
+export interface ModuleListAccountTransactions extends BaseFilterable<ModuleListAccountTransactions> {
+    /**
+     * Filter by transaction ID(s).
+     */
+    id?: string | string[];
+    /**
+     * Filter by store credit account ID(s).
+     */
+    account_id?: string | string[];
+    /**
+     * The field to order results by.
+     */
+    order?: string;
+}
+/**
+ * The main service interface for the StoreCredit Module.
+ */
+export interface IStoreCreditModuleService extends IModuleService {
+    /**
+     * This method creates a store credit account.
+     *
+     * @param {ModuleCreateStoreCreditAccount} data - The store credit account to create.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ModuleStoreCreditAccount>} The created store credit account.
+     *
+     * @example
+     * const account = await storeCreditModuleService.createStoreCreditAccounts({
+     *   currency_code: "usd",
+     *   customer_id: "cust_123",
+     * })
+     */
+    createStoreCreditAccounts(data: ModuleCreateStoreCreditAccount, sharedContext?: Context): Promise<ModuleStoreCreditAccount>;
+    /**
+     * This method creates store credit accounts.
+     *
+     * @param {ModuleCreateStoreCreditAccount[]} data - The store credit accounts to create.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ModuleStoreCreditAccount[]>} The created store credit accounts.
+     *
+     * @example
+     * const accounts = await storeCreditModuleService.createStoreCreditAccounts([
+     *   {
+     *     currency_code: "usd",
+     *     customer_id: "cust_123",
+     *   },
+     * ])
+     */
+    createStoreCreditAccounts(data: ModuleCreateStoreCreditAccount[], sharedContext?: Context): Promise<ModuleStoreCreditAccount[]>;
+    /**
+     * This method updates a store credit account.
+     *
+     * @param {ModuleUpdateStoreCreditAccount} data - The attributes to update in the store credit account.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ModuleStoreCreditAccount>} The updated store credit account.
+     *
+     * @example
+     * const account = await storeCreditModuleService.updateStoreCreditAccounts({
+     *   id: "sca_123",
+     *   customer_id: "cust_456",
+     * })
+     */
+    updateStoreCreditAccounts(data: ModuleUpdateStoreCreditAccount, sharedContext?: Context): Promise<ModuleStoreCreditAccount>;
+    /**
+     * This method updates store credit accounts.
+     *
+     * @param {ModuleUpdateStoreCreditAccount[]} data - The attributes to update in the store credit accounts.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ModuleStoreCreditAccount[]>} The updated store credit accounts.
+     *
+     * @example
+     * const accounts = await storeCreditModuleService.updateStoreCreditAccounts([
+     *   {
+     *     id: "sca_123",
+     *     customer_id: "cust_456",
+     *   },
+     * ])
+     */
+    updateStoreCreditAccounts(data: ModuleUpdateStoreCreditAccount[], sharedContext?: Context): Promise<ModuleStoreCreditAccount[]>;
+    /**
+     * This method retrieves a paginated list of store credit accounts based on optional filters and configuration.
+     *
+     * @param {ModuleStoreCreditAccountFilters} filters - The filters to apply on the retrieved store credit accounts.
+     * @param {FindConfig<ModuleStoreCreditAccount>} config - The configurations determining how the store credit accounts are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a store credit account.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ModuleStoreCreditAccount[]>} The list of store credit accounts.
+     *
+     * @example
+     * To retrieve a list of store credit accounts by customer:
+     *
+     * ```ts
+     * const accounts = await storeCreditModuleService.listStoreCreditAccounts({
+     *   id: ["sca_123", "sca_321"],
+     * })
+     * ```
+     *
+     * To specify relations that should be retrieved within the store credit accounts:
+     *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
+     * ```ts
+     * const accounts = await storeCreditModuleService.listStoreCreditAccounts(
+     *   {
+     *     id: ["sca_123", "sca_321"],
+     *   },
+     *   {
+     *     relations: ["transactions"],
+     *   }
+     * )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const accounts = await storeCreditModuleService.listStoreCreditAccounts(
+     *   { id: ["sca_123", "sca_321"] },
+     *   { take: 20, skip: 2 }
+     * )
+     * ```
+     */
+    listStoreCreditAccounts(filters?: ModuleStoreCreditAccountFilters, config?: FindConfig<ModuleStoreCreditAccount>, sharedContext?: Context): Promise<ModuleStoreCreditAccount[]>;
+    /**
+     * This method retrieves a store credit account by its ID.
+     *
+     * @param {string} id - The ID of the store credit account to retrieve.
+     * @param {FindConfig<ModuleStoreCreditAccount>} config - The configurations determining how the store credit account is retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a store credit account.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ModuleStoreCreditAccount>} The retrieved store credit account.
+     *
+     * @example
+     * A simple example that retrieves a store credit account by its ID:
+     *
+     * ```ts
+     * const account = await storeCreditModuleService.retrieveStoreCreditAccount("sca_123")
+     * ```
+     *
+     * To specify relations that should be retrieved:
+     *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
+     * ```ts
+     * const account = await storeCreditModuleService.retrieveStoreCreditAccount("sca_123", {
+     *   relations: ["transactions"],
+     * })
+     * ```
+     */
+    retrieveStoreCreditAccount(id: string, config?: FindConfig<ModuleStoreCreditAccount>, sharedContext?: Context): Promise<ModuleStoreCreditAccount>;
+    /**
+     * This method deletes store credit accounts by their IDs.
+     *
+     * @param {string[]} ids - The IDs of the store credit accounts to delete.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the store credit accounts are deleted successfully.
+     *
+     * @example
+     * await storeCreditModuleService.deleteStoreCreditAccounts(["sca_123", "sca_456"])
+     */
+    deleteStoreCreditAccounts(ids: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method soft deletes store credit accounts by their IDs. Soft-deleted accounts can be restored using the {@link restoreStoreCreditAccounts} method.
+     *
+     * @param {string[]} ids - The IDs of the store credit accounts to soft delete.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the store credit accounts are soft deleted successfully.
+     *
+     * @example
+     * await storeCreditModuleService.softDeleteStoreCreditAccounts(["sca_123"])
+     */
+    softDeleteStoreCreditAccounts(ids: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method restores soft-deleted store credit accounts by their IDs.
+     *
+     * @param {string[]} ids - The IDs of the store credit accounts to restore.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore and return.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<TReturnableLinkableKeys, string[]> | void>} The IDs of restored linked records, or void if no linkable keys are requested.
+     *
+     * @example
+     * await storeCreditModuleService.restoreStoreCreditAccounts(["sca_123"])
+     */
+    restoreStoreCreditAccounts<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
+    /**
+     * This method retrieves a list of account transactions based on the provided filters.
+     *
+     * @param {ModuleListAccountTransactions} filters - The filters to apply on the retrieved transactions.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ModuleAccountTransaction[]>} The list of account transactions.
+     *
+     * @example
+     * To retrieve a list of account transactions by ID:
+     *
+     * ```ts
+     * const transactions = await storeCreditModuleService.listAccountTransactions({
+     *   id: ["txn_123", "txn_321"],
+     * })
+     * ```
+     *
+     * To specify relations that should be retrieved within the account transactions:
+     *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
+     * ```ts
+     * const transactions = await storeCreditModuleService.listAccountTransactions({
+     *   id: ["txn_123", "txn_321"],
+     * }, {
+     *   relations: ["account"],
+     * })
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const transactions = await storeCreditModuleService.listAccountTransactions(
+     *   { id: ["txn_123", "txn_321"] },
+     *   { take: 20, skip: 2 }
+     * )
+     * ```
+     */
+    listAccountTransactions(filters: ModuleListAccountTransactions, sharedContext?: Context): Promise<ModuleAccountTransaction[]>;
+    /**
+     * This method retrieves the balance statistics for a store credit account.
+     *
+     * @param {ModuleRetrieveAccountStats} filters - The filters to identify the account to retrieve stats for.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ModuleAccountStats>} The account statistics including balance, credits, and debits.
+     *
+     * @example
+     * const stats = await storeCreditModuleService.retrieveAccountStats({
+     *   account_id: "sca_123",
+     * })
+     */
+    retrieveAccountStats(filters: ModuleRetrieveAccountStats, sharedContext?: Context): Promise<ModuleAccountStats>;
+    /**
+     * This method credits one or more store credit accounts by creating credit transactions.
+     *
+     * @param {ModuleCreditAccount[]} data - The credit transactions to create.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ModuleAccountTransaction[]>} The created credit transactions.
+     *
+     * @example
+     * const transactions = await storeCreditModuleService.creditAccounts([
+     *   {
+     *     account_id: "sca_123",
+     *     amount: 100,
+     *     reference: "order",
+     *     reference_id: "order_123",
+     *   },
+     * ])
+     */
+    creditAccounts(data: ModuleCreditAccount[], sharedContext?: Context): Promise<ModuleAccountTransaction[]>;
+    /**
+     * This method debits one or more store credit accounts by creating debit transactions.
+     *
+     * @param {ModuleDebitAccount[]} data - The debit transactions to create.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ModuleAccountTransaction[]>} The created debit transactions.
+     *
+     * @example
+     * const transactions = await storeCreditModuleService.debitAccounts([
+     *   {
+     *     account_id: "sca_123",
+     *     amount: 50,
+     *     reference: "cart",
+     *     reference_id: "cart_123",
+     *   },
+     * ])
+     */
+    debitAccounts(data: ModuleDebitAccount[], sharedContext?: Context): Promise<ModuleAccountTransaction[]>;
+    /**
+     * This method deletes account transactions by their IDs.
+     *
+     * @param {string[]} ids - The IDs of the transactions to delete.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the transactions are deleted successfully.
+     *
+     * @example
+     * await storeCreditModuleService.deleteTransactions(["txn_123", "txn_456"])
+     */
+    deleteTransactions(ids: string[], sharedContext?: Context): Promise<void>;
+}

package/.medusa/server/src/types/store-credit/service.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VydmljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy90eXBlcy9zdG9yZS1jcmVkaXQvc2VydmljZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

package/.medusa/server/src/utils/code-generator.d.ts

@@ -0,0 +1 @@
+export declare function generateCode(prefix?: string, sections?: number): string;

package/.medusa/server/src/utils/code-generator.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateCode = generateCode;
+const crypto_1 = __importDefault(require("crypto"));
+function generateCode(prefix = "GIFT", sections = 4) {
+    // Characters to use (excluding similar-looking characters like 0/O, 1/I)
+    const characters = "ABCDEFGHJKLMNPQRSTUVWXYZ23456789";
+    // Calculate how many bytes we need for generating our code
+    // We need enough random bytes to select from our character set
+    const length = sections * 4;
+    const byteLength = Math.ceil((length * Math.log2(characters.length)) / 8);
+    // Generate random bytes
+    const randomBytes = crypto_1.default.randomBytes(byteLength);
+    // Generate the code
+    let code = "";
+    for (let i = 0; i < length; i++) {
+        // Use a modulo operation to select a character from our set
+        const randomIndex = randomBytes[i % randomBytes.length] % characters.length;
+        code += characters.charAt(randomIndex);
+    }
+    // Split into chunks of 4 characters
+    const chunks = [];
+    for (let i = 0; i < code.length; i += 4) {
+        chunks.push(code.slice(i, i + 4));
+    }
+    // Format with prefix
+    return prefix ? `${prefix}-${chunks.join("-")}` : chunks.join("-");
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29kZS1nZW5lcmF0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvdXRpbHMvY29kZS1nZW5lcmF0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFFQSxvQ0FrQ0M7QUFwQ0Qsb0RBQTRCO0FBRTVCLFNBQWdCLFlBQVksQ0FDMUIsU0FBaUIsTUFBTSxFQUN2QixXQUFtQixDQUFDO0lBRXBCLHlFQUF5RTtJQUN6RSxNQUFNLFVBQVUsR0FBVyxrQ0FBa0MsQ0FBQztJQUU5RCwyREFBMkQ7SUFDM0QsK0RBQStEO0lBQy9ELE1BQU0sTUFBTSxHQUFXLFFBQVEsR0FBRyxDQUFDLENBQUM7SUFDcEMsTUFBTSxVQUFVLEdBQVcsSUFBSSxDQUFDLElBQUksQ0FDbEMsQ0FBQyxNQUFNLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQzVDLENBQUM7SUFFRix3QkFBd0I7SUFDeEIsTUFBTSxXQUFXLEdBQVcsZ0JBQU0sQ0FBQyxXQUFXLENBQUMsVUFBVSxDQUFDLENBQUM7SUFFM0Qsb0JBQW9CO0lBQ3BCLElBQUksSUFBSSxHQUFXLEVBQUUsQ0FBQztJQUN0QixLQUFLLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUcsTUFBTSxFQUFFLENBQUMsRUFBRSxFQUFFLENBQUM7UUFDaEMsNERBQTREO1FBQzVELE1BQU0sV0FBVyxHQUNmLFdBQVcsQ0FBQyxDQUFDLEdBQUcsV0FBVyxDQUFDLE1BQU0sQ0FBQyxHQUFHLFVBQVUsQ0FBQyxNQUFNLENBQUM7UUFDMUQsSUFBSSxJQUFJLFVBQVUsQ0FBQyxNQUFNLENBQUMsV0FBVyxDQUFDLENBQUM7SUFDekMsQ0FBQztJQUVELG9DQUFvQztJQUNwQyxNQUFNLE1BQU0sR0FBYSxFQUFFLENBQUM7SUFDNUIsS0FBSyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxHQUFHLElBQUksQ0FBQyxNQUFNLEVBQUUsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO1FBQ3hDLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDcEMsQ0FBQztJQUVELHFCQUFxQjtJQUNyQixPQUFPLE1BQU0sQ0FBQyxDQUFDLENBQUMsR0FBRyxNQUFNLElBQUksTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0FBQ3JFLENBQUMifQ==

package/.medusa/server/src/workflows/carts/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./workflows/add-gift-card-to-cart";
+export * from "./workflows/add-store-credits-to-cart";
+export * from "./workflows/confirm-cart-credit-lines";
+export * from "./workflows/refresh-cart-gift-cards";
+export * from "./workflows/remove-gift-cart-from-cart";

package/.medusa/server/src/workflows/carts/index.js

@@ -0,0 +1,22 @@
+"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("./workflows/add-gift-card-to-cart"), exports);
+__exportStar(require("./workflows/add-store-credits-to-cart"), exports);
+__exportStar(require("./workflows/confirm-cart-credit-lines"), exports);
+__exportStar(require("./workflows/refresh-cart-gift-cards"), exports);
+__exportStar(require("./workflows/remove-gift-cart-from-cart"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvd29ya2Zsb3dzL2NhcnRzL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSxvRUFBaUQ7QUFDakQsd0VBQXFEO0FBQ3JELHdFQUFxRDtBQUNyRCxzRUFBbUQ7QUFDbkQseUVBQXNEIn0=

package/.medusa/server/src/workflows/carts/steps/validate-gift-card-balances.d.ts

@@ -0,0 +1,37 @@
+import { ModuleAccountStats, ModuleGiftCard } from "../../../types";
+/**
+ * Input to validate that all gift cards in a collection have a positive balance.
+ */
+export interface ValidateGiftCardBalancesStepInput {
+    /**
+     * The gift cards to validate.
+     */
+    giftCards: ModuleGiftCard[];
+    /**
+     * A map of gift card codes to their account statistics, including the current balance.
+     */
+    giftCardsBalanceMap: Record<string, ModuleAccountStats>;
+}
+/**
+ * This step validates that all gift cards in a collection have a positive balance.
+ * It throws an error for any gift card with zero or negative balance.
+ *
+ * @example
+ * const data = validateGiftCardBalancesStep({
+ *   giftCards: [
+ *     {
+ *       id: "gc_123",
+ *       code: "GC-XXXX",
+ *       // other gift card properties...
+ *     }
+ *   ],
+ *   giftCardsBalanceMap: {
+ *     "GC-XXXX": {
+ *       balance: 100,
+ *       credit: 150,
+ *       debit: 50,
+ *     }
+ *   },
+ * })
+ */
+export declare const validateGiftCardBalancesStep: import("@medusajs/framework/workflows-sdk").StepFunction<ValidateGiftCardBalancesStepInput, unknown>;

package/.medusa/server/src/workflows/carts/steps/validate-gift-card-balances.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateGiftCardBalancesStep = void 0;
+const utils_1 = require("@medusajs/framework/utils");
+const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
+/**
+ * This step validates that all gift cards in a collection have a positive balance.
+ * It throws an error for any gift card with zero or negative balance.
+ *
+ * @example
+ * const data = validateGiftCardBalancesStep({
+ *   giftCards: [
+ *     {
+ *       id: "gc_123",
+ *       code: "GC-XXXX",
+ *       // other gift card properties...
+ *     }
+ *   ],
+ *   giftCardsBalanceMap: {
+ *     "GC-XXXX": {
+ *       balance: 100,
+ *       credit: 150,
+ *       debit: 50,
+ *     }
+ *   },
+ * })
+ */
+exports.validateGiftCardBalancesStep = (0, workflows_sdk_1.createStep)("validate-gift-card-balances", async function ({ giftCards, giftCardsBalanceMap, }) {
+    for (const giftCard of giftCards) {
+        const stats = giftCardsBalanceMap[giftCard.code];
+        if (utils_1.MathBN.convert(stats.balance).lte(0)) {
+            throw new utils_1.MedusaError(utils_1.MedusaError.Types.INVALID_DATA, `Gift card (${giftCard.code}) has no balance`);
+        }
+    }
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGUtZ2lmdC1jYXJkLWJhbGFuY2VzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vLi4vc3JjL3dvcmtmbG93cy9jYXJ0cy9zdGVwcy92YWxpZGF0ZS1naWZ0LWNhcmQtYmFsYW5jZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEscURBQWdFO0FBQ2hFLHFFQUErRDtBQWlCL0Q7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQXFCRztBQUNVLFFBQUEsNEJBQTRCLEdBQUcsSUFBQSwwQkFBVSxFQUNwRCw2QkFBNkIsRUFDN0IsS0FBSyxXQUFXLEVBQ2QsU0FBUyxFQUNULG1CQUFtQixHQUNlO0lBQ2xDLEtBQUssTUFBTSxRQUFRLElBQUksU0FBUyxFQUFFLENBQUM7UUFDakMsTUFBTSxLQUFLLEdBQUcsbUJBQW1CLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBRWpELElBQUksY0FBTSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUM7WUFDekMsTUFBTSxJQUFJLG1CQUFXLENBQ25CLG1CQUFXLENBQUMsS0FBSyxDQUFDLFlBQVksRUFDOUIsY0FBYyxRQUFRLENBQUMsSUFBSSxrQkFBa0IsQ0FDOUMsQ0FBQztRQUNKLENBQUM7SUFDSCxDQUFDO0FBQ0gsQ0FBQyxDQUNGLENBQUMifQ==

package/.medusa/server/src/workflows/carts/workflows/add-gift-card-to-cart.d.ts

@@ -0,0 +1,118 @@
+import { PluginCartDTO } from "../../../types/cart";
+import { ModuleGiftCard } from "../../../types/loyalty";
+import { ModuleAccountStats, ModuleStoreCreditAccount } from "../../../types/store-credit";
+/**
+ * Input to retrieve the balance of a single gift card from its associated store credit account.
+ */
+export interface RetrieveGiftCardBalanceStepInput {
+    /**
+     * The store credit account linked to the gift card.
+     */
+    storeCreditAccount: ModuleStoreCreditAccount;
+    /**
+     * The gift card whose balance should be retrieved.
+     */
+    giftCard: ModuleGiftCard;
+}
+/**
+ * This step retrieves the balance of a single gift card from its associated store
+ * credit account. Returns a map of the gift card code to its account stats.
+ *
+ * @example
+ * const data = retrieveGiftCardBalanceStep({
+ *   storeCreditAccount: {
+ *     id: "sca_123",
+ *     balance: 100,
+ *     // other store credit account properties...
+ *   },
+ *   giftCard: {
+ *     id: "gc_123",
+ *     code: "GC-XXXX",
+ *     // other gift card properties...
+ *   },
+ * })
+ */
+export declare const retrieveGiftCardBalanceStep: import("@medusajs/framework/workflows-sdk").StepFunction<RetrieveGiftCardBalanceStepInput, Record<string, ModuleAccountStats>>;
+/**
+ * Input to validate that a gift card exists.
+ */
+export interface ValidateGiftCardExistsStepInput {
+    /**
+     * The gift card to validate, or undefined if not found.
+     */
+    giftCard: ModuleGiftCard;
+    /**
+     * The lookup input containing the gift card code.
+     */
+    input: {
+        code: string;
+    };
+}
+/**
+ * Input to validate that gift cards can be added to a cart.
+ */
+export interface ValidateCartGiftCardStepInput {
+    /**
+     * The cart to validate against, including its currently applied gift cards.
+     */
+    cart: PluginCartDTO;
+    /**
+     * The gift cards to apply to the cart.
+     */
+    giftCards: ModuleGiftCard[];
+}
+/**
+ * This step validates that gift cards can be added to a cart. It throws an error
+ * if a gift card is already applied to the cart or if the gift card currency does
+ * not match the cart's currency.
+ *
+ * @example
+ * const data = validateCartGiftCardStep({
+ *   cart: {
+ *     id: "cart_123",
+ *     gift_cards: [
+ *       { code: "GC-XXXX-XXXX" },
+ *       // other gift cards applied to the cart...
+ *     ],
+ *     currency_code: "usd",
+ *     // other cart properties...
+ *   },
+ *   giftCards: [...],
+ * })
+ */
+export declare const validateCartGiftCardStep: import("@medusajs/framework/workflows-sdk").StepFunction<ValidateCartGiftCardStepInput, unknown>;
+/**
+ * Input to apply a gift card to a cart.
+ */
+export interface AddGiftCardToCartWorkflowInput {
+    /**
+     * The code of the gift card to apply.
+     */
+    code: string;
+    /**
+     * The ID of the cart to apply the gift card to.
+     */
+    cart_id: string;
+}
+/**
+ * This workflow applies a gift card to a cart by creating a credit line for the
+ * gift card's balance and linking the gift card to the cart. It validates that
+ * the gift card exists, has sufficient balance, and can be applied to the cart.
+ *
+ * You can use this workflow within your own customizations or custom workflows,
+ * allowing you to wrap custom logic around adding gift cards to carts.
+ *
+ * @example
+ * const { result } = await addGiftCardToCartWorkflow(container)
+ *   .run({
+ *     input: {
+ *       code: "GC-XXXX-XXXX",
+ *       cart_id: "cart_123",
+ *     },
+ *   })
+ *
+ * @summary
+ *
+ * Apply a gift card to a cart.
+ */
+export declare const addGiftCardToCartWorkflow: import("@medusajs/framework/workflows-sdk").ReturnWorkflow<AddGiftCardToCartWorkflowInput, import("@medusajs/framework/types").CartCreditLineDTO[], []>;