@loaders.gl/schema 4.0.0-alpha.23 → 4.0.0-alpha.25

package/dist/lib/table/arrow-api/enum.js

@@ -1,97 +0,0 @@
-"use strict";
-// This code is adapted from ArrowJS https://github.com/apache/arrow
-// under Apache license http://www.apache.org/licenses/LICENSE-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Type = void 0;
-/**
- * Main data type enumeration.
- *
- * Data types in this library are all *logical*. They can be expressed as
- * either a primitive physical type (bytes or bits of some fixed size), a
- * nested type consisting of other data types, or another data type (e.g. a
- * timestamp encoded as an int64).
- *
- * **Note**: Only enum values 0-17 (NONE through Map) are written to an Arrow
- * IPC payload.
- *
- * The rest of the values are specified here so TypeScript can narrow the type
- * signatures further beyond the base Arrow Types. The Arrow DataTypes include
- * metadata like `bitWidth` that impact the type signatures of the values we
- * accept and return.
- *
- * For example, the `Int8Vector` reads 1-byte numbers from an `Int8Array`, an
- * `Int32Vector` reads a 4-byte number from an `Int32Array`, and an `Int64Vector`
- * reads a pair of 4-byte lo, hi 32-bit integers as a zero-copy slice from the
- * underlying `Int32Array`.
- *
- * Library consumers benefit by knowing the narrowest type, since we can ensure
- * the types across all public methods are propagated, and never bail to `any`.
- * These values are _never_ used at runtime, and they will _never_ be written
- * to the flatbuffers metadata of serialized Arrow IPC payloads.
- */
-var Type;
-(function (Type) {
-    /** The default placeholder type */
-    Type[Type["NONE"] = 0] = "NONE";
-    /** A NULL type having no physical storage */
-    Type[Type["Null"] = 1] = "Null";
-    /** Signed or unsigned 8, 16, 32, or 64-bit little-endian integer */
-    Type[Type["Int"] = 2] = "Int";
-    /** 2, 4, or 8-byte floating point value */
-    Type[Type["Float"] = 3] = "Float";
-    /** Variable-length bytes (no guarantee of UTF8-ness) */
-    Type[Type["Binary"] = 4] = "Binary";
-    /** UTF8 variable-length string as List<Char> */
-    Type[Type["Utf8"] = 5] = "Utf8";
-    /** Boolean as 1 bit, LSB bit-packed ordering */
-    Type[Type["Bool"] = 6] = "Bool";
-    /** Precision-and-scale-based decimal type. Storage type depends on the parameters. */
-    Type[Type["Decimal"] = 7] = "Decimal";
-    /** int32_t days or int64_t milliseconds since the UNIX epoch */
-    Type[Type["Date"] = 8] = "Date";
-    /** Time as signed 32 or 64-bit integer, representing either seconds, milliseconds, microseconds, or nanoseconds since midnight since midnight */
-    Type[Type["Time"] = 9] = "Time";
-    /** Exact timestamp encoded with int64 since UNIX epoch (Default unit millisecond) */
-    Type[Type["Timestamp"] = 10] = "Timestamp";
-    /** YEAR_MONTH or DAY_TIME interval in SQL style */
-    Type[Type["Interval"] = 11] = "Interval";
-    /** A list of some logical data type */
-    Type[Type["List"] = 12] = "List";
-    /** Struct of logical types */
-    Type[Type["Struct"] = 13] = "Struct";
-    /** Union of logical types */
-    Type[Type["Union"] = 14] = "Union";
-    /** Fixed-size binary. Each value occupies the same number of bytes */
-    Type[Type["FixedSizeBinary"] = 15] = "FixedSizeBinary";
-    /** Fixed-size list. Each value occupies the same number of bytes */
-    Type[Type["FixedSizeList"] = 16] = "FixedSizeList";
-    /** Map of named logical types */
-    Type[Type["Map"] = 17] = "Map";
-    /** Dictionary aka Category type */
-    Type[Type["Dictionary"] = -1] = "Dictionary";
-    Type[Type["Int8"] = -2] = "Int8";
-    Type[Type["Int16"] = -3] = "Int16";
-    Type[Type["Int32"] = -4] = "Int32";
-    Type[Type["Int64"] = -5] = "Int64";
-    Type[Type["Uint8"] = -6] = "Uint8";
-    Type[Type["Uint16"] = -7] = "Uint16";
-    Type[Type["Uint32"] = -8] = "Uint32";
-    Type[Type["Uint64"] = -9] = "Uint64";
-    Type[Type["Float16"] = -10] = "Float16";
-    Type[Type["Float32"] = -11] = "Float32";
-    Type[Type["Float64"] = -12] = "Float64";
-    Type[Type["DateDay"] = -13] = "DateDay";
-    Type[Type["DateMillisecond"] = -14] = "DateMillisecond";
-    Type[Type["TimestampSecond"] = -15] = "TimestampSecond";
-    Type[Type["TimestampMillisecond"] = -16] = "TimestampMillisecond";
-    Type[Type["TimestampMicrosecond"] = -17] = "TimestampMicrosecond";
-    Type[Type["TimestampNanosecond"] = -18] = "TimestampNanosecond";
-    Type[Type["TimeSecond"] = -19] = "TimeSecond";
-    Type[Type["TimeMillisecond"] = -20] = "TimeMillisecond";
-    Type[Type["TimeMicrosecond"] = -21] = "TimeMicrosecond";
-    Type[Type["TimeNanosecond"] = -22] = "TimeNanosecond";
-    Type[Type["DenseUnion"] = -23] = "DenseUnion";
-    Type[Type["SparseUnion"] = -24] = "SparseUnion";
-    Type[Type["IntervalDayTime"] = -25] = "IntervalDayTime";
-    Type[Type["IntervalYearMonth"] = -26] = "IntervalYearMonth";
-})(Type || (exports.Type = Type = {}));

package/dist/lib/table/arrow-api/get-type-info.js

@@ -1,29 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTypeInfo = void 0;
-const arrow_like_type_1 = require("./arrow-like-type");
-/**
- * Gets type information from an Arrow type object or "mock" Arrow type object
- * @param arrowTypeLike Arrow Type or type object of similar shape
- */
-function getTypeInfo(arrowTypeLike) {
-    return {
-        typeId: arrowTypeLike.typeId,
-        ArrayType: arrowTypeLike.ArrayType,
-        typeName: arrowTypeLike.toString(),
-        typeEnumName: getTypeKey(arrowTypeLike.typeId),
-        precision: arrowTypeLike.precision
-    };
-}
-exports.getTypeInfo = getTypeInfo;
-let ReverseType = null;
-function getTypeKey(typeKey) {
-    if (!ReverseType) {
-        ReverseType = {};
-        for (const key in arrow_like_type_1.Type) {
-            ReverseType[arrow_like_type_1.Type[key]] = key;
-        }
-    }
-    return ReverseType[typeKey];
-}

package/dist/lib/table/arrow-api/index.js

@@ -1,25 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Table = exports.Schema = exports.Field = void 0;
-var arrow_like_field_1 = require("./arrow-like-field");
-Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return arrow_like_field_1.ArrowLikeField; } });
-var arrow_like_schema_1 = require("./arrow-like-schema");
-Object.defineProperty(exports, "Schema", { enumerable: true, get: function () { return arrow_like_schema_1.ArrowLikeSchema; } });
-var arrow_like_table_1 = require("./arrow-like-table");
-Object.defineProperty(exports, "Table", { enumerable: true, get: function () { return arrow_like_table_1.ArrowLikeTable; } });
-__exportStar(require("./arrow-like-type"), exports);

package/dist/lib/table/batches/base-table-batch-aggregator.js

@@ -1,60 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseTableBatchAggregator = void 0;
-const DEFAULT_ROW_COUNT = 100;
-class BaseTableBatchAggregator {
-    constructor(schema, options) {
-        this.length = 0;
-        this.rows = null;
-        this.cursor = 0;
-        this._headers = [];
-        this.options = options;
-        this.schema = schema;
-        // schema is an array if there're no headers
-        // object if there are headers
-        if (!Array.isArray(schema)) {
-            this._headers = [];
-            for (const key in schema) {
-                this._headers[schema[key].index] = schema[key].name;
-            }
-        }
-    }
-    rowCount() {
-        return this.length;
-    }
-    addArrayRow(row, cursor) {
-        if (Number.isFinite(cursor)) {
-            this.cursor = cursor;
-        }
-        this.rows = this.rows || new Array(DEFAULT_ROW_COUNT);
-        this.rows[this.length] = row;
-        this.length++;
-    }
-    addObjectRow(row, cursor) {
-        if (Number.isFinite(cursor)) {
-            this.cursor = cursor;
-        }
-        this.rows = this.rows || new Array(DEFAULT_ROW_COUNT);
-        this.rows[this.length] = row;
-        this.length++;
-    }
-    getBatch() {
-        let rows = this.rows;
-        if (!rows) {
-            return null;
-        }
-        rows = rows.slice(0, this.length);
-        this.rows = null;
-        const batch = {
-            shape: this.options.shape,
-            batchType: 'data',
-            data: rows,
-            length: this.length,
-            schema: this.schema,
-            cursor: this.cursor
-        };
-        return batch;
-    }
-}
-exports.BaseTableBatchAggregator = BaseTableBatchAggregator;

package/dist/lib/table/batches/columnar-table-batch-aggregator.js

@@ -1,92 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ColumnarTableBatchAggregator = void 0;
-const DEFAULT_ROW_COUNT = 100;
-class ColumnarTableBatchAggregator {
-    constructor(schema, options) {
-        this.length = 0;
-        this.allocated = 0;
-        this.columns = {};
-        this.schema = schema;
-        this._reallocateColumns();
-    }
-    rowCount() {
-        return this.length;
-    }
-    addArrayRow(row) {
-        // If user keeps pushing rows beyond batch size, reallocate
-        this._reallocateColumns();
-        let i = 0;
-        // TODO what if no csv header, columns not populated?
-        for (const fieldName in this.columns) {
-            this.columns[fieldName][this.length] = row[i++];
-        }
-        this.length++;
-    }
-    addObjectRow(row) {
-        // If user keeps pushing rows beyond batch size, reallocate
-        this._reallocateColumns();
-        for (const fieldName in row) {
-            this.columns[fieldName][this.length] = row[fieldName];
-        }
-        this.length++;
-    }
-    getBatch() {
-        this._pruneColumns();
-        const columns = Array.isArray(this.schema) ? this.columns : {};
-        // schema is an array if there're no headers
-        // object if there are headers
-        // columns should match schema format
-        if (!Array.isArray(this.schema)) {
-            for (const fieldName in this.schema) {
-                const field = this.schema[fieldName];
-                columns[field.name] = this.columns[field.index];
-            }
-        }
-        this.columns = {};
-        const batch = {
-            shape: 'columnar-table',
-            batchType: 'data',
-            data: columns,
-            schema: this.schema,
-            length: this.length
-        };
-        return batch;
-    }
-    // HELPERS
-    _reallocateColumns() {
-        if (this.length < this.allocated) {
-            return;
-        }
-        // @ts-ignore TODO
-        this.allocated = this.allocated > 0 ? (this.allocated *= 2) : DEFAULT_ROW_COUNT;
-        this.columns = {};
-        for (const fieldName in this.schema) {
-            const field = this.schema[fieldName];
-            const ArrayType = field.type || Float32Array;
-            const oldColumn = this.columns[field.index];
-            if (oldColumn && ArrayBuffer.isView(oldColumn)) {
-                // Copy the old data to the new array
-                const typedArray = new ArrayType(this.allocated);
-                typedArray.set(oldColumn);
-                this.columns[field.index] = typedArray;
-            }
-            else if (oldColumn) {
-                // Plain array
-                oldColumn.length = this.allocated;
-                this.columns[field.index] = oldColumn;
-            }
-            else {
-                // Create new
-                this.columns[field.index] = new ArrayType(this.allocated);
-            }
-        }
-    }
-    _pruneColumns() {
-        for (const [columnName, column] of Object.entries(this.columns)) {
-            this.columns[columnName] = column.slice(0, this.length);
-        }
-    }
-}
-exports.ColumnarTableBatchAggregator = ColumnarTableBatchAggregator;

package/dist/lib/table/batches/row-table-batch-aggregator.js

@@ -1,81 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RowTableBatchAggregator = void 0;
-// import type {ArrayRowTableBatch, ObjectRowTableBatch} from '../../category/table';
-const row_utils_1 = require("../simple-table/row-utils");
-const DEFAULT_ROW_COUNT = 100;
-class RowTableBatchAggregator {
-    constructor(schema, options) {
-        this.length = 0;
-        this.objectRows = null;
-        this.arrayRows = null;
-        this.cursor = 0;
-        this._headers = [];
-        this.options = options;
-        this.schema = schema;
-        // schema is an array if there're no headers
-        // object if there are headers
-        if (!Array.isArray(schema)) {
-            this._headers = [];
-            for (const key in schema) {
-                this._headers[schema[key].index] = schema[key].name;
-            }
-        }
-    }
-    rowCount() {
-        return this.length;
-    }
-    addArrayRow(row, cursor) {
-        if (Number.isFinite(cursor)) {
-            this.cursor = cursor;
-        }
-        // eslint-disable-next-line default-case
-        switch (this.options.shape) {
-            case 'object-row-table':
-                const rowObject = (0, row_utils_1.convertToObjectRow)(row, this._headers);
-                this.addObjectRow(rowObject, cursor);
-                break;
-            case 'array-row-table':
-                this.arrayRows = this.arrayRows || new Array(DEFAULT_ROW_COUNT);
-                this.arrayRows[this.length] = row;
-                this.length++;
-                break;
-        }
-    }
-    addObjectRow(row, cursor) {
-        if (Number.isFinite(cursor)) {
-            this.cursor = cursor;
-        }
-        // eslint-disable-next-line default-case
-        switch (this.options.shape) {
-            case 'array-row-table':
-                const rowArray = (0, row_utils_1.convertToArrayRow)(row, this._headers);
-                this.addArrayRow(rowArray, cursor);
-                break;
-            case 'object-row-table':
-                this.objectRows = this.objectRows || new Array(DEFAULT_ROW_COUNT);
-                this.objectRows[this.length] = row;
-                this.length++;
-                break;
-        }
-    }
-    getBatch() {
-        let rows = this.arrayRows || this.objectRows;
-        if (!rows) {
-            return null;
-        }
-        rows = rows.slice(0, this.length);
-        this.arrayRows = null;
-        this.objectRows = null;
-        return {
-            shape: this.options.shape,
-            batchType: 'data',
-            data: rows,
-            length: this.length,
-            schema: this.schema,
-            cursor: this.cursor
-        };
-    }
-}
-exports.RowTableBatchAggregator = RowTableBatchAggregator;

package/dist/lib/table/batches/table-batch-aggregator.js

@@ -1,3 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/table/batches/table-batch-builder.js

@@ -1,152 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TableBatchBuilder = void 0;
-const base_table_batch_aggregator_1 = require("./base-table-batch-aggregator");
-const row_table_batch_aggregator_1 = require("./row-table-batch-aggregator");
-const columnar_table_batch_aggregator_1 = require("./columnar-table-batch-aggregator");
-const DEFAULT_OPTIONS = {
-    shape: 'array-row-table',
-    batchSize: 'auto',
-    batchDebounceMs: 0,
-    limit: 0,
-    _limitMB: 0
-};
-const ERR_MESSAGE = 'TableBatchBuilder';
-/** Incrementally builds batches from a stream of rows */
-class TableBatchBuilder {
-    constructor(schema, options) {
-        this.aggregator = null;
-        this.batchCount = 0;
-        this.bytesUsed = 0;
-        this.isChunkComplete = false;
-        this.lastBatchEmittedMs = Date.now();
-        this.totalLength = 0;
-        this.totalBytes = 0;
-        this.rowBytes = 0;
-        this.schema = schema;
-        this.options = { ...DEFAULT_OPTIONS, ...options };
-    }
-    limitReached() {
-        if (Boolean(this.options?.limit) && this.totalLength >= this.options.limit) {
-            return true;
-        }
-        if (Boolean(this.options?._limitMB) && this.totalBytes / 1e6 >= this.options._limitMB) {
-            return true;
-        }
-        return false;
-    }
-    /** @deprecated Use addArrayRow or addObjectRow */
-    addRow(row) {
-        if (this.limitReached()) {
-            return;
-        }
-        this.totalLength++;
-        this.rowBytes = this.rowBytes || this._estimateRowMB(row);
-        this.totalBytes += this.rowBytes;
-        if (Array.isArray(row)) {
-            this.addArrayRow(row);
-        }
-        else {
-            this.addObjectRow(row);
-        }
-    }
-    /** Add one row to the batch */
-    addArrayRow(row) {
-        if (!this.aggregator) {
-            const TableBatchType = this._getTableBatchType();
-            this.aggregator = new TableBatchType(this.schema, this.options);
-        }
-        this.aggregator.addArrayRow(row);
-    }
-    /** Add one row to the batch */
-    addObjectRow(row) {
-        if (!this.aggregator) {
-            const TableBatchType = this._getTableBatchType();
-            this.aggregator = new TableBatchType(this.schema, this.options);
-        }
-        this.aggregator.addObjectRow(row);
-    }
-    /** Mark an incoming raw memory chunk has completed */
-    chunkComplete(chunk) {
-        if (chunk instanceof ArrayBuffer) {
-            this.bytesUsed += chunk.byteLength;
-        }
-        if (typeof chunk === 'string') {
-            this.bytesUsed += chunk.length;
-        }
-        this.isChunkComplete = true;
-    }
-    getFullBatch(options) {
-        return this._isFull() ? this._getBatch(options) : null;
-    }
-    getFinalBatch(options) {
-        return this._getBatch(options);
-    }
-    // INTERNAL
-    _estimateRowMB(row) {
-        return Array.isArray(row) ? row.length * 8 : Object.keys(row).length * 8;
-    }
-    _isFull() {
-        // No batch, not ready
-        if (!this.aggregator || this.aggregator.rowCount() === 0) {
-            return false;
-        }
-        // if batchSize === 'auto' we wait for chunk to complete
-        // if batchSize === number, ensure we have enough rows
-        if (this.options.batchSize === 'auto') {
-            if (!this.isChunkComplete) {
-                return false;
-            }
-        }
-        else if (this.options.batchSize > this.aggregator.rowCount()) {
-            return false;
-        }
-        // Debounce batches
-        if (this.options.batchDebounceMs > Date.now() - this.lastBatchEmittedMs) {
-            return false;
-        }
-        // Emit batch
-        this.isChunkComplete = false;
-        this.lastBatchEmittedMs = Date.now();
-        return true;
-    }
-    /**
-     * bytesUsed can be set via chunkComplete or via getBatch*
-     */
-    _getBatch(options) {
-        if (!this.aggregator) {
-            return null;
-        }
-        // TODO - this can overly increment bytes used?
-        if (options?.bytesUsed) {
-            this.bytesUsed = options.bytesUsed;
-        }
-        const normalizedBatch = this.aggregator.getBatch();
-        normalizedBatch.count = this.batchCount;
-        normalizedBatch.bytesUsed = this.bytesUsed;
-        Object.assign(normalizedBatch, options);
-        this.batchCount++;
-        this.aggregator = null;
-        return normalizedBatch;
-    }
-    _getTableBatchType() {
-        switch (this.options.shape) {
-            case 'row-table':
-                return base_table_batch_aggregator_1.BaseTableBatchAggregator;
-            case 'array-row-table':
-            case 'object-row-table':
-                return row_table_batch_aggregator_1.RowTableBatchAggregator;
-            case 'columnar-table':
-                return columnar_table_batch_aggregator_1.ColumnarTableBatchAggregator;
-            case 'arrow-table':
-                if (!TableBatchBuilder.ArrowBatch) {
-                    throw new Error(ERR_MESSAGE);
-                }
-                return TableBatchBuilder.ArrowBatch;
-            default:
-                throw new Error(ERR_MESSAGE);
-        }
-    }
-}
-exports.TableBatchBuilder = TableBatchBuilder;

package/dist/lib/table/simple-table/convert-table.js

@@ -1,65 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeObjectRowTable = exports.makeArrayRowTable = exports.makeColumnarTable = void 0;
-// loaders.gl, MIT license
-const table_accessors_1 = require("./table-accessors");
-const table_schema_1 = require("./table-schema");
-const table_column_1 = require("./table-column");
-/** Convert any simple table into columnar format */
-function makeColumnarTable(table) {
-    // TODO - should schema really be optional?
-    const schema = table.schema || (0, table_schema_1.deduceTableSchema)(table);
-    const fields = table.schema?.fields || [];
-    if (table.shape === 'columnar-table') {
-        return { ...table, schema };
-    }
-    const length = (0, table_accessors_1.getTableLength)(table);
-    const columns = {};
-    for (const field of fields) {
-        const column = (0, table_column_1.makeColumnFromField)(field, length);
-        columns[field.name] = column;
-        for (let rowIndex = 0; rowIndex < length; rowIndex++) {
-            column[rowIndex] = (0, table_accessors_1.getTableCell)(table, rowIndex, field.name);
-        }
-    }
-    return {
-        shape: 'columnar-table',
-        schema,
-        data: columns
-    };
-}
-exports.makeColumnarTable = makeColumnarTable;
-/** Convert any table into array row format */
-function makeArrayRowTable(table) {
-    if (table.shape === 'array-row-table') {
-        return table;
-    }
-    const length = (0, table_accessors_1.getTableLength)(table);
-    const data = new Array(length);
-    for (let rowIndex = 0; rowIndex < length; rowIndex++) {
-        data[rowIndex] = (0, table_accessors_1.getTableRowAsArray)(table, rowIndex);
-    }
-    return {
-        shape: 'array-row-table',
-        schema: table.schema,
-        data
-    };
-}
-exports.makeArrayRowTable = makeArrayRowTable;
-/** Convert any table into object row format */
-function makeObjectRowTable(table) {
-    if (table.shape === 'object-row-table') {
-        return table;
-    }
-    const length = (0, table_accessors_1.getTableLength)(table);
-    const data = new Array(length);
-    for (let rowIndex = 0; rowIndex < length; rowIndex++) {
-        data[rowIndex] = (0, table_accessors_1.getTableRowAsObject)(table, rowIndex);
-    }
-    return {
-        shape: 'object-row-table',
-        schema: table.schema,
-        data
-    };
-}
-exports.makeObjectRowTable = makeObjectRowTable;