@eyepop.ai/eyepop 0.16.3 → 0.18.0

package/dist/eyepop.index.d.mts

@@ -44,6 +44,17 @@ interface UrlSource {
     readonly url: string;
 }
 type Source = FileSource | StreamSource | PathSource | LiveSource | UrlSource;
+interface Box {
+    readonly topLeft: Point2d;
+    readonly bottomRight: Point2d;
+}
+interface Roi {
+    readonly points: Point2d[] | undefined;
+    readonly boxes: Box[] | undefined;
+}
+interface SourceParams {
+    readonly roi: Roi | undefined;
+}
 interface StreamTime {
     timestamp: number;
     seconds: number;
@@ -65,6 +76,16 @@ interface PredictedClass {
     classLabel: string;
     category: string;
 }
+interface Contour {
+    points: Array<Point2d>;
+    cutouts: Array<Array<Point2d>>;
+}
+interface Mask {
+    bitmap: string;
+    width: number;
+    height: number;
+    stride: number;
+}
 interface PredictedObject extends PredictedClass {
     traceId: number | undefined;
     x: number;
@@ -72,12 +93,14 @@ interface PredictedObject extends PredictedClass {
     width: number;
     height: number;
     orientation: number;
-    outline: Array<Point2d>;
-    objects: Array<PredictedObject>;
-    classes: Array<PredictedClass>;
-    labels: Array<string>;
-    meshs: Array<PredictedMesh>;
-    keyPoints: Array<PredictedKeyPoints>;
+    outline: Array<Point2d> | undefined;
+    contours: Array<Contour> | undefined;
+    mask: Mask | undefined;
+    objects: Array<PredictedObject> | undefined;
+    classes: Array<PredictedClass> | undefined;
+    labels: Array<string> | undefined;
+    meshs: Array<PredictedMesh> | undefined;
+    keyPoints: Array<PredictedKeyPoints> | undefined;
 }
 interface Point2d {
     x: number;
@@ -129,12 +152,15 @@ interface OAuth2Auth {
     oAuth2: true | Auth0Options;
 }
 type Authentication = undefined | SecretKeyAuth | SessionAuth | OAuth2Auth;
+declare enum TransientPopId {
+    Transient = "transient"
+}
 interface Options {
     auth?: Authentication | undefined;
     /**
      * Defaults to process.env['EYEPOP_POP_ID'].
      */
-    popId?: string | undefined;
+    popId?: string | TransientPopId | undefined;
     /**
      * Override the default base URL for the API, e.g., "https://api.eyepop.ai/"
      *
@@ -154,6 +180,7 @@ declare class Endpoint {
     private _baseUrl;
     private _pipelineId;
     private _popName;
+    private _pipeline;
     private _client;
     private _limit;
     private _state;
@@ -167,6 +194,8 @@ declare class Endpoint {
     state(): EndpointState;
     pendingJobs(): number;
     popName(): string | null;
+    popComp(): string | null;
+    changePopComp(popComp: string): Promise<void>;
     popId(): string | null;
     onStateChanged(handler: (fromState: EndpointState, toState: EndpointState) => void): Endpoint;
     onIngressEvent(handler: (event: IngressEvent) => void): Endpoint;
@@ -175,7 +204,7 @@ declare class Endpoint {
     session(): Promise<SessionPlus>;
     liveIngress(stream: MediaStream): Promise<LiveMedia>;
     liveEgress(ingressId: string): Promise<LiveMedia>;
-    process(source: Source): Promise<ResultStream>;
+    process(source: Source, params?: SourceParams | undefined): Promise<ResultStream>;
     private startIngressWs;
     private uploadFile;
     private uploadStream;
@@ -188,10 +217,11 @@ declare class Endpoint {
     private reconnect;
     private authorizationHeader;
     private currentAccessToken;
+    private startPopLessPipeline;
 }
 
 declare namespace EyePop {
     function endpoint(opts?: Options): Endpoint;
 }
 
-export { EndpointState, EyePop, 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 StreamTime, type UrlSource, EyePop as default };
+export { type Contour, EndpointState, EyePop, 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 StreamTime, type UrlSource, EyePop as default };

package/dist/eyepop.index.d.ts

@@ -44,6 +44,17 @@ interface UrlSource {
     readonly url: string;
 }
 type Source = FileSource | StreamSource | PathSource | LiveSource | UrlSource;
+interface Box {
+    readonly topLeft: Point2d;
+    readonly bottomRight: Point2d;
+}
+interface Roi {
+    readonly points: Point2d[] | undefined;
+    readonly boxes: Box[] | undefined;
+}
+interface SourceParams {
+    readonly roi: Roi | undefined;
+}
 interface StreamTime {
     timestamp: number;
     seconds: number;
@@ -65,6 +76,16 @@ interface PredictedClass {
     classLabel: string;
     category: string;
 }
+interface Contour {
+    points: Array<Point2d>;
+    cutouts: Array<Array<Point2d>>;
+}
+interface Mask {
+    bitmap: string;
+    width: number;
+    height: number;
+    stride: number;
+}
 interface PredictedObject extends PredictedClass {
     traceId: number | undefined;
     x: number;
@@ -72,12 +93,14 @@ interface PredictedObject extends PredictedClass {
     width: number;
     height: number;
     orientation: number;
-    outline: Array<Point2d>;
-    objects: Array<PredictedObject>;
-    classes: Array<PredictedClass>;
-    labels: Array<string>;
-    meshs: Array<PredictedMesh>;
-    keyPoints: Array<PredictedKeyPoints>;
+    outline: Array<Point2d> | undefined;
+    contours: Array<Contour> | undefined;
+    mask: Mask | undefined;
+    objects: Array<PredictedObject> | undefined;
+    classes: Array<PredictedClass> | undefined;
+    labels: Array<string> | undefined;
+    meshs: Array<PredictedMesh> | undefined;
+    keyPoints: Array<PredictedKeyPoints> | undefined;
 }
 interface Point2d {
     x: number;
@@ -129,12 +152,15 @@ interface OAuth2Auth {
     oAuth2: true | Auth0Options;
 }
 type Authentication = undefined | SecretKeyAuth | SessionAuth | OAuth2Auth;
+declare enum TransientPopId {
+    Transient = "transient"
+}
 interface Options {
     auth?: Authentication | undefined;
     /**
      * Defaults to process.env['EYEPOP_POP_ID'].
      */
-    popId?: string | undefined;
+    popId?: string | TransientPopId | undefined;
     /**
      * Override the default base URL for the API, e.g., "https://api.eyepop.ai/"
      *
@@ -154,6 +180,7 @@ declare class Endpoint {
     private _baseUrl;
     private _pipelineId;
     private _popName;
+    private _pipeline;
     private _client;
     private _limit;
     private _state;
@@ -167,6 +194,8 @@ declare class Endpoint {
     state(): EndpointState;
     pendingJobs(): number;
     popName(): string | null;
+    popComp(): string | null;
+    changePopComp(popComp: string): Promise<void>;
     popId(): string | null;
     onStateChanged(handler: (fromState: EndpointState, toState: EndpointState) => void): Endpoint;
     onIngressEvent(handler: (event: IngressEvent) => void): Endpoint;
@@ -175,7 +204,7 @@ declare class Endpoint {
     session(): Promise<SessionPlus>;
     liveIngress(stream: MediaStream): Promise<LiveMedia>;
     liveEgress(ingressId: string): Promise<LiveMedia>;
-    process(source: Source): Promise<ResultStream>;
+    process(source: Source, params?: SourceParams | undefined): Promise<ResultStream>;
     private startIngressWs;
     private uploadFile;
     private uploadStream;
@@ -188,10 +217,11 @@ declare class Endpoint {
     private reconnect;
     private authorizationHeader;
     private currentAccessToken;
+    private startPopLessPipeline;
 }
 
 declare namespace EyePop {
     function endpoint(opts?: Options): Endpoint;
 }
 
-export { EndpointState, EyePop, 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 StreamTime, type UrlSource, EyePop as default };
+export { type Contour, EndpointState, EyePop, 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 StreamTime, type UrlSource, EyePop as default };

package/dist/eyepop.index.js

@@ -8927,10 +8927,11 @@ function readableStreamAsyncIterable(stream) {
 
 // jobs.ts
 var AbstractJob = class {
-  constructor(getSession, client, requestLogger) {
+  constructor(params, getSession, client, requestLogger) {
     this._responseStream = null;
     this._controller = new AbortController();
     this._getSession = getSession;
+    this._params = params ?? null;
     this._client = client;
     this._requestLogger = requestLogger;
   }
@@ -9004,36 +9005,60 @@ var UploadJob = class extends AbstractJob {
   get [Symbol.toStringTag]() {
     return "uploadJob";
   }
-  constructor(stream, mimeType, getSession, client, requestLogger) {
-    super(getSession, client, requestLogger);
+  constructor(stream, mimeType, params, getSession, client, requestLogger) {
+    super(params, getSession, client, requestLogger);
     this._uploadStream = stream;
     this._mimeType = mimeType;
   }
   async startJob() {
     const session = await this._getSession();
-    const headers = {
-      "Authorization": `Bearer ${session.accessToken}`,
-      "Accept": "application/jsonl",
-      "Content-Type": this._mimeType
-    };
     const postUrl = `${session.baseUrl.replace(/\/+$/, "")}/pipelines/${session.pipelineId}/source?mode=queue&processing=sync`;
-    this._requestLogger.debug("before POST %s with stream as body");
-    const response = await this._client.fetch(postUrl, {
-      headers,
-      method: "POST",
-      body: this._uploadStream,
-      signal: this._controller.signal,
-      // @ts-ignore
-      "duplex": "half",
-      dispatcher: this._dispatcher
-    });
-    this._requestLogger.debug("after POST %s with stream as body");
+    let response;
+    if (this._params) {
+      this._requestLogger.debug("before POST %s with multipart body because of params");
+      const params = JSON.stringify(this._params);
+      const paramBlob = new Blob([params], { type: "application/json" });
+      const formData = new FormData();
+      formData.append("params", paramBlob);
+      formData.append("file", this._uploadStream);
+      const headers = {
+        "Authorization": `Bearer ${session.accessToken}`,
+        "Accept": "application/jsonl"
+      };
+      response = await this._client.fetch(postUrl, {
+        headers,
+        method: "POST",
+        body: formData,
+        signal: this._controller.signal,
+        // @ts-ignore
+        "duplex": "half",
+        dispatcher: this._dispatcher
+      });
+      this._requestLogger.debug("after POST %s with multipart body because of params");
+    } else {
+      this._requestLogger.debug("before POST %s with stream as body");
+      const headers = {
+        "Authorization": `Bearer ${session.accessToken}`,
+        "Accept": "application/jsonl",
+        "Content-Type": this._mimeType
+      };
+      response = await this._client.fetch(postUrl, {
+        headers,
+        method: "POST",
+        body: this._uploadStream,
+        signal: this._controller.signal,
+        // @ts-ignore
+        "duplex": "half",
+        dispatcher: this._dispatcher
+      });
+      this._requestLogger.debug("after POST %s with stream as body");
+    }
     return response;
   }
 };
 var LoadFromJob = class extends AbstractJob {
-  constructor(location, getSession, client, requestLogger) {
-    super(getSession, client, requestLogger);
+  constructor(location, params, getSession, client, requestLogger) {
+    super(params, getSession, client, requestLogger);
     this._location = location;
   }
   get [Symbol.toStringTag]() {
@@ -9042,7 +9067,8 @@ var LoadFromJob = class extends AbstractJob {
   async startJob() {
     const body = {
       "sourceType": "URL",
-      "url": this._location
+      "url": this._location,
+      "params": this._params
     };
     const session = await this._getSession();
     const headers = {
@@ -9065,8 +9091,8 @@ var LoadFromJob = class extends AbstractJob {
   }
 };
 var LoadLiveIngressJob = class extends AbstractJob {
-  constructor(ingressId, getSession, client, requestLogger) {
-    super(getSession, client, requestLogger);
+  constructor(ingressId, params, getSession, client, requestLogger) {
+    super(params, getSession, client, requestLogger);
     this._ingressId = ingressId;
   }
   get [Symbol.toStringTag]() {
@@ -9075,7 +9101,8 @@ var LoadLiveIngressJob = class extends AbstractJob {
   async startJob() {
     const body = {
       "sourceType": "LIVE_INGRESS",
-      "liveIngressId": this._ingressId
+      "liveIngressId": this._ingressId,
+      "params": this._params
     };
     const session = await this._getSession();
     const headers = {
@@ -9794,6 +9821,7 @@ var Endpoint = class {
     this._expire_token_time = null;
     this._client = null;
     this._state = "Idle" /* Idle */;
+    this._pipeline = null;
     this._stateChangeHandler = null;
     this._ingressEventHandler = null;
     this._ingressEventWs = null;
@@ -9823,6 +9851,40 @@ var Endpoint = class {
   popName() {
     return this._popName;
   }
+  popComp() {
+    if (this._pipeline) {
+      return this._pipeline.inferPipeline;
+    } else {
+      return null;
+    }
+  }
+  async changePopComp(popComp) {
+    if (!this._baseUrl || !this._client) {
+      return Promise.reject("endpoint not connected, use connect() before changePopComp()");
+    }
+    const patch_url = `${this._baseUrl}/pipelines/${this._pipelineId}/inferencePipeline`;
+    const headers = {
+      "Authorization": await this.authorizationHeader(),
+      "Content-Type": "application/json"
+    };
+    const body = {
+      "pipeline": popComp
+    };
+    this._requestLogger.debug("before PATCH %s", patch_url);
+    let response = await this._client.fetch(patch_url, {
+      method: "PATCH",
+      body: JSON.stringify(body),
+      headers
+    });
+    if (response.status != 204) {
+      const message = await response.text();
+      return Promise.reject(`Unexpected status ${response.status}: ${message}`);
+    }
+    this._requestLogger.debug("after PATCH %s", patch_url);
+    if (this._pipeline) {
+      this._pipeline.inferPipeline = popComp;
+    }
+  }
   popId() {
     return this._options.popId || null;
   }
@@ -9938,17 +10000,17 @@ var Endpoint = class {
     }, this._client, this._requestLogger);
     return whep.start();
   }
-  async process(source) {
+  async process(source, params = void 0) {
     if (source.file !== void 0) {
-      return this.uploadFile(source);
+      return this.uploadFile(source, params);
     } else if (source.stream !== void 0) {
-      return this.uploadStream(source);
+      return this.uploadStream(source, params);
     } else if (source.path !== void 0) {
-      return this.uploadPath(source);
+      return this.uploadPath(source, params);
     } else if (source.url !== void 0) {
-      return this.loadFrom(source);
+      return this.loadFrom(source, params);
     } else if (source.ingressId !== void 0) {
-      return this.loadLiveIngress(source);
+      return this.loadLiveIngress(source, params);
     } else {
       return Promise.reject("unknown source type");
     }
@@ -9990,14 +10052,14 @@ var Endpoint = class {
       this.updateState();
     }
   }
-  async uploadFile(source) {
+  async uploadFile(source, params) {
     if (!this._baseUrl || !this._pipelineId || !this._client || !this._limit) {
       return Promise.reject("endpoint not connected, use connect() before upload()");
     }
     await this._limit.acquire();
     try {
       this.updateState();
-      const job = new UploadJob(source.file, source.file.type, async () => {
+      const job = new UploadJob(source.file, source.file.type, params, async () => {
         return this.session();
       }, this._client, this._requestLogger);
       return job.start(() => {
@@ -10010,14 +10072,14 @@ var Endpoint = class {
       throw e;
     }
   }
-  async uploadStream(source) {
+  async uploadStream(source, params) {
     if (!this._baseUrl || !this._pipelineId || !this._client || !this._limit) {
       return Promise.reject("endpoint not connected, use connect() before upload()");
     }
     await this._limit.acquire();
     try {
       this.updateState();
-      const job = new UploadJob(source.stream, source.mimeType, async () => {
+      const job = new UploadJob(source.stream, source.mimeType, params, async () => {
         return this.session();
       }, this._client, this._requestLogger);
       return job.start(() => {
@@ -10030,7 +10092,7 @@ var Endpoint = class {
       throw e;
     }
   }
-  async uploadPath(source) {
+  async uploadPath(source, params) {
     if (!this._baseUrl || !this._pipelineId || !this._client || !this._limit) {
       throw new Error("endpoint not connected, use connect() before process()");
     }
@@ -10038,7 +10100,7 @@ var Endpoint = class {
     try {
       this.updateState();
       const streamSource = await resolvePath(source);
-      const job = new UploadJob(streamSource.stream, streamSource.mimeType, async () => {
+      const job = new UploadJob(streamSource.stream, streamSource.mimeType, params, async () => {
         return this.session();
       }, this._client, this._requestLogger);
       return job.start(() => {
@@ -10051,14 +10113,14 @@ var Endpoint = class {
       throw e;
     }
   }
-  async loadFrom(source) {
+  async loadFrom(source, params) {
     if (!this._baseUrl || !this._pipelineId || !this._client || !this._limit) {
       throw new Error("endpoint not connected, use connect() before loadFrom()");
     }
     await this._limit.acquire();
     try {
       this.updateState();
-      const job = new LoadFromJob(source.url, async () => {
+      const job = new LoadFromJob(source.url, params, async () => {
         return this.session();
       }, this._client, this._requestLogger);
       return job.start(() => {
@@ -10071,14 +10133,14 @@ var Endpoint = class {
       throw e;
     }
   }
-  async loadLiveIngress(source) {
+  async loadLiveIngress(source, params) {
     if (!this._baseUrl || !this._pipelineId || !this._client || !this._limit) {
       throw new Error("endpoint not connected, use connect() before loadLiveIngress()");
     }
     await this._limit.acquire();
     try {
       this.updateState();
-      const job = new LoadLiveIngressJob(source.ingressId, async () => {
+      const job = new LoadLiveIngressJob(source.ingressId, params, async () => {
         return this.session();
       }, this._client, this._requestLogger);
       return job.start(() => {
@@ -10122,7 +10184,12 @@ var Endpoint = class {
     if (!this._client) {
       return Promise.reject("endpoint not initialized");
     }
-    const config_url = `${this.eyepopUrl()}/pops/${this._options.popId}/config?auto_start=false`;
+    let config_url;
+    if (this._options.popId == "transient" /* Transient */) {
+      config_url = `${this.eyepopUrl()}/workers/config`;
+    } else {
+      config_url = `${this.eyepopUrl()}/pops/${this._options.popId}/config?auto_start=false`;
+    }
     const headers = {
       "Authorization": await this.authorizationHeader()
     };
@@ -10167,13 +10234,35 @@ var Endpoint = class {
       }
       const baseUrl = new URL(config.base_url, this.eyepopUrl());
       this._baseUrl = baseUrl.toString();
-      this._pipelineId = config.pipeline_id;
-      this._popName = config.name;
+      if (this._options.popId == "transient" /* Transient */) {
+        this._pipelineId = await this.startPopLessPipeline();
+        this._popName = this._options.popId;
+      } else {
+        this._pipelineId = config.pipeline_id;
+        this._popName = config.name;
+      }
       this._requestLogger.debug("after GET %s: %s / %s", config_url, this._baseUrl, this._pipelineId);
       if (!this._pipelineId || !this._baseUrl) {
         return Promise.reject(`Pop not started`);
       }
       this._baseUrl = this._baseUrl.replace(/\/+$/, "");
+      if (this._baseUrl) {
+        const get_url = `${this._baseUrl}/pipelines/${this._pipelineId}`;
+        const headers2 = {
+          "Authorization": await this.authorizationHeader()
+        };
+        this._requestLogger.debug("before GET %s", get_url);
+        let response2 = await this._client.fetch(get_url, {
+          method: "GET",
+          headers: headers2
+        });
+        if (response2.status > 200) {
+          const message = await response2.text();
+          return Promise.reject(`Unexpected status ${response2.status}: ${message}`);
+        }
+        this._requestLogger.debug("after GET %s", get_url);
+        this._pipeline = await response2.json();
+      }
       this.updateState();
       return Promise.resolve(this);
     }
@@ -10228,6 +10317,60 @@ var Endpoint = class {
     this._logger.debug("using access token, valid for at least %d seconds", this._expire_token_time - now);
     return this._token;
   }
+  async startPopLessPipeline() {
+    if (this._client == null || this._baseUrl == null) {
+      return Promise.reject("endpoint not initialized");
+    }
+    this.updateState("StartingPop" /* StartingPop */);
+    let pipeline;
+    if (this._pipeline) {
+      pipeline = this._pipeline.inferPipeline;
+    } else {
+      pipeline = "identity";
+    }
+    const body = {
+      "inferPipelineDef": {
+        "pipeline": pipeline
+      },
+      "source": {
+        "sourceType": "NONE"
+      },
+      "idleTimeoutSeconds": 30,
+      "logging": ["out_meta"],
+      "videoOutput": "no_output"
+    };
+    const post_url = `${this._baseUrl.replace(/\/+$/, "")}/pipelines`;
+    let headers = {
+      "Content-Type": "application/json",
+      "Authorization": await this.authorizationHeader()
+    };
+    this._requestLogger.debug("before POST %s", post_url);
+    let response = await this._client.fetch(post_url, {
+      method: "POST",
+      headers,
+      body: JSON.stringify(body)
+    });
+    if (response.status == 401) {
+      this._requestLogger.debug("after GET %s: 401, about to retry with fresh access token", post_url);
+      this._token = null;
+      headers = {
+        "Content-Type": "application/json",
+        "Authorization": await this.authorizationHeader()
+      };
+      response = await this._client.fetch(post_url, {
+        method: "POST",
+        headers,
+        body: JSON.stringify(body)
+      });
+    }
+    if (response.status != 200) {
+      const message = await response.text();
+      return Promise.reject(`Unexpected status ${response.status}: ${message}`);
+    }
+    this._requestLogger.debug("after POST %s", post_url);
+    const pipelineId = (await response.json())["id"];
+    return pipelineId;
+  }
 };
 
 // index.ts