@medusajs/fulfillment 0.1.0

package/README.md

@@ -0,0 +1 @@
+# Fulfillment 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.FULFILLMENT,
+    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,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.joinerConfig = exports.entityNameToLinkableKeysMap = exports.LinkableKeys = void 0;
+const modules_sdk_1 = require("@medusajs/modules-sdk");
+// TODO manage the config
+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.FULFILLMENT,
+    primaryKeys: ["id"],
+    linkableKeys: exports.LinkableKeys,
+    alias: [],
+};

package/dist/models/fullfilment-set.d.ts

@@ -0,0 +1,14 @@
+import { OptionalProps } from "@mikro-orm/core";
+import { DAL } from "@medusajs/types";
+type FulfillmentSetOptionalProps = DAL.SoftDeletableEntityDateColumns;
+export default class FulfillmentSet {
+    [OptionalProps]?: FulfillmentSetOptionalProps;
+    id: string;
+    name: string;
+    created_at: Date;
+    updated_at: Date;
+    deleted_at: Date | null;
+    onCreate(): void;
+    onInit(): void;
+}
+export {};

package/dist/models/fullfilment-set.js

@@ -0,0 +1,71 @@
+"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 utils_1 = require("@medusajs/utils");
+const core_1 = require("@mikro-orm/core");
+let FulfillmentSet = class FulfillmentSet {
+    constructor() {
+        this.deleted_at = null;
+    }
+    onCreate() {
+        this.id = (0, utils_1.generateEntityId)(this.id, "fuset");
+    }
+    onInit() {
+        this.id = (0, utils_1.generateEntityId)(this.id, "fuset");
+    }
+};
+__decorate([
+    (0, core_1.PrimaryKey)({ columnType: "text" }),
+    __metadata("design:type", String)
+], FulfillmentSet.prototype, "id", void 0);
+__decorate([
+    (0, core_1.Property)({ columnType: "text" }),
+    __metadata("design:type", String)
+], FulfillmentSet.prototype, "name", void 0);
+__decorate([
+    (0, core_1.Property)({
+        onCreate: () => new Date(),
+        columnType: "timestamptz",
+        defaultRaw: "now()",
+    }),
+    __metadata("design:type", Date)
+], FulfillmentSet.prototype, "created_at", void 0);
+__decorate([
+    (0, core_1.Property)({
+        onCreate: () => new Date(),
+        onUpdate: () => new Date(),
+        columnType: "timestamptz",
+        defaultRaw: "now()",
+    }),
+    __metadata("design:type", Date)
+], FulfillmentSet.prototype, "updated_at", void 0);
+__decorate([
+    (0, core_1.Index)({ name: "IDX_fulfillment_set_deleted_at" }),
+    (0, core_1.Property)({ columnType: "timestamptz", nullable: true }),
+    __metadata("design:type", Object)
+], FulfillmentSet.prototype, "deleted_at", void 0);
+__decorate([
+    (0, core_1.BeforeCreate)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], FulfillmentSet.prototype, "onCreate", null);
+__decorate([
+    (0, core_1.OnInit)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], FulfillmentSet.prototype, "onInit", null);
+FulfillmentSet = __decorate([
+    (0, core_1.Entity)(),
+    (0, core_1.Filter)(utils_1.DALUtils.mikroOrmSoftDeletableFilterOptions)
+], FulfillmentSet);
+exports.default = FulfillmentSet;

package/dist/models/index.d.ts

@@ -0,0 +1 @@
+export { default as FulfillmentSet } from "./fullfilment-set";

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.FulfillmentSet = void 0;
+var fullfilment_set_1 = require("./fullfilment-set");
+Object.defineProperty(exports, "FulfillmentSet", { enumerable: true, get: function () { return __importDefault(fullfilment_set_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,58 @@
+"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 });
+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 migrationScriptOptions = {
+    moduleName: modules_sdk_1.Modules.FULFILLMENT,
+    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.FULFILLMENT,
+    moduleModels: Object.values(Models),
+    migrationsPath: __dirname + "/migrations",
+});
+const service = _services_1.FulfillmentModuleService;
+const loaders = [containerLoader, connectionLoader];
+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-fulfillment-seed <filePath>`);
+    }
+    const run = utils_1.ModulesSdkUtils.buildSeedScript({
+        moduleName: modules_sdk_1.Modules.FULFILLMENT,
+        models: Models,
+        pathToMigrations: __dirname + "/../../migrations",
+        seedHandler: async ({ manager, data }) => {
+            // TODO: Add seed logic
+        },
+    });
+    await run({ path });
+})();

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

@@ -0,0 +1,20 @@
+import { Context, DAL, FulfillmentTypes, IFulfillmentModuleService, InternalModuleDeclaration, ModuleJoinerConfig, ModulesSdkTypes } from "@medusajs/types";
+import { ModulesSdkUtils } from "@medusajs/utils";
+import { FulfillmentSet } from "../models";
+type InjectedDependencies = {
+    baseRepository: DAL.RepositoryService;
+    fulfillmentService: ModulesSdkTypes.InternalModuleService<any>;
+};
+declare const FulfillmentModuleService_base: new (container: InjectedDependencies) => ModulesSdkUtils.AbstractModuleService<InjectedDependencies, any, {}>;
+export default class FulfillmentModuleService<TEntity extends FulfillmentSet = FulfillmentSet> extends FulfillmentModuleService_base implements IFulfillmentModuleService {
+    protected readonly moduleDeclaration: InternalModuleDeclaration;
+    protected baseRepository_: DAL.RepositoryService;
+    protected readonly fulfillmentService_: ModulesSdkTypes.InternalModuleService<TEntity>;
+    constructor({ baseRepository, fulfillmentService }: InjectedDependencies, moduleDeclaration: InternalModuleDeclaration);
+    __joinerConfig(): ModuleJoinerConfig;
+    create(data: any[], sharedContext?: Context): Promise<FulfillmentTypes.FulfillmentDTO[]>;
+    create(data: any, sharedContext?: Context): Promise<FulfillmentTypes.FulfillmentDTO>;
+    update(data: any[], sharedContext?: Context): Promise<FulfillmentTypes.FulfillmentDTO[]>;
+    update(data: any, sharedContext?: Context): Promise<FulfillmentTypes.FulfillmentDTO>;
+}
+export {};

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

@@ -0,0 +1,46 @@
+"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 utils_1 = require("@medusajs/utils");
+const joiner_config_1 = require("../joiner-config");
+const _models_1 = require("../models");
+class FulfillmentModuleService extends utils_1.ModulesSdkUtils.abstractModuleServiceFactory(_models_1.FulfillmentSet, [], joiner_config_1.entityNameToLinkableKeysMap) {
+    constructor({ baseRepository, fulfillmentService }, moduleDeclaration) {
+        // @ts-ignore
+        super(...arguments);
+        this.moduleDeclaration = moduleDeclaration;
+        this.baseRepository_ = baseRepository;
+        this.fulfillmentService_ = fulfillmentService;
+    }
+    __joinerConfig() {
+        return joiner_config_1.joinerConfig;
+    }
+    // TODO Implement the methods from the interface and change type
+    async create(data, sharedContext) {
+        return await Promise.resolve([]);
+    }
+    async update(data, sharedContext) {
+        return await Promise.resolve([]);
+    }
+}
+exports.default = FulfillmentModuleService;
+__decorate([
+    (0, utils_1.InjectTransactionManager)("baseRepository_"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Object]),
+    __metadata("design:returntype", Promise)
+], FulfillmentModuleService.prototype, "create", null);
+__decorate([
+    (0, utils_1.InjectTransactionManager)("baseRepository_"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Object]),
+    __metadata("design:returntype", Promise)
+], FulfillmentModuleService.prototype, "update", null);

package/dist/services/index.d.ts

@@ -0,0 +1 @@
+export { default as FulfillmentModuleService } from "./fulfillment-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.FulfillmentModuleService = void 0;
+var fulfillment_module_service_1 = require("./fulfillment-module-service");
+Object.defineProperty(exports, "FulfillmentModuleService", { enumerable: true, get: function () { return __importDefault(fulfillment_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/fulfillment",
+  "version": "0.1.0",
+  "description": "Medusa Fulfillment module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=16"
+  },
+  "bin": {
+    "medusa-fulfillment-seed": "dist/scripts/bin/run-seed.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medusajs/medusa",
+    "directory": "packages/fulfillment"
+  },
+  "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 --runInBand --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": "^1.1.40",
+    "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.4",
+    "@medusajs/types": "^1.11.8",
+    "@medusajs/utils": "^1.11.1",
+    "@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"
+  }
+}