@itwin/core-common 3.5.4 → 3.5.5

package/lib/cjs/BlobReader.d.ts

@@ -1,32 +1,32 @@
-/** @packageDocumentation
- * @module iModels
- */
-import { Id64String } from "@itwin/core-bentley";
-import { BlobOptions, BlobRange, DbBlobRequest, DbBlobResponse, DbRequestExecutor } from "./ConcurrentQuery";
-/** @beta */
-export declare class Uint8Chunks implements Iterable<Uint8Array> {
-    private _chunks;
-    append(chunk: Uint8Array): void;
-    at(idx: number): Uint8Array;
-    get length(): number;
-    [Symbol.iterator](): Iterator<Uint8Array, any, undefined>;
-    combine(): Uint8Array;
-}
-/** @beta */
-export declare class BlobReader {
-    private _executor;
-    readonly className: string;
-    readonly accessString: string;
-    readonly instanceId: Id64String;
-    private _chunks;
-    private _lengthToRead;
-    private _options;
-    constructor(_executor: DbRequestExecutor<DbBlobRequest, DbBlobResponse>, className: string, accessString: string, instanceId: Id64String, options?: BlobOptions);
-    reset(options?: BlobOptions): void;
-    get range(): BlobRange;
-    step(): Promise<boolean>;
-    readToEnd(): Promise<Uint8Array>;
-    get current(): Uint8Array;
-    get chunks(): Uint8Chunks;
-}
+/** @packageDocumentation
+ * @module iModels
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { BlobOptions, BlobRange, DbBlobRequest, DbBlobResponse, DbRequestExecutor } from "./ConcurrentQuery";
+/** @beta */
+export declare class Uint8Chunks implements Iterable<Uint8Array> {
+    private _chunks;
+    append(chunk: Uint8Array): void;
+    at(idx: number): Uint8Array;
+    get length(): number;
+    [Symbol.iterator](): Iterator<Uint8Array, any, undefined>;
+    combine(): Uint8Array;
+}
+/** @beta */
+export declare class BlobReader {
+    private _executor;
+    readonly className: string;
+    readonly accessString: string;
+    readonly instanceId: Id64String;
+    private _chunks;
+    private _lengthToRead;
+    private _options;
+    constructor(_executor: DbRequestExecutor<DbBlobRequest, DbBlobResponse>, className: string, accessString: string, instanceId: Id64String, options?: BlobOptions);
+    reset(options?: BlobOptions): void;
+    get range(): BlobRange;
+    step(): Promise<boolean>;
+    readToEnd(): Promise<Uint8Array>;
+    get current(): Uint8Array;
+    get chunks(): Uint8Chunks;
+}
 //# sourceMappingURL=BlobReader.d.ts.map

package/lib/cjs/BlobReader.js

@@ -1,85 +1,85 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BlobReader = exports.Uint8Chunks = void 0;
-const ConcurrentQuery_1 = require("./ConcurrentQuery");
-/** @beta */
-class Uint8Chunks {
-    constructor() {
-        this._chunks = [];
-    }
-    append(chunk) {
-        this._chunks.push(chunk);
-    }
-    at(idx) { return this._chunks[idx]; }
-    get length() { return this._chunks.length; }
-    [Symbol.iterator]() {
-        return this._chunks[Symbol.iterator];
-    }
-    combine() {
-        const totalChunkLength = this._chunks.reduce((acc, v) => acc + v.length, 0);
-        const combineChunk = new Uint8Array(totalChunkLength);
-        let offset = 0;
-        for (const array of this._chunks) {
-            combineChunk.set(array, offset);
-            offset += array.length;
-        }
-        return combineChunk;
-    }
-}
-exports.Uint8Chunks = Uint8Chunks;
-/** @beta */
-class BlobReader {
-    constructor(_executor, className, accessString, instanceId, options) {
-        this._executor = _executor;
-        this.className = className;
-        this.accessString = accessString;
-        this.instanceId = instanceId;
-        this._chunks = new Uint8Chunks();
-        this._lengthToRead = -1;
-        this._options = new ConcurrentQuery_1.BlobOptionsBuilder().getOptions();
-        this.reset(options);
-    }
-    reset(options) {
-        if (options) {
-            this._options = options;
-        }
-        this._chunks = new Uint8Chunks();
-        this._lengthToRead = this.range.count;
-    }
-    get range() { return this._options.range; }
-    async step() {
-        if (this._lengthToRead === this._chunks.length) {
-            return false;
-        }
-        const request = {
-            kind: ConcurrentQuery_1.DbRequestKind.BlobIO,
-            className: this.className,
-            accessString: this.accessString,
-            instanceId: this.instanceId,
-            ...this._options,
-        };
-        request.range = { offset: this._chunks.length, count: this.range ? this._lengthToRead - this._chunks.length : 0 };
-        const resp = await this._executor.execute(request);
-        ConcurrentQuery_1.DbQueryError.throwIfError(resp, request);
-        if (this._lengthToRead === -1) {
-            this._lengthToRead = resp.rawBlobSize;
-        }
-        if (resp.data && resp.data.length > 0) {
-            this._chunks.append(resp.data);
-        }
-        return true;
-    }
-    async readToEnd() {
-        while (await this.step()) { }
-        return this._chunks.combine();
-    }
-    get current() {
-        if (this._chunks.length === 0) {
-            throw new Error("there is no current buffer");
-        }
-        return this._chunks.at(this._chunks.length);
-    }
-    get chunks() { return this._chunks; }
-}
-exports.BlobReader = BlobReader;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlobReader = exports.Uint8Chunks = void 0;
+const ConcurrentQuery_1 = require("./ConcurrentQuery");
+/** @beta */
+class Uint8Chunks {
+    constructor() {
+        this._chunks = [];
+    }
+    append(chunk) {
+        this._chunks.push(chunk);
+    }
+    at(idx) { return this._chunks[idx]; }
+    get length() { return this._chunks.length; }
+    [Symbol.iterator]() {
+        return this._chunks[Symbol.iterator];
+    }
+    combine() {
+        const totalChunkLength = this._chunks.reduce((acc, v) => acc + v.length, 0);
+        const combineChunk = new Uint8Array(totalChunkLength);
+        let offset = 0;
+        for (const array of this._chunks) {
+            combineChunk.set(array, offset);
+            offset += array.length;
+        }
+        return combineChunk;
+    }
+}
+exports.Uint8Chunks = Uint8Chunks;
+/** @beta */
+class BlobReader {
+    constructor(_executor, className, accessString, instanceId, options) {
+        this._executor = _executor;
+        this.className = className;
+        this.accessString = accessString;
+        this.instanceId = instanceId;
+        this._chunks = new Uint8Chunks();
+        this._lengthToRead = -1;
+        this._options = new ConcurrentQuery_1.BlobOptionsBuilder().getOptions();
+        this.reset(options);
+    }
+    reset(options) {
+        if (options) {
+            this._options = options;
+        }
+        this._chunks = new Uint8Chunks();
+        this._lengthToRead = this.range.count;
+    }
+    get range() { return this._options.range; }
+    async step() {
+        if (this._lengthToRead === this._chunks.length) {
+            return false;
+        }
+        const request = {
+            kind: ConcurrentQuery_1.DbRequestKind.BlobIO,
+            className: this.className,
+            accessString: this.accessString,
+            instanceId: this.instanceId,
+            ...this._options,
+        };
+        request.range = { offset: this._chunks.length, count: this.range ? this._lengthToRead - this._chunks.length : 0 };
+        const resp = await this._executor.execute(request);
+        ConcurrentQuery_1.DbQueryError.throwIfError(resp, request);
+        if (this._lengthToRead === -1) {
+            this._lengthToRead = resp.rawBlobSize;
+        }
+        if (resp.data && resp.data.length > 0) {
+            this._chunks.append(resp.data);
+        }
+        return true;
+    }
+    async readToEnd() {
+        while (await this.step()) { }
+        return this._chunks.combine();
+    }
+    get current() {
+        if (this._chunks.length === 0) {
+            throw new Error("there is no current buffer");
+        }
+        return this._chunks.at(this._chunks.length);
+    }
+    get chunks() { return this._chunks; }
+}
+exports.BlobReader = BlobReader;
 //# sourceMappingURL=BlobReader.js.map

package/lib/cjs/BlobReader.js.map

@@ -1 +1 @@
-{"version":3,"file":"BlobReader.js","sourceRoot":"","sources":["../../src/BlobReader.ts"],"names":[],"mappings":";;;AAQA,uDAE2B;AAE3B,YAAY;AACZ,MAAa,WAAW;IAAxB;QACU,YAAO,GAAiB,EAAE,CAAC;IAmBrC,CAAC;IAlBQ,MAAM,CAAC,KAAiB;QAC7B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IACM,EAAE,CAAC,GAAW,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACpD,IAAW,MAAM,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAQ,IAAI,CAAC,OAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IACM,OAAO;QACZ,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5E,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACtD,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE;YAChC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;SACxB;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AApBD,kCAoBC;AACD,YAAY;AACZ,MAAa,UAAU;IAIrB,YAA2B,SAA2D,EACpE,SAAiB,EACjB,YAAoB,EACpB,UAAsB,EACtC,OAAqB;QAJI,cAAS,GAAT,SAAS,CAAkD;QACpE,cAAS,GAAT,SAAS,CAAQ;QACjB,iBAAY,GAAZ,YAAY,CAAQ;QACpB,eAAU,GAAV,UAAU,CAAY;QANhC,YAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QAC5B,kBAAa,GAAW,CAAC,CAAC,CAAC;QAC3B,aAAQ,GAAG,IAAI,oCAAkB,EAAE,CAAC,UAAU,EAAE,CAAC;QAMvD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IACM,KAAK,CAAC,OAAqB;QAChC,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;SACzB;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC;IACzC,CAAC;IACD,IAAW,KAAK,KAAgB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAM,CAAC,CAAC,CAAC;IACvD,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YAC9C,OAAO,KAAK,CAAC;SACd;QACD,MAAM,OAAO,GAAkB;YAC7B,IAAI,EAAE,+BAAa,CAAC,MAAM;YAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,GAAG,IAAI,CAAC,QAAQ;SACjB,CAAC;QACF,OAAO,CAAC,KAAK,GAAG,EAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC;QAChH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACnD,8BAAY,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEzC,IAAI,IAAI,CAAC,aAAa,KAAK,CAAC,CAAC,EAAE;YAC7B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC;SACvC;QACD,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACrC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAChC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,KAAK,CAAC,SAAS;QACpB,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAChC,CAAC;IACD,IAAW,OAAO;QAChB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IACD,IAAW,MAAM,KAAkB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;CAC1D;AArDD,gCAqDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\nimport { Id64String } from \"@itwin/core-bentley\";\nimport {\n  BlobOptions, BlobOptionsBuilder, BlobRange, DbBlobRequest, DbBlobResponse, DbQueryError, DbRequestExecutor, DbRequestKind,\n} from \"./ConcurrentQuery\";\n\n/** @beta */\nexport class Uint8Chunks implements Iterable<Uint8Array> {\n  private _chunks: Uint8Array[] = [];\n  public append(chunk: Uint8Array) {\n    this._chunks.push(chunk);\n  }\n  public at(idx: number) { return this._chunks[idx]; }\n  public get length() { return this._chunks.length; }\n  public [Symbol.iterator](): Iterator<Uint8Array, any, undefined> {\n    return (this._chunks as any)[Symbol.iterator];\n  }\n  public combine(): Uint8Array {\n    const totalChunkLength = this._chunks.reduce((acc, v) => acc + v.length, 0);\n    const combineChunk = new Uint8Array(totalChunkLength);\n    let offset = 0;\n    for (const array of this._chunks) {\n      combineChunk.set(array, offset);\n      offset += array.length;\n    }\n    return combineChunk;\n  }\n}\n/** @beta */\nexport class BlobReader {\n  private _chunks = new Uint8Chunks();\n  private _lengthToRead: number = -1;\n  private _options = new BlobOptionsBuilder().getOptions();\n  public constructor(private _executor: DbRequestExecutor<DbBlobRequest, DbBlobResponse>,\n    public readonly className: string,\n    public readonly accessString: string,\n    public readonly instanceId: Id64String,\n    options?: BlobOptions) {\n    this.reset(options);\n  }\n  public reset(options?: BlobOptions) {\n    if (options) {\n      this._options = options;\n    }\n    this._chunks = new Uint8Chunks();\n    this._lengthToRead = this.range.count!;\n  }\n  public get range(): BlobRange { return this._options.range!; }\n  public async step(): Promise<boolean> {\n    if (this._lengthToRead === this._chunks.length) {\n      return false;\n    }\n    const request: DbBlobRequest = {\n      kind: DbRequestKind.BlobIO,\n      className: this.className,\n      accessString: this.accessString,\n      instanceId: this.instanceId,\n      ...this._options,\n    };\n    request.range = {offset: this._chunks.length, count: this.range ? this._lengthToRead - this._chunks.length : 0};\n    const resp = await this._executor.execute(request);\n    DbQueryError.throwIfError(resp, request);\n\n    if (this._lengthToRead === -1) {\n      this._lengthToRead = resp.rawBlobSize;\n    }\n    if (resp.data && resp.data.length > 0) {\n      this._chunks.append(resp.data);\n    }\n    return true;\n  }\n  public async readToEnd(): Promise<Uint8Array> {\n    while (await this.step()) { }\n    return this._chunks.combine();\n  }\n  public get current(): Uint8Array {\n    if (this._chunks.length === 0) {\n      throw new Error(\"there is no current buffer\");\n    }\n    return this._chunks.at(this._chunks.length);\n  }\n  public get chunks(): Uint8Chunks { return this._chunks; }\n}\n"]}
+{"version":3,"file":"BlobReader.js","sourceRoot":"","sources":["../../src/BlobReader.ts"],"names":[],"mappings":";;;AAQA,uDAE2B;AAE3B,YAAY;AACZ,MAAa,WAAW;IAAxB;QACU,YAAO,GAAiB,EAAE,CAAC;IAmBrC,CAAC;IAlBQ,MAAM,CAAC,KAAiB;QAC7B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IACM,EAAE,CAAC,GAAW,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACpD,IAAW,MAAM,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAQ,IAAI,CAAC,OAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IACM,OAAO;QACZ,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5E,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACtD,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE;YAChC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;SACxB;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AApBD,kCAoBC;AACD,YAAY;AACZ,MAAa,UAAU;IAIrB,YAA2B,SAA2D,EACpE,SAAiB,EACjB,YAAoB,EACpB,UAAsB,EACtC,OAAqB;QAJI,cAAS,GAAT,SAAS,CAAkD;QACpE,cAAS,GAAT,SAAS,CAAQ;QACjB,iBAAY,GAAZ,YAAY,CAAQ;QACpB,eAAU,GAAV,UAAU,CAAY;QANhC,YAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QAC5B,kBAAa,GAAW,CAAC,CAAC,CAAC;QAC3B,aAAQ,GAAG,IAAI,oCAAkB,EAAE,CAAC,UAAU,EAAE,CAAC;QAMvD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IACM,KAAK,CAAC,OAAqB;QAChC,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;SACzB;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC;IACzC,CAAC;IACD,IAAW,KAAK,KAAgB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAM,CAAC,CAAC,CAAC;IACvD,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YAC9C,OAAO,KAAK,CAAC;SACd;QACD,MAAM,OAAO,GAAkB;YAC7B,IAAI,EAAE,+BAAa,CAAC,MAAM;YAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,GAAG,IAAI,CAAC,QAAQ;SACjB,CAAC;QACF,OAAO,CAAC,KAAK,GAAG,EAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC;QAChH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACnD,8BAAY,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEzC,IAAI,IAAI,CAAC,aAAa,KAAK,CAAC,CAAC,EAAE;YAC7B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC;SACvC;QACD,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACrC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAChC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,KAAK,CAAC,SAAS;QACpB,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAChC,CAAC;IACD,IAAW,OAAO;QAChB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IACD,IAAW,MAAM,KAAkB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;CAC1D;AArDD,gCAqDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport {\r\n  BlobOptions, BlobOptionsBuilder, BlobRange, DbBlobRequest, DbBlobResponse, DbQueryError, DbRequestExecutor, DbRequestKind,\r\n} from \"./ConcurrentQuery\";\r\n\r\n/** @beta */\r\nexport class Uint8Chunks implements Iterable<Uint8Array> {\r\n  private _chunks: Uint8Array[] = [];\r\n  public append(chunk: Uint8Array) {\r\n    this._chunks.push(chunk);\r\n  }\r\n  public at(idx: number) { return this._chunks[idx]; }\r\n  public get length() { return this._chunks.length; }\r\n  public [Symbol.iterator](): Iterator<Uint8Array, any, undefined> {\r\n    return (this._chunks as any)[Symbol.iterator];\r\n  }\r\n  public combine(): Uint8Array {\r\n    const totalChunkLength = this._chunks.reduce((acc, v) => acc + v.length, 0);\r\n    const combineChunk = new Uint8Array(totalChunkLength);\r\n    let offset = 0;\r\n    for (const array of this._chunks) {\r\n      combineChunk.set(array, offset);\r\n      offset += array.length;\r\n    }\r\n    return combineChunk;\r\n  }\r\n}\r\n/** @beta */\r\nexport class BlobReader {\r\n  private _chunks = new Uint8Chunks();\r\n  private _lengthToRead: number = -1;\r\n  private _options = new BlobOptionsBuilder().getOptions();\r\n  public constructor(private _executor: DbRequestExecutor<DbBlobRequest, DbBlobResponse>,\r\n    public readonly className: string,\r\n    public readonly accessString: string,\r\n    public readonly instanceId: Id64String,\r\n    options?: BlobOptions) {\r\n    this.reset(options);\r\n  }\r\n  public reset(options?: BlobOptions) {\r\n    if (options) {\r\n      this._options = options;\r\n    }\r\n    this._chunks = new Uint8Chunks();\r\n    this._lengthToRead = this.range.count!;\r\n  }\r\n  public get range(): BlobRange { return this._options.range!; }\r\n  public async step(): Promise<boolean> {\r\n    if (this._lengthToRead === this._chunks.length) {\r\n      return false;\r\n    }\r\n    const request: DbBlobRequest = {\r\n      kind: DbRequestKind.BlobIO,\r\n      className: this.className,\r\n      accessString: this.accessString,\r\n      instanceId: this.instanceId,\r\n      ...this._options,\r\n    };\r\n    request.range = {offset: this._chunks.length, count: this.range ? this._lengthToRead - this._chunks.length : 0};\r\n    const resp = await this._executor.execute(request);\r\n    DbQueryError.throwIfError(resp, request);\r\n\r\n    if (this._lengthToRead === -1) {\r\n      this._lengthToRead = resp.rawBlobSize;\r\n    }\r\n    if (resp.data && resp.data.length > 0) {\r\n      this._chunks.append(resp.data);\r\n    }\r\n    return true;\r\n  }\r\n  public async readToEnd(): Promise<Uint8Array> {\r\n    while (await this.step()) { }\r\n    return this._chunks.combine();\r\n  }\r\n  public get current(): Uint8Array {\r\n    if (this._chunks.length === 0) {\r\n      throw new Error(\"there is no current buffer\");\r\n    }\r\n    return this._chunks.at(this._chunks.length);\r\n  }\r\n  public get chunks(): Uint8Chunks { return this._chunks; }\r\n}\r\n"]}

package/lib/cjs/BriefcaseTypes.d.ts

@@ -1,190 +1,190 @@
-/** @packageDocumentation
- * @module iModels
- */
-import { GuidString } from "@itwin/core-bentley";
-import { ChangesetIdWithIndex, LocalFileName } from "./ChangesetProps";
-import { IModelEncryptionProps, OpenDbKey } from "./IModel";
-import { IModelVersionProps } from "./IModelVersion";
-/** The Id assigned to a briefcase by iModelHub, or [[BriefcaseIdValue.Unassigned]] .
- * @public
- * @extensions
- */
-export declare type BriefcaseId = number;
-/** Values of [[BriefcaseId]] that have special meaning.
- * @public
- * @extensions
- */
-export declare enum BriefcaseIdValue {
-    /** Indicates an invalid/illegal BriefcaseId */
-    Illegal = 4294967295,
-    /** BriefcaseIds must be less than this value */
-    Max = 16777216,
-    /** All valid iModelHub issued BriefcaseIds will be equal or higher than this */
-    FirstValid = 2,
-    /** All valid iModelHub issued BriefcaseIds will be equal or lower than this */
-    LastValid = 16777205,
-    /**
-     * The briefcase has not been assigned a unique Id by iModelHub. Only briefcases that have been assigned a unique BriefcaseId may create changesets,
-     * because BriefcaseId is used to create unique ElementIds for new elements.
-     *
-     * The `Unassigned` briefcaseId is used for several purposes:
-     *  - **Snapshots**. Snapshot files are immutable copies of an iModel for archival or data exchange purposes. They can neither generate nor accept new changesets.
-     *  - **Checkpoints**. Checkpoints are Snapshots that represent a specific version on an iModel's timeline.
-     *  - **PullOnly**. A local briefcase file that may be used to "slide" along a timeline by applying incoming changesets.
-     * They are always opened readonly except to apply changesets.
-     *  - **Standalone**. Standalone iModels are local files that are not connected to iModelHub, and therefore cannot accept or create changesets.
-     */
-    Unassigned = 0
-}
-/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub
- * @public
- * @extensions
- */
-export declare enum SyncMode {
-    /** Use a fixed version (i.e. a checkpoint). See [CheckpointManager]($backend) for preferred approach to using checkpoint files. */
-    FixedVersion = 1,
-    /** A briefcase that can be edited. A unique briefcaseId must be assigned by iModelHub. */
-    PullAndPush = 2,
-    /** use [BriefcaseIdValue.Unassigned](%backend). This makes a briefcase that can accept changesets from iModelHub but can never create changesets. */
-    PullOnly = 3
-}
-/**
- * Options to open a previously downloaded briefcase
- * @public
- */
-export interface OpenBriefcaseOptions {
-    /** open briefcase Readonly */
-    readonly openAsReadOnly?: boolean;
-}
-/**
- * Properties that specify a briefcase within the local briefcase cache.
- * @see BriefcaseManager.getFileName
- * @public
- */
-export interface BriefcaseProps {
-    /** Id of the iModel */
-    readonly iModelId: GuidString;
-    /** BriefcaseId of the briefcase */
-    readonly briefcaseId: BriefcaseId;
-}
-/** Properties for opening a local briefcase file via [BriefcaseDb.open]($backend)
- * @public
- */
-export interface OpenBriefcaseProps extends IModelEncryptionProps, OpenDbKey {
-    /** the full path to the briefcase file  */
-    readonly fileName: LocalFileName;
-    /** If true, open the briefcase readonly */
-    readonly readonly?: boolean;
-}
-/** Properties of a local briefcase file, returned by [BriefcaseManager.getCachedBriefcases]($backend) and [BriefcaseManager.downloadBriefcase]($backend)
- * @public
- * @extensions
- */
-export interface LocalBriefcaseProps {
-    /** Full path of local file. */
-    readonly fileName: LocalFileName;
-    /** The iTwin containing the iModel. */
-    readonly iTwinId: GuidString;
-    /** The iModelId. */
-    readonly iModelId: GuidString;
-    /** The briefcaseId. */
-    readonly briefcaseId: BriefcaseId;
-    /** The current changesetId.
-     * @note ChangeSet Ids are string hash values based on the ChangeSet's content and parent.
-     */
-    readonly changeset: ChangesetIdWithIndex;
-    /** Size of the briefcase file in bytes  */
-    readonly fileSize: number;
-}
-/** Properties for downloading a briefcase to a local file, from iModelHub.
- * @public
- * @extensions
- */
-export interface RequestNewBriefcaseProps {
-    /** iTwin that the iModel belongs to. */
-    readonly iTwinId: GuidString;
-    /** The iModelId for the new briefcase. */
-    readonly iModelId: GuidString;
-    /** Full path of local file to store the briefcase. If undefined, a file will be created in the briefcase cache, and this member will be filled with the full path to the file.
-     * Callers can use this to open the briefcase after the download completes.
-     * @note this member is both an input and an output.
-     */
-    readonly fileName?: LocalFileName;
-    /**
-     * The BriefcaseId for the new briefcase. If undefined, a new BriefcaseId will be acquired from iModelHub before the download, and is returned in this member.
-     * @note To download a briefcase that can accept but not create new changesets (sometimes referred to as "pull only" briefcases), set this value to [[BriefcaseIdValue.Unassigned]].
-     * After downloading, you can merely delete unassigned briefcase files when they are no longer needed. Assigned BriefcaseIds should be released (via [BriefcaseManager.releaseBriefcase]($backend) )
-     * when you are done with them.
-     * @note this member is both an input and an output.
-     *
-     */
-    briefcaseId?: BriefcaseId;
-    /** Id of the change set of the new briefcase. If undefined, use latest. */
-    asOf?: IModelVersionProps;
-}
-/**
- * Manages the download of a briefcase
- * @public
- */
-export interface BriefcaseDownloader {
-    /** Id of the briefcase being downloaded */
-    readonly briefcaseId: BriefcaseId;
-    /** the name of the local file for the briefcase */
-    readonly fileName: LocalFileName;
-    /** Promise that resolves when the download completes. await this to complete the download */
-    readonly downloadPromise: Promise<void>;
-    /** Request cancellation of the download */
-    readonly requestCancel: () => Promise<boolean>;
-}
-/** Option to control the validation and upgrade of domain schemas in the Db
- * @beta
- */
-export declare enum DomainOptions {
-    /** Domain schemas will be validated for any required upgrades. Any errors will be reported back, and cause the application to fail opening the Db */
-    CheckRequiredUpgrades = 0,
-    /** Domain schemas will be validated for any required or optional upgrades. Any errors will be reported back, and cause the application to fail opening the Db */
-    CheckRecommendedUpgrades = 1,
-    /** Domain schemas will be upgraded if necessary. However, only compatible schema upgrades will be allowed - these are typically additions of classes, properties, and changes to custom attributes */
-    Upgrade = 2,
-    /** Domain schemas will neither be validated nor be upgraded. Used only internally */
-    SkipCheck = 3
-}
-/** Options that control whether a profile upgrade should be performed when opening a Db
- * @beta
- */
-export declare enum ProfileOptions {
-    /** No profile upgrade will be performed. If a profile upgrade was required, opening the file will fail */
-    None = 0,
-    /** Profile upgrade will be performed if necessary */
-    Upgrade = 1
-}
-/** Arguments to validate and update the profile and domain schemas when opening a Db
- * @beta
- */
-export interface UpgradeOptions {
-    /** Option to control the validation and upgrade of domain schemas in the Db */
-    readonly domain?: DomainOptions;
-    /** Options that control whether a profile upgrade should be performed when opening a file */
-    readonly profile?: ProfileOptions;
-}
-/**
- * The state of the schemas in the Db compared with what the current version of the software expects
- * Note: The state may vary depending on whether the Db is to be opened ReadOnly or ReadWrite.
- * @beta
- */
-export declare enum SchemaState {
-    /** The schemas in the Db are up-to-date, and do not need to be upgraded before opening it with the current version of the software */
-    UpToDate = 0,
-    /** It's required that the schemas in the Db be upgraded before it can be opened with the current version of the software.
-     * This may happen in read-write scenarios where the application requires a newer version of the schemas to be in place before
-     * it can write data based on that new schema.
-     */
-    UpgradeRequired = 1,
-    /** It's recommended, but not necessary that the schemas in the Db be upgraded before opening it with the current version of the software */
-    UpgradeRecommended = 2,
-    /** The schemas in the Db are too old to be opened by the current version of the software. Upgrade using the API is not possible. */
-    TooOld = 3,
-    /** The schemas in the Db are too new to be opened by the current version of the software */
-    TooNew = 4
-}
+/** @packageDocumentation
+ * @module iModels
+ */
+import { GuidString } from "@itwin/core-bentley";
+import { ChangesetIdWithIndex, LocalFileName } from "./ChangesetProps";
+import { IModelEncryptionProps, OpenDbKey } from "./IModel";
+import { IModelVersionProps } from "./IModelVersion";
+/** The Id assigned to a briefcase by iModelHub, or [[BriefcaseIdValue.Unassigned]] .
+ * @public
+ * @extensions
+ */
+export declare type BriefcaseId = number;
+/** Values of [[BriefcaseId]] that have special meaning.
+ * @public
+ * @extensions
+ */
+export declare enum BriefcaseIdValue {
+    /** Indicates an invalid/illegal BriefcaseId */
+    Illegal = 4294967295,
+    /** BriefcaseIds must be less than this value */
+    Max = 16777216,
+    /** All valid iModelHub issued BriefcaseIds will be equal or higher than this */
+    FirstValid = 2,
+    /** All valid iModelHub issued BriefcaseIds will be equal or lower than this */
+    LastValid = 16777205,
+    /**
+     * The briefcase has not been assigned a unique Id by iModelHub. Only briefcases that have been assigned a unique BriefcaseId may create changesets,
+     * because BriefcaseId is used to create unique ElementIds for new elements.
+     *
+     * The `Unassigned` briefcaseId is used for several purposes:
+     *  - **Snapshots**. Snapshot files are immutable copies of an iModel for archival or data exchange purposes. They can neither generate nor accept new changesets.
+     *  - **Checkpoints**. Checkpoints are Snapshots that represent a specific version on an iModel's timeline.
+     *  - **PullOnly**. A local briefcase file that may be used to "slide" along a timeline by applying incoming changesets.
+     * They are always opened readonly except to apply changesets.
+     *  - **Standalone**. Standalone iModels are local files that are not connected to iModelHub, and therefore cannot accept or create changesets.
+     */
+    Unassigned = 0
+}
+/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub
+ * @public
+ * @extensions
+ */
+export declare enum SyncMode {
+    /** Use a fixed version (i.e. a checkpoint). See [CheckpointManager]($backend) for preferred approach to using checkpoint files. */
+    FixedVersion = 1,
+    /** A briefcase that can be edited. A unique briefcaseId must be assigned by iModelHub. */
+    PullAndPush = 2,
+    /** use [BriefcaseIdValue.Unassigned](%backend). This makes a briefcase that can accept changesets from iModelHub but can never create changesets. */
+    PullOnly = 3
+}
+/**
+ * Options to open a previously downloaded briefcase
+ * @public
+ */
+export interface OpenBriefcaseOptions {
+    /** open briefcase Readonly */
+    readonly openAsReadOnly?: boolean;
+}
+/**
+ * Properties that specify a briefcase within the local briefcase cache.
+ * @see BriefcaseManager.getFileName
+ * @public
+ */
+export interface BriefcaseProps {
+    /** Id of the iModel */
+    readonly iModelId: GuidString;
+    /** BriefcaseId of the briefcase */
+    readonly briefcaseId: BriefcaseId;
+}
+/** Properties for opening a local briefcase file via [BriefcaseDb.open]($backend)
+ * @public
+ */
+export interface OpenBriefcaseProps extends IModelEncryptionProps, OpenDbKey {
+    /** the full path to the briefcase file  */
+    readonly fileName: LocalFileName;
+    /** If true, open the briefcase readonly */
+    readonly readonly?: boolean;
+}
+/** Properties of a local briefcase file, returned by [BriefcaseManager.getCachedBriefcases]($backend) and [BriefcaseManager.downloadBriefcase]($backend)
+ * @public
+ * @extensions
+ */
+export interface LocalBriefcaseProps {
+    /** Full path of local file. */
+    readonly fileName: LocalFileName;
+    /** The iTwin containing the iModel. */
+    readonly iTwinId: GuidString;
+    /** The iModelId. */
+    readonly iModelId: GuidString;
+    /** The briefcaseId. */
+    readonly briefcaseId: BriefcaseId;
+    /** The current changesetId.
+     * @note ChangeSet Ids are string hash values based on the ChangeSet's content and parent.
+     */
+    readonly changeset: ChangesetIdWithIndex;
+    /** Size of the briefcase file in bytes  */
+    readonly fileSize: number;
+}
+/** Properties for downloading a briefcase to a local file, from iModelHub.
+ * @public
+ * @extensions
+ */
+export interface RequestNewBriefcaseProps {
+    /** iTwin that the iModel belongs to. */
+    readonly iTwinId: GuidString;
+    /** The iModelId for the new briefcase. */
+    readonly iModelId: GuidString;
+    /** Full path of local file to store the briefcase. If undefined, a file will be created in the briefcase cache, and this member will be filled with the full path to the file.
+     * Callers can use this to open the briefcase after the download completes.
+     * @note this member is both an input and an output.
+     */
+    readonly fileName?: LocalFileName;
+    /**
+     * The BriefcaseId for the new briefcase. If undefined, a new BriefcaseId will be acquired from iModelHub before the download, and is returned in this member.
+     * @note To download a briefcase that can accept but not create new changesets (sometimes referred to as "pull only" briefcases), set this value to [[BriefcaseIdValue.Unassigned]].
+     * After downloading, you can merely delete unassigned briefcase files when they are no longer needed. Assigned BriefcaseIds should be released (via [BriefcaseManager.releaseBriefcase]($backend) )
+     * when you are done with them.
+     * @note this member is both an input and an output.
+     *
+     */
+    briefcaseId?: BriefcaseId;
+    /** Id of the change set of the new briefcase. If undefined, use latest. */
+    asOf?: IModelVersionProps;
+}
+/**
+ * Manages the download of a briefcase
+ * @public
+ */
+export interface BriefcaseDownloader {
+    /** Id of the briefcase being downloaded */
+    readonly briefcaseId: BriefcaseId;
+    /** the name of the local file for the briefcase */
+    readonly fileName: LocalFileName;
+    /** Promise that resolves when the download completes. await this to complete the download */
+    readonly downloadPromise: Promise<void>;
+    /** Request cancellation of the download */
+    readonly requestCancel: () => Promise<boolean>;
+}
+/** Option to control the validation and upgrade of domain schemas in the Db
+ * @beta
+ */
+export declare enum DomainOptions {
+    /** Domain schemas will be validated for any required upgrades. Any errors will be reported back, and cause the application to fail opening the Db */
+    CheckRequiredUpgrades = 0,
+    /** Domain schemas will be validated for any required or optional upgrades. Any errors will be reported back, and cause the application to fail opening the Db */
+    CheckRecommendedUpgrades = 1,
+    /** Domain schemas will be upgraded if necessary. However, only compatible schema upgrades will be allowed - these are typically additions of classes, properties, and changes to custom attributes */
+    Upgrade = 2,
+    /** Domain schemas will neither be validated nor be upgraded. Used only internally */
+    SkipCheck = 3
+}
+/** Options that control whether a profile upgrade should be performed when opening a Db
+ * @beta
+ */
+export declare enum ProfileOptions {
+    /** No profile upgrade will be performed. If a profile upgrade was required, opening the file will fail */
+    None = 0,
+    /** Profile upgrade will be performed if necessary */
+    Upgrade = 1
+}
+/** Arguments to validate and update the profile and domain schemas when opening a Db
+ * @beta
+ */
+export interface UpgradeOptions {
+    /** Option to control the validation and upgrade of domain schemas in the Db */
+    readonly domain?: DomainOptions;
+    /** Options that control whether a profile upgrade should be performed when opening a file */
+    readonly profile?: ProfileOptions;
+}
+/**
+ * The state of the schemas in the Db compared with what the current version of the software expects
+ * Note: The state may vary depending on whether the Db is to be opened ReadOnly or ReadWrite.
+ * @beta
+ */
+export declare enum SchemaState {
+    /** The schemas in the Db are up-to-date, and do not need to be upgraded before opening it with the current version of the software */
+    UpToDate = 0,
+    /** It's required that the schemas in the Db be upgraded before it can be opened with the current version of the software.
+     * This may happen in read-write scenarios where the application requires a newer version of the schemas to be in place before
+     * it can write data based on that new schema.
+     */
+    UpgradeRequired = 1,
+    /** It's recommended, but not necessary that the schemas in the Db be upgraded before opening it with the current version of the software */
+    UpgradeRecommended = 2,
+    /** The schemas in the Db are too old to be opened by the current version of the software. Upgrade using the API is not possible. */
+    TooOld = 3,
+    /** The schemas in the Db are too new to be opened by the current version of the software */
+    TooNew = 4
+}
 //# sourceMappingURL=BriefcaseTypes.d.ts.map