@sandboxrouter/sdk 0.1.0 → 0.3.0

package/dist/catalog.d.ts

@@ -16,20 +16,249 @@ export interface ProviderInfo {
         maxVcpu: number;
         maxMemoryGb: number;
     };
+    /**
+     * The size every sandbox gets unless a custom image (template, snapshot) is passed, whatever
+     * vcpu/memoryGb ask for. Measured inside real sandboxes (nproc, MemTotal). The router skips the
+     * provider for requests bigger than this and prices it at this size.
+     */
+    defaultSize?: {
+        vcpu: number;
+        memoryGb: number;
+        measured: string;
+    };
+    /** Runs on your own machine (Docker). Never chosen automatically; name it to use it. */
+    local?: boolean;
     /** Env vars the adapter reads. Any one group being fully set means "configured". */
     credentials: string[][];
     docs: string;
+    /**
+     * Set when you can't just sign up and get a key: "waitlist" (invite or beta only) or "closed"
+     * (not taking new accounts). Existing accounts keep working, so routing is unchanged: the router
+     * only ever uses providers you have keys for.
+     */
+    access?: {
+        status: "waitlist" | "closed";
+        note: string;
+        checked: string;
+    };
+    /**
+     * "allocated": you pay for the size you asked for while it runs. "active-cpu": CPU is charged only
+     * while it's busy, so the listed price (every core busy) is the most an hour can cost; idle agents pay less.
+     */
+    billing: "allocated" | "active-cpu";
+    /**
+     * The cheapest monthly plan you need before you can create sandboxes through the API. Absent when a
+     * free tier or plain pay-as-you-go works. `credited`: the fee comes back as usage credit.
+     * `unclear`: the pricing page doesn't say whether a free tier can use the API.
+     */
+    plan?: {
+        usdMonth: number;
+        credited: boolean;
+        unclear?: boolean;
+        note: string;
+        checked: string;
+    };
 }
+/** Short label for a gated provider's sign-up status, or null when anyone can sign up. */
+export declare function accessLabel(id: ProviderId): string | null;
+/** Short label for the plan a provider needs before you can use it: "none", "$20/mo (credited)", "$5/mo". */
+export declare function planLabel(id: ProviderId): string;
 /**
- * Catalog order is the default routing order. Maritime is first because it is the cheapest
- * managed sandbox per hour in this list at every shape; `npx @sandboxrouter/sdk providers` prints the
- * numbers so you can check, and PRs that correct a price are welcome.
+ * The order tables list providers in (README, CLI, website): providers anyone can sign up for that can
+ * take this size, cheapest first, ties alphabetical; then waitlisted or closed sign-ups; then providers
+ * that can't take the size; then Docker. The router uses the same price order, but only among providers
+ * you have keys for, so a gated provider only gets work if you already have an account there.
  */
+export declare function listingOrder(spec?: SandboxSpec): ProviderInfo[];
 export declare const CATALOG: ProviderInfo[];
+/** Cloudflare only rents fixed instance types: https://developers.cloudflare.com/containers/platform/limits/ */
+export declare const CLOUDFLARE_INSTANCES: readonly [{
+    readonly name: "lite";
+    readonly vcpu: number;
+    readonly memoryGb: 0.25;
+}, {
+    readonly name: "basic";
+    readonly vcpu: number;
+    readonly memoryGb: 1;
+}, {
+    readonly name: "standard-1";
+    readonly vcpu: number;
+    readonly memoryGb: 4;
+}, {
+    readonly name: "standard-2";
+    readonly vcpu: 1;
+    readonly memoryGb: 6;
+}, {
+    readonly name: "standard-3";
+    readonly vcpu: 2;
+    readonly memoryGb: 8;
+}, {
+    readonly name: "standard-4";
+    readonly vcpu: 4;
+    readonly memoryGb: 12;
+}];
+/** CodeSandbox VM tiers: https://docs.together.ai/docs/together-code-sandbox-legacy (Pico supports 2 vCPU / 1 GB). */
+export declare const CODESANDBOX_TIERS: readonly [{
+    readonly name: "Pico";
+    readonly vcpu: 2;
+    readonly memoryGb: 1;
+    readonly usdHour: 0.0743;
+}, {
+    readonly name: "Nano";
+    readonly vcpu: 2;
+    readonly memoryGb: 4;
+    readonly usdHour: 0.1486;
+}, {
+    readonly name: "Micro";
+    readonly vcpu: 4;
+    readonly memoryGb: 8;
+    readonly usdHour: 0.2972;
+}, {
+    readonly name: "Small";
+    readonly vcpu: 8;
+    readonly memoryGb: 16;
+    readonly usdHour: 0.5944;
+}, {
+    readonly name: "Medium";
+    readonly vcpu: 16;
+    readonly memoryGb: 32;
+    readonly usdHour: 1.1888;
+}, {
+    readonly name: "Large";
+    readonly vcpu: 32;
+    readonly memoryGb: 64;
+    readonly usdHour: 2.3776;
+}, {
+    readonly name: "XLarge";
+    readonly vcpu: 64;
+    readonly memoryGb: 128;
+    readonly usdHour: 4.7552;
+}];
+/** Smallest tier with at least the requested vCPUs and memory (the largest if nothing fits). */
+export declare function codesandboxTier(vcpu: number, memoryGb: number): {
+    readonly name: "Pico";
+    readonly vcpu: 2;
+    readonly memoryGb: 1;
+    readonly usdHour: 0.0743;
+} | {
+    readonly name: "Nano";
+    readonly vcpu: 2;
+    readonly memoryGb: 4;
+    readonly usdHour: 0.1486;
+} | {
+    readonly name: "Micro";
+    readonly vcpu: 4;
+    readonly memoryGb: 8;
+    readonly usdHour: 0.2972;
+} | {
+    readonly name: "Small";
+    readonly vcpu: 8;
+    readonly memoryGb: 16;
+    readonly usdHour: 0.5944;
+} | {
+    readonly name: "Medium";
+    readonly vcpu: 16;
+    readonly memoryGb: 32;
+    readonly usdHour: 1.1888;
+} | {
+    readonly name: "Large";
+    readonly vcpu: 32;
+    readonly memoryGb: 64;
+    readonly usdHour: 2.3776;
+} | {
+    readonly name: "XLarge";
+    readonly vcpu: 64;
+    readonly memoryGb: 128;
+    readonly usdHour: 4.7552;
+};
+/** Upstash Box sizes (https://upstash.com/docs/box/overall/how-it-works.md#box-size). */
+export declare const UPSTASH_SIZES: readonly [{
+    readonly size: "small";
+    readonly vcpu: 2;
+    readonly memoryGb: 4;
+}, {
+    readonly size: "medium";
+    readonly vcpu: 4;
+    readonly memoryGb: 8;
+}, {
+    readonly size: "large";
+    readonly vcpu: 8;
+    readonly memoryGb: 16;
+}];
+export declare function upstashSize(vcpu: number, memoryGb: number): {
+    readonly size: "small";
+    readonly vcpu: 2;
+    readonly memoryGb: 4;
+} | {
+    readonly size: "medium";
+    readonly vcpu: 4;
+    readonly memoryGb: 8;
+} | {
+    readonly size: "large";
+    readonly vcpu: 8;
+    readonly memoryGb: 16;
+};
+/** Boat's fixed machine sizes and hourly prices: https://docs.boat.dev/machines.md */
+export declare const BOAT_SIZES: readonly [{
+    readonly type: "small";
+    readonly vcpu: 2;
+    readonly memoryGb: 4;
+    readonly usdHour: 0.018;
+}, {
+    readonly type: "default";
+    readonly vcpu: 4;
+    readonly memoryGb: 8;
+    readonly usdHour: 0.036;
+}, {
+    readonly type: "large";
+    readonly vcpu: 8;
+    readonly memoryGb: 16;
+    readonly usdHour: 0.072;
+}, {
+    readonly type: "xlarge";
+    readonly vcpu: 16;
+    readonly memoryGb: 32;
+    readonly usdHour: 0.2;
+}];
+export declare function cloudflareInstance(vcpu: number, memoryGb: number): {
+    readonly name: "lite";
+    readonly vcpu: number;
+    readonly memoryGb: 0.25;
+} | {
+    readonly name: "basic";
+    readonly vcpu: number;
+    readonly memoryGb: 1;
+} | {
+    readonly name: "standard-1";
+    readonly vcpu: number;
+    readonly memoryGb: 4;
+} | {
+    readonly name: "standard-2";
+    readonly vcpu: 1;
+    readonly memoryGb: 6;
+} | {
+    readonly name: "standard-3";
+    readonly vcpu: 2;
+    readonly memoryGb: 8;
+} | {
+    readonly name: "standard-4";
+    readonly vcpu: 4;
+    readonly memoryGb: 12;
+};
 export declare function info(id: ProviderId): ProviderInfo;
 export declare const DEFAULT_VCPU = 2;
 export declare const DEFAULT_MEMORY_GB = 4;
 /** Estimated USD per hour for this spec on this provider (list price, while running). */
+/** The size the sandbox will really have when it's fixed by the default image, else null. */
+export declare function fixedSize(id: ProviderId, spec?: SandboxSpec): {
+    vcpu: number;
+    memoryGb: number;
+} | null;
+/** A spec this provider can take as-is: its default size if it has one, else the router default. */
+export declare function fittingSpec(id: ProviderId): {
+    vcpu: number;
+    memoryGb: number;
+};
 export declare function hourlyCost(id: ProviderId, spec?: SandboxSpec): number;
 /** Why a provider can't take this spec, or null if it can. */
 export declare function unfit(id: ProviderId, spec: SandboxSpec, require?: Capability[]): string | null;