@ingcreators/annot-core 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @ingcreators/annot-core
+
+## 0.1.0
+
+### Minor Changes
+
+- 408791f: Initial public release — headless annotator + Playwright fixture + SDK.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ingcreators
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,56 @@
+# @ingcreators/annot-core
+
+The shared core of [Annot](../../README.md). Two tiers live here:
+
+- **Tier A** — pure Node, DOM-free. Storage types, SVG format
+  versioning, path utilities, ZIP builder, capability predicates,
+  encode helpers.
+- **Tier B** — jsdom-friendly element-takers. SVG-element helpers
+  (`arrow-markers`, `transform-utils`, `shape-utils`, `text-utils`,
+  `gradient-utils`), the `TOOL_REGISTRY` / `PROPERTY_CONTROLS`
+  registries, the OOXML shape mapping (`svg-to-annotation-shapes`).
+  No `<canvas>`, no live editor.
+
+Live-browser editor primitives (CanvasManager, SelectionManager,
+PropertyPanel, tools) live in [`@ingcreators/annot-editor`](../editor).
+Data-driven canvas rendering (gallery thumbnails, the shared OOXML
+DrawingML builder) lives in [`@ingcreators/annot-render`](../render).
+
+## Public entry points
+
+| Subpath | Tier | Surface |
+|---------|------|---------|
+| `@ingcreators/annot-core` | A | Re-exports everything from `/headless` — DOM-free root entry |
+| `@ingcreators/annot-core/headless` | A | Same as root, kept as an alias for callers that want to be explicit |
+| `@ingcreators/annot-core/storage` | A | `ImageRecord`, `FolderRecord`, `PageElement`, `PageMetadata`, `StorageProvider` |
+| `@ingcreators/annot-core/utils` | A | `assertNonNull`, `computeDasharray`, `newIdB58`, defaults |
+| `@ingcreators/annot-core/zip` | A | ZIP builder used by PPTX export |
+| `@ingcreators/annot-core/encode` | A | Image encode helpers |
+| `@ingcreators/annot-core/editor` | B | jsdom-friendly element helpers + `TOOL_REGISTRY` / `PROPERTY_CONTROLS` |
+| `@ingcreators/annot-core/xmp` | browser | `createEditableImage` / `readEditableImage` round-trip |
+| `@ingcreators/annot-core/desktop-bridge` | browser | Electron desktop-host IPC + `isDesktop` detection |
+
+The Tier A surface is CI-enforced by
+[`src/headless.test.ts`](./src/headless.test.ts): it imports every
+documented subpath in a pure-Node Vitest environment and asserts no
+DOM globals leak in. It also walks the loader cache to prove that
+no `annot-core` module transitively pulls `annot-editor` or
+`annot-render` (cycle invariant).
+
+## Build
+
+```bash
+pnpm --filter @ingcreators/annot-core build      # vite library build
+pnpm --filter @ingcreators/annot-core typecheck  # tsc --noEmit
+```
+
+## See also
+
+- [Root README](../../README.md) — monorepo overview, getting started.
+- [`PRODUCT_DIRECTION.md`](../../PRODUCT_DIRECTION.md) — strategic north star (this package is the future
+  headless library boundary).
+- [`CLAUDE.md`](../../CLAUDE.md) — Tier model rationale and the rules for adding new symbols.
+
+## License
+
+[Apache License, Version 2.0](../../LICENSE) © ingcreators.

package/dist/auto-capture-options.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Auto Capture engine settings — shared between
+ * `@ingcreators/annot-web` (live) and `@ingcreators/annot-extension`
+ * (future, when the extension grows its own Auto Capture surface).
+ *
+ * Three discrete-choice presets cover the spec §6.6 settings —
+ * raw millisecond / ratio numbers stay internal so the UI can
+ * surface readable labels and the encoder doesn't have to validate
+ * arbitrary user input.
+ *
+ * Persistence shape on each host:
+ * - Web: `localStorage["annot-auto-capture-options"]` mirrors this
+ *   `AutoCaptureOptions` blob 1:1, with `loadAutoCaptureOptions()`
+ *   doing the merge / validation.
+ * - Extension (future): one nested record under
+ *   `Settings.autoCapture` in `chrome.storage.sync`, mirroring the
+ *   `Settings.quality` precedent.
+ *
+ * The engine consumes the resolved milliseconds via the Tier C
+ * `<annot-capture-workspace>` wiring; this Tier A leaf is pure
+ * data + helpers so it pulls into a Node test harness without the
+ * DOM / Lit / engine code.
+ */
+/** Sampling cadence — how often the engine grabs a comparison
+ *  frame. Faster catches sub-second flickers; slower reduces
+ *  CPU pressure on low-end machines. */
+export type CaptureIntervalPreset = "fast" | "standard" | "slow";
+/** How aggressively the engine treats a frame diff as "meaningful".
+ *  - sensitive: small UI changes (a button hover) trigger captures
+ *  - standard: typical procedure-doc flow (page navigation, dialog open)
+ *  - major: only obvious changes (full-page navigation, modal swap) */
+export type ChangeSensitivityPreset = "sensitive" | "standard" | "major";
+/** How long the engine waits for the screen to settle before
+ *  capturing — protects against capturing mid-animation frames.
+ *  - none: capture immediately when diff drops below threshold
+ *  - short: spec default (700ms)
+ *  - long: animation-heavy sites that take >1s to settle */
+export type StableWaitPreset = "none" | "short" | "long";
+export interface AutoCaptureOptions {
+    /** Sampling cadence preset. */
+    interval: CaptureIntervalPreset;
+    /** Diff-detection threshold preset. */
+    sensitivity: ChangeSensitivityPreset;
+    /** Stable-wait duration preset. */
+    stableWait: StableWaitPreset;
+    /** When true, frames whose only change is a localized cursor-
+     *  shaped region are dropped (no candidate created). Default
+     *  on — most users want stable workflow captures, not cursor
+     *  movements. */
+    ignoreCursorOnlyChanges: boolean;
+}
+export declare const DEFAULT_AUTO_CAPTURE_OPTIONS: AutoCaptureOptions;
+/** Preset → millisecond mapping. Engine consumes the resolved
+ *  milliseconds; UI surfaces the preset key + the human label
+ *  via {@link CAPTURE_INTERVAL_LABEL}. */
+export declare const CAPTURE_INTERVAL_MS: Record<CaptureIntervalPreset, number>;
+export declare const CAPTURE_INTERVAL_LABEL: Record<CaptureIntervalPreset, string>;
+/** Preset → diff ratio threshold. Higher = more change required
+ *  before the engine treats the frame as meaningful. */
+export declare const CHANGE_SENSITIVITY_RATIO: Record<ChangeSensitivityPreset, number>;
+export declare const CHANGE_SENSITIVITY_LABEL: Record<ChangeSensitivityPreset, string>;
+/** Preset → stable-wait milliseconds. */
+export declare const STABLE_WAIT_MS: Record<StableWaitPreset, number>;
+export declare const STABLE_WAIT_LABEL: Record<StableWaitPreset, string>;
+/** Engine-facing resolved values. The Tier C
+ *  `<annot-capture-workspace>` calls this once when starting the
+ *  engine and passes the result into `AutoCaptureEngine`. */
+export interface ResolvedAutoCaptureSettings {
+    intervalMs: number;
+    changeRatioThreshold: number;
+    stableWaitMs: number;
+    ignoreCursorOnlyChanges: boolean;
+}
+export declare function resolveAutoCaptureOptions(opts?: AutoCaptureOptions): ResolvedAutoCaptureSettings;
+/** Type guards — useful for the persistence layer's merge step. */
+export declare function isCaptureIntervalPreset(v: unknown): v is CaptureIntervalPreset;
+export declare function isChangeSensitivityPreset(v: unknown): v is ChangeSensitivityPreset;
+export declare function isStableWaitPreset(v: unknown): v is StableWaitPreset;

package/dist/editor/arrow-markers.d.ts

@@ -0,0 +1,142 @@
+import { ArrowDim, ArrowShape } from './tool-options.js';
+export interface Point {
+    x: number;
+    y: number;
+}
+export interface ArrowSpec {
+    shape: ArrowShape;
+    /** OOXML `w` — perpendicular-to-stem thickness preset. */
+    width: ArrowDim;
+    /** OOXML `len` — along-stem length preset. */
+    length: ArrowDim;
+}
+/**
+ * Minimal adapter that mirrors the subset of `AbstractCanvas2D`
+ * maxGraph's marker factories call. Internally it just accumulates
+ * SVG path commands into a `d` attribute string.
+ */
+declare class SvgPathCanvas {
+    #private;
+    begin(): void;
+    moveTo(x: number, y: number): void;
+    lineTo(x: number, y: number): void;
+    quadTo(cx: number, cy: number, x: number, y: number): void;
+    close(): void;
+    /** maxGraph emits `canvas.ellipse(x, y, w, h)` for the oval
+     *  marker (box top-left + box dimensions). We render it as two
+     *  half-arc commands — SVG A commands can't draw a full ellipse
+     *  in a single sweep. */
+    ellipse(x: number, y: number, w: number, h: number): void;
+    stroke(): void;
+    fillAndStroke(): void;
+    get d(): string;
+    clear(): void;
+}
+export interface ArrowRenderResult {
+    /** Whether the arrow head is a filled (closed) shape. Used by the
+     *  caller to decide whether to route this head's path data into
+     *  the "filled" head `<path>` (fill=stroke) or the "open" head
+     *  `<path>` (fill=none). Splitting is REQUIRED when mixing filled
+     *  and open heads on the same arrow — e.g. start=oval + end=arrow
+     *  — because a single `<path>` with fill=stroke would auto-close
+     *  the open chevron subpath and render it as a filled triangle. */
+    filled: boolean;
+}
+/**
+ * Render one arrow head into `canvas` at endpoint `pe`, mutating
+ * `pe` to the shortened line endpoint. The returned `filled` flag
+ * tells the caller whether to set fill=stroke on the parent path.
+ */
+export declare function renderArrowHead(canvas: SvgPathCanvas, spec: ArrowSpec, pe: Point, unitX: number, unitY: number, strokeWidth: number): ArrowRenderResult;
+/**
+ * Compute the stem and arrow-head path-data strings independently.
+ *
+ * The heads mutate their respective endpoints inward so the stem
+ * stops exactly where the head begins. The two `d` strings are
+ * returned separately so the caller can render them in separate
+ * `<path>` elements — that lets the stem carry a dash pattern
+ * (`stroke-dasharray`) WITHOUT the dashes bleeding into the arrow-
+ * head outlines (a single `<path>` would apply its dasharray to
+ * every subpath including the closed heads).
+ *
+ * `anyFilled` signals that at least one head is a filled (closed)
+ * shape, so the head `<path>` should use `fill=stroke` to paint
+ * the interiors.
+ */
+export declare function computeArrowParts(x1: number, y1: number, x2: number, y2: number, specStart: ArrowSpec, specEnd: ArrowSpec, strokeWidth: number, control?: Point | null): {
+    stemD: string;
+    headFilledD: string;
+    headOpenD: string;
+};
+/** Read the per-end arrow spec off an existing arrow <path> element.
+ *  Mirrors the data-* attribute contract applyArrowPath writes. */
+export declare function detectArrowSpec(el: SVGElement, end: "start" | "end"): ArrowSpec;
+/** Write the arrow spec back onto an element. */
+export declare function writeArrowSpec(el: SVGElement, end: "start" | "end", spec: ArrowSpec): void;
+/** Read the geometric endpoints of an arrow `<path>` element. The
+ *  x1/y1/x2/y2 values are stored as data attrs (the `d` string is
+ *  derived from them). */
+export declare function readArrowEndpoints(el: SVGElement): {
+    x1: number;
+    y1: number;
+    x2: number;
+    y2: number;
+};
+export declare function writeArrowEndpoints(el: SVGElement, x1: number, y1: number, x2: number, y2: number): void;
+/** Read the quadratic-bezier control point for a curved arrow, or
+ *  null if the arrow is straight (no data-cx/cy set). */
+export declare function readArrowControl(el: SVGElement): Point | null;
+/** Write the control point (turns the arrow curved) or clear it
+ *  (back to straight). Pass null to straighten. */
+export declare function writeArrowControl(el: SVGElement, control: Point | null): void;
+/**
+ * Rebuild the stem and arrow-head `<path>` children of an arrow
+ * `<g>` wrapper from its current endpoint and arrow-spec data attrs.
+ * Called after any endpoint drag / arrow-head change / stroke-width
+ * change so the composed geometry stays in sync.
+ *
+ * DOM shape expected:
+ *   <g data-type="arrow" data-x1=.. data-y1=.. data-x2=.. data-y2=..
+ *                        data-arrow-start-* ... data-arrow-end-* ...
+ *                        stroke=.. stroke-width=.. stroke-dasharray=.. fill=..>
+ *     <path data-role="stem"        d="..."/>
+ *     <path data-role="head-filled" d="..." fill=stroke/>
+ *     <path data-role="head-open"   d="..." fill="none"/>
+ *   </g>
+ *
+ * Missing children are created on the fly so old DOM upgrades
+ * cleanly. We use TWO head paths so mixed configurations (e.g.
+ * oval at start + open arrow at end) render correctly — a single
+ * head path with fill=stroke would implicitly close the open
+ * chevron into a filled triangle.
+ */
+export declare function refreshArrowPath(el: SVGElement): void;
+/**
+ * Inline SVG for an arrow-end shape used by the per-end pulldown
+ * cells. Shared 40×14 viewBox with `arrowSizePreview` so Begin/End
+ * type and size buttons render at the same apparent stem length —
+ * the four rows line up visually in the right panel instead of
+ * looking like mismatched pairs.
+ */
+export declare function arrowPreview(shape: ArrowShape, dir?: "left" | "right"): string;
+/**
+ * Inner SVG for `arrowPreview` — the head + stem geometry without
+ * the wrapping `<svg>` element. Exposed separately so callers can
+ * compose it inside their own `<svg>` (used by the toolbar's
+ * variant flyout).
+ *
+ * 40×14 viewBox. Stem along y=7, head occupies x∈[28,38], 10-unit
+ * long × 10-unit wide (tip at x=38, base at x=28). The stem's
+ * right endpoint varies per shape so it touches the marker's
+ * attachment point (chevron tip, stealth notch, filled base, etc).
+ */
+export declare function arrowPreviewContent(shape: ArrowShape): string;
+/**
+ * Render an arrow head preview at the requested width × length so
+ * the per-end size pulldown's cells accurately reflect the actual
+ * canvas rendering. Uses the same `computeArrowParts` engine the
+ * canvas uses, eliminating the previous ad-hoc scale table that
+ * tended to drift from real geometry.
+ */
+export declare function arrowSizePreview(w: ArrowDim, l: ArrowDim, dir?: "left" | "right"): string;
+export {};