@effect-kit/storage 0.0.0-stage → 0.1.0

package/dist/content.d.ts

@@ -0,0 +1,590 @@
+import { StorageError } from "./core/errors.js";
+import { GetResult } from "./core/requests.js";
+import { Storage } from "./core/storage.js";
+import "./index.js";
+import { UploadSource } from "./transfers/sources.js";
+import { TransferPolicy } from "./transfers/models.js";
+import { TransferDriver, TransferHash } from "./transfers/dependencies.js";
+import "./transfers.js";
+import { WorkflowStoreOptions } from "./workflows/store.js";
+import { CollectionPlan, ContentId, ContentRecord } from "./workflows/content/schema.js";
+import { Context, Effect, Layer, Schema } from "effect";
+import { SecureRandom } from "effect/crypto";
+declare const ContentReferenceStore_base: Context.ServiceClass<ContentReferenceStore, "@effect-kit/storage/ContentReferenceStore", {
+  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 ContentReferenceStore extends ContentReferenceStore_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<ContentReferenceStore, StorageError, import("effect/persistence/KeyValueStore").KeyValueStore>;
+}
+export interface ContentStoreOptions {
+  readonly configurationId: string;
+  readonly namespace: string;
+  readonly algorithm?: "sha256";
+  readonly maxBytes: number;
+  readonly minimumRetentionMillis?: number;
+  readonly transfer?: TransferPolicy;
+}
+declare const ContentStore_base: Context.ServiceClass<ContentStore, "@effect-kit/storage/ContentStore", {
+  put: <E = never, R = never>(request: {
+    readonly source: UploadSource<E, R>;
+    readonly reference?: string;
+  }) => Effect.Effect<{
+    id: string;
+    metadata: {
+      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;
+    };
+    size: number;
+    checksum: {
+      readonly algorithm: string;
+      readonly encoding: "base64" | "hex";
+      readonly scope: "composite" | "full-object";
+      readonly value: string;
+      readonly partCount?: number | undefined;
+    };
+  }, E | StorageError, Exclude<R, import("effect/Scope").Scope>>;
+  head: (id: string) => Effect.Effect<{
+    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;
+  }, StorageError, never>;
+  get: (id: string) => Effect.Effect<GetResult, StorageError, import("effect/Scope").Scope>;
+  status: (id: string) => Effect.Effect<{
+    readonly id: string;
+    readonly binding: string;
+    readonly generation: number;
+    readonly state: "deleted" | "deleting" | "ready" | "writing";
+    readonly size: number;
+    readonly createdAt: number;
+    readonly retainUntil: number;
+    readonly edgeCount: number;
+    readonly object?: {
+      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;
+  }, StorageError, never>;
+  reconcile: (id: string) => Effect.Effect<{
+    readonly id: string;
+    readonly binding: string;
+    readonly generation: number;
+    readonly state: "deleted" | "deleting" | "ready" | "writing";
+    readonly size: number;
+    readonly createdAt: number;
+    readonly retainUntil: number;
+    readonly edgeCount: number;
+    readonly object?: {
+      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;
+  }, StorageError, never>;
+  attach: (request: {
+    readonly contentId: string;
+    readonly reference: string;
+    readonly replace?: boolean;
+  }) => Effect.Effect<{
+    readonly reference: string;
+    readonly intentId: string;
+    readonly contentId?: string | undefined;
+  }, StorageError, never>;
+  detach: (request: {
+    readonly reference: string;
+  }) => Effect.Effect<{
+    readonly reference: string;
+    readonly intentId: string;
+    readonly contentId?: string | undefined;
+  }, StorageError, never>;
+  references: (id: string, page?: {
+    readonly offset?: number;
+    readonly limit?: number;
+  }) => Effect.Effect<{
+    references: string[];
+    pending: string[];
+    nextOffset?: number;
+  }, StorageError, never>;
+  reconcileReference: (reference: string) => Effect.Effect<{
+    readonly id: string;
+    readonly reference: string;
+    readonly contentId?: string | undefined;
+    readonly edge?: number | undefined;
+    readonly state: "completed" | "pending";
+  } | undefined, StorageError, never>;
+  planGarbageCollection: (request: {
+    readonly olderThan: number;
+  }) => Effect.Effect<{
+    readonly id: string;
+    readonly binding: string;
+    readonly cutoff: number;
+    readonly count: number;
+    readonly state: "applying" | "completed" | "partial" | "planned";
+  }, StorageError, never>;
+  inspectGarbageCollection: (id: string, page?: {
+    readonly offset?: number;
+    readonly limit?: number;
+  }) => Effect.Effect<{
+    plan: {
+      readonly id: string;
+      readonly binding: string;
+      readonly cutoff: number;
+      readonly count: number;
+      readonly state: "applying" | "completed" | "partial" | "planned";
+    };
+    entries: ({
+      readonly contentId: string;
+      readonly generation: number;
+      readonly state: "collected" | "planned" | "retained" | "unknown";
+    } | undefined)[];
+    nextOffset?: number;
+  }, StorageError, never>;
+  applyGarbageCollection: (id: string, batch?: {
+    readonly limit?: number;
+  }) => Effect.Effect<{
+    readonly id: string;
+    readonly binding: string;
+    readonly cutoff: number;
+    readonly count: number;
+    readonly state: "applying" | "completed" | "partial" | "planned";
+  }, StorageError, never>;
+}>;
+export declare class ContentStore extends ContentStore_base {
+  static readonly make: (options: ContentStoreOptions) => Effect.Effect<{
+    put: <E = never, R = never>(request: {
+      readonly source: UploadSource<E, R>;
+      readonly reference?: string;
+    }) => Effect.Effect<{
+      id: string;
+      metadata: {
+        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;
+      };
+      size: number;
+      checksum: {
+        readonly algorithm: string;
+        readonly encoding: "base64" | "hex";
+        readonly scope: "composite" | "full-object";
+        readonly value: string;
+        readonly partCount?: number | undefined;
+      };
+    }, E | StorageError, Exclude<R, import("effect/Scope").Scope>>;
+    head: (id: string) => Effect.Effect<{
+      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;
+    }, StorageError, never>;
+    get: (id: string) => Effect.Effect<GetResult, StorageError, import("effect/Scope").Scope>;
+    status: (id: string) => Effect.Effect<{
+      readonly id: string;
+      readonly binding: string;
+      readonly generation: number;
+      readonly state: "deleted" | "deleting" | "ready" | "writing";
+      readonly size: number;
+      readonly createdAt: number;
+      readonly retainUntil: number;
+      readonly edgeCount: number;
+      readonly object?: {
+        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;
+    }, StorageError, never>;
+    reconcile: (id: string) => Effect.Effect<{
+      readonly id: string;
+      readonly binding: string;
+      readonly generation: number;
+      readonly state: "deleted" | "deleting" | "ready" | "writing";
+      readonly size: number;
+      readonly createdAt: number;
+      readonly retainUntil: number;
+      readonly edgeCount: number;
+      readonly object?: {
+        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;
+    }, StorageError, never>;
+    attach: (request: {
+      readonly contentId: string;
+      readonly reference: string;
+      readonly replace?: boolean;
+    }) => Effect.Effect<{
+      readonly reference: string;
+      readonly intentId: string;
+      readonly contentId?: string | undefined;
+    }, StorageError, never>;
+    detach: (request: {
+      readonly reference: string;
+    }) => Effect.Effect<{
+      readonly reference: string;
+      readonly intentId: string;
+      readonly contentId?: string | undefined;
+    }, StorageError, never>;
+    references: (id: string, page?: {
+      readonly offset?: number;
+      readonly limit?: number;
+    }) => Effect.Effect<{
+      references: string[];
+      pending: string[];
+      nextOffset?: number;
+    }, StorageError, never>;
+    reconcileReference: (reference: string) => Effect.Effect<{
+      readonly id: string;
+      readonly reference: string;
+      readonly contentId?: string | undefined;
+      readonly edge?: number | undefined;
+      readonly state: "completed" | "pending";
+    } | undefined, StorageError, never>;
+    planGarbageCollection: (request: {
+      readonly olderThan: number;
+    }) => Effect.Effect<{
+      readonly id: string;
+      readonly binding: string;
+      readonly cutoff: number;
+      readonly count: number;
+      readonly state: "applying" | "completed" | "partial" | "planned";
+    }, StorageError, never>;
+    inspectGarbageCollection: (id: string, page?: {
+      readonly offset?: number;
+      readonly limit?: number;
+    }) => Effect.Effect<{
+      plan: {
+        readonly id: string;
+        readonly binding: string;
+        readonly cutoff: number;
+        readonly count: number;
+        readonly state: "applying" | "completed" | "partial" | "planned";
+      };
+      entries: ({
+        readonly contentId: string;
+        readonly generation: number;
+        readonly state: "collected" | "planned" | "retained" | "unknown";
+      } | undefined)[];
+      nextOffset?: number;
+    }, StorageError, never>;
+    applyGarbageCollection: (id: string, batch?: {
+      readonly limit?: number;
+    }) => Effect.Effect<{
+      readonly id: string;
+      readonly binding: string;
+      readonly cutoff: number;
+      readonly count: number;
+      readonly state: "applying" | "completed" | "partial" | "planned";
+    }, StorageError, never>;
+  }, StorageError, ContentReferenceStore | import("effect/FileSystem").FileSystem | import("effect/Path").Path | SecureRandom.SecureRandom | Storage | TransferDriver | TransferHash>;
+  static layer(options: ContentStoreOptions): Layer.Layer<ContentStore, StorageError, ContentReferenceStore | import("effect/FileSystem").FileSystem | import("effect/Path").Path | SecureRandom.SecureRandom | Storage | TransferDriver | TransferHash>;
+}
+export { CollectionPlan, ContentId, ContentRecord, type WorkflowStoreOptions as ContentReferenceStoreOptions };
+//# sourceMappingURL=content.d.ts.map