@productcraft/trawl 0.1.2 → 0.2.0

package/README.md

@@ -23,7 +23,8 @@ import: `npm install productcraft`.
 ```ts
 import { Trawl } from "@productcraft/trawl";
 
-const trawl = new Trawl({ auth: { type: "apiKey", key: process.env.PCFT_KEY! } });
+// Reads PRODUCTCRAFT_API_KEY from the environment
+const trawl = new Trawl();
 
 // Submit an extraction job (workspace-scoped).
 const { data, error } = await trawl.client.POST(
@@ -51,10 +52,23 @@ register a webhook (`POST /v1/workspaces/{workspaceId}/webhooks`) to have
 the terminal result delivered to you. Job submission is rate-limited per
 workspace (default 10/min); a `429` carries a `Retry-After` header.
 
+## Credentials from the environment
+
+Server-side, omit `auth` and the client reads your workspace key from the environment:
+
+```bash
+# .env
+PRODUCTCRAFT_API_KEY=pcft_live_...
+```
+
+- An explicit `auth` always wins over the environment.
+- Hosts are never read from the environment. Override them in code with `baseUrl`.
+- This is a server-only fallback. Never put a key in `NEXT_PUBLIC_*` or any other variable a bundler inlines into browser code.
+
 ## Auth
 
-Pass a workspace API key (`pcft_live_*`) as `{ type: "apiKey", key }`. The
-client sets `Authorization: Bearer <key>` on every request.
+Pass a workspace API key (`pcft_live_*`) as `{ type: "apiKey", key }`, or omit
+`auth` to use `PRODUCTCRAFT_API_KEY` (see above). The client sets `Authorization: Bearer <key>` on every request.
 
 ## License
 

package/dist/index.d.cts

@@ -408,7 +408,9 @@ interface components {
              *       "type": "object"
              *     }
              */
-            json_schema: Record<string, never>;
+            json_schema: {
+                [key: string]: unknown;
+            };
             /**
              * @description Maximum number of agent steps (one LLM call each) before the job stops. Defaults to 20. Multi-source extractions typically need 40+. The server additionally clamps this to an operator ceiling, so a very large value does not guarantee a very long run — `timeout_s` still applies.
              * @default 20
@@ -528,10 +530,16 @@ interface components {
             enqueued_at: string;
             error: string | null;
             id: string;
-            json_schema: Record<string, never>;
+            /** @description The JSON Schema the job was created with. */
+            json_schema: {
+                [key: string]: unknown;
+            };
             max_steps: number;
             model_tier: string;
-            result: Record<string, never> | null;
+            /** @description The extracted data, shaped by `json_schema`. Null until the job succeeds. */
+            result: {
+                [key: string]: unknown;
+            } | null;
             started_at: string | null;
             /** @enum {string} */
             status: "queued" | "running" | "succeeded" | "failed" | "cancelled";

package/dist/index.d.ts

@@ -408,7 +408,9 @@ interface components {
              *       "type": "object"
              *     }
              */
-            json_schema: Record<string, never>;
+            json_schema: {
+                [key: string]: unknown;
+            };
             /**
              * @description Maximum number of agent steps (one LLM call each) before the job stops. Defaults to 20. Multi-source extractions typically need 40+. The server additionally clamps this to an operator ceiling, so a very large value does not guarantee a very long run — `timeout_s` still applies.
              * @default 20
@@ -528,10 +530,16 @@ interface components {
             enqueued_at: string;
             error: string | null;
             id: string;
-            json_schema: Record<string, never>;
+            /** @description The JSON Schema the job was created with. */
+            json_schema: {
+                [key: string]: unknown;
+            };
             max_steps: number;
             model_tier: string;
-            result: Record<string, never> | null;
+            /** @description The extracted data, shaped by `json_schema`. Null until the job succeeds. */
+            result: {
+                [key: string]: unknown;
+            } | null;
             started_at: string | null;
             /** @enum {string} */
             status: "queued" | "running" | "succeeded" | "failed" | "cancelled";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@productcraft/trawl",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "AI web-extraction — submit a JSON Schema + natural-language description, get schema-conforming data extracted from the live web and delivered to an HMAC-signed webhook via ProductCraft Trawl. Generated from the production OpenAPI spec.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "openapi-fetch": "^0.13.0",
-    "@productcraft/core": "^0.2.1"
+    "@productcraft/core": "^0.3.0"
   },
   "scripts": {
     "build": "tsup"