@phpsandbox/sdk 0.1.1 → 0.1.2

package/examples/notebook-readonly-smoke.ts

@@ -155,12 +155,12 @@ async function main(): Promise<void> {
     }, false);
 
     await recordStep(steps, 'container.opened-ports', options.stepTimeoutMs, async () => {
-      const ports = await notebook!.container.openedPorts();
-      return describePorts(assertPortInfoList(ports, 'container.openedPorts'));
+      const ports = await notebook!.ports.list();
+      return describePorts(assertPortInfoList(ports, 'ports.list'));
     }, false);
 
     const rootSnapshot = await recordStep(steps, 'filesystem.root', options.stepTimeoutMs, async () => {
-      const rootEntries = await notebook!.file.readDirectory('/');
+      const rootEntries = await notebook!.files.list('/');
 
       const preferred = ['composer.json', 'index.php', 'artisan'];
       const rootNames = new Set(rootEntries.map(([name]) => name));
@@ -174,7 +174,7 @@ async function main(): Promise<void> {
     const treePath = rootSnapshot.candidate === 'artisan' ? 'routes' : undefined;
     if (treePath) {
       await recordStep(steps, 'filesystem.tree', options.stepTimeoutMs, async () => {
-        const tree = await notebook!.file.tree(treePath);
+        const tree = await notebook!.files.tree(treePath);
         return `path=${treePath} bytes=${tree.length}`;
       }, false);
     } else {
@@ -183,8 +183,8 @@ async function main(): Promise<void> {
 
     const findSnapshot = await recordStep(steps, 'filesystem.find', options.stepTimeoutMs, async () => {
       const [composerFiles, indexFiles] = await Promise.all([
-        notebook!.file.find('composer.json', { maxResults: 10 }),
-        notebook!.file.find('index.php', { maxResults: 10 }),
+        notebook!.files.find('composer.json', { maxResults: 10 }),
+        notebook!.files.find('index.php', { maxResults: 10 }),
       ]);
       const candidate = [...composerFiles, ...indexFiles].find((file) => typeof file.path === 'string')?.path;
       return {
@@ -197,15 +197,13 @@ async function main(): Promise<void> {
 
     if (candidate) {
       await recordStep(steps, 'filesystem.read-candidate', options.stepTimeoutMs, async () => {
-        const [info, stat, content, tail] = await Promise.all([
-          notebook!.file.info(candidate),
-          notebook!.file.stat(candidate),
-          notebook!.file.readFile(candidate),
-          notebook!.file.tail(candidate, 10),
+        const [stat, content, tail] = await Promise.all([
+          notebook!.files.stat(candidate),
+          notebook!.files.read(candidate),
+          notebook!.files.tail(candidate, { lines: 10 }),
         ]);
 
-        const bytes = content instanceof Uint8Array ? content : new TextEncoder().encode(JSON.stringify(content));
-        return `path=${candidate} size=${stat.size} binary=${info.binary} sha256=${sha256(bytes)} tailBytes=${tail.length}`;
+        return `path=${candidate} size=${stat.size} sha256=${sha256(content)} tailBytes=${tail.length}`;
       }, false);
     } else {
       recordSkippedStep(steps, 'filesystem.read-candidate', 'No readable candidate file found.');
@@ -214,7 +212,10 @@ async function main(): Promise<void> {
     if (options.includeDownload) {
       if (candidate) {
         await recordStep(steps, 'filesystem.download', options.stepTimeoutMs, async () => {
-          const archive = await notebook!.file.download(undefined, ['vendor/**', 'node_modules/**'], [candidate]);
+          const archive = await notebook!.files.download({
+            exclude: ['vendor/**', 'node_modules/**'],
+            include: [candidate],
+          });
           if (archive.size === 0) {
             throw new Error('file.download() returned an empty blob.');
           }
@@ -228,7 +229,7 @@ async function main(): Promise<void> {
     }
 
     await recordStep(steps, 'filesystem.search', options.stepTimeoutMs, async () => {
-      const [hasMore, matches] = await notebook!.file.search({
+      const [hasMore, matches] = await notebook!.files.search({
         pattern: 'php',
         isRegExp: false,
         isCaseSensitive: false,
@@ -260,7 +261,7 @@ async function main(): Promise<void> {
       await runExecutionChecks(notebook, steps, options);
     } else {
       recordSkippedStep(steps, 'shell.run', 'Enable with --include-exec.');
-      recordSkippedStep(steps, 'terminal.spawn', 'Enable with --include-exec.');
+      recordSkippedStep(steps, 'terminals.create', 'Enable with --include-exec.');
       recordSkippedStep(steps, 'terminal.interactive', 'Enable with --include-exec.');
       recordSkippedStep(steps, 'terminal.osc', 'Enable with --include-exec.');
       recordSkippedStep(steps, 'repl.eval', 'Enable with --include-exec.');
@@ -332,26 +333,25 @@ async function runExecutionChecks(notebook: NotebookInstance, steps: StepArtifac
     return `exit=${result.exitCode}`;
   }, false);
 
-  await recordStep(steps, 'terminal.spawn', options.stepTimeoutMs, async () => {
-    const process = await notebook.terminal.spawn('php', ['-r', 'echo "sdk-smoke";'], { output: true });
+  await recordStep(steps, 'terminals.create', options.stepTimeoutMs, async () => {
+    const process = await notebook.terminals.create({ command: 'php', args: ['-r', 'echo "sdk-smoke";'] });
     const [exitCode, output] = await Promise.all([
       withTimeout(process.wait(), options.stepTimeoutMs, 'waiting for terminal process exit'),
       readStreamToString(process.output, options.streamTimeoutMs, options.maxStreamChars),
     ]);
 
     if (exitCode !== 0 || !output.includes('sdk-smoke')) {
-      throw new Error(`terminal.spawn failed: exit=${exitCode} output=${trimDetail(output)}`);
+      throw new Error(`terminals.create failed: exit=${exitCode} output=${trimDetail(output)}`);
     }
 
     return `exit=${exitCode}`;
   }, false);
 
   await recordStep(steps, 'terminal.interactive', options.stepTimeoutMs, async () => {
-    const process = await notebook.terminal.spawn(
-      'bash',
-      ['-lc', 'IFS= read -r line; printf "sdk-input:%s\\n" "$line"'],
-      { output: true }
-    );
+    const process = await notebook.terminals.create({
+      command: 'bash',
+      args: ['-lc', 'IFS= read -r line; printf "sdk-input:%s\\n" "$line"'],
+    });
 
     try {
       const writer = process.input.getWriter();
@@ -374,15 +374,12 @@ async function runExecutionChecks(notebook: NotebookInstance, steps: StepArtifac
   }, false);
 
   await recordStep(steps, 'terminal.osc', options.stepTimeoutMs, async () => {
-    const process = await notebook.terminal.spawn(
-      'bash',
-      ['-lc', 'printf "sdk-prompt$"'],
-      {
-        output: true,
-        osc: true,
-        terminal: { cols: 80, rows: 15 },
-      }
-    );
+    const process = await notebook.terminals.create({
+      command: 'bash',
+      args: ['-lc', 'printf "sdk-prompt$"'],
+      osc: true,
+      size: [80, 15],
+    });
 
     try {
       const [exitCode, output] = await Promise.all([

package/package.json

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