@eyepop.ai/eyepop 3.15.1 → 3.16.0

package/README.md

@@ -56,18 +56,18 @@ For provisioned persistent worker sessions, also set `EYEPOP_SESSION_UUID`.
 import { EyePop } from '@eyepop.ai/eyepop'
 
 ;(async () => {
-    const endpoint = await EyePop.workerEndpoint().connect()
-    try {
-        await endpoint.changePop({
+    const endpoint = await EyePop.workerEndpoint({
+        pop: {
             components: [
                 {
                     type: 'inference',
-                    model: 'eyepop.person:latest',
+                    ability: 'eyepop.person:latest',
                     categoryName: 'person',
                 },
             ],
-        })
-
+        },
+    }).connect()
+    try {
         const results = await endpoint.process({ source: { path: 'examples/example.jpg' } })
         for await (const result of results) {
             console.log(result)
@@ -78,6 +78,8 @@ import { EyePop } from '@eyepop.ai/eyepop'
 })()
 ```
 
+For transient sessions, pass `pop` when creating the endpoint whenever possible. Use `endpoint.changePop(pop)` only when an already connected transient worker needs to switch Pops.
+
 You can also pass the key explicitly from server-side configuration:
 
 ```typescript
@@ -133,7 +135,7 @@ Dashboard users can run local browser demos with the current browser session:
                 components: [
                     {
                         type: 'inference',
-                        model: 'eyepop.person:latest',
+                        ability: 'eyepop.person:latest',
                         categoryName: 'person',
                     },
                 ],

package/dist/eyepop.index.d.mts

@@ -735,8 +735,15 @@ declare enum PredictionVersion {
 }
 declare const DEFAULT_PREDICTION_VERSION: PredictionVersion;
 interface WorkerSession extends Session {
+    /**
+     * @deprecated Pop ids are only retained for backwards compatibility.
+     * Configure transient sessions with `WorkerOptions.pop`.
+     */
     readonly popId: string;
     readonly baseUrl: string | undefined;
+    /**
+     * Transient sessions may not have a pipeline until the first source is processed.
+     */
     readonly pipelineId: string | undefined;
     authenticationHeaders(): any;
 }
@@ -1068,15 +1075,25 @@ declare class Endpoint<T extends Endpoint<T>> {
     private currentAccessToken;
 }
 
+/**
+ * @deprecated Configure transient sessions with `WorkerOptions.pop`.
+ * Support for pop id will be removed in 3.16.
+ */
 declare enum TransientPopId {
     Transient = "transient"
 }
 interface WorkerOptions extends Options {
     /**
-     * TODO: deprecated, support for pop id will be removed in 3.16
+     * @deprecated Pass `pop` for transient sessions or `sessionUuid` for persistent sessions.
+     * Support for pop id will be removed in 3.16.
      */
     popId?: string | TransientPopId | undefined;
     sessionUuid?: string | undefined;
+    sessionName?: string | undefined;
+    pipelineImage?: string | undefined;
+    pipelineVersion?: string | undefined;
+    pop?: Pop | undefined;
+    sessionReadyTimeoutSeconds?: number | undefined;
     autoStart?: boolean;
     stopJobs?: boolean;
     isLocalMode?: boolean;
@@ -1092,13 +1109,17 @@ declare enum SessionStatus {
     PIPELINE_CREATING = "pipeline_creating",
     PIPELINE_OK = "pipeline_ok",
     PIPELINE_CHECKING = "pipeline_checking",
-    PIPELINE_ERROR = "pipeline_error"
+    PIPELINE_ERROR = "pipeline_error",
+    UPGRADING = "upgrading"
 }
 declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     private _baseUrl;
     private _pipelineId;
     private _popName;
+    private _sessionAccessToken;
+    private _sessionAccessTokenValidUntil;
     private _pipeline;
+    private _pipelineCreatePromise;
     constructor(options: WorkerOptions);
     private options;
     disconnect(wait?: boolean): Promise<void>;
@@ -1108,6 +1129,10 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     pop(): Pop | null;
     changePop(pop: Pop): Promise<void>;
     private _authenticationHeaders;
+    /**
+     * @deprecated Pop ids are only retained for backwards compatibility.
+     * Configure transient sessions with `WorkerOptions.pop`.
+     */
     popId(): string | null;
     /**
      * V1 call to process media as a source with optional component params
@@ -1141,10 +1166,21 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     private static SESSION_DEAD;
     private static WAIT_FOR_IS_READY;
     private static CHECK_FOR_IS_READY_INTERVAL;
+    private sessionReadyTimeoutMs;
+    private sessionHealthReady;
     private getComputeSession;
     private getOnDemandComputeSession;
     private getPermanentComputeSession;
     private startTransientPipeline;
+    private ensureTransientPipelineStarted;
+    private changeTransientPop;
+    private deleteTransientPipeline;
+    private pipelineIdFromSession;
+    protected authorizationHeader(): Promise<string>;
+    private computeAuthorizationHeader;
+    private setComputeSessionAccessToken;
+    private setTransientPipelinePop;
+    private sessionCreateBody;
 }
 
 interface DataOptions extends Options {

package/dist/eyepop.index.d.ts

@@ -735,8 +735,15 @@ declare enum PredictionVersion {
 }
 declare const DEFAULT_PREDICTION_VERSION: PredictionVersion;
 interface WorkerSession extends Session {
+    /**
+     * @deprecated Pop ids are only retained for backwards compatibility.
+     * Configure transient sessions with `WorkerOptions.pop`.
+     */
     readonly popId: string;
     readonly baseUrl: string | undefined;
+    /**
+     * Transient sessions may not have a pipeline until the first source is processed.
+     */
     readonly pipelineId: string | undefined;
     authenticationHeaders(): any;
 }
@@ -1068,15 +1075,25 @@ declare class Endpoint<T extends Endpoint<T>> {
     private currentAccessToken;
 }
 
+/**
+ * @deprecated Configure transient sessions with `WorkerOptions.pop`.
+ * Support for pop id will be removed in 3.16.
+ */
 declare enum TransientPopId {
     Transient = "transient"
 }
 interface WorkerOptions extends Options {
     /**
-     * TODO: deprecated, support for pop id will be removed in 3.16
+     * @deprecated Pass `pop` for transient sessions or `sessionUuid` for persistent sessions.
+     * Support for pop id will be removed in 3.16.
      */
     popId?: string | TransientPopId | undefined;
     sessionUuid?: string | undefined;
+    sessionName?: string | undefined;
+    pipelineImage?: string | undefined;
+    pipelineVersion?: string | undefined;
+    pop?: Pop | undefined;
+    sessionReadyTimeoutSeconds?: number | undefined;
     autoStart?: boolean;
     stopJobs?: boolean;
     isLocalMode?: boolean;
@@ -1092,13 +1109,17 @@ declare enum SessionStatus {
     PIPELINE_CREATING = "pipeline_creating",
     PIPELINE_OK = "pipeline_ok",
     PIPELINE_CHECKING = "pipeline_checking",
-    PIPELINE_ERROR = "pipeline_error"
+    PIPELINE_ERROR = "pipeline_error",
+    UPGRADING = "upgrading"
 }
 declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     private _baseUrl;
     private _pipelineId;
     private _popName;
+    private _sessionAccessToken;
+    private _sessionAccessTokenValidUntil;
     private _pipeline;
+    private _pipelineCreatePromise;
     constructor(options: WorkerOptions);
     private options;
     disconnect(wait?: boolean): Promise<void>;
@@ -1108,6 +1129,10 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     pop(): Pop | null;
     changePop(pop: Pop): Promise<void>;
     private _authenticationHeaders;
+    /**
+     * @deprecated Pop ids are only retained for backwards compatibility.
+     * Configure transient sessions with `WorkerOptions.pop`.
+     */
     popId(): string | null;
     /**
      * V1 call to process media as a source with optional component params
@@ -1141,10 +1166,21 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     private static SESSION_DEAD;
     private static WAIT_FOR_IS_READY;
     private static CHECK_FOR_IS_READY_INTERVAL;
+    private sessionReadyTimeoutMs;
+    private sessionHealthReady;
     private getComputeSession;
     private getOnDemandComputeSession;
     private getPermanentComputeSession;
     private startTransientPipeline;
+    private ensureTransientPipelineStarted;
+    private changeTransientPop;
+    private deleteTransientPipeline;
+    private pipelineIdFromSession;
+    protected authorizationHeader(): Promise<string>;
+    private computeAuthorizationHeader;
+    private setComputeSessionAccessToken;
+    private setTransientPipelinePop;
+    private sessionCreateBody;
 }
 
 interface DataOptions extends Options {