max-agent-ui 0.0.13 → 0.0.14

package/README.md

@@ -1,4 +1,4 @@
-# Max Agent UI
+# Max Agent UI
 
 This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 21.2.0.
 
@@ -16,75 +16,121 @@ For a complete list of available schematics (such as `components`, `directives`,
 ng generate --help
 ```
 
-## Building
-
-To build the library, run:
+## Building
+
+To build the library, run:
 
 ```bash
-ng build max-agent-ui
-```
-
-This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
-
-## Assistant Component
-
-This package exposes one public API: the standalone chat assistant component.
-
-```ts
-import { MaxAssistantComponent } from 'max-agent-ui';
-```
-
-Add `MaxAssistantComponent` to the consuming component imports and render:
-
-```html
-<max-assistant
-  assistantApiUrl="http://127.0.0.1:8001/chat"
-  app="cortex"
-/>
-```
-
-Or provide shared configuration once:
-
-```ts
-providers: [
-  {
-    provide: MAX_ASSISTANT_CONFIG,
-    useValue: {
-      assistantApiUrl: 'http://127.0.0.1:8001/chat',
-      app: 'cortex'
-    }
-  }
-]
-```
-
-Host apps should provide Angular `HttpClient` for real API calls and include their PrimeNG theme and PrimeIcons styles.
-
-For local integration, install the generated tarball and peer UI dependencies in the consuming app:
-
-```bash
-npm install C:/Users/Dev100/Documents/Maxtime/Projects/maxtime-ui-library/dist/max-agent-ui/max-agent-ui-0.0.9.tgz primeng primeicons @angular/cdk
-```
-
-### Publishing the Library
-
-Build and package the library:
-
-```bash
-ng build max-agent-ui
-cd dist/max-agent-ui
-npm pack
-```
-
-Publish the generated tarball after logging in to npm:
-
-```bash
-npm login
-npm publish max-agent-ui-0.0.9.tgz
-```
+ng build max-agent-ui
+```
+
+This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+
+## Assistant Component
+
+This package exposes the standalone chat assistant component, its typed models,
+and `MaxAssistantService`.
+
+```ts
+import { MaxAssistantComponent } from 'max-agent-ui';
+```
+
+Add `MaxAssistantComponent` to the consuming component imports and render:
+
+```html
+<max-assistant
+  assistantApiUrl="/agent-api/v1/chat"
+  app="cortex"
+/>
+```
+
+For authenticated host applications, provide shared configuration once. The
+current token and API version are sent as headers, while role, permissions,
+route, and timezone are sent as request context:
+
+```ts
+providers: [
+  {
+    provide: MAX_ASSISTANT_CONFIG,
+    useFactory: (session: SessionService, router: Router) => ({
+      assistantApiUrl: '/agent-api/v1/chat',
+      app: 'cortex',
+      user: () => ({
+        token: session.authToken(),
+        version: session.apiVersion()
+      }),
+      context: () => ({
+        role: session.role(),
+        permissions: session.agentPermissions(),
+        route: router.url,
+        timezone: Intl.DateTimeFormat().resolvedOptions().timeZone
+      })
+    }),
+    deps: [SessionService, Router]
+  }
+]
+```
+
+GET actions are rendered immediately. POST and PATCH proposals are rendered
+with Approve and Reject controls. Approval sends a structured confirmation for
+the exact pending action; typing words such as "yes" does not execute it.
+
+Host features that already know an action capability can bypass
+natural-language routing without bypassing server authorization:
+
+```ts
+import { MaxAssistantService } from 'max-agent-ui';
+
+assistant.sendStructuredAction(
+  'Cancel this session',
+  {
+    capabilityKey: 'cortex.timetable.session.cancel',
+    arguments: { sessionId: 42 }
+  }
+).subscribe();
+```
+
+The agent still validates the capability and permissions in Supabase, performs
+live preflight reads, and returns the normal Approve/Reject proposal.
+
+For another product, supply product-specific authentication headers through
+`requestHeaders`. Cortex's existing `user.token` and `user.version` shortcuts
+remain supported:
+
+```ts
+requestHeaders: () => ({
+  'x-nemesys-auth-token': session.nemesysToken()
+})
+```
+
+Host apps should provide Angular `HttpClient` for real API calls and include their PrimeNG theme and PrimeIcons styles.
+
+For local integration, install the generated tarball and peer UI dependencies in the consuming app:
+
+```bash
+npm install C:/Users/Dev100/Documents/Maxtime/Projects/maxtime-ui-library/dist/max-agent-ui/max-agent-ui-0.0.24.tgz primeng primeicons @angular/cdk
+```
+
+### Publishing the Library
+
+Build and package the library:
+
+```bash
+ng build max-agent-ui
+cd dist/max-agent-ui
+npm pack
+```
+
+Publish the generated tarball after logging in to npm:
+
+```bash
+npm login
+npm publish max-agent-ui-0.0.24.tgz
+```
 
 ## Running unit tests
 
-To execute unit tests with the [Vitest](https://vitest.dev/) test runner, use the following command:
+To execute unit tests with the [Vitest](https://vitest.dev/) test runner, use the following command:
 
 ```bash
 ng test