@strapi/provider-upload-local 4.10.0-beta.0 → 4.10.0-beta.1

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+import { ReadStream } from 'fs';
+interface File {
+    name: string;
+    alternativeText?: string;
+    caption?: string;
+    width?: number;
+    height?: number;
+    formats?: Record<string, unknown>;
+    hash: string;
+    ext?: string;
+    mime: string;
+    size: number;
+    url: string;
+    previewUrl?: string;
+    path?: string;
+    provider?: string;
+    provider_metadata?: Record<string, unknown>;
+    stream?: ReadStream;
+    buffer?: Buffer;
+}
+interface InitOptions {
+    sizeLimit?: number;
+}
+interface CheckFileSizeOptions {
+    sizeLimit?: number;
+}
+declare const _default: {
+    init({ sizeLimit: providerOptionsSizeLimit }?: InitOptions): {
+        checkFileSize(file: File, options: CheckFileSizeOptions): void;
+        uploadStream(file: File): Promise<void>;
+        upload(file: File): Promise<void>;
+        delete(file: File): Promise<string | void>;
+    };
+};
+export = _default;

package/dist/index.js

@@ -0,0 +1,87 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const stream_1 = require("stream");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const utils_1 = __importDefault(require("@strapi/utils"));
+const { PayloadTooLargeError } = utils_1.default.errors;
+const { kbytesToBytes, bytesToHumanReadable } = utils_1.default.file;
+const UPLOADS_FOLDER_NAME = 'uploads';
+module.exports = {
+    init({ sizeLimit: providerOptionsSizeLimit } = {}) {
+        // TODO V5: remove providerOptions sizeLimit
+        if (providerOptionsSizeLimit) {
+            process.emitWarning('[deprecated] In future versions, "sizeLimit" argument will be ignored from upload.config.providerOptions. Move it to upload.config');
+        }
+        // Ensure uploads folder exists
+        const uploadPath = path_1.default.resolve(strapi.dirs.static.public, UPLOADS_FOLDER_NAME);
+        if (!fs_extra_1.default.pathExistsSync(uploadPath)) {
+            throw new Error(`The upload folder (${uploadPath}) doesn't exist or is not accessible. Please make sure it exists.`);
+        }
+        return {
+            checkFileSize(file, options) {
+                const { sizeLimit } = options ?? {};
+                // TODO V5: remove providerOptions sizeLimit
+                if (providerOptionsSizeLimit) {
+                    if (kbytesToBytes(file.size) > providerOptionsSizeLimit)
+                        throw new PayloadTooLargeError(`${file.name} exceeds size limit of ${bytesToHumanReadable(providerOptionsSizeLimit)}.`);
+                }
+                else if (sizeLimit) {
+                    if (kbytesToBytes(file.size) > sizeLimit)
+                        throw new PayloadTooLargeError(`${file.name} exceeds size limit of ${bytesToHumanReadable(sizeLimit)}.`);
+                }
+            },
+            uploadStream(file) {
+                if (!file.stream) {
+                    return Promise.reject(new Error('Missing file stream'));
+                }
+                const { stream } = file;
+                return new Promise((resolve, reject) => {
+                    (0, stream_1.pipeline)(stream, fs_1.default.createWriteStream(path_1.default.join(uploadPath, `${file.hash}${file.ext}`)), (err) => {
+                        if (err) {
+                            return reject(err);
+                        }
+                        file.url = `/${UPLOADS_FOLDER_NAME}/${file.hash}${file.ext}`;
+                        resolve();
+                    });
+                });
+            },
+            upload(file) {
+                if (!file.buffer) {
+                    return Promise.reject(new Error('Missing file buffer'));
+                }
+                const { buffer } = file;
+                return new Promise((resolve, reject) => {
+                    // write file in public/assets folder
+                    fs_1.default.writeFile(path_1.default.join(uploadPath, `${file.hash}${file.ext}`), buffer, (err) => {
+                        if (err) {
+                            return reject(err);
+                        }
+                        file.url = `/${UPLOADS_FOLDER_NAME}/${file.hash}${file.ext}`;
+                        resolve();
+                    });
+                });
+            },
+            delete(file) {
+                return new Promise((resolve, reject) => {
+                    const filePath = path_1.default.join(uploadPath, `${file.hash}${file.ext}`);
+                    if (!fs_1.default.existsSync(filePath)) {
+                        resolve("File doesn't exist");
+                        return;
+                    }
+                    // remove file from public/assets folder
+                    fs_1.default.unlink(filePath, (err) => {
+                        if (err) {
+                            return reject(err);
+                        }
+                        resolve();
+                    });
+                });
+            },
+        };
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,mCAAkC;AAClC,4CAAoC;AACpC,gDAAwB;AACxB,wDAA2B;AAC3B,0DAAkC;AAsBlC,MAAM,EAAE,oBAAoB,EAAE,GAAG,eAAK,CAAC,MAAM,CAAC;AAC9C,MAAM,EAAE,aAAa,EAAE,oBAAoB,EAAE,GAAG,eAAK,CAAC,IAAI,CAAC;AAE3D,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAUtC,iBAAS;IACP,IAAI,CAAC,EAAE,SAAS,EAAE,wBAAwB,KAAkB,EAAE;QAC5D,4CAA4C;QAC5C,IAAI,wBAAwB,EAAE;YAC5B,OAAO,CAAC,WAAW,CACjB,oIAAoI,CACrI,CAAC;SACH;QAED,+BAA+B;QAC/B,MAAM,UAAU,GAAG,cAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAChF,IAAI,CAAC,kBAAG,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;YACnC,MAAM,IAAI,KAAK,CACb,sBAAsB,UAAU,mEAAmE,CACpG,CAAC;SACH;QAED,OAAO;YACL,aAAa,CAAC,IAAU,EAAE,OAA6B;gBACrD,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;gBAEpC,4CAA4C;gBAC5C,IAAI,wBAAwB,EAAE;oBAC5B,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,wBAAwB;wBACrD,MAAM,IAAI,oBAAoB,CAC5B,GAAG,IAAI,CAAC,IAAI,0BAA0B,oBAAoB,CACxD,wBAAwB,CACzB,GAAG,CACL,CAAC;iBACL;qBAAM,IAAI,SAAS,EAAE;oBACpB,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,SAAS;wBACtC,MAAM,IAAI,oBAAoB,CAC5B,GAAG,IAAI,CAAC,IAAI,0BAA0B,oBAAoB,CAAC,SAAS,CAAC,GAAG,CACzE,CAAC;iBACL;YACH,CAAC;YACD,YAAY,CAAC,IAAU;gBACrB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;oBAChB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC;iBACzD;gBAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;gBAExB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBACrC,IAAA,iBAAQ,EACN,MAAM,EACN,YAAE,CAAC,iBAAiB,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,EACtE,CAAC,GAAG,EAAE,EAAE;wBACN,IAAI,GAAG,EAAE;4BACP,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;yBACpB;wBAED,IAAI,CAAC,GAAG,GAAG,IAAI,mBAAmB,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;wBAE7D,OAAO,EAAE,CAAC;oBACZ,CAAC,CACF,CAAC;gBACJ,CAAC,CAAC,CAAC;YACL,CAAC;YACD,MAAM,CAAC,IAAU;gBACf,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;oBAChB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC;iBACzD;gBAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;gBAExB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBACrC,qCAAqC;oBACrC,YAAE,CAAC,SAAS,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE;wBAC7E,IAAI,GAAG,EAAE;4BACP,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;yBACpB;wBAED,IAAI,CAAC,GAAG,GAAG,IAAI,mBAAmB,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;wBAE7D,OAAO,EAAE,CAAC;oBACZ,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;YACL,CAAC;YACD,MAAM,CAAC,IAAU;gBACf,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBACrC,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;oBAElE,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;wBAC5B,OAAO,CAAC,oBAAoB,CAAC,CAAC;wBAC9B,OAAO;qBACR;oBAED,wCAAwC;oBACxC,YAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE;wBAC1B,IAAI,GAAG,EAAE;4BACP,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;yBACpB;wBAED,OAAO,EAAE,CAAC;oBACZ,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/provider-upload-local",
-  "version": "4.10.0-beta.0",
+  "version": "4.10.0-beta.1",
   "description": "Local provider for strapi upload",
   "keywords": [
     "upload",
@@ -27,20 +27,33 @@
       "url": "https://strapi.io"
     }
   ],
-  "main": "./lib",
-  "directories": {
-    "lib": "./lib"
-  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist"
+  ],
   "scripts": {
-    "test": "echo \"no tests yet\""
+    "build": "run -T tsc",
+    "build:ts": "run -T tsc",
+    "watch": "run -T tsc -w --preserveWatchOutput",
+    "clean": "run -T rimraf ./dist",
+    "prepublishOnly": "yarn clean && yarn build",
+    "test:unit": "run -T jest",
+    "test:unit:watch": "run -T jest --watch",
+    "lint": "run -T eslint ."
   },
   "dependencies": {
-    "@strapi/utils": "4.10.0-beta.0",
+    "@strapi/utils": "4.10.0-beta.1",
     "fs-extra": "10.0.0"
   },
+  "devDependencies": {
+    "@types/jest": "29.2.0",
+    "eslint-config-custom": "4.10.0-beta.1",
+    "tsconfig": "4.10.0-beta.1"
+  },
   "engines": {
     "node": ">=14.19.1 <=18.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "1519ef0e56d27b738f24fc88223797651ad47aaf"
+  "gitHead": "95d581b31bee464af42e5d8db408fa578d8532c7"
 }

package/lib/index.js

@@ -1,105 +0,0 @@
-'use strict';
-
-/**
- * Module dependencies
- */
-
-// Public node modules.
-const { pipeline } = require('stream');
-const fs = require('fs');
-const path = require('path');
-const fse = require('fs-extra');
-const {
-  errors: { PayloadTooLargeError },
-  file: { kbytesToBytes, bytesToHumanReadable },
-} = require('@strapi/utils');
-
-const UPLOADS_FOLDER_NAME = 'uploads';
-
-module.exports = {
-  init({ sizeLimit: providerOptionsSizeLimit } = {}) {
-    // TODO V5: remove providerOptions sizeLimit
-    if (providerOptionsSizeLimit) {
-      process.emitWarning(
-        `[deprecated] In future versions, "sizeLimit" argument will be ignored from upload.config.providerOptions. Move it to upload.config`
-      );
-    }
-
-    // Ensure uploads folder exists
-    const uploadPath = path.resolve(strapi.dirs.static.public, UPLOADS_FOLDER_NAME);
-    if (!fse.pathExistsSync(uploadPath)) {
-      throw new Error(
-        `The upload folder (${uploadPath}) doesn't exist or is not accessible. Please make sure it exists.`
-      );
-    }
-
-    return {
-      checkFileSize(file, { sizeLimit } = {}) {
-        // TODO V5: remove providerOptions sizeLimit
-        if (providerOptionsSizeLimit) {
-          if (kbytesToBytes(file.size) > providerOptionsSizeLimit)
-            throw new PayloadTooLargeError(
-              `${file.name} exceeds size limit of ${bytesToHumanReadable(
-                providerOptionsSizeLimit
-              )}.`
-            );
-        } else if (sizeLimit) {
-          if (kbytesToBytes(file.size) > sizeLimit)
-            throw new PayloadTooLargeError(
-              `${file.name} exceeds size limit of ${bytesToHumanReadable(sizeLimit)}.`
-            );
-        }
-      },
-      uploadStream(file) {
-        return new Promise((resolve, reject) => {
-          pipeline(
-            file.stream,
-            fs.createWriteStream(path.join(uploadPath, `${file.hash}${file.ext}`)),
-            (err) => {
-              if (err) {
-                return reject(err);
-              }
-
-              file.url = `/${UPLOADS_FOLDER_NAME}/${file.hash}${file.ext}`;
-
-              resolve();
-            }
-          );
-        });
-      },
-      upload(file) {
-        return new Promise((resolve, reject) => {
-          // write file in public/assets folder
-          fs.writeFile(path.join(uploadPath, `${file.hash}${file.ext}`), file.buffer, (err) => {
-            if (err) {
-              return reject(err);
-            }
-
-            file.url = `/${UPLOADS_FOLDER_NAME}/${file.hash}${file.ext}`;
-
-            resolve();
-          });
-        });
-      },
-      delete(file) {
-        return new Promise((resolve, reject) => {
-          const filePath = path.join(uploadPath, `${file.hash}${file.ext}`);
-
-          if (!fs.existsSync(filePath)) {
-            // eslint-disable-next-line no-promise-executor-return
-            return resolve("File doesn't exist");
-          }
-
-          // remove file from public/assets folder
-          fs.unlink(filePath, (err) => {
-            if (err) {
-              return reject(err);
-            }
-
-            resolve();
-          });
-        });
-      },
-    };
-  },
-};