@medusajs/currency 0.1.0

package/README.md

@@ -0,0 +1 @@
+# Currency Module

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { moduleDefinition } from "./module-definition";
+export * from "./types";
+export * from "./models";
+export * from "./services";
+export declare const initialize: (options?: import("@medusajs/modules-sdk").InternalModuleDeclaration | import("@medusajs/modules-sdk").ModuleServiceInitializeOptions | import("@medusajs/modules-sdk").ModuleServiceInitializeCustomDataLayerOptions | import("@medusajs/modules-sdk").ExternalModuleDeclaration | undefined, injectedDependencies?: any) => Promise<unknown>;
+export declare const runMigrations: ((options: import("@medusajs/modules-sdk").LoaderOptions<any>, moduleDeclaration?: import("@medusajs/modules-sdk").InternalModuleDeclaration | undefined) => Promise<void>) | undefined;
+export declare const revertMigration: ((options: import("@medusajs/modules-sdk").LoaderOptions<any>, moduleDeclaration?: import("@medusajs/modules-sdk").InternalModuleDeclaration | undefined) => Promise<void>) | undefined;
+export default moduleDefinition;

package/dist/index.js

@@ -0,0 +1,29 @@
+"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 });
+exports.revertMigration = exports.runMigrations = exports.initialize = void 0;
+const module_definition_1 = require("./module-definition");
+const modules_sdk_1 = require("@medusajs/modules-sdk");
+__exportStar(require("./types"), exports);
+__exportStar(require("./models"), exports);
+__exportStar(require("./services"), exports);
+exports.initialize = (0, modules_sdk_1.initializeFactory)({
+    moduleName: modules_sdk_1.Modules.CURRENCY,
+    moduleDefinition: module_definition_1.moduleDefinition,
+});
+exports.runMigrations = module_definition_1.moduleDefinition.runMigrations;
+exports.revertMigration = module_definition_1.moduleDefinition.revertMigration;
+exports.default = module_definition_1.moduleDefinition;

package/dist/joiner-config.d.ts

@@ -0,0 +1,5 @@
+import { ModuleJoinerConfig } from "@medusajs/types";
+import { MapToConfig } from "@medusajs/utils";
+export declare const LinkableKeys: Record<string, string>;
+export declare const entityNameToLinkableKeysMap: MapToConfig;
+export declare const joinerConfig: ModuleJoinerConfig;

package/dist/joiner-config.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.joinerConfig = exports.entityNameToLinkableKeysMap = exports.LinkableKeys = void 0;
+const modules_sdk_1 = require("@medusajs/modules-sdk");
+const currency_1 = __importDefault(require("./models/currency"));
+exports.LinkableKeys = {};
+const entityLinkableKeysMap = {};
+Object.entries(exports.LinkableKeys).forEach(([key, value]) => {
+    entityLinkableKeysMap[value] ?? (entityLinkableKeysMap[value] = []);
+    entityLinkableKeysMap[value].push({
+        mapTo: key,
+        valueFrom: key.split("_").pop(),
+    });
+});
+exports.entityNameToLinkableKeysMap = entityLinkableKeysMap;
+exports.joinerConfig = {
+    serviceName: modules_sdk_1.Modules.CURRENCY,
+    primaryKeys: ["code"],
+    linkableKeys: exports.LinkableKeys,
+    alias: [
+        {
+            name: ["currency", "currencies"],
+            args: { entity: currency_1.default.name },
+        },
+    ],
+};

package/dist/loaders/initial-data.d.ts

@@ -0,0 +1,3 @@
+import { ModulesSdkTypes, LoaderOptions } from "@medusajs/types";
+declare const _default: ({ container, options, }: LoaderOptions<ModulesSdkTypes.ModuleServiceInitializeOptions | ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions>) => Promise<void>;
+export default _default;

package/dist/loaders/initial-data.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const modules_sdk_1 = require("@medusajs/modules-sdk");
+const utils_1 = require("@medusajs/utils");
+exports.default = async ({ container, options, }) => {
+    // TODO: Add default logger to the container when running tests
+    const logger = container.resolve(utils_1.ContainerRegistrationKeys.LOGGER) ?? console;
+    const { currencyService_, } = container.resolve(modules_sdk_1.ModuleRegistrationName.CURRENCY);
+    try {
+        const normalizedCurrencies = Object.values(utils_1.defaultCurrencies).map((c) => ({
+            ...c,
+            code: c.code.toLowerCase(),
+        }));
+        const resp = await currencyService_.upsert(normalizedCurrencies);
+        logger.info(`Loaded ${resp.length} currencies`);
+    }
+    catch (error) {
+        logger.warn(`Failed to load currencies, skipping loader. Original error: ${error.message}`);
+    }
+};

package/dist/migrations/InitialSetup20240228133303.d.ts

@@ -0,0 +1,4 @@
+import { Migration } from "@mikro-orm/migrations";
+export declare class InitialSetup20240228133303 extends Migration {
+    up(): Promise<void>;
+}

package/dist/migrations/InitialSetup20240228133303.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InitialSetup20240228133303 = void 0;
+const migrations_1 = require("@mikro-orm/migrations");
+class InitialSetup20240228133303 extends migrations_1.Migration {
+    async up() {
+        this.addSql(`create table if not exists "currency" 
+    ("code" text not null, "symbol" text not null, "symbol_native" text not null, "name" text not null, 
+    constraint "currency_pkey" primary key ("code"));`);
+    }
+}
+exports.InitialSetup20240228133303 = InitialSetup20240228133303;

package/dist/models/currency.d.ts

@@ -0,0 +1,7 @@
+declare class Currency {
+    code: string;
+    symbol: string;
+    symbol_native: string;
+    name: string;
+}
+export default Currency;

package/dist/models/currency.js

@@ -0,0 +1,34 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@mikro-orm/core");
+let Currency = class Currency {
+};
+__decorate([
+    (0, core_1.PrimaryKey)({ columnType: "text" }),
+    __metadata("design:type", String)
+], Currency.prototype, "code", void 0);
+__decorate([
+    (0, core_1.Property)({ columnType: "text" }),
+    __metadata("design:type", String)
+], Currency.prototype, "symbol", void 0);
+__decorate([
+    (0, core_1.Property)({ columnType: "text" }),
+    __metadata("design:type", String)
+], Currency.prototype, "symbol_native", void 0);
+__decorate([
+    (0, core_1.Property)({ columnType: "text" }),
+    __metadata("design:type", String)
+], Currency.prototype, "name", void 0);
+Currency = __decorate([
+    (0, core_1.Entity)({ tableName: "currency" })
+], Currency);
+exports.default = Currency;

package/dist/models/index.d.ts

@@ -0,0 +1 @@
+export { default as Currency } from "./currency";

package/dist/models/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Currency = void 0;
+var currency_1 = require("./currency");
+Object.defineProperty(exports, "Currency", { enumerable: true, get: function () { return __importDefault(currency_1).default; } });

package/dist/module-definition.d.ts

@@ -0,0 +1,2 @@
+import { ModuleExports } from "@medusajs/types";
+export declare const moduleDefinition: ModuleExports;

package/dist/module-definition.js

@@ -0,0 +1,62 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.moduleDefinition = void 0;
+const ModuleServices = __importStar(require("./services"));
+const _services_1 = require("./services");
+const modules_sdk_1 = require("@medusajs/modules-sdk");
+const Models = __importStar(require("./models"));
+const ModuleModels = __importStar(require("./models"));
+const utils_1 = require("@medusajs/utils");
+const ModuleRepositories = __importStar(require("./repositories"));
+const initial_data_1 = __importDefault(require("./loaders/initial-data"));
+const migrationScriptOptions = {
+    moduleName: modules_sdk_1.Modules.CURRENCY,
+    models: Models,
+    pathToMigrations: __dirname + "/migrations",
+};
+const runMigrations = utils_1.ModulesSdkUtils.buildMigrationScript(migrationScriptOptions);
+const revertMigration = utils_1.ModulesSdkUtils.buildRevertMigrationScript(migrationScriptOptions);
+const containerLoader = utils_1.ModulesSdkUtils.moduleContainerLoaderFactory({
+    moduleModels: ModuleModels,
+    moduleRepositories: ModuleRepositories,
+    moduleServices: ModuleServices,
+});
+const connectionLoader = utils_1.ModulesSdkUtils.mikroOrmConnectionLoaderFactory({
+    moduleName: modules_sdk_1.Modules.CURRENCY,
+    moduleModels: Object.values(Models),
+    migrationsPath: __dirname + "/migrations",
+});
+const service = _services_1.CurrencyModuleService;
+const loaders = [containerLoader, connectionLoader, initial_data_1.default];
+exports.moduleDefinition = {
+    service,
+    loaders,
+    revertMigration,
+    runMigrations,
+};

package/dist/repositories/index.d.ts

@@ -0,0 +1 @@
+export { MikroOrmBaseRepository as BaseRepository } from "@medusajs/utils";

package/dist/repositories/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseRepository = void 0;
+var utils_1 = require("@medusajs/utils");
+Object.defineProperty(exports, "BaseRepository", { enumerable: true, get: function () { return utils_1.MikroOrmBaseRepository; } });

package/dist/scripts/bin/run-seed.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+declare const _default: Promise<void>;
+export default _default;

package/dist/scripts/bin/run-seed.js

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@medusajs/utils");
+const modules_sdk_1 = require("@medusajs/modules-sdk");
+const Models = __importStar(require("../../models"));
+const os_1 = require("os");
+const args = process.argv;
+const path = args.pop();
+exports.default = (async () => {
+    const { config } = await Promise.resolve().then(() => __importStar(require("dotenv")));
+    config();
+    if (!path) {
+        throw new Error(`filePath is required.${os_1.EOL}Example: medusa-currency-seed <filePath>`);
+    }
+    const run = utils_1.ModulesSdkUtils.buildSeedScript({
+        moduleName: modules_sdk_1.Modules.CURRENCY,
+        models: Models,
+        pathToMigrations: __dirname + "/../../migrations",
+        seedHandler: async ({ manager, data }) => {
+            // TODO: Add seed logic
+        },
+    });
+    await run({ path });
+})();

package/dist/services/currency-module-service.d.ts

@@ -0,0 +1,24 @@
+import { DAL, InternalModuleDeclaration, ModuleJoinerConfig, ModulesSdkTypes, ICurrencyModuleService, CurrencyTypes, Context, FindConfig, FilterableCurrencyProps } from "@medusajs/types";
+import { ModulesSdkUtils } from "@medusajs/utils";
+import { Currency } from "../models";
+type InjectedDependencies = {
+    baseRepository: DAL.RepositoryService;
+    currencyService: ModulesSdkTypes.InternalModuleService<any>;
+};
+declare const CurrencyModuleService_base: new (container: InjectedDependencies) => ModulesSdkUtils.AbstractModuleService<InjectedDependencies, CurrencyTypes.CurrencyDTO, {
+    Currency: {
+        dto: CurrencyTypes.CurrencyDTO;
+    };
+}>;
+export default class CurrencyModuleService<TEntity extends Currency = Currency> extends CurrencyModuleService_base implements ICurrencyModuleService {
+    protected readonly moduleDeclaration: InternalModuleDeclaration;
+    protected baseRepository_: DAL.RepositoryService;
+    protected readonly currencyService_: ModulesSdkTypes.InternalModuleService<TEntity>;
+    constructor({ baseRepository, currencyService }: InjectedDependencies, moduleDeclaration: InternalModuleDeclaration);
+    __joinerConfig(): ModuleJoinerConfig;
+    retrieve(code: string, config?: FindConfig<CurrencyTypes.CurrencyDTO>, sharedContext?: Context): Promise<CurrencyTypes.CurrencyDTO>;
+    list(filters?: FilterableCurrencyProps, config?: FindConfig<CurrencyTypes.CurrencyDTO>, sharedContext?: Context): Promise<CurrencyTypes.CurrencyDTO[]>;
+    listAndCount(filters?: FilterableCurrencyProps, config?: FindConfig<CurrencyTypes.CurrencyDTO>, sharedContext?: Context): Promise<[CurrencyTypes.CurrencyDTO[], number]>;
+    protected static normalizeFilters(filters: FilterableCurrencyProps | undefined): FilterableCurrencyProps | undefined;
+}
+export {};

package/dist/services/currency-module-service.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@medusajs/utils");
+const _models_1 = require("../models");
+const joiner_config_1 = require("../joiner-config");
+const generateMethodForModels = [];
+class CurrencyModuleService extends utils_1.ModulesSdkUtils.abstractModuleServiceFactory(_models_1.Currency, generateMethodForModels, joiner_config_1.entityNameToLinkableKeysMap) {
+    constructor({ baseRepository, currencyService }, moduleDeclaration) {
+        // @ts-ignore
+        super(...arguments);
+        this.moduleDeclaration = moduleDeclaration;
+        this.baseRepository_ = baseRepository;
+        this.currencyService_ = currencyService;
+    }
+    __joinerConfig() {
+        return joiner_config_1.joinerConfig;
+    }
+    retrieve(code, config, sharedContext) {
+        return this.currencyService_.retrieve(code?.toLowerCase(), config, sharedContext);
+    }
+    list(filters, config, sharedContext) {
+        return this.currencyService_.list(CurrencyModuleService.normalizeFilters(filters), config, sharedContext);
+    }
+    listAndCount(filters, config, sharedContext) {
+        return this.currencyService_.listAndCount(CurrencyModuleService.normalizeFilters(filters), config, sharedContext);
+    }
+    static normalizeFilters(filters) {
+        return normalizeFilterable(filters, (fieldName, value) => {
+            if (fieldName === "code" && !!value) {
+                return value.toLowerCase();
+            }
+            return value;
+        });
+    }
+}
+exports.default = CurrencyModuleService;
+// TODO: Move normalizer support to `buildQuery` so we don't even need to override the list/retrieve methods just for normalization
+const normalizeFilterable = (filters, normalizer) => {
+    if (!filters) {
+        return filters;
+    }
+    const normalizedFilters = {};
+    for (const key in filters) {
+        if (key === "$and" || key === "$or") {
+            normalizedFilters[key] = filters[key].map((filter) => normalizeFilterable(filter, normalizer));
+        }
+        else if (filters[key] !== undefined) {
+            if (Array.isArray(filters[key])) {
+                normalizedFilters[key] = filters[key].map((val) => normalizer(key, val));
+            }
+            else {
+                normalizedFilters[key] = normalizer(key, filters[key]);
+            }
+        }
+    }
+    return normalizedFilters;
+};

package/dist/services/index.d.ts

@@ -0,0 +1 @@
+export { default as CurrencyModuleService } from "./currency-module-service";

package/dist/services/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CurrencyModuleService = void 0;
+var currency_module_service_1 = require("./currency-module-service");
+Object.defineProperty(exports, "CurrencyModuleService", { enumerable: true, get: function () { return __importDefault(currency_module_service_1).default; } });

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+import { IEventBusModuleService, Logger } from "@medusajs/types";
+export type InitializeModuleInjectableDependencies = {
+    logger?: Logger;
+    eventBusService?: IEventBusModuleService;
+};

package/dist/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@medusajs/currency",
+  "version": "0.1.0",
+  "description": "Medusa Currency module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=16"
+  },
+  "bin": {
+    "medusa-currency-seed": "dist/scripts/bin/run-seed.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medusajs/medusa",
+    "directory": "packages/currency"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Medusa",
+  "license": "MIT",
+  "scripts": {
+    "watch": "tsc --build --watch",
+    "watch:test": "tsc --build tsconfig.spec.json --watch",
+    "prepublishOnly": "cross-env NODE_ENV=production tsc --build && tsc-alias -p tsconfig.json",
+    "build": "rimraf dist && tsc --build && tsc-alias -p tsconfig.json",
+    "test": "jest --runInBand --bail --forceExit -- src/**/__tests__/**/*.ts",
+    "test:integration": "jest --forceExit -- integration-tests/**/__tests__/**/*.ts",
+    "migration:generate": " MIKRO_ORM_CLI=./mikro-orm.config.dev.ts mikro-orm migration:generate",
+    "migration:initial": " MIKRO_ORM_CLI=./mikro-orm.config.dev.ts mikro-orm migration:create --initial",
+    "migration:create": " MIKRO_ORM_CLI=./mikro-orm.config.dev.ts mikro-orm migration:create",
+    "migration:up": " MIKRO_ORM_CLI=./mikro-orm.config.dev.ts mikro-orm migration:up",
+    "orm:cache:clear": " MIKRO_ORM_CLI=./mikro-orm.config.dev.ts mikro-orm cache:clear"
+  },
+  "devDependencies": {
+    "@mikro-orm/cli": "5.9.7",
+    "cross-env": "^5.2.1",
+    "jest": "^29.6.3",
+    "medusa-test-utils": "workspace:^",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "tsc-alias": "^1.8.6",
+    "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "@medusajs/modules-sdk": "1.12.9-next-20240305095805",
+    "@medusajs/types": "1.11.14-next-20240305095805",
+    "@medusajs/utils": "1.11.7-next-20240305095805",
+    "@mikro-orm/core": "5.9.7",
+    "@mikro-orm/migrations": "5.9.7",
+    "@mikro-orm/postgresql": "5.9.7",
+    "awilix": "^8.0.0",
+    "dotenv": "^16.1.4",
+    "knex": "2.4.2"
+  }
+}