@kadoa/node-sdk 0.14.1 → 0.15.0

package/dist/index.d.mts

@@ -670,7 +670,7 @@ interface CreateSchemaBody {
     /**
      * Entity type for the schema
      */
-    'entity': string;
+    'entity'?: string;
     /**
      * Array of field definitions
      */
@@ -996,7 +996,7 @@ interface CreateWorkflowWithCustomSchemaBody {
     /**
      * Entity name for extraction
      */
-    'entity': string;
+    'entity'?: string;
     /**
      * Schema fields for extraction
      */
@@ -2183,59 +2183,6 @@ interface V4WorkflowsWorkflowIdGet200ResponseBrowserActionsInner {
     'url'?: string;
 }
 
-/**
- * Kadoa API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0.0
- * Contact: support@kadoa.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-interface V4WorkflowsWorkflowIdGet200ResponseLastJobErrorsInner {
-    /**
-     * Error code identifying the type of error
-     */
-    'errorCode'?: string;
-    /**
-     * Human-readable error message
-     */
-    'message'?: string;
-    /**
-     * When the error occurred
-     */
-    'timestamp'?: string;
-    /**
-     * Optional screenshot URL
-     */
-    'screenshot'?: string;
-    /**
-     * Additional context about the error
-     */
-    'context'?: object;
-}
-
-/**
- * Kadoa API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0.0
- * Contact: support@kadoa.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-interface V4WorkflowsWorkflowIdGet200ResponseLastJob {
-    /**
-     * Errors from the last job run
-     */
-    'errors'?: Array<V4WorkflowsWorkflowIdGet200ResponseLastJobErrorsInner>;
-}
-
 /**
  * Kadoa API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -2345,6 +2292,76 @@ declare const V4WorkflowsWorkflowIdGet200ResponseSchemaInnerDataTypeEnum: {
 };
 type V4WorkflowsWorkflowIdGet200ResponseSchemaInnerDataTypeEnum = typeof V4WorkflowsWorkflowIdGet200ResponseSchemaInnerDataTypeEnum[keyof typeof V4WorkflowsWorkflowIdGet200ResponseSchemaInnerDataTypeEnum];
 
+/**
+ * Kadoa API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@kadoa.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Additional context about the error
+ */
+interface V4WorkflowsWorkflowIdHistoryGet200ResponseWorkflowRunsInnerErrorsInnerContext {
+    [key: string]: any;
+    /**
+     * The URL where the error occurred
+     */
+    'url'?: string;
+    /**
+     * HTTP status code if applicable
+     */
+    'httpStatus'?: number;
+    /**
+     * Number of retry attempts made
+     */
+    'retryCount'?: number;
+    /**
+     * Additional error-specific details
+     */
+    'details'?: string;
+    /**
+     * When the error context was captured
+     */
+    'timestamp'?: string;
+}
+
+/**
+ * Kadoa API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@kadoa.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+interface V4WorkflowsWorkflowIdHistoryGet200ResponseWorkflowRunsInnerErrorsInner {
+    /**
+     * Error code identifying the type of error
+     */
+    'errorCode'?: string;
+    /**
+     * Human-readable error message
+     */
+    'message'?: string;
+    /**
+     * When the error occurred
+     */
+    'timestamp'?: string;
+    /**
+     * Optional screenshot URL
+     */
+    'screenshot'?: string;
+    'context'?: V4WorkflowsWorkflowIdHistoryGet200ResponseWorkflowRunsInnerErrorsInnerContext;
+}
+
 /**
  * Kadoa API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -2455,7 +2472,10 @@ interface V4WorkflowsGet200ResponseWorkflowsInner {
      * Whether the schema can be edited
      */
     'isSchemaEditable'?: boolean;
-    'lastJob'?: V4WorkflowsWorkflowIdGet200ResponseLastJob;
+    /**
+     * Errors from the last job run
+     */
+    'errors'?: Array<V4WorkflowsWorkflowIdHistoryGet200ResponseWorkflowRunsInnerErrorsInner>;
     'dataValidation'?: V4WorkflowsGet200ResponseWorkflowsInnerDataValidation;
     'validationStatistics'?: V4WorkflowsGet200ResponseWorkflowsInnerValidationStatistics;
     /**
@@ -2796,6 +2816,40 @@ interface V4WorkflowsWorkflowIdGet200ResponseDataValidation {
     'ruleCounts'?: V4WorkflowsWorkflowIdGet200ResponseDataValidationRuleCounts;
 }
 
+/**
+ * Kadoa API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@kadoa.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface V4WorkflowsWorkflowIdGet200ResponseErrorsInner {
+    /**
+     * Error code identifying the type of error
+     */
+    'errorCode'?: string;
+    /**
+     * Human-readable error message
+     */
+    'message'?: string;
+    /**
+     * When the error occurred
+     */
+    'timestamp'?: string;
+    /**
+     * Optional screenshot URL
+     */
+    'screenshot'?: string;
+    /**
+     * Additional context about the error
+     */
+    'context'?: object;
+}
+
 /**
  * Kadoa API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -2907,7 +2961,10 @@ interface V4WorkflowsWorkflowIdGet200Response {
      * Database key for the workflow data
      */
     'dataKey'?: string;
-    'lastJob'?: V4WorkflowsWorkflowIdGet200ResponseLastJob;
+    /**
+     * Errors from the last job run
+     */
+    'errors'?: Array<V4WorkflowsWorkflowIdGet200ResponseErrorsInner>;
     /**
      * Cost of the last job run in credits
      */
@@ -3037,7 +3094,7 @@ interface V4WorkflowsWorkflowIdHistoryGet200ResponseWorkflowRunsInner {
     /**
      * Errors that occurred during the workflow run
      */
-    'errors'?: Array<V4WorkflowsWorkflowIdGet200ResponseLastJobErrorsInner>;
+    'errors'?: Array<V4WorkflowsWorkflowIdHistoryGet200ResponseWorkflowRunsInnerErrorsInner>;
     /**
      * Number of credits used for this workflow run
      */
@@ -5984,7 +6041,7 @@ interface CreateWorkflowInput {
     name: string;
     description?: string;
     schemaId?: string;
-    entity: string;
+    entity?: string;
     fields: Array<SchemaField$1>;
     tags?: string[];
     interval?: WorkflowInterval;
@@ -6184,6 +6241,7 @@ declare class SchemaBuilder {
     private static readonly TYPES_REQUIRING_EXAMPLE;
     readonly fields: SchemaField[];
     entityName?: string;
+    private hasSchemaFields;
     entity(entityName: string): this;
     /**
      * Add a structured field to the schema
@@ -6206,7 +6264,7 @@ declare class SchemaBuilder {
      */
     raw(name: RawFormat | RawFormat[]): this;
     build(): {
-        entityName: string;
+        entityName?: string;
         fields: SchemaField[];
     };
     private validateFieldName;
@@ -6351,7 +6409,7 @@ declare class SchemasService {
     /**
      * Create a schema builder with fluent API and inline create support.
      */
-    builder(entityName: string): SchemaBuilder & {
+    builder(entityName?: string): SchemaBuilder & {
         create(name?: string): Promise<SchemaResponse>;
     };
     /**
@@ -6697,13 +6755,13 @@ interface EntityRequestOptions {
     navigationMode?: string;
 }
 interface ResolvedEntity {
-    entity: string;
+    entity?: string;
     fields: SchemaField$1[];
 }
 type EntityConfig = "ai-detection" | {
     schemaId: string;
 } | {
-    name: string;
+    name?: string;
     fields: SchemaField$1[];
 };
 /**

package/dist/index.d.ts

@@ -670,7 +670,7 @@ interface CreateSchemaBody {
     /**
      * Entity type for the schema
      */
-    'entity': string;
+    'entity'?: string;
     /**
      * Array of field definitions
      */
@@ -996,7 +996,7 @@ interface CreateWorkflowWithCustomSchemaBody {
     /**
      * Entity name for extraction
      */
-    'entity': string;
+    'entity'?: string;
     /**
      * Schema fields for extraction
      */
@@ -2183,59 +2183,6 @@ interface V4WorkflowsWorkflowIdGet200ResponseBrowserActionsInner {
     'url'?: string;
 }
 
-/**
- * Kadoa API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0.0
- * Contact: support@kadoa.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-interface V4WorkflowsWorkflowIdGet200ResponseLastJobErrorsInner {
-    /**
-     * Error code identifying the type of error
-     */
-    'errorCode'?: string;
-    /**
-     * Human-readable error message
-     */
-    'message'?: string;
-    /**
-     * When the error occurred
-     */
-    'timestamp'?: string;
-    /**
-     * Optional screenshot URL
-     */
-    'screenshot'?: string;
-    /**
-     * Additional context about the error
-     */
-    'context'?: object;
-}
-
-/**
- * Kadoa API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0.0
- * Contact: support@kadoa.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-interface V4WorkflowsWorkflowIdGet200ResponseLastJob {
-    /**
-     * Errors from the last job run
-     */
-    'errors'?: Array<V4WorkflowsWorkflowIdGet200ResponseLastJobErrorsInner>;
-}
-
 /**
  * Kadoa API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -2345,6 +2292,76 @@ declare const V4WorkflowsWorkflowIdGet200ResponseSchemaInnerDataTypeEnum: {
 };
 type V4WorkflowsWorkflowIdGet200ResponseSchemaInnerDataTypeEnum = typeof V4WorkflowsWorkflowIdGet200ResponseSchemaInnerDataTypeEnum[keyof typeof V4WorkflowsWorkflowIdGet200ResponseSchemaInnerDataTypeEnum];
 
+/**
+ * Kadoa API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@kadoa.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Additional context about the error
+ */
+interface V4WorkflowsWorkflowIdHistoryGet200ResponseWorkflowRunsInnerErrorsInnerContext {
+    [key: string]: any;
+    /**
+     * The URL where the error occurred
+     */
+    'url'?: string;
+    /**
+     * HTTP status code if applicable
+     */
+    'httpStatus'?: number;
+    /**
+     * Number of retry attempts made
+     */
+    'retryCount'?: number;
+    /**
+     * Additional error-specific details
+     */
+    'details'?: string;
+    /**
+     * When the error context was captured
+     */
+    'timestamp'?: string;
+}
+
+/**
+ * Kadoa API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@kadoa.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+interface V4WorkflowsWorkflowIdHistoryGet200ResponseWorkflowRunsInnerErrorsInner {
+    /**
+     * Error code identifying the type of error
+     */
+    'errorCode'?: string;
+    /**
+     * Human-readable error message
+     */
+    'message'?: string;
+    /**
+     * When the error occurred
+     */
+    'timestamp'?: string;
+    /**
+     * Optional screenshot URL
+     */
+    'screenshot'?: string;
+    'context'?: V4WorkflowsWorkflowIdHistoryGet200ResponseWorkflowRunsInnerErrorsInnerContext;
+}
+
 /**
  * Kadoa API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -2455,7 +2472,10 @@ interface V4WorkflowsGet200ResponseWorkflowsInner {
      * Whether the schema can be edited
      */
     'isSchemaEditable'?: boolean;
-    'lastJob'?: V4WorkflowsWorkflowIdGet200ResponseLastJob;
+    /**
+     * Errors from the last job run
+     */
+    'errors'?: Array<V4WorkflowsWorkflowIdHistoryGet200ResponseWorkflowRunsInnerErrorsInner>;
     'dataValidation'?: V4WorkflowsGet200ResponseWorkflowsInnerDataValidation;
     'validationStatistics'?: V4WorkflowsGet200ResponseWorkflowsInnerValidationStatistics;
     /**
@@ -2796,6 +2816,40 @@ interface V4WorkflowsWorkflowIdGet200ResponseDataValidation {
     'ruleCounts'?: V4WorkflowsWorkflowIdGet200ResponseDataValidationRuleCounts;
 }
 
+/**
+ * Kadoa API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@kadoa.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface V4WorkflowsWorkflowIdGet200ResponseErrorsInner {
+    /**
+     * Error code identifying the type of error
+     */
+    'errorCode'?: string;
+    /**
+     * Human-readable error message
+     */
+    'message'?: string;
+    /**
+     * When the error occurred
+     */
+    'timestamp'?: string;
+    /**
+     * Optional screenshot URL
+     */
+    'screenshot'?: string;
+    /**
+     * Additional context about the error
+     */
+    'context'?: object;
+}
+
 /**
  * Kadoa API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -2907,7 +2961,10 @@ interface V4WorkflowsWorkflowIdGet200Response {
      * Database key for the workflow data
      */
     'dataKey'?: string;
-    'lastJob'?: V4WorkflowsWorkflowIdGet200ResponseLastJob;
+    /**
+     * Errors from the last job run
+     */
+    'errors'?: Array<V4WorkflowsWorkflowIdGet200ResponseErrorsInner>;
     /**
      * Cost of the last job run in credits
      */
@@ -3037,7 +3094,7 @@ interface V4WorkflowsWorkflowIdHistoryGet200ResponseWorkflowRunsInner {
     /**
      * Errors that occurred during the workflow run
      */
-    'errors'?: Array<V4WorkflowsWorkflowIdGet200ResponseLastJobErrorsInner>;
+    'errors'?: Array<V4WorkflowsWorkflowIdHistoryGet200ResponseWorkflowRunsInnerErrorsInner>;
     /**
      * Number of credits used for this workflow run
      */
@@ -5984,7 +6041,7 @@ interface CreateWorkflowInput {
     name: string;
     description?: string;
     schemaId?: string;
-    entity: string;
+    entity?: string;
     fields: Array<SchemaField$1>;
     tags?: string[];
     interval?: WorkflowInterval;
@@ -6184,6 +6241,7 @@ declare class SchemaBuilder {
     private static readonly TYPES_REQUIRING_EXAMPLE;
     readonly fields: SchemaField[];
     entityName?: string;
+    private hasSchemaFields;
     entity(entityName: string): this;
     /**
      * Add a structured field to the schema
@@ -6206,7 +6264,7 @@ declare class SchemaBuilder {
      */
     raw(name: RawFormat | RawFormat[]): this;
     build(): {
-        entityName: string;
+        entityName?: string;
         fields: SchemaField[];
     };
     private validateFieldName;
@@ -6351,7 +6409,7 @@ declare class SchemasService {
     /**
      * Create a schema builder with fluent API and inline create support.
      */
-    builder(entityName: string): SchemaBuilder & {
+    builder(entityName?: string): SchemaBuilder & {
         create(name?: string): Promise<SchemaResponse>;
     };
     /**
@@ -6697,13 +6755,13 @@ interface EntityRequestOptions {
     navigationMode?: string;
 }
 interface ResolvedEntity {
-    entity: string;
+    entity?: string;
     fields: SchemaField$1[];
 }
 type EntityConfig = "ai-detection" | {
     schemaId: string;
 } | {
-    name: string;
+    name?: string;
     fields: SchemaField$1[];
 };
 /**

package/dist/index.js

@@ -333,6 +333,9 @@ var _SchemaBuilder = class _SchemaBuilder {
   constructor() {
     this.fields = [];
   }
+  hasSchemaFields() {
+    return this.fields.some((field) => field.fieldType === "SCHEMA");
+  }
   entity(entityName) {
     this.entityName = entityName;
     return this;
@@ -400,11 +403,14 @@ var _SchemaBuilder = class _SchemaBuilder {
     return this;
   }
   build() {
-    if (!this.entityName) {
-      throw new KadoaSdkException("Entity name is required", {
-        code: "VALIDATION_ERROR",
-        details: { entityName: this.entityName }
-      });
+    if (this.hasSchemaFields() && !this.entityName) {
+      throw new KadoaSdkException(
+        "Entity name is required when schema fields are present",
+        {
+          code: "VALIDATION_ERROR",
+          details: { entityName: this.entityName }
+        }
+      );
     }
     return {
       entityName: this.entityName,
@@ -4307,15 +4313,30 @@ var SchemasService = class {
     return new class extends SchemaBuilder {
       constructor() {
         super();
-        this.entity(entityName);
+        if (entityName) {
+          this.entity(entityName);
+        }
       }
       async create(name) {
         const built = this.build();
-        return service.createSchema({
-          name: name || built.entityName,
-          entity: built.entityName,
-          fields: built.fields
-        });
+        const schemaName = name ?? built.entityName;
+        if (!schemaName) {
+          throw new KadoaSdkException(
+            "Schema name is required when entity name is not provided",
+            {
+              code: "VALIDATION_ERROR",
+              details: { name }
+            }
+          );
+        }
+        const createSchemaBody = {
+          name: schemaName,
+          fields: built.fields,
+          ...built.entityName ? { entity: built.entityName } : {}
+        };
+        return service.createSchema(
+          createSchemaBody
+        );
       }
     }();
   }
@@ -4411,8 +4432,9 @@ var EntityResolverService = class {
         location: options.location,
         navigationMode: options.navigationMode
       });
+      const entity = entityPrediction.entity;
       return {
-        entity: entityPrediction.entity,
+        entity,
         fields: entityPrediction.fields
       };
     } else if (entityConfig) {
@@ -4421,10 +4443,10 @@ var EntityResolverService = class {
           entityConfig.schemaId
         );
         return {
-          entity: schema.entity ?? "",
+          entity: schema.entity ?? void 0,
           fields: schema.schema
         };
-      } else if ("name" in entityConfig && "fields" in entityConfig) {
+      } else if ("fields" in entityConfig) {
         return {
           entity: entityConfig.name,
           fields: entityConfig.fields
@@ -4580,11 +4602,12 @@ var ExtractionService = class {
       }
     );
     const hasNotifications = !!config.notifications;
-    const result = await this.workflowsCoreService.create({
+    const workflowRequest = {
       ...config,
-      entity: resolvedEntity.entity,
-      fields: resolvedEntity.fields
-    });
+      fields: resolvedEntity.fields,
+      ...resolvedEntity.entity !== void 0 ? { entity: resolvedEntity.entity } : {}
+    };
+    const result = await this.workflowsCoreService.create(workflowRequest);
     workflowId = result.id;
     if (hasNotifications) {
       const result2 = await this.notificationSetupService.setup({
@@ -4726,7 +4749,7 @@ var ExtractionBuilderService = class {
         entity = { schemaId: result.schemaId };
       } else {
         const builtSchema = result.build();
-        entity = { name: builtSchema.entityName, fields: builtSchema.fields };
+        entity = builtSchema.entityName ? { name: builtSchema.entityName, fields: builtSchema.fields } : { fields: builtSchema.fields };
       }
     }
     this._options = {
@@ -4770,17 +4793,14 @@ var ExtractionBuilderService = class {
   async create() {
     assert__default.default(this._options, "Options are not set");
     const { urls, name, description, navigationMode, entity } = this.options;
-    const resolvedEntity = typeof entity === "object" && "schemaId" in entity ? void 0 : await this.entityResolverService.resolveEntity(entity, {
-      link: urls[0],
-      location: this._options.location,
-      navigationMode
-    });
-    if (!resolvedEntity) {
-      throw new KadoaSdkException(ERROR_MESSAGES.ENTITY_FETCH_FAILED, {
-        code: "VALIDATION_ERROR",
-        details: { entity }
-      });
-    }
+    const resolvedEntity = await this.entityResolverService.resolveEntity(
+      entity,
+      {
+        link: urls[0],
+        location: this._options.location,
+        navigationMode
+      }
+    );
     const workflow = await this.workflowsCoreService.create({
       urls,
       name,
@@ -5278,7 +5298,7 @@ var WSS_API_URI = process.env.KADOA_WSS_API_URI ?? "wss://realtime.kadoa.com";
 var REALTIME_API_URI = process.env.KADOA_REALTIME_API_URI ?? "https://realtime.kadoa.com";
 
 // src/version.ts
-var SDK_VERSION = "0.14.1";
+var SDK_VERSION = "0.15.0";
 var SDK_NAME = "kadoa-node-sdk";
 var SDK_LANGUAGE = "node";