@brass-build/client 0.4.1 → 0.5.0

package/dist/sealed-arrow.d.ts

@@ -0,0 +1,170 @@
+/** The slice of Arrow JS this reader uses. */
+export interface ArrowData {
+    type: {
+        typeId: number;
+    };
+    length: number;
+    offset: number;
+    values: ArrayLike<number> & {
+        subarray?: (a: number, b: number) => Uint8Array;
+    };
+    valueOffsets: Int32Array;
+    children: ArrowData[];
+    dictionary?: {
+        length: number;
+        data: ArrowData[];
+    };
+}
+export interface ArrowReader {
+    tableFromIPC(bytes: Uint8Array): {
+        schema: {
+            metadata: Map<string, string>;
+        };
+        batches: {
+            data: ArrowData;
+        }[];
+    };
+}
+/** The variants a slot's values take, in the order the `t` column numbers
+ *  them. */
+export interface Slot {
+    v: Variant[];
+}
+/** A string derived from a sibling number field: field index `from`, and per
+ *  code an upper-case flag and a suffix. */
+export interface Derivation {
+    from: number;
+    rules: [0 | 1, string][];
+}
+export type Variant = {
+    k: 'null';
+} | {
+    k: 'bool';
+    c?: boolean;
+} | {
+    k: 'num';
+    int: boolean;
+    c?: number;
+} | {
+    k: 'str';
+    c?: string;
+    derive?: Derivation;
+} | {
+    k: 'tuple';
+    items: Slot[];
+} | {
+    k: 'list';
+    item: Slot;
+} | {
+    k: 'obj';
+    keys: string[];
+    fields: Slot[];
+} | {
+    k: 'json';
+};
+/** How a table stores its keys: a shared prefix before an int32, two
+ *  dictionary halves around a separator, utf8 text, or JSON text for a key
+ *  UTF-8 cannot carry. */
+export type KeyMeta = {
+    prefix: string;
+} | {
+    split: string;
+} | {
+    text: true;
+} | {
+    json: true;
+};
+export interface TableMeta {
+    root: string;
+    key: KeyMeta;
+    slot: Slot;
+}
+/** The derived-string code for a row whose text no rule rebuilds. */
+export declare const HELD = 255;
+/** The table metadata's key in an IPC file's schema metadata. */
+export declare const TABLE_META_KEY = "brass:table";
+/** Whether a variant stores a column. */
+export declare function variantStored(v: Variant): boolean;
+/** Named parts behind a JSON table of names and lengths. */
+export declare function unpackParts(bytes: Uint8Array): [string, Uint8Array][];
+/**
+ * Throws unless an Arrow IPC file's footer and every message it points at
+ * stay inside the file. Arrow reads a file by its own offsets and vector
+ * lengths, so a footer block naming a message of the wrong kind makes its
+ * reader loop, and a declared length makes it allocate that much; both are
+ * held to the bytes here before Arrow reads anything.
+ */
+export declare function checkIpcFile(bytes: Uint8Array): void;
+/**
+ * Throws unless a stored table's buffers carry every row it declares. A
+ * column's length is the uploader's claim, and the reader allocates and loops
+ * on it, so each claim is held to the bytes behind it: a fixed-width column
+ * has a value per row, offsets rise and stay inside the bytes or child they
+ * index (so no two rows share a range, and decoding every row reads each
+ * byte once), a struct's fields are each as long as it, and a dictionary is
+ * no longer than the column that indexes it. A table's own struct carries
+ * the key, gap and value columns.
+ */
+export declare function checkTableData(data: ArrowData): void;
+export type Reader = (row: number) => unknown;
+/** What one decode shares across its tables: each object key list's
+ *  construction site, and each dictionary decoded once. A `lazy` context
+ *  decodes a dictionary's entries as reads reach them, which suits a keyed
+ *  read; a walk reads every entry, and decoding them up front is faster. */
+export declare class ReadContext {
+    readonly lazy: boolean;
+    private readonly shapes;
+    private readonly dictionaries;
+    private readonly lazyDictionaries;
+    constructor(lazy?: boolean);
+    strings(dictionary: {
+        data: ArrowData[];
+    }): string[];
+    lazyStrings(dictionary: {
+        data: ArrowData[];
+    }): LazyDictionary;
+    /** A flag per dictionary entry equal to `s`, or null where none is. */
+    matches(dictionary: {
+        data: ArrowData[];
+    }, s: string): Uint8Array | null;
+    shapeId(keys: readonly string[]): number;
+}
+/** A dictionary whose entries are decoded on first read and kept. */
+export declare class LazyDictionary {
+    private readonly chunks;
+    readonly length: number;
+    private readonly decoded;
+    /** Each chunk's first entry. */
+    private readonly starts;
+    constructor(chunks: readonly ArrowData[]);
+    at(i: number): string;
+    /** A flag per entry equal to `s`, found by comparing bytes, or null where
+     *  none is. */
+    matches(s: string): Uint8Array | null;
+}
+/**
+ * A table's keys as text, row by row. Each key reads only in the form the
+ * encoder writes it (a non-negative integer id, a separator that falls after
+ * the first half, UTF-8 text, JSON text as `JSON.stringify` writes it), so a
+ * walk and a keyed read (`rowsWithKey`) agree on every key; any other form
+ * throws.
+ */
+export declare function keyReader(meta: TableMeta, d: ArrowData, cx: ReadContext): (row: number) => string;
+/**
+ * The rows of a table whose key reads as `key`, found from the key column
+ * alone: an id compared as a number, a dictionary half by its index, text by
+ * its bytes. Nothing is decoded for a row that does not match.
+ */
+export declare function rowsWithKey(meta: TableMeta, d: ArrowData, key: string, cx: ReadContext): number[];
+export declare function readSlot(slot: Slot, d: ArrowData, cx: ReadContext): Reader;
+/** One table of a map, ready to read: each row's position in the map, its
+ *  key, and its value. */
+export interface ReadyTable {
+    positions: Int32Array;
+    key: (row: number) => string;
+    value: Reader;
+}
+/** A stored table's rows prepared for reading. Positions are absolute, and a
+ *  table's gap column runs from zero. */
+export declare function readyTable(meta: TableMeta, data: ArrowData, cx: ReadContext): ReadyTable;
+//# sourceMappingURL=sealed-arrow.d.ts.map

package/dist/sealed-arrow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sealed-arrow.d.ts","sourceRoot":"","sources":["../src/sealed-arrow.ts"],"names":[],"mappings":"AAyCA,8CAA8C;AAC9C,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG;QAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,UAAU,CAAA;KAAE,CAAC;IAChF,YAAY,EAAE,UAAU,CAAC;IACzB,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,UAAU,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,SAAS,EAAE,CAAA;KAAE,CAAC;CACpD;AAED,MAAM,WAAW,WAAW;IAC1B,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG;QAC/B,MAAM,EAAE;YAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;SAAE,CAAC;QAC1C,OAAO,EAAE;YAAE,IAAI,EAAE,SAAS,CAAA;SAAE,EAAE,CAAC;KAChC,CAAC;CACH;AAED;YACY;AACZ,MAAM,WAAW,IAAI;IACnB,CAAC,EAAE,OAAO,EAAE,CAAC;CACd;AAED;4CAC4C;AAC5C,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC;CAC1B;AAED,MAAM,MAAM,OAAO,GACf;IAAE,CAAC,EAAE,MAAM,CAAA;CAAE,GACb;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,CAAC,EAAE,OAAO,CAAA;CAAE,GAC1B;IAAE,CAAC,EAAE,KAAK,CAAC;IAAC,GAAG,EAAE,OAAO,CAAC;IAAC,CAAC,CAAC,EAAE,MAAM,CAAA;CAAE,GACtC;IAAE,CAAC,EAAE,KAAK,CAAC;IAAC,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,UAAU,CAAA;CAAE,GAC7C;IAAE,CAAC,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,IAAI,EAAE,CAAA;CAAE,GAC7B;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,IAAI,CAAA;CAAE,GACzB;IAAE,CAAC,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,EAAE,IAAI,EAAE,CAAA;CAAE,GAC5C;IAAE,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAElB;;0BAE0B;AAC1B,MAAM,MAAM,OAAO,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC;AAE/F,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,OAAO,CAAC;IACb,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,qEAAqE;AACrE,eAAO,MAAM,IAAI,MAAM,CAAC;AAExB,iEAAiE;AACjE,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAE5C,yCAAyC;AACzC,wBAAgB,aAAa,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO,CAUjD;AAQD,4DAA4D;AAC5D,wBAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,CAcrE;AAgDD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,CA0DpD;AAWD;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAKpD;AAiED,MAAM,MAAM,MAAM,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;AAE9C;;;4EAG4E;AAC5E,qBAAa,WAAW;IAKV,QAAQ,CAAC,IAAI;IAJzB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA6B;IACpD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAmC;IAChE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAyC;gBAErD,IAAI,UAAQ;IAEjC,OAAO,CAAC,UAAU,EAAE;QAAE,IAAI,EAAE,SAAS,EAAE,CAAA;KAAE,GAAG,MAAM,EAAE;IAapD,WAAW,CAAC,UAAU,EAAE;QAAE,IAAI,EAAE,SAAS,EAAE,CAAA;KAAE,GAAG,cAAc;IAS9D,uEAAuE;IACvE,OAAO,CAAC,UAAU,EAAE;QAAE,IAAI,EAAE,SAAS,EAAE,CAAA;KAAE,EAAE,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;IAIxE,OAAO,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM;CASzC;AAED,qEAAqE;AACrE,qBAAa,cAAc;IAMb,OAAO,CAAC,QAAQ,CAAC,MAAM;IALnC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IACjD,gCAAgC;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;gBAEV,MAAM,EAAE,SAAS,SAAS,EAAE;IAUzD,EAAE,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAcrB;mBACe;IACf,OAAO,CAAC,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;CAsBtC;AAYD;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAqCjG;AA2BD;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,WAAW,GAAG,MAAM,EAAE,CAuCjG;AAWD,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,GAAG,MAAM,CAQ1E;AAyOD;0BAC0B;AAC1B,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,UAAU,CAAC;IACtB,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;CACf;AAED;yCACyC;AACzC,wBAAgB,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,GAAG,UAAU,CAUxF"}