@truenorth-it/dataverse-client 1.0.2 → 1.0.4

package/README.md

@@ -1,6 +1,10 @@
 # @truenorth-it/dataverse-client
 
-A type-safe JavaScript client for the Dataverse Contact API. Works with **any** deployment — generate TypeScript types specific to your Dataverse org, or use it untyped.
+**Unlock your Dataverse data.** Your CRM data is trapped behind OData queries, Azure AD service principals, and Microsoft SDK complexity. Your frontend team just wants JSON. This package is the key.
+
+A type-safe JavaScript/TypeScript client that turns your Dataverse instance into clean REST endpoints. Secure by architecture — every request is authenticated, authorised, and scoped to the logged-in user. No Microsoft dependencies in your frontend. No Azure tokens in the browser.
+
+Works with **any** deployment — generate TypeScript types specific to your Dataverse org, or use it untyped.
 
 ## Installation
 
@@ -31,6 +35,21 @@ for (const record of result.data) {
 }
 ```
 
+## Why this exists
+
+Your Dataverse data is locked behind APIs designed for platform consultants — not for frontend teams building customer portals. Between your React app and the data sit Azure AD client credentials, OData entity navigation, MSAL token management, and GUID-based lookups.
+
+This client eliminates all of that:
+
+| You write | Instead of |
+|---|---|
+| `client.me.list("incident")` | OData queries, `$filter`, `$expand`, GUID joins |
+| `getAccessTokenSilently()` | MSAL, client credentials, service principal config |
+| Nothing — it's automatic | Custom row-level security middleware |
+| `npx dataverse-client generate` | Manually typing Dataverse schemas |
+
+**Stop building middleware. Start building your portal.**
+
 ## Types are optional
 
 Generated types are a **developer experience** convenience, not a requirement. The SDK works identically with or without them — every method accepts an optional generic, and defaults to `Record<string, unknown>` when none is provided.
@@ -240,6 +259,23 @@ const result = await client.me.create("casenotes", {
 console.log(result.data.annotationid); // new note GUID
 ```
 
+The API automatically binds contact and account relationship fields when creating records.
+For tables with auto-binding configured (like `incident`), you only need to provide content fields:
+
+```typescript
+// Create a case — contact and account are auto-bound from your identity
+const newCase = await client.me.create("incident", {
+  title: "VPN not connecting",
+  description: "Getting timeout errors when connecting to corporate VPN.",
+});
+
+console.log(newCase.data.incidentid);   // new case GUID
+console.log(newCase.data.ticketnumber); // auto-generated case number
+```
+
+You do **not** need to set `primarycontactid` or `customerid_account` — the API resolves
+these from your authenticated identity and binds them automatically.
+
 ### Update a record
 
 Available on all scopes (`me`, `team`, `all`):

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truenorth-it/dataverse-client",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "type": "module",
   "main": "./sdk/dist/index.js",
   "types": "./sdk/dist/index.d.ts",