@anyformat/sdk 0.2.0 → 0.2.2

package/README.md

@@ -24,6 +24,15 @@ const result = await af
 result.field("vendor")?.value; // -> "Acme Corp"
 ```
 
+## Managing workflows
+
+```ts
+const workflows = await af.listWorkflows({ pageSize: 50 }); // -> Workflow[]
+for (const wf of workflows) console.log(wf.id, wf.name);
+
+await af.deleteWorkflow(workflows[0].id); // -> the deleted id
+```
+
 ## How it's built
 
 The wire types and the low-level HTTP client are **generated** from the API's

package/dist/index.cjs

@@ -26,6 +26,7 @@ __export(index_exports, {
   BadRequest: () => BadRequest,
   Forbidden: () => Forbidden,
   NotFound: () => NotFound,
+  ParseView: () => ParseView,
   RateLimited: () => RateLimited,
   Result: () => Result,
   Run: () => Run,
@@ -33,6 +34,7 @@ __export(index_exports, {
   Schema: () => Schema,
   ServerError: () => ServerError,
   Unauthorized: () => Unauthorized,
+  Workflow: () => Workflow,
   WorkflowBuilder: () => WorkflowBuilder,
   WorkflowBuilderError: () => WorkflowBuilderError
 });
@@ -42,18 +44,62 @@ module.exports = __toCommonJS(index_exports);
 var import_node_fs = require("fs");
 var import_node_path = require("path");
 
+// src/parse-view.ts
+var ParseView = class {
+  /** @internal */
+  constructor(parse) {
+    this.parse = parse;
+  }
+  parse;
+  get markdown() {
+    return this.parse.markdown ?? null;
+  }
+  get text() {
+    return this.parse.text ?? null;
+  }
+  get blocks() {
+    return this.parse.blocks ?? [];
+  }
+  /**
+   * Document-level confidence (0-100) in the parsed content. May be `null` for
+   * some parse modes — fall back to `layoutConfidence`.
+   */
+  get parseConfidence() {
+    return this.parse.parse_confidence ?? null;
+  }
+  /**
+   * Document-level confidence (0-100) in the page layout (block positions).
+   * `null` when not available.
+   */
+  get layoutConfidence() {
+    return this.parse.layout_confidence ?? null;
+  }
+};
+
 // src/result.ts
 var Result = class {
   constructor(raw) {
     this.raw = raw;
   }
   raw;
+  _parse;
   get collectionId() {
     return this.raw.collection_id;
   }
   get extractions() {
     return this.raw.extractions ?? [];
   }
+  /**
+   * Typed view over the parse node's output, or `null` when the workflow has
+   * no parse node. Cached so repeated access doesn't re-wrap.
+   */
+  get parse() {
+    if (this._parse === void 0) {
+      const raw = this.raw.parse;
+      this._parse = raw ? new ParseView(raw) : null;
+    }
+    return this._parse;
+  }
   /**
    * Convenience accessor for a top-level scalar field on the first
    * extraction (linear workflows). Returns `undefined` for missing fields
@@ -926,6 +972,11 @@ var createClient = (config = {}) => {
 var client = createClient(createConfig({ baseUrl: "https://api-dev.anyformat.ai" }));
 
 // src/sdk/sdk.gen.ts
+var v2ListWorkflows = (options) => (options?.client ?? client).get({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/v2/workflows/",
+  ...options
+});
 var v2CreateWorkflow = (options) => (options.client ?? client).post({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/v2/workflows/",
@@ -935,6 +986,20 @@ var v2CreateWorkflow = (options) => (options.client ?? client).post({
     ...options.headers
   }
 });
+var v2DeleteWorkflow = (options) => (options.client ?? client).delete({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/v2/workflows/{workflow_id}/",
+  ...options
+});
+var v2UpdateWorkflow = (options) => (options.client ?? client).put({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/v2/workflows/{workflow_id}/",
+  ...options,
+  headers: {
+    "Content-Type": "application/json",
+    ...options.headers
+  }
+});
 var v2GetFileResults = (options) => (options.client ?? client).get({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/v2/workflows/{workflow_id}/files/{collection_id}/results/",
@@ -953,45 +1018,23 @@ var v2RunWorkflow = (options) => (options.client ?? client).post({
 
 // src/run.ts
 var Run = class {
-  constructor(client2, request, file, text) {
+  /** @internal */
+  constructor(client2, workflowId, id) {
     this.client = client2;
-    this.request = request;
-    this.file = file;
-    this.text = text;
+    this.workflowId = workflowId;
+    this.id = id;
   }
   client;
-  request;
-  file;
-  text;
-  workflowId = null;
-  collectionId = null;
-  /**
-   * Create the workflow and submit the document — exactly once per `Run`.
-   * Memoized so that retrying `wait()` after an `SDKTimeout` resumes polling
-   * the in-flight run instead of creating a duplicate workflow + submission.
-   */
-  async submit() {
-    if (this.collectionId !== null) return;
-    const created = await v2CreateWorkflow({ client: this.client, body: this.request });
-    if (created.error) throw toApiError(created.response?.status ?? 500, created.error);
-    this.workflowId = created.data.id;
-    const submitted = await v2RunWorkflow({
-      client: this.client,
-      path: { workflow_id: this.workflowId },
-      body: { file: this.file, text: this.text }
-    });
-    if (submitted.error) throw toApiError(submitted.response?.status ?? 500, submitted.error);
-    this.collectionId = submitted.data.id;
-  }
+  workflowId;
+  id;
   async wait(opts = {}) {
-    const timeoutMs = opts.timeoutMs ?? 12e4;
-    const pollMs = opts.pollMs ?? 2e3;
-    await this.submit();
+    const timeoutMs = opts.timeoutMs ?? 3e5;
+    const pollMs = opts.pollMs ?? 3e3;
     const deadline = Date.now() + timeoutMs;
     while (Date.now() < deadline) {
       const results = await v2GetFileResults({
         client: this.client,
-        path: { workflow_id: this.workflowId, collection_id: this.collectionId }
+        path: { workflow_id: this.workflowId, collection_id: this.id }
       });
       if (!results.error) return new Result(results.data);
       if (results.response?.status !== 412) {
@@ -1003,6 +1046,43 @@ var Run = class {
   }
 };
 
+// src/workflow.ts
+var Workflow = class {
+  /** @internal */
+  constructor(client2, id, name) {
+    this.client = client2;
+    this.id = id;
+    this.name = name;
+  }
+  client;
+  id;
+  name;
+  /** Submit a document against this workflow and return a pending `Run`. */
+  async run(file = null, opts = {}) {
+    if (file === null && !opts.text) {
+      throw new WorkflowBuilderError("run() requires a document \u2014 pass a file or non-empty opts.text");
+    }
+    if (file !== null && opts.text !== void 0) {
+      throw new WorkflowBuilderError("run() accepts either a file or text, not both");
+    }
+    if (file !== null) {
+      const filename = file.name;
+      if (typeof filename !== "string" || filename.length === 0) {
+        throw new WorkflowBuilderError(
+          'run() needs a named file so the server can detect its type \u2014 pass a File, e.g. new File([bytes], "invoice.pdf"), not a bare Blob'
+        );
+      }
+    }
+    const submitted = await v2RunWorkflow({
+      client: this.client,
+      path: { workflow_id: this.id },
+      body: { file, text: opts.text ?? null }
+    });
+    if (submitted.error) throw toApiError(submitted.response?.status ?? 500, submitted.error);
+    return new Run(this.client, this.id, submitted.data.id);
+  }
+};
+
 // src/builder.ts
 var WorkflowBuilder = class {
   constructor(client2, name, description) {
@@ -1034,7 +1114,8 @@ var WorkflowBuilder = class {
       id: opts.id ?? this.nextId("parse"),
       mode: opts.mode ?? "standard",
       ...opts.promptHint !== void 0 ? { prompt_hint: opts.promptHint } : {},
-      figure_enhancement: opts.figureEnhancement ?? false
+      figure_enhancement: opts.figureEnhancement ?? false,
+      cache: opts.cache ?? true
     };
     return this;
   }
@@ -1165,26 +1246,17 @@ var WorkflowBuilder = class {
     }
     return { name: this.name, description: this.description, nodes, edges };
   }
-  /** Persist the workflow and return its id. */
+  /** Persist the workflow and return a handle you can `.run(file)` on. */
   async create() {
     const res = await v2CreateWorkflow({ client: this.client, body: this.build() });
     if (res.error) throw toApiError(res.response?.status ?? 500, res.error);
-    return res.data.id;
+    return new Workflow(this.client, res.data.id, res.data.name);
   }
-  /** Create the workflow, submit a document, and return a pending `Run`. */
-  run(file = null, opts = {}) {
-    this.require(
-      !(file === null && opts.text === void 0),
-      "run() requires a document \u2014 pass a file or opts.text"
-    );
-    if (file !== null) {
-      const filename = file.name;
-      this.require(
-        typeof filename === "string" && filename.length > 0,
-        'run() needs a named file so the server can detect its type \u2014 pass a File, e.g. new File([bytes], "invoice.pdf"), not a bare Blob'
-      );
-    }
-    return new Run(this.client, this.build(), file, opts.text ?? null);
+  /** Replace an existing workflow's definition and return a handle you can `.run(file)` on. */
+  async update(workflowId) {
+    const res = await v2UpdateWorkflow({ client: this.client, path: { workflow_id: workflowId }, body: this.build() });
+    if (res.error) throw toApiError(res.response?.status ?? 500, res.error);
+    return new Workflow(this.client, res.data.id, res.data.name);
   }
 };
 
@@ -1196,13 +1268,32 @@ var Anyformat = class {
     this._client = createClient(
       createConfig({
         baseUrl: opts.baseUrl ?? "https://api.anyformat.ai",
-        auth: opts.apiKey
+        auth: opts.apiKey,
+        // Identifies the caller in our logs (Datadog facet). Plain HTTP callers
+        // send no such header and are logged as origin "api".
+        headers: { "x-anyformat-origin": "js-sdk" }
       })
     );
   }
   workflow(name, description) {
     return new WorkflowBuilder(this._client, name, description);
   }
+  async listWorkflows(opts) {
+    const res = await v2ListWorkflows({
+      client: this._client,
+      query: { page: opts?.page, page_size: opts?.pageSize, status: opts?.status }
+    });
+    if (res.error) throw toApiError(res.response?.status ?? 500, res.error);
+    return res.data.results.map((r) => new Workflow(this._client, r.id, r.name ?? ""));
+  }
+  async deleteWorkflow(workflowId) {
+    const res = await v2DeleteWorkflow({
+      client: this._client,
+      path: { workflow_id: workflowId }
+    });
+    if (res.error) throw toApiError(res.response?.status ?? 500, res.error);
+    return workflowId;
+  }
 };
 
 // src/schema.ts
@@ -1230,6 +1321,7 @@ var Schema = {
   BadRequest,
   Forbidden,
   NotFound,
+  ParseView,
   RateLimited,
   Result,
   Run,
@@ -1237,6 +1329,7 @@ var Schema = {
   Schema,
   ServerError,
   Unauthorized,
+  Workflow,
   WorkflowBuilder,
   WorkflowBuilderError
 });