@ricsam/formula-engine 0.2.10 → 0.2.12

package/dist/types/core/managers/range-metadata-manager.d.ts

@@ -0,0 +1,22 @@
+/**
+ * RangeMetadataManager - Manages arbitrary consumer-defined metadata attached
+ * to ranges rather than individual cells.
+ */
+import type { CellAddress, RangeAddress, RangeMetadata, RangeMetadataInput } from "../types";
+import type { RangeMetadataManagerSnapshot } from "../engine-snapshot";
+export declare class RangeMetadataManager<TMetadata = unknown> {
+    private rangeMetadata;
+    addRangeMetadata(entry: RangeMetadataInput<TMetadata>): string;
+    removeRangeMetadata(id: string): boolean;
+    getAllRangeMetadata(): RangeMetadata<TMetadata>[];
+    getRangeMetadataForCell(cellAddress: CellAddress): RangeMetadata<TMetadata>[];
+    getRangeMetadataIntersectingWithRange(range: RangeAddress): RangeMetadata<TMetadata>[];
+    clearRangeMetadataInRange(range: RangeAddress): void;
+    removeWorkbookRangeMetadata(workbookName: string): void;
+    removeSheetRangeMetadata(workbookName: string, sheetName: string): void;
+    updateWorkbookName(oldName: string, newName: string): void;
+    updateSheetName(workbookName: string, oldSheetName: string, newSheetName: string): void;
+    resetRangeMetadata(rangeMetadata?: RangeMetadata<TMetadata>[]): void;
+    toSnapshot(): RangeMetadataManagerSnapshot;
+    restoreFromSnapshot(snapshot: RangeMetadataManagerSnapshot): void;
+}

package/dist/types/core/types.d.ts

@@ -371,6 +371,16 @@ export interface DirectCellStyle {
     areas: RangeAddress[];
     style: CellStyle;
 }
+export interface RangeMetadata<TMetadata = unknown> {
+    id: string;
+    areas: RangeAddress[];
+    metadata: TMetadata;
+}
+export interface RangeMetadataInput<TMetadata = unknown> {
+    id?: string;
+    areas: RangeAddress[];
+    metadata: TMetadata;
+}
 export interface CellStyle {
     backgroundColor?: string;
     color?: string;
@@ -378,7 +388,9 @@ export interface CellStyle {
     bold?: boolean;
     italic?: boolean;
     underline?: boolean;
+    wrapText?: boolean;
 }
+export type CopyCellsIncludePart = "content" | "style" | "cellMetadata" | "rangeMetadata";
 export interface CopyCellsOptions {
     /**
      * Whether this is a cut operation (clears source cells after copying)
@@ -387,18 +399,19 @@ export interface CopyCellsOptions {
     cut?: boolean;
     /**
      * What to include in the copy operation.
-     * - Use 'all' as shorthand for ['content', 'style', 'metadata']
+     * - Use 'all' as shorthand for ['content', 'style', 'cellMetadata', 'rangeMetadata']
      * - Use array for fine-grained control over what to copy:
      *   - ['content'] - copy only values/formulas
      *   - ['style'] - copy only formatting
-     *   - ['metadata'] - copy only metadata (rich text, links, etc.)
+     *   - ['cellMetadata'] - copy only cell metadata (rich text, links, etc.)
+     *   - ['rangeMetadata'] - copy only range metadata
      *   - ['content', 'style'] - copy content and formatting
-     *   - ['content', 'metadata'] - copy content and metadata
-     *   - ['style', 'metadata'] - copy formatting and metadata
-     *   - ['content', 'style', 'metadata'] - same as 'all'
+     *   - ['content', 'cellMetadata'] - copy content and cell metadata
+     *   - ['style', 'rangeMetadata'] - copy formatting and range metadata
+     *   - ['content', 'style', 'cellMetadata', 'rangeMetadata'] - same as 'all'
      * @default 'all'
      */
-    include?: "all" | ("content" | "style" | "metadata")[];
+    include?: "all" | CopyCellsIncludePart[];
     /**
      * The type of the content to copy
      * value: Copy the value from the source to the target,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ricsam/formula-engine",
-  "version": "0.2.10",
+  "version": "0.2.12",
   "module": "./dist/mjs/lib.mjs",
   "scripts": {
     "test": "bun test",