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

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

@@ -0,0 +1,71 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.create = create;
+exports.destroy = destroy;
+function _actions() {
+  const data = _interopRequireDefault(require("@nocobase/actions"));
+  _actions = function _actions() {
+    return data;
+  };
+  return data;
+}
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+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); }); }; }
+function create(_x, _x2) {
+  return _create.apply(this, arguments);
+}
+function _create() {
+  _create = _asyncToGenerator(function* (ctx, next) {
+    const values = ctx.action.params.values;
+    if (!values.role) {
+      return;
+    }
+    const repository = ctx.db.getRepository('users.roles', ctx.auth.user.id);
+    const role = yield 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.create(ctx, /*#__PURE__*/_asyncToGenerator(function* () {
+      ctx.body = {
+        token
+      };
+      yield next();
+    }));
+  });
+  return _create.apply(this, arguments);
+}
+function destroy(_x3, _x4) {
+  return _destroy.apply(this, arguments);
+}
+function _destroy() {
+  _destroy = _asyncToGenerator(function* (ctx, next) {
+    const repo = ctx.db.getRepository(ctx.action.resourceName);
+    const filterByTk = ctx.action.params.filterByTk;
+    const data = yield repo.findById(filterByTk);
+    const token = data === null || data === void 0 ? void 0 : data.get('token');
+    if (token) {
+      yield ctx.app.authManager.jwt.block(token);
+    }
+    return _actions().default.destroy(ctx, next);
+  });
+  return _destroy.apply(this, arguments);
+}

package/lib/server/index.d.ts

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

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 _plugin.default;
+  }
+});
+var _plugin = _interopRequireDefault(require("./plugin"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/lib/server/locale/en-US.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

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

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {};
+exports.default = _default;

package/lib/server/locale/index.d.ts

@@ -0,0 +1,2 @@
+export { default as enUS } from './en-US';
+export { default as zhCN } from './zh-CN';

package/lib/server/locale/index.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "enUS", {
+  enumerable: true,
+  get: function get() {
+    return _enUS.default;
+  }
+});
+Object.defineProperty(exports, "zhCN", {
+  enumerable: true,
+  get: function get() {
+    return _zhCN.default;
+  }
+});
+var _enUS = _interopRequireDefault(require("./en-US"));
+var _zhCN = _interopRequireDefault(require("./zh-CN"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/lib/server/locale/zh-CN.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    'Role not found': string;
+};
+export default _default;

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

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  'Role not found': '角色不存在'
+};
+exports.default = _default;

package/lib/server/plugin.d.ts

@@ -0,0 +1,10 @@
+import { Plugin } from '@nocobase/server';
+export interface ApiKeysPluginConfig {
+    name?: string;
+}
+export default class ApiKeysPlugin extends Plugin<ApiKeysPluginConfig> {
+    resourceName: string;
+    constructor(app: any, options: any);
+    beforeLoad(): Promise<void>;
+    load(): Promise<void>;
+}

package/lib/server/plugin.js

@@ -0,0 +1,77 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+function _server() {
+  const data = require("@nocobase/server");
+  _server = function _server() {
+    return data;
+  };
+  return data;
+}
+function _path() {
+  const data = require("path");
+  _path = function _path() {
+    return data;
+  };
+  return data;
+}
+var _constants = require("../constants");
+var _apiKeys = require("./actions/api-keys");
+var _locale = require("./locale");
+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 ApiKeysPlugin extends _server().Plugin {
+  constructor(app, options) {
+    super(app, options);
+    this.resourceName = 'apiKeys';
+  }
+  beforeLoad() {
+    var _this = this;
+    return _asyncToGenerator(function* () {
+      _this.app.i18n.addResources('zh-CN', _constants.NAMESPACE, _locale.zhCN);
+      _this.app.i18n.addResources('en-US', _constants.NAMESPACE, _locale.enUS);
+      yield _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']
+      });
+    })();
+  }
+  load() {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      yield _this2.db.import({
+        directory: (0, _path().resolve)(__dirname, '../collections')
+      });
+      _this2.app.resourcer.use( /*#__PURE__*/function () {
+        var _ref = _asyncToGenerator(function* (ctx, next) {
+          const _ctx$action$params = ctx.action.params,
+            resourceName = _ctx$action$params.resourceName,
+            actionName = _ctx$action$params.actionName;
+          if (resourceName == _this2.resourceName && ['list', 'destroy'].includes(actionName)) {
+            ctx.action.mergeParams({
+              filter: {
+                createdById: ctx.auth.user.id
+              }
+            });
+          }
+          yield next();
+        });
+        return function (_x, _x2) {
+          return _ref.apply(this, arguments);
+        };
+      }());
+    })();
+  }
+}
+exports.default = ApiKeysPlugin;

package/package.json

@@ -0,0 +1,24 @@
+{
+  "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.10.1-alpha.1",
+  "license": "AGPL-3.0",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "dependencies": {
+    "@nocobase/actions": "0.10.1-alpha.1",
+    "@nocobase/database": "0.10.1-alpha.1",
+    "@nocobase/resourcer": "0.10.1-alpha.1",
+    "@nocobase/server": "0.10.1-alpha.1",
+    "@nocobase/utils": "0.10.1-alpha.1",
+    "jsonwebtoken": "^8.5.1"
+  },
+  "devDependencies": {
+    "@nocobase/test": "0.10.1-alpha.1",
+    "@types/jsonwebtoken": "^8.5.8"
+  },
+  "gitHead": "8f415f5e0ee2e72d681f9ab16af5911b52c374a9"
+}

package/server.d.ts

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

package/server.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/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];
+    }
+  });
+});

package/src/client/Configuration/ExpiresSelect.tsx

@@ -0,0 +1,80 @@
+import { css } from '@emotion/css';
+import { connect, mapProps, mapReadPretty } from '@formily/react';
+import { useRecord } from '@nocobase/client';
+import { useBoolean } from 'ahooks';
+import { DatePicker, Select, Space, Typography } from 'antd';
+import moment from 'moment';
+import React, { useMemo } from 'react';
+import { useTranslation } from '../locale';
+
+const TOMORROW = moment().add(1, 'days');
+
+const spaceCSS = css`
+  width: 100%;
+  & > .ant-space-item {
+    flex: 1;
+  }
+`;
+
+const InternalExpiresSelect = (props) => {
+  const { onChange } = props;
+  const [isCustom, { toggle: toggleShowDatePicker, setFalse }] = useBoolean();
+
+  const onSelectChange = (v) => {
+    if (v === 'custom') {
+      onChange('1d');
+      return toggleShowDatePicker();
+    } else {
+      setFalse();
+      onChange(v);
+    }
+  };
+
+  const onDatePickerChange = (v: moment.Moment) => {
+    v = v.milliseconds(0).second(0);
+    const NOW = moment().milliseconds(0).seconds(0);
+    const value = `${v.diff(NOW, 'd')}d`;
+    onChange(value);
+  };
+
+  return (
+    <Space className={spaceCSS}>
+      <Select {...props} value={isCustom ? 'custom' : props.value} onChange={onSelectChange}></Select>
+      {isCustom ? (
+        <DatePicker
+          disabledDate={(time) => {
+            return time.isSameOrBefore();
+          }}
+          defaultValue={TOMORROW}
+          onChange={onDatePickerChange}
+          showToday={false}
+          allowClear={false}
+        />
+      ) : null}
+    </Space>
+  );
+};
+
+const ReadPretty = () => {
+  const { expiresIn, createdAt } = useRecord();
+  const { t } = useTranslation();
+  const expiresDate = useMemo(() => {
+    if (expiresIn === 'never') return t('Never expires');
+
+    return moment(createdAt)
+      .add(expiresIn?.replace('d', '') || 0, 'days')
+      .format('YYYY-MM-DD HH:mm:ss');
+  }, [createdAt, expiresIn]);
+
+  return <Typography.Text>{expiresDate}</Typography.Text>;
+};
+
+const ExpiresSelect = connect(
+  InternalExpiresSelect,
+  mapProps({
+    dataSource: 'options',
+  }),
+  mapReadPretty(ReadPretty),
+);
+
+export { ExpiresSelect };

package/src/client/Configuration/index.tsx

@@ -0,0 +1,18 @@
+import { RecursionField } from '@formily/react';
+import { CollectionManagerProvider, SchemaComponentOptions, useCurrentRoles } from '@nocobase/client';
+import React from 'react';
+import { apiKeysCollection } from '../../collections';
+import { ExpiresSelect } from './ExpiresSelect';
+import { configurationSchema } from './schema';
+
+export const Configuration = () => {
+  const currentRoles = useCurrentRoles();
+
+  return (
+    <CollectionManagerProvider collections={[apiKeysCollection]}>
+      <SchemaComponentOptions scope={{ currentRoles }} components={{ ExpiresSelect }}>
+        <RecursionField schema={configurationSchema} />
+      </SchemaComponentOptions>
+    </CollectionManagerProvider>
+  );
+};

package/src/client/Configuration/roles.ts

@@ -0,0 +1,9 @@
+import { useCurrentRoles } from '@nocobase/client';
+
+export const useCurrentRolesProps = () => {
+  const options = useCurrentRoles();
+
+  return {
+    options,
+  };
+};

package/src/client/Configuration/schema.tsx

@@ -0,0 +1,264 @@
+import { ISchema, useForm } from '@formily/react';
+import { uid } from '@formily/shared';
+import { useActionContext, useBlockRequestContext, useRecord } from '@nocobase/client';
+import { Alert, Modal, Space, Typography } from 'antd';
+import React from 'react';
+import { generateNTemplate } from '../../locale';
+import { useTranslation } from '../locale';
+const { useModal } = Modal;
+
+const useCreateAction = () => {
+  const form = useForm();
+  const { setVisible } = useActionContext();
+  const { resource, service } = useBlockRequestContext();
+  const { t } = useTranslation();
+  const [modalIns, element] = useModal();
+  return {
+    async run() {
+      await form.submit();
+      const response = await resource.create({
+        values: form.values,
+      });
+
+      modalIns.success({
+        title: t('API key created successfully'),
+        onOk: () => {
+          form.reset();
+          setVisible(false);
+        },
+        content: (
+          <Space direction="vertical">
+            <Alert
+              message={t('Make sure to copy your personal access key now as you will not be able to see this again.')}
+              type="warning"
+            ></Alert>
+            <Typography.Text copyable>{response.data?.data?.token}</Typography.Text>
+          </Space>
+        ),
+      });
+      service?.refresh();
+    },
+    element,
+  };
+};
+
+const useDestroyAction = () => {
+  const record = useRecord();
+  const { resource, service } = useBlockRequestContext();
+  return {
+    async run() {
+      await resource.destroy({
+        filterByTk: record.id,
+      });
+      service.refresh();
+    },
+  };
+};
+
+export const configurationSchema: ISchema = {
+  type: 'object',
+  properties: {
+    configuration: {
+      type: 'void',
+      'x-decorator': 'TableBlockProvider',
+      'x-decorator-props': {
+        collection: 'apiKeys',
+        resource: 'apiKeys',
+        action: 'list',
+        params: {
+          pageSize: 20,
+          appends: ['role'],
+          sort: ['-createdAt'],
+        },
+        rowKey: 'name',
+        showIndex: true,
+      },
+      'x-component': 'CardItem',
+      properties: {
+        actions: {
+          type: 'void',
+          'x-component': 'ActionBar',
+          'x-component-props': {
+            style: {
+              marginBottom: 'var(--nb-spacing)',
+            },
+          },
+          properties: {
+            create: {
+              type: 'void',
+              'x-action': 'create',
+              title: generateNTemplate('Add API key'),
+              'x-component': 'Action',
+              'x-component-props': {
+                openMode: 'drawer',
+                type: 'primary',
+              },
+              properties: {
+                drawer: {
+                  type: 'void',
+                  title: generateNTemplate('Add API key'),
+                  'x-decorator': 'Form',
+                  'x-component': 'Action.Modal',
+                  'x-component-props': {
+                    maskClosable: false,
+                    style: {
+                      maxWidth: '520px',
+                      width: '100%',
+                    },
+                  },
+                  properties: {
+                    name: {
+                      type: 'string',
+                      title: generateNTemplate('Key name'),
+                      required: true,
+                      'x-component': 'CollectionField',
+                      'x-decorator': 'FormItem',
+                    },
+                    role: {
+                      type: 'string',
+                      title: generateNTemplate('Role'),
+                      required: true,
+                      'x-collection-field': 'apiKeys.role',
+                      'x-component': 'CollectionField',
+                      'x-decorator': 'FormItem',
+                    },
+                    expiresIn: {
+                      type: 'string',
+                      title: generateNTemplate('Expiration'),
+                      required: true,
+                      'x-component': 'CollectionField',
+                      'x-decorator': 'FormItem',
+                      default: '30d',
+                    },
+                    footer: {
+                      type: 'void',
+                      'x-component': 'Action.Modal.Footer',
+                      properties: {
+                        cancel: {
+                          title: '{{t("Cancel")}}',
+                          'x-component': 'Action',
+                          'x-component-props': {
+                            useAction: '{{ cm.useCancelAction }}',
+                          },
+                        },
+                        submit: {
+                          title: '{{t("Submit")}}',
+                          'x-component': 'Action',
+                          'x-component-props': {
+                            type: 'primary',
+                            useAction: useCreateAction,
+                          },
+                        },
+                      },
+                    },
+                  },
+                },
+              },
+              'x-align': 'right',
+            },
+          },
+        },
+        [uid()]: {
+          type: 'array',
+          'x-component': 'TableV2',
+          'x-component-props': {
+            rowKey: 'id',
+            useProps: '{{ useTableBlockProps }}',
+          },
+          properties: {
+            column1: {
+              type: 'void',
+              'x-decorator': 'TableV2.Column.Decorator',
+              'x-component': 'TableV2.Column',
+              title: generateNTemplate('Key name'),
+              properties: {
+                name: {
+                  type: 'string',
+                  'x-component': 'CollectionField',
+                  'x-read-pretty': true,
+                },
+              },
+            },
+            column2: {
+              type: 'void',
+              'x-decorator': 'TableV2.Column.Decorator',
+              'x-component': 'TableV2.Column',
+              title: generateNTemplate('Role'),
+              properties: {
+                role: {
+                  type: 'object',
+                  'x-collection-field': 'apiKeys.role',
+                  'x-component': 'CollectionField',
+                  'x-component-props': {
+                    enableLink: false,
+                  },
+                  'x-read-pretty': true,
+                },
+              },
+            },
+            column3: {
+              type: 'void',
+              'x-decorator': 'TableV2.Column.Decorator',
+              'x-component': 'TableV2.Column',
+              title: generateNTemplate('Expiration'),
+              properties: {
+                expiresIn: {
+                  type: 'string',
+                  'x-component': 'CollectionField',
+                  'x-read-pretty': true,
+                },
+              },
+            },
+            column4: {
+              type: 'void',
+              'x-decorator': 'TableV2.Column.Decorator',
+              'x-component': 'TableV2.Column',
+              title: generateNTemplate('Created at'),
+              properties: {
+                createdAt: {
+                  type: 'date',
+                  // 'x-component': 'CollectionField',
+                  'x-component': 'DatePicker',
+                  'x-component-props': {
+                    format: 'YYYY-MM-DD HH:mm:ss',
+                  },
+                  'x-read-pretty': true,
+                },
+              },
+            },
+            actionColumn: {
+              type: 'void',
+              title: '{{ t("Actions") }}',
+              'x-action-column': 'actions',
+              'x-decorator': 'TableV2.Column.ActionBar',
+              'x-component': 'TableV2.Column',
+              properties: {
+                columnActions: {
+                  type: 'void',
+                  'x-component': 'Space',
+                  'x-component-props': {
+                    split: '|',
+                  },
+                  properties: {
+                    delete: {
+                      type: 'void',
+                      title: '{{ t("Delete") }}',
+                      'x-component': 'Action.Link',
+                      'x-component-props': {
+                        confirm: {
+                          title: generateNTemplate('Delete API key'),
+                          content: "{{t('Are you sure you want to delete it?')}}",
+                        },
+                        useAction: useDestroyAction,
+                      },
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+};