@nocobase/plugin-api-keys 0.11.1-alpha.5 → 0.12.0-alpha.1

package/dist/locale.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var constants = require('./constants');
+
+function generateNTemplate(key) {
+  return `{{t('${key}', { ns: '${constants.NAMESPACE}', nsMode: 'fallback' })}}`;
+}
+
+exports.generateNTemplate = generateNTemplate;

package/dist/server/actions/api-keys.js

@@ -0,0 +1,51 @@
+'use strict';
+
+var actions = require('@nocobase/actions');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var actions__default = /*#__PURE__*/_interopDefault(actions);
+
+async function create(ctx, next) {
+  const { values } = ctx.action.params;
+  if (!values.role) {
+    return;
+  }
+  const repository = ctx.db.getRepository("users.roles", ctx.auth.user.id);
+  const role = await repository.findOne({
+    filter: {
+      name: values.role.name
+    }
+  });
+  if (!role) {
+    throw ctx.throw(400, ctx.t("Role not found"));
+  }
+  const token = ctx.app.authManager.jwt.sign(
+    { userId: ctx.auth.user.id, roleName: role.name },
+    { expiresIn: values.expiresIn }
+  );
+  ctx.action.mergeParams({
+    values: {
+      token
+    }
+  });
+  return actions__default.default.create(ctx, async () => {
+    ctx.body = {
+      token
+    };
+    await next();
+  });
+}
+async function destroy(ctx, next) {
+  const repo = ctx.db.getRepository(ctx.action.resourceName);
+  const { filterByTk } = ctx.action.params;
+  const data = await repo.findById(filterByTk);
+  const token = data == null ? void 0 : data.get("token");
+  if (token) {
+    await ctx.app.authManager.jwt.block(token);
+  }
+  return actions__default.default.destroy(ctx, next);
+}
+
+exports.create = create;
+exports.destroy = destroy;

package/dist/server/index.js

@@ -0,0 +1,11 @@
+'use strict';
+
+var plugin = require('./plugin');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var plugin__default = /*#__PURE__*/_interopDefault(plugin);
+
+
+
+module.exports = plugin__default.default;

package/dist/server/locale/en-US.js

@@ -0,0 +1,5 @@
+'use strict';
+
+var en_US_default = {};
+
+module.exports = en_US_default;

package/dist/server/locale/fr-FR.js

@@ -0,0 +1,5 @@
+'use strict';
+
+var fr_FR_default = {};
+
+module.exports = fr_FR_default;

package/dist/server/locale/index.js

@@ -0,0 +1,20 @@
+'use strict';
+
+var enUS = require('./en-US');
+var zhCN = require('./zh-CN');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var enUS__default = /*#__PURE__*/_interopDefault(enUS);
+var zhCN__default = /*#__PURE__*/_interopDefault(zhCN);
+
+
+
+Object.defineProperty(exports, 'enUS', {
+  enumerable: true,
+  get: function () { return enUS__default.default; }
+});
+Object.defineProperty(exports, 'zhCN', {
+  enumerable: true,
+  get: function () { return zhCN__default.default; }
+});

package/dist/server/locale/zh-CN.js

@@ -0,0 +1,7 @@
+'use strict';
+
+var zh_CN_default = {
+  "Role not found": "\u89D2\u8272\u4E0D\u5B58\u5728"
+};
+
+module.exports = zh_CN_default;

package/dist/server/plugin.js

@@ -0,0 +1,48 @@
+'use strict';
+
+var server = require('@nocobase/server');
+var path = require('path');
+var constants = require('../constants');
+var apiKeys = require('./actions/api-keys');
+var locale = require('./locale');
+
+class ApiKeysPlugin extends server.Plugin {
+  resourceName = "apiKeys";
+  constructor(app, options) {
+    super(app, options);
+  }
+  async beforeLoad() {
+    this.app.i18n.addResources("zh-CN", constants.NAMESPACE, locale.zhCN);
+    this.app.i18n.addResources("en-US", constants.NAMESPACE, locale.enUS);
+    await this.app.resourcer.define({
+      name: this.resourceName,
+      actions: {
+        create: apiKeys.create,
+        destroy: apiKeys.destroy
+      },
+      only: ["list", "create", "destroy"]
+    });
+    this.app.acl.registerSnippet({
+      name: ["pm", this.name, "configuration"].join("."),
+      actions: ["apiKeys:list", "apiKeys:create", "apiKeys:destroy"]
+    });
+  }
+  async load() {
+    await this.db.import({
+      directory: path.resolve(__dirname, "../collections")
+    });
+    this.app.resourcer.use(async (ctx, next) => {
+      const { resourceName, actionName } = ctx.action.params;
+      if (resourceName == this.resourceName && ["list", "destroy"].includes(actionName)) {
+        ctx.action.mergeParams({
+          filter: {
+            createdById: ctx.auth.user.id
+          }
+        });
+      }
+      await next();
+    });
+  }
+}
+
+module.exports = ApiKeysPlugin;

package/docs/en-US/changelog.md

@@ -0,0 +1 @@
+# API keys Changelog

package/docs/en-US/index.md

@@ -0,0 +1,9 @@
+# API keys
+
+## Introduction
+
+This plugin allows you to create and manage API keys. The generated API key can be used to access all `NocoBase` APIs.
+
+## Access Control
+
+When creating an API key, you can bind it to a role, and the role's permissions will be the same as the Key's permissions.

package/docs/en-US/tabs.json

@@ -0,0 +1,14 @@
+[
+  {
+    "title": "Introduction",
+    "path": "index"
+  },
+  {
+    "title": "Usage",
+    "path": "usage"
+  },
+  {
+    "title": "Changelog",
+    "path": "changelog"
+  }
+]

package/docs/en-US/usage.md

@@ -0,0 +1,19 @@
+# API keys Usage
+
+## Creating an API key
+
+After enabling the plugin, go to the API keys plugin management page, click `Add API key`, fill in the relevant information, and click Save to create an API key.
+
+## Using an API key
+
+Add the `Authorization` field to the request header, with the value of `Bearer ${API_KEY}`, to access all `NocoBase` APIs using the API key.
+
+Here's an example using cURL:
+
+```bash
+curl '{domain}/api/roles:check' -H 'Authorization: Bearer {API key}'
+```
+
+## Deleting an API key
+
+After deleting the API key, it will no longer be usable.

package/docs/zh-CN/changelog.md

@@ -0,0 +1 @@
+# API keys 更新日志

package/docs/zh-CN/index.md

@@ -0,0 +1,10 @@
+# API keys
+
+## 简介
+
+该插件允许你创建和管理 API keys，生成的 API key 可以用于访问 `NocoBase` 所有 API。
+
+
+## 权限控制
+
+创建 API key 时，可以为该 Key 绑定角色，角色的权限就是 Key 的权限。

package/docs/zh-CN/tabs.json

@@ -0,0 +1,14 @@
+[
+  {
+    "title": "介绍",
+    "path": "index"
+  },
+  {
+    "title": "用法",
+    "path": "usage"
+  },
+  {
+    "title": "日志",
+    "path": "changelog"
+  }
+]

package/docs/zh-CN/usage.md

@@ -0,0 +1,19 @@
+# API keys 使用方法
+
+## 创建 API key
+
+当你启用插件后，前往 API keys 的插件管理页面，点击 `添加 API key` 并填写相关信息，点击 `保存` 即可创建 API key。
+
+## 使用 API key
+
+在请求头中添加 `Authorization` 字段，值为 `Bearer ${API_KEY}`，即可使用 API key 访问 `NocoBase` 所有 API。
+
+cURL 的例子如下
+
+```bash
+curl '{domain}/api/roles:check' -H 'Authorization: Bearer {API key}'
+```
+
+## 删除 API key
+
+删除 API key 后，该 Key 将无法继续使用。

package/package.json

@@ -1,39 +1,31 @@
 {
   "name": "@nocobase/plugin-api-keys",
   "displayName": "API keys",
-  "displayName.zh-CN": "API keys",
-  "description": "Allow users to use API key to access NocoBase's api",
-  "description.zh-CN": "允许用户使用 API key 访问 NocoBase 的 api",
-  "version": "0.11.1-alpha.5",
+  "displayName.zh-CN": "API 秘钥",
+  "description": "Allow users to use API key to access NocoBase server API",
+  "description.zh-CN": "允许用户使用 API key 访问 NocoBase server API",
+  "version": "0.12.0-alpha.1",
   "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"
-  ],
+  "main": "./dist/server/index.js",
   "devDependencies": {
-    "@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/resourcer": "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",
+    "@formily/react": "2.x",
+    "@formily/shared": "2.x",
+    "ahooks": "^3.7.2",
+    "antd": "5.x",
     "dayjs": "^1.11.8",
     "i18next": "^22.4.9",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "react-i18next": "^11.15.1"
   },
-  "gitHead": "1dcfd15a7d95a40b0a2f60e1de19ec574066fb20"
+  "peerDependencies": {
+    "@nocobase/actions": "0.x",
+    "@nocobase/client": "0.x",
+    "@nocobase/database": "0.x",
+    "@nocobase/resourcer": "0.x",
+    "@nocobase/server": "0.x",
+    "@nocobase/test": "0.x",
+    "@nocobase/utils": "0.x"
+  },
+  "gitHead": "543dcc0216b7b1451b552b0f685bc3e0682f9d59"
 }

package/server.d.ts

@@ -1,4 +1,3 @@
 // @ts-nocheck
-export * from './lib/server';
-export { default } from './lib/server';
-
+export * from './dist/server';
+export { default } from './dist/server';

package/server.js

@@ -1,30 +1 @@
-"use strict";
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-var _index = _interopRequireWildcard(require("./lib/server"));
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _exportNames = {};
-Object.defineProperty(exports, "default", {
-  enumerable: true,
-  get: function get() {
-    return _index.default;
-  }
-});
-
-Object.keys(_index).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
-  if (key in exports && exports[key] === _index[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _index[key];
-    }
-  });
-});
+module.exports = require('./dist/server/index.js');

package/lib/client/Configuration/ExpiresSelect.js

@@ -1,130 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.ExpiresSelect = void 0;
-function _css() {
-  const data = require("@emotion/css");
-  _css = function _css() {
-    return data;
-  };
-  return data;
-}
-function _react() {
-  const data = require("@formily/react");
-  _react = function _react() {
-    return data;
-  };
-  return data;
-}
-function _client() {
-  const data = require("@nocobase/client");
-  _client = function _client() {
-    return data;
-  };
-  return data;
-}
-function _client2() {
-  const data = require("@nocobase/utils/client");
-  _client2 = function _client2() {
-    return data;
-  };
-  return data;
-}
-function _ahooks() {
-  const data = require("ahooks");
-  _ahooks = function _ahooks() {
-    return data;
-  };
-  return data;
-}
-function _antd() {
-  const data = require("antd");
-  _antd = function _antd() {
-    return data;
-  };
-  return data;
-}
-function _react2() {
-  const data = _interopRequireWildcard(require("react"));
-  _react2 = function _react2() {
-    return data;
-  };
-  return data;
-}
-var _locale = require("../locale");
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
-function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
-function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
-function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-const TOMORROW = (0, _client2().dayjs)().add(1, 'days');
-const spaceCSS = (0, _css().css)`
-  width: 100%;
-  & > .ant-space-item {
-    flex: 1;
-  }
-`;
-const InternalExpiresSelect = props => {
-  const onChange = props.onChange;
-  const _useBoolean = (0, _ahooks().useBoolean)(),
-    _useBoolean2 = _slicedToArray(_useBoolean, 2),
-    isCustom = _useBoolean2[0],
-    _useBoolean2$ = _useBoolean2[1],
-    toggleShowDatePicker = _useBoolean2$.toggle,
-    setFalse = _useBoolean2$.setFalse;
-  const onSelectChange = v => {
-    if (v === 'custom') {
-      onChange('1d');
-      return toggleShowDatePicker();
-    } else {
-      setFalse();
-      onChange(v);
-    }
-  };
-  const onDatePickerChange = v => {
-    v = v.millisecond(0).second(0);
-    const NOW = (0, _client2().dayjs)().millisecond(0).second(0);
-    const value = `${v.diff(NOW, 'd')}d`;
-    onChange(value);
-  };
-  return _react2().default.createElement(_antd().Space, {
-    className: spaceCSS
-  }, _react2().default.createElement(_antd().Select, _objectSpread(_objectSpread({}, props), {}, {
-    value: isCustom ? 'custom' : props.value,
-    onChange: onSelectChange
-  })), isCustom ? _react2().default.createElement(_antd().DatePicker, {
-    disabledDate: date => {
-      return date.isSameOrBefore();
-    },
-    defaultValue: TOMORROW,
-    onChange: onDatePickerChange,
-    showToday: false,
-    allowClear: false
-  }) : null);
-};
-const ReadPretty = () => {
-  const _useRecord = (0, _client().useRecord)(),
-    expiresIn = _useRecord.expiresIn,
-    createdAt = _useRecord.createdAt;
-  const _useTranslation = (0, _locale.useTranslation)(),
-    t = _useTranslation.t;
-  const expiresDate = (0, _react2().useMemo)(() => {
-    if (expiresIn === 'never') return t('Never expires');
-    return (0, _client2().dayjs)(createdAt).add((expiresIn === null || expiresIn === void 0 ? void 0 : expiresIn.replace('d', '')) || 0, 'days').format('YYYY-MM-DD HH:mm:ss');
-  }, [createdAt, expiresIn]);
-  return _react2().default.createElement(_antd().Typography.Text, null, expiresDate);
-};
-const ExpiresSelect = (0, _react().connect)(InternalExpiresSelect, (0, _react().mapProps)({
-  dataSource: 'options'
-}), (0, _react().mapReadPretty)(ReadPretty));
-exports.ExpiresSelect = ExpiresSelect;

package/lib/client/Configuration/index.js

@@ -1,47 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Configuration = void 0;
-function _react() {
-  const data = require("@formily/react");
-  _react = function _react() {
-    return data;
-  };
-  return data;
-}
-function _client() {
-  const data = require("@nocobase/client");
-  _client = function _client() {
-    return data;
-  };
-  return data;
-}
-function _react2() {
-  const data = _interopRequireDefault(require("react"));
-  _react2 = function _react2() {
-    return data;
-  };
-  return data;
-}
-var _collections = require("../../collections");
-var _ExpiresSelect = require("./ExpiresSelect");
-var _schema = require("./schema");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-const Configuration = () => {
-  const currentRoles = (0, _client().useCurrentRoles)();
-  return _react2().default.createElement(_client().CollectionManagerProvider, {
-    collections: [_collections.apiKeysCollection]
-  }, _react2().default.createElement(_client().SchemaComponentOptions, {
-    scope: {
-      currentRoles
-    },
-    components: {
-      ExpiresSelect: _ExpiresSelect.ExpiresSelect
-    }
-  }, _react2().default.createElement(_react().RecursionField, {
-    schema: _schema.configurationSchema
-  })));
-};
-exports.Configuration = Configuration;

package/lib/client/Configuration/roles.js

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useCurrentRolesProps = void 0;
-function _client() {
-  const data = require("@nocobase/client");
-  _client = function _client() {
-    return data;
-  };
-  return data;
-}
-const useCurrentRolesProps = () => {
-  const options = (0, _client().useCurrentRoles)();
-  return {
-    options
-  };
-};
-exports.useCurrentRolesProps = useCurrentRolesProps;