@crewx/sdk 0.9.0-rc.110 → 0.9.0-rc.112

package/dist/lifecycle/process-lease.d.ts

@@ -0,0 +1,80 @@
+export declare const PROCESS_LEASE_FILENAME = "process-lease.json";
+export type ProcessLeaseClock = () => number;
+export interface ProcessLeaseProcessProbe {
+    isAlive(pid: number): boolean | 'unknown';
+    getStartIdentity(pid: number): string | null;
+}
+export interface ProcessLeaseRecord {
+    leaseId: string;
+    ownerId: string;
+    pid: number;
+    pidStartIdentity: string;
+    host: string;
+    startedAt: string;
+    heartbeatAt: string;
+}
+export interface ProcessLeaseOptions {
+    leasePath?: string;
+    ownerId?: string;
+    pid?: number;
+    pidStartIdentity?: string;
+    host?: string;
+    clock?: ProcessLeaseClock;
+    now?: ProcessLeaseClock;
+    processProbe?: ProcessLeaseProcessProbe;
+    probe?: ProcessLeaseProcessProbe;
+}
+export interface ProcessLeasePathOptions {
+    leasePath?: string;
+}
+export interface ProcessLeaseMutationOptions extends ProcessLeaseOptions {
+    leaseId: string;
+    ownerId: string;
+}
+export interface ProcessLeaseReclaimOptions extends ProcessLeaseOptions {
+    leaseId: string;
+    expectedOwnerId?: string;
+}
+export type ProcessLeaseReason = 'live-owner' | 'pid-reused' | 'owner-dead' | 'identity-unknown' | 'marker-corrupt' | 'marker-unreadable' | 'contention' | 'owner-mismatch' | 'io-error' | 'invalid-options';
+export type ProcessLeaseReadResult = {
+    status: 'absent';
+} | {
+    status: 'present';
+    record: ProcessLeaseRecord;
+} | {
+    status: 'unknown';
+    reason: 'marker-corrupt' | 'marker-unreadable' | 'io-error';
+};
+export interface ProcessLeaseHandle {
+    readonly leasePath: string;
+    readonly leaseId: string;
+    readonly ownerId: string;
+    readonly pid: number;
+    readonly pidStartIdentity: string;
+    readonly record: ProcessLeaseRecord;
+    renew(): boolean;
+    release(): boolean;
+}
+export type ProcessLeaseAcquireResult = {
+    acquired: true;
+    status: 'owner';
+    role: 'owner';
+    leaseId: string;
+    ownerId: string;
+    record: ProcessLeaseRecord;
+    lease: ProcessLeaseHandle;
+} | {
+    acquired: false;
+    status: 'standby';
+    role: 'standby';
+    reason: ProcessLeaseReason;
+    record?: ProcessLeaseRecord;
+};
+export declare function resolveProcessLeasePath(input?: string | ProcessLeasePathOptions): string;
+export declare function getProcessStartIdentity(pid: number): string | null;
+export declare const getProcessStartTime: typeof getProcessStartIdentity;
+export declare function readProcessLease(input?: string | ProcessLeasePathOptions): ProcessLeaseReadResult;
+export declare function acquireProcessLease(options?: ProcessLeaseOptions): ProcessLeaseAcquireResult;
+export declare function renewProcessLease(options: ProcessLeaseMutationOptions): boolean;
+export declare function releaseProcessLease(options: ProcessLeaseMutationOptions): boolean;
+export declare function reclaimProcessLease(options: ProcessLeaseReclaimOptions): boolean;