@eyepop.ai/eyepop 3.14.7 → 3.15.1

package/dist/eyepop.index.d.ts

@@ -60,24 +60,35 @@ interface Prediction extends StreamTime {
      */
     source_height: number;
     source_id?: string;
+    source_url?: string;
+    source_type?: string;
+    system_timestamp?: number;
     objects?: Array<PredictedObject>;
     classes?: Array<PredictedClass>;
     texts?: Array<PredictedText>;
     meshs?: Array<PredictedMesh>;
     keyPoints?: Array<PredictedKeyPoints>;
+    embeddings?: Array<PredictedEmbedding>;
+    motions?: Array<PredictedMotion>;
 }
 interface PredictedClass {
     id?: number;
-    confidence: number;
+    confidence?: number;
     classLabel: string;
     category?: string;
 }
 interface PredictedText {
     id?: number;
-    confidence: number;
+    confidence?: number;
     text: string;
     category?: string;
 }
+interface PredictedEmbedding {
+    x?: number;
+    y?: number;
+    embedding: Array<number>;
+    category?: string;
+}
 interface Contour {
     points: Array<Point2d>;
     cutouts: Array<Array<Point2d>>;
@@ -89,41 +100,45 @@ interface Mask {
     stride: number;
 }
 interface PredictedObject extends PredictedClass {
-    trackId: number | undefined;
+    trackId?: number;
     x: number;
     y: number;
     width: number;
     height: number;
     orientation?: number;
-    outline: Array<Point2d> | undefined;
-    contours: Array<Contour> | undefined;
-    mask: Mask | undefined;
-    objects: Array<PredictedObject> | undefined;
-    classes: Array<PredictedClass> | undefined;
-    texts: Array<PredictedText> | undefined;
-    meshs: Array<PredictedMesh> | undefined;
-    keyPoints: Array<PredictedKeyPoints> | undefined;
+    outline?: Array<Point2d>;
+    contours?: Array<Contour>;
+    mask?: Mask;
+    objects?: Array<PredictedObject>;
+    classes?: Array<PredictedClass>;
+    texts?: Array<PredictedText>;
+    meshs?: Array<PredictedMesh>;
+    keyPoints?: Array<PredictedKeyPoints>;
 }
 interface Point2d {
     x: number;
     y: number;
 }
 interface PredictedMesh {
-    category: string;
-    id: number;
-    confidence: number;
+    category?: string;
+    id?: number;
+    confidence?: number;
     points: Array<Point3d>;
 }
 interface Point3d extends Point2d {
-    z: number | undefined;
+    z?: number;
 }
 interface PredictedKeyPoints {
-    category: string;
-    type: string;
+    category?: string;
+    type?: string;
     points: Array<PredictedKeyPoint>;
 }
-interface PredictedKeyPoint extends Point3d, PredictedClass {
-    visible: boolean | undefined;
+interface PredictedKeyPoint extends Point3d {
+    id?: number;
+    confidence?: number;
+    classLabel?: string;
+    category?: string;
+    visible?: boolean;
 }
 interface PredictedMotion {
     begin_timestamp: number;
@@ -941,11 +956,6 @@ interface PlatformSupport {
 }
 interface Options {
     auth?: Authentication | undefined;
-    /**
-     * Override the default base URL for the API, e.g., "https://api.eyepop.ai/"
-     *
-     * Defaults to process.env['EYEPOP_URL'].
-     */
     eyepopUrl?: string | undefined;
     jobQueueLength?: number;
     logger?: Logger | undefined;
@@ -1063,9 +1073,10 @@ declare enum TransientPopId {
 }
 interface WorkerOptions extends Options {
     /**
-     * TODO: deprecated, defaults to process.env['EYEPOP_POP_ID'].
+     * TODO: deprecated, support for pop id will be removed in 3.16
      */
     popId?: string | TransientPopId | undefined;
+    sessionUuid?: string | undefined;
     autoStart?: boolean;
     stopJobs?: boolean;
     isLocalMode?: boolean;
@@ -1130,7 +1141,9 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     private static SESSION_DEAD;
     private static WAIT_FOR_IS_READY;
     private static CHECK_FOR_IS_READY_INTERVAL;
-    private startComputeSession;
+    private getComputeSession;
+    private getOnDemandComputeSession;
+    private getPermanentComputeSession;
     private startTransientPipeline;
 }
 
@@ -1405,4 +1418,4 @@ declare namespace EyePop {
     function dataEndpoint(opts?: DataOptions): DataEndpoint;
 }
 
-export { type AbilityAliasEntry, AbstractJob, type AliasResolution, type Annotation, AnnotationInclusionMode, AnnotationType, type ApiKeyAuth, type Area, AreaType, ArtifactType, type Asset, type AssetImport, AssetInclusionMode, AssetStatus, AssetUrlType, type AssetUuidSource, type Auth0Options, type Authentication, type AutoAnnotate, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateStatus, AutoAnnotateTask, type AutoPromptConfig, type AutoTask, type BaseArea, type BaseComponent, type BaseTask, type Box, type ChangeEvent, ChangeType, type ClassificationTask, type ComponentFinderComponent, type ComponentParams, type Contour, type ContourArea, type ContourFinderComponent, ContourType, type CreateWorkflow, type CreateWorkflowConfig, DEFAULT_PREDICTION_VERSION, DataApiType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetAutoAnnotate, type DatasetAutoAnnotateCreate, type DatasetAutoAnnotateUpdate, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, type DownloadResponse, Endpoint, EndpointState, type EvaluateConfig, type EvaluateFilter, type EvaluateRequest, type EvaluateResponse, type EvaluateRunInfo, EvaluationStatus, ExportedBy, EyePop, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferRequest, type InferRunInfo, type InferRuntimeConfig, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromJob, LoadMediaStreamJob, type LocalAuth, type Mask, type MediaStreamSource, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type MotionDetectConfig, MotionModel, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedMotion, type PredictedObject, type PredictedText, type Prediction, PredictionVersion, type ProcessParams, type ProcessRequest, type QcAiHubExportParams, type RectangleArea, type ResultStream, type Roi, Semaphore, type Session, type SessionAuth, SessionStatus, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, type VlmAbility, type VlmAbilityCreate, type VlmAbilityGroup, type VlmAbilityGroupCreate, type VlmAbilityGroupUpdate, VlmAbilityStatus, type VlmAbilityUpdate, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, type Workflow, WorkflowPhase, EyePop as default, getBaseUrl, readableStreamFromString };
+export { type AbilityAliasEntry, AbstractJob, type AliasResolution, type Annotation, AnnotationInclusionMode, AnnotationType, type ApiKeyAuth, type Area, AreaType, ArtifactType, type Asset, type AssetImport, AssetInclusionMode, AssetStatus, AssetUrlType, type AssetUuidSource, type Auth0Options, type Authentication, type AutoAnnotate, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateStatus, AutoAnnotateTask, type AutoPromptConfig, type AutoTask, type BaseArea, type BaseComponent, type BaseTask, type Box, type ChangeEvent, ChangeType, type ClassificationTask, type ComponentFinderComponent, type ComponentParams, type Contour, type ContourArea, type ContourFinderComponent, ContourType, type CreateWorkflow, type CreateWorkflowConfig, DEFAULT_PREDICTION_VERSION, DataApiType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetAutoAnnotate, type DatasetAutoAnnotateCreate, type DatasetAutoAnnotateUpdate, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, type DownloadResponse, Endpoint, EndpointState, type EvaluateConfig, type EvaluateFilter, type EvaluateRequest, type EvaluateResponse, type EvaluateRunInfo, EvaluationStatus, ExportedBy, EyePop, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferRequest, type InferRunInfo, type InferRuntimeConfig, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromJob, LoadMediaStreamJob, type LocalAuth, type Mask, type MediaStreamSource, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type MotionDetectConfig, MotionModel, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedEmbedding, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedMotion, type PredictedObject, type PredictedText, type Prediction, PredictionVersion, type ProcessParams, type ProcessRequest, type QcAiHubExportParams, type RectangleArea, type ResultStream, type Roi, Semaphore, type Session, type SessionAuth, SessionStatus, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, type VlmAbility, type VlmAbilityCreate, type VlmAbilityGroup, type VlmAbilityGroupCreate, type VlmAbilityGroupUpdate, VlmAbilityStatus, type VlmAbilityUpdate, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, type Workflow, WorkflowPhase, EyePop as default, getBaseUrl, readableStreamFromString };

package/dist/eyepop.index.js

@@ -10599,8 +10599,10 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
   }
   async reconnect() {
     if (this.options().popId == "transient" /* Transient */) {
-      await this.startComputeSession();
+      await this.getComputeSession();
       this._pipelineId = await this.startTransientPipeline();
+    } else if (this.options().sessionUuid) {
+      await this.getComputeSession();
     } else {
       await this.startWebApiSessionWithPopId();
     }
@@ -10695,17 +10697,52 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
       }
     }
   }
-  async startComputeSession() {
+  async getComputeSession() {
     if (!this._client) {
       throw new Error("endpoint not initialized");
     }
+    let session;
+    let headers;
+    const sessionUuid = this.options().sessionUuid;
+    if (sessionUuid) {
+      [session, headers] = await this.getPermanentComputeSession(this._client, sessionUuid);
+    } else {
+      [session, headers] = await this.getOnDemandComputeSession(this._client);
+    }
+    let isReady = false;
+    const deadline = Date.now() + _WorkerEndpoint.WAIT_FOR_IS_READY;
+    while (!isReady) {
+      const health_url = `${session.session_endpoint}/health`;
+      const response = await this._client.fetch(health_url, {
+        headers
+      });
+      if (response.status < 300) {
+        isReady = true;
+      } else if (Date.now() > deadline) {
+        throw new Error(`Created session ${session.session_uuid} did not become healthy after ${_WorkerEndpoint.WAIT_FOR_IS_READY / 1e3} seconds`);
+      } else {
+        this._logger.debug(`session ${session.session_uuid} health check status ${response.status}, wait and poll for update`);
+        await sleep(_WorkerEndpoint.CHECK_FOR_IS_READY_INTERVAL);
+      }
+    }
+    this._baseUrl = session.session_endpoint;
+    this._pipeline = null;
+    if (session.pipeline_uuid) {
+      this._pipelineId = session.pipeline_uuid;
+    } else if (session.pipelines) {
+      this._pipelineId = session.pipelines[0].pipeline_id;
+    } else {
+      this._pipelineId = null;
+    }
+  }
+  async getOnDemandComputeSession(httpClient) {
     let session = null;
     const sessionsUrl = `${this.eyepopUrl()}/v1/sessions`;
     this._requestLogger.debug("fetching sessions from: %s", sessionsUrl);
     const headers = {
       Authorization: await this.authorizationHeader()
     };
-    let response = await this._client.fetch(sessionsUrl, {
+    let response = await httpClient.fetch(sessionsUrl, {
       headers
     });
     let sessions;
@@ -10719,11 +10756,10 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
       const response_content = await response.json();
       sessions = response_content;
     }
-    console.log(sessions);
     if (sessions.length > 0) {
-      this._logger.debug(`User has ${sessions.length} sessions, inspecting for active session`);
+      this._logger.debug(`User has ${sessions.length} sessions, inspecting for usable session`);
       for (let s of sessions) {
-        if (!_WorkerEndpoint.SESSION_DEAD.has(s.session_status)) {
+        if (!_WorkerEndpoint.SESSION_DEAD.has(s.session_status) && !s.persistent) {
           session = s;
           this._logger.debug(`Use active session ${s.session_uuid} with pipeline ${s.pipeline_uuid}`);
           break;
@@ -10732,7 +10768,7 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
     }
     if (!session) {
       this._requestLogger.debug("creating a new session at: %s", sessionsUrl);
-      response = await this._client.fetch(`${sessionsUrl}?wait=true`, {
+      response = await httpClient.fetch(`${sessionsUrl}?wait=true`, {
         headers,
         method: "POST"
       });
@@ -10751,29 +10787,30 @@ var _WorkerEndpoint = class _WorkerEndpoint extends Endpoint {
     if (!session) {
       throw new Error("unexpected undefined session");
     }
-    let isReady = false;
-    const deadline = Date.now() + _WorkerEndpoint.WAIT_FOR_IS_READY;
-    while (!isReady) {
-      const health_url = `${session.session_endpoint}/health`;
-      response = await this._client.fetch(health_url, {
-        headers
-      });
-      if (response.status < 300) {
-        isReady = true;
-      } else if (Date.now() > deadline) {
-        throw new Error(`Created session ${session.session_uuid} did not become healthy after ${_WorkerEndpoint.WAIT_FOR_IS_READY / 1e3} seconds`);
-      } else {
-        this._logger.debug(`session ${session.session_uuid} health check status ${response.status}, wait and poll for update`);
-        await sleep(_WorkerEndpoint.CHECK_FOR_IS_READY_INTERVAL);
-      }
-    }
-    this._baseUrl = session.session_endpoint;
-    this._pipeline = null;
-    if (session.pipeline_uuid) {
-      this._pipelineId = session.pipeline_uuid;
+    return [session, headers];
+  }
+  async getPermanentComputeSession(httpClient, sessionUuid) {
+    let session = null;
+    const sessionUrl = `${this.eyepopUrl()}/v1/sessions/${sessionUuid}`;
+    this._requestLogger.debug("fetching session from: %s", sessionUrl);
+    const headers = {
+      Authorization: await this.authorizationHeader()
+    };
+    let response = await httpClient.fetch(sessionUrl, {
+      headers
+    });
+    if (response.status == 404) {
+      this.updateState("Error" /* Error */);
+      throw new Error(`Unexpected status ${response.status} compute sessions ${sessionUuid} not found`);
+    } else if (response.status != 200) {
+      this.updateState("Error" /* Error */);
+      const message = await response.text();
+      throw new Error(`Unexpected status ${response.status} fetching compute sessions: ${message}`);
     } else {
-      this._pipelineId = null;
+      const response_content = await response.json();
+      session = response_content;
     }
+    return [session, headers];
   }
   async startTransientPipeline() {
     const client = this._client;
@@ -12191,7 +12228,10 @@ var EyePop;
         throw new Error("auth option or EYEPOP_API_KEY environment variable is required");
       }
     }
-    if (opts.popId === void 0) {
+    if (opts.sessionUuid === void 0) {
+      opts.sessionUuid = readEnv("EYEPOP_SESSION_UUID");
+    }
+    if (opts.popId === void 0 && opts.sessionUuid === void 0) {
       opts.popId = readEnv("EYEPOP_POP_ID") || "transient" /* Transient */;
     }
     if (opts.autoStart === void 0) {