@truenorth-it/dataverse-client 1.3.2 → 1.3.3

package/README.md

@@ -22,7 +22,7 @@ import { createClient } from "@truenorth-it/dataverse-client";
 const client = createClient({
   baseUrl: "https://api.dataverse-contact.tnapps.co.uk",
   scope: "default", // scope segment in API URLs (e.g. /api/v2/default/me/case)
-  getToken: () => getAccessTokenSilently(), // your Auth0 token provider
+  getToken: () => getAccessTokenSilently(), // any function returning a Bearer token (e.g. MSAL for Entra External ID)
 });
 
 const result = await client.me.list("case", {
@@ -172,28 +172,37 @@ const tsSource = generateTableTypes(schema);
 // Write tsSource to a file, pipe it, etc.
 ```
 
-## Usage with React + Auth0
+## Usage with React + MSAL (Entra External ID)
 
 ```tsx
 import { useMemo } from "react";
-import { useAuth0 } from "@auth0/auth0-react";
+import { useMsal } from "@azure/msal-react";
 import { createClient } from "@truenorth-it/dataverse-client";
 
 function useApiClient() {
-  const { getAccessTokenSilently } = useAuth0();
+  const { instance, accounts } = useMsal();
 
   return useMemo(
     () =>
       createClient({
         baseUrl: import.meta.env.VITE_API_BASE_URL,
         scope: "default",
-        getToken: () => getAccessTokenSilently(),
+        getToken: async () => {
+          const { accessToken } = await instance.acquireTokenSilent({
+            // Application ID URI of your API's Entra app registration
+            scopes: [`${import.meta.env.VITE_API_SCOPE}/access_as_user`],
+            account: accounts[0],
+          });
+          return accessToken;
+        },
       }),
-    [getAccessTokenSilently],
+    [instance, accounts],
   );
 }
 ```
 
+The SDK is identity-provider-agnostic — `getToken` just needs to return a Bearer string. Swap MSAL for any other OIDC client if your deployment uses a different provider.
+
 ## Client configuration
 
 ```typescript
@@ -594,7 +603,7 @@ The API must have `SIGNALR_CONNECTION_STRING` configured. When it's not set, `ne
 
 ### Negotiate
 
-The client exposes a `negotiate()` method that exchanges your Auth0 token for a SignalR connection token:
+The client exposes a `negotiate()` method that exchanges your Bearer token for a SignalR connection token:
 
 ```typescript
 const { url, accessToken } = await client.negotiate();
@@ -761,7 +770,7 @@ import type { Case, Contact, TableName } from "./dataverse-tables.generated";
 ## Requirements
 
 - Node.js 18+
-- An Auth0 token provider (or any async function that returns a Bearer token) — optional if using only `client.public`
+- An async function that returns a Bearer token — typically MSAL for Entra External ID, but any OIDC client works (optional if using only `client.public`)
 - Access to a deployed Dataverse Contact API instance
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truenorth-it/dataverse-client",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "type": "module",
   "main": "./sdk/dist/index.js",
   "types": "./sdk/dist/index.d.ts",
@@ -38,13 +38,16 @@
     "test:stats": "vitest run --coverage && node scripts/generate-test-stats.cjs",
     "build:landing": "vite build --config landing/vite.config.ts && cp -rL docs dist/docs",
     "build": "npm run build:landing && npm run build:sdk && npm run build:admin-cli",
-    "start": "node --import tsx docker/server.ts",
+    "start": "node --env-file-if-exists=.env --import tsx docker/server.ts",
     "docker:build": "docker build -t dataverse-contact-api .",
     "docker:run": "docker run -p 8080:8080 --env-file .env dataverse-contact-api",
-    "docker:build:azure": "docker build -f Dockerfile.azure-functions -t dataverse-contact-api-azure ."
+    "docker:build:azure": "docker build -f Dockerfile.azure-functions -t dataverse-contact-api-azure .",
+    "env:check": "op whoami && op vault get \"LA stack\" > /dev/null && echo \"OK: LA stack vault accessible\"",
+    "env:pull": "op inject -f -i .env.tpl -o .env && op inject -f -i .env.e2e.tpl -o .env.e2e && echo \"Rendered .env and .env.e2e from 1Password\""
   },
   "dependencies": {
     "@azure/identity": "^4.2.0",
+    "@azure/msal-browser": "^5.11.0",
     "@azure/storage-blob": "^12.31.0",
     "@modelcontextprotocol/sdk": "^1.26.0",
     "applicationinsights": "^2.9.8",