@itwin/ecschema-rpcinterface-common 5.1.0-dev.59 → 5.1.0-dev.60

package/lib/cjs/RpcIncrementalSchemaLocater.d.ts

@@ -0,0 +1,27 @@
+import { type IModelRpcProps } from "@itwin/core-common";
+import { ECSqlQueryOptions, ECSqlSchemaLocater, ECSqlSchemaLocaterOptions, SchemaKey, SchemaProps } from "@itwin/ecschema-metadata";
+/**
+ * A [[ECSqlSchemaLocater]]($ecschema-metadata) implementation that uses the ECSchema RPC interfaces to load schemas incrementally.
+ * @beta
+ */
+export declare class RpcIncrementalSchemaLocater extends ECSqlSchemaLocater {
+    private readonly _iModelProps;
+    /**
+     * Initializes a new instance of the RpcIncrementalSchemaLocater class.
+     */
+    constructor(iModelProps: IModelRpcProps, options?: ECSqlSchemaLocaterOptions);
+    /**
+     * Executes the given ECSql query and returns the resulting rows.
+     * @param query The ECSql query to execute.
+     * @param options Optional arguments to control the query result.
+     * @returns A promise that resolves to the resulting rows.
+     */
+    protected executeQuery<TRow>(query: string, options?: ECSqlQueryOptions): Promise<ReadonlyArray<TRow>>;
+    /**
+     * Gets the [[SchemaProps]]($ecschema-metadata) for the given [[SchemaKey]]($ecschema-metadata).
+     * This is the full schema json with all elements that are defined in the schema.
+     * @param schemaKey The schema key of the schema to be resolved.
+     */
+    protected getSchemaProps(schemaKey: SchemaKey): Promise<SchemaProps | undefined>;
+}
+//# sourceMappingURL=RpcIncrementalSchemaLocater.d.ts.map

package/lib/cjs/RpcIncrementalSchemaLocater.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RpcIncrementalSchemaLocater.d.ts","sourceRoot":"","sources":["../../src/RpcIncrementalSchemaLocater.ts"],"names":[],"mappings":"AAIA,OAAO,EAA2F,KAAK,cAAc,EAA6C,MAAM,oBAAoB,CAAC;AAC7L,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAGpI;;;GAGG;AACH,qBAAa,2BAA4B,SAAQ,kBAAkB;IACjE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAiB;IAE9C;;OAEG;gBACS,WAAW,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,yBAAyB;IAK5E;;;;;OAKG;cACsB,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAiBrH;;;;OAIG;cACa,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;CAIvF"}

package/lib/cjs/RpcIncrementalSchemaLocater.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RpcIncrementalSchemaLocater = void 0;
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+const core_common_1 = require("@itwin/core-common");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const ECSchemaRpcInterface_1 = require("./ECSchemaRpcInterface");
+/**
+ * A [[ECSqlSchemaLocater]]($ecschema-metadata) implementation that uses the ECSchema RPC interfaces to load schemas incrementally.
+ * @beta
+ */
+class RpcIncrementalSchemaLocater extends ecschema_metadata_1.ECSqlSchemaLocater {
+    _iModelProps;
+    /**
+     * Initializes a new instance of the RpcIncrementalSchemaLocater class.
+     */
+    constructor(iModelProps, options) {
+        super(options);
+        this._iModelProps = iModelProps;
+    }
+    /**
+     * Executes the given ECSql query and returns the resulting rows.
+     * @param query The ECSql query to execute.
+     * @param options Optional arguments to control the query result.
+     * @returns A promise that resolves to the resulting rows.
+     */
+    async executeQuery(query, options) {
+        const ecSqlQueryClient = core_common_1.IModelReadRpcInterface.getClient();
+        const queryExecutor = {
+            execute: async (request) => ecSqlQueryClient.queryRows(this._iModelProps, request),
+        };
+        const queryOptions = {
+            limit: { count: options?.limit },
+            rowFormat: core_common_1.QueryRowFormat.UseECSqlPropertyNames,
+        };
+        const queryParameters = options && options.parameters ? core_common_1.QueryBinder.from(options.parameters) : undefined;
+        const queryReader = new core_common_1.ECSqlReader(queryExecutor, query, queryParameters, queryOptions);
+        return queryReader.toArray();
+    }
+    /**
+     * Gets the [[SchemaProps]]($ecschema-metadata) for the given [[SchemaKey]]($ecschema-metadata).
+     * This is the full schema json with all elements that are defined in the schema.
+     * @param schemaKey The schema key of the schema to be resolved.
+     */
+    async getSchemaProps(schemaKey) {
+        const rpcSchemaClient = ECSchemaRpcInterface_1.ECSchemaRpcInterface.getClient();
+        return rpcSchemaClient.getSchemaJSON(this._iModelProps, schemaKey.name);
+    }
+    ;
+}
+exports.RpcIncrementalSchemaLocater = RpcIncrementalSchemaLocater;
+//# sourceMappingURL=RpcIncrementalSchemaLocater.js.map

package/lib/cjs/RpcIncrementalSchemaLocater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RpcIncrementalSchemaLocater.js","sourceRoot":"","sources":["../../src/RpcIncrementalSchemaLocater.ts"],"names":[],"mappings":";;;AAAA;;;gGAGgG;AAChG,oDAA6L;AAC7L,gEAAoI;AACpI,iEAA8D;AAE9D;;;GAGG;AACH,MAAa,2BAA4B,SAAQ,sCAAkB;IAChD,YAAY,CAAiB;IAE9C;;OAEG;IACH,YAAY,WAA2B,EAAE,OAAmC;QAC1E,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACgB,KAAK,CAAC,YAAY,CAAO,KAAa,EAAE,OAA2B;QACpF,MAAM,gBAAgB,GAAG,oCAAsB,CAAC,SAAS,EAAE,CAAC;QAC5D,MAAM,aAAa,GAAuD;YACxE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC;SACnF,CAAC;QAEF,MAAM,YAAY,GAAiB;YACjC,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE;YAChC,SAAS,EAAE,4BAAc,CAAC,qBAAqB;SAChD,CAAC;QAEF,MAAM,eAAe,GAAG,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,yBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzG,MAAM,WAAW,GAAG,IAAI,yBAAW,CAAC,aAAa,EAAE,KAAK,EAAE,eAAe,EAAE,YAAY,CAAC,CAAC;QAEzF,OAAO,WAAW,CAAC,OAAO,EAAE,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,cAAc,CAAC,SAAoB;QACjD,MAAM,eAAe,GAAG,2CAAoB,CAAC,SAAS,EAAE,CAAC;QACzD,OAAO,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IAC1E,CAAC;IAAA,CAAC;CACH;AA3CD,kEA2CC","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 *--------------------------------------------------------------------------------------------*/\nimport { DbQueryRequest, DbQueryResponse, DbRequestExecutor, ECSqlReader, IModelReadRpcInterface, type IModelRpcProps, QueryBinder, QueryOptions, QueryRowFormat } from \"@itwin/core-common\";\nimport { ECSqlQueryOptions, ECSqlSchemaLocater, ECSqlSchemaLocaterOptions, SchemaKey, SchemaProps } from \"@itwin/ecschema-metadata\";\nimport { ECSchemaRpcInterface } from \"./ECSchemaRpcInterface\";\n\n/**\n * A [[ECSqlSchemaLocater]]($ecschema-metadata) implementation that uses the ECSchema RPC interfaces to load schemas incrementally.\n * @beta\n */\nexport class RpcIncrementalSchemaLocater extends ECSqlSchemaLocater {\n  private readonly _iModelProps: IModelRpcProps;\n\n  /**\n   * Initializes a new instance of the RpcIncrementalSchemaLocater class.\n   */\n  constructor(iModelProps: IModelRpcProps, options?: ECSqlSchemaLocaterOptions) {\n    super(options);\n    this._iModelProps = iModelProps;\n  }\n\n  /**\n   * Executes the given ECSql query and returns the resulting rows.\n   * @param query The ECSql query to execute.\n   * @param options Optional arguments to control the query result.\n   * @returns A promise that resolves to the resulting rows.\n   */\n  protected override async executeQuery<TRow>(query: string, options?: ECSqlQueryOptions): Promise<ReadonlyArray<TRow>> {\n    const ecSqlQueryClient = IModelReadRpcInterface.getClient();\n    const queryExecutor: DbRequestExecutor<DbQueryRequest, DbQueryResponse> = {\n      execute: async (request) => ecSqlQueryClient.queryRows(this._iModelProps, request),\n    };\n\n    const queryOptions: QueryOptions = {\n      limit: { count: options?.limit },\n      rowFormat: QueryRowFormat.UseECSqlPropertyNames,\n    };\n\n    const queryParameters = options && options.parameters ? QueryBinder.from(options.parameters) : undefined;\n    const queryReader = new ECSqlReader(queryExecutor, query, queryParameters, queryOptions);\n\n    return queryReader.toArray();\n  }\n\n  /**\n   * Gets the [[SchemaProps]]($ecschema-metadata) for the given [[SchemaKey]]($ecschema-metadata).\n   * This is the full schema json with all elements that are defined in the schema.\n   * @param schemaKey The schema key of the schema to be resolved.\n   */\n  protected async getSchemaProps(schemaKey: SchemaKey): Promise<SchemaProps | undefined> {\n    const rpcSchemaClient = ECSchemaRpcInterface.getClient();\n    return rpcSchemaClient.getSchemaJSON(this._iModelProps, schemaKey.name);\n  };\n}\n"]}

package/lib/cjs/ecschema-rpc-interface.d.ts

@@ -1,3 +1,4 @@
 export * from "./ECSchemaRpcInterface";
 export * from "./ECSchemaRpcLocater";
+export * from "./RpcIncrementalSchemaLocater";
 //# sourceMappingURL=ecschema-rpc-interface.d.ts.map

package/lib/cjs/ecschema-rpc-interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ecschema-rpc-interface.d.ts","sourceRoot":"","sources":["../../src/ecschema-rpc-interface.ts"],"names":[],"mappings":"AAIA,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"ecschema-rpc-interface.d.ts","sourceRoot":"","sources":["../../src/ecschema-rpc-interface.ts"],"names":[],"mappings":"AAIA,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC"}

package/lib/cjs/ecschema-rpc-interface.js

@@ -20,4 +20,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 *--------------------------------------------------------------------------------------------*/
 __exportStar(require("./ECSchemaRpcInterface"), exports);
 __exportStar(require("./ECSchemaRpcLocater"), exports);
+__exportStar(require("./RpcIncrementalSchemaLocater"), exports);
 //# sourceMappingURL=ecschema-rpc-interface.js.map

package/lib/cjs/ecschema-rpc-interface.js.map

@@ -1 +1 @@
-{"version":3,"file":"ecschema-rpc-interface.js","sourceRoot":"","sources":["../../src/ecschema-rpc-interface.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;+FAG+F;AAC/F,yDAAuC;AACvC,uDAAqC","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*--------------------------------------------------------------------------------------------*/\nexport * from \"./ECSchemaRpcInterface\";\nexport * from \"./ECSchemaRpcLocater\";\n"]}
+{"version":3,"file":"ecschema-rpc-interface.js","sourceRoot":"","sources":["../../src/ecschema-rpc-interface.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;+FAG+F;AAC/F,yDAAuC;AACvC,uDAAqC;AACrC,gEAA8C","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*--------------------------------------------------------------------------------------------*/\nexport * from \"./ECSchemaRpcInterface\";\nexport * from \"./ECSchemaRpcLocater\";\nexport * from \"./RpcIncrementalSchemaLocater\";"]}

package/lib/cjs/test/RpcIncrementalSchemaLocater.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=RpcIncrementalSchemaLocater.test.d.ts.map

package/lib/cjs/test/RpcIncrementalSchemaLocater.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RpcIncrementalSchemaLocater.test.d.ts","sourceRoot":"","sources":["../../../src/test/RpcIncrementalSchemaLocater.test.ts"],"names":[],"mappings":""}

package/lib/cjs/test/RpcIncrementalSchemaLocater.test.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const RpcIncrementalSchemaLocater_1 = require("../RpcIncrementalSchemaLocater");
+const core_common_1 = require("@itwin/core-common");
+const ECSchemaRpcInterface_1 = require("../ECSchemaRpcInterface");
+const chai_1 = require("chai");
+const sinon = require("sinon");
+// RpcIncrementalSchemaLocater derives from IncrementalSchemaLocater and ECSqlSchemaLocater, so
+// the basic functionality is already tested in their tests. This test suite verifies the expected
+// behaviour of the RPC specific implementation.
+describe("RpcIncrementalSchemaLocater Tests", () => {
+    let imodelReadInterface;
+    let ecschemaRpcInterface;
+    const schemaInfoColumns = ["name", "version", "references", "alias"];
+    beforeEach(() => {
+        sinon.stub(core_common_1.IModelReadRpcInterface, "getClient").returns(imodelReadInterface = {
+            queryRows: async () => { throw new Error("Method must be implemented in the tests."); },
+        });
+        sinon.stub(ECSchemaRpcInterface_1.ECSchemaRpcInterface, "getClient").returns(ecschemaRpcInterface = {
+            getSchemaJSON: async () => { throw new Error("Method must be implemented in the tests."); },
+        });
+    });
+    afterEach(() => {
+        sinon.restore();
+    });
+    it("get schema info, schema found", async () => {
+        const schemaKey = ecschema_metadata_1.SchemaKey.parseString("TestSchema.1.0.0");
+        sinon.stub(imodelReadInterface, "queryRows").returns(toQueryResult(schemaInfoColumns, [
+            { name: schemaKey.name, version: schemaKey.version.toString(), references: "[]", alias: "ts" }
+        ]));
+        const locater = new RpcIncrementalSchemaLocater_1.RpcIncrementalSchemaLocater({ key: "rpc-test-imodel" });
+        const schemaInfo = await locater.getSchemaInfo(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest, new ecschema_metadata_1.SchemaContext());
+        (0, chai_1.expect)(schemaInfo).is.not.undefined;
+        (0, chai_1.expect)(schemaInfo).has.property("schemaKey").that.satisfies((key) => key.matches(schemaKey));
+        (0, chai_1.expect)(schemaInfo).has.property("alias").that.equals("ts");
+        (0, chai_1.expect)(schemaInfo).has.property("references").that.is.empty;
+    });
+    it("get schema info, schema not found, return undefined", async () => {
+        sinon.stub(imodelReadInterface, "queryRows").returns(toQueryResult(schemaInfoColumns, []));
+        const schemaKey = ecschema_metadata_1.SchemaKey.parseString("TestSchema.1.0.0");
+        const locater = new RpcIncrementalSchemaLocater_1.RpcIncrementalSchemaLocater({ key: "rpc-test-imodel" });
+        const schemaInfo = await locater.getSchemaInfo(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest, new ecschema_metadata_1.SchemaContext());
+        (0, chai_1.expect)(schemaInfo).to.be.undefined;
+    });
+    it("get schema, incrementally", async () => {
+        const context = new ecschema_metadata_1.SchemaContext();
+        const locater = new RpcIncrementalSchemaLocater_1.RpcIncrementalSchemaLocater({ key: "rpc-test-imodel" });
+        context.addLocater(locater);
+        const schemaKey = ecschema_metadata_1.SchemaKey.parseString("TestSchema.1.0.0");
+        sinon.stub(imodelReadInterface, "queryRows")
+            .onCall(0).returns(toQueryResult(schemaInfoColumns, [
+            { name: schemaKey.name, version: schemaKey.version.toString(), references: "[]", alias: "ts" },
+            { name: "ECDbMeta", version: "4.0.3", references: "[]", alias: "ecdb" },
+        ]))
+            .onCall(1).returns(toQueryResult(["name", "version", "alias", "references", "items"], [
+            {
+                name: schemaKey.name,
+                version: schemaKey.version.toString(),
+                alias: "ts",
+                references: "[]",
+                items: "[]",
+            }
+        ]))
+            .returns(toQueryResult(["schema", "items"], [
+            {
+                schema: `{
+            "name": "${schemaKey.name}",
+            "version": "${schemaKey.version.toString()}",
+            "alias": "ts",
+            "label": "Test Schema",
+            "description": "This is a test schema."
+          }`,
+            }
+        ]));
+        const schema = await context.getSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest);
+        (0, chai_1.expect)(schema).is.not.undefined;
+        (0, chai_1.expect)(schema).has.property("schemaKey").that.satisfies((key) => key.matches(schemaKey));
+        (0, chai_1.expect)(schema).has.property("alias").that.equals("ts");
+        (0, chai_1.expect)(schema).has.property("loadingController").that.is.not.undefined;
+        (0, chai_1.expect)(schema).has.a.nested.property("loadingController.inProgress").that.is.true;
+        await schema.loadingController?.wait();
+        (0, chai_1.expect)(schema).has.property("label", "Test Schema");
+        (0, chai_1.expect)(schema).has.property("description", "This is a test schema.");
+    });
+    it("get schema, unsupported metaschema", async () => {
+        const schemaKey = ecschema_metadata_1.SchemaKey.parseString("TestSchema.1.0.0");
+        sinon.stub(imodelReadInterface, "queryRows").returns(toQueryResult(schemaInfoColumns, [
+            { name: schemaKey.name, version: schemaKey.version.toString(), references: "[]", alias: "ts" },
+            { name: "ECDbMeta", version: "4.0.1", references: "[]", alias: "ecdb" },
+        ]));
+        sinon.stub(ecschemaRpcInterface, "getSchemaJSON").returns(Promise.resolve({
+            $schema: ecschema_metadata_1.ECSchemaNamespaceUris.SCHEMAURL3_2_JSON,
+            name: schemaKey.name,
+            version: schemaKey.version.toString(),
+            alias: "ts"
+        }));
+        const locater = new RpcIncrementalSchemaLocater_1.RpcIncrementalSchemaLocater({ key: "rpc-test-imodel" });
+        const schema = await locater.getSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest, new ecschema_metadata_1.SchemaContext());
+        (0, chai_1.expect)(schema).is.not.undefined;
+        (0, chai_1.expect)(schema).has.property("schemaKey").that.satisfies((key) => key.matches(schemaKey));
+        (0, chai_1.expect)(schema).has.property("alias").that.equals("ts");
+    });
+    it("get schema, schema not found, return undefined", async () => {
+        const schemaKey = ecschema_metadata_1.SchemaKey.parseString("TestSchema.1.0.0");
+        sinon.stub(imodelReadInterface, "queryRows").returns(toQueryResult(schemaInfoColumns, []));
+        const locater = new RpcIncrementalSchemaLocater_1.RpcIncrementalSchemaLocater({ key: "rpc-test-imodel" });
+        const schema = await locater.getSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest, new ecschema_metadata_1.SchemaContext());
+        (0, chai_1.expect)(schema).is.undefined;
+    });
+});
+/**
+ * This is a very simple helper function to translate a set of rows into a DbQueryResponse.
+ * It does not handle different row formats or property order.
+ */
+async function toQueryResult(columns, rows) {
+    return {
+        kind: core_common_1.DbResponseKind.ECSql,
+        status: core_common_1.DbResponseStatus.Done,
+        stats: {},
+        rowCount: rows.length,
+        meta: columns.map((column, i) => ({ name: column, jsonName: column, index: i })),
+        data: rows.map(row => columns.map(k => row[k])),
+    };
+}
+//# sourceMappingURL=RpcIncrementalSchemaLocater.test.js.map

package/lib/cjs/test/RpcIncrementalSchemaLocater.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RpcIncrementalSchemaLocater.test.js","sourceRoot":"","sources":["../../../src/test/RpcIncrementalSchemaLocater.test.ts"],"names":[],"mappings":";;AACA;;;+FAG+F;AAC/F,gEAA4G;AAC5G,gFAA6E;AAC7E,oDAA+G;AAC/G,kEAA+D;AAC/D,+BAA8B;AAC9B,+BAA+B;AAE/B,+FAA+F;AAC/F,kGAAkG;AAClG,gDAAgD;AAChD,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;IAEjD,IAAI,mBAA2C,CAAC;IAChD,IAAI,oBAA0C,CAAC;IAE/C,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAErE,UAAU,CAAC,GAAG,EAAE;QACd,KAAK,CAAC,IAAI,CAAC,oCAAsB,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,mBAAmB,GAAG;YAC5E,SAAS,EAAE,KAAK,IAAI,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC;SACjF,CAAC,CAAC;QACV,KAAK,CAAC,IAAI,CAAC,2CAAoB,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,oBAAoB,GAAG;YAC3E,aAAa,EAAE,KAAK,IAAI,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC;SACrF,CAAC,CAAC;IACZ,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;QAC7C,MAAM,SAAS,GAAG,6BAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;QAC5D,KAAK,CAAC,IAAI,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAE;YACpF,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;SAC/F,CAAC,CAAC,CAAC;QAEJ,MAAM,OAAO,GAAG,IAAI,yDAA2B,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC5E,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,mCAAe,CAAC,MAAM,EAAE,IAAI,iCAAa,EAAE,CAAC,CAAC;QAEvG,IAAA,aAAM,EAAC,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QACpC,IAAA,aAAM,EAAC,UAAU,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAc,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;QACxG,IAAA,aAAM,EAAC,UAAU,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3D,IAAA,aAAM,EAAC,UAAU,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,KAAK,CAAC,IAAI,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,CAAC;QAE3F,MAAM,SAAS,GAAG,6BAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;QAC5D,MAAM,OAAO,GAAG,IAAI,yDAA2B,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC5E,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,mCAAe,CAAC,MAAM,EAAE,IAAI,iCAAa,EAAE,CAAC,CAAC;QAEvG,IAAA,aAAM,EAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,OAAO,GAAG,IAAI,iCAAa,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,yDAA2B,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC5E,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,SAAS,GAAG,6BAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;QAC5D,KAAK,CAAC,IAAI,CAAC,mBAAmB,EAAE,WAAW,CAAC;aACzC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAE;YAClD,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;YAC9F,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE;SACxE,CAAC,CAAC;aACF,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE;YACpF;gBACE,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACrC,KAAK,EAAE,IAAI;gBACX,UAAU,EAAE,IAAI;gBAChB,KAAK,EAAE,IAAI;aACZ;SACF,CAAC,CAAC;aACF,OAAO,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE;YAC1C;gBACE,MAAM,EAAE;uBACK,SAAS,CAAC,IAAI;0BACX,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE;;;;YAI1C;aACH;SACF,CAAC,CAAC,CAAC;QAEN,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC;QAE1E,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAChC,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAc,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;QACpG,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEvD,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QACvE,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,8BAA8B,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC;QAClF,MAAM,MAAO,CAAC,iBAAiB,EAAE,IAAI,EAAE,CAAC;QAExC,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QACpD,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,aAAa,EAAE,wBAAwB,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,SAAS,GAAG,6BAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;QAC5D,KAAK,CAAC,IAAI,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAE;YACpF,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;YAC9F,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE;SACxE,CAAC,CAAC,CAAC;QAEJ,KAAK,CAAC,IAAI,CAAC,oBAAoB,EAAE,eAAe,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;YACxE,OAAO,EAAE,yCAAqB,CAAC,iBAAiB;YAChD,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE;YACrC,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC,CAAC;QAEJ,MAAM,OAAO,GAAG,IAAI,yDAA2B,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC5E,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,mCAAe,CAAC,MAAM,EAAE,IAAI,iCAAa,EAAE,CAAC,CAAC;QAE/F,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAChC,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAc,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;QACpG,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,SAAS,GAAG,6BAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;QAC5D,KAAK,CAAC,IAAI,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,CAAC;QAE3F,MAAM,OAAO,GAAG,IAAI,yDAA2B,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC5E,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,mCAAe,CAAC,MAAM,EAAE,IAAI,iCAAa,EAAE,CAAC,CAAC;QAE/F,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC;IAC9B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACH,KAAK,UAAU,aAAa,CAAC,OAAsB,EAAE,IAAsC;IACzF,OAAO;QACL,IAAI,EAAE,4BAAc,CAAC,KAAK;QAC1B,MAAM,EAAE,8BAAgB,CAAC,IAAI;QAC7B,KAAK,EAAE,EAAS;QAChB,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAU,CAAA,CAAC;QACvF,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KAChD,CAAC;AACJ,CAAC","sourcesContent":["\n/*---------------------------------------------------------------------------------------------\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*--------------------------------------------------------------------------------------------*/\nimport { ECSchemaNamespaceUris, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\nimport { RpcIncrementalSchemaLocater } from \"../RpcIncrementalSchemaLocater\";\nimport { DbQueryResponse, DbResponseKind, DbResponseStatus, IModelReadRpcInterface } from \"@itwin/core-common\";\nimport { ECSchemaRpcInterface } from \"../ECSchemaRpcInterface\";\nimport { expect } from \"chai\";\nimport * as sinon from \"sinon\";\n\n// RpcIncrementalSchemaLocater derives from IncrementalSchemaLocater and ECSqlSchemaLocater, so\n// the basic functionality is already tested in their tests. This test suite verifies the expected\n// behaviour of the RPC specific implementation.\ndescribe(\"RpcIncrementalSchemaLocater Tests\", () => {\n\n  let imodelReadInterface: IModelReadRpcInterface;\n  let ecschemaRpcInterface: ECSchemaRpcInterface;\n\n  const schemaInfoColumns = [\"name\", \"version\", \"references\", \"alias\"];\n\n  beforeEach(() => {\n    sinon.stub(IModelReadRpcInterface, \"getClient\").returns(imodelReadInterface = {\n      queryRows: async () => { throw new Error(\"Method must be implemented in the tests.\"); },\n    } as any);\n    sinon.stub(ECSchemaRpcInterface, \"getClient\").returns(ecschemaRpcInterface = {\n      getSchemaJSON: async () => { throw new Error(\"Method must be implemented in the tests.\"); },\n    } as any);\n  });\n\n  afterEach(() => {\n    sinon.restore();\n  });\n\n  it(\"get schema info, schema found\", async () => {\n    const schemaKey = SchemaKey.parseString(\"TestSchema.1.0.0\");\n    sinon.stub(imodelReadInterface, \"queryRows\").returns(toQueryResult(schemaInfoColumns, [\n      { name: schemaKey.name, version: schemaKey.version.toString(), references: \"[]\", alias: \"ts\" }\n    ]));\n\n    const locater = new RpcIncrementalSchemaLocater({ key: \"rpc-test-imodel\" });\n    const schemaInfo = await locater.getSchemaInfo(schemaKey, SchemaMatchType.Latest, new SchemaContext());\n\n    expect(schemaInfo).is.not.undefined;\n    expect(schemaInfo).has.property(\"schemaKey\").that.satisfies((key: SchemaKey) => key.matches(schemaKey));\n    expect(schemaInfo).has.property(\"alias\").that.equals(\"ts\");\n    expect(schemaInfo).has.property(\"references\").that.is.empty;\n  });\n\n  it(\"get schema info, schema not found, return undefined\", async () => {\n    sinon.stub(imodelReadInterface, \"queryRows\").returns(toQueryResult(schemaInfoColumns, []));\n\n    const schemaKey = SchemaKey.parseString(\"TestSchema.1.0.0\");\n    const locater = new RpcIncrementalSchemaLocater({ key: \"rpc-test-imodel\" });\n    const schemaInfo = await locater.getSchemaInfo(schemaKey, SchemaMatchType.Latest, new SchemaContext());\n\n    expect(schemaInfo).to.be.undefined;\n  });\n\n  it(\"get schema, incrementally\", async () => {\n    const context = new SchemaContext();\n    const locater = new RpcIncrementalSchemaLocater({ key: \"rpc-test-imodel\" });\n    context.addLocater(locater);\n\n    const schemaKey = SchemaKey.parseString(\"TestSchema.1.0.0\");\n    sinon.stub(imodelReadInterface, \"queryRows\")\n      .onCall(0).returns(toQueryResult(schemaInfoColumns, [\n        { name: schemaKey.name, version: schemaKey.version.toString(), references: \"[]\", alias: \"ts\" },\n        { name: \"ECDbMeta\", version: \"4.0.3\", references: \"[]\", alias: \"ecdb\" },\n      ]))\n      .onCall(1).returns(toQueryResult([\"name\", \"version\", \"alias\", \"references\", \"items\"], [\n        {\n          name: schemaKey.name,\n          version: schemaKey.version.toString(),\n          alias: \"ts\",\n          references: \"[]\",\n          items: \"[]\",\n        }\n      ]))\n      .returns(toQueryResult([\"schema\", \"items\"], [\n        {\n          schema: `{\n            \"name\": \"${schemaKey.name}\",\n            \"version\": \"${schemaKey.version.toString()}\",\n            \"alias\": \"ts\",\n            \"label\": \"Test Schema\",\n            \"description\": \"This is a test schema.\"\n          }`,\n        }\n      ]));\n\n    const schema = await context.getSchema(schemaKey, SchemaMatchType.Latest);\n\n    expect(schema).is.not.undefined;\n    expect(schema).has.property(\"schemaKey\").that.satisfies((key: SchemaKey) => key.matches(schemaKey));\n    expect(schema).has.property(\"alias\").that.equals(\"ts\");\n\n    expect(schema).has.property(\"loadingController\").that.is.not.undefined;\n    expect(schema).has.a.nested.property(\"loadingController.inProgress\").that.is.true;\n    await schema!.loadingController?.wait();\n\n    expect(schema).has.property(\"label\", \"Test Schema\");\n    expect(schema).has.property(\"description\", \"This is a test schema.\");\n  });\n\n  it(\"get schema, unsupported metaschema\", async () => {\n    const schemaKey = SchemaKey.parseString(\"TestSchema.1.0.0\");\n    sinon.stub(imodelReadInterface, \"queryRows\").returns(toQueryResult(schemaInfoColumns, [\n      { name: schemaKey.name, version: schemaKey.version.toString(), references: \"[]\", alias: \"ts\" },\n      { name: \"ECDbMeta\", version: \"4.0.1\", references: \"[]\", alias: \"ecdb\" },\n    ]));\n\n    sinon.stub(ecschemaRpcInterface, \"getSchemaJSON\").returns(Promise.resolve({\n      $schema: ECSchemaNamespaceUris.SCHEMAURL3_2_JSON,\n      name: schemaKey.name,\n      version: schemaKey.version.toString(),\n      alias: \"ts\"\n    }));\n\n    const locater = new RpcIncrementalSchemaLocater({ key: \"rpc-test-imodel\" });\n    const schema = await locater.getSchema(schemaKey, SchemaMatchType.Latest, new SchemaContext());\n\n    expect(schema).is.not.undefined;\n    expect(schema).has.property(\"schemaKey\").that.satisfies((key: SchemaKey) => key.matches(schemaKey));\n    expect(schema).has.property(\"alias\").that.equals(\"ts\");\n  });\n\n  it(\"get schema, schema not found, return undefined\", async () => {\n    const schemaKey = SchemaKey.parseString(\"TestSchema.1.0.0\");\n    sinon.stub(imodelReadInterface, \"queryRows\").returns(toQueryResult(schemaInfoColumns, []));\n\n    const locater = new RpcIncrementalSchemaLocater({ key: \"rpc-test-imodel\" });\n    const schema = await locater.getSchema(schemaKey, SchemaMatchType.Latest, new SchemaContext());\n\n    expect(schema).is.undefined;\n  });\n});\n\n/**\n * This is a very simple helper function to translate a set of rows into a DbQueryResponse.\n * It does not handle different row formats or property order.\n */\nasync function toQueryResult(columns: Array<string>, rows: Array<{ [column: string]: any }>): Promise<DbQueryResponse> {\n  return {\n    kind: DbResponseKind.ECSql,\n    status: DbResponseStatus.Done,\n    stats: {} as any,\n    rowCount: rows.length,\n    meta: columns.map((column, i) => ({ name: column, jsonName: column, index: i } as any)),\n    data: rows.map(row => columns.map(k => row[k])),\n  };\n}"]}

package/lib/esm/RpcIncrementalSchemaLocater.d.ts

@@ -0,0 +1,27 @@
+import { type IModelRpcProps } from "@itwin/core-common";
+import { ECSqlQueryOptions, ECSqlSchemaLocater, ECSqlSchemaLocaterOptions, SchemaKey, SchemaProps } from "@itwin/ecschema-metadata";
+/**
+ * A [[ECSqlSchemaLocater]]($ecschema-metadata) implementation that uses the ECSchema RPC interfaces to load schemas incrementally.
+ * @beta
+ */
+export declare class RpcIncrementalSchemaLocater extends ECSqlSchemaLocater {
+    private readonly _iModelProps;
+    /**
+     * Initializes a new instance of the RpcIncrementalSchemaLocater class.
+     */
+    constructor(iModelProps: IModelRpcProps, options?: ECSqlSchemaLocaterOptions);
+    /**
+     * Executes the given ECSql query and returns the resulting rows.
+     * @param query The ECSql query to execute.
+     * @param options Optional arguments to control the query result.
+     * @returns A promise that resolves to the resulting rows.
+     */
+    protected executeQuery<TRow>(query: string, options?: ECSqlQueryOptions): Promise<ReadonlyArray<TRow>>;
+    /**
+     * Gets the [[SchemaProps]]($ecschema-metadata) for the given [[SchemaKey]]($ecschema-metadata).
+     * This is the full schema json with all elements that are defined in the schema.
+     * @param schemaKey The schema key of the schema to be resolved.
+     */
+    protected getSchemaProps(schemaKey: SchemaKey): Promise<SchemaProps | undefined>;
+}
+//# sourceMappingURL=RpcIncrementalSchemaLocater.d.ts.map

package/lib/esm/RpcIncrementalSchemaLocater.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RpcIncrementalSchemaLocater.d.ts","sourceRoot":"","sources":["../../src/RpcIncrementalSchemaLocater.ts"],"names":[],"mappings":"AAIA,OAAO,EAA2F,KAAK,cAAc,EAA6C,MAAM,oBAAoB,CAAC;AAC7L,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAGpI;;;GAGG;AACH,qBAAa,2BAA4B,SAAQ,kBAAkB;IACjE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAiB;IAE9C;;OAEG;gBACS,WAAW,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,yBAAyB;IAK5E;;;;;OAKG;cACsB,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAiBrH;;;;OAIG;cACa,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;CAIvF"}

package/lib/esm/RpcIncrementalSchemaLocater.js

@@ -0,0 +1,51 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { ECSqlReader, IModelReadRpcInterface, QueryBinder, QueryRowFormat } from "@itwin/core-common";
+import { ECSqlSchemaLocater } from "@itwin/ecschema-metadata";
+import { ECSchemaRpcInterface } from "./ECSchemaRpcInterface";
+/**
+ * A [[ECSqlSchemaLocater]]($ecschema-metadata) implementation that uses the ECSchema RPC interfaces to load schemas incrementally.
+ * @beta
+ */
+export class RpcIncrementalSchemaLocater extends ECSqlSchemaLocater {
+    _iModelProps;
+    /**
+     * Initializes a new instance of the RpcIncrementalSchemaLocater class.
+     */
+    constructor(iModelProps, options) {
+        super(options);
+        this._iModelProps = iModelProps;
+    }
+    /**
+     * Executes the given ECSql query and returns the resulting rows.
+     * @param query The ECSql query to execute.
+     * @param options Optional arguments to control the query result.
+     * @returns A promise that resolves to the resulting rows.
+     */
+    async executeQuery(query, options) {
+        const ecSqlQueryClient = IModelReadRpcInterface.getClient();
+        const queryExecutor = {
+            execute: async (request) => ecSqlQueryClient.queryRows(this._iModelProps, request),
+        };
+        const queryOptions = {
+            limit: { count: options?.limit },
+            rowFormat: QueryRowFormat.UseECSqlPropertyNames,
+        };
+        const queryParameters = options && options.parameters ? QueryBinder.from(options.parameters) : undefined;
+        const queryReader = new ECSqlReader(queryExecutor, query, queryParameters, queryOptions);
+        return queryReader.toArray();
+    }
+    /**
+     * Gets the [[SchemaProps]]($ecschema-metadata) for the given [[SchemaKey]]($ecschema-metadata).
+     * This is the full schema json with all elements that are defined in the schema.
+     * @param schemaKey The schema key of the schema to be resolved.
+     */
+    async getSchemaProps(schemaKey) {
+        const rpcSchemaClient = ECSchemaRpcInterface.getClient();
+        return rpcSchemaClient.getSchemaJSON(this._iModelProps, schemaKey.name);
+    }
+    ;
+}
+//# sourceMappingURL=RpcIncrementalSchemaLocater.js.map

package/lib/esm/RpcIncrementalSchemaLocater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RpcIncrementalSchemaLocater.js","sourceRoot":"","sources":["../../src/RpcIncrementalSchemaLocater.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG,OAAO,EAAsD,WAAW,EAAE,sBAAsB,EAAuB,WAAW,EAAgB,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC7L,OAAO,EAAqB,kBAAkB,EAAqD,MAAM,0BAA0B,CAAC;AACpI,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;;GAGG;AACH,MAAM,OAAO,2BAA4B,SAAQ,kBAAkB;IAChD,YAAY,CAAiB;IAE9C;;OAEG;IACH,YAAY,WAA2B,EAAE,OAAmC;QAC1E,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACgB,KAAK,CAAC,YAAY,CAAO,KAAa,EAAE,OAA2B;QACpF,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,SAAS,EAAE,CAAC;QAC5D,MAAM,aAAa,GAAuD;YACxE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC;SACnF,CAAC;QAEF,MAAM,YAAY,GAAiB;YACjC,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE;YAChC,SAAS,EAAE,cAAc,CAAC,qBAAqB;SAChD,CAAC;QAEF,MAAM,eAAe,GAAG,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzG,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,aAAa,EAAE,KAAK,EAAE,eAAe,EAAE,YAAY,CAAC,CAAC;QAEzF,OAAO,WAAW,CAAC,OAAO,EAAE,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,cAAc,CAAC,SAAoB;QACjD,MAAM,eAAe,GAAG,oBAAoB,CAAC,SAAS,EAAE,CAAC;QACzD,OAAO,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IAC1E,CAAC;IAAA,CAAC;CACH","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 *--------------------------------------------------------------------------------------------*/\nimport { DbQueryRequest, DbQueryResponse, DbRequestExecutor, ECSqlReader, IModelReadRpcInterface, type IModelRpcProps, QueryBinder, QueryOptions, QueryRowFormat } from \"@itwin/core-common\";\nimport { ECSqlQueryOptions, ECSqlSchemaLocater, ECSqlSchemaLocaterOptions, SchemaKey, SchemaProps } from \"@itwin/ecschema-metadata\";\nimport { ECSchemaRpcInterface } from \"./ECSchemaRpcInterface\";\n\n/**\n * A [[ECSqlSchemaLocater]]($ecschema-metadata) implementation that uses the ECSchema RPC interfaces to load schemas incrementally.\n * @beta\n */\nexport class RpcIncrementalSchemaLocater extends ECSqlSchemaLocater {\n  private readonly _iModelProps: IModelRpcProps;\n\n  /**\n   * Initializes a new instance of the RpcIncrementalSchemaLocater class.\n   */\n  constructor(iModelProps: IModelRpcProps, options?: ECSqlSchemaLocaterOptions) {\n    super(options);\n    this._iModelProps = iModelProps;\n  }\n\n  /**\n   * Executes the given ECSql query and returns the resulting rows.\n   * @param query The ECSql query to execute.\n   * @param options Optional arguments to control the query result.\n   * @returns A promise that resolves to the resulting rows.\n   */\n  protected override async executeQuery<TRow>(query: string, options?: ECSqlQueryOptions): Promise<ReadonlyArray<TRow>> {\n    const ecSqlQueryClient = IModelReadRpcInterface.getClient();\n    const queryExecutor: DbRequestExecutor<DbQueryRequest, DbQueryResponse> = {\n      execute: async (request) => ecSqlQueryClient.queryRows(this._iModelProps, request),\n    };\n\n    const queryOptions: QueryOptions = {\n      limit: { count: options?.limit },\n      rowFormat: QueryRowFormat.UseECSqlPropertyNames,\n    };\n\n    const queryParameters = options && options.parameters ? QueryBinder.from(options.parameters) : undefined;\n    const queryReader = new ECSqlReader(queryExecutor, query, queryParameters, queryOptions);\n\n    return queryReader.toArray();\n  }\n\n  /**\n   * Gets the [[SchemaProps]]($ecschema-metadata) for the given [[SchemaKey]]($ecschema-metadata).\n   * This is the full schema json with all elements that are defined in the schema.\n   * @param schemaKey The schema key of the schema to be resolved.\n   */\n  protected async getSchemaProps(schemaKey: SchemaKey): Promise<SchemaProps | undefined> {\n    const rpcSchemaClient = ECSchemaRpcInterface.getClient();\n    return rpcSchemaClient.getSchemaJSON(this._iModelProps, schemaKey.name);\n  };\n}\n"]}

package/lib/esm/ecschema-rpc-interface.d.ts

@@ -1,3 +1,4 @@
 export * from "./ECSchemaRpcInterface";
 export * from "./ECSchemaRpcLocater";
+export * from "./RpcIncrementalSchemaLocater";
 //# sourceMappingURL=ecschema-rpc-interface.d.ts.map

package/lib/esm/ecschema-rpc-interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ecschema-rpc-interface.d.ts","sourceRoot":"","sources":["../../src/ecschema-rpc-interface.ts"],"names":[],"mappings":"AAIA,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"ecschema-rpc-interface.d.ts","sourceRoot":"","sources":["../../src/ecschema-rpc-interface.ts"],"names":[],"mappings":"AAIA,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC"}

package/lib/esm/ecschema-rpc-interface.js

@@ -4,4 +4,5 @@
 *--------------------------------------------------------------------------------------------*/
 export * from "./ECSchemaRpcInterface";
 export * from "./ECSchemaRpcLocater";
+export * from "./RpcIncrementalSchemaLocater";
 //# sourceMappingURL=ecschema-rpc-interface.js.map

package/lib/esm/ecschema-rpc-interface.js.map

@@ -1 +1 @@
-{"version":3,"file":"ecschema-rpc-interface.js","sourceRoot":"","sources":["../../src/ecschema-rpc-interface.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC","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*--------------------------------------------------------------------------------------------*/\nexport * from \"./ECSchemaRpcInterface\";\nexport * from \"./ECSchemaRpcLocater\";\n"]}
+{"version":3,"file":"ecschema-rpc-interface.js","sourceRoot":"","sources":["../../src/ecschema-rpc-interface.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC","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*--------------------------------------------------------------------------------------------*/\nexport * from \"./ECSchemaRpcInterface\";\nexport * from \"./ECSchemaRpcLocater\";\nexport * from \"./RpcIncrementalSchemaLocater\";"]}

package/lib/esm/test/RpcIncrementalSchemaLocater.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=RpcIncrementalSchemaLocater.test.d.ts.map

package/lib/esm/test/RpcIncrementalSchemaLocater.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RpcIncrementalSchemaLocater.test.d.ts","sourceRoot":"","sources":["../../../src/test/RpcIncrementalSchemaLocater.test.ts"],"names":[],"mappings":""}

package/lib/esm/test/RpcIncrementalSchemaLocater.test.js

@@ -0,0 +1,128 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { ECSchemaNamespaceUris, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { RpcIncrementalSchemaLocater } from "../RpcIncrementalSchemaLocater";
+import { DbResponseKind, DbResponseStatus, IModelReadRpcInterface } from "@itwin/core-common";
+import { ECSchemaRpcInterface } from "../ECSchemaRpcInterface";
+import { expect } from "chai";
+import * as sinon from "sinon";
+// RpcIncrementalSchemaLocater derives from IncrementalSchemaLocater and ECSqlSchemaLocater, so
+// the basic functionality is already tested in their tests. This test suite verifies the expected
+// behaviour of the RPC specific implementation.
+describe("RpcIncrementalSchemaLocater Tests", () => {
+    let imodelReadInterface;
+    let ecschemaRpcInterface;
+    const schemaInfoColumns = ["name", "version", "references", "alias"];
+    beforeEach(() => {
+        sinon.stub(IModelReadRpcInterface, "getClient").returns(imodelReadInterface = {
+            queryRows: async () => { throw new Error("Method must be implemented in the tests."); },
+        });
+        sinon.stub(ECSchemaRpcInterface, "getClient").returns(ecschemaRpcInterface = {
+            getSchemaJSON: async () => { throw new Error("Method must be implemented in the tests."); },
+        });
+    });
+    afterEach(() => {
+        sinon.restore();
+    });
+    it("get schema info, schema found", async () => {
+        const schemaKey = SchemaKey.parseString("TestSchema.1.0.0");
+        sinon.stub(imodelReadInterface, "queryRows").returns(toQueryResult(schemaInfoColumns, [
+            { name: schemaKey.name, version: schemaKey.version.toString(), references: "[]", alias: "ts" }
+        ]));
+        const locater = new RpcIncrementalSchemaLocater({ key: "rpc-test-imodel" });
+        const schemaInfo = await locater.getSchemaInfo(schemaKey, SchemaMatchType.Latest, new SchemaContext());
+        expect(schemaInfo).is.not.undefined;
+        expect(schemaInfo).has.property("schemaKey").that.satisfies((key) => key.matches(schemaKey));
+        expect(schemaInfo).has.property("alias").that.equals("ts");
+        expect(schemaInfo).has.property("references").that.is.empty;
+    });
+    it("get schema info, schema not found, return undefined", async () => {
+        sinon.stub(imodelReadInterface, "queryRows").returns(toQueryResult(schemaInfoColumns, []));
+        const schemaKey = SchemaKey.parseString("TestSchema.1.0.0");
+        const locater = new RpcIncrementalSchemaLocater({ key: "rpc-test-imodel" });
+        const schemaInfo = await locater.getSchemaInfo(schemaKey, SchemaMatchType.Latest, new SchemaContext());
+        expect(schemaInfo).to.be.undefined;
+    });
+    it("get schema, incrementally", async () => {
+        const context = new SchemaContext();
+        const locater = new RpcIncrementalSchemaLocater({ key: "rpc-test-imodel" });
+        context.addLocater(locater);
+        const schemaKey = SchemaKey.parseString("TestSchema.1.0.0");
+        sinon.stub(imodelReadInterface, "queryRows")
+            .onCall(0).returns(toQueryResult(schemaInfoColumns, [
+            { name: schemaKey.name, version: schemaKey.version.toString(), references: "[]", alias: "ts" },
+            { name: "ECDbMeta", version: "4.0.3", references: "[]", alias: "ecdb" },
+        ]))
+            .onCall(1).returns(toQueryResult(["name", "version", "alias", "references", "items"], [
+            {
+                name: schemaKey.name,
+                version: schemaKey.version.toString(),
+                alias: "ts",
+                references: "[]",
+                items: "[]",
+            }
+        ]))
+            .returns(toQueryResult(["schema", "items"], [
+            {
+                schema: `{
+            "name": "${schemaKey.name}",
+            "version": "${schemaKey.version.toString()}",
+            "alias": "ts",
+            "label": "Test Schema",
+            "description": "This is a test schema."
+          }`,
+            }
+        ]));
+        const schema = await context.getSchema(schemaKey, SchemaMatchType.Latest);
+        expect(schema).is.not.undefined;
+        expect(schema).has.property("schemaKey").that.satisfies((key) => key.matches(schemaKey));
+        expect(schema).has.property("alias").that.equals("ts");
+        expect(schema).has.property("loadingController").that.is.not.undefined;
+        expect(schema).has.a.nested.property("loadingController.inProgress").that.is.true;
+        await schema.loadingController?.wait();
+        expect(schema).has.property("label", "Test Schema");
+        expect(schema).has.property("description", "This is a test schema.");
+    });
+    it("get schema, unsupported metaschema", async () => {
+        const schemaKey = SchemaKey.parseString("TestSchema.1.0.0");
+        sinon.stub(imodelReadInterface, "queryRows").returns(toQueryResult(schemaInfoColumns, [
+            { name: schemaKey.name, version: schemaKey.version.toString(), references: "[]", alias: "ts" },
+            { name: "ECDbMeta", version: "4.0.1", references: "[]", alias: "ecdb" },
+        ]));
+        sinon.stub(ecschemaRpcInterface, "getSchemaJSON").returns(Promise.resolve({
+            $schema: ECSchemaNamespaceUris.SCHEMAURL3_2_JSON,
+            name: schemaKey.name,
+            version: schemaKey.version.toString(),
+            alias: "ts"
+        }));
+        const locater = new RpcIncrementalSchemaLocater({ key: "rpc-test-imodel" });
+        const schema = await locater.getSchema(schemaKey, SchemaMatchType.Latest, new SchemaContext());
+        expect(schema).is.not.undefined;
+        expect(schema).has.property("schemaKey").that.satisfies((key) => key.matches(schemaKey));
+        expect(schema).has.property("alias").that.equals("ts");
+    });
+    it("get schema, schema not found, return undefined", async () => {
+        const schemaKey = SchemaKey.parseString("TestSchema.1.0.0");
+        sinon.stub(imodelReadInterface, "queryRows").returns(toQueryResult(schemaInfoColumns, []));
+        const locater = new RpcIncrementalSchemaLocater({ key: "rpc-test-imodel" });
+        const schema = await locater.getSchema(schemaKey, SchemaMatchType.Latest, new SchemaContext());
+        expect(schema).is.undefined;
+    });
+});
+/**
+ * This is a very simple helper function to translate a set of rows into a DbQueryResponse.
+ * It does not handle different row formats or property order.
+ */
+async function toQueryResult(columns, rows) {
+    return {
+        kind: DbResponseKind.ECSql,
+        status: DbResponseStatus.Done,
+        stats: {},
+        rowCount: rows.length,
+        meta: columns.map((column, i) => ({ name: column, jsonName: column, index: i })),
+        data: rows.map(row => columns.map(k => row[k])),
+    };
+}
+//# sourceMappingURL=RpcIncrementalSchemaLocater.test.js.map

package/lib/esm/test/RpcIncrementalSchemaLocater.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RpcIncrementalSchemaLocater.test.js","sourceRoot":"","sources":["../../../src/test/RpcIncrementalSchemaLocater.test.ts"],"names":[],"mappings":"AACA;;;+FAG+F;AAC/F,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC5G,OAAO,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAC;AAC7E,OAAO,EAAmB,cAAc,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC/G,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,+FAA+F;AAC/F,kGAAkG;AAClG,gDAAgD;AAChD,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;IAEjD,IAAI,mBAA2C,CAAC;IAChD,IAAI,oBAA0C,CAAC;IAE/C,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAErE,UAAU,CAAC,GAAG,EAAE;QACd,KAAK,CAAC,IAAI,CAAC,sBAAsB,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,mBAAmB,GAAG;YAC5E,SAAS,EAAE,KAAK,IAAI,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC;SACjF,CAAC,CAAC;QACV,KAAK,CAAC,IAAI,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,oBAAoB,GAAG;YAC3E,aAAa,EAAE,KAAK,IAAI,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC;SACrF,CAAC,CAAC;IACZ,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;QAC7C,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;QAC5D,KAAK,CAAC,IAAI,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAE;YACpF,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;SAC/F,CAAC,CAAC,CAAC;QAEJ,MAAM,OAAO,GAAG,IAAI,2BAA2B,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC5E,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,eAAe,CAAC,MAAM,EAAE,IAAI,aAAa,EAAE,CAAC,CAAC;QAEvG,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QACpC,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAc,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;QACxG,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3D,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,KAAK,CAAC,IAAI,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,CAAC;QAE3F,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;QAC5D,MAAM,OAAO,GAAG,IAAI,2BAA2B,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC5E,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,eAAe,CAAC,MAAM,EAAE,IAAI,aAAa,EAAE,CAAC,CAAC;QAEvG,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,2BAA2B,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC5E,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;QAC5D,KAAK,CAAC,IAAI,CAAC,mBAAmB,EAAE,WAAW,CAAC;aACzC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAE;YAClD,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;YAC9F,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE;SACxE,CAAC,CAAC;aACF,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE;YACpF;gBACE,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACrC,KAAK,EAAE,IAAI;gBACX,UAAU,EAAE,IAAI;gBAChB,KAAK,EAAE,IAAI;aACZ;SACF,CAAC,CAAC;aACF,OAAO,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE;YAC1C;gBACE,MAAM,EAAE;uBACK,SAAS,CAAC,IAAI;0BACX,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE;;;;YAI1C;aACH;SACF,CAAC,CAAC,CAAC;QAEN,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;QAE1E,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAChC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAc,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;QACpG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEvD,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QACvE,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,8BAA8B,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC;QAClF,MAAM,MAAO,CAAC,iBAAiB,EAAE,IAAI,EAAE,CAAC;QAExC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QACpD,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,aAAa,EAAE,wBAAwB,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;QAC5D,KAAK,CAAC,IAAI,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAE;YACpF,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;YAC9F,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE;SACxE,CAAC,CAAC,CAAC;QAEJ,KAAK,CAAC,IAAI,CAAC,oBAAoB,EAAE,eAAe,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;YACxE,OAAO,EAAE,qBAAqB,CAAC,iBAAiB;YAChD,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE;YACrC,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC,CAAC;QAEJ,MAAM,OAAO,GAAG,IAAI,2BAA2B,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC5E,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,MAAM,EAAE,IAAI,aAAa,EAAE,CAAC,CAAC;QAE/F,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAChC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAc,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;QACpG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;QAC5D,KAAK,CAAC,IAAI,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,CAAC;QAE3F,MAAM,OAAO,GAAG,IAAI,2BAA2B,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC5E,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,MAAM,EAAE,IAAI,aAAa,EAAE,CAAC,CAAC;QAE/F,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC;IAC9B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACH,KAAK,UAAU,aAAa,CAAC,OAAsB,EAAE,IAAsC;IACzF,OAAO;QACL,IAAI,EAAE,cAAc,CAAC,KAAK;QAC1B,MAAM,EAAE,gBAAgB,CAAC,IAAI;QAC7B,KAAK,EAAE,EAAS;QAChB,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAU,CAAA,CAAC;QACvF,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KAChD,CAAC;AACJ,CAAC","sourcesContent":["\n/*---------------------------------------------------------------------------------------------\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*--------------------------------------------------------------------------------------------*/\nimport { ECSchemaNamespaceUris, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\nimport { RpcIncrementalSchemaLocater } from \"../RpcIncrementalSchemaLocater\";\nimport { DbQueryResponse, DbResponseKind, DbResponseStatus, IModelReadRpcInterface } from \"@itwin/core-common\";\nimport { ECSchemaRpcInterface } from \"../ECSchemaRpcInterface\";\nimport { expect } from \"chai\";\nimport * as sinon from \"sinon\";\n\n// RpcIncrementalSchemaLocater derives from IncrementalSchemaLocater and ECSqlSchemaLocater, so\n// the basic functionality is already tested in their tests. This test suite verifies the expected\n// behaviour of the RPC specific implementation.\ndescribe(\"RpcIncrementalSchemaLocater Tests\", () => {\n\n  let imodelReadInterface: IModelReadRpcInterface;\n  let ecschemaRpcInterface: ECSchemaRpcInterface;\n\n  const schemaInfoColumns = [\"name\", \"version\", \"references\", \"alias\"];\n\n  beforeEach(() => {\n    sinon.stub(IModelReadRpcInterface, \"getClient\").returns(imodelReadInterface = {\n      queryRows: async () => { throw new Error(\"Method must be implemented in the tests.\"); },\n    } as any);\n    sinon.stub(ECSchemaRpcInterface, \"getClient\").returns(ecschemaRpcInterface = {\n      getSchemaJSON: async () => { throw new Error(\"Method must be implemented in the tests.\"); },\n    } as any);\n  });\n\n  afterEach(() => {\n    sinon.restore();\n  });\n\n  it(\"get schema info, schema found\", async () => {\n    const schemaKey = SchemaKey.parseString(\"TestSchema.1.0.0\");\n    sinon.stub(imodelReadInterface, \"queryRows\").returns(toQueryResult(schemaInfoColumns, [\n      { name: schemaKey.name, version: schemaKey.version.toString(), references: \"[]\", alias: \"ts\" }\n    ]));\n\n    const locater = new RpcIncrementalSchemaLocater({ key: \"rpc-test-imodel\" });\n    const schemaInfo = await locater.getSchemaInfo(schemaKey, SchemaMatchType.Latest, new SchemaContext());\n\n    expect(schemaInfo).is.not.undefined;\n    expect(schemaInfo).has.property(\"schemaKey\").that.satisfies((key: SchemaKey) => key.matches(schemaKey));\n    expect(schemaInfo).has.property(\"alias\").that.equals(\"ts\");\n    expect(schemaInfo).has.property(\"references\").that.is.empty;\n  });\n\n  it(\"get schema info, schema not found, return undefined\", async () => {\n    sinon.stub(imodelReadInterface, \"queryRows\").returns(toQueryResult(schemaInfoColumns, []));\n\n    const schemaKey = SchemaKey.parseString(\"TestSchema.1.0.0\");\n    const locater = new RpcIncrementalSchemaLocater({ key: \"rpc-test-imodel\" });\n    const schemaInfo = await locater.getSchemaInfo(schemaKey, SchemaMatchType.Latest, new SchemaContext());\n\n    expect(schemaInfo).to.be.undefined;\n  });\n\n  it(\"get schema, incrementally\", async () => {\n    const context = new SchemaContext();\n    const locater = new RpcIncrementalSchemaLocater({ key: \"rpc-test-imodel\" });\n    context.addLocater(locater);\n\n    const schemaKey = SchemaKey.parseString(\"TestSchema.1.0.0\");\n    sinon.stub(imodelReadInterface, \"queryRows\")\n      .onCall(0).returns(toQueryResult(schemaInfoColumns, [\n        { name: schemaKey.name, version: schemaKey.version.toString(), references: \"[]\", alias: \"ts\" },\n        { name: \"ECDbMeta\", version: \"4.0.3\", references: \"[]\", alias: \"ecdb\" },\n      ]))\n      .onCall(1).returns(toQueryResult([\"name\", \"version\", \"alias\", \"references\", \"items\"], [\n        {\n          name: schemaKey.name,\n          version: schemaKey.version.toString(),\n          alias: \"ts\",\n          references: \"[]\",\n          items: \"[]\",\n        }\n      ]))\n      .returns(toQueryResult([\"schema\", \"items\"], [\n        {\n          schema: `{\n            \"name\": \"${schemaKey.name}\",\n            \"version\": \"${schemaKey.version.toString()}\",\n            \"alias\": \"ts\",\n            \"label\": \"Test Schema\",\n            \"description\": \"This is a test schema.\"\n          }`,\n        }\n      ]));\n\n    const schema = await context.getSchema(schemaKey, SchemaMatchType.Latest);\n\n    expect(schema).is.not.undefined;\n    expect(schema).has.property(\"schemaKey\").that.satisfies((key: SchemaKey) => key.matches(schemaKey));\n    expect(schema).has.property(\"alias\").that.equals(\"ts\");\n\n    expect(schema).has.property(\"loadingController\").that.is.not.undefined;\n    expect(schema).has.a.nested.property(\"loadingController.inProgress\").that.is.true;\n    await schema!.loadingController?.wait();\n\n    expect(schema).has.property(\"label\", \"Test Schema\");\n    expect(schema).has.property(\"description\", \"This is a test schema.\");\n  });\n\n  it(\"get schema, unsupported metaschema\", async () => {\n    const schemaKey = SchemaKey.parseString(\"TestSchema.1.0.0\");\n    sinon.stub(imodelReadInterface, \"queryRows\").returns(toQueryResult(schemaInfoColumns, [\n      { name: schemaKey.name, version: schemaKey.version.toString(), references: \"[]\", alias: \"ts\" },\n      { name: \"ECDbMeta\", version: \"4.0.1\", references: \"[]\", alias: \"ecdb\" },\n    ]));\n\n    sinon.stub(ecschemaRpcInterface, \"getSchemaJSON\").returns(Promise.resolve({\n      $schema: ECSchemaNamespaceUris.SCHEMAURL3_2_JSON,\n      name: schemaKey.name,\n      version: schemaKey.version.toString(),\n      alias: \"ts\"\n    }));\n\n    const locater = new RpcIncrementalSchemaLocater({ key: \"rpc-test-imodel\" });\n    const schema = await locater.getSchema(schemaKey, SchemaMatchType.Latest, new SchemaContext());\n\n    expect(schema).is.not.undefined;\n    expect(schema).has.property(\"schemaKey\").that.satisfies((key: SchemaKey) => key.matches(schemaKey));\n    expect(schema).has.property(\"alias\").that.equals(\"ts\");\n  });\n\n  it(\"get schema, schema not found, return undefined\", async () => {\n    const schemaKey = SchemaKey.parseString(\"TestSchema.1.0.0\");\n    sinon.stub(imodelReadInterface, \"queryRows\").returns(toQueryResult(schemaInfoColumns, []));\n\n    const locater = new RpcIncrementalSchemaLocater({ key: \"rpc-test-imodel\" });\n    const schema = await locater.getSchema(schemaKey, SchemaMatchType.Latest, new SchemaContext());\n\n    expect(schema).is.undefined;\n  });\n});\n\n/**\n * This is a very simple helper function to translate a set of rows into a DbQueryResponse.\n * It does not handle different row formats or property order.\n */\nasync function toQueryResult(columns: Array<string>, rows: Array<{ [column: string]: any }>): Promise<DbQueryResponse> {\n  return {\n    kind: DbResponseKind.ECSql,\n    status: DbResponseStatus.Done,\n    stats: {} as any,\n    rowCount: rows.length,\n    meta: columns.map((column, i) => ({ name: column, jsonName: column, index: i } as any)),\n    data: rows.map(row => columns.map(k => row[k])),\n  };\n}"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/ecschema-rpcinterface-common",
-  "version": "5.1.0-dev.59",
+  "version": "5.1.0-dev.60",
   "description": "Schema RPC Interface common interface",
   "main": "lib/cjs/ecschema-rpc-interface.js",
   "module": "lib/esm/ecschema-rpc-interface.js",
@@ -22,21 +22,27 @@
     "url": "http://www.bentley.com"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "5.1.0-dev.59",
-    "@itwin/core-common": "5.1.0-dev.59",
-    "@itwin/core-geometry": "5.1.0-dev.59",
-    "@itwin/ecschema-metadata": "5.1.0-dev.59"
+    "@itwin/core-bentley": "5.1.0-dev.60",
+    "@itwin/core-geometry": "5.1.0-dev.60",
+    "@itwin/core-common": "5.1.0-dev.60",
+    "@itwin/ecschema-metadata": "5.1.0-dev.60"
   },
   "devDependencies": {
     "@itwin/eslint-plugin": "5.0.0-dev.1",
+    "@types/chai": "4.3.1",
+    "@types/mocha": "^10.0.6",
+    "@types/sinon": "^17.0.2",
+    "chai": "^4.3.10",
     "eslint": "^9.13.0",
+    "mocha": "^11.1.0",
+    "sinon": "^17.0.2",
     "rimraf": "^6.0.1",
     "typescript": "~5.6.2",
-    "@itwin/build-tools": "5.1.0-dev.59",
-    "@itwin/core-common": "5.1.0-dev.59",
-    "@itwin/core-bentley": "5.1.0-dev.59",
-    "@itwin/ecschema-metadata": "5.1.0-dev.59",
-    "@itwin/core-geometry": "5.1.0-dev.59"
+    "@itwin/build-tools": "5.1.0-dev.60",
+    "@itwin/core-geometry": "5.1.0-dev.60",
+    "@itwin/core-bentley": "5.1.0-dev.60",
+    "@itwin/core-common": "5.1.0-dev.60",
+    "@itwin/ecschema-metadata": "5.1.0-dev.60"
   },
   "scripts": {
     "build": "npm run -s build:cjs && npm run -s build:esm",
@@ -47,6 +53,6 @@
     "docs": "",
     "extract-api": "betools extract-api --entry=ecschema-rpc-interface",
     "lint": "eslint \"./src/**/*.ts\" 1>&2",
-    "test": ""
+    "test": "mocha"
   }
 }