@itwin/ecschema-locaters 3.5.0-dev.8 → 3.5.1

package/CHANGELOG.md

@@ -1,6 +1,77 @@
 # Change Log - @itwin/ecschema-locaters
 
-This log was last generated on Thu, 01 Sep 2022 14:37:22 GMT and should not be manually modified.
+This log was last generated on Thu, 15 Dec 2022 16:38:29 GMT and should not be manually modified.
+
+## 3.5.1
+Thu, 15 Dec 2022 16:38:29 GMT
+
+_Version update only_
+
+## 3.5.0
+Wed, 07 Dec 2022 19:12:37 GMT
+
+### Updates
+
+- bump up xmldom/xmldom version to avoid prototype pollution
+
+## 3.4.7
+Wed, 30 Nov 2022 14:28:19 GMT
+
+_Version update only_
+
+## 3.4.6
+Tue, 22 Nov 2022 14:24:19 GMT
+
+_Version update only_
+
+## 3.4.5
+Thu, 17 Nov 2022 21:32:50 GMT
+
+_Version update only_
+
+## 3.4.4
+Thu, 10 Nov 2022 19:32:17 GMT
+
+### Updates
+
+- bump xmldom to resolve GHSA-crh6-fp67-6883
+
+## 3.4.3
+Fri, 28 Oct 2022 13:34:58 GMT
+
+_Version update only_
+
+## 3.4.2
+Mon, 24 Oct 2022 13:23:45 GMT
+
+_Version update only_
+
+## 3.4.1
+Mon, 17 Oct 2022 20:06:51 GMT
+
+_Version update only_
+
+## 3.4.0
+Thu, 13 Oct 2022 20:24:47 GMT
+
+### Updates
+
+- Updated Node types declaration to support latest v16
+
+## 3.3.5
+Tue, 27 Sep 2022 11:50:59 GMT
+
+_Version update only_
+
+## 3.3.4
+Thu, 08 Sep 2022 19:00:05 GMT
+
+_Version update only_
+
+## 3.3.3
+Tue, 06 Sep 2022 20:54:19 GMT
+
+_Version update only_
 
 ## 3.3.2
 Thu, 01 Sep 2022 14:37:22 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