@loaders.gl/schema 3.1.0-alpha.4 → 3.1.0-beta.3

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

@@ -0,0 +1,153 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_table_batch_aggregator_1 = __importDefault(require("./base-table-batch-aggregator"));
+const row_table_batch_aggregator_1 = __importDefault(require("./row-table-batch-aggregator"));
+const columnar_table_batch_aggregator_1 = __importDefault(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.default;
+            case 'array-row-table':
+            case 'object-row-table':
+                return row_table_batch_aggregator_1.default;
+            case 'columnar-table':
+                return columnar_table_batch_aggregator_1.default;
+            case 'arrow-table':
+                if (!TableBatchBuilder.ArrowBatch) {
+                    throw new Error(ERR_MESSAGE);
+                }
+                return TableBatchBuilder.ArrowBatch;
+            default:
+                throw new Error(ERR_MESSAGE);
+        }
+    }
+}
+exports.default = TableBatchBuilder;

package/dist/lib/schema/impl/enum.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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.
+ */
+export declare enum Type {
+    /** The default placeholder type */
+    NONE = 0,
+    /** A NULL type having no physical storage */
+    Null = 1,
+    /** Signed or unsigned 8, 16, 32, or 64-bit little-endian integer */
+    Int = 2,
+    /** 2, 4, or 8-byte floating point value */
+    Float = 3,
+    /** Variable-length bytes (no guarantee of UTF8-ness) */
+    Binary = 4,
+    /** UTF8 variable-length string as List<Char> */
+    Utf8 = 5,
+    /** Boolean as 1 bit, LSB bit-packed ordering */
+    Bool = 6,
+    /** Precision-and-scale-based decimal type. Storage type depends on the parameters. */
+    Decimal = 7,
+    /** int32_t days or int64_t milliseconds since the UNIX epoch */
+    Date = 8,
+    /** Time as signed 32 or 64-bit integer, representing either seconds, milliseconds, microseconds, or nanoseconds since midnight since midnight */
+    Time = 9,
+    /** Exact timestamp encoded with int64 since UNIX epoch (Default unit millisecond) */
+    Timestamp = 10,
+    /** YEAR_MONTH or DAY_TIME interval in SQL style */
+    Interval = 11,
+    /** A list of some logical data type */
+    List = 12,
+    /** Struct of logical types */
+    Struct = 13,
+    /** Union of logical types */
+    Union = 14,
+    /** Fixed-size binary. Each value occupies the same number of bytes */
+    FixedSizeBinary = 15,
+    /** Fixed-size list. Each value occupies the same number of bytes */
+    FixedSizeList = 16,
+    /** Map of named logical types */
+    Map = 17,
+    /** Dictionary aka Category type */
+    Dictionary = -1,
+    Int8 = -2,
+    Int16 = -3,
+    Int32 = -4,
+    Int64 = -5,
+    Uint8 = -6,
+    Uint16 = -7,
+    Uint32 = -8,
+    Uint64 = -9,
+    Float16 = -10,
+    Float32 = -11,
+    Float64 = -12,
+    DateDay = -13,
+    DateMillisecond = -14,
+    TimestampSecond = -15,
+    TimestampMillisecond = -16,
+    TimestampMicrosecond = -17,
+    TimestampNanosecond = -18,
+    TimeSecond = -19,
+    TimeMillisecond = -20,
+    TimeMicrosecond = -21,
+    TimeNanosecond = -22,
+    DenseUnion = -23,
+    SparseUnion = -24,
+    IntervalDayTime = -25,
+    IntervalYearMonth = -26
+}
+//# sourceMappingURL=enum.d.ts.map

package/dist/lib/schema/impl/enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enum.d.ts","sourceRoot":"","sources":["../../../../src/lib/schema/impl/enum.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,oBAAY,IAAI;IACd,mCAAmC;IACnC,IAAI,IAAI;IACR,6CAA6C;IAC7C,IAAI,IAAI;IACR,oEAAoE;IACpE,GAAG,IAAI;IACP,2CAA2C;IAC3C,KAAK,IAAI;IACT,wDAAwD;IACxD,MAAM,IAAI;IACV,gDAAgD;IAChD,IAAI,IAAI;IACR,gDAAgD;IAChD,IAAI,IAAI;IACR,sFAAsF;IACtF,OAAO,IAAI;IACX,gEAAgE;IAChE,IAAI,IAAI;IACR,iJAAiJ;IACjJ,IAAI,IAAI;IACR,qFAAqF;IACrF,SAAS,KAAK;IACd,mDAAmD;IACnD,QAAQ,KAAK;IACb,uCAAuC;IACvC,IAAI,KAAK;IACT,8BAA8B;IAC9B,MAAM,KAAK;IACX,6BAA6B;IAC7B,KAAK,KAAK;IACV,sEAAsE;IACtE,eAAe,KAAK;IACpB,oEAAoE;IACpE,aAAa,KAAK;IAClB,iCAAiC;IACjC,GAAG,KAAK;IAER,mCAAmC;IACnC,UAAU,KAAK;IACf,IAAI,KAAK;IACT,KAAK,KAAK;IACV,KAAK,KAAK;IACV,KAAK,KAAK;IACV,KAAK,KAAK;IACV,MAAM,KAAK;IACX,MAAM,KAAK;IACX,MAAM,KAAK;IACX,OAAO,MAAM;IACb,OAAO,MAAM;IACb,OAAO,MAAM;IACb,OAAO,MAAM;IACb,eAAe,MAAM;IACrB,eAAe,MAAM;IACrB,oBAAoB,MAAM;IAC1B,oBAAoB,MAAM;IAC1B,mBAAmB,MAAM;IACzB,UAAU,MAAM;IAChB,eAAe,MAAM;IACrB,eAAe,MAAM;IACrB,cAAc,MAAM;IACpB,UAAU,MAAM;IAChB,WAAW,MAAM;IACjB,eAAe,MAAM;IACrB,iBAAiB,MAAM;CACxB"}

package/dist/lib/schema/impl/enum.js

@@ -0,0 +1,97 @@
+"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 || (exports.Type = {}));

package/dist/lib/schema/impl/field.d.ts

@@ -0,0 +1,19 @@
+import { DataType } from './type';
+/**
+ * ArrowJS `Field` API-compatible class for row-based tables
+ * https://loaders.gl/arrowjs/docs/api-reference/field
+ * A field holds name, nullable, and metadata information about a table "column"
+ * A Schema is essentially a list of fields
+ */
+export default class Field {
+    name: string;
+    type: DataType;
+    nullable: boolean;
+    metadata: Map<string, string>;
+    constructor(name: string, type: DataType, nullable?: boolean, metadata?: Map<string, string>);
+    get typeId(): number;
+    clone(): Field;
+    compareTo(other: this): boolean;
+    toString(): string;
+}
+//# sourceMappingURL=field.d.ts.map

package/dist/lib/schema/impl/field.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../../../src/lib/schema/impl/field.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,QAAQ,CAAC;AAEhC;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAG5B,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,QAAQ,EACd,QAAQ,UAAQ,EAChB,QAAQ,GAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAa;IAQ3C,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,KAAK,IAAI,KAAK;IAId,SAAS,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO;IAS/B,QAAQ,IAAI,MAAM;CAKnB"}

package/dist/lib/schema/impl/field.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * ArrowJS `Field` API-compatible class for row-based tables
+ * https://loaders.gl/arrowjs/docs/api-reference/field
+ * A field holds name, nullable, and metadata information about a table "column"
+ * A Schema is essentially a list of fields
+ */
+class Field {
+    constructor(name, type, nullable = false, metadata = new Map()) {
+        this.name = name;
+        this.type = type;
+        this.nullable = nullable;
+        this.metadata = metadata;
+    }
+    get typeId() {
+        return this.type && this.type.typeId;
+    }
+    clone() {
+        return new Field(this.name, this.type, this.nullable, this.metadata);
+    }
+    compareTo(other) {
+        return (this.name === other.name &&
+            this.type === other.type &&
+            this.nullable === other.nullable &&
+            this.metadata === other.metadata);
+    }
+    toString() {
+        return `${this.type}${this.nullable ? ', nullable' : ''}${this.metadata ? `, metadata: ${this.metadata}` : ''}`;
+    }
+}
+exports.default = Field;

package/dist/lib/schema/impl/schema.d.ts

@@ -0,0 +1,16 @@
+import Field from './field';
+export declare type SchemaMetadata = Map<string, any>;
+/**
+ * ArrowJS `Schema` API-compatible class for row-based tables (returned from `DataTable`)
+ * https://loaders.gl/arrowjs/docs/api-reference/schema
+ */
+export default class Schema {
+    fields: Field[];
+    metadata: SchemaMetadata;
+    constructor(fields: Field[], metadata?: SchemaMetadata);
+    compareTo(other: Schema): boolean;
+    select(...columnNames: string[]): Schema;
+    selectAt(...columnIndices: number[]): Schema;
+    assign(schemaOrFields: Schema | Field[]): Schema;
+}
+//# sourceMappingURL=schema.d.ts.map

package/dist/lib/schema/impl/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../src/lib/schema/impl/schema.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,oBAAY,cAAc,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE9C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,MAAM,EAAE,KAAK,EAAE,CAAC;IAEhB,QAAQ,EAAE,cAAc,CAAC;gBAEb,MAAM,EAAE,KAAK,EAAE,EAAE,QAAQ,CAAC,EAAE,cAAc;IAStD,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAejC,MAAM,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM;IAUxC,QAAQ,CAAC,GAAG,aAAa,EAAE,MAAM,EAAE,GAAG,MAAM;IAM5C,MAAM,CAAC,cAAc,EAAE,MAAM,GAAG,KAAK,EAAE,GAAG,MAAM;CA2BjD"}

package/dist/lib/schema/impl/schema.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = require("../../utils/assert");
+/**
+ * ArrowJS `Schema` API-compatible class for row-based tables (returned from `DataTable`)
+ * https://loaders.gl/arrowjs/docs/api-reference/schema
+ */
+class Schema {
+    constructor(fields, metadata) {
+        (0, assert_1.assert)(Array.isArray(fields));
+        checkNames(fields);
+        // For kepler fields, create arrow compatible `Fields` that have kepler fields as `metadata`
+        this.fields = fields;
+        this.metadata = metadata || new Map();
+    }
+    // TODO - arrow only seems to compare fields, not metadata
+    compareTo(other) {
+        if (this.metadata !== other.metadata) {
+            return false;
+        }
+        if (this.fields.length !== other.fields.length) {
+            return false;
+        }
+        for (let i = 0; i < this.fields.length; ++i) {
+            if (!this.fields[i].compareTo(other.fields[i])) {
+                return false;
+            }
+        }
+        return true;
+    }
+    select(...columnNames) {
+        // Ensure column names reference valid fields
+        const nameMap = Object.create(null);
+        for (const name of columnNames) {
+            nameMap[name] = true;
+        }
+        const selectedFields = this.fields.filter((field) => nameMap[field.name]);
+        return new Schema(selectedFields, this.metadata);
+    }
+    selectAt(...columnIndices) {
+        // Ensure column indices reference valid fields
+        const selectedFields = columnIndices.map((index) => this.fields[index]).filter(Boolean);
+        return new Schema(selectedFields, this.metadata);
+    }
+    assign(schemaOrFields) {
+        let fields;
+        let metadata = this.metadata;
+        if (schemaOrFields instanceof Schema) {
+            const otherSchema = schemaOrFields;
+            fields = otherSchema.fields;
+            metadata = mergeMaps(mergeMaps(new Map(), this.metadata), otherSchema.metadata);
+        }
+        else {
+            fields = schemaOrFields;
+        }
+        // Create a merged list of fields, overwrite fields in place, new fields at end
+        const fieldMap = Object.create(null);
+        for (const field of this.fields) {
+            fieldMap[field.name] = field;
+        }
+        for (const field of fields) {
+            fieldMap[field.name] = field;
+        }
+        const mergedFields = Object.values(fieldMap);
+        return new Schema(mergedFields, metadata);
+    }
+}
+exports.default = Schema;
+// Warn if any duplicated field names
+function checkNames(fields) {
+    const usedNames = {};
+    for (const field of fields) {
+        if (usedNames[field.name]) {
+            // eslint-disable-next-line
+            console.warn('Schema: duplicated field name', field.name, field);
+        }
+        usedNames[field.name] = true;
+    }
+}
+function mergeMaps(m1, m2) {
+    // @ts-ignore
+    return new Map([...(m1 || new Map()), ...(m2 || new Map())]);
+}

package/dist/lib/schema/impl/type.d.ts

@@ -0,0 +1,176 @@
+import { Type } from './enum';
+import Field from './field';
+export { Type } from './enum';
+export declare type TypedIntArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Int32Array | Uint32Array | Uint8ClampedArray;
+export declare type TypedFloatArray = Float32Array | Float64Array;
+export declare type TypedArray = TypedIntArray | TypedFloatArray;
+export declare type AnyArrayType = Array<any> | TypedIntArray | TypedFloatArray;
+export declare class DataType {
+    static isNull(x: any): boolean;
+    static isInt(x: any): boolean;
+    static isFloat(x: any): boolean;
+    static isBinary(x: any): boolean;
+    static isUtf8(x: any): boolean;
+    static isBool(x: any): boolean;
+    static isDecimal(x: any): boolean;
+    static isDate(x: any): boolean;
+    static isTime(x: any): boolean;
+    static isTimestamp(x: any): boolean;
+    static isInterval(x: any): boolean;
+    static isList(x: any): boolean;
+    static isStruct(x: any): boolean;
+    static isUnion(x: any): boolean;
+    static isFixedSizeBinary(x: any): boolean;
+    static isFixedSizeList(x: any): boolean;
+    static isMap(x: any): boolean;
+    static isDictionary(x: any): boolean;
+    get typeId(): Type;
+    compareTo(other: DataType): boolean;
+}
+export declare class Null extends DataType {
+    get typeId(): Type;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+}
+export declare class Bool extends DataType {
+    get typeId(): Type;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+}
+export declare class Int extends DataType {
+    readonly isSigned: boolean;
+    readonly bitWidth: number;
+    constructor(isSigned: any, bitWidth: any);
+    get typeId(): Type;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+}
+export declare class Int8 extends Int {
+    constructor();
+}
+export declare class Int16 extends Int {
+    constructor();
+}
+export declare class Int32 extends Int {
+    constructor();
+}
+export declare class Int64 extends Int {
+    constructor();
+}
+export declare class Uint8 extends Int {
+    constructor();
+}
+export declare class Uint16 extends Int {
+    constructor();
+}
+export declare class Uint32 extends Int {
+    constructor();
+}
+export declare class Uint64 extends Int {
+    constructor();
+}
+export declare class Float extends DataType {
+    readonly precision: number;
+    constructor(precision: any);
+    get typeId(): Type;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+}
+export declare class Float16 extends Float {
+    constructor();
+}
+export declare class Float32 extends Float {
+    constructor();
+}
+export declare class Float64 extends Float {
+    constructor();
+}
+export declare class Binary extends DataType {
+    constructor();
+    get typeId(): Type;
+    toString(): string;
+    get [Symbol.toStringTag](): string;
+}
+export declare class Utf8 extends DataType {
+    get typeId(): Type;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+}
+export declare class Date extends DataType {
+    readonly unit: number;
+    constructor(unit: any);
+    get typeId(): Type;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+}
+export declare class DateDay extends Date {
+    constructor();
+}
+export declare class DateMillisecond extends Date {
+    constructor();
+}
+export declare class Time extends DataType {
+    readonly unit: any;
+    readonly bitWidth: number;
+    constructor(unit: any, bitWidth: number);
+    get typeId(): Type;
+    toString(): string;
+    get [Symbol.toStringTag](): string;
+}
+export declare class TimeSecond extends Time {
+    constructor();
+}
+export declare class TimeMillisecond extends Time {
+    constructor();
+}
+export declare class Timestamp extends DataType {
+    readonly unit: any;
+    readonly timezone: any;
+    constructor(unit: any, timezone?: null);
+    get typeId(): Type;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+}
+export declare class TimestampSecond extends Timestamp {
+    constructor(timezone?: null);
+}
+export declare class TimestampMillisecond extends Timestamp {
+    constructor(timezone?: null);
+}
+export declare class TimestampMicrosecond extends Timestamp {
+    constructor(timezone?: null);
+}
+export declare class TimestampNanosecond extends Timestamp {
+    constructor(timezone?: null);
+}
+export declare class Interval extends DataType {
+    readonly unit: number;
+    constructor(unit: number);
+    get typeId(): Type;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+}
+export declare class IntervalDayTime extends Interval {
+    constructor();
+}
+export declare class IntervalYearMonth extends Interval {
+    constructor();
+}
+export declare class FixedSizeList extends DataType {
+    readonly listSize: number;
+    readonly children: Field[];
+    constructor(listSize: number, child: Field);
+    get typeId(): Type;
+    get valueType(): DataType;
+    get valueField(): Field;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+}
+export declare class Struct extends DataType {
+    readonly children: Field[];
+    constructor(children: Field[]);
+    get typeId(): Type;
+    toString(): string;
+    get [Symbol.toStringTag](): string;
+}
+//# sourceMappingURL=type.d.ts.map