npm - @rushstack/lookup-by-path - Versions diffs - 0.4.7 → 0.5.1 - Mend

@rushstack/lookup-by-path 0.4.7 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/CHANGELOG.json +24 -0
package/CHANGELOG.md +14 -1
package/dist/lookup-by-path.d.ts +101 -10
package/dist/tsdoc-metadata.json +1 -1
package/lib/LookupByPath.d.ts +101 -10
package/lib/LookupByPath.d.ts.map +1 -1
package/lib/LookupByPath.js +114 -8
package/lib/LookupByPath.js.map +1 -1
package/package.json +2 -2

package/CHANGELOG.json CHANGED Viewed

@@ -1,6 +1,30 @@
 {
   "name": "@rushstack/lookup-by-path",
   "entries": [
+    {
+      "version": "0.5.1",
+      "tag": "@rushstack/lookup-by-path_v0.5.1",
+      "date": "Tue, 07 Jan 2025 22:17:32 GMT",
+      "comments": {
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/heft\" to `0.68.12`"
+          }
+        ]
+      }
+    },
+    {
+      "version": "0.5.0",
+      "tag": "@rushstack/lookup-by-path_v0.5.0",
+      "date": "Wed, 18 Dec 2024 01:11:33 GMT",
+      "comments": {
+        "minor": [
+          {
+            "comment": "Update all methods to accept optional override delimiters. Add `size`, `entries(), `get()`, `has()`, `removeItem()`. Make class iterable.\nExplicitly exclude `undefined` and `null` from the allowed types for the type parameter `TItem`."
+          }
+        ]
+      }
+    },
     {
       "version": "0.4.7",
       "tag": "@rushstack/lookup-by-path_v0.4.7",

package/CHANGELOG.md CHANGED Viewed

@@ -1,6 +1,19 @@
 # Change Log - @rushstack/lookup-by-path
-This log was last generated on Sat, 14 Dec 2024 01:11:07 GMT and should not be manually modified.
+This log was last generated on Tue, 07 Jan 2025 22:17:32 GMT and should not be manually modified.
+## 0.5.1
+Tue, 07 Jan 2025 22:17:32 GMT
+_Version update only_
+## 0.5.0
+Wed, 18 Dec 2024 01:11:33 GMT
+### Minor changes
+- Update all methods to accept optional override delimiters. Add `size`, `entries(), `get()`, `has()`, `removeItem()`. Make class iterable.
+Explicitly exclude `undefined` and `null` from the allowed types for the type parameter `TItem`.
 ## 0.4.7
 Sat, 14 Dec 2024 01:11:07 GMT

package/dist/lookup-by-path.d.ts CHANGED Viewed

@@ -9,7 +9,7 @@
  *
  * @beta
  */
-export declare interface IPrefixMatch<TItem> {
+export declare interface IPrefixMatch<TItem extends {}> {
     /**
      * The item that matched the prefix
      */
@@ -29,7 +29,7 @@ export declare interface IPrefixMatch<TItem> {
  *
  * @beta
  */
-export declare interface IReadonlyLookupByPath<TItem> {
+export declare interface IReadonlyLookupByPath<TItem extends {}> extends Iterable<[string, TItem]> {
     /**
      * Searches for the item associated with `childPath`, or the nearest ancestor of that path that
      * has an associated item.
@@ -43,7 +43,7 @@ export declare interface IReadonlyLookupByPath<TItem> {
      * trie.findChildPath('foo/bar/baz'); // returns 2
      * ```
      */
-    findChildPath(childPath: string): TItem | undefined;
+    findChildPath(childPath: string, delimiter?: string): TItem | undefined;
     /**
      * Searches for the item for which the recorded prefix is the longest matching prefix of `query`.
      * Obtains both the item and the length of the matched prefix, so that the remainder of the path can be
@@ -58,7 +58,7 @@ export declare interface IReadonlyLookupByPath<TItem> {
      * trie.findLongestPrefixMatch('foo/bar/baz'); // returns { item: 2, index: 7 }
      * ```
      */
-    findLongestPrefixMatch(query: string): IPrefixMatch<TItem> | undefined;
+    findLongestPrefixMatch(query: string, delimiter?: string): IPrefixMatch<TItem> | undefined;
     /**
      * Searches for the item associated with `childPathSegments`, or the nearest ancestor of that path that
      * has an associated item.
@@ -73,6 +73,51 @@ export declare interface IReadonlyLookupByPath<TItem> {
      * ```
      */
     findChildPathFromSegments(childPathSegments: Iterable<string>): TItem | undefined;
+    /**
+     * Determines if an entry exists exactly at the specified path.
+     *
+     * @returns `true` if an entry exists at the specified path, `false` otherwise
+     */
+    has(query: string, delimiter?: string): boolean;
+    /**
+     * Retrieves the entry that exists exactly at the specified path, if any.
+     *
+     * @returns The entry that exists exactly at the specified path, or `undefined` if no entry exists.
+     */
+    get(query: string, delimiter?: string): TItem | undefined;
+    /**
+     * Gets the number of entries in this trie.
+     *
+     * @returns The number of entries in this trie.
+     */
+    get size(): number;
+    /**
+     * Iterates over the entries in this trie.
+     *
+     * @param query - An optional query. If specified only entries that start with the query will be returned.
+     *
+     * @returns An iterator over the entries under the specified query (or the root if no query is specified).
+     * @remarks
+     * Keys in the returned iterator use the provided delimiter to join segments.
+     * Iteration order is not specified.
+     * @example
+     * ```ts
+     * const trie = new LookupByPath([['foo', 1], ['foo/bar', 2]]);
+     * [...trie.entries(undefined, ',')); // returns [['foo', 1], ['foo,bar', 2]]
+     * ```
+     */
+    entries(query?: string, delimiter?: string): IterableIterator<[string, TItem]>;
+    /**
+     * Iterates over the entries in this trie.
+     *
+     * @param query - An optional query. If specified only entries that start with the query will be returned.
+     *
+     * @returns An iterator over the entries under the specified query (or the root if no query is specified).
+     * @remarks
+     * Keys in the returned iterator use the provided delimiter to join segments.
+     * Iteration order is not specified.
+     */
+    [Symbol.iterator](query?: string, delimiter?: string): IterableIterator<[string, TItem]>;
     /**
      * Groups the provided map of info by the nearest entry in the trie that contains the path. If the path
      * is not found in the trie, the info is ignored.
@@ -81,7 +126,7 @@ export declare interface IReadonlyLookupByPath<TItem> {
      *
      * @param infoByPath - The info to be grouped, keyed by path
      */
-    groupByChild<TInfo>(infoByPath: Map<string, TInfo>): Map<TItem, Map<string, TInfo>>;
+    groupByChild<TInfo>(infoByPath: Map<string, TInfo>, delimiter?: string): Map<TItem, Map<string, TInfo>>;
 }
 /**
@@ -104,7 +149,7 @@ export declare interface IReadonlyLookupByPath<TItem> {
  * ```
  * @beta
  */
-export declare class LookupByPath<TItem> implements IReadonlyLookupByPath<TItem> {
+export declare class LookupByPath<TItem extends {}> implements IReadonlyLookupByPath<TItem> {
     /**
      * The delimiter used to split paths
      */
@@ -113,6 +158,10 @@ export declare class LookupByPath<TItem> implements IReadonlyLookupByPath<TItem>
      * The root node of the trie, corresponding to the path ''
      */
     private readonly _root;
+    /**
+     * The number of entries in this trie.
+     */
+    private _size;
     /**
      * Constructs a new `LookupByPath`
      *
@@ -130,13 +179,32 @@ export declare class LookupByPath<TItem> implements IReadonlyLookupByPath<TItem>
      */
     static iteratePathSegments(serializedPath: string, delimiter?: string): Iterable<string>;
     private static _iteratePrefixes;
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    get size(): number;
+    /**
+     * Deletes all entries from this `LookupByPath` instance.
+     *
+     * @returns this, for chained calls
+     */
+    clear(): this;
     /**
      * Associates the value with the specified serialized path.
      * If a value is already associated, will overwrite.
      *
      * @returns this, for chained calls
      */
-    setItem(serializedPath: string, value: TItem): this;
+    setItem(serializedPath: string, value: TItem, delimiter?: string): this;
+    /**
+     * Deletes an item if it exists.
+     * @param query - The path to the item to delete
+     * @param delimeter - Optional override delimeter for parsing the query
+     * @returns `true` if the item was found and deleted, `false` otherwise
+     * @remarks
+     * If the node has children with values, they will be retained.
+     */
+    deleteItem(query: string, delimeter?: string): boolean;
     /**
      * Associates the value with the specified path.
      * If a value is already associated, will overwrite.
@@ -147,11 +215,11 @@ export declare class LookupByPath<TItem> implements IReadonlyLookupByPath<TItem>
     /**
      * {@inheritdoc IReadonlyLookupByPath}
      */
-    findChildPath(childPath: string): TItem | undefined;
+    findChildPath(childPath: string, delimiter?: string): TItem | undefined;
     /**
      * {@inheritdoc IReadonlyLookupByPath}
      */
-    findLongestPrefixMatch(query: string): IPrefixMatch<TItem> | undefined;
+    findLongestPrefixMatch(query: string, delimiter?: string): IPrefixMatch<TItem> | undefined;
     /**
      * {@inheritdoc IReadonlyLookupByPath}
      */
@@ -159,7 +227,23 @@ export declare class LookupByPath<TItem> implements IReadonlyLookupByPath<TItem>
     /**
      * {@inheritdoc IReadonlyLookupByPath}
      */
-    groupByChild<TInfo>(infoByPath: Map<string, TInfo>): Map<TItem, Map<string, TInfo>>;
+    has(key: string, delimiter?: string): boolean;
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    get(key: string, delimiter?: string): TItem | undefined;
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    groupByChild<TInfo>(infoByPath: Map<string, TInfo>, delimiter?: string): Map<TItem, Map<string, TInfo>>;
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    entries(query?: string, delimiter?: string): IterableIterator<[string, TItem]>;
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    [Symbol.iterator](query?: string, delimiter?: string): IterableIterator<[string, TItem]>;
     /**
      * Iterates through progressively longer prefixes of a given string and returns as soon
      * as the number of candidate items that match the prefix are 1 or 0.
@@ -169,6 +253,13 @@ export declare class LookupByPath<TItem> implements IReadonlyLookupByPath<TItem>
      * @returns the found item, or `undefined` if no item was found
      */
     private _findLongestPrefixMatch;
+    /**
+     * Finds the node at the specified path, or `undefined` if no node was found.
+     *
+     * @param query - The path to the node to search for
+     * @returns The trie node at the specified path, or `undefined` if no node was found
+     */
+    private _findNodeAtPrefix;
 }
 export { }

package/dist/tsdoc-metadata.json CHANGED Viewed

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.48.0"
+      "packageVersion": "7.48.1"
     }
   ]
 }

package/lib/LookupByPath.d.ts CHANGED Viewed

@@ -3,7 +3,7 @@
  *
  * @beta
  */
-export interface IPrefixMatch<TItem> {
+export interface IPrefixMatch<TItem extends {}> {
     /**
      * The item that matched the prefix
      */
@@ -22,7 +22,7 @@ export interface IPrefixMatch<TItem> {
  *
  * @beta
  */
-export interface IReadonlyLookupByPath<TItem> {
+export interface IReadonlyLookupByPath<TItem extends {}> extends Iterable<[string, TItem]> {
     /**
      * Searches for the item associated with `childPath`, or the nearest ancestor of that path that
      * has an associated item.
@@ -36,7 +36,7 @@ export interface IReadonlyLookupByPath<TItem> {
      * trie.findChildPath('foo/bar/baz'); // returns 2
      * ```
      */
-    findChildPath(childPath: string): TItem | undefined;
+    findChildPath(childPath: string, delimiter?: string): TItem | undefined;
     /**
      * Searches for the item for which the recorded prefix is the longest matching prefix of `query`.
      * Obtains both the item and the length of the matched prefix, so that the remainder of the path can be
@@ -51,7 +51,7 @@ export interface IReadonlyLookupByPath<TItem> {
      * trie.findLongestPrefixMatch('foo/bar/baz'); // returns { item: 2, index: 7 }
      * ```
      */
-    findLongestPrefixMatch(query: string): IPrefixMatch<TItem> | undefined;
+    findLongestPrefixMatch(query: string, delimiter?: string): IPrefixMatch<TItem> | undefined;
     /**
      * Searches for the item associated with `childPathSegments`, or the nearest ancestor of that path that
      * has an associated item.
@@ -66,6 +66,51 @@ export interface IReadonlyLookupByPath<TItem> {
      * ```
      */
     findChildPathFromSegments(childPathSegments: Iterable<string>): TItem | undefined;
+    /**
+     * Determines if an entry exists exactly at the specified path.
+     *
+     * @returns `true` if an entry exists at the specified path, `false` otherwise
+     */
+    has(query: string, delimiter?: string): boolean;
+    /**
+     * Retrieves the entry that exists exactly at the specified path, if any.
+     *
+     * @returns The entry that exists exactly at the specified path, or `undefined` if no entry exists.
+     */
+    get(query: string, delimiter?: string): TItem | undefined;
+    /**
+     * Gets the number of entries in this trie.
+     *
+     * @returns The number of entries in this trie.
+     */
+    get size(): number;
+    /**
+     * Iterates over the entries in this trie.
+     *
+     * @param query - An optional query. If specified only entries that start with the query will be returned.
+     *
+     * @returns An iterator over the entries under the specified query (or the root if no query is specified).
+     * @remarks
+     * Keys in the returned iterator use the provided delimiter to join segments.
+     * Iteration order is not specified.
+     * @example
+     * ```ts
+     * const trie = new LookupByPath([['foo', 1], ['foo/bar', 2]]);
+     * [...trie.entries(undefined, ',')); // returns [['foo', 1], ['foo,bar', 2]]
+     * ```
+     */
+    entries(query?: string, delimiter?: string): IterableIterator<[string, TItem]>;
+    /**
+     * Iterates over the entries in this trie.
+     *
+     * @param query - An optional query. If specified only entries that start with the query will be returned.
+     *
+     * @returns An iterator over the entries under the specified query (or the root if no query is specified).
+     * @remarks
+     * Keys in the returned iterator use the provided delimiter to join segments.
+     * Iteration order is not specified.
+     */
+    [Symbol.iterator](query?: string, delimiter?: string): IterableIterator<[string, TItem]>;
     /**
      * Groups the provided map of info by the nearest entry in the trie that contains the path. If the path
      * is not found in the trie, the info is ignored.
@@ -74,7 +119,7 @@ export interface IReadonlyLookupByPath<TItem> {
      *
      * @param infoByPath - The info to be grouped, keyed by path
      */
-    groupByChild<TInfo>(infoByPath: Map<string, TInfo>): Map<TItem, Map<string, TInfo>>;
+    groupByChild<TInfo>(infoByPath: Map<string, TInfo>, delimiter?: string): Map<TItem, Map<string, TInfo>>;
 }
 /**
  * This class is used to associate path-like-strings, such as those returned by `git` commands,
@@ -96,7 +141,7 @@ export interface IReadonlyLookupByPath<TItem> {
  * ```
  * @beta
  */
-export declare class LookupByPath<TItem> implements IReadonlyLookupByPath<TItem> {
+export declare class LookupByPath<TItem extends {}> implements IReadonlyLookupByPath<TItem> {
     /**
      * The delimiter used to split paths
      */
@@ -105,6 +150,10 @@ export declare class LookupByPath<TItem> implements IReadonlyLookupByPath<TItem>
      * The root node of the trie, corresponding to the path ''
      */
     private readonly _root;
+    /**
+     * The number of entries in this trie.
+     */
+    private _size;
     /**
      * Constructs a new `LookupByPath`
      *
@@ -122,13 +171,32 @@ export declare class LookupByPath<TItem> implements IReadonlyLookupByPath<TItem>
      */
     static iteratePathSegments(serializedPath: string, delimiter?: string): Iterable<string>;
     private static _iteratePrefixes;
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    get size(): number;
+    /**
+     * Deletes all entries from this `LookupByPath` instance.
+     *
+     * @returns this, for chained calls
+     */
+    clear(): this;
     /**
      * Associates the value with the specified serialized path.
      * If a value is already associated, will overwrite.
      *
      * @returns this, for chained calls
      */
-    setItem(serializedPath: string, value: TItem): this;
+    setItem(serializedPath: string, value: TItem, delimiter?: string): this;
+    /**
+     * Deletes an item if it exists.
+     * @param query - The path to the item to delete
+     * @param delimeter - Optional override delimeter for parsing the query
+     * @returns `true` if the item was found and deleted, `false` otherwise
+     * @remarks
+     * If the node has children with values, they will be retained.
+     */
+    deleteItem(query: string, delimeter?: string): boolean;
     /**
      * Associates the value with the specified path.
      * If a value is already associated, will overwrite.
@@ -139,11 +207,11 @@ export declare class LookupByPath<TItem> implements IReadonlyLookupByPath<TItem>
     /**
      * {@inheritdoc IReadonlyLookupByPath}
      */
-    findChildPath(childPath: string): TItem | undefined;
+    findChildPath(childPath: string, delimiter?: string): TItem | undefined;
     /**
      * {@inheritdoc IReadonlyLookupByPath}
      */
-    findLongestPrefixMatch(query: string): IPrefixMatch<TItem> | undefined;
+    findLongestPrefixMatch(query: string, delimiter?: string): IPrefixMatch<TItem> | undefined;
     /**
      * {@inheritdoc IReadonlyLookupByPath}
      */
@@ -151,7 +219,23 @@ export declare class LookupByPath<TItem> implements IReadonlyLookupByPath<TItem>
     /**
      * {@inheritdoc IReadonlyLookupByPath}
      */
-    groupByChild<TInfo>(infoByPath: Map<string, TInfo>): Map<TItem, Map<string, TInfo>>;
+    has(key: string, delimiter?: string): boolean;
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    get(key: string, delimiter?: string): TItem | undefined;
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    groupByChild<TInfo>(infoByPath: Map<string, TInfo>, delimiter?: string): Map<TItem, Map<string, TInfo>>;
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    entries(query?: string, delimiter?: string): IterableIterator<[string, TItem]>;
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    [Symbol.iterator](query?: string, delimiter?: string): IterableIterator<[string, TItem]>;
     /**
      * Iterates through progressively longer prefixes of a given string and returns as soon
      * as the number of candidate items that match the prefix are 1 or 0.
@@ -161,5 +245,12 @@ export declare class LookupByPath<TItem> implements IReadonlyLookupByPath<TItem>
      * @returns the found item, or `undefined` if no item was found
      */
     private _findLongestPrefixMatch;
+    /**
+     * Finds the node at the specified path, or `undefined` if no node was found.
+     *
+     * @param query - The path to the node to search for
+     * @returns The trie node at the specified path, or `undefined` if no node was found
+     */
+    private _findNodeAtPrefix;
 }
 //# sourceMappingURL=LookupByPath.d.ts.map

package/lib/LookupByPath.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"LookupByPath.d.ts","sourceRoot":"","sources":["../src/LookupByPath.ts"],"names":[],"mappings":"~~AA4BA~~;;;;GAIG;AACH,MAAM,WAAW,YAAY,CAAC,KAAK;~~IACjC~~;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;~~IACb~~;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;~~IACd~~;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB,CAAC,KAAK;~~IAC1C~~;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAAC;~~IAEpD~~;;;;;;;;;;;;;OAaG;IACH,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;~~IAEvE~~;;;;;;;;;;;;OAYG;IACH,yBAAyB,CAAC,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,KAAK,GAAG,SAAS,CAAC;IAElF;;;;;;;OAOG;IACH,YAAY,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;~~CACrF~~;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,YAAY,CAAC,KAAK,CAAE,YAAW,qBAAqB,CAAC,KAAK,CAAC;~~IACtE~~;;OAEG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;~~IAClC~~;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuB;IAE7C;;;;OAIG;gBACgB,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,MAAM;~~IAe1E~~;;;;;;;;OAQG;WACY,mBAAmB,CAAC,cAAc,EAAE,MAAM,EAAE,SAAS,GAAE,MAAY,GAAG,QAAQ,CAAC,MAAM,CAAC;IAMrG,OAAO,CAAC,MAAM,CAAE,gBAAgB;IA2BhC;;;;;OAKG;IACI,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;~~IAI1D~~;;;;;OAKG;IACI,mBAAmB,CAAC,YAAY,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;~~IAuB9E~~;;OAEG;IACI,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;~~IAI1D~~;;OAEG;IACI,sBAAsB,~~CAAC~~,KAAK,EAAE,MAAM,~~GAAG~~,YAAY,CAAC,KAAK,CAAC,GAAG,SAAS;~~IAI7E~~;;OAEG;IACI,yBAAyB,CAAC,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,KAAK,GAAG,SAAS;IAqBxF;;OAEG;IACI,YAAY,CAAC,KAAK,~~EAAE~~,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;~~IAmB1F~~;;;;;;;OAOG;IACH,OAAO,CAAC,uBAAuB;~~CAgChC~~"}
1	+ {"version":3,"file":"LookupByPath.d.ts","sourceRoot":"","sources":["../src/LookupByPath.ts"],"names":[],"mappings":"AA8BA;;;;GAIG;AACH,MAAM,WAAW,YAAY,CAAC,KAAK,SAAS,EAAE;IAC5C;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB,CAAC,KAAK,SAAS,EAAE,CAAE,SAAQ,QAAQ,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACxF;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAAC;IAExE;;;;;;;;;;;;;OAaG;IACH,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IAE3F;;;;;;;;;;;;OAYG;IACH,yBAAyB,CAAC,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,KAAK,GAAG,SAAS,CAAC;IAElF;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEhD;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAAC;IAE1D;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAAC;IAEnB;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAE/E;;;;;;;;;OASG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAEzF;;;;;;;OAOG;IACH,YAAY,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;CACzG;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,YAAY,CAAC,KAAK,SAAS,EAAE,CAAE,YAAW,qBAAqB,CAAC,KAAK,CAAC;IACjF;;OAEG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuB;IAE7C;;OAEG;IACH,OAAO,CAAC,KAAK,CAAS;IAEtB;;;;OAIG;gBACgB,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,MAAM;IAgB1E;;;;;;;;OAQG;WACY,mBAAmB,CAAC,cAAc,EAAE,MAAM,EAAE,SAAS,GAAE,MAAY,GAAG,QAAQ,CAAC,MAAM,CAAC;IAMrG,OAAO,CAAC,MAAM,CAAE,gBAAgB;IA2BhC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;;OAIG;IACI,KAAK,IAAI,IAAI;IAOpB;;;;;OAKG;IACI,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,GAAE,MAAuB,GAAG,IAAI;IAI9F;;;;;;;OAOG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,GAAE,MAAuB,GAAG,OAAO;IAW7E;;;;;OAKG;IACI,mBAAmB,CAAC,YAAY,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;IA0B9E;;OAEG;IACI,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,GAAE,MAAuB,GAAG,KAAK,GAAG,SAAS;IAI9F;;OAEG;IACI,sBAAsB,CAC3B,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,MAAuB,GACjC,YAAY,CAAC,KAAK,CAAC,GAAG,SAAS;IAIlC;;OAEG;IACI,yBAAyB,CAAC,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,KAAK,GAAG,SAAS;IAqBxF;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,GAAE,MAAuB,GAAG,OAAO;IAKpE;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,GAAE,MAAuB,GAAG,KAAK,GAAG,SAAS;IAK9E;;OAEG;IACI,YAAY,CAAC,KAAK,EACvB,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,EAC9B,SAAS,GAAE,MAAuB,GACjC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAmBjC;;OAEG;IACK,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,GAAE,MAAuB,GAAG,gBAAgB,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IA0BtG;;OAEG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC,CACtB,KAAK,CAAC,EAAE,MAAM,EACd,SAAS,GAAE,MAAuB,GACjC,gBAAgB,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAIpC;;;;;;;OAOG;IACH,OAAO,CAAC,uBAAuB;IAiC/B;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;CAiB1B"}

package/lib/LookupByPath.js CHANGED Viewed

@@ -35,6 +35,7 @@ class LookupByPath {
             children: undefined
         };
         this.delimiter = delimiter !== null && delimiter !== void 0 ? delimiter : '/';
+        this._size = 0;
         if (entries) {
             for (const [path, item] of entries) {
                 this.setItem(path, item);
@@ -78,14 +79,48 @@ class LookupByPath {
             };
         }
     }
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    get size() {
+        return this._size;
+    }
+    /**
+     * Deletes all entries from this `LookupByPath` instance.
+     *
+     * @returns this, for chained calls
+     */
+    clear() {
+        this._root.value = undefined;
+        this._root.children = undefined;
+        this._size = 0;
+        return this;
+    }
     /**
      * Associates the value with the specified serialized path.
      * If a value is already associated, will overwrite.
      *
      * @returns this, for chained calls
      */
-    setItem(serializedPath, value) {
-        return this.setItemFromSegments(LookupByPath.iteratePathSegments(serializedPath, this.delimiter), value);
+    setItem(serializedPath, value, delimiter = this.delimiter) {
+        return this.setItemFromSegments(LookupByPath.iteratePathSegments(serializedPath, delimiter), value);
+    }
+    /**
+     * Deletes an item if it exists.
+     * @param query - The path to the item to delete
+     * @param delimeter - Optional override delimeter for parsing the query
+     * @returns `true` if the item was found and deleted, `false` otherwise
+     * @remarks
+     * If the node has children with values, they will be retained.
+     */
+    deleteItem(query, delimeter = this.delimiter) {
+        const node = this._findNodeAtPrefix(query, delimeter);
+        if ((node === null || node === void 0 ? void 0 : node.value) !== undefined) {
+            node.value = undefined;
+            this._size--;
+            return true;
+        }
+        return false;
     }
     /**
      * Associates the value with the specified path.
@@ -108,20 +143,23 @@ class LookupByPath {
             }
             node = child;
         }
+        if (node.value === undefined) {
+            this._size++;
+        }
         node.value = value;
         return this;
     }
     /**
      * {@inheritdoc IReadonlyLookupByPath}
      */
-    findChildPath(childPath) {
-        return this.findChildPathFromSegments(LookupByPath.iteratePathSegments(childPath, this.delimiter));
+    findChildPath(childPath, delimiter = this.delimiter) {
+        return this.findChildPathFromSegments(LookupByPath.iteratePathSegments(childPath, delimiter));
     }
     /**
      * {@inheritdoc IReadonlyLookupByPath}
      */
-    findLongestPrefixMatch(query) {
-        return this._findLongestPrefixMatch(LookupByPath._iteratePrefixes(query, this.delimiter));
+    findLongestPrefixMatch(query, delimiter = this.delimiter) {
+        return this._findLongestPrefixMatch(LookupByPath._iteratePrefixes(query, delimiter));
     }
     /**
      * {@inheritdoc IReadonlyLookupByPath}
@@ -149,10 +187,24 @@ class LookupByPath {
     /**
      * {@inheritdoc IReadonlyLookupByPath}
      */
-    groupByChild(infoByPath) {
+    has(key, delimiter = this.delimiter) {
+        const match = this.findLongestPrefixMatch(key, delimiter);
+        return (match === null || match === void 0 ? void 0 : match.index) === key.length;
+    }
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    get(key, delimiter = this.delimiter) {
+        const match = this.findLongestPrefixMatch(key, delimiter);
+        return (match === null || match === void 0 ? void 0 : match.index) === key.length ? match.value : undefined;
+    }
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    groupByChild(infoByPath, delimiter = this.delimiter) {
         const groupedInfoByChild = new Map();
         for (const [path, info] of infoByPath) {
-            const child = this.findChildPath(path);
+            const child = this.findChildPath(path, delimiter);
             if (child === undefined) {
                 continue;
             }
@@ -165,6 +217,40 @@ class LookupByPath {
         }
         return groupedInfoByChild;
     }
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    *entries(query, delimiter = this.delimiter) {
+        let root;
+        if (query) {
+            root = this._findNodeAtPrefix(query, delimiter);
+            if (!root) {
+                return;
+            }
+        }
+        else {
+            root = this._root;
+        }
+        const stack = [[query !== null && query !== void 0 ? query : '', root]];
+        while (stack.length > 0) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const [prefix, node] = stack.pop();
+            if (node.value !== undefined) {
+                yield [prefix, node.value];
+            }
+            if (node.children) {
+                for (const [segment, child] of node.children) {
+                    stack.push([prefix ? `${prefix}${delimiter}${segment}` : segment, child]);
+                }
+            }
+        }
+    }
+    /**
+     * {@inheritdoc IReadonlyLookupByPath}
+     */
+    [Symbol.iterator](query, delimiter = this.delimiter) {
+        return this.entries(query, delimiter);
+    }
     /**
      * Iterates through progressively longer prefixes of a given string and returns as soon
      * as the number of candidate items that match the prefix are 1 or 0.
@@ -204,6 +290,26 @@ class LookupByPath {
         }
         return best;
     }
+    /**
+     * Finds the node at the specified path, or `undefined` if no node was found.
+     *
+     * @param query - The path to the node to search for
+     * @returns The trie node at the specified path, or `undefined` if no node was found
+     */
+    _findNodeAtPrefix(query, delimiter = this.delimiter) {
+        let node = this._root;
+        for (const { prefix } of LookupByPath._iteratePrefixes(query, delimiter)) {
+            if (!node.children) {
+                return undefined;
+            }
+            const child = node.children.get(prefix);
+            if (!child) {
+                return undefined;
+            }
+            node = child;
+        }
+        return node;
+    }
 }
 exports.LookupByPath = LookupByPath;
 //# sourceMappingURL=LookupByPath.js.map

package/lib/LookupByPath.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"LookupByPath.js","sourceRoot":"","sources":["../src/LookupByPath.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AA8G3D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,YAAY;IAUvB;;;;OAIG;IACH,YAAmB,OAAmC,EAAE,SAAkB;QACxE,IAAI,CAAC,KAAK,GAAG;YACX,KAAK,EAAE,SAAS;YAChB,QAAQ,EAAE,SAAS;SACpB,CAAC;QAEF,IAAI,CAAC,SAAS,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,GAAG,CAAC;QAElC,IAAI,OAAO,EAAE,CAAC;YACZ,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,OAAO,EAAE,CAAC;gBACnC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,CAAC,mBAAmB,CAAC,cAAsB,EAAE,YAAoB,GAAG;QAChF,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,SAAS,CAAC,EAAE,CAAC;YAC3E,MAAM,WAAW,CAAC,MAAM,CAAC;QAC3B,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,CAAC,gBAAgB,CAAC,KAAa,EAAE,YAAoB,GAAG;QACrE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO;QACT,CAAC;QAED,IAAI,aAAa,GAAW,CAAC,CAAC;QAC9B,IAAI,SAAS,GAAW,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAEjD,mBAAmB;QACnB,OAAO,SAAS,IAAI,CAAC,EAAE,CAAC;YACtB,MAAM;gBACJ,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,aAAa,EAAE,SAAS,CAAC;gBAC7C,KAAK,EAAE,SAAS;aACjB,CAAC;YACF,aAAa,GAAG,SAAS,GAAG,CAAC,CAAC;YAC9B,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QACtD,CAAC;QAED,eAAe;QACf,IAAI,aAAa,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;YACjC,MAAM;gBACJ,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC;gBAChD,KAAK,EAAE,KAAK,CAAC,MAAM;aACpB,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,cAAsB,EAAE,KAAY;QACjD,OAAO,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,mBAAmB,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;OAKG;IACI,mBAAmB,CAAC,YAA8B,EAAE,KAAY;QACrE,IAAI,IAAI,GAAyB,IAAI,CAAC,KAAK,CAAC;QAC5C,KAAK,MAAM,OAAO,IAAI,YAAY,EAAE,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;YAC5B,CAAC;YACD,IAAI,KAAK,GAAqC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACzE,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,IAAI,CAAC,QAAQ,CAAC,GAAG,CACf,OAAO,EACP,CAAC,KAAK,GAAG;oBACP,KAAK,EAAE,SAAS;oBAChB,QAAQ,EAAE,SAAS;iBACpB,CAAC,CACH,CAAC;YACJ,CAAC;YACD,IAAI,GAAG,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAEnB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,SAAiB;QACpC,OAAO,IAAI,CAAC,yBAAyB,CAAC,YAAY,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACI,sBAAsB,CAAC,KAAa;QACzC,OAAO,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAC5F,CAAC;IAED;;OAEG;IACI,yBAAyB,CAAC,iBAAmC;;QAClE,IAAI,IAAI,GAAyB,IAAI,CAAC,KAAK,CAAC;QAC5C,IAAI,IAAI,GAAsB,IAAI,CAAC,KAAK,CAAC;QACzC,gBAAgB;QAChB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,KAAK,MAAM,OAAO,IAAI,iBAAiB,EAAE,CAAC;gBACxC,MAAM,KAAK,GAAqC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAC3E,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,MAAM;gBACR,CAAC;gBACD,IAAI,GAAG,KAAK,CAAC;gBACb,IAAI,GAAG,MAAA,IAAI,CAAC,KAAK,mCAAI,IAAI,CAAC;gBAC1B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACnB,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,YAAY,CAAQ,UAA8B;QACvD,MAAM,kBAAkB,GAAmC,IAAI,GAAG,EAAE,CAAC;QAErE,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC;YACtC,MAAM,KAAK,GAAsB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC1D,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,SAAS;YACX,CAAC;YACD,IAAI,WAAW,GAAmC,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAChF,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;gBACxB,kBAAkB,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YAC7C,CAAC;YACD,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACK,uBAAuB,CAAC,QAAgC;QAC9D,IAAI,IAAI,GAAyB,IAAI,CAAC,KAAK,CAAC;QAC5C,IAAI,IAAI,GAAoC,IAAI,CAAC,KAAK;YACpD,CAAC,CAAC;gBACE,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,KAAK,EAAE,CAAC;gBACR,SAAS,EAAE,SAAS;aACrB;YACH,CAAC,CAAC,SAAS,CAAC;QACd,gBAAgB;QAChB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,QAAQ,EAAE,CAAC;gBAC/C,MAAM,KAAK,GAAqC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACxE,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,MAAM;gBACR,CAAC;gBACD,IAAI,GAAG,KAAK,CAAC;gBACb,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBAC7B,IAAI,GAAG;wBACL,KAAK,EAAE,IAAI,CAAC,KAAK;wBACjB,KAAK;wBACL,SAAS,EAAE,IAAI;qBAChB,CAAC;gBACJ,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACnB,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAnND,oCAmNC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/*\n A node in the path trie used in LookupByPath\n /\ninterface IPathTrieNode<TItem> {\n /\n The value that exactly matches the current relative path\n /\n value: TItem \| undefined;\n /\n Child nodes by subfolder\n /\n children: Map<string, IPathTrieNode<TItem>> \| undefined;\n}\n\ninterface IPrefixEntry {\n /\n The prefix that was matched\n /\n prefix: string;\n /\n The index of the first character after the matched prefix\n /\n index: number;\n}\n\n/\n Object containing both the matched item and the start index of the remainder of the query.\n \n @beta\n /\nexport interface IPrefixMatch<TItem> {\n /\n The item that matched the prefix\n /\n value: TItem;\n /\n The index of the first character after the matched prefix\n /\n index: number;\n /\n The last match found (with a shorter prefix), if any\n /\n lastMatch?: IPrefixMatch<TItem>;\n}\n\n/\n The readonly component of `LookupByPath`, to simplify unit testing.\n \n @beta\n /\nexport interface IReadonlyLookupByPath<TItem> {\n /\n Searches for the item associated with `childPath`, or the nearest ancestor of that path that\n * has an associated item.\n \n @returns the found item, or `undefined` if no item was found\n \n @example\n * ```ts\n * const trie = new LookupByPath([['foo', 1], ['foo/bar', 2]]);\n * trie.findChildPath('foo/baz'); // returns 1\n * trie.findChildPath('foo/bar/baz'); // returns 2\n * ```\n /\n findChildPath(childPath: string): TItem \| undefined;\n\n /\n Searches for the item for which the recorded prefix is the longest matching prefix of `query`.\n * Obtains both the item and the length of the matched prefix, so that the remainder of the path can be\n * extracted.\n \n @returns the found item and the length of the matched prefix, or `undefined` if no item was found\n \n @example\n * ```ts\n * const trie = new LookupByPath([['foo', 1], ['foo/bar', 2]]);\n * trie.findLongestPrefixMatch('foo/baz'); // returns { item: 1, index: 3 }\n * trie.findLongestPrefixMatch('foo/bar/baz'); // returns { item: 2, index: 7 }\n * ```\n /\n findLongestPrefixMatch(query: string): IPrefixMatch<TItem> \| undefined;\n\n /\n Searches for the item associated with `childPathSegments`, or the nearest ancestor of that path that\n * has an associated item.\n \n @returns the found item, or `undefined` if no item was found\n \n @example\n * ```ts\n * const trie = new LookupByPath([['foo', 1], ['foo/bar', 2]]);\n * trie.findChildPathFromSegments(['foo', 'baz']); // returns 1\n * trie.findChildPathFromSegments(['foo','bar', 'baz']); // returns 2\n * ```\n /\n findChildPathFromSegments(childPathSegments: Iterable<string>): TItem \| undefined;\n\n /\n Groups the provided map of info by the nearest entry in the trie that contains the path. If the path\n * is not found in the trie, the info is ignored.\n \n @returns The grouped info, grouped by the nearest entry in the trie that contains the path\n \n @param infoByPath - The info to be grouped, keyed by path\n /\n groupByChild<TInfo>(infoByPath: Map<string, TInfo>): Map<TItem, Map<string, TInfo>>;\n}\n\n/\n This class is used to associate path-like-strings, such as those returned by `git` commands,\n * with entities that correspond with ancestor folders, such as Rush Projects or npm packages.\n \n It is optimized for efficiently locating the nearest ancestor path with an associated value.\n \n It is implemented as a Trie (https://en.wikipedia.org/wiki/Trie) data structure, with each edge\n * being a path segment.\n \n @example\n * ```ts\n * const trie = new LookupByPath([['foo', 1], ['bar', 2], ['foo/bar', 3]]);\n * trie.findChildPath('foo'); // returns 1\n * trie.findChildPath('foo/baz'); // returns 1\n * trie.findChildPath('baz'); // returns undefined\n * trie.findChildPath('foo/bar/baz'); returns 3\n * trie.findChildPath('bar/foo/bar'); returns 2\n * ```\n * @beta\n /\nexport class LookupByPath<TItem> implements IReadonlyLookupByPath<TItem> {\n /\n The delimiter used to split paths\n /\n public readonly delimiter: string;\n /\n The root node of the trie, corresponding to the path ''\n /\n private readonly _root: IPathTrieNode<TItem>;\n\n /\n Constructs a new `LookupByPath`\n \n @param entries - Initial path-value pairs to populate the trie.\n /\n public constructor(entries?: Iterable<[string, TItem]>, delimiter?: string) {\n this._root = {\n value: undefined,\n children: undefined\n };\n\n this.delimiter = delimiter ?? '/';\n\n if (entries) {\n for (const [path, item] of entries) {\n this.setItem(path, item);\n }\n }\n }\n\n /\n Iterates over the segments of a serialized path.\n \n @example\n \n `LookupByPath.iteratePathSegments('foo/bar/baz')` yields 'foo', 'bar', 'baz'\n \n `LookupByPath.iteratePathSegments('foo\\\\bar\\\\baz', '\\\\')` yields 'foo', 'bar', 'baz'\n /\n public static iteratePathSegments(serializedPath: string, delimiter: string = '/'): Iterable<string> {\n for (const prefixMatch of this._iteratePrefixes(serializedPath, delimiter)) {\n yield prefixMatch.prefix;\n }\n }\n\n private static _iteratePrefixes(input: string, delimiter: string = '/'): Iterable<IPrefixEntry> {\n if (!input) {\n return;\n }\n\n let previousIndex: number = 0;\n let nextIndex: number = input.indexOf(delimiter);\n\n // Leading segments\n while (nextIndex >= 0) {\n yield {\n prefix: input.slice(previousIndex, nextIndex),\n index: nextIndex\n };\n previousIndex = nextIndex + 1;\n nextIndex = input.indexOf(delimiter, previousIndex);\n }\n\n // Last segment\n if (previousIndex < input.length) {\n yield {\n prefix: input.slice(previousIndex, input.length),\n index: input.length\n };\n }\n }\n\n /\n Associates the value with the specified serialized path.\n * If a value is already associated, will overwrite.\n \n @returns this, for chained calls\n /\n public setItem(serializedPath: string, value: TItem): this {\n return this.setItemFromSegments(LookupByPath.iteratePathSegments(serializedPath, this.delimiter), value);\n }\n\n /\n Associates the value with the specified path.\n * If a value is already associated, will overwrite.\n \n @returns this, for chained calls\n /\n public setItemFromSegments(pathSegments: Iterable<string>, value: TItem): this {\n let node: IPathTrieNode<TItem> = this._root;\n for (const segment of pathSegments) {\n if (!node.children) {\n node.children = new Map();\n }\n let child: IPathTrieNode<TItem> \| undefined = node.children.get(segment);\n if (!child) {\n node.children.set(\n segment,\n (child = {\n value: undefined,\n children: undefined\n })\n );\n }\n node = child;\n }\n node.value = value;\n\n return this;\n }\n\n /\n {@inheritdoc IReadonlyLookupByPath}\n /\n public findChildPath(childPath: string): TItem \| undefined {\n return this.findChildPathFromSegments(LookupByPath.iteratePathSegments(childPath, this.delimiter));\n }\n\n /\n {@inheritdoc IReadonlyLookupByPath}\n /\n public findLongestPrefixMatch(query: string): IPrefixMatch<TItem> \| undefined {\n return this._findLongestPrefixMatch(LookupByPath._iteratePrefixes(query, this.delimiter));\n }\n\n /\n {@inheritdoc IReadonlyLookupByPath}\n /\n public findChildPathFromSegments(childPathSegments: Iterable<string>): TItem \| undefined {\n let node: IPathTrieNode<TItem> = this._root;\n let best: TItem \| undefined = node.value;\n // Trivial cases\n if (node.children) {\n for (const segment of childPathSegments) {\n const child: IPathTrieNode<TItem> \| undefined = node.children.get(segment);\n if (!child) {\n break;\n }\n node = child;\n best = node.value ?? best;\n if (!node.children) {\n break;\n }\n }\n }\n\n return best;\n }\n\n /\n {@inheritdoc IReadonlyLookupByPath}\n /\n public groupByChild<TInfo>(infoByPath: Map<string, TInfo>): Map<TItem, Map<string, TInfo>> {\n const groupedInfoByChild: Map<TItem, Map<string, TInfo>> = new Map();\n\n for (const [path, info] of infoByPath) {\n const child: TItem \| undefined = this.findChildPath(path);\n if (child === undefined) {\n continue;\n }\n let groupedInfo: Map<string, TInfo> \| undefined = groupedInfoByChild.get(child);\n if (!groupedInfo) {\n groupedInfo = new Map();\n groupedInfoByChild.set(child, groupedInfo);\n }\n groupedInfo.set(path, info);\n }\n\n return groupedInfoByChild;\n }\n\n /\n Iterates through progressively longer prefixes of a given string and returns as soon\n * as the number of candidate items that match the prefix are 1 or 0.\n \n If a match is present, returns the matched itme and the length of the matched prefix.\n \n @returns the found item, or `undefined` if no item was found\n */\n private _findLongestPrefixMatch(prefixes: Iterable<IPrefixEntry>): IPrefixMatch<TItem> \| undefined {\n let node: IPathTrieNode<TItem> = this._root;\n let best: IPrefixMatch<TItem> \| undefined = node.value\n ? {\n value: node.value,\n index: 0,\n lastMatch: undefined\n }\n : undefined;\n // Trivial cases\n if (node.children) {\n for (const { prefix: hash, index } of prefixes) {\n const child: IPathTrieNode<TItem> \| undefined = node.children.get(hash);\n if (!child) {\n break;\n }\n node = child;\n if (node.value !== undefined) {\n best = {\n value: node.value,\n index,\n lastMatch: best\n };\n }\n if (!node.children) {\n break;\n }\n }\n }\n\n return best;\n }\n}\n"]}
1	+ {"version":3,"file":"LookupByPath.js","sourceRoot":"","sources":["../src/LookupByPath.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAoK3D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,YAAY;IAgBvB;;;;OAIG;IACH,YAAmB,OAAmC,EAAE,SAAkB;QACxE,IAAI,CAAC,KAAK,GAAG;YACX,KAAK,EAAE,SAAS;YAChB,QAAQ,EAAE,SAAS;SACpB,CAAC;QAEF,IAAI,CAAC,SAAS,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,GAAG,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QAEf,IAAI,OAAO,EAAE,CAAC;YACZ,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,OAAO,EAAE,CAAC;gBACnC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,CAAC,mBAAmB,CAAC,cAAsB,EAAE,YAAoB,GAAG;QAChF,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,SAAS,CAAC,EAAE,CAAC;YAC3E,MAAM,WAAW,CAAC,MAAM,CAAC;QAC3B,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,CAAC,gBAAgB,CAAC,KAAa,EAAE,YAAoB,GAAG;QACrE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO;QACT,CAAC;QAED,IAAI,aAAa,GAAW,CAAC,CAAC;QAC9B,IAAI,SAAS,GAAW,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAEjD,mBAAmB;QACnB,OAAO,SAAS,IAAI,CAAC,EAAE,CAAC;YACtB,MAAM;gBACJ,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,aAAa,EAAE,SAAS,CAAC;gBAC7C,KAAK,EAAE,SAAS;aACjB,CAAC;YACF,aAAa,GAAG,SAAS,GAAG,CAAC,CAAC;YAC9B,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QACtD,CAAC;QAED,eAAe;QACf,IAAI,aAAa,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;YACjC,MAAM;gBACJ,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC;gBAChD,KAAK,EAAE,KAAK,CAAC,MAAM;aACpB,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACI,KAAK;QACV,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,cAAsB,EAAE,KAAY,EAAE,YAAoB,IAAI,CAAC,SAAS;QACrF,OAAO,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,mBAAmB,CAAC,cAAc,EAAE,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;OAOG;IACI,UAAU,CAAC,KAAa,EAAE,YAAoB,IAAI,CAAC,SAAS;QACjE,MAAM,IAAI,GAAqC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACxF,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,MAAK,SAAS,EAAE,CAAC;YAC9B,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;YACvB,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,mBAAmB,CAAC,YAA8B,EAAE,KAAY;QACrE,IAAI,IAAI,GAAyB,IAAI,CAAC,KAAK,CAAC;QAC5C,KAAK,MAAM,OAAO,IAAI,YAAY,EAAE,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;YAC5B,CAAC;YACD,IAAI,KAAK,GAAqC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACzE,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,IAAI,CAAC,QAAQ,CAAC,GAAG,CACf,OAAO,EACP,CAAC,KAAK,GAAG;oBACP,KAAK,EAAE,SAAS;oBAChB,QAAQ,EAAE,SAAS;iBACpB,CAAC,CACH,CAAC;YACJ,CAAC;YACD,IAAI,GAAG,KAAK,CAAC;QACf,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAEnB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,SAAiB,EAAE,YAAoB,IAAI,CAAC,SAAS;QACxE,OAAO,IAAI,CAAC,yBAAyB,CAAC,YAAY,CAAC,mBAAmB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAChG,CAAC;IAED;;OAEG;IACI,sBAAsB,CAC3B,KAAa,EACb,YAAoB,IAAI,CAAC,SAAS;QAElC,OAAO,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACI,yBAAyB,CAAC,iBAAmC;;QAClE,IAAI,IAAI,GAAyB,IAAI,CAAC,KAAK,CAAC;QAC5C,IAAI,IAAI,GAAsB,IAAI,CAAC,KAAK,CAAC;QACzC,gBAAgB;QAChB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,KAAK,MAAM,OAAO,IAAI,iBAAiB,EAAE,CAAC;gBACxC,MAAM,KAAK,GAAqC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAC3E,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,MAAM;gBACR,CAAC;gBACD,IAAI,GAAG,KAAK,CAAC;gBACb,IAAI,GAAG,MAAA,IAAI,CAAC,KAAK,mCAAI,IAAI,CAAC;gBAC1B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACnB,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW,EAAE,YAAoB,IAAI,CAAC,SAAS;QACxD,MAAM,KAAK,GAAoC,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC3F,OAAO,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,MAAK,GAAG,CAAC,MAAM,CAAC;IACrC,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW,EAAE,YAAoB,IAAI,CAAC,SAAS;QACxD,MAAM,KAAK,GAAoC,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC3F,OAAO,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,MAAK,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;IAED;;OAEG;IACI,YAAY,CACjB,UAA8B,EAC9B,YAAoB,IAAI,CAAC,SAAS;QAElC,MAAM,kBAAkB,GAAmC,IAAI,GAAG,EAAE,CAAC;QAErE,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC;YACtC,MAAM,KAAK,GAAsB,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACrE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,SAAS;YACX,CAAC;YACD,IAAI,WAAW,GAAmC,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAChF,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;gBACxB,kBAAkB,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YAC7C,CAAC;YACD,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,CAAC,OAAO,CAAC,KAAc,EAAE,YAAoB,IAAI,CAAC,SAAS;QAChE,IAAI,IAAsC,CAAC;QAC3C,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YAChD,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,OAAO;YACT,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;QACpB,CAAC;QAED,MAAM,KAAK,GAAqC,CAAC,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;QACtE,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,oEAAoE;YACpE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;YACpC,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YAC7B,CAAC;YACD,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,KAAK,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAC7C,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;gBAC5E,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC,CACtB,KAAc,EACd,YAAoB,IAAI,CAAC,SAAS;QAElC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACK,uBAAuB,CAAC,QAAgC;QAC9D,IAAI,IAAI,GAAyB,IAAI,CAAC,KAAK,CAAC;QAC5C,IAAI,IAAI,GAAoC,IAAI,CAAC,KAAK;YACpD,CAAC,CAAC;gBACE,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,KAAK,EAAE,CAAC;gBACR,SAAS,EAAE,SAAS;aACrB;YACH,CAAC,CAAC,SAAS,CAAC;QACd,gBAAgB;QAChB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,QAAQ,EAAE,CAAC;gBAC/C,MAAM,KAAK,GAAqC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACxE,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,MAAM;gBACR,CAAC;gBACD,IAAI,GAAG,KAAK,CAAC;gBACb,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBAC7B,IAAI,GAAG;wBACL,KAAK,EAAE,IAAI,CAAC,KAAK;wBACjB,KAAK;wBACL,SAAS,EAAE,IAAI;qBAChB,CAAC;gBACJ,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACnB,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACK,iBAAiB,CACvB,KAAa,EACb,YAAoB,IAAI,CAAC,SAAS;QAElC,IAAI,IAAI,GAAyB,IAAI,CAAC,KAAK,CAAC;QAC5C,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,YAAY,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;YACzE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACnB,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,KAAK,GAAqC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC1E,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,IAAI,GAAG,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAxVD,oCAwVC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/*\n A node in the path trie used in LookupByPath\n /\ninterface IPathTrieNode<TItem extends {}> {\n /\n The value that exactly matches the current relative path\n /\n value: TItem \| undefined;\n\n /\n Child nodes by subfolder\n /\n children: Map<string, IPathTrieNode<TItem>> \| undefined;\n}\n\ninterface IPrefixEntry {\n /\n The prefix that was matched\n /\n prefix: string;\n\n /\n The index of the first character after the matched prefix\n /\n index: number;\n}\n\n/\n Object containing both the matched item and the start index of the remainder of the query.\n \n @beta\n /\nexport interface IPrefixMatch<TItem extends {}> {\n /\n The item that matched the prefix\n /\n value: TItem;\n\n /\n The index of the first character after the matched prefix\n /\n index: number;\n\n /\n The last match found (with a shorter prefix), if any\n /\n lastMatch?: IPrefixMatch<TItem>;\n}\n\n/\n The readonly component of `LookupByPath`, to simplify unit testing.\n \n @beta\n /\nexport interface IReadonlyLookupByPath<TItem extends {}> extends Iterable<[string, TItem]> {\n /\n Searches for the item associated with `childPath`, or the nearest ancestor of that path that\n * has an associated item.\n \n @returns the found item, or `undefined` if no item was found\n \n @example\n * ```ts\n * const trie = new LookupByPath([['foo', 1], ['foo/bar', 2]]);\n * trie.findChildPath('foo/baz'); // returns 1\n * trie.findChildPath('foo/bar/baz'); // returns 2\n * ```\n /\n findChildPath(childPath: string, delimiter?: string): TItem \| undefined;\n\n /\n Searches for the item for which the recorded prefix is the longest matching prefix of `query`.\n * Obtains both the item and the length of the matched prefix, so that the remainder of the path can be\n * extracted.\n \n @returns the found item and the length of the matched prefix, or `undefined` if no item was found\n \n @example\n * ```ts\n * const trie = new LookupByPath([['foo', 1], ['foo/bar', 2]]);\n * trie.findLongestPrefixMatch('foo/baz'); // returns { item: 1, index: 3 }\n * trie.findLongestPrefixMatch('foo/bar/baz'); // returns { item: 2, index: 7 }\n * ```\n /\n findLongestPrefixMatch(query: string, delimiter?: string): IPrefixMatch<TItem> \| undefined;\n\n /\n Searches for the item associated with `childPathSegments`, or the nearest ancestor of that path that\n * has an associated item.\n \n @returns the found item, or `undefined` if no item was found\n \n @example\n * ```ts\n * const trie = new LookupByPath([['foo', 1], ['foo/bar', 2]]);\n * trie.findChildPathFromSegments(['foo', 'baz']); // returns 1\n * trie.findChildPathFromSegments(['foo','bar', 'baz']); // returns 2\n * ```\n /\n findChildPathFromSegments(childPathSegments: Iterable<string>): TItem \| undefined;\n\n /\n Determines if an entry exists exactly at the specified path.\n \n @returns `true` if an entry exists at the specified path, `false` otherwise\n /\n has(query: string, delimiter?: string): boolean;\n\n /\n Retrieves the entry that exists exactly at the specified path, if any.\n \n @returns The entry that exists exactly at the specified path, or `undefined` if no entry exists.\n /\n get(query: string, delimiter?: string): TItem \| undefined;\n\n /\n Gets the number of entries in this trie.\n \n @returns The number of entries in this trie.\n /\n get size(): number;\n\n /\n Iterates over the entries in this trie.\n \n @param query - An optional query. If specified only entries that start with the query will be returned.\n \n @returns An iterator over the entries under the specified query (or the root if no query is specified).\n * @remarks\n * Keys in the returned iterator use the provided delimiter to join segments.\n * Iteration order is not specified.\n * @example\n * ```ts\n * const trie = new LookupByPath([['foo', 1], ['foo/bar', 2]]);\n * [...trie.entries(undefined, ',')); // returns [['foo', 1], ['foo,bar', 2]]\n * ```\n /\n entries(query?: string, delimiter?: string): IterableIterator<[string, TItem]>;\n\n /\n Iterates over the entries in this trie.\n \n @param query - An optional query. If specified only entries that start with the query will be returned.\n \n @returns An iterator over the entries under the specified query (or the root if no query is specified).\n * @remarks\n * Keys in the returned iterator use the provided delimiter to join segments.\n * Iteration order is not specified.\n /\n [Symbol.iterator](query?: string, delimiter?: string): IterableIterator<[string, TItem]>;\n\n /\n Groups the provided map of info by the nearest entry in the trie that contains the path. If the path\n * is not found in the trie, the info is ignored.\n \n @returns The grouped info, grouped by the nearest entry in the trie that contains the path\n \n @param infoByPath - The info to be grouped, keyed by path\n /\n groupByChild<TInfo>(infoByPath: Map<string, TInfo>, delimiter?: string): Map<TItem, Map<string, TInfo>>;\n}\n\n/\n This class is used to associate path-like-strings, such as those returned by `git` commands,\n * with entities that correspond with ancestor folders, such as Rush Projects or npm packages.\n \n It is optimized for efficiently locating the nearest ancestor path with an associated value.\n \n It is implemented as a Trie (https://en.wikipedia.org/wiki/Trie) data structure, with each edge\n * being a path segment.\n \n @example\n * ```ts\n * const trie = new LookupByPath([['foo', 1], ['bar', 2], ['foo/bar', 3]]);\n * trie.findChildPath('foo'); // returns 1\n * trie.findChildPath('foo/baz'); // returns 1\n * trie.findChildPath('baz'); // returns undefined\n * trie.findChildPath('foo/bar/baz'); returns 3\n * trie.findChildPath('bar/foo/bar'); returns 2\n * ```\n * @beta\n /\nexport class LookupByPath<TItem extends {}> implements IReadonlyLookupByPath<TItem> {\n /\n The delimiter used to split paths\n /\n public readonly delimiter: string;\n\n /\n The root node of the trie, corresponding to the path ''\n /\n private readonly _root: IPathTrieNode<TItem>;\n\n /\n The number of entries in this trie.\n /\n private _size: number;\n\n /\n Constructs a new `LookupByPath`\n \n @param entries - Initial path-value pairs to populate the trie.\n /\n public constructor(entries?: Iterable<[string, TItem]>, delimiter?: string) {\n this._root = {\n value: undefined,\n children: undefined\n };\n\n this.delimiter = delimiter ?? '/';\n this._size = 0;\n\n if (entries) {\n for (const [path, item] of entries) {\n this.setItem(path, item);\n }\n }\n }\n\n /\n Iterates over the segments of a serialized path.\n \n @example\n \n `LookupByPath.iteratePathSegments('foo/bar/baz')` yields 'foo', 'bar', 'baz'\n \n `LookupByPath.iteratePathSegments('foo\\\\bar\\\\baz', '\\\\')` yields 'foo', 'bar', 'baz'\n /\n public static iteratePathSegments(serializedPath: string, delimiter: string = '/'): Iterable<string> {\n for (const prefixMatch of this._iteratePrefixes(serializedPath, delimiter)) {\n yield prefixMatch.prefix;\n }\n }\n\n private static _iteratePrefixes(input: string, delimiter: string = '/'): Iterable<IPrefixEntry> {\n if (!input) {\n return;\n }\n\n let previousIndex: number = 0;\n let nextIndex: number = input.indexOf(delimiter);\n\n // Leading segments\n while (nextIndex >= 0) {\n yield {\n prefix: input.slice(previousIndex, nextIndex),\n index: nextIndex\n };\n previousIndex = nextIndex + 1;\n nextIndex = input.indexOf(delimiter, previousIndex);\n }\n\n // Last segment\n if (previousIndex < input.length) {\n yield {\n prefix: input.slice(previousIndex, input.length),\n index: input.length\n };\n }\n }\n\n /\n {@inheritdoc IReadonlyLookupByPath}\n /\n public get size(): number {\n return this._size;\n }\n\n /\n Deletes all entries from this `LookupByPath` instance.\n \n @returns this, for chained calls\n /\n public clear(): this {\n this._root.value = undefined;\n this._root.children = undefined;\n this._size = 0;\n return this;\n }\n\n /\n Associates the value with the specified serialized path.\n * If a value is already associated, will overwrite.\n \n @returns this, for chained calls\n /\n public setItem(serializedPath: string, value: TItem, delimiter: string = this.delimiter): this {\n return this.setItemFromSegments(LookupByPath.iteratePathSegments(serializedPath, delimiter), value);\n }\n\n /\n Deletes an item if it exists.\n * @param query - The path to the item to delete\n * @param delimeter - Optional override delimeter for parsing the query\n * @returns `true` if the item was found and deleted, `false` otherwise\n * @remarks\n * If the node has children with values, they will be retained.\n /\n public deleteItem(query: string, delimeter: string = this.delimiter): boolean {\n const node: IPathTrieNode<TItem> \| undefined = this._findNodeAtPrefix(query, delimeter);\n if (node?.value !== undefined) {\n node.value = undefined;\n this._size--;\n return true;\n }\n\n return false;\n }\n\n /\n Associates the value with the specified path.\n * If a value is already associated, will overwrite.\n \n @returns this, for chained calls\n /\n public setItemFromSegments(pathSegments: Iterable<string>, value: TItem): this {\n let node: IPathTrieNode<TItem> = this._root;\n for (const segment of pathSegments) {\n if (!node.children) {\n node.children = new Map();\n }\n let child: IPathTrieNode<TItem> \| undefined = node.children.get(segment);\n if (!child) {\n node.children.set(\n segment,\n (child = {\n value: undefined,\n children: undefined\n })\n );\n }\n node = child;\n }\n if (node.value === undefined) {\n this._size++;\n }\n node.value = value;\n\n return this;\n }\n\n /\n {@inheritdoc IReadonlyLookupByPath}\n /\n public findChildPath(childPath: string, delimiter: string = this.delimiter): TItem \| undefined {\n return this.findChildPathFromSegments(LookupByPath.iteratePathSegments(childPath, delimiter));\n }\n\n /\n {@inheritdoc IReadonlyLookupByPath}\n /\n public findLongestPrefixMatch(\n query: string,\n delimiter: string = this.delimiter\n ): IPrefixMatch<TItem> \| undefined {\n return this._findLongestPrefixMatch(LookupByPath._iteratePrefixes(query, delimiter));\n }\n\n /\n {@inheritdoc IReadonlyLookupByPath}\n /\n public findChildPathFromSegments(childPathSegments: Iterable<string>): TItem \| undefined {\n let node: IPathTrieNode<TItem> = this._root;\n let best: TItem \| undefined = node.value;\n // Trivial cases\n if (node.children) {\n for (const segment of childPathSegments) {\n const child: IPathTrieNode<TItem> \| undefined = node.children.get(segment);\n if (!child) {\n break;\n }\n node = child;\n best = node.value ?? best;\n if (!node.children) {\n break;\n }\n }\n }\n\n return best;\n }\n\n /\n {@inheritdoc IReadonlyLookupByPath}\n /\n public has(key: string, delimiter: string = this.delimiter): boolean {\n const match: IPrefixMatch<TItem> \| undefined = this.findLongestPrefixMatch(key, delimiter);\n return match?.index === key.length;\n }\n\n /\n {@inheritdoc IReadonlyLookupByPath}\n /\n public get(key: string, delimiter: string = this.delimiter): TItem \| undefined {\n const match: IPrefixMatch<TItem> \| undefined = this.findLongestPrefixMatch(key, delimiter);\n return match?.index === key.length ? match.value : undefined;\n }\n\n /\n {@inheritdoc IReadonlyLookupByPath}\n /\n public groupByChild<TInfo>(\n infoByPath: Map<string, TInfo>,\n delimiter: string = this.delimiter\n ): Map<TItem, Map<string, TInfo>> {\n const groupedInfoByChild: Map<TItem, Map<string, TInfo>> = new Map();\n\n for (const [path, info] of infoByPath) {\n const child: TItem \| undefined = this.findChildPath(path, delimiter);\n if (child === undefined) {\n continue;\n }\n let groupedInfo: Map<string, TInfo> \| undefined = groupedInfoByChild.get(child);\n if (!groupedInfo) {\n groupedInfo = new Map();\n groupedInfoByChild.set(child, groupedInfo);\n }\n groupedInfo.set(path, info);\n }\n\n return groupedInfoByChild;\n }\n\n /\n {@inheritdoc IReadonlyLookupByPath}\n /\n public entries(query?: string, delimiter: string = this.delimiter): IterableIterator<[string, TItem]> {\n let root: IPathTrieNode<TItem> \| undefined;\n if (query) {\n root = this._findNodeAtPrefix(query, delimiter);\n if (!root) {\n return;\n }\n } else {\n root = this._root;\n }\n\n const stack: [string, IPathTrieNode<TItem>][] = [[query ?? '', root]];\n while (stack.length > 0) {\n // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n const [prefix, node] = stack.pop()!;\n if (node.value !== undefined) {\n yield [prefix, node.value];\n }\n if (node.children) {\n for (const [segment, child] of node.children) {\n stack.push([prefix ? `${prefix}${delimiter}${segment}` : segment, child]);\n }\n }\n }\n }\n\n /*\n {@inheritdoc IReadonlyLookupByPath}\n /\n public [Symbol.iterator](\n query?: string,\n delimiter: string = this.delimiter\n ): IterableIterator<[string, TItem]> {\n return this.entries(query, delimiter);\n }\n\n /\n Iterates through progressively longer prefixes of a given string and returns as soon\n * as the number of candidate items that match the prefix are 1 or 0.\n \n If a match is present, returns the matched itme and the length of the matched prefix.\n \n @returns the found item, or `undefined` if no item was found\n /\n private _findLongestPrefixMatch(prefixes: Iterable<IPrefixEntry>): IPrefixMatch<TItem> \| undefined {\n let node: IPathTrieNode<TItem> = this._root;\n let best: IPrefixMatch<TItem> \| undefined = node.value\n ? {\n value: node.value,\n index: 0,\n lastMatch: undefined\n }\n : undefined;\n // Trivial cases\n if (node.children) {\n for (const { prefix: hash, index } of prefixes) {\n const child: IPathTrieNode<TItem> \| undefined = node.children.get(hash);\n if (!child) {\n break;\n }\n node = child;\n if (node.value !== undefined) {\n best = {\n value: node.value,\n index,\n lastMatch: best\n };\n }\n if (!node.children) {\n break;\n }\n }\n }\n\n return best;\n }\n\n /\n Finds the node at the specified path, or `undefined` if no node was found.\n \n @param query - The path to the node to search for\n * @returns The trie node at the specified path, or `undefined` if no node was found\n */\n private _findNodeAtPrefix(\n query: string,\n delimiter: string = this.delimiter\n ): IPathTrieNode<TItem> \| undefined {\n let node: IPathTrieNode<TItem> = this._root;\n for (const { prefix } of LookupByPath._iteratePrefixes(query, delimiter)) {\n if (!node.children) {\n return undefined;\n }\n const child: IPathTrieNode<TItem> \| undefined = node.children.get(prefix);\n if (!child) {\n return undefined;\n }\n node = child;\n }\n return node;\n }\n}\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/lookup-by-path",
-  "version": "0.4.7",
+  "version": "0.5.1",
   "description": "Strongly typed trie data structure for path and URL-like strings.",
   "main": "lib/index.js",
   "typings": "dist/lookup-by-path.d.ts",
@@ -18,7 +18,7 @@
     "directory": "libraries/lookup-by-path"
   },
   "devDependencies": {
-    "@rushstack/heft": "0.68.11",
+    "@rushstack/heft": "0.68.12",
     "local-node-rig": "1.0.0"
   },
   "peerDependencies": {