@effect-kit/storage 0.0.0-stage → 0.1.0

package/dist/migrations.d.ts

@@ -0,0 +1,537 @@
+import { ObjectMetadata } from "./core/object.js";
+import { StorageError } from "./core/errors.js";
+import { Storage } from "./core/storage.js";
+import { TransferEndpoint, TransferPolicy } from "./transfers/models.js";
+import { TransferDriver, TransferHash } from "./transfers/dependencies.js";
+import { WorkflowStoreOptions } from "./workflows/store.js";
+import { MigrationEntry, MigrationId, MigrationPlan, MigrationRequest } from "./workflows/migrations/schema.js";
+import { Context, Effect, Layer, Schema, Stream } from "effect";
+import { SecureRandom } from "effect/crypto";
+declare const MigrationStore_base: Context.ServiceClass<MigrationStore, "@effect-kit/storage/MigrationStore", {
+  exclusive: <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E | StorageError, R>;
+  read: <S extends Schema.Constraint>(id: string, schema: S) => Effect.Effect<S["Type"] | undefined, StorageError, S["DecodingServices"]>;
+  write: <S extends Schema.Constraint>(id: string, schema: S, value: S["Type"]) => Effect.Effect<undefined, StorageError, S["EncodingServices"]>;
+}>;
+export declare class MigrationStore extends MigrationStore_base {
+  static make(options: WorkflowStoreOptions): Effect.Effect<{
+    exclusive: <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E | StorageError, R>;
+    read: <S extends Schema.Constraint>(id: string, schema: S) => Effect.Effect<S["Type"] | undefined, StorageError, S["DecodingServices"]>;
+    write: <S extends Schema.Constraint>(id: string, schema: S, value: S["Type"]) => Effect.Effect<undefined, StorageError, S["EncodingServices"]>;
+  }, StorageError, import("effect/persistence/KeyValueStore").KeyValueStore>;
+  static layer(options: WorkflowStoreOptions): Layer.Layer<MigrationStore, StorageError, import("effect/persistence/KeyValueStore").KeyValueStore>;
+}
+export interface MigrationOptions {
+  readonly configurationId: string;
+  readonly source: TransferEndpoint;
+  readonly destination: TransferEndpoint;
+  readonly transfer?: TransferPolicy;
+  readonly deadlineMillis?: number;
+}
+declare const StorageMigrations_base: Context.ServiceClass<StorageMigrations, "@effect-kit/storage/StorageMigrations", {
+  plan: <E = never, R = never>(raw: MigrationRequest & {
+    readonly inventory?: Stream.Stream<ObjectMetadata, E, R>;
+  }) => Effect.Effect<{
+    readonly id: string;
+    readonly binding: string;
+    readonly request: {
+      readonly id?: string | undefined;
+      readonly inventoryId?: string | undefined;
+      readonly prefix: string;
+      readonly destinationPrefix?: string | undefined;
+      readonly conflict: "fail" | "replace-if-unchanged" | "skip";
+      readonly deleteSource: boolean;
+      readonly deleteExtraneous?: boolean | undefined;
+    };
+    readonly state: "applying" | "completed" | "partial" | "planned" | "planning";
+    readonly count: number;
+    readonly createdAt: number;
+  }, E | StorageError, R>;
+  status: (id: string) => Effect.Effect<{
+    readonly id: string;
+    readonly binding: string;
+    readonly request: {
+      readonly id?: string | undefined;
+      readonly inventoryId?: string | undefined;
+      readonly prefix: string;
+      readonly destinationPrefix?: string | undefined;
+      readonly conflict: "fail" | "replace-if-unchanged" | "skip";
+      readonly deleteSource: boolean;
+      readonly deleteExtraneous?: boolean | undefined;
+    };
+    readonly state: "applying" | "completed" | "partial" | "planned" | "planning";
+    readonly count: number;
+    readonly createdAt: number;
+  }, StorageError, never>;
+  inspect: (id: string, options?: {
+    readonly offset?: number;
+    readonly limit?: number;
+  }) => Effect.Effect<{
+    plan: {
+      readonly id: string;
+      readonly binding: string;
+      readonly request: {
+        readonly id?: string | undefined;
+        readonly inventoryId?: string | undefined;
+        readonly prefix: string;
+        readonly destinationPrefix?: string | undefined;
+        readonly conflict: "fail" | "replace-if-unchanged" | "skip";
+        readonly deleteSource: boolean;
+        readonly deleteExtraneous?: boolean | undefined;
+      };
+      readonly state: "applying" | "completed" | "partial" | "planned" | "planning";
+      readonly count: number;
+      readonly createdAt: number;
+    };
+    entries: {
+      readonly index: number;
+      readonly action: "copy" | "delete";
+      readonly source: {
+        readonly contentType?: string | undefined;
+        readonly contentEncoding?: string | undefined;
+        readonly contentLanguage?: string | undefined;
+        readonly contentDisposition?: string | undefined;
+        readonly cacheControl?: string | undefined;
+        readonly customMetadata?: {
+          readonly [x: string]: string;
+        } | undefined;
+        readonly ref: {
+          readonly storeId: string;
+          readonly key: string;
+          readonly version?: {
+            readonly _tag: "S3Version";
+            readonly id: string;
+          } | {
+            readonly _tag: "GcsGeneration";
+            readonly id: string;
+            readonly metageneration?: string | undefined;
+          } | {
+            readonly _tag: "AzureVersion";
+            readonly id: string;
+          } | {
+            readonly _tag: "AzureSnapshot";
+            readonly id: string;
+          } | {
+            readonly _tag: "OpaqueVersion";
+            readonly provider: string;
+            readonly id: string;
+          } | undefined;
+        };
+        readonly size?: number | undefined;
+        readonly etag?: string | undefined;
+        readonly lastModified?: import("effect/DateTime").Utc | undefined;
+        readonly checksums?: readonly {
+          readonly algorithm: string;
+          readonly encoding: "base64" | "hex";
+          readonly scope: "composite" | "full-object";
+          readonly value: string;
+          readonly partCount?: number | undefined;
+        }[] | undefined;
+        readonly storageClass?: string | undefined;
+      };
+      readonly destinationKey: string;
+      readonly previous?: {
+        readonly contentType?: string | undefined;
+        readonly contentEncoding?: string | undefined;
+        readonly contentLanguage?: string | undefined;
+        readonly contentDisposition?: string | undefined;
+        readonly cacheControl?: string | undefined;
+        readonly customMetadata?: {
+          readonly [x: string]: string;
+        } | undefined;
+        readonly ref: {
+          readonly storeId: string;
+          readonly key: string;
+          readonly version?: {
+            readonly _tag: "S3Version";
+            readonly id: string;
+          } | {
+            readonly _tag: "GcsGeneration";
+            readonly id: string;
+            readonly metageneration?: string | undefined;
+          } | {
+            readonly _tag: "AzureVersion";
+            readonly id: string;
+          } | {
+            readonly _tag: "AzureSnapshot";
+            readonly id: string;
+          } | {
+            readonly _tag: "OpaqueVersion";
+            readonly provider: string;
+            readonly id: string;
+          } | undefined;
+        };
+        readonly size?: number | undefined;
+        readonly etag?: string | undefined;
+        readonly lastModified?: import("effect/DateTime").Utc | undefined;
+        readonly checksums?: readonly {
+          readonly algorithm: string;
+          readonly encoding: "base64" | "hex";
+          readonly scope: "composite" | "full-object";
+          readonly value: string;
+          readonly partCount?: number | undefined;
+        }[] | undefined;
+        readonly storageClass?: string | undefined;
+      } | undefined;
+      readonly sha256: string;
+      readonly state: "completed" | "conflict" | "copied" | "copying" | "deleting" | "failed" | "planned" | "skipped" | "unknown";
+      readonly destination?: {
+        readonly contentType?: string | undefined;
+        readonly contentEncoding?: string | undefined;
+        readonly contentLanguage?: string | undefined;
+        readonly contentDisposition?: string | undefined;
+        readonly cacheControl?: string | undefined;
+        readonly customMetadata?: {
+          readonly [x: string]: string;
+        } | undefined;
+        readonly ref: {
+          readonly storeId: string;
+          readonly key: string;
+          readonly version?: {
+            readonly _tag: "S3Version";
+            readonly id: string;
+          } | {
+            readonly _tag: "GcsGeneration";
+            readonly id: string;
+            readonly metageneration?: string | undefined;
+          } | {
+            readonly _tag: "AzureVersion";
+            readonly id: string;
+          } | {
+            readonly _tag: "AzureSnapshot";
+            readonly id: string;
+          } | {
+            readonly _tag: "OpaqueVersion";
+            readonly provider: string;
+            readonly id: string;
+          } | undefined;
+        };
+        readonly size?: number | undefined;
+        readonly etag?: string | undefined;
+        readonly lastModified?: import("effect/DateTime").Utc | undefined;
+        readonly checksums?: readonly {
+          readonly algorithm: string;
+          readonly encoding: "base64" | "hex";
+          readonly scope: "composite" | "full-object";
+          readonly value: string;
+          readonly partCount?: number | undefined;
+        }[] | undefined;
+        readonly storageClass?: string | undefined;
+      } | undefined;
+      readonly strategy?: string | undefined;
+      readonly error?: StorageError | undefined;
+    }[];
+    nextOffset?: number;
+  }, StorageError, never>;
+  apply: (id: string, options?: {
+    readonly limit?: number;
+  }) => Effect.Effect<{
+    readonly id: string;
+    readonly binding: string;
+    readonly request: {
+      readonly id?: string | undefined;
+      readonly inventoryId?: string | undefined;
+      readonly prefix: string;
+      readonly destinationPrefix?: string | undefined;
+      readonly conflict: "fail" | "replace-if-unchanged" | "skip";
+      readonly deleteSource: boolean;
+      readonly deleteExtraneous?: boolean | undefined;
+    };
+    readonly state: "applying" | "completed" | "partial" | "planned" | "planning";
+    readonly count: number;
+    readonly createdAt: number;
+  }, StorageError, never>;
+  resume: (id: string, options?: {
+    readonly limit?: number;
+  }) => Effect.Effect<{
+    readonly id: string;
+    readonly binding: string;
+    readonly request: {
+      readonly id?: string | undefined;
+      readonly inventoryId?: string | undefined;
+      readonly prefix: string;
+      readonly destinationPrefix?: string | undefined;
+      readonly conflict: "fail" | "replace-if-unchanged" | "skip";
+      readonly deleteSource: boolean;
+      readonly deleteExtraneous?: boolean | undefined;
+    };
+    readonly state: "applying" | "completed" | "partial" | "planned" | "planning";
+    readonly count: number;
+    readonly createdAt: number;
+  }, StorageError, never>;
+  reconcile: (id: string, options?: {
+    readonly limit?: number;
+  }) => Effect.Effect<{
+    readonly id: string;
+    readonly binding: string;
+    readonly request: {
+      readonly id?: string | undefined;
+      readonly inventoryId?: string | undefined;
+      readonly prefix: string;
+      readonly destinationPrefix?: string | undefined;
+      readonly conflict: "fail" | "replace-if-unchanged" | "skip";
+      readonly deleteSource: boolean;
+      readonly deleteExtraneous?: boolean | undefined;
+    };
+    readonly state: "applying" | "completed" | "partial" | "planned" | "planning";
+    readonly count: number;
+    readonly createdAt: number;
+  }, StorageError, never>;
+}>;
+export declare class StorageMigrations extends StorageMigrations_base {
+  static readonly make: (configuration: MigrationOptions) => Effect.Effect<{
+    plan: <E = never, R = never>(raw: MigrationRequest & {
+      readonly inventory?: Stream.Stream<ObjectMetadata, E, R>;
+    }) => Effect.Effect<{
+      readonly id: string;
+      readonly binding: string;
+      readonly request: {
+        readonly id?: string | undefined;
+        readonly inventoryId?: string | undefined;
+        readonly prefix: string;
+        readonly destinationPrefix?: string | undefined;
+        readonly conflict: "fail" | "replace-if-unchanged" | "skip";
+        readonly deleteSource: boolean;
+        readonly deleteExtraneous?: boolean | undefined;
+      };
+      readonly state: "applying" | "completed" | "partial" | "planned" | "planning";
+      readonly count: number;
+      readonly createdAt: number;
+    }, E | StorageError, R>;
+    status: (id: string) => Effect.Effect<{
+      readonly id: string;
+      readonly binding: string;
+      readonly request: {
+        readonly id?: string | undefined;
+        readonly inventoryId?: string | undefined;
+        readonly prefix: string;
+        readonly destinationPrefix?: string | undefined;
+        readonly conflict: "fail" | "replace-if-unchanged" | "skip";
+        readonly deleteSource: boolean;
+        readonly deleteExtraneous?: boolean | undefined;
+      };
+      readonly state: "applying" | "completed" | "partial" | "planned" | "planning";
+      readonly count: number;
+      readonly createdAt: number;
+    }, StorageError, never>;
+    inspect: (id: string, options?: {
+      readonly offset?: number;
+      readonly limit?: number;
+    }) => Effect.Effect<{
+      plan: {
+        readonly id: string;
+        readonly binding: string;
+        readonly request: {
+          readonly id?: string | undefined;
+          readonly inventoryId?: string | undefined;
+          readonly prefix: string;
+          readonly destinationPrefix?: string | undefined;
+          readonly conflict: "fail" | "replace-if-unchanged" | "skip";
+          readonly deleteSource: boolean;
+          readonly deleteExtraneous?: boolean | undefined;
+        };
+        readonly state: "applying" | "completed" | "partial" | "planned" | "planning";
+        readonly count: number;
+        readonly createdAt: number;
+      };
+      entries: {
+        readonly index: number;
+        readonly action: "copy" | "delete";
+        readonly source: {
+          readonly contentType?: string | undefined;
+          readonly contentEncoding?: string | undefined;
+          readonly contentLanguage?: string | undefined;
+          readonly contentDisposition?: string | undefined;
+          readonly cacheControl?: string | undefined;
+          readonly customMetadata?: {
+            readonly [x: string]: string;
+          } | undefined;
+          readonly ref: {
+            readonly storeId: string;
+            readonly key: string;
+            readonly version?: {
+              readonly _tag: "S3Version";
+              readonly id: string;
+            } | {
+              readonly _tag: "GcsGeneration";
+              readonly id: string;
+              readonly metageneration?: string | undefined;
+            } | {
+              readonly _tag: "AzureVersion";
+              readonly id: string;
+            } | {
+              readonly _tag: "AzureSnapshot";
+              readonly id: string;
+            } | {
+              readonly _tag: "OpaqueVersion";
+              readonly provider: string;
+              readonly id: string;
+            } | undefined;
+          };
+          readonly size?: number | undefined;
+          readonly etag?: string | undefined;
+          readonly lastModified?: import("effect/DateTime").Utc | undefined;
+          readonly checksums?: readonly {
+            readonly algorithm: string;
+            readonly encoding: "base64" | "hex";
+            readonly scope: "composite" | "full-object";
+            readonly value: string;
+            readonly partCount?: number | undefined;
+          }[] | undefined;
+          readonly storageClass?: string | undefined;
+        };
+        readonly destinationKey: string;
+        readonly previous?: {
+          readonly contentType?: string | undefined;
+          readonly contentEncoding?: string | undefined;
+          readonly contentLanguage?: string | undefined;
+          readonly contentDisposition?: string | undefined;
+          readonly cacheControl?: string | undefined;
+          readonly customMetadata?: {
+            readonly [x: string]: string;
+          } | undefined;
+          readonly ref: {
+            readonly storeId: string;
+            readonly key: string;
+            readonly version?: {
+              readonly _tag: "S3Version";
+              readonly id: string;
+            } | {
+              readonly _tag: "GcsGeneration";
+              readonly id: string;
+              readonly metageneration?: string | undefined;
+            } | {
+              readonly _tag: "AzureVersion";
+              readonly id: string;
+            } | {
+              readonly _tag: "AzureSnapshot";
+              readonly id: string;
+            } | {
+              readonly _tag: "OpaqueVersion";
+              readonly provider: string;
+              readonly id: string;
+            } | undefined;
+          };
+          readonly size?: number | undefined;
+          readonly etag?: string | undefined;
+          readonly lastModified?: import("effect/DateTime").Utc | undefined;
+          readonly checksums?: readonly {
+            readonly algorithm: string;
+            readonly encoding: "base64" | "hex";
+            readonly scope: "composite" | "full-object";
+            readonly value: string;
+            readonly partCount?: number | undefined;
+          }[] | undefined;
+          readonly storageClass?: string | undefined;
+        } | undefined;
+        readonly sha256: string;
+        readonly state: "completed" | "conflict" | "copied" | "copying" | "deleting" | "failed" | "planned" | "skipped" | "unknown";
+        readonly destination?: {
+          readonly contentType?: string | undefined;
+          readonly contentEncoding?: string | undefined;
+          readonly contentLanguage?: string | undefined;
+          readonly contentDisposition?: string | undefined;
+          readonly cacheControl?: string | undefined;
+          readonly customMetadata?: {
+            readonly [x: string]: string;
+          } | undefined;
+          readonly ref: {
+            readonly storeId: string;
+            readonly key: string;
+            readonly version?: {
+              readonly _tag: "S3Version";
+              readonly id: string;
+            } | {
+              readonly _tag: "GcsGeneration";
+              readonly id: string;
+              readonly metageneration?: string | undefined;
+            } | {
+              readonly _tag: "AzureVersion";
+              readonly id: string;
+            } | {
+              readonly _tag: "AzureSnapshot";
+              readonly id: string;
+            } | {
+              readonly _tag: "OpaqueVersion";
+              readonly provider: string;
+              readonly id: string;
+            } | undefined;
+          };
+          readonly size?: number | undefined;
+          readonly etag?: string | undefined;
+          readonly lastModified?: import("effect/DateTime").Utc | undefined;
+          readonly checksums?: readonly {
+            readonly algorithm: string;
+            readonly encoding: "base64" | "hex";
+            readonly scope: "composite" | "full-object";
+            readonly value: string;
+            readonly partCount?: number | undefined;
+          }[] | undefined;
+          readonly storageClass?: string | undefined;
+        } | undefined;
+        readonly strategy?: string | undefined;
+        readonly error?: StorageError | undefined;
+      }[];
+      nextOffset?: number;
+    }, StorageError, never>;
+    apply: (id: string, options?: {
+      readonly limit?: number;
+    }) => Effect.Effect<{
+      readonly id: string;
+      readonly binding: string;
+      readonly request: {
+        readonly id?: string | undefined;
+        readonly inventoryId?: string | undefined;
+        readonly prefix: string;
+        readonly destinationPrefix?: string | undefined;
+        readonly conflict: "fail" | "replace-if-unchanged" | "skip";
+        readonly deleteSource: boolean;
+        readonly deleteExtraneous?: boolean | undefined;
+      };
+      readonly state: "applying" | "completed" | "partial" | "planned" | "planning";
+      readonly count: number;
+      readonly createdAt: number;
+    }, StorageError, never>;
+    resume: (id: string, options?: {
+      readonly limit?: number;
+    }) => Effect.Effect<{
+      readonly id: string;
+      readonly binding: string;
+      readonly request: {
+        readonly id?: string | undefined;
+        readonly inventoryId?: string | undefined;
+        readonly prefix: string;
+        readonly destinationPrefix?: string | undefined;
+        readonly conflict: "fail" | "replace-if-unchanged" | "skip";
+        readonly deleteSource: boolean;
+        readonly deleteExtraneous?: boolean | undefined;
+      };
+      readonly state: "applying" | "completed" | "partial" | "planned" | "planning";
+      readonly count: number;
+      readonly createdAt: number;
+    }, StorageError, never>;
+    reconcile: (id: string, options?: {
+      readonly limit?: number;
+    }) => Effect.Effect<{
+      readonly id: string;
+      readonly binding: string;
+      readonly request: {
+        readonly id?: string | undefined;
+        readonly inventoryId?: string | undefined;
+        readonly prefix: string;
+        readonly destinationPrefix?: string | undefined;
+        readonly conflict: "fail" | "replace-if-unchanged" | "skip";
+        readonly deleteSource: boolean;
+        readonly deleteExtraneous?: boolean | undefined;
+      };
+      readonly state: "applying" | "completed" | "partial" | "planned" | "planning";
+      readonly count: number;
+      readonly createdAt: number;
+    }, StorageError, never>;
+  }, StorageError, MigrationStore | SecureRandom.SecureRandom | TransferHash>;
+  static layer<ES, RS, ED, RD>(options: Omit<MigrationOptions, "source" | "destination"> & {
+    readonly source: Layer.Layer<Storage | TransferDriver, ES, RS>;
+    readonly destination: Layer.Layer<Storage | TransferDriver, ED, RD>;
+  }): Layer.Layer<StorageMigrations, ED | ES | StorageError, MigrationStore | SecureRandom.SecureRandom | TransferHash | Exclude<RD, import("effect/Scope").Scope> | Exclude<RS, import("effect/Scope").Scope>>;
+}
+export { MigrationEntry, MigrationId, MigrationPlan, MigrationRequest, type WorkflowStoreOptions as MigrationStoreOptions };
+//# sourceMappingURL=migrations.d.ts.map