@onabl/js 0.1.2 → 0.1.3

package/README.md

@@ -1,25 +1,62 @@
 # `@onabl/js`
 
-Framework-agnostic core of the onabl SDK. No React, no DOM assumptions —
-`@onabl/react` and `@onabl/next` build on top of this.
+Framework-agnostic JavaScript/TypeScript client for the onabl API. No React,
+no DOM assumptions — install this directly in any JS backend, or use
+`@onabl/react` / `@onabl/next` for framework-specific integration.
 
-**Status:** skeleton only (Phase 14 §14.5.2, in progress). See
-`docs/SDK-DESIGN.md` for the full intended API surface before adding to this
-package, and `docs/INTEGRATION-LAYER-TODO.md` for current build status.
+## Install
 
-## What belongs here
+```bash
+npm install @onabl/js
+```
 
-- `createOnablClient()` — the typed API client
+## Usage
+
+```ts
+import {createOnablClient} from "@onabl/js";
+
+const onabl = createOnablClient({
+  handle: "acme", // your onabl tenant handle
+  secretKey: process.env.ONABL_SECRET_KEY!, // server-side only, never expose to the browser
+});
+
+const form = await onabl.forms.get();
+
+const {quoteId, quoteUrl, token} = await onabl.submissions.create({
+  hours: 4,
+  serviceType: "design",
+});
+```
+
+`secretKey` must never reach the browser. If you're building a Next.js app,
+use `@onabl/next` instead, which keeps the secret key server-side for you.
+
+## What's included
+
+- `createOnablClient()` — the typed API client (forms, submissions, quotes,
+  invoices, storage)
 - `OnablError` and its subclasses (`OnablNotFound`, `OnablUnauthorized`,
-  `OnablValidation`, `OnablNetwork`)
-- The condition evaluator and form state machine, extracted from
-  `apps/web/components/form/MultiStepForm.tsx`
-- `presentQuote` / `groupLineItems`, re-exported (and bundled — see
-  `tsup.config.ts`) from `@onabl/engine`, which is never published on its own
-
-## Build
-
-Built with `tsup`, not plain `tsc` — `@onabl/engine`'s presentation code has
-to be bundled into this package's output since `@onabl/engine` itself is
-private and never installable on its own. See the comment in
-`tsup.config.ts` before changing the dependency/build setup.
+  `OnablValidation`, `OnablNetwork`) for typed error handling
+- `presentQuote` / `groupLineItems` — helpers for rendering a quote's line
+  items and totals
+- Form helpers (`getVisibleSteps`, `getAllFields`, `getInitialAnswers`,
+  `validateFields`) for building a custom multi-step quote form UI
+
+## Errors
+
+All client calls throw a subclass of `OnablError` on failure:
+
+```ts
+import {OnablNotFound, OnablValidation} from "@onabl/js";
+
+try {
+  await onabl.quotes.get(uuid, {token});
+} catch (err) {
+  if (err instanceof OnablNotFound) {
+    // handle missing quote
+  }
+  if (err instanceof OnablValidation) {
+    // err.fieldErrors has per-field details
+  }
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onabl/js",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Framework-agnostic onabl SDK core — typed API client, error classes, condition evaluator, form state machine, and quote presentation. No React, no DOM assumptions. See docs/SDK-DESIGN.md.",
   "license": "MIT",
   "repository": {
@@ -30,12 +30,12 @@
     "vitest": "^1.6.0",
     "typescript": "^5.4.0",
     "@onabl/engine": "0.0.1",
-    "@onabl/typescript-config": "0.0.1",
-    "@onabl/eslint-config": "0.0.1"
+    "@onabl/eslint-config": "0.0.1",
+    "@onabl/typescript-config": "0.0.1"
   },
   "dependencies": {
-    "@onabl/contracts": "0.1.1",
-    "@onabl/types": "0.1.0"
+    "@onabl/contracts": "0.1.2",
+    "@onabl/types": "0.1.1"
   },
   "scripts": {
     "build": "tsup",