@kadoa/node-sdk 0.5.0 → 0.7.0

package/README.md

@@ -93,16 +93,29 @@ client.onEvent((event) => {
 - `timeout` (optional): Request timeout in milliseconds (default: 30000)
 
 Returns a client instance with:
-- `extraction`: Extraction module with `run()` method
+- `extraction`: Extraction module with `run()`, `submit()`, `fetchData()` methods
+- `workflow`: Workflow module with `get()`, `submit()`, `cancel()`, `wait()` methods
 - `onEvent()`: Subscribe to events
 - `offEvent()`: Unsubscribe from events
 - `dispose()`: Releases resources and removes all event listeners
 
 ### client.extraction.run(options)
+Runs extraction and waits for completion.
 - `urls`: Array of URLs to extract from
 - `name`: Workflow name
 - Additional options available in API documentation
 
+### client.extraction.submit(options)
+Submits extraction without waiting for completion.
+- `urls`: Array of URLs to extract from
+- `name`: Workflow name
+- Returns: `{ workflowId: string }`
+
+### client.workflow.get(workflowId)
+Gets the current status of a workflow.
+- `workflowId`: The workflow ID to query
+- Returns: Workflow status object
+
 ## Examples
 
 See [examples directory](https://github.com/kadoa-org/kadoa-sdks/tree/main/examples/node-examples) for more usage examples.

package/dist/index.d.mts

@@ -1282,6 +1282,7 @@ declare const V4WorkflowsGet200ResponseWorkflowsInnerSchemaInnerDataTypeEnum: {
     readonly Date: "DATE";
     readonly Datetime: "DATETIME";
     readonly Currency: "CURRENCY";
+    readonly Money: "MONEY";
     readonly Image: "IMAGE";
     readonly Link: "LINK";
     readonly Object: "OBJECT";
@@ -1726,6 +1727,7 @@ declare const WorkflowWithCustomSchemaFieldsInnerDataTypeEnum: {
     readonly Date: "DATE";
     readonly Datetime: "DATETIME";
     readonly Currency: "CURRENCY";
+    readonly Money: "MONEY";
     readonly Image: "IMAGE";
     readonly Link: "LINK";
     readonly Object: "OBJECT";
@@ -5125,11 +5127,14 @@ type ExtractionOptions = {
     urls: string[];
 } & Partial<Omit<ExtractionConfig, "urls">>;
 interface ExtractionResult {
-    workflowId: string | undefined;
+    workflowId: string;
     workflow?: V4WorkflowsWorkflowIdGet200Response;
     data?: Array<object>;
     pagination?: PageInfo;
 }
+interface SubmitExtractionResult {
+    workflowId: string;
+}
 
 type DataPagination = V4WorkflowsWorkflowIdDataGet200ResponsePagination;
 type WorkflowDataResponse = V4WorkflowsWorkflowIdDataGet200Response;
@@ -5165,6 +5170,7 @@ declare class ExtractionModule {
      * ```
      */
     run(options: ExtractionOptions): Promise<ExtractionResult>;
+    submit(options: ExtractionOptions): Promise<SubmitExtractionResult>;
     /**
      * Fetch paginated data from a workflow
      *
@@ -5217,6 +5223,33 @@ declare class ExtractionModule {
     fetchDataPages(options: FetchDataOptions): AsyncGenerator<FetchDataResult, void, unknown>;
 }
 
+interface CreateWorkflowInput {
+    urls: string[];
+    navigationMode: string;
+    name: string;
+    entity?: string;
+    fields?: Array<WorkflowWithCustomSchemaFieldsInner>;
+    tags?: string[];
+}
+
+interface SubmitOptions {
+    idempotencyKey?: string;
+}
+interface WaitOptions {
+    pollIntervalMs?: number;
+    timeoutMs?: number;
+}
+declare class WorkflowsModule {
+    private readonly core;
+    constructor(client: KadoaClient);
+    submit(input: CreateWorkflowInput, options?: SubmitOptions): Promise<{
+        workflowId: string;
+    }>;
+    get(workflowId: string): Promise<V4WorkflowsWorkflowIdGet200Response>;
+    cancel(workflowId: string): Promise<void>;
+    wait(workflowId: string, options?: WaitOptions): Promise<V4WorkflowsWorkflowIdGet200Response>;
+}
+
 interface KadoaClientConfig {
     apiKey: string;
     baseUrl?: string;
@@ -5252,6 +5285,7 @@ declare class KadoaClient implements ApiProvider {
     private readonly _workflowsApi;
     private readonly _crawlApi;
     readonly extraction: ExtractionModule;
+    readonly workflow: WorkflowsModule;
     constructor(config: KadoaClientConfig);
     /**
      * Register an event listener

package/dist/index.d.ts

@@ -1282,6 +1282,7 @@ declare const V4WorkflowsGet200ResponseWorkflowsInnerSchemaInnerDataTypeEnum: {
     readonly Date: "DATE";
     readonly Datetime: "DATETIME";
     readonly Currency: "CURRENCY";
+    readonly Money: "MONEY";
     readonly Image: "IMAGE";
     readonly Link: "LINK";
     readonly Object: "OBJECT";
@@ -1726,6 +1727,7 @@ declare const WorkflowWithCustomSchemaFieldsInnerDataTypeEnum: {
     readonly Date: "DATE";
     readonly Datetime: "DATETIME";
     readonly Currency: "CURRENCY";
+    readonly Money: "MONEY";
     readonly Image: "IMAGE";
     readonly Link: "LINK";
     readonly Object: "OBJECT";
@@ -5125,11 +5127,14 @@ type ExtractionOptions = {
     urls: string[];
 } & Partial<Omit<ExtractionConfig, "urls">>;
 interface ExtractionResult {
-    workflowId: string | undefined;
+    workflowId: string;
     workflow?: V4WorkflowsWorkflowIdGet200Response;
     data?: Array<object>;
     pagination?: PageInfo;
 }
+interface SubmitExtractionResult {
+    workflowId: string;
+}
 
 type DataPagination = V4WorkflowsWorkflowIdDataGet200ResponsePagination;
 type WorkflowDataResponse = V4WorkflowsWorkflowIdDataGet200Response;
@@ -5165,6 +5170,7 @@ declare class ExtractionModule {
      * ```
      */
     run(options: ExtractionOptions): Promise<ExtractionResult>;
+    submit(options: ExtractionOptions): Promise<SubmitExtractionResult>;
     /**
      * Fetch paginated data from a workflow
      *
@@ -5217,6 +5223,33 @@ declare class ExtractionModule {
     fetchDataPages(options: FetchDataOptions): AsyncGenerator<FetchDataResult, void, unknown>;
 }
 
+interface CreateWorkflowInput {
+    urls: string[];
+    navigationMode: string;
+    name: string;
+    entity?: string;
+    fields?: Array<WorkflowWithCustomSchemaFieldsInner>;
+    tags?: string[];
+}
+
+interface SubmitOptions {
+    idempotencyKey?: string;
+}
+interface WaitOptions {
+    pollIntervalMs?: number;
+    timeoutMs?: number;
+}
+declare class WorkflowsModule {
+    private readonly core;
+    constructor(client: KadoaClient);
+    submit(input: CreateWorkflowInput, options?: SubmitOptions): Promise<{
+        workflowId: string;
+    }>;
+    get(workflowId: string): Promise<V4WorkflowsWorkflowIdGet200Response>;
+    cancel(workflowId: string): Promise<void>;
+    wait(workflowId: string, options?: WaitOptions): Promise<V4WorkflowsWorkflowIdGet200Response>;
+}
+
 interface KadoaClientConfig {
     apiKey: string;
     baseUrl?: string;
@@ -5252,6 +5285,7 @@ declare class KadoaClient implements ApiProvider {
     private readonly _workflowsApi;
     private readonly _crawlApi;
     readonly extraction: ExtractionModule;
+    readonly workflow: WorkflowsModule;
     constructor(config: KadoaClientConfig);
     /**
      * Register an event listener

package/dist/index.js

@@ -3,12 +3,13 @@
 var events = require('events');
 var globalAxios3 = require('axios');
 var url = require('url');
+var esToolkit = require('es-toolkit');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var globalAxios3__default = /*#__PURE__*/_interopDefault(globalAxios3);
 
-// src/core/events/event-emitter.ts
+// src/internal/runtime/events/event-emitter.ts
 var KadoaEventEmitter = class extends events.EventEmitter {
   /**
    * Emit a typed SDK event
@@ -49,7 +50,7 @@ var KadoaEventEmitter = class extends events.EventEmitter {
   }
 };
 
-// src/core/exceptions/base.exception.ts
+// src/internal/runtime/exceptions/base.exception.ts
 var _KadoaSdkException = class _KadoaSdkException extends Error {
   constructor(message, options) {
     super(message);
@@ -2276,11 +2277,11 @@ var Configuration = class {
   }
 };
 
-// src/core/patterns/command.ts
+// src/internal/runtime/patterns/command.ts
 var Command = class {
 };
 
-// src/core/pagination/paginator.ts
+// src/internal/runtime/pagination/paginator.ts
 var PagedIterator = class {
   constructor(fetchPage) {
     this.fetchPage = fetchPage;
@@ -2400,7 +2401,7 @@ var FetchDataQuery = class {
   }
 };
 
-// src/core/config/constants.ts
+// src/internal/runtime/config/constants.ts
 var DEFAULT_API_BASE_URL = "https://api.kadoa.com";
 
 // src/modules/extraction/services/entity-detector.service.ts
@@ -2626,10 +2627,7 @@ var RunExtractionCommand = class extends Command {
    */
   async execute(options) {
     this.validateOptions(options);
-    const config = {
-      ...DEFAULT_OPTIONS,
-      ...options
-    };
+    const config = esToolkit.merge(DEFAULT_OPTIONS, options);
     try {
       const entityPrediction = await this.entityDetector.fetchEntityFields({
         link: config.urls[0],
@@ -2663,6 +2661,11 @@ var RunExtractionCommand = class extends Command {
         },
         "extraction"
       );
+      if (options.mode === "submit") {
+        return {
+          workflowId
+        };
+      }
       const workflow = await this.workflowManager.waitForWorkflowCompletion(
         workflowId,
         config.pollingInterval,
@@ -2777,7 +2780,10 @@ var ExtractionModule = class {
    * ```
    */
   async run(options) {
-    return this.runExtractionCommand.execute(options);
+    return this.runExtractionCommand.execute({ ...options, mode: "run" });
+  }
+  async submit(options) {
+    return this.runExtractionCommand.execute({ ...options, mode: "submit" });
   }
   /**
    * Fetch paginated data from a workflow
@@ -2837,8 +2843,125 @@ var ExtractionModule = class {
   }
 };
 
+// src/internal/domains/workflows/workflows-core.service.ts
+var TERMINAL_RUN_STATES2 = /* @__PURE__ */ new Set([
+  "FINISHED",
+  "SUCCESS",
+  "FAILED",
+  "ERROR",
+  "STOPPED",
+  "CANCELLED"
+]);
+var WorkflowsCoreService = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async create(input, _idempotencyKey) {
+    const request = {
+      urls: input.urls,
+      navigationMode: input.navigationMode,
+      entity: input.entity,
+      name: input.name,
+      fields: input.fields,
+      bypassPreview: true,
+      tags: input.tags ?? ["sdk"]
+    };
+    try {
+      const response = await this.client.workflows.v4WorkflowsPost({
+        v4WorkflowsPostRequest: request
+      });
+      const workflowId = response.data?.workflowId;
+      if (!workflowId) {
+        throw new KadoaSdkException(ERROR_MESSAGES.NO_WORKFLOW_ID, {
+          code: "INTERNAL_ERROR",
+          details: {
+            response: response.data
+          }
+        });
+      }
+      return { id: workflowId };
+    } catch (error) {
+      throw KadoaHttpException.wrap(error, {
+        message: ERROR_MESSAGES.WORKFLOW_CREATE_FAILED,
+        details: request
+      });
+    }
+  }
+  async get(id) {
+    try {
+      const response = await this.client.workflows.v4WorkflowsWorkflowIdGet({
+        workflowId: id
+      });
+      return response.data;
+    } catch (error) {
+      throw KadoaHttpException.wrap(error, {
+        message: ERROR_MESSAGES.PROGRESS_CHECK_FAILED,
+        details: { workflowId: id }
+      });
+    }
+  }
+  async cancel(id) {
+    try {
+      await this.client.workflows.v4WorkflowsWorkflowIdDelete({
+        workflowId: id
+      });
+    } catch (error) {
+      throw KadoaHttpException.wrap(error, {
+        message: ERROR_MESSAGES.WORKFLOW_CREATE_FAILED,
+        details: { workflowId: id }
+      });
+    }
+  }
+  async wait(id, options) {
+    const pollInterval = Math.max(250, options?.pollIntervalMs ?? 1e3);
+    const timeoutMs = options?.timeoutMs ?? 5 * 60 * 1e3;
+    const start = Date.now();
+    let last;
+    while (Date.now() - start < timeoutMs) {
+      if (options?.abortSignal?.aborted) {
+        throw new KadoaSdkException("Aborted");
+      }
+      const current = await this.get(id);
+      if (last?.state !== current.state || last?.runState !== current.runState) ;
+      if (current.runState && TERMINAL_RUN_STATES2.has(current.runState.toUpperCase())) {
+        return current;
+      }
+      last = current;
+      await new Promise((r) => setTimeout(r, pollInterval));
+    }
+    throw new KadoaSdkException(ERROR_MESSAGES.WORKFLOW_TIMEOUT, {
+      details: {
+        workflowId: id,
+        lastState: last?.state,
+        lastRunState: last?.runState,
+        timeoutMs
+      }
+    });
+  }
+};
+
+// src/modules/workflows/workflows.module.ts
+var WorkflowsModule = class {
+  constructor(client) {
+    this.core = new WorkflowsCoreService(client);
+  }
+  async submit(input, options) {
+    const { id } = await this.core.create(input, options?.idempotencyKey);
+    return { workflowId: id };
+  }
+  async get(workflowId) {
+    return this.core.get(workflowId);
+  }
+  async cancel(workflowId) {
+    return this.core.cancel(workflowId);
+  }
+  async wait(workflowId, options) {
+    return this.core.wait(workflowId, options);
+  }
+};
+
 // src/version.ts
-var SDK_VERSION = "0.5.0";
+var SDK_VERSION = "0.7.0";
 var SDK_NAME = "kadoa-node-sdk";
 var SDK_LANGUAGE = "node";
 
@@ -2871,6 +2994,7 @@ var KadoaClient = class {
     this._workflowsApi = config.apiOverrides?.workflows || new WorkflowsApi(this._configuration, this._baseUrl, this._axiosInstance);
     this._crawlApi = config.apiOverrides?.crawl || new CrawlApi(this._configuration, this._baseUrl, this._axiosInstance);
     this.extraction = new ExtractionModule(this);
+    this.workflow = new WorkflowsModule(this);
   }
   /**
    * Register an event listener