@the-focus-ai/artifacts 1.0.3 → 1.2.0

package/dist/src/living-doc.d.ts

@@ -0,0 +1,163 @@
+import { type PublisherTokenStore } from "./auth.js";
+import { type CommentOrigin, type LivingDoc, type LivingDocComment, type LivingDocMetadataStore, type LivingDocSuggestion, type SuggestionStatus } from "./storage/living-doc-metadata.js";
+export declare const livingDocViewPrefix = "/d";
+export declare const livingDocReviewPrefix = "/r";
+export declare const maxLivingDocMarkdownBytes: number;
+export declare const maxLivingDocTextBytes: number;
+export interface PublishLivingDocInput {
+    markdown: string;
+    publisherEmail: string;
+    publicBaseUrl: string;
+    store: LivingDocMetadataStore;
+    title?: string | null;
+    opaqueId?: string;
+    reviewId?: string;
+}
+export interface PublishLivingDocResult {
+    opaqueId: string;
+    reviewId: string;
+    title: string | null;
+    viewUrl: string;
+    reviewUrl: string;
+}
+export declare function publishLivingDoc(input: PublishLivingDocInput): Promise<PublishLivingDocResult>;
+export interface PullLivingDocInput {
+    opaqueId: string;
+    publisherEmail: string;
+    store: LivingDocMetadataStore;
+}
+export interface PulledComment {
+    id: string;
+    origin: CommentOrigin;
+    author: string | null;
+    anchorQuote: string;
+    body: string;
+    createdAt: string;
+}
+export interface PulledSuggestion {
+    id: string;
+    anchorQuote: string;
+    anchorStart: number | null;
+    replacement: string;
+    note: string | null;
+    status: SuggestionStatus;
+}
+export interface PullLivingDocResult {
+    opaqueId: string;
+    title: string | null;
+    versionNumber: number;
+    previousVersionNumber: number | null;
+    markdown: string;
+    diffFromPreviousVersion: string | null;
+    openComments: PulledComment[];
+    priorSuggestions: PulledSuggestion[];
+}
+/**
+ * Cut an immutable Version of the Living Doc and return the current Markdown,
+ * a diff versus the previous Version, and the open Reviewer feedback. This is
+ * the turn boundary: each pull advances the version number.
+ */
+export declare function pullLivingDocFeedback(input: PullLivingDocInput): Promise<PullLivingDocResult>;
+export interface RespondSuggestionInput {
+    anchorQuote: string;
+    replacement: string;
+    note?: string | null;
+    anchorStart?: number | null;
+}
+export interface RespondReplyInput {
+    parentCommentId: string;
+    body: string;
+}
+export interface RespondLivingDocInput {
+    opaqueId: string;
+    publisherEmail: string;
+    store: LivingDocMetadataStore;
+    suggestions?: RespondSuggestionInput[];
+    replies?: RespondReplyInput[];
+}
+export interface RespondLivingDocResult {
+    opaqueId: string;
+    versionNumber: number;
+    createdSuggestions: PulledSuggestion[];
+    createdReplies: PulledComment[];
+}
+/**
+ * The agent's half of the round: post span-anchored Suggestions (never applied
+ * automatically) and replies to open Comments. Suggestions target the latest
+ * pulled Version.
+ */
+export declare function respondToLivingDoc(input: RespondLivingDocInput): Promise<RespondLivingDocResult>;
+export interface RemoveLivingDocInput {
+    opaqueId: string;
+    publisherEmail: string;
+    store: LivingDocMetadataStore;
+}
+export interface RemoveLivingDocResult {
+    opaqueId: string;
+    status: "removed" | "not-found";
+}
+/**
+ * Removal disables the Living Doc: the View Link and Review Link both stop
+ * serving it. This is the kill switch for a leaked Review Link.
+ */
+export declare function removeLivingDoc(input: RemoveLivingDocInput): Promise<RemoveLivingDocResult>;
+export interface ReviewStateResult {
+    opaqueId: string;
+    title: string | null;
+    versionNumber: number;
+    markdown: string;
+    comments: LivingDocComment[];
+    pendingSuggestions: LivingDocSuggestion[];
+}
+export declare function getReviewState(store: LivingDocMetadataStore, reviewId: string): Promise<ReviewStateResult>;
+export declare function saveReviewMarkdown(store: LivingDocMetadataStore, reviewId: string, markdown: string): Promise<LivingDoc>;
+export interface AddReviewerCommentInput {
+    anchorQuote: string;
+    body: string;
+    anchorStart?: number | null;
+    anchorEnd?: number | null;
+    author?: string | null;
+}
+export declare function addReviewerComment(store: LivingDocMetadataStore, reviewId: string, input: AddReviewerCommentInput): Promise<LivingDocComment>;
+export declare function resolveReviewerComment(store: LivingDocMetadataStore, reviewId: string, commentId: string): Promise<LivingDocComment>;
+export interface DecideSuggestionResult {
+    suggestion: LivingDocSuggestion;
+    markdown: string;
+    applied: boolean;
+    occurrenceCount: number;
+}
+/**
+ * Accept or reject an agent Suggestion. Accepting applies the change to the
+ * live Markdown at the anchored quote — when the quote matches more than one
+ * place, the occurrence nearest the Suggestion's anchorStart offset wins. If
+ * the quote no longer exists (the Reviewer edited past it), the Suggestion
+ * stays pending so its replacement text remains visible on the review surface
+ * instead of vanishing with an accepted-but-unapplied status.
+ */
+export declare function decideSuggestion(store: LivingDocMetadataStore, reviewId: string, suggestionId: string, decision: Extract<SuggestionStatus, "accepted" | "rejected">): Promise<DecideSuggestionResult>;
+export interface ServeLivingDocViewInput {
+    request: Request;
+    store: LivingDocMetadataStore;
+}
+export declare function serveLivingDocViewRequest({ request, store, }: ServeLivingDocViewInput): Promise<Response>;
+export interface HandleAgentApiInput {
+    request: Request;
+    store: LivingDocMetadataStore;
+    tokenStore: PublisherTokenStore;
+    publicBaseUrl?: string;
+}
+export declare function handleLivingDocAgentApiRequest({ request, store, tokenStore, publicBaseUrl, }: HandleAgentApiInput): Promise<Response>;
+export interface HandleReviewApiInput {
+    request: Request;
+    store: LivingDocMetadataStore;
+}
+export declare function handleReviewApiRequest({ request, store, }: HandleReviewApiInput): Promise<Response>;
+export declare function livingDocViewUrl(publicBaseUrl: string, opaqueId: string): string;
+export declare function livingDocReviewUrl(publicBaseUrl: string, reviewId: string): string;
+export declare function opaqueIdFromViewUrl(url: string): string | null;
+export declare function reviewIdFromReviewUrl(url: string): string | null;
+export declare function opaqueIdFromViewReference(reference: string): string;
+export declare function livingDocSafetyHeaders(headers?: HeadersInit): Headers;
+export declare function deriveMarkdownTitle(markdown: string): string | null;
+export declare function createReviewId(): string;
+//# sourceMappingURL=living-doc.d.ts.map

package/dist/src/living-doc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"living-doc.d.ts","sourceRoot":"","sources":["../../src/living-doc.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,KAAK,mBAAmB,EACzB,MAAM,WAAW,CAAC;AAGnB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,SAAS,EACd,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACtB,MAAM,kCAAkC,CAAC;AAE1C,eAAO,MAAM,mBAAmB,OAAO,CAAC;AACxC,eAAO,MAAM,qBAAqB,OAAO,CAAC;AAI1C,eAAO,MAAM,yBAAyB,QAAkB,CAAC;AACzD,eAAO,MAAM,qBAAqB,QAAY,CAAC;AAc/C,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,sBAAsB,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,wBAAsB,gBAAgB,CACpC,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,sBAAsB,CAAC,CAkBjC;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,sBAAsB,CAAC;CAC/B;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,aAAa,CAAC;IACtB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,YAAY,EAAE,aAAa,EAAE,CAAC;IAC9B,gBAAgB,EAAE,gBAAgB,EAAE,CAAC;CACtC;AAED;;;;GAIG;AACH,wBAAsB,qBAAqB,CACzC,KAAK,EAAE,kBAAkB,GACxB,OAAO,CAAC,mBAAmB,CAAC,CAuC9B;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAGrB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,iBAAiB;IAChC,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,sBAAsB,CAAC;IAC9B,WAAW,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACvC,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,gBAAgB,EAAE,CAAC;IACvC,cAAc,EAAE,aAAa,EAAE,CAAC;CACjC;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CACtC,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,sBAAsB,CAAC,CAwEjC;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,sBAAsB,CAAC;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;CACjC;AAED;;;GAGG;AACH,wBAAsB,eAAe,CACnC,KAAK,EAAE,oBAAoB,GAC1B,OAAO,CAAC,qBAAqB,CAAC,CAUhC;AAID,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B,kBAAkB,EAAE,mBAAmB,EAAE,CAAC;CAC3C;AAED,wBAAsB,cAAc,CAClC,KAAK,EAAE,sBAAsB,EAC7B,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,iBAAiB,CAAC,CAY5B;AAED,wBAAsB,kBAAkB,CACtC,KAAK,EAAE,sBAAsB,EAC7B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,SAAS,CAAC,CAMpB;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,wBAAsB,kBAAkB,CACtC,KAAK,EAAE,sBAAsB,EAC7B,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,uBAAuB,GAC7B,OAAO,CAAC,gBAAgB,CAAC,CAe3B;AAED,wBAAsB,sBAAsB,CAC1C,KAAK,EAAE,sBAAsB,EAC7B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,gBAAgB,CAAC,CAS3B;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,mBAAmB,CAAC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IAGjB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,wBAAsB,gBAAgB,CACpC,KAAK,EAAE,sBAAsB,EAC7B,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,OAAO,CAAC,gBAAgB,EAAE,UAAU,GAAG,UAAU,CAAC,GAC3D,OAAO,CAAC,sBAAsB,CAAC,CAwCjC;AA8BD,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,sBAAsB,CAAC;CAC/B;AAED,wBAAsB,yBAAyB,CAAC,EAC9C,OAAO,EACP,KAAK,GACN,EAAE,uBAAuB,GAAG,OAAO,CAAC,QAAQ,CAAC,CA2B7C;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,sBAAsB,CAAC;IAC9B,UAAU,EAAE,mBAAmB,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,wBAAsB,8BAA8B,CAAC,EACnD,OAAO,EACP,KAAK,EACL,UAAU,EACV,aAAoC,GACrC,EAAE,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC,CA4FzC;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,sBAAsB,CAAC;CAC/B;AAED,wBAAsB,sBAAsB,CAAC,EAC3C,OAAO,EACP,KAAK,GACN,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC,CA2E1C;AAID,wBAAgB,gBAAgB,CAC9B,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,GACf,MAAM,CAKR;AAED,wBAAgB,kBAAkB,CAChC,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,GACf,MAAM,CAKR;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAI9D;AAED,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAIhE;AAED,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAQnE;AAED,wBAAgB,sBAAsB,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAMzE;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAOnE;AA6ED,wBAAgB,cAAc,IAAI,MAAM,CAEvC"}