dytools-capture-engine 1.0.0 → 1.0.1

package/dist/index.d.cts

@@ -0,0 +1,560 @@
+import { Rectangle, InteractiveObject, Size, Point, Polygon, Vector } from 'dytools-canvas-engine';
+import { Result } from 'dytools-result';
+
+type ExternalZoneType = "TemplateSimpleZone" | "TemplateAnchorZone" | "TemplateAnchorZoneChild";
+interface ExternalTemplateZone {
+    TemplateZoneId: string;
+    Name: string;
+    Type: ExternalZoneType;
+    X: number;
+    Y: number;
+    Width: number;
+    Height: number;
+    XAbsolute?: number;
+    YAbsolute?: number;
+    WidthAbsolute?: number;
+    HeightAbsolute?: number;
+    AnchorLocationXAbsoluteHint?: number;
+    AnchorLocationYAbsoluteHint?: number;
+    RegExFilter?: string | null;
+    RegExOutput?: string | null;
+    RegExReplacement?: string | null;
+    Required?: boolean;
+    DataType?: string | null;
+    ExcludeFromOutput?: boolean;
+    DefaultValueIfEmpty?: string | null;
+    AnchorLocation?: string;
+    GroupChildrenInSubRecord?: boolean;
+    ChildZones?: ExternalTemplateZone[];
+}
+interface ExternalTemplate {
+    Name: string;
+    DocumentWidth?: number;
+    DocumentHeight?: number;
+    Zones: ExternalTemplateZone[];
+}
+declare const CapturePublicEventType: {
+    readonly ZonePositionChanged: "zone:position_changed";
+    readonly ZoneNameChanged: "zone:name_changed";
+    readonly ZoneFilterRegexChanged: "zone:filter_regex_changed";
+    readonly ZoneExampleChanged: "zone:example_changed";
+    readonly ZoneHiddenChanged: "zone:hidden_changed";
+    readonly ZoneChanged: "zone:changed";
+    readonly TemplateChanged: "template:changed";
+    readonly ZoneSelected: "zone:selected";
+    readonly ZoneDeselected: "zone:deselected";
+    readonly ZoneFlagsAdded: "zone:flags_added";
+    readonly ZoneFlagsRemoved: "zone:flags_removed";
+    readonly ZoneAdded: "capture:zone_added";
+    readonly ZoneRemoved: "capture:zone_removed";
+    readonly ViewportChanged: "capture:viewport_changed";
+    readonly DrawingCompleted: "capture:drawing_completed";
+    readonly OcrShown: "capture:ocr_shown";
+    readonly OcrHidden: "capture:ocr_hidden";
+    readonly OcrReadLoaded: "capture:api_ocr_loaded";
+    readonly OcrMatchesLoaded: "capture:api_ocr_matches_loaded";
+    readonly CaptureStarted: "capture:started";
+    readonly CaptureError: "capture:error";
+    readonly CaptureBackgroundChanged: "capture:background_changed";
+    readonly CaptureRenderStarted: "capture:render_started";
+    readonly CaptureRenderCompleted: "capture:render_completed";
+};
+type CapturePublicEventType = typeof CapturePublicEventType[keyof typeof CapturePublicEventType];
+interface CapturePublicEventPayloads {
+    [CapturePublicEventType.ZonePositionChanged]: {
+        zone: TemplateZoneBase;
+        oldPosition: Rectangle;
+        newPosition: Rectangle;
+    };
+    [CapturePublicEventType.ZoneNameChanged]: {
+        zone: TemplateZoneBase;
+        oldName: string;
+        newName: string;
+    };
+    [CapturePublicEventType.ZoneFilterRegexChanged]: {
+        zone: TemplateZoneBase;
+        oldFilterRegex: number;
+        newFilterRegex: number;
+    };
+    [CapturePublicEventType.ZoneExampleChanged]: {
+        zone: TemplateZoneBase;
+        oldExample: string;
+        newExample: string;
+    };
+    [CapturePublicEventType.ZoneHiddenChanged]: {
+        zone: TemplateZoneBase;
+        oldHidden: boolean;
+        newHidden: boolean;
+    };
+    [CapturePublicEventType.ZoneChanged]: {
+        zone: TemplateZoneBase;
+        propertiesChanged: string[];
+    };
+    [CapturePublicEventType.TemplateChanged]: {};
+    [CapturePublicEventType.ZoneSelected]: {
+        zone: TemplateZoneBase;
+    };
+    [CapturePublicEventType.ZoneDeselected]: {
+        zone: TemplateZoneBase;
+    };
+    [CapturePublicEventType.ZoneFlagsAdded]: {
+        zone: TemplateZoneBase;
+        addedFlags: string[];
+        currentFlags: string[];
+    };
+    [CapturePublicEventType.ZoneFlagsRemoved]: {
+        zone: TemplateZoneBase;
+        removedFlags: string[];
+        currentFlags: string[];
+    };
+    [CapturePublicEventType.ZoneAdded]: {
+        newZone: TemplateZoneBase;
+        parentZone?: TemplateZoneBase;
+        isChildZone?: boolean;
+    };
+    [CapturePublicEventType.ZoneRemoved]: {
+        id: string;
+        removedZone?: TemplateZoneBase;
+        parentZone?: TemplateZoneBase;
+        isChildZone?: boolean;
+    };
+    [CapturePublicEventType.ViewportChanged]: {
+        oldPan: Vector;
+        newPan: Vector;
+        oldZoom: number;
+        newZoom: number;
+    };
+    [CapturePublicEventType.DrawingCompleted]: {
+        rect: Rectangle;
+        maxZ: number;
+    };
+    [CapturePublicEventType.OcrShown]: {};
+    [CapturePublicEventType.OcrHidden]: {};
+    [CapturePublicEventType.OcrReadLoaded]: {
+        ocr: OcrRead | null;
+    };
+    [CapturePublicEventType.OcrMatchesLoaded]: {
+        matches: ZoneOcrMatch[];
+    };
+    [CapturePublicEventType.CaptureStarted]: {};
+    [CapturePublicEventType.CaptureError]: {
+        error?: Error;
+        message: string;
+    };
+    [CapturePublicEventType.CaptureBackgroundChanged]: {
+        newImage: Blob;
+        newWidth: number;
+        newHeight: number;
+        oldWidth: number;
+        oldHeight: number;
+    };
+    [CapturePublicEventType.CaptureRenderStarted]: {};
+    [CapturePublicEventType.CaptureRenderCompleted]: {};
+}
+declare const CaptureZoneEventType: {
+    readonly ZoneCanvasManagerSet: "zone_internal:canvas_manager_set";
+    readonly ZonePositionChanged: "zone_internal:position_changed";
+    readonly ZoneColorChanged: "zone_internal:color_changed";
+    readonly ZoneNameChanged: "zone_internal:name_changed";
+    readonly ZoneExampleChanged: "zone_internal:example_changed";
+    readonly ZoneHiddenChanged: "zone_internal:hidden_changed";
+    readonly ZoneFilterRegexChanged: "zone_internal:filter_regex_changed";
+    readonly ZoneOutputRegexChanged: "zone_internal:output_regex_changed";
+    readonly ZoneOutputReplacementChanged: "zone_internal:output_replacement_changed";
+    readonly ZoneRequiredChanged: "zone_internal:required_changed";
+    readonly ZoneDataTypeChanged: "zone_internal:data_type_changed";
+    readonly ZoneExcludeFromOutputChanged: "zone_internal:exclude_from_output_changed";
+    readonly ZoneDefaultValueIfEmptyChanged: "zone_internal:default_value_if_empty_changed";
+    readonly ZoneOcrMatchesChanged: "zone_internal:ocr_matches_changed";
+    readonly ZoneGroupChildrenChanged: "zone_internal:group_children_changed";
+    readonly ZoneAnchorLocationChanged: "zone_internal:anchor_location_changed";
+};
+type CaptureZoneEventType = typeof CaptureZoneEventType[keyof typeof CaptureZoneEventType];
+interface CaptureZoneEventPayloads {
+    [CaptureZoneEventType.ZonePositionChanged]: {
+        oldPosition: Rectangle;
+        newPosition: Rectangle;
+    };
+    [CaptureZoneEventType.ZoneColorChanged]: {
+        oldColor: string;
+        newColor: string;
+    };
+    [CaptureZoneEventType.ZoneNameChanged]: {
+        oldName: string;
+        newName: string;
+    };
+    [CaptureZoneEventType.ZoneExampleChanged]: {
+        oldExample: string | null;
+        newExample: string | null;
+    };
+    [CaptureZoneEventType.ZoneHiddenChanged]: {
+        oldHidden: boolean;
+        newHidden: boolean;
+    };
+    [CaptureZoneEventType.ZoneFilterRegexChanged]: {
+        oldFilterRegex: string | null;
+        newFilterRegex: string | null;
+    };
+    [CaptureZoneEventType.ZoneOutputRegexChanged]: {
+        oldOutputRegex: string | null;
+        newOutputRegex: string | null;
+    };
+    [CaptureZoneEventType.ZoneOutputReplacementChanged]: {
+        oldOutputReplacement: string | null;
+        newOutputReplacement: string | null;
+    };
+    [CaptureZoneEventType.ZoneRequiredChanged]: {
+        oldRequired: boolean;
+        newRequired: boolean;
+    };
+    [CaptureZoneEventType.ZoneDataTypeChanged]: {
+        oldDataType: string | null;
+        newDataType: string | null;
+    };
+    [CaptureZoneEventType.ZoneExcludeFromOutputChanged]: {
+        oldExcludeFromOutput: boolean;
+        newExcludeFromOutput: boolean;
+    };
+    [CaptureZoneEventType.ZoneDefaultValueIfEmptyChanged]: {
+        oldDefaultValueIfEmpty: string | null;
+        newDefaultValueIfEmpty: string | null;
+    };
+    [CaptureZoneEventType.ZoneCanvasManagerSet]: {
+        canvasManager: ZoneCanvasManager;
+    };
+    [CaptureZoneEventType.ZoneOcrMatchesChanged]: {
+        matches: InternalZoneOcrMatch[] | null;
+    };
+    [CaptureZoneEventType.ZoneGroupChildrenChanged]: {
+        newGroupChildren: boolean;
+        oldGroupChildren: boolean;
+    };
+    [CaptureZoneEventType.ZoneAnchorLocationChanged]: {
+        oldAnchorLocation: AnchorLocation;
+        newAnchorLocation: AnchorLocation;
+    };
+}
+declare const CaptureEngineToZoneEventType: {
+    readonly CanvasObjectPositionChanged: "canvas:object_position_changed";
+    readonly CanvasObjectResized: "canvas:object_resized";
+    readonly CanvasObjectMoved: "canvas:object_moved";
+    readonly ZoneSelected: "zone:selected";
+    readonly ZoneDeselected: "zone:deselected";
+    readonly ZoneFlagsAdded: "zone:flags_added";
+    readonly ZoneFlagsRemoved: "zone:flags_removed";
+    readonly CaptureOcrReadLoaded: "capture:ocr_read_loaded";
+    readonly CaptureOcrMatchesLoaded: "capture:ocr_matches_loaded";
+};
+type CaptureEngineToZoneEventType = typeof CaptureEngineToZoneEventType[keyof typeof CaptureEngineToZoneEventType];
+interface CaptureEngineToZoneEventPayloads {
+    [CaptureEngineToZoneEventType.CanvasObjectPositionChanged]: {
+        object: InteractiveObject;
+        oldPosition: Rectangle;
+        newPosition: Rectangle;
+    };
+    [CaptureEngineToZoneEventType.CanvasObjectResized]: {
+        object: InteractiveObject;
+        oldSize: Size;
+        newSize: Size;
+    };
+    [CaptureEngineToZoneEventType.CanvasObjectMoved]: {
+        object: InteractiveObject;
+        oldPoint: Point;
+        newPoint: Point;
+    };
+    [CaptureEngineToZoneEventType.ZoneSelected]: {};
+    [CaptureEngineToZoneEventType.ZoneDeselected]: {};
+    [CaptureEngineToZoneEventType.ZoneFlagsAdded]: {
+        addedFlags: string[];
+        currentFlags: string[];
+    };
+    [CaptureEngineToZoneEventType.ZoneFlagsRemoved]: {
+        removedFlags: string[];
+        currentFlags: string[];
+    };
+    [CaptureEngineToZoneEventType.CaptureOcrReadLoaded]: {
+        ocrRead: OcrRead | null;
+    };
+    [CaptureEngineToZoneEventType.CaptureOcrMatchesLoaded]: {
+        ocrMatches: InternalZoneOcrMatch[] | null;
+    };
+}
+declare const CaptureToEngineEventType: {
+    readonly ZonePositionChanged: "zone:position_changed";
+    readonly ZoneNameChanged: "zone:name_changed";
+    readonly ZoneFilterRegexChanged: "zone:filter_regex_changed";
+    readonly ZoneOutputRegexChanged: "zone:output_regex_changed";
+    readonly ZoneOutputReplacementChanged: "zone:output_replacement_changed";
+    readonly ZoneRequiredChanged: "zone:required_changed";
+    readonly ZoneDataTypeChanged: "zone:data_type_changed";
+    readonly ZoneExcludeFromOutputChanged: "zone:exclude_from_output_changed";
+    readonly ZoneDefaultValueIfEmptyChanged: "zone:default_value_if_empty_changed";
+    readonly ZoneExampleChanged: "zone:example_changed";
+    readonly ZoneHiddenChanged: "zone:hidden_changed";
+    readonly ZoneChanged: "zone:changed";
+    readonly ZoneAnchorLocationChanged: "zone:anchor_location_changed";
+    readonly ZoneGroupChildrenChanged: "zone:group_children_changed";
+    readonly ZoneChildZoneAdded: "zone:child_zone_added";
+    readonly ZoneChildZoneRemoved: "zone:child_zone_removed";
+    readonly ZoneChildZonesChanged: "zone:child_zone_changed";
+    readonly ZoneError: "zone:error";
+};
+type CaptureToEngineEventType = typeof CaptureToEngineEventType[keyof typeof CaptureToEngineEventType];
+interface CaptureToEngineEventPayloads {
+    [CaptureToEngineEventType.ZonePositionChanged]: {
+        zone: TemplateZoneBase;
+        oldPosition: Rectangle;
+        newPosition: Rectangle;
+    };
+    [CaptureToEngineEventType.ZoneNameChanged]: {
+        zone: TemplateZoneBase;
+        oldName: string;
+        newName: string;
+    };
+    [CaptureToEngineEventType.ZoneFilterRegexChanged]: {
+        zone: TemplateZoneBase;
+        oldFilterRegex: string | null;
+        newFilterRegex: string | null;
+    };
+    [CaptureToEngineEventType.ZoneOutputRegexChanged]: {
+        zone: TemplateZoneBase;
+        oldOutputRegex: string | null;
+        newOutputRegex: string | null;
+    };
+    [CaptureToEngineEventType.ZoneOutputReplacementChanged]: {
+        zone: TemplateZoneBase;
+        oldOutputReplacement: string | null;
+        newOutputReplacement: string | null;
+    };
+    [CaptureToEngineEventType.ZoneRequiredChanged]: {
+        zone: TemplateZoneBase;
+        oldRequired: boolean;
+        newRequired: boolean;
+    };
+    [CaptureToEngineEventType.ZoneDataTypeChanged]: {
+        zone: TemplateZoneBase;
+        oldDataType: string | null;
+        newDataType: string | null;
+    };
+    [CaptureToEngineEventType.ZoneExcludeFromOutputChanged]: {
+        zone: TemplateZoneBase;
+        oldExcludeFromOutput: boolean;
+        newExcludeFromOutput: boolean;
+    };
+    [CaptureToEngineEventType.ZoneDefaultValueIfEmptyChanged]: {
+        zone: TemplateZoneBase;
+        oldDefaultValueIfEmpty: string | null;
+        newDefaultValueIfEmpty: string | null;
+    };
+    [CaptureToEngineEventType.ZoneExampleChanged]: {
+        zone: TemplateZoneBase;
+        oldExample: string | null;
+        newExample: string | null;
+    };
+    [CaptureToEngineEventType.ZoneHiddenChanged]: {
+        zone: TemplateZoneBase;
+        oldHidden: boolean;
+        newHidden: boolean;
+    };
+    [CaptureToEngineEventType.ZoneChanged]: {
+        zone: TemplateZoneBase;
+        propertiesChanged: string[];
+    };
+    [CaptureToEngineEventType.ZoneAnchorLocationChanged]: {
+        zone: TemplateZoneBase;
+        oldAnchorLocation: AnchorLocation;
+        newAnchorLocation: AnchorLocation;
+    };
+    [CaptureToEngineEventType.ZoneGroupChildrenChanged]: {
+        zone: TemplateZoneBase;
+        newGroupChildren: boolean;
+        oldGroupChildren: boolean;
+    };
+    [CaptureToEngineEventType.ZoneChildZoneAdded]: {
+        parentZone: TemplateZoneBase;
+        newChildZone: TemplateZoneBase;
+    };
+    [CaptureToEngineEventType.ZoneChildZoneRemoved]: {
+        parentZone: TemplateZoneBase;
+        removedChildZone: TemplateZoneBase;
+    };
+    [CaptureToEngineEventType.ZoneChildZonesChanged]: {
+        parentZone: TemplateZoneBase;
+    };
+    [CaptureToEngineEventType.ZoneError]: {
+        zone: TemplateZoneBase;
+        error?: Error;
+        message: string;
+    };
+}
+type ZoneKind = "simple" | "anchor" | "anchor-child";
+type AnchorLocation = "TopLeft" | "TopRight" | "BottomLeft" | "BottomRight" | "Center";
+interface TemplateZoneBase {
+    id: string;
+    name: string;
+    type: ZoneKind;
+    example: string | null;
+    needsAnchorReposition: boolean;
+    rect: Rectangle;
+    hidden?: boolean;
+    filterRegex: string | null;
+    outputRegex: string | null;
+    outputReplacement: string | null;
+    required: boolean;
+    dataType: string | null;
+    excludeFromOutput: boolean;
+    defaultValueIfEmpty: string | null;
+    anchorLocation?: AnchorLocation;
+    groupChildren?: boolean;
+    children?: TemplateZoneBase[];
+    handleEvent?<T extends CaptureEngineToZoneEventType>(id: string, type: T, payload: CaptureEngineToZoneEventPayloads[T]): void;
+    setCanvasManager?(cm?: ZoneCanvasManager): void;
+    toExternal(docWidth: number, docHeight: number): ExternalTemplateZone;
+    setEngineEventSink?(callback?: (type: CaptureToEngineEventType, payload?: CaptureToEngineEventPayloads[CaptureToEngineEventType]) => void): void;
+}
+interface ZoneCanvasManager {
+    readonly zoneId: string;
+    addPolygon(points: Point[], color: string, isSelectable: boolean): string;
+    addRectangle(rect: Rectangle, name: string | null, color: string, isResizable: boolean, isSelectable: boolean): string;
+    addCircle(center: Point, radius: number, color: string, isResizable: boolean, isSelectable: boolean): string;
+    setName(id: string, name: string | null): void;
+    setColor(id: string, color: string): void;
+    setSelectable(id: string, isSelectable: boolean): void;
+    setResizable(id: string, isResizable: boolean): void;
+    setRectangleSize(id: string, rect: Rectangle): void;
+    setVisibility(id: string, isVisible: boolean): void;
+    removeObject(id: string): void;
+    /** convenience for “wipe all visuals for this zone” */
+    clearAll(): void;
+}
+declare class CaptureEngine {
+    private readonly engine;
+    private listeners;
+    private serverApi?;
+    private _name;
+    zones: TemplateZoneBase[];
+    private ocrRead;
+    private zoneOcrMatches;
+    private ocrOverlayIds;
+    private flags;
+    private zoneCounter;
+    constructor(selector: string, serverApi?: CaptureEngineServerApi);
+    private setupEngine;
+    on<T extends CapturePublicEventType>(event: T, handler: (payload: CapturePublicEventPayloads[T]) => void, options?: {
+        once?: boolean;
+    }): void;
+    off<T extends CapturePublicEventType>(event: T, handler: (payload: CapturePublicEventPayloads[T]) => void): void;
+    private emitExternal;
+    private emitToZone;
+    private refreshMatches;
+    private engineEventHandler;
+    private onZoneAdded;
+    private onZoneRemoved;
+    private getZoneByCanvasEngineId;
+    private doRender;
+    private createMeteredFn;
+    loadExternalTemplate(external: ExternalTemplate, reapplyZonePositioning: boolean): void;
+    getExternalTemplate(): ExternalTemplate;
+    private rectFromExternal;
+    private zoneFromExternal;
+    get name(): string;
+    set name(value: string);
+    get allZonesFlattened(): TemplateZoneBase[];
+    getZoneById(id: string): TemplateZoneBase | undefined;
+    /**
+     * Add a new simple zone
+     * @param bounds Rectangle
+     */
+    addSimpleZone(bounds: Rectangle): void;
+    /**
+     * Add a new anchor zone
+     * @param bounds Rectangle
+     */
+    addAnchorZone(bounds: Rectangle): void;
+    /**
+     * Add a child zone linked to an anchor
+     * @param anchorId string
+     * @param bounds Rectangle
+     */
+    addAnchorChildZone(anchorId: string, bounds: Rectangle): void;
+    /**
+     * Remove a zone and its canvas representation by id
+     * @param id string
+     */
+    removeZoneById(id: string): boolean;
+    updateZone(id: string, patch: Partial<TemplateZoneBase>): void;
+    private setFlag;
+    private clearFlag;
+    hasFlag(objOrId: string | TemplateZoneBase, flag: string): boolean;
+    private clearAllFlags;
+    getObjectsWithFlag(flag: string): TemplateZoneBase[];
+    setSelectedZones(objOrIds: (string | TemplateZoneBase)[]): void;
+    getSelectedZones(): TemplateZoneBase[];
+    get pan(): Vector;
+    get zoom(): number;
+    setZoom(zoom: number, center?: Point): void;
+    setPan(x: number, y: number): void;
+    get width(): number;
+    get height(): number;
+    setBackgroundImage(imageOrUrl: string | File | Blob): Promise<void>;
+    switchMode(name: string): void;
+    get mode(): string;
+    /**
+     * Render the current OCR snapshot as non-interactive polygons on the canvas.
+     */
+    showOcr(): void;
+    /**
+     * Remove OCR overlay polygons from the canvas.
+     */
+    hideOcr(): void;
+    get isOcrShown(): boolean;
+    setOcrSnapshot(ocrRead: OcrRead | null): void;
+    getOcrSnapshot(): OcrRead | null;
+    setOcrMatchesSnapshot(matches: ZoneOcrMatch[]): void;
+    getOcrMatchesSnapshot(): ZoneOcrMatch[];
+    setServerApi(api: CaptureEngineServerApi): void;
+    private loadOcrFromImage;
+    private getZoneMatchesFromServer;
+}
+interface OcrRead {
+    documentWidth: number;
+    documentHeight: number;
+    lines: OcrWord[];
+}
+interface OcrWord {
+    ocrTextResultId: string;
+    text: string;
+    confidence: number;
+    polygonPercent: Polygon;
+    bounds: Rectangle;
+    center: Point;
+}
+interface ZoneOcrMatch {
+    templateZoneId: string;
+    ocrTextResultId: number;
+    originalText: string;
+    processedText: string;
+    polygonPercent: Polygon;
+    anchorPoint?: Point | null;
+}
+interface InternalZoneOcrMatch {
+    templateZoneId: string;
+    ocrTextResultId: number;
+    originalText: string;
+    processedText: string;
+    polygonPercent: Polygon;
+    polygonAbsolute: Polygon;
+    anchorPointPercent?: Point | null;
+    anchorPointAbsolute?: Point | null;
+}
+interface CaptureEngineServerApi {
+    /** 1) /api/v1/ocr/readimage */
+    readImage(file: File | Blob): Promise<Result<OcrRead>>;
+    /** 2) /api/v1/ocr/matchocrtozones */
+    matchOcrToZones(req: {
+        captureTemplate: ExternalTemplate;
+        ocr: OcrRead;
+    }): Promise<Result<ZoneOcrMatch[]>>;
+}
+
+export { CaptureEngine, type CaptureEngineServerApi, type CaptureEngineToZoneEventPayloads, CaptureEngineToZoneEventType, type CapturePublicEventPayloads, CapturePublicEventType, type CaptureToEngineEventPayloads, CaptureToEngineEventType, type CaptureZoneEventPayloads, type ExternalTemplate, type ExternalTemplateZone, type ExternalZoneType, type OcrRead, type OcrWord, type TemplateZoneBase, type ZoneCanvasManager, type ZoneKind, type ZoneOcrMatch };

package/dist/index.d.ts

@@ -0,0 +1,560 @@
+import { Rectangle, InteractiveObject, Size, Point, Polygon, Vector } from 'dytools-canvas-engine';
+import { Result } from 'dytools-result';
+
+type ExternalZoneType = "TemplateSimpleZone" | "TemplateAnchorZone" | "TemplateAnchorZoneChild";
+interface ExternalTemplateZone {
+    TemplateZoneId: string;
+    Name: string;
+    Type: ExternalZoneType;
+    X: number;
+    Y: number;
+    Width: number;
+    Height: number;
+    XAbsolute?: number;
+    YAbsolute?: number;
+    WidthAbsolute?: number;
+    HeightAbsolute?: number;
+    AnchorLocationXAbsoluteHint?: number;
+    AnchorLocationYAbsoluteHint?: number;
+    RegExFilter?: string | null;
+    RegExOutput?: string | null;
+    RegExReplacement?: string | null;
+    Required?: boolean;
+    DataType?: string | null;
+    ExcludeFromOutput?: boolean;
+    DefaultValueIfEmpty?: string | null;
+    AnchorLocation?: string;
+    GroupChildrenInSubRecord?: boolean;
+    ChildZones?: ExternalTemplateZone[];
+}
+interface ExternalTemplate {
+    Name: string;
+    DocumentWidth?: number;
+    DocumentHeight?: number;
+    Zones: ExternalTemplateZone[];
+}
+declare const CapturePublicEventType: {
+    readonly ZonePositionChanged: "zone:position_changed";
+    readonly ZoneNameChanged: "zone:name_changed";
+    readonly ZoneFilterRegexChanged: "zone:filter_regex_changed";
+    readonly ZoneExampleChanged: "zone:example_changed";
+    readonly ZoneHiddenChanged: "zone:hidden_changed";
+    readonly ZoneChanged: "zone:changed";
+    readonly TemplateChanged: "template:changed";
+    readonly ZoneSelected: "zone:selected";
+    readonly ZoneDeselected: "zone:deselected";
+    readonly ZoneFlagsAdded: "zone:flags_added";
+    readonly ZoneFlagsRemoved: "zone:flags_removed";
+    readonly ZoneAdded: "capture:zone_added";
+    readonly ZoneRemoved: "capture:zone_removed";
+    readonly ViewportChanged: "capture:viewport_changed";
+    readonly DrawingCompleted: "capture:drawing_completed";
+    readonly OcrShown: "capture:ocr_shown";
+    readonly OcrHidden: "capture:ocr_hidden";
+    readonly OcrReadLoaded: "capture:api_ocr_loaded";
+    readonly OcrMatchesLoaded: "capture:api_ocr_matches_loaded";
+    readonly CaptureStarted: "capture:started";
+    readonly CaptureError: "capture:error";
+    readonly CaptureBackgroundChanged: "capture:background_changed";
+    readonly CaptureRenderStarted: "capture:render_started";
+    readonly CaptureRenderCompleted: "capture:render_completed";
+};
+type CapturePublicEventType = typeof CapturePublicEventType[keyof typeof CapturePublicEventType];
+interface CapturePublicEventPayloads {
+    [CapturePublicEventType.ZonePositionChanged]: {
+        zone: TemplateZoneBase;
+        oldPosition: Rectangle;
+        newPosition: Rectangle;
+    };
+    [CapturePublicEventType.ZoneNameChanged]: {
+        zone: TemplateZoneBase;
+        oldName: string;
+        newName: string;
+    };
+    [CapturePublicEventType.ZoneFilterRegexChanged]: {
+        zone: TemplateZoneBase;
+        oldFilterRegex: number;
+        newFilterRegex: number;
+    };
+    [CapturePublicEventType.ZoneExampleChanged]: {
+        zone: TemplateZoneBase;
+        oldExample: string;
+        newExample: string;
+    };
+    [CapturePublicEventType.ZoneHiddenChanged]: {
+        zone: TemplateZoneBase;
+        oldHidden: boolean;
+        newHidden: boolean;
+    };
+    [CapturePublicEventType.ZoneChanged]: {
+        zone: TemplateZoneBase;
+        propertiesChanged: string[];
+    };
+    [CapturePublicEventType.TemplateChanged]: {};
+    [CapturePublicEventType.ZoneSelected]: {
+        zone: TemplateZoneBase;
+    };
+    [CapturePublicEventType.ZoneDeselected]: {
+        zone: TemplateZoneBase;
+    };
+    [CapturePublicEventType.ZoneFlagsAdded]: {
+        zone: TemplateZoneBase;
+        addedFlags: string[];
+        currentFlags: string[];
+    };
+    [CapturePublicEventType.ZoneFlagsRemoved]: {
+        zone: TemplateZoneBase;
+        removedFlags: string[];
+        currentFlags: string[];
+    };
+    [CapturePublicEventType.ZoneAdded]: {
+        newZone: TemplateZoneBase;
+        parentZone?: TemplateZoneBase;
+        isChildZone?: boolean;
+    };
+    [CapturePublicEventType.ZoneRemoved]: {
+        id: string;
+        removedZone?: TemplateZoneBase;
+        parentZone?: TemplateZoneBase;
+        isChildZone?: boolean;
+    };
+    [CapturePublicEventType.ViewportChanged]: {
+        oldPan: Vector;
+        newPan: Vector;
+        oldZoom: number;
+        newZoom: number;
+    };
+    [CapturePublicEventType.DrawingCompleted]: {
+        rect: Rectangle;
+        maxZ: number;
+    };
+    [CapturePublicEventType.OcrShown]: {};
+    [CapturePublicEventType.OcrHidden]: {};
+    [CapturePublicEventType.OcrReadLoaded]: {
+        ocr: OcrRead | null;
+    };
+    [CapturePublicEventType.OcrMatchesLoaded]: {
+        matches: ZoneOcrMatch[];
+    };
+    [CapturePublicEventType.CaptureStarted]: {};
+    [CapturePublicEventType.CaptureError]: {
+        error?: Error;
+        message: string;
+    };
+    [CapturePublicEventType.CaptureBackgroundChanged]: {
+        newImage: Blob;
+        newWidth: number;
+        newHeight: number;
+        oldWidth: number;
+        oldHeight: number;
+    };
+    [CapturePublicEventType.CaptureRenderStarted]: {};
+    [CapturePublicEventType.CaptureRenderCompleted]: {};
+}
+declare const CaptureZoneEventType: {
+    readonly ZoneCanvasManagerSet: "zone_internal:canvas_manager_set";
+    readonly ZonePositionChanged: "zone_internal:position_changed";
+    readonly ZoneColorChanged: "zone_internal:color_changed";
+    readonly ZoneNameChanged: "zone_internal:name_changed";
+    readonly ZoneExampleChanged: "zone_internal:example_changed";
+    readonly ZoneHiddenChanged: "zone_internal:hidden_changed";
+    readonly ZoneFilterRegexChanged: "zone_internal:filter_regex_changed";
+    readonly ZoneOutputRegexChanged: "zone_internal:output_regex_changed";
+    readonly ZoneOutputReplacementChanged: "zone_internal:output_replacement_changed";
+    readonly ZoneRequiredChanged: "zone_internal:required_changed";
+    readonly ZoneDataTypeChanged: "zone_internal:data_type_changed";
+    readonly ZoneExcludeFromOutputChanged: "zone_internal:exclude_from_output_changed";
+    readonly ZoneDefaultValueIfEmptyChanged: "zone_internal:default_value_if_empty_changed";
+    readonly ZoneOcrMatchesChanged: "zone_internal:ocr_matches_changed";
+    readonly ZoneGroupChildrenChanged: "zone_internal:group_children_changed";
+    readonly ZoneAnchorLocationChanged: "zone_internal:anchor_location_changed";
+};
+type CaptureZoneEventType = typeof CaptureZoneEventType[keyof typeof CaptureZoneEventType];
+interface CaptureZoneEventPayloads {
+    [CaptureZoneEventType.ZonePositionChanged]: {
+        oldPosition: Rectangle;
+        newPosition: Rectangle;
+    };
+    [CaptureZoneEventType.ZoneColorChanged]: {
+        oldColor: string;
+        newColor: string;
+    };
+    [CaptureZoneEventType.ZoneNameChanged]: {
+        oldName: string;
+        newName: string;
+    };
+    [CaptureZoneEventType.ZoneExampleChanged]: {
+        oldExample: string | null;
+        newExample: string | null;
+    };
+    [CaptureZoneEventType.ZoneHiddenChanged]: {
+        oldHidden: boolean;
+        newHidden: boolean;
+    };
+    [CaptureZoneEventType.ZoneFilterRegexChanged]: {
+        oldFilterRegex: string | null;
+        newFilterRegex: string | null;
+    };
+    [CaptureZoneEventType.ZoneOutputRegexChanged]: {
+        oldOutputRegex: string | null;
+        newOutputRegex: string | null;
+    };
+    [CaptureZoneEventType.ZoneOutputReplacementChanged]: {
+        oldOutputReplacement: string | null;
+        newOutputReplacement: string | null;
+    };
+    [CaptureZoneEventType.ZoneRequiredChanged]: {
+        oldRequired: boolean;
+        newRequired: boolean;
+    };
+    [CaptureZoneEventType.ZoneDataTypeChanged]: {
+        oldDataType: string | null;
+        newDataType: string | null;
+    };
+    [CaptureZoneEventType.ZoneExcludeFromOutputChanged]: {
+        oldExcludeFromOutput: boolean;
+        newExcludeFromOutput: boolean;
+    };
+    [CaptureZoneEventType.ZoneDefaultValueIfEmptyChanged]: {
+        oldDefaultValueIfEmpty: string | null;
+        newDefaultValueIfEmpty: string | null;
+    };
+    [CaptureZoneEventType.ZoneCanvasManagerSet]: {
+        canvasManager: ZoneCanvasManager;
+    };
+    [CaptureZoneEventType.ZoneOcrMatchesChanged]: {
+        matches: InternalZoneOcrMatch[] | null;
+    };
+    [CaptureZoneEventType.ZoneGroupChildrenChanged]: {
+        newGroupChildren: boolean;
+        oldGroupChildren: boolean;
+    };
+    [CaptureZoneEventType.ZoneAnchorLocationChanged]: {
+        oldAnchorLocation: AnchorLocation;
+        newAnchorLocation: AnchorLocation;
+    };
+}
+declare const CaptureEngineToZoneEventType: {
+    readonly CanvasObjectPositionChanged: "canvas:object_position_changed";
+    readonly CanvasObjectResized: "canvas:object_resized";
+    readonly CanvasObjectMoved: "canvas:object_moved";
+    readonly ZoneSelected: "zone:selected";
+    readonly ZoneDeselected: "zone:deselected";
+    readonly ZoneFlagsAdded: "zone:flags_added";
+    readonly ZoneFlagsRemoved: "zone:flags_removed";
+    readonly CaptureOcrReadLoaded: "capture:ocr_read_loaded";
+    readonly CaptureOcrMatchesLoaded: "capture:ocr_matches_loaded";
+};
+type CaptureEngineToZoneEventType = typeof CaptureEngineToZoneEventType[keyof typeof CaptureEngineToZoneEventType];
+interface CaptureEngineToZoneEventPayloads {
+    [CaptureEngineToZoneEventType.CanvasObjectPositionChanged]: {
+        object: InteractiveObject;
+        oldPosition: Rectangle;
+        newPosition: Rectangle;
+    };
+    [CaptureEngineToZoneEventType.CanvasObjectResized]: {
+        object: InteractiveObject;
+        oldSize: Size;
+        newSize: Size;
+    };
+    [CaptureEngineToZoneEventType.CanvasObjectMoved]: {
+        object: InteractiveObject;
+        oldPoint: Point;
+        newPoint: Point;
+    };
+    [CaptureEngineToZoneEventType.ZoneSelected]: {};
+    [CaptureEngineToZoneEventType.ZoneDeselected]: {};
+    [CaptureEngineToZoneEventType.ZoneFlagsAdded]: {
+        addedFlags: string[];
+        currentFlags: string[];
+    };
+    [CaptureEngineToZoneEventType.ZoneFlagsRemoved]: {
+        removedFlags: string[];
+        currentFlags: string[];
+    };
+    [CaptureEngineToZoneEventType.CaptureOcrReadLoaded]: {
+        ocrRead: OcrRead | null;
+    };
+    [CaptureEngineToZoneEventType.CaptureOcrMatchesLoaded]: {
+        ocrMatches: InternalZoneOcrMatch[] | null;
+    };
+}
+declare const CaptureToEngineEventType: {
+    readonly ZonePositionChanged: "zone:position_changed";
+    readonly ZoneNameChanged: "zone:name_changed";
+    readonly ZoneFilterRegexChanged: "zone:filter_regex_changed";
+    readonly ZoneOutputRegexChanged: "zone:output_regex_changed";
+    readonly ZoneOutputReplacementChanged: "zone:output_replacement_changed";
+    readonly ZoneRequiredChanged: "zone:required_changed";
+    readonly ZoneDataTypeChanged: "zone:data_type_changed";
+    readonly ZoneExcludeFromOutputChanged: "zone:exclude_from_output_changed";
+    readonly ZoneDefaultValueIfEmptyChanged: "zone:default_value_if_empty_changed";
+    readonly ZoneExampleChanged: "zone:example_changed";
+    readonly ZoneHiddenChanged: "zone:hidden_changed";
+    readonly ZoneChanged: "zone:changed";
+    readonly ZoneAnchorLocationChanged: "zone:anchor_location_changed";
+    readonly ZoneGroupChildrenChanged: "zone:group_children_changed";
+    readonly ZoneChildZoneAdded: "zone:child_zone_added";
+    readonly ZoneChildZoneRemoved: "zone:child_zone_removed";
+    readonly ZoneChildZonesChanged: "zone:child_zone_changed";
+    readonly ZoneError: "zone:error";
+};
+type CaptureToEngineEventType = typeof CaptureToEngineEventType[keyof typeof CaptureToEngineEventType];
+interface CaptureToEngineEventPayloads {
+    [CaptureToEngineEventType.ZonePositionChanged]: {
+        zone: TemplateZoneBase;
+        oldPosition: Rectangle;
+        newPosition: Rectangle;
+    };
+    [CaptureToEngineEventType.ZoneNameChanged]: {
+        zone: TemplateZoneBase;
+        oldName: string;
+        newName: string;
+    };
+    [CaptureToEngineEventType.ZoneFilterRegexChanged]: {
+        zone: TemplateZoneBase;
+        oldFilterRegex: string | null;
+        newFilterRegex: string | null;
+    };
+    [CaptureToEngineEventType.ZoneOutputRegexChanged]: {
+        zone: TemplateZoneBase;
+        oldOutputRegex: string | null;
+        newOutputRegex: string | null;
+    };
+    [CaptureToEngineEventType.ZoneOutputReplacementChanged]: {
+        zone: TemplateZoneBase;
+        oldOutputReplacement: string | null;
+        newOutputReplacement: string | null;
+    };
+    [CaptureToEngineEventType.ZoneRequiredChanged]: {
+        zone: TemplateZoneBase;
+        oldRequired: boolean;
+        newRequired: boolean;
+    };
+    [CaptureToEngineEventType.ZoneDataTypeChanged]: {
+        zone: TemplateZoneBase;
+        oldDataType: string | null;
+        newDataType: string | null;
+    };
+    [CaptureToEngineEventType.ZoneExcludeFromOutputChanged]: {
+        zone: TemplateZoneBase;
+        oldExcludeFromOutput: boolean;
+        newExcludeFromOutput: boolean;
+    };
+    [CaptureToEngineEventType.ZoneDefaultValueIfEmptyChanged]: {
+        zone: TemplateZoneBase;
+        oldDefaultValueIfEmpty: string | null;
+        newDefaultValueIfEmpty: string | null;
+    };
+    [CaptureToEngineEventType.ZoneExampleChanged]: {
+        zone: TemplateZoneBase;
+        oldExample: string | null;
+        newExample: string | null;
+    };
+    [CaptureToEngineEventType.ZoneHiddenChanged]: {
+        zone: TemplateZoneBase;
+        oldHidden: boolean;
+        newHidden: boolean;
+    };
+    [CaptureToEngineEventType.ZoneChanged]: {
+        zone: TemplateZoneBase;
+        propertiesChanged: string[];
+    };
+    [CaptureToEngineEventType.ZoneAnchorLocationChanged]: {
+        zone: TemplateZoneBase;
+        oldAnchorLocation: AnchorLocation;
+        newAnchorLocation: AnchorLocation;
+    };
+    [CaptureToEngineEventType.ZoneGroupChildrenChanged]: {
+        zone: TemplateZoneBase;
+        newGroupChildren: boolean;
+        oldGroupChildren: boolean;
+    };
+    [CaptureToEngineEventType.ZoneChildZoneAdded]: {
+        parentZone: TemplateZoneBase;
+        newChildZone: TemplateZoneBase;
+    };
+    [CaptureToEngineEventType.ZoneChildZoneRemoved]: {
+        parentZone: TemplateZoneBase;
+        removedChildZone: TemplateZoneBase;
+    };
+    [CaptureToEngineEventType.ZoneChildZonesChanged]: {
+        parentZone: TemplateZoneBase;
+    };
+    [CaptureToEngineEventType.ZoneError]: {
+        zone: TemplateZoneBase;
+        error?: Error;
+        message: string;
+    };
+}
+type ZoneKind = "simple" | "anchor" | "anchor-child";
+type AnchorLocation = "TopLeft" | "TopRight" | "BottomLeft" | "BottomRight" | "Center";
+interface TemplateZoneBase {
+    id: string;
+    name: string;
+    type: ZoneKind;
+    example: string | null;
+    needsAnchorReposition: boolean;
+    rect: Rectangle;
+    hidden?: boolean;
+    filterRegex: string | null;
+    outputRegex: string | null;
+    outputReplacement: string | null;
+    required: boolean;
+    dataType: string | null;
+    excludeFromOutput: boolean;
+    defaultValueIfEmpty: string | null;
+    anchorLocation?: AnchorLocation;
+    groupChildren?: boolean;
+    children?: TemplateZoneBase[];
+    handleEvent?<T extends CaptureEngineToZoneEventType>(id: string, type: T, payload: CaptureEngineToZoneEventPayloads[T]): void;
+    setCanvasManager?(cm?: ZoneCanvasManager): void;
+    toExternal(docWidth: number, docHeight: number): ExternalTemplateZone;
+    setEngineEventSink?(callback?: (type: CaptureToEngineEventType, payload?: CaptureToEngineEventPayloads[CaptureToEngineEventType]) => void): void;
+}
+interface ZoneCanvasManager {
+    readonly zoneId: string;
+    addPolygon(points: Point[], color: string, isSelectable: boolean): string;
+    addRectangle(rect: Rectangle, name: string | null, color: string, isResizable: boolean, isSelectable: boolean): string;
+    addCircle(center: Point, radius: number, color: string, isResizable: boolean, isSelectable: boolean): string;
+    setName(id: string, name: string | null): void;
+    setColor(id: string, color: string): void;
+    setSelectable(id: string, isSelectable: boolean): void;
+    setResizable(id: string, isResizable: boolean): void;
+    setRectangleSize(id: string, rect: Rectangle): void;
+    setVisibility(id: string, isVisible: boolean): void;
+    removeObject(id: string): void;
+    /** convenience for “wipe all visuals for this zone” */
+    clearAll(): void;
+}
+declare class CaptureEngine {
+    private readonly engine;
+    private listeners;
+    private serverApi?;
+    private _name;
+    zones: TemplateZoneBase[];
+    private ocrRead;
+    private zoneOcrMatches;
+    private ocrOverlayIds;
+    private flags;
+    private zoneCounter;
+    constructor(selector: string, serverApi?: CaptureEngineServerApi);
+    private setupEngine;
+    on<T extends CapturePublicEventType>(event: T, handler: (payload: CapturePublicEventPayloads[T]) => void, options?: {
+        once?: boolean;
+    }): void;
+    off<T extends CapturePublicEventType>(event: T, handler: (payload: CapturePublicEventPayloads[T]) => void): void;
+    private emitExternal;
+    private emitToZone;
+    private refreshMatches;
+    private engineEventHandler;
+    private onZoneAdded;
+    private onZoneRemoved;
+    private getZoneByCanvasEngineId;
+    private doRender;
+    private createMeteredFn;
+    loadExternalTemplate(external: ExternalTemplate, reapplyZonePositioning: boolean): void;
+    getExternalTemplate(): ExternalTemplate;
+    private rectFromExternal;
+    private zoneFromExternal;
+    get name(): string;
+    set name(value: string);
+    get allZonesFlattened(): TemplateZoneBase[];
+    getZoneById(id: string): TemplateZoneBase | undefined;
+    /**
+     * Add a new simple zone
+     * @param bounds Rectangle
+     */
+    addSimpleZone(bounds: Rectangle): void;
+    /**
+     * Add a new anchor zone
+     * @param bounds Rectangle
+     */
+    addAnchorZone(bounds: Rectangle): void;
+    /**
+     * Add a child zone linked to an anchor
+     * @param anchorId string
+     * @param bounds Rectangle
+     */
+    addAnchorChildZone(anchorId: string, bounds: Rectangle): void;
+    /**
+     * Remove a zone and its canvas representation by id
+     * @param id string
+     */
+    removeZoneById(id: string): boolean;
+    updateZone(id: string, patch: Partial<TemplateZoneBase>): void;
+    private setFlag;
+    private clearFlag;
+    hasFlag(objOrId: string | TemplateZoneBase, flag: string): boolean;
+    private clearAllFlags;
+    getObjectsWithFlag(flag: string): TemplateZoneBase[];
+    setSelectedZones(objOrIds: (string | TemplateZoneBase)[]): void;
+    getSelectedZones(): TemplateZoneBase[];
+    get pan(): Vector;
+    get zoom(): number;
+    setZoom(zoom: number, center?: Point): void;
+    setPan(x: number, y: number): void;
+    get width(): number;
+    get height(): number;
+    setBackgroundImage(imageOrUrl: string | File | Blob): Promise<void>;
+    switchMode(name: string): void;
+    get mode(): string;
+    /**
+     * Render the current OCR snapshot as non-interactive polygons on the canvas.
+     */
+    showOcr(): void;
+    /**
+     * Remove OCR overlay polygons from the canvas.
+     */
+    hideOcr(): void;
+    get isOcrShown(): boolean;
+    setOcrSnapshot(ocrRead: OcrRead | null): void;
+    getOcrSnapshot(): OcrRead | null;
+    setOcrMatchesSnapshot(matches: ZoneOcrMatch[]): void;
+    getOcrMatchesSnapshot(): ZoneOcrMatch[];
+    setServerApi(api: CaptureEngineServerApi): void;
+    private loadOcrFromImage;
+    private getZoneMatchesFromServer;
+}
+interface OcrRead {
+    documentWidth: number;
+    documentHeight: number;
+    lines: OcrWord[];
+}
+interface OcrWord {
+    ocrTextResultId: string;
+    text: string;
+    confidence: number;
+    polygonPercent: Polygon;
+    bounds: Rectangle;
+    center: Point;
+}
+interface ZoneOcrMatch {
+    templateZoneId: string;
+    ocrTextResultId: number;
+    originalText: string;
+    processedText: string;
+    polygonPercent: Polygon;
+    anchorPoint?: Point | null;
+}
+interface InternalZoneOcrMatch {
+    templateZoneId: string;
+    ocrTextResultId: number;
+    originalText: string;
+    processedText: string;
+    polygonPercent: Polygon;
+    polygonAbsolute: Polygon;
+    anchorPointPercent?: Point | null;
+    anchorPointAbsolute?: Point | null;
+}
+interface CaptureEngineServerApi {
+    /** 1) /api/v1/ocr/readimage */
+    readImage(file: File | Blob): Promise<Result<OcrRead>>;
+    /** 2) /api/v1/ocr/matchocrtozones */
+    matchOcrToZones(req: {
+        captureTemplate: ExternalTemplate;
+        ocr: OcrRead;
+    }): Promise<Result<ZoneOcrMatch[]>>;
+}
+
+export { CaptureEngine, type CaptureEngineServerApi, type CaptureEngineToZoneEventPayloads, CaptureEngineToZoneEventType, type CapturePublicEventPayloads, CapturePublicEventType, type CaptureToEngineEventPayloads, CaptureToEngineEventType, type CaptureZoneEventPayloads, type ExternalTemplate, type ExternalTemplateZone, type ExternalZoneType, type OcrRead, type OcrWord, type TemplateZoneBase, type ZoneCanvasManager, type ZoneKind, type ZoneOcrMatch };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dytools-capture-engine",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "An editor allowing the creation of templates for ocr capture.",
   "type": "module",
   "main": "./dist/index.cjs",