Extract CredentialCache from Rush into @rushstack/credential-cache (#5421)

* Add new credential-cache package

* Add test command

* Factor out CredentialCache

* Fix routing

* Fix API

* Update readme

* Update readme

* rush update

* Forward rush-user folder name

* Remove old credentials schema

* Restore caching in getHomeFolder

* Remove reexport of areDeepEqual

* Update API md

* Centralize polyfill

---------

Co-authored-by: David Michon <[email protected]>

Author: dmichon-msft

README.md

@@ -80,6 +80,7 @@ These GitHub repositories provide supplementary resources for Rush Stack:
 | [/heft-plugins/heft-webpack4-plugin](./heft-plugins/heft-webpack4-plugin/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Fheft-webpack4-plugin.svg)](https://badge.fury.io/js/%40rushstack%2Fheft-webpack4-plugin) | [changelog](./heft-plugins/heft-webpack4-plugin/CHANGELOG.md) | [@rushstack/heft-webpack4-plugin](https://www.npmjs.com/package/@rushstack/heft-webpack4-plugin) |
 | [/heft-plugins/heft-webpack5-plugin](./heft-plugins/heft-webpack5-plugin/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Fheft-webpack5-plugin.svg)](https://badge.fury.io/js/%40rushstack%2Fheft-webpack5-plugin) | [changelog](./heft-plugins/heft-webpack5-plugin/CHANGELOG.md) | [@rushstack/heft-webpack5-plugin](https://www.npmjs.com/package/@rushstack/heft-webpack5-plugin) |
 | [/libraries/api-extractor-model](./libraries/api-extractor-model/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fapi-extractor-model.svg)](https://badge.fury.io/js/%40microsoft%2Fapi-extractor-model) | [changelog](./libraries/api-extractor-model/CHANGELOG.md) | [@microsoft/api-extractor-model](https://www.npmjs.com/package/@microsoft/api-extractor-model) |
+| [/libraries/credential-cache](./libraries/credential-cache/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Fcredential-cache.svg)](https://badge.fury.io/js/%40rushstack%2Fcredential-cache) | [changelog](./libraries/credential-cache/CHANGELOG.md) | [@rushstack/credential-cache](https://www.npmjs.com/package/@rushstack/credential-cache) |
 | [/libraries/debug-certificate-manager](./libraries/debug-certificate-manager/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Fdebug-certificate-manager.svg)](https://badge.fury.io/js/%40rushstack%2Fdebug-certificate-manager) | [changelog](./libraries/debug-certificate-manager/CHANGELOG.md) | [@rushstack/debug-certificate-manager](https://www.npmjs.com/package/@rushstack/debug-certificate-manager) |
 | [/libraries/heft-config-file](./libraries/heft-config-file/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Fheft-config-file.svg)](https://badge.fury.io/js/%40rushstack%2Fheft-config-file) | [changelog](./libraries/heft-config-file/CHANGELOG.md) | [@rushstack/heft-config-file](https://www.npmjs.com/package/@rushstack/heft-config-file) |
 | [/libraries/load-themed-styles](./libraries/load-themed-styles/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fload-themed-styles.svg)](https://badge.fury.io/js/%40microsoft%2Fload-themed-styles) | [changelog](./libraries/load-themed-styles/CHANGELOG.md) | [@microsoft/load-themed-styles](https://www.npmjs.com/package/@microsoft/load-themed-styles) |

common/changes/@microsoft/rush/extract-credential-cache_2025-10-22-01-44.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Extract CredentialCache API out into \"@rushstack/credential-cache\". Reference directly in plugins to avoid pulling in all of \"@rushstack/rush-sdk\" unless necessary.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

common/changes/@rushstack/credential-cache/extract-credential-cache_2025-10-22-01-44.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/credential-cache",
+      "comment": "Create dedicated package for the Rush \"CredentialCache\" API. This API manages credential persistence on the local machine.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/credential-cache"
+}

common/changes/@rushstack/node-core-library/extract-credential-cache_2025-10-22-01-44.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/node-core-library",
+      "comment": "Add \"Objects.areDeepEqual\" and \"User.getHomeFolder\" APIs.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/node-core-library"
+}

common/config/rush/nonbrowser-approved-packages.json

@@ -130,6 +130,10 @@
       "name": "@rspack/dev-server",
       "allowedCategories": [ "libraries" ]
     },
+    {
+      "name": "@rushstack/credential-cache",
+      "allowedCategories": [ "libraries" ]
+    },
     {
       "name": "@rushstack/debug-certificate-manager",
       "allowedCategories": [ "libraries", "vscode-extensions" ]

common/config/subspaces/build-tests-subspace/pnpm-lock.yaml

@@ -1,6 +1,6 @@
 // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
 {
-  "pnpmShrinkwrapHash": "1dc2b69423ca353582cec8716410a0b8a8210aff",
+  "pnpmShrinkwrapHash": "c9e998d8d98c587075f2380a11aa0816aecfd2fc",
   "preferredVersionsHash": "550b4cee0bef4e97db6c6aad726df5149d20e7d9",
-  "packageJsonInjectedDependenciesHash": "7bf222162008849ca931709cbaa90632d56766da"
+  "packageJsonInjectedDependenciesHash": "9c50330f156d5d74c5dd1fb2e3aa6b9c2a2403c7"
 }

common/config/subspaces/build-tests-subspace/repo-state.json

@@ -0,0 +1,50 @@
+## API Report File for "@rushstack/credential-cache"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public (undocumented)
+export class CredentialCache implements Disposable {
+    // (undocumented)
+    [Symbol.dispose](): void;
+    // (undocumented)
+    deleteCacheEntry(cacheId: string): void;
+    // (undocumented)
+    dispose(): void;
+    // (undocumented)
+    static initializeAsync(options: ICredentialCacheOptions): Promise<CredentialCache>;
+    // (undocumented)
+    saveIfModifiedAsync(): Promise<void>;
+    // (undocumented)
+    setCacheEntry(cacheId: string, entry: ICredentialCacheEntry): void;
+    // (undocumented)
+    trimExpiredEntries(): void;
+    // (undocumented)
+    tryGetCacheEntry(cacheId: string): ICredentialCacheEntry | undefined;
+    // (undocumented)
+    static usingAsync(options: ICredentialCacheOptions, doActionAsync: (credentialCache: CredentialCache) => Promise<void> | void): Promise<void>;
+}
+
+// @public (undocumented)
+export interface ICredentialCacheEntry {
+    // (undocumented)
+    credential: string;
+    // (undocumented)
+    credentialMetadata?: object;
+    // (undocumented)
+    expires?: Date;
+}
+
+// @public (undocumented)
+export interface ICredentialCacheOptions {
+    // (undocumented)
+    cacheFilePath?: string;
+    // (undocumented)
+    supportEditing: boolean;
+}
+
+// @public
+export const RUSH_USER_FOLDER_NAME: '.rush-user';
+
+```