@opencraw/core 0.1.0 → 0.1.2

package/dist/src/workbook-document/read-xlsx.client.d.ts

@@ -0,0 +1,18 @@
+import type { WorkbookDocument } from './workbook-document.model.js';
+/**
+ * Reads an `.xlsx` workbook into a workbook document, through
+ * `@opencraw/office-reader`: every worksheet's cells, with hidden sheets,
+ * hidden rows and merged ranges. Numbers and booleans keep their type (a
+ * cell's `13955.625` is unambiguous; as text, a locale guess could read it as
+ * thirteen million), dates become ISO text, errors their text, empty cells
+ * `''`. Formulas give their cached value. The reader is imported on first use,
+ * so recipes that never read a spreadsheet never load it.
+ *
+ * @param bytes - The file.
+ * @param source - Where it came from, for messages.
+ * @returns The workbook.
+ * @throws Error naming the source, and saying what to do, for a file that is
+ * not a readable workbook (a legacy `.xls`, a password-protected file, an `.ods`…).
+ */
+export declare function readXlsxWorkbook(bytes: Uint8Array, source: string): Promise<WorkbookDocument>;
+//# sourceMappingURL=read-xlsx.client.d.ts.map

package/dist/src/workbook-document/workbook-document.model.d.ts

@@ -0,0 +1,51 @@
+/**
+ * A cell: text, or, from a spreadsheet, the number or boolean it holds
+ * (`13955.625` stays a number, so no locale guess can misread it). Dates are
+ * ISO text (`2026-06-01`, `2026-06-01T09:30:00`), errors their text
+ * (`#DIV/0!`), an empty cell `''`. A CSV's cells are all text.
+ */
+export type WorkbookCell = string | number | boolean;
+/** One sheet of a workbook. A CSV is a workbook of one sheet. */
+export interface Sheet {
+    name: string;
+    /** Top to bottom; a row holds as many cells as were read (rows can be ragged). */
+    rows: WorkbookCell[][];
+    /** A sheet hidden in the workbook: `table` skips it unless `includeHidden`. */
+    hidden?: boolean;
+    /** Rows hidden in the sheet (0-based): `table` skips them unless `includeHidden`. */
+    hiddenRows?: number[];
+    /**
+     * Merged ranges as A1 references (`B10:B13`). The value of a merged range
+     * sits in its top-left cell only, as the file stores it; `table` copies it
+     * into every cell the range covers.
+     */
+    merges?: string[];
+}
+/** How a CSV was read, for a probe to report. */
+export interface CsvFormat {
+    encoding: string;
+    delimiter: string;
+}
+/** A spreadsheet or a CSV read into sheets of cells: what `extract` works on. */
+export interface WorkbookDocument {
+    kind: 'workbook';
+    sheets: Sheet[];
+    /** Present when the workbook came from a CSV. */
+    csv?: CsvFormat;
+}
+/**
+ * The text a `regex` extract reads: the visible rows of the visible sheets,
+ * cells separated by a tab, sheets separated by a blank line.
+ *
+ * @param document - The workbook.
+ * @returns The text.
+ */
+export declare function workbookText(document: WorkbookDocument): string;
+/**
+ * Whether a value bound in scope is a read workbook (so `extract … from` can take it).
+ *
+ * @param value - Anything.
+ * @returns Whether it is a {@link WorkbookDocument}.
+ */
+export declare function isWorkbookDocument(value: unknown): value is WorkbookDocument;
+//# sourceMappingURL=workbook-document.model.d.ts.map

package/dist/src/yaml-document/index.d.ts

@@ -0,0 +1,3 @@
+export { readYaml } from './read-yaml.client.js';
+export type { YamlRead, YamlScalars } from './read-yaml.client.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/yaml-document/read-yaml.client.d.ts

@@ -0,0 +1,25 @@
+/** How YAML scalars are read: typed as YAML 1.2 types them, or as the text written. */
+export type YamlScalars = 'typed' | 'text';
+/** A YAML text, read. */
+export interface YamlRead {
+    /** The document's value; several documents (`---`) give an array of their values. */
+    data: unknown;
+    documents: number;
+    /** What the parser noticed but read anyway: an unknown tag (`!!js/function`) is kept as its plain value. */
+    warnings: string[];
+}
+/**
+ * Parses YAML with the `yaml` package, imported on first use. The version is
+ * pinned to YAML 1.2 (core schema) whatever the document declares: under a
+ * `%YAML 1.1` directive, `NO` would read as `false` and `0123` as octal `83`.
+ * Merge keys (`<<: *base`) are applied, duplicate keys are an error, aliases
+ * are capped, and custom tags never build values: nothing in the text runs.
+ *
+ * @param text - The YAML.
+ * @param source - Where it came from, for messages.
+ * @param scalars - `typed` (default), or `text` to keep every scalar as written (`0123` stays `"0123"`).
+ * @returns The data, the number of documents and the warnings.
+ * @throws Error naming the source, with the line and column, for YAML that does not parse.
+ */
+export declare function readYaml(text: string, source: string, scalars?: YamlScalars): Promise<YamlRead>;
+//# sourceMappingURL=read-yaml.client.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencraw/core",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "type": "module",
   "main": "./dist/index.esm.js",
   "module": "./dist/index.esm.js",
@@ -20,10 +20,14 @@
     "!**/*.js.map"
   ],
   "dependencies": {
+    "@opencraw/office-reader": "^0.0.2",
     "cheerio": "^1.2.0",
     "domhandler": "^6.0.1",
     "jsonpath-plus": "^10.4.0",
+    "marked": "^18.0.14",
+    "pdfjs-dist": "^6.3.289",
     "playwright": "^1.63.0",
+    "yaml": "^2.9.1",
     "zod": "^4.6.5"
   },
   "publishConfig": {
@@ -53,7 +57,8 @@
       "e2e": {
         "executor": "nx:run-commands",
         "dependsOn": [
-          "build"
+          "build",
+          "^build"
         ],
         "options": {
           "command": "tsc -p tsconfig.e2e.json && jest --config jest.e2e.config.cts",
@@ -69,6 +74,16 @@
           "command": "node tools/emit-json-schemas.mjs",
           "cwd": "packages/core"
         }
+      },
+      "typecheck": {
+        "dependsOn": [
+          "^build"
+        ]
+      },
+      "lint": {
+        "dependsOn": [
+          "^build"
+        ]
       }
     }
   }