@modesto_ma/dsh-channels 0.5.0-beta.1 → 0.5.0-beta.2

package/src/feishu/wiki/consent.ts

@@ -0,0 +1,183 @@
+/**
+ * Topic-owner consent for wiki tool calls.
+ *
+ * A wiki tool that opens, creates, or edits a document asks the topic owner
+ * on a consent card in the topic and waits for the answer. Only the topic
+ * owner (`route.senderUserId`) can decide; a click by anyone else adds the
+ * owner-only notice once. An unanswered card is denied after the configured
+ * window (`approvalTimeoutMs`). A read consent is remembered per Session and
+ * document, in memory only: it ends with the Session (`/renew`) or the
+ * process. Create and edit consents are never remembered.
+ *
+ * @module dsh-channels/feishu/wiki/consent
+ */
+
+import { randomUUID } from 'node:crypto'
+import { buildWikiConsentCard, buildWikiConsentSettledCard } from '../../cards/wiki.ts'
+import type { WikiConsentAction, WikiConsentCardState, WikiConsentQuestion } from '../../cards/wiki.ts'
+import type { CardActionEvent, FeishuChannel } from '../../feishu-channel.ts'
+import { PendingCardTable } from '../../interactions/pending.ts'
+import type { InteractionRoute, PendingCardEntry } from '../../interactions/pending.ts'
+
+/** How one consent request ended. */
+export type WikiConsentOutcome = 'allowed' | 'denied' | 'expired' | 'cancelled' | 'unavailable'
+
+/** One consent to ask for. */
+export interface WikiConsentRequest {
+  readonly sessionId: string
+  readonly route: InteractionRoute
+  readonly action: WikiConsentAction
+  readonly title: string
+  readonly url?: string
+  readonly location: string
+  readonly details: readonly string[]
+  /** The tool call's abort signal; aborting withdraws the card. */
+  readonly signal: AbortSignal
+}
+
+interface Pending extends PendingCardEntry {
+  readonly question: WikiConsentQuestion
+  resolve(outcome: WikiConsentOutcome): void
+}
+
+export interface WikiConsentDeps {
+  /** Live Feishu channel; undefined while disconnected. */
+  channel(): FeishuChannel | undefined
+  /** Decision window per card, read per request (`approvalTimeoutMs`). */
+  timeoutMs(): number
+  /** Log a non-fatal delivery/update failure. */
+  onError(sessionId: string, error: unknown): void
+}
+
+/** Consent cards for the wiki tools. */
+export class WikiConsent {
+  /** One table per channel instance (cards are patched through their channel). */
+  private table: { channel: FeishuChannel; entries: PendingCardTable<Pending> } | undefined
+  /** sessionId → document ids with a standing read consent. */
+  private readonly readGrants = new Map<string, Set<string>>()
+
+  constructor(private readonly deps: WikiConsentDeps) {}
+
+  /**
+   * Whether the Session already holds a read consent for one document.
+   * @param sessionId The Session.
+   * @param documentId Docx document id.
+   * @returns True when reading needs no new card.
+   */
+  hasReadGrant(sessionId: string, documentId: string): boolean {
+    return this.readGrants.get(sessionId)?.has(documentId) === true
+  }
+
+  /**
+   * Record a standing read consent (after an allowed read, or for a document
+   * the topic owner just approved creating).
+   * @param sessionId The Session.
+   * @param documentId Docx document id.
+   */
+  grantRead(sessionId: string, documentId: string): void {
+    let grants = this.readGrants.get(sessionId)
+    if (grants === undefined) {
+      grants = new Set()
+      this.readGrants.set(sessionId, grants)
+    }
+    grants.add(documentId)
+  }
+
+  /**
+   * Ask the topic owner and wait for the decision. Never rejects.
+   * @param request What to ask.
+   * @returns The outcome; `unavailable` when no card could be delivered.
+   */
+  request(request: WikiConsentRequest): Promise<WikiConsentOutcome> {
+    if (request.signal.aborted) return Promise.resolve('cancelled')
+    const channel = this.deps.channel()
+    if (channel === undefined) return Promise.resolve('unavailable')
+    const table = this.tableFor(channel)
+    const timeoutMs = this.deps.timeoutMs()
+    const question: WikiConsentQuestion = {
+      token: randomUUID(),
+      action: request.action,
+      title: request.title,
+      ...(request.url === undefined ? {} : { url: request.url }),
+      location: request.location,
+      details: request.details,
+      timeoutMs,
+    }
+    return new Promise<WikiConsentOutcome>((resolve) => {
+      const entry: Pending = {
+        token: question.token,
+        sessionId: request.sessionId,
+        route: request.route,
+        messageId: undefined,
+        settled: false,
+        timer: undefined,
+        signal: request.signal,
+        onAbort: undefined,
+        unauthorizedNoted: false,
+        question,
+        resolve,
+      }
+      const onAbort = (): void => this.settle(table, entry, 'cancelled', 'cancelled')
+      entry.onAbort = onAbort
+      request.signal.addEventListener('abort', onAbort, { once: true })
+      table.add(entry)
+      void table.deliver(entry, {
+        card: buildWikiConsentCard(question),
+        onWithdrawn: e => table.patch(e, buildWikiConsentSettledCard(e.question, 'cancelled')),
+        onDelivered: e => table.armTimeout(e, timeoutMs, () => this.settle(table, e, 'expired', 'expired')),
+        onFailure: e => this.settle(table, e, 'unavailable'),
+      })
+    })
+  }
+
+  /**
+   * Route one card button callback to its pending consent; unknown cards are
+   * ignored.
+   * @param event The card action.
+   */
+  onCardAction(event: CardActionEvent): void {
+    const table = this.table?.entries
+    if (table === undefined) return
+    const entry = table.resolveAction(event, (candidate) => {
+      if (candidate.unauthorizedNoted) return
+      candidate.unauthorizedNoted = true
+      table.patch(candidate, buildWikiConsentCard(candidate.question, { unauthorizedNote: true }))
+    })
+    if (entry === undefined) return
+    const decision = (event.action.value as { decision?: unknown } | undefined)?.decision
+    if (decision === 'allow') this.settle(table, entry, 'allowed', 'allowed')
+    else if (decision === 'deny') this.settle(table, entry, 'denied', 'denied')
+  }
+
+  /** Withdraw every pending card and forget every read consent (shutdown). */
+  dispose(): void {
+    const table = this.table?.entries
+    table?.withdrawAll(entry => this.settle(table, entry, 'cancelled', 'cancelled'))
+    this.table = undefined
+    this.readGrants.clear()
+  }
+
+  /** Pending consent count (diagnostics/tests). */
+  pendingCount(): number {
+    return this.table?.entries.count() ?? 0
+  }
+
+  private tableFor(channel: FeishuChannel): PendingCardTable<Pending> {
+    if (this.table?.channel !== channel) {
+      this.table = { channel, entries: new PendingCardTable<Pending>(channel, this.deps.onError) }
+    }
+    return this.table.entries
+  }
+
+  private settle(
+    table: PendingCardTable<Pending>,
+    entry: Pending,
+    outcome: WikiConsentOutcome,
+    cardState?: WikiConsentCardState,
+  ): void {
+    const closed = table.close(entry, () => {
+      if (cardState !== undefined) table.patch(entry, buildWikiConsentSettledCard(entry.question, cardState))
+    })
+    if (closed) entry.resolve(outcome)
+  }
+}

package/src/feishu/wiki/links.ts

@@ -0,0 +1,122 @@
+/**
+ * Feishu wiki (知识库) link parsing: the `wikiRoots` allow-list entries and
+ * the document references the model passes to the wiki tools.
+ *
+ * Pure module: no I/O. Hosts are not checked because tenants use their own
+ * subdomains (`<tenant>.feishu.cn`) and the API never uses the link host.
+ *
+ * @module dsh-channels/feishu/wiki/links
+ */
+
+/** Feishu wiki space id: decimal digits. */
+const SPACE_ID_PATTERN = /^\d{1,32}$/u
+
+/** Feishu wiki node / docx token: letters and digits. */
+const TOKEN_PATTERN = /^[A-Za-z0-9]{8,64}$/u
+
+/** One configured `wikiRoots` entry. */
+export type WikiRoot =
+  | {
+    /** A whole wiki space (`/wiki/space/<space_id>`). */
+    readonly kind: 'space'
+    readonly spaceId: string
+    /** The link as configured. */
+    readonly link: string
+  }
+  | {
+    /** One wiki node and every node below it (`/wiki/<node_token>`). */
+    readonly kind: 'node'
+    readonly nodeToken: string
+    /** The link as configured. */
+    readonly link: string
+  }
+
+/** Why a `wikiRoots` entry was rejected. */
+export type WikiRootLinkError =
+  | 'not-a-url'
+  | 'not-https'
+  | 'not-a-wiki-link'
+
+/** Readable reasons for {@link WikiRootLinkError}. */
+export const WIKI_ROOT_LINK_ERRORS: Readonly<Record<WikiRootLinkError, string>> = {
+  'not-a-url': '不是有效的链接',
+  'not-https': '必须是 https 链接',
+  'not-a-wiki-link': '只支持知识空间链接 https://<租户>.feishu.cn/wiki/space/<space_id> 或节点链接 https://<租户>.feishu.cn/wiki/<node_token>',
+}
+
+/**
+ * Parse one `wikiRoots` entry.
+ *
+ * @param link Link as configured (surrounding whitespace is ignored).
+ * @returns The root, or the reason it is invalid.
+ */
+export function parseWikiRootLink(link: string): { ok: true; root: WikiRoot } | { ok: false; error: WikiRootLinkError } {
+  const trimmed = link.trim()
+  let url: URL
+  try {
+    url = new URL(trimmed)
+  } catch {
+    // Unparseable input: reported as a configuration error below.
+    return { ok: false, error: 'not-a-url' }
+  }
+  if (url.protocol !== 'https:') return { ok: false, error: 'not-https' }
+  const segments = url.pathname.split('/').filter(segment => segment !== '')
+  if (segments[0] !== 'wiki') return { ok: false, error: 'not-a-wiki-link' }
+  if (segments.length === 3 && segments[1] === 'space' && SPACE_ID_PATTERN.test(segments[2]!)) {
+    return { ok: true, root: { kind: 'space', spaceId: segments[2]!, link: trimmed } }
+  }
+  if (segments.length === 2 && segments[1] !== 'space' && TOKEN_PATTERN.test(segments[1]!)) {
+    return { ok: true, root: { kind: 'node', nodeToken: segments[1]!, link: trimmed } }
+  }
+  return { ok: false, error: 'not-a-wiki-link' }
+}
+
+/**
+ * Parse every configured root. Callers validate the config first, so an
+ * invalid entry here is a programming error.
+ *
+ * @param links Validated `wikiRoots` entries.
+ * @returns The parsed roots, in configuration order.
+ */
+export function parseWikiRoots(links: readonly string[]): WikiRoot[] {
+  return links.map((link) => {
+    const parsed = parseWikiRootLink(link)
+    if (!parsed.ok) throw new Error(`dsh-channels: invalid wikiRoots entry ${link}: ${WIKI_ROOT_LINK_ERRORS[parsed.error]}`)
+    return parsed.root
+  })
+}
+
+/** A document or node the model names: a wiki node, a docx, or a whole space. */
+export type WikiRef =
+  | { readonly kind: 'node'; readonly token: string }
+  | { readonly kind: 'docx'; readonly token: string }
+  | { readonly kind: 'space'; readonly spaceId: string }
+
+/**
+ * Parse a model-supplied reference: a wiki node link, a docx link, a space
+ * link, or a bare node token.
+ *
+ * @param input Raw tool argument.
+ * @returns The reference, or `undefined` when it names nothing recognizable.
+ */
+export function parseWikiRef(input: string): WikiRef | undefined {
+  const trimmed = input.trim()
+  if (TOKEN_PATTERN.test(trimmed)) return { kind: 'node', token: trimmed }
+  let url: URL
+  try {
+    url = new URL(trimmed)
+  } catch {
+    // Neither a token nor a URL.
+    return undefined
+  }
+  if (url.protocol !== 'https:') return undefined
+  const segments = url.pathname.split('/').filter(segment => segment !== '')
+  if (segments[0] === 'wiki' && segments.length === 3 && segments[1] === 'space' && SPACE_ID_PATTERN.test(segments[2]!)) {
+    return { kind: 'space', spaceId: segments[2]! }
+  }
+  if (segments.length === 2 && TOKEN_PATTERN.test(segments[1]!)) {
+    if (segments[0] === 'wiki' && segments[1] !== 'space') return { kind: 'node', token: segments[1]! }
+    if (segments[0] === 'docx') return { kind: 'docx', token: segments[1]! }
+  }
+  return undefined
+}

package/src/feishu/wiki/scope.ts

@@ -0,0 +1,66 @@
+/**
+ * `wikiRoots` containment: decides whether a wiki node lies inside one of the
+ * configured roots before any wiki tool touches it.
+ *
+ * A space root contains every node of that space. A node root contains
+ * itself and its descendants; descent is checked by walking the node's
+ * parent chain with `spaces/get_node`, bounded by {@link MAX_PARENT_DEPTH}.
+ * A node whose chain cannot be read is treated as outside (fail closed).
+ *
+ * @module dsh-channels/feishu/wiki/scope
+ */
+
+import type { WikiApi, WikiNode } from './api.ts'
+import type { WikiRoot } from './links.ts'
+
+/**
+ * Longest parent chain walked for a node root. Feishu limits wiki depth well
+ * below this; a longer chain is treated as outside.
+ */
+const MAX_PARENT_DEPTH = 64
+
+/** The root a node was found under. */
+export interface WikiContainment {
+  readonly root: WikiRoot
+}
+
+/**
+ * Find the configured root containing `node`.
+ *
+ * @param api Wiki endpoints (for parent lookups).
+ * @param roots Configured roots.
+ * @param node The node to check.
+ * @returns The containing root, or `undefined` when none contains it.
+ */
+export async function containingRoot(
+  api: WikiApi,
+  roots: readonly WikiRoot[],
+  node: WikiNode,
+): Promise<WikiContainment | undefined> {
+  for (const root of roots) {
+    if (root.kind === 'space' && root.spaceId === node.spaceId) return { root }
+  }
+  const nodeRoots = roots.filter((root): root is Extract<WikiRoot, { kind: 'node' }> => root.kind === 'node')
+  if (nodeRoots.length === 0) return undefined
+  const byToken = new Map(nodeRoots.map(root => [root.nodeToken, root]))
+  let current: WikiNode = node
+  for (let depth = 0; depth <= MAX_PARENT_DEPTH; depth += 1) {
+    const match = byToken.get(current.nodeToken)
+    if (match !== undefined) return { root: match }
+    if (current.parentNodeToken === undefined) return undefined
+    current = await api.getNode(current.parentNodeToken, 'wiki')
+  }
+  return undefined
+}
+
+/**
+ * Whether a whole space (its top level) is inside the roots: only a space
+ * root covers a space's top level.
+ *
+ * @param roots Configured roots.
+ * @param spaceId The space.
+ * @returns True when a space root names it.
+ */
+export function spaceIsRoot(roots: readonly WikiRoot[], spaceId: string): boolean {
+  return roots.some(root => root.kind === 'space' && root.spaceId === spaceId)
+}