@rushstack/rush-sdk 5.97.1-pr3949.2 → 5.98.0

package/lib/api/CobuildConfiguration.d.ts

@@ -1,63 +0,0 @@
-import { ITerminal } from '@rushstack/node-core-library';
-import { RushSession } from '../pluginFramework/RushSession';
-import type { ICobuildLockProvider } from '../logic/cobuild/ICobuildLockProvider';
-import type { RushConfiguration } from './RushConfiguration';
-/**
- * @beta
- */
-export interface ICobuildJson {
-    cobuildEnabled: boolean;
-    cobuildLockProvider: string;
-}
-/**
- * @beta
- */
-export interface ICobuildConfigurationOptions {
-    cobuildJson: ICobuildJson;
-    rushConfiguration: RushConfiguration;
-    rushSession: RushSession;
-}
-/**
- * Use this class to load and save the "common/config/rush/cobuild.json" config file.
- * This file provides configuration options for the Rush Cobuild feature.
- * @beta
- */
-export declare class CobuildConfiguration {
-    private static _jsonSchema;
-    /**
-     * Indicates whether the cobuild feature is enabled.
-     * Typically it is enabled in the cobuild.json config file.
-     *
-     * Note: The orchestrator (or local users) should always have to opt into running with cobuilds by
-     * providing a cobuild context id. Even if cobuilds are "enabled" as a feature, they don't
-     * actually turn on for that particular build unless the cobuild context id is provided as an
-     * non-empty string.
-     */
-    readonly cobuildEnabled: boolean;
-    /**
-     * Cobuild context id
-     *
-     * @remarks
-     * The cobuild feature won't be enabled until the context id is provided as an non-empty string.
-     */
-    readonly cobuildContextId: string | undefined;
-    /**
-     * If true, Rush will automatically handle the leaf project with build cache "disabled" by writing
-     * to the cache in a special "log files only mode". This is useful when you want to use Cobuilds
-     * to improve the performance in CI validations and the leaf projects have not enabled cache.
-     */
-    readonly cobuildLeafProjectLogOnlyAllowed: boolean;
-    readonly cobuildLockProvider: ICobuildLockProvider;
-    private constructor();
-    /**
-     * Attempts to load the cobuild.json data from the standard file path `common/config/rush/cobuild.json`.
-     * If the file has not been created yet, then undefined is returned.
-     */
-    static tryLoadAsync(terminal: ITerminal, rushConfiguration: RushConfiguration, rushSession: RushSession): Promise<CobuildConfiguration | undefined>;
-    static getCobuildConfigFilePath(rushConfiguration: RushConfiguration): string;
-    private static _loadAsync;
-    get contextId(): string | undefined;
-    connectLockProviderAsync(): Promise<void>;
-    disconnectLockProviderAsync(): Promise<void>;
-}
-//# sourceMappingURL=CobuildConfiguration.d.ts.map

package/lib/api/CobuildConfiguration.js

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

package/lib/logic/cobuild/CobuildLock.d.ts

@@ -1,24 +0,0 @@
-import type { CobuildConfiguration } from '../../api/CobuildConfiguration';
-import type { ProjectBuildCache } from '../buildCache/ProjectBuildCache';
-import type { OperationStatus } from '../operations/OperationStatus';
-import type { ICobuildContext } from './ICobuildLockProvider';
-export interface ICobuildLockOptions {
-    cobuildConfiguration: CobuildConfiguration;
-    projectBuildCache: ProjectBuildCache;
-}
-export interface ICobuildCompletedState {
-    status: OperationStatus.Success | OperationStatus.SuccessWithWarning | OperationStatus.Failure;
-    cacheId: string;
-}
-export declare class CobuildLock {
-    readonly projectBuildCache: ProjectBuildCache;
-    readonly cobuildConfiguration: CobuildConfiguration;
-    private _cobuildContext;
-    constructor(options: ICobuildLockOptions);
-    setCompletedStateAsync(state: ICobuildCompletedState): Promise<void>;
-    getCompletedStateAsync(): Promise<ICobuildCompletedState | undefined>;
-    tryAcquireLockAsync(): Promise<boolean>;
-    renewLockAsync(): Promise<void>;
-    get cobuildContext(): ICobuildContext;
-}
-//# sourceMappingURL=CobuildLock.d.ts.map

package/lib/logic/cobuild/ICobuildLockProvider.d.ts

@@ -1,46 +0,0 @@
-import type { OperationStatus } from '../operations/OperationStatus';
-/**
- * @beta
- */
-export interface ICobuildContext {
-    /**
-     * The contextId is provided by the monorepo maintainer, it reads from environment variable {@link EnvironmentVariableNames.RUSH_COBUILD_CONTEXT_ID}.
-     * It ensure only the builds from the same given contextId cooperated. If user was more permissive,
-     * and wanted all PR and CI builds building anything with the same contextId to cooperate, then just
-     * set it to a static value.
-     */
-    contextId: string;
-    /**
-     * The id of cache. It should be keep same as the normal cacheId from ProjectBuildCache.
-     * Otherwise, there is a discrepancy in the success case then turning on cobuilds will
-     * fail to populate the normal build cache.
-     */
-    cacheId: string;
-    /**
-     * {@inheritdoc RushConstants.cobuildLockVersion}
-     */
-    version: number;
-}
-/**
- * @beta
- */
-export interface ICobuildCompletedState {
-    status: OperationStatus.Success | OperationStatus.SuccessWithWarning | OperationStatus.Failure;
-    /**
-     * Completed state points to the cache id that was used to store the build cache.
-     * Note: Cache failed builds in a separate cache id
-     */
-    cacheId: string;
-}
-/**
- * @beta
- */
-export interface ICobuildLockProvider {
-    connectAsync(): Promise<void>;
-    disconnectAsync(): Promise<void>;
-    acquireLockAsync(context: ICobuildContext): Promise<boolean>;
-    renewLockAsync(context: ICobuildContext): Promise<void>;
-    setCompletedStateAsync(context: ICobuildContext, state: ICobuildCompletedState): Promise<void>;
-    getCompletedStateAsync(context: ICobuildContext): Promise<ICobuildCompletedState | undefined>;
-}
-//# sourceMappingURL=ICobuildLockProvider.d.ts.map

package/lib/logic/cobuild/ICobuildLockProvider.js

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

package/lib/logic/operations/CacheableOperationPlugin.d.ts

@@ -1,21 +0,0 @@
-import { CobuildLock } from '../cobuild/CobuildLock';
-import { ProjectBuildCache } from '../buildCache/ProjectBuildCache';
-import type { IPhasedCommandPlugin, PhasedCommandHooks } from '../../pluginFramework/PhasedCommandHooks';
-export interface IOperationBuildCacheContext {
-    isCacheWriteAllowed: boolean;
-    isCacheReadAllowed: boolean;
-    isSkipAllowed: boolean;
-    projectBuildCache: ProjectBuildCache | undefined;
-    cobuildLock: CobuildLock | undefined;
-}
-export declare class CacheableOperationPlugin implements IPhasedCommandPlugin {
-    private _buildCacheContextByOperationRunner;
-    apply(hooks: PhasedCommandHooks): void;
-    private _applyShellOperationRunner;
-    private _getBuildCacheContextByRunner;
-    private _getBuildCacheContextByRunnerOrThrow;
-    private _tryGetProjectBuildCacheAsync;
-    private _tryGetLogOnlyProjectBuildCacheAsync;
-    private _tryGetCobuildLockAsync;
-}
-//# sourceMappingURL=CacheableOperationPlugin.d.ts.map

package/lib/logic/operations/CacheableOperationPlugin.js

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

package/lib/logic/operations/OperationRunnerHooks.d.ts

@@ -1,50 +0,0 @@
-import { AsyncSeriesWaterfallHook } from 'tapable';
-import type { ITerminal } from '@rushstack/node-core-library';
-import type { IOperationRunnerContext } from './IOperationRunner';
-import type { OperationStatus } from './OperationStatus';
-import type { IProjectDeps, ShellOperationRunner } from './ShellOperationRunner';
-import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
-import type { IPhase } from '../../api/CommandLineConfiguration';
-/**
- * A plugin tht interacts with a operation runner
- */
-export interface IOperationRunnerPlugin {
-    /**
-     * Applies this plugin.
-     */
-    apply(hooks: OperationRunnerHooks): void;
-}
-export interface IOperationRunnerBeforeExecuteContext {
-    context: IOperationRunnerContext;
-    runner: ShellOperationRunner;
-    earlyReturnStatus: OperationStatus | undefined;
-    terminal: ITerminal;
-    projectDeps: IProjectDeps | undefined;
-    lastProjectDeps: IProjectDeps | undefined;
-    trackedProjectFiles: string[] | undefined;
-    logPath: string;
-    errorLogPath: string;
-    rushProject: RushConfigurationProject;
-    phase: IPhase;
-    commandName: string;
-    commandToRun: string;
-}
-export interface IOperationRunnerAfterExecuteContext {
-    context: IOperationRunnerContext;
-    terminal: ITerminal;
-    /**
-     * Exit code of the operation command
-     */
-    exitCode: number;
-    status: OperationStatus;
-    taskIsSuccessful: boolean;
-}
-/**
- * Hooks into the lifecycle of the operation runner
- *
- */
-export declare class OperationRunnerHooks {
-    beforeExecute: AsyncSeriesWaterfallHook<IOperationRunnerBeforeExecuteContext>;
-    afterExecute: AsyncSeriesWaterfallHook<IOperationRunnerAfterExecuteContext>;
-}
-//# sourceMappingURL=OperationRunnerHooks.d.ts.map

package/lib/logic/operations/OperationRunnerHooks.js

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

package/lib/logic/operations/PeriodicCallback.d.ts

@@ -1,20 +0,0 @@
-export declare type ICallbackFn = () => Promise<void> | void;
-export interface IPeriodicCallbackOptions {
-    interval: number;
-}
-/**
- * A help class to run callbacks in a loop with a specified interval.
- *
- * @beta
- */
-export declare class PeriodicCallback {
-    private _callbacks;
-    private _interval;
-    private _intervalId;
-    private _isRunning;
-    constructor(options: IPeriodicCallbackOptions);
-    addCallback(callback: ICallbackFn): void;
-    start(): void;
-    stop(): void;
-}
-//# sourceMappingURL=PeriodicCallback.d.ts.map

package/lib/logic/operations/PeriodicCallback.js

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