@phpsandbox/sdk 0.0.63 → 0.0.65

package/dist/git.d.ts

@@ -111,6 +111,7 @@ export type GitDiffInput = GitRemoteSource & {
     token?: string;
     ref?: string;
     base?: string;
+    patch?: boolean;
 };
 export interface GitDiffPreview {
     status: 'ready' | 'unrelated';

package/dist/index.d.ts

@@ -213,6 +213,9 @@ export interface NotebookPreviewDataEnabled {
     expires_at: string;
 }
 export type NotebookPreviewData = NotebookPreviewDataDisabled | NotebookPreviewDataEnabled;
+export type NotebookPreviewDataWithUrl = NotebookPreviewDataDisabled | (NotebookPreviewDataEnabled & {
+    url: string;
+});
 export interface SetNotebookPreviewInput {
     password: string;
 }
@@ -220,16 +223,22 @@ export interface NotebookPreviewSessionData {
     preview_session_id: string;
     token: string;
     expires_at: string;
+    url: string;
+}
+export interface CreateNotebookPreviewSessionInput {
+    url: string;
 }
 export interface CreateNotebookPreviewHandoffInput {
     preview_session_id: string;
     expires_in_seconds?: number;
+    url: string;
 }
 export interface NotebookPreviewHandoffData {
     handoff_id: string;
     preview_session_id: string;
     token: string;
     expires_at: string;
+    url: string;
 }
 export interface NotebookMailRecipientData {
     name?: string;
@@ -344,9 +353,10 @@ export declare class NotebookPreviewApi {
     private readonly client;
     constructor(client: Client);
     get(id: string): Promise<NotebookPreviewData>;
+    get(id: string, url: string): Promise<NotebookPreviewDataWithUrl>;
     setPassword(id: string, input: SetNotebookPreviewInput): Promise<NotebookPreviewData>;
     disable(id: string): Promise<void>;
-    createSession(id: string): Promise<NotebookPreviewSessionData>;
+    createSession(id: string, input: CreateNotebookPreviewSessionInput): Promise<NotebookPreviewSessionData>;
     createHandoff(id: string, input: CreateNotebookPreviewHandoffInput): Promise<NotebookPreviewHandoffData>;
 }
 export declare class NotebookMailApi {
@@ -441,9 +451,10 @@ export declare class NotebookPreview {
     private readonly notebookId;
     constructor(client: Client, notebookId: string);
     get(): Promise<NotebookPreviewData>;
+    get(url: string): Promise<NotebookPreviewDataWithUrl>;
     setPassword(input: SetNotebookPreviewInput): Promise<NotebookPreviewData>;
     disable(): Promise<void>;
-    createSession(): Promise<NotebookPreviewSessionData>;
+    createSession(input: CreateNotebookPreviewSessionInput): Promise<NotebookPreviewSessionData>;
     createHandoff(input: CreateNotebookPreviewHandoffInput): Promise<NotebookPreviewHandoffData>;
 }
 export declare class NotebookMail {

package/dist/index.js

@@ -275,8 +275,9 @@ export class NotebookPreviewApi {
     constructor(client) {
         this.client = client;
     }
-    async get(id) {
-        const response = await this.client.get(`/notebook/${id}/preview`);
+    async get(id, url) {
+        const query = url === undefined ? '' : `?${new URLSearchParams({ url }).toString()}`;
+        const response = await this.client.get(`/notebook/${id}/preview${query}`);
         return response.data;
     }
     async setPassword(id, input) {
@@ -286,8 +287,8 @@ export class NotebookPreviewApi {
     async disable(id) {
         await this.client.delete(`/notebook/${id}/preview`);
     }
-    async createSession(id) {
-        const response = await this.client.post(`/notebook/${id}/preview/session`);
+    async createSession(id, input) {
+        const response = await this.client.post(`/notebook/${id}/preview/session`, input);
         return response.data;
     }
     async createHandoff(id, input) {
@@ -577,8 +578,8 @@ export class NotebookPreview {
         this.client = client;
         this.notebookId = notebookId;
     }
-    get() {
-        return this.client.notebook.preview.get(this.notebookId);
+    get(url) {
+        return this.client.notebook.preview.get(this.notebookId, url);
     }
     setPassword(input) {
         return this.client.notebook.preview.setPassword(this.notebookId, input);
@@ -586,8 +587,8 @@ export class NotebookPreview {
     disable() {
         return this.client.notebook.preview.disable(this.notebookId);
     }
-    createSession() {
-        return this.client.notebook.preview.createSession(this.notebookId);
+    createSession(input) {
+        return this.client.notebook.preview.createSession(this.notebookId, input);
     }
     createHandoff(input) {
         return this.client.notebook.preview.createHandoff(this.notebookId, input);

package/examples/deploy-cloudflare-container.ts

@@ -1,4 +1,5 @@
 import { Client } from '../src/index.js';
+import { deploymentTargetProviderLabel } from './deployment-provider-label.js';
 
 const token = process.env.PHPSANDBOX_TOKEN;
 if (!token) {
@@ -18,7 +19,7 @@ const notebook = await client.notebook.get(notebookId);
 try {
   const deployment = await notebook.deployment();
   if (deployment && deployment.data.targetProvider !== 'okraCloudflareContainer') {
-    throw new Error(`Notebook is already published to ${deployment.data.targetProvider}. Delete that deployment before changing providers.`);
+    throw new Error(`Notebook is already published to ${deploymentTargetProviderLabel(deployment.data.targetProvider)}. Delete that deployment before changing providers.`);
   }
 
   const run = deployment

package/examples/deploy-laravel-cloud.ts

@@ -1,4 +1,5 @@
 import { Client, type LaravelCloudRegion } from '../src/index.js';
+import { deploymentTargetProviderLabel } from './deployment-provider-label.js';
 
 const token = process.env.PHPSANDBOX_TOKEN;
 if (!token) {
@@ -26,7 +27,7 @@ const notebook = await client.notebook.get(notebookId);
 try {
   const deployment = await notebook.deployment();
   if (deployment && deployment.data.targetProvider !== 'okraLaravelCloud') {
-    throw new Error(`Notebook is already published to ${deployment.data.targetProvider}. Delete that deployment before changing providers.`);
+    throw new Error(`Notebook is already published to ${deploymentTargetProviderLabel(deployment.data.targetProvider)}. Delete that deployment before changing providers.`);
   }
 
   const run = deployment ? await deployment.publish() : await publishFirstLaravelCloudDeployment();

package/examples/deploy-ssh-agent.ts

@@ -4,6 +4,7 @@ import { tmpdir } from 'node:os';
 import { join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { Client, type ServerInstance } from '../src/index.js';
+import { deploymentTargetProviderLabel } from './deployment-provider-label.js';
 
 const token = process.env.PHPSANDBOX_TOKEN;
 if (!token) {
@@ -30,7 +31,7 @@ let agent: ChildProcessWithoutNullStreams | null = null;
 try {
   const deployment = await notebook.deployment();
   if (deployment && deployment.data.targetProvider !== 'okraSshAgent') {
-    throw new Error(`Notebook is already published to ${deployment.data.targetProvider}. Delete that deployment before changing providers.`);
+    throw new Error(`Notebook is already published to ${deploymentTargetProviderLabel(deployment.data.targetProvider)}. Delete that deployment before changing providers.`);
   }
 
   const run = deployment

package/examples/deployment-provider-label.ts

@@ -0,0 +1,11 @@
+import type { DeploymentTargetProvider } from '../src/index.js';
+
+const deploymentTargetProviderLabels: Record<DeploymentTargetProvider, string> = {
+  okraCloudflareContainer: 'Cloudflare Containers',
+  okraSshAgent: 'SSH Agent',
+  okraLaravelCloud: 'Laravel Cloud',
+};
+
+export function deploymentTargetProviderLabel(provider: DeploymentTargetProvider): string {
+  return deploymentTargetProviderLabels[provider] ?? provider;
+}

package/examples/laravel-load-test.ts

@@ -2028,7 +2028,7 @@ async function requestPreviewWithSession(
 ): Promise<{ status: number; body: string }> {
   let session: NotebookPreviewSessionData;
   try {
-    session = await notebook.preview.createSession();
+    session = await notebook.preview.createSession({ url });
   } catch (error) {
     if (formatError(error).includes('Preview access must be enabled')) {
       return requestPreview(options, url);
@@ -2037,7 +2037,7 @@ async function requestPreviewWithSession(
     throw error;
   }
 
-  const bootstrapUrl = previewUrlWithSessionToken(url, session.token);
+  const bootstrapUrl = session.url;
   const bootstrap = await requestPreview(options, bootstrapUrl, { maxRedirects: 0 });
   const cookie = firstSetCookie(bootstrap.headers);
 
@@ -2064,12 +2064,6 @@ async function requestPreviewWithSession(
   };
 }
 
-function previewUrlWithSessionToken(url: string, token: string): string {
-  const next = new URL(url);
-  next.searchParams.set('__helfer_preview_session', token);
-  return next.toString();
-}
-
 function firstSetCookie(headers: Record<string, unknown>): string | undefined {
   const raw = headers['set-cookie'];
   const value = Array.isArray(raw) ? raw[0] : raw;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phpsandbox/sdk",
-  "version": "0.0.63",
+  "version": "0.0.65",
   "description": "A comprehensive TypeScript SDK for interacting with cloud-based PHP development environments",
   "main": "./dist/index.js",
   "module": "./dist/index.js",