agent-plugkit 0.1.0

package/dist/application/local-release.d.ts

@@ -0,0 +1,122 @@
+import { inspectWorkspaceArtifacts } from "./artifact-generation.js";
+import { runWorkspaceOperation } from "./workspace-operation.js";
+export declare const LOCAL_RELEASE_DIRECTORY = "dist/release";
+export declare const LOCAL_RELEASE_MANIFEST = "dist/release/release-manifest.json";
+export declare const LOCAL_RELEASE_LOCK = ".agent-plugkit-release.lock";
+export interface LocalReleaseBlocker {
+    readonly id: string;
+    readonly code: string;
+    readonly objectLabel: string;
+    readonly summary: string;
+    readonly impact: string;
+    readonly nextAction: string;
+}
+export type LocalReleasePreflightResult = {
+    readonly status: "ready";
+    readonly pluginCount: number;
+} | {
+    readonly status: "blocked";
+    readonly pluginCount: number;
+    readonly blockers: readonly LocalReleaseBlocker[];
+} | {
+    readonly status: "unavailable";
+    readonly message: string;
+};
+export interface LocalReleasePreflightDependencies {
+    readonly now?: () => Date;
+    readonly yieldToEventLoop?: () => Promise<void>;
+    readonly runValidation?: typeof runWorkspaceOperation;
+    readonly inspectArtifacts?: typeof inspectWorkspaceArtifacts;
+}
+interface ReleaseSnapshotDirectory {
+    readonly kind: "directory";
+    readonly sourceRelativePath: string;
+    readonly releaseRelativePath: string;
+    readonly mode: number;
+}
+interface ReleaseSnapshotFile {
+    readonly kind: "file";
+    readonly sourceRelativePath?: string;
+    readonly releaseRelativePath: string;
+    readonly mode: number;
+    readonly bytes: Uint8Array;
+    readonly revision: string;
+}
+type ReleaseSnapshotEntry = ReleaseSnapshotDirectory | ReleaseSnapshotFile;
+export interface LocalReleasePlan {
+    readonly kind: "local-release";
+    readonly workspaceDirectory: string;
+    readonly marketplaceName: string;
+    readonly generatedAt: string;
+    readonly pluginCount: number;
+    readonly archiveName: string;
+    readonly archiveRelativePath: string;
+    readonly releaseDirectoryRelativePath: typeof LOCAL_RELEASE_DIRECTORY;
+    readonly manifestRelativePath: typeof LOCAL_RELEASE_MANIFEST;
+    readonly releaseDirectoryExisted: boolean;
+    readonly sourceEntries: readonly ReleaseSnapshotEntry[];
+    readonly releaseEntries: readonly ReleaseSnapshotEntry[];
+    readonly existingReleaseRevision: string | "missing";
+}
+export interface PlanLocalReleaseDependencies {
+    readonly now?: () => Date;
+}
+export type LocalReleaseBoundary = "prepare-start" | "prepare-complete" | "directory-commit-start" | "directory-commit-complete" | "archive-start" | "archive-returned" | "archive-complete" | "verify-start" | "verify-complete";
+export interface LocalReleaseTransactionFacts {
+    readonly releaseDirectory: "unchanged" | "committed" | "uncertain";
+    readonly archive: "not-created" | "created" | "uncertain";
+    readonly changedPaths: readonly string[];
+    readonly canonicalPaths: readonly string[];
+    readonly createdParentPaths: readonly string[];
+    readonly residuePaths: readonly string[];
+    readonly diskChanged: boolean;
+    readonly cleanupComplete: boolean;
+}
+export type LocalReleaseCommitResult = {
+    readonly status: "success";
+    readonly phase: "verify";
+    readonly pluginCount: number;
+    readonly facts: LocalReleaseTransactionFacts;
+} | {
+    readonly status: "failed";
+    readonly phase: "prepare" | "directory-commit" | "archive" | "verify";
+    readonly message: string;
+    readonly pluginCount: number;
+    readonly facts: LocalReleaseTransactionFacts;
+} | {
+    readonly status: "canceled";
+    readonly phase: "prepare" | "directory-commit" | "archive" | "verify";
+    readonly message: string;
+    readonly pluginCount: number;
+    readonly facts: LocalReleaseTransactionFacts;
+};
+export interface LocalReleaseArchiveRequest {
+    readonly distDirectory: string;
+    readonly temporaryArchivePath: string;
+}
+export type LocalReleaseExpectedArchiveEntry = {
+    readonly relativePath: string;
+    readonly kind: "directory";
+} | {
+    readonly relativePath: string;
+    readonly kind: "file";
+    readonly revision: string;
+    readonly byteLength: number;
+};
+export interface LocalReleaseCommitDependencies {
+    readonly createToken?: () => string;
+    readonly signal?: AbortSignal;
+    readonly onBoundary?: (boundary: LocalReleaseBoundary, facts: LocalReleaseTransactionFacts) => void;
+    readonly yieldToEventLoop?: () => Promise<void>;
+    readonly beforeStageEntry?: (relativePath: string) => void;
+    readonly beforeInstallReleaseDirectory?: () => void;
+    readonly beforeArchiveCommit?: (archiveRelativePath: string) => void;
+    readonly archiveExecutor?: (request: LocalReleaseArchiveRequest) => void;
+    readonly archiveVerifier?: (archivePath: string, expectedReleaseEntries: readonly LocalReleaseExpectedArchiveEntry[]) => void;
+    readonly cleanupOwnedPath?: (path: string, relativePath: string) => void;
+}
+export declare function inspectLocalReleasePreflight(workspaceDirectory: string, dependencies?: LocalReleasePreflightDependencies): Promise<LocalReleasePreflightResult>;
+export declare function planLocalRelease(workspaceDirectory: string, dependencies?: PlanLocalReleaseDependencies): LocalReleasePlan;
+export declare function commitLocalReleasePlan(plan: LocalReleasePlan, dependencies?: LocalReleaseCommitDependencies): LocalReleaseCommitResult;
+export declare function commitLocalReleasePlanAsync(plan: LocalReleasePlan, dependencies?: LocalReleaseCommitDependencies): Promise<LocalReleaseCommitResult>;
+export {};