@rushstack/rush-sdk 5.90.0 → 5.90.2-pr3954.0

package/README.md

@@ -1,29 +1,64 @@
 ## @rushstack/rush-sdk
 
-This is a companion package for the Rush tool.  See the [@microsoft/rush](https://www.npmjs.com/package/@microsoft/rush) package for details.
+This is a companion package for the Rush tool. See the [@microsoft/rush](https://www.npmjs.com/package/@microsoft/rush) package for details.
 
-⚠ ***THIS PACKAGE IS EXPERIMENTAL*** ⚠
+⚠ **_THIS PACKAGE IS EXPERIMENTAL_** ⚠
 
-The **@rushstack/rush-sdk** package acts as a lightweight proxy for accessing the APIs of the **@microsoft/rush-lib** engine.  It is intended to support three different use cases:
+The **@rushstack/rush-sdk** package acts as a lightweight proxy for accessing the APIs of the **@microsoft/rush-lib** engine. It is intended to support three different use cases:
 
-1. Rush plugins should import from **@rushstack/rush-sdk** instead of **@microsoft/rush-lib**.  This gives plugins full access to Rush APIs while avoiding a redundant installation of those packages.  At runtime, the APIs will be bound to the correct `rushVersion` from **rush.json**, and guaranteed to be the same **@microsoft/rush-lib** module instance as the plugin host.
+1. Rush plugins should import from **@rushstack/rush-sdk** instead of **@microsoft/rush-lib**. This gives plugins full access to Rush APIs while avoiding a redundant installation of those packages. At runtime, the APIs will be bound to the correct `rushVersion` from **rush.json**, and guaranteed to be the same **@microsoft/rush-lib** module instance as the plugin host.
 
-2. When authoring unit tests for a Rush plugin, developers should add **@microsoft/rush-lib** to their **package.json** `devDependencies`.  In this context, **@rushstack/rush-sdk** will resolve to that instance for testing purposes.
-
-3. For scripts and tools that are designed to be used in a Rush monorepo, in the future **@rushstack/rush-sdk** will automatically invoke **install-run-rush.js** and load the local installation.  This ensures that tools load a compatible version of the Rush engine for the given branch.  Once this is implemented, **@rushstack/rush-sdk** can replace **@microsoft/rush-lib** entirely as the official API interface, with the latter serving as the underlying implementation.
+2. When authoring unit tests for a Rush plugin, developers should add **@microsoft/rush-lib** to their **package.json** `devDependencies`. In this context, **@rushstack/rush-sdk** will resolve to that instance for testing purposes.
 
+3. For scripts and tools that are designed to be used in a Rush monorepo, in the future **@rushstack/rush-sdk** will automatically invoke **install-run-rush.js** and load the local installation. This ensures that tools load a compatible version of the Rush engine for the given branch. Once this is implemented, **@rushstack/rush-sdk** can replace **@microsoft/rush-lib** entirely as the official API interface, with the latter serving as the underlying implementation.
 
 The **@rushstack/rush-sdk** API declarations are identical to the corresponding version of **@microsoft/rush-lib**.
 
-## Debugging
+## Importing internal APIs
+
+Backwards compatibility is only guaranteed for the APIs marked as `@public` in the official `rush-lib.d.ts` entry point.
+However, sometimes it is expedient for a script to import internal modules from `@microsoft/rush-lib` to access
+unofficial APIs. This practice faces a technical challenge that `@microsoft/rush-lib` is bundled using Webpack.
+The `@rushstack/rush-sdk` package provides stub files that import the corresponding internal module from the
+Webpack bundle, via the `@rushstack/webpack-deep-imports-plugin` mechanism.
+
+> **WARNING:** If the loaded `rush-lib` package has a different version from `rush-sdk`, there is
+> no guarantee that the corresponding path will exist or have the same type signature.
+> Access internal APIs at your own risk. If you find an internal API to be useful, we recommend
+> that you create a GitHub issue proposing to make it public.
+
+Example 1: Conventional import of a public API:
+
+```ts
+// THIS IS THE RECOMMENDED PRACTICE:
+import { RushConfiguration } from '@rushstack/rush-sdk';
+const config = RushConfiguration.loadFromDefaultLocation();
+console.log(config.commonFolder);
+```
 
-Verbose logging can be turn on by set environment variable `RUSH_SDK_DEBUG` to `1`
+Example 2: How to import an internal API:
+
+```ts
+// WARNING: INTERNAL APIS MAY CHANGE AT ANY TIME -- USE THIS AT YOUR OWN RISK:
+
+// Important: Since we're calling an internal API, we need to use the unbundled .d.ts files
+// instead of the normal .d.ts rollup
+import { RushConfiguration } from '@rushstack/rush-sdk/lib/';
+const config = RushConfiguration.loadFromDefaultLocation();
+console.log(config.commonFolder);
+
+// Load an internal module from the Webpack bundle using a path-based import of a stub file:
+import { GitEmailPolicy } from '@rushstack/rush-sdk/lib/logic/policy/GitEmailPolicy';
+console.log(GitEmailPolicy.getEmailExampleLines(config));
+```
+
+## Debugging
 
+Verbose logging can be enabled by setting environment variable `RUSH_SDK_DEBUG=1`.
 
 ## Links
 
-- [CHANGELOG.md](
-  https://github.com/microsoft/rushstack/blob/main/apps/rush/CHANGELOG.md) - Find
+- [CHANGELOG.md](https://github.com/microsoft/rushstack/blob/main/apps/rush/CHANGELOG.md) - Find
   out what's new in the latest version
 - [API Reference](https://api.rushstack.io/pages/rush-lib/)
 

package/dist/rush-lib.d.ts

@@ -1095,6 +1095,23 @@ export declare interface IOperationExecutionResult {
     readonly nonCachedDurationMs: number | undefined;
 }
 
+/**
+ * @internal
+ */
+export declare interface _IOperationMetadata {
+    durationInSeconds: number;
+    logPath: string;
+    errorLogPath: string;
+}
+
+/**
+ * @internal
+ */
+export declare interface _IOperationMetadataManagerOptions {
+    rushProject: RushConfigurationProject;
+    phase: IPhase;
+}
+
 /**
  * Options for constructing a new Operation.
  * @alpha
@@ -1177,11 +1194,11 @@ export declare interface IOperationRunnerContext {
      */
     stdioSummarizer: StdioSummarizer;
     /**
-     * Object used to record state of the operation.
+     * Object used to manage metadata of the operation.
      *
      * @internal
      */
-    _operationStateFile?: _OperationStateFile;
+    _operationMetadataManager?: _OperationMetadataManager;
     /**
      * Object used to track elapsed time.
      */
@@ -1192,8 +1209,8 @@ export declare interface IOperationRunnerContext {
  * @internal
  */
 export declare interface _IOperationStateFileOptions {
-    rushProject: RushConfigurationProject;
-    phase: IPhase;
+    projectFolder: string;
+    metadataFolder: string;
 }
 
 /**
@@ -1962,6 +1979,35 @@ export declare class Operation {
     deleteDependency(dependency: Operation): void;
 }
 
+/**
+ * A helper class for managing the meta files of a operation.
+ *
+ * @internal
+ */
+export declare class _OperationMetadataManager {
+    readonly stateFile: _OperationStateFile;
+    private _metadataFolder;
+    private _logPath;
+    private _errorLogPath;
+    private _relativeLogPath;
+    private _relativeErrorLogPath;
+    constructor(options: _IOperationMetadataManagerOptions);
+    /**
+     * Returns the relative paths of the metadata files to project folder.
+     *
+     * Example: `.rush/temp/operation/_phase_build/state.json`
+     * Example: `.rush/temp/operation/_phase_build/all.log`
+     * Example: `.rush/temp/operation/_phase_build/error.log`
+     */
+    get relativeFilepaths(): string[];
+    saveAsync({ durationInSeconds, logPath, errorLogPath }: _IOperationMetadata): Promise<void>;
+    tryRestoreAsync({ terminal, logPath, errorLogPath }: {
+        terminal: ITerminal;
+        logPath: string;
+        errorLogPath: string;
+    }): Promise<void>;
+}
+
 /**
  * A helper class for managing the state file of a operation.
  *
@@ -1970,17 +2016,19 @@ export declare class Operation {
 export declare class _OperationStateFile {
     private _state;
     /**
-     * Returns the filename of the metadata file.
+     * The path of the state json file.
+     *
+     * Example: `/code/repo/my-project/.rush/temp/operation/_phase_build/state.json`
      */
-    readonly filename: string;
-    constructor(options: _IOperationStateFileOptions);
-    private static _getFilename;
+    readonly filepath: string;
     /**
-     * ProjectBuildCache expects the relative path for better logging
+     * The relative path of the state json file to project folder
      *
-     * @internal
+     * Example: `.rush/temp/operation/_phase_build/state.json`
      */
-    static getFilenameRelativeToProjectRoot(phase: IPhase): string;
+    readonly relativeFilepath: string;
+    static filename: string;
+    constructor(options: _IOperationStateFileOptions);
     get state(): _IOperationStateJson | undefined;
     writeAsync(json: _IOperationStateJson): Promise<void>;
     tryRestoreAsync(): Promise<_IOperationStateJson | undefined>;
@@ -2452,6 +2500,7 @@ export declare class RepoStateFile {
  */
 export declare class Rush {
     private static __rushLibPackageJson;
+    private static __rushLibPackageFolder;
     /**
      * This API is used by the `@microsoft/rush` front end to launch the "rush" command-line.
      * Third-party tools should not use this API.  Instead, they should execute the "rush" binary
@@ -2485,6 +2534,8 @@ export declare class Rush {
      * @internal
      */
     static get _rushLibPackageJson(): IPackageJson;
+    static get _rushLibPackageFolder(): string;
+    private static _ensureOwnPackageJsonIsLoaded;
     /**
      * Assign the `RUSH_INVOKED_FOLDER` environment variable during startup.  This is only applied when
      * Rush is invoked via the CLI, not via the `@microsoft/rush-lib` automation API.
@@ -3393,6 +3444,21 @@ export declare class _RushGlobalFolder {
     constructor();
 }
 
+/**
+ * Used by rush-sdk to access internals of rush-lib.
+ * @internal
+ */
+export declare class _RushInternals {
+    /**
+     * Used by rush-sdk to load an internal API specified by its module path.
+     *
+     * @param srcImportPath - The module path to load.  For example, to refer to `src/api/ChangeFile.ts`,
+     * the `srcImportPath` would be `"api/ChangeFile"`.
+     * @returns the module object as would be returned by `require()`
+     */
+    static loadModule(srcImportPath: string): unknown;
+}
+
 /**
  * Hooks into the lifecycle of the Rush process invocation that plugins may tap into.
  *

package/lib/api/ApprovedPackagesConfiguration.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Part of IApprovedPackagesJson.
+ */
+export interface IApprovedPackagesItemJson {
+    name: string;
+    allowedCategories: string[];
+}
+/**
+ * This represents the JSON data structure for the "browser-approved-packages.json"
+ * and "nonbrowser-approved-packages.json" configuration files.  See "approved-packages.schema.json"
+ * for documentation.
+ */
+export interface IApprovedPackagesJson {
+    $schema?: string;
+    packages: IApprovedPackagesItemJson[];
+}
+/**
+ * An item returned by ApprovedPackagesConfiguration
+ * @public
+ */
+export declare class ApprovedPackagesItem {
+    /**
+     * The NPM package name
+     */
+    packageName: string;
+    /**
+     * The project categories that are allowed to use this package.
+     */
+    allowedCategories: Set<string>;
+    /**
+     * @internal
+     */
+    constructor(packageName: string);
+}
+/**
+ * This represents the JSON file specified via the "approvedPackagesFile" option in rush.json.
+ * @public
+ */
+export declare class ApprovedPackagesConfiguration {
+    private static _jsonSchema;
+    items: ApprovedPackagesItem[];
+    private _itemsByName;
+    private _loadedJson;
+    private _jsonFilename;
+    constructor(jsonFilename: string);
+    /**
+     * Clears all the settings, returning to an empty state.
+     */
+    clear(): void;
+    getItemByName(packageName: string): ApprovedPackagesItem | undefined;
+    addOrUpdatePackage(packageName: string, reviewCategory: string): boolean;
+    /**
+     * If the file exists, calls loadFromFile().
+     */
+    tryLoadFromFile(approvedPackagesPolicyEnabled: boolean): boolean;
+    /**
+     * Loads the configuration data from the filename that was passed to the constructor.
+     */
+    loadFromFile(): void;
+    /**
+     * Loads the configuration data to the filename that was passed to the constructor.
+     */
+    saveToFile(): void;
+    /**
+     * Helper function only used by the constructor when loading the file.
+     */
+    private _addItemJson;
+    /**
+     * Helper function that adds an already created ApprovedPackagesItem to the
+     * list and set.
+     */
+    private _addItem;
+}
+//# sourceMappingURL=ApprovedPackagesConfiguration.d.ts.map

package/lib/api/ApprovedPackagesConfiguration.js

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

package/lib/api/ApprovedPackagesPolicy.d.ts

@@ -0,0 +1,54 @@
+import { ApprovedPackagesConfiguration } from './ApprovedPackagesConfiguration';
+import { RushConfiguration, IRushConfigurationJson } from './RushConfiguration';
+/**
+ * This is a helper object for RushConfiguration.
+ * It exposes the "approvedPackagesPolicy" feature from rush.json.
+ * @public
+ */
+export declare class ApprovedPackagesPolicy {
+    /**
+     * Whether the feature is enabled.  The feature is enabled if the "approvedPackagesPolicy"
+     * field is assigned in rush.json.
+     */
+    readonly enabled: boolean;
+    /**
+     * A list of NPM package scopes that will be excluded from review (e.g. `@types`)
+     */
+    readonly ignoredNpmScopes: ReadonlySet<string>;
+    /**
+     * A list of category names that are valid for usage as the RushConfigurationProject.reviewCategory field.
+     * This array will never be undefined.
+     */
+    readonly reviewCategories: ReadonlySet<string>;
+    /**
+     * Packages approved for usage in a web browser.  This is the stricter of the two types, so by default
+     * all new packages are added to this file.
+     *
+     * @remarks
+     *
+     * This is part of an optional approval workflow, whose purpose is to review any new dependencies
+     * that are introduced (e.g. maybe a legal review is required, or maybe we are trying to minimize bloat).
+     * When Rush discovers a new dependency has been added to package.json, it will update the file.
+     * The intent is that the file will be stored in Git and tracked by a branch policy that notifies
+     * reviewers when a PR attempts to modify the file.
+     *
+     * Example filename: `C:\MyRepo\common\config\rush\browser-approved-packages.json`
+     */
+    readonly browserApprovedPackages: ApprovedPackagesConfiguration;
+    /**
+     * Packages approved for usage everywhere *except* in a web browser.
+     *
+     * @remarks
+     *
+     * This is part of an optional approval workflow, whose purpose is to review any new dependencies
+     * that are introduced (e.g. maybe a legal review is required, or maybe we are trying to minimize bloat).
+     * The intent is that the file will be stored in Git and tracked by a branch policy that notifies
+     * reviewers when a PR attempts to modify the file.
+     *
+     * Example filename: `C:\MyRepo\common\config\rush\browser-approved-packages.json`
+     */
+    readonly nonbrowserApprovedPackages: ApprovedPackagesConfiguration;
+    /** @internal */
+    constructor(rushConfiguration: RushConfiguration, rushConfigurationJson: IRushConfigurationJson);
+}
+//# sourceMappingURL=ApprovedPackagesPolicy.d.ts.map

package/lib/api/ApprovedPackagesPolicy.js

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

package/lib/api/BuildCacheConfiguration.d.ts

@@ -0,0 +1,77 @@
+import { JsonObject, ITerminal } from '@rushstack/node-core-library';
+import { RushConfiguration } from './RushConfiguration';
+import { FileSystemBuildCacheProvider } from '../logic/buildCache/FileSystemBuildCacheProvider';
+import { ICloudBuildCacheProvider } from '../logic/buildCache/ICloudBuildCacheProvider';
+import { GetCacheEntryIdFunction } from '../logic/buildCache/CacheEntryId';
+import type { RushSession } from '../pluginFramework/RushSession';
+/**
+ * Describes the file structure for the "common/config/rush/build-cache.json" config file.
+ */
+export interface IBaseBuildCacheJson {
+    buildCacheEnabled: boolean;
+    cacheProvider: string;
+    cacheEntryNamePattern?: string;
+}
+/**
+ * @public
+ */
+export interface ILocalBuildCacheJson extends IBaseBuildCacheJson {
+    readonly cacheProvider: 'local-only';
+}
+/**
+ * @beta
+ */
+export interface ICloudBuildCacheJson extends IBaseBuildCacheJson {
+    readonly cacheProvider: string;
+    [otherConfigKey: string]: JsonObject;
+}
+/**
+ * @beta
+ */
+export declare type IBuildCacheJson = ICloudBuildCacheJson | ILocalBuildCacheJson;
+/**
+ * Use this class to load and save the "common/config/rush/build-cache.json" config file.
+ * This file provides configuration options for cached project build output.
+ * @beta
+ */
+export declare class BuildCacheConfiguration {
+    private static _jsonSchema;
+    /**
+     * Indicates whether the build cache feature is enabled.
+     * Typically it is enabled in the build-cache.json config file.
+     */
+    readonly buildCacheEnabled: boolean;
+    /**
+     * Indicates whether or not writing to the cache is enabled.
+     */
+    cacheWriteEnabled: boolean;
+    /**
+     * Method to calculate the cache entry id for a project, phase, and project state.
+     */
+    readonly getCacheEntryId: GetCacheEntryIdFunction;
+    /**
+     * The provider for interacting with the local build cache.
+     */
+    readonly localCacheProvider: FileSystemBuildCacheProvider;
+    /**
+     * The provider for interacting with the cloud build cache, if configured.
+     */
+    readonly cloudCacheProvider: ICloudBuildCacheProvider | undefined;
+    private constructor();
+    /**
+     * Attempts to load the build-cache.json data from the standard file path `common/config/rush/build-cache.json`.
+     * If the file has not been created yet, then undefined is returned.
+     */
+    static tryLoadAsync(terminal: ITerminal, rushConfiguration: RushConfiguration, rushSession: RushSession): Promise<BuildCacheConfiguration | undefined>;
+    /**
+     * Loads the build-cache.json data from the standard file path `common/config/rush/build-cache.json`.
+     * If the file has not been created yet, or if the feature is not enabled, then an error is reported.
+     */
+    static loadAndRequireEnabledAsync(terminal: ITerminal, rushConfiguration: RushConfiguration, rushSession: RushSession): Promise<BuildCacheConfiguration>;
+    /**
+     * Gets the absolute path to the build-cache.json file in the specified rush workspace.
+     */
+    static getBuildCacheConfigFilePath(rushConfiguration: RushConfiguration): string;
+    private static _loadAsync;
+}
+//# sourceMappingURL=BuildCacheConfiguration.d.ts.map

package/lib/api/BuildCacheConfiguration.js

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

package/lib/api/ChangeFile.d.ts

@@ -0,0 +1,42 @@
+import { RushConfiguration } from './RushConfiguration';
+import { IChangeFile, IChangeInfo } from './ChangeManagement';
+/**
+ * This class represents a single change file.
+ */
+export declare class ChangeFile {
+    private _changeFileData;
+    private _rushConfiguration;
+    /**
+     * @internal
+     */
+    constructor(changeFileData: IChangeFile, rushConfiguration: RushConfiguration);
+    /**
+     * Adds a change entry into the change file
+     * @param data - change information
+     */
+    addChange(data: IChangeInfo): void;
+    /**
+     * Gets all the change entries about the specified package from the change file.
+     * @param packageName - package name
+     */
+    getChanges(packageName: string): IChangeInfo[];
+    /**
+     * Writes the change file to disk in sync mode.
+     * Returns the file path.
+     * @returns the path to the file that was written (based on generatePath())
+     */
+    writeSync(): string;
+    /**
+     * Generates a file path for storing the change file to disk.
+     * Note that this value may change if called twice in a row,
+     * as it is partially based on the current date/time.
+     */
+    generatePath(): string;
+    /**
+     * Gets the current time, formatted as YYYY-MM-DD-HH-MM
+     * Optionally will include seconds
+     */
+    private _getTimestamp;
+    private _escapeFilename;
+}
+//# sourceMappingURL=ChangeFile.d.ts.map

package/lib/api/ChangeFile.js

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

package/lib/api/ChangeManagement.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Representation for a changes file
+ */
+export interface IChangeFile {
+    changes: IChangeInfo[];
+    packageName: string;
+    email: string | undefined;
+}
+/**
+ * Represents all of the types of change requests.
+ */
+export declare enum ChangeType {
+    none = 0,
+    dependency = 1,
+    hotfix = 2,
+    patch = 3,
+    minor = 4,
+    major = 5
+}
+export interface IVersionPolicyChangeInfo {
+    /**
+     * Defines the type of change.
+     */
+    changeType: ChangeType;
+    /**
+     * The new version for the version policy, as calculated by the findChangeRequests function.
+     */
+    newVersion: string;
+    /**
+     * The name of the version policy.
+     */
+    versionPolicyName: string;
+}
+/**
+ * Defines an IChangeInfo object.
+ */
+export interface IChangeInfo {
+    /**
+     * Defines the type of change. This is not expected to exist within the JSON file definition as we
+     * parse it from the "type" property.
+     */
+    changeType?: ChangeType;
+    /**
+     * Defines the array of related changes for the given package. This is used to iterate over comments
+     * requested by the change requests.
+     */
+    changes?: IChangeInfo[];
+    /**
+     * A user provided comment for the change.
+     */
+    comment?: string;
+    /**
+     * An optional dictionary of custom string fields.
+     */
+    customFields?: Record<string, string>;
+    /**
+     * The email of the user who provided the comment. Pulled from the Git log.
+     */
+    author?: string;
+    /**
+     * The commit hash for the change.
+     */
+    commit?: string;
+    /**
+     * The new downstream range dependency, as calculated by the findChangeRequests function.
+     */
+    newRangeDependency?: string;
+    /**
+     * The new version for the package, as calculated by the findChangeRequests function.
+     */
+    newVersion?: string;
+    /**
+     * The order in which the change request should be published.
+     */
+    order?: number;
+    /**
+     * The name of the package.
+     */
+    packageName: string;
+    /**
+     * The type of the package publishing request (patch/minor/major), as provided by the JSON file.
+     */
+    type?: string;
+}
+//# sourceMappingURL=ChangeManagement.d.ts.map

package/lib/api/ChangeManagement.js

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

package/lib/api/ChangeManager.d.ts

@@ -0,0 +1,16 @@
+import { RushConfiguration } from './RushConfiguration';
+/**
+ * A class that helps with programmatically interacting with Rush's change files.
+ * @public
+ */
+export declare class ChangeManager {
+    /**
+     * Creates a change file that has a 'none' type.
+     * @param rushConfiguration - The rush configuration we are working with
+     * @param projectName - The name of the project for which to create a change file
+     * @param emailAddress - The email address which should be associated with this change
+     * @returns the path to the file that was created, or undefined if no file was written
+     */
+    static createEmptyChangeFiles(rushConfiguration: RushConfiguration, projectName: string, emailAddress: string): string | undefined;
+}
+//# sourceMappingURL=ChangeManager.d.ts.map

package/lib/api/ChangeManager.js

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

package/lib/api/Changelog.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Interface representing a changelog json object for a package used to represent the parsed
+ * content of CHANGELOG.json
+ */
+export interface IChangelog {
+    /**
+     * Name of the project
+     */
+    name: string;
+    /**
+     * Entries within the changelog corresponding to each published version.
+     */
+    entries: IChangeLogEntry[];
+}
+/**
+ * Interface representing a single published entry in the changelog.
+ */
+export interface IChangeLogEntryComments {
+    /** Describes changes which cause a patch-level SemVer bump */
+    patch?: IChangeLogComment[];
+    /** Describes changes which cause a minor-level SemVer bump */
+    minor?: IChangeLogComment[];
+    /** Describes changes which cause a major-level SemVer bump */
+    major?: IChangeLogComment[];
+    /** Describes changes to the package's dependencies */
+    dependency?: IChangeLogComment[];
+    /** Describe changes that do not have version information */
+    none?: IChangeLogComment[];
+    /** Describe changes that do not have version information */
+    hotfix?: IChangeLogComment[];
+}
+/**
+ * Interface representing a single published entry in the changelog.
+ */
+export interface IChangeLogEntry {
+    /**
+     * Published version for the entry. (Example: 1.0.0)
+     */
+    version: string;
+    /**
+     * Git tag used to identify the published commit. (Example: b7f55611e54910327a206476b185265498c66acf)
+     */
+    tag: string;
+    /**
+     * The UTC date when the publish was applied. (Example: Fri, 02 Dec 2016 22:27:16 GMT)
+     */
+    date: string | undefined;
+    /**
+     * Comments for the entry, where key represents the ChangeType string (Example: major)
+     */
+    comments: IChangeLogEntryComments;
+}
+/**
+ * Interface representing a single changelog comment within an entry.
+ */
+export interface IChangeLogComment {
+    /**
+     * The given comment. (supports markdown.)
+     */
+    comment: string;
+    /**
+     * The author, if applicable, that created the change request.
+     */
+    author?: string;
+    /**
+     * The commit, if applicable, including the change request.
+     */
+    commit?: string;
+    /**
+     * An optional dictionary of custom string fields.
+     */
+    customFields?: Record<string, string>;
+}
+//# sourceMappingURL=Changelog.d.ts.map

package/lib/api/Changelog.js

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