@eyepop.ai/eyepop 0.9.2 → 0.11.0

package/dist/eyepop.min.js.LICENSE.txt

@@ -0,0 +1,36 @@
+/*!
+ * The buffer module from node.js, for the browser.
+ *
+ * @author   Feross Aboukhadijeh <feross@feross.org> <http://feross.org>
+ * @license  MIT
+ */
+
+/*!
+ * The buffer module from node.js, for the browser.
+ *
+ * @author   Feross Aboukhadijeh <https://feross.org>
+ * @license  MIT
+ */
+
+/*! Bundled license information:
+
+mime-db/index.js:
+  (*!
+   * mime-db
+   * Copyright(c) 2014 Jonathan Ong
+   * Copyright(c) 2015-2022 Douglas Christopher Wilson
+   * MIT Licensed
+   *)
+
+mime-types/index.js:
+  (*!
+   * mime-types
+   * Copyright(c) 2014 Jonathan Ong
+   * Copyright(c) 2015 Douglas Christopher Wilson
+   * MIT Licensed
+   *)
+*/
+
+/*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> */
+
+/*! safe-buffer. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */

package/dist/index.d.mts

@@ -2,8 +2,30 @@ import { Logger } from 'pino';
 import { CanvasRenderingContext2D } from 'canvas';
 
 interface Session {
+    readonly eyepopUrl: string;
+    readonly popId: string;
     readonly accessToken: string;
-    readonly validUntil: Date;
+    readonly validUntil: number;
+}
+interface SessionPlus extends Session {
+    readonly baseUrl: string;
+    readonly pipelineId: string;
+}
+declare enum EndpointState {
+    Idle = "Idle",
+    Busy = "Busy",
+    Authenticating = "Authenticating",
+    FetchConfig = "FetchConfig",
+    StartingPop = "StartingPop",
+    Error = "Error"
+}
+interface LiveIngress {
+    ingressId(): string;
+    close(): Promise<void>;
+}
+interface IngressEvent {
+    readonly ingressId?: string;
+    readonly event?: "stream-ready" | "stream-ready";
 }
 interface UploadParams {
     readonly filePath?: string | undefined;
@@ -60,8 +82,11 @@ interface PredictedKeyPoints {
 }
 interface PredictedKeyPoint extends Point3d, PredictedClass {
 }
+interface ResultStream extends AsyncIterable<Prediction> {
+    cancel(): void;
+}
 
-interface Options {
+interface Authentication {
     /**
      * Authentication secret for server side execution.
      * Defaults to process.env['EYEPOP_SECRET_KEY'].
@@ -71,6 +96,14 @@ interface Options {
      * Temporary authentication token for client side execution.
      */
     session?: Session | undefined;
+    /**
+     * 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'
+     */
+    oAuth?: true | string | undefined;
+}
+interface Options {
+    auth?: Authentication | undefined;
     /**
      * Defaults to process.env['EYEPOP_POP_ID'].
      */
@@ -87,10 +120,6 @@ interface Options {
     logger?: Logger | undefined;
 }
 
-interface ResultStream extends AsyncIterable<Prediction> {
-    cancel(): void;
-}
-
 declare class Endpoint {
     private _options;
     private _token;
@@ -100,18 +129,34 @@ declare class Endpoint {
     private _popName;
     private _client;
     private _limit;
+    private _state;
+    private _stateChangeHandler;
+    private _ingressEventHandler;
+    private _ingressEventWs;
     private _logger;
     private readonly _requestLogger;
     constructor(options: Options);
+    onStateChanged(handler: (fromState: EndpointState, toState: EndpointState) => void): Endpoint;
+    private startIngressWs;
+    onIngressEvent(handler: (event: IngressEvent) => void): Endpoint;
+    state(): EndpointState;
+    pendingJobs(): number;
     popName(): string | null;
-    session(): Promise<Session>;
+    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>;
     connect(): Promise<Endpoint>;
+    private jobDone;
+    private updateState;
+    private jobStatus;
+    private reconnect;
     disconnect(wait?: boolean): Promise<void>;
     protected authorizationHeader(): Promise<string>;
     private currentAccessToken;
-    private eyepopUrl;
+    eyepopUrl(): string;
 }
 
 declare class EyePopPlot {
@@ -129,13 +174,16 @@ declare class EyePopPlot {
         blank_color: string;
     };
     prediction(p: Prediction): void;
-    object(obj: PredictedObject): void;
+    object(obj: PredictedObject, x_scale?: number, y_scale?: number): void;
     static toTitleCase(str: string): string;
 }
 
 declare class EyePopSdk {
-    static endpoint({ secretKey, session, popId, eyepopUrl, autoStart, stopJobs, jobQueueLength, logger, ...opts }?: Options): Endpoint;
+    static defaultAuth: {
+        secretKey: string | undefined;
+    };
+    static endpoint({ auth, popId, eyepopUrl, autoStart, stopJobs, jobQueueLength, logger, ...opts }?: Options): Endpoint;
     static plot(context: CanvasRenderingContext2D): EyePopPlot;
 }
 
-export { EyePopSdk };
+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 };

package/dist/index.d.ts

@@ -2,8 +2,30 @@ import { Logger } from 'pino';
 import { CanvasRenderingContext2D } from 'canvas';
 
 interface Session {
+    readonly eyepopUrl: string;
+    readonly popId: string;
     readonly accessToken: string;
-    readonly validUntil: Date;
+    readonly validUntil: number;
+}
+interface SessionPlus extends Session {
+    readonly baseUrl: string;
+    readonly pipelineId: string;
+}
+declare enum EndpointState {
+    Idle = "Idle",
+    Busy = "Busy",
+    Authenticating = "Authenticating",
+    FetchConfig = "FetchConfig",
+    StartingPop = "StartingPop",
+    Error = "Error"
+}
+interface LiveIngress {
+    ingressId(): string;
+    close(): Promise<void>;
+}
+interface IngressEvent {
+    readonly ingressId?: string;
+    readonly event?: "stream-ready" | "stream-ready";
 }
 interface UploadParams {
     readonly filePath?: string | undefined;
@@ -60,8 +82,11 @@ interface PredictedKeyPoints {
 }
 interface PredictedKeyPoint extends Point3d, PredictedClass {
 }
+interface ResultStream extends AsyncIterable<Prediction> {
+    cancel(): void;
+}
 
-interface Options {
+interface Authentication {
     /**
      * Authentication secret for server side execution.
      * Defaults to process.env['EYEPOP_SECRET_KEY'].
@@ -71,6 +96,14 @@ interface Options {
      * Temporary authentication token for client side execution.
      */
     session?: Session | undefined;
+    /**
+     * 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'
+     */
+    oAuth?: true | string | undefined;
+}
+interface Options {
+    auth?: Authentication | undefined;
     /**
      * Defaults to process.env['EYEPOP_POP_ID'].
      */
@@ -87,10 +120,6 @@ interface Options {
     logger?: Logger | undefined;
 }
 
-interface ResultStream extends AsyncIterable<Prediction> {
-    cancel(): void;
-}
-
 declare class Endpoint {
     private _options;
     private _token;
@@ -100,18 +129,34 @@ declare class Endpoint {
     private _popName;
     private _client;
     private _limit;
+    private _state;
+    private _stateChangeHandler;
+    private _ingressEventHandler;
+    private _ingressEventWs;
     private _logger;
     private readonly _requestLogger;
     constructor(options: Options);
+    onStateChanged(handler: (fromState: EndpointState, toState: EndpointState) => void): Endpoint;
+    private startIngressWs;
+    onIngressEvent(handler: (event: IngressEvent) => void): Endpoint;
+    state(): EndpointState;
+    pendingJobs(): number;
     popName(): string | null;
-    session(): Promise<Session>;
+    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>;
     connect(): Promise<Endpoint>;
+    private jobDone;
+    private updateState;
+    private jobStatus;
+    private reconnect;
     disconnect(wait?: boolean): Promise<void>;
     protected authorizationHeader(): Promise<string>;
     private currentAccessToken;
-    private eyepopUrl;
+    eyepopUrl(): string;
 }
 
 declare class EyePopPlot {
@@ -129,13 +174,16 @@ declare class EyePopPlot {
         blank_color: string;
     };
     prediction(p: Prediction): void;
-    object(obj: PredictedObject): void;
+    object(obj: PredictedObject, x_scale?: number, y_scale?: number): void;
     static toTitleCase(str: string): string;
 }
 
 declare class EyePopSdk {
-    static endpoint({ secretKey, session, popId, eyepopUrl, autoStart, stopJobs, jobQueueLength, logger, ...opts }?: Options): Endpoint;
+    static defaultAuth: {
+        secretKey: string | undefined;
+    };
+    static endpoint({ auth, popId, eyepopUrl, autoStart, stopJobs, jobQueueLength, logger, ...opts }?: Options): Endpoint;
     static plot(context: CanvasRenderingContext2D): EyePopPlot;
 }
 
-export { EyePopSdk };
+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 };