@itwin/ecschema-locaters 3.4.0-dev.9 → 3.5.0-dev.4

package/CHANGELOG.md

@@ -1,6 +1,29 @@
 # Change Log - @itwin/ecschema-locaters
 
-This log was last generated on Tue, 09 Aug 2022 15:52:41 GMT and should not be manually modified.
+This log was last generated on Thu, 01 Sep 2022 14:37:22 GMT and should not be manually modified.
+
+## 3.3.2
+Thu, 01 Sep 2022 14:37:22 GMT
+
+_Version update only_
+
+## 3.3.1
+Fri, 26 Aug 2022 15:40:02 GMT
+
+_Version update only_
+
+## 3.3.0
+Thu, 18 Aug 2022 19:08:02 GMT
+
+### Updates
+
+- upgrade mocha to version 10.0.0
+- The new utility method SchemaFileUtility.writeSchemaXmlFile writes an EC Schema to an xml file on the file system.
+
+## 3.2.9
+Fri, 26 Aug 2022 14:21:40 GMT
+
+_Version update only_
 
 ## 3.2.8
 Tue, 09 Aug 2022 15:52:41 GMT

package/lib/cjs/SchemaFileLocater.d.ts

@@ -1,83 +1,83 @@
-import { Schema, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
-/**
- * A SchemaKey implementation that aids in identifying Schema files via the
- * addition of two properties: fileName and schemaText.  The fileName contains the
- * full path to the file on disk and schemaText is the full string representation
- * of the Schema.
- * @beta
- */
-export declare class FileSchemaKey extends SchemaKey {
-    fileName: string;
-    schemaText?: string;
-    /**
-     * Initializes a new FileSchemaKey object.
-     * @param key The EC SchemaKey identifying the Schema.
-     * @param fileName The full path to the Schema file.
-     * @param schemaText The string representation of the Schema
-     * loaded from disk. Optional.
-     */
-    constructor(key: SchemaKey, fileName: string, schemaJson?: string);
-}
-/**
- * Abstract class to hold common/overlapping functionality between SchemaJsonFileLocater and SchemaXmlFileLocater
- * @beta - Needs further testing and possibly moved to a separate package.
- */
-export declare abstract class SchemaFileLocater {
-    searchPaths: string[];
-    constructor();
-    readUtf8FileToString(filePath: string): Promise<string | undefined>;
-    readUtf8FileToStringSync(filePath: string): string | undefined;
-    fileExists(filePath: string): Promise<boolean | undefined>;
-    fileExistsSync(filePath: string): boolean | undefined;
-    /**
-     * Adds more search paths used by this locator to find the
-     * Schema files.
-     * @param schemaPaths An array of search paths to add
-     */
-    addSchemaSearchPaths(schemaPaths: string[]): void;
-    /**
-     * Add one search path used by this locator to find the
-     * Schema files.
-     * @param schemaPath A search path to add
-     */
-    addSchemaSearchPath(schemaPath: string): void;
-    protected abstract getSchemaKey(data: string): SchemaKey;
-    /**
-     * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey. This method
-     * only attempts to find schema files that have no version in the file name.
-     * @param foundFiles The collection of SchemaKeys found in the given directory.
-     * @param schemaPath The directory in which to search for the Schemas.
-     * @param schemaName The short name of the Schema (without version).
-     * @param desiredKey The SchemaKey used to find matching Schema files.
-     * @param matchType The SchemaMatchType to use when comparing the desiredKey and the keys found during the search.
-     * @param format The type of file that the schema key refers to. json or xml
-     */
-    private addCandidateNoExtSchemaKey;
-    /**
-     * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey
-     * @param foundFiles The collection of SchemaKeys found in the given directory
-     * @param schemaPath The directory in which to search for the Schemas
-     * @param fileFilter The file filter, potentially with wildcards, used to locate the Schema files.
-     * @param desiredKey The schemaKey used to find matching Schema files
-     * @param matchType The SchemaMatchType to use when comparing the desired Key and the keys found during the search.
-     * @param format The type of file that the schema key refers to. json or xml
-     */
-    private addCandidateSchemaKeys;
-    /**
-     * Attempts to find all Schema files in the configurable search paths that match
-     * the desired SchemaKey.
-     * @param desiredKey The SchemaKey to match.
-     * @param matchType The SchemaMatchType.
-     * @param format The type of file that the schema key refers to. json or xml
-     */
-    protected findEligibleSchemaKeys(desiredKey: SchemaKey, matchType: SchemaMatchType, format: string): FileSchemaKey[];
-    abstract getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;
-    /**
-     * Compares two Schema versions.  If the left-hand version is greater, 1 is returned. If the
-     * left-hand version is less, -1 us returned.  If the versions are an exact match, 0 is returned.
-     * @param lhs The 'left-hand' FileSchemaKey.
-     * @param rhs The 'right-hand' FileSchemaKey.
-     */
-    compareSchemaKeyByVersion: (lhs: FileSchemaKey, rhs: FileSchemaKey) => number;
-}
+import { Schema, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+/**
+ * A SchemaKey implementation that aids in identifying Schema files via the
+ * addition of two properties: fileName and schemaText.  The fileName contains the
+ * full path to the file on disk and schemaText is the full string representation
+ * of the Schema.
+ * @beta
+ */
+export declare class FileSchemaKey extends SchemaKey {
+    fileName: string;
+    schemaText?: string;
+    /**
+     * Initializes a new FileSchemaKey object.
+     * @param key The EC SchemaKey identifying the Schema.
+     * @param fileName The full path to the Schema file.
+     * @param schemaText The string representation of the Schema
+     * loaded from disk. Optional.
+     */
+    constructor(key: SchemaKey, fileName: string, schemaJson?: string);
+}
+/**
+ * Abstract class to hold common/overlapping functionality between SchemaJsonFileLocater and SchemaXmlFileLocater
+ * @beta - Needs further testing and possibly moved to a separate package.
+ */
+export declare abstract class SchemaFileLocater {
+    searchPaths: string[];
+    constructor();
+    readUtf8FileToString(filePath: string): Promise<string | undefined>;
+    readUtf8FileToStringSync(filePath: string): string | undefined;
+    fileExists(filePath: string): Promise<boolean | undefined>;
+    fileExistsSync(filePath: string): boolean | undefined;
+    /**
+     * Adds more search paths used by this locator to find the
+     * Schema files.
+     * @param schemaPaths An array of search paths to add
+     */
+    addSchemaSearchPaths(schemaPaths: string[]): void;
+    /**
+     * Add one search path used by this locator to find the
+     * Schema files.
+     * @param schemaPath A search path to add
+     */
+    addSchemaSearchPath(schemaPath: string): void;
+    protected abstract getSchemaKey(data: string): SchemaKey;
+    /**
+     * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey. This method
+     * only attempts to find schema files that have no version in the file name.
+     * @param foundFiles The collection of SchemaKeys found in the given directory.
+     * @param schemaPath The directory in which to search for the Schemas.
+     * @param schemaName The short name of the Schema (without version).
+     * @param desiredKey The SchemaKey used to find matching Schema files.
+     * @param matchType The SchemaMatchType to use when comparing the desiredKey and the keys found during the search.
+     * @param format The type of file that the schema key refers to. json or xml
+     */
+    private addCandidateNoExtSchemaKey;
+    /**
+     * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey
+     * @param foundFiles The collection of SchemaKeys found in the given directory
+     * @param schemaPath The directory in which to search for the Schemas
+     * @param fileFilter The file filter, potentially with wildcards, used to locate the Schema files.
+     * @param desiredKey The schemaKey used to find matching Schema files
+     * @param matchType The SchemaMatchType to use when comparing the desired Key and the keys found during the search.
+     * @param format The type of file that the schema key refers to. json or xml
+     */
+    private addCandidateSchemaKeys;
+    /**
+     * Attempts to find all Schema files in the configurable search paths that match
+     * the desired SchemaKey.
+     * @param desiredKey The SchemaKey to match.
+     * @param matchType The SchemaMatchType.
+     * @param format The type of file that the schema key refers to. json or xml
+     */
+    protected findEligibleSchemaKeys(desiredKey: SchemaKey, matchType: SchemaMatchType, format: string): FileSchemaKey[];
+    abstract getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;
+    /**
+     * Compares two Schema versions.  If the left-hand version is greater, 1 is returned. If the
+     * left-hand version is less, -1 us returned.  If the versions are an exact match, 0 is returned.
+     * @param lhs The 'left-hand' FileSchemaKey.
+     * @param rhs The 'right-hand' FileSchemaKey.
+     */
+    compareSchemaKeyByVersion: (lhs: FileSchemaKey, rhs: FileSchemaKey) => number;
+}
 //# sourceMappingURL=SchemaFileLocater.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SchemaFileLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaFileLocater.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAwB7F;;;;;;GAMG;AACH,qBAAa,aAAc,SAAQ,SAAS;IAEnC,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;OAMG;gBACS,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM;CAKlE;AAED;;;GAGG;AACH,8BAAsB,iBAAiB;IAC9B,WAAW,EAAE,MAAM,EAAE,CAAC;;IAMhB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAWzE,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAIxD,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAQhE,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI5D;;;;OAIG;IACI,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE;IAMjD;;;;OAIG;IACI,mBAAmB,CAAC,UAAU,EAAE,MAAM;IAM7C,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAExD;;;;;;;;;OASG;IACH,OAAO,CAAC,0BAA0B;IAkBlC;;;;;;;;OAQG;IACH,OAAO,CAAC,sBAAsB;IAwB9B;;;;;;OAMG;IACH,SAAS,CAAC,sBAAsB,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,GAAG,aAAa,EAAE;aAmCpG,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAEvI;;;;;OAKG;IACI,yBAAyB,QAAS,aAAa,OAAO,aAAa,KAAG,MAAM,CAEjF;CACH"}
+{"version":3,"file":"SchemaFileLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaFileLocater.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AA4B7F;;;;;;GAMG;AACH,qBAAa,aAAc,SAAQ,SAAS;IAEnC,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;OAMG;gBACS,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM;CAKlE;AAED;;;GAGG;AACH,8BAAsB,iBAAiB;IAC9B,WAAW,EAAE,MAAM,EAAE,CAAC;;IAMhB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAWzE,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAIxD,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAQhE,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI5D;;;;OAIG;IACI,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE;IAMjD;;;;OAIG;IACI,mBAAmB,CAAC,UAAU,EAAE,MAAM;IAM7C,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAExD;;;;;;;;;OASG;IACH,OAAO,CAAC,0BAA0B;IAoBlC;;;;;;;;OAQG;IACH,OAAO,CAAC,sBAAsB;IAwB9B;;;;;;OAMG;IACH,SAAS,CAAC,sBAAsB,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,GAAG,aAAa,EAAE;aAmCpG,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAEvI;;;;;OAKG;IACI,yBAAyB,QAAS,aAAa,OAAO,aAAa,KAAG,MAAM,CAEjF;CACH"}