@tachybase/plugin-api-keys 0.23.8

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,21 @@
+# 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 `TachyBase` APIs using the API key.
+
+Here's an example using cURL:
+
+```bash
+curl '{domain}/api/roles:check' -H 'Authorization: Bearer {API key}'
+```
+
+> Warning: When using the `Docker` image to use `TachyBase`, make sure you have configured the [APP_KEY](https://docs.tachybase.com/api/env#app_key) environment variable, otherwise the API key will be invalid after each restart.
+
+## 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 可以用于访问 `TachyBase` 所有 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,21 @@
+# API keys 使用方法
+
+## 创建 API key
+
+当你启用插件后，前往 API keys 的插件管理页面，点击 `添加 API key` 并填写相关信息，点击 `保存` 即可创建 API key。
+
+## 使用 API key
+
+在请求头中添加 `Authorization` 字段，值为 `Bearer ${API_KEY}`，即可使用 API key 访问 `TachyBase` 所有 API。
+
+cURL 的例子如下
+
+```bash
+curl '{domain}/api/roles:check' -H 'Authorization: Bearer {API key}'
+```
+
+> Warning: 当你使用 `Docker` 镜像来使用 `TachyBase` 时，请确保你配置了 [APP_KEY](https://docs-cn.tachybase.com/api/env#app_key) 环境变量，否则 API key 将在每次重启后失效。
+
+## 删除 API key
+
+删除 API key 后，该 Key 将无法继续使用。

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@tachybase/plugin-api-keys",
+  "displayName": "Auth: API keys",
+  "version": "0.23.8",
+  "description": "Allows users to use API key to access application's HTTP API",
+  "keywords": [
+    "Authentication"
+  ],
+  "license": "Apache-2.0",
+  "main": "./dist/server/index.js",
+  "devDependencies": {
+    "ahooks": "^3.8.4",
+    "antd": "5.22.5",
+    "dayjs": "1.11.13",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-i18next": "^15.2.0",
+    "@tachybase/schema": "0.23.8"
+  },
+  "peerDependencies": {
+    "@tachybase/client": "0.23.8",
+    "@tachybase/test": "0.23.8",
+    "@tachybase/actions": "0.23.8",
+    "@tachybase/server": "0.23.8",
+    "@tachybase/database": "0.23.8",
+    "@tachybase/resourcer": "0.23.8",
+    "@tachybase/utils": "0.23.8"
+  },
+  "description.zh-CN": "允许用户使用 API 密钥访问应用的 HTTP API",
+  "displayName.zh-CN": "认证：API 密钥",
+  "scripts": {
+    "build": "tachybase-build --no-dts @tachybase/plugin-api-keys"
+  }
+}

package/server.d.ts

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

package/server.js

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