@deepraxis/sdk 0.1.1-dev.f0ef747 → 0.1.1-dev.f23829c

package/dist/core/client.d.ts

@@ -1,3 +1,4 @@
+import { type SandboxTemplateBuildInput, type SandboxTemplateBuildResult } from "../helpers/sandbox-templates.js";
 import { type UploadFileOptions, type UploadedFile } from '../helpers/file-upload.js';
 import { resourceFactories } from '../resources.generated.js';
 import { type PraxisOptions } from './transport.js';
@@ -7,7 +8,12 @@ import { type CountInput, type CountResult } from '../helpers/database-count.js'
 type Resources = {
     readonly [K in keyof typeof resourceFactories]: ReturnType<(typeof resourceFactories)[K]>;
 };
-export interface Praxis extends Omit<Resources, 'application' | 'browser' | 'database' | 'file'> {
+export interface Praxis extends Omit<Resources, 'application' | 'browser' | 'database' | 'file' | 'sandbox'> {
+    readonly sandbox: Omit<Resources['sandbox'], 'templates'> & {
+        templates: Resources['sandbox']['templates'] & {
+            build(input: SandboxTemplateBuildInput): Promise<SandboxTemplateBuildResult>;
+        };
+    };
     readonly browser: Resources['browser'] & {
         connect(options?: BrowserConnectOptions): Promise<PraxisBrowser>;
     };

package/dist/core/client.js

@@ -1,3 +1,4 @@
+import { buildSandboxTemplate } from "../helpers/sandbox-templates.js";
 import { uploadFile } from "../helpers/file-upload.js";
 import { resourceFactories } from "../resources.generated.js";
 import { Transport } from "./transport.js";
@@ -10,6 +11,8 @@ export class Praxis {
         for (const [name, create] of Object.entries(resourceFactories)) {
             const resource = create(transport);
             // Assemble before sealing the resource property; never replace a readonly SDK resource.
+            if (name === 'sandbox')
+                Object.assign(resource.templates, { build: (input) => buildSandboxTemplate(this, input) });
             if (name === 'file')
                 Object.assign(resource, { uploadFile: (file, options) => uploadFile(this, file, options) });
             if (name === 'database')

package/dist/core/transport.d.ts

@@ -25,6 +25,15 @@ type InternalOptions = RequestOptions & {
     query?: unknown;
     lastEventId?: string;
 };
+/** Margin over a server-side execution deadline: the response still has to travel back after it. */
+export declare const SERVER_DEADLINE_MARGIN_MS = 30000;
+/**
+ * A request body that carries its own execution deadline (`timeoutMs`, as in sandbox commands.run) is
+ * waited for at least that long plus a margin, so the client never gives up before the server answers.
+ */
+export declare function serverDeadlineMs(options: {
+    body?: unknown;
+}): number;
 export declare class Transport {
     private readonly config;
     constructor(options: PraxisOptions);

package/dist/core/transport.js

@@ -32,10 +32,21 @@ function assertKnownOptions(options) {
         detail: `Unrecognised option ${stray.length > 1 ? 'keys' : 'key'} ${names}. Request parameters are not flat: put each under \`query\` (GET/DELETE: filters, pagination), \`path\` (URL segments) or \`body\` (POST/PATCH/PUT payload), e.g. call({ query: { ${stray[0]} } }) or call({ body: { ${stray[0]} } }). Common top-level keys: path, query, body, headers, signal, timeoutMs, maxRetries.`,
     });
 }
+/** Margin over a server-side execution deadline: the response still has to travel back after it. */
+export const SERVER_DEADLINE_MARGIN_MS = 30_000;
+/**
+ * A request body that carries its own execution deadline (`timeoutMs`, as in sandbox commands.run) is
+ * waited for at least that long plus a margin, so the client never gives up before the server answers.
+ */
+export function serverDeadlineMs(options) {
+    const body = options.body;
+    const deadline = body && typeof body === 'object' ? body.timeoutMs : undefined;
+    return typeof deadline === 'number' && Number.isFinite(deadline) && deadline > 0 ? deadline + SERVER_DEADLINE_MARGIN_MS : 0;
+}
 export class Transport {
     config;
     constructor(options) {
-        this.config = { timeoutMs: 60_000, maxRetries: 2, fetch: globalThis.fetch, ...options };
+        this.config = { timeoutMs: 600_000, maxRetries: 2, fetch: globalThis.fetch, ...options };
         this.validate(this.config.timeoutMs, this.config.maxRetries);
     }
     validate(timeout, retries) {
@@ -46,7 +57,7 @@ export class Transport {
     }
     scope(options, streaming) {
         assertKnownOptions(options);
-        const timeoutMs = options.timeoutMs ?? this.config.timeoutMs;
+        const timeoutMs = options.timeoutMs ?? Math.max(this.config.timeoutMs, serverDeadlineMs(options));
         const maxRetries = options.maxRetries ?? this.config.maxRetries;
         this.validate(timeoutMs, maxRetries);
         const controller = new AbortController();