@cifn/runner 0.0.1

package/dist/index.d.mts

@@ -0,0 +1,223 @@
+import { MemoryStore, QueueClient, PipelineSpec } from 'cifn';
+
+interface LogEntry {
+    runId: string;
+    jobKey: string;
+    stepKey: string;
+    line: string;
+    timestamp: string;
+}
+interface LogFnClient {
+    append(entry: LogEntry): void;
+    appendLines(runId: string, jobKey: string, stepKey: string, lines: string[]): void;
+    getLines(runId: string, jobKey: string): LogEntry[];
+    getAllLines(runId: string): LogEntry[];
+}
+declare class MemoryLogFnClient implements LogFnClient {
+    private entries;
+    append(entry: LogEntry): void;
+    appendLines(runId: string, jobKey: string, stepKey: string, lines: string[]): void;
+    getLines(runId: string, jobKey: string): LogEntry[];
+    getAllLines(runId: string): LogEntry[];
+}
+
+interface RunStepResult {
+    exitCode: number;
+    stdout: string;
+    stderr: string;
+    lines: string[];
+}
+declare function executeRunStep(command: string, workspacePath: string, env?: Record<string, string>): RunStepResult;
+
+interface DockerExecutorOptions {
+    image: string;
+    workspace: string;
+    command: string;
+    env?: Record<string, string>;
+}
+interface DockerCommandRunner {
+    run(args: string[], options: {
+        cwd: string;
+        env?: Record<string, string>;
+    }): {
+        status: number | null;
+        stdout: string;
+        stderr: string;
+        error?: string;
+    };
+}
+declare class DockerExecutor {
+    private readonly runner;
+    constructor(runner?: DockerCommandRunner);
+    execute(options: DockerExecutorOptions): RunStepResult;
+}
+
+interface RunnerOptions {
+    store: MemoryStore;
+    queue: QueueClient;
+    logClient: LogFnClient;
+    pipelineSpecs?: Map<string, PipelineSpec>;
+    queueName?: string;
+    cleanWorkspace?: boolean;
+    fileFnClient?: {
+        upload(namespace: string, key: string, data: Buffer): Promise<string>;
+        downloadByKey(namespace: string, key: string): Promise<Buffer | null>;
+    };
+    artifactStore?: {
+        addArtifact(runId: string, artifact: {
+            name: string;
+            fileId: string;
+            url?: string;
+        }): void;
+    };
+    secretValues?: Map<string, string[]>;
+    /** Resolve secret by name for interpolation. When not set, ${{ secrets.* }} in run/with/cache key will fail. */
+    getSecret?: (runId: string, name: string) => Promise<string | null>;
+    labels?: string[];
+    runnerType?: 'default' | 'hostfn-runner';
+    dockerExecutor?: DockerExecutor;
+    defaultDockerImage?: string;
+    dockerRunOnLabels?: string[];
+    dockerForDefault?: boolean;
+}
+declare class Runner {
+    private store;
+    private queue;
+    private logClient;
+    private pipelineSpecs;
+    private queueName;
+    private cleanWorkspace;
+    private fileFnClient?;
+    private artifactStore?;
+    private secretValues;
+    private labels;
+    private runnerType;
+    private dockerExecutor?;
+    private defaultDockerImage;
+    private dockerRunOnLabels;
+    private dockerForDefault;
+    private getSecret?;
+    constructor(options: RunnerOptions);
+    registerPipelineSpec(runId: string, spec: PipelineSpec): void;
+    registerSecretValues(runId: string, values: string[]): void;
+    processNextJob(): Promise<boolean>;
+    processAllJobs(): Promise<number>;
+    private executeJob;
+    private executeRunCommand;
+    private shouldUseDocker;
+    private enqueueDependentJobs;
+    private checkRunCompletion;
+}
+
+interface CheckoutOptions {
+    repo: string;
+    ref: string;
+    workspace: string;
+    token?: string;
+}
+interface CheckoutResult {
+    success: boolean;
+    lines: string[];
+    error?: string;
+}
+declare function executeCheckout(options: CheckoutOptions): CheckoutResult;
+
+interface ArtifactUploadOptions {
+    name: string;
+    path: string;
+    workspace: string;
+    runId: string;
+    fileFnClient: {
+        upload(namespace: string, key: string, data: Buffer): Promise<string>;
+    };
+}
+interface ArtifactUploadResult {
+    success: boolean;
+    fileId?: string;
+    lines: string[];
+    error?: string;
+}
+declare function executeArtifactUpload(options: ArtifactUploadOptions): Promise<ArtifactUploadResult>;
+
+interface ArtifactDownloadOptions {
+    name: string;
+    workspace: string;
+    runId: string;
+    fileFnClient: {
+        downloadByKey(namespace: string, key: string): Promise<Buffer | null>;
+    };
+}
+interface ArtifactDownloadResult {
+    success: boolean;
+    lines: string[];
+    error?: string;
+}
+declare function executeArtifactDownload(options: ArtifactDownloadOptions): Promise<ArtifactDownloadResult>;
+
+interface CacheSaveOptions {
+    key: string;
+    paths: string[];
+    workspace: string;
+    fileFnClient: {
+        upload(namespace: string, key: string, data: Buffer): Promise<string>;
+    };
+}
+interface CacheSaveResult {
+    success: boolean;
+    lines: string[];
+    error?: string;
+}
+declare function executeCacheSave(options: CacheSaveOptions): Promise<CacheSaveResult>;
+
+interface CacheRestoreOptions {
+    key: string;
+    workspace: string;
+    fileFnClient: {
+        downloadByKey(namespace: string, key: string): Promise<Buffer | null>;
+    };
+}
+interface CacheRestoreResult {
+    success: boolean;
+    hit: boolean;
+    lines: string[];
+    error?: string;
+}
+declare function executeCacheRestore(options: CacheRestoreOptions): Promise<CacheRestoreResult>;
+
+declare function redactSecrets(lines: string[], secretValues: string[]): string[];
+
+interface TestFnRunOptions {
+    framework?: string;
+    testPattern?: string;
+    reporter?: string;
+    outputPath?: string;
+    workspace: string;
+    env?: Record<string, string>;
+    parallel?: number | 'auto';
+    timeout?: number;
+    retries?: number;
+}
+interface TestFnRunResult {
+    success: boolean;
+    exitCode: number;
+    lines: string[];
+    error?: string;
+}
+declare function executeTestFnRun(options: TestFnRunOptions): TestFnRunResult;
+
+interface HostFnDeployOptions {
+    environment: string;
+    ci?: boolean;
+    local?: boolean;
+    workspace: string;
+    env?: Record<string, string>;
+}
+interface HostFnDeployResult {
+    success: boolean;
+    exitCode: number;
+    lines: string[];
+    error?: string;
+}
+declare function executeHostFnDeploy(options: HostFnDeployOptions): HostFnDeployResult;
+
+export { type ArtifactDownloadOptions, type ArtifactDownloadResult, type ArtifactUploadOptions, type ArtifactUploadResult, type CacheRestoreOptions, type CacheRestoreResult, type CacheSaveOptions, type CacheSaveResult, type CheckoutOptions, type CheckoutResult, type DockerCommandRunner, DockerExecutor, type DockerExecutorOptions, type HostFnDeployOptions, type HostFnDeployResult, type LogEntry, type LogFnClient, MemoryLogFnClient, type RunStepResult, Runner, type RunnerOptions, type TestFnRunOptions, type TestFnRunResult, executeArtifactDownload, executeArtifactUpload, executeCacheRestore, executeCacheSave, executeCheckout, executeHostFnDeploy, executeRunStep, executeTestFnRun, redactSecrets };