@truenorth-it/dataverse-client 1.0.0

package/README.md

@@ -0,0 +1,405 @@
+<!-- This file is published to npmjs.com as the package README. Edit here, not the root README.md. -->
+
+# @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.
+
+## Installation
+
+```bash
+npm install @truenorth-it/dataverse-client
+```
+
+## Quick start (no types)
+
+The SDK works out of the box without any type generation. Response data is `Record<string, unknown>`:
+
+```typescript
+import { createClient } from "@truenorth-it/dataverse-client";
+
+const client = createClient({
+  baseUrl: "https://your-api.vercel.app",
+  getToken: () => getAccessTokenSilently(), // your Auth0 token provider
+});
+
+const result = await client.me.list("incident", {
+  select: ["title", "ticketnumber", "statuscode", "createdon"],
+  top: 20,
+  orderBy: "modifiedon:desc",
+});
+
+for (const record of result.data) {
+  console.log(record.ticketnumber, record.title);
+}
+```
+
+## Generate types for your API
+
+For full TypeScript autocomplete and type safety, generate interfaces from your own API deployment:
+
+```bash
+npx dataverse-client generate --url https://your-api.vercel.app
+```
+
+This fetches the schema and choice values from your API (public endpoints, no auth required) and creates `dataverse-tables.generated.ts` with:
+- Typed interfaces for every table
+- Const enum objects for every choice (picklist) field
+
+### CLI options
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--url`, `-u` | (required) | Base URL of your API deployment |
+| `--output`, `-o` | `./dataverse-tables.generated.ts` | Output file path |
+| `--api-base` | `/api/v2` | API base path |
+| `--no-choices` | `false` | Skip fetching choice values (no enums generated) |
+
+### Using generated types
+
+```typescript
+import { createClient } from "@truenorth-it/dataverse-client";
+import type { Incident, Contact } from "./dataverse-tables.generated";
+
+const client = createClient({
+  baseUrl: "https://your-api.vercel.app",
+  getToken: () => getAccessTokenSilently(),
+});
+
+// Fully typed — result.data is Incident[]
+const result = await client.me.list<Incident>("incident", {
+  select: ["title", "ticketnumber", "statuscode", "createdon"],
+  top: 20,
+});
+
+for (const c of result.data) {
+  console.log(c.ticketnumber, c.title, c.statuscode_label);
+  //          ^ string        ^ string  ^ "In Progress" etc.
+}
+```
+
+### Using choice enums
+
+The generated file also includes const objects for choice (picklist) fields, so you can compare values without magic numbers:
+
+```typescript
+import { createClient } from "@truenorth-it/dataverse-client";
+import type { Incident } from "./dataverse-tables.generated";
+import { IncidentStatuscode, IncidentPrioritycode } from "./dataverse-tables.generated";
+
+const cases = await client.me.list<Incident>("incident", {
+  filter: `statuscode eq ${IncidentStatuscode.InProgress}`,
+});
+
+for (const c of cases.data) {
+  if (c.statuscode === IncidentStatuscode.OnHold) {
+    console.log("Case is on hold:", c.title);
+  }
+  if (c.prioritycode === IncidentPrioritycode.High) {
+    console.log("High priority:", c.title);
+  }
+}
+```
+
+Each choice const is also a type — use it for function signatures:
+
+```typescript
+function handleStatus(status: IncidentStatuscode) {
+  // status is narrowed to 1 | 2 | 3 | 5 etc.
+}
+```
+
+To skip choice generation (faster, interfaces only): `npx dataverse-client generate --url ... --no-choices`
+
+### CI / build integration
+
+Add to your `package.json` to regenerate types when your schema changes:
+
+```json
+{
+  "scripts": {
+    "generate:types": "dataverse-client generate --url $API_URL --output src/dataverse-types.ts",
+    "prebuild": "npm run generate:types"
+  }
+}
+```
+
+### Programmatic usage
+
+The codegen function is also exported for use in custom build scripts:
+
+```typescript
+import { generateTableTypes } from "@truenorth-it/dataverse-client";
+
+const response = await fetch("https://your-api.vercel.app/api/v2/schema");
+const schema = await response.json();
+const tsSource = generateTableTypes(schema);
+// Write tsSource to a file, pipe it, etc.
+```
+
+## Usage with React + Auth0
+
+```tsx
+import { useMemo } from "react";
+import { useAuth0 } from "@auth0/auth0-react";
+import { createClient } from "@truenorth-it/dataverse-client";
+
+function useApiClient() {
+  const { getAccessTokenSilently } = useAuth0();
+
+  return useMemo(
+    () =>
+      createClient({
+        baseUrl: import.meta.env.VITE_API_BASE_URL,
+        getToken: () => getAccessTokenSilently(),
+      }),
+    [getAccessTokenSilently],
+  );
+}
+```
+
+## Client configuration
+
+```typescript
+createClient({
+  baseUrl: string;                    // API deployment URL
+  getToken: () => Promise<string>;    // Returns a Bearer token
+  apiBase?: string;                   // Defaults to "/api/v2"
+});
+```
+
+## Access scopes
+
+The client exposes three scopes, each backed by server-side authorization:
+
+| Scope | Description | Operations |
+|-------|-------------|------------|
+| `client.me` | Your own records (contact-scoped) | list, get, update, lookup, create, whoami |
+| `client.team` | Records belonging to your team/account | list, get, update, lookup |
+| `client.all` | All records (requires elevated permissions) | list, get, update, lookup |
+
+## Operations
+
+### List records
+
+```typescript
+import type { Incident } from "./dataverse-tables.generated";
+
+const result = await client.me.list<Incident>("incident", {
+  select: ["title", "ticketnumber", "statuscode", "prioritycode", "createdon"],
+  top: 50,
+  orderBy: "createdon:desc",
+  filter: "statuscode eq 1",
+});
+
+// result.data — Incident[] with full autocomplete
+// result.page — { top, skip, next }
+
+for (const c of result.data) {
+  console.log(c.ticketnumber, c.title);
+  console.log(c.statuscode, c.statuscode_label);     // 1, "In Progress"
+  console.log(c.prioritycode, c.prioritycode_label); // 2, "Normal"
+}
+```
+
+### Get a single record
+
+```typescript
+const result = await client.me.get<Incident>("incident", caseId, {
+  select: ["title", "description", "statuscode", "customerid"],
+});
+
+const c = result.data;
+console.log(c.title);             // "Network outage in building 3"
+console.log(c._customerid_value); // GUID of the linked customer
+console.log(c.statuscode_label);  // "In Progress"
+```
+
+### Create a record (me scope only)
+
+```typescript
+import type { Casenotes } from "./dataverse-tables.generated";
+
+const result = await client.me.create<Casenotes>("casenotes", {
+  subject: "Follow-up call",
+  notetext: "Spoke with customer — issue resolved.",
+  objectid_incident: incidentId, // link to parent case
+});
+
+console.log(result.data.annotationid); // new note GUID
+```
+
+### Update a record
+
+Available on all scopes (`me`, `team`, `all`):
+
+```typescript
+const result = await client.me.update<Incident>("incident", caseId, {
+  description: "Updated with latest findings",
+});
+
+console.log(result.data.modifiedon); // "2026-02-13T10:30:00Z"
+```
+
+### Lookup (type-ahead search)
+
+```typescript
+import type { Contact } from "./dataverse-tables.generated";
+
+const result = await client.me.lookup<Contact>("contact", {
+  search: "john",
+  select: ["fullname", "emailaddress1", "jobtitle"],
+  top: 10,
+});
+
+// Great for autocomplete dropdowns
+for (const contact of result.data) {
+  console.log(contact.fullname, contact.emailaddress1);
+}
+```
+
+### Who am I
+
+```typescript
+const me = await client.me.whoami();
+console.log(me.fullname);   // "Jane Developer"
+console.log(me.email);      // "jane@example.com"
+console.log(me.contactid);  // Dataverse contact GUID
+console.log(me.accountid);  // Dataverse account GUID (if linked)
+```
+
+### Choices (option sets)
+
+Choice fields (picklists) have their values managed in Dataverse. Fetch them for building dropdowns:
+
+```typescript
+// All choice fields for a table
+const allChoices = await client.choices("incident");
+// allChoices.fields.statuscode → [{ value: 1, label: "In Progress" }, ...]
+// allChoices.fields.prioritycode → [{ value: 1, label: "High" }, ...]
+
+// Single field
+const statusChoices = await client.choices("incident", "statuscode");
+// statusChoices.choices → [{ value: 1, label: "In Progress" }, ...]
+```
+
+### Schema
+
+```typescript
+// All table schemas
+const schemas = await client.schema();
+
+// Single table
+const incidentSchema = await client.schema("incident");
+console.log(incidentSchema.fields);       // field definitions with types + descriptions
+console.log(incidentSchema.defaultFields); // fields returned when no `select` is specified
+```
+
+## Query options
+
+Used by `list()`:
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `select` | `string[]` | Fields to return |
+| `top` | `number` | Page size (1-100) |
+| `skip` | `number` | Records to skip |
+| `orderBy` | `string` | Sort field and direction, e.g. `"createdon:desc"` |
+| `filter` | `string \| string[]` | OData-style filter expressions |
+| `filterLogic` | `"and" \| "or"` | How to combine multiple filters (default: `"and"`) |
+| `expand` | `string` | Expand related lookups |
+
+`lookup()` accepts the same options plus:
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `search` | `string` | Search term for type-ahead filtering |
+
+`get()` accepts only `select` and `expand`.
+
+## Error handling
+
+```typescript
+import { ApiError } from "@truenorth-it/dataverse-client";
+
+try {
+  await client.me.list("incident");
+} catch (err) {
+  if (err instanceof ApiError) {
+    console.error(err.status);  // HTTP status code
+    console.error(err.body);    // Error response body
+  }
+}
+```
+
+| Status | Meaning |
+|--------|---------|
+| 401 | Missing or invalid token |
+| 403 | Insufficient permissions |
+| 404 | Unknown table or contact not found |
+
+## Generated type patterns
+
+### Choice and lookup field siblings
+
+Choice fields (picklists) include a `_label` sibling with the display text:
+```typescript
+record.statuscode        // 1 (numeric value)
+record.statuscode_label  // "In Progress" (display text from Dataverse)
+```
+
+Lookup fields include a `_value` sibling with the referenced record's GUID:
+```typescript
+record._customerid_value      // "a1b2c3d4-..." (GUID of linked customer)
+record._primarycontactid_value // "e5f6g7h8-..." (GUID of linked contact)
+```
+
+### TableName union
+
+The generated file includes a `TableName` union of all valid table names and aliases:
+
+```typescript
+import type { TableName } from "./dataverse-tables.generated";
+
+// Type-safe table parameter — accepts "incident", "case", "contact", etc.
+function fetchRecords(table: TableName) {
+  return client.me.list(table);
+}
+```
+
+## Exported types
+
+All types are importable from the main package:
+
+```typescript
+import type {
+  // Client & scope interfaces
+  DataverseClient, ScopeClient, MeScopeClient, ClientConfig,
+  // Query types
+  QueryOptions, LookupOptions,
+  // Response types
+  PaginatedResponse, SingleResponse, WhoamiResponse,
+  // Schema & choices
+  TableSchema, SchemaField, ExpandSchema, Choice,
+  FieldChoicesResponse, TableChoicesResponse,
+  // Codegen types (for programmatic usage)
+  SchemaResponse, SchemaTableInput,
+  // Errors
+  ApiErrorBody,
+} from "@truenorth-it/dataverse-client";
+```
+
+Table-specific types come from your generated file:
+
+```typescript
+import type { Incident, Contact, TableName } from "./dataverse-tables.generated";
+```
+
+## Requirements
+
+- Node.js 18+
+- An Auth0 token provider (or any async function that returns a Bearer token)
+- Access to a deployed Dataverse Contact API instance
+
+## License
+
+ISC

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@truenorth-it/dataverse-client",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./sdk/dist/index.js",
+  "types": "./sdk/dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./sdk/dist/index.js",
+      "types": "./sdk/dist/index.d.ts"
+    }
+  },
+  "bin": {
+    "dataverse-client": "./sdk/dist/cli.js"
+  },
+  "files": [
+    "sdk/dist"
+  ],
+  "scripts": {
+    "generate:sdk-types": "tsx scripts/generate-sdk-types.ts",
+    "build:sdk": "tsc -p sdk/tsconfig.json",
+    "prepare": "tsc -p sdk/tsconfig.json",
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview",
+    "lint": "eslint . --ext .ts,.tsx",
+    "typecheck": "tsc --noEmit",
+    "generate-tables": "tsx scripts/generate-tables.ts",
+    "sync-auth0-perms": "tsx scripts/sync-auth0-permissions.ts",
+    "sync-auth0-perms:apply": "tsx scripts/sync-auth0-permissions.ts --apply",
+    "add-table": "tsx scripts/add-table.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
+  "dependencies": {
+    "@auth0/auth0-react": "^2.2.4",
+    "@azure/identity": "^4.2.0",
+    "@microsoft/applicationinsights-web": "^3.3.11",
+    "applicationinsights": "^2.9.8",
+    "jose": "^5.2.0",
+    "mermaid": "^11.12.2",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-markdown": "^10.1.0",
+    "react-router-dom": "^7.13.0",
+    "remark-gfm": "^4.0.1"
+  },
+  "devDependencies": {
+    "@tailwindcss/vite": "^4.1.18",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/node": "^20.11.0",
+    "@types/react": "^18.2.48",
+    "@types/react-dom": "^18.2.18",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "@vercel/node": "^3.0.0",
+    "@vitejs/plugin-react": "^4.2.1",
+    "eslint": "^8.56.0",
+    "happy-dom": "^20.6.1",
+    "tailwindcss": "^4.1.18",
+    "tsx": "^4.21.0",
+    "typescript": "^5.3.3",
+    "vercel": "^33.0.0",
+    "vite": "^5.0.12",
+    "vitest": "^4.0.18"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/sdk/dist/cli.d.ts

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+/**
+ * CLI for generating TypeScript table types from a Dataverse Contact API deployment.
+ *
+ * Usage:
+ *   npx dataverse-client generate --url https://your-api.vercel.app
+ *   npx dataverse-client generate --url https://your-api.vercel.app --output src/types.ts
+ */
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/sdk/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;;;;GAMG"}

package/sdk/dist/cli.js

@@ -0,0 +1,119 @@
+#!/usr/bin/env node
+/**
+ * CLI for generating TypeScript table types from a Dataverse Contact API deployment.
+ *
+ * Usage:
+ *   npx dataverse-client generate --url https://your-api.vercel.app
+ *   npx dataverse-client generate --url https://your-api.vercel.app --output src/types.ts
+ */
+import { parseArgs } from "node:util";
+import { writeFileSync } from "node:fs";
+import { resolve } from "node:path";
+import { generateTableTypes } from "./codegen.js";
+const HELP = `
+dataverse-client — TypeScript SDK for Dataverse Contact API
+
+Commands:
+  generate    Fetch schema from your API and generate TypeScript types
+
+Options:
+  --url, -u         Base URL of your API deployment (required)
+  --output, -o      Output file path (default: ./dataverse-tables.generated.ts)
+  --api-base        API base path (default: /api/v2)
+  --no-choices      Skip fetching choice values (faster, no enums generated)
+  --help, -h        Show this help message
+
+Examples:
+  npx dataverse-client generate --url https://my-api.vercel.app
+  npx dataverse-client generate -u https://my-api.vercel.app -o src/tables.ts
+  npx dataverse-client generate --url https://my-api.vercel.app --no-choices
+`.trim();
+async function main() {
+    const { values, positionals } = parseArgs({
+        args: process.argv.slice(2),
+        options: {
+            url: { type: "string", short: "u" },
+            output: { type: "string", short: "o", default: "./dataverse-tables.generated.ts" },
+            "api-base": { type: "string", default: "/api/v2" },
+            "no-choices": { type: "boolean", default: false },
+            help: { type: "boolean", short: "h", default: false },
+        },
+        allowPositionals: true,
+    });
+    if (values.help || positionals.length === 0) {
+        console.log(HELP);
+        process.exit(0);
+    }
+    const command = positionals[0];
+    if (command !== "generate") {
+        console.error(`Unknown command: ${command}\n\nRun 'dataverse-client --help' for usage.`);
+        process.exit(1);
+    }
+    if (!values.url) {
+        console.error("Error: --url is required.\n\nExample: npx dataverse-client generate --url https://your-api.vercel.app");
+        process.exit(1);
+    }
+    const baseUrl = values.url.replace(/\/+$/, "");
+    const apiBase = values["api-base"] ?? "/api/v2";
+    const skipChoices = values["no-choices"] ?? false;
+    const schemaUrl = `${baseUrl}${apiBase}/schema`;
+    // 1. Fetch schema
+    console.log(`Fetching schema from ${schemaUrl} ...`);
+    let schemaResponse;
+    try {
+        schemaResponse = await fetch(schemaUrl);
+    }
+    catch (err) {
+        const message = err instanceof Error ? err.message : String(err);
+        console.error(`Failed to fetch schema: ${message}`);
+        process.exit(1);
+    }
+    if (!schemaResponse.ok) {
+        console.error(`Schema endpoint returned ${schemaResponse.status} ${schemaResponse.statusText}`);
+        process.exit(1);
+    }
+    const schema = await schemaResponse.json();
+    if (!schema.tables || !Array.isArray(schema.tables)) {
+        console.error("Unexpected response shape — expected { tables: [...] }");
+        process.exit(1);
+    }
+    // 2. Fetch all public choices in a single request
+    let choices;
+    if (!skipChoices) {
+        const choicesUrl = `${baseUrl}${apiBase}/choices`;
+        console.log(`Fetching choices from ${choicesUrl} ...`);
+        try {
+            const choicesResponse = await fetch(choicesUrl);
+            if (choicesResponse.ok) {
+                const data = await choicesResponse.json();
+                if (data.tables && Array.isArray(data.tables)) {
+                    choices = data.tables;
+                    console.log(`  Got choices for ${choices.length} table(s)`);
+                }
+            }
+            else {
+                console.warn(`  Choices endpoint returned ${choicesResponse.status}, skipping enums`);
+            }
+        }
+        catch {
+            console.warn("  Failed to fetch choices, skipping enums");
+        }
+    }
+    // 3. Generate TypeScript
+    const source = generateTableTypes(schema, choices);
+    const outputPath = resolve(process.cwd(), values.output);
+    writeFileSync(outputPath, source, "utf-8");
+    const tableCount = schema.tables.length;
+    const fieldCount = schema.tables.reduce((sum, t) => sum + t.fields.length, 0);
+    console.log(`Generated ${tableCount} table(s) with ${fieldCount} total fields`);
+    if (choices && choices.length > 0) {
+        const enumCount = choices.reduce((sum, c) => sum + Object.keys(c.fields).length, 0);
+        console.log(`Generated ${enumCount} choice enum(s)`);
+    }
+    console.log(`Written to ${outputPath}`);
+}
+main().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+//# sourceMappingURL=cli.js.map

package/sdk/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;;;;GAMG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGlD,MAAM,IAAI,GAAG;;;;;;;;;;;;;;;;;CAiBZ,CAAC,IAAI,EAAE,CAAC;AAET,KAAK,UAAU,IAAI;IACjB,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC;QACxC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3B,OAAO,EAAE;YACP,GAAG,EAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE;YAC5C,MAAM,EAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,iCAAiC,EAAE;YACxF,UAAU,EAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE;YACpD,YAAY,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;YACjD,IAAI,EAAU,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE;SAC9D;QACD,gBAAgB,EAAE,IAAI;KACvB,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,IAAI,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5C,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAE/B,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,oBAAoB,OAAO,8CAA8C,CAAC,CAAC;QACzF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,uGAAuG,CAAC,CAAC;QACvH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC/C,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,SAAS,CAAC;IAChD,MAAM,WAAW,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC;IAClD,MAAM,SAAS,GAAG,GAAG,OAAO,GAAG,OAAO,SAAS,CAAC;IAEhD,kBAAkB;IAClB,OAAO,CAAC,GAAG,CAAC,wBAAwB,SAAS,MAAM,CAAC,CAAC;IAErD,IAAI,cAAwB,CAAC;IAC7B,IAAI,CAAC;QACH,cAAc,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,CAAC;IAC1C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjE,OAAO,CAAC,KAAK,CAAC,2BAA2B,OAAO,EAAE,CAAC,CAAC;QACpD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,CAAC;QACvB,OAAO,CAAC,KAAK,CAAC,4BAA4B,cAAc,CAAC,MAAM,IAAI,cAAc,CAAC,UAAU,EAAE,CAAC,CAAC;QAChG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,CAAC;IAE3C,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACpD,OAAO,CAAC,KAAK,CAAC,wDAAwD,CAAC,CAAC;QACxE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,kDAAkD;IAClD,IAAI,OAAwC,CAAC;IAE7C,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,UAAU,GAAG,GAAG,OAAO,GAAG,OAAO,UAAU,CAAC;QAClD,OAAO,CAAC,GAAG,CAAC,yBAAyB,UAAU,MAAM,CAAC,CAAC;QAEvD,IAAI,CAAC;YACH,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,CAAC;YAChD,IAAI,eAAe,CAAC,EAAE,EAAE,CAAC;gBACvB,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,CAAC;gBAC1C,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC9C,OAAO,GAAG,IAAI,CAAC,MAA6B,CAAC;oBAC7C,OAAO,CAAC,GAAG,CAAC,qBAAqB,OAAO,CAAC,MAAM,WAAW,CAAC,CAAC;gBAC9D,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,+BAA+B,eAAe,CAAC,MAAM,kBAAkB,CAAC,CAAC;YACxF,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IAED,yBAAyB;IACzB,MAAM,MAAM,GAAG,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnD,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,MAAO,CAAC,CAAC;IAE1D,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAE3C,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,MAAgB,CAAC;IAClD,MAAM,UAAU,GAAI,MAAM,CAAC,MAAkC,CAAC,MAAM,CAClE,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,EACjC,CAAC,CACF,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,aAAa,UAAU,kBAAkB,UAAU,eAAe,CAAC,CAAC;IAChF,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClC,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAC9B,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAC9C,CAAC,CACF,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,iBAAiB,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,cAAc,UAAU,EAAE,CAAC,CAAC;AAC1C,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACnB,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/sdk/dist/client.d.ts

@@ -0,0 +1,42 @@
+import type { ClientConfig, QueryOptions, LookupOptions, PaginatedResponse, SingleResponse, WhoamiResponse, TableSchema, FieldChoicesResponse, TableChoicesResponse, ApiErrorBody } from "./types.js";
+/** Error thrown when the API returns a non-OK response */
+export declare class ApiError extends Error {
+    readonly status: number;
+    readonly statusText: string;
+    readonly body: ApiErrorBody | null;
+    constructor(status: number, statusText: string, body: ApiErrorBody | null);
+}
+/** Scoped API operations (me, team, or all) */
+export interface ScopeClient {
+    /** List records from a table */
+    list<T = Record<string, unknown>>(table: string, options?: QueryOptions): Promise<PaginatedResponse<T>>;
+    /** Get a single record by ID */
+    get<T = Record<string, unknown>>(table: string, id: string, options?: Pick<QueryOptions, "select" | "expand">): Promise<SingleResponse<T>>;
+    /** Update a record */
+    update<T = Record<string, unknown>>(table: string, id: string, data: Record<string, unknown>): Promise<SingleResponse<T>>;
+    /** Search lookup records (type-ahead) */
+    lookup<T = Record<string, unknown>>(table: string, options?: LookupOptions): Promise<PaginatedResponse<T>>;
+}
+/** Extended scope with create and whoami (only available on "me") */
+export interface MeScopeClient extends ScopeClient {
+    /** Create a new record */
+    create<T = Record<string, unknown>>(table: string, data: Record<string, unknown>): Promise<SingleResponse<T>>;
+    /** Get authenticated identity + Dataverse contact info */
+    whoami(): Promise<WhoamiResponse>;
+}
+/** Dataverse Contact API client */
+export interface DataverseClient {
+    /** Operations on the authenticated user's own records */
+    me: MeScopeClient;
+    /** Operations on records belonging to the user's account/team */
+    team: ScopeClient;
+    /** Operations on all records (admin) */
+    all: ScopeClient;
+    /** Fetch choice/option-set values for a table, or a specific field */
+    choices(table: string, field?: string): Promise<FieldChoicesResponse | TableChoicesResponse>;
+    /** Fetch table schema (single table or all tables) */
+    schema(table?: string): Promise<TableSchema | TableSchema[]>;
+}
+/** Create a configured API client instance */
+export declare function createClient(config: ClientConfig): DataverseClient;
+//# sourceMappingURL=client.d.ts.map

package/sdk/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,WAAW,EACX,oBAAoB,EACpB,oBAAoB,EACpB,YAAY,EACb,MAAM,YAAY,CAAC;AAEpB,0DAA0D;AAC1D,qBAAa,QAAS,SAAQ,KAAK;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI,CAAC;gBAEvB,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,IAAI;CAO1E;AA+DD,+CAA+C;AAC/C,MAAM,WAAW,WAAW;IAC1B,gCAAgC;IAChC,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjC,gCAAgC;IAChC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,KAAK,EAAE,MAAM,EACb,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,QAAQ,CAAC,GAChD,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAE9B,sBAAsB;IACtB,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,KAAK,EAAE,MAAM,EACb,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAE9B,yCAAyC;IACzC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC;AAwDD,qEAAqE;AACrE,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,0BAA0B;IAC1B,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAE9B,0DAA0D;IAC1D,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC;CACnC;AAoBD,mCAAmC;AACnC,MAAM,WAAW,eAAe;IAC9B,yDAAyD;IACzD,EAAE,EAAE,aAAa,CAAC;IAClB,iEAAiE;IACjE,IAAI,EAAE,WAAW,CAAC;IAClB,wCAAwC;IACxC,GAAG,EAAE,WAAW,CAAC;IAEjB,sEAAsE;IACtE,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,GAAG,oBAAoB,CAAC,CAAC;IAE7F,sDAAsD;IACtD,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,WAAW,EAAE,CAAC,CAAC;CAC9D;AAED,8CAA8C;AAC9C,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,CAsBlE"}