@tachybase/plugin-api-keys 0.23.8

package/dist/locale.js

@@ -0,0 +1,30 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var locale_exports = {};
+__export(locale_exports, {
+  generateNTemplate: () => generateNTemplate
+});
+module.exports = __toCommonJS(locale_exports);
+var import_constants = require("./constants");
+function generateNTemplate(key) {
+  return `{{t('${key}', { ns: '${import_constants.NAMESPACE}', nsMode: 'fallback' })}}`;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  generateNTemplate
+});

package/dist/server/actions/api-keys.d.ts

@@ -0,0 +1,3 @@
+import { Context, Next } from '@tachybase/actions';
+export declare function create(ctx: Context, next: Next): Promise<void>;
+export declare function destroy(ctx: Context, next: Next): Promise<void>;

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

@@ -0,0 +1,84 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var api_keys_exports = {};
+__export(api_keys_exports, {
+  create: () => create,
+  destroy: () => destroy
+});
+module.exports = __toCommonJS(api_keys_exports);
+var import_crypto = require("crypto");
+var import_actions = __toESM(require("@tachybase/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 hash = (0, import_crypto.createHash)("sha256");
+  const jwtToken = ctx.app.authManager.jwt.sign(
+    { userId: ctx.auth.user.id, roleName: role.name },
+    { expiresIn: values.expiresIn }
+  );
+  hash.update(jwtToken);
+  const token = hash.digest("hex");
+  ctx.action.mergeParams({
+    values: {
+      token: jwtToken,
+      accessToken: token
+    }
+  });
+  return import_actions.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 import_actions.default.destroy(ctx, next);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  create,
+  destroy
+});

package/dist/server/collections/apiKeys.d.ts

@@ -0,0 +1,2 @@
+import apiKeys from '../../collections/apiKeys';
+export default apiKeys;

package/dist/server/collections/apiKeys.js

@@ -0,0 +1,34 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var apiKeys_exports = {};
+__export(apiKeys_exports, {
+  default: () => apiKeys_default
+});
+module.exports = __toCommonJS(apiKeys_exports);
+var import_apiKeys = __toESM(require("../../collections/apiKeys"));
+var apiKeys_default = import_apiKeys.default;

package/dist/server/index.d.ts

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

package/dist/server/index.js

@@ -0,0 +1,33 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var server_exports = {};
+__export(server_exports, {
+  default: () => import_plugin.default
+});
+module.exports = __toCommonJS(server_exports);
+var import_plugin = __toESM(require("./plugin"));

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

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

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

@@ -0,0 +1,23 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var en_US_exports = {};
+__export(en_US_exports, {
+  default: () => en_US_default
+});
+module.exports = __toCommonJS(en_US_exports);
+var en_US_default = {};

package/dist/server/locale/fr-FR.d.ts

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

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

@@ -0,0 +1,23 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var fr_FR_exports = {};
+__export(fr_FR_exports, {
+  default: () => fr_FR_default
+});
+module.exports = __toCommonJS(fr_FR_exports);
+var fr_FR_default = {};

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

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

package/dist/server/locale/index.js

@@ -0,0 +1,40 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var locale_exports = {};
+__export(locale_exports, {
+  enUS: () => import_en_US.default,
+  zhCN: () => import_zh_CN.default
+});
+module.exports = __toCommonJS(locale_exports);
+var import_en_US = __toESM(require("./en-US"));
+var import_zh_CN = __toESM(require("./zh-CN"));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  enUS,
+  zhCN
+});

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

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

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

@@ -0,0 +1,25 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var zh_CN_exports = {};
+__export(zh_CN_exports, {
+  default: () => zh_CN_default
+});
+module.exports = __toCommonJS(zh_CN_exports);
+var zh_CN_default = {
+  "Role not found": "\u89D2\u8272\u4E0D\u5B58\u5728"
+};

package/dist/server/plugin.d.ts

@@ -0,0 +1,7 @@
+import { Plugin } from '@tachybase/server';
+export declare class PluginAPIKeysServer extends Plugin {
+    resourceName: string;
+    beforeLoad(): Promise<void>;
+    load(): Promise<void>;
+}
+export default PluginAPIKeysServer;

package/dist/server/plugin.js

@@ -0,0 +1,85 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var plugin_exports = {};
+__export(plugin_exports, {
+  PluginAPIKeysServer: () => PluginAPIKeysServer,
+  default: () => plugin_default
+});
+module.exports = __toCommonJS(plugin_exports);
+var import_server = require("@tachybase/server");
+var import_api_keys = require("./actions/api-keys");
+class PluginAPIKeysServer extends import_server.Plugin {
+  resourceName = "apiKeys";
+  async beforeLoad() {
+    this.app.resourcer.define({
+      name: this.resourceName,
+      actions: {
+        create: import_api_keys.create,
+        destroy: import_api_keys.destroy
+      },
+      only: ["list", "create", "destroy"]
+    });
+    this.app.acl.registerSnippet({
+      name: ["pm", this.name, "configuration"].join("."),
+      actions: ["apiKeys:list", "apiKeys:create", "apiKeys:destroy"]
+    });
+  }
+  async load() {
+    const repo = this.db.getRepository("apiKeys");
+    this.app.resourcer.use(
+      async (ctx, next) => {
+        const token = ctx.getBearerToken();
+        if ((token == null ? void 0 : token.length) !== 64) {
+          return await next();
+        }
+        const key = await repo.findOne({
+          filter: {
+            accessToken: token
+          }
+        });
+        ctx.getBearerToken = () => {
+          if (key) {
+            return key.token;
+          }
+          return token;
+        };
+        await next();
+      },
+      { tag: "api-access-token", before: "auth" }
+    );
+    this.app.resourcer.use(
+      async (ctx, next) => {
+        const { resourceName, actionName } = ctx.action;
+        if (resourceName === this.resourceName && ["list", "destroy"].includes(actionName)) {
+          ctx.action.mergeParams({
+            filter: {
+              createdById: ctx.auth.user.id
+            }
+          });
+        }
+        await next();
+      },
+      { tag: "resourceNameListDestroyFilter" }
+    );
+  }
+}
+var plugin_default = PluginAPIKeysServer;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PluginAPIKeysServer
+});

package/dist/swagger/index.d.ts

@@ -0,0 +1,106 @@
+declare const _default: {
+    info: {
+        title: string;
+    };
+    tags: any[];
+    paths: {
+        '/apiKeys:create': {
+            post: {
+                description: string;
+                tags: string[];
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        token: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/apiKeys:list': {
+            get: {
+                description: string;
+                tags: string[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    items: {
+                                        $ref: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/apiKeys:destroy/{filterByTk}': {
+            delete: {
+                description: string;
+                tags: string[];
+                parameters: {
+                    name: string;
+                    description: string;
+                    required: boolean;
+                    in: string;
+                    schema: {
+                        type: string;
+                        example: number;
+                    };
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                    };
+                };
+            };
+        };
+    };
+    components: {
+        schemas: {
+            apiKeys: {
+                type: string;
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    name: {
+                        type: string;
+                        example: string;
+                    };
+                    role: {
+                        type: string;
+                    };
+                    expiresIn: {
+                        type: string;
+                        enum: string[];
+                    };
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/swagger/index.js

@@ -0,0 +1,130 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var swagger_exports = {};
+__export(swagger_exports, {
+  default: () => swagger_default
+});
+module.exports = __toCommonJS(swagger_exports);
+var swagger_default = {
+  info: {
+    title: "TachyBase API - API keys plugin"
+  },
+  tags: [],
+  paths: {
+    "/apiKeys:create": {
+      post: {
+        description: "Create api key",
+        tags: ["apiKeys"],
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/apiKeys"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            description: "successful operation",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    token: {
+                      type: "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/apiKeys:list": {
+      get: {
+        description: "get api keys",
+        tags: ["apiKeys"],
+        responses: {
+          200: {
+            description: "successful operation",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    $ref: "#/components/schemas/apiKeys"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/apiKeys:destroy/{filterByTk}": {
+      delete: {
+        description: "Create api key",
+        tags: ["apiKeys"],
+        parameters: [
+          {
+            name: "filterByTk",
+            description: "primary key",
+            required: true,
+            in: "path",
+            schema: {
+              type: "integer",
+              example: 1
+            }
+          }
+        ],
+        responses: {
+          200: {
+            description: "successful operation"
+          }
+        }
+      }
+    }
+  },
+  components: {
+    schemas: {
+      apiKeys: {
+        type: "object",
+        properties: {
+          id: {
+            type: "integer"
+          },
+          name: {
+            type: "string",
+            example: "key-name"
+          },
+          role: {
+            type: "object"
+            // $ref: '#/components/schemas/roles'
+          },
+          expiresIn: {
+            type: "string",
+            enum: ["1d", "7d", "30d", "90d", "never"]
+          }
+        }
+      }
+    }
+  }
+};

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 `TachyBase` 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.