@phpsandbox/sdk 0.3.4 → 0.3.5

package/dist/errors/index.d.ts

@@ -1,4 +1,4 @@
-export type RemoteErrorSource = 'core' | 'runtime';
+export type RemoteErrorSource = 'core' | 'platform' | 'runtime';
 declare const remoteErrorCodes: readonly ["ActionNotFound", "AuthenticationRequired", "BadGateway", "BadRequest", "Conflict", "FileAlreadyExists", "FileIsDirectory", "FileNotDirectory", "FileNotFound", "FilesystemUnavailable", "InternalError", "InvalidArgument", "InvalidConfiguration", "InvalidRequest", "InvalidResponse", "InvalidServiceCommand", "MethodNotAllowed", "NotebookInitializationFailed", "NotebookUnavailable", "NotFound", "PayloadTooLarge", "PermissionDenied", "RateLimited", "RequestFailed", "RuntimeOperationFailed", "ServiceNotFound", "ServiceUnavailable", "UnprocessableEntity", "ValidationFailed", "WorkspaceUnavailable"];
 export type RemoteErrorCode = (typeof remoteErrorCodes)[number];
 export type TransportErrorCode = 'ConnectionFailed' | 'ConnectionTimeout' | 'InvalidResponse' | 'SendTimeout';

package/dist/index.d.ts

@@ -35,7 +35,7 @@ export type { ConfigPortMapping, ProjectConfig } from './config.js';
 export { PHPSandboxError, RemoteError, TransportError } from './errors/index.js';
 export type { HttpResponseDiagnostics, RemoteErrorCode, RemoteErrorSource, TransportErrorCode, ValidationErrorDetails, } from './errors/index.js';
 export * from './publication/index.js';
-export type { CreateServerInput, ServerData, ServerInstance, ServerListOptions, ServerMemberData, ServerSshOptions, } from './servers.js';
+export type { CreateServerInput, ServerData, ServerInstance, ServerListOptions, ServerMemberData, ServerInvitationData, ServerInvitationTarget, ServerOrganizationTarget, ShareServerInput, ServerSshOptions, } from './servers.js';
 export type { ConfigureFeedbackInput, FeedbackData, FeedbackListOptions, FeedbackSource, FeedbackStatus, FeedbackType, FeedbackWidgetConfig, FeedbackWidgetTarget, SubmitFeedbackInput, UpdateFeedbackInput, } from './feedback.js';
 export type { Integration, IntegrationAuthorization, IntegrationAuthorizationType, IntegrationData, IntegrationProvider, IntegrationReference, LinkIntegrationInput, UpdateIntegrationInput, AttachSandboxIntegrationInput, SandboxIntegration, SandboxIntegrationData, SandboxIntegrationEffect, SandboxIntegrationReference, UpdateSandboxIntegrationInput, } from './integrations/index.js';
 interface Result<TType extends 'success' | 'error' | 'running', TData extends object> {

package/dist/index.js

@@ -157,7 +157,7 @@ class ClientImplementation {
             headers: this.headers,
         }));
         if (!response.ok) {
-            throw await responseError(response);
+            throw await responseError(response, path.startsWith('/platform/') ? 'platform' : 'core');
         }
         if (response.status === 204) {
             return { data: undefined };
@@ -195,10 +195,10 @@ class ClientImplementation {
         }
     }
 }
-async function responseError(response) {
+async function responseError(response, source = 'core') {
     const body = await response.text();
     try {
-        return remoteError('core', errorPayload(body === '' ? undefined : JSON.parse(body)), response);
+        return remoteError(source, errorPayload(body === '' ? undefined : JSON.parse(body)), response);
     }
     catch {
         return new TransportError(`PHPSandbox API returned an invalid error response (HTTP ${response.status}).`, 'InvalidResponse', response, {

package/dist/servers.d.ts

@@ -20,6 +20,16 @@ export interface ServerMemberData {
     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;
@@ -32,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>;
@@ -47,9 +71,13 @@ export declare class ServerInstance {
         installCommand: string;
     }>;
     members(options?: ServerListOptions): Promise<PaginatedApiResponse<ServerMemberData>>;
-    share(email: string): Promise<ServerMemberData>;
-    shareWithOrganization(organizationId: 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,16 +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 shareWithOrganization(organizationId) {
-        return (await this.client.post(`/servers/${encodeURIComponent(this.data.id)}/members`, { organizationId }))
-            .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);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phpsandbox/sdk",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "The TypeScript SDK for PHPSandbox cloud development environments",
   "keywords": [
     "cloud",