first

.dockerignore

+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+/data
+/output
+/config.yaml
+
+.git*
+Dockerfile
+.dockerignore

.eslintignore

+webpack.config.js
+dist/*
+build/*
\ No newline at end of file

.eslintrc.js

+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir : __dirname, 
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

.gitignore

+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+/data
+/output
+/config.yaml
\ No newline at end of file

.gitlab-ci.yml

+stages:
+  - install
+  - build
+  - deploy
+
+variables:
+  GIT_DEPTH: "1"
+
+npm_ci:
+  stage: install
+  tags:
+    - linux
+  script:
+    - npm ci
+  artifacts:
+    paths:
+      - node_modules
+
+.build_base:
+  stage: build
+  tags:
+    - linux
+  dependencies:
+    - npm_ci
+
+build:
+  extends: .build_base
+  script: npm run build
+  artifacts:
+    paths:
+      - dist/
+
+test:
+  extends: .build_base
+  script: npm run test
+
+upload_to_minio:
+  stage: deploy
+  dependencies:
+    - build
+  tags:
+    - linux
+  script:
+    - aws s3 --endpoint=https://minio.mycard.moe:9000 sync --delete dist/full/ s3://nanahira/koishi-plugin/chatgpt-api
+  only:
+    - master
+
+deploy_npm:
+  stage: deploy
+  dependencies:
+    - build
+  tags:
+    - linux
+  script:
+    - apt update;apt -y install coreutils
+    - echo $NPMRC | base64 --decode > ~/.npmrc
+    - npm publish . --access public && curl -X PUT "https://registry-direct.npmmirror.com/$(cat package.json | jq '.name' | sed 's/\"//g')/sync?sync_upstream=true" || true
+  only:
+    - master

.npmignore

+/install-npm.sh
+.git*
+/data
+/output
+/config.yaml
+.idea
+.dockerignore
+Dockerfile
+/src
+/dist/full
+/coverage
+/tests
+/dist/tests
+/dev
+/dist/dev
+/webpack.config.js
+/.eslint*
+.*ignore
+.prettierrc*

.prettierrc

+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}
\ No newline at end of file

LICENSE

+The MIT License (MIT)
+
+Copyright (c) 2021 Nanahira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

 # koishi-plugin-chatgpt-api
 
-ChatGPT API 插件，使用官方 API。
\ No newline at end of file
+ChatGPT API 插件，使用官方 API。
+
+## 安装
+
+### npm
+
+```bash
+npm install koishi-plugin-chatgpt-api
+```
+
+## 配置
+
+需要先安装好 [Cache](https://cache.koishi.chat) 服务。
+
+- **apikey**: `string` ChatGPT API Key。
+- **prefix**: `string[]` 触发词。若无触发词则任意情况都能触发。
+- **model**: `string` 模型名称。默认 `text-davinci-003`。
\ No newline at end of file

dev/extras.tsx

+import { Context } from 'koishi';
+
+export default class ExtrasInDev {
+  constructor(ctx: Context) {}
+}

dev/index.tsx

+import { App } from 'koishi';
+import TargetPlugin from '../src';
+import ConsolePlugin from '@koishijs/plugin-console';
+import * as SandboxPlugin from '@koishijs/plugin-sandbox';
+import DatabasePlugin from '@koishijs/plugin-database-memory';
+import * as Help from '@koishijs/plugin-help';
+import ExtrasInDev from './extras';
+import AragamiPlugin from 'koishi-plugin-cache-aragami';
+
+const app = new App({
+  port: 14514,
+  host: 'localhost',
+  prefix: '.',
+});
+
+app.plugin(Help);
+
+// Console and sandbox
+app.plugin(SandboxPlugin);
+app.plugin(ConsolePlugin, {
+  open: false,
+});
+
+// Some services
+app.plugin(DatabasePlugin);
+app.plugin(AragamiPlugin);
+
+// Some extras
+app.plugin(ExtrasInDev);
+
+// Target plugin
+app.plugin(TargetPlugin, {
+  apiKey: 'wwww',
+  prefix: [],
+});
+
+app.start();

install-npm.sh

+#!/bin/bash
+npm install --save \
+	koishi-thirdeye
+
+npm install --save-peer \
+	koishi
+
+	npm i --save-exact --save-dev eslint@8.22.0
+
+npm install --save-dev \
+	@types/node \
+	typescript \
+	'@typescript-eslint/eslint-plugin@^5.0.0' \
+	'@typescript-eslint/parser@^5.0.0 '\
+	'eslint-config-prettier@^8.3.0' \
+	'eslint-plugin-prettier@^4.0.0' \
+	prettier \
+	raw-loader \
+	ts-loader \
+	webpack \
+	webpack-cli \
+	ws \
+	ts-node \
+	@koishijs/plugin-help \
+	@koishijs/plugin-console \
+	@koishijs/plugin-sandbox \
+	@koishijs/plugin-database-memory \
+	jest \
+	ts-jest \
+	@types/jest

package.json

+{
+  "name": "koishi-plugin-chatgpt-api",
+  "description": "ChatGPT API 插件，使用官方 API。",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/src/index.d.ts",
+  "scripts": {
+    "lint": "eslint --fix .",
+    "build": "webpack",
+    "start": "ts-node ./dev",
+    "test": "jest --passWithNoTests"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://code.mycard.moe/3rdeye/koishi-plugin-chatgpt-api.git"
+  },
+  "author": "Nanahira <nanahira@momobako.com>",
+  "license": "MIT",
+  "keywords": [
+    "Koishi.js",
+    "qqbot",
+    "cqhttp",
+    "onebot"
+  ],
+  "bugs": {
+    "url": "https://code.mycard.moe/3rdeye/koishi-plugin-chatgpt-api/issues"
+  },
+  "homepage": "https://code.mycard.moe/3rdeye/koishi-plugin-chatgpt-api",
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "tests",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  },
+  "dependencies": {
+    "@koishijs/cache": "^0.1.3",
+    "chatgpt": "^4.2.0",
+    "koishi-thirdeye": "^11.1.23",
+    "marked": "^4.2.12",
+    "node-fetch": "^3.3.0"
+  },
+  "peerDependencies": {
+    "koishi": "^4.11.5"
+  },
+  "devDependencies": {
+    "@koishijs/plugin-console": "^5.2.3",
+    "@koishijs/plugin-database-memory": "^2.3.0",
+    "@koishijs/plugin-help": "^2.0.2",
+    "@koishijs/plugin-sandbox": "^2.6.1",
+    "@types/jest": "^29.4.0",
+    "@types/marked": "^4.0.8",
+    "@types/node": "^18.13.0",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
+    "eslint": "8.22.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.4.2",
+    "koishi-plugin-cache-aragami": "^2.6.0",
+    "prettier": "^2.8.4",
+    "raw-loader": "^4.0.2",
+    "ts-jest": "^29.0.5",
+    "ts-loader": "^9.4.2",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5",
+    "webpack": "^5.75.0",
+    "webpack-cli": "^5.0.1",
+    "ws": "^8.12.0"
+  },
+  "koishi": {
+    "service": {
+      "required": [
+        "cache"
+      ]
+    }
+  }
+}

src/config.tsx

+import { SchemaProperty, RegisterSchema } from 'koishi-thirdeye';
+import type { openai, ChatGPTAPI, SendMessageOptions } from 'chatgpt';
+import { Schema } from 'koishi';
+
+@RegisterSchema()
+export class ChatGPTApiPluginConfig {
+  constructor(config: ChatGPTApiPluginConfigLike) {}
+
+  @SchemaProperty({
+    required: true,
+    description: 'ChatGPT API Key. ',
+    role: 'secret',
+  })
+  apiKey: string;
+
+  @SchemaProperty({
+    type: Schema.object({}),
+    description: 'OpenAI API 额外选项。',
+    default: {},
+    hidden: true,
+  })
+  completionParams: Partial<openai.CompletionParams>;
+
+  @SchemaProperty({ description: '模型名称。', default: 'text-davinci-003' })
+  model: string;
+
+  @SchemaProperty({
+    type: Schema.object({}),
+    default: {},
+    description: 'ChatGPT API 额外选项。',
+    hidden: true,
+  })
+  extras: Partial<ConstructorParameters<typeof ChatGPTAPI>[0]>;
+
+  @SchemaProperty({
+    type: Schema.object({}),
+    default: {},
+    description: '发送消息时的额外选项。',
+    hidden: true,
+  })
+  sendOptions: Partial<SendMessageOptions>;
+
+  @SchemaProperty({
+    description: '会话超时时间（ms）。',
+    default: 3600000,
+  })
+  sessionTTL: number;
+
+  @SchemaProperty({
+    description: '触发前缀。如果为空则任何时候都触发。',
+    default: ['!', '！'],
+    type: String,
+  })
+  prefix: string[];
+}
+
+export type ChatGPTApiPluginConfigLike = Partial<ChatGPTApiPluginConfig>;

src/index.tsx

+import { ChatGPTApiPluginConfig } from './config';
+import {
+  DefinePlugin,
+  Inject,
+  InjectLogger,
+  LifecycleEvents,
+  PutSession,
+  StarterPlugin,
+  UseCommand,
+  UseMiddleware,
+} from 'koishi-thirdeye';
+export * from './config';
+import type { ChatGPTAPI, ChatMessage } from 'chatgpt';
+import Cache from '@koishijs/cache';
+import { Logger, Next, Session } from 'koishi';
+import internal from 'stream';
+import { transform } from './transform';
+
+declare module '@koishijs/cache' {
+  interface Tables {
+    chatgptMessages: ChatMessage;
+  }
+}
+
+@DefinePlugin({ name: 'chatgpt-api' })
+export default class ChatGPTApiPlugin
+  extends StarterPlugin(ChatGPTApiPluginConfig)
+  implements LifecycleEvents
+{
+  @Inject(true)
+  private __cache__: Cache;
+
+  ChatGPTAPIConstructor: typeof ChatGPTAPI;
+  async onConnect() {
+    if (!globalThis.fetch) {
+      const { default: fetch } = await eval("import('node-fetch')");
+      globalThis.fetch = fetch;
+      globalThis.Headers = fetch.Headers;
+      globalThis.Request = fetch.Request;
+      globalThis.Response = fetch.Response;
+    }
+    const { ChatGPTAPI } = await eval("import('chatgpt')");
+    this.ChatGPTAPIConstructor = ChatGPTAPI;
+  }
+
+  getApiInstance(session: Session) {
+    const table = this.__cache__.cache('chatgptMessages');
+    return new this.ChatGPTAPIConstructor({
+      apiKey: this.config.apiKey,
+      completionParams: {
+        model: this.config.model,
+        ...this.config.completionParams,
+      },
+      userLabel: session.username || session.userId,
+      assistantLabel: session.bot.username || session.selfId,
+      getMessageById: (id) => table.get(`${internal}:${id}`),
+      upsertMessage: (message) =>
+        table.set(`${internal}:${message.id}`, message),
+      ...this.config.extras,
+    });
+  }
+
+  private sessionKey(session: Session) {
+    return `session:${session.platform}:${session.selfId}:${session.channelId}:${session.userId}`;
+  }
+
+  @UseCommand('chatgpt-reset', '重置 ChatGPT 对话')
+  async reset(@PutSession() session: Session) {
+    await this.__cache__
+      .cache('chatgptMessages')
+      .delete(this.sessionKey(session));
+    return 'OK';
+  }
+
+  @InjectLogger()
+  private logger: Logger;
+
+  @UseMiddleware()
+  middleware(session: Session, next: Next) {
+    if (!this.config.prefix.length || session.parsed?.appel)
+      return this.handle(session, session.content);
+    const matchingPrefix = this.config.prefix.find((prefix) =>
+      session.content.startsWith(prefix),
+    );
+    if (!matchingPrefix) return next();
+    return this.handle(session, session.content.slice(matchingPrefix.length));
+  }
+
+  async handle(session: Session, text: string) {
+    const api = this.getApiInstance(session);
+    const key = this.sessionKey(session);
+    const lastMessage = await this.__cache__.cache('chatgptMessages').get(key);
+    try {
+      const message = await api.sendMessage(text, {
+        ...(lastMessage
+          ? {
+              parentMessageId: lastMessage.id,
+              conversationId: lastMessage.conversationId,
+            }
+          : {}),
+        timeoutMs: 300000,
+        ...this.config.sendOptions,
+      });
+      await this.__cache__
+        .cache('chatgptMessages')
+        .set(key, message, this.config.sessionTTL);
+      return transform(message.text);
+    } catch (e) {
+      this.logger.error(e);
+    }
+    return 'Internal Server Error';
+  }
+}

src/transform.ts

+import { segment } from 'koishi';
+import { marked } from 'marked';
+
+declare module 'marked' {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace Tokens {
+    interface Def {
+      type: 'def';
+    }
+
+    interface Paragraph {
+      tokens: marked.Token[];
+    }
+  }
+}
+
+function renderToken(token: marked.Token) {
+  if (token.type === 'code') {
+    return token.text + '\n';
+  } else if (token.type === 'paragraph') {
+    return render(token.tokens);
+  } else if (token.type === 'image') {
+    return segment.image(token.href);
+  } else if (token.type === 'blockquote') {
+    return token.text;
+  }
+  return token.raw;
+}
+
+function render(tokens: marked.Token[]) {
+  return tokens.map(renderToken).join('');
+}
+
+export function transform(source: string) {
+  if (!source) return '';
+  source = source.replace(/^<!--(.*)-->$/gm, '');
+  return render(marked.lexer(source))
+    .trim()
+    .replace(/\n\s*\n/g, '\n');
+}

tests/sample.spec.ts

+import { App } from 'koishi';
+import TargetPlugin from '../src';
+
+describe('Test of plugin.', () => {
+  let app: App;
+
+  beforeEach(async () => {
+    app = new App();
+    // app.plugin(TargetPlugin);
+    await app.start();
+  });
+
+  it('should pass', () => {
+    expect(true).toBe(true);
+  });
+});

tsconfig.json

+{
+	"compilerOptions": {
+		"outDir": "dist",
+		"module": "commonjs",
+		"target": "es2021",
+		"esModuleInterop": true,
+		"emitDecoratorMetadata": true,
+		"experimentalDecorators": true,
+		"declaration": true,
+		"sourceMap": true,
+		"skipLibCheck": true,
+		"jsx": "react-jsx",
+		"jsxImportSource": "@satorijs/element"
+	},
+	"compileOnSave": true,
+	"allowJs": true,
+	"include": [
+		"*.ts",
+		"src/**/*.ts",
+		"tests/**/*.ts",
+		"dev/**/*.ts",
+		"*.tsx",
+		"src/**/*.tsx",
+		"tests/**/*.tsx",
+		"dev/**/*.tsx"
+	]
+}

webpack.config.js

+const path = require('path');
+const packgeInfo = require('./package.json');
+
+function externalsFromDep() {
+  return Object.fromEntries(
+    [
+      ...Object.keys(packgeInfo.dependencies || {}),
+      ...Object.keys(packgeInfo.peerDependencies || {}),
+    ]
+      .filter((dep) => dep !== 'source-map-support')
+      .map((dep) => [dep, dep]),
+  );
+}
+
+const packAll = !!process.env.PACK_ALL;
+
+module.exports = {
+  entry: './src/index.tsx',
+  mode: 'production',
+  target: 'node',
+  devtool: 'source-map',
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: 'ts-loader',
+        exclude: /node_modules/,
+      },
+      { test: /\.mustache$/, use: 'raw-loader' },
+    ],
+  },
+  resolve: {
+    extensions: ['.tsx', '.ts', '.js'],
+  },
+  output: {
+    filename: 'index.js',
+    library: {
+      type: 'commonjs',
+    },
+    path: path.resolve(__dirname, packAll ? 'dist/full' : 'dist'),
+  },
+  externals: {
+    koishi: 'koishi',
+    '@satorijs/element': '@satorijs/element',
+    '@satorijs/element/jsx-runtime': '@satorijs/element',
+    ...(packAll ? {} : externalsFromDep()),
+  },
+};