@apicrafthq/script-sdk 0.1.0-beta.1 → 0.1.0-beta.3

package/dist/index.d.ts

@@ -11,12 +11,20 @@ interface HttpRequestInit {
     /** Serialized according to the Content-Type. */
     body?: unknown;
     query?: Record<string, string>;
-}
-interface HttpResponse {
+    /** Workflow scripts only: resolve `{{placeholders}}` against this API's bound environment. */
+    api?: string;
+}
+/**
+ * Parsed JSON when the response is JSON, the raw string otherwise, null when empty.
+ * Kept permissive so scripts can write `body.items[0].id` without narrowing first.
+ */
+type HttpResponseBody = any;
+interface HttpResponse<TBody = HttpResponseBody> {
     status: number;
     statusText: string;
     headers: Record<string, string>;
-    body: Record<string, any>;
+    body: TBody;
+    duration?: number;
 }
 /** Persistent key/value store across executions. */
 interface ScriptCache {
@@ -75,40 +83,38 @@ interface ResolvedRequest {
     body?: unknown;
 }
 
-/** Shared base for workflow scripts (assert, condition, script). */
+/**
+ * Known workflow block ids. Augmented per-API by the generated env.d.ts so
+ * `blockResult(...)` autocompletes real block ids; falls back to `string`.
+ */
+interface BlockResultSchema {
+}
+type WorkflowBlockId = keyof BlockResultSchema extends never ? string : keyof BlockResultSchema | (string & {});
+/** Shared base for workflow scripts (assert, condition, transform, script). */
 interface WorkflowScopedContext extends BaseContext {
     /** Reads the result of a previous block by its id. */
-    blockResult(blockId: string): BlockResult;
-    /** Writes a variable available to later blocks. */
-    setVar(name: string, value: unknown): void;
-    /** Runs an existing request instance and returns its response. */
-    executeRequest(resource: string, instance: string, overrides?: RequestOverrides): Promise<HttpResponse>;
-    /** Non-blocking pause, e.g. for polling. */
-    sleep(milliseconds: number): Promise<void>;
+    blockResult<K extends WorkflowBlockId>(blockId: K): K extends keyof BlockResultSchema ? BlockResultSchema[K] : BlockResult;
+    /** Resolved environment of an API bound to this run. Throws when the API is unbound. */
+    env(apiSlug: string): Promise<Record<string, string | number | boolean>>;
 }
 interface BlockResult {
     /** Present for `request` blocks. */
     response?: HttpResponse;
     [key: string]: unknown;
 }
-interface RequestOverrides {
-    params?: {
-        path?: Record<string, string>;
-        query?: Record<string, string>;
-        header?: Record<string, string>;
-    };
-    body?: {
-        data?: unknown;
-    };
-}
 /** Context for an assert script. Throw to fail the assertion. */
 interface AssertContext extends WorkflowScopedContext {
 }
 /** Context for a condition script. Return a boolean to pick then/else. */
 interface ConditionContext extends WorkflowScopedContext {
 }
-/** Context for a free-form script block. */
+/** Context for a transform script. Return an object; its keys become the block's outputs. */
+interface TransformContext extends WorkflowScopedContext {
+}
+/** Context for a free-form script block (side-effects only, e.g. wait/poll). */
 interface ScriptContext extends WorkflowScopedContext {
+    /** Non-blocking pause, e.g. for polling. */
+    sleep(milliseconds: number): Promise<void>;
 }
 
-export type { AfterResponseContext, AssertContext, BaseContext, BeforeRequestContext, BlockResult, ConditionContext, EnvSchema, HttpClient, HttpRequestInit, HttpResponse, MutableResolvedRequest, RequestOverrides, RequestScopedContext, ResolvedRequest, ScriptCache, ScriptContext, ScriptLogger, WorkflowScopedContext };
+export type { AfterResponseContext, AssertContext, BaseContext, BeforeRequestContext, BlockResult, BlockResultSchema, ConditionContext, EnvSchema, HttpClient, HttpRequestInit, HttpResponse, HttpResponseBody, MutableResolvedRequest, RequestScopedContext, ResolvedRequest, ScriptCache, ScriptContext, ScriptLogger, TransformContext, WorkflowScopedContext };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apicrafthq/script-sdk",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0-beta.3",
   "type": "module",
   "description": "TypeScript types for API Craft middleware and custom-auth scripts.",
   "license": "MIT",
@@ -34,25 +34,18 @@
   },
   "exports": {
     ".": {
+      "development": "./src/index.ts",
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
-    },
-    "./testing": {
-      "types": "./dist/testing.d.ts",
-      "import": "./dist/testing.js"
     }
   },
   "devDependencies": {
-    "@types/chai": "^5.2.0",
     "tsup": "^8",
     "typescript": "^5"
   },
-  "dependencies": {
-    "@vitest/expect": "^3.2.0",
-    "chai": "^5.1.2"
-  },
   "scripts": {
-    "build": "tsup src/index.ts src/testing.ts --format esm --dts --clean",
-    "dev": "tsup src/index.ts src/testing.ts --format esm --dts --watch"
+    "build": "tsup src/index.ts --format esm --dts --clean",
+    "dev": "tsup src/index.ts --format esm --dts --watch",
+    "typecheck": "tsc --noEmit -p tsconfig.json"
   }
 }

package/dist/testing.d.ts

@@ -1,5 +0,0 @@
-import { ExpectStatic } from '@vitest/expect';
-
-declare const expect: ExpectStatic;
-
-export { expect };

package/dist/testing.js

@@ -1,10 +0,0 @@
-// src/expect.ts
-import * as chai from "chai";
-import { JestExtend, JestChaiExpect, JestAsymmetricMatchers } from "@vitest/expect";
-chai.use(JestExtend);
-chai.use(JestChaiExpect);
-chai.use(JestAsymmetricMatchers);
-var expect2 = chai.expect;
-export {
-  expect2 as expect
-};