@rushstack/rush-sdk 5.100.0-pr4132 → 5.100.0

package/dist/rush-lib.d.ts

@@ -185,7 +185,6 @@ export declare enum BumpType {
     'none' = 0,
     'prerelease' = 1,
     'patch' = 2,
-    'preminor' = 3,
     'minor' = 4,
     'major' = 5
 }
@@ -1712,7 +1711,7 @@ export declare interface ITryFindRushJsonLocationOptions {
      */
     showVerbose?: boolean;
     /**
-     * The folder path where the search will start.  Defaults tot he current working directory.
+     * The folder path where the search will start.  Defaults to the current working directory.
      */
     startingFolder?: string;
 }

package/lib/api/RushConfiguration.d.ts

@@ -127,7 +127,7 @@ export interface ITryFindRushJsonLocationOptions {
      */
     showVerbose?: boolean;
     /**
-     * The folder path where the search will start.  Defaults tot he current working directory.
+     * The folder path where the search will start.  Defaults to the current working directory.
      */
     startingFolder?: string;
 }

package/lib/api/VersionPolicy.d.ts

@@ -9,7 +9,6 @@ export declare enum BumpType {
     'none' = 0,
     'prerelease' = 1,
     'patch' = 2,
-    'preminor' = 3,
     'minor' = 4,
     'major' = 5
 }

package/lib/cli/actions/AddAction.d.ts

@@ -8,6 +8,7 @@ export declare class AddAction extends BaseAddAndRemoveAction {
     private readonly _exactFlag;
     private readonly _caretFlag;
     private readonly _devDependencyFlag;
+    private readonly _peerDependencyFlag;
     private readonly _makeConsistentFlag;
     constructor(parser: RushCommandLineParser);
     getUpdateOptions(): IPackageJsonUpdaterRushAddOptions;

package/lib/logic/PackageJsonUpdaterTypes.d.ts

@@ -58,6 +58,10 @@ export interface IPackageJsonUpdaterRushAddOptions extends IPackageJsonUpdaterRu
      * Whether or not this dependency should be added as a devDependency or a regular dependency.
      */
     devDependency: boolean;
+    /**
+     * Whether or not this dependency should be added as a peerDependency or a regular dependency.
+     */
+    peerDependency: boolean;
     /**
      * If specified, other packages that use this dependency will also have their package.json's updated.
      */

package/lib/logic/pnpm/PnpmShrinkwrapFile.d.ts

@@ -9,6 +9,12 @@ import { PackageManagerOptionsConfigurationBase } from '../base/BasePackageManag
 export interface IPeerDependenciesMetaYaml {
     optional?: boolean;
 }
+export type IPnpmV7VersionSpecifier = string;
+export interface IPnpmV8VersionSpecifier {
+    version: string;
+    specifier: string;
+}
+export type IPnpmVersionSpecifier = IPnpmV7VersionSpecifier | IPnpmV8VersionSpecifier;
 export interface IPnpmShrinkwrapDependencyYaml {
     /** Information about the resolved package */
     resolution?: {
@@ -18,42 +24,31 @@ export interface IPnpmShrinkwrapDependencyYaml {
         tarball?: string;
     };
     /** The list of dependencies and the resolved version */
-    dependencies?: {
-        [dependency: string]: string;
-    };
+    dependencies?: Record<string, IPnpmVersionSpecifier>;
     /** The list of optional dependencies and the resolved version */
-    optionalDependencies?: {
-        [dependency: string]: string;
-    };
+    optionalDependencies?: Record<string, IPnpmVersionSpecifier>;
     /** The list of peer dependencies and the resolved version */
-    peerDependencies?: {
-        [dependency: string]: string;
-    };
+    peerDependencies?: Record<string, IPnpmVersionSpecifier>;
     /**
      * Used to indicate optional peer dependencies, as described in this RFC:
      * https://github.com/yarnpkg/rfcs/blob/master/accepted/0000-optional-peer-dependencies.md
      */
-    peerDependenciesMeta?: {
-        [dependency: string]: IPeerDependenciesMetaYaml;
-    };
+    peerDependenciesMeta?: Record<string, IPeerDependenciesMetaYaml>;
 }
 export interface IPnpmShrinkwrapImporterYaml {
     /** The list of resolved version numbers for direct dependencies */
-    dependencies?: {
-        [dependency: string]: string;
-    };
+    dependencies?: Record<string, IPnpmVersionSpecifier>;
     /** The list of resolved version numbers for dev dependencies */
-    devDependencies?: {
-        [dependency: string]: string;
-    };
+    devDependencies?: Record<string, IPnpmVersionSpecifier>;
     /** The list of resolved version numbers for optional dependencies */
-    optionalDependencies?: {
-        [dependency: string]: string;
-    };
-    /** The list of specifiers used to resolve dependency versions */
-    specifiers: {
-        [dependency: string]: string;
-    };
+    optionalDependencies?: Record<string, IPnpmVersionSpecifier>;
+    /**
+     * The list of specifiers used to resolve dependency versions
+     *
+     * @remarks
+     * This has been removed in PNPM v8
+     */
+    specifiers?: Record<string, IPnpmVersionSpecifier>;
 }
 /**
  * This interface represents the raw pnpm-lock.YAML file
@@ -87,24 +82,18 @@ export interface IPnpmShrinkwrapImporterYaml {
  *  }
  */
 export interface IPnpmShrinkwrapYaml {
+    /** The version of the lockfile format */
+    lockfileVersion?: string | number;
     /** The list of resolved version numbers for direct dependencies */
-    dependencies: {
-        [dependency: string]: string;
-    };
+    dependencies: Record<string, string>;
     /** The list of importers for local workspace projects */
-    importers: {
-        [relativePath: string]: IPnpmShrinkwrapImporterYaml;
-    };
+    importers: Record<string, IPnpmShrinkwrapImporterYaml>;
     /** The description of the solved graph */
-    packages: {
-        [dependencyVersion: string]: IPnpmShrinkwrapDependencyYaml;
-    };
+    packages: Record<string, IPnpmShrinkwrapDependencyYaml>;
     /** URL of the registry which was used */
     registry: string;
     /** The list of specifiers used to resolve direct dependency versions */
-    specifiers: {
-        [dependency: string]: string;
-    };
+    specifiers: Record<string, string>;
 }
 /**
  * Given an encoded "dependency key" from the PNPM shrinkwrap file, this parses it into an equivalent
@@ -112,11 +101,13 @@ export interface IPnpmShrinkwrapYaml {
  *
  * @returns a SemVer string, or undefined if the version specifier cannot be parsed
  */
-export declare function parsePnpmDependencyKey(dependencyName: string, dependencyKey: string): DependencySpecifier | undefined;
+export declare function parsePnpmDependencyKey(dependencyName: string, versionSpecifier: IPnpmVersionSpecifier): DependencySpecifier | undefined;
+export declare function normalizePnpmVersionSpecifier(versionSpecifier: IPnpmVersionSpecifier): string;
 export declare class PnpmShrinkwrapFile extends BaseShrinkwrapFile {
+    readonly shrinkwrapFileMajorVersion: number;
     readonly isWorkspaceCompatible: boolean;
     readonly registry: string;
-    readonly dependencies: ReadonlyMap<string, string>;
+    readonly dependencies: ReadonlyMap<string, IPnpmVersionSpecifier>;
     readonly importers: ReadonlyMap<string, IPnpmShrinkwrapImporterYaml>;
     readonly specifiers: ReadonlyMap<string, string>;
     readonly packages: ReadonlyMap<string, IPnpmShrinkwrapDependencyYaml>;
@@ -137,7 +128,7 @@ export declare class PnpmShrinkwrapFile extends BaseShrinkwrapFile {
      * Example of return value: file:projects/build-tools.tgz
      */
     getTarballPath(packageName: string): string | undefined;
-    getTopLevelDependencyKey(dependencyName: string): string | undefined;
+    getTopLevelDependencyKey(dependencyName: string): IPnpmVersionSpecifier | undefined;
     /**
      * Gets the version number from the list of top-level dependencies in the "dependencies" section
      * of the shrinkwrap file. Sample return values:
@@ -150,7 +141,7 @@ export declare class PnpmShrinkwrapFile extends BaseShrinkwrapFile {
      */
     getTopLevelDependencyVersion(dependencyName: string): DependencySpecifier | undefined;
     /**
-     * The PNPM shrinkwrap file has top-level dependencies on the temp projects like this:
+     * The PNPM shrinkwrap file has top-level dependencies on the temp projects like this (version 5.x):
      *
      * ```
      * dependencies:
@@ -164,12 +155,32 @@ export declare class PnpmShrinkwrapFile extends BaseShrinkwrapFile {
      *     version: 0.0.0
      * ```
      *
-     * We refer to 'file:projects/my-app.tgz_25c559a5921686293a001a397be4dce0' as the temp project dependency key
-     * of the temp project '@rush-temp/my-app'.
+     * or in version 6.1, like this:
+     * ```
+     * dependencies:
+     *  '@rush-temp/my-app':
+     *    specifier: file:./projects/my-app.tgz
+     *    version: file:projects/my-app.tgz
+     *  packages:
+     *    /@types/node@10.14.15:
+     *      resolution: {integrity: sha512-iAB+**==}
+     *      dev: false
+     *    file:projects/my-app.tgz
+     *      resolution: {integrity: sha512-guuoFIc**==, tarball: file:projects/sp-filepicker.tgz}
+     *      name: '@rush-temp/my-app'
+     *      version: 0.0.0
+     *      dependencies:
+     *        '@microsoft/load-themed-styles': 1.10.7
+     *        ...
+     *      dev: false
+     * ```
+     *
+     * We refer to 'file:projects/my-app.tgz_25c559a5921686293a001a397be4dce0' or 'file:projects/my-app.tgz' as
+     * the temp project dependency key of the temp project '@rush-temp/my-app'.
      */
     getTempProjectDependencyKey(tempProjectName: string): string | undefined;
     getShrinkwrapEntryFromTempProjectDependencyKey(tempProjectDependencyKey: string): IPnpmShrinkwrapDependencyYaml | undefined;
-    getShrinkwrapEntry(name: string, version: string): IPnpmShrinkwrapDependencyYaml | undefined;
+    getShrinkwrapEntry(name: string, version: IPnpmVersionSpecifier): IPnpmShrinkwrapDependencyYaml | undefined;
     /**
      * Serializes the PNPM Shrinkwrap file
      *

package/lib/utilities/objectUtilities.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Determines if two objects are deeply equal.
+ */
+export declare function objectsAreDeepEqual<TObject>(a: TObject, b: TObject): boolean;
+export declare function cloneDeep<TObject>(obj: TObject): TObject;
+export declare function merge<TBase extends object, TOther>(base: TBase, other: TOther): (TBase & TOther) | TOther;
+//# sourceMappingURL=objectUtilities.d.ts.map

package/lib/utilities/objectUtilities.js

@@ -0,0 +1 @@
+module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("utilities/objectUtilities");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.100.0-pr4132",
+  "version": "5.100.0",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -14,18 +14,18 @@
   "dependencies": {
     "@types/node-fetch": "2.6.2",
     "tapable": "2.2.1",
-    "@rushstack/node-core-library": "3.59.2"
+    "@rushstack/node-core-library": "3.59.3"
   },
   "devDependencies": {
     "@types/semver": "7.3.5",
     "@types/webpack-env": "1.18.0",
-    "@microsoft/rush-lib": "5.100.0-pr4132",
-    "@rushstack/eslint-config": "3.3.0",
-    "@rushstack/heft": "0.51.0",
-    "@rushstack/heft-node-rig": "2.0.0",
-    "@rushstack/stream-collator": "4.0.237",
-    "@rushstack/ts-command-line": "4.13.3",
-    "@rushstack/terminal": "0.5.12"
+    "@microsoft/rush-lib": "5.100.0",
+    "@rushstack/eslint-config": "3.3.1",
+    "@rushstack/heft": "0.54.0",
+    "@rushstack/heft-node-rig": "2.2.6",
+    "@rushstack/stream-collator": "4.0.246",
+    "@rushstack/ts-command-line": "4.15.0",
+    "@rushstack/terminal": "0.5.21"
   },
   "scripts": {
     "build": "heft build --clean",