@medusajs/file-local 1.0.1-next-20230529135657

package/README.md

@@ -0,0 +1,49 @@
+# Local file storage
+
+Store uploaded files to your Medusa backend locally.
+
+> Not suited for production environments
+
+[Plugin Documentation](https://docs.medusajs.com/plugins/file-service/local) | [Medusa Website](https://medusajs.com) | [Medusa Repository](https://github.com/medusajs/medusa)
+
+## Features
+
+- Store product images locally
+
+---
+
+## Prerequisites
+
+- [Medusa backend](https://docs.medusajs.com/development/backend/install)
+
+---
+
+## How to Install
+
+1\. Run the following command in the directory of the Medusa backend:
+
+```bash
+npm install @medusajs/file-local
+```
+
+2 \. In `medusa-config.js` add the following at the end of the `plugins` array:
+
+```js
+const plugins = [
+  // ...
+  `@medusajs/file-local`
+]
+```
+
+---
+
+## Test the Plugin
+
+1\. Run the following command in the directory of the Medusa backend to run the backend:
+
+```bash
+npm run start
+```
+
+2\. Upload an image for a product using the admin dashboard or using [the Admin APIs](https://docs.medusajs.com/api/admin#tag/Upload).
+

package/dist/api/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (rootDirectory: any, pluginOptions: any) => import("express-serve-static-core").Router;
+export default _default;

package/dist/api/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var express_1 = __importDefault(require("express"));
+exports.default = (function (rootDirectory, pluginOptions) {
+    var _a;
+    var app = express_1.default.Router();
+    var uploadDir = (_a = pluginOptions.upload_dir) !== null && _a !== void 0 ? _a : "uploads/images";
+    app.use("/".concat(uploadDir), express_1.default.static(uploadDir));
+    return app;
+});
+//# sourceMappingURL=index.js.map

package/dist/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;;;AAAA,oDAA6B;AAE7B,mBAAe,UAAC,aAAa,EAAE,aAAa;;IAC1C,IAAM,GAAG,GAAG,iBAAO,CAAC,MAAM,EAAE,CAAA;IAE5B,IAAM,SAAS,GAAG,MAAA,aAAa,CAAC,UAAU,mCAAI,gBAAgB,CAAA;IAE9D,GAAG,CAAC,GAAG,CAAC,WAAI,SAAS,CAAE,EAAE,iBAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAA;IAEnD,OAAO,GAAG,CAAA;AACZ,CAAC,EAAA"}

package/dist/services/local-file-service.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="multer" />
+/// <reference types="node" />
+import { AbstractFileService, FileServiceGetUploadStreamResult, FileServiceUploadResult, IFileService } from "@medusajs/medusa";
+declare class LocalService extends AbstractFileService implements IFileService {
+    protected uploadDir_: string;
+    protected backendUrl_: string;
+    constructor({}: {}, options: any);
+    upload(file: Express.Multer.File): Promise<FileServiceUploadResult>;
+    uploadProtected(file: Express.Multer.File): Promise<{
+        url: string;
+    }>;
+    uploadFile(file: Express.Multer.File, options?: {}): Promise<{
+        url: string;
+    }>;
+    delete(file: any): Promise<void>;
+    getUploadStreamDescriptor(fileData: any): Promise<FileServiceGetUploadStreamResult>;
+    getDownloadStream(fileData: any): Promise<NodeJS.ReadableStream>;
+    getPresignedDownloadUrl(fileData: any): Promise<string>;
+}
+export default LocalService;

package/dist/services/local-file-service.js

@@ -0,0 +1,139 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var medusa_1 = require("@medusajs/medusa");
+var fs_1 = __importDefault(require("fs"));
+var path_1 = require("path");
+var LocalService = /** @class */ (function (_super) {
+    __extends(LocalService, _super);
+    function LocalService(_a, options) {
+        var _this = _super.call(this, {}, options) || this;
+        _this.uploadDir_ = options.upload_dir || "uploads/images";
+        _this.backendUrl_ = options.backend_url || "http://localhost:9000";
+        return _this;
+    }
+    LocalService.prototype.upload = function (file) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.uploadFile(file)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    LocalService.prototype.uploadProtected = function (file) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.uploadFile(file, {})];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    LocalService.prototype.uploadFile = function (file, options) {
+        if (options === void 0) { options = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            var parsedFilename, fileKey;
+            var _this = this;
+            return __generator(this, function (_a) {
+                parsedFilename = (0, path_1.parse)(file.originalname);
+                fileKey = "".concat(parsedFilename.name, "-").concat(Date.now()).concat(parsedFilename.ext);
+                return [2 /*return*/, new Promise(function (resolve, reject) {
+                        fs_1.default.copyFile(file.path, "".concat(_this.uploadDir_, "/").concat(fileKey), function (err) {
+                            if (err) {
+                                throw err;
+                            }
+                            var fileUrl = "".concat(_this.backendUrl_, "/").concat(_this.uploadDir_, "/").concat(fileKey);
+                            resolve({ url: fileUrl });
+                        });
+                    })];
+            });
+        });
+    };
+    LocalService.prototype.delete = function (file) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                throw Error("Not implemented");
+            });
+        });
+    };
+    LocalService.prototype.getUploadStreamDescriptor = function (fileData) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                throw Error("Not implemented");
+            });
+        });
+    };
+    LocalService.prototype.getDownloadStream = function (fileData) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                throw Error("Not implemented");
+            });
+        });
+    };
+    LocalService.prototype.getPresignedDownloadUrl = function (fileData) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                throw Error("Not implemented");
+            });
+        });
+    };
+    return LocalService;
+}(medusa_1.AbstractFileService));
+exports.default = LocalService;
+//# sourceMappingURL=local-file-service.js.map

package/dist/services/local-file-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-file-service.js","sourceRoot":"","sources":["../../src/services/local-file-service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAKyB;AACzB,0CAAmB;AACnB,6BAA4B;AAE5B;IAA2B,gCAAmB;IAI5C,sBAAY,EAAE,EAAE,OAAO;QAAvB,YACE,kBAAM,EAAE,EAAE,OAAO,CAAC,SAInB;QAFC,KAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,gBAAgB,CAAA;QACxD,KAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,uBAAuB,CAAA;;IACnE,CAAC;IAEK,6BAAM,GAAZ,UAAa,IAAyB;;;;4BAC7B,qBAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAA;4BAAlC,sBAAO,SAA2B,EAAA;;;;KACnC;IAEK,sCAAe,GAArB,UAAsB,IAAyB;;;;4BACtC,qBAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,EAAA;4BAAtC,sBAAO,SAA+B,EAAA;;;;KACvC;IAEK,iCAAU,GAAhB,UACE,IAAyB,EACzB,OAAY;QAAZ,wBAAA,EAAA,YAAY;;;;;gBAEN,cAAc,GAAG,IAAA,YAAK,EAAC,IAAI,CAAC,YAAY,CAAC,CAAA;gBAEzC,OAAO,GAAG,UAAG,cAAc,CAAC,IAAI,cAAI,IAAI,CAAC,GAAG,EAAE,SAAG,cAAc,CAAC,GAAG,CAAE,CAAA;gBAE3E,sBAAO,IAAI,OAAO,CAAC,UAAC,OAAO,EAAE,MAAM;wBACjC,YAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,UAAG,KAAI,CAAC,UAAU,cAAI,OAAO,CAAE,EAAE,UAAC,GAAG;4BAC1D,IAAI,GAAG,EAAE;gCACP,MAAM,GAAG,CAAA;6BACV;4BAED,IAAM,OAAO,GAAG,UAAG,KAAI,CAAC,WAAW,cAAI,KAAI,CAAC,UAAU,cAAI,OAAO,CAAE,CAAA;4BAEnE,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAA;wBAC3B,CAAC,CAAC,CAAA;oBACJ,CAAC,CAAC,EAAA;;;KACH;IAEK,6BAAM,GAAZ,UAAa,IAAI;;;gBACf,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAA;;;KAC/B;IAEK,gDAAyB,GAA/B,UACE,QAAQ;;;gBAER,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAA;;;KAC/B;IAEK,wCAAiB,GAAvB,UAAwB,QAAQ;;;gBAC9B,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAA;;;KAC/B;IAEK,8CAAuB,GAA7B,UAA8B,QAAQ;;;gBACpC,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAA;;;KAC/B;IACH,mBAAC;AAAD,CAAC,AAzDD,CAA2B,4BAAmB,GAyD7C;AAED,kBAAe,YAAY,CAAA"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@medusajs/file-local",
+  "version": "1.0.1-next-20230529135657",
+  "description": "Local file plugin for Medusa",
+  "main": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medusajs/medusa",
+    "directory": "packages/medusa-file-local"
+  },
+  "author": "Medusa",
+  "license": "MIT",
+  "devDependencies": {
+    "@medusajs/medusa": "1.11.1-next-20230529135657",
+    "cross-env": "^5.2.1",
+    "jest": "^25.5.4",
+    "typescript": "^4.9.5"
+  },
+  "scripts": {
+    "prepare": "cross-env NODE_ENV=production yarn run build",
+    "test": "jest --passWithNoTests src",
+    "build": "tsc",
+    "watch": "tsc --watch"
+  },
+  "peerDependencies": {
+    "medusa-interfaces": "^1.3.7"
+  },
+  "gitHead": "81a7ff73d012fda722f6e9ef0bd9ba0232d37808",
+  "keywords": [
+    "medusa-plugin",
+    "medusa-plugin-file"
+  ]
+}