@itwin/ecschema-rpcinterface-common 5.0.0-dev.99 → 5.0.1

package/CHANGELOG.md

@@ -1,6 +1,61 @@
 # Change Log - @itwin/ecschema-rpcinterface-common
 
-This log was last generated on Wed, 02 Apr 2025 19:38:36 GMT and should not be manually modified.
+This log was last generated on Tue, 17 Jun 2025 18:33:52 GMT and should not be manually modified.
+
+## 5.0.1
+Tue, 17 Jun 2025 18:33:52 GMT
+
+_Version update only_
+
+## 5.0.0
+Fri, 13 Jun 2025 20:25:38 GMT
+
+### Updates
+
+- Deprecated `getSchemaSync` method from ECSchemaRpcLocater.
+- Add ESM build
+- Upgrade compile target to ES2023 and module to ES2022
+- applied changes in ecschema-metadatas SchemaLocater interface
+
+## 4.11.6
+Mon, 16 Jun 2025 15:00:15 GMT
+
+_Version update only_
+
+## 4.11.5
+Fri, 06 Jun 2025 13:41:18 GMT
+
+_Version update only_
+
+## 4.11.4
+Tue, 03 Jun 2025 16:15:19 GMT
+
+_Version update only_
+
+## 4.11.3
+Wed, 28 May 2025 13:56:23 GMT
+
+_Version update only_
+
+## 4.11.2
+Tue, 20 May 2025 20:14:46 GMT
+
+_Version update only_
+
+## 4.11.1
+Wed, 30 Apr 2025 13:13:21 GMT
+
+_Version update only_
+
+## 4.11.0
+Wed, 16 Apr 2025 15:50:28 GMT
+
+_Version update only_
+
+## 4.10.13
+Thu, 10 Apr 2025 17:47:21 GMT
+
+_Version update only_
 
 ## 4.10.12
 Wed, 02 Apr 2025 19:35:47 GMT

package/lib/cjs/ECSchemaRpcLocater.d.ts

@@ -2,9 +2,10 @@ import { ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMat
 import { IModelRpcProps } from "@itwin/core-common";
 /**
  * Defines a schema locater that retrieves schemas using an RPC interface.
- * @beta
+ * @public @preview
  */
 export declare class ECSchemaRpcLocater implements ISchemaLocater {
+    /** @internal */
     readonly token: IModelRpcProps;
     constructor(token: IModelRpcProps);
     /**
@@ -22,11 +23,14 @@ export declare class ECSchemaRpcLocater implements ISchemaLocater {
       */
     getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | 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.
+     * This method is not supported for locating schemas over RPC/HTTP.
+     * Use the asynchronous `getSchema` method instead.
+     * @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.
+     * @throws Error Always throws an error indicating this method is not supported.
+     * @deprecated in 5.0. Use the asynchronous `getSchema` method for schema retrieval.
     */
-    getSchemaSync(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | undefined;
+    getSchemaSync(_schemaKey: SchemaKey, _matchType: SchemaMatchType, _context: SchemaContext): Schema | undefined;
 }
 //# sourceMappingURL=ECSchemaRpcLocater.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ECSchemaRpcLocater.d.ts","sourceRoot":"","sources":["../../src/ECSchemaRpcLocater.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAAe,MAAM,0BAA0B,CAAC;AACtI,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGpD;;;GAGG;AACH,qBAAa,kBAAmB,YAAW,cAAc;IACvD,SAAgB,KAAK,EAAE,cAAc,CAAC;gBAE1B,KAAK,EAAE,cAAc;IAEjC;;;;;MAKE;IACW,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAO7H;;;;;QAKI;IACS,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IASrI;;;;;MAKE;IACK,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS;CAUnH"}
+{"version":3,"file":"ECSchemaRpcLocater.d.ts","sourceRoot":"","sources":["../../src/ECSchemaRpcLocater.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACzH,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGpD;;;GAGG;AACH,qBAAa,kBAAmB,YAAW,cAAc;IACvD,gBAAgB;IAChB,SAAgB,KAAK,EAAE,cAAc,CAAC;gBAE1B,KAAK,EAAE,cAAc;IAEjC;;;;;MAKE;IACW,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAO7H;;;;;QAKI;IACS,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IASrI;;;;;;;;MAQE;IACK,aAAa,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS;CAGtH"}

package/lib/cjs/ECSchemaRpcLocater.js

@@ -9,9 +9,10 @@ const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
 const ECSchemaRpcInterface_1 = require("./ECSchemaRpcInterface");
 /**
  * Defines a schema locater that retrieves schemas using an RPC interface.
- * @beta
+ * @public @preview
  */
 class ECSchemaRpcLocater {
+    /** @internal */
     token;
     constructor(token) { this.token = token; }
     /**
@@ -40,20 +41,16 @@ class ECSchemaRpcLocater {
         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.
+     * This method is not supported for locating schemas over RPC/HTTP.
+     * Use the asynchronous `getSchema` method instead.
+     * @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.
+     * @throws Error Always throws an error indicating this method is not supported.
+     * @deprecated in 5.0. Use the asynchronous `getSchema` method for schema retrieval.
     */
-    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;
+    getSchemaSync(_schemaKey, _matchType, _context) {
+        throw new Error("getSchemaSync is not supported. Use the asynchronous getSchema method instead.");
     }
 }
 exports.ECSchemaRpcLocater = ECSchemaRpcLocater;

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,gEAAsI;AAEtI,iEAA8D;AAE9D;;;GAGG;AACH,MAAa,kBAAkB;IACb,KAAK,CAAiB;IAEtC,YAAY,KAAqB,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;IAE1D;;;;;MAKE;IACK,KAAK,CAAC,SAAS,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC7F,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAExD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,MAAM,UAAU,GAAG,MAAM,2CAAoB,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QACpG,MAAM,UAAU,GAAG,MAAM,0BAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,OAAO,IAAI,IAAI,iCAAa,EAAE,CAAC,CAAC;QACjG,IAAI,UAAU,KAAK,SAAS,IAAI,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC;YACnF,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;MAKE;IACK,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC3F,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,CAAC;YAC3E,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAjDD,gDAiDC","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, SchemaInfo, 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 * @beta\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(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined> {\n    await this.getSchemaInfo(schemaKey, matchType, context);\n\n    const schema = await context.getCachedSchema(schemaKey, matchType);\n    return schema;\n  }\n\n  /**\n    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\n    * The fully loaded schema can be accessed via the schema context using the getCachedSchema method.\n    * @param schemaKey The SchemaKey describing the schema to get from the cache.\n    * @param matchType The match type to use when locating the schema\n    */\n  public async getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\n    const schemaJson = await ECSchemaRpcInterface.getClient().getSchemaJSON(this.token, schemaKey.name);\n    const schemaInfo = await Schema.startLoadingFromJson(schemaJson, context || new SchemaContext());\n    if (schemaInfo !== undefined && schemaInfo.schemaKey.matches(schemaKey, matchType)) {\n      return schemaInfo;\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(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | 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;\n    }\n    return undefined;\n  }\n}\n"]}
+{"version":3,"file":"ECSchemaRpcLocater.js","sourceRoot":"","sources":["../../src/ECSchemaRpcLocater.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,gEAAyH;AAEzH,iEAA8D;AAE9D;;;GAGG;AACH,MAAa,kBAAkB;IAC7B,gBAAgB;IACA,KAAK,CAAiB;IAEtC,YAAY,KAAqB,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;IAE1D;;;;;MAKE;IACK,KAAK,CAAC,SAAS,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC7F,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAExD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,MAAM,UAAU,GAAG,MAAM,2CAAoB,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QACpG,MAAM,UAAU,GAAG,MAAM,0BAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,OAAO,IAAI,IAAI,iCAAa,EAAE,CAAC,CAAC;QACjG,IAAI,UAAU,KAAK,SAAS,IAAI,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC;YACnF,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;;MAQE;IACK,aAAa,CAAC,UAAqB,EAAE,UAA2B,EAAE,QAAuB;QAC9F,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC;IACpG,CAAC;CACF;AA9CD,gDA8CC","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, SchemaInfo, SchemaKey, SchemaMatchType } 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 * @public @preview\n */\nexport class ECSchemaRpcLocater implements ISchemaLocater {\n  /** @internal */\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(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined> {\n    await this.getSchemaInfo(schemaKey, matchType, context);\n\n    const schema = await context.getCachedSchema(schemaKey, matchType);\n    return schema;\n  }\n\n  /**\n    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\n    * The fully loaded schema can be accessed via the schema context using the getCachedSchema method.\n    * @param schemaKey The SchemaKey describing the schema to get from the cache.\n    * @param matchType The match type to use when locating the schema\n    */\n  public async getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\n    const schemaJson = await ECSchemaRpcInterface.getClient().getSchemaJSON(this.token, schemaKey.name);\n    const schemaInfo = await Schema.startLoadingFromJson(schemaJson, context || new SchemaContext());\n    if (schemaInfo !== undefined && schemaInfo.schemaKey.matches(schemaKey, matchType)) {\n      return schemaInfo;\n    }\n    return undefined;\n  }\n\n  /**\n   * This method is not supported for locating schemas over RPC/HTTP.\n   * Use the asynchronous `getSchema` method instead.\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   * @throws Error Always throws an error indicating this method is not supported.\n   * @deprecated in 5.0. Use the asynchronous `getSchema` method for schema retrieval.\n  */\n  public getSchemaSync(_schemaKey: SchemaKey, _matchType: SchemaMatchType, _context: SchemaContext): Schema | undefined {\n    throw new Error(\"getSchemaSync is not supported. Use the asynchronous getSchema method instead.\");\n  }\n}\n"]}

package/lib/esm/ECSchemaRpcLocater.d.ts

@@ -2,9 +2,10 @@ import { ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMat
 import { IModelRpcProps } from "@itwin/core-common";
 /**
  * Defines a schema locater that retrieves schemas using an RPC interface.
- * @beta
+ * @public @preview
  */
 export declare class ECSchemaRpcLocater implements ISchemaLocater {
+    /** @internal */
     readonly token: IModelRpcProps;
     constructor(token: IModelRpcProps);
     /**
@@ -22,11 +23,14 @@ export declare class ECSchemaRpcLocater implements ISchemaLocater {
       */
     getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | 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.
+     * This method is not supported for locating schemas over RPC/HTTP.
+     * Use the asynchronous `getSchema` method instead.
+     * @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.
+     * @throws Error Always throws an error indicating this method is not supported.
+     * @deprecated in 5.0. Use the asynchronous `getSchema` method for schema retrieval.
     */
-    getSchemaSync(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | undefined;
+    getSchemaSync(_schemaKey: SchemaKey, _matchType: SchemaMatchType, _context: SchemaContext): Schema | undefined;
 }
 //# sourceMappingURL=ECSchemaRpcLocater.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ECSchemaRpcLocater.d.ts","sourceRoot":"","sources":["../../src/ECSchemaRpcLocater.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAAe,MAAM,0BAA0B,CAAC;AACtI,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGpD;;;GAGG;AACH,qBAAa,kBAAmB,YAAW,cAAc;IACvD,SAAgB,KAAK,EAAE,cAAc,CAAC;gBAE1B,KAAK,EAAE,cAAc;IAEjC;;;;;MAKE;IACW,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAO7H;;;;;QAKI;IACS,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IASrI;;;;;MAKE;IACK,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS;CAUnH"}
+{"version":3,"file":"ECSchemaRpcLocater.d.ts","sourceRoot":"","sources":["../../src/ECSchemaRpcLocater.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACzH,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGpD;;;GAGG;AACH,qBAAa,kBAAmB,YAAW,cAAc;IACvD,gBAAgB;IAChB,SAAgB,KAAK,EAAE,cAAc,CAAC;gBAE1B,KAAK,EAAE,cAAc;IAEjC;;;;;MAKE;IACW,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAO7H;;;;;QAKI;IACS,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IASrI;;;;;;;;MAQE;IACK,aAAa,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS;CAGtH"}

package/lib/esm/ECSchemaRpcLocater.js

@@ -6,9 +6,10 @@ import { Schema, SchemaContext } from "@itwin/ecschema-metadata";
 import { ECSchemaRpcInterface } from "./ECSchemaRpcInterface";
 /**
  * Defines a schema locater that retrieves schemas using an RPC interface.
- * @beta
+ * @public @preview
  */
 export class ECSchemaRpcLocater {
+    /** @internal */
     token;
     constructor(token) { this.token = token; }
     /**
@@ -37,20 +38,16 @@ export class ECSchemaRpcLocater {
         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.
+     * This method is not supported for locating schemas over RPC/HTTP.
+     * Use the asynchronous `getSchema` method instead.
+     * @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.
+     * @throws Error Always throws an error indicating this method is not supported.
+     * @deprecated in 5.0. Use the asynchronous `getSchema` method for schema retrieval.
     */
-    getSchemaSync(schemaKey, matchType, context) {
-        const schemaJson = ECSchemaRpcInterface.getClient().getSchemaJSON(this.token, schemaKey.name).then((props) => {
-            return props;
-        });
-        const schema = Schema.fromJsonSync(schemaJson, context || new SchemaContext());
-        if (schema !== undefined && schema.schemaKey.matches(schemaKey, matchType)) {
-            return schema;
-        }
-        return undefined;
+    getSchemaSync(_schemaKey, _matchType, _context) {
+        throw new Error("getSchemaSync is not supported. Use the asynchronous getSchema method instead.");
     }
 }
 //# sourceMappingURL=ECSchemaRpcLocater.js.map

package/lib/esm/ECSchemaRpcLocater.js.map

@@ -1 +1 @@
-{"version":3,"file":"ECSchemaRpcLocater.js","sourceRoot":"","sources":["../../src/ECSchemaRpcLocater.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAkB,MAAM,EAAE,aAAa,EAAuD,MAAM,0BAA0B,CAAC;AAEtI,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;;GAGG;AACH,MAAM,OAAO,kBAAkB;IACb,KAAK,CAAiB;IAEtC,YAAY,KAAqB,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;IAE1D;;;;;MAKE;IACK,KAAK,CAAC,SAAS,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC7F,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAExD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,MAAM,UAAU,GAAG,MAAM,oBAAoB,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QACpG,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,OAAO,IAAI,IAAI,aAAa,EAAE,CAAC,CAAC;QACjG,IAAI,UAAU,KAAK,SAAS,IAAI,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC;YACnF,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;MAKE;IACK,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC3F,MAAM,UAAU,GAAG,oBAAoB,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,MAAM,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,IAAI,IAAI,aAAa,EAAE,CAAC,CAAC;QAC/E,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC;YAC3E,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF","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, SchemaInfo, 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 * @beta\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(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined> {\n    await this.getSchemaInfo(schemaKey, matchType, context);\n\n    const schema = await context.getCachedSchema(schemaKey, matchType);\n    return schema;\n  }\n\n  /**\n    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\n    * The fully loaded schema can be accessed via the schema context using the getCachedSchema method.\n    * @param schemaKey The SchemaKey describing the schema to get from the cache.\n    * @param matchType The match type to use when locating the schema\n    */\n  public async getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\n    const schemaJson = await ECSchemaRpcInterface.getClient().getSchemaJSON(this.token, schemaKey.name);\n    const schemaInfo = await Schema.startLoadingFromJson(schemaJson, context || new SchemaContext());\n    if (schemaInfo !== undefined && schemaInfo.schemaKey.matches(schemaKey, matchType)) {\n      return schemaInfo;\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(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | 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;\n    }\n    return undefined;\n  }\n}\n"]}
+{"version":3,"file":"ECSchemaRpcLocater.js","sourceRoot":"","sources":["../../src/ECSchemaRpcLocater.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAkB,MAAM,EAAE,aAAa,EAA0C,MAAM,0BAA0B,CAAC;AAEzH,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;;GAGG;AACH,MAAM,OAAO,kBAAkB;IAC7B,gBAAgB;IACA,KAAK,CAAiB;IAEtC,YAAY,KAAqB,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;IAE1D;;;;;MAKE;IACK,KAAK,CAAC,SAAS,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC7F,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAExD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,MAAM,UAAU,GAAG,MAAM,oBAAoB,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QACpG,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,OAAO,IAAI,IAAI,aAAa,EAAE,CAAC,CAAC;QACjG,IAAI,UAAU,KAAK,SAAS,IAAI,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC;YACnF,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;;MAQE;IACK,aAAa,CAAC,UAAqB,EAAE,UAA2B,EAAE,QAAuB;QAC9F,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC;IACpG,CAAC;CACF","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, SchemaInfo, SchemaKey, SchemaMatchType } 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 * @public @preview\n */\nexport class ECSchemaRpcLocater implements ISchemaLocater {\n  /** @internal */\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(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined> {\n    await this.getSchemaInfo(schemaKey, matchType, context);\n\n    const schema = await context.getCachedSchema(schemaKey, matchType);\n    return schema;\n  }\n\n  /**\n    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\n    * The fully loaded schema can be accessed via the schema context using the getCachedSchema method.\n    * @param schemaKey The SchemaKey describing the schema to get from the cache.\n    * @param matchType The match type to use when locating the schema\n    */\n  public async getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\n    const schemaJson = await ECSchemaRpcInterface.getClient().getSchemaJSON(this.token, schemaKey.name);\n    const schemaInfo = await Schema.startLoadingFromJson(schemaJson, context || new SchemaContext());\n    if (schemaInfo !== undefined && schemaInfo.schemaKey.matches(schemaKey, matchType)) {\n      return schemaInfo;\n    }\n    return undefined;\n  }\n\n  /**\n   * This method is not supported for locating schemas over RPC/HTTP.\n   * Use the asynchronous `getSchema` method instead.\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   * @throws Error Always throws an error indicating this method is not supported.\n   * @deprecated in 5.0. Use the asynchronous `getSchema` method for schema retrieval.\n  */\n  public getSchemaSync(_schemaKey: SchemaKey, _matchType: SchemaMatchType, _context: SchemaContext): Schema | undefined {\n    throw new Error(\"getSchemaSync is not supported. Use the asynchronous getSchema method instead.\");\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/ecschema-rpcinterface-common",
-  "version": "5.0.0-dev.99",
+  "version": "5.0.1",
   "description": "Schema RPC Interface common interface",
   "main": "lib/cjs/ecschema-rpc-interface.js",
   "module": "lib/esm/ecschema-rpc-interface.js",
@@ -22,21 +22,21 @@
     "url": "http://www.bentley.com"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "5.0.0-dev.99",
-    "@itwin/core-common": "5.0.0-dev.99",
-    "@itwin/core-geometry": "5.0.0-dev.99",
-    "@itwin/ecschema-metadata": "5.0.0-dev.99"
+    "@itwin/core-bentley": "5.0.1",
+    "@itwin/core-common": "5.0.1",
+    "@itwin/ecschema-metadata": "5.0.1",
+    "@itwin/core-geometry": "5.0.1"
   },
   "devDependencies": {
     "@itwin/eslint-plugin": "5.0.0-dev.1",
     "eslint": "^9.13.0",
     "rimraf": "^6.0.1",
     "typescript": "~5.6.2",
-    "@itwin/build-tools": "5.0.0-dev.99",
-    "@itwin/ecschema-metadata": "5.0.0-dev.99",
-    "@itwin/core-bentley": "5.0.0-dev.99",
-    "@itwin/core-common": "5.0.0-dev.99",
-    "@itwin/core-geometry": "5.0.0-dev.99"
+    "@itwin/build-tools": "5.0.1",
+    "@itwin/core-common": "5.0.1",
+    "@itwin/core-geometry": "5.0.1",
+    "@itwin/core-bentley": "5.0.1",
+    "@itwin/ecschema-metadata": "5.0.1"
   },
   "scripts": {
     "build": "npm run -s build:cjs && npm run -s build:esm",