@ecsplico/editor 1.0.0 → 2.1.0

package/dist/adapters/comments/drizzle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"drizzle.js","names":[],"sources":["../../../src/adapters/comments/drizzle.ts"],"sourcesContent":["import { and, eq, type SQL, sql } from 'drizzle-orm'\nimport { integer, primaryKey, type SQLiteColumn, type SQLiteTable, sqliteTable, text } from 'drizzle-orm/sqlite-core'\nimport type { PortableAnchor } from '../anchors'\nimport type { EditorDb } from '../drizzle'\nimport { conflict, invalid, notFound } from './errors'\nimport { assertNewThread } from './record'\nimport type { Annotation, Comment, CommentStore, CommentThread, Discussion } from './types'\n\nconst COMMENT_TABLES = {\n  annotations: sqliteTable('editor_comment_annotations', {\n    documentId: text('document_id').notNull(),\n    id: text('id').notNull(),\n    threadId: text('thread_id').notNull(),\n    seq: integer('seq').notNull(),\n    anchor: text('anchor', { mode: 'json' }).$type<PortableAnchor>().notNull(),\n  }, table => [primaryKey({ columns: [table.documentId, table.id] })]),\n  threads: sqliteTable('editor_comment_threads', {\n    documentId: text('document_id').notNull(),\n    id: text('id').notNull(),\n    annotationId: text('annotation_id').notNull(),\n    status: text('status', { enum: ['open', 'resolved'] }).notNull(),\n    seq: integer('seq').notNull(),\n  }, table => [primaryKey({ columns: [table.documentId, table.id] })]),\n  comments: sqliteTable('editor_comments', {\n    documentId: text('document_id').notNull(),\n    threadId: text('thread_id').notNull(),\n    id: text('id').notNull(),\n    seq: integer('seq').notNull(),\n    body: text('body').notNull(),\n    authorId: text('author_id').notNull(),\n    authorName: text('author_name'),\n    authorColor: text('author_color'),\n    createdAt: text('created_at').notNull(),\n    editedAt: text('edited_at'),\n  }, table => [primaryKey({ columns: [table.documentId, table.threadId, table.id] })]),\n}\n\nexport type CommentTables = typeof COMMENT_TABLES\n\n/**\n * The tables of the comment store in a SQLite database:\n *\n *     editor_comment_annotations(document_id, id, thread_id, seq, anchor json; PK (document_id, id))\n *     editor_comment_threads(document_id, id, annotation_id, status, seq; PK (document_id, id))\n *     editor_comments(document_id, thread_id, id, seq, body, author_id, author_name?, author_color?, created_at, edited_at?; PK (document_id, thread_id, id))\n *\n * `seq` orders rows within their document (annotations, threads) or thread (comments). Call it from the host's drizzle\n * schema (so `drizzle-kit` migrates the tables) or use `bootstrapCommentTables` in a host without migrations.\n */\nexport const commentTables = (): CommentTables => COMMENT_TABLES\n\n/** `CREATE TABLE IF NOT EXISTS` for the tables of `commentTables()`. */\nexport async function bootstrapCommentTables(db: EditorDb): Promise<void> {\n  await db.run(sql`CREATE TABLE IF NOT EXISTS editor_comment_annotations (document_id text NOT NULL, id text NOT NULL, thread_id text NOT NULL, seq integer NOT NULL, anchor text NOT NULL, PRIMARY KEY (document_id, id))`)\n  await db.run(sql`CREATE TABLE IF NOT EXISTS editor_comment_threads (document_id text NOT NULL, id text NOT NULL, annotation_id text NOT NULL, status text NOT NULL, seq integer NOT NULL, PRIMARY KEY (document_id, id))`)\n  await db.run(sql`CREATE TABLE IF NOT EXISTS editor_comments (document_id text NOT NULL, thread_id text NOT NULL, id text NOT NULL, seq integer NOT NULL, body text NOT NULL, author_id text NOT NULL, author_name text, author_color text, created_at text NOT NULL, edited_at text, PRIMARY KEY (document_id, thread_id, id))`)\n}\n\nexport interface DrizzleCommentStoreOptions {\n  db: EditorDb\n  tables: CommentTables\n}\n\n/** Writers on one database of one process run one after another: SQLite has one writer, and each operation is several statements. */\nconst queues = new WeakMap<object, Promise<unknown>>()\n\nfunction serialized<T>(db: object, action: () => Promise<T>): Promise<T> {\n  const run = (queues.get(db) ?? Promise.resolve()).then(action)\n  const tail = run.catch(() => {})\n  queues.set(db, tail)\n  void tail.then(() => {\n    if (queues.get(db) === tail) queues.delete(db)\n  })\n  return run\n}\n\n/**\n * The comment store on drizzle tables. Operations are several single statements (no transaction, so it runs on sync and\n * async drivers) applied one after another per database; a failed `createThread` removes what it had written. A\n * unique key still protects against a second process writing the same ids. Unlike the JSON store it keeps only the\n * fields of `Comment`, `Annotation` and `CommentThread`.\n */\nexport function createDrizzleCommentStore({ db, tables }: DrizzleCommentStoreOptions): CommentStore {\n  const { annotations, threads, comments } = tables\n  type CommentRow = typeof comments.$inferSelect\n\n  const commentOf = (row: CommentRow): Comment => ({\n    id: row.id,\n    body: row.body,\n    authorId: row.authorId,\n    createdAt: row.createdAt,\n    ...(row.authorName !== null && { authorName: row.authorName }),\n    ...(row.authorColor !== null && { authorColor: row.authorColor }),\n    ...(row.editedAt !== null && { editedAt: row.editedAt }),\n  })\n\n  async function threadRow(documentId: string, id: string) {\n    return db.select().from(threads).where(and(eq(threads.documentId, documentId), eq(threads.id, id))).get()\n  }\n\n  async function threadOf(documentId: string, id: string): Promise<CommentThread | undefined> {\n    const row = await threadRow(documentId, id)\n    if (!row) return undefined\n    const rows = await db.select().from(comments).where(and(eq(comments.documentId, documentId), eq(comments.threadId, id))).orderBy(comments.seq).all()\n    return { id: row.id, annotationId: row.annotationId, status: row.status, comments: rows.map(commentOf) }\n  }\n\n  async function requireThread(documentId: string, id: string): Promise<CommentThread> {\n    const thread = await threadOf(documentId, id)\n    if (!thread) throw notFound('comment thread', id)\n    return thread\n  }\n\n  async function discussion(documentId: string): Promise<Discussion> {\n    const [annotationRows, threadRows, commentRows] = await Promise.all([\n      db.select().from(annotations).where(eq(annotations.documentId, documentId)).orderBy(annotations.seq).all(),\n      db.select().from(threads).where(eq(threads.documentId, documentId)).orderBy(threads.seq).all(),\n      db.select().from(comments).where(eq(comments.documentId, documentId)).orderBy(comments.seq).all(),\n    ])\n    return {\n      annotations: annotationRows.map(row => ({ id: row.id, threadId: row.threadId, anchor: row.anchor })),\n      threads: threadRows.map(row => ({\n        id: row.id,\n        annotationId: row.annotationId,\n        status: row.status,\n        comments: commentRows.filter(comment => comment.threadId === row.id).map(commentOf),\n      })),\n    }\n  }\n\n  const nextSeq = async (column: SQLiteColumn, table: SQLiteTable, where: SQL | undefined): Promise<number> => {\n    const row = await db.select({ value: sql<number>`coalesce(max(${column}), 0)` }).from(table).where(where).get()\n    return (row?.value ?? 0) + 1\n  }\n\n  const insertComment = async (documentId: string, threadId: string, comment: Comment) => {\n    await db.insert(comments).values({\n      documentId,\n      threadId,\n      id: comment.id,\n      seq: await nextSeq(comments.seq, comments, and(eq(comments.documentId, documentId), eq(comments.threadId, threadId))),\n      body: comment.body,\n      authorId: comment.authorId,\n      authorName: comment.authorName ?? null,\n      authorColor: comment.authorColor ?? null,\n      createdAt: comment.createdAt,\n      editedAt: comment.editedAt ?? null,\n    }).run()\n  }\n\n  const write = <T>(action: () => Promise<T>) => serialized(db, action)\n\n  return {\n    getDiscussion: discussion,\n    getThread: (documentId, threadId) => threadOf(documentId, threadId),\n    async listThreads(documentId) {\n      return (await discussion(documentId)).threads\n    },\n\n    createThread: (documentId, input) => write(async () => {\n      assertNewThread(input)\n      const { annotation, thread } = input\n      if (await db.select({ id: annotations.id }).from(annotations).where(and(eq(annotations.documentId, documentId), eq(annotations.id, annotation.id))).get()) throw conflict(`Annotation \"${annotation.id}\" already exists.`)\n      if (await threadRow(documentId, thread.id)) throw conflict(`Comment thread \"${thread.id}\" already exists.`)\n      try {\n        await db.insert(annotations).values({\n          documentId,\n          id: annotation.id,\n          threadId: annotation.threadId,\n          seq: await nextSeq(annotations.seq, annotations, eq(annotations.documentId, documentId)),\n          anchor: annotation.anchor,\n        }).run()\n        await db.insert(threads).values({\n          documentId,\n          id: thread.id,\n          annotationId: thread.annotationId,\n          status: 'open',\n          seq: await nextSeq(threads.seq, threads, eq(threads.documentId, documentId)),\n        }).run()\n        await insertComment(documentId, thread.id, thread.initialComment)\n      }\n      catch (error) {\n        await db.delete(comments).where(and(eq(comments.documentId, documentId), eq(comments.threadId, thread.id))).run()\n        await db.delete(threads).where(and(eq(threads.documentId, documentId), eq(threads.id, thread.id))).run()\n        await db.delete(annotations).where(and(eq(annotations.documentId, documentId), eq(annotations.id, annotation.id))).run()\n        throw error\n      }\n      return { annotation: structuredClone(annotation), thread: await requireThread(documentId, thread.id) }\n    }),\n\n    addComment: (documentId, threadId, comment) => write(async () => {\n      await requireThread(documentId, threadId)\n      if (await db.select({ id: comments.id }).from(comments).where(and(eq(comments.documentId, documentId), eq(comments.threadId, threadId), eq(comments.id, comment.id))).get()) {\n        throw conflict(`Comment \"${comment.id}\" already exists in thread \"${threadId}\".`)\n      }\n      await insertComment(documentId, threadId, comment)\n      return requireThread(documentId, threadId)\n    }),\n\n    editComment: (documentId, threadId, commentId, body, editedAt) => write(async () => {\n      const thread = await requireThread(documentId, threadId)\n      if (!thread.comments.some(comment => comment.id === commentId)) throw notFound('comment', commentId)\n      await db.update(comments).set({ body, editedAt }).where(and(eq(comments.documentId, documentId), eq(comments.threadId, threadId), eq(comments.id, commentId))).run()\n      return requireThread(documentId, threadId)\n    }),\n\n    removeComment: (documentId, threadId, commentId) => write(async () => {\n      const thread = await requireThread(documentId, threadId)\n      const index = thread.comments.findIndex(comment => comment.id === commentId)\n      if (index < 0) throw notFound('comment', commentId)\n      if (index === 0) throw invalid('The first comment of a thread cannot be removed on its own; remove the thread.')\n      await db.delete(comments).where(and(eq(comments.documentId, documentId), eq(comments.threadId, threadId), eq(comments.id, commentId))).run()\n      return requireThread(documentId, threadId)\n    }),\n\n    setThreadStatus: (documentId, threadId, status) => write(async () => {\n      await requireThread(documentId, threadId)\n      await db.update(threads).set({ status }).where(and(eq(threads.documentId, documentId), eq(threads.id, threadId))).run()\n      return requireThread(documentId, threadId)\n    }),\n\n    updateAnchor: (documentId, annotation: Annotation) => write(async () => {\n      const row = await db.select().from(annotations).where(and(eq(annotations.documentId, documentId), eq(annotations.id, annotation.id))).get()\n      if (!row) throw notFound('annotation', annotation.id)\n      if (row.threadId !== annotation.threadId) throw invalid('An annotation cannot move to another thread.')\n      await db.update(annotations).set({ anchor: annotation.anchor }).where(and(eq(annotations.documentId, documentId), eq(annotations.id, annotation.id))).run()\n      return structuredClone(annotation)\n    }),\n\n    removeThread: (documentId, threadId) => write(async () => {\n      await db.delete(comments).where(and(eq(comments.documentId, documentId), eq(comments.threadId, threadId))).run()\n      await db.delete(threads).where(and(eq(threads.documentId, documentId), eq(threads.id, threadId))).run()\n      await db.delete(annotations).where(and(eq(annotations.documentId, documentId), eq(annotations.threadId, threadId))).run()\n    }),\n\n    removeDocuments: prefix => write(async () => {\n      const under = (column: { name: string }) => sql`substr(${sql.identifier(column.name)}, 1, ${prefix.length}) = ${prefix}`\n      const documents = new Set<string>()\n      for (const [table, column] of [[annotations, annotations.documentId], [threads, threads.documentId], [comments, comments.documentId]] as const) {\n        for (const row of await db.selectDistinct({ documentId: column }).from(table).where(under(column)).all()) documents.add(row.documentId)\n      }\n      for (const [table, column] of [[comments, comments.documentId], [threads, threads.documentId], [annotations, annotations.documentId]] as const) {\n        await db.delete(table).where(under(column)).run()\n      }\n      return documents.size\n    }),\n  }\n}\n"],"mappings":";;;;;AAQA,MAAM,iBAAiB;CACrB,aAAa,YAAY,8BAA8B;EACrD,YAAY,KAAK,aAAa,CAAC,CAAC,QAAQ;EACxC,IAAI,KAAK,IAAI,CAAC,CAAC,QAAQ;EACvB,UAAU,KAAK,WAAW,CAAC,CAAC,QAAQ;EACpC,KAAK,QAAQ,KAAK,CAAC,CAAC,QAAQ;EAC5B,QAAQ,KAAK,UAAU,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,MAAsB,CAAC,CAAC,QAAQ;CAC3E,IAAG,UAAS,CAAC,WAAW,EAAE,SAAS,CAAC,MAAM,YAAY,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;CACnE,SAAS,YAAY,0BAA0B;EAC7C,YAAY,KAAK,aAAa,CAAC,CAAC,QAAQ;EACxC,IAAI,KAAK,IAAI,CAAC,CAAC,QAAQ;EACvB,cAAc,KAAK,eAAe,CAAC,CAAC,QAAQ;EAC5C,QAAQ,KAAK,UAAU,EAAE,MAAM,CAAC,QAAQ,UAAU,EAAE,CAAC,CAAC,CAAC,QAAQ;EAC/D,KAAK,QAAQ,KAAK,CAAC,CAAC,QAAQ;CAC9B,IAAG,UAAS,CAAC,WAAW,EAAE,SAAS,CAAC,MAAM,YAAY,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;CACnE,UAAU,YAAY,mBAAmB;EACvC,YAAY,KAAK,aAAa,CAAC,CAAC,QAAQ;EACxC,UAAU,KAAK,WAAW,CAAC,CAAC,QAAQ;EACpC,IAAI,KAAK,IAAI,CAAC,CAAC,QAAQ;EACvB,KAAK,QAAQ,KAAK,CAAC,CAAC,QAAQ;EAC5B,MAAM,KAAK,MAAM,CAAC,CAAC,QAAQ;EAC3B,UAAU,KAAK,WAAW,CAAC,CAAC,QAAQ;EACpC,YAAY,KAAK,aAAa;EAC9B,aAAa,KAAK,cAAc;EAChC,WAAW,KAAK,YAAY,CAAC,CAAC,QAAQ;EACtC,UAAU,KAAK,WAAW;CAC5B,IAAG,UAAS,CAAC,WAAW,EAAE,SAAS;EAAC,MAAM;EAAY,MAAM;EAAU,MAAM;CAAE,EAAE,CAAC,CAAC,CAAC;AACrF;;;;;;;;;;;AAcA,MAAa,sBAAqC;;AAGlD,eAAsB,uBAAuB,IAA6B;CACxE,MAAM,GAAG,IAAI,GAAG,yMAAyM;CACzN,MAAM,GAAG,IAAI,GAAG,yMAAyM;CACzN,MAAM,GAAG,IAAI,GAAG,+SAA+S;AACjU;;AAQA,MAAM,yBAAS,IAAI,QAAkC;AAErD,SAAS,WAAc,IAAY,QAAsC;CACvE,MAAM,OAAO,OAAO,IAAI,EAAE,KAAK,QAAQ,QAAQ,EAAA,CAAG,KAAK,MAAM;CAC7D,MAAM,OAAO,IAAI,YAAY,CAAC,CAAC;CAC/B,OAAO,IAAI,IAAI,IAAI;CACnB,KAAU,WAAW;EACnB,IAAI,OAAO,IAAI,EAAE,MAAM,MAAM,OAAO,OAAO,EAAE;CAC/C,CAAC;CACD,OAAO;AACT;;;;;;;AAQA,SAAgB,0BAA0B,EAAE,IAAI,UAAoD;CAClG,MAAM,EAAE,aAAa,SAAS,aAAa;CAG3C,MAAM,aAAa,SAA8B;EAC/C,IAAI,IAAI;EACR,MAAM,IAAI;EACV,UAAU,IAAI;EACd,WAAW,IAAI;EACf,GAAI,IAAI,eAAe,QAAQ,EAAE,YAAY,IAAI,WAAW;EAC5D,GAAI,IAAI,gBAAgB,QAAQ,EAAE,aAAa,IAAI,YAAY;EAC/D,GAAI,IAAI,aAAa,QAAQ,EAAE,UAAU,IAAI,SAAS;CACxD;CAEA,eAAe,UAAU,YAAoB,IAAY;EACvD,OAAO,GAAG,OAAO,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,MAAM,IAAI,GAAG,QAAQ,YAAY,UAAU,GAAG,GAAG,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI;CAC1G;CAEA,eAAe,SAAS,YAAoB,IAAgD;EAC1F,MAAM,MAAM,MAAM,UAAU,YAAY,EAAE;EAC1C,IAAI,CAAC,KAAK,OAAO,KAAA;EACjB,MAAM,OAAO,MAAM,GAAG,OAAO,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,MAAM,IAAI,GAAG,SAAS,YAAY,UAAU,GAAG,GAAG,SAAS,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,SAAS,GAAG,CAAC,CAAC,IAAI;EACnJ,OAAO;GAAE,IAAI,IAAI;GAAI,cAAc,IAAI;GAAc,QAAQ,IAAI;GAAQ,UAAU,KAAK,IAAI,SAAS;EAAE;CACzG;CAEA,eAAe,cAAc,YAAoB,IAAoC;EACnF,MAAM,SAAS,MAAM,SAAS,YAAY,EAAE;EAC5C,IAAI,CAAC,QAAQ,MAAM,SAAS,kBAAkB,EAAE;EAChD,OAAO;CACT;CAEA,eAAe,WAAW,YAAyC;EACjE,MAAM,CAAC,gBAAgB,YAAY,eAAe,MAAM,QAAQ,IAAI;GAClE,GAAG,OAAO,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC,MAAM,GAAG,YAAY,YAAY,UAAU,CAAC,CAAC,CAAC,QAAQ,YAAY,GAAG,CAAC,CAAC,IAAI;GACzG,GAAG,OAAO,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,MAAM,GAAG,QAAQ,YAAY,UAAU,CAAC,CAAC,CAAC,QAAQ,QAAQ,GAAG,CAAC,CAAC,IAAI;GAC7F,GAAG,OAAO,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,MAAM,GAAG,SAAS,YAAY,UAAU,CAAC,CAAC,CAAC,QAAQ,SAAS,GAAG,CAAC,CAAC,IAAI;EAClG,CAAC;EACD,OAAO;GACL,aAAa,eAAe,KAAI,SAAQ;IAAE,IAAI,IAAI;IAAI,UAAU,IAAI;IAAU,QAAQ,IAAI;GAAO,EAAE;GACnG,SAAS,WAAW,KAAI,SAAQ;IAC9B,IAAI,IAAI;IACR,cAAc,IAAI;IAClB,QAAQ,IAAI;IACZ,UAAU,YAAY,QAAO,YAAW,QAAQ,aAAa,IAAI,EAAE,CAAC,CAAC,IAAI,SAAS;GACpF,EAAE;EACJ;CACF;CAEA,MAAM,UAAU,OAAO,QAAsB,OAAoB,UAA4C;EAE3G,SAAQ,MADU,GAAG,OAAO,EAAE,OAAO,GAAW,gBAAgB,OAAO,OAAO,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,IAAI,EAAA,EACjG,SAAS,KAAK;CAC7B;CAEA,MAAM,gBAAgB,OAAO,YAAoB,UAAkB,YAAqB;EACtF,MAAM,GAAG,OAAO,QAAQ,CAAC,CAAC,OAAO;GAC/B;GACA;GACA,IAAI,QAAQ;GACZ,KAAK,MAAM,QAAQ,SAAS,KAAK,UAAU,IAAI,GAAG,SAAS,YAAY,UAAU,GAAG,GAAG,SAAS,UAAU,QAAQ,CAAC,CAAC;GACpH,MAAM,QAAQ;GACd,UAAU,QAAQ;GAClB,YAAY,QAAQ,cAAc;GAClC,aAAa,QAAQ,eAAe;GACpC,WAAW,QAAQ;GACnB,UAAU,QAAQ,YAAY;EAChC,CAAC,CAAC,CAAC,IAAI;CACT;CAEA,MAAM,SAAY,WAA6B,WAAW,IAAI,MAAM;CAEpE,OAAO;EACL,eAAe;EACf,YAAY,YAAY,aAAa,SAAS,YAAY,QAAQ;EAClE,MAAM,YAAY,YAAY;GAC5B,QAAQ,MAAM,WAAW,UAAU,EAAA,CAAG;EACxC;EAEA,eAAe,YAAY,UAAU,MAAM,YAAY;GACrD,gBAAgB,KAAK;GACrB,MAAM,EAAE,YAAY,WAAW;GAC/B,IAAI,MAAM,GAAG,OAAO,EAAE,IAAI,YAAY,GAAG,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC,MAAM,IAAI,GAAG,YAAY,YAAY,UAAU,GAAG,GAAG,YAAY,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,MAAM,SAAS,eAAe,WAAW,GAAG,kBAAkB;GACzN,IAAI,MAAM,UAAU,YAAY,OAAO,EAAE,GAAG,MAAM,SAAS,mBAAmB,OAAO,GAAG,kBAAkB;GAC1G,IAAI;IACF,MAAM,GAAG,OAAO,WAAW,CAAC,CAAC,OAAO;KAClC;KACA,IAAI,WAAW;KACf,UAAU,WAAW;KACrB,KAAK,MAAM,QAAQ,YAAY,KAAK,aAAa,GAAG,YAAY,YAAY,UAAU,CAAC;KACvF,QAAQ,WAAW;IACrB,CAAC,CAAC,CAAC,IAAI;IACP,MAAM,GAAG,OAAO,OAAO,CAAC,CAAC,OAAO;KAC9B;KACA,IAAI,OAAO;KACX,cAAc,OAAO;KACrB,QAAQ;KACR,KAAK,MAAM,QAAQ,QAAQ,KAAK,SAAS,GAAG,QAAQ,YAAY,UAAU,CAAC;IAC7E,CAAC,CAAC,CAAC,IAAI;IACP,MAAM,cAAc,YAAY,OAAO,IAAI,OAAO,cAAc;GAClE,SACO,OAAO;IACZ,MAAM,GAAG,OAAO,QAAQ,CAAC,CAAC,MAAM,IAAI,GAAG,SAAS,YAAY,UAAU,GAAG,GAAG,SAAS,UAAU,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI;IAChH,MAAM,GAAG,OAAO,OAAO,CAAC,CAAC,MAAM,IAAI,GAAG,QAAQ,YAAY,UAAU,GAAG,GAAG,QAAQ,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI;IACvG,MAAM,GAAG,OAAO,WAAW,CAAC,CAAC,MAAM,IAAI,GAAG,YAAY,YAAY,UAAU,GAAG,GAAG,YAAY,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI;IACvH,MAAM;GACR;GACA,OAAO;IAAE,YAAY,gBAAgB,UAAU;IAAG,QAAQ,MAAM,cAAc,YAAY,OAAO,EAAE;GAAE;EACvG,CAAC;EAED,aAAa,YAAY,UAAU,YAAY,MAAM,YAAY;GAC/D,MAAM,cAAc,YAAY,QAAQ;GACxC,IAAI,MAAM,GAAG,OAAO,EAAE,IAAI,SAAS,GAAG,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,MAAM,IAAI,GAAG,SAAS,YAAY,UAAU,GAAG,GAAG,SAAS,UAAU,QAAQ,GAAG,GAAG,SAAS,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,GACxK,MAAM,SAAS,YAAY,QAAQ,GAAG,8BAA8B,SAAS,GAAG;GAElF,MAAM,cAAc,YAAY,UAAU,OAAO;GACjD,OAAO,cAAc,YAAY,QAAQ;EAC3C,CAAC;EAED,cAAc,YAAY,UAAU,WAAW,MAAM,aAAa,MAAM,YAAY;GAElF,IAAI,EAAC,MADgB,cAAc,YAAY,QAAQ,EAAA,CAC3C,SAAS,MAAK,YAAW,QAAQ,OAAO,SAAS,GAAG,MAAM,SAAS,WAAW,SAAS;GACnG,MAAM,GAAG,OAAO,QAAQ,CAAC,CAAC,IAAI;IAAE;IAAM;GAAS,CAAC,CAAC,CAAC,MAAM,IAAI,GAAG,SAAS,YAAY,UAAU,GAAG,GAAG,SAAS,UAAU,QAAQ,GAAG,GAAG,SAAS,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI;GACnK,OAAO,cAAc,YAAY,QAAQ;EAC3C,CAAC;EAED,gBAAgB,YAAY,UAAU,cAAc,MAAM,YAAY;GAEpE,MAAM,SAAQ,MADO,cAAc,YAAY,QAAQ,EAAA,CAClC,SAAS,WAAU,YAAW,QAAQ,OAAO,SAAS;GAC3E,IAAI,QAAQ,GAAG,MAAM,SAAS,WAAW,SAAS;GAClD,IAAI,UAAU,GAAG,MAAM,QAAQ,gFAAgF;GAC/G,MAAM,GAAG,OAAO,QAAQ,CAAC,CAAC,MAAM,IAAI,GAAG,SAAS,YAAY,UAAU,GAAG,GAAG,SAAS,UAAU,QAAQ,GAAG,GAAG,SAAS,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI;GAC3I,OAAO,cAAc,YAAY,QAAQ;EAC3C,CAAC;EAED,kBAAkB,YAAY,UAAU,WAAW,MAAM,YAAY;GACnE,MAAM,cAAc,YAAY,QAAQ;GACxC,MAAM,GAAG,OAAO,OAAO,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,IAAI,GAAG,QAAQ,YAAY,UAAU,GAAG,GAAG,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI;GACtH,OAAO,cAAc,YAAY,QAAQ;EAC3C,CAAC;EAED,eAAe,YAAY,eAA2B,MAAM,YAAY;GACtE,MAAM,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC,MAAM,IAAI,GAAG,YAAY,YAAY,UAAU,GAAG,GAAG,YAAY,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI;GAC1I,IAAI,CAAC,KAAK,MAAM,SAAS,cAAc,WAAW,EAAE;GACpD,IAAI,IAAI,aAAa,WAAW,UAAU,MAAM,QAAQ,8CAA8C;GACtG,MAAM,GAAG,OAAO,WAAW,CAAC,CAAC,IAAI,EAAE,QAAQ,WAAW,OAAO,CAAC,CAAC,CAAC,MAAM,IAAI,GAAG,YAAY,YAAY,UAAU,GAAG,GAAG,YAAY,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI;GAC1J,OAAO,gBAAgB,UAAU;EACnC,CAAC;EAED,eAAe,YAAY,aAAa,MAAM,YAAY;GACxD,MAAM,GAAG,OAAO,QAAQ,CAAC,CAAC,MAAM,IAAI,GAAG,SAAS,YAAY,UAAU,GAAG,GAAG,SAAS,UAAU,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI;GAC/G,MAAM,GAAG,OAAO,OAAO,CAAC,CAAC,MAAM,IAAI,GAAG,QAAQ,YAAY,UAAU,GAAG,GAAG,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI;GACtG,MAAM,GAAG,OAAO,WAAW,CAAC,CAAC,MAAM,IAAI,GAAG,YAAY,YAAY,UAAU,GAAG,GAAG,YAAY,UAAU,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI;EAC1H,CAAC;EAED,kBAAiB,WAAU,MAAM,YAAY;GAC3C,MAAM,SAAS,WAA6B,GAAG,UAAU,IAAI,WAAW,OAAO,IAAI,EAAE,OAAO,OAAO,OAAO,MAAM;GAChH,MAAM,4BAAY,IAAI,IAAY;GAClC,KAAK,MAAM,CAAC,OAAO,WAAW;IAAC,CAAC,aAAa,YAAY,UAAU;IAAG,CAAC,SAAS,QAAQ,UAAU;IAAG,CAAC,UAAU,SAAS,UAAU;GAAC,GAClI,KAAK,MAAM,OAAO,MAAM,GAAG,eAAe,EAAE,YAAY,OAAO,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,MAAM,MAAM,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,UAAU,IAAI,IAAI,UAAU;GAExI,KAAK,MAAM,CAAC,OAAO,WAAW;IAAC,CAAC,UAAU,SAAS,UAAU;IAAG,CAAC,SAAS,QAAQ,UAAU;IAAG,CAAC,aAAa,YAAY,UAAU;GAAC,GAClI,MAAM,GAAG,OAAO,KAAK,CAAC,CAAC,MAAM,MAAM,MAAM,CAAC,CAAC,CAAC,IAAI;GAElD,OAAO,UAAU;EACnB,CAAC;CACH;AACF"}

package/dist/adapters/comments/errors.d.ts

@@ -0,0 +1,9 @@
+//#region src/adapters/comments/errors.d.ts
+/** A caller mistake in a comment store operation; `status` is the HTTP status `handleCommentsRequest` answers with. */
+export declare class CommentStoreError extends Error {
+  readonly code: 'not-found' | 'conflict' | 'invalid';
+  readonly status: 404 | 409 | 400;
+  constructor(message: string, code: 'not-found' | 'conflict' | 'invalid', status: 404 | 409 | 400);
+}
+//#endregion
+//# sourceMappingURL=errors.d.ts.map

package/dist/adapters/comments/errors.js

@@ -0,0 +1,19 @@
+//#region src/adapters/comments/errors.ts
+/** A caller mistake in a comment store operation; `status` is the HTTP status `handleCommentsRequest` answers with. */
+var CommentStoreError = class extends Error {
+	code;
+	status;
+	constructor(message, code, status) {
+		super(message);
+		this.code = code;
+		this.status = status;
+		this.name = "CommentStoreError";
+	}
+};
+const notFound = (what, id) => new CommentStoreError(`Unknown ${what} "${id}".`, "not-found", 404);
+const conflict = (message) => new CommentStoreError(message, "conflict", 409);
+const invalid = (message) => new CommentStoreError(message, "invalid", 400);
+//#endregion
+export { CommentStoreError, conflict, invalid, notFound };
+
+//# sourceMappingURL=errors.js.map

package/dist/adapters/comments/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","names":[],"sources":["../../../src/adapters/comments/errors.ts"],"sourcesContent":["/** A caller mistake in a comment store operation; `status` is the HTTP status `handleCommentsRequest` answers with. */\nexport class CommentStoreError extends Error {\n  constructor(message: string, readonly code: 'not-found' | 'conflict' | 'invalid', readonly status: 404 | 409 | 400) {\n    super(message)\n    this.name = 'CommentStoreError'\n  }\n}\n\nexport const notFound = (what: string, id: string) => new CommentStoreError(`Unknown ${what} \"${id}\".`, 'not-found', 404)\nexport const conflict = (message: string) => new CommentStoreError(message, 'conflict', 409)\nexport const invalid = (message: string) => new CommentStoreError(message, 'invalid', 400)\n"],"mappings":";;AACA,IAAa,oBAAb,cAAuC,MAAM;CACL;CAAqD;CAA3F,YAAY,SAAiB,MAAqD,QAAkC;EAClH,MAAM,OAAO;EADuB,KAAA,OAAA;EAAqD,KAAA,SAAA;EAEzF,KAAK,OAAO;CACd;AACF;AAEA,MAAa,YAAY,MAAc,OAAe,IAAI,kBAAkB,WAAW,KAAK,IAAI,GAAG,KAAK,aAAa,GAAG;AACxH,MAAa,YAAY,YAAoB,IAAI,kBAAkB,SAAS,YAAY,GAAG;AAC3F,MAAa,WAAW,YAAoB,IAAI,kBAAkB,SAAS,WAAW,GAAG"}

package/dist/adapters/comments/json.d.ts

@@ -0,0 +1,19 @@
+import { CommentStore } from "./types.js";
+//#region src/adapters/comments/json.d.ts
+export interface JsonCommentStoreOptions {
+  /** The one file all documents' discussions live in, e.g. `<data>/concept-discussions.json`; its directory is created on demand. */
+  file: string;
+}
+/**
+ * Comment threads in one JSON file, the layout of skaile-forge's `concept-discussions.json`:
+ *
+ *     { "<documentId>": { "annotations": [{ id, threadId, anchor }], "threads": [{ id, annotationId, status, comments }] } }
+ *
+ * written with two-space indentation and a trailing newline. Existing files load unchanged and fields this package does
+ * not know stay on the records it rewrites; a change that alters nothing does not touch the file. Every write goes
+ * through a temp file and a rename and through one queue per file, so concurrent operations (also of two stores on the
+ * same file) apply one after another. Single node only: the file is not coordinated across processes.
+ */
+export declare function createJsonCommentStore(options: JsonCommentStoreOptions): CommentStore;
+//#endregion
+//# sourceMappingURL=json.d.ts.map

package/dist/adapters/comments/json.js

@@ -0,0 +1,94 @@
+import { isMissing, writeAtomic } from "../files.js";
+import { addComment, createThread, editComment, emptyDiscussion, removeComment, removeThread, setThreadStatus, updateAnchor } from "./record.js";
+import { promises } from "node:fs";
+import path from "node:path";
+//#region src/adapters/comments/json.ts
+/** Stores of one process on one file share a queue, so two of them cannot read the same snapshot and lose one write. */
+const queues = /* @__PURE__ */ new Map();
+function serialized(file, action) {
+	const run = (queues.get(file) ?? Promise.resolve()).then(action);
+	const tail = run.catch(() => {});
+	queues.set(file, tail);
+	tail.then(() => {
+		if (queues.get(file) === tail) queues.delete(file);
+	});
+	return run;
+}
+async function read(file) {
+	let raw;
+	try {
+		raw = await promises.readFile(file, "utf8");
+	} catch (error) {
+		if (isMissing(error)) return { all: {} };
+		throw error;
+	}
+	const parsed = JSON.parse(raw);
+	if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) throw new TypeError(`@ecsplico/editor: ${file} does not hold a JSON object of discussions`);
+	return { all: parsed };
+}
+/** `record` with the two lists every operation relies on (records written by older tools may lack one). */
+function complete(record) {
+	if (!record) return void 0;
+	record.annotations ??= [];
+	record.threads ??= [];
+	return record;
+}
+/**
+* Comment threads in one JSON file, the layout of skaile-forge's `concept-discussions.json`:
+*
+*     { "<documentId>": { "annotations": [{ id, threadId, anchor }], "threads": [{ id, annotationId, status, comments }] } }
+*
+* written with two-space indentation and a trailing newline. Existing files load unchanged and fields this package does
+* not know stay on the records it rewrites; a change that alters nothing does not touch the file. Every write goes
+* through a temp file and a rename and through one queue per file, so concurrent operations (also of two stores on the
+* same file) apply one after another. Single node only: the file is not coordinated across processes.
+*/
+function createJsonCommentStore(options) {
+	const file = path.resolve(options.file);
+	/** Reads the file, runs `operation` on the document's record and writes the result back when the text changed. `create`: a document without a record gets one. */
+	function mutate(documentId, create, operation) {
+		return serialized(file, async () => {
+			const { all } = await read(file);
+			const existing = complete(all[documentId]);
+			const before = JSON.stringify(all);
+			const record = existing ?? emptyDiscussion();
+			const result = operation(record);
+			if (existing || create) all[documentId] = record;
+			if (JSON.stringify(all) !== before) await writeAtomic(file, `${JSON.stringify(all, null, 2)}\n`);
+			return structuredClone(result);
+		});
+	}
+	async function discussion(documentId) {
+		const { all } = await read(file);
+		return structuredClone(complete(all[documentId]) ?? emptyDiscussion());
+	}
+	return {
+		getDiscussion: discussion,
+		async getThread(documentId, threadId) {
+			return (await discussion(documentId)).threads.find((thread) => thread.id === threadId);
+		},
+		async listThreads(documentId) {
+			return (await discussion(documentId)).threads;
+		},
+		createThread: (documentId, input) => mutate(documentId, true, (record) => createThread(record, input)),
+		addComment: (documentId, threadId, comment) => mutate(documentId, false, (record) => addComment(record, threadId, comment)),
+		editComment: (documentId, threadId, commentId, body, editedAt) => mutate(documentId, false, (record) => editComment(record, threadId, commentId, body, editedAt)),
+		removeComment: (documentId, threadId, commentId) => mutate(documentId, false, (record) => removeComment(record, threadId, commentId)),
+		setThreadStatus: (documentId, threadId, status) => mutate(documentId, false, (record) => setThreadStatus(record, threadId, status)),
+		updateAnchor: (documentId, annotation) => mutate(documentId, false, (record) => updateAnchor(record, annotation)),
+		removeThread: (documentId, threadId) => mutate(documentId, false, (record) => removeThread(record, threadId)),
+		removeDocuments: (prefix) => serialized(file, async () => {
+			const { all } = await read(file);
+			const kept = {};
+			let removed = 0;
+			for (const [documentId, record] of Object.entries(all)) if (documentId.startsWith(prefix)) removed++;
+			else kept[documentId] = record;
+			if (removed) await writeAtomic(file, `${JSON.stringify(kept, null, 2)}\n`);
+			return removed;
+		})
+	};
+}
+//#endregion
+export { createJsonCommentStore };
+
+//# sourceMappingURL=json.js.map

package/dist/adapters/comments/json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.js","names":["fs","ops.emptyDiscussion","ops.createThread","ops.addComment","ops.editComment","ops.removeComment","ops.setThreadStatus","ops.updateAnchor","ops.removeThread"],"sources":["../../../src/adapters/comments/json.ts"],"sourcesContent":["import { promises as fs } from 'node:fs'\nimport path from 'node:path'\nimport { isMissing, writeAtomic } from '../files'\nimport * as ops from './record'\nimport type { Annotation, Comment, CommentStore, CommentThread, Discussion, NewThread, ThreadStatus } from './types'\n\nexport interface JsonCommentStoreOptions {\n  /** The one file all documents' discussions live in, e.g. `<data>/concept-discussions.json`; its directory is created on demand. */\n  file: string\n}\n\ntype Persisted = Record<string, Discussion>\n\n/** Stores of one process on one file share a queue, so two of them cannot read the same snapshot and lose one write. */\nconst queues = new Map<string, Promise<unknown>>()\n\nfunction serialized<T>(file: string, action: () => Promise<T>): Promise<T> {\n  const run = (queues.get(file) ?? Promise.resolve()).then(action)\n  const tail = run.catch(() => {})\n  queues.set(file, tail)\n  void tail.then(() => {\n    if (queues.get(file) === tail) queues.delete(file)\n  })\n  return run\n}\n\nasync function read(file: string): Promise<{ all: Persisted }> {\n  let raw: string\n  try {\n    raw = await fs.readFile(file, 'utf8')\n  }\n  catch (error) {\n    if (isMissing(error)) return { all: {} }\n    throw error\n  }\n  const parsed: unknown = JSON.parse(raw)\n  if (typeof parsed !== 'object' || parsed === null || Array.isArray(parsed)) throw new TypeError(`@ecsplico/editor: ${file} does not hold a JSON object of discussions`)\n  return { all: parsed as Persisted }\n}\n\n/** `record` with the two lists every operation relies on (records written by older tools may lack one). */\nfunction complete(record: Discussion | undefined): Discussion | undefined {\n  if (!record) return undefined\n  record.annotations ??= []\n  record.threads ??= []\n  return record\n}\n\n/**\n * Comment threads in one JSON file, the layout of skaile-forge's `concept-discussions.json`:\n *\n *     { \"<documentId>\": { \"annotations\": [{ id, threadId, anchor }], \"threads\": [{ id, annotationId, status, comments }] } }\n *\n * written with two-space indentation and a trailing newline. Existing files load unchanged and fields this package does\n * not know stay on the records it rewrites; a change that alters nothing does not touch the file. Every write goes\n * through a temp file and a rename and through one queue per file, so concurrent operations (also of two stores on the\n * same file) apply one after another. Single node only: the file is not coordinated across processes.\n */\nexport function createJsonCommentStore(options: JsonCommentStoreOptions): CommentStore {\n  const file = path.resolve(options.file)\n\n  /** Reads the file, runs `operation` on the document's record and writes the result back when the text changed. `create`: a document without a record gets one. */\n  function mutate<T>(documentId: string, create: boolean, operation: (record: Discussion) => T): Promise<T> {\n    return serialized(file, async () => {\n      const { all } = await read(file)\n      const existing = complete(all[documentId])\n      const before = JSON.stringify(all)\n      const record = existing ?? ops.emptyDiscussion()\n      const result = operation(record)\n      if (existing || create) all[documentId] = record\n      if (JSON.stringify(all) !== before) await writeAtomic(file, `${JSON.stringify(all, null, 2)}\\n`)\n      return structuredClone(result)\n    })\n  }\n\n  async function discussion(documentId: string): Promise<Discussion> {\n    const { all } = await read(file)\n    return structuredClone(complete(all[documentId]) ?? ops.emptyDiscussion())\n  }\n\n  return {\n    getDiscussion: discussion,\n    async getThread(documentId, threadId) {\n      return (await discussion(documentId)).threads.find(thread => thread.id === threadId)\n    },\n    async listThreads(documentId) {\n      return (await discussion(documentId)).threads\n    },\n    createThread: (documentId: string, input: NewThread) => mutate(documentId, true, record => ops.createThread(record, input)),\n    addComment: (documentId: string, threadId: string, comment: Comment): Promise<CommentThread> => mutate(documentId, false, record => ops.addComment(record, threadId, comment)),\n    editComment: (documentId, threadId, commentId, body, editedAt) => mutate(documentId, false, record => ops.editComment(record, threadId, commentId, body, editedAt)),\n    removeComment: (documentId, threadId, commentId) => mutate(documentId, false, record => ops.removeComment(record, threadId, commentId)),\n    setThreadStatus: (documentId: string, threadId: string, status: ThreadStatus) => mutate(documentId, false, record => ops.setThreadStatus(record, threadId, status)),\n    updateAnchor: (documentId: string, annotation: Annotation) => mutate(documentId, false, record => ops.updateAnchor(record, annotation)),\n    removeThread: (documentId, threadId) => mutate(documentId, false, record => ops.removeThread(record, threadId)),\n    removeDocuments: prefix => serialized(file, async () => {\n      const { all } = await read(file)\n      const kept: Persisted = {}\n      let removed = 0\n      for (const [documentId, record] of Object.entries(all)) {\n        if (documentId.startsWith(prefix)) removed++\n        else kept[documentId] = record\n      }\n      if (removed) await writeAtomic(file, `${JSON.stringify(kept, null, 2)}\\n`)\n      return removed\n    }),\n  }\n}\n"],"mappings":";;;;;;AAcA,MAAM,yBAAS,IAAI,IAA8B;AAEjD,SAAS,WAAc,MAAc,QAAsC;CACzE,MAAM,OAAO,OAAO,IAAI,IAAI,KAAK,QAAQ,QAAQ,EAAA,CAAG,KAAK,MAAM;CAC/D,MAAM,OAAO,IAAI,YAAY,CAAC,CAAC;CAC/B,OAAO,IAAI,MAAM,IAAI;CACrB,KAAU,WAAW;EACnB,IAAI,OAAO,IAAI,IAAI,MAAM,MAAM,OAAO,OAAO,IAAI;CACnD,CAAC;CACD,OAAO;AACT;AAEA,eAAe,KAAK,MAA2C;CAC7D,IAAI;CACJ,IAAI;EACF,MAAM,MAAMA,SAAG,SAAS,MAAM,MAAM;CACtC,SACO,OAAO;EACZ,IAAI,UAAU,KAAK,GAAG,OAAO,EAAE,KAAK,CAAC,EAAE;EACvC,MAAM;CACR;CACA,MAAM,SAAkB,KAAK,MAAM,GAAG;CACtC,IAAI,OAAO,WAAW,YAAY,WAAW,QAAQ,MAAM,QAAQ,MAAM,GAAG,MAAM,IAAI,UAAU,qBAAqB,KAAK,4CAA4C;CACtK,OAAO,EAAE,KAAK,OAAoB;AACpC;;AAGA,SAAS,SAAS,QAAwD;CACxE,IAAI,CAAC,QAAQ,OAAO,KAAA;CACpB,OAAO,gBAAgB,CAAC;CACxB,OAAO,YAAY,CAAC;CACpB,OAAO;AACT;;;;;;;;;;;AAYA,SAAgB,uBAAuB,SAAgD;CACrF,MAAM,OAAO,KAAK,QAAQ,QAAQ,IAAI;;CAGtC,SAAS,OAAU,YAAoB,QAAiB,WAAkD;EACxG,OAAO,WAAW,MAAM,YAAY;GAClC,MAAM,EAAE,QAAQ,MAAM,KAAK,IAAI;GAC/B,MAAM,WAAW,SAAS,IAAI,WAAW;GACzC,MAAM,SAAS,KAAK,UAAU,GAAG;GACjC,MAAM,SAAS,YAAYC,gBAAoB;GAC/C,MAAM,SAAS,UAAU,MAAM;GAC/B,IAAI,YAAY,QAAQ,IAAI,cAAc;GAC1C,IAAI,KAAK,UAAU,GAAG,MAAM,QAAQ,MAAM,YAAY,MAAM,GAAG,KAAK,UAAU,KAAK,MAAM,CAAC,EAAE,GAAG;GAC/F,OAAO,gBAAgB,MAAM;EAC/B,CAAC;CACH;CAEA,eAAe,WAAW,YAAyC;EACjE,MAAM,EAAE,QAAQ,MAAM,KAAK,IAAI;EAC/B,OAAO,gBAAgB,SAAS,IAAI,WAAW,KAAKA,gBAAoB,CAAC;CAC3E;CAEA,OAAO;EACL,eAAe;EACf,MAAM,UAAU,YAAY,UAAU;GACpC,QAAQ,MAAM,WAAW,UAAU,EAAA,CAAG,QAAQ,MAAK,WAAU,OAAO,OAAO,QAAQ;EACrF;EACA,MAAM,YAAY,YAAY;GAC5B,QAAQ,MAAM,WAAW,UAAU,EAAA,CAAG;EACxC;EACA,eAAe,YAAoB,UAAqB,OAAO,YAAY,OAAM,WAAUC,aAAiB,QAAQ,KAAK,CAAC;EAC1H,aAAa,YAAoB,UAAkB,YAA6C,OAAO,YAAY,QAAO,WAAUC,WAAe,QAAQ,UAAU,OAAO,CAAC;EAC7K,cAAc,YAAY,UAAU,WAAW,MAAM,aAAa,OAAO,YAAY,QAAO,WAAUC,YAAgB,QAAQ,UAAU,WAAW,MAAM,QAAQ,CAAC;EAClK,gBAAgB,YAAY,UAAU,cAAc,OAAO,YAAY,QAAO,WAAUC,cAAkB,QAAQ,UAAU,SAAS,CAAC;EACtI,kBAAkB,YAAoB,UAAkB,WAAyB,OAAO,YAAY,QAAO,WAAUC,gBAAoB,QAAQ,UAAU,MAAM,CAAC;EAClK,eAAe,YAAoB,eAA2B,OAAO,YAAY,QAAO,WAAUC,aAAiB,QAAQ,UAAU,CAAC;EACtI,eAAe,YAAY,aAAa,OAAO,YAAY,QAAO,WAAUC,aAAiB,QAAQ,QAAQ,CAAC;EAC9G,kBAAiB,WAAU,WAAW,MAAM,YAAY;GACtD,MAAM,EAAE,QAAQ,MAAM,KAAK,IAAI;GAC/B,MAAM,OAAkB,CAAC;GACzB,IAAI,UAAU;GACd,KAAK,MAAM,CAAC,YAAY,WAAW,OAAO,QAAQ,GAAG,GACnD,IAAI,WAAW,WAAW,MAAM,GAAG;QAC9B,KAAK,cAAc;GAE1B,IAAI,SAAS,MAAM,YAAY,MAAM,GAAG,KAAK,UAAU,MAAM,MAAM,CAAC,EAAE,GAAG;GACzE,OAAO;EACT,CAAC;CACH;AACF"}

package/dist/adapters/comments/record.js

@@ -0,0 +1,78 @@
+import { conflict, invalid, notFound } from "./errors.js";
+//#region src/adapters/comments/record.ts
+const emptyDiscussion = () => ({
+	annotations: [],
+	threads: []
+});
+function requireThread(record, id) {
+	const thread = record.threads.find((item) => item.id === id);
+	if (!thread) throw notFound("comment thread", id);
+	return thread;
+}
+/** Checks the parts of a new thread that do not depend on stored data. */
+function assertNewThread({ annotation, thread }) {
+	if (!annotation.id || !thread.id) throw invalid("Annotation and thread need an id.");
+	if (thread.annotationId !== annotation.id || annotation.threadId !== thread.id) throw invalid("The annotation and the thread must point to each other.");
+}
+function createThread(record, input) {
+	assertNewThread(input);
+	if (record.annotations.some((item) => item.id === input.annotation.id)) throw conflict(`Annotation "${input.annotation.id}" already exists.`);
+	if (record.threads.some((item) => item.id === input.thread.id)) throw conflict(`Comment thread "${input.thread.id}" already exists.`);
+	const annotation = structuredClone(input.annotation);
+	const thread = {
+		id: input.thread.id,
+		annotationId: input.thread.annotationId,
+		status: "open",
+		comments: [structuredClone(input.thread.initialComment)]
+	};
+	record.annotations.push(annotation);
+	record.threads.push(thread);
+	return {
+		annotation,
+		thread
+	};
+}
+function addComment(record, threadId, comment) {
+	const thread = requireThread(record, threadId);
+	if (thread.comments.some((existing) => existing.id === comment.id)) throw conflict(`Comment "${comment.id}" already exists in thread "${threadId}".`);
+	thread.comments.push(structuredClone(comment));
+	return thread;
+}
+function editComment(record, threadId, commentId, body, editedAt) {
+	const thread = requireThread(record, threadId);
+	const comment = thread.comments.find((existing) => existing.id === commentId);
+	if (!comment) throw notFound("comment", commentId);
+	comment.body = body;
+	comment.editedAt = editedAt;
+	return thread;
+}
+function removeComment(record, threadId, commentId) {
+	const thread = requireThread(record, threadId);
+	const index = thread.comments.findIndex((existing) => existing.id === commentId);
+	if (index < 0) throw notFound("comment", commentId);
+	if (index === 0) throw invalid("The first comment of a thread cannot be removed on its own; remove the thread.");
+	thread.comments.splice(index, 1);
+	return thread;
+}
+function setThreadStatus(record, threadId, status) {
+	const thread = requireThread(record, threadId);
+	thread.status = status;
+	return thread;
+}
+function updateAnchor(record, annotation) {
+	const index = record.annotations.findIndex((item) => item.id === annotation.id);
+	const existing = record.annotations[index];
+	if (!existing) throw notFound("annotation", annotation.id);
+	if (existing.threadId !== annotation.threadId) throw invalid("An annotation cannot move to another thread.");
+	const stored = structuredClone(annotation);
+	record.annotations[index] = stored;
+	return stored;
+}
+function removeThread(record, threadId) {
+	record.threads = record.threads.filter((thread) => thread.id !== threadId);
+	record.annotations = record.annotations.filter((annotation) => annotation.threadId !== threadId);
+}
+//#endregion
+export { addComment, assertNewThread, createThread, editComment, emptyDiscussion, removeComment, removeThread, requireThread, setThreadStatus, updateAnchor };
+
+//# sourceMappingURL=record.js.map

package/dist/adapters/comments/record.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record.js","names":[],"sources":["../../../src/adapters/comments/record.ts"],"sourcesContent":["import { conflict, invalid, notFound } from './errors'\nimport type { Annotation, Comment, CommentThread, Discussion, NewThread, ThreadStatus } from './types'\n\n// The semantics of every `CommentStore` operation on one document's `Discussion`, for stores that hold the whole\n// record in memory (the JSON file). They mutate `record` in place and throw `CommentStoreError` before changing anything.\n\nexport const emptyDiscussion = (): Discussion => ({ annotations: [], threads: [] })\n\nexport function requireThread(record: Discussion, id: string): CommentThread {\n  const thread = record.threads.find(item => item.id === id)\n  if (!thread) throw notFound('comment thread', id)\n  return thread\n}\n\n/** Checks the parts of a new thread that do not depend on stored data. */\nexport function assertNewThread({ annotation, thread }: NewThread): void {\n  if (!annotation.id || !thread.id) throw invalid('Annotation and thread need an id.')\n  if (thread.annotationId !== annotation.id || annotation.threadId !== thread.id) throw invalid('The annotation and the thread must point to each other.')\n}\n\nexport function createThread(record: Discussion, input: NewThread): { annotation: Annotation, thread: CommentThread } {\n  assertNewThread(input)\n  if (record.annotations.some(item => item.id === input.annotation.id)) throw conflict(`Annotation \"${input.annotation.id}\" already exists.`)\n  if (record.threads.some(item => item.id === input.thread.id)) throw conflict(`Comment thread \"${input.thread.id}\" already exists.`)\n  const annotation = structuredClone(input.annotation)\n  const thread: CommentThread = { id: input.thread.id, annotationId: input.thread.annotationId, status: 'open', comments: [structuredClone(input.thread.initialComment)] }\n  record.annotations.push(annotation)\n  record.threads.push(thread)\n  return { annotation, thread }\n}\n\nexport function addComment(record: Discussion, threadId: string, comment: Comment): CommentThread {\n  const thread = requireThread(record, threadId)\n  if (thread.comments.some(existing => existing.id === comment.id)) throw conflict(`Comment \"${comment.id}\" already exists in thread \"${threadId}\".`)\n  thread.comments.push(structuredClone(comment))\n  return thread\n}\n\nexport function editComment(record: Discussion, threadId: string, commentId: string, body: string, editedAt: string): CommentThread {\n  const thread = requireThread(record, threadId)\n  const comment = thread.comments.find(existing => existing.id === commentId)\n  if (!comment) throw notFound('comment', commentId)\n  comment.body = body\n  comment.editedAt = editedAt\n  return thread\n}\n\nexport function removeComment(record: Discussion, threadId: string, commentId: string): CommentThread {\n  const thread = requireThread(record, threadId)\n  const index = thread.comments.findIndex(existing => existing.id === commentId)\n  if (index < 0) throw notFound('comment', commentId)\n  if (index === 0) throw invalid('The first comment of a thread cannot be removed on its own; remove the thread.')\n  thread.comments.splice(index, 1)\n  return thread\n}\n\nexport function setThreadStatus(record: Discussion, threadId: string, status: ThreadStatus): CommentThread {\n  const thread = requireThread(record, threadId)\n  thread.status = status\n  return thread\n}\n\nexport function updateAnchor(record: Discussion, annotation: Annotation): Annotation {\n  const index = record.annotations.findIndex(item => item.id === annotation.id)\n  const existing = record.annotations[index]\n  if (!existing) throw notFound('annotation', annotation.id)\n  if (existing.threadId !== annotation.threadId) throw invalid('An annotation cannot move to another thread.')\n  const stored = structuredClone(annotation)\n  record.annotations[index] = stored\n  return stored\n}\n\nexport function removeThread(record: Discussion, threadId: string): void {\n  record.threads = record.threads.filter(thread => thread.id !== threadId)\n  record.annotations = record.annotations.filter(annotation => annotation.threadId !== threadId)\n}\n"],"mappings":";;AAMA,MAAa,yBAAqC;CAAE,aAAa,CAAC;CAAG,SAAS,CAAC;AAAE;AAEjF,SAAgB,cAAc,QAAoB,IAA2B;CAC3E,MAAM,SAAS,OAAO,QAAQ,MAAK,SAAQ,KAAK,OAAO,EAAE;CACzD,IAAI,CAAC,QAAQ,MAAM,SAAS,kBAAkB,EAAE;CAChD,OAAO;AACT;;AAGA,SAAgB,gBAAgB,EAAE,YAAY,UAA2B;CACvE,IAAI,CAAC,WAAW,MAAM,CAAC,OAAO,IAAI,MAAM,QAAQ,mCAAmC;CACnF,IAAI,OAAO,iBAAiB,WAAW,MAAM,WAAW,aAAa,OAAO,IAAI,MAAM,QAAQ,yDAAyD;AACzJ;AAEA,SAAgB,aAAa,QAAoB,OAAqE;CACpH,gBAAgB,KAAK;CACrB,IAAI,OAAO,YAAY,MAAK,SAAQ,KAAK,OAAO,MAAM,WAAW,EAAE,GAAG,MAAM,SAAS,eAAe,MAAM,WAAW,GAAG,kBAAkB;CAC1I,IAAI,OAAO,QAAQ,MAAK,SAAQ,KAAK,OAAO,MAAM,OAAO,EAAE,GAAG,MAAM,SAAS,mBAAmB,MAAM,OAAO,GAAG,kBAAkB;CAClI,MAAM,aAAa,gBAAgB,MAAM,UAAU;CACnD,MAAM,SAAwB;EAAE,IAAI,MAAM,OAAO;EAAI,cAAc,MAAM,OAAO;EAAc,QAAQ;EAAQ,UAAU,CAAC,gBAAgB,MAAM,OAAO,cAAc,CAAC;CAAE;CACvK,OAAO,YAAY,KAAK,UAAU;CAClC,OAAO,QAAQ,KAAK,MAAM;CAC1B,OAAO;EAAE;EAAY;CAAO;AAC9B;AAEA,SAAgB,WAAW,QAAoB,UAAkB,SAAiC;CAChG,MAAM,SAAS,cAAc,QAAQ,QAAQ;CAC7C,IAAI,OAAO,SAAS,MAAK,aAAY,SAAS,OAAO,QAAQ,EAAE,GAAG,MAAM,SAAS,YAAY,QAAQ,GAAG,8BAA8B,SAAS,GAAG;CAClJ,OAAO,SAAS,KAAK,gBAAgB,OAAO,CAAC;CAC7C,OAAO;AACT;AAEA,SAAgB,YAAY,QAAoB,UAAkB,WAAmB,MAAc,UAAiC;CAClI,MAAM,SAAS,cAAc,QAAQ,QAAQ;CAC7C,MAAM,UAAU,OAAO,SAAS,MAAK,aAAY,SAAS,OAAO,SAAS;CAC1E,IAAI,CAAC,SAAS,MAAM,SAAS,WAAW,SAAS;CACjD,QAAQ,OAAO;CACf,QAAQ,WAAW;CACnB,OAAO;AACT;AAEA,SAAgB,cAAc,QAAoB,UAAkB,WAAkC;CACpG,MAAM,SAAS,cAAc,QAAQ,QAAQ;CAC7C,MAAM,QAAQ,OAAO,SAAS,WAAU,aAAY,SAAS,OAAO,SAAS;CAC7E,IAAI,QAAQ,GAAG,MAAM,SAAS,WAAW,SAAS;CAClD,IAAI,UAAU,GAAG,MAAM,QAAQ,gFAAgF;CAC/G,OAAO,SAAS,OAAO,OAAO,CAAC;CAC/B,OAAO;AACT;AAEA,SAAgB,gBAAgB,QAAoB,UAAkB,QAAqC;CACzG,MAAM,SAAS,cAAc,QAAQ,QAAQ;CAC7C,OAAO,SAAS;CAChB,OAAO;AACT;AAEA,SAAgB,aAAa,QAAoB,YAAoC;CACnF,MAAM,QAAQ,OAAO,YAAY,WAAU,SAAQ,KAAK,OAAO,WAAW,EAAE;CAC5E,MAAM,WAAW,OAAO,YAAY;CACpC,IAAI,CAAC,UAAU,MAAM,SAAS,cAAc,WAAW,EAAE;CACzD,IAAI,SAAS,aAAa,WAAW,UAAU,MAAM,QAAQ,8CAA8C;CAC3G,MAAM,SAAS,gBAAgB,UAAU;CACzC,OAAO,YAAY,SAAS;CAC5B,OAAO;AACT;AAEA,SAAgB,aAAa,QAAoB,UAAwB;CACvE,OAAO,UAAU,OAAO,QAAQ,QAAO,WAAU,OAAO,OAAO,QAAQ;CACvE,OAAO,cAAc,OAAO,YAAY,QAAO,eAAc,WAAW,aAAa,QAAQ;AAC/F"}

package/dist/adapters/comments/server.d.ts

@@ -0,0 +1,23 @@
+import { Annotation, Comment, CommentAction, CommentStore, CommentThread, CreateThreadInput, Discussion, NewThread, ThreadStatus } from "./types.js";
+import { CommentStoreError } from "./errors.js";
+//#region src/adapters/comments/server.d.ts
+export interface CommentsRequest {
+  method: string;
+  documentId: string;
+  /** The parsed JSON body of a `POST`. */
+  body?: unknown;
+}
+export interface CommentsResponse {
+  status: number;
+  /** JSON; `{ error }` for a refused request. */
+  body: unknown;
+}
+/**
+ * `GET` → `200` with the document's `Discussion`; `POST` with a `CommentAction` → `200` with the changed `thread`/`annotation`
+ * (`create`: both; `remove`: `{ ok: true }`). Refused requests answer `404` (unknown ids), `409` (duplicate ids), `400`
+ * (malformed input) or `405` with `{ error }`; anything else is a server fault and is thrown.
+ */
+export declare function handleCommentsRequest(store: CommentStore, request: CommentsRequest): Promise<CommentsResponse>;
+//#endregion
+export { type Annotation, type Comment, type CommentAction, type CommentStore, CommentStoreError, type CommentThread, type CreateThreadInput, type Discussion, type NewThread, type ThreadStatus };
+//# sourceMappingURL=server.d.ts.map

package/dist/adapters/comments/server.js

@@ -0,0 +1,102 @@
+import { isPortableAnchor } from "../anchors.js";
+import { CommentStoreError, invalid } from "./errors.js";
+//#region src/adapters/comments/server.ts
+const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+const isText = (value) => typeof value === "string";
+const isId = (value) => isText(value) && value !== "";
+function commentOf(value) {
+	if (!isRecord(value) || !isId(value.id) || !isText(value.body) || !isId(value.authorId) || !isId(value.createdAt)) throw invalid("A comment needs id, body, authorId and createdAt.");
+	for (const key of [
+		"authorName",
+		"authorColor",
+		"editedAt"
+	]) if (value[key] !== void 0 && !isText(value[key])) throw invalid(`Comment ${key} must be text.`);
+	const { id, body, authorId, createdAt } = value;
+	const { authorName, authorColor, editedAt } = value;
+	return {
+		id,
+		body,
+		authorId,
+		createdAt,
+		...authorName !== void 0 && { authorName },
+		...authorColor !== void 0 && { authorColor },
+		...editedAt !== void 0 && { editedAt }
+	};
+}
+function annotationOf(value) {
+	if (!isRecord(value) || !isId(value.id) || !isId(value.threadId) || !isPortableAnchor(value.anchor)) throw invalid("An annotation needs id, threadId and a valid anchor.");
+	return {
+		id: value.id,
+		threadId: value.threadId,
+		anchor: value.anchor
+	};
+}
+function threadInputOf(value) {
+	if (!isRecord(value) || !isId(value.id) || !isId(value.annotationId)) throw invalid("A thread needs id, annotationId and initialComment.");
+	return {
+		id: value.id,
+		annotationId: value.annotationId,
+		initialComment: commentOf(value.initialComment)
+	};
+}
+function idOf(value, key) {
+	const id = value[key];
+	if (!isId(id)) throw invalid(`"${key}" must be a non-empty string.`);
+	return id;
+}
+function statusOf(value) {
+	if (value !== "open" && value !== "resolved") throw invalid("\"status\" must be \"open\" or \"resolved\".");
+	return value;
+}
+async function perform(store, documentId, body) {
+	if (!isRecord(body)) throw invalid("The request body must be a JSON object with an \"action\".");
+	switch (body.action) {
+		case "create": return store.createThread(documentId, {
+			annotation: annotationOf(body.annotation),
+			thread: threadInputOf(body.thread)
+		});
+		case "reply": return { thread: await store.addComment(documentId, idOf(body, "threadId"), commentOf(body.comment)) };
+		case "status": return { thread: await store.setThreadStatus(documentId, idOf(body, "threadId"), statusOf(body.status)) };
+		case "update-annotation": return { annotation: await store.updateAnchor(documentId, annotationOf(body.annotation)) };
+		case "remove":
+			await store.removeThread(documentId, idOf(body, "threadId"));
+			return { ok: true };
+		case "edit":
+			if (!isText(body.body)) throw invalid("\"body\" must be text.");
+			return { thread: await store.editComment(documentId, idOf(body, "threadId"), idOf(body, "commentId"), body.body, isId(body.editedAt) ? body.editedAt : (/* @__PURE__ */ new Date()).toISOString()) };
+		case "remove-comment": return { thread: await store.removeComment(documentId, idOf(body, "threadId"), idOf(body, "commentId")) };
+		default: throw invalid("Unknown comment action.");
+	}
+}
+/**
+* `GET` → `200` with the document's `Discussion`; `POST` with a `CommentAction` → `200` with the changed `thread`/`annotation`
+* (`create`: both; `remove`: `{ ok: true }`). Refused requests answer `404` (unknown ids), `409` (duplicate ids), `400`
+* (malformed input) or `405` with `{ error }`; anything else is a server fault and is thrown.
+*/
+async function handleCommentsRequest(store, request) {
+	const method = request.method.toUpperCase();
+	try {
+		if (method === "GET") return {
+			status: 200,
+			body: await store.getDiscussion(request.documentId)
+		};
+		if (method === "POST") return {
+			status: 200,
+			body: await perform(store, request.documentId, request.body)
+		};
+		return {
+			status: 405,
+			body: { error: `Method ${request.method} is not allowed.` }
+		};
+	} catch (error) {
+		if (error instanceof CommentStoreError) return {
+			status: error.status,
+			body: { error: error.message }
+		};
+		throw error;
+	}
+}
+//#endregion
+export { CommentStoreError, handleCommentsRequest };
+
+//# sourceMappingURL=server.js.map

package/dist/adapters/comments/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","names":[],"sources":["../../../src/adapters/comments/server.ts"],"sourcesContent":["import { isPortableAnchor } from '../anchors'\nimport { CommentStoreError, invalid } from './errors'\nimport type { Annotation, Comment, CommentStore, CreateThreadInput, ThreadStatus } from './types'\n\n// Framework-free REST handler of a document's comments endpoint: the host routes `GET`/`POST` of\n// `<base>/<documentId>` here after its own authentication and authorisation (the handler trusts the caller, including\n// the `authorId` of new comments), and answers with `status` and `body`. Nitro, Express or a test's fetch stub all fit.\n\nexport type { Annotation, Comment, CommentAction, CommentStore, CommentThread, CreateThreadInput, Discussion, NewThread, ThreadStatus } from './types'\nexport { CommentStoreError } from './errors'\n\nexport interface CommentsRequest {\n  method: string\n  documentId: string\n  /** The parsed JSON body of a `POST`. */\n  body?: unknown\n}\n\nexport interface CommentsResponse {\n  status: number\n  /** JSON; `{ error }` for a refused request. */\n  body: unknown\n}\n\nconst isRecord = (value: unknown): value is Record<string, unknown> => typeof value === 'object' && value !== null && !Array.isArray(value)\nconst isText = (value: unknown): value is string => typeof value === 'string'\nconst isId = (value: unknown): value is string => isText(value) && value !== ''\n\nfunction commentOf(value: unknown): Comment {\n  if (!isRecord(value) || !isId(value.id) || !isText(value.body) || !isId(value.authorId) || !isId(value.createdAt)) throw invalid('A comment needs id, body, authorId and createdAt.')\n  for (const key of ['authorName', 'authorColor', 'editedAt']) {\n    if (value[key] !== undefined && !isText(value[key])) throw invalid(`Comment ${key} must be text.`)\n  }\n  const { id, body, authorId, createdAt } = value\n  const { authorName, authorColor, editedAt } = value as Record<string, string | undefined>\n  return { id, body, authorId, createdAt, ...(authorName !== undefined && { authorName }), ...(authorColor !== undefined && { authorColor }), ...(editedAt !== undefined && { editedAt }) }\n}\n\nfunction annotationOf(value: unknown): Annotation {\n  if (!isRecord(value) || !isId(value.id) || !isId(value.threadId) || !isPortableAnchor(value.anchor)) throw invalid('An annotation needs id, threadId and a valid anchor.')\n  return { id: value.id, threadId: value.threadId, anchor: value.anchor }\n}\n\nfunction threadInputOf(value: unknown): CreateThreadInput {\n  if (!isRecord(value) || !isId(value.id) || !isId(value.annotationId)) throw invalid('A thread needs id, annotationId and initialComment.')\n  return { id: value.id, annotationId: value.annotationId, initialComment: commentOf(value.initialComment) }\n}\n\nfunction idOf(value: Record<string, unknown>, key: string): string {\n  const id = value[key]\n  if (!isId(id)) throw invalid(`\"${key}\" must be a non-empty string.`)\n  return id\n}\n\nfunction statusOf(value: unknown): ThreadStatus {\n  if (value !== 'open' && value !== 'resolved') throw invalid('\"status\" must be \"open\" or \"resolved\".')\n  return value\n}\n\nasync function perform(store: CommentStore, documentId: string, body: unknown): Promise<unknown> {\n  if (!isRecord(body)) throw invalid('The request body must be a JSON object with an \"action\".')\n  switch (body.action) {\n    case 'create':\n      return store.createThread(documentId, { annotation: annotationOf(body.annotation), thread: threadInputOf(body.thread) })\n    case 'reply':\n      return { thread: await store.addComment(documentId, idOf(body, 'threadId'), commentOf(body.comment)) }\n    case 'status':\n      return { thread: await store.setThreadStatus(documentId, idOf(body, 'threadId'), statusOf(body.status)) }\n    case 'update-annotation':\n      return { annotation: await store.updateAnchor(documentId, annotationOf(body.annotation)) }\n    case 'remove':\n      await store.removeThread(documentId, idOf(body, 'threadId'))\n      return { ok: true }\n    case 'edit':\n      if (!isText(body.body)) throw invalid('\"body\" must be text.')\n      return { thread: await store.editComment(documentId, idOf(body, 'threadId'), idOf(body, 'commentId'), body.body, isId(body.editedAt) ? body.editedAt : new Date().toISOString()) }\n    case 'remove-comment':\n      return { thread: await store.removeComment(documentId, idOf(body, 'threadId'), idOf(body, 'commentId')) }\n    default:\n      throw invalid('Unknown comment action.')\n  }\n}\n\n/**\n * `GET` → `200` with the document's `Discussion`; `POST` with a `CommentAction` → `200` with the changed `thread`/`annotation`\n * (`create`: both; `remove`: `{ ok: true }`). Refused requests answer `404` (unknown ids), `409` (duplicate ids), `400`\n * (malformed input) or `405` with `{ error }`; anything else is a server fault and is thrown.\n */\nexport async function handleCommentsRequest(store: CommentStore, request: CommentsRequest): Promise<CommentsResponse> {\n  const method = request.method.toUpperCase()\n  try {\n    if (method === 'GET') return { status: 200, body: await store.getDiscussion(request.documentId) }\n    if (method === 'POST') return { status: 200, body: await perform(store, request.documentId, request.body) }\n    return { status: 405, body: { error: `Method ${request.method} is not allowed.` } } // i18n-ignore: HTTP error body of the comments route (server messages are not localised, like src/server)\n  }\n  catch (error) {\n    if (error instanceof CommentStoreError) return { status: error.status, body: { error: error.message } }\n    throw error\n  }\n}\n"],"mappings":";;;AAwBA,MAAM,YAAY,UAAqD,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC1I,MAAM,UAAU,UAAoC,OAAO,UAAU;AACrE,MAAM,QAAQ,UAAoC,OAAO,KAAK,KAAK,UAAU;AAE7E,SAAS,UAAU,OAAyB;CAC1C,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,KAAK,MAAM,EAAE,KAAK,CAAC,OAAO,MAAM,IAAI,KAAK,CAAC,KAAK,MAAM,QAAQ,KAAK,CAAC,KAAK,MAAM,SAAS,GAAG,MAAM,QAAQ,mDAAmD;CACpL,KAAK,MAAM,OAAO;EAAC;EAAc;EAAe;CAAU,GACxD,IAAI,MAAM,SAAS,KAAA,KAAa,CAAC,OAAO,MAAM,IAAI,GAAG,MAAM,QAAQ,WAAW,IAAI,eAAe;CAEnG,MAAM,EAAE,IAAI,MAAM,UAAU,cAAc;CAC1C,MAAM,EAAE,YAAY,aAAa,aAAa;CAC9C,OAAO;EAAE;EAAI;EAAM;EAAU;EAAW,GAAI,eAAe,KAAA,KAAa,EAAE,WAAW;EAAI,GAAI,gBAAgB,KAAA,KAAa,EAAE,YAAY;EAAI,GAAI,aAAa,KAAA,KAAa,EAAE,SAAS;CAAG;AAC1L;AAEA,SAAS,aAAa,OAA4B;CAChD,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,KAAK,MAAM,EAAE,KAAK,CAAC,KAAK,MAAM,QAAQ,KAAK,CAAC,iBAAiB,MAAM,MAAM,GAAG,MAAM,QAAQ,sDAAsD;CACzK,OAAO;EAAE,IAAI,MAAM;EAAI,UAAU,MAAM;EAAU,QAAQ,MAAM;CAAO;AACxE;AAEA,SAAS,cAAc,OAAmC;CACxD,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,KAAK,MAAM,EAAE,KAAK,CAAC,KAAK,MAAM,YAAY,GAAG,MAAM,QAAQ,qDAAqD;CACzI,OAAO;EAAE,IAAI,MAAM;EAAI,cAAc,MAAM;EAAc,gBAAgB,UAAU,MAAM,cAAc;CAAE;AAC3G;AAEA,SAAS,KAAK,OAAgC,KAAqB;CACjE,MAAM,KAAK,MAAM;CACjB,IAAI,CAAC,KAAK,EAAE,GAAG,MAAM,QAAQ,IAAI,IAAI,8BAA8B;CACnE,OAAO;AACT;AAEA,SAAS,SAAS,OAA8B;CAC9C,IAAI,UAAU,UAAU,UAAU,YAAY,MAAM,QAAQ,8CAAwC;CACpG,OAAO;AACT;AAEA,eAAe,QAAQ,OAAqB,YAAoB,MAAiC;CAC/F,IAAI,CAAC,SAAS,IAAI,GAAG,MAAM,QAAQ,4DAA0D;CAC7F,QAAQ,KAAK,QAAb;EACE,KAAK,UACH,OAAO,MAAM,aAAa,YAAY;GAAE,YAAY,aAAa,KAAK,UAAU;GAAG,QAAQ,cAAc,KAAK,MAAM;EAAE,CAAC;EACzH,KAAK,SACH,OAAO,EAAE,QAAQ,MAAM,MAAM,WAAW,YAAY,KAAK,MAAM,UAAU,GAAG,UAAU,KAAK,OAAO,CAAC,EAAE;EACvG,KAAK,UACH,OAAO,EAAE,QAAQ,MAAM,MAAM,gBAAgB,YAAY,KAAK,MAAM,UAAU,GAAG,SAAS,KAAK,MAAM,CAAC,EAAE;EAC1G,KAAK,qBACH,OAAO,EAAE,YAAY,MAAM,MAAM,aAAa,YAAY,aAAa,KAAK,UAAU,CAAC,EAAE;EAC3F,KAAK;GACH,MAAM,MAAM,aAAa,YAAY,KAAK,MAAM,UAAU,CAAC;GAC3D,OAAO,EAAE,IAAI,KAAK;EACpB,KAAK;GACH,IAAI,CAAC,OAAO,KAAK,IAAI,GAAG,MAAM,QAAQ,wBAAsB;GAC5D,OAAO,EAAE,QAAQ,MAAM,MAAM,YAAY,YAAY,KAAK,MAAM,UAAU,GAAG,KAAK,MAAM,WAAW,GAAG,KAAK,MAAM,KAAK,KAAK,QAAQ,IAAI,KAAK,4BAAW,IAAI,KAAK,EAAA,CAAE,YAAY,CAAC,EAAE;EACnL,KAAK,kBACH,OAAO,EAAE,QAAQ,MAAM,MAAM,cAAc,YAAY,KAAK,MAAM,UAAU,GAAG,KAAK,MAAM,WAAW,CAAC,EAAE;EAC1G,SACE,MAAM,QAAQ,yBAAyB;CAC3C;AACF;;;;;;AAOA,eAAsB,sBAAsB,OAAqB,SAAqD;CACpH,MAAM,SAAS,QAAQ,OAAO,YAAY;CAC1C,IAAI;EACF,IAAI,WAAW,OAAO,OAAO;GAAE,QAAQ;GAAK,MAAM,MAAM,MAAM,cAAc,QAAQ,UAAU;EAAE;EAChG,IAAI,WAAW,QAAQ,OAAO;GAAE,QAAQ;GAAK,MAAM,MAAM,QAAQ,OAAO,QAAQ,YAAY,QAAQ,IAAI;EAAE;EAC1G,OAAO;GAAE,QAAQ;GAAK,MAAM,EAAE,OAAO,UAAU,QAAQ,OAAO,kBAAkB;EAAE;CACpF,SACO,OAAO;EACZ,IAAI,iBAAiB,mBAAmB,OAAO;GAAE,QAAQ,MAAM;GAAQ,MAAM,EAAE,OAAO,MAAM,QAAQ;EAAE;EACtG,MAAM;CACR;AACF"}

package/dist/adapters/comments/types.d.ts

@@ -0,0 +1,109 @@
+import { PortableAnchor } from "../anchors.js";
+//#region src/adapters/comments/types.d.ts
+export type ThreadStatus = 'open' | 'resolved';
+/** One message of a thread; the first is the thread's own text, the rest are replies. */
+export interface Comment {
+  id: string;
+  body: string;
+  authorId: string;
+  /** ISO timestamp. */
+  createdAt: string;
+  /** Display name and colour of the author when the writer knew them; older data has only `authorId`. */
+  authorName?: string;
+  authorColor?: string;
+  /** ISO timestamp of the last change of `body`. */
+  editedAt?: string;
+}
+/** A discussion: one annotation's messages, `open` or `resolved`. */
+export interface CommentThread {
+  id: string;
+  annotationId: string;
+  status: ThreadStatus;
+  comments: Comment[];
+}
+/** Where a thread points to in the document. */
+export interface Annotation {
+  id: string;
+  threadId: string;
+  anchor: PortableAnchor;
+}
+/** Everything stored for one document. */
+export interface Discussion {
+  annotations: Annotation[];
+  threads: CommentThread[];
+}
+export interface CreateThreadInput {
+  id: string;
+  annotationId: string;
+  initialComment: Comment;
+}
+/** A new thread together with the annotation it hangs on; stored as one unit. */
+export interface NewThread {
+  annotation: Annotation;
+  thread: CreateThreadInput;
+}
+/**
+ * Where a host keeps the comment threads of its documents, keyed by document id. Persistence only: who may read or
+ * write, and who the author is, stay with the host (`handleCommentsRequest` takes already-authorised calls). Every
+ * method rejects with a `CommentStoreError` for caller mistakes (unknown or duplicate ids, inconsistent input) and
+ * never partially applies a change.
+ */
+export interface CommentStore {
+  /** The annotations and threads of `documentId`, in the order they were created; empty for an unknown document. */
+  getDiscussion(documentId: string): Promise<Discussion>;
+  getThread(documentId: string, threadId: string): Promise<CommentThread | undefined>;
+  listThreads(documentId: string): Promise<CommentThread[]>;
+  /** Stores the annotation and the thread with its first comment. Duplicate annotation or thread ids are a conflict. */
+  createThread(documentId: string, input: NewThread): Promise<{
+    annotation: Annotation;
+    thread: CommentThread;
+  }>;
+  /** Appends a reply. */
+  addComment(documentId: string, threadId: string, comment: Comment): Promise<CommentThread>;
+  /** Changes the text of one comment (the first one is the thread's own text) and stamps it `editedAt`. */
+  editComment(documentId: string, threadId: string, commentId: string, body: string, editedAt: string): Promise<CommentThread>;
+  /** Deletes one reply. The first comment cannot be deleted on its own: remove the thread. */
+  removeComment(documentId: string, threadId: string, commentId: string): Promise<CommentThread>;
+  setThreadStatus(documentId: string, threadId: string, status: ThreadStatus): Promise<CommentThread>;
+  /** Replaces the anchor of an existing annotation (after the text moved, or became an orphan). */
+  updateAnchor(documentId: string, annotation: Annotation): Promise<Annotation>;
+  /** Deletes the thread and the annotations that point to it; unknown ids are fine. */
+  removeThread(documentId: string, threadId: string): Promise<void>;
+  /** Deletes the discussions of every document whose id starts with `prefix` (a deleted workspace's `<id>/`); the number of documents that had any. */
+  removeDocuments(prefix: string): Promise<number>;
+}
+/**
+ * The body of a `POST` to a document's comments endpoint (`handleCommentsRequest` answers it, `createRestCommentsModel`
+ * sends it). `GET` answers the document's `Discussion`. The first five actions are skaile-forge's original wire format.
+ */
+export type CommentAction = {
+  action: 'create';
+  annotation: Annotation;
+  thread: CreateThreadInput;
+} | {
+  action: 'reply';
+  threadId: string;
+  comment: Comment;
+} | {
+  action: 'status';
+  threadId: string;
+  status: ThreadStatus;
+} | {
+  action: 'update-annotation';
+  annotation: Annotation;
+} | {
+  action: 'remove';
+  threadId: string;
+} | {
+  action: 'edit';
+  threadId: string;
+  commentId: string;
+  body: string;
+  editedAt?: string;
+} | {
+  action: 'remove-comment';
+  threadId: string;
+  commentId: string;
+};
+//#endregion
+//# sourceMappingURL=types.d.ts.map