koishi-plugin-http-monetary 0.0.2

package/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/lib/config.d.ts

@@ -0,0 +1,7 @@
+import { Schema } from 'koishi';
+export interface Config {
+    loggerinfo: boolean;
+    apiPrefix: string;
+    apiKey: string;
+}
+export declare const Config: Schema<Config>;

package/lib/index.d.ts

@@ -0,0 +1,7 @@
+import { Context } from 'koishi';
+import { Config } from './config';
+export * from './config';
+export declare const name = "plugin-http-monetary";
+export declare const inject: string[];
+export declare const usage = "\n<hr>\n<h2>\u6D45\u6D45\u7684\u7528http\u5C01\u88C5\u4E00\u4E0Bwww\uFF08\u5E26\u9274\u6743\u7248\uFF09</h2>\n<hr>\n";
+export declare function apply(ctx: Context, config: Config): void;

package/lib/index.js

@@ -0,0 +1,168 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name2 in all)
+    __defProp(target, name2, { get: all[name2], 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);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Config: () => Config,
+  apply: () => apply,
+  inject: () => inject,
+  name: () => name,
+  usage: () => usage
+});
+module.exports = __toCommonJS(src_exports);
+var import_koishi2 = require("koishi");
+
+// src/utils.ts
+function logger_status(logger2, enable) {
+  if (enable) {
+    return logger2;
+  } else {
+    return null;
+  }
+}
+__name(logger_status, "logger_status");
+
+// src/config.ts
+var import_koishi = require("koishi");
+var Config = import_koishi.Schema.intersect([
+  import_koishi.Schema.object({
+    apiPrefix: import_koishi.Schema.string().default("/monetary").description("API 前缀"),
+    apiKey: import_koishi.Schema.string().default("").description("API 鉴权密钥，留空则不启用鉴权"),
+    loggerinfo: import_koishi.Schema.boolean().default(false).description("日志调试模式").experimental()
+  }).description("调试设置")
+]);
+
+// src/index.ts
+var name = "plugin-http-monetary";
+var inject = ["monetary", "server", "logger"];
+var usage = `
+<hr>
+<h2>浅浅的用http封装一下www（带鉴权版）</h2>
+<hr>
+`;
+var logger = new import_koishi2.Logger("plugin-http-monetary");
+function apply(ctx, config) {
+  const prefix = config.apiPrefix;
+  const apiKey = config.apiKey;
+  const checkAuth = /* @__PURE__ */ __name((koaCtx) => {
+    if (!apiKey) return true;
+    const authHeader = koaCtx.headers.authorization;
+    if (!authHeader || !authHeader.startsWith("Bearer ")) {
+      return false;
+    }
+    const token = authHeader.substring(7);
+    return token === apiKey;
+  }, "checkAuth");
+  const handleUnauthorized = /* @__PURE__ */ __name((koaCtx) => {
+    koaCtx.status = 401;
+    koaCtx.body = { error: "unauthorized" };
+    logger_status(logger, config.loggerinfo)?.warn(`鉴权失败: IP=${koaCtx.ip} 路径=${koaCtx.path}`);
+  }, "handleUnauthorized");
+  ctx.server.get(prefix + "/balance/:uid", async (koaCtx) => {
+    if (!checkAuth(koaCtx)) {
+      handleUnauthorized(koaCtx);
+      return;
+    }
+    const koishiCtx = koaCtx.ctx;
+    const uid = parseInt(koaCtx.params.uid);
+    if (isNaN(uid)) {
+      koaCtx.status = 400;
+      koaCtx.body = { error: "invalid uid" };
+      logger_status(logger, config.loggerinfo)?.warn(`参数错误: uid=${koaCtx.params.uid} IP=${koaCtx.ip}`);
+      return;
+    }
+    const currency = koaCtx.query.currency || "default";
+    try {
+      const [data] = await koishiCtx.database.get("monetary", { uid, currency }, ["value"]);
+      koaCtx.body = {
+        uid,
+        currency,
+        balance: data?.value ?? 0
+      };
+      logger.info(`查询余额成功: uid=${uid} currency=${currency} balance=${data?.value ?? 0}`);
+    } catch (e) {
+      koaCtx.status = 500;
+      koaCtx.body = { error: e.message };
+      logger_status(logger, config.loggerinfo)?.error(`查询余额失败: uid=${uid} error=${e.message}`);
+    }
+  });
+  ctx.server.post(prefix + "/gain", async (koaCtx) => {
+    if (!checkAuth(koaCtx)) {
+      handleUnauthorized(koaCtx);
+      return;
+    }
+    const koishiCtx = koaCtx.ctx;
+    const { uid, amount, currency } = koaCtx.request.body;
+    if (typeof uid !== "number" || typeof amount !== "number" || amount <= 0) {
+      koaCtx.status = 400;
+      koaCtx.body = { error: "invalid parameters: uid and amount must be positive numbers" };
+      logger_status(logger, config.loggerinfo)?.warn(`增加点数参数错误: body=${JSON.stringify(koaCtx.request.body)} IP=${koaCtx.ip}`);
+      return;
+    }
+    try {
+      await koishiCtx.monetary.gain(uid, amount, currency || "default");
+      koaCtx.body = { success: true };
+      logger_status(logger, config.loggerinfo)?.info(`增加点数成功: uid=${uid} amount=${amount} currency=${currency || "default"}`);
+    } catch (e) {
+      koaCtx.status = 500;
+      koaCtx.body = { error: e.message };
+      logger_status(logger, config.loggerinfo)?.error(`增加点数失败: uid=${uid} error=${e.message}`);
+    }
+  });
+  ctx.server.post(prefix + "/cost", async (koaCtx) => {
+    if (!checkAuth(koaCtx)) {
+      handleUnauthorized(koaCtx);
+      return;
+    }
+    const koishiCtx = koaCtx.ctx;
+    const { uid, amount, currency } = koaCtx.request.body;
+    if (typeof uid !== "number" || typeof amount !== "number" || amount <= 0) {
+      koaCtx.status = 400;
+      koaCtx.body = { error: "invalid parameters: uid and amount must be positive numbers" };
+      logger_status(logger, config.loggerinfo)?.warn(`扣除点数参数错误: body=${JSON.stringify(koaCtx.request.body)} IP=${koaCtx.ip}`);
+      return;
+    }
+    try {
+      await koishiCtx.monetary.cost(uid, amount, currency || "default");
+      koaCtx.body = { success: true };
+      logger_status(logger, config.loggerinfo)?.info(`扣除点数成功: uid=${uid} amount=${amount} currency=${currency || "default"}`);
+    } catch (e) {
+      if (e.message === "insufficient balance.") {
+        koaCtx.status = 400;
+        koaCtx.body = { error: "insufficient balance" };
+        logger_status(logger, config.loggerinfo)?.warn(`扣除点数余额不足: uid=${uid} amount=${amount}`);
+      } else {
+        koaCtx.status = 500;
+        koaCtx.body = { error: e.message };
+        logger_status(logger, config.loggerinfo)?.error(`扣除点数失败: uid=${uid} error=${e.message}`);
+      }
+    }
+  });
+  logger_status(logger, config.loggerinfo)?.info(`HTTP API 已挂载在 ${prefix}，鉴权状态：${apiKey ? "已启用" : "未启用"}`);
+}
+__name(apply, "apply");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Config,
+  apply,
+  inject,
+  name,
+  usage
+});

package/lib/utils.d.ts

@@ -0,0 +1,2 @@
+import { Logger } from 'koishi';
+export declare function logger_status(logger: Logger, enable: boolean): Logger;

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "koishi-plugin-http-monetary",
+  "description": "HTTP API for Koishi Monetary Plugin",
+  "version": "0.0.2",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "contributors": [
+    "FLY1919 <qw687255511@163.com>"
+  ],
+  "files": [
+    "lib",
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/FLY1919/plugin-http-monetary.git"
+  },
+  "bugs": {
+    "url": "https://github.com/FLY1919/plugin-http-monetary/issues"
+  },
+  "scripts": {
+    "build": "tsc",
+    "pub": "npm run build && npm publish"
+  },
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/FLY1919/plugin-http-monetary",
+  "koishi": {
+    "description": {
+      "zh": "Koishi Monetary 插件的 HTTP API 插件",
+      "en": "HTTP API plugin for Koishi Monetary plugin",
+      "ja": "Koishi Monetary プラグインの HTTP API プラグイン",
+      "ko": "Koishi Monetary 플러그인의 HTTP API 플러그인",
+      "zh-TW": "Koishi Monetary 插件的 HTTP API 插件",
+      "fr": "Plugin HTTP API pour le plugin Koishi Monetary",
+      "ru": "HTTP API плагин для плагина Koishi Monetary",
+      "de": "HTTP-API-Plugin für das Koishi Monetary Plugin",
+      "es": "Plugin HTTP API para el plugin Koishi Monetary"
+    }
+  },
+  "keywords": [
+    "chatbot",
+    "koishi",
+    "plugin",
+    "monetary",
+    "http",
+    "api"
+  ],
+  "peerDependencies": {
+    "koishi": "4.18.10"
+  },
+  "devDependencies": {
+    "koishi": "4.18.10"
+  }
+}

package/readme.md

@@ -0,0 +1,172 @@
+# 🐱 喵点通 · Koishi HTTP Monetary 插件
+
+[![npm](https://img.shields.io/npm/v/koishi-plugin-plugin-http-monetary?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-plugin-http-monetary)
+
+✨ **给 Koishi 的 monetary 服务加上萌萌的 HTTP 小爪子～**  
+主人可以通过 REST API 查询余额、增加/扣除点数，还能用暗号保护咱的小金库哦。
+
+---
+
+## 📦 安装
+
+```bash
+npm install koishi-plugin-plugin-http-monetary
+# 或
+yarn add koishi-plugin-plugin-http-monetary
+```
+
+> 🚨 **需要一起玩耍的小伙伴**：
+> - [`koishi-plugin-monetary`](https://www.npmjs.com/package/koishi-plugin-monetary) —— 点数系统的家
+> - [`@koishijs/plugin-server`](https://www.npmjs.com/package/@koishijs/plugin-server) —— 开门迎客的 HTTP 服务
+
+---
+
+## ⚙️ 配置项
+
+| 参数 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `apiPrefix` | `string` | `'/monetary'` | API 路由前缀，不喜欢可以改喵 |
+| `apiKey` | `string` | `''` | 访问密钥，留空就是公开访问（慎用哦） |
+| `loggerinfo` | `boolean` | `false` | 调试模式，打开后咱会多说点话 |
+
+**配置示例**（在 `koishi.config.yml` 里）：
+```yaml
+plugin-http-monetary:
+  apiPrefix: '/money'          # 改成 /money 也认得
+  apiKey: 'meow-secret-key'    # 只有知道暗号的人才能调用
+  loggerinfo: true             # 想听咱碎碎念就打开吧
+```
+
+---
+
+## 🛣️ API 路由
+
+所有接口都返回 JSON。如果设置了 `apiKey`，请求头必须包含：
+
+```
+Authorization: Bearer <你的密钥>
+```
+
+---
+
+### 🔍 查询余额
+
+```
+GET /monetary/balance/:uid?currency=<币种>
+```
+
+**路径参数**  
+- `uid`：用户 ID（数字）
+
+**查询参数**  
+- `currency`：币种，默认 `'default'`
+
+**示例**  
+```bash
+curl "http://localhost:8080/monetary/balance/12345?currency=gold"
+```
+
+**成功响应**  
+```json
+{
+  "uid": 12345,
+  "currency": "gold",
+  "balance": 100
+}
+```
+
+**错误响应**  
+- `400`：uid 格式不对  
+- `401`：未授权（密钥错误或缺失）  
+- `500`：服务器内部错误
+
+---
+
+### ➕ 增加点数
+
+```
+POST /monetary/gain
+Content-Type: application/json
+
+{
+  "uid": 12345,
+  "amount": 50,
+  "currency": "gold"   // 可选，默认为 default
+}
+```
+
+**示例**  
+```bash
+curl -X POST http://localhost:8080/monetary/gain \
+  -H "Authorization: Bearer meow-secret-key" \
+  -H "Content-Type: application/json" \
+  -d '{"uid": 12345, "amount": 50}'
+```
+
+**成功响应**  
+```json
+{ "success": true }
+```
+
+**错误响应**  
+- `400`：参数无效（如 amount ≤ 0）  
+- `401`：未授权  
+- `500`：内部错误
+
+---
+
+### ➖ 扣除点数
+
+```
+POST /monetary/cost
+Content-Type: application/json
+
+{
+  "uid": 12345,
+  "amount": 30,
+  "currency": "gold"
+}
+```
+
+**示例**  
+```bash
+curl -X POST http://localhost:8080/monetary/cost \
+  -H "Authorization: Bearer meow-secret-key" \
+  -H "Content-Type: application/json" \
+  -d '{"uid": 12345, "amount": 30}'
+```
+
+**成功响应**  
+```json
+{ "success": true }
+```
+
+**余额不足时**（HTTP 400）  
+```json
+{ "error": "insufficient balance" }
+```
+
+**其他错误**  
+- `400`：参数无效  
+- `401`：未授权  
+- `500`：内部错误
+
+---
+
+## 🐾 调试模式
+
+将 `loggerinfo` 设为 `true`，咱就会在控制台里轻声细语地记录每次请求，帮主人揪出捣蛋鬼。
+
+---
+
+## 💌 来自猫娘的叮嘱
+
+- 如果 `apiKey` 留空，任何人都能调用 API，请务必在安全网络下使用哦。
+- 记得先让 `@koishijs/plugin-server` 起床，不然咱开不了门。
+- 数据库表由 `monetary` 自动创建，咱只负责跑腿。
+
+---
+
+## 📄 许可证
+
+Apache-2.0 — 想怎么玩就怎么玩，不过要是把咱弄哭了，可是要负责的哦 (,,•́ . •̀,,)