@lesliechan721/aw 0.1.0-beta.3

package/dist/src/utils/lifecycle-active-store.d.ts

@@ -0,0 +1,175 @@
+import type { ArtifactState, ArtifactTarget, GeneratedArtifact, PlatformName, PluginLifecycleEvent, PluginMeta, Scope, TrackedHookGroupIdentity } from '../types.js';
+import { type ProcessLockFileSystem, type ProcessLockLease } from './process-lock.js';
+export declare const LIFECYCLE_ACTIVE_DIR = "lifecycle-active";
+export declare const LIFECYCLE_ACTIVE_SCHEMA_VERSION = 2;
+export declare const LIFECYCLE_ACTIVE_METADATA_FILE = "metadata.json";
+export interface LifecycleActiveTargetIdentity {
+    sourceId?: string;
+    sourceIdentity?: string;
+    pluginId?: string;
+    pluginName: string;
+    platform: PlatformName;
+    scope: Scope;
+    projectKey: string | null;
+    locationKey: string;
+}
+export interface LifecycleArtifactOwnerIdentity {
+    sourceId?: string;
+    sourceIdentity?: string;
+    pluginId?: string;
+    pluginName: string;
+    platform: PlatformName;
+    scope: Scope;
+    projectKey: string | null;
+}
+export interface LifecycleActiveArtifactDescriptor {
+    path: string;
+    paths?: string[];
+    kind: GeneratedArtifact['kind'];
+    platform: PlatformName;
+    artifactKey?: string;
+    hookGroups?: TrackedHookGroupIdentity[];
+    id?: string;
+    target?: ArtifactTarget;
+    state?: ArtifactState;
+    refreshKeys?: string[];
+    roleKey?: string;
+    owner: LifecycleArtifactOwnerIdentity;
+}
+interface LifecycleActiveMetadataPayload {
+    schemaVersion: 1 | 2;
+    sourceId?: string;
+    sourceIdentity?: string;
+    pluginId?: string;
+    pluginName: string;
+    pluginVersion: string;
+    platform: PlatformName;
+    scope: Scope;
+    projectKey: string | null;
+    sourceManifestDigest: string;
+    fingerprintVersion: 2;
+    bundleFingerprint: string;
+    events: PluginLifecycleEvent[];
+    artifacts: LifecycleActiveArtifactDescriptor[];
+}
+export interface LifecycleActiveMetadata extends LifecycleActiveMetadataPayload {
+    metadataIntegrityDigest: string;
+}
+export interface LifecycleActiveTarget extends LifecycleActiveTargetIdentity {
+    awHome: string;
+    coordinationRoot: string;
+    storeRoot: string;
+    targetRoot: string;
+    activeRoot: string;
+    stagingRoot: string;
+    lockPath: string;
+    operationLockPath: string;
+    artifactOutputRoots: string[];
+    pathAliases: Array<{
+        source: string;
+        canonical: string;
+    }>;
+}
+export interface StagedLifecycleActiveSnapshot {
+    status: 'staged';
+    target: LifecycleActiveTarget;
+    stageId: string;
+    stageRoot: string;
+    metadata: LifecycleActiveMetadata;
+}
+export interface LifecycleActiveSnapshotNotRequired {
+    status: 'not-required';
+    reason: 'no-uninstall-lifecycle';
+    target: LifecycleActiveTarget;
+}
+export type PreparedLifecycleActiveSnapshot = StagedLifecycleActiveSnapshot | LifecycleActiveSnapshotNotRequired;
+export interface ReadLifecycleActiveSnapshot {
+    target: LifecycleActiveTarget;
+    activeRoot: string;
+    bundleRoot: string;
+    manifestPath: string;
+    metadata: LifecycleActiveMetadata;
+    plugin: PluginMeta;
+    artifacts: GeneratedArtifact[];
+}
+export interface LifecycleActiveScriptInputs {
+    currentPlugin: PluginMeta;
+    artifacts: GeneratedArtifact[];
+}
+export type LifecycleActivePluginLoader = (bundleRoot: string, manifestPath: string) => Promise<PluginMeta>;
+export declare function setLifecycleActiveBeforePruneForTests(hook: (() => Promise<void>) | undefined): void;
+export declare function setLifecycleActiveLockFileSystemForTests(fileSystem: ProcessLockFileSystem | undefined): void;
+export declare class LifecycleActiveSnapshotError extends Error {
+    readonly code = "invalidLifecycleActiveSnapshot";
+    constructor(message: string, options?: ErrorOptions);
+}
+export declare function createLifecycleProjectLocationKey(projectKey: string): string;
+export declare function resolveLifecycleActiveTarget(options: {
+    sourceId?: string;
+    sourceIdentity?: string;
+    pluginName: string;
+    platform: PlatformName;
+    scope: Scope;
+    cwd: string;
+    env?: NodeJS.ProcessEnv;
+}): Promise<LifecycleActiveTarget>;
+export declare function acquireLifecycleOperationLock(options: {
+    sourceId?: string;
+    sourceIdentity?: string;
+    pluginName: string;
+    platform: PlatformName;
+    scope: Scope;
+    cwd: string;
+    env?: NodeJS.ProcessEnv;
+}): Promise<ProcessLockLease>;
+export declare function prepareLifecycleActiveSnapshot(options: {
+    sourceId?: string;
+    sourceIdentity?: string;
+    plugin: PluginMeta;
+    platform: PlatformName;
+    scope: Scope;
+    cwd: string;
+    artifacts?: readonly GeneratedArtifact[];
+    loadPlugin: LifecycleActivePluginLoader;
+    env?: NodeJS.ProcessEnv;
+    lifecycleLeaseHeld?: boolean;
+}): Promise<PreparedLifecycleActiveSnapshot>;
+export declare function promoteLifecycleActiveSnapshot(prepared: PreparedLifecycleActiveSnapshot): Promise<ReadLifecycleActiveSnapshot | null>;
+export declare function discardLifecycleActiveSnapshot(prepared: PreparedLifecycleActiveSnapshot): Promise<void>;
+type ReadLifecycleActiveSnapshotOptions = {
+    sourceId?: string;
+    sourceIdentity?: string;
+    pluginName: string;
+    platform: PlatformName;
+    scope: Scope;
+    cwd: string;
+    loadPlugin: LifecycleActivePluginLoader;
+    env?: NodeJS.ProcessEnv;
+};
+export declare function readLifecycleActiveSnapshot(options: ReadLifecycleActiveSnapshotOptions): Promise<ReadLifecycleActiveSnapshot | null>;
+export declare function inspectLifecycleActiveSnapshotForInventory(options: ReadLifecycleActiveSnapshotOptions): Promise<ReadLifecycleActiveSnapshot | null>;
+export declare function leaseLifecycleActiveSnapshot(options: {
+    sourceId?: string;
+    sourceIdentity?: string;
+    pluginName: string;
+    platform: PlatformName;
+    scope: Scope;
+    cwd: string;
+    loadPlugin: LifecycleActivePluginLoader;
+    env?: NodeJS.ProcessEnv;
+    lifecycleLeaseHeld?: boolean;
+}): Promise<ReadLifecycleActiveSnapshot | null>;
+export declare function releaseLifecycleActiveSnapshot(snapshot: ReadLifecycleActiveSnapshot): Promise<void>;
+export declare function restoreLifecycleActiveScriptInputs(snapshot: ReadLifecycleActiveSnapshot): LifecycleActiveScriptInputs;
+export declare function removeLifecycleActiveSnapshot(options: {
+    sourceId?: string;
+    sourceIdentity?: string;
+    pluginName: string;
+    platform: PlatformName;
+    scope: Scope;
+    cwd: string;
+    env?: NodeJS.ProcessEnv;
+    lifecycleLeaseHeld?: boolean;
+    expectedMetadataIntegrityDigest?: string;
+}): Promise<void>;
+export {};