@rushstack/rush-sdk 5.131.0 → 5.131.1

package/dist/rush-lib.d.ts

@@ -14,9 +14,11 @@ import type { CommandLineParameter } from '@rushstack/ts-command-line';
 import { CommandLineParameterKind } from '@rushstack/ts-command-line';
 import { HookMap } from 'tapable';
 import { IPackageJson } from '@rushstack/node-core-library';
+import { IPrefixMatch } from '@rushstack/lookup-by-path';
 import { ITerminal } from '@rushstack/terminal';
 import { ITerminalProvider } from '@rushstack/terminal';
 import { JsonObject } from '@rushstack/node-core-library';
+import { LookupByPath } from '@rushstack/lookup-by-path';
 import { PackageNameParser } from '@rushstack/node-core-library';
 import type { StdioSummarizer } from '@rushstack/terminal';
 import { SyncHook } from 'tapable';
@@ -2059,15 +2061,7 @@ export declare interface IPnpmPeerDependencyRules {
     allowedVersions?: Record<string, string>;
 }
 
-/**
- * Object containing both the matched item and the start index of the remainder of the query.
- *
- * @beta
- */
-export declare interface IPrefixMatch<TItem> {
-    value: TItem;
-    index: number;
-}
+export { IPrefixMatch }
 
 /**
  * @internal
@@ -2590,116 +2584,7 @@ export declare class LockStepVersionPolicy extends VersionPolicy {
     private _getReleaseType;
 }
 
-/**
- * This class is used to associate POSIX relative paths, such as those returned by `git` commands,
- * with entities that correspond with ancestor folders, such as Rush Projects.
- *
- * It is optimized for efficiently locating the nearest ancestor path with an associated value.
- *
- * @example
- * ```ts
- * const tree = new LookupByPath([['foo', 1], ['bar', 2], ['foo/bar', 3]]);
- * tree.findChildPath('foo'); // returns 1
- * tree.findChildPath('foo/baz'); // returns 1
- * tree.findChildPath('baz'); // returns undefined
- * tree.findChildPath('foo/bar/baz'); returns 3
- * tree.findChildPath('bar/foo/bar'); returns 2
- * ```
- * @beta
- */
-export declare class LookupByPath<TItem> {
-    /**
-     * The delimiter used to split paths
-     */
-    readonly delimiter: string;
-    /**
-     * The root node of the tree, corresponding to the path ''
-     */
-    private readonly _root;
-    /**
-     * Constructs a new `LookupByPath`
-     *
-     * @param entries - Initial path-value pairs to populate the tree.
-     */
-    constructor(entries?: Iterable<[string, TItem]>, delimiter?: string);
-    /**
-     * Iterates over the segments of a serialized path.
-     *
-     * @example
-     *
-     * `LookupByPath.iteratePathSegments('foo/bar/baz')` yields 'foo', 'bar', 'baz'
-     *
-     * `LookupByPath.iteratePathSegments('foo\\bar\\baz', '\\')` yields 'foo', 'bar', 'baz'
-     */
-    static iteratePathSegments(serializedPath: string, delimiter?: string): Iterable<string>;
-    private static _iteratePrefixes;
-    /**
-     * 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;
-    /**
-     * Associates the value with the specified path.
-     * If a value is already associated, will overwrite.
-     *
-     * @returns this, for chained calls
-     */
-    setItemFromSegments(pathSegments: Iterable<string>, value: TItem): this;
-    /**
-     * Searches for the item associated with `childPath`, or the nearest ancestor of that path that
-     * has an associated item.
-     *
-     * @returns the found item, or `undefined` if no item was found
-     *
-     * @example
-     * ```ts
-     * const tree = new LookupByPath([['foo', 1], ['foo/bar', 2]]);
-     * tree.findChildPath('foo/baz'); // returns 1
-     * tree.findChildPath('foo/bar/baz'); // returns 2
-     * ```
-     */
-    findChildPath(childPath: 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
-     * extracted.
-     *
-     * @returns the found item and the length of the matched prefix, or `undefined` if no item was found
-     *
-     * @example
-     * ```ts
-     * const tree = new LookupByPath([['foo', 1], ['foo/bar', 2]]);
-     * tree.findLongestPrefixMatch('foo/baz'); // returns { item: 1, index: 3 }
-     * tree.findLongestPrefixMatch('foo/bar/baz'); // returns { item: 2, index: 7 }
-     * ```
-     */
-    findLongestPrefixMatch(query: string): IPrefixMatch<TItem> | undefined;
-    /**
-     * Searches for the item associated with `childPathSegments`, or the nearest ancestor of that path that
-     * has an associated item.
-     *
-     * @returns the found item, or `undefined` if no item was found
-     *
-     * @example
-     * ```ts
-     * const tree = new LookupByPath([['foo', 1], ['foo/bar', 2]]);
-     * tree.findChildPathFromSegments(['foo', 'baz']); // returns 1
-     * tree.findChildPathFromSegments(['foo','bar', 'baz']); // returns 2
-     * ```
-     */
-    findChildPathFromSegments(childPathSegments: Iterable<string>): TItem | undefined;
-    /**
-     * 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.
-     *
-     * If a match is present, returns the matched itme and the length of the matched prefix.
-     *
-     * @returns the found item, or `undefined` if no item was found
-     */
-    private _findLongestPrefixMatch;
-}
+export { LookupByPath }
 
 /**
  * Options that are only used when the NPM package manager is selected.

package/dist/tsdoc-metadata.json

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

package/lib/api/RushConfiguration.d.ts

@@ -1,4 +1,5 @@
 import { type PackageNameParser } from '@rushstack/node-core-library';
+import { LookupByPath } from '@rushstack/lookup-by-path';
 import { RushConfigurationProject, type IRushConfigurationProjectJson } from './RushConfigurationProject';
 import { ApprovedPackagesPolicy } from './ApprovedPackagesPolicy';
 import { EventHooks } from './EventHooks';
@@ -7,7 +8,6 @@ import type { CommonVersionsConfiguration } from './CommonVersionsConfiguration'
 import type { PackageManagerName, PackageManager } from './packageManager/PackageManager';
 import { ExperimentsConfiguration } from './ExperimentsConfiguration';
 import type { RepoStateFile } from '../logic/RepoStateFile';
-import { LookupByPath } from '../logic/LookupByPath';
 import { RushPluginsConfiguration } from './RushPluginsConfiguration';
 import { type IPnpmOptionsJson, PnpmOptionsConfiguration } from '../logic/pnpm/PnpmOptionsConfiguration';
 import { type INpmOptionsJson, NpmOptionsConfiguration } from '../logic/npm/NpmOptionsConfiguration';

package/lib/index.d.ts

@@ -2,6 +2,7 @@
  * A library for writing scripts that interact with the {@link https://rushjs.io/ | Rush} tool.
  * @packageDocumentation
  */
+export { LookupByPath as LookupByPath, type IPrefixMatch } from '@rushstack/lookup-by-path';
 export { ApprovedPackagesPolicy } from './api/ApprovedPackagesPolicy';
 export { RushConfiguration, type ITryFindRushJsonLocationOptions } from './api/RushConfiguration';
 export { Subspace } from './api/Subspace';
@@ -26,7 +27,6 @@ export { ApprovedPackagesItem, ApprovedPackagesConfiguration } from './api/Appro
 export { CommonVersionsConfiguration } from './api/CommonVersionsConfiguration';
 export { PackageJsonEditor, PackageJsonDependency, DependencyType, PackageJsonDependencyMeta } from './api/PackageJsonEditor';
 export { RepoStateFile } from './logic/RepoStateFile';
-export { LookupByPath, type IPrefixMatch } from './logic/LookupByPath';
 export { EventHooks, Event } from './api/EventHooks';
 export { ChangeManager } from './api/ChangeManager';
 export { FlagFile as _FlagFile } from './api/FlagFile';