gremlin 4.0.0-beta.2 → 4.0.0-beta.3

package/build/esm/structure/io/binary/internals/SetSerializer.d.ts

@@ -4,12 +4,19 @@ export default class SetSerializer {
     ID: any;
     canBeUsedFor(value: any): value is Set<any>;
     serialize(item: any, fullyQualifiedFormat?: boolean): Buffer<ArrayBuffer>;
-    deserialize(buffer: any, fullyQualifiedFormat?: boolean, ...args: any[]): {
-        v: null;
-        len: number;
-    } | {
-        v: Set<any>;
-        len: number;
-    };
+    /**
+     * Async deserialization of set value bytes from a StreamReader.
+     * @param {StreamReader} reader
+     * @param {number} valueFlag - 0x00 for normal, 0x02 for bulked
+     * @param {number} typeCode
+     * @returns {Promise<Set>}
+     */
+    deserializeValue(reader: StreamReader, valueFlag: number, typeCode: number): Promise<Set<any>>;
+    /**
+     * Async fully-qualified deserialization from a StreamReader.
+     * @param {StreamReader} reader
+     * @returns {Promise<Set|null>}
+     */
+    deserialize(reader: StreamReader): Promise<Set<any> | null>;
 }
 import { Buffer } from 'buffer';

package/build/esm/structure/io/binary/internals/SetSerializer.js

@@ -55,81 +55,47 @@ export default class SetSerializer {
         }
         return Buffer.concat(bufs);
     }
-    deserialize(buffer, fullyQualifiedFormat = true) {
-        let len = 0;
-        let cursor = buffer;
-        let isBulked = false;
-        try {
-            if (buffer === undefined || buffer === null || !(buffer instanceof Buffer)) {
-                throw new Error('buffer is missing');
-            }
-            if (buffer.length < 1) {
-                throw new Error('buffer is empty');
-            }
-            if (fullyQualifiedFormat) {
-                const typeCode = cursor.readUInt8();
-                len++;
-                if (typeCode !== this.ID) {
-                    throw new Error('unexpected {type_code}');
-                }
-                cursor = cursor.slice(1);
-                if (cursor.length < 1) {
-                    throw new Error('{value_flag} is missing');
-                }
-                const valueFlag = cursor.readUInt8();
-                len++;
-                if (valueFlag === 1) {
-                    return { v: null, len };
-                }
-                if (valueFlag !== 0 && valueFlag !== 2) {
-                    throw new Error('unexpected {value_flag}');
-                }
-                isBulked = valueFlag === 2;
-                cursor = cursor.slice(1);
-            }
-            let length, lengthLen;
-            try {
-                ({ v: length, len: lengthLen } = this.ioc.intSerializer.deserialize(cursor, false));
-                len += lengthLen;
-            }
-            catch (err) {
-                err.message = '{length}: ' + err.message;
-                throw err;
-            }
-            if (length < 0) {
-                throw new Error('{length} is less than zero');
-            }
-            cursor = cursor.slice(lengthLen);
-            const v = new Set();
-            for (let i = 0; i < length; i++) {
-                let value, valueLen;
-                try {
-                    ({ v: value, len: valueLen } = this.ioc.anySerializer.deserialize(cursor));
-                    len += valueLen;
-                }
-                catch (err) {
-                    err.message = `{item_${i}}: ` + err.message;
-                    throw err;
-                }
-                cursor = cursor.slice(valueLen);
-                if (isBulked) {
-                    if (cursor.length < 8) {
-                        throw new Error(`{item_${i}}: bulk count is missing`);
-                    }
-                    cursor.readBigInt64BE();
-                    len += 8;
-                    cursor = cursor.slice(8);
-                    // Set.add is idempotent; bulk count only affects cardinality, not Set membership
-                    v.add(value);
-                }
-                else {
-                    v.add(value);
-                }
+    /**
+     * Async deserialization of set value bytes from a StreamReader.
+     * @param {StreamReader} reader
+     * @param {number} valueFlag - 0x00 for normal, 0x02 for bulked
+     * @param {number} typeCode
+     * @returns {Promise<Set>}
+     */
+    async deserializeValue(reader, valueFlag, typeCode) {
+        const isBulked = valueFlag === 0x02;
+        const length = await this.ioc.intSerializer.deserializeBare(reader);
+        if (length < 0) {
+            throw new Error(`SetSerializer: {length}=${length} is less than zero`);
+        }
+        const v = new Set();
+        for (let i = 0; i < length; i++) {
+            const value = await this.ioc.anySerializer.deserialize(reader);
+            if (isBulked) {
+                // consume the bulk count; Set.add is idempotent so count doesn't matter
+                await reader.readBigInt64BE();
             }
-            return { v, len };
+            v.add(value);
+        }
+        return v;
+    }
+    /**
+     * Async fully-qualified deserialization from a StreamReader.
+     * @param {StreamReader} reader
+     * @returns {Promise<Set|null>}
+     */
+    async deserialize(reader) {
+        const type_code = await reader.readUInt8();
+        if (type_code !== this.ID) {
+            throw new Error(`SetSerializer: unexpected {type_code}=0x${type_code.toString(16)}`);
+        }
+        const value_flag = await reader.readUInt8();
+        if (value_flag === 0x01) {
+            return null;
         }
-        catch (err) {
-            throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
+        if (value_flag !== 0x00 && value_flag !== 0x02) {
+            throw new Error(`SetSerializer: unexpected {value_flag}=0x${value_flag.toString(16)}`);
         }
+        return this.deserializeValue(reader, value_flag, type_code);
     }
 }

package/build/esm/structure/io/binary/internals/ShortSerializer.d.ts

@@ -3,9 +3,17 @@ export default class ShortSerializer {
     ioc: any;
     canBeUsedFor(value: any): void;
     serialize(item: any, fullyQualifiedFormat?: boolean): Buffer<ArrayBuffer>;
-    deserialize(buffer: any, fullyQualifiedFormat?: boolean, ...args: any[]): {
-        v: any;
-        len: number;
-    };
+    /**
+     * @param {StreamReader} reader
+     * @param {number} valueFlag
+     * @param {number} typeCode
+     * @returns {Promise<number>}
+     */
+    deserializeValue(reader: StreamReader, valueFlag: number, typeCode: number): Promise<number>;
+    /**
+     * @param {StreamReader} reader
+     * @returns {Promise<number|null>}
+     */
+    deserialize(reader: StreamReader): Promise<number | null>;
 }
 import { Buffer } from 'buffer';

package/build/esm/structure/io/binary/internals/ShortSerializer.js

@@ -44,45 +44,31 @@ export default class ShortSerializer {
         bufs.push(v);
         return Buffer.concat(bufs);
     }
-    deserialize(buffer, fullyQualifiedFormat = true) {
-        let len = 0;
-        let cursor = buffer;
-        try {
-            if (buffer === undefined || buffer === null || !(buffer instanceof Buffer)) {
-                throw new Error('buffer is missing');
-            }
-            if (buffer.length < 1) {
-                throw new Error('buffer is empty');
-            }
-            if (fullyQualifiedFormat) {
-                const type_code = cursor.readUInt8();
-                len++;
-                if (type_code !== this.ioc.DataType.SHORT) {
-                    throw new Error('unexpected {type_code}');
-                }
-                cursor = cursor.slice(1);
-                if (cursor.length < 1) {
-                    throw new Error('{value_flag} is missing');
-                }
-                const value_flag = cursor.readUInt8();
-                len++;
-                if (value_flag === 1) {
-                    return { v: null, len };
-                }
-                if (value_flag !== 0) {
-                    throw new Error('unexpected {value_flag}');
-                }
-                cursor = cursor.slice(1);
-            }
-            if (cursor.length < 2) {
-                throw new Error('unexpected {value} length');
-            }
-            len += 2;
-            const v = cursor.readInt16BE();
-            return { v, len };
+    /**
+     * @param {StreamReader} reader
+     * @param {number} valueFlag
+     * @param {number} typeCode
+     * @returns {Promise<number>}
+     */
+    async deserializeValue(reader, valueFlag, typeCode) {
+        return await reader.readInt16BE();
+    }
+    /**
+     * @param {StreamReader} reader
+     * @returns {Promise<number|null>}
+     */
+    async deserialize(reader) {
+        const type_code = await reader.readUInt8();
+        if (type_code !== this.ioc.DataType.SHORT) {
+            throw new Error(`ShortSerializer: unexpected {type_code}=0x${type_code.toString(16)}`);
+        }
+        const value_flag = await reader.readUInt8();
+        if (value_flag === 0x01) {
+            return null;
         }
-        catch (err) {
-            throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
+        if (value_flag !== 0x00) {
+            throw new Error(`ShortSerializer: unexpected {value_flag}=0x${value_flag.toString(16)}`);
         }
+        return this.deserializeValue(reader, value_flag, type_code);
     }
 }

package/build/esm/structure/io/binary/internals/StreamReader.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Async byte reader that provides a uniform interface over both a complete Buffer
+ * (for non-streaming submit()) and a ReadableStream (for streaming HTTP responses).
+ *
+ * Handles chunk boundaries transparently and blocks (awaits) until the requested bytes are available.
+ */
+export default class StreamReader {
+    /**
+     * Create a StreamReader backed by a complete Buffer.
+     * All reads are satisfied from the buffer; no async I/O occurs.
+     * @param {Buffer} buffer
+     * @returns {StreamReader}
+     */
+    static fromBuffer(buffer: Buffer): StreamReader;
+    /**
+     * Create a StreamReader backed by a ReadableStream (e.g. fetch response.body).
+     * Reads pull chunks from the stream as needed.
+     * @param {ReadableStream} readableStream
+     * @returns {StreamReader}
+     */
+    static fromReadableStream(readableStream: ReadableStream): StreamReader;
+    /**
+     * @param {Buffer} initialBuffer
+     * @param {ReadableStreamDefaultReader|null} reader
+     */
+    constructor(initialBuffer: Buffer, reader: ReadableStreamDefaultReader | null);
+    /**
+     * Total number of bytes consumed so far (monotonically increasing).
+     * Useful for error diagnostics.
+     * @returns {number}
+     */
+    get position(): number;
+    /**
+     * Read exactly `n` bytes and return them as a Buffer.
+     * @param {number} n
+     * @returns {Promise<Buffer>}
+     */
+    readBytes(n: number): Promise<Buffer>;
+    /**
+     * @returns {Promise<number>} unsigned 8-bit integer
+     */
+    readUInt8(): Promise<number>;
+    /**
+     * @returns {Promise<number>} signed 8-bit integer
+     */
+    readByte(): Promise<number>;
+    /**
+     * @returns {Promise<number>} signed 16-bit big-endian integer
+     */
+    readInt16BE(): Promise<number>;
+    /**
+     * @returns {Promise<number>} signed 32-bit big-endian integer
+     */
+    readInt32BE(): Promise<number>;
+    /**
+     * @returns {Promise<bigint>} signed 64-bit big-endian integer
+     */
+    readBigInt64BE(): Promise<bigint>;
+    /**
+     * @returns {Promise<number>} 32-bit big-endian float
+     */
+    readFloatBE(): Promise<number>;
+    /**
+     * @returns {Promise<number>} 64-bit big-endian double
+     */
+    readDoubleBE(): Promise<number>;
+    #private;
+}
+import { Buffer } from 'buffer';

package/build/esm/structure/io/binary/internals/StreamReader.js

@@ -0,0 +1,181 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+import { Buffer } from 'buffer';
+/**
+ * Async byte reader that provides a uniform interface over both a complete Buffer
+ * (for non-streaming submit()) and a ReadableStream (for streaming HTTP responses).
+ *
+ * Handles chunk boundaries transparently and blocks (awaits) until the requested bytes are available.
+ */
+export default class StreamReader {
+    /** @type {Buffer} */
+    #buffer;
+    /** @type {number} */
+    #offset;
+    /** @type {ReadableStreamDefaultReader|null} */
+    #reader;
+    /** @type {number} Total bytes consumed (monotonically increasing, survives chunk reassembly) */
+    #position;
+    /**
+     * @param {Buffer} initialBuffer
+     * @param {ReadableStreamDefaultReader|null} reader
+     */
+    constructor(initialBuffer, reader) {
+        this.#buffer = initialBuffer;
+        this.#offset = 0;
+        this.#reader = reader;
+        this.#position = 0;
+    }
+    /**
+     * Create a StreamReader backed by a complete Buffer.
+     * All reads are satisfied from the buffer; no async I/O occurs.
+     * @param {Buffer} buffer
+     * @returns {StreamReader}
+     */
+    static fromBuffer(buffer) {
+        return new StreamReader(buffer, null);
+    }
+    /**
+     * Create a StreamReader backed by a ReadableStream (e.g. fetch response.body).
+     * Reads pull chunks from the stream as needed.
+     * @param {ReadableStream} readableStream
+     * @returns {StreamReader}
+     */
+    static fromReadableStream(readableStream) {
+        return new StreamReader(Buffer.alloc(0), readableStream.getReader());
+    }
+    /**
+     * Ensure at least `n` bytes are available in the buffer from the current offset.
+     * For buffer-backed readers this is a bounds check. For stream-backed readers
+     * this pulls chunks until enough data is buffered.
+     * @param {number} n
+     */
+    async #ensure(n) {
+        const available = this.#buffer.length - this.#offset;
+        if (available >= n) {
+            return;
+        }
+        if (this.#reader === null) {
+            throw new Error(`Unexpected end of buffer at position ${this.#position}: needed ${n} bytes, ${available} available`);
+        }
+        // Collect chunks until we have enough
+        const chunks = [this.#buffer.subarray(this.#offset)];
+        let total = available;
+        while (total < n) {
+            const { value, done } = await this.#reader.read();
+            if (done) {
+                break;
+            }
+            const chunk = Buffer.isBuffer(value) ? value : Buffer.from(value);
+            chunks.push(chunk);
+            total += chunk.length;
+        }
+        if (total < n) {
+            throw new Error(`Unexpected end of stream at position ${this.#position}: needed ${n} bytes, ${total} available`);
+        }
+        this.#buffer = Buffer.concat(chunks);
+        this.#offset = 0;
+    }
+    /**
+     * Total number of bytes consumed so far (monotonically increasing).
+     * Useful for error diagnostics.
+     * @returns {number}
+     */
+    get position() {
+        return this.#position;
+    }
+    /**
+     * Read exactly `n` bytes and return them as a Buffer.
+     * @param {number} n
+     * @returns {Promise<Buffer>}
+     */
+    async readBytes(n) {
+        await this.#ensure(n);
+        const result = this.#buffer.subarray(this.#offset, this.#offset + n);
+        this.#offset += n;
+        this.#position += n;
+        return result;
+    }
+    /**
+     * @returns {Promise<number>} unsigned 8-bit integer
+     */
+    async readUInt8() {
+        await this.#ensure(1);
+        this.#position++;
+        return this.#buffer[this.#offset++];
+    }
+    /**
+     * @returns {Promise<number>} signed 8-bit integer
+     */
+    async readByte() {
+        await this.#ensure(1);
+        this.#position++;
+        return this.#buffer.readInt8(this.#offset++);
+    }
+    /**
+     * @returns {Promise<number>} signed 16-bit big-endian integer
+     */
+    async readInt16BE() {
+        await this.#ensure(2);
+        const v = this.#buffer.readInt16BE(this.#offset);
+        this.#offset += 2;
+        this.#position += 2;
+        return v;
+    }
+    /**
+     * @returns {Promise<number>} signed 32-bit big-endian integer
+     */
+    async readInt32BE() {
+        await this.#ensure(4);
+        const v = this.#buffer.readInt32BE(this.#offset);
+        this.#offset += 4;
+        this.#position += 4;
+        return v;
+    }
+    /**
+     * @returns {Promise<bigint>} signed 64-bit big-endian integer
+     */
+    async readBigInt64BE() {
+        await this.#ensure(8);
+        const v = this.#buffer.readBigInt64BE(this.#offset);
+        this.#offset += 8;
+        this.#position += 8;
+        return v;
+    }
+    /**
+     * @returns {Promise<number>} 32-bit big-endian float
+     */
+    async readFloatBE() {
+        await this.#ensure(4);
+        const v = this.#buffer.readFloatBE(this.#offset);
+        this.#offset += 4;
+        this.#position += 4;
+        return v;
+    }
+    /**
+     * @returns {Promise<number>} 64-bit big-endian double
+     */
+    async readDoubleBE() {
+        await this.#ensure(8);
+        const v = this.#buffer.readDoubleBE(this.#offset);
+        this.#offset += 8;
+        this.#position += 8;
+        return v;
+    }
+}

package/build/esm/structure/io/binary/internals/StringSerializer.d.ts

@@ -4,8 +4,18 @@ export default class StringSerializer {
     ID: any;
     canBeUsedFor(value: any): value is string;
     serialize(item: any, fullyQualifiedFormat?: boolean): any;
-    deserialize(buffer: any, fullyQualifiedFormat?: boolean, nullable?: boolean, ...args: any[]): {
-        v: any;
-        len: number;
-    };
+    /**
+     * Read the string value bytes from the StreamReader (length + text_value).
+     * @param {StreamReader} reader
+     * @param {number} valueFlag
+     * @param {number} typeCode
+     * @returns {Promise<string>}
+     */
+    deserializeValue(reader: StreamReader, valueFlag: number, typeCode: number): Promise<string>;
+    /**
+     * Read a fully-qualified string from the StreamReader.
+     * @param {StreamReader} reader
+     * @returns {Promise<string|null>}
+     */
+    deserialize(reader: StreamReader): Promise<string | null>;
 }

package/build/esm/structure/io/binary/internals/StringSerializer.js

@@ -45,60 +45,41 @@ export default class StringSerializer {
         bufs.push(v);
         return Buffer.concat(bufs);
     }
-    deserialize(buffer, fullyQualifiedFormat = true, nullable = false) {
-        let len = 0;
-        let cursor = buffer;
-        try {
-            if (buffer === undefined || buffer === null || !(buffer instanceof Buffer)) {
-                throw new Error('buffer is missing');
-            }
-            if (buffer.length < 1) {
-                throw new Error('buffer is empty');
-            }
-            if (fullyQualifiedFormat) {
-                const type_code = cursor.readUInt8();
-                len++;
-                if (type_code !== this.ID) {
-                    throw new Error('unexpected {type_code}');
-                }
-                cursor = cursor.slice(1);
-            }
-            if (fullyQualifiedFormat || nullable) {
-                if (cursor.length < 1) {
-                    throw new Error('{value_flag} is missing');
-                }
-                const value_flag = cursor.readUInt8();
-                len++;
-                if (value_flag === 1) {
-                    return { v: null, len };
-                }
-                if (value_flag !== 0) {
-                    throw new Error('unexpected {value_flag}');
-                }
-                cursor = cursor.slice(1);
-            }
-            let length, length_len;
-            try {
-                ({ v: length, len: length_len } = this.ioc.intSerializer.deserialize(cursor, false));
-                len += length_len;
-            }
-            catch (err) {
-                err.message = '{length}: ' + err.message;
-                throw err;
-            }
-            if (length < 0) {
-                throw new Error('{length} is less than zero');
-            }
-            cursor = cursor.slice(length_len);
-            if (cursor.length < length) {
-                throw new Error('unexpected {text_value} length');
-            }
-            len += length;
-            const v = cursor.toString('utf8', 0, length);
-            return { v, len };
+    /**
+     * Read the string value bytes from the StreamReader (length + text_value).
+     * @param {StreamReader} reader
+     * @param {number} valueFlag
+     * @param {number} typeCode
+     * @returns {Promise<string>}
+     */
+    async deserializeValue(reader, valueFlag, typeCode) {
+        const length = await this.ioc.intSerializer.deserializeBare(reader);
+        if (length < 0) {
+            throw new Error(`StringSerializer: {length}=${length} is less than zero`);
+        }
+        if (length === 0) {
+            return '';
+        }
+        const bytes = await reader.readBytes(length);
+        return bytes.toString('utf8');
+    }
+    /**
+     * Read a fully-qualified string from the StreamReader.
+     * @param {StreamReader} reader
+     * @returns {Promise<string|null>}
+     */
+    async deserialize(reader) {
+        const type_code = await reader.readUInt8();
+        if (type_code !== this.ID) {
+            throw new Error(`StringSerializer: unexpected {type_code}=0x${type_code.toString(16)}`);
+        }
+        const value_flag = await reader.readUInt8();
+        if (value_flag === 0x01) {
+            return null;
         }
-        catch (err) {
-            throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });
+        if (value_flag !== 0x00) {
+            throw new Error(`StringSerializer: unexpected {value_flag}=0x${value_flag.toString(16)}`);
         }
+        return this.deserializeValue(reader, value_flag, type_code);
     }
 }

package/build/esm/structure/io/binary/internals/StubSerializer.d.ts

@@ -3,5 +3,5 @@ export default class StubSerializer {
     ioc: any;
     typeCode: any;
     typeName: any;
-    deserialize(): void;
+    deserializeValue(reader: any, valueFlag: any, typeCode: any): Promise<void>;
 }

package/build/esm/structure/io/binary/internals/StubSerializer.js

@@ -23,7 +23,8 @@ export default class StubSerializer {
         this.typeName = typeName;
         this.ioc.serializers[typeCode] = this;
     }
-    deserialize() {
+    // eslint-disable-next-line require-await
+    async deserializeValue(reader, valueFlag, typeCode) {
         throw new Error(`${this.typeName} deserialization is not yet implemented`);
     }
 }