@ingcreators/annot-annotator 0.3.0 → 0.6.0

package/dist/encode/encode.d.ts

@@ -16,10 +16,10 @@ import { EncodeResult } from './options.js';
  *            - Sample unique-colour count via {@link isPhotoHeavy}.
  *              If photo-heavy, emit `smartFallback` (PNG-32 or
  *              JPEG) with reason `"photo-fallback-*"`.
- *            - Otherwise quantize to ≤256 colours via libimagequant
- *              (if installed) and emit PNG-8 with reason `"png-8"`.
- *              When the optional imagequant WASM isn't installed,
- *              fall back to PNG-32 with `reason: "imagequant-missing"`.
+ *            - Otherwise quantize to ≤256 colours via the
+ *              in-tree Median Cut + FS dither and emit PNG-8 with
+ *              reason `"png-8"`. PNG-8 is unconditionally
+ *              available post-Phase 3 (no optional WASM gate).
  */
 export declare function encodeRgba(rgba: Uint8Array, width: number, height: number, options?: EncodeOptions): Promise<EncodeResult>;
 /**

package/dist/encode/quantize.d.ts

@@ -1,12 +1,10 @@
 /**
- * Quantize RGBA pixels to ≤256 colours via libimagequant and emit
- * a PNG-8 file. Returns the encoded bytes, OR `null` if the
- * optional imagequant module isn't installed.
+ * Quantize RGBA pixels to ≤256 colours via Median Cut + Floyd–
+ * Steinberg dither and emit a PNG-8 file.
  *
- * The caller is responsible for falling back to a non-PNG-8 path
- * (PNG-32 or JPEG) when this returns `null`.
+ * Synchronous, deterministic, GPL-free.
  */
-export declare function quantizeRgbaToPng8(rgba: Uint8Array, width: number, height: number): Promise<Uint8Array | null>;
+export declare function quantizeRgbaToPng8(rgba: Uint8Array, width: number, height: number): Uint8Array;
 /**
  * Heuristic: does this image look photo-heavy?
  *
@@ -17,7 +15,3 @@ export declare function quantizeRgbaToPng8(rgba: Uint8Array, width: number, heig
  * colours; pages with rich photography return >20,000.
  */
 export declare function isPhotoHeavy(rgba: Uint8Array, threshold: number): boolean;
-/** Whether the optional imagequant WASM is available at runtime.
- *  Useful for callers that want to decide ahead of time whether to
- *  request `format: "smart"`. */
-export declare function isImagequantAvailable(): Promise<boolean>;

package/dist/flatten-editable-png.d.ts

@@ -0,0 +1,37 @@
+/**
+ * "Burn" an editable PNG into a flat one — drop the editor's
+ * editable layer (Adobe XMP iTXt + custom `svGo` chunk) while
+ * keeping the visible bitmap byte-identical.
+ *
+ * The editable PNG format embeds:
+ *
+ *   - **visible bytes** — the annotated raster the user sees.
+ *   - **Adobe XMP iTXt chunk** — `<annot:annotations>` (the SVG
+ *     layer) + `<annot:tags>` (provenance) for re-edit.
+ *   - **custom `svGo` chunk** — the original un-annotated capture
+ *     for re-edit.
+ *
+ * Flattening strips the iTXt + svGo chunks. The result is a
+ * regular PNG with the same visible pixels but no recoverable
+ * original / no SVG layer. Re-opening in the editor shows the
+ * annotated capture as a non-editable bitmap;
+ * `readEditablePngBytes` returns `null`.
+ *
+ * Use cases:
+ *
+ *   - **Publish-flat** — editor session → distribution-ready
+ *     PNG; the editable layer is dead weight for downstream
+ *     consumers (Slack drop, third-party viewers).
+ *   - **File size** — editable PNG roughly doubles in bytes
+ *     (original + SVG); flattening drops the overhead.
+ *   - **Privacy hardening** — `burnRedactions` is the strong
+ *     version for *redact* regions; flattening drops the
+ *     recoverable original entirely for *all* annotations,
+ *     including non-redact ones whose annotated visual the
+ *     publisher wants to keep but whose original capture
+ *     they don't want shippable.
+ *
+ * Pure data — no DOM, no canvas. Returns input bytes unchanged
+ * when no editable-layer chunks are present (idempotent).
+ */
+export declare function flattenEditablePng(pngBytes: Uint8Array): Uint8Array;

package/dist/index.d.ts

@@ -1,8 +1,12 @@
-export { type Annotator, type AnnotatorInput, type AnnotatorOptions, createAnnotator, } from './annotator.js';
+export { type Annotator, type AnnotatorInput, type AnnotatorOptions, createAnnotator, type EditableInput, } from './annotator.js';
 export { decodeAndEncodeImage, encodeRgba } from './encode/encode.js';
 export { type BrowserEncodeResult, computeResizeTarget, DEFAULT_ENCODE_OPTIONS, type EncodeFormat, type EncodeOptions, type EncodeResult, SAVE_SIZE_LABEL, SAVE_SIZE_MAX_WIDTH, type SaveSizePreset, } from './encode/options.js';
-export { isImagequantAvailable, isPhotoHeavy } from './encode/quantize.js';
+export { isPhotoHeavy } from './encode/quantize.js';
+export { burnRedactions, burnRegions, type RedactRegion } from './redact-burn.js';
+export { type DiffOptions, type DiffResult, DimensionMismatchError, diffScreenshots, } from './diff.js';
+export { aggregateDiffRegions } from './diff-aggregate.js';
+export { flattenEditablePng } from './flatten-editable-png.js';
 export { BBOX_ANNOTATION_SCHEMA, BBOX_REDACT_REGION_SCHEMA, SHARED_DEFS, } from './dsl/schema.js';
 export { type ArrowOptions, arrowBetween, type BoundingBox, type RectOptions, rectForBoundingBox, type TextOptions, textAt, } from './dsl/svg-primitives.js';
 export { bboxAnnotationsToSvg } from './dsl/to-svg.js';
-export type { AnnotationStyle, BBox, BboxAnnotation, BboxArrowAnnotation, BboxCalloutAnnotation, BboxCircleAnnotation, BboxRectAnnotation, BboxRedactRegion, BboxTextAnnotation, Intent, Point, RawAnnotation, RedactStyle, } from './dsl/types.js';
+export type { AnnotationStyle, BadgePlacement, BBox, BboxAnnotation, BboxArrowAnnotation, BboxCalloutAnnotation, BboxCircleAnnotation, BboxFocusMaskAnnotation, BboxFreehandAnnotation, BboxNumberedBadgeAnnotation, BboxRectAnnotation, BboxRedactRegion, BboxTextAnnotation, Intent, Point, RawAnnotation, RedactStyle, } from './dsl/types.js';