@zhin.js/adapter-juejin 0.0.0-stage → 0.1.0

package/schema.json

@@ -0,0 +1,485 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "apiBaseUrl": {
+      "type": "string",
+      "default": "https://api.juejin.cn"
+    },
+    "pollIntervalSec": {
+      "type": "number",
+      "minimum": 60,
+      "default": 60,
+      "description": "轮询间隔（秒），最小 60，实际会加 0–20% 随机抖动",
+      "x-i18n": {
+        "en": {
+          "description": "Polling interval in seconds, at least 60; adds 0–20% random jitter."
+        }
+      }
+    },
+    "sendMode": {
+      "type": "string",
+      "enum": [
+        "review",
+        "off"
+      ],
+      "default": "review",
+      "description": "出站模式：review=AI 回复只进草稿队列，master 在 Console 或用 juejin-draft send <id> 审批后才发出（默认）；off=禁止出站。不提供自动直发",
+      "x-i18n": {
+        "en": {
+          "description": "Outbound mode: review (default) queues AI replies as drafts; a master approves each send on the Console page or with juejin-draft send. off disables outbound messages. Automatic direct replies are not supported."
+        }
+      }
+    },
+    "minSendIntervalSec": {
+      "type": "number",
+      "minimum": 10,
+      "default": 30,
+      "description": "审批后两次真实发送的最小间隔（秒），最小 10；不足时拒绝发送，不排队",
+      "x-i18n": {
+        "en": {
+          "description": "Minimum interval between approved sends in seconds (at least 10). Sending too soon is rejected, not queued."
+        }
+      }
+    },
+    "dataDir": {
+      "type": "string",
+      "default": "data/juejin",
+      "description": "本地数据目录：待审草稿存在 <dataDir>/<endpoint id>/drafts.json（权限 600，相对进程工作目录），重启不丢。不要放进仓库",
+      "x-i18n": {
+        "en": {
+          "description": "Local data directory. Pending drafts are stored in <dataDir>/<endpoint id>/drafts.json (mode 600, relative to the working directory) and survive restarts. Keep it out of the repository."
+        }
+      }
+    },
+    "notify": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "有新草稿或登录失效时，主动发消息提醒到这个聊天会话（通常是你和机器人的私聊）。不填则只在 Console「掘金评论审批」页和日志里看到",
+      "x-i18n": {
+        "en": {
+          "description": "Chat conversation to notify when a new draft arrives or the login expires (usually your private chat with the bot). Without it, drafts only appear on the Console Juejin comment review page and in logs."
+        }
+      },
+      "properties": {
+        "adapter": {
+          "type": "string",
+          "description": "适配器名，如 icqq、telegram",
+          "x-i18n": {
+            "en": {
+              "description": "Adapter name, such as icqq or telegram."
+            }
+          }
+        },
+        "endpoint": {
+          "type": "string",
+          "description": "该适配器的 endpoint id",
+          "x-i18n": {
+            "en": {
+              "description": "Endpoint id of that adapter."
+            }
+          }
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "private",
+            "group",
+            "channel"
+          ],
+          "default": "private",
+          "description": "会话类型",
+          "x-i18n": {
+            "en": {
+              "description": "Conversation type."
+            }
+          }
+        },
+        "id": {
+          "type": [
+            "string",
+            "number"
+          ],
+          "description": "会话 id：私聊填你的账号，群聊填群号",
+          "x-i18n": {
+            "en": {
+              "description": "Conversation id: your account for a private chat, or the group id."
+            }
+          }
+        }
+      },
+      "required": [
+        "adapter",
+        "endpoint",
+        "id"
+      ]
+    },
+    "articles": {
+      "type": "array",
+      "items": {
+        "type": [
+          "string"
+        ],
+        "pattern": "^(?:[1-9][0-9]{0,19}|https?://(?:www\\.)?juejin\\.cn/post/[1-9][0-9]{0,19}(?:[/?#].*)?)$"
+      },
+      "description": "白名单文章：文章 id（请写成带引号的字符串）或 https://juejin.cn/post/<id> 链接。只轮询这些文章的评论，不做全站搜索；留空 = 不轮询",
+      "x-i18n": {
+        "en": {
+          "description": "Allowed articles: article IDs (quoted strings) or https://juejin.cn/post/<id> links. Only these articles are polled; there is no site-wide search. Empty means nothing is polled."
+        }
+      }
+    },
+    "master": {
+      "type": [
+        "string",
+        "number"
+      ],
+      "description": "框架 master（掘金 uid）。endpoints[i].master 可逐项覆盖",
+      "x-i18n": {
+        "en": {
+          "description": "Framework masters (Juejin uid). endpoints[i].master can override this value."
+        }
+      }
+    },
+    "trusted": {
+      "type": "array",
+      "items": {
+        "type": [
+          "string",
+          "number"
+        ],
+        "description": "信任的掘金用户 ID",
+        "x-i18n": {
+          "en": {
+            "description": "Trusted Juejin user ID"
+          }
+        }
+      },
+      "description": "框架 trusted 用户列表（掘金 uid）",
+      "x-i18n": {
+        "en": {
+          "description": "Framework trusted users (Juejin uid)."
+        }
+      }
+    },
+    "commandPrefix": {
+      "type": "string",
+      "default": "",
+      "description": "命令前缀（默认 '' 无前缀，任意文本按命令匹配；如 '/' 要求 / 开头）。endpoints[i] 可逐项覆盖",
+      "x-i18n": {
+        "en": {
+          "description": "Command prefix. The default empty string allows unprefixed commands; '/' requires a leading slash. Each endpoints[i] can override it."
+        }
+      }
+    },
+    "endpoints": {
+      "type": "array",
+      "minItems": 1,
+      "description": "多账号：一个插件实例挂多个 endpoint。每项与顶层字段同构（id 必填，其余覆盖顶层）",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Endpoint 名称（本地标识，不是掘金账号）",
+            "x-i18n": {
+              "en": {
+                "description": "Local endpoint name, not a Juejin account ID."
+              }
+            }
+          },
+          "cookie": {
+            "type": "string",
+            "description": "掘金网页登录态 Cookie 整串（至少含 sessionid；以你的账号身份操作；请用 ${JUEJIN_COOKIE} 注入，切勿写入仓库）",
+            "x-i18n": {
+              "en": {
+                "description": "Full Juejin web login Cookie header (must include sessionid), acting as your account. Reference ${JUEJIN_COOKIE}; never commit it to the repository."
+              }
+            }
+          },
+          "articles": {
+            "type": "array",
+            "items": {
+              "type": [
+                "string"
+              ],
+              "pattern": "^(?:[1-9][0-9]{0,19}|https?://(?:www\\.)?juejin\\.cn/post/[1-9][0-9]{0,19}(?:[/?#].*)?)$"
+            },
+            "description": "白名单文章：文章 id（请写成带引号的字符串）或 https://juejin.cn/post/<id> 链接。只轮询这些文章的评论，不做全站搜索；留空 = 不轮询",
+            "x-i18n": {
+              "en": {
+                "description": "Allowed articles: article IDs (quoted strings) or https://juejin.cn/post/<id> links. Only these articles are polled; there is no site-wide search. Empty means nothing is polled."
+              }
+            }
+          },
+          "pollIntervalSec": {
+            "type": "number",
+            "minimum": 60,
+            "default": 60,
+            "description": "轮询间隔（秒），最小 60，实际会加 0–20% 随机抖动",
+            "x-i18n": {
+              "en": {
+                "description": "Polling interval in seconds, at least 60; adds 0–20% random jitter."
+              }
+            }
+          },
+          "sendMode": {
+            "type": "string",
+            "enum": [
+              "review",
+              "off"
+            ],
+            "default": "review",
+            "description": "出站模式：review=AI 回复只进草稿队列，master 在 Console 或用 juejin-draft send <id> 审批后才发出（默认）；off=禁止出站。不提供自动直发",
+            "x-i18n": {
+              "en": {
+                "description": "Outbound mode: review (default) queues AI replies as drafts; a master approves each send on the Console page or with juejin-draft send. off disables outbound messages. Automatic direct replies are not supported."
+              }
+            }
+          },
+          "minSendIntervalSec": {
+            "type": "number",
+            "minimum": 10,
+            "default": 30,
+            "description": "审批后两次真实发送的最小间隔（秒），最小 10；不足时拒绝发送，不排队",
+            "x-i18n": {
+              "en": {
+                "description": "Minimum interval between approved sends in seconds (at least 10). Sending too soon is rejected, not queued."
+              }
+            }
+          },
+          "dataDir": {
+            "type": "string",
+            "default": "data/juejin",
+            "description": "本地数据目录：待审草稿存在 <dataDir>/<endpoint id>/drafts.json（权限 600，相对进程工作目录），重启不丢。不要放进仓库",
+            "x-i18n": {
+              "en": {
+                "description": "Local data directory. Pending drafts are stored in <dataDir>/<endpoint id>/drafts.json (mode 600, relative to the working directory) and survive restarts. Keep it out of the repository."
+              }
+            }
+          },
+          "notify": {
+            "type": "object",
+            "additionalProperties": false,
+            "description": "有新草稿或登录失效时，主动发消息提醒到这个聊天会话（通常是你和机器人的私聊）。不填则只在 Console「掘金评论审批」页和日志里看到",
+            "x-i18n": {
+              "en": {
+                "description": "Chat conversation to notify when a new draft arrives or the login expires (usually your private chat with the bot). Without it, drafts only appear on the Console Juejin comment review page and in logs."
+              }
+            },
+            "properties": {
+              "adapter": {
+                "type": "string",
+                "description": "适配器名，如 icqq、telegram",
+                "x-i18n": {
+                  "en": {
+                    "description": "Adapter name, such as icqq or telegram."
+                  }
+                }
+              },
+              "endpoint": {
+                "type": "string",
+                "description": "该适配器的 endpoint id",
+                "x-i18n": {
+                  "en": {
+                    "description": "Endpoint id of that adapter."
+                  }
+                }
+              },
+              "kind": {
+                "type": "string",
+                "enum": [
+                  "private",
+                  "group",
+                  "channel"
+                ],
+                "default": "private",
+                "description": "会话类型",
+                "x-i18n": {
+                  "en": {
+                    "description": "Conversation type."
+                  }
+                }
+              },
+              "id": {
+                "type": [
+                  "string",
+                  "number"
+                ],
+                "description": "会话 id：私聊填你的账号，群聊填群号",
+                "x-i18n": {
+                  "en": {
+                    "description": "Conversation id: your account for a private chat, or the group id."
+                  }
+                }
+              }
+            },
+            "required": [
+              "adapter",
+              "endpoint",
+              "id"
+            ]
+          },
+          "apiBaseUrl": {
+            "type": "string",
+            "default": "https://api.juejin.cn"
+          },
+          "master": {
+            "type": [
+              "string",
+              "number"
+            ],
+            "description": "本 endpoint 的框架 master（掘金 uid）",
+            "x-i18n": {
+              "en": {
+                "description": "Framework masters for this endpoint (Juejin uid)."
+              }
+            }
+          },
+          "trusted": {
+            "type": "array",
+            "items": {
+              "type": [
+                "string",
+                "number"
+              ],
+              "description": "信任的掘金用户 ID",
+              "x-i18n": {
+                "en": {
+                  "description": "Trusted Juejin user ID"
+                }
+              }
+            },
+            "description": "本 endpoint 的 trusted 列表",
+            "x-i18n": {
+              "en": {
+                "description": "Trusted users for this endpoint."
+              }
+            }
+          },
+          "commandPrefix": {
+            "type": "string"
+          },
+          "nickname": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "账号昵称兜底",
+            "x-i18n": {
+              "en": {
+                "description": "Fallback account nickname"
+              }
+            }
+          },
+          "profile": {
+            "$ref": "#/$defs/selfProfileFallback",
+            "description": "账号资料兜底",
+            "x-i18n": {
+              "en": {
+                "description": "Fallback account profile"
+              }
+            }
+          }
+        },
+        "required": [
+          "id"
+        ]
+      },
+      "x-i18n": {
+        "en": {
+          "description": "Multiple accounts: mount multiple endpoints in one plugin instance. Each entry uses the top-level fields; id is required and other fields override defaults."
+        }
+      }
+    },
+    "nickname": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "账号昵称兜底",
+      "x-i18n": {
+        "en": {
+          "description": "Fallback account nickname"
+        }
+      }
+    },
+    "profile": {
+      "$ref": "#/$defs/selfProfileFallback",
+      "description": "账号资料兜底",
+      "x-i18n": {
+        "en": {
+          "description": "Fallback account profile"
+        }
+      }
+    }
+  },
+  "required": [
+    "endpoints"
+  ],
+  "$defs": {
+    "selfProfileFallback": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "gender": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "enum": [
+            "male",
+            "female",
+            "other",
+            "unknown",
+            null
+          ]
+        },
+        "age": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": 0
+        },
+        "birthday": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"
+        },
+        "signature": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "avatar": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^(https?://[^\\s/?#]+(?:[/?#].*)?|)$"
+        },
+        "interests": {
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "string"
+          }
+        },
+        "bio": {
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      }
+    }
+  }
+}

package/src/adapter.ts

@@ -0,0 +1,45 @@
+import { Adapter, type AdapterContext, type EndpointCreationContext } from 'zhin.js/adapter';
+import { formatCompact, getAdapterLogger } from '@zhin.js/logger';
+import { JuejinClient, type JuejinClientEventMap, type JuejinFetch } from './client.js';
+import { JuejinEndpoint } from './endpoint.js';
+import { resolveJuejinConfig, type JuejinEndpointConfig } from './protocol.js';
+import { juejinNotifierToken } from './juejin-runtime-state.js';
+import { formatNotice } from './review.js';
+
+export class JuejinAdapter extends Adapter<JuejinEndpoint, JuejinEndpointConfig, JuejinClientEventMap> {
+  readonly #context: AdapterContext<JuejinEndpointConfig>;
+  constructor(context: AdapterContext<JuejinEndpointConfig>) { super(); this.#context = context; }
+  override get configurationIdentityFields(): readonly string[] { return ['id']; }
+  override get configurationIdentityProbeFields(): readonly string[] { return ['cookie', 'apiBaseUrl']; }
+  override get configurationUpdateFields(): readonly string[] {
+    return ['cookie', 'articles', 'pollIntervalSec', 'sendMode', 'minSendIntervalSec', 'notify', 'apiBaseUrl'];
+  }
+  protected override validateConfiguration(config: JuejinEndpointConfig): void { resolveJuejinConfig(config); }
+  protected override prepareConfiguration(config: JuejinEndpointConfig, identity: Readonly<{ instanceId: string }>): JuejinEndpointConfig {
+    return { ...config, stateDirectoryId: identity.instanceId };
+  }
+  protected override async identifyConfiguration(input: JuejinEndpointConfig, signal: AbortSignal): Promise<string | undefined> {
+    const config = resolveJuejinConfig(input);
+    if (!config.cookie) return undefined;
+    const self = await new JuejinClient(config, globalThis.fetch as unknown as JuejinFetch, signal).getSelf();
+    signal.throwIfAborted();
+    return self ? `juejin:${self.userId}` : undefined;
+  }
+  protected createEndpoint(input: JuejinEndpointConfig, execution: EndpointCreationContext): JuejinEndpoint {
+    const config = resolveJuejinConfig(input);
+    const notifier = this.#context.use(juejinNotifierToken);
+    const logger = getAdapterLogger('juejin', config.id);
+    return new JuejinEndpoint({ id: execution.canonicalId, config, signal: execution.signal,
+      stateDir: config.dataDir,
+      notify: async notice => {
+        if (!config.notify) return;
+        if (!await notifier(config.notify, formatNotice(notice, { formatCommand: path => path }))) {
+          logger.info(formatCompact({ op: 'juejin_notify_skipped', kind: notice.kind, hint: '没有可用的出站通道' }));
+        }
+      },
+    });
+  }
+}
+declare module '@zhin.js/feature-kit' {
+  interface AdapterRegistry { readonly juejin: JuejinAdapter; }
+}