@mlightcad/cad-simple-viewer 1.7.5 → 1.7.6

package/lib/find/findText.d.ts

@@ -0,0 +1,147 @@
+/**
+ * Text search over the entities of one layout (FIND).
+ *
+ * Shared by every UI (cad-simple-ui-plugin, the full Vue cad-viewer) so that
+ * both behave identically. Pure TypeScript with no runtime imports, published
+ * as the `@mlightcad/cad-simple-viewer/find` subpath.
+ *
+ * Searched fields:
+ * - `TEXT` — `textString`
+ * - `MTEXT` — `contents` with MTEXT formatting codes removed
+ * - `ATTRIB` — attribute value (`textString`) of every `INSERT` in the layout
+ *   (the tag is reported for display but is not searched)
+ * - `TEXT` / `MTEXT` / `ATTRIB` inside the block definition of every `INSERT`
+ *   (nested blocks included, anonymous/dynamic blocks too): title blocks,
+ *   legends and labels are usually drawn this way
+ * - constant `ATTDEF` values inside block definitions (the only ATTDEFs that
+ *   are drawn inside a block; templates get their value from an `ATTRIB`)
+ * - `DIMENSION` — the text of its dimension block when that block has a
+ *   match, otherwise the override text (`dimensionText`)
+ * - `MULTILEADER` — its MTEXT contents
+ * - `ACAD_TABLE` — the cell text (from the table block when present,
+ *   otherwise the cell strings)
+ *
+ * Every layout is visited in one synchronous pass per search. A hit inside a
+ * block, dimension or table selects the top-level entity of the layout that
+ * contains it, and carries the WCS extents of the matched text so the view
+ * can zoom to the text itself instead of to the whole block. Xrefs are not
+ * searched.
+ *
+ * The module is structural (no `instanceof`) so it can be unit tested with
+ * plain objects.
+ */
+/** Maximum number of hits returned by one search. */
+export declare const ACAP_FIND_MAX_RESULTS = 500;
+/** Kind of entity that produced a hit. */
+export type AcApFindHitKind = 'text' | 'mtext' | 'attribute'
+/** TEXT / MTEXT inside a block definition (via an `INSERT`). */
+ | 'block' | 'dimension' | 'leader' | 'table';
+/** Options for {@link acapFindTextInLayout}. */
+export interface AcApFindOptions {
+    /**
+     * When true the query must match case and accents exactly. When false
+     * (default) case, accents (diacritics) and runs of whitespace are ignored.
+     */
+    matchCase?: boolean;
+    /** Maximum hits to return; defaults to {@link ACAP_FIND_MAX_RESULTS}. */
+    maxResults?: number;
+}
+/** One match returned by {@link acapFindTextInLayout}. */
+export interface AcApFindHit {
+    /**
+     * Top-level entity of the layout that is selected (the `INSERT` for
+     * attributes and block text, the `DIMENSION` / `ACAD_TABLE` for their text).
+     */
+    entityId: string;
+    /**
+     * Key of the text that matched, unique within the layout: the entity id
+     * for top-level text, the attribute id for attributes, and
+     * `<entityId>/<nested id>…` for text found inside a block, dimension or
+     * table (the same block text appears once per `INSERT`).
+     */
+    textEntityId: string;
+    kind: AcApFindHitKind;
+    /** Plain text that matched (formatting codes removed, whitespace collapsed). */
+    text: string;
+    /** Attribute tag, for `attribute` hits. */
+    tag?: string;
+    /** Block name of the owning `INSERT`, for `attribute` hits. */
+    blockName?: string;
+    layer: string;
+    /** Insertion point of the text in WCS. */
+    position: {
+        x: number;
+        y: number;
+    };
+    /**
+     * WCS extents of the matched text, when known (text nested in a block,
+     * dimension or table). Used to zoom to the text itself.
+     */
+    extents?: {
+        min: {
+            x: number;
+            y: number;
+        };
+        max: {
+            x: number;
+            y: number;
+        };
+    };
+}
+/** Result of one search. */
+export interface AcApFindResult {
+    hits: AcApFindHit[];
+    /** True when more than `maxResults` entities matched. */
+    truncated: boolean;
+}
+type EntityLike = any;
+/** Minimal database shape used by the search. */
+export interface AcApFindDatabaseLike {
+    tables: {
+        blockTable: {
+            /** Block definition by name; used to search text inside blocks. */
+            getAt?(name: string): {
+                newIterator(): Iterable<EntityLike>;
+            } | undefined;
+            getIdAt(id: string): {
+                newIterator(): Iterable<EntityLike>;
+                /** Used to resolve the matched entity for zoom extents. */
+                getIdAt?(id: string): EntityLike;
+            } | undefined;
+        };
+        layerTable?: {
+            getAt(name: string): {
+                isOff?: boolean;
+                isFrozen?: boolean;
+            } | undefined;
+        };
+    };
+}
+/**
+ * Normalizes text or a query for comparison.
+ *
+ * - always: NFKC, whitespace runs → one space, trimmed
+ * - unless `matchCase`: accents removed, lower-cased
+ */
+export declare function acapNormalizeFindText(value: string, matchCase?: boolean): string;
+/**
+ * Converts MTEXT contents to plain text: removes formatting codes
+ * (`\f…;`, `\H…;`, `\C…;`, `\L \l \O \o \K \k`, braces), turns `\P` into a
+ * space, decodes `\~`, `\U+XXXX`, stacked fractions and `%%c %%d %%p`.
+ */
+export declare function acapMTextToPlainText(contents: string): string;
+/**
+ * Finds text in the entities of one block table record (a layout).
+ *
+ * Entities that are invisible or sit on an off/frozen layer are skipped so
+ * that results always correspond to something the user can see.
+ *
+ * @param db - Database owning the layout.
+ * @param layoutBtrId - Block table record id of the layout (model/paper space).
+ * @param query - User query; blank queries return no hits.
+ */
+export declare function acapFindTextInLayout(db: AcApFindDatabaseLike, layoutBtrId: string, query: string, options?: AcApFindOptions): AcApFindResult;
+/** Returns a short excerpt of `text` centred on the first match of `query`. */
+export declare function acapFindExcerpt(text: string, query: string, matchCase?: boolean, width?: number): string;
+export {};
+//# sourceMappingURL=findText.d.ts.map

package/lib/find/findText.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findText.d.ts","sourceRoot":"","sources":["../../src/find/findText.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,qDAAqD;AACrD,eAAO,MAAM,qBAAqB,MAAM,CAAA;AAExC,0CAA0C;AAC1C,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,OAAO,GACP,WAAW;AACb,gEAAgE;GAC9D,OAAO,GACP,WAAW,GACX,QAAQ,GACR,OAAO,CAAA;AAEX,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,0DAA0D;AAC1D,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,eAAe,CAAA;IACrB,gFAAgF;IAChF,IAAI,EAAE,MAAM,CAAA;IACZ,2CAA2C;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;IACb,0CAA0C;IAC1C,QAAQ,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE;QAAE,GAAG,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,GAAG,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAA;CAC3E;AAED,4BAA4B;AAC5B,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,WAAW,EAAE,CAAA;IACnB,yDAAyD;IACzD,SAAS,EAAE,OAAO,CAAA;CACnB;AAGD,KAAK,UAAU,GAAG,GAAG,CAAA;AAGrB,iDAAiD;AACjD,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE;QACN,UAAU,EAAE;YACV,mEAAmE;YACnE,KAAK,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG;gBAAE,WAAW,IAAI,QAAQ,CAAC,UAAU,CAAC,CAAA;aAAE,GAAG,SAAS,CAAA;YACzE,OAAO,CAAC,EAAE,EAAE,MAAM,GACd;gBACE,WAAW,IAAI,QAAQ,CAAC,UAAU,CAAC,CAAA;gBACnC,2DAA2D;gBAC3D,OAAO,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,CAAA;aACjC,GACD,SAAS,CAAA;SACd,CAAA;QACD,UAAU,CAAC,EAAE;YACX,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG;gBAAE,KAAK,CAAC,EAAE,OAAO,CAAC;gBAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;aAAE,GAAG,SAAS,CAAA;SACzE,CAAA;KACF,CAAA;CACF;AAKD;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,EACb,SAAS,UAAQ,GAChB,MAAM,CAMR;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CA8C7D;AAyHD;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAClC,EAAE,EAAE,oBAAoB,EACxB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,eAAoB,GAC5B,cAAc,CAwRhB;AAED,+EAA+E;AAC/E,wBAAgB,eAAe,CAC7B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,SAAS,UAAQ,EACjB,KAAK,SAAK,GACT,MAAM,CAQR"}