@corto-ai/dexter-integrations 0.1.0-dev.0 → 0.1.1-test.0

package/README.md

@@ -1,6 +1,7 @@
 # @corto-ai/dexter-integrations
 
-Connect a table editor to Dexter. Dexter supplies matter context and owns Save; your app edits field values and displays errors.
+Allows connecting a table editor to Dexter. Dexter supplies matter values and lookups and controls saving.
+Your app edits field values, sends all edits to dexter, receives live matter updates and displays errors.
 
 ## Install
 
@@ -36,25 +37,28 @@ client.sendChanges({
   isValid: true
 });
 
-// For an invalid edit, send no values:
+// For an invalid edit, you do not need to send values:
 client.sendChanges({ isValid: false });
-
-// On teardown:
-client.disconnect();
 ```
 
-Replace the comments with your editor's behaviour. Connection starts automatically; no context request is needed. A late matter-update handler receives the latest context. Registering a handler replaces its previous callback.
+The connection starts automatically when you call createTableAppClient(). The initial handshake keeps retrying until Dexter is ready.
+
+If any messages are sent in either direction before the connection establishes, the latest payloads will be sent on connection.
 
-The matter-update callback receives `{ matter, lookups, tableId, table, tableLookups }`, using Dexter API DTOs.
+Re-registering a handler will replace previous registrations of that handler.
+
+The handleMatterUpdate callback receives `{ matter, lookups, tableId, table, tableLookups }`, using Dexter API DTOs.
 
 ## Editing
 
 Only use field IDs permitted by `tableLookups.fields`. You can populate an allowed field that is not yet present in the table. An empty string clears a value; omitted values also count as empty, so always send the complete draft.
 
-Send only `{ isValid: false }` for invalid edits. The SDK discards draft values and blocks Save; invalid edits still count as unsaved for leave protection. Dexter independently validates changes, tracks unsaved values and enables Save when appropriate. Reverting to persisted values clears the dirty state. Your app may continue editing during a save.
+Send only `{ isValid: false }` for invalid edits. The SDK discards draft values and blocks Save; invalid edits still count as unsaved for navigation blocking.
+
+Dexter independently validates changes, tracks unsaved values and enables Save when appropriate. Your app may continue editing during a save.
 
-Save success acknowledges persistence without returning data. Dexter forwards its own context updates separately; the SDK does not fetch, merge or reorder them. External updates do not merge or replace a valid submitted draft. If your app adopts updated values, call `sendChanges` again. Reloading the iframe discards the draft.
+All matter updates (provided through handleMatterUpdate) do not merge or replace your draft. If your app adopts updated values, call `sendChanges` again. Reloading the iframe discards the draft.
 
-`handleSaveError` also reports invalid changes and connection failures. The initial handshake keeps retrying until Dexter is ready or the app is torn down. After 10 seconds it reports a one-time waiting warning and continues trying. The SDK never automatically retries saves.
+`handleSaveError` also reports invalid changes and connection failures. After 10 seconds it reports a one-time waiting warning and continues trying. The SDK never automatically retries saves.
 
 Callback errors are reported through `handleSaveError` without disconnecting. Errors thrown by the error handler itself are logged to the browser console to avoid recursive reporting.

package/index.d.ts

@@ -240,6 +240,8 @@ interface StaffDto {
 }
 
 interface TableDto$1 {
+    appDisplayName?: string;
+    appUrl?: string;
     description: string;
     fields: Array<FieldV2Dto>;
     id: string;
@@ -361,6 +363,8 @@ interface StatusLookupDto {
 }
 
 interface TableLookupDto {
+    appDisplayName?: string;
+    appUrl?: string;
     description: string;
     fields?: Array<FieldLookupDto>;
     id: string;
@@ -417,7 +421,6 @@ interface TableAppClient {
     sendChanges(changes: TableAppChanges): void;
     handleSaveSuccess(callback: () => void): void;
     handleSaveError(callback: (error: Error) => void): void;
-    disconnect(): void;
 }
 type TableAppClientOptions = TransportOptions;
 declare const createTableAppClient: (options?: TableAppClientOptions) => TableAppClient;