@alchemy.run/modal 0.0.0 → 2.0.0-beta.87

package/lib/VolumeClient.d.ts

@@ -0,0 +1,53 @@
+import type { VolumeGetFile2Error, VolumeListFiles2Error, VolumeRemoveFile2Error, VolumeCopyFiles2Error, VolumePutFiles2Error } from "@distilled.cloud/modal/volume";
+import type { RuntimeContext } from "alchemy/RuntimeContext";
+import * as Effect from "effect/Effect";
+import type { HttpClientError } from "effect/http/HttpClientError";
+import { type VolumeFileEntry, type VolumeFileOps, type VolumeTransferError } from "./VolumeFiles.ts";
+/** Errors reading a volume file: `VolumeFileNotFound` when the path is missing. */
+export type ReadVolumeFileError = VolumeGetFile2Error | VolumeTransferError | HttpClientError;
+/** Errors listing a volume directory. */
+export type ListVolumeFilesError = VolumeListFiles2Error;
+/** Errors removing or copying volume files. */
+export type ChangeVolumeFilesError = VolumeRemoveFile2Error | VolumeCopyFiles2Error;
+/** Errors writing a volume file. */
+export type WriteVolumeFileError = VolumePutFiles2Error | VolumeTransferError | HttpClientError;
+/** Read access to one volume's files. */
+export interface ReadVolumeClient {
+    /** The volume's id. */
+    readonly volumeId: Effect.Effect<string>;
+    /** Read a file. */
+    readFile(path: string): Effect.Effect<Uint8Array, ReadVolumeFileError, RuntimeContext>;
+    /** Read a UTF-8 file. */
+    readFileString(path: string): Effect.Effect<string, ReadVolumeFileError, RuntimeContext>;
+    /** List a directory (`recursive` walks it). */
+    listFiles(path: string, options?: {
+        readonly recursive?: boolean;
+    }): Effect.Effect<ReadonlyArray<VolumeFileEntry>, ListVolumeFilesError, RuntimeContext>;
+}
+/** Write access to one volume's files. */
+export interface WriteVolumeClient {
+    /** The volume's id. */
+    readonly volumeId: Effect.Effect<string>;
+    /** Write (create or replace) a file. */
+    writeFile(path: string, data: string | Uint8Array, options?: {
+        readonly mode?: number;
+    }): Effect.Effect<void, WriteVolumeFileError, RuntimeContext>;
+    /** Remove a file, or a directory with `recursive`. */
+    removeFile(path: string, options?: {
+        readonly recursive?: boolean;
+    }): Effect.Effect<void, ChangeVolumeFilesError, RuntimeContext>;
+    /** Copy files to `destination` inside the volume. */
+    copyFiles(sources: ReadonlyArray<string>, destination: string, options?: {
+        readonly recursive?: boolean;
+    }): Effect.Effect<void, ChangeVolumeFilesError, RuntimeContext>;
+}
+/** Read and write access to one volume's files. */
+export interface ReadWriteVolumeClient extends ReadVolumeClient, WriteVolumeClient {
+}
+/** The read half of a volume client over `volumeId`. */
+export declare const makeReadVolumeClient: (volumeId: Effect.Effect<string>, ops: VolumeFileOps) => ReadVolumeClient;
+/** The write half of a volume client over `volumeId`. */
+export declare const makeWriteVolumeClient: (volumeId: Effect.Effect<string>, ops: VolumeFileOps) => WriteVolumeClient;
+/** A read-write volume client over `volumeId`. */
+export declare const makeReadWriteVolumeClient: (volumeId: Effect.Effect<string>, ops: VolumeFileOps) => ReadWriteVolumeClient;
+//# sourceMappingURL=VolumeClient.d.ts.map

package/lib/VolumeClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VolumeClient.d.ts","sources":["../src/VolumeClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAML,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACzB,MAAM,kBAAkB,CAAC;AAE1B,mFAAmF;AACnF,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,eAAe,CAAC;AAC9F,yCAAyC;AACzC,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,CAAC;AACzD,+CAA+C;AAC/C,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,GAAG,qBAAqB,CAAC;AACpF,oCAAoC;AACpC,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG,mBAAmB,GAAG,eAAe,CAAC;AAEhG,yCAAyC;AACzC,MAAM,WAAW,gBAAgB;IAC/B,uBAAuB;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACzC,mBAAmB;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,mBAAmB,EAAE,cAAc,CAAC,CAAC;IACvF,yBAAyB;IACzB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,cAAc,CAAC,CAAC;IACzF,+CAA+C;IAC/C,SAAS,CACP,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GACzC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,oBAAoB,EAAE,cAAc,CAAC,CAAC;CACxF;AAED,0CAA0C;AAC1C,MAAM,WAAW,iBAAiB;IAChC,uBAAuB;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACzC,wCAAwC;IACxC,SAAS,CACP,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GAAG,UAAU,EACzB,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GACnC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,cAAc,CAAC,CAAC;IAC7D,sDAAsD;IACtD,UAAU,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GACzC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,cAAc,CAAC,CAAC;IAC/D,qDAAqD;IACrD,SAAS,CACP,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAC9B,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GACzC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,cAAc,CAAC,CAAC;CAChE;AAED,mDAAmD;AACnD,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB,EAAE,iBAAiB;CAAG;AAErF,wDAAwD;AACxD,eAAO,MAAM,oBAAoB,aACrB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAC1B,aAAa,KACjB,gBASD,CAAC;AAEH,yDAAyD;AACzD,eAAO,MAAM,qBAAqB,aACtB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAC1B,aAAa,KACjB,iBAQD,CAAC;AAEH,kDAAkD;AAClD,eAAO,MAAM,yBAAyB,aAC1B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAC1B,aAAa,KACjB,qBAGD,CAAC"}

package/lib/VolumeClient.js

@@ -0,0 +1,22 @@
+import * as Effect from "effect/Effect";
+import { copyVolumeFiles, listVolumeFiles, readVolumeFile, removeVolumeFile, writeVolumeFile, } from "./VolumeFiles.js";
+/** The read half of a volume client over `volumeId`. */
+export const makeReadVolumeClient = (volumeId, ops) => ({
+    volumeId,
+    readFile: (path) => Effect.flatMap(volumeId, (id) => readVolumeFile(ops, id, path)),
+    readFileString: (path) => Effect.flatMap(volumeId, (id) => readVolumeFile(ops, id, path)).pipe(Effect.map((bytes) => new TextDecoder().decode(bytes))),
+    listFiles: (path, options) => Effect.flatMap(volumeId, (id) => listVolumeFiles(ops, id, path, options)),
+});
+/** The write half of a volume client over `volumeId`. */
+export const makeWriteVolumeClient = (volumeId, ops) => ({
+    volumeId,
+    writeFile: (path, data, options) => Effect.flatMap(volumeId, (id) => writeVolumeFile(ops, id, path, data, options)),
+    removeFile: (path, options) => Effect.flatMap(volumeId, (id) => removeVolumeFile(ops, id, path, options)),
+    copyFiles: (sources, destination, options) => Effect.flatMap(volumeId, (id) => copyVolumeFiles(ops, id, sources, destination, options)),
+});
+/** A read-write volume client over `volumeId`. */
+export const makeReadWriteVolumeClient = (volumeId, ops) => ({
+    ...makeReadVolumeClient(volumeId, ops),
+    ...makeWriteVolumeClient(volumeId, ops),
+});
+//# sourceMappingURL=VolumeClient.js.map

package/lib/VolumeClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VolumeClient.js","sources":["../src/VolumeClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EACL,eAAe,EACf,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,eAAe,GAIhB,MAAM,kBAAkB,CAAC;AAoD1B,wDAAwD;AACxD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,QAA+B,EAC/B,GAAkB,EACA,EAAE,CAAC,CAAC;IACtB,QAAQ;IACR,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IACnF,cAAc,EAAE,CAAC,IAAI,EAAE,EAAE,CACvB,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAClE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CACvD;IACH,SAAS,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAC3B,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;CAC5E,CAAC,CAAC;AAEH,yDAAyD;AACzD,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,QAA+B,EAC/B,GAAkB,EACC,EAAE,CAAC,CAAC;IACvB,QAAQ;IACR,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,CACjC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACjF,UAAU,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAC5B,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5E,SAAS,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,CAC3C,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;CAC5F,CAAC,CAAC;AAEH,kDAAkD;AAClD,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACvC,QAA+B,EAC/B,GAAkB,EACK,EAAE,CAAC,CAAC;IAC3B,GAAG,oBAAoB,CAAC,QAAQ,EAAE,GAAG,CAAC;IACtC,GAAG,qBAAqB,CAAC,QAAQ,EAAE,GAAG,CAAC;CACxC,CAAC,CAAC"}

package/lib/VolumeFiles.d.ts

@@ -0,0 +1,94 @@
+import * as volume from "@distilled.cloud/modal/volume";
+import * as Effect from "effect/Effect";
+import * as HttpClient from "effect/http/HttpClient";
+declare const VolumeTransferError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
+    readonly _tag: "Modal.VolumeTransferError";
+} & Readonly<A>;
+/** A block upload or download to a URL Modal handed out failed. */
+export declare class VolumeTransferError extends VolumeTransferError_base<{
+    readonly path: string;
+    readonly message: string;
+}> {
+}
+/** One entry of a volume directory listing. */
+export interface VolumeFileEntry {
+    /** Path relative to the volume root. */
+    readonly path: string;
+    readonly type: "file" | "directory" | "symlink" | "other";
+    /** Size in bytes (files). */
+    readonly size: number;
+    /** Modification time, seconds since the epoch. */
+    readonly mtime: number;
+}
+/** The operations a volume's files need, resolved by `ModalBindings.withCredentials`. */
+export declare const VolumeFileOps: Effect.Effect<{
+    readonly getFile: (input: volume.VolumeGetFile2Request) => Effect.Effect<volume.VolumeGetFile2Response, volume.VolumeGetFile2Error, never>;
+    readonly listFiles: import("@distilled.cloud/core/api").StreamingCall<volume.VolumeListFiles2Request, volume.VolumeListFiles2Stream, volume.VolumeListFiles2Error, never, volume.VolumeListFilesResponse>;
+    readonly putFiles: (input: volume.VolumePutFiles2Request) => Effect.Effect<volume.VolumePutFiles2Response, volume.VolumePutFiles2Error, never>;
+    readonly removeFile: (input: volume.VolumeRemoveFile2Request) => Effect.Effect<volume.VolumeRemoveFile2Response, volume.VolumeRemoveFile2Error, never>;
+    readonly copyFiles: (input: volume.VolumeCopyFiles2Request) => Effect.Effect<volume.VolumeCopyFiles2Response, volume.VolumeCopyFiles2Error, never>;
+    readonly http: HttpClient.HttpClient;
+}, never, import("./internal.ts").OperationServices>;
+export type VolumeFileOps = Effect.Success<typeof VolumeFileOps>;
+/**
+ * Read a file from a (v2) volume: Modal returns presigned URLs for the
+ * file's blocks, which are fetched and concatenated.
+ */
+export declare const readVolumeFile: (ops: {
+    readonly getFile: (input: volume.VolumeGetFile2Request) => Effect.Effect<volume.VolumeGetFile2Response, volume.VolumeGetFile2Error, never>;
+    readonly listFiles: import("@distilled.cloud/core/api").StreamingCall<volume.VolumeListFiles2Request, volume.VolumeListFiles2Stream, volume.VolumeListFiles2Error, never, volume.VolumeListFilesResponse>;
+    readonly putFiles: (input: volume.VolumePutFiles2Request) => Effect.Effect<volume.VolumePutFiles2Response, volume.VolumePutFiles2Error, never>;
+    readonly removeFile: (input: volume.VolumeRemoveFile2Request) => Effect.Effect<volume.VolumeRemoveFile2Response, volume.VolumeRemoveFile2Error, never>;
+    readonly copyFiles: (input: volume.VolumeCopyFiles2Request) => Effect.Effect<volume.VolumeCopyFiles2Response, volume.VolumeCopyFiles2Error, never>;
+    readonly http: HttpClient.HttpClient;
+}, volumeId: string, path: string) => Effect.Effect<Uint8Array<ArrayBuffer>, VolumeTransferError | volume.VolumeGetFile2Error, never>;
+/** List a directory of a (v2) volume. */
+export declare const listVolumeFiles: (ops: {
+    readonly getFile: (input: volume.VolumeGetFile2Request) => Effect.Effect<volume.VolumeGetFile2Response, volume.VolumeGetFile2Error, never>;
+    readonly listFiles: import("@distilled.cloud/core/api").StreamingCall<volume.VolumeListFiles2Request, volume.VolumeListFiles2Stream, volume.VolumeListFiles2Error, never, volume.VolumeListFilesResponse>;
+    readonly putFiles: (input: volume.VolumePutFiles2Request) => Effect.Effect<volume.VolumePutFiles2Response, volume.VolumePutFiles2Error, never>;
+    readonly removeFile: (input: volume.VolumeRemoveFile2Request) => Effect.Effect<volume.VolumeRemoveFile2Response, volume.VolumeRemoveFile2Error, never>;
+    readonly copyFiles: (input: volume.VolumeCopyFiles2Request) => Effect.Effect<volume.VolumeCopyFiles2Response, volume.VolumeCopyFiles2Error, never>;
+    readonly http: HttpClient.HttpClient;
+}, volumeId: string, path: string, options?: {
+    readonly recursive?: boolean;
+} | undefined) => Effect.Effect<VolumeFileEntry[], volume.VolumeListFiles2Error, never>;
+/**
+ * Write a file to a (v2) volume: send each 8 MiB block's SHA-256, upload
+ * the blocks Modal reports missing to the URLs it returns, then commit with
+ * the upload responses.
+ */
+export declare const writeVolumeFile: (ops: {
+    readonly getFile: (input: volume.VolumeGetFile2Request) => Effect.Effect<volume.VolumeGetFile2Response, volume.VolumeGetFile2Error, never>;
+    readonly listFiles: import("@distilled.cloud/core/api").StreamingCall<volume.VolumeListFiles2Request, volume.VolumeListFiles2Stream, volume.VolumeListFiles2Error, never, volume.VolumeListFilesResponse>;
+    readonly putFiles: (input: volume.VolumePutFiles2Request) => Effect.Effect<volume.VolumePutFiles2Response, volume.VolumePutFiles2Error, never>;
+    readonly removeFile: (input: volume.VolumeRemoveFile2Request) => Effect.Effect<volume.VolumeRemoveFile2Response, volume.VolumeRemoveFile2Error, never>;
+    readonly copyFiles: (input: volume.VolumeCopyFiles2Request) => Effect.Effect<volume.VolumeCopyFiles2Response, volume.VolumeCopyFiles2Error, never>;
+    readonly http: HttpClient.HttpClient;
+}, volumeId: string, path: string, data: string | Uint8Array<ArrayBufferLike>, options?: {
+    readonly mode?: number;
+} | undefined) => Effect.Effect<undefined, VolumeTransferError | volume.VolumePutFiles2Error, never>;
+/** Remove a file (or, with `recursive`, a directory) from a (v2) volume. */
+export declare const removeVolumeFile: (ops: {
+    readonly getFile: (input: volume.VolumeGetFile2Request) => Effect.Effect<volume.VolumeGetFile2Response, volume.VolumeGetFile2Error, never>;
+    readonly listFiles: import("@distilled.cloud/core/api").StreamingCall<volume.VolumeListFiles2Request, volume.VolumeListFiles2Stream, volume.VolumeListFiles2Error, never, volume.VolumeListFilesResponse>;
+    readonly putFiles: (input: volume.VolumePutFiles2Request) => Effect.Effect<volume.VolumePutFiles2Response, volume.VolumePutFiles2Error, never>;
+    readonly removeFile: (input: volume.VolumeRemoveFile2Request) => Effect.Effect<volume.VolumeRemoveFile2Response, volume.VolumeRemoveFile2Error, never>;
+    readonly copyFiles: (input: volume.VolumeCopyFiles2Request) => Effect.Effect<volume.VolumeCopyFiles2Response, volume.VolumeCopyFiles2Error, never>;
+    readonly http: HttpClient.HttpClient;
+}, volumeId: string, path: string, options?: {
+    readonly recursive?: boolean;
+} | undefined) => Effect.Effect<void, volume.VolumeRemoveFile2Error, never>;
+/** Copy files inside a (v2) volume. */
+export declare const copyVolumeFiles: (ops: {
+    readonly getFile: (input: volume.VolumeGetFile2Request) => Effect.Effect<volume.VolumeGetFile2Response, volume.VolumeGetFile2Error, never>;
+    readonly listFiles: import("@distilled.cloud/core/api").StreamingCall<volume.VolumeListFiles2Request, volume.VolumeListFiles2Stream, volume.VolumeListFiles2Error, never, volume.VolumeListFilesResponse>;
+    readonly putFiles: (input: volume.VolumePutFiles2Request) => Effect.Effect<volume.VolumePutFiles2Response, volume.VolumePutFiles2Error, never>;
+    readonly removeFile: (input: volume.VolumeRemoveFile2Request) => Effect.Effect<volume.VolumeRemoveFile2Response, volume.VolumeRemoveFile2Error, never>;
+    readonly copyFiles: (input: volume.VolumeCopyFiles2Request) => Effect.Effect<volume.VolumeCopyFiles2Response, volume.VolumeCopyFiles2Error, never>;
+    readonly http: HttpClient.HttpClient;
+}, volumeId: string, sources: readonly string[], destination: string, options?: {
+    readonly recursive?: boolean;
+} | undefined) => Effect.Effect<void, volume.VolumeCopyFiles2Error, never>;
+export {};
+//# sourceMappingURL=VolumeFiles.d.ts.map

package/lib/VolumeFiles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VolumeFiles.d.ts","sources":["../src/VolumeFiles.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AAExD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;;;;AAIrD,mEAAmE;AACnE,qBAAa,mBAAoB,SAAQ,yBAA8C;IACrF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;CAAG;AAEL,+CAA+C;AAC/C,MAAM,WAAW,eAAe;IAC9B,wCAAwC;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC;IAC1D,6BAA6B;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,kDAAkD;IAClD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAID,yFAAyF;AACzF,eAAO,MAAM,aAAa;;;;;;;oDAOxB,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,aAAa,CAAC,CAAC;AAcjE;;;GAGG;AACH,eAAO,MAAM,cAAc;;;;;;;qIAwBzB,CAAC;AAEH,yCAAyC;AACzC,eAAO,MAAM,eAAe;;;;;;;;yBAIM,OAAO;uFAevC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;;oBAKC,MAAM;oGAsDjC,CAAC;AAEH,4EAA4E;AAC5E,eAAO,MAAM,gBAAgB;;;;;;;;yBAIK,OAAO;2EAGvC,CAAC;AAEH,uCAAuC;AACvC,eAAO,MAAM,eAAe;;;;;;;;yBAKM,OAAO;0EAQvC,CAAC"}

package/lib/VolumeFiles.js

@@ -0,0 +1,139 @@
+import { createHash } from "node:crypto";
+import * as volume from "@distilled.cloud/modal/volume";
+import * as Data from "effect/Data";
+import * as Effect from "effect/Effect";
+import * as HttpClient from "effect/http/HttpClient";
+import * as HttpClientRequest from "effect/http/HttpClientRequest";
+import { operations } from "./internal.js";
+/** A block upload or download to a URL Modal handed out failed. */
+export class VolumeTransferError extends Data.TaggedError("Modal.VolumeTransferError") {
+}
+const BLOCK_SIZE = 8 * 1024 * 1024;
+/** The operations a volume's files need, resolved by `ModalBindings.withCredentials`. */
+export const VolumeFileOps = operations({
+    getFile: volume.volumeGetFile2,
+    listFiles: volume.volumeListFiles2,
+    putFiles: volume.volumePutFiles2,
+    removeFile: volume.volumeRemoveFile2,
+    copyFiles: volume.volumeCopyFiles2,
+    http: HttpClient.HttpClient,
+});
+const typeOf = (type) => type === "FILE"
+    ? "file"
+    : type === "DIRECTORY"
+        ? "directory"
+        : type === "SYMLINK"
+            ? "symlink"
+            : "other";
+const toBytes = (data) => Effect.sync(() => (typeof data === "string" ? new TextEncoder().encode(data) : data));
+/**
+ * Read a file from a (v2) volume: Modal returns presigned URLs for the
+ * file's blocks, which are fetched and concatenated.
+ */
+export const readVolumeFile = Effect.fn(function* (ops, volumeId, path) {
+    const { getUrls, size } = yield* ops.getFile({ volumeId, path });
+    const total = Number(size ?? 0);
+    const out = new Uint8Array(total);
+    let offset = 0;
+    for (const url of getUrls ?? []) {
+        // A presigned block URL returned by VolumeGetFile2 (allowed raw HTTP).
+        const response = yield* ops.http.execute(HttpClientRequest.get(url));
+        if (response.status >= 300) {
+            return yield* new VolumeTransferError({
+                path,
+                message: `Downloading a block of ${path} failed with HTTP ${response.status}`,
+            });
+        }
+        const buffer = yield* response.arrayBuffer;
+        const block = new Uint8Array(buffer);
+        out.set(block.subarray(0, Math.max(0, total - offset)), offset);
+        offset += Math.min(block.length, BLOCK_SIZE);
+    }
+    return out;
+});
+/** List a directory of a (v2) volume. */
+export const listVolumeFiles = Effect.fn(function* (ops, volumeId, path, options = {}) {
+    const { items } = yield* ops.listFiles({
+        volumeId,
+        path,
+        recursive: options.recursive ?? false,
+    });
+    return items.flatMap((batch) => (batch.entries ?? []).map((entry) => ({
+        path: entry.path ?? "",
+        type: typeOf(entry.type),
+        size: Number(entry.size ?? 0),
+        mtime: Number(entry.mtime ?? 0),
+    })));
+});
+/**
+ * Write a file to a (v2) volume: send each 8 MiB block's SHA-256, upload
+ * the blocks Modal reports missing to the URLs it returns, then commit with
+ * the upload responses.
+ */
+export const writeVolumeFile = Effect.fn(function* (ops, volumeId, path, data, options = {}) {
+    const bytes = yield* toBytes(data);
+    const blocks = yield* Effect.sync(() => {
+        const out = [];
+        for (let offset = 0; offset === 0 || offset < bytes.length; offset += BLOCK_SIZE) {
+            const block = bytes.subarray(offset, offset + BLOCK_SIZE);
+            out.push({ data: block, sha256: createHash("sha256").update(block).digest("base64") });
+            if (bytes.length === 0)
+                break;
+        }
+        return out;
+    });
+    const putResponses = new Map();
+    for (let round = 0; round < 3; round++) {
+        const { missingBlocks } = yield* ops.putFiles({
+            volumeId,
+            files: [
+                {
+                    path,
+                    size: String(bytes.length),
+                    mode: options.mode ?? 0o644,
+                    blocks: blocks.map((block, index) => ({
+                        contentsSha256: block.sha256,
+                        putResponse: putResponses.get(index),
+                    })),
+                },
+            ],
+        });
+        if (!missingBlocks || missingBlocks.length === 0)
+            return;
+        for (const missing of missingBlocks) {
+            const index = Number(missing.blockIndex ?? 0);
+            const block = blocks[index];
+            if (!block || !missing.putUrl)
+                continue;
+            // A presigned block URL returned by VolumePutFiles2 (allowed raw HTTP).
+            const response = yield* ops.http.execute(HttpClientRequest.put(missing.putUrl).pipe(HttpClientRequest.bodyUint8Array(block.data, "application/octet-stream")));
+            if (response.status >= 300) {
+                return yield* new VolumeTransferError({
+                    path,
+                    message: `Uploading block ${index} of ${path} failed with HTTP ${response.status}`,
+                });
+            }
+            const body = yield* response.arrayBuffer;
+            const encoded = yield* Effect.sync(() => Buffer.from(body).toString("base64"));
+            putResponses.set(index, encoded);
+        }
+    }
+    return yield* new VolumeTransferError({
+        path,
+        message: `Modal kept reporting blocks of ${path} missing after upload`,
+    });
+});
+/** Remove a file (or, with `recursive`, a directory) from a (v2) volume. */
+export const removeVolumeFile = Effect.fn(function* (ops, volumeId, path, options = {}) {
+    yield* ops.removeFile({ volumeId, path, recursive: options.recursive ?? false });
+});
+/** Copy files inside a (v2) volume. */
+export const copyVolumeFiles = Effect.fn(function* (ops, volumeId, sources, destination, options = {}) {
+    yield* ops.copyFiles({
+        volumeId,
+        srcPaths: [...sources],
+        dstPath: destination,
+        recursive: options.recursive ?? false,
+    });
+});
+//# sourceMappingURL=VolumeFiles.js.map

package/lib/VolumeFiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VolumeFiles.js","sources":["../src/VolumeFiles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AACxD,OAAO,KAAK,IAAI,MAAM,aAAa,CAAC;AACpC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,iBAAiB,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,mEAAmE;AACnE,MAAM,OAAO,mBAAoB,SAAQ,IAAI,CAAC,WAAW,CAAC,2BAA2B,CAGnF;CAAG;AAaL,MAAM,UAAU,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AAEnC,yFAAyF;AACzF,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC,cAAc;IAC9B,SAAS,EAAE,MAAM,CAAC,gBAAgB;IAClC,QAAQ,EAAE,MAAM,CAAC,eAAe;IAChC,UAAU,EAAE,MAAM,CAAC,iBAAiB;IACpC,SAAS,EAAE,MAAM,CAAC,gBAAgB;IAClC,IAAI,EAAE,UAAU,CAAC,UAAU;CAC5B,CAAC,CAAC;AAIH,MAAM,MAAM,GAAG,CAAC,IAAwB,EAA2B,EAAE,CACnE,IAAI,KAAK,MAAM;IACb,CAAC,CAAC,MAAM;IACR,CAAC,CAAC,IAAI,KAAK,WAAW;QACpB,CAAC,CAAC,WAAW;QACb,CAAC,CAAC,IAAI,KAAK,SAAS;YAClB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,OAAO,CAAC;AAElB,MAAM,OAAO,GAAG,CAAC,IAAyB,EAAE,EAAE,CAC5C,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AAExF;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAC/C,GAAkB,EAClB,QAAgB,EAChB,IAAY;IAEZ,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;IAChC,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;IAClC,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,GAAG,IAAI,OAAO,IAAI,EAAE,EAAE,CAAC;QAChC,uEAAuE;QACvE,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACrE,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC,CAAC,IAAI,mBAAmB,CAAC;gBACpC,IAAI;gBACJ,OAAO,EAAE,0BAA0B,IAAI,qBAAqB,QAAQ,CAAC,MAAM,EAAE;aAC9E,CAAC,CAAC;QACL,CAAC;QACD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC3C,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QACrC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAChE,MAAM,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC,CAAC;AAEH,yCAAyC;AACzC,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAChD,GAAkB,EAClB,QAAgB,EAChB,IAAY,EACZ,OAAO,GAAqC,EAAE;IAE9C,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC;QACrC,QAAQ;QACR,IAAI;QACJ,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,KAAK;KACtC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAC7B,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,CAAC;QACrD,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE;QACtB,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC;QAC7B,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;KAChC,CAAC,CAAC,CACJ,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAChD,GAAkB,EAClB,QAAgB,EAChB,IAAY,EACZ,IAAyB,EACzB,OAAO,GAA+B,EAAE;IAExC,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE;QACrC,MAAM,GAAG,GAA6D,EAAE,CAAC;QACzE,KAAK,IAAI,MAAM,GAAG,CAAC,EAAE,MAAM,KAAK,CAAC,IAAI,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,MAAM,IAAI,UAAU,EAAE,CAAC;YACjF,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC;YAC1D,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACvF,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBAAE,MAAM;QAChC,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC/C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;QACvC,MAAM,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC5C,QAAQ;YACR,KAAK,EAAE;gBACL;oBACE,IAAI;oBACJ,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;oBAC1B,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,KAAK;oBAC3B,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;wBACpC,cAAc,EAAE,KAAK,CAAC,MAAM;wBAC5B,WAAW,EAAE,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC;qBACrC,CAAC,CAAC;iBACJ;aACF;SACF,CAAC,CAAC;QACH,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QACzD,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC;YAC9C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAC5B,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM;gBAAE,SAAS;YACxC,wEAAwE;YACxE,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CACtC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CACxC,iBAAiB,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,0BAA0B,CAAC,CACzE,CACF,CAAC;YACF,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;gBAC3B,OAAO,KAAK,CAAC,CAAC,IAAI,mBAAmB,CAAC;oBACpC,IAAI;oBACJ,OAAO,EAAE,mBAAmB,KAAK,OAAO,IAAI,qBAAqB,QAAQ,CAAC,MAAM,EAAE;iBACnF,CAAC,CAAC;YACL,CAAC;YACD,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;YACzC,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC/E,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC,CAAC,IAAI,mBAAmB,CAAC;QACpC,IAAI;QACJ,OAAO,EAAE,kCAAkC,IAAI,uBAAuB;KACvE,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,4EAA4E;AAC5E,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EACjD,GAAkB,EAClB,QAAgB,EAChB,IAAY,EACZ,OAAO,GAAqC,EAAE;IAE9C,KAAK,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,KAAK,EAAE,CAAC,CAAC;AACnF,CAAC,CAAC,CAAC;AAEH,uCAAuC;AACvC,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAChD,GAAkB,EAClB,QAAgB,EAChB,OAA8B,EAC9B,WAAmB,EACnB,OAAO,GAAqC,EAAE;IAE9C,KAAK,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC;QACnB,QAAQ;QACR,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC;QACtB,OAAO,EAAE,WAAW;QACpB,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,KAAK;KACtC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/WebhookToken.d.ts

@@ -0,0 +1,102 @@
+import * as environment from "@distilled.cloud/modal/environment";
+import * as Provider from "alchemy/Provider";
+import { Resource } from "alchemy/Resource";
+import * as Effect from "effect/Effect";
+import * as Redacted from "effect/Redacted";
+import type { Providers } from "./Providers.ts";
+declare const WebhookTokenUnexpectedResponse_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
+    readonly _tag: "Modal.WebhookTokenUnexpectedResponse";
+} & Readonly<A>;
+export declare class WebhookTokenUnexpectedResponse extends WebhookTokenUnexpectedResponse_base<{
+    readonly message: string;
+}> {
+}
+export interface WebhookTokenProps {
+    /**
+     * Display name of the token. If omitted, one is generated from the stack,
+     * stage and logical ID. Changing it renames the token in place.
+     */
+    name?: string;
+    /**
+     * Limit the token to the environments in {@link environments}. Changing it
+     * replaces the token (and its secret).
+     * @default false
+     */
+    scoped?: boolean;
+    /**
+     * Environments a scoped token works in: environment IDs, or yielded
+     * `Modal.Environment`s. Ignored unless {@link scoped} is set.
+     */
+    environments?: Array<string | {
+        readonly environmentId: string;
+    }>;
+}
+export interface WebhookTokenAttributes {
+    /** Token ID (`wk-…`), sent as the `Modal-Key` header. */
+    tokenId: string;
+    /** Token secret (`ws-…`), sent as the `Modal-Secret` header. */
+    tokenSecret: Redacted.Redacted<string>;
+    /** Display name. */
+    name: string;
+    /** Whether the token is limited to {@link WebhookTokenProps.environments}. */
+    scoped: boolean;
+    /** Environment IDs a scoped token works in. */
+    environments: string[];
+}
+/**
+ * A Modal proxy auth token: the `Modal-Key` / `Modal-Secret` header pair
+ * that web endpoints and sandbox tunnels created with proxy authentication
+ * require. A scoped token works only in the environments it lists.
+ *
+ * Modal shows a token's secret once, at creation, so a token deleted outside
+ * Alchemy is recreated with a new secret on the next deploy. Tokens have no
+ * unique names, so they can't be adopted and aren't listed for
+ * `alchemy nuke`.
+ *
+ * ### Creating a token
+ * **Example:** A workspace-wide token
+ * ```typescript
+ * import * as Modal from "@alchemy.run/modal";
+ *
+ * export const Caller = Modal.WebhookToken("Caller", {});
+ * ```
+ *
+ * **Example:** A token scoped to one environment
+ * ```typescript
+ * import * as Modal from "@alchemy.run/modal";
+ *
+ * export const Agents = Modal.Environment("Agents", {});
+ * export const AgentsCaller = Modal.WebhookToken("AgentsCaller", {
+ *   scoped: true,
+ *   environments: [Agents],
+ * });
+ * ```
+ *
+ * ### Calling a protected endpoint
+ * **Example:** Send the header pair
+ * ```typescript
+ * const token = yield* AgentsCaller;
+ * const response = yield* HttpClient.get(url, {
+ *   headers: {
+ *     "Modal-Key": token.tokenId,
+ *     "Modal-Secret": Redacted.value(token.tokenSecret),
+ *   },
+ * });
+ * ```
+ *
+ * @resource
+ * @product WebhookToken
+ */
+export declare const WebhookToken: import("alchemy/Resource").ResourceConstructor<WebhookToken, Providers> & Effect.Effect<import("alchemy/Resource").ResourceConstructor<WebhookToken, never>, never, never> & {
+    Self: import("alchemy/Self").Self<WebhookToken>;
+    Provider: Provider.Provider<WebhookToken>;
+    Aliases: readonly string[] | undefined;
+    ref(id: string, options?: {
+        stage?: string;
+        stack?: string;
+    }): Effect.Effect<WebhookToken, never, never>;
+} & ((id: string, props: import("./internal/Declared.ts").DeclaredProps<WebhookTokenProps>) => Effect.Effect<WebhookToken, never, Providers>);
+export type WebhookToken = Resource<"Modal.WebhookToken", WebhookTokenProps, WebhookTokenAttributes, never, Providers>;
+export declare const WebhookTokenProvider: () => import("effect/Layer").Layer<Provider.Provider<WebhookToken>, never, import("alchemy/Stack").Stack | import("alchemy/Stage").Stage | environment.ModalOpContext>;
+export {};
+//# sourceMappingURL=WebhookToken.d.ts.map

package/lib/WebhookToken.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebhookToken.d.ts","sources":["../src/WebhookToken.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,WAAW,MAAM,oCAAoC,CAAC;AAGlE,OAAO,KAAK,QAAQ,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAG5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;;;;AAEhD,qBAAa,8BAA+B,SAAQ,oCAElD;IACA,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;CAAG;AAEL,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG;QAAE,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACnE;AAED,MAAM,WAAW,sBAAsB;IACrC,yDAAyD;IACzD,OAAO,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,WAAW,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACvC,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,8EAA8E;IAC9E,MAAM,EAAE,OAAO,CAAC;IAChB,+CAA+C;IAC/C,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,eAAO,MAAM,YAAY;;;;;;;;6IAExB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,QAAQ,CACjC,oBAAoB,EACpB,iBAAiB,EACjB,sBAAsB,EACtB,KAAK,EACL,SAAS,CACV,CAAC;AAEF,eAAO,MAAM,oBAAoB,wKA2H9B,CAAC"}

package/lib/WebhookToken.js

@@ -0,0 +1,176 @@
+import * as environment from "@distilled.cloud/modal/environment";
+import * as webhook from "@distilled.cloud/modal/webhook";
+import { isResolved } from "alchemy/Diff";
+import * as Provider from "alchemy/Provider";
+import { Resource } from "alchemy/Resource";
+import * as Data from "effect/Data";
+import * as Effect from "effect/Effect";
+import * as Redacted from "effect/Redacted";
+import { objectName } from "./internal.js";
+import { declarable } from "./internal/Declared.js";
+export class WebhookTokenUnexpectedResponse extends Data.TaggedError("Modal.WebhookTokenUnexpectedResponse") {
+}
+/**
+ * A Modal proxy auth token: the `Modal-Key` / `Modal-Secret` header pair
+ * that web endpoints and sandbox tunnels created with proxy authentication
+ * require. A scoped token works only in the environments it lists.
+ *
+ * Modal shows a token's secret once, at creation, so a token deleted outside
+ * Alchemy is recreated with a new secret on the next deploy. Tokens have no
+ * unique names, so they can't be adopted and aren't listed for
+ * `alchemy nuke`.
+ *
+ * ### Creating a token
+ * **Example:** A workspace-wide token
+ * ```typescript
+ * import * as Modal from "@alchemy.run/modal";
+ *
+ * export const Caller = Modal.WebhookToken("Caller", {});
+ * ```
+ *
+ * **Example:** A token scoped to one environment
+ * ```typescript
+ * import * as Modal from "@alchemy.run/modal";
+ *
+ * export const Agents = Modal.Environment("Agents", {});
+ * export const AgentsCaller = Modal.WebhookToken("AgentsCaller", {
+ *   scoped: true,
+ *   environments: [Agents],
+ * });
+ * ```
+ *
+ * ### Calling a protected endpoint
+ * **Example:** Send the header pair
+ * ```typescript
+ * const token = yield* AgentsCaller;
+ * const response = yield* HttpClient.get(url, {
+ *   headers: {
+ *     "Modal-Key": token.tokenId,
+ *     "Modal-Secret": Redacted.value(token.tokenSecret),
+ *   },
+ * });
+ * ```
+ *
+ * @resource
+ * @product WebhookToken
+ */
+export const WebhookToken = declarable()(Resource("Modal.WebhookToken"));
+export const WebhookTokenProvider = () => Provider.effect(WebhookToken, Effect.gen(function* () {
+    const observe = Effect.fn(function* (tokenId) {
+        const { tokens } = yield* webhook.listWebhookToken({});
+        return (tokens ?? []).find((token) => token.tokenId === tokenId);
+    });
+    return {
+        stables: ["tokenId", "tokenSecret", "scoped"],
+        diff: Effect.fn(function* ({ news, olds }) {
+            if (!isResolved(news))
+                return undefined;
+            if ((news.scoped ?? false) !== (olds?.scoped ?? false)) {
+                return { action: "replace" };
+            }
+            return undefined;
+        }),
+        read: Effect.fn(function* ({ output }) {
+            if (output === undefined)
+                return undefined;
+            const found = yield* observe(output.tokenId);
+            if (!found)
+                return undefined;
+            return { ...output, name: found.name ?? output.name, scoped: found.scoped ?? false };
+        }),
+        reconcile: Effect.fn(function* ({ id, news, output, session }) {
+            const name = yield* objectName(id, news.name);
+            const scoped = news.scoped ?? false;
+            // Observe: only a token we created (its secret is in state) can be kept.
+            const found = output !== undefined ? yield* observe(output.tokenId) : undefined;
+            let current;
+            if (found && output) {
+                current = { ...output, name: found.name ?? output.name };
+            }
+            else {
+                // A token under our generated name that state doesn't hold is
+                // left from a create that failed before state was saved; its
+                // secret is lost, so replace it.
+                if (news.name === undefined) {
+                    const { tokens } = yield* webhook.listWebhookToken({});
+                    for (const stale of (tokens ?? []).filter((t) => t.name === name)) {
+                        if (!stale.tokenId)
+                            continue;
+                        yield* webhook
+                            .deleteWebhookToken({ tokenId: stale.tokenId })
+                            .pipe(Effect.catchTag("WebhookTokenNotFound", () => Effect.void));
+                    }
+                }
+                // Ensure
+                yield* session.note(`Creating webhook token ${name}...`);
+                const created = yield* webhook.createWebhookToken({ name, scoped });
+                if (!created.tokenId || created.tokenSecret === undefined) {
+                    return yield* new WebhookTokenUnexpectedResponse({
+                        message: `Modal returned no token for ${name}`,
+                    });
+                }
+                current = {
+                    tokenId: created.tokenId,
+                    tokenSecret: Redacted.isRedacted(created.tokenSecret)
+                        ? created.tokenSecret
+                        : Redacted.make(created.tokenSecret),
+                    name,
+                    scoped,
+                    environments: [],
+                };
+            }
+            // Sync the name.
+            if (current.name !== name) {
+                yield* webhook.updateWebhookToken({ tokenId: current.tokenId, name });
+                current = { ...current, name };
+            }
+            // Sync environments against the observed set.
+            if (scoped) {
+                // Modal doesn't serve `WebhookTokenEnvironmentList`, so read the
+                // token's environments from each environment's token list.
+                const { items } = yield* environment.listEnvironment({});
+                const observed = new Set();
+                for (const env of items ?? []) {
+                    if (!env.environmentId || !env.name)
+                        continue;
+                    // An environment deleted since the list holds no tokens.
+                    const { tokens } = yield* webhook
+                        .webhookTokenListForEnvironment({ environmentName: env.name })
+                        .pipe(Effect.catchTag("EnvironmentNotFound", () => Effect.succeed({ tokens: [] })));
+                    if ((tokens ?? []).some((token) => token.tokenId === current.tokenId)) {
+                        observed.add(env.environmentId);
+                    }
+                }
+                const desired = new Set((news.environments ?? []).flatMap((env) => typeof env === "string"
+                    ? [env]
+                    : typeof env === "object" && env !== null && "environmentId" in env
+                        ? [env.environmentId]
+                        : []));
+                for (const environmentId of desired) {
+                    if (!observed.has(environmentId)) {
+                        yield* webhook.addWebhookTokenEnvironment({
+                            tokenId: current.tokenId,
+                            environmentId,
+                        });
+                    }
+                }
+                for (const environmentId of observed) {
+                    if (!desired.has(environmentId)) {
+                        yield* webhook.removeWebhookTokenEnvironment({
+                            tokenId: current.tokenId,
+                            environmentId,
+                        });
+                    }
+                }
+                current = { ...current, environments: [...desired] };
+            }
+            return current;
+        }),
+        delete: Effect.fn(function* ({ output }) {
+            yield* webhook
+                .deleteWebhookToken({ tokenId: output.tokenId })
+                .pipe(Effect.catchTag("WebhookTokenNotFound", () => Effect.void));
+        }),
+    };
+}));
+//# sourceMappingURL=WebhookToken.js.map

package/lib/WebhookToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebhookToken.js","sources":["../src/WebhookToken.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,WAAW,MAAM,oCAAoC,CAAC;AAClE,OAAO,KAAK,OAAO,MAAM,gCAAgC,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,KAAK,QAAQ,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,IAAI,MAAM,aAAa,CAAC;AACpC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAGpD,MAAM,OAAO,8BAA+B,SAAQ,IAAI,CAAC,WAAW,CAClE,sCAAsC,CAGtC;CAAG;AAkCL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,UAAU,EAAgB,CACpD,QAAQ,CAAe,oBAAoB,CAAC,CAC7C,CAAC;AAUF,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,EAAE,CACvC,QAAQ,CAAC,MAAM,CACb,YAAY,EACZ,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,OAAO,GAAG,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAe;QAClD,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QACvD,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,OAAO,EAAE,CAAC,SAAS,EAAE,aAAa,EAAE,QAAQ,CAAC;QAC7C,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;YACvC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;gBAAE,OAAO,SAAS,CAAC;YACxC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,IAAI,KAAK,CAAC,EAAE,CAAC;gBACvD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAW,CAAC;YACxC,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC;QACF,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE;YACnC,IAAI,MAAM,KAAK,SAAS;gBAAE,OAAO,SAAS,CAAC;YAC3C,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC7C,IAAI,CAAC,KAAK;gBAAE,OAAO,SAAS,CAAC;YAC7B,OAAO,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,KAAK,EAAE,CAAC;QACvF,CAAC,CAAC;QACF,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;YAC3D,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC;YAEpC,yEAAyE;YACzE,MAAM,KAAK,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAChF,IAAI,OAA+B,CAAC;YACpC,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;gBACpB,OAAO,GAAG,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAC3D,CAAC;iBAAM,CAAC;gBACN,8DAA8D;gBAC9D,6DAA6D;gBAC7D,iCAAiC;gBACjC,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC5B,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;oBACvD,KAAK,MAAM,KAAK,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;wBAClE,IAAI,CAAC,KAAK,CAAC,OAAO;4BAAE,SAAS;wBAC7B,KAAK,CAAC,CAAC,OAAO;6BACX,kBAAkB,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;6BAC9C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;oBACtE,CAAC;gBACH,CAAC;gBACD,SAAS;gBACT,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,IAAI,KAAK,CAAC,CAAC;gBACzD,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;gBACpE,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC1D,OAAO,KAAK,CAAC,CAAC,IAAI,8BAA8B,CAAC;wBAC/C,OAAO,EAAE,+BAA+B,IAAI,EAAE;qBAC/C,CAAC,CAAC;gBACL,CAAC;gBACD,OAAO,GAAG;oBACR,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC;wBACnD,CAAC,CAAC,OAAO,CAAC,WAAW;wBACrB,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;oBACtC,IAAI;oBACJ,MAAM;oBACN,YAAY,EAAE,EAAE;iBACjB,CAAC;YACJ,CAAC;YAED,iBAAiB;YACjB,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;gBAC1B,KAAK,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;gBACtE,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC;YACjC,CAAC;YAED,8CAA8C;YAC9C,IAAI,MAAM,EAAE,CAAC;gBACX,iEAAiE;gBACjE,2DAA2D;gBAC3D,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;gBACzD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;gBACnC,KAAK,MAAM,GAAG,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;oBAC9B,IAAI,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,GAAG,CAAC,IAAI;wBAAE,SAAS;oBAC9C,yDAAyD;oBACzD,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,OAAO;yBAC9B,8BAA8B,CAAC,EAAE,eAAe,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC;yBAC7D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;oBACtF,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;wBACtE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;oBAClC,CAAC;gBACH,CAAC;gBACD,MAAM,OAAO,GAAG,IAAI,GAAG,CACrB,CAAC,IAAI,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CACxC,OAAO,GAAG,KAAK,QAAQ;oBACrB,CAAC,CAAC,CAAC,GAAG,CAAC;oBACP,CAAC,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,eAAe,IAAI,GAAG;wBACjE,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC;wBACrB,CAAC,CAAC,EAAE,CACT,CACF,CAAC;gBACF,KAAK,MAAM,aAAa,IAAI,OAAO,EAAE,CAAC;oBACpC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;wBACjC,KAAK,CAAC,CAAC,OAAO,CAAC,0BAA0B,CAAC;4BACxC,OAAO,EAAE,OAAO,CAAC,OAAO;4BACxB,aAAa;yBACd,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;gBACD,KAAK,MAAM,aAAa,IAAI,QAAQ,EAAE,CAAC;oBACrC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;wBAChC,KAAK,CAAC,CAAC,OAAO,CAAC,6BAA6B,CAAC;4BAC3C,OAAO,EAAE,OAAO,CAAC,OAAO;4BACxB,aAAa;yBACd,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;gBACD,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,YAAY,EAAE,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC;YACvD,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC;QACF,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE;YACrC,KAAK,CAAC,CAAC,OAAO;iBACX,kBAAkB,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;iBAC/C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QACtE,CAAC,CAAC;KACH,CAAC;AACJ,CAAC,CAAC,CACH,CAAC"}