@nocobase/plugin-file-manager 0.11.1-alpha.5 → 0.12.0-alpha.2

package/dist/server/index.js

@@ -0,0 +1,23 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var constants = require('./constants');
+var server = require('./server');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var server__default = /*#__PURE__*/_interopDefault(server);
+
+
+
+Object.defineProperty(exports, 'default', {
+  enumerable: true,
+  get: function () { return server__default.default; }
+});
+Object.keys(constants).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return constants[k]; }
+  });
+});

package/dist/server/rules/index.js

@@ -0,0 +1,14 @@
+'use strict';
+
+var mimetype = require('./mimetype');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var mimetype__default = /*#__PURE__*/_interopDefault(mimetype);
+
+
+
+Object.defineProperty(exports, 'mimetype', {
+  enumerable: true,
+  get: function () { return mimetype__default.default; }
+});

package/dist/server/rules/mimetype.js

@@ -0,0 +1,13 @@
+'use strict';
+
+var match = require('mime-match');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var match__default = /*#__PURE__*/_interopDefault(match);
+
+function mimetype_default(file, options = "*") {
+  return options.toString().split(",").some(match__default.default(file.mimetype));
+}
+
+module.exports = mimetype_default;

package/dist/server/server.js

@@ -0,0 +1,75 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var server = require('@nocobase/server');
+var path = require('path');
+var initActions = require('./actions');
+var constants = require('./constants');
+var storages = require('./storages');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var initActions__default = /*#__PURE__*/_interopDefault(initActions);
+var storages__default = /*#__PURE__*/_interopDefault(storages);
+
+class PluginFileManager extends server.Plugin {
+  storageType() {
+    return process.env.DEFAULT_STORAGE_TYPE ?? "local";
+  }
+  async install() {
+    const defaultStorageConfig = storages.getStorageConfig(this.storageType());
+    if (defaultStorageConfig) {
+      const Storage = this.db.getCollection("storages");
+      if (await Storage.repository.findOne({
+        filter: {
+          name: defaultStorageConfig.defaults().name
+        }
+      })) {
+        return;
+      }
+      await Storage.repository.create({
+        values: {
+          ...defaultStorageConfig.defaults(),
+          type: this.storageType(),
+          default: true
+        }
+      });
+    }
+  }
+  async load() {
+    await this.importCollections(path.resolve(__dirname, "./collections"));
+    this.app.acl.registerSnippet({
+      name: `pm.${this.name}.storages`,
+      actions: ["storages:*"]
+    });
+    initActions__default.default(this);
+    this.app.acl.allow("attachments", "upload", "loggedIn");
+    this.app.acl.allow("attachments", "create", "loggedIn");
+    if (process.env.APP_ENV !== "production") {
+      await storages.getStorageConfig(constants.STORAGE_TYPE_LOCAL).middleware(this.app);
+    }
+    const defaultStorageName = storages.getStorageConfig(this.storageType()).defaults().name;
+    this.app.acl.addFixedParams("storages", "destroy", () => {
+      return {
+        filter: { "name.$ne": defaultStorageName }
+      };
+    });
+    const ownMerger = () => {
+      return {
+        filter: {
+          createdById: "{{ctx.state.currentUser.id}}"
+        }
+      };
+    };
+    this.app.acl.addFixedParams("attachments", "update", ownMerger);
+    this.app.acl.addFixedParams("attachments", "create", ownMerger);
+    this.app.acl.addFixedParams("attachments", "destroy", ownMerger);
+  }
+}
+
+Object.defineProperty(exports, 'storageTypes', {
+  enumerable: true,
+  get: function () { return storages__default.default; }
+});
+exports.default = PluginFileManager;

package/{src/server/storages/ali-oss.ts → dist/server/storages/ali-oss.js}

@@ -1,35 +1,38 @@
-import { AttachmentModel } from '.';
-import { STORAGE_TYPE_ALI_OSS } from '../constants';
-import { cloudFilenameGetter } from '../utils';
+'use strict';
 
-export default {
+var constants = require('../constants');
+var utils = require('../utils');
+
+var ali_oss_default = {
   make(storage) {
-    const createAliOssStorage = require('multer-aliyun-oss');
+    const createAliOssStorage = require("multer-aliyun-oss");
     return new createAliOssStorage({
       config: storage.options,
-      filename: cloudFilenameGetter(storage),
+      filename: utils.cloudFilenameGetter(storage)
     });
   },
   defaults() {
     return {
-      title: '阿里云对象存储',
-      type: STORAGE_TYPE_ALI_OSS,
-      name: 'ali-oss-1',
+      title: "\u963F\u91CC\u4E91\u5BF9\u8C61\u5B58\u50A8",
+      type: constants.STORAGE_TYPE_ALI_OSS,
+      name: "ali-oss-1",
       baseUrl: process.env.ALI_OSS_STORAGE_BASE_URL,
       options: {
         region: process.env.ALI_OSS_REGION,
         accessKeyId: process.env.ALI_OSS_ACCESS_KEY_ID,
         accessKeySecret: process.env.ALI_OSS_ACCESS_KEY_SECRET,
-        bucket: process.env.ALI_OSS_BUCKET,
-      },
+        bucket: process.env.ALI_OSS_BUCKET
+      }
     };
   },
-  async delete(storage, records: AttachmentModel[]): Promise<[number, AttachmentModel[]]> {
+  async delete(storage, records) {
     const { client } = this.make(storage);
     const { deleted } = await client.deleteMulti(records.map((record) => `${record.path}/${record.filename}`));
     return [
       deleted.length,
-      records.filter((record) => !deleted.find((item) => item.Key === `${record.path}/${record.filename}`)),
+      records.filter((record) => !deleted.find((item) => item.Key === `${record.path}/${record.filename}`))
     ];
-  },
+  }
 };
+
+module.exports = ali_oss_default;

package/dist/server/storages/index.js

@@ -0,0 +1,30 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('@nocobase/utils');
+var local = require('./local');
+var oss = require('./ali-oss');
+var s3 = require('./s3');
+var cos = require('./tx-cos');
+var constants = require('../constants');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var local__default = /*#__PURE__*/_interopDefault(local);
+var oss__default = /*#__PURE__*/_interopDefault(oss);
+var s3__default = /*#__PURE__*/_interopDefault(s3);
+var cos__default = /*#__PURE__*/_interopDefault(cos);
+
+const storageTypes = new utils.Registry();
+storageTypes.register(constants.STORAGE_TYPE_LOCAL, local__default.default);
+storageTypes.register(constants.STORAGE_TYPE_ALI_OSS, oss__default.default);
+storageTypes.register(constants.STORAGE_TYPE_S3, s3__default.default);
+storageTypes.register(constants.STORAGE_TYPE_TX_COS, cos__default.default);
+function getStorageConfig(key) {
+  return storageTypes.get(key);
+}
+var storages_default = storageTypes;
+
+exports.default = storages_default;
+exports.getStorageConfig = getStorageConfig;

package/dist/server/storages/local.js

@@ -0,0 +1,148 @@
+'use strict';
+
+var fs = require('fs/promises');
+var serve = require('koa-static');
+var mkdirp = require('mkdirp');
+var multer = require('multer');
+var path = require('path');
+var url = require('url');
+var constants = require('../constants');
+var utils = require('../utils');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefault(fs);
+var serve__default = /*#__PURE__*/_interopDefault(serve);
+var mkdirp__default = /*#__PURE__*/_interopDefault(mkdirp);
+var multer__default = /*#__PURE__*/_interopDefault(multer);
+var path__default = /*#__PURE__*/_interopDefault(path);
+
+function match(basePath, pathname) {
+  if (!pathname.startsWith(basePath)) {
+    return false;
+  }
+  const newPath = pathname.replace(basePath, "") || "/";
+  if (basePath.slice(-1) === "/") {
+    return true;
+  }
+  return newPath[0] === "/";
+}
+async function refresh(app, storages, options) {
+  const Storage = app.db.getCollection("storages");
+  const items = await Storage.repository.find({
+    filter: {
+      type: constants.STORAGE_TYPE_LOCAL
+    },
+    transaction: options == null ? void 0 : options.transaction
+  });
+  const primaryKey = Storage.model.primaryKeyAttribute;
+  storages.clear();
+  for (const storage of items) {
+    storages.set(storage[primaryKey], storage);
+  }
+}
+function createLocalServerUpdateHook(app, storages) {
+  return async function(row, options) {
+    if (row.get("type") === constants.STORAGE_TYPE_LOCAL) {
+      await refresh(app, storages, options);
+    }
+  };
+}
+function getDocumentRoot(storage) {
+  const { documentRoot = process.env.LOCAL_STORAGE_DEST || "storage/uploads" } = storage.options || {};
+  return path__default.default.resolve(path__default.default.isAbsolute(documentRoot) ? documentRoot : path__default.default.join(process.cwd(), documentRoot));
+}
+async function middleware(app) {
+  const Storage = app.db.getCollection("storages");
+  const storages = /* @__PURE__ */ new Map();
+  const localServerUpdateHook = createLocalServerUpdateHook(app, storages);
+  Storage.model.addHook("afterSave", localServerUpdateHook);
+  Storage.model.addHook("afterDestroy", localServerUpdateHook);
+  app.on("beforeStart", async () => {
+    await refresh(app, storages);
+  });
+  app.use(async function(ctx, next) {
+    var _a;
+    for (const storage of storages.values()) {
+      const baseUrl = storage.get("baseUrl").trim();
+      if (!baseUrl) {
+        console.error('"baseUrl" is not configured');
+        continue;
+      }
+      let url$1;
+      try {
+        url$1 = new url.URL(baseUrl);
+      } catch (e) {
+        url$1 = {
+          pathname: baseUrl
+        };
+      }
+      if (url$1.origin && ((_a = storage == null ? void 0 : storage.options) == null ? void 0 : _a.serve) === false) {
+        continue;
+      }
+      const basePath = url$1.pathname.startsWith("/") ? url$1.pathname : `/${url$1.pathname}`;
+      if (!match(basePath, ctx.path)) {
+        continue;
+      }
+      ctx.path = ctx.path.replace(basePath, "");
+      const documentRoot = getDocumentRoot(storage);
+      return serve__default.default(documentRoot)(ctx, async () => {
+        if (ctx.status == 404) {
+          return;
+        }
+        await next();
+      });
+    }
+    await next();
+  });
+}
+var local_default = {
+  middleware,
+  make(storage) {
+    return multer__default.default.diskStorage({
+      destination: function(req, file, cb) {
+        const destPath = path__default.default.join(getDocumentRoot(storage), storage.path);
+        mkdirp__default.default(destPath, (err) => cb(err, destPath));
+      },
+      filename: utils.getFilename
+    });
+  },
+  defaults() {
+    const { LOCAL_STORAGE_DEST, LOCAL_STORAGE_BASE_URL, APP_PORT } = process.env;
+    const documentRoot = LOCAL_STORAGE_DEST || "storage/uploads";
+    return {
+      title: "Local storage",
+      type: constants.STORAGE_TYPE_LOCAL,
+      name: `local`,
+      baseUrl: LOCAL_STORAGE_BASE_URL || `http://localhost:${APP_PORT || "13000"}/${documentRoot}`,
+      options: {
+        documentRoot
+      }
+    };
+  },
+  async delete(storage, records) {
+    const documentRoot = getDocumentRoot(storage);
+    let count = 0;
+    const undeleted = [];
+    await records.reduce(
+      (promise, record) => promise.then(async () => {
+        try {
+          await fs__default.default.unlink(path__default.default.join(documentRoot, record.path, record.filename));
+          count += 1;
+        } catch (ex) {
+          if (ex.code === "ENOENT") {
+            console.warn(ex.message);
+            count += 1;
+          } else {
+            console.error(ex);
+            undeleted.push(record);
+          }
+        }
+      }),
+      Promise.resolve()
+    );
+    return [count, undeleted];
+  }
+};
+
+module.exports = local_default;

package/{src/server/storages/s3.ts → dist/server/storages/s3.js}

@@ -1,21 +1,21 @@
-import { AttachmentModel } from '.';
-import { STORAGE_TYPE_S3 } from '../constants';
-import { cloudFilenameGetter } from '../utils';
+'use strict';
 
-export default {
-  filenameKey: 'key',
+var constants = require('../constants');
+var utils = require('../utils');
+
+var s3_default = {
+  filenameKey: "key",
   make(storage) {
-    const { S3Client } = require('@aws-sdk/client-s3');
-    const multerS3 = require('multer-s3');
-    const { accessKeyId, secretAccessKey, bucket, acl = 'public-read', ...options } = storage.options;
+    const { S3Client } = require("@aws-sdk/client-s3");
+    const multerS3 = require("multer-s3");
+    const { accessKeyId, secretAccessKey, bucket, acl = "public-read", ...options } = storage.options;
     const s3 = new S3Client({
       ...options,
       credentials: {
         accessKeyId,
-        secretAccessKey,
-      },
+        secretAccessKey
+      }
     });
-
     return multerS3({
       s3,
       bucket,
@@ -25,41 +25,41 @@ export default {
           cb(null, file.mimetype);
           return;
         }
-
         multerS3.AUTO_CONTENT_TYPE(req, file, cb);
       },
-      key: cloudFilenameGetter(storage),
+      key: utils.cloudFilenameGetter(storage)
     });
   },
   defaults() {
     return {
-      title: 'AWS S3',
-      name: 'aws-s3',
-      type: STORAGE_TYPE_S3,
+      title: "AWS S3",
+      name: "aws-s3",
+      type: constants.STORAGE_TYPE_S3,
       baseUrl: process.env.AWS_S3_STORAGE_BASE_URL,
       options: {
         region: process.env.AWS_S3_REGION,
         accessKeyId: process.env.AWS_ACCESS_KEY_ID,
         secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
-        bucket: process.env.AWS_S3_BUCKET,
-      },
+        bucket: process.env.AWS_S3_BUCKET
+      }
     };
   },
-  async delete(storage, records: AttachmentModel[]): Promise<[number, AttachmentModel[]]> {
-    const { DeleteObjectsCommand } = require('@aws-sdk/client-s3');
+  async delete(storage, records) {
+    const { DeleteObjectsCommand } = require("@aws-sdk/client-s3");
     const { s3 } = this.make(storage);
     const { Deleted } = await s3.send(
       new DeleteObjectsCommand({
         Bucket: storage.options.bucket,
         Delete: {
-          Objects: records.map((record) => ({ Key: `${record.path}/${record.filename}` })),
-        },
-      }),
+          Objects: records.map((record) => ({ Key: `${record.path}/${record.filename}` }))
+        }
+      })
     );
-
     return [
       Deleted.length,
-      records.filter((record) => !Deleted.find((item) => item.Key === `${record.path}/${record.filename}`)),
+      records.filter((record) => !Deleted.find((item) => item.Key === `${record.path}/${record.filename}`))
     ];
-  },
+  }
 };
+
+module.exports = s3_default;

package/dist/server/storages/tx-cos.js

@@ -0,0 +1,44 @@
+'use strict';
+
+var util = require('util');
+var constants = require('../constants');
+var utils = require('../utils');
+
+var tx_cos_default = {
+  filenameKey: "url",
+  make(storage) {
+    const createTxCosStorage = require("multer-cos");
+    return new createTxCosStorage({
+      cos: storage.options,
+      filename: utils.cloudFilenameGetter(storage)
+    });
+  },
+  defaults() {
+    return {
+      title: "\u817E\u8BAF\u4E91\u5BF9\u8C61\u5B58\u50A8",
+      type: constants.STORAGE_TYPE_TX_COS,
+      name: "tx-cos-1",
+      baseUrl: process.env.TX_COS_STORAGE_BASE_URL,
+      options: {
+        Region: process.env.TX_COS_REGION,
+        SecretId: process.env.TX_COS_SECRET_ID,
+        SecretKey: process.env.TX_COS_SECRET_KEY,
+        Bucket: process.env.TX_COS_BUCKET
+      }
+    };
+  },
+  async delete(storage, records) {
+    const { cos } = this.make(storage);
+    const { Deleted } = await util.promisify(cos.deleteMultipleObject)({
+      Region: storage.options.Region,
+      Bucket: storage.options.Bucket,
+      Objects: records.map((record) => ({ Key: `${record.path}/${record.filename}` }))
+    });
+    return [
+      Deleted.length,
+      records.filter((record) => !Deleted.find((item) => item.Key === `${record.path}/${record.filename}`))
+    ];
+  }
+};
+
+module.exports = tx_cos_default;

package/dist/server/utils.js

@@ -0,0 +1,26 @@
+'use strict';
+
+var crypto = require('crypto');
+var path = require('path');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var crypto__default = /*#__PURE__*/_interopDefault(crypto);
+var path__default = /*#__PURE__*/_interopDefault(path);
+
+function getFilename(req, file, cb) {
+  crypto__default.default.pseudoRandomBytes(16, function(err, raw) {
+    cb(err, err ? void 0 : `${raw.toString("hex")}${path__default.default.extname(file.originalname)}`);
+  });
+}
+const cloudFilenameGetter = (storage) => (req, file, cb) => {
+  getFilename(req, file, (err, filename) => {
+    if (err) {
+      return cb(err);
+    }
+    cb(null, `${storage.path ? `${storage.path}/` : ""}${filename}`);
+  });
+};
+
+exports.cloudFilenameGetter = cloudFilenameGetter;
+exports.getFilename = getFilename;

package/package.json

@@ -1,28 +1,22 @@
 {
   "name": "@nocobase/plugin-file-manager",
-  "version": "0.11.1-alpha.5",
-  "displayName": "file manager",
-  "displayName.zh-CN": "文件管理",
+  "version": "0.12.0-alpha.2",
+  "displayName": "File manager",
+  "displayName.zh-CN": "文件管理器",
   "description": "file management plugin.",
-  "description.zh-CN": "文件管理。",
+  "description.zh-CN": "提供文件存储服务，并拓展了文件表模板和附件字段",
   "license": "AGPL-3.0",
-  "main": "./lib/server/index.js",
-  "files": [
-    "lib",
-    "src",
-    "README.md",
-    "README.zh-CN.md",
-    "CHANGELOG.md",
-    "server.js",
-    "server.d.ts",
-    "client.js",
-    "client.d.ts"
-  ],
-  "dependencies": {
+  "main": "./dist/server/index.js",
+  "devDependencies": {
     "@aws-sdk/client-s3": "^3.245.0",
+    "@formily/antd-v5": "1.x",
+    "@formily/core": "2.x",
+    "@formily/react": "2.x",
+    "@formily/shared": "2.x",
     "@koa/multer": "^3.0.0",
     "@types/koa-multer": "^1.0.1",
     "@types/multer": "^1.4.5",
+    "antd": "5.x",
     "cos-nodejs-sdk-v5": "^2.11.14",
     "koa-static": "^5.0.0",
     "mime-match": "^1.0.2",
@@ -30,23 +24,18 @@
     "multer": "^1.4.2",
     "multer-aliyun-oss": "2.1.1",
     "multer-cos": "^1.0.3",
-    "multer-s3": "^3.0.1"
-  },
-  "devDependencies": {
-    "@formily/antd-v5": "^1.1.0",
-    "@formily/core": "^2.2.27",
-    "@formily/react": "^2.2.27",
-    "@formily/shared": "^2.2.27",
-    "@nocobase/actions": "0.11.1-alpha.5",
-    "@nocobase/client": "0.11.1-alpha.5",
-    "@nocobase/database": "0.11.1-alpha.5",
-    "@nocobase/server": "0.11.1-alpha.5",
-    "@nocobase/test": "0.11.1-alpha.5",
-    "@nocobase/utils": "0.11.1-alpha.5",
-    "antd": "^5.6.4",
+    "multer-s3": "^3.0.1",
     "react": "^18.2.0",
     "react-i18next": "^11.15.1",
     "supertest": "^6.1.6"
   },
-  "gitHead": "1dcfd15a7d95a40b0a2f60e1de19ec574066fb20"
+  "peerDependencies": {
+    "@nocobase/actions": "0.x",
+    "@nocobase/client": "0.x",
+    "@nocobase/database": "0.x",
+    "@nocobase/server": "0.x",
+    "@nocobase/test": "0.x",
+    "@nocobase/utils": "0.x"
+  },
+  "gitHead": "a95e9e2666f0318c955113a4735bc005a2c9a767"
 }

package/server.d.ts

@@ -1,3 +1,2 @@
-export * from './src/server';
-export { default } from './src/server';
-
+export * from './dist/server';
+export { default } from './dist/server';

package/server.js

@@ -1 +1 @@
-module.exports = require('./lib/server/index.js');
+module.exports = require('./dist/server/index.js');