@nocobase/plugin-api-keys 0.10.1-alpha.1

package/README.md

@@ -0,0 +1,9 @@
+# api-keys
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

package/README.zh-CN.md

@@ -0,0 +1,9 @@
+# api-keys
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

package/client.d.ts

@@ -0,0 +1,4 @@
+// @ts-nocheck
+export * from './lib/client';
+export { default } from './lib/client';
+

package/client.js

@@ -0,0 +1,30 @@
+"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/client"));
+
+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];
+    }
+  });
+});

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/lib/client/Configuration/ExpiresSelect.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const ExpiresSelect: React.ForwardRefExoticComponent<Pick<Partial<any>, string | number | symbol> & React.RefAttributes<unknown>>;
+export { ExpiresSelect };

package/lib/client/Configuration/ExpiresSelect.js

@@ -0,0 +1,131 @@
+"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 _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 _moment() {
+  const data = _interopRequireDefault(require("moment"));
+  _moment = function _moment() {
+    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 _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+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, _moment().default)().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.milliseconds(0).second(0);
+    const NOW = (0, _moment().default)().milliseconds(0).seconds(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: time => {
+      return time.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, _moment().default)(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.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Configuration: () => React.JSX.Element;

package/lib/client/Configuration/index.js

@@ -0,0 +1,47 @@
+"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.d.ts

@@ -0,0 +1,3 @@
+export declare const useCurrentRolesProps: () => {
+    options: any;
+};

package/lib/client/Configuration/roles.js

@@ -0,0 +1,20 @@
+"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;

package/lib/client/Configuration/schema.d.ts

@@ -0,0 +1,2 @@
+import { ISchema } from '@formily/react';
+export declare const configurationSchema: ISchema;