@eyepop.ai/eyepop 0.9.1 → 0.10.0

package/dist/index.d.mts

@@ -1,28 +1,29 @@
 import { Logger } from 'pino';
-import stream from 'node:stream';
 import { CanvasRenderingContext2D } from 'canvas';
 
-interface Options {
-    /**
-     * Defaults to process.env['EYEPOP_SECRET_KEY'].
-     */
-    secretKey?: string | undefined;
-    /**
-     * Defaults to process.env['EYEPOP_POP_ID'].
-     */
-    popId?: string | undefined;
-    /**
-     * Override the default base URL for the API, e.g., "https://api.eyepop.ai/"
-     *
-     * Defaults to process.env['EYEPOP_URL'].
-     */
-    eyepopUrl?: string;
-    autoStart?: boolean;
-    stopJobs?: boolean;
-    jobQueueLength?: number;
-    logger?: Logger | undefined;
+interface Session {
+    readonly eyepopUrl: string;
+    readonly popId: string;
+    readonly accessToken: string;
+    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 UploadParams {
+    readonly filePath?: string | undefined;
+    readonly file?: File | undefined;
+    readonly mimeType?: string | undefined;
 }
-
 interface Prediction {
     timestamp: number;
     seconds: number;
@@ -74,34 +75,75 @@ interface PredictedKeyPoints {
 interface PredictedKeyPoint extends Point3d, PredictedClass {
 }
 
+interface Authentication {
+    /**
+     * Authentication secret for server side execution.
+     * Defaults to process.env['EYEPOP_SECRET_KEY'].
+     */
+    secretKey?: string | undefined;
+    /**
+     * 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'].
+     */
+    popId?: string | undefined;
+    /**
+     * Override the default base URL for the API, e.g., "https://api.eyepop.ai/"
+     *
+     * Defaults to process.env['EYEPOP_URL'].
+     */
+    eyepopUrl?: string;
+    autoStart?: boolean;
+    stopJobs?: boolean;
+    jobQueueLength?: number;
+    logger?: Logger | undefined;
+}
+
 interface ResultStream extends AsyncIterable<Prediction> {
     cancel(): void;
 }
 
-interface UploadParams {
-    readonly filePath?: string | undefined;
-    readonly stream?: stream.Readable | undefined;
-    readonly mimeType?: string | undefined;
-}
 declare class Endpoint {
-    private static readonly MAX_CONNECTIONS;
     private _options;
     private _token;
     private _expire_token_time;
     private _baseUrl;
     private _pipelineId;
-    private _dispatcher;
+    private _popName;
+    private _client;
     private _limit;
+    private _state;
+    private _stateChangeHandler;
     private _logger;
-    private _requestLogger;
+    private readonly _requestLogger;
     constructor(options: Options);
+    onStateChanged(handler: (fromState: EndpointState, toState: EndpointState) => void): Endpoint;
+    state(): EndpointState;
+    pendingJobs(): number;
+    popName(): string | null;
+    popId(): string | null;
+    session(): Promise<SessionPlus>;
     upload(params: UploadParams): Promise<ResultStream>;
     loadFrom(location: string): Promise<ResultStream>;
     connect(): Promise<Endpoint>;
+    private jobDone;
+    private updateState;
+    private jobStatus;
+    private reconnect;
     disconnect(wait?: boolean): Promise<void>;
     protected authorizationHeader(): Promise<string>;
-    private accessToken;
-    private eyepopUrl;
+    private currentAccessToken;
+    eyepopUrl(): string;
 }
 
 declare class EyePopPlot {
@@ -119,13 +161,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, 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 Point2d, type Point3d, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type Prediction, type Session, type UploadParams, EyePopSdk as default };

package/dist/index.d.ts

@@ -1,28 +1,29 @@
 import { Logger } from 'pino';
-import stream from 'node:stream';
 import { CanvasRenderingContext2D } from 'canvas';
 
-interface Options {
-    /**
-     * Defaults to process.env['EYEPOP_SECRET_KEY'].
-     */
-    secretKey?: string | undefined;
-    /**
-     * Defaults to process.env['EYEPOP_POP_ID'].
-     */
-    popId?: string | undefined;
-    /**
-     * Override the default base URL for the API, e.g., "https://api.eyepop.ai/"
-     *
-     * Defaults to process.env['EYEPOP_URL'].
-     */
-    eyepopUrl?: string;
-    autoStart?: boolean;
-    stopJobs?: boolean;
-    jobQueueLength?: number;
-    logger?: Logger | undefined;
+interface Session {
+    readonly eyepopUrl: string;
+    readonly popId: string;
+    readonly accessToken: string;
+    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 UploadParams {
+    readonly filePath?: string | undefined;
+    readonly file?: File | undefined;
+    readonly mimeType?: string | undefined;
 }
-
 interface Prediction {
     timestamp: number;
     seconds: number;
@@ -74,34 +75,75 @@ interface PredictedKeyPoints {
 interface PredictedKeyPoint extends Point3d, PredictedClass {
 }
 
+interface Authentication {
+    /**
+     * Authentication secret for server side execution.
+     * Defaults to process.env['EYEPOP_SECRET_KEY'].
+     */
+    secretKey?: string | undefined;
+    /**
+     * 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'].
+     */
+    popId?: string | undefined;
+    /**
+     * Override the default base URL for the API, e.g., "https://api.eyepop.ai/"
+     *
+     * Defaults to process.env['EYEPOP_URL'].
+     */
+    eyepopUrl?: string;
+    autoStart?: boolean;
+    stopJobs?: boolean;
+    jobQueueLength?: number;
+    logger?: Logger | undefined;
+}
+
 interface ResultStream extends AsyncIterable<Prediction> {
     cancel(): void;
 }
 
-interface UploadParams {
-    readonly filePath?: string | undefined;
-    readonly stream?: stream.Readable | undefined;
-    readonly mimeType?: string | undefined;
-}
 declare class Endpoint {
-    private static readonly MAX_CONNECTIONS;
     private _options;
     private _token;
     private _expire_token_time;
     private _baseUrl;
     private _pipelineId;
-    private _dispatcher;
+    private _popName;
+    private _client;
     private _limit;
+    private _state;
+    private _stateChangeHandler;
     private _logger;
-    private _requestLogger;
+    private readonly _requestLogger;
     constructor(options: Options);
+    onStateChanged(handler: (fromState: EndpointState, toState: EndpointState) => void): Endpoint;
+    state(): EndpointState;
+    pendingJobs(): number;
+    popName(): string | null;
+    popId(): string | null;
+    session(): Promise<SessionPlus>;
     upload(params: UploadParams): Promise<ResultStream>;
     loadFrom(location: string): Promise<ResultStream>;
     connect(): Promise<Endpoint>;
+    private jobDone;
+    private updateState;
+    private jobStatus;
+    private reconnect;
     disconnect(wait?: boolean): Promise<void>;
     protected authorizationHeader(): Promise<string>;
-    private accessToken;
-    private eyepopUrl;
+    private currentAccessToken;
+    eyepopUrl(): string;
 }
 
 declare class EyePopPlot {
@@ -119,13 +161,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, 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 Point2d, type Point3d, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type Prediction, type Session, type UploadParams, EyePopSdk as default };