@computesdk/quilt 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 computesdk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,95 @@
+# @computesdk/quilt
+
+Quilt provider for ComputeSDK.
+
+This package maps ComputeSDK's sandbox interface onto Quilt's tenant-scoped container API. It supports container lifecycle, synchronous command execution, published HTTP/WebSocket services, shell-backed filesystem operations, and Quilt snapshots.
+
+## Features
+
+- Create, inspect, list, and destroy Quilt containers
+- Run shell commands through Quilt's synchronous `/exec` API
+- Expose HTTP or WebSocket URLs through Quilt published services
+- Read and write files inside the container filesystem through exec
+- Create, list, and delete Quilt snapshots
+
+## Installation
+
+```bash
+npm install computesdk @computesdk/quilt
+```
+
+## Configuration
+
+The provider accepts config directly and falls back to environment variables.
+
+```typescript
+import { quilt } from '@computesdk/quilt';
+
+const provider = quilt({
+  baseUrl: process.env.QUILT_BASE_URL,
+  apiKey: process.env.QUILT_API_KEY,
+  tenantId: process.env.QUILT_TENANT_ID,
+});
+```
+
+Supported config fields:
+
+- `baseUrl` or `QUILT_BASE_URL`: Quilt backend base URL
+- `apiKey` or `QUILT_API_KEY`: Quilt API key
+- `accessToken` or `QUILT_ACCESS_TOKEN`: Bearer token for JWT-backed deployments
+- `tenantId` or `QUILT_TENANT_ID`: required for snapshot operations
+- `image` or `QUILT_IMAGE`: default container image, defaults to `prod`
+- `timeout` or `QUILT_TIMEOUT_MS`: default provider timeout in milliseconds
+- `publishedServiceAuthMode` or `QUILT_PUBLISHED_SERVICE_AUTH_MODE`: `service_token` or `public`
+- `publishedServiceTtlSecs` or `QUILT_PUBLISHED_SERVICE_TTL_SECS`: optional published-service TTL
+- `pollIntervalMs` or `QUILT_POLL_INTERVAL_MS`: async operation polling interval
+
+At least one of `apiKey` or `accessToken` must be configured.
+
+## Usage
+
+```typescript
+import { compute } from 'computesdk';
+import { quilt } from '@computesdk/quilt';
+
+compute.setConfig({
+  provider: quilt({
+    baseUrl: process.env.QUILT_BASE_URL,
+    apiKey: process.env.QUILT_API_KEY,
+    tenantId: process.env.QUILT_TENANT_ID,
+  }),
+});
+
+const sandbox = await compute.sandbox.create({
+  name: 'computesdk-demo',
+  envs: {
+    APP_ENV: 'dev',
+  },
+});
+
+const result = await sandbox.runCommand('echo "hello from Quilt"');
+console.log(result.stdout);
+
+const url = await sandbox.getUrl({ port: 3000 });
+console.log(url);
+
+await sandbox.destroy();
+```
+
+## Snapshot Support
+
+Snapshot operations require `tenantId` because Quilt validates `X-Tenant-Id` on snapshot routes.
+
+```typescript
+const snapshot = await provider.snapshot?.create(sandbox.sandboxId, {
+  name: 'baseline',
+  metadata: { branch: 'main' },
+});
+```
+
+## Limitations
+
+- `getUrl()` maps to Quilt published services, so it is HTTP/WebSocket only
+- Filesystem operations are implemented over shell exec for portability across Quilt containers
+- `template` operations are not exposed because Quilt's closest equivalents are image references and snapshots, which map differently
+

package/dist/__tests__/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+import type { Snapshot } from 'computesdk';
+type QuiltAuthMode = 'apiKey' | 'accessToken';
+type QuiltServiceAuthMode = 'service_token' | 'public';
+type QuiltContainerState = 'created' | 'starting' | 'running' | 'exited' | 'error';
+export interface QuiltConfig {
+    baseUrl?: string;
+    apiKey?: string;
+    accessToken?: string;
+    tenantId?: string;
+    image?: string;
+    timeout?: number;
+    publishedServiceAuthMode?: QuiltServiceAuthMode;
+    publishedServiceTtlSecs?: number;
+    pollIntervalMs?: number;
+}
+interface QuiltResolvedConfig {
+    baseUrl: string;
+    authMode: QuiltAuthMode;
+    authToken: string;
+    tenantId?: string;
+    image: string;
+    timeout: number;
+    publishedServiceAuthMode: QuiltServiceAuthMode;
+    publishedServiceTtlSecs?: number;
+    pollIntervalMs: number;
+}
+interface QuiltContainer {
+    container_id: string;
+    tenant_id?: string;
+    name?: string;
+    state?: QuiltContainerState;
+    created_at?: string;
+    started_at?: string | null;
+    exited_at?: string | null;
+    ip_address?: string | null;
+    exec_ready?: boolean;
+    network_ready?: boolean;
+    labels?: Record<string, string>;
+    [key: string]: unknown;
+}
+interface QuiltSandboxHandle {
+    config: QuiltResolvedConfig;
+    sandboxId: string;
+    container: QuiltContainer;
+}
+export declare const quilt: (config: QuiltConfig) => import("@computesdk/provider").Provider<QuiltSandboxHandle, never, Snapshot>;
+export {};