@modelprofile.com/browser-runtime 1.0.1 → 2.1.0

package/dist_ts/classes.runtime.d.ts

@@ -2,10 +2,10 @@ 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 type { IAttachTrustedFramedPeerOptions, IApplyBrowserAttachmentBindingRequest, IBrowserAttachmentBinding, TBrowserCapabilityDescriptor, TBrowserCapabilityAuthorizationRequest, IBrowserRuntimeFrameSubscription, IBrowserRuntimeOperationOptions, IBrowserRuntimeOptions, IBrowserResourceRegistration, IBrowserRuntimeState, ICreateBrowserResourceRequest, IRegisterBrowserResourceRequest, TIssueBrowserCapabilityRequest, TIssuedBrowserCapability, ILiveBrowserSessionLike, TBrowserActorRole, TBrowserAgentAction, TBrowserAgentActionResult, TBrowserRuntimeEvent } from './interfaces.js';
 import { TransitionMutex } from './utils.js';
 import { BrowserRuntimeFramedServerPeer } from './classes.framed.js';
-interface ICapabilityRecord extends IBrowserCapabilityDescriptor {
+type TCapabilityRecord = TBrowserCapabilityDescriptor & {
     digest: plugins.Buffer;
     state: 'active' | 'revoked' | 'expired';
     expiryTimer: ReturnType<typeof setTimeout>;
@@ -16,18 +16,20 @@ interface ICapabilityRecord extends IBrowserCapabilityDescriptor {
     revocationComplete?: boolean;
     leaseCleanupComplete?: boolean;
     disconnectComplete?: boolean;
-}
+    revoking?: boolean;
+};
 interface ILeaseRecord {
     leaseId: string;
-    capability: ICapabilityRecord;
+    capability: TCapabilityRecord;
     digest: plugins.Buffer;
     peerId: string;
     role: TBrowserActorRole;
-    slot: IProjectSlot;
+    slot: IResourceSlot;
     controller: AbortController;
     released: boolean;
     releasePromise?: Promise<void>;
     releaseGeneration?: number;
+    releaseOwnsFence?: boolean;
 }
 interface IOperationRecord {
     operationId: string;
@@ -35,6 +37,8 @@ interface IOperationRecord {
     controller: AbortController;
     action: string;
     startedAt: number;
+    session: ILiveBrowserSessionLike;
+    incarnationGeneration: number;
     promise: Promise<void>;
 }
 interface IFrameSubscriptionRecord {
@@ -46,12 +50,19 @@ interface IFrameSubscriptionRecord {
     };
     closed: boolean;
 }
-interface IProjectSlot {
+interface IResourceSlot {
     projectId: string;
+    browserResourceId: string;
+    registeredAt: number;
+    attachmentBinding: IBrowserAttachmentBinding;
     mutex: TransitionMutex;
-    generation: number;
+    arbitrationGeneration: number;
+    incarnationGeneration: number;
     fencingGeneration?: number;
     permanentlyFenced: boolean;
+    retirementPending: boolean;
+    attachmentFenceCount: number;
+    attachmentRetryBinding?: IBrowserAttachmentBinding;
     session?: ILiveBrowserSessionLike;
     proxy?: BrowserEgressProxy;
     profileDirectory?: string;
@@ -60,16 +71,18 @@ interface IProjectSlot {
     operation?: IOperationRecord;
     frameSubscription?: IFrameSubscriptionRecord;
     idleTimer?: ReturnType<typeof setTimeout>;
+    lifecycleTail: Promise<void>;
+    lifecycleOperationCount: number;
+    terminationRequestGeneration: number;
+    terminationFenceGeneration?: number;
+    terminatePromise?: Promise<void>;
+    retirePromise?: Promise<void>;
+    attachmentOperations: Map<string, Promise<IBrowserResourceRegistration>>;
 }
-export interface IAcquireBrowserRuntimeLeaseOptions {
+export type TAcquireBrowserRuntimeLeaseOptions = TBrowserCapabilityAuthorizationRequest & {
     capabilityToken: string;
-    peerId: string;
-    expectedRole?: TBrowserActorRole;
-    expectedSource?: TBrowserCapabilitySource;
-    scopeId?: string;
-    sessionId?: string;
     signal?: AbortSignal;
-}
+};
 export declare class BrowserRuntime {
     private readonly options;
     private readonly profileRoot;
@@ -77,6 +90,8 @@ export declare class BrowserRuntime {
     private readonly lockPath;
     private readonly artifactStore;
     private readonly slots;
+    private readonly retiredResourceIds;
+    private readonly retiredResourceKeys;
     private readonly capabilitiesByDigest;
     private readonly capabilitiesById;
     private readonly failedRevocations;
@@ -92,15 +107,27 @@ export declare class BrowserRuntime {
     private lifecycleController;
     private pendingCapabilities;
     private readonly pendingCapabilitiesByProject;
+    private readonly pendingCapabilitiesByResource;
+    private pendingLaunches;
+    private readonly pendingLaunchesByProject;
     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;
+    createResource(requestArg: ICreateBrowserResourceRequest): IBrowserResourceRegistration;
+    registerResource(requestArg: IRegisterBrowserResourceRequest): IBrowserResourceRegistration;
+    listResources(): IBrowserResourceRegistration[];
+    applyAttachmentBinding(requestArg: IApplyBrowserAttachmentBindingRequest): Promise<IBrowserResourceRegistration>;
+    terminateResource(projectIdArg: string, browserResourceIdArg: string): Promise<void>;
+    retireResource(projectIdArg: string, browserResourceIdArg: string): Promise<void>;
+    issueCapability(requestArg: TIssueBrowserCapabilityRequest): Promise<TIssuedBrowserCapability>;
+    acquireLease(optionsArg: TAcquireBrowserRuntimeLeaseOptions): Promise<BrowserRuntimeLease>;
+    authorizeCapability(capabilityTokenArg: string, expectedArg: TBrowserCapabilityAuthorizationRequest): TBrowserCapabilityDescriptor;
     revokeCapability(capabilityIdArg: string): Promise<void>;
+    /** @internal */
+    revokeFramedCapability(capabilityIdArg: string): Promise<void>;
+    /** @internal */
+    beforeFramedPeerLeasePublication(): Promise<void>;
     disconnectPeer(peerIdArg: string): Promise<void>;
-    retireProject(projectIdArg: string): Promise<void>;
     attachTrustedFramedPeer(options: IAttachTrustedFramedPeerOptions): BrowserRuntimeFramedServerPeer;
     getArtifactStore(): BrowserArtifactStore;
     /** @internal */
@@ -136,35 +163,68 @@ export declare class BrowserRuntime {
     private startInternal;
     private stopInternal;
     private requireRunning;
-    private getOrCreateSlot;
     private acquireAgentLease;
     private acquireHumanLease;
     private createLeaseRecord;
     private ensureSession;
     private runOperation;
+    private normalizeOperationError;
+    private operationErrorCode;
+    private runBeforeOperation;
+    private createOperationIdentity;
     private executeAgentActionInternal;
     private resolveSemanticTarget;
-    private projectState;
+    private resourceState;
     private handleSessionEvent;
     private pushToSubscription;
     private closeFrameSubscription;
     private acknowledgeFrameInBackground;
+    private handleFrameFailure;
+    private trackFrameCapabilityRevocation;
     private requireValidLease;
     private resolveCapability;
     private describeCapability;
     private revokeCapabilityRecord;
+    private invalidateCapabilityRecord;
     private releaseLeaseRecord;
     private releaseLeaseRecordInternal;
     private closeFrameSubscriptionIfLease;
     private quiesceSlot;
     private enforceOperationQuiescence;
     private terminateSlotSession;
-    private scheduleIdleRetirement;
+    private scheduleIdleTermination;
     private stopProxyBounded;
-    private retireSlot;
+    private terminateRegisteredResourceInternal;
+    private retireRegisteredResourceInternal;
+    private framedPeersForResource;
     private assertSlotAvailable;
     private throwIfAcquisitionAborted;
     private requireHuman;
+    private enqueueResourceLifecycle;
+    private notifyFramedLeaseEnded;
+    private applyAttachmentBindingInternal;
+    private attachmentBindingKey;
+    private tombstoneIndex;
+    private addRetiredTombstone;
+    private hasRetiredTombstone;
+    private resourceKey;
+    private validateIdentifier;
+    private validateResourceId;
+    private validateQualifiedSessionId;
+    private validateAttachmentBinding;
+    private bindingsEqual;
+    private sessionsEqual;
+    private resolveResourceRequest;
+    private getRegisteredSlot;
+    private describeResource;
+    private assertCapabilityBinding;
+    private assertCapabilityStillAttached;
+    private validateExpectedCapabilityBinding;
+    private describeCapabilityIdentity;
+    private capabilityIdentitiesEqual;
+    private capabilitiesForResource;
+    private reserveLaunch;
+    private releaseLaunchReservation;
     private validateRole;
     private validateSource;
     private trackCleanup;
@@ -176,8 +236,12 @@ export declare class BrowserRuntimeLease {
     /** @internal */
     constructor(runtime: BrowserRuntime, record: ILeaseRecord);
     get leaseId(): string;
+    get capabilityId(): string;
     get role(): TBrowserActorRole;
     get projectId(): string;
+    get browserResourceId(): string;
+    get attachmentAuthorityId(): string;
+    get attachmentRevision(): number;
     getState(): IBrowserRuntimeState;
     executeAgentAction(action: TBrowserAgentAction, options?: IBrowserRuntimeOperationOptions): Promise<TBrowserAgentActionResult>;
     executeHumanAction(action: TBrowserAgentAction, options?: IBrowserRuntimeOperationOptions): Promise<TBrowserAgentActionResult>;