don't harmonize clients

Author: ianardee

docs/code_samples/default_v2.txt

@@ -10,7 +10,7 @@ const modelId = "MY_MODEL_ID";
 const mindeeClient = new mindee.ClientV2({ apiKey: apiKey });
 
 // Load a file from disk
-const inputSource = mindeeClient.docFromPath(filePath);
+const inputSource = mindeeClient.sourceFromPath(filePath);
 const params = {
   modelId: modelId,
   // If set to `true`, will enable Retrieval-Augmented Generation.

src/baseClient.ts

@@ -21,7 +21,8 @@ import { setTimeout } from "node:timers/promises";
 import { MindeeError } from "./errors";
 import { WorkflowResponse } from "./parsing/common/workflowResponse";
 import { WorkflowEndpoint } from "./http/workflowEndpoint";
-import { BaseClient } from "./baseClient";
+import { Base64Input, BufferInput, BytesInput, PathInput, StreamInput, UrlInput } from "./input";
+import { Readable } from "stream";
 
 /**
  * Common options for workflows & predictions.
@@ -129,7 +130,7 @@ export interface ClientOptions {
  *
  * @category Client
  */
-export class Client extends BaseClient {
+export class Client {
   /** Key of the API. */
   protected apiKey: string;
 
@@ -143,7 +144,6 @@ export class Client extends BaseClient {
       debug: false,
     }
   ) {
-    super();
     this.apiKey = apiKey ? apiKey : "";
     errorHandler.throwOnError = throwOnError ?? true;
     logger.level =
@@ -565,4 +565,72 @@ Job status: ${pollResults.job.status}.`
     InferenceFactory.getEndpoint(productClass);
     return [endpointName, endpointVersion];
   }
+
+  /**
+   * Load an input document from a local path.
+   * @param inputPath
+   */
+  docFromPath(inputPath: string): PathInput {
+    return new PathInput({
+      inputPath: inputPath,
+    });
+  }
+
+  /**
+   * Load an input document from a base64 encoded string.
+   * @param inputString input content, as a string.
+   * @param filename file name.
+   */
+  docFromBase64(inputString: string, filename: string): Base64Input {
+    return new Base64Input({
+      inputString: inputString,
+      filename: filename,
+    });
+  }
+
+  /**
+   * Load an input document from a `stream.Readable` object.
+   * @param inputStream input content, as a readable stream.
+   * @param filename file name.
+   */
+  docFromStream(inputStream: Readable, filename: string): StreamInput {
+    return new StreamInput({
+      inputStream: inputStream,
+      filename: filename,
+    });
+  }
+
+  /**
+   * Load an input document from bytes.
+   * @param inputBytes input content, as a Uint8Array or Buffer.
+   * @param filename file name.
+   */
+  docFromBytes(inputBytes: Uint8Array, filename: string): BytesInput {
+    return new BytesInput({
+      inputBytes: inputBytes,
+      filename: filename,
+    });
+  }
+
+  /**
+   * Load an input document from a URL.
+   * @param url input url. Must be HTTPS.
+   */
+  docFromUrl(url: string): UrlInput {
+    return new UrlInput({
+      url: url,
+    });
+  }
+
+  /**
+   * Load an input document from a Buffer.
+   * @param buffer input content, as a buffer.
+   * @param filename file name.
+   */
+  docFromBuffer(buffer: Buffer, filename: string): BufferInput {
+    return new BufferInput({
+      buffer: buffer,
+      filename: filename,
+    });
+  }
 }

src/client.ts

@@ -1,14 +1,15 @@
 import {
-  LocalInputSource,
+  Base64Input, BufferInput, BytesInput,
+  LocalInputSource, PathInput, StreamInput, UrlInput,
 } from "./input";
 import { errorHandler } from "./errors/handler";
 import { LOG_LEVELS, logger } from "./logger";
 
 import { setTimeout } from "node:timers/promises";
 import { ErrorResponse, InferenceResponse, JobResponse } from "./parsing/v2";
 import { MindeeApiV2 } from "./http/mindeeApiV2";
-import { BaseClient } from "./baseClient";
 import { MindeeHttpErrorV2 } from "./errors/mindeeError";
+import { Readable } from "stream";
 
 /**
  * Parameters for the internal polling loop in {@link ClientV2.enqueueAndGetInference | enqueueAndGetInference()} .
@@ -122,7 +123,7 @@ export interface ClientOptions {
  *
  * @category ClientV2
  */
-export class ClientV2 extends BaseClient {
+export class ClientV2 {
   /** Key of the API. */
   protected mindeeApi: MindeeApiV2;
 
@@ -136,7 +137,6 @@ export class ClientV2 extends BaseClient {
       debug: false,
     }
   ) {
-    super();
     this.mindeeApi = new MindeeApiV2(apiKey);
     errorHandler.throwOnError = throwOnError ?? true;
     logger.level =
@@ -283,4 +283,72 @@ Job status: ${pollResults.job.status}.`
       " seconds"
     );
   }
+
+  /**
+   * Load an input document from a local path.
+   * @param inputPath
+   */
+  sourceFromPath(inputPath: string): PathInput {
+    return new PathInput({
+      inputPath: inputPath,
+    });
+  }
+
+  /**
+   * Load an input document from a base64 encoded string.
+   * @param inputString input content, as a string.
+   * @param filename file name.
+   */
+  sourceFromBase64(inputString: string, filename: string): Base64Input {
+    return new Base64Input({
+      inputString: inputString,
+      filename: filename,
+    });
+  }
+
+  /**
+   * Load an input document from a `stream.Readable` object.
+   * @param inputStream input content, as a readable stream.
+   * @param filename file name.
+   */
+  sourceFromStream(inputStream: Readable, filename: string): StreamInput {
+    return new StreamInput({
+      inputStream: inputStream,
+      filename: filename,
+    });
+  }
+
+  /**
+   * Load an input document from bytes.
+   * @param inputBytes input content, as a Uint8Array or Buffer.
+   * @param filename file name.
+   */
+  sourceFromBytes(inputBytes: Uint8Array, filename: string): BytesInput {
+    return new BytesInput({
+      inputBytes: inputBytes,
+      filename: filename,
+    });
+  }
+
+  /**
+   * Load an input document from a Buffer.
+   * @param buffer input content, as a buffer.
+   * @param filename file name.
+   */
+  sourceFromBuffer(buffer: Buffer, filename: string): BufferInput {
+    return new BufferInput({
+      buffer: buffer,
+      filename: filename,
+    });
+  }
+
+  /**
+   * Load an input document from a URL.
+   * @param url input url. Must be HTTPS.
+   */
+  sourceFromUrl(url: string): UrlInput {
+    return new UrlInput({
+      url: url,
+    });
+  }
 }

src/clientV2.ts

@@ -78,7 +78,7 @@ describe("ClientV2", () => {
 
     it("enqueue(path) rejects with MindeeHttpErrorV2 on 4xx", async () => {
       const filePath = path.join(fileTypesDir, "receipt.jpg");
-      const inputDoc = client.docFromPath(filePath);
+      const inputDoc = client.sourceFromPath(filePath);
 
       await assert.rejects(
         client.enqueueInference(inputDoc, { modelId: "dummy-model" }),
@@ -88,7 +88,7 @@ describe("ClientV2", () => {
 
     it("enqueueAndParse(path) rejects with MindeeHttpErrorV2 on 4xx", async () => {
       const filePath = path.join(fileTypesDir, "receipt.jpg");
-      const inputDoc = client.docFromPath(filePath);
+      const inputDoc = client.sourceFromPath(filePath);
       await assert.rejects(
         client.enqueueAndGetInference(
           inputDoc,