flexorch-sdk 0.2.2 → 0.2.3

package/README.md

@@ -134,6 +134,10 @@ for (const r of results) {
 
 Throws `JobFailedError` if the job fails, `JobTimeoutError` if timeout is exceeded.
 
+Key properties: `id`, `status`, `qualityGrade`, `qualityScore`, `documentId`, `hasDataset`, `degraded`, `failureReason`.
+
+`degraded` is `true` when the underlying pipeline execution completed but one or more non-critical steps failed (e.g. structured extraction couldn't find a table in the document). The job still succeeds — PII detection and quality scoring results are still meaningful — but the resulting dataset's records/columns may be empty. `wait()` does not throw for a degraded completion.
+
 ---
 
 ### `Dataset`

package/dist/index.cjs

@@ -366,6 +366,16 @@ var Job = class _Job {
   qualityScore;
   documentId;
   hasDataset;
+  /**
+   * True when the underlying pipeline execution completed but one or more
+   * non-critical steps failed (e.g. structured extraction couldn't find a
+   * table in the document). The job still succeeds — PII detection and
+   * quality scoring results are still meaningful — but `records`/columns
+   * may be empty. Read from `execution_summary.degraded`; false for jobs
+   * with no execution (e.g. dataset_build). wait() does not throw for a
+   * degraded completion.
+   */
+  degraded;
   failureReason;
   _transport;
   constructor(data) {
@@ -375,11 +385,13 @@ var Job = class _Job {
     this.qualityScore = data.qualityScore;
     this.documentId = data.documentId;
     this.hasDataset = data.hasDataset;
+    this.degraded = data.degraded;
     this.failureReason = data.failureReason;
     this._transport = data._transport;
   }
   static fromDict(data, transport) {
     const quality = data["quality"] ?? {};
+    const executionSummary = data["execution_summary"];
     return new _Job({
       id: String(data["job_id"] ?? data["id"] ?? ""),
       status: String(data["status"] ?? ""),
@@ -387,6 +399,7 @@ var Job = class _Job {
       qualityScore: quality["score"] ?? null,
       documentId: data["document_id"] ?? null,
       hasDataset: Boolean(data["has_dataset"] ?? false),
+      degraded: Boolean(executionSummary?.["degraded"] ?? false),
       failureReason: data["failure_reason"] ?? null,
       _transport: transport
     });
@@ -912,7 +925,7 @@ var FlexOrchReader = class {
 };
 
 // src/index.ts
-var version = "0.2.0";
+var version = "0.2.3";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AuthError,

package/dist/index.d.cts

@@ -77,6 +77,16 @@ declare class Job {
     readonly qualityScore: number | null;
     readonly documentId: string | null;
     readonly hasDataset: boolean;
+    /**
+     * True when the underlying pipeline execution completed but one or more
+     * non-critical steps failed (e.g. structured extraction couldn't find a
+     * table in the document). The job still succeeds — PII detection and
+     * quality scoring results are still meaningful — but `records`/columns
+     * may be empty. Read from `execution_summary.degraded`; false for jobs
+     * with no execution (e.g. dataset_build). wait() does not throw for a
+     * degraded completion.
+     */
+    readonly degraded: boolean;
     readonly failureReason: string | null;
     private readonly _transport;
     constructor(data: {
@@ -86,6 +96,7 @@ declare class Job {
         qualityScore: number | null;
         documentId: string | null;
         hasDataset: boolean;
+        degraded: boolean;
         failureReason: string | null;
         _transport: Transport;
     });
@@ -399,6 +410,6 @@ declare class FlexOrchReader {
     toString(): string;
 }
 
-declare const version = "0.2.0";
+declare const version = "0.2.3";
 
 export { AuthError, Connector, type ConnectorTestResult, type ConnectorType, Dataset, type ExportFormat, FlexOrchClient, type FlexOrchClientOptions, FlexOrchError, FlexOrchReader, FlexOrchRetriever, Job, JobFailedError, JobTimeoutError, NotFoundError, QuotaError, RAGDocument, RateLimitError, type ReaderLoadOptions, type RetrieverOptions, type S3ConnectorConfig, type SearchFilters, SearchResult, ServerError, type UsageSnapshot, ValidationError, type Webhook, type WebhookEvent, version };

package/dist/index.d.ts

@@ -77,6 +77,16 @@ declare class Job {
     readonly qualityScore: number | null;
     readonly documentId: string | null;
     readonly hasDataset: boolean;
+    /**
+     * True when the underlying pipeline execution completed but one or more
+     * non-critical steps failed (e.g. structured extraction couldn't find a
+     * table in the document). The job still succeeds — PII detection and
+     * quality scoring results are still meaningful — but `records`/columns
+     * may be empty. Read from `execution_summary.degraded`; false for jobs
+     * with no execution (e.g. dataset_build). wait() does not throw for a
+     * degraded completion.
+     */
+    readonly degraded: boolean;
     readonly failureReason: string | null;
     private readonly _transport;
     constructor(data: {
@@ -86,6 +96,7 @@ declare class Job {
         qualityScore: number | null;
         documentId: string | null;
         hasDataset: boolean;
+        degraded: boolean;
         failureReason: string | null;
         _transport: Transport;
     });
@@ -399,6 +410,6 @@ declare class FlexOrchReader {
     toString(): string;
 }
 
-declare const version = "0.2.0";
+declare const version = "0.2.3";
 
 export { AuthError, Connector, type ConnectorTestResult, type ConnectorType, Dataset, type ExportFormat, FlexOrchClient, type FlexOrchClientOptions, FlexOrchError, FlexOrchReader, FlexOrchRetriever, Job, JobFailedError, JobTimeoutError, NotFoundError, QuotaError, RAGDocument, RateLimitError, type ReaderLoadOptions, type RetrieverOptions, type S3ConnectorConfig, type SearchFilters, SearchResult, ServerError, type UsageSnapshot, ValidationError, type Webhook, type WebhookEvent, version };

package/dist/index.js

@@ -198,6 +198,16 @@ var Job = class _Job {
   qualityScore;
   documentId;
   hasDataset;
+  /**
+   * True when the underlying pipeline execution completed but one or more
+   * non-critical steps failed (e.g. structured extraction couldn't find a
+   * table in the document). The job still succeeds — PII detection and
+   * quality scoring results are still meaningful — but `records`/columns
+   * may be empty. Read from `execution_summary.degraded`; false for jobs
+   * with no execution (e.g. dataset_build). wait() does not throw for a
+   * degraded completion.
+   */
+  degraded;
   failureReason;
   _transport;
   constructor(data) {
@@ -207,11 +217,13 @@ var Job = class _Job {
     this.qualityScore = data.qualityScore;
     this.documentId = data.documentId;
     this.hasDataset = data.hasDataset;
+    this.degraded = data.degraded;
     this.failureReason = data.failureReason;
     this._transport = data._transport;
   }
   static fromDict(data, transport) {
     const quality = data["quality"] ?? {};
+    const executionSummary = data["execution_summary"];
     return new _Job({
       id: String(data["job_id"] ?? data["id"] ?? ""),
       status: String(data["status"] ?? ""),
@@ -219,6 +231,7 @@ var Job = class _Job {
       qualityScore: quality["score"] ?? null,
       documentId: data["document_id"] ?? null,
       hasDataset: Boolean(data["has_dataset"] ?? false),
+      degraded: Boolean(executionSummary?.["degraded"] ?? false),
       failureReason: data["failure_reason"] ?? null,
       _transport: transport
     });
@@ -740,7 +753,7 @@ var FlexOrchReader = class {
 };
 
 // src/index.ts
-var version = "0.2.0";
+var version = "0.2.3";
 export {
   AuthError,
   Connector,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flexorch-sdk",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "TypeScript/JavaScript SDK for the FlexOrch API — process documents, build LLM-ready datasets",
   "type": "module",
   "main": "./dist/index.cjs",