@eyepop.ai/eyepop 0.11.0 → 0.13.0

package/dist/index.d.mts

@@ -19,19 +19,32 @@ declare enum EndpointState {
     StartingPop = "StartingPop",
     Error = "Error"
 }
-interface LiveIngress {
+interface LiveMedia {
     ingressId(): string;
+    stream(): Promise<MediaStream>;
     close(): Promise<void>;
 }
 interface IngressEvent {
-    readonly ingressId?: string;
-    readonly event?: "stream-ready" | "stream-ready";
+    readonly ingressId: string;
+    readonly event: "stream-ready" | "stream-ready";
 }
-interface UploadParams {
-    readonly filePath?: string | undefined;
-    readonly file?: File | undefined;
-    readonly mimeType?: string | undefined;
+interface FileSource {
+    readonly file: File;
 }
+interface StreamSource {
+    readonly stream: ReadableStream<Uint8Array>;
+    readonly mimeType: string;
+}
+interface PathSource {
+    readonly path: string;
+}
+interface LiveSource {
+    readonly ingressId: string;
+}
+interface UrlSource {
+    readonly url: string;
+}
+type Source = FileSource | StreamSource | PathSource | LiveSource | UrlSource;
 interface Prediction {
     timestamp: number;
     seconds: number;
@@ -86,22 +99,32 @@ interface ResultStream extends AsyncIterable<Prediction> {
     cancel(): void;
 }
 
-interface Authentication {
+interface Auth0Options {
+    domain: string;
+    clientId: string;
+    audience: string;
+    scope: string;
+}
+interface SecretKeyAuth {
     /**
      * Authentication secret for server side execution.
      * Defaults to process.env['EYEPOP_SECRET_KEY'].
      */
-    secretKey?: string | undefined;
+    secretKey: string;
+}
+interface SessionAuth {
     /**
      * Temporary authentication token for client side execution.
      */
-    session?: Session | undefined;
+    session: Session;
+}
+interface OAuth2Auth {
     /**
-     * For development mode, attempt to fetch an session from a logged in EyePop user in the same browser session.
-     * Either pass the Url of the dashboard, or true fro the default url 'https://dashboard.eyepop.ai/sdkauth'
+     * For development mode, authenticate with your dashboard.eyepop.ai account
      */
-    oAuth?: true | string | undefined;
+    oAuth2: true | Auth0Options;
 }
+type Authentication = undefined | SecretKeyAuth | SessionAuth | OAuth2Auth;
 interface Options {
     auth?: Authentication | undefined;
     /**
@@ -136,27 +159,31 @@ declare class Endpoint {
     private _logger;
     private readonly _requestLogger;
     constructor(options: Options);
-    onStateChanged(handler: (fromState: EndpointState, toState: EndpointState) => void): Endpoint;
-    private startIngressWs;
-    onIngressEvent(handler: (event: IngressEvent) => void): Endpoint;
+    eyepopUrl(): string;
     state(): EndpointState;
     pendingJobs(): number;
     popName(): string | null;
     popId(): string | null;
-    session(): Promise<SessionPlus>;
-    liveIngress(stream: MediaStream): Promise<LiveIngress>;
-    upload(params: UploadParams): Promise<ResultStream>;
-    loadFrom(location: string): Promise<ResultStream>;
-    loadLiveIngress(ingressId: string): Promise<ResultStream>;
+    onStateChanged(handler: (fromState: EndpointState, toState: EndpointState) => void): Endpoint;
+    onIngressEvent(handler: (event: IngressEvent) => void): Endpoint;
     connect(): Promise<Endpoint>;
+    disconnect(wait?: boolean): Promise<void>;
+    session(): Promise<SessionPlus>;
+    liveIngress(stream: MediaStream): Promise<LiveMedia>;
+    liveEgress(ingressId: string): Promise<LiveMedia>;
+    process(source: Source): Promise<ResultStream>;
+    private startIngressWs;
+    private uploadFile;
+    private uploadStream;
+    private uploadPath;
+    private loadFrom;
+    private loadLiveIngress;
     private jobDone;
     private updateState;
     private jobStatus;
     private reconnect;
-    disconnect(wait?: boolean): Promise<void>;
-    protected authorizationHeader(): Promise<string>;
+    private authorizationHeader;
     private currentAccessToken;
-    eyepopUrl(): string;
 }
 
 declare class EyePopPlot {
@@ -179,11 +206,10 @@ declare class EyePopPlot {
 }
 
 declare class EyePopSdk {
-    static defaultAuth: {
-        secretKey: string | undefined;
-    };
+    private static readonly envSecretKey;
+    static defaultAuth: SecretKeyAuth | undefined;
     static endpoint({ auth, popId, eyepopUrl, autoStart, stopJobs, jobQueueLength, logger, ...opts }?: Options): Endpoint;
     static plot(context: CanvasRenderingContext2D): EyePopPlot;
 }
 
-export { EndpointState, EyePopSdk, type IngressEvent, type LiveIngress, type Point2d, type Point3d, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type Prediction, type ResultStream, type Session, type UploadParams, EyePopSdk as default };
+export { EndpointState, EyePopSdk, type FileSource, type IngressEvent, type LiveMedia, type LiveSource, type PathSource, type Point2d, type Point3d, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type Prediction, type ResultStream, type Session, type Source, type StreamSource, type UrlSource, EyePopSdk as default };

package/dist/index.d.ts

@@ -19,19 +19,32 @@ declare enum EndpointState {
     StartingPop = "StartingPop",
     Error = "Error"
 }
-interface LiveIngress {
+interface LiveMedia {
     ingressId(): string;
+    stream(): Promise<MediaStream>;
     close(): Promise<void>;
 }
 interface IngressEvent {
-    readonly ingressId?: string;
-    readonly event?: "stream-ready" | "stream-ready";
+    readonly ingressId: string;
+    readonly event: "stream-ready" | "stream-ready";
 }
-interface UploadParams {
-    readonly filePath?: string | undefined;
-    readonly file?: File | undefined;
-    readonly mimeType?: string | undefined;
+interface FileSource {
+    readonly file: File;
 }
+interface StreamSource {
+    readonly stream: ReadableStream<Uint8Array>;
+    readonly mimeType: string;
+}
+interface PathSource {
+    readonly path: string;
+}
+interface LiveSource {
+    readonly ingressId: string;
+}
+interface UrlSource {
+    readonly url: string;
+}
+type Source = FileSource | StreamSource | PathSource | LiveSource | UrlSource;
 interface Prediction {
     timestamp: number;
     seconds: number;
@@ -86,22 +99,32 @@ interface ResultStream extends AsyncIterable<Prediction> {
     cancel(): void;
 }
 
-interface Authentication {
+interface Auth0Options {
+    domain: string;
+    clientId: string;
+    audience: string;
+    scope: string;
+}
+interface SecretKeyAuth {
     /**
      * Authentication secret for server side execution.
      * Defaults to process.env['EYEPOP_SECRET_KEY'].
      */
-    secretKey?: string | undefined;
+    secretKey: string;
+}
+interface SessionAuth {
     /**
      * Temporary authentication token for client side execution.
      */
-    session?: Session | undefined;
+    session: Session;
+}
+interface OAuth2Auth {
     /**
-     * For development mode, attempt to fetch an session from a logged in EyePop user in the same browser session.
-     * Either pass the Url of the dashboard, or true fro the default url 'https://dashboard.eyepop.ai/sdkauth'
+     * For development mode, authenticate with your dashboard.eyepop.ai account
      */
-    oAuth?: true | string | undefined;
+    oAuth2: true | Auth0Options;
 }
+type Authentication = undefined | SecretKeyAuth | SessionAuth | OAuth2Auth;
 interface Options {
     auth?: Authentication | undefined;
     /**
@@ -136,27 +159,31 @@ declare class Endpoint {
     private _logger;
     private readonly _requestLogger;
     constructor(options: Options);
-    onStateChanged(handler: (fromState: EndpointState, toState: EndpointState) => void): Endpoint;
-    private startIngressWs;
-    onIngressEvent(handler: (event: IngressEvent) => void): Endpoint;
+    eyepopUrl(): string;
     state(): EndpointState;
     pendingJobs(): number;
     popName(): string | null;
     popId(): string | null;
-    session(): Promise<SessionPlus>;
-    liveIngress(stream: MediaStream): Promise<LiveIngress>;
-    upload(params: UploadParams): Promise<ResultStream>;
-    loadFrom(location: string): Promise<ResultStream>;
-    loadLiveIngress(ingressId: string): Promise<ResultStream>;
+    onStateChanged(handler: (fromState: EndpointState, toState: EndpointState) => void): Endpoint;
+    onIngressEvent(handler: (event: IngressEvent) => void): Endpoint;
     connect(): Promise<Endpoint>;
+    disconnect(wait?: boolean): Promise<void>;
+    session(): Promise<SessionPlus>;
+    liveIngress(stream: MediaStream): Promise<LiveMedia>;
+    liveEgress(ingressId: string): Promise<LiveMedia>;
+    process(source: Source): Promise<ResultStream>;
+    private startIngressWs;
+    private uploadFile;
+    private uploadStream;
+    private uploadPath;
+    private loadFrom;
+    private loadLiveIngress;
     private jobDone;
     private updateState;
     private jobStatus;
     private reconnect;
-    disconnect(wait?: boolean): Promise<void>;
-    protected authorizationHeader(): Promise<string>;
+    private authorizationHeader;
     private currentAccessToken;
-    eyepopUrl(): string;
 }
 
 declare class EyePopPlot {
@@ -179,11 +206,10 @@ declare class EyePopPlot {
 }
 
 declare class EyePopSdk {
-    static defaultAuth: {
-        secretKey: string | undefined;
-    };
+    private static readonly envSecretKey;
+    static defaultAuth: SecretKeyAuth | undefined;
     static endpoint({ auth, popId, eyepopUrl, autoStart, stopJobs, jobQueueLength, logger, ...opts }?: Options): Endpoint;
     static plot(context: CanvasRenderingContext2D): EyePopPlot;
 }
 
-export { EndpointState, EyePopSdk, type IngressEvent, type LiveIngress, type Point2d, type Point3d, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type Prediction, type ResultStream, type Session, type UploadParams, EyePopSdk as default };
+export { EndpointState, EyePopSdk, type FileSource, type IngressEvent, type LiveMedia, type LiveSource, type PathSource, type Point2d, type Point3d, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type Prediction, type ResultStream, type Session, type Source, type StreamSource, type UrlSource, EyePopSdk as default };