odf-kit 0.9.6 → 0.9.8

package/dist/ods-reader/types.d.ts

@@ -0,0 +1,139 @@
+/**
+ * ODS reader type definitions.
+ *
+ * These types describe the in-memory model returned by readOds().
+ */
+/** Top-level ODS document model returned by readOds(). */
+export interface OdsDocumentModel {
+    /** Sheets in tab order. */
+    sheets: OdsSheetModel[];
+    /** Document metadata from meta.xml. */
+    metadata?: OdsMetadata;
+}
+/** Document metadata from meta.xml. */
+export interface OdsMetadata {
+    title?: string;
+    creator?: string;
+    description?: string;
+    creationDate?: string;
+    lastModified?: string;
+}
+/** A single sheet (tab) in the spreadsheet. */
+export interface OdsSheetModel {
+    /** Sheet tab name. */
+    name: string;
+    /** Tab color if set (hex or CSS named color). */
+    tabColor?: string;
+    /** Rows in order. Sparse rows (e.g. from table:number-rows-repeated) are expanded. */
+    rows: OdsRowModel[];
+    /** Column widths by zero-based column index. */
+    columnWidths: Map<number, string>;
+    /** Number of frozen rows (from settings.xml). */
+    freezeRows?: number;
+    /** Number of frozen columns (from settings.xml). */
+    freezeColumns?: number;
+}
+/** A row of cells. */
+export interface OdsRowModel {
+    /** Zero-based row index within the sheet. */
+    index: number;
+    /** Cells in column order. Covered cells have type "covered". */
+    cells: OdsCellModel[];
+    /** Row height if explicitly set. */
+    height?: string;
+}
+/**
+ * A single cell in the spreadsheet.
+ *
+ * Cell types:
+ * - `"string"`  — text value; `value` is a string
+ * - `"float"`   — numeric value; `value` is a number
+ * - `"date"`    — date/datetime; `value` is a Date (UTC)
+ * - `"boolean"` — boolean; `value` is true or false
+ * - `"formula"` — formula cell; `value` is the cached result, `formula` is the original string
+ * - `"empty"`   — no content; `value` is null
+ * - `"covered"` — covered by a merge from a primary cell; `value` is null
+ */
+export interface OdsCellModel {
+    /** Zero-based column index. Always correct regardless of merges. */
+    colIndex: number;
+    /** Cell type. */
+    type: "string" | "float" | "date" | "boolean" | "formula" | "empty" | "covered";
+    /**
+     * The typed JavaScript value.
+     * - string → string
+     * - float → number
+     * - date → Date (UTC)
+     * - boolean → boolean
+     * - formula → cached result (number, string, or boolean)
+     * - empty/covered → null
+     */
+    value: string | number | boolean | Date | null;
+    /**
+     * Original formula string for formula cells (e.g. `"=SUM(A1:A10)"`).
+     * The `of:` OpenFormula prefix is stripped.
+     * Undefined for non-formula cells.
+     */
+    formula?: string;
+    /**
+     * Display text as it appears in the cell (the text:p content).
+     * e.g. `"1,234.56"` for a formatted number, `"15/01/2026"` for a date.
+     * May differ from `value` when number or date formatting is applied.
+     */
+    displayText?: string;
+    /**
+     * Number of columns this cell spans (1 = no merge).
+     * Only set when > 1.
+     */
+    colSpan?: number;
+    /**
+     * Number of rows this cell spans (1 = no merge).
+     * Only set when > 1.
+     */
+    rowSpan?: number;
+    /** Cell formatting extracted from the cell style. */
+    formatting?: OdsCellFormatting;
+}
+/** Cell formatting properties extracted from ODS automatic styles. */
+export interface OdsCellFormatting {
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    fontSize?: string;
+    fontFamily?: string;
+    /** Text color. */
+    color?: string;
+    /** Cell background color. */
+    backgroundColor?: string;
+    /** Horizontal text alignment. */
+    textAlign?: "left" | "center" | "right";
+    /** Vertical alignment. */
+    verticalAlign?: "top" | "middle" | "bottom";
+    /** Number format string (e.g. `"decimal:2"`, `"currency:EUR"`, `"percentage"`). */
+    numberFormat?: string;
+    /** Date format string (e.g. `"YYYY-MM-DD"`, `"DD/MM/YYYY"`). */
+    dateFormat?: string;
+}
+/** Options for {@link readOds}. */
+export interface ReadOdsOptions {
+    /**
+     * Whether to include cell formatting in the model.
+     * Defaults to `true`. Set to `false` for faster parsing when
+     * only values and types are needed.
+     */
+    includeFormatting?: boolean;
+}
+/** Options for {@link odsToHtml}. */
+export interface OdsHtmlOptions {
+    /**
+     * Whether to include inline styles from cell formatting.
+     * Defaults to `true`.
+     */
+    includeStyles?: boolean;
+    /**
+     * CSS class prefix for generated elements.
+     * Defaults to `"ods"`.
+     */
+    classPrefix?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/ods-reader/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/ods-reader/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,0DAA0D;AAC1D,MAAM,WAAW,gBAAgB;IAC/B,2BAA2B;IAC3B,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,WAAW,CAAC;CACxB;AAED,uCAAuC;AACvC,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,+CAA+C;AAC/C,MAAM,WAAW,aAAa;IAC5B,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sFAAsF;IACtF,IAAI,EAAE,WAAW,EAAE,CAAC;IACpB,gDAAgD;IAChD,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,iDAAiD;IACjD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,sBAAsB;AACtB,MAAM,WAAW,WAAW;IAC1B,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,gEAAgE;IAChE,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,YAAY;IAC3B,oEAAoE;IACpE,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB;IACjB,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;IAEhF;;;;;;;;OAQG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC;IAE/C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,qDAAqD;IACrD,UAAU,CAAC,EAAE,iBAAiB,CAAC;CAChC;AAED,sEAAsE;AACtE,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iCAAiC;IACjC,SAAS,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IACxC,0BAA0B;IAC1B,aAAa,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC5C,mFAAmF;IACnF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gEAAgE;IAChE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAID,mCAAmC;AACnC,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,qCAAqC;AACrC,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/ods-reader/types.js

@@ -0,0 +1,7 @@
+/**
+ * ODS reader type definitions.
+ *
+ * These types describe the in-memory model returned by readOds().
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/ods-reader/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/ods-reader/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "odf-kit",
-  "version": "0.9.6",
+  "version": "0.9.8",
   "description": "Generate, fill, read, and convert OpenDocument Format (.odt) files in JavaScript and TypeScript. Works in Node.js and browsers.",
   "type": "module",
   "main": "./dist/index.js",
@@ -14,10 +14,18 @@
       "types": "./dist/odt/index.d.ts",
       "import": "./dist/odt/index.js"
     },
+    "./odt-reader": {
+      "types": "./dist/reader/index.d.ts",
+      "import": "./dist/reader/index.js"
+    },
     "./ods": {
       "types": "./dist/ods/index.d.ts",
       "import": "./dist/ods/index.js"
     },
+    "./ods-reader": {
+      "types": "./dist/ods-reader/index.d.ts",
+      "import": "./dist/ods-reader/index.js"
+    },
     "./template": {
       "types": "./dist/template/index.d.ts",
       "import": "./dist/template/index.js"
@@ -51,13 +59,22 @@
     "opendocument",
     "odt",
     "ods",
-    "odp",
-    "odg",
     "libreoffice",
     "document",
     "spreadsheet",
-    "presentation",
-    "browser"
+    "browser",
+    "tiptap",
+    "prosemirror",
+    "tiptap-odt",
+    "prosemirror-odt",
+    "html-to-odt",
+    "markdown-to-odt",
+    "tiptap-export",
+    "odt-export",
+    "odt-generator",
+    "template",
+    "typst",
+    "iso26300"
   ],
   "author": "GitHubNewbie0",
   "license": "Apache-2.0",