@itwin/ecschema-rpcinterface-common 4.0.0-dev.22 → 4.0.0-dev.23

package/lib/cjs/ECSchemaRpcInterface.d.ts

@@ -1,35 +1,35 @@
-import { IModelRpcProps, RpcInterface } from "@itwin/core-common";
-import { SchemaKeyProps, SchemaProps } from "@itwin/ecschema-metadata";
-/***
- * Defines an RPC interface to get schema information from a given iModel context.
- * Method @see getSchemaNames will return the names of schemas that live in this iModel.
- * The actual schemas can be downloaded using @see getSchemaJSON to get the schema as JSON props.
- * @internal
- */
-export declare abstract class ECSchemaRpcInterface extends RpcInterface {
-    /** The version of the RPC Interface. */
-    static version: string;
-    static readonly interfaceName = "ECSchemaRpcInterface";
-    static interfaceVersion: string;
-    /**
-     * Returns the RPC client instance for the frontend.
-     * @returns                 A client to communicate with the RPC Interface.
-     */
-    static getClient(): ECSchemaRpcInterface;
-    /**
-     * Returns an array of SchemaKeyProps that exists in the current iModel context. The client can call
-     * SchemaKey.fromJson() to parse the props to a SchemaKey.
-     * @param tokenProps        The iModelToken props that hold the information which iModel is used.
-     * @returns                 An array of SchemaKeyProps.
-     */
-    getSchemaKeys(_tokenProps: IModelRpcProps): Promise<SchemaKeyProps[]>;
-    /**
-     * Gets the schema JSON for the current iModel context and returns the schema as a SchemaProps which
-     * the client can call Schema.fromJson() to return a Schema.
-     * @param tokenProps        The iModelToken props that hold the information which iModel is used.
-     * @param schemaName        The name of the schema that shall be returned.
-     * @returns                 The SchemaProps.
-     */
-    getSchemaJSON(_tokenProps: IModelRpcProps, _schemaName: string): Promise<SchemaProps>;
-}
+import { IModelRpcProps, RpcInterface } from "@itwin/core-common";
+import { SchemaKeyProps, SchemaProps } from "@itwin/ecschema-metadata";
+/***
+ * Defines an RPC interface to get schema information from a given iModel context.
+ * Method @see getSchemaNames will return the names of schemas that live in this iModel.
+ * The actual schemas can be downloaded using @see getSchemaJSON to get the schema as JSON props.
+ * @internal
+ */
+export declare abstract class ECSchemaRpcInterface extends RpcInterface {
+    /** The version of the RPC Interface. */
+    static version: string;
+    static readonly interfaceName = "ECSchemaRpcInterface";
+    static interfaceVersion: string;
+    /**
+     * Returns the RPC client instance for the frontend.
+     * @returns                 A client to communicate with the RPC Interface.
+     */
+    static getClient(): ECSchemaRpcInterface;
+    /**
+     * Returns an array of SchemaKeyProps that exists in the current iModel context. The client can call
+     * SchemaKey.fromJson() to parse the props to a SchemaKey.
+     * @param tokenProps        The iModelToken props that hold the information which iModel is used.
+     * @returns                 An array of SchemaKeyProps.
+     */
+    getSchemaKeys(_tokenProps: IModelRpcProps): Promise<SchemaKeyProps[]>;
+    /**
+     * Gets the schema JSON for the current iModel context and returns the schema as a SchemaProps which
+     * the client can call Schema.fromJson() to return a Schema.
+     * @param tokenProps        The iModelToken props that hold the information which iModel is used.
+     * @param schemaName        The name of the schema that shall be returned.
+     * @returns                 The SchemaProps.
+     */
+    getSchemaJSON(_tokenProps: IModelRpcProps, _schemaName: string): Promise<SchemaProps>;
+}
 //# sourceMappingURL=ECSchemaRpcInterface.d.ts.map

package/lib/cjs/ECSchemaRpcInterface.js

@@ -1,57 +1,57 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ECSchemaRpcInterface = 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");
-/***
- * Defines an RPC interface to get schema information from a given iModel context.
- * Method @see getSchemaNames will return the names of schemas that live in this iModel.
- * The actual schemas can be downloaded using @see getSchemaJSON to get the schema as JSON props.
- * @internal
- */
-class ECSchemaRpcInterface extends core_common_1.RpcInterface {
-    /**
-     * Returns the RPC client instance for the frontend.
-     * @returns                 A client to communicate with the RPC Interface.
-     */
-    static getClient() {
-        return core_common_1.RpcManager.getClientForInterface(ECSchemaRpcInterface);
-    }
-    /**
-     * Returns an array of SchemaKeyProps that exists in the current iModel context. The client can call
-     * SchemaKey.fromJson() to parse the props to a SchemaKey.
-     * @param tokenProps        The iModelToken props that hold the information which iModel is used.
-     * @returns                 An array of SchemaKeyProps.
-     */
-    async getSchemaKeys(_tokenProps) {
-        return this.forward.apply(this, [arguments]);
-    }
-    /**
-     * Gets the schema JSON for the current iModel context and returns the schema as a SchemaProps which
-     * the client can call Schema.fromJson() to return a Schema.
-     * @param tokenProps        The iModelToken props that hold the information which iModel is used.
-     * @param schemaName        The name of the schema that shall be returned.
-     * @returns                 The SchemaProps.
-     */
-    async getSchemaJSON(_tokenProps, _schemaName) {
-        return this.forward.apply(this, [arguments]);
-    }
-}
-/** The version of the RPC Interface. */
-ECSchemaRpcInterface.version = "2.0.0";
-ECSchemaRpcInterface.interfaceName = "ECSchemaRpcInterface";
-ECSchemaRpcInterface.interfaceVersion = ECSchemaRpcInterface.version;
-__decorate([
-    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
-], ECSchemaRpcInterface.prototype, "getSchemaJSON", null);
-exports.ECSchemaRpcInterface = ECSchemaRpcInterface;
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ECSchemaRpcInterface = 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");
+/***
+ * Defines an RPC interface to get schema information from a given iModel context.
+ * Method @see getSchemaNames will return the names of schemas that live in this iModel.
+ * The actual schemas can be downloaded using @see getSchemaJSON to get the schema as JSON props.
+ * @internal
+ */
+class ECSchemaRpcInterface extends core_common_1.RpcInterface {
+    /**
+     * Returns the RPC client instance for the frontend.
+     * @returns                 A client to communicate with the RPC Interface.
+     */
+    static getClient() {
+        return core_common_1.RpcManager.getClientForInterface(ECSchemaRpcInterface);
+    }
+    /**
+     * Returns an array of SchemaKeyProps that exists in the current iModel context. The client can call
+     * SchemaKey.fromJson() to parse the props to a SchemaKey.
+     * @param tokenProps        The iModelToken props that hold the information which iModel is used.
+     * @returns                 An array of SchemaKeyProps.
+     */
+    async getSchemaKeys(_tokenProps) {
+        return this.forward.apply(this, [arguments]);
+    }
+    /**
+     * Gets the schema JSON for the current iModel context and returns the schema as a SchemaProps which
+     * the client can call Schema.fromJson() to return a Schema.
+     * @param tokenProps        The iModelToken props that hold the information which iModel is used.
+     * @param schemaName        The name of the schema that shall be returned.
+     * @returns                 The SchemaProps.
+     */
+    async getSchemaJSON(_tokenProps, _schemaName) {
+        return this.forward.apply(this, [arguments]);
+    }
+}
+/** The version of the RPC Interface. */
+ECSchemaRpcInterface.version = "2.0.0";
+ECSchemaRpcInterface.interfaceName = "ECSchemaRpcInterface";
+ECSchemaRpcInterface.interfaceVersion = ECSchemaRpcInterface.version;
+__decorate([
+    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
+], ECSchemaRpcInterface.prototype, "getSchemaJSON", null);
+exports.ECSchemaRpcInterface = ECSchemaRpcInterface;
 //# sourceMappingURL=ECSchemaRpcInterface.js.map

package/lib/cjs/ECSchemaRpcInterface.js.map

@@ -1 +1 @@
-{"version":3,"file":"ECSchemaRpcInterface.js","sourceRoot":"","sources":["../../src/ECSchemaRpcInterface.ts"],"names":[],"mappings":";;;;;;;;;AAAA;;;+FAG+F;AAC/F,oDAA4F;AAG5F;;;;;GAKG;AACH,MAAsB,oBAAqB,SAAQ,0BAAY;IAO7D;;;OAGG;IACI,MAAM,CAAC,SAAS;QACrB,OAAO,wBAAU,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,WAA2B;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,CAA8B,CAAC;IAC5E,CAAC;IAED;;;;;;OAMG;IAEI,KAAK,CAAC,aAAa,CAAC,WAA2B,EAAE,WAAmB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,CAAyB,CAAC;IACvE,CAAC;;AAlCD,wCAAwC;AAC1B,4BAAO,GAAG,OAAO,CAAC;AAET,kCAAa,GAAG,sBAAsB,CAAC;AAChD,qCAAgB,GAAG,oBAAoB,CAAC,OAAO,CAAC;AA4B9D;IADC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;yDAG1D;AAnCH,oDAqCC","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\nimport { IModelRpcProps, RpcInterface, RpcManager, RpcOperation } from \"@itwin/core-common\";\r\nimport { SchemaKeyProps, SchemaProps } from \"@itwin/ecschema-metadata\";\r\n\r\n/***\r\n * Defines an RPC interface to get schema information from a given iModel context.\r\n * Method @see getSchemaNames will return the names of schemas that live in this iModel.\r\n * The actual schemas can be downloaded using @see getSchemaJSON to get the schema as JSON props.\r\n * @internal\r\n */\r\nexport abstract class ECSchemaRpcInterface extends RpcInterface { // eslint-disable-line deprecation/deprecation\r\n  /** The version of the RPC Interface. */\r\n  public static version = \"2.0.0\";\r\n\r\n  public static readonly interfaceName = \"ECSchemaRpcInterface\";\r\n  public static interfaceVersion = ECSchemaRpcInterface.version;\r\n\r\n  /**\r\n   * Returns the RPC client instance for the frontend.\r\n   * @returns                 A client to communicate with the RPC Interface.\r\n   */\r\n  public static getClient(): ECSchemaRpcInterface {\r\n    return RpcManager.getClientForInterface(ECSchemaRpcInterface);\r\n  }\r\n\r\n  /**\r\n   * Returns an array of SchemaKeyProps that exists in the current iModel context. The client can call\r\n   * SchemaKey.fromJson() to parse the props to a SchemaKey.\r\n   * @param tokenProps        The iModelToken props that hold the information which iModel is used.\r\n   * @returns                 An array of SchemaKeyProps.\r\n   */\r\n  public async getSchemaKeys(_tokenProps: IModelRpcProps): Promise<SchemaKeyProps[]> {\r\n    return this.forward.apply(this, [arguments]) as Promise<SchemaKeyProps[]>;\r\n  }\r\n\r\n  /**\r\n   * Gets the schema JSON for the current iModel context and returns the schema as a SchemaProps which\r\n   * the client can call Schema.fromJson() to return a Schema.\r\n   * @param tokenProps        The iModelToken props that hold the information which iModel is used.\r\n   * @param schemaName        The name of the schema that shall be returned.\r\n   * @returns                 The SchemaProps.\r\n   */\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getSchemaJSON(_tokenProps: IModelRpcProps, _schemaName: string): Promise<SchemaProps> {\r\n    return this.forward.apply(this, [arguments]) as Promise<SchemaProps>;\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"ECSchemaRpcInterface.js","sourceRoot":"","sources":["../../src/ECSchemaRpcInterface.ts"],"names":[],"mappings":";;;;;;;;;AAAA;;;+FAG+F;AAC/F,oDAA4F;AAG5F;;;;;GAKG;AACH,MAAsB,oBAAqB,SAAQ,0BAAY;IAO7D;;;OAGG;IACI,MAAM,CAAC,SAAS;QACrB,OAAO,wBAAU,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,WAA2B;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,CAA8B,CAAC;IAC5E,CAAC;IAED;;;;;;OAMG;IAEI,KAAK,CAAC,aAAa,CAAC,WAA2B,EAAE,WAAmB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,CAAyB,CAAC;IACvE,CAAC;;AAlCD,wCAAwC;AAC1B,4BAAO,GAAG,OAAO,CAAC;AAET,kCAAa,GAAG,sBAAsB,CAAC;AAChD,qCAAgB,GAAG,oBAAoB,CAAC,OAAO,CAAC;AA4B9D;IADC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;yDAG1D;AAnCH,oDAqCC","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 { IModelRpcProps, RpcInterface, RpcManager, RpcOperation } from \"@itwin/core-common\";\nimport { SchemaKeyProps, SchemaProps } from \"@itwin/ecschema-metadata\";\n\n/***\n * Defines an RPC interface to get schema information from a given iModel context.\n * Method @see getSchemaNames will return the names of schemas that live in this iModel.\n * The actual schemas can be downloaded using @see getSchemaJSON to get the schema as JSON props.\n * @internal\n */\nexport abstract class ECSchemaRpcInterface extends RpcInterface { // eslint-disable-line deprecation/deprecation\n  /** The version of the RPC Interface. */\n  public static version = \"2.0.0\";\n\n  public static readonly interfaceName = \"ECSchemaRpcInterface\";\n  public static interfaceVersion = ECSchemaRpcInterface.version;\n\n  /**\n   * Returns the RPC client instance for the frontend.\n   * @returns                 A client to communicate with the RPC Interface.\n   */\n  public static getClient(): ECSchemaRpcInterface {\n    return RpcManager.getClientForInterface(ECSchemaRpcInterface);\n  }\n\n  /**\n   * Returns an array of SchemaKeyProps that exists in the current iModel context. The client can call\n   * SchemaKey.fromJson() to parse the props to a SchemaKey.\n   * @param tokenProps        The iModelToken props that hold the information which iModel is used.\n   * @returns                 An array of SchemaKeyProps.\n   */\n  public async getSchemaKeys(_tokenProps: IModelRpcProps): Promise<SchemaKeyProps[]> {\n    return this.forward.apply(this, [arguments]) as Promise<SchemaKeyProps[]>;\n  }\n\n  /**\n   * Gets the schema JSON for the current iModel context and returns the schema as a SchemaProps which\n   * the client can call Schema.fromJson() to return a Schema.\n   * @param tokenProps        The iModelToken props that hold the information which iModel is used.\n   * @param schemaName        The name of the schema that shall be returned.\n   * @returns                 The SchemaProps.\n   */\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\n  public async getSchemaJSON(_tokenProps: IModelRpcProps, _schemaName: string): Promise<SchemaProps> {\n    return this.forward.apply(this, [arguments]) as Promise<SchemaProps>;\n  }\n\n}\n"]}

package/lib/cjs/ECSchemaRpcLocater.d.ts

@@ -1,25 +1,25 @@
-import { ISchemaLocater, Schema, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
-import { IModelRpcProps } from "@itwin/core-common";
-/**
- * Defines a schema locater that retrieves schemas using an RPC interface.
- * @alpha
- */
-export declare class ECSchemaRpcLocater implements ISchemaLocater {
-    readonly token: IModelRpcProps;
-    constructor(token: IModelRpcProps);
-    /**
-     * Attempts to get a schema from the schema rpc locater. Yields undefined if no matching schema is found.
-     * @param schemaKey Key to look up
-     * @param matchType How to match key against candidate schemas
-     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
-    */
-    getSchema<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;
-    /**
-     * Attempts to get a schema from the schema rpc locater. Yields undefined if no matching schema is found.
-     * @param schemaKey Key to look up
-     * @param matchType How to match key against candidate schemas
-     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
-    */
-    getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined;
-}
+import { ISchemaLocater, Schema, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { IModelRpcProps } from "@itwin/core-common";
+/**
+ * Defines a schema locater that retrieves schemas using an RPC interface.
+ * @alpha
+ */
+export declare class ECSchemaRpcLocater implements ISchemaLocater {
+    readonly token: IModelRpcProps;
+    constructor(token: IModelRpcProps);
+    /**
+     * Attempts to get a schema from the schema rpc locater. Yields undefined if no matching schema is found.
+     * @param schemaKey Key to look up
+     * @param matchType How to match key against candidate schemas
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+    */
+    getSchema<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;
+    /**
+     * Attempts to get a schema from the schema rpc locater. Yields undefined if no matching schema is found.
+     * @param schemaKey Key to look up
+     * @param matchType How to match key against candidate schemas
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+    */
+    getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined;
+}
 //# sourceMappingURL=ECSchemaRpcLocater.d.ts.map

package/lib/cjs/ECSchemaRpcLocater.js

@@ -1,48 +1,48 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ECSchemaRpcLocater = 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 ecschema_metadata_1 = require("@itwin/ecschema-metadata");
-const ECSchemaRpcInterface_1 = require("./ECSchemaRpcInterface");
-/**
- * Defines a schema locater that retrieves schemas using an RPC interface.
- * @alpha
- */
-class ECSchemaRpcLocater {
-    constructor(token) { this.token = token; }
-    /**
-     * Attempts to get a schema from the schema rpc locater. Yields undefined if no matching schema is found.
-     * @param schemaKey Key to look up
-     * @param matchType How to match key against candidate schemas
-     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
-    */
-    async getSchema(schemaKey, matchType, context) {
-        const schemaJson = await ECSchemaRpcInterface_1.ECSchemaRpcInterface.getClient().getSchemaJSON(this.token, schemaKey.name);
-        const schema = await ecschema_metadata_1.Schema.fromJson(schemaJson, context || new ecschema_metadata_1.SchemaContext());
-        if (schema !== undefined && schema.schemaKey.matches(schemaKey, matchType)) {
-            return schema;
-        }
-        return undefined;
-    }
-    /**
-     * Attempts to get a schema from the schema rpc locater. Yields undefined if no matching schema is found.
-     * @param schemaKey Key to look up
-     * @param matchType How to match key against candidate schemas
-     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
-    */
-    getSchemaSync(schemaKey, matchType, context) {
-        const schemaJson = ECSchemaRpcInterface_1.ECSchemaRpcInterface.getClient().getSchemaJSON(this.token, schemaKey.name).then((props) => {
-            return props;
-        });
-        const schema = ecschema_metadata_1.Schema.fromJsonSync(schemaJson, context || new ecschema_metadata_1.SchemaContext());
-        if (schema !== undefined && schema.schemaKey.matches(schemaKey, matchType)) {
-            return schema;
-        }
-        return undefined;
-    }
-}
-exports.ECSchemaRpcLocater = ECSchemaRpcLocater;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ECSchemaRpcLocater = 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 ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const ECSchemaRpcInterface_1 = require("./ECSchemaRpcInterface");
+/**
+ * Defines a schema locater that retrieves schemas using an RPC interface.
+ * @alpha
+ */
+class ECSchemaRpcLocater {
+    constructor(token) { this.token = token; }
+    /**
+     * Attempts to get a schema from the schema rpc locater. Yields undefined if no matching schema is found.
+     * @param schemaKey Key to look up
+     * @param matchType How to match key against candidate schemas
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+    */
+    async getSchema(schemaKey, matchType, context) {
+        const schemaJson = await ECSchemaRpcInterface_1.ECSchemaRpcInterface.getClient().getSchemaJSON(this.token, schemaKey.name);
+        const schema = await ecschema_metadata_1.Schema.fromJson(schemaJson, context || new ecschema_metadata_1.SchemaContext());
+        if (schema !== undefined && schema.schemaKey.matches(schemaKey, matchType)) {
+            return schema;
+        }
+        return undefined;
+    }
+    /**
+     * Attempts to get a schema from the schema rpc locater. Yields undefined if no matching schema is found.
+     * @param schemaKey Key to look up
+     * @param matchType How to match key against candidate schemas
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+    */
+    getSchemaSync(schemaKey, matchType, context) {
+        const schemaJson = ECSchemaRpcInterface_1.ECSchemaRpcInterface.getClient().getSchemaJSON(this.token, schemaKey.name).then((props) => {
+            return props;
+        });
+        const schema = ecschema_metadata_1.Schema.fromJsonSync(schemaJson, context || new ecschema_metadata_1.SchemaContext());
+        if (schema !== undefined && schema.schemaKey.matches(schemaKey, matchType)) {
+            return schema;
+        }
+        return undefined;
+    }
+}
+exports.ECSchemaRpcLocater = ECSchemaRpcLocater;
 //# sourceMappingURL=ECSchemaRpcLocater.js.map

package/lib/cjs/ECSchemaRpcLocater.js.map

@@ -1 +1 @@
-{"version":3,"file":"ECSchemaRpcLocater.js","sourceRoot":"","sources":["../../src/ECSchemaRpcLocater.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,gEAA0H;AAE1H,iEAA8D;AAE9D;;;GAGG;AACH,MAAa,kBAAkB;IAG7B,YAAY,KAAqB,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;IAE1D;;;;;MAKE;IACK,KAAK,CAAC,SAAS,CAAmB,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC/G,MAAM,UAAU,GAAG,MAAM,2CAAoB,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QACpG,MAAM,MAAM,GAAG,MAAM,0BAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,IAAI,IAAI,iCAAa,EAAE,CAAC,CAAC;QACjF,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE;YAC1E,OAAO,MAAW,CAAC;SACpB;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;MAKE;IACK,aAAa,CAAmB,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC7G,MAAM,UAAU,GAAG,2CAAoB,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,KAAkB,EAAE,EAAE;YACxH,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,0BAAM,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,IAAI,IAAI,iCAAa,EAAE,CAAC,CAAC;QAC/E,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE;YAC1E,OAAO,MAAW,CAAC;SACpB;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AApCD,gDAoCC","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\nimport { ISchemaLocater, Schema, SchemaContext, SchemaKey, SchemaMatchType, SchemaProps } from \"@itwin/ecschema-metadata\";\r\nimport { IModelRpcProps } from \"@itwin/core-common\";\r\nimport { ECSchemaRpcInterface } from \"./ECSchemaRpcInterface\";\r\n\r\n/**\r\n * Defines a schema locater that retrieves schemas using an RPC interface.\r\n * @alpha\r\n */\r\nexport class ECSchemaRpcLocater implements ISchemaLocater {\r\n  public readonly token: IModelRpcProps;\r\n\r\n  constructor(token: IModelRpcProps) { this.token = token; }\r\n\r\n  /**\r\n   * Attempts to get a schema from the schema rpc locater. Yields undefined if no matching schema is found.\r\n   * @param schemaKey Key to look up\r\n   * @param matchType How to match key against candidate schemas\r\n   * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\r\n  */\r\n  public async getSchema<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined> {\r\n    const schemaJson = await ECSchemaRpcInterface.getClient().getSchemaJSON(this.token, schemaKey.name);\r\n    const schema = await Schema.fromJson(schemaJson, context || new SchemaContext());\r\n    if (schema !== undefined && schema.schemaKey.matches(schemaKey, matchType)) {\r\n      return schema as T;\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  /**\r\n   * Attempts to get a schema from the schema rpc locater. Yields undefined if no matching schema is found.\r\n   * @param schemaKey Key to look up\r\n   * @param matchType How to match key against candidate schemas\r\n   * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\r\n  */\r\n  public getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined {\r\n    const schemaJson = ECSchemaRpcInterface.getClient().getSchemaJSON(this.token, schemaKey.name).then((props: SchemaProps) => {\r\n      return props;\r\n    });\r\n    const schema = Schema.fromJsonSync(schemaJson, context || new SchemaContext());\r\n    if (schema !== undefined && schema.schemaKey.matches(schemaKey, matchType)) {\r\n      return schema as T;\r\n    }\r\n    return undefined;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ECSchemaRpcLocater.js","sourceRoot":"","sources":["../../src/ECSchemaRpcLocater.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,gEAA0H;AAE1H,iEAA8D;AAE9D;;;GAGG;AACH,MAAa,kBAAkB;IAG7B,YAAY,KAAqB,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;IAE1D;;;;;MAKE;IACK,KAAK,CAAC,SAAS,CAAmB,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC/G,MAAM,UAAU,GAAG,MAAM,2CAAoB,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QACpG,MAAM,MAAM,GAAG,MAAM,0BAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,IAAI,IAAI,iCAAa,EAAE,CAAC,CAAC;QACjF,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE;YAC1E,OAAO,MAAW,CAAC;SACpB;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;MAKE;IACK,aAAa,CAAmB,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC7G,MAAM,UAAU,GAAG,2CAAoB,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,KAAkB,EAAE,EAAE;YACxH,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,0BAAM,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,IAAI,IAAI,iCAAa,EAAE,CAAC,CAAC;QAC/E,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE;YAC1E,OAAO,MAAW,CAAC;SACpB;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AApCD,gDAoCC","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 { ISchemaLocater, Schema, SchemaContext, SchemaKey, SchemaMatchType, SchemaProps } from \"@itwin/ecschema-metadata\";\nimport { IModelRpcProps } from \"@itwin/core-common\";\nimport { ECSchemaRpcInterface } from \"./ECSchemaRpcInterface\";\n\n/**\n * Defines a schema locater that retrieves schemas using an RPC interface.\n * @alpha\n */\nexport class ECSchemaRpcLocater implements ISchemaLocater {\n  public readonly token: IModelRpcProps;\n\n  constructor(token: IModelRpcProps) { this.token = token; }\n\n  /**\n   * Attempts to get a schema from the schema rpc locater. Yields undefined if no matching schema is found.\n   * @param schemaKey Key to look up\n   * @param matchType How to match key against candidate schemas\n   * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\n  */\n  public async getSchema<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined> {\n    const schemaJson = await ECSchemaRpcInterface.getClient().getSchemaJSON(this.token, schemaKey.name);\n    const schema = await Schema.fromJson(schemaJson, context || new SchemaContext());\n    if (schema !== undefined && schema.schemaKey.matches(schemaKey, matchType)) {\n      return schema as T;\n    }\n    return undefined;\n  }\n\n  /**\n   * Attempts to get a schema from the schema rpc locater. Yields undefined if no matching schema is found.\n   * @param schemaKey Key to look up\n   * @param matchType How to match key against candidate schemas\n   * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\n  */\n  public getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined {\n    const schemaJson = ECSchemaRpcInterface.getClient().getSchemaJSON(this.token, schemaKey.name).then((props: SchemaProps) => {\n      return props;\n    });\n    const schema = Schema.fromJsonSync(schemaJson, context || new SchemaContext());\n    if (schema !== undefined && schema.schemaKey.matches(schemaKey, matchType)) {\n      return schema as T;\n    }\n    return undefined;\n  }\n}\n"]}

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

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

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

@@ -1,19 +1,19 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-__exportStar(require("./ECSchemaRpcInterface"), exports);
-__exportStar(require("./ECSchemaRpcLocater"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+__exportStar(require("./ECSchemaRpcInterface"), exports);
+__exportStar(require("./ECSchemaRpcLocater"), 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":["/*---------------------------------------------------------------------------------------------\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\nexport * from \"./ECSchemaRpcInterface\";\r\nexport * from \"./ECSchemaRpcLocater\";\r\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","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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/ecschema-rpcinterface-common",
-  "version": "4.0.0-dev.22",
+  "version": "4.0.0-dev.23",
   "description": "Schema RPC Interface common interface",
   "main": "lib/cjs/ecschema-rpc-interface.js",
   "typings": "lib/cjs/ecschema-rpc-interface",
@@ -20,18 +20,18 @@
     "url": "http://www.bentley.com"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "4.0.0-dev.22",
-    "@itwin/core-common": "4.0.0-dev.22",
-    "@itwin/core-geometry": "4.0.0-dev.22",
-    "@itwin/ecschema-metadata": "4.0.0-dev.22"
+    "@itwin/core-bentley": "4.0.0-dev.23",
+    "@itwin/core-common": "4.0.0-dev.23",
+    "@itwin/core-geometry": "4.0.0-dev.23",
+    "@itwin/ecschema-metadata": "4.0.0-dev.23"
   },
   "devDependencies": {
-    "@itwin/build-tools": "4.0.0-dev.22",
-    "@itwin/core-bentley": "4.0.0-dev.22",
-    "@itwin/core-common": "4.0.0-dev.22",
-    "@itwin/core-geometry": "4.0.0-dev.22",
-    "@itwin/ecschema-metadata": "4.0.0-dev.22",
-    "@itwin/eslint-plugin": "4.0.0-dev.22",
+    "@itwin/build-tools": "4.0.0-dev.23",
+    "@itwin/core-bentley": "4.0.0-dev.23",
+    "@itwin/core-common": "4.0.0-dev.23",
+    "@itwin/core-geometry": "4.0.0-dev.23",
+    "@itwin/ecschema-metadata": "4.0.0-dev.23",
+    "@itwin/eslint-plugin": "4.0.0-dev.23",
     "eslint": "^7.11.0",
     "rimraf": "^3.0.2",
     "typescript": "~4.4.0"