vastgrid-js 0.0.0-stage → 0.2.0

package/dist/arrow.js

@@ -0,0 +1,25 @@
+/**
+ * Tables given as Arrow (docs/spec.md §2.3), read by a module of their own that the engine loads with the
+ * first such table, so that pages whose tables are rows do not load it.
+ */
+import { decodeColumns } from "vastgrid-spec/columns";
+import { checkNames, TableProblem } from "./table.js";
+/**
+ * Checks a table given as Arrow and reads its columns: their logical types, and their values kept as Arrow holds
+ * them. Throws a `TableProblem` at `/arrow` for bytes that are not an Arrow table of §2.3.
+ */
+export function checkArrow(bytes) {
+    if (!(bytes instanceof Uint8Array)) {
+        throw new TableProblem("/arrow", "arrow is the bytes of an Arrow IPC stream or file, in a Uint8Array.");
+    }
+    let decoded;
+    try {
+        decoded = decodeColumns(bytes);
+    }
+    catch (error) {
+        throw new TableProblem("/arrow", `The bytes are not an Arrow table of §2.3: ${error.message}`);
+    }
+    checkNames(decoded.columns, () => "/arrow");
+    return { columns: decoded.columns, rows: null, vectors: decoded.values, rowCount: decoded.length };
+}
+//# sourceMappingURL=arrow.js.map

package/dist/arrow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrow.js","sourceRoot":"","sources":["../src/arrow.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAqB,UAAU,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAEzE;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,IAAI,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,qEAAqE,CAAC,CAAC;IAC1G,CAAC;IACD,IAAI,OAAyC,CAAC;IAC9C,IAAI,CAAC;QACH,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,6CAA8C,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IACD,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC5C,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;AACrG,CAAC"}

package/dist/engine.d.ts

@@ -0,0 +1,40 @@
+/**
+ * An engine over tables in memory (docs/spec.md §8): it answers the requests of §8.2 about tables that
+ * its host gives it as arrays of typed JSON values (§2.2), as Arrow, as text files or as Parquet files, with views in
+ * the order of §3.3.
+ */
+import { type Capabilities } from "vastgrid-spec";
+import { type ArrowTable, type FileTable, type MemoryTable, type ParquetTable } from "./table.js";
+/** A table that a host gives the engine: rows of typed JSON, Arrow, a text file or a Parquet file. */
+type HostTable = MemoryTable | ArrowTable | FileTable | ParquetTable;
+export interface MemoryEngineOptions {
+    /**
+     * The tables that `open` opens, by the `ref` that names them: rows of typed JSON, Arrow, text files or Parquet
+     * files.
+     */
+    tables: Record<string, HostTable>;
+}
+export interface MemoryEngine {
+    /**
+     * Answers a request (§8.1) with its response or error, with blocks in the structured encoding (§8.8);
+     * `cancel` has no answer. Never throws: a message that does not follow §8 is answered with
+     * `invalid_request`.
+     */
+    handle(message: unknown): Promise<Record<string, unknown> | undefined>;
+    /** Listens to the events of §8.5, until the function it gives is called. This engine sends none yet. */
+    subscribe(listener: (event: Record<string, unknown>) => void): () => void;
+}
+/**
+ * What the engine evaluates (§4.10): every plan of §4.1, with every function of §4.4 and every measure of §4.5;
+ * `summarize`, `find`, `locate` and `export` of CSV, TSV, JSON and xlsx as data.
+ */
+export declare const MEMORY_CAPABILITIES: Readonly<Capabilities>;
+/**
+ * An engine over tables in memory. The host gives the tables by the `ref` that `open` takes; the engine checks
+ * the form of a table against §2 when it is first opened, and its values as it reads them (a column whole before
+ * it sorts or sums it), answering `load_failed` with the JSON Pointer of a value that does not follow §2.2. It
+ * reads the rows as they are, without copying them, so they must not change afterwards.
+ */
+export declare function memoryEngine(options: MemoryEngineOptions): MemoryEngine;
+export {};
+//# sourceMappingURL=engine.d.ts.map

package/dist/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAEL,KAAK,YAAY,EAsBlB,MAAM,eAAe,CAAC;AAIvB,OAAO,EACL,KAAK,UAAU,EAGf,KAAK,SAAS,EAMd,KAAK,WAAW,EAChB,KAAK,YAAY,EAOlB,MAAM,YAAY,CAAC;AAEpB,sGAAsG;AACtG,KAAK,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,GAAG,YAAY,CAAC;AAErE,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC;IACvE,wGAAwG;IACxG,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;CAC3E;AAKD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,YAAY,CAqBrD,CAAC;AA2hCH;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,YAAY,CAEvE"}