@phpsandbox/sdk 0.3.3 → 0.3.5

package/dist/schemas/publications.js

@@ -1,9 +1,5 @@
 import { z } from 'zod';
-export const PublicationProviderNameSchema = z.enum([
-    'cloudflare-containers',
-    'ssh-server',
-    'laravel-cloud',
-]);
+export const PublicationProviderNameSchema = z.enum(['cloudflare-containers', 'ssh-server', 'laravel-cloud']);
 export const PublicationStatusSchema = z.enum([
     'pending',
     'queued',
@@ -16,71 +12,55 @@ export const PublicationStatusSchema = z.enum([
     'deleted',
     'delete_failed',
 ]);
-export const PublicationBuildStatusSchema = z.enum([
-    'pending',
-    'queued',
-    'running',
-    'succeeded',
-    'failed',
-    'cancelled',
-]);
+export const PublicationBuildStatusSchema = z.enum(['pending', 'queued', 'running', 'succeeded', 'failed', 'cancelled']);
 export const PublicationReleaseStatusSchema = z.enum(['created', 'ready', 'deleted']);
-export const PublicationSizeSchema = z.enum([
-    'nano',
-    'small',
-    'medium',
-    'large',
-    'lite',
-    'basic',
-    'standard-1',
-    'standard-2',
-]);
-export const PublicationRegionSchema = z.enum([
-    'ENAM',
-    'WNAM',
-    'EEUR',
-    'WEUR',
-    'APAC',
-    'SAM',
-    'ME',
-    'OC',
-    'AFR',
-]);
+export const PublicationSizeSchema = z.enum(['nano', 'small', 'medium', 'large', 'lite', 'basic', 'standard-1', 'standard-2']);
+export const PublicationRegionSchema = z.enum(['ENAM', 'WNAM', 'EEUR', 'WEUR', 'APAC', 'SAM', 'ME', 'OC', 'AFR']);
 export const PublicationJurisdictionSchema = z.enum(['eu', 'fedramp']);
 export const PublicationProtectionModeSchema = z.enum(['none', 'password']);
 export const PublicationLogStreamSchema = z.enum(['build', 'runtime']);
 export const PublishStreamLogStreamSchema = z.enum(['build', 'publish', 'runtime']);
-const PublicationEventPayloadSchema = z.preprocess((payload) => Array.isArray(payload) && payload.length === 0 ? {} : payload, z.record(z.string(), z.unknown()));
-export const PublicationEventDataSchema = z.object({
+const PublicationEventPayloadSchema = z.preprocess((payload) => (Array.isArray(payload) && payload.length === 0 ? {} : payload), z.record(z.string(), z.unknown()));
+export const PublicationEventDataSchema = z
+    .object({
     id: z.union([z.number(), z.string()]).optional(),
     sequence: z.number(),
     type: z.string(),
     payload: PublicationEventPayloadSchema,
     createdAt: z.string().nullable(),
-}).passthrough();
-export const PublicationLogChunkDataSchema = z.object({
+})
+    .passthrough();
+export const PublicationLogChunkDataSchema = z
+    .object({
     sequence: z.number(),
     stream: PublicationLogStreamSchema,
     content: z.string(),
     createdAt: z.string().nullable(),
-}).passthrough();
-export const PublishStreamPhaseSchema = z.object({
+})
+    .passthrough();
+export const PublishStreamPhaseSchema = z
+    .object({
     name: z.string(),
     status: z.enum(['running', 'completed', 'failed']).optional(),
     data: z.record(z.string(), z.unknown()).optional(),
-}).strict();
-export const PublishStreamLogSchema = z.object({
+})
+    .strict();
+export const PublishStreamLogSchema = z
+    .object({
     stream: PublishStreamLogStreamSchema,
     content: z.string(),
-}).strict();
-export const PublishStreamResultSchema = z.object({
+})
+    .strict();
+export const PublishStreamResultSchema = z
+    .object({
     success: z.boolean(),
     publicationId: z.string(),
     url: z.string().url(),
     buildId: z.string(),
     releaseId: z.string(),
     status: PublicationStatusSchema,
-}).strict();
+})
+    .strict();
 export const PublishStreamPhaseEventSchema = PublishStreamPhaseSchema.extend({
     type: z.literal('phase'),
 }).strict();
@@ -95,37 +75,51 @@ export const PublishStreamEventSchema = z.discriminatedUnion('type', [
     PublishStreamLogEventSchema,
     PublishStreamResultEventSchema,
 ]);
-export const PublishStreamErrorSchema = z.object({
+export const PublishStreamErrorSchema = z
+    .object({
     message: z.string().optional(),
-}).passthrough();
+})
+    .passthrough();
 export const PublishStreamSseEventNameSchema = z.enum(['phase', 'log', 'done', 'result', 'error']);
-export const PublishStreamSsePhaseEventSchema = z.object({
+export const PublishStreamSsePhaseEventSchema = z
+    .object({
     event: z.literal('phase'),
     data: PublishStreamPhaseSchema,
-}).strict();
-export const PublishStreamSseLogEventSchema = z.object({
+})
+    .strict();
+export const PublishStreamSseLogEventSchema = z
+    .object({
     event: z.literal('log'),
     data: PublishStreamLogSchema,
-}).strict();
-export const PublishStreamSseDoneEventSchema = z.object({
+})
+    .strict();
+export const PublishStreamSseDoneEventSchema = z
+    .object({
     event: z.literal('done'),
     data: PublishStreamResultSchema,
-}).strict();
-export const PublishStreamSseResultEventSchema = z.object({
+})
+    .strict();
+export const PublishStreamSseResultEventSchema = z
+    .object({
     event: z.literal('result'),
     data: PublishStreamResultSchema,
-}).strict();
-export const PublishStreamSseErrorEventSchema = z.object({
+})
+    .strict();
+export const PublishStreamSseErrorEventSchema = z
+    .object({
     event: z.literal('error'),
     data: PublishStreamErrorSchema,
-}).strict();
-export const PublishStreamSseEventSchema = z.discriminatedUnion('event', [
+})
+    .strict();
+export const PublishStreamSseEventSchema = z
+    .discriminatedUnion('event', [
     PublishStreamSsePhaseEventSchema,
     PublishStreamSseLogEventSchema,
     PublishStreamSseDoneEventSchema,
     PublishStreamSseResultEventSchema,
     PublishStreamSseErrorEventSchema,
-]).transform((event) => {
+])
+    .transform((event) => {
     if (event.event === 'error') {
         throw new Error(event.data.message ?? 'Publish failed');
     }

package/dist/servers.d.ts

@@ -14,11 +14,22 @@ export interface ServerData {
     updatedAt: string | null;
 }
 export interface ServerMemberData {
+    organizationId?: string | null;
     id: number;
     name: string;
     email: string;
     access: 'deployer';
 }
+export interface ServerInvitationData {
+    recipientOrganizationId: string | null;
+    id: string;
+    serverId: string;
+    serverName: string;
+    email: string;
+    status: 'pending' | 'accepting' | 'accepted' | 'declined' | 'cancelled' | 'expired';
+    expiresAt: string;
+    createdAt: string;
+}
 export interface ServerSshOptions {
     user?: string;
     port?: number;
@@ -31,9 +42,23 @@ export interface CreateServerInput {
 export interface ServerListOptions {
     page?: number;
 }
+export interface ServerInvitationTarget {
+    email: string;
+    organizationId?: never;
+    requestId?: string;
+}
+export interface ServerOrganizationTarget {
+    organizationId: string;
+    email?: never;
+    requestId?: string;
+}
+export type ShareServerInput = ServerInvitationTarget | ServerOrganizationTarget;
 export declare class ServerApi {
     private readonly client;
     constructor(client: Client);
+    inspectInvitation(id: string, token: string): Promise<ServerInvitationData>;
+    acceptInvitation(id: string, token: string): Promise<ServerInvitationData>;
+    declineInvitation(id: string, token: string): Promise<ServerInvitationData>;
     list(options?: ServerListOptions): Promise<PaginatedApiResponse<ServerData>>;
     create(input: CreateServerInput): Promise<ServerInstance>;
     get(id: string): Promise<ServerInstance>;
@@ -46,8 +71,13 @@ export declare class ServerInstance {
         installCommand: string;
     }>;
     members(options?: ServerListOptions): Promise<PaginatedApiResponse<ServerMemberData>>;
-    share(email: string): Promise<ServerMemberData>;
+    share(target: ServerInvitationTarget): Promise<ServerInvitationData>;
+    share(target: ServerOrganizationTarget): Promise<ServerMemberData>;
+    share(target: ShareServerInput): Promise<ServerInvitationData | ServerMemberData>;
     revokeAccess(memberId: number): Promise<void>;
+    invitations(options?: ServerListOptions): Promise<PaginatedApiResponse<ServerInvitationData>>;
+    cancelInvitation(id: string): Promise<ServerInvitationData>;
+    resendInvitation(id: string): Promise<ServerInvitationData>;
     refresh(): Promise<ServerInstance>;
     delete(): Promise<void>;
     waitReady(options?: {

package/dist/servers.js

@@ -1,7 +1,17 @@
+import { PHPSandboxError } from './errors/index.js';
 export class ServerApi {
     constructor(client) {
         this.client = client;
     }
+    async inspectInvitation(id, token) {
+        return (await this.client.post(`/platform/server-invitations/${encodeURIComponent(id)}/inspect`, { token })).data;
+    }
+    async acceptInvitation(id, token) {
+        return (await this.client.post(`/platform/server-invitations/${encodeURIComponent(id)}/accept`, { token })).data;
+    }
+    async declineInvitation(id, token) {
+        return (await this.client.post(`/platform/server-invitations/${encodeURIComponent(id)}/decline`, { token })).data;
+    }
     async list(options = {}) {
         const query = options.page === undefined ? '' : `?${new URLSearchParams({ page: String(options.page) }).toString()}`;
         return this.client.get(`/servers${query}`);
@@ -27,12 +37,33 @@ export class ServerInstance {
         const query = options.page === undefined ? '' : `?${new URLSearchParams({ page: String(options.page) }).toString()}`;
         return this.client.get(`/servers/${encodeURIComponent(this.data.id)}/members${query}`);
     }
-    async share(email) {
-        return (await this.client.post(`/servers/${encodeURIComponent(this.data.id)}/members`, { email })).data;
+    async share(target) {
+        if (target.email !== undefined) {
+            return (await this.client.post(`/platform/servers/${encodeURIComponent(this.data.id)}/invitations`, {
+                email: target.email,
+                requestId: target.requestId ?? crypto.randomUUID(),
+            })).data;
+        }
+        const body = { organizationId: target.organizationId, requestId: target.requestId };
+        return (await this.client.post(`/servers/${encodeURIComponent(this.data.id)}/members`, body)).data;
     }
     async revokeAccess(memberId) {
         await this.client.delete(`/servers/${encodeURIComponent(this.data.id)}/members/${encodeURIComponent(String(memberId))}`);
     }
+    async invitations(options = {}) {
+        const query = options.page === undefined ? '' : `?${new URLSearchParams({ page: String(options.page) }).toString()}`;
+        return this.client.get(`/platform/servers/${encodeURIComponent(this.data.id)}/invitations${query}`);
+    }
+    async cancelInvitation(id) {
+        const response = await this.client.delete(`/platform/servers/${encodeURIComponent(this.data.id)}/invitations/${encodeURIComponent(id)}`);
+        if (response.data === undefined) {
+            throw new PHPSandboxError('Missing invitation cancellation response.');
+        }
+        return response.data;
+    }
+    async resendInvitation(id) {
+        return (await this.client.post(`/platform/servers/${encodeURIComponent(this.data.id)}/invitations/${encodeURIComponent(id)}/resend`, {})).data;
+    }
     refresh() {
         return this.client.servers.get(this.data.id);
     }
@@ -51,7 +82,7 @@ export class ServerInstance {
             if (server.data.status === 'failed') {
                 throw new Error(`Server provisioning failed: ${server.data.id}`);
             }
-            await new Promise(resolve => setTimeout(resolve, interval));
+            await new Promise((resolve) => setTimeout(resolve, interval));
         }
         throw new Error(`Server did not become ready within ${timeout}ms`);
     }

package/dist/shell.js

@@ -89,10 +89,13 @@ export class ShellProcess {
             stderr.fail(error);
         };
         const { abortSignal, ...payloadOpts } = opts;
-        this.completion = this.okra.invoke('shell.exec', { command, opts: { ...payloadOpts, id: this.id } }, { abortSignal }).then((result) => {
+        this.completion = this.okra
+            .invoke('shell.exec', { command, opts: { ...payloadOpts, id: this.id } }, { abortSignal })
+            .then((result) => {
             finish();
             return result;
-        }).catch((error) => {
+        })
+            .catch((error) => {
             fail(error);
             throw error;
         });

package/dist/socket/index.js

@@ -6,7 +6,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _Transport_instances, _Transport_connect, _Transport_startPeriodicPing;
 import { nanoid } from 'nanoid';
 import { encode, decode } from '@msgpack/msgpack';
-import { PromiseTimeoutError, RemoteError, SendTimeoutError, TransportError, remoteError, } from '../errors/index.js';
+import { PromiseTimeoutError, RemoteError, SendTimeoutError, TransportError, remoteError } from '../errors/index.js';
 import { retry } from '../utils/retry.js';
 import * as ReconnectingWebSocketModule from 'reconnecting-websocket';
 import { timeout } from '../utils/promise.js';
@@ -14,11 +14,21 @@ import { describeWebSocketEvent } from '../utils/websocket.js';
 import WebSocket from 'isomorphic-ws';
 import { NamedDisposable } from '../utils/disposable.js';
 const SAFE_DEBUG_METADATA_KEYS = new Set([
-    'url', 'action', 'event', 'responseEvent', 'errorEvent', 'hasData',
-    'code', 'attempt', 'maxRetries', 'timeout', 'errorCount', 'byteLength',
+    'url',
+    'action',
+    'event',
+    'responseEvent',
+    'errorEvent',
+    'hasData',
+    'code',
+    'attempt',
+    'maxRetries',
+    'timeout',
+    'errorCount',
+    'byteLength',
 ]);
-const ReconnectingWebSocket = (ReconnectingWebSocketModule.default
-    ?? ReconnectingWebSocketModule);
+const ReconnectingWebSocket = (ReconnectingWebSocketModule
+    .default ?? ReconnectingWebSocketModule);
 export var SocketEvent;
 (function (SocketEvent) {
     SocketEvent["BootError"] = "Events.BootError";
@@ -66,9 +76,7 @@ export class Transport {
         // Validate configuration
         this.validateConfiguration(options);
         this.url = typeof url === 'string' ? new URL(url) : null;
-        const urlProvider = typeof url === 'string'
-            ? new URL(url).toString()
-            : async () => new URL(await url()).toString();
+        const urlProvider = typeof url === 'string' ? new URL(url).toString() : async () => new URL(await url()).toString();
         // Use configurable ping interval
         this.PING_INTERVAL = options.pingInterval ?? 30000;
         this.CONNECT_WAIT_TIMEOUT = options.connectWaitTimeout ?? 30000;
@@ -127,7 +135,7 @@ export class Transport {
     id() {
         return this.clientId;
     }
-    async registerWatchers() {
+    registerWatchers() {
         const onMessage = (ev) => {
             this.incomingMessageChain = this.incomingMessageChain
                 .catch(() => undefined)
@@ -306,7 +314,9 @@ export class Transport {
             this.eventEmitter.emit(event, this.clientId);
             return;
         }
-        event && this.eventEmitter.emit(as || event, data);
+        if (event) {
+            this.eventEmitter.emit(as || event, data);
+        }
     }
     listen(event, listener, _context) {
         return this.eventEmitter.listen(event, listener);
@@ -437,14 +447,16 @@ export class Transport {
             if (!options.timeout) {
                 return promise;
             }
-            return timeout(promise, options.timeout).catch((error) => {
+            return timeout(promise, options.timeout)
+                .catch((error) => {
                 if (error instanceof PromiseTimeoutError) {
                     throw SendTimeoutError.fromPromiseTimeoutError(error);
                 }
                 throw error;
-            }).finally(removeListeners);
+            })
+                .finally(removeListeners);
         };
-        const retries = options.retries === false ? 0 : options.retries ?? 0;
+        const retries = options.retries === false ? 0 : (options.retries ?? 0);
         return this.sendWithRetry(async () => await send(), retries);
     }
     send(action, data = {}) {

package/dist/telemetry.js

@@ -40,7 +40,9 @@ export class RuntimeTelemetry {
         }
     }
     synchronize() {
-        this.synchronization = this.synchronization.catch(() => { }).then(async () => {
+        this.synchronization = this.synchronization
+            .catch(() => { })
+            .then(async () => {
             const features = Array.from(this.references.keys());
             if (features.length === 0) {
                 await this.okra.invoke('container.stop-telemetry');
@@ -88,13 +90,16 @@ export function watchRuntimeTelemetry(okra, telemetry, feature, event, transform
                 }
                 options.signal.addEventListener('abort', abort, { once: true });
             }
-            void telemetry.acquire(feature).then(async (releaseTelemetry) => {
+            void telemetry
+                .acquire(feature)
+                .then(async (releaseTelemetry) => {
                 if (closed) {
                     await releaseTelemetry();
                     return;
                 }
                 release = releaseTelemetry;
-            }).catch((error) => {
+            })
+                .catch((error) => {
                 if (!closed) {
                     closed = true;
                     subscription?.dispose();

package/dist/terminal.js

@@ -1,6 +1,7 @@
 import { nanoid } from 'nanoid';
 import { once } from './utils/promise.js';
 const TERMINAL_INPUT_FLUSH_DELAY_MS = 8;
+// eslint-disable-next-line no-control-regex -- Terminal control bytes intentionally trigger an immediate flush.
 const terminalInputFlushPattern = /[\x00-\x1f\x7f]/;
 export default class Terminals {
     constructor(okra) {
@@ -12,9 +13,7 @@ export default class Terminals {
     async create(options = {}) {
         const id = options.id ?? nanoid();
         const handle = this.processHandle(id, options.abortSignal);
-        const command = typeof options.command === 'string' && options.args?.length
-            ? [options.command, ...options.args]
-            : options.command;
+        const command = typeof options.command === 'string' && options.args?.length ? [options.command, ...options.args] : options.command;
         const { abortSignal, args: _args, ...input } = options;
         try {
             const task = await this.okra.invoke('terminal.create', {
@@ -135,7 +134,7 @@ export default class Terminals {
             return this.okra.invoke('terminal.close', { id });
         });
         const resize = (dimensions) => {
-            this.okra.invoke('terminal.resize', { id, width: dimensions.cols, height: dimensions.rows });
+            return this.okra.invoke('terminal.resize', { id, width: dimensions.cols, height: dimensions.rows });
         };
         if (abortSignal && !abortSignal.aborted) {
             abortHandler = () => {

package/dist/utils/promise.js

@@ -5,7 +5,7 @@
  * @param time
  * @param exception
  */
-import { PromiseTimeoutError } from "../errors/index.js";
+import { PromiseTimeoutError } from '../errors/index.js';
 export const timeout = (prom, time) => {
     let timer;
     return Promise.race([

package/dist/utils/websocket.js

@@ -2,12 +2,12 @@ const getReadyStateLabel = (state) => {
     if (typeof state !== 'number') {
         return undefined;
     }
-    return {
+    return ({
         0: 'CONNECTING',
         1: 'OPEN',
         2: 'CLOSING',
         3: 'CLOSED',
-    }[state] ?? `STATE_${state}`;
+    }[state] ?? `STATE_${state}`);
 };
 const sanitizeWebSocketUrl = (value) => {
     try {

package/package.json

@@ -1,11 +1,38 @@
 {
   "name": "@phpsandbox/sdk",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "The TypeScript SDK for PHPSandbox cloud development environments",
+  "keywords": [
+    "cloud",
+    "composer",
+    "development",
+    "laravel",
+    "php",
+    "sandbox",
+    "sdk",
+    "typescript"
+  ],
+  "homepage": "https://github.com/phpsandbox/sdk#readme",
+  "bugs": {
+    "url": "https://github.com/phpsandbox/sdk/issues"
+  },
+  "license": "MIT",
+  "author": "PHPSandbox",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/phpsandbox/sdk.git"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "type": "module",
+  "unpkg": "./dist/browser/phpsandbox-sdk.iife.min.js",
+  "jsdelivr": "./dist/browser/phpsandbox-sdk.esm.min.js",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -23,13 +50,6 @@
       "default": "./dist/beacon/index.js"
     }
   },
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
-  ],
-  "unpkg": "./dist/browser/phpsandbox-sdk.iife.min.js",
-  "jsdelivr": "./dist/browser/phpsandbox-sdk.esm.min.js",
   "scripts": {
     "build": "npm run build:tsc && npm run build:browser",
     "build:tsc": "tsc",
@@ -46,30 +66,15 @@
     "smoke:reaper": "npm run build:tsc && vitest run --reporter=verbose --config tests/smoke/vitest.config.ts tests/smoke/maintenance/resources.reaper.smoke.ts",
     "smoke:typecheck": "npm run build:tsc && tsc --project tests/smoke/tsconfig.json --noEmit",
     "prepublishOnly": "npm test && npm run clean && npm run build",
-    "bumpAndPublish": "npm version patch && npm publish --access public"
-  },
-  "keywords": [
-    "php",
-    "sandbox",
-    "development",
-    "cloud",
-    "typescript",
-    "sdk",
-    "laravel",
-    "composer"
-  ],
-  "author": "PHPSandbox",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/phpsandbox/sdk.git"
-  },
-  "bugs": {
-    "url": "https://github.com/phpsandbox/sdk/issues"
-  },
-  "homepage": "https://github.com/phpsandbox/sdk#readme",
-  "engines": {
-    "node": ">=18.0.0"
+    "bumpAndPublish": "npm version patch && npm publish --access public",
+    "lint": "oxlint --type-aware .",
+    "lint:fix": "oxlint --type-aware --fix .",
+    "format": "oxfmt --write src tests package.json tsconfig.json vitest.config.ts build.mjs .oxfmtrc.json .oxlintrc.json",
+    "format:check": "oxfmt --check src tests package.json tsconfig.json vitest.config.ts build.mjs .oxfmtrc.json .oxlintrc.json",
+    "typecheck": "tsc --noEmit",
+    "check": "npm run lint && npm run format:check && npm run typecheck && npm run smoke:typecheck && npm test && npm run build && npm pack --dry-run",
+    "prelint": "npm run build:tsc",
+    "prelint:fix": "npm run build:tsc"
   },
   "dependencies": {
     "@msgpack/msgpack": "^3.1.1",
@@ -85,8 +90,14 @@
     "@types/ws": "^8.18.1",
     "axios": "^1.17.0",
     "esbuild": "^0.27.1",
+    "oxfmt": "0.71.0",
+    "oxlint": "1.86.0",
+    "oxlint-tsgolint": "7.0.2003",
     "playwright": "^1.62.1",
     "typescript": "^5.7.2",
     "vitest": "^4.1.11"
+  },
+  "engines": {
+    "node": ">=18.0.0"
   }
 }

package/dist/auth.d.ts

@@ -1,11 +0,0 @@
-import { Action, NotebookInstance } from './index.js';
-export interface AuthActions {
-    'auth.login': Action<{
-        runtimeTicket: string;
-    }, boolean>;
-}
-export default class Auth {
-    protected okra: NotebookInstance;
-    constructor(okra: NotebookInstance);
-    login(runtimeUrl: string): Promise<boolean>;
-}

package/dist/auth.js

@@ -1,12 +0,0 @@
-export default class Auth {
-    constructor(okra) {
-        this.okra = okra;
-    }
-    login(runtimeUrl) {
-        const runtimeTicket = new URL(runtimeUrl).searchParams.get('ticket');
-        if (runtimeTicket === null || runtimeTicket === '') {
-            throw new TypeError('The notebook connection does not contain a runtime ticket.');
-        }
-        return this.okra.invoke('auth.login', { runtimeTicket });
-    }
-}