@eyepop.ai/eyepop 1.13.1 → 1.14.0

package/README.md

@@ -6,16 +6,27 @@ TypeScript or JavaScript language.
 ## Installation
 
 ### Node
-
+EyePop Sdk is tested with the LTS versions `node v20.11.0` and `npm v10.2.4`. Getting started with:
 ```shell
 npm install --save @eyepop.ai/eyepop
 ```
+See the [Node example folder](https://github.com/eyepop-ai/eyepop-sdk-node/blob/main/examples/node) for code examples. 
 
 ### Browser
-
+EyePop Sdk supports all model browsers and can be used with Javascript w/o any additional dependencies:  
 ```html
 <script src="https://cdn.jsdelivr.net/npm/@eyepop.ai/eyepop/dist/eyepop.min.js"></script>
 ```
+See the [Web example folder](https://github.com/eyepop-ai/eyepop-sdk-node/tree/main/examples/web/static) for code examples. 
+
+### React Native
+```shell
+npm install --save @eyepop.ai/eyepop
+```
+
+See the [ReactNative example folder](https://github.com/eyepop-ai/eyepop-sdk-node/tree/main/examples/react_native/upload-example) for code 
+examples and tips for to debug your configuration. 
+
 
 ## Configuration
 

package/dist/eyepop.index.d.mts

@@ -286,21 +286,22 @@ declare enum VideoMode {
 }
 interface IngressEvent {
     readonly ingressId: string;
-    readonly event: 'stream-ready' | 'stream-ready';
+    readonly event: 'stream-ready' | 'stream-not-ready';
 }
 interface FileSource {
     readonly file: File;
-    readonly videoMode?: VideoMode;
+    readonly videoMode?: VideoMode | undefined;
 }
 interface StreamSource {
     readonly stream: ReadableStream<Uint8Array> | Blob | BufferSource;
     readonly mimeType: string;
-    readonly videoMode?: VideoMode;
+    readonly size?: number | undefined;
+    readonly videoMode?: VideoMode | undefined;
 }
 interface PathSource {
     readonly path: string;
-    readonly mimeType?: string;
-    readonly videoMode?: VideoMode;
+    readonly mimeType?: string | undefined;
+    readonly videoMode?: VideoMode | undefined;
 }
 interface LiveSource {
     readonly ingressId: string;
@@ -801,6 +802,7 @@ declare class DataEndpoint extends Endpoint<DataEndpoint> {
     private dispatchChangeEvent;
 }
 
+type Bytes = string | ArrayBuffer | Uint8Array | Buffer | null | undefined;
 interface StreamEvent {
     type: string;
     source_id?: string;
@@ -818,6 +820,23 @@ declare class Stream<Prediction> implements AsyncIterable<Prediction> {
      */
     tee(): [Stream<Prediction>, Stream<Prediction>];
 }
+/**
+ * A re-implementation of httpx's `LineDecoder` in Python that handles incrementally
+ * reading lines from text.
+ *
+ * https://github.com/encode/httpx/blob/920333ea98118e9cf617f246905d7b202510941c/httpx/_decoders.py#L258
+ */
+declare class EyepopLineDecoder {
+    static NEWLINE_CHARS: Set<string>;
+    static NEWLINE_REGEXP: RegExp;
+    buffer: string[];
+    trailingCR: boolean;
+    textDecoder: any;
+    constructor();
+    decode(chunk: Bytes): string[];
+    decodeText(bytes: Bytes): string;
+    flush(): string[];
+}
 
 declare class AbstractJob implements ResultStream {
     protected _getSession: () => Promise<WorkerSession>;
@@ -837,10 +856,11 @@ declare class AbstractJob implements ResultStream {
 declare class UploadJob extends AbstractJob {
     private readonly _uploadStream;
     private readonly _mimeType;
+    private readonly _size;
     private readonly _needsFullDuplex;
     private readonly _videoMode;
     get [Symbol.toStringTag](): string;
-    constructor(stream: ReadableStream<Uint8Array> | Blob | BufferSource, mimeType: string, videoMode: VideoMode | undefined, params: SourceParams | undefined, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
+    constructor(stream: ReadableStream<Uint8Array> | Blob | BufferSource, mimeType: string, size: number | undefined, videoMode: VideoMode | undefined, params: SourceParams | undefined, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
     protected onEvent(event: StreamEvent): Promise<void>;
     protected startJob(): Promise<Response>;
 }
@@ -920,4 +940,4 @@ declare namespace EyePop {
     function dataEndpoint(opts?: DataOptions): DataEndpoint;
 }
 
-export { AbstractJob, type Annotation, AnnotationType, ArtifactType, type Asset, type AssetImport, AssetStatus, type Auth0Options, type Authentication, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateTask, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, ExportedBy, EyePop, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type LocalAuth, type Mask, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelInstanceDef, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type PredictedText, type Prediction, type QcAiHubExportParams, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamEvent, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };
+export { AbstractJob, type Annotation, AnnotationType, ArtifactType, type Asset, type AssetImport, AssetStatus, type Auth0Options, type Authentication, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateTask, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, ExportedBy, EyePop, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type LocalAuth, type Mask, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelInstanceDef, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type PredictedText, type Prediction, type QcAiHubExportParams, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamEvent, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };

package/dist/eyepop.index.d.ts

@@ -286,21 +286,22 @@ declare enum VideoMode {
 }
 interface IngressEvent {
     readonly ingressId: string;
-    readonly event: 'stream-ready' | 'stream-ready';
+    readonly event: 'stream-ready' | 'stream-not-ready';
 }
 interface FileSource {
     readonly file: File;
-    readonly videoMode?: VideoMode;
+    readonly videoMode?: VideoMode | undefined;
 }
 interface StreamSource {
     readonly stream: ReadableStream<Uint8Array> | Blob | BufferSource;
     readonly mimeType: string;
-    readonly videoMode?: VideoMode;
+    readonly size?: number | undefined;
+    readonly videoMode?: VideoMode | undefined;
 }
 interface PathSource {
     readonly path: string;
-    readonly mimeType?: string;
-    readonly videoMode?: VideoMode;
+    readonly mimeType?: string | undefined;
+    readonly videoMode?: VideoMode | undefined;
 }
 interface LiveSource {
     readonly ingressId: string;
@@ -801,6 +802,7 @@ declare class DataEndpoint extends Endpoint<DataEndpoint> {
     private dispatchChangeEvent;
 }
 
+type Bytes = string | ArrayBuffer | Uint8Array | Buffer | null | undefined;
 interface StreamEvent {
     type: string;
     source_id?: string;
@@ -818,6 +820,23 @@ declare class Stream<Prediction> implements AsyncIterable<Prediction> {
      */
     tee(): [Stream<Prediction>, Stream<Prediction>];
 }
+/**
+ * A re-implementation of httpx's `LineDecoder` in Python that handles incrementally
+ * reading lines from text.
+ *
+ * https://github.com/encode/httpx/blob/920333ea98118e9cf617f246905d7b202510941c/httpx/_decoders.py#L258
+ */
+declare class EyepopLineDecoder {
+    static NEWLINE_CHARS: Set<string>;
+    static NEWLINE_REGEXP: RegExp;
+    buffer: string[];
+    trailingCR: boolean;
+    textDecoder: any;
+    constructor();
+    decode(chunk: Bytes): string[];
+    decodeText(bytes: Bytes): string;
+    flush(): string[];
+}
 
 declare class AbstractJob implements ResultStream {
     protected _getSession: () => Promise<WorkerSession>;
@@ -837,10 +856,11 @@ declare class AbstractJob implements ResultStream {
 declare class UploadJob extends AbstractJob {
     private readonly _uploadStream;
     private readonly _mimeType;
+    private readonly _size;
     private readonly _needsFullDuplex;
     private readonly _videoMode;
     get [Symbol.toStringTag](): string;
-    constructor(stream: ReadableStream<Uint8Array> | Blob | BufferSource, mimeType: string, videoMode: VideoMode | undefined, params: SourceParams | undefined, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
+    constructor(stream: ReadableStream<Uint8Array> | Blob | BufferSource, mimeType: string, size: number | undefined, videoMode: VideoMode | undefined, params: SourceParams | undefined, getSession: () => Promise<WorkerSession>, client: HttpClient, requestLogger: Logger);
     protected onEvent(event: StreamEvent): Promise<void>;
     protected startJob(): Promise<Response>;
 }
@@ -920,4 +940,4 @@ declare namespace EyePop {
     function dataEndpoint(opts?: DataOptions): DataEndpoint;
 }
 
-export { AbstractJob, type Annotation, AnnotationType, ArtifactType, type Asset, type AssetImport, AssetStatus, type Auth0Options, type Authentication, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateTask, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, ExportedBy, EyePop, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type LocalAuth, type Mask, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelInstanceDef, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type PredictedText, type Prediction, type QcAiHubExportParams, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamEvent, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };
+export { AbstractJob, type Annotation, AnnotationType, ArtifactType, type Asset, type AssetImport, AssetStatus, type Auth0Options, type Authentication, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateTask, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, ExportedBy, EyePop, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type LocalAuth, type Mask, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelInstanceDef, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type PredictedText, type Prediction, type QcAiHubExportParams, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamEvent, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };