@phpsandbox/sdk 0.0.51 → 0.0.53

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) PHPSandbox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -8,7 +8,7 @@ TypeScript SDK for working with PHPSandbox notebooks: create environments, edit
 npm install @phpsandbox/sdk
 ```
 
-Node.js `>=18` is required.
+Node.js `>=18` is required. This package is ESM-only; use `import` rather than `require()`.
 
 ## Quick Start
 
@@ -220,16 +220,15 @@ await notebook.git.revert({ path: 'README.md' });
 await notebook.git.revert({ path: 'staged-file.php', staged: true });
 
 const fork = await notebook.fork();
-const forkCredentials = await fork.git.credentials();
 const preview = await notebook.git.diff({
-  url: forkCredentials.url,
-  token: forkCredentials.token,
+  notebookId: fork.data.id,
+  token: process.env.PHPSANDBOX_TOKEN,
 });
 
 if (preview.status === 'ready') {
   const result = await notebook.git.merge({
-    url: forkCredentials.url,
-    token: forkCredentials.token,
+    notebookId: fork.data.id,
+    token: process.env.PHPSANDBOX_TOKEN,
     expectedBaseRef: preview.baseRef,
     author: 'PHPSandbox <hi@phpsandbox.io>',
     message: 'Merge fork into base',
@@ -241,6 +240,8 @@ if (preview.status === 'ready') {
 }
 ```
 
+Use `notebookId` when diffing or merging from another PHPSandbox notebook. Use `url` for external Git remotes. `notebookId`, `url`, and `target` are mutually exclusive.
+
 Fork diff requires the base and fork to share Git history. If they do not, `diff()` returns `status: 'unrelated'`.
 
 ### Mail

package/dist/auth.d.ts

@@ -11,4 +11,3 @@ export default class Auth {
     logout(): Promise<void>;
     login(newConnectionData: string): Promise<boolean>;
 }
-//# sourceMappingURL=auth.d.ts.map

package/dist/auth.js

@@ -9,4 +9,3 @@ export default class Auth {
         return this.okra.invoke('auth.login', { newConnectionData });
     }
 }
-//# sourceMappingURL=auth.js.map

package/dist/beacon/index.d.ts

@@ -70,7 +70,7 @@ export declare class Beacon implements BeaconActions {
     /**
      * Event emitter methods (both private and public for navigator access)
      */
-    emit(event: string, payload: any): void;
+    emit(event: string, payload: unknown): void;
     /**
      * Start the beacon initialization process
      */
@@ -90,7 +90,7 @@ export declare class Beacon implements BeaconActions {
     /**
      * Listen for beacon events (one-time)
      */
-    once<K extends keyof BeaconEvents>(event: K, handler: (payload: BeaconEvents[K]) => void): void;
+    once<K extends keyof BeaconEvents>(event: K, handler: (payload: BeaconEvents[K]) => void): Disposable;
     /**
      * Ping the beacon to check if it's responsive
      */
@@ -120,7 +120,7 @@ export declare class Beacon implements BeaconActions {
      */
     executeCode(code: string): Promise<{
         success: boolean;
-        result?: any;
+        result?: unknown;
         error?: string;
     }>;
     /**
@@ -128,7 +128,7 @@ export declare class Beacon implements BeaconActions {
      */
     inspectElement(selector: string): Promise<{
         success: boolean;
-        element?: any;
+        element?: unknown;
         error?: string;
     }>;
     /**
@@ -170,4 +170,3 @@ export declare function createBeacon(iframe: HTMLIFrameElement, options?: Beacon
  * Check if the current environment supports the Beacon SDK
  */
 export declare function isBeaconSupported(): boolean;
-//# sourceMappingURL=index.d.ts.map

package/dist/beacon/index.js

@@ -221,11 +221,11 @@ export class Beacon {
                 });
             });
         }, {
-            retries: this.options.retry?.retries || 3,
-            minTimeout: this.options.retry?.minTimeout || 1000,
-            maxTimeout: this.options.retry?.maxTimeout || 5000,
-            factor: this.options.retry?.factor || 2,
-            randomize: this.options.retry?.randomize || true,
+            retries: this.options.retry?.retries ?? 3,
+            minTimeout: this.options.retry?.minTimeout ?? 1000,
+            maxTimeout: this.options.retry?.maxTimeout ?? 5000,
+            factor: this.options.retry?.factor ?? 2,
+            randomize: this.options.retry?.randomize ?? true,
             onRetry: (error, attempt) => {
                 if (this.options.debug) {
                     const errorMessage = error instanceof Error ? error.message : String(error);
@@ -297,11 +297,11 @@ export class Beacon {
                 }
             });
         }, {
-            retries: this.options.retry?.retries || 3,
-            minTimeout: this.options.retry?.minTimeout || 1000,
-            maxTimeout: this.options.retry?.maxTimeout || 5000,
-            factor: this.options.retry?.factor || 2,
-            randomize: this.options.retry?.randomize || true,
+            retries: this.options.retry?.retries ?? 3,
+            minTimeout: this.options.retry?.minTimeout ?? 1000,
+            maxTimeout: this.options.retry?.maxTimeout ?? 5000,
+            factor: this.options.retry?.factor ?? 2,
+            randomize: this.options.retry?.randomize ?? true,
             onRetry: (error, attempt) => {
                 if (this.options.debug) {
                     const errorMessage = error instanceof Error ? error.message : String(error);
@@ -361,7 +361,7 @@ export class Beacon {
      * Listen for beacon events (one-time)
      */
     once(event, handler) {
-        this.eventEmitter.once(event, handler);
+        return this.eventEmitter.once(event, handler);
     }
     /**
      * Ping the beacon to check if it's responsive
@@ -542,4 +542,3 @@ export function isBeaconSupported() {
         return false;
     }
 }
-//# sourceMappingURL=index.js.map

package/dist/beacon/navigator.d.ts

@@ -132,10 +132,9 @@ export declare class Navigator implements NavigatorActions {
     /**
      * Get the current history state (always null since we don't store state)
      */
-    getHistoryState(): Promise<any>;
+    getHistoryState(): Promise<unknown>;
     /**
      * Get comprehensive history information
      */
     getHistoryInfo(): Promise<HistoryInfoResponse>;
 }
-//# sourceMappingURL=navigator.d.ts.map

package/dist/beacon/navigator.js

@@ -243,4 +243,3 @@ export class Navigator {
         this.onceEvent(event, handler);
     }
 }
-//# sourceMappingURL=navigator.js.map

package/dist/beacon/types.d.ts

@@ -1,4 +1,4 @@
-export interface BeaconMessage<T = any> {
+export interface BeaconMessage<T = unknown> {
     type: string;
     payload: T;
     timestamp: number;
@@ -19,7 +19,7 @@ export interface UrlChangeEvent {
 }
 export interface ConsoleEvent {
     level: 'log' | 'warn' | 'error' | 'info' | 'debug';
-    args: any[];
+    args: unknown[];
     timestamp: number;
     stack?: string;
 }
@@ -41,8 +41,8 @@ export interface DebugInfo {
     };
     timestamp: number;
     performance?: {
-        navigation: any;
-        timing: any;
+        navigation: unknown;
+        timing: unknown;
     };
     console?: ConsoleEvent[];
     errors?: BeaconErrorEvent[];
@@ -162,7 +162,7 @@ export interface DOMInfo {
     }>;
 }
 export interface PerformanceInfo {
-    navigationTiming: any;
+    navigationTiming: unknown;
     loadEventEnd: number;
     domContentLoaded: number;
     firstPaint?: number;
@@ -200,12 +200,12 @@ export interface BeaconActions {
     clearErrors: () => Promise<void>;
     executeCode: (code: string) => Promise<{
         success: boolean;
-        result?: any;
+        result?: unknown;
         error?: string;
     }>;
     inspectElement: (selector: string) => Promise<{
         success: boolean;
-        element?: any;
+        element?: unknown;
         error?: string;
     }>;
     captureScreenshot: (request?: ScreenshotRequest) => Promise<ScreenshotResult>;
@@ -228,12 +228,12 @@ export interface BeaconEvents {
     errorEvents: BeaconErrorEvent[];
     codeExecutionResult: {
         success: boolean;
-        result?: any;
+        result?: unknown;
         error?: string;
     };
     elementInspectionResult: {
         success: boolean;
-        element?: any;
+        element?: unknown;
         error?: string;
     };
     screenshotResult: ScreenshotResult;
@@ -252,13 +252,13 @@ export interface BeaconEvents {
         success: boolean;
         error?: string;
         action?: string;
-        state?: any;
+        state?: unknown;
         title?: string;
         url?: string;
     };
     historyChange: {
         url: string;
-        state: any;
+        state: unknown;
         direction: 'back' | 'forward' | 'push' | 'replace' | 'reload';
         timestamp: number;
     };
@@ -271,7 +271,7 @@ export interface BeaconEvents {
     };
     historyInfo: {
         length: number;
-        state: any;
+        state: unknown;
         url: string;
         canGoBack: boolean;
         canGoForward: boolean;
@@ -289,4 +289,3 @@ export interface BeaconOptions {
         randomize?: boolean;
     };
 }
-//# sourceMappingURL=types.d.ts.map

package/dist/beacon/types.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=types.js.map