customer-module-frontend 2.6.7-beta.2 → 2.7.0-beta.1

package/README.md

@@ -1,3 +1,63 @@
+# customer-module-frontend
+
+The Hiver customer module (contacts, accounts, conversations) as an embeddable
+React library, published to npm and mounted by a host application.
+
+## Integrating with a host
+
+The library renders against the host's own API surface. Two optional fields on
+the mount config decide how.
+
+**Additive only.** Both fields are optional, and with both absent every code
+path is the one that shipped in `2.6.2` — Omni hosts require no action.
+
+### `CustomerModuleConfig.platform?: 'GMAIL' | 'HIVERWEB'`
+
+Absent (as `outlook-ui` supplies it) keeps the existing behaviour. `'GMAIL'`
+opts the response interceptor into the envelope normaliser, because the proxied
+API returns a bare page body where the library expects
+`{ status, message, data }`.
+
+The discriminator is read per response, never cached on the shared `apiClient`
+singleton, so one page can hold a GMAIL config and a HIVERWEB config without
+either leaking into the other.
+
+### `CustomerModuleCallbacks.cmApiCallback?: HostTransport`
+
+When supplied it is installed as the axios adapter, and the host owns the wire:
+base URL, auth headers, credentials, CSRF. The library forwards only what it
+owns — the path, the params, the body, and the two per-request options
+(`responseType`, `paramsSerializer`) that silently change behaviour when a
+transport drops them.
+
+Omit it and the library issues the request itself, unchanged.
+
+A transport is expected to resolve with an axios-shaped response carrying the
+real HTTP `status` — including for failures. The adapter applies
+`validateStatus` itself, so a relayed `401`/`422`/`5xx` rejects the request and
+reaches the library's error handling. A transport that rejects natively is
+re-wrapped as an `AxiosError` so its status survives.
+
+Any existing `ApiCallback` satisfies `HostTransport`.
+
+### Bundled dependencies
+
+`react-router-dom` is bundled rather than declared external, so consumers do not
+have to provide it. The library mounts its own `<MemoryRouter>` and never reads
+a host Router context.
+
+## Development
+
+```bash
+yarn install
+yarn dev        # vite dev server
+yarn build      # tsc -b && vite build
+yarn test       # vitest run
+yarn lint       # eslint .
+```
+
+---
+
 # React + TypeScript + Vite
 
 This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.