@airnauts/comments-core 0.1.0

package/dist/pageKey.d.ts

@@ -0,0 +1,3 @@
+export type PageKeyFn = (url: string) => string;
+export declare function normalizePageKey(url: string | URL): string;
+//# sourceMappingURL=pageKey.d.ts.map

package/dist/pageKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pageKey.d.ts","sourceRoot":"","sources":["../src/pageKey.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAA;AAE/C,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,GAAG,MAAM,CAO1D"}

package/dist/schemas/anchor.d.ts

@@ -0,0 +1,62 @@
+import { z } from 'zod';
+export declare const ANCHOR_SCHEMA_VERSION = 1;
+export declare const Signals: z.ZodObject<{
+    tag: z.ZodString;
+    role: z.ZodOptional<z.ZodString>;
+    textSnippet: z.ZodOptional<z.ZodString>;
+    classes: z.ZodArray<z.ZodString>;
+    siblingIndex: z.ZodNumber;
+    ancestorTrail: z.ZodArray<z.ZodString>;
+    stableAttrs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$strip>;
+export type Signals = z.infer<typeof Signals>;
+export declare const Selection: z.ZodObject<{
+    start: z.ZodObject<{
+        selectors: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+        textNodeIndex: z.ZodNumber;
+        offset: z.ZodNumber;
+    }, z.core.$strip>;
+    end: z.ZodObject<{
+        selectors: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+        textNodeIndex: z.ZodNumber;
+        offset: z.ZodNumber;
+    }, z.core.$strip>;
+    quote: z.ZodString;
+    prefix: z.ZodString;
+    suffix: z.ZodString;
+}, z.core.$strip>;
+export type Selection = z.infer<typeof Selection>;
+export declare const Anchor: z.ZodObject<{
+    schemaVersion: z.ZodNumber;
+    selectors: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+    signals: z.ZodObject<{
+        tag: z.ZodString;
+        role: z.ZodOptional<z.ZodString>;
+        textSnippet: z.ZodOptional<z.ZodString>;
+        classes: z.ZodArray<z.ZodString>;
+        siblingIndex: z.ZodNumber;
+        ancestorTrail: z.ZodArray<z.ZodString>;
+        stableAttrs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strip>;
+    offset: z.ZodObject<{
+        fx: z.ZodNumber;
+        fy: z.ZodNumber;
+    }, z.core.$strip>;
+    selection: z.ZodOptional<z.ZodObject<{
+        start: z.ZodObject<{
+            selectors: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+            textNodeIndex: z.ZodNumber;
+            offset: z.ZodNumber;
+        }, z.core.$strip>;
+        end: z.ZodObject<{
+            selectors: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+            textNodeIndex: z.ZodNumber;
+            offset: z.ZodNumber;
+        }, z.core.$strip>;
+        quote: z.ZodString;
+        prefix: z.ZodString;
+        suffix: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type Anchor = z.infer<typeof Anchor>;
+//# sourceMappingURL=anchor.d.ts.map

package/dist/schemas/anchor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"anchor.d.ts","sourceRoot":"","sources":["../../src/schemas/anchor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,qBAAqB,IAAI,CAAA;AAItC,eAAO,MAAM,OAAO;;;;;;;;iBAUM,CAAA;AAC1B,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAA;AAQ7C,eAAO,MAAM,SAAS;;;;;;;;;;;;;;iBAQM,CAAA;AAC5B,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAA;AAEjD,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAUM,CAAA;AACzB,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAA"}

package/dist/schemas/capture.d.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+export declare const CaptureContext: z.ZodObject<{
+    viewportW: z.ZodNumber;
+    viewportH: z.ZodNumber;
+    devicePixelRatio: z.ZodNumber;
+    userAgent: z.ZodString;
+}, z.core.$strip>;
+export type CaptureContext = z.infer<typeof CaptureContext>;
+export declare const Provenance: z.ZodObject<{
+    commitSha: z.ZodOptional<z.ZodString>;
+    branch: z.ZodOptional<z.ZodString>;
+    deploymentId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type Provenance = z.infer<typeof Provenance>;
+//# sourceMappingURL=capture.d.ts.map

package/dist/schemas/capture.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capture.d.ts","sourceRoot":"","sources":["../../src/schemas/capture.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,cAAc;;;;;iBAOM,CAAA;AACjC,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D,eAAO,MAAM,UAAU;;;;iBAMM,CAAA;AAC7B,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAA"}

package/dist/schemas/comment.d.ts

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+export declare const Author: z.ZodObject<{
+    id: z.ZodOptional<z.core.$ZodBranded<z.ZodString, "AuthorId", "out">>;
+    email: z.ZodEmail;
+    name: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type Author = z.infer<typeof Author>;
+export declare const Attachment: z.ZodObject<{
+    id: z.core.$ZodBranded<z.ZodString, "AttachmentId", "out">;
+    url: z.ZodURL;
+    name: z.ZodString;
+    contentType: z.ZodString;
+    size: z.ZodNumber;
+    w: z.ZodOptional<z.ZodNumber>;
+    h: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type Attachment = z.infer<typeof Attachment>;
+export declare const Comment: z.ZodObject<{
+    id: z.core.$ZodBranded<z.ZodString, "CommentId", "out">;
+    author: z.ZodObject<{
+        id: z.ZodOptional<z.core.$ZodBranded<z.ZodString, "AuthorId", "out">>;
+        email: z.ZodEmail;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    text: z.ZodString;
+    attachments: z.ZodArray<z.ZodObject<{
+        id: z.core.$ZodBranded<z.ZodString, "AttachmentId", "out">;
+        url: z.ZodURL;
+        name: z.ZodString;
+        contentType: z.ZodString;
+        size: z.ZodNumber;
+        w: z.ZodOptional<z.ZodNumber>;
+        h: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    createdAt: z.ZodISODateTime;
+    editedAt: z.ZodOptional<z.ZodISODateTime>;
+}, z.core.$strip>;
+export type Comment = z.infer<typeof Comment>;
+//# sourceMappingURL=comment.d.ts.map

package/dist/schemas/comment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment.d.ts","sourceRoot":"","sources":["../../src/schemas/comment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvB,eAAO,MAAM,MAAM;;;;iBAEM,CAAA;AACzB,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAA;AAE3C,eAAO,MAAM,UAAU;;;;;;;;iBAUM,CAAA;AAC7B,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAA;AAEnD,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;iBASM,CAAA;AAC1B,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAA"}

package/dist/schemas/common.d.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export declare const Email: z.ZodEmail;
+export type Email = z.infer<typeof Email>;
+export declare const IsoTimestamp: z.ZodISODateTime;
+export type IsoTimestamp = z.infer<typeof IsoTimestamp>;
+export declare const Cursor: z.ZodString;
+export type Cursor = z.infer<typeof Cursor>;
+//# sourceMappingURL=common.d.ts.map

package/dist/schemas/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/schemas/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,KAAK,YAAkC,CAAA;AACpD,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,CAAA;AAEzC,eAAO,MAAM,YAAY,kBAAgD,CAAA;AACzE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;AAIvD,eAAO,MAAM,MAAM,aAAoB,CAAA;AACvC,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAA"}

package/dist/schemas/thread.d.ts

@@ -0,0 +1,163 @@
+import { z } from 'zod';
+export declare const ThreadStatus: z.ZodEnum<{
+    open: "open";
+    resolved: "resolved";
+}>;
+export type ThreadStatus = z.infer<typeof ThreadStatus>;
+export declare const AnchorState: z.ZodEnum<{
+    anchored: "anchored";
+    orphaned: "orphaned";
+}>;
+export type AnchorState = z.infer<typeof AnchorState>;
+export declare const ThreadListItem: z.ZodObject<{
+    id: z.core.$ZodBranded<z.ZodString, "ThreadId", "out">;
+    scope: z.ZodLiteral<"page">;
+    pageKey: z.ZodNullable<z.ZodString>;
+    pageUrl: z.ZodURL;
+    pageTitle: z.ZodOptional<z.ZodString>;
+    anchor: z.ZodObject<{
+        schemaVersion: z.ZodNumber;
+        selectors: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+        signals: z.ZodObject<{
+            tag: z.ZodString;
+            role: z.ZodOptional<z.ZodString>;
+            textSnippet: z.ZodOptional<z.ZodString>;
+            classes: z.ZodArray<z.ZodString>;
+            siblingIndex: z.ZodNumber;
+            ancestorTrail: z.ZodArray<z.ZodString>;
+            stableAttrs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        }, z.core.$strip>;
+        offset: z.ZodObject<{
+            fx: z.ZodNumber;
+            fy: z.ZodNumber;
+        }, z.core.$strip>;
+        selection: z.ZodOptional<z.ZodObject<{
+            start: z.ZodObject<{
+                selectors: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+                textNodeIndex: z.ZodNumber;
+                offset: z.ZodNumber;
+            }, z.core.$strip>;
+            end: z.ZodObject<{
+                selectors: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+                textNodeIndex: z.ZodNumber;
+                offset: z.ZodNumber;
+            }, z.core.$strip>;
+            quote: z.ZodString;
+            prefix: z.ZodString;
+            suffix: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    status: z.ZodEnum<{
+        open: "open";
+        resolved: "resolved";
+    }>;
+    anchorState: z.ZodEnum<{
+        anchored: "anchored";
+        orphaned: "orphaned";
+    }>;
+    selectionLost: z.ZodOptional<z.ZodBoolean>;
+    commentCount: z.ZodNumber;
+    unresolvedCount: z.ZodNumber;
+    createdBy: z.ZodObject<{
+        id: z.ZodOptional<z.core.$ZodBranded<z.ZodString, "AuthorId", "out">>;
+        email: z.ZodEmail;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+    lastActivityAt: z.ZodISODateTime;
+    schemaVersion: z.ZodNumber;
+}, z.core.$strip>;
+export type ThreadListItem = z.infer<typeof ThreadListItem>;
+export declare const Thread: z.ZodObject<{
+    id: z.core.$ZodBranded<z.ZodString, "ThreadId", "out">;
+    scope: z.ZodLiteral<"page">;
+    pageKey: z.ZodNullable<z.ZodString>;
+    pageUrl: z.ZodURL;
+    pageTitle: z.ZodOptional<z.ZodString>;
+    anchor: z.ZodObject<{
+        schemaVersion: z.ZodNumber;
+        selectors: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+        signals: z.ZodObject<{
+            tag: z.ZodString;
+            role: z.ZodOptional<z.ZodString>;
+            textSnippet: z.ZodOptional<z.ZodString>;
+            classes: z.ZodArray<z.ZodString>;
+            siblingIndex: z.ZodNumber;
+            ancestorTrail: z.ZodArray<z.ZodString>;
+            stableAttrs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        }, z.core.$strip>;
+        offset: z.ZodObject<{
+            fx: z.ZodNumber;
+            fy: z.ZodNumber;
+        }, z.core.$strip>;
+        selection: z.ZodOptional<z.ZodObject<{
+            start: z.ZodObject<{
+                selectors: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+                textNodeIndex: z.ZodNumber;
+                offset: z.ZodNumber;
+            }, z.core.$strip>;
+            end: z.ZodObject<{
+                selectors: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+                textNodeIndex: z.ZodNumber;
+                offset: z.ZodNumber;
+            }, z.core.$strip>;
+            quote: z.ZodString;
+            prefix: z.ZodString;
+            suffix: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    status: z.ZodEnum<{
+        open: "open";
+        resolved: "resolved";
+    }>;
+    anchorState: z.ZodEnum<{
+        anchored: "anchored";
+        orphaned: "orphaned";
+    }>;
+    selectionLost: z.ZodOptional<z.ZodBoolean>;
+    commentCount: z.ZodNumber;
+    unresolvedCount: z.ZodNumber;
+    createdBy: z.ZodObject<{
+        id: z.ZodOptional<z.core.$ZodBranded<z.ZodString, "AuthorId", "out">>;
+        email: z.ZodEmail;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+    lastActivityAt: z.ZodISODateTime;
+    schemaVersion: z.ZodNumber;
+    comments: z.ZodArray<z.ZodObject<{
+        id: z.core.$ZodBranded<z.ZodString, "CommentId", "out">;
+        author: z.ZodObject<{
+            id: z.ZodOptional<z.core.$ZodBranded<z.ZodString, "AuthorId", "out">>;
+            email: z.ZodEmail;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        text: z.ZodString;
+        attachments: z.ZodArray<z.ZodObject<{
+            id: z.core.$ZodBranded<z.ZodString, "AttachmentId", "out">;
+            url: z.ZodURL;
+            name: z.ZodString;
+            contentType: z.ZodString;
+            size: z.ZodNumber;
+            w: z.ZodOptional<z.ZodNumber>;
+            h: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        createdAt: z.ZodISODateTime;
+        editedAt: z.ZodOptional<z.ZodISODateTime>;
+    }, z.core.$strip>>;
+    captureContext: z.ZodObject<{
+        viewportW: z.ZodNumber;
+        viewportH: z.ZodNumber;
+        devicePixelRatio: z.ZodNumber;
+        userAgent: z.ZodString;
+    }, z.core.$strip>;
+    provenance: z.ZodOptional<z.ZodObject<{
+        commitSha: z.ZodOptional<z.ZodString>;
+        branch: z.ZodOptional<z.ZodString>;
+        deploymentId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type Thread = z.infer<typeof Thread>;
+//# sourceMappingURL=thread.d.ts.map

package/dist/schemas/thread.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"thread.d.ts","sourceRoot":"","sources":["../../src/schemas/thread.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAOvB,eAAO,MAAM,YAAY;;;EAA+B,CAAA;AACxD,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;AAEvD,eAAO,MAAM,WAAW;;;EAAmC,CAAA;AAC3D,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAA;AAqBrD,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAA4C,CAAA;AACvE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIM,CAAA;AACzB,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@airnauts/comments-core",
+  "version": "0.1.0",
+  "description": "Framework-agnostic core for the Airnauts embeddable commenting tool: zod schemas, page-key normalization, the scoring/threshold policy, and the OpenAPI contract.",
+  "keywords": [
+    "comments",
+    "commenting",
+    "annotations",
+    "feedback",
+    "airnauts",
+    "zod",
+    "openapi"
+  ],
+  "license": "MIT",
+  "author": "Airnauts",
+  "homepage": "https://github.com/Airnauts/commenting-tool#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Airnauts/commenting-tool.git",
+    "directory": "packages/core"
+  },
+  "bugs": {
+    "url": "https://github.com/Airnauts/commenting-tool/issues"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/.tsbuildinfo",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "zod": "^4.4.3",
+    "zod-openapi": "^5.4.6"
+  },
+  "devDependencies": {
+    "@scalar/openapi-parser": "^0.28.5",
+    "tsx": "^4.22.3"
+  },
+  "scripts": {
+    "build": "tsup && tsc --build --force && tsx scripts/emit-openapi.ts",
+    "typecheck": "tsc --build",
+    "test": "vitest run",
+    "emit:openapi": "tsx scripts/emit-openapi.ts"
+  }
+}