@phpsandbox/sdk 0.1.13 → 0.1.14

package/examples/publication-provider-label.ts

@@ -1,11 +0,0 @@
-import type { PublicationProviderName } from '@phpsandbox/sdk';
-
-const publicationProviderLabels: Record<PublicationProviderName, string> = {
-  'cloudflare-containers': 'Cloudflare Containers',
-  'ssh-server': 'SSH Server',
-  'laravel-cloud': 'Laravel Cloud',
-};
-
-export function publicationProviderLabel(provider: PublicationProviderName): string {
-  return publicationProviderLabels[provider] ?? provider;
-}

package/examples/publish-cloudflare-container.ts

@@ -1,65 +0,0 @@
-import { PHPSandbox } from '@phpsandbox/sdk';
-import { publicationProviderLabel } from './publication-provider-label.js';
-
-const token = process.env.PHPSANDBOX_TOKEN;
-if (!token) {
-  throw new Error('Missing PHPSANDBOX_TOKEN');
-}
-
-const notebookId = process.env.PHPSANDBOX_NOTEBOOK_ID;
-if (!notebookId) {
-  throw new Error('Missing PHPSANDBOX_NOTEBOOK_ID');
-}
-
-const slug = process.env.PHPSANDBOX_PUBLISH_SLUG ?? `sdk-cloudflare-${Date.now().toString(36)}`;
-const apiUrl = process.env.PHPSANDBOX_API_URL;
-const cloudflareAccountId = process.env.CLOUDFLARE_ACCOUNT_ID;
-const cloudflareApiToken = process.env.CLOUDFLARE_API_TOKEN;
-if (!cloudflareAccountId || !cloudflareApiToken) {
-  throw new Error('Missing CLOUDFLARE_ACCOUNT_ID or CLOUDFLARE_API_TOKEN');
-}
-const client = PHPSandbox.realtime(token, apiUrl);
-const notebook = await client.notebook.get(notebookId);
-
-try {
-  const existingIntegration = (await client.integrations.list()).find(({ provider }) => provider === 'cloudflare');
-  const integration = existingIntegration
-    ? await existingIntegration.update({ authorization: { type: 'token', token: cloudflareApiToken } })
-    : await client.integrations.link({
-      provider: 'cloudflare',
-      authorization: { type: 'token', token: cloudflareApiToken },
-    });
-  await notebook.integrations.attach({ integration });
-
-  const publication = await notebook.publication();
-  if (publication && publication.data.provider.name !== 'cloudflare-containers') {
-    throw new Error(`Notebook is already published to ${publicationProviderLabel(publication.data.provider.name)}. Destroy that publication before changing providers.`);
-  }
-
-  const run = publication
-    ? await publication.publish()
-    : await notebook.publish({
-      slug,
-      provider: {
-        name: 'cloudflare-containers',
-        accountId: cloudflareAccountId,
-        size: 'small',
-        sleepAfter: '30m',
-      },
-    });
-
-  for await (const event of run.events()) {
-    if (event.type === 'phase') {
-      console.log('phase:', event.name);
-    } else if (event.type === 'log') {
-      process.stdout.write(event.content);
-    } else if (event.type === 'result') {
-      console.log('result:', event);
-    }
-  }
-
-  const current = await run.publication();
-  console.log('publication:', current.data.id, current.data.status, current.data.url);
-} finally {
-  notebook.dispose();
-}

package/examples/publish-laravel-cloud.ts

@@ -1,123 +0,0 @@
-import { PHPSandbox, type Integration, type LaravelCloudRegion } from '@phpsandbox/sdk';
-import { publicationProviderLabel } from './publication-provider-label.js';
-
-const token = process.env.PHPSANDBOX_TOKEN;
-if (!token) {
-  throw new Error('Missing PHPSANDBOX_TOKEN');
-}
-
-const notebookId = process.env.PHPSANDBOX_NOTEBOOK_ID;
-if (!notebookId) {
-  throw new Error('Missing PHPSANDBOX_NOTEBOOK_ID');
-}
-
-const slug = process.env.PHPSANDBOX_PUBLISH_SLUG ?? `sdk-laravel-cloud-${Date.now().toString(36)}`;
-const region: LaravelCloudRegion = 'eu-central-1';
-const apiUrl = process.env.PHPSANDBOX_API_URL ?? 'https://api.phpsandbox.io/v1';
-
-if (new URL(apiUrl).hostname.endsWith('.test') && process.env.NODE_TLS_REJECT_UNAUTHORIZED === undefined) {
-  process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-}
-
-const client = PHPSandbox.realtime(token, apiUrl);
-const notebook = await client.notebook.get(notebookId);
-
-try {
-  const publication = await notebook.publication();
-  if (publication && publication.data.provider.name !== 'laravel-cloud') {
-    throw new Error(`Notebook is already published to ${publicationProviderLabel(publication.data.provider.name)}. Destroy that publication before changing providers.`);
-  }
-
-  const run = publication ? await publication.publish() : await publishFirstLaravelCloudPublication();
-
-  for await (const event of run.events()) {
-    if (event.type === 'phase') {
-      console.log('phase:', event.name);
-    } else if (event.type === 'log') {
-      process.stdout.write(`${event.content}\n`);
-    } else if (event.type === 'result') {
-      console.log('result:', event);
-    }
-  }
-
-  const current = await run.publication();
-  console.log('publication:', current.data.id, current.data.status, current.data.url);
-} finally {
-  notebook.dispose();
-}
-
-async function publishFirstLaravelCloudPublication() {
-  const repository = process.env.PHPSANDBOX_LARAVEL_CLOUD_REPOSITORY;
-  if (!repository) {
-    throw new Error('Missing PHPSANDBOX_LARAVEL_CLOUD_REPOSITORY');
-  }
-
-  const githubToken = process.env.PHPSANDBOX_GITHUB_TOKEN;
-  if (!githubToken) {
-    throw new Error('Missing PHPSANDBOX_GITHUB_TOKEN');
-  }
-
-  const gitAuthorName = process.env.PHPSANDBOX_GIT_AUTHOR_NAME;
-  if (!gitAuthorName) {
-    throw new Error('Missing PHPSANDBOX_GIT_AUTHOR_NAME');
-  }
-
-  const gitAuthorEmail = process.env.PHPSANDBOX_GIT_AUTHOR_EMAIL;
-  if (!gitAuthorEmail) {
-    throw new Error('Missing PHPSANDBOX_GIT_AUTHOR_EMAIL');
-  }
-
-  const apiKey = process.env.PHPSANDBOX_LARAVEL_CLOUD_API_KEY;
-  if (!apiKey) {
-    throw new Error('Missing PHPSANDBOX_LARAVEL_CLOUD_API_KEY');
-  }
-
-  const existingIntegration = (await client.integrations.list()).find(({ provider }) => provider === 'github');
-  const github = existingIntegration
-    ? await existingIntegration.update({ authorization: { type: 'token', token: githubToken } })
-    : await client.integrations.link({
-      provider: 'github',
-      authorization: { type: 'token', token: githubToken },
-    });
-  await selectSandboxIntegration(github);
-  const target = await notebook.git.targets.create({
-    provider: 'github',
-    repository,
-    author: { name: gitAuthorName, email: gitAuthorEmail },
-    branch: 'main',
-    setDefault: true,
-  });
-  const source = await target.sync();
-
-  console.log('source:', source.data.repository, source.data.branch, source.data.lastCommitSha);
-
-  const existingLaravelCloudIntegration = (await client.integrations.list())
-    .find(({ provider }) => provider === 'laravel-cloud');
-  const laravelCloud = existingLaravelCloudIntegration
-    ? await existingLaravelCloudIntegration.update({ authorization: { type: 'token', token: apiKey } })
-    : await client.integrations.link({
-      provider: 'laravel-cloud',
-      authorization: { type: 'token', token: apiKey },
-    });
-  await selectSandboxIntegration(laravelCloud);
-
-  return notebook.publish({
-    slug,
-    provider: {
-      name: 'laravel-cloud',
-      region,
-    },
-  });
-}
-
-async function selectSandboxIntegration(integration: Integration): Promise<void> {
-  const binding = (await notebook.integrations.list())
-    .find((candidate) => candidate.integration.provider === integration.provider);
-
-  if (binding) {
-    await binding.update({ integration });
-    return;
-  }
-
-  await notebook.integrations.attach({ integration });
-}

package/examples/publish-ssh-agent.ts

@@ -1,211 +0,0 @@
-import { spawn, type ChildProcessWithoutNullStreams } from 'node:child_process';
-import { existsSync, mkdtempSync, writeFileSync } from 'node:fs';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { PHPSandbox, type ServerInstance } from '@phpsandbox/sdk';
-import { publicationProviderLabel } from './publication-provider-label.js';
-
-const token = process.env.PHPSANDBOX_TOKEN;
-if (!token) {
-  throw new Error('Missing PHPSANDBOX_TOKEN');
-}
-
-const notebookId = process.env.PHPSANDBOX_NOTEBOOK_ID;
-if (!notebookId) {
-  throw new Error('Missing PHPSANDBOX_NOTEBOOK_ID');
-}
-
-const slug = process.env.PHPSANDBOX_PUBLISH_SLUG ?? `sdk-ssh-${Date.now().toString(36)}`;
-const apiUrl = process.env.PHPSANDBOX_API_URL ?? 'https://api.phpsandbox.io/v1';
-const isLocal = new URL(apiUrl).hostname.endsWith('.test');
-
-if (isLocal && process.env.NODE_TLS_REJECT_UNAUTHORIZED === undefined) {
-  process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-}
-
-const client = PHPSandbox.realtime(token, apiUrl);
-const notebook = await client.notebook.get(notebookId);
-let agent: ChildProcessWithoutNullStreams | null = null;
-
-try {
-  const publication = await notebook.publication();
-  if (publication && publication.data.provider.name !== 'ssh-server') {
-    throw new Error(`Notebook is already published to ${publicationProviderLabel(publication.data.provider.name)}. Destroy that publication before changing providers.`);
-  }
-
-  const run = publication
-    ? await publication.publish()
-    : await notebook.publish({
-      slug,
-      provider: { name: 'ssh-server', serverId: (await resolveServer()).data.id },
-    });
-
-  for await (const event of run.events()) {
-    if (event.type === 'phase') {
-      console.log('phase:', event.name);
-    } else if (event.type === 'log') {
-      process.stdout.write(event.content);
-    } else if (event.type === 'result') {
-      console.log('result:', event);
-    }
-  }
-
-  const current = await run.publication();
-  console.log('publication:', current.data.id, current.data.status, current.data.url);
-
-  if (current.data.url) {
-    const response = await fetch(current.data.url);
-    console.log('http:', response.status, response.statusText, await response.text());
-    if (!response.ok) {
-      throw new Error(`Publication URL returned ${response.status} ${response.statusText}`);
-    }
-  }
-} finally {
-  notebook.dispose();
-  if (agent) {
-    stopLocalAgent(agent);
-  }
-}
-
-async function resolveServer(): Promise<ServerInstance> {
-  const serverId = process.env.PHPSANDBOX_PUBLISH_SERVER_ID;
-  if (serverId) {
-    const server = await client.servers.get(serverId);
-    console.log('server:', server.data.id, server.data.status);
-    return server;
-  }
-
-  const server = await client.servers.create({
-    name: `SDK SSH ${slug}`,
-    host: process.env.PHPSANDBOX_PUBLISH_SERVER_HOST ?? 'localhost',
-    ssh: {
-      user: process.env.USER ?? 'local',
-      port: Number(process.env.PHPSANDBOX_PUBLISH_SERVER_PORT ?? 22),
-    },
-  });
-
-  console.log('server:', server.data.id, server.data.status);
-
-  if (!isLocal) {
-    throw new Error('Created server registration. Install the agent on the target server, then rerun with PHPSANDBOX_PUBLISH_SERVER_ID.');
-  }
-
-  if (!server.data.token) {
-    throw new Error('Created server registration without an agent token.');
-  }
-
-  agent = await startLocalAgent(server.data.id, server.data.token);
-  const connected = await server.waitReady({ timeout: 120_000, interval: 1_000 });
-  console.log('server:', connected.data.id, connected.data.status);
-
-  return connected;
-}
-
-async function startLocalAgent(serverId: string, serverToken: string): Promise<ChildProcessWithoutNullStreams> {
-  const dir = mkdtempSync(join(tmpdir(), 'phpsandbox-sdk-ssh-agent-'));
-  const configPath = join(dir, 'agent.yaml');
-  const stateDir = join(dir, 'state');
-  const controlPlane = process.env.PHPSANDBOX_AGENT_CONTROL_PLANE ?? 'wss://okra-edge.ciroue.test/_okra/agent/connect';
-
-  writeFileSync(configPath, [
-    `server_id: "${serverId}"`,
-    `token: "${serverToken}"`,
-    `control_plane: "${controlPlane}"`,
-    `state_dir: "${stateDir}"`,
-    '',
-  ].join('\n'));
-
-  const rookDir = process.env.PHPSANDBOX_ROOK_DIR
-    ?? fileURLToPath(new URL('../../rook/', import.meta.url));
-  if (!existsSync(join(rookDir, 'cmd/rook/main.go'))) {
-    throw new Error('Cannot find local Rook repo. Set PHPSANDBOX_ROOK_DIR to the rook directory.');
-  }
-
-  const child = spawn('go', ['run', './cmd/rook', '--config', configPath], {
-    cwd: rookDir,
-    detached: true,
-    env: {
-      ...process.env,
-      SSL_CERT_FILE: localCaCertPath(),
-    },
-  });
-
-  process.once('exit', () => stopLocalAgent(child));
-
-  await waitForAgent(child);
-  console.log('agent:', 'connected');
-
-  return child;
-}
-
-function stopLocalAgent(child: ChildProcessWithoutNullStreams): void {
-  if (child.exitCode !== null || child.signalCode !== null) {
-    return;
-  }
-
-  if (child.pid && child.pid > 0) {
-    try {
-      process.kill(-child.pid, 'SIGTERM');
-      return;
-    } catch {
-      // Fall back to killing the direct child when process group signaling is unavailable.
-    }
-  }
-
-  child.kill('SIGTERM');
-}
-
-function waitForAgent(child: ChildProcessWithoutNullStreams): Promise<void> {
-  return new Promise((resolve, reject) => {
-    let settled = false;
-    let output = '';
-    const timeout = setTimeout(() => {
-      finish(new Error(`Timed out waiting for Rook to connect. ${output.trim()}`));
-    }, 120_000);
-
-    const finish = (error?: Error) => {
-      if (settled) {
-        return;
-      }
-      settled = true;
-      clearTimeout(timeout);
-      child.stdout.off('data', onStdout);
-      child.stderr.off('data', onStderr);
-      child.off('exit', onExit);
-      if (error) {
-        reject(error);
-      } else {
-        resolve();
-      }
-    };
-
-    const append = (chunk: Buffer) => {
-      output = `${output}${chunk.toString()}`.slice(-4000);
-    };
-
-    const onStdout = (chunk: Buffer) => {
-      append(chunk);
-      if (chunk.toString().includes('connected, waiting for commands')) {
-        finish();
-      }
-    };
-
-    const onStderr = (chunk: Buffer) => append(chunk);
-    const onExit = (code: number | null) => {
-      finish(new Error(`Rook exited before connecting with code ${code}. ${output.trim()}`));
-    };
-
-    child.stdout.on('data', onStdout);
-    child.stderr.on('data', onStderr);
-    child.once('exit', onExit);
-  });
-}
-
-function localCaCertPath(): string {
-  const configured = process.env.PHPSANDBOX_LOCAL_CA_CERT
-    ?? process.env.NODE_EXTRA_CA_CERTS
-    ?? `${process.env.HOME}/.config/valet/CA/LaravelValetCASelfSigned.pem`;
-
-  return configured.replace(/^"(.*)"$/, '$1');
-}