@alvera-ai/platform-sdk 0.5.2 → 0.6.0

package/README.md

@@ -13,6 +13,40 @@ npm install @alvera-ai/platform-sdk
 pnpm add @alvera-ai/platform-sdk
 ```
 
+## TypeScript configuration
+
+The SDK uses [`@hey-api/client-fetch`](https://heyapi.dev/openapi-ts/clients/fetch),
+whose generated code references WHATWG fetch types — `BodyInit`,
+`RequestInit`, `Headers`, `FormData`, etc. Those names live in
+`lib.dom.d.ts`, not `@types/node`, so a Node-only consumer with
+`"lib": ["ES2022"]` in its `tsconfig.json` will see errors like
+`Cannot find name 'BodyInit'` when typechecking.
+
+The fix is to add `DOM` and `DOM.Iterable` to your `lib`:
+
+```jsonc
+// tsconfig.json
+{
+  "compilerOptions": {
+    "lib": ["ES2022", "DOM", "DOM.Iterable"]
+    //               ^^^^^^^^^^^^^^^^^^^^^^^
+    // Required by @hey-api/client-fetch — see
+    //   https://github.com/hey-api/openapi-ts/issues/2539
+    // Provides type-only declarations for fetch globals.
+    // Adds NOTHING to the runtime — Node 18+ provides real fetch
+    // independently of these types.
+  }
+}
+```
+
+This is the workaround documented in hey-api's open issue
+[#2539](https://github.com/hey-api/openapi-ts/issues/2539); when
+the upstream fix lands and emits self-contained types, you can
+drop the `DOM` lib entries again.
+
+Browser consumers (React, Vue, Next, Nuxt, Remix) already have
+`DOM` and `DOM.Iterable` enabled by default — no change needed.
+
 ## Quick start
 
 ```ts

package/package.json

@@ -1,23 +1,23 @@
 {
   "name": "@alvera-ai/platform-sdk",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "description": "Typed SDK for the Alvera platform API — manage data sources, tools, generic tables, AI agents, and action status updaters.",
   "type": "module",
   "sideEffects": false,
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./src/index.ts",
+  "module": "./src/index.ts",
+  "types": "./src/index.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "types": "./src/index.ts",
+      "import": "./src/index.ts"
     }
   },
   "bin": {
-    "alvera": "./dist/cli.js"
+    "alvera": "./src/cli.ts"
   },
   "files": [
-    "dist",
+    "src",
     "README.md",
     "LICENSE"
   ],
@@ -30,10 +30,9 @@
     "codegen": "openapi-ts && tsx scripts/patch-generated.ts",
     "check-coverage": "tsx scripts/check-sdk-coverage.ts",
     "regen": "pnpm gen-environments && pnpm codegen && pnpm check-coverage",
-    "build": "tsc",
     "typecheck": "tsc --noEmit && tsc --noEmit -p scripts/tsconfig.json",
-    "clean": "rm -rf dist src/generated src/environments.generated.ts",
-    "prepack": "pnpm gen-environments && pnpm codegen && pnpm check-coverage && pnpm build"
+    "clean": "rm -rf src/generated src/environments.generated.ts",
+    "prepare": "pnpm gen-environments && pnpm codegen && pnpm check-coverage"
   },
   "dependencies": {
     "commander": "14.0.3",