flexorch-sdk 0.3.1 → 0.3.3

package/dist/{chunk-4KCMMRD7.js → chunk-U2CE5GVG.js}

@@ -16,6 +16,9 @@ var Dataset = class _Dataset {
   slug;
   status;
   rowCount;
+  piiMasked;
+  piiFindingsCount;
+  piiTypeSummary;
   createdAt;
   availableFormats;
   _transport;
@@ -25,6 +28,9 @@ var Dataset = class _Dataset {
     this.slug = data.slug;
     this.status = data.status;
     this.rowCount = data.rowCount;
+    this.piiMasked = data.piiMasked;
+    this.piiFindingsCount = data.piiFindingsCount;
+    this.piiTypeSummary = data.piiTypeSummary;
     this.createdAt = data.createdAt;
     this.availableFormats = data.availableFormats;
     this._transport = data._transport;
@@ -32,12 +38,19 @@ var Dataset = class _Dataset {
   static fromDict(data, transport) {
     const fmt = data["format_summary"] ?? {};
     const files = fmt["files"] ?? {};
+    const privacy = data["privacy"];
+    const piiMasked = privacy ? Boolean(privacy["privacy_applied"] ?? false) : Boolean(data["privacy_applied"] ?? false);
+    const piiFindingsCount = privacy ? Number(privacy["pii_findings_count"] ?? 0) : Number(data["pii_findings_count"] ?? 0);
+    const piiTypeSummary = privacy ? privacy["pii_type_summary"] ?? {} : {};
     return new _Dataset({
       id: String(data["id"] ?? ""),
       name: String(data["name"] ?? ""),
       slug: String(data["slug"] ?? ""),
       status: String(data["status"] ?? ""),
       rowCount: Number(data["row_count"] ?? 0),
+      piiMasked,
+      piiFindingsCount,
+      piiTypeSummary,
       createdAt: String(data["created_at"] ?? ""),
       availableFormats: Object.keys(files),
       _transport: transport

package/dist/{dataset-E7EXJETI.js → dataset-UGUUKKH3.js}

@@ -1,6 +1,6 @@
 import {
   Dataset
-} from "./chunk-4KCMMRD7.js";
+} from "./chunk-U2CE5GVG.js";
 export {
   Dataset
 };

package/dist/index.cjs

@@ -56,6 +56,9 @@ var init_dataset = __esm({
       slug;
       status;
       rowCount;
+      piiMasked;
+      piiFindingsCount;
+      piiTypeSummary;
       createdAt;
       availableFormats;
       _transport;
@@ -65,6 +68,9 @@ var init_dataset = __esm({
         this.slug = data.slug;
         this.status = data.status;
         this.rowCount = data.rowCount;
+        this.piiMasked = data.piiMasked;
+        this.piiFindingsCount = data.piiFindingsCount;
+        this.piiTypeSummary = data.piiTypeSummary;
         this.createdAt = data.createdAt;
         this.availableFormats = data.availableFormats;
         this._transport = data._transport;
@@ -72,12 +78,19 @@ var init_dataset = __esm({
       static fromDict(data, transport) {
         const fmt = data["format_summary"] ?? {};
         const files = fmt["files"] ?? {};
+        const privacy = data["privacy"];
+        const piiMasked = privacy ? Boolean(privacy["privacy_applied"] ?? false) : Boolean(data["privacy_applied"] ?? false);
+        const piiFindingsCount = privacy ? Number(privacy["pii_findings_count"] ?? 0) : Number(data["pii_findings_count"] ?? 0);
+        const piiTypeSummary = privacy ? privacy["pii_type_summary"] ?? {} : {};
         return new _Dataset({
           id: String(data["id"] ?? ""),
           name: String(data["name"] ?? ""),
           slug: String(data["slug"] ?? ""),
           status: String(data["status"] ?? ""),
           rowCount: Number(data["row_count"] ?? 0),
+          piiMasked,
+          piiFindingsCount,
+          piiTypeSummary,
           createdAt: String(data["created_at"] ?? ""),
           availableFormats: Object.keys(files),
           _transport: transport
@@ -312,7 +325,7 @@ var Transport = class {
     this.fetchFn = fetchFn ?? globalThis.fetch.bind(globalThis);
     this.defaultHeaders = {
       "X-API-KEY": apiKey,
-      "User-Agent": "flexorch-sdk-js/0.3.1"
+      "User-Agent": "flexorch-sdk-js/0.3.3"
     };
   }
   url(path, params) {
@@ -418,6 +431,9 @@ var Job = class _Job {
    */
   degraded;
   failureReason;
+  piiMasked;
+  piiFindingsCount;
+  piiTypeSummary;
   _transport;
   constructor(data) {
     this.id = data.id;
@@ -430,12 +446,16 @@ var Job = class _Job {
     this.datasetId = data.datasetId;
     this.degraded = data.degraded;
     this.failureReason = data.failureReason;
+    this.piiMasked = data.piiMasked;
+    this.piiFindingsCount = data.piiFindingsCount;
+    this.piiTypeSummary = data.piiTypeSummary;
     this._transport = data._transport;
   }
   static fromDict(data, transport) {
     const executionSummary = data["execution_summary"];
     const processingSummary = data["processing_summary"];
     const datasetSummary = data["dataset_summary"];
+    const privacy = executionSummary?.["privacy"];
     let quality = data["quality"];
     if (!quality && processingSummary) {
       quality = processingSummary["quality"];
@@ -458,6 +478,13 @@ var Job = class _Job {
       datasetId: datasetSummary?.["dataset_id"] ?? null,
       degraded: Boolean(executionSummary?.["degraded"] ?? false),
       failureReason: data["failure_reason"] ?? null,
+      // execution_summary.privacy — computed fresh on every GET /jobs/{id}
+      // read, not frozen at job-completion time, so this works even for
+      // jobs older than this field. Defaults for jobs with no execution
+      // (e.g. dataset_build) or against an older API version.
+      piiMasked: Boolean(privacy?.["privacy_applied"] ?? false),
+      piiFindingsCount: Number(privacy?.["pii_findings_count"] ?? 0),
+      piiTypeSummary: privacy?.["pii_type_summary"] ?? {},
       _transport: transport
     });
   }
@@ -821,14 +848,25 @@ var UsageResource = class {
 };
 
 // src/resources/webhooks.ts
-var VALID_EVENTS = /* @__PURE__ */ new Set(["dataset.ready", "job.completed", "job.failed"]);
+var VALID_EVENTS = /* @__PURE__ */ new Set(["dataset.ready", "job.completed", "job.failed", "quota.warning"]);
+function autoExportFromDict(data) {
+  if (!data || typeof data !== "object") return null;
+  const d = data;
+  return {
+    connectorId: Number(d["connector_id"] ?? 0),
+    format: String(d["format"] ?? ""),
+    prefix: d["prefix"] !== void 0 ? String(d["prefix"]) : void 0
+  };
+}
 function webhookFromDict(data) {
   return {
     id: String(data["id"] ?? ""),
     url: String(data["url"] ?? ""),
     events: data["events"] ?? [],
     active: Boolean(data["active"] ?? true),
-    createdAt: String(data["created_at"] ?? "")
+    createdAt: String(data["created_at"] ?? ""),
+    autoExport: autoExportFromDict(data["auto_export"]),
+    secret: data["secret"] ?? null
   };
 }
 var WebhooksResource = class {
@@ -836,12 +874,20 @@ var WebhooksResource = class {
     this._t = _t;
   }
   _t;
-  async register(url, events) {
+  async register(url, events, autoExport) {
     const invalid = events.filter((e) => !VALID_EVENTS.has(e));
     if (invalid.length > 0) {
       throw new Error(`Unknown event types: ${invalid.join(", ")}. Valid: ${[...VALID_EVENTS].join(", ")}`);
     }
-    const data = await this._t.post("/webhooks", { url, events });
+    const body = { url, events };
+    if (autoExport) {
+      body["auto_export"] = {
+        connector_id: autoExport.connectorId,
+        format: autoExport.format,
+        ...autoExport.prefix !== void 0 ? { prefix: autoExport.prefix } : {}
+      };
+    }
+    const data = await this._t.post("/webhooks", body);
     return webhookFromDict(data);
   }
   async list() {
@@ -863,6 +909,9 @@ var Connector = class _Connector {
   lastTestedAt;
   lastUsedAt;
   createdAt;
+  /** Non-secret config fields (bucket/region, folder_id, index_name, etc.) —
+   * credentials are never included. */
+  config;
   constructor(data) {
     this.id = data.id;
     this.name = data.name;
@@ -871,6 +920,7 @@ var Connector = class _Connector {
     this.lastTestedAt = data.lastTestedAt;
     this.lastUsedAt = data.lastUsedAt;
     this.createdAt = data.createdAt;
+    this.config = data.config ?? {};
   }
   static fromDict(data) {
     return new _Connector({
@@ -880,7 +930,8 @@ var Connector = class _Connector {
       active: Boolean(data["active"] ?? true),
       lastTestedAt: data["last_tested_at"] ?? null,
       lastUsedAt: data["last_used_at"] ?? null,
-      createdAt: String(data["created_at"] ?? "")
+      createdAt: String(data["created_at"] ?? ""),
+      config: data["config"] ?? {}
     });
   }
   toString() {
@@ -1275,7 +1326,7 @@ var FlexOrchReader = class {
 };
 
 // src/index.ts
-var version = "0.3.1";
+var version = "0.3.3";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AuthError,

package/dist/index.d.cts

@@ -22,6 +22,9 @@ declare class Dataset {
     readonly slug: string;
     readonly status: string;
     readonly rowCount: number;
+    readonly piiMasked: boolean;
+    readonly piiFindingsCount: number;
+    readonly piiTypeSummary: Record<string, number>;
     readonly createdAt: string;
     readonly availableFormats: string[];
     private readonly _transport;
@@ -31,6 +34,9 @@ declare class Dataset {
         slug: string;
         status: string;
         rowCount: number;
+        piiMasked: boolean;
+        piiFindingsCount: number;
+        piiTypeSummary: Record<string, number>;
         createdAt: string;
         availableFormats: string[];
         _transport: Transport;
@@ -112,6 +118,9 @@ declare class Job {
      */
     readonly degraded: boolean;
     readonly failureReason: string | null;
+    readonly piiMasked: boolean;
+    readonly piiFindingsCount: number;
+    readonly piiTypeSummary: Record<string, number>;
     private readonly _transport;
     constructor(data: {
         id: string;
@@ -124,6 +133,9 @@ declare class Job {
         datasetId: number | null;
         degraded: boolean;
         failureReason: string | null;
+        piiMasked: boolean;
+        piiFindingsCount: number;
+        piiTypeSummary: Record<string, number>;
         _transport: Transport;
     });
     static fromDict(data: Record<string, unknown>, transport: Transport): Job;
@@ -334,18 +346,27 @@ declare class UsageResource {
     rateLimits(): Promise<RateLimitStatus>;
 }
 
-type WebhookEvent = "dataset.ready" | "job.completed" | "job.failed";
+type WebhookEvent = "dataset.ready" | "job.completed" | "job.failed" | "quota.warning";
+interface WebhookAutoExport {
+    connectorId: number;
+    format: string;
+    prefix?: string;
+}
 interface Webhook {
     id: string;
     url: string;
     events: WebhookEvent[];
     active: boolean;
     createdAt: string;
+    autoExport: WebhookAutoExport | null;
+    /** Signing secret — only present on the response from register(). Store it
+     * securely; it is never returned again by list()/get(). */
+    secret: string | null;
 }
 declare class WebhooksResource {
     private readonly _t;
     constructor(_t: Transport);
-    register(url: string, events: WebhookEvent[]): Promise<Webhook>;
+    register(url: string, events: WebhookEvent[], autoExport?: WebhookAutoExport): Promise<Webhook>;
     list(): Promise<Webhook[]>;
     delete(webhookId: string): Promise<void>;
 }
@@ -358,6 +379,9 @@ declare class Connector {
     readonly lastTestedAt: string | null;
     readonly lastUsedAt: string | null;
     readonly createdAt: string;
+    /** Non-secret config fields (bucket/region, folder_id, index_name, etc.) —
+     * credentials are never included. */
+    readonly config: Record<string, unknown>;
     constructor(data: {
         id: string;
         name: string;
@@ -366,6 +390,7 @@ declare class Connector {
         lastTestedAt: string | null;
         lastUsedAt: string | null;
         createdAt: string;
+        config?: Record<string, unknown>;
     });
     static fromDict(data: Record<string, unknown>): Connector;
     toString(): string;
@@ -606,6 +631,6 @@ declare class FlexOrchReader {
     toString(): string;
 }
 
-declare const version = "0.3.1";
+declare const version = "0.3.3";
 
 export { AuthError, Connector, type ConnectorTestResult, type ConnectorType, Dataset, Document, type ExportFormat, FlexOrchClient, type FlexOrchClientOptions, FlexOrchError, FlexOrchReader, FlexOrchRetriever, Job, JobFailedError, type JobFeedback, JobTimeoutError, NotFoundError, type QualityTrendItem, QuotaError, RAGDocument, RateLimitError, type RateLimitStatus, type ReaderLoadOptions, type RetrieverOptions, type S3ConnectorConfig, type SearchFilters, SearchResult, ServerError, type SyncLog, type SyncSchedule, type UsageHistoryItem, type UsageSnapshot, ValidationError, type Webhook, type WebhookEvent, version };

package/dist/index.d.ts

@@ -22,6 +22,9 @@ declare class Dataset {
     readonly slug: string;
     readonly status: string;
     readonly rowCount: number;
+    readonly piiMasked: boolean;
+    readonly piiFindingsCount: number;
+    readonly piiTypeSummary: Record<string, number>;
     readonly createdAt: string;
     readonly availableFormats: string[];
     private readonly _transport;
@@ -31,6 +34,9 @@ declare class Dataset {
         slug: string;
         status: string;
         rowCount: number;
+        piiMasked: boolean;
+        piiFindingsCount: number;
+        piiTypeSummary: Record<string, number>;
         createdAt: string;
         availableFormats: string[];
         _transport: Transport;
@@ -112,6 +118,9 @@ declare class Job {
      */
     readonly degraded: boolean;
     readonly failureReason: string | null;
+    readonly piiMasked: boolean;
+    readonly piiFindingsCount: number;
+    readonly piiTypeSummary: Record<string, number>;
     private readonly _transport;
     constructor(data: {
         id: string;
@@ -124,6 +133,9 @@ declare class Job {
         datasetId: number | null;
         degraded: boolean;
         failureReason: string | null;
+        piiMasked: boolean;
+        piiFindingsCount: number;
+        piiTypeSummary: Record<string, number>;
         _transport: Transport;
     });
     static fromDict(data: Record<string, unknown>, transport: Transport): Job;
@@ -334,18 +346,27 @@ declare class UsageResource {
     rateLimits(): Promise<RateLimitStatus>;
 }
 
-type WebhookEvent = "dataset.ready" | "job.completed" | "job.failed";
+type WebhookEvent = "dataset.ready" | "job.completed" | "job.failed" | "quota.warning";
+interface WebhookAutoExport {
+    connectorId: number;
+    format: string;
+    prefix?: string;
+}
 interface Webhook {
     id: string;
     url: string;
     events: WebhookEvent[];
     active: boolean;
     createdAt: string;
+    autoExport: WebhookAutoExport | null;
+    /** Signing secret — only present on the response from register(). Store it
+     * securely; it is never returned again by list()/get(). */
+    secret: string | null;
 }
 declare class WebhooksResource {
     private readonly _t;
     constructor(_t: Transport);
-    register(url: string, events: WebhookEvent[]): Promise<Webhook>;
+    register(url: string, events: WebhookEvent[], autoExport?: WebhookAutoExport): Promise<Webhook>;
     list(): Promise<Webhook[]>;
     delete(webhookId: string): Promise<void>;
 }
@@ -358,6 +379,9 @@ declare class Connector {
     readonly lastTestedAt: string | null;
     readonly lastUsedAt: string | null;
     readonly createdAt: string;
+    /** Non-secret config fields (bucket/region, folder_id, index_name, etc.) —
+     * credentials are never included. */
+    readonly config: Record<string, unknown>;
     constructor(data: {
         id: string;
         name: string;
@@ -366,6 +390,7 @@ declare class Connector {
         lastTestedAt: string | null;
         lastUsedAt: string | null;
         createdAt: string;
+        config?: Record<string, unknown>;
     });
     static fromDict(data: Record<string, unknown>): Connector;
     toString(): string;
@@ -606,6 +631,6 @@ declare class FlexOrchReader {
     toString(): string;
 }
 
-declare const version = "0.3.1";
+declare const version = "0.3.3";
 
 export { AuthError, Connector, type ConnectorTestResult, type ConnectorType, Dataset, Document, type ExportFormat, FlexOrchClient, type FlexOrchClientOptions, FlexOrchError, FlexOrchReader, FlexOrchRetriever, Job, JobFailedError, type JobFeedback, JobTimeoutError, NotFoundError, type QualityTrendItem, QuotaError, RAGDocument, RateLimitError, type RateLimitStatus, type ReaderLoadOptions, type RetrieverOptions, type S3ConnectorConfig, type SearchFilters, SearchResult, ServerError, type SyncLog, type SyncSchedule, type UsageHistoryItem, type UsageSnapshot, ValidationError, type Webhook, type WebhookEvent, version };

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   Dataset
-} from "./chunk-4KCMMRD7.js";
+} from "./chunk-U2CE5GVG.js";
 
 // src/errors.ts
 var FlexOrchError = class extends Error {
@@ -123,7 +123,7 @@ var Transport = class {
     this.fetchFn = fetchFn ?? globalThis.fetch.bind(globalThis);
     this.defaultHeaders = {
       "X-API-KEY": apiKey,
-      "User-Agent": "flexorch-sdk-js/0.3.1"
+      "User-Agent": "flexorch-sdk-js/0.3.3"
     };
   }
   url(path, params) {
@@ -229,6 +229,9 @@ var Job = class _Job {
    */
   degraded;
   failureReason;
+  piiMasked;
+  piiFindingsCount;
+  piiTypeSummary;
   _transport;
   constructor(data) {
     this.id = data.id;
@@ -241,12 +244,16 @@ var Job = class _Job {
     this.datasetId = data.datasetId;
     this.degraded = data.degraded;
     this.failureReason = data.failureReason;
+    this.piiMasked = data.piiMasked;
+    this.piiFindingsCount = data.piiFindingsCount;
+    this.piiTypeSummary = data.piiTypeSummary;
     this._transport = data._transport;
   }
   static fromDict(data, transport) {
     const executionSummary = data["execution_summary"];
     const processingSummary = data["processing_summary"];
     const datasetSummary = data["dataset_summary"];
+    const privacy = executionSummary?.["privacy"];
     let quality = data["quality"];
     if (!quality && processingSummary) {
       quality = processingSummary["quality"];
@@ -269,6 +276,13 @@ var Job = class _Job {
       datasetId: datasetSummary?.["dataset_id"] ?? null,
       degraded: Boolean(executionSummary?.["degraded"] ?? false),
       failureReason: data["failure_reason"] ?? null,
+      // execution_summary.privacy — computed fresh on every GET /jobs/{id}
+      // read, not frozen at job-completion time, so this works even for
+      // jobs older than this field. Defaults for jobs with no execution
+      // (e.g. dataset_build) or against an older API version.
+      piiMasked: Boolean(privacy?.["privacy_applied"] ?? false),
+      piiFindingsCount: Number(privacy?.["pii_findings_count"] ?? 0),
+      piiTypeSummary: privacy?.["pii_type_summary"] ?? {},
       _transport: transport
     });
   }
@@ -294,7 +308,7 @@ var Job = class _Job {
     throw new JobTimeoutError(this.id, timeout);
   }
   async dataset() {
-    const { Dataset: Dataset2 } = await import("./dataset-E7EXJETI.js");
+    const { Dataset: Dataset2 } = await import("./dataset-UGUUKKH3.js");
     if (this.datasetId !== null) {
       const data2 = await this._transport.get(`/datasets/${this.datasetId}`);
       return Dataset2.fromDict(data2, this._transport);
@@ -631,14 +645,25 @@ var UsageResource = class {
 };
 
 // src/resources/webhooks.ts
-var VALID_EVENTS = /* @__PURE__ */ new Set(["dataset.ready", "job.completed", "job.failed"]);
+var VALID_EVENTS = /* @__PURE__ */ new Set(["dataset.ready", "job.completed", "job.failed", "quota.warning"]);
+function autoExportFromDict(data) {
+  if (!data || typeof data !== "object") return null;
+  const d = data;
+  return {
+    connectorId: Number(d["connector_id"] ?? 0),
+    format: String(d["format"] ?? ""),
+    prefix: d["prefix"] !== void 0 ? String(d["prefix"]) : void 0
+  };
+}
 function webhookFromDict(data) {
   return {
     id: String(data["id"] ?? ""),
     url: String(data["url"] ?? ""),
     events: data["events"] ?? [],
     active: Boolean(data["active"] ?? true),
-    createdAt: String(data["created_at"] ?? "")
+    createdAt: String(data["created_at"] ?? ""),
+    autoExport: autoExportFromDict(data["auto_export"]),
+    secret: data["secret"] ?? null
   };
 }
 var WebhooksResource = class {
@@ -646,12 +671,20 @@ var WebhooksResource = class {
     this._t = _t;
   }
   _t;
-  async register(url, events) {
+  async register(url, events, autoExport) {
     const invalid = events.filter((e) => !VALID_EVENTS.has(e));
     if (invalid.length > 0) {
       throw new Error(`Unknown event types: ${invalid.join(", ")}. Valid: ${[...VALID_EVENTS].join(", ")}`);
     }
-    const data = await this._t.post("/webhooks", { url, events });
+    const body = { url, events };
+    if (autoExport) {
+      body["auto_export"] = {
+        connector_id: autoExport.connectorId,
+        format: autoExport.format,
+        ...autoExport.prefix !== void 0 ? { prefix: autoExport.prefix } : {}
+      };
+    }
+    const data = await this._t.post("/webhooks", body);
     return webhookFromDict(data);
   }
   async list() {
@@ -673,6 +706,9 @@ var Connector = class _Connector {
   lastTestedAt;
   lastUsedAt;
   createdAt;
+  /** Non-secret config fields (bucket/region, folder_id, index_name, etc.) —
+   * credentials are never included. */
+  config;
   constructor(data) {
     this.id = data.id;
     this.name = data.name;
@@ -681,6 +717,7 @@ var Connector = class _Connector {
     this.lastTestedAt = data.lastTestedAt;
     this.lastUsedAt = data.lastUsedAt;
     this.createdAt = data.createdAt;
+    this.config = data.config ?? {};
   }
   static fromDict(data) {
     return new _Connector({
@@ -690,7 +727,8 @@ var Connector = class _Connector {
       active: Boolean(data["active"] ?? true),
       lastTestedAt: data["last_tested_at"] ?? null,
       lastUsedAt: data["last_used_at"] ?? null,
-      createdAt: String(data["created_at"] ?? "")
+      createdAt: String(data["created_at"] ?? ""),
+      config: data["config"] ?? {}
     });
   }
   toString() {
@@ -1082,7 +1120,7 @@ var FlexOrchReader = class {
 };
 
 // src/index.ts
-var version = "0.3.1";
+var version = "0.3.3";
 export {
   AuthError,
   Connector,

package/package.json

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