@sandbox-kit/modal 0.1.0 → 0.1.2

package/README.md

@@ -1,13 +1,17 @@
-# Modal provider for Sandbox Kit
+# `@sandbox-kit/modal`
 
-Independent package over `modal@0.11.1`, published separately from the core
-`@sandbox-kit/sandbox` client. Use it through that shared API.
+Modal provider for [`@sandbox-kit/sandbox`](https://www.npmjs.com/package/@sandbox-kit/sandbox).
+Use the shared client API; this package supplies the `modal()` provider.
+
+## Install
 
 ```sh
 npm install @sandbox-kit/sandbox @sandbox-kit/modal
 ```
 
-## Usage
+Requires Node.js 20, 22, or 24.15+, and a Modal token pair.
+
+## Quick start
 
 ```ts
 import { modal } from "@sandbox-kit/modal";
@@ -16,41 +20,63 @@ import { Client } from "@sandbox-kit/sandbox";
 await using client = new Client({
   provider: modal(),
   auth: {
-    tokenPair: { id: "...", secret: "..." },
+    tokenPair: {
+      id: process.env.MODAL_TOKEN_ID!,
+      secret: process.env.MODAL_TOKEN_SECRET!,
+    },
+  },
+  scope: {
+    appName: process.env.MODAL_APP_NAME!,
+    environment: process.env.MODAL_ENVIRONMENT ?? "main",
   },
-  scope: { appName: "my-app", environment: "main" },
+  timeout: 120_000,
 });
 
 const sandbox = await client.create({
   source: { image: { reference: "alpine:3.21" } },
-  provisioning: { timeout: 120_000 },
+  resources: { cpuCores: 0.5, memoryMib: 512n },
+  lifetime: { maximumLifetime: 5 * 60_000 },
 });
 console.log(sandbox.id);
 ```
 
-Closing the client releases local SDK resources only. The Modal app must already
-exist.
+Closing the client releases local SDK resources only. Reclaim sandboxes with
+idle/max lifetime policies or `terminate`.
 
-## Examples
+## Configuration
+
+| Setting        | Notes                                                      |
+| -------------- | ---------------------------------------------------------- |
+| Token pair     | `auth: { tokenPair: { id, secret } }`                      |
+| OAuth refresh  | Supported with client ID and exactly one secret or JWT key |
+| Omitted `auth` | Modal SDK environment / profile credentials                |
+| App            | `scope.appName` — required                                 |
+| Environment    | `scope.environment` (default often `main`)                 |
+| Region         | `region` — default placement preference                    |
+| Endpoint       | Not supported                                              |
 
-| Example    | Project                                                                                                    |
-| ---------- | ---------------------------------------------------------------------------------------------------------- |
-| Creation   | [create-modal-sandbox](../../../../examples/typescript/modal/create-modal-sandbox/README.md)               |
-| Resources  | [create-modal-with-resources](../../../../examples/typescript/modal/create-modal-with-resources/README.md) |
-| Attach     | [attach-modal-sandbox](../../../../examples/typescript/modal/attach-modal-sandbox/README.md)               |
-| Full index | [TypeScript examples](../../../../examples/typescript/README.md)                                           |
+## What you can do
 
-## Capabilities
+**Create** from a registry image with runtime (command, workdir, PTY), gVisor or
+Linux VM isolation, CPU/memory, placement, network policy and ports, secrets,
+OIDC workload identity, readiness probes, timeouts, labels, and verbose mode.
+
+**Lifecycle** on the handle: `attach`, `terminate`, and local `close`.
+Provider-verified `get` / `refresh`, start, stop, pause, archive, and delete are
+unsupported.
+
+When you set resources, Modal requires at least 0.125 CPU cores and 128 MiB
+memory. Omitted values keep Modal defaults. Disk size cannot be raised at create.
+
+## Examples
 
-Modal supports image creation, attach, terminate, and local handle detachment.
-The creation adapter covers runtime command/workdir/PTY, gVisor or VM isolation,
-CPU and memory reservations and limits, placement, network policy and ports,
-secrets, OIDC workload identity, readiness, timeouts, labels, and verbose mode.
-Unsupported shared intent is rejected before contacting Modal.
+| Example    | Project                                                                                                                           |
+| ---------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| Creation   | [create-modal-sandbox](https://github.com/sandbox-kit/kit/tree/main/examples/typescript/modal/create-modal-sandbox)               |
+| Resources  | [create-modal-with-resources](https://github.com/sandbox-kit/kit/tree/main/examples/typescript/modal/create-modal-with-resources) |
+| Attach     | [attach-modal-sandbox](https://github.com/sandbox-kit/kit/tree/main/examples/typescript/modal/attach-modal-sandbox)               |
+| Full index | [TypeScript examples](https://github.com/sandbox-kit/kit/tree/main/examples/typescript)                                           |
 
-## Implementation notes
+## License
 
-Checks and portable field mappings are handwritten in `checks/provider_checks.ts`,
-`mappings/provider_mappings.ts`, and `config/provider_config.ts`, kept in sync with
-`specs/providers/modal.yaml`. `src/modal.ts` owns SDK call ordering;
-`src/mappings.ts` owns remaining composition those helpers do not cover.
+MIT

package/dist/checks/provider_checks.js

@@ -1,18 +1,34 @@
-import { ErrorKind, sandboxError, CreateFieldEnvironment, CreateFieldNetworkInboundCidrsEntries, CreateFieldNetworkOutboundCidrsEntries, CreateFieldNetworkOutboundDomainsEntries, CreateFieldPlacementCloud, CreateFieldResourcesCpuCores, CreateFieldResourcesMemoryMib, CreateFieldRuntimeWorkingDirectory } from "@sandbox-kit/sandbox";
+import { ErrorKind, CreateFieldEnvironment, CreateFieldNetworkInboundCidrsEntries, CreateFieldNetworkOutboundCidrsEntries, CreateFieldNetworkOutboundDomainsEntries, CreateFieldPlacementCloud, CreateFieldResourcesCpuCores, CreateFieldResourcesMemoryMib, CreateFieldRuntimeWorkingDirectory, validCidr, validDomain, validEnvName, } from "@sandbox-kit/sandbox";
+import { providerError } from "#errors.js";
 // validateProviderCreate rejects creation settings this provider cannot honor.
 // Rules are inventoried in specs/providers/modal.yaml checks.
 export function validateProviderCreate(request) {
     const cpuCores = request.resources?.cpuCores;
     if (cpuCores !== undefined && cpuCores < 0.125) {
-        fail(ErrorKind.InvalidArgument, CreateFieldResourcesCpuCores, "resources.cpu_cores is outside supported values");
+        providerError({
+            kind: ErrorKind.InvalidArgument,
+            operation: "create",
+            field: CreateFieldResourcesCpuCores,
+            message: "resources.cpu_cores is outside supported values",
+        });
     }
     const memoryMib = request.resources?.memoryMib;
     if (memoryMib !== undefined && memoryMib < BigInt("128")) {
-        fail(ErrorKind.InvalidArgument, CreateFieldResourcesMemoryMib, "resources.memory_mib is outside supported values");
+        providerError({
+            kind: ErrorKind.InvalidArgument,
+            operation: "create",
+            field: CreateFieldResourcesMemoryMib,
+            message: "resources.memory_mib is outside supported values",
+        });
     }
     const workingDirectory = request.runtime?.workingDirectory;
     if (workingDirectory !== undefined && !workingDirectory.startsWith("/")) {
-        fail(ErrorKind.InvalidArgument, CreateFieldRuntimeWorkingDirectory, "runtime.working_directory is outside supported values");
+        providerError({
+            kind: ErrorKind.InvalidArgument,
+            operation: "create",
+            field: CreateFieldRuntimeWorkingDirectory,
+            message: "runtime.working_directory is outside supported values",
+        });
     }
     const cloud = request.placement?.cloud;
     if (cloud !== undefined &&
@@ -20,87 +36,51 @@ export function validateProviderCreate(request) {
         cloud !== "gcp" &&
         cloud !== "oci" &&
         cloud !== "auto") {
-        fail(ErrorKind.Unsupported, CreateFieldPlacementCloud, "placement.cloud is outside supported values");
+        providerError({
+            kind: ErrorKind.Unsupported,
+            operation: "create",
+            field: CreateFieldPlacementCloud,
+            message: "placement.cloud is outside supported values",
+        });
     }
     for (const value of request.network?.outboundCidrs ?? []) {
         if (value !== "" && !validCidr(value)) {
-            fail(ErrorKind.InvalidArgument, CreateFieldNetworkOutboundCidrsEntries, "network.outbound_cidrs.entries is outside supported values");
+            providerError({
+                kind: ErrorKind.InvalidArgument,
+                operation: "create",
+                field: CreateFieldNetworkOutboundCidrsEntries,
+                message: "network.outbound_cidrs.entries is outside supported values",
+            });
         }
     }
     for (const value of request.network?.inboundCidrs ?? []) {
         if (!validCidr(value)) {
-            fail(ErrorKind.InvalidArgument, CreateFieldNetworkInboundCidrsEntries, "network.inbound_cidrs.entries is outside supported values");
+            providerError({
+                kind: ErrorKind.InvalidArgument,
+                operation: "create",
+                field: CreateFieldNetworkInboundCidrsEntries,
+                message: "network.inbound_cidrs.entries is outside supported values",
+            });
         }
     }
     for (const value of request.network?.outboundDomains ?? []) {
         if (value !== "" && !validDomain(value)) {
-            fail(ErrorKind.InvalidArgument, CreateFieldNetworkOutboundDomainsEntries, "network.outbound_domains.entries is outside supported values");
+            providerError({
+                kind: ErrorKind.InvalidArgument,
+                operation: "create",
+                field: CreateFieldNetworkOutboundDomainsEntries,
+                message: "network.outbound_domains.entries is outside supported values",
+            });
         }
     }
     for (const value of Object.keys(request.environment ?? {})) {
         if (!validEnvName(value)) {
-            fail(ErrorKind.InvalidArgument, CreateFieldEnvironment, "environment is outside supported values");
+            providerError({
+                kind: ErrorKind.InvalidArgument,
+                operation: "create",
+                field: CreateFieldEnvironment,
+                message: "environment is outside supported values",
+            });
         }
     }
 }
-function validEnvName(value) {
-    return /^[A-Za-z_][A-Za-z0-9_]*$/.test(value);
-}
-function validDomain(value) {
-    const domain = value.startsWith("*.") ? value.slice(2) : value;
-    return (domain.length <= 253 &&
-        /^(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.?$/i.test(domain));
-}
-function validCidr(value) {
-    const separator = value.lastIndexOf("/");
-    if (separator <= 0)
-        return false;
-    const address = value.slice(0, separator);
-    const prefix = Number(value.slice(separator + 1));
-    if (!Number.isInteger(prefix))
-        return false;
-    return address.includes(":")
-        ? prefix >= 0 && prefix <= 128 && validIpv6(address)
-        : prefix >= 0 && prefix <= 32 && validIpv4(address);
-}
-function validIpv4(value) {
-    const parts = value.split(".");
-    return (parts.length === 4 &&
-        parts.every((part) => /^(0|[1-9][0-9]{0,2})$/.test(part) && Number(part) <= 255));
-}
-function validIpv6(value) {
-    if ((value.match(/::/g)?.length ?? 0) > 1)
-        return false;
-    const halves = value.split("::");
-    if (halves.length > 2)
-        return false;
-    const count = (part) => {
-        if (part === "")
-            return 0;
-        const groups = part.split(":");
-        let total = 0;
-        for (const group of groups) {
-            if (/^[0-9a-f]{1,4}$/i.test(group))
-                total++;
-            else if (validIpv4(group))
-                total += 2;
-            else
-                return undefined;
-        }
-        return total;
-    };
-    const left = count(halves[0] ?? "");
-    const right = count(halves[1] ?? "");
-    return (left !== undefined &&
-        right !== undefined &&
-        (halves.length === 2 ? left + right < 8 : left === 8));
-}
-function fail(kind, field, message) {
-    throw sandboxError({
-        kind,
-        provider: "modal",
-        operation: "create",
-        field,
-        message: "sandbox-kit modal: " + message,
-    });
-}

package/dist/config/provider_config.js

@@ -1,10 +1,10 @@
 // Client configuration composition for the native SDK constructor.
 // Kept in sync with specs/providers/modal.yaml client: rules (not emitted).
-import { ErrorKind, sandboxError, validateConfig, ConfigFieldAuth, ConfigFieldEndpoint, ConfigFieldScopeProjectId } from "@sandbox-kit/sandbox";
+import { ErrorKind, ConfigFieldAuth, ConfigFieldEndpoint, ConfigFieldScopeProjectId, } from "@sandbox-kit/sandbox";
 import { mapClientScope, mapOAuthAuth, mapTokenPairCredentials, } from "#mappings/provider_mappings.js";
+import { providerError } from "#errors.js";
 export function mapGeneratedClientConfig(config) {
     const source = config;
-    validateConfig(source, "modal", "initialize");
     const target = {};
     if (source.endpoint !== undefined)
         unsupported(ConfigFieldEndpoint, "Endpoint cannot be configured through this SDK's public client constructor");
@@ -36,11 +36,10 @@ export function captureProviderState(config) {
     };
 }
 function unsupported(field, message) {
-    throw sandboxError({
+    providerError({
         kind: ErrorKind.Unsupported,
-        provider: "modal",
         operation: "initialize",
         field,
-        message: "sandbox-kit modal: " + message,
+        message,
     });
 }

package/dist/errors.d.ts

@@ -1,2 +1,11 @@
-import { SandboxError } from "@sandbox-kit/sandbox";
+import { SandboxError, type ErrorInfo } from "@sandbox-kit/sandbox";
+/** Inputs for throwing a Modal-scoped validation or mapping error. */
+export interface ProviderErrorInput {
+    kind: ErrorInfo["kind"];
+    operation: string;
+    field: string;
+    message: string;
+}
 export declare function mapModalError(error: unknown, operation: string): SandboxError;
+/** Local throw helper for mappings, checks, and config. */
+export declare function providerError(input: ProviderErrorInput): never;

package/dist/errors.js

@@ -1,15 +1,15 @@
 // Native Modal error translation is handwritten.
 // Classification order: existing SandboxError, abort/timeout DOMException,
 // then native Modal types, then unknown. Cause stays on SandboxError.cause.
-import { AlreadyExistsError, ClientClosedError, ConflictError, InvalidError, NotFoundError, ResourceExhaustedError, SandboxTimeoutError, TimeoutError } from "modal";
-import { ErrorKind, SandboxError, sandboxError } from "@sandbox-kit/sandbox";
+import { AlreadyExistsError, ClientClosedError, ConflictError, InvalidError, NotFoundError, ResourceExhaustedError, SandboxTimeoutError, TimeoutError, } from "modal";
+import { ErrorKind, SandboxError, sandboxError, } from "@sandbox-kit/sandbox";
 export function mapModalError(error, operation) {
     if (error instanceof SandboxError)
         return error;
     if (error instanceof DOMException && error.name === "AbortError")
-        return create(ErrorKind.Canceled, error, operation);
+        return create({ kind: ErrorKind.Canceled, error, operation });
     if (error instanceof DOMException && error.name === "TimeoutError")
-        return create(ErrorKind.Timeout, error, operation);
+        return create({ kind: ErrorKind.Timeout, error, operation });
     let kind = ErrorKind.Unknown;
     if (kind === ErrorKind.Unknown && error instanceof InvalidError)
         kind = ErrorKind.InvalidArgument;
@@ -27,8 +27,30 @@ export function mapModalError(error, operation) {
         kind = ErrorKind.Timeout;
     if (kind === ErrorKind.Unknown && error instanceof ClientClosedError)
         kind = ErrorKind.FailedPrecondition;
-    return create(kind, error, operation);
+    return create({ kind, error, operation });
 }
-function create(kind, error, operation, statusCode, providerCode, providerSource) {
-    return sandboxError({ kind, provider: "modal", operation, field: "", message: error instanceof Error ? error.message : "sandbox-kit modal: provider operation failed", ...(statusCode === undefined ? {} : { statusCode }), ...(providerCode === undefined ? {} : { providerCode }), ...(providerSource === undefined ? {} : { providerSource }) }, error);
+function create(input) {
+    const { kind, error, operation, statusCode, providerCode, providerSource } = input;
+    return sandboxError({
+        kind,
+        provider: "modal",
+        operation,
+        field: "",
+        message: error instanceof Error
+            ? error.message
+            : "sandbox-kit modal: provider operation failed",
+        ...(statusCode === undefined ? {} : { statusCode }),
+        ...(providerCode === undefined ? {} : { providerCode }),
+        ...(providerSource === undefined ? {} : { providerSource }),
+    }, error);
+}
+/** Local throw helper for mappings, checks, and config. */
+export function providerError(input) {
+    throw sandboxError({
+        kind: input.kind,
+        provider: "modal",
+        operation: input.operation,
+        field: input.field,
+        message: "sandbox-kit modal: " + input.message,
+    });
 }

package/dist/mappings/mappings.js

@@ -1,9 +1,10 @@
 // Provider-specific orchestration around generated portable field mappings.
 import { Probe, } from "modal";
-import { EgressMode, ErrorKind, IsolationKind, PolicyMode, PortTransport, SecretInjection, SandboxState, ValueOrigin, WaitCondition, sandboxError, CreateFieldIsolation, CreateFieldIsolationKind, CreateFieldLifetime, CreateFieldLifetimeIdleTerminateAfter, CreateFieldLifetimeIdleTerminateMode, CreateFieldNetwork, CreateFieldNetworkEgress, CreateFieldNetworkPortsPort, CreateFieldNetworkPortsTransport, CreateFieldPlacementTarget, CreateFieldProvisioningTimeout, CreateFieldProvisioningWaitFor, CreateFieldReadiness, CreateFieldRuntime, CreateFieldSecuritySecretsEnvironmentVariable, CreateFieldSecuritySecretsInjection, CreateFieldSource, ConfigFieldScopeAppName, CreateFieldName, CreateFieldNetworkInboundCidrs, CreateFieldNetworkProxyReference, CreateFieldProvisioningQueueTimeout, CreateFieldResourcesCpuLimitCores, CreateFieldResourcesDiskMib, CreateFieldResourcesMemoryLimitMib, CreateFieldResourcesMemoryMib, CreateFieldSecurityPublicAccess, CreateFieldSecuritySecretsReference, CreateFieldSourceImageReference } from "@sandbox-kit/sandbox";
+import { EgressMode, ErrorKind, IsolationKind, PolicyMode, PortTransport, SecretInjection, SandboxState, ValueOrigin, WaitCondition, CreateFieldIsolation, CreateFieldIsolationKind, CreateFieldLifetime, CreateFieldLifetimeIdleTerminateAfter, CreateFieldLifetimeIdleTerminateMode, CreateFieldNetwork, CreateFieldNetworkEgress, CreateFieldNetworkPortsPort, CreateFieldNetworkPortsTransport, CreateFieldPlacementTarget, CreateFieldProvisioningTimeout, CreateFieldProvisioningWaitFor, CreateFieldReadiness, CreateFieldRuntime, CreateFieldSecuritySecretsEnvironmentVariable, CreateFieldSecuritySecretsInjection, CreateFieldSource, ConfigFieldScopeAppName, CreateFieldName, CreateFieldNetworkInboundCidrs, CreateFieldNetworkProxyReference, CreateFieldProvisioningQueueTimeout, CreateFieldResourcesCpuLimitCores, CreateFieldResourcesDiskMib, CreateFieldResourcesMemoryLimitMib, CreateFieldResourcesMemoryMib, CreateFieldSecurityPublicAccess, CreateFieldSecuritySecretsReference, CreateFieldSourceImageReference, } from "@sandbox-kit/sandbox";
 import { mapCommonCreateFields as generatedMapCommonCreateFields, mapIdleDuration as generatedMapIdleDuration, mapLifetimeDuration as generatedMapLifetimeDuration, mapResources as generatedMapResources, mapSandboxIdentity as generatedMapSandboxIdentity, } from "./provider_mappings.js";
 import { validateProviderCreate } from "#checks/provider_checks.js";
 import { mapGeneratedClientConfig } from "#config/provider_config.js";
+import { providerError } from "#errors.js";
 export function mapClientConfig(config) {
     const result = mapGeneratedClientConfig(config);
     if (config.timeout !== undefined)
@@ -289,29 +290,26 @@ function finiteDurationMs(v, f, zero) {
     return v;
 }
 function invalid(field, message) {
-    throw sandboxError({
+    providerError({
         kind: ErrorKind.InvalidArgument,
-        provider: "modal",
         operation: "create",
         field,
-        message: "sandbox-kit modal: " + message,
+        message,
     });
 }
 function unsupported(field, message) {
-    throw sandboxError({
+    providerError({
         kind: ErrorKind.Unsupported,
-        provider: "modal",
         operation: "create",
         field,
-        message: "sandbox-kit modal: " + message,
+        message,
     });
 }
 function configInvalid(field, message) {
-    throw sandboxError({
+    providerError({
         kind: ErrorKind.InvalidArgument,
-        provider: "modal",
         operation: "initialize",
         field,
-        message: "sandbox-kit modal: " + message,
+        message,
     });
 }

package/dist/mappings/provider_mappings.js

@@ -1,6 +1,7 @@
 // Provider field mappings between shared CreateOptions/Config and the native SDK.
 // Inventoried in specs/providers/modal.yaml groups; kept in sync by hand (not emitted).
-import { ErrorKind, ValueOrigin, sandboxError, CreateFieldResourcesMemoryLimitMib, CreateFieldResourcesMemoryMib, InfoFieldId, CreateFieldLifetimeIdleTerminateAfter, CreateFieldLifetimeMaximumLifetime, CreateFieldResourcesCpuCores, CreateFieldResourcesCpuLimitCores } from "@sandbox-kit/sandbox";
+import { ErrorKind, ValueOrigin, CreateFieldResourcesMemoryLimitMib, CreateFieldResourcesMemoryMib, InfoFieldId, CreateFieldLifetimeIdleTerminateAfter, CreateFieldLifetimeMaximumLifetime, CreateFieldResourcesCpuCores, CreateFieldResourcesCpuLimitCores, } from "@sandbox-kit/sandbox";
+import { providerError } from "#errors.js";
 export function mapSandboxIdentity(source, operation = "create") {
     const target = {};
     if (source === undefined)
@@ -71,7 +72,12 @@ export function mapResources(source, operation = "create") {
         if (source.memoryMib !== undefined) {
             const value = source.memoryMib;
             if (value > 2147483647n)
-                mappingError(ErrorKind.InvalidArgument, CreateFieldResourcesMemoryMib, "memory_mib cannot be represented", operation);
+                mappingError({
+                    kind: ErrorKind.InvalidArgument,
+                    field: CreateFieldResourcesMemoryMib,
+                    message: "memory_mib cannot be represented",
+                    operation,
+                });
             target.memoryMiB = Number(value);
         }
     }
@@ -79,7 +85,12 @@ export function mapResources(source, operation = "create") {
         if (source.memoryLimitMib !== undefined) {
             const value = source.memoryLimitMib;
             if (value > 2147483647n)
-                mappingError(ErrorKind.InvalidArgument, CreateFieldResourcesMemoryLimitMib, "memory_limit_mib cannot be represented", operation);
+                mappingError({
+                    kind: ErrorKind.InvalidArgument,
+                    field: CreateFieldResourcesMemoryLimitMib,
+                    message: "memory_limit_mib cannot be represented",
+                    operation,
+                });
             target.memoryLimitMiB = Number(value);
         }
     }
@@ -114,7 +125,12 @@ function scaledCpuCores(value, field, operation) {
         value < 0 ||
         value !== scaled / 1000 ||
         scaled > 4_294_967_295) {
-        mappingError(ErrorKind.InvalidArgument, field, field.slice(field.lastIndexOf(".") + 1) + " cannot be represented", operation);
+        mappingError({
+            kind: ErrorKind.InvalidArgument,
+            field,
+            message: field.slice(field.lastIndexOf(".") + 1) + " cannot be represented",
+            operation,
+        });
     }
     return value * 1000 < scaled ? scaled / 1000 : value;
 }
@@ -124,7 +140,12 @@ function durationSecondsMs(value, field, maximumSeconds, operation) {
         value <= 0 ||
         value % 1000 !== 0 ||
         value / 1000 > maximumSeconds) {
-        mappingError(ErrorKind.InvalidArgument, field, field.slice(field.lastIndexOf(".") + 1) + " cannot be represented", operation);
+        mappingError({
+            kind: ErrorKind.InvalidArgument,
+            field,
+            message: field.slice(field.lastIndexOf(".") + 1) + " cannot be represented",
+            operation,
+        });
     }
     return value;
 }
@@ -168,12 +189,6 @@ export function mapOAuthAuth(source, operation = "create") {
     }
     return target;
 }
-function mappingError(kind, field, message, operation) {
-    throw sandboxError({
-        kind,
-        provider: "modal",
-        operation,
-        field,
-        message: "sandbox-kit modal: " + message,
-    });
+function mappingError(input) {
+    providerError(input);
 }

package/dist/modal.js

@@ -1,9 +1,9 @@
 import { ModalClient, } from "modal";
-import { LifecycleCapability } from "@sandbox-kit/sandbox";
+import { LifecycleCapability, } from "@sandbox-kit/sandbox";
 import { mapClientConfig, mapCreateRequest, mapSandboxInfo, } from "#mappings/mappings.js";
-import { mapModalError } from "./errors.js";
+import { mapModalError } from "#errors.js";
 import { BackendBase, ProviderBase } from "./provider.js";
-import { captureProviderState } from "#config/provider_config.js";
+import { captureProviderState, } from "#config/provider_config.js";
 /** @internal Exported for adapter boundary tests, but not from the package root. */
 export class ModalProvider extends ProviderBase {
     nativeFactory;

package/package.json

@@ -1,7 +1,14 @@
 {
   "name": "@sandbox-kit/modal",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "modal provider for sandbox kit",
+  "keywords": [
+    "sandbox-kit",
+    "sandbox",
+    "modal",
+    "sdk",
+    "provider"
+  ],
   "license": "MIT",
   "type": "module",
   "packageManager": "npm@11.19.0",
@@ -45,16 +52,21 @@
     "#config/*.js": {
       "@sandbox-kit/source": "./src/config/*.ts",
       "default": "./dist/config/*.js"
+    },
+    "#errors.js": {
+      "@sandbox-kit/source": "./src/errors.ts",
+      "default": "./dist/errors.js"
     }
   },
   "scripts": {
+    "clean": "rm -rf dist",
     "build": "tsc -p tsconfig.build.json",
-    "prepublishOnly": "npm run build",
+    "prepublishOnly": "npm run clean && npm run build",
     "test": "tsc -p tsconfig.test.json && vitest run"
   },
   "dependencies": {
     "@bufbuild/protobuf": "2.16.0",
-    "@sandbox-kit/sandbox": "0.1.0",
+    "@sandbox-kit/sandbox": "0.1.2",
     "modal": "0.11.1"
   },
   "devDependencies": {

package/dist/mappings.d.ts

@@ -1,17 +0,0 @@
-import { type ModalClientParams, type Sandbox, type SandboxCreateParams } from "modal";
-import { type Config, type CreateOptions, type SandboxInfo } from "@sandbox-kit/sandbox";
-import type { ProviderState } from "./provider_config.js";
-export interface ModalCreatePlan {
-    readonly app: string;
-    readonly environment?: string;
-    readonly image: string;
-    readonly params: SandboxCreateParams;
-    readonly secretNames: readonly string[];
-    readonly proxyName?: string;
-    readonly waitUntilReady: boolean;
-    readonly readyTimeoutMs?: number;
-}
-export declare function mapClientConfig(config: Config): ModalClientParams;
-export declare function mapCreateRequest(request: CreateOptions, config: ProviderState): ModalCreatePlan;
-export declare function mapSandboxInfo(value: Sandbox, request?: CreateOptions): SandboxInfo;
-//# sourceMappingURL=mappings.d.ts.map