@nocobase/plugin-system-settings 0.10.0-alpha.5 → 0.11.0-alpha.1

package/client.d.ts

@@ -0,0 +1,3 @@
+export * from './src/client';
+export { default } from './src/client';
+

package/client.js

@@ -0,0 +1 @@
+module.exports = require('./lib/client/index.js');

package/lib/client/index.d.ts

@@ -0,0 +1,5 @@
+import { Plugin } from '@nocobase/client';
+declare class SystemSettingPlugin extends Plugin {
+    load(): Promise<void>;
+}
+export default SystemSettingPlugin;

package/lib/client/index.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+function _client() {
+  const data = require("@nocobase/client");
+  _client = function _client() {
+    return data;
+  };
+  return data;
+}
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+class SystemSettingPlugin extends _client().Plugin {
+  load() {
+    return _asyncToGenerator(function* () {})();
+  }
+}
+var _default = SystemSettingPlugin;
+exports.default = _default;

package/lib/server/index.d.ts

@@ -0,0 +1 @@
+export { default } from './server';

package/lib/server/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _server.default;
+  }
+});
+var _server = _interopRequireDefault(require("./server"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/package.json

@@ -4,12 +4,25 @@
   "displayName.zh-CN": "系统配置",
   "description": "A plugin specifically designed to adjust the system-level settings of NocoBase.",
   "description.zh-CN": "用于调整 nocobase 的系统级设置。",
-  "version": "0.10.0-alpha.5",
+  "version": "0.11.0-alpha.1",
   "license": "AGPL-3.0",
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
+  "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"
+  ],
   "devDependencies": {
-    "@nocobase/test": "0.10.0-alpha.5"
+    "@nocobase/client": "0.11.0-alpha.1",
+    "@nocobase/database": "0.11.0-alpha.1",
+    "@nocobase/server": "0.11.0-alpha.1",
+    "@nocobase/test": "0.11.0-alpha.1"
   },
-  "gitHead": "1be8fcdad42688064460761cea22830cf392c7c0"
+  "gitHead": "7581b6d3a3a54f09f06a9effb7e3e65328281b2b"
 }

package/server.d.ts

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

package/server.js

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

package/src/client/index.ts

@@ -0,0 +1,7 @@
+import { Plugin } from '@nocobase/client';
+
+class SystemSettingPlugin extends Plugin {
+  async load() { }
+}
+
+export default SystemSettingPlugin;

package/src/index.ts

@@ -0,0 +1 @@
+export { default } from './server';

package/src/server/collections/systemSettings.ts

@@ -0,0 +1,46 @@
+import { defineCollection } from '@nocobase/database';
+
+export default defineCollection({
+  namespace: 'system-settings.systemSettings',
+  duplicator: 'optional',
+  name: 'systemSettings',
+  fields: [
+    {
+      type: 'string',
+      name: 'title',
+    },
+    {
+      type: 'boolean',
+      name: 'showLogoOnly',
+    },
+    {
+      type: 'boolean',
+      name: 'allowSignUp',
+      defaultValue: true,
+    },
+    {
+      type: 'boolean',
+      name: 'smsAuthEnabled',
+      defaultValue: false,
+    },
+    {
+      type: 'belongsTo',
+      name: 'logo',
+      target: 'attachments',
+    },
+    {
+      type: 'json',
+      name: 'enabledLanguages',
+      defaultValue: [],
+    },
+    {
+      type: 'string',
+      name: 'appLang',
+    },
+    {
+      type: 'json',
+      name: 'options',
+      defaultValue: {},
+    },
+  ],
+});

package/src/server/index.ts

@@ -0,0 +1 @@
+export { default } from './server';

package/src/server/migrations/20220714204714-update-enabled-languages.ts

@@ -0,0 +1,17 @@
+import { Migration } from '@nocobase/server';
+
+export default class UpdateEnabledLanguagesMigration extends Migration {
+  async up() {
+    const result = await this.app.version.satisfies('<=0.7.2-alpha.7');
+    if (!result) {
+      return;
+    }
+    const SystemSetting = this.context.db.getRepository('systemSettings');
+    const setting = await SystemSetting.findOne();
+    const enabledLanguages = setting.get('enabledLanguages') || [];
+    if (Array.isArray(enabledLanguages) && enabledLanguages.length === 0) {
+      setting.set('enabledLanguages', [setting.get('appLang') || 'en-US']);
+      await setting.save();
+    }
+  }
+}

package/src/server/server.ts

@@ -0,0 +1,53 @@
+import { InstallOptions, Plugin } from '@nocobase/server';
+import { resolve } from 'path';
+
+export class SystemSettingsPlugin extends Plugin {
+  getInitAppLang(options) {
+    return options?.cliArgs?.[0]?.opts?.lang || process.env.INIT_APP_LANG || 'en-US';
+  }
+
+  async install(options?: InstallOptions) {
+    await this.db.getRepository('systemSettings').create({
+      values: {
+        title: 'NocoBase',
+        appLang: this.getInitAppLang(options),
+        enabledLanguages: [this.getInitAppLang(options)],
+        logo: {
+          title: 'nocobase-logo',
+          filename: '682e5ad037dd02a0fe4800a3e91c283b.png',
+          extname: '.png',
+          mimetype: 'image/png',
+          url: 'https://nocobase.oss-cn-beijing.aliyuncs.com/682e5ad037dd02a0fe4800a3e91c283b.png',
+        },
+      },
+    });
+  }
+
+  beforeLoad() {
+    const cmd = this.app.findCommand('install');
+    if (cmd) {
+      cmd.option('-l, --lang [lang]');
+    }
+
+    this.app.acl.registerSnippet({
+      name: `pm.${this.name}.system-settings`,
+      actions: ['systemSettings:update'],
+    });
+  }
+
+  async load() {
+    await this.app.db.import({
+      directory: resolve(__dirname, 'collections'),
+    });
+
+    this.app.acl.addFixedParams('systemSettings', 'destroy', () => {
+      return {
+        'id.$ne': 1,
+      };
+    });
+
+    this.app.acl.allow('systemSettings', 'get', 'public');
+  }
+}
+
+export default SystemSettingsPlugin;