@modelprofile.com/browser-runtime 1.0.0

package/dist_ts/classes.runtime.d.ts

@@ -0,0 +1,202 @@
+import * as plugins from './plugins.js';
+import { BrowserArtifactStore } from './classes.artifactstore.js';
+import { BrowserEgressProxy } from './classes.egressproxy.js';
+import { type IBrowserRuntimeTestingOptions } from './internal.testing.js';
+import type { IAttachTrustedFramedPeerOptions, IBrowserCapabilityDescriptor, IBrowserRuntimeFrameSubscription, IBrowserRuntimeOperationOptions, IBrowserRuntimeOptions, IBrowserRuntimeState, IIssueBrowserCapabilityRequest, IIssuedBrowserCapability, ILiveBrowserSessionLike, TBrowserActorRole, TBrowserAgentAction, TBrowserAgentActionResult, TBrowserCapabilitySource, TBrowserRuntimeEvent } from './interfaces.js';
+import { TransitionMutex } from './utils.js';
+import { BrowserRuntimeFramedServerPeer } from './classes.framed.js';
+interface ICapabilityRecord extends IBrowserCapabilityDescriptor {
+    digest: plugins.Buffer;
+    state: 'active' | 'revoked' | 'expired';
+    expiryTimer: ReturnType<typeof setTimeout>;
+    disconnect?: (signal: AbortSignal) => Promise<void> | void;
+    lease?: ILeaseRecord;
+    revocationPromise?: Promise<void>;
+    revocationInvokeDisconnect?: boolean;
+    revocationComplete?: boolean;
+    leaseCleanupComplete?: boolean;
+    disconnectComplete?: boolean;
+}
+interface ILeaseRecord {
+    leaseId: string;
+    capability: ICapabilityRecord;
+    digest: plugins.Buffer;
+    peerId: string;
+    role: TBrowserActorRole;
+    slot: IProjectSlot;
+    controller: AbortController;
+    released: boolean;
+    releasePromise?: Promise<void>;
+    releaseGeneration?: number;
+}
+interface IOperationRecord {
+    operationId: string;
+    lease: ILeaseRecord;
+    controller: AbortController;
+    action: string;
+    startedAt: number;
+    promise: Promise<void>;
+}
+interface IFrameSubscriptionRecord {
+    lease: ILeaseRecord;
+    listener: (event: TBrowserRuntimeEvent) => void;
+    outstanding?: {
+        acknowledgement: plugins.smartpuppeteer.ILiveBrowserFrameAcknowledgementRequest;
+        timer: ReturnType<typeof setTimeout>;
+    };
+    closed: boolean;
+}
+interface IProjectSlot {
+    projectId: string;
+    mutex: TransitionMutex;
+    generation: number;
+    fencingGeneration?: number;
+    permanentlyFenced: boolean;
+    session?: ILiveBrowserSessionLike;
+    proxy?: BrowserEgressProxy;
+    profileDirectory?: string;
+    unsubscribeSession?: () => void;
+    lease?: ILeaseRecord;
+    operation?: IOperationRecord;
+    frameSubscription?: IFrameSubscriptionRecord;
+    idleTimer?: ReturnType<typeof setTimeout>;
+}
+export interface IAcquireBrowserRuntimeLeaseOptions {
+    capabilityToken: string;
+    peerId: string;
+    expectedRole?: TBrowserActorRole;
+    expectedSource?: TBrowserCapabilitySource;
+    scopeId?: string;
+    sessionId?: string;
+    signal?: AbortSignal;
+}
+export declare class BrowserRuntime {
+    private readonly options;
+    private readonly profileRoot;
+    private readonly artifactRoot;
+    private readonly lockPath;
+    private readonly artifactStore;
+    private readonly slots;
+    private readonly capabilitiesByDigest;
+    private readonly capabilitiesById;
+    private readonly failedRevocations;
+    private readonly capabilityMutex;
+    private readonly cleanupOperations;
+    private readonly framedPeers;
+    private lockHandle?;
+    private lockHandleClosed;
+    private startPromise?;
+    private stopPromise?;
+    private lifecycleState;
+    private lifecycleEpoch;
+    private lifecycleController;
+    private pendingCapabilities;
+    private readonly pendingCapabilitiesByProject;
+    constructor(options: IBrowserRuntimeOptions | IBrowserRuntimeTestingOptions);
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    issueCapability(requestArg: IIssueBrowserCapabilityRequest): Promise<IIssuedBrowserCapability>;
+    acquireLease(optionsArg: IAcquireBrowserRuntimeLeaseOptions): Promise<BrowserRuntimeLease>;
+    authorizeCapability(capabilityTokenArg: string, peerIdArg: string, role: TBrowserActorRole, source: TBrowserCapabilitySource): IBrowserCapabilityDescriptor;
+    revokeCapability(capabilityIdArg: string): Promise<void>;
+    disconnectPeer(peerIdArg: string): Promise<void>;
+    retireProject(projectIdArg: string): Promise<void>;
+    attachTrustedFramedPeer(options: IAttachTrustedFramedPeerOptions): BrowserRuntimeFramedServerPeer;
+    getArtifactStore(): BrowserArtifactStore;
+    /** @internal */
+    getLeaseState(lease: ILeaseRecord): IBrowserRuntimeState;
+    /** @internal */
+    executeLeaseAgentAction(lease: ILeaseRecord, actionArg: unknown, operationOptions?: IBrowserRuntimeOperationOptions): Promise<TBrowserAgentActionResult>;
+    /** @internal */
+    leaseCreateTab(lease: ILeaseRecord, options?: plugins.smartpuppeteer.ILiveBrowserCreateTabOptions, operationOptions?: IBrowserRuntimeOperationOptions): Promise<IBrowserRuntimeState>;
+    /** @internal */
+    leaseActivateTab(lease: ILeaseRecord, tabIdArg: string, operationOptions?: IBrowserRuntimeOperationOptions): Promise<IBrowserRuntimeState>;
+    /** @internal */
+    leaseCloseTab(lease: ILeaseRecord, tabIdArg: string, operationOptions?: IBrowserRuntimeOperationOptions): Promise<IBrowserRuntimeState>;
+    /** @internal */
+    leaseHistory(lease: ILeaseRecord, action: 'back' | 'forward' | 'reload', options?: plugins.smartpuppeteer.ILiveBrowserNavigationOptions, operationOptions?: IBrowserRuntimeOperationOptions): Promise<IBrowserRuntimeState>;
+    /** @internal */
+    leaseHumanAgentAction(lease: ILeaseRecord, actionArg: unknown, operationOptions?: IBrowserRuntimeOperationOptions): Promise<TBrowserAgentActionResult>;
+    /** @internal */
+    leaseSetViewport(lease: ILeaseRecord, viewport: plugins.smartpuppeteer.ILiveBrowserViewport, operationOptions?: IBrowserRuntimeOperationOptions): Promise<void>;
+    /** @internal */
+    leaseDispatchRawInput(lease: ILeaseRecord, action: 'dispatchMouse' | 'dispatchWheel' | 'dispatchKey' | 'insertText', input: plugins.smartpuppeteer.ILiveBrowserMouseInput | plugins.smartpuppeteer.ILiveBrowserWheelInput | plugins.smartpuppeteer.ILiveBrowserKeyInput | plugins.smartpuppeteer.ILiveBrowserInsertTextInput, operationOptions?: IBrowserRuntimeOperationOptions): Promise<void>;
+    /** @internal */
+    subscribeLeaseEvents(lease: ILeaseRecord, listener: (event: TBrowserRuntimeEvent) => void): Promise<IBrowserRuntimeFrameSubscription>;
+    /** @internal */
+    acknowledgeLeaseFrame(lease: ILeaseRecord, acknowledgement: plugins.smartpuppeteer.ILiveBrowserFrameAcknowledgementRequest): Promise<boolean>;
+    /** @internal */
+    readLeaseArtifact(lease: ILeaseRecord, artifactId: string): Promise<Uint8Array>;
+    /** @internal */
+    deleteLeaseArtifact(lease: ILeaseRecord, artifactId: string): Promise<void>;
+    /** @internal */
+    cancelLeaseOperation(lease: ILeaseRecord): boolean;
+    /** @internal */
+    releaseLease(lease: ILeaseRecord): Promise<void>;
+    private startInternal;
+    private stopInternal;
+    private requireRunning;
+    private getOrCreateSlot;
+    private acquireAgentLease;
+    private acquireHumanLease;
+    private createLeaseRecord;
+    private ensureSession;
+    private runOperation;
+    private executeAgentActionInternal;
+    private resolveSemanticTarget;
+    private projectState;
+    private handleSessionEvent;
+    private pushToSubscription;
+    private closeFrameSubscription;
+    private acknowledgeFrameInBackground;
+    private requireValidLease;
+    private resolveCapability;
+    private describeCapability;
+    private revokeCapabilityRecord;
+    private releaseLeaseRecord;
+    private releaseLeaseRecordInternal;
+    private closeFrameSubscriptionIfLease;
+    private quiesceSlot;
+    private enforceOperationQuiescence;
+    private terminateSlotSession;
+    private scheduleIdleRetirement;
+    private stopProxyBounded;
+    private retireSlot;
+    private assertSlotAvailable;
+    private throwIfAcquisitionAborted;
+    private requireHuman;
+    private validateRole;
+    private validateSource;
+    private trackCleanup;
+    private emitAudit;
+}
+export declare class BrowserRuntimeLease {
+    private readonly runtime;
+    private readonly record;
+    /** @internal */
+    constructor(runtime: BrowserRuntime, record: ILeaseRecord);
+    get leaseId(): string;
+    get role(): TBrowserActorRole;
+    get projectId(): string;
+    getState(): IBrowserRuntimeState;
+    executeAgentAction(action: TBrowserAgentAction, options?: IBrowserRuntimeOperationOptions): Promise<TBrowserAgentActionResult>;
+    executeHumanAction(action: TBrowserAgentAction, options?: IBrowserRuntimeOperationOptions): Promise<TBrowserAgentActionResult>;
+    createTab(options?: plugins.smartpuppeteer.ILiveBrowserCreateTabOptions, operationOptions?: IBrowserRuntimeOperationOptions): Promise<IBrowserRuntimeState>;
+    activateTab(tabId: string, operationOptions?: IBrowserRuntimeOperationOptions): Promise<IBrowserRuntimeState>;
+    closeTab(tabId: string, operationOptions?: IBrowserRuntimeOperationOptions): Promise<IBrowserRuntimeState>;
+    back(options?: plugins.smartpuppeteer.ILiveBrowserNavigationOptions, operationOptions?: IBrowserRuntimeOperationOptions): Promise<IBrowserRuntimeState>;
+    forward(options?: plugins.smartpuppeteer.ILiveBrowserNavigationOptions, operationOptions?: IBrowserRuntimeOperationOptions): Promise<IBrowserRuntimeState>;
+    reload(options?: plugins.smartpuppeteer.ILiveBrowserNavigationOptions, operationOptions?: IBrowserRuntimeOperationOptions): Promise<IBrowserRuntimeState>;
+    setViewport(viewport: plugins.smartpuppeteer.ILiveBrowserViewport, operationOptions?: IBrowserRuntimeOperationOptions): Promise<void>;
+    dispatchMouse(input: plugins.smartpuppeteer.ILiveBrowserMouseInput, operationOptions?: IBrowserRuntimeOperationOptions): Promise<void>;
+    dispatchWheel(input: plugins.smartpuppeteer.ILiveBrowserWheelInput, operationOptions?: IBrowserRuntimeOperationOptions): Promise<void>;
+    dispatchKey(input: plugins.smartpuppeteer.ILiveBrowserKeyInput, operationOptions?: IBrowserRuntimeOperationOptions): Promise<void>;
+    insertText(input: plugins.smartpuppeteer.ILiveBrowserInsertTextInput, operationOptions?: IBrowserRuntimeOperationOptions): Promise<void>;
+    subscribeEvents(listener: (event: TBrowserRuntimeEvent) => void): Promise<IBrowserRuntimeFrameSubscription>;
+    acknowledgeFrame(acknowledgement: plugins.smartpuppeteer.ILiveBrowserFrameAcknowledgementRequest): Promise<boolean>;
+    readArtifact(artifactId: string): Promise<Uint8Array>;
+    deleteArtifact(artifactId: string): Promise<void>;
+    cancelActiveOperation(): boolean;
+    release(): Promise<void>;
+}
+export {};