@kjerneverk/riotplan-cloud 1.0.0-dev.0

package/dist/index.d.ts

@@ -0,0 +1,179 @@
+export declare function buildSyncDiff(remoteObjects: Record<string, RemoteObjectState>, manifestObjects: Record<string, SyncManifestObject> | undefined, localFiles: Set<string>): {
+    added: string[];
+    changed: string[];
+    unchanged: string[];
+    deletedLocal: string[];
+};
+
+export declare interface CloudRuntime extends CloudRuntimeDirectories {
+    enabled: boolean;
+    syncDown: (options?: {
+        forceRefresh?: boolean;
+    }) => Promise<{
+        plan: GcsSyncDownStats | null;
+        context: GcsSyncDownStats | null;
+        syncFreshHit: boolean;
+        coalescedWaiterCount: number;
+    }>;
+    syncUpPlans: () => Promise<GcsSyncUpStats | null>;
+    syncUpContext: () => Promise<GcsSyncUpStats | null>;
+}
+
+export declare interface CloudRuntimeConfig {
+    cloud?: CloudStorageConfig;
+}
+
+export declare interface CloudRuntimeDiagnostics {
+    debug?: (event: string, details?: Record<string, unknown>) => void;
+}
+
+export declare interface CloudRuntimeDirectories {
+    workingDirectory: string;
+    contextDirectory: string;
+}
+
+export declare interface CloudStorageConfig {
+    enabled?: boolean;
+    incrementalSyncEnabled?: boolean;
+    syncFreshnessTtlMs?: number;
+    syncTimeoutMs?: number;
+    planBucket?: string;
+    planPrefix?: string;
+    contextBucket?: string;
+    contextPrefix?: string;
+    projectId?: string;
+    keyFilename?: string;
+    credentialsJson?: string;
+    cacheDirectory?: string;
+}
+
+export declare function createCloudRuntime(config: CloudRuntimeConfig | null | undefined, localPlanDirectory: string, diagnostics?: CloudRuntimeDiagnostics): Promise<CloudRuntime>;
+
+export declare interface GcsAuthConfig {
+    projectId?: string;
+    keyFilename?: string;
+    credentialsJson?: string;
+}
+
+export declare interface GcsBucketLocation {
+    bucket: string;
+    prefix?: string;
+}
+
+export declare class GcsMirror {
+    private readonly auth;
+    private readonly bucketName;
+    private readonly prefix;
+    private readonly localDirectory;
+    private readonly includeFile;
+    private readonly incrementalSyncEnabled;
+    private readonly onDebugEvent?;
+    constructor(options: {
+        auth: GcsAuthConfig;
+        location: GcsBucketLocation;
+        localDirectory: string;
+        includeFile?: (relativePath: string) => boolean;
+        incrementalSyncEnabled?: boolean;
+        onDebugEvent?: MirrorDebugEvent;
+    });
+    syncDown(): Promise<GcsSyncDownStats>;
+    syncUp(): Promise<GcsSyncUpStats>;
+}
+
+export declare interface GcsSyncDownStats {
+    bucket: string;
+    prefix: string;
+    localDirectory: string;
+    remoteListedCount: number;
+    remoteIncludedCount: number;
+    changedCount: number;
+    skippedUnchangedCount: number;
+    downloadedCount: number;
+    downloadedBytes: number;
+    localScannedCount: number;
+    removedCount: number;
+    elapsedMs: number;
+    phases: {
+        mkdirMs: number;
+        createClientMs: number;
+        listRemoteMs: number;
+        downloadMs: number;
+        listLocalMs: number;
+        cleanupMs: number;
+    };
+}
+
+export declare interface GcsSyncUpStats {
+    bucket: string;
+    prefix: string;
+    localDirectory: string;
+    localScannedCount: number;
+    localIncludedCount: number;
+    uploadedCount: number;
+    remoteListedCount: number;
+    removedRemoteCount: number;
+    elapsedMs: number;
+    phases: {
+        mkdirMs: number;
+        createClientMs: number;
+        listLocalMs: number;
+        uploadMs: number;
+        listRemoteMs: number;
+        cleanupMs: number;
+    };
+}
+
+export declare function loadSyncManifest(localDirectory: string): Promise<{
+    manifest: SyncManifest | null;
+    invalidated: boolean;
+}>;
+
+declare type MirrorDebugEvent = (event: string, details: Record<string, unknown>) => void;
+
+export declare interface RemoteObjectState {
+    path: string;
+    generation?: string;
+    etag?: string;
+    md5Hash?: string;
+    size?: number;
+    updatedAt?: string;
+}
+
+export declare function runCoalescedOperation<T>(key: string, operation: () => Promise<T>, options?: {
+    timeoutMs?: number;
+}): Promise<{
+    result: T;
+    coalesced: boolean;
+    waiterCount: number;
+}>;
+
+export declare function runDebouncedCoalescedOperation<T>(key: string, operation: () => Promise<T>, options?: {
+    debounceMs?: number;
+    timeoutMs?: number;
+}): Promise<{
+    result: T;
+    coalesced: boolean;
+    waiterCount: number;
+}>;
+
+export declare interface SyncManifest {
+    version: number;
+    createdAt: string;
+    updatedAt: string;
+    objects: Record<string, SyncManifestObject>;
+}
+
+export declare interface SyncManifestObject {
+    path: string;
+    generation?: string;
+    etag?: string;
+    md5Hash?: string;
+    size?: number;
+    updatedAt?: string;
+    localPath: string;
+    lastSyncedAt: string;
+}
+
+export declare function writeSyncManifest(localDirectory: string, objects: Record<string, SyncManifestObject>): Promise<void>;
+
+export { }