@eyepop.ai/eyepop 3.18.0 → 3.19.1

package/README.md

@@ -6,7 +6,7 @@ The EyePop.ai Node SDK provides JavaScript and TypeScript access to EyePop worke
 
 ### Node
 
-The SDK is tested with Node 20 LTS and newer.
+Requires Node.js 18 or newer. CI validates Node.js 22.
 
 ```shell
 npm install --save @eyepop.ai/eyepop

package/dist/eyepop.index.d.mts

@@ -71,6 +71,7 @@ interface Prediction extends StreamTime {
     embeddings?: Array<PredictedEmbedding>;
     details?: Array<Map<string, any>>;
     motions?: Array<PredictedMotion>;
+    depth?: Depth;
 }
 interface PredictedClass {
     id?: number;
@@ -100,6 +101,24 @@ interface Mask {
     height: number;
     stride: number;
 }
+/**
+ * A frame-level depth map as produced by depth estimation abilities
+ * (e.g. eyepop.depth.*).
+ *
+ * `values` is the base64 encoding of width*height little-endian float32
+ * values in row-major order. The map always has the aspect ratio of the
+ * source frame; map a source coordinate (x, y) to the map proportionally:
+ * (x * width / source_width, y * height / source_height).
+ *
+ * Values are canonical metric depth (multiply by the camera's focal length
+ * in pixels and divide by 300 for meters). Sky pixels carry +Infinity.
+ * Use decodeDepthMap() to access the values.
+ */
+interface Depth {
+    width: number;
+    height: number;
+    values: string;
+}
 interface PredictedObject extends PredictedClass {
     trackId?: number;
     x: number;
@@ -1232,12 +1251,21 @@ declare class EvaluateDatasetJob {
     cancel(): void;
 }
 
+declare class EyePopDataWebSocketError extends Error {
+    readonly code = "DATA_WEBSOCKET_CONNECTION_FAILED";
+    readonly endpoint: string;
+    readonly sourceError: unknown;
+    constructor(url: string, event: unknown);
+}
 declare class DataEndpoint extends Endpoint<DataEndpoint> {
     private datasetApiUrl;
     private vlmApiUrl;
     private _accountId;
     private _ws;
     private _ws_current_reconnect_delay;
+    private _ws_reconnect_timeout;
+    private _ws_reconnect_enabled;
+    private _ws_connecting;
     private _account_event_handlers;
     private _dataset_uuid_to_event_handlers;
     constructor(options: DataOptions);
@@ -1245,6 +1273,9 @@ declare class DataEndpoint extends Endpoint<DataEndpoint> {
     disconnect(wait?: boolean): Promise<void>;
     protected reconnect(): Promise<DataEndpoint>;
     private reconnect_ws;
+    private open_ws;
+    private close_ws;
+    private schedule_ws_reconnect;
     private options;
     private request;
     listDatasets(include_stats?: boolean, modifiable_version_only?: boolean): Promise<Dataset[]>;
@@ -1320,6 +1351,40 @@ declare class DataEndpoint extends Endpoint<DataEndpoint> {
     resolveAliases(aliases: string[]): Promise<AliasResolution[]>;
 }
 
+/**
+ * A decoded frame-level depth map.
+ *
+ * Values are canonical metric depth in row-major order; sky pixels are +Infinity.
+ * See decodeDepthMap().
+ */
+declare class DepthMap {
+    readonly width: number;
+    readonly height: number;
+    readonly values: Float32Array;
+    private _finiteMin;
+    private _finiteMax;
+    constructor(width: number, height: number, values: Float32Array);
+    /**
+     * The depth value at map pixel (x, y), or - when sourceWidth/sourceHeight
+     * are given - at source frame coordinate (x, y) mapped proportionally.
+     * Returns +Infinity for sky pixels.
+     */
+    at(x: number, y: number, sourceWidth?: number, sourceHeight?: number): number;
+    isSky(x: number, y: number, sourceWidth?: number, sourceHeight?: number): boolean;
+    /** The smallest finite depth value, or undefined if the whole map is sky. */
+    get finiteMin(): number | undefined;
+    /** The largest finite depth value, or undefined if the whole map is sky. */
+    get finiteMax(): number | undefined;
+    private computeFiniteRange;
+}
+/**
+ * Decode a Prediction's `depth` member into a DepthMap.
+ *
+ * The wire format is base64 of width*height little-endian float32 values in
+ * row-major order; sky pixels are +Infinity.
+ */
+declare function decodeDepthMap(depth: Depth): DepthMap;
+
 type Bytes = string | ArrayBuffer | Uint8Array | Buffer | null | undefined;
 interface StreamEvent {
     type: string;
@@ -1498,4 +1563,4 @@ declare namespace EyePop {
     function dataEndpoint(opts?: DataOptions): DataEndpoint;
 }
 
-export { type AbilityAliasEntry, AbstractJob, type AccessTokenAuth, 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, LoadFromGroupJob, 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 MultipartContent, type MultipartPart, 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, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadGroupJob, UploadJob, type UploadSource, 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, accessTokenCredential, apiKeyCredential, EyePop as default, encodeMultipartFormData, getBaseUrl, randomMultipartBoundary, readableStreamFromString, resolveAuth };
+export { type AbilityAliasEntry, AbstractJob, type AccessTokenAuth, 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 Depth, DepthMap, type DownloadResponse, Endpoint, EndpointState, type EvaluateConfig, type EvaluateFilter, type EvaluateRequest, type EvaluateResponse, type EvaluateRunInfo, EvaluationStatus, ExportedBy, EyePop, EyePopDataWebSocketError, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferRequest, type InferRunInfo, type InferRuntimeConfig, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromGroupJob, 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 MultipartContent, type MultipartPart, 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, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadGroupJob, UploadJob, type UploadSource, 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, accessTokenCredential, apiKeyCredential, decodeDepthMap, EyePop as default, encodeMultipartFormData, getBaseUrl, randomMultipartBoundary, readableStreamFromString, resolveAuth };

package/dist/eyepop.index.d.ts

@@ -71,6 +71,7 @@ interface Prediction extends StreamTime {
     embeddings?: Array<PredictedEmbedding>;
     details?: Array<Map<string, any>>;
     motions?: Array<PredictedMotion>;
+    depth?: Depth;
 }
 interface PredictedClass {
     id?: number;
@@ -100,6 +101,24 @@ interface Mask {
     height: number;
     stride: number;
 }
+/**
+ * A frame-level depth map as produced by depth estimation abilities
+ * (e.g. eyepop.depth.*).
+ *
+ * `values` is the base64 encoding of width*height little-endian float32
+ * values in row-major order. The map always has the aspect ratio of the
+ * source frame; map a source coordinate (x, y) to the map proportionally:
+ * (x * width / source_width, y * height / source_height).
+ *
+ * Values are canonical metric depth (multiply by the camera's focal length
+ * in pixels and divide by 300 for meters). Sky pixels carry +Infinity.
+ * Use decodeDepthMap() to access the values.
+ */
+interface Depth {
+    width: number;
+    height: number;
+    values: string;
+}
 interface PredictedObject extends PredictedClass {
     trackId?: number;
     x: number;
@@ -1232,12 +1251,21 @@ declare class EvaluateDatasetJob {
     cancel(): void;
 }
 
+declare class EyePopDataWebSocketError extends Error {
+    readonly code = "DATA_WEBSOCKET_CONNECTION_FAILED";
+    readonly endpoint: string;
+    readonly sourceError: unknown;
+    constructor(url: string, event: unknown);
+}
 declare class DataEndpoint extends Endpoint<DataEndpoint> {
     private datasetApiUrl;
     private vlmApiUrl;
     private _accountId;
     private _ws;
     private _ws_current_reconnect_delay;
+    private _ws_reconnect_timeout;
+    private _ws_reconnect_enabled;
+    private _ws_connecting;
     private _account_event_handlers;
     private _dataset_uuid_to_event_handlers;
     constructor(options: DataOptions);
@@ -1245,6 +1273,9 @@ declare class DataEndpoint extends Endpoint<DataEndpoint> {
     disconnect(wait?: boolean): Promise<void>;
     protected reconnect(): Promise<DataEndpoint>;
     private reconnect_ws;
+    private open_ws;
+    private close_ws;
+    private schedule_ws_reconnect;
     private options;
     private request;
     listDatasets(include_stats?: boolean, modifiable_version_only?: boolean): Promise<Dataset[]>;
@@ -1320,6 +1351,40 @@ declare class DataEndpoint extends Endpoint<DataEndpoint> {
     resolveAliases(aliases: string[]): Promise<AliasResolution[]>;
 }
 
+/**
+ * A decoded frame-level depth map.
+ *
+ * Values are canonical metric depth in row-major order; sky pixels are +Infinity.
+ * See decodeDepthMap().
+ */
+declare class DepthMap {
+    readonly width: number;
+    readonly height: number;
+    readonly values: Float32Array;
+    private _finiteMin;
+    private _finiteMax;
+    constructor(width: number, height: number, values: Float32Array);
+    /**
+     * The depth value at map pixel (x, y), or - when sourceWidth/sourceHeight
+     * are given - at source frame coordinate (x, y) mapped proportionally.
+     * Returns +Infinity for sky pixels.
+     */
+    at(x: number, y: number, sourceWidth?: number, sourceHeight?: number): number;
+    isSky(x: number, y: number, sourceWidth?: number, sourceHeight?: number): boolean;
+    /** The smallest finite depth value, or undefined if the whole map is sky. */
+    get finiteMin(): number | undefined;
+    /** The largest finite depth value, or undefined if the whole map is sky. */
+    get finiteMax(): number | undefined;
+    private computeFiniteRange;
+}
+/**
+ * Decode a Prediction's `depth` member into a DepthMap.
+ *
+ * The wire format is base64 of width*height little-endian float32 values in
+ * row-major order; sky pixels are +Infinity.
+ */
+declare function decodeDepthMap(depth: Depth): DepthMap;
+
 type Bytes = string | ArrayBuffer | Uint8Array | Buffer | null | undefined;
 interface StreamEvent {
     type: string;
@@ -1498,4 +1563,4 @@ declare namespace EyePop {
     function dataEndpoint(opts?: DataOptions): DataEndpoint;
 }
 
-export { type AbilityAliasEntry, AbstractJob, type AccessTokenAuth, 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, LoadFromGroupJob, 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 MultipartContent, type MultipartPart, 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, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadGroupJob, UploadJob, type UploadSource, 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, accessTokenCredential, apiKeyCredential, EyePop as default, encodeMultipartFormData, getBaseUrl, randomMultipartBoundary, readableStreamFromString, resolveAuth };
+export { type AbilityAliasEntry, AbstractJob, type AccessTokenAuth, 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 Depth, DepthMap, type DownloadResponse, Endpoint, EndpointState, type EvaluateConfig, type EvaluateFilter, type EvaluateRequest, type EvaluateResponse, type EvaluateRunInfo, EvaluationStatus, ExportedBy, EyePop, EyePopDataWebSocketError, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferRequest, type InferRunInfo, type InferRuntimeConfig, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromGroupJob, 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 MultipartContent, type MultipartPart, 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, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, TaskMode, TaskType, type TimeSpan, type TrackingComponent, TranscodeMode, type TransformInto, TransientPopId, UploadGroupJob, UploadJob, type UploadSource, 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, accessTokenCredential, apiKeyCredential, decodeDepthMap, EyePop as default, encodeMultipartFormData, getBaseUrl, randomMultipartBoundary, readableStreamFromString, resolveAuth };