New schema locater to locate the standard schemas delivered as part of the core-backend package

common/api/ecschema-locaters.api.md

@@ -20,6 +20,29 @@ export class FileSchemaKey extends SchemaKey {
     schemaText?: string;
 }
 
+// @beta
+export class PublishedSchemaJsonFileLocater extends SchemaJsonFileLocater implements ISchemaLocater {
+    constructor();
+    addSchemaSearchPath(schemaPath: string): void;
+    addSchemaSearchPaths(schemaPaths: string[]): void;
+}
+
+// @beta
+export class PublishedSchemaXmlFileLocater extends SchemaXmlFileLocater implements ISchemaLocater {
+    constructor(knownBackendAssetsDir?: string);
+    addSchemaSearchPath(schemaPath: string): void;
+    addSchemaSearchPaths(schemaPaths: string[]): void;
+}
+
+// @beta
+export class PublishedSchemaXmlStringLocater extends SchemaXmlStringLocater implements ISchemaLocater {
+    constructor(knownBackendAssetsDir?: string);
+    addSchemaString(schemaString: string): void;
+    addSchemaStrings(schemaStrings: string[]): void;
+    // (undocumented)
+    static defaultSchemaSearchPaths: Set<string>;
+}
+
 // @beta
 export abstract class SchemaFileLocater {
     constructor();
@@ -40,6 +63,8 @@ export abstract class SchemaFileLocater {
     // (undocumented)
     readUtf8FileToStringSync(filePath: string): string | undefined;
     // (undocumented)
+    protected searchPathPrecedence: Map<string, number>;
+    // (undocumented)
     searchPaths: string[];
 }
 

common/api/summary/ecschema-locaters.exports.csv

@@ -1,6 +1,9 @@
 sep=;
 Release Tag;API Item Type;API Item Name
 beta;class;FileSchemaKey
+beta;class;PublishedSchemaJsonFileLocater
+beta;class;PublishedSchemaXmlFileLocater
+beta;class;PublishedSchemaXmlStringLocater
 beta;class;SchemaFileLocater
 beta;class;SchemaJsonFileLocater
 beta;namespace;SchemaXml

common/changes/@itwin/ecschema-locaters/rohitptnkr-backend-schemas-file-locater_2024-11-15-10-26.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/ecschema-locaters",
+      "comment": "Implemented new schema locaters PublishedSchemaXmlFileLocater, PublishedSchemaXmlStringLocater, PublishedSchemaJsonFileLocater that will locate/load schemas from published schema xml/json files.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/ecschema-locaters"
+}

common/config/rush/browser-approved-packages.json

@@ -10,6 +10,10 @@
       "name": "@bentley/aec-units-schema",
       "allowedCategories": [ "backend", "internal" ]
     },
+    {
+      "name": "@bentley/analytical-schema",
+      "allowedCategories": [ "backend" ]
+    },
     {
       "name": "@bentley/architectural-physical-schema",
       "allowedCategories": [ "backend" ]
@@ -74,10 +78,18 @@
       "name": "@bentley/core-custom-attributes-schema",
       "allowedCategories": [ "backend" ]
     },
+    {
+      "name": "@bentley/ecdb-file-info-schema",
+      "allowedCategories": [ "backend" ]
+    },
     {
       "name": "@bentley/ecdb-map-schema",
       "allowedCategories": [ "backend" ]
     },
+    {
+      "name": "@bentley/ecdb-meta-schema",
+      "allowedCategories": [ "backend" ]
+    },
     {
       "name": "@bentley/ecdb-schema-policies-schema",
       "allowedCategories": [ "backend" ]
@@ -86,6 +98,14 @@
       "name": "@bentley/formats-schema",
       "allowedCategories": [ "backend" ]
     },
+    {
+      "name": "@bentley/functional-schema",
+      "allowedCategories": [ "backend" ]
+    },
+    {
+      "name": "@bentley/generic-schema",
+      "allowedCategories": [ "backend" ]
+    },
     {
       "name": "@bentley/icons-generic",
       "allowedCategories": [ "internal" ]
@@ -110,6 +130,10 @@
       "name": "@bentley/plant-custom-attributes-schema",
       "allowedCategories": [ "backend", "internal" ]
     },
+    {
+      "name": "@bentley/presentation-rules-schema",
+      "allowedCategories": [ "backend" ]
+    },
     {
       "name": "@bentley/process-functional-schema",
       "allowedCategories": [ "internal" ]
@@ -126,6 +150,10 @@
       "name": "@bentley/road-rail-units-schema",
       "allowedCategories": [ "internal" ]
     },
+    {
+      "name": "@bentley/schema-upgrade-custom-attributes-schema",
+      "allowedCategories": [ "backend" ]
+    },
     {
       "name": "@bentley/spatial-composition-schema",
       "allowedCategories": [ "backend" ]

core/ecschema-locaters/CHANGELOG.md

@@ -281,7 +281,7 @@ Tue, 17 Oct 2023 15:14:32 GMT
 
 ### Updates
 
-- Expose the SchemaFileUtility class to allow users to export in memory Schemas to xml files. 
+- Expose the SchemaFileUtility class to allow users to export in memory Schemas to xml files.
 - extract-api run
 - Export SchemaFileUtility and make beta
 - Change SchemaFileUtility class to SchemaXml namespace, update class names

core/ecschema-locaters/package.json

@@ -36,10 +36,17 @@
     "@bentley/aec-units-schema": "^1.0.3",
     "@bentley/architectural-physical-schema": "^1.0.3",
     "@bentley/bis-core-schema": "^1.0.15",
+    "@bentley/generic-schema": "^1.0.5",
+    "@bentley/analytical-schema": "^1.0.1",
+    "@bentley/functional-schema": "^1.0.4",
+    "@bentley/presentation-rules-schema": "^1.0.1",
+    "@bentley/ecdb-file-info-schema": "^2.0.1",
+    "@bentley/ecdb-meta-schema": "^4.0.3",
+    "@bentley/schema-upgrade-custom-attributes-schema": "^1.0.0",
     "@bentley/bis-custom-attributes-schema": "^1.0.0",
     "@bentley/construction-schema": "^1.0.4",
     "@bentley/core-custom-attributes-schema": "^1.0.4",
-    "@bentley/ecdb-map-schema": "^2.0.1",
+    "@bentley/ecdb-map-schema": "^2.0.4",
     "@bentley/ecdb-schema-policies-schema": "^1.0.1",
     "@bentley/formats-schema": "^1.0.0",
     "@bentley/linear-referencing-schema": "^2.0.3",
@@ -81,4 +88,4 @@
     "extends": "./node_modules/@itwin/build-tools/.nycrc",
     "sourceMap": false
   }
-}
+}

core/ecschema-locaters/src/SchemaFileLocater.ts

@@ -66,6 +66,7 @@ export class FileSchemaKey extends SchemaKey {
  */
 export abstract class SchemaFileLocater {
   public searchPaths: string[];
+  protected searchPathPrecedence = new Map<string, number>();
 
   constructor() {
     this.searchPaths = [];

core/ecschema-locaters/src/SchemaJsonFileLocater.ts

@@ -12,6 +12,7 @@ import {
   ECObjectsError, ECObjectsStatus, ECVersion, ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType,
 } from "@itwin/ecschema-metadata";
 import { FileSchemaKey, SchemaFileLocater } from "./SchemaFileLocater";
+import { globSync } from "glob";
 
 /**
  * A SchemaLocator implementation for locating JSON Schema files
@@ -116,3 +117,49 @@ export class SchemaJsonFileLocater extends SchemaFileLocater implements ISchemaL
     return schema as T;
   }
 }
+
+/**
+ * A SchemaLocator implementation for locating JSON Schema files
+ * from the file system using configurable search paths.
+ * @beta This is a workaround the current lack of a full xml parser.
+ */
+export class PublishedSchemaJsonFileLocater extends SchemaJsonFileLocater implements ISchemaLocater {
+  public constructor() {
+    super();
+
+    globSync(path.join(__dirname, "..", "..", "node_modules", "@bentley", "*-schema"), { windowsPathsNoEscape: true }).forEach((schemaPath) => {
+      if (fs.existsSync(schemaPath)) {
+        this.searchPaths.push(schemaPath);
+
+        // The precedence of the standard schema search paths is set to the lower priority of 1
+        // This is to ensure that user-defined search paths have higher precedence which will be set with the priority of 0
+        this.searchPathPrecedence.set(schemaPath, 1);
+      }
+    });
+  }
+
+  /**
+   * Add one search path to be used by this locator to find the Schema files.
+   * @param schemaPath A search path to add
+   */
+  public override addSchemaSearchPath(schemaPath: string): void {
+    this.addSchemaSearchPaths([schemaPath]);
+  }
+
+  /**
+   * Adds more search paths to be used by this locator to find the Schema files.
+   * @param schemaPaths An array of search paths to add
+   */
+  public override addSchemaSearchPaths(schemaPaths: string[]): void {
+    // Add a schema path if it doesn't exist in the locater's search paths
+    schemaPaths.forEach((schemaPath) => {
+      if (!this.searchPaths.includes(schemaPath) && !this.searchPaths.includes(`\\\\?\\${schemaPath}`)) {
+        this.searchPaths.push(schemaPath);
+
+        // User defined search paths have the highesh precendence/priority of 0
+        if (this.searchPathPrecedence.get(schemaPath) === undefined)
+          this.searchPathPrecedence.set(schemaPath, 0);
+      }
+    });
+  }
+}

core/ecschema-locaters/src/SchemaStringLocater.ts

@@ -35,6 +35,7 @@ export class StringSchemaKey extends SchemaKey {
  */
 export abstract class SchemaStringLocater {
   public schemaStrings: string[];
+  protected searchPathPrecedence = new Map<string, number>();
 
   constructor() {
     this.schemaStrings = [];