@webority/support-react 0.13.1 → 0.13.4

package/README.md

@@ -42,10 +42,18 @@ export function App() {
 rejects with a `SupportApiError` carrying `code`, `status` and a `message` written for the
 person, which the components show as-is.
 
+`listTickets` returns one page, most recently updated first, in the shape
+`{ items, page, pageSize, totalCount, totalPages }`. Every query part is optional: `status` is one
+of `Open`, `InProgress`, `Resolved` or `Closed`, `search` matches the subject or the ticket
+number, `page` starts at 1, and the API caps `pageSize` at 100. `getTicketCounts` returns
+`{ open, inProgress, resolved, closed, total }`. A ticket's `accountId` and `realm` are `null` on
+the customer side, and its `version` is for support staff only; the components use none of them.
+
 | Method | Request |
 |---|---|
 | `getConfig()` | `GET {base}/settings` |
-| `listTickets()` | `GET {base}/tickets` |
+| `listTickets({ status, search, page, pageSize })` | `GET {base}/tickets?status=&search=&page=&pageSize=`, one page |
+| `getTicketCounts()` | `GET {base}/tickets/counts` |
 | `getTicket(id)` | `GET {base}/tickets/{id}` |
 | `createTicket({ category, subject, body, pageUrl, userAgent, appVersion, files, screenshots })` | `POST {base}/tickets`, multipart |
 | `reply(id, { body, files, screenshots })` | `POST {base}/tickets/{id}/replies`, multipart |
@@ -58,7 +66,10 @@ person, which the components show as-is.
 ### `<SupportCenter />`
 
 The support page: the customer's tickets with status tabs and a search box, one ticket's
-conversation, and a New ticket dialog.
+conversation, and a New ticket dialog. The server filters, searches and pages the list, so it
+stays quick however many tickets a customer has. The tabs are All, Open, In progress, Resolved
+and Closed, each labelled with its count from `getTicketCounts`. All is chosen first. The search
+asks the server once typing pauses, and a new tab or search starts again at page 1.
 
 ```jsx
 <SupportCenter appVersion={import.meta.env.VITE_APP_VERSION} defaultCategory="Question" />
@@ -74,7 +85,8 @@ Support emails link to the support page with `?ticket=<id>`. The centre opens th
 keeps the parameter in step as tickets open and close, so a refresh stays on the same ticket.
 In a ticket the customer can reply with files (pasting an image into the message attaches it),
 reopen a settled ticket, and say whether it solved their problem. Files are checked against the
-config's type, size and count limits before anything uploads.
+config's type, size and count limits before anything uploads, and a file that breaks a limit gets
+one message, in the package's words.
 
 ### `<ReportIssue />`
 
@@ -95,6 +107,17 @@ pasting them. The ticket records the page address, the browser and the product v
 | `getTicketHref(id)` | Shows a View ticket link to the new ticket. |
 | `onOpenTicket(ticket)` | Called by the View ticket button when there is no href. |
 | `onCreated(ticket)` | Called once the ticket is raised. |
+| `className` | Added to the button's wrapper, floating or inline, to place it. |
+| `style` | Merged over the wrapper's own style. |
+
+Place the button with `className` or `style`. Both land on the wrapper that holds the button,
+which is the element that floats. With `floating`, an inset moves it clear of other fixed controls
+such as a chat launcher:
+
+```jsx
+<ReportIssue floating style={{ bottom: "5rem" }} />
+<ReportIssue className="ms-auto" />
+```
 
 The screenshot is taken before the dialog opens, and the button itself is left out of it.
 Anything else the page marks with `data-support-capture="exclude"` is left out too.
@@ -110,8 +133,11 @@ support config. A field the product has not set is left out, and nothing renders
 
 ## Hooks
 
-`useSupportConfig()`, `useSupportTickets()` and `useSupportTicket(id)` return the data with
-`loading`, `error` and `reload`. `useSupportTicket` also returns `reply`, `reopen` and `rate`,
+`useSupportConfig()`, `useSupportTickets(query)`, `useSupportTicketCounts()` and
+`useSupportTicket(id)` return the data with `loading`, `error` and `reload`.
+`useSupportTickets` takes the same query as `listTickets` and returns `tickets` (the page's items),
+`totalCount` and `totalPages`; it asks again whenever the query changes. `useSupportTicketCounts`
+returns `counts`. `useSupportTicket` also returns `reply`, `reopen` and `rate`,
 each resolving to the updated ticket. `useSupportClient()` returns the client itself.
 
 ## Display rules