@weaver-apps/service-desk 0.1.2 → 0.2.0

package/README.md

@@ -7,10 +7,15 @@ gateway the host supplies, and holds no key.
 ## Compose it
 
 ```ts
-import { createServiceDeskPlugin, createHttpServiceDeskGateway, provideServiceDeskGateway } from '@weaver-apps/service-desk';
-
-provideTranslationNamespaces('service-desk'),
-provideCapabilityGrants({ 'service-desk': ['contributions', 'navigation', 'ui'] }),
+import {
+  createHttpServiceDeskGateway,
+  createServiceDeskPlugin,
+  provideServiceDeskGateway,
+  serviceDeskPluginId,
+} from '@weaver-apps/service-desk';
+
+provideTranslationNamespaces(serviceDeskPluginId),
+provideCapabilityGrants({ [serviceDeskPluginId]: ['contributions', 'navigation', 'ui'] }),
 ...providePlugins(createServiceDeskPlugin({ railItem: true })),
 provideServiceDeskGateway(createHttpServiceDeskGateway({ baseUrl: '/weaver-apps' })),
 ```
@@ -18,15 +23,38 @@ provideServiceDeskGateway(createHttpServiceDeskGateway({ baseUrl: '/weaver-apps'
 - `baseUrl` is a same-origin path the host's backend forwards to the server with the forwarding key and the
   signed-in person's tenant. The gateway appends the server's routes, such as
   `/service-desk/desks/{id}/requests`.
-- Serve the translations: copy `node_modules/@weaver-apps/service-desk/i18n/service-desk` to
-  `i18n/service-desk`.
-- If the host compiles the shell's theme with Tailwind, add the package as an `@source`.
-
-## Surfaces
-
-| Path | What it shows |
-|---|---|
-| `service-desk` | the tenant's desks |
-| `service-desk/:deskId` | one desk's requests, filtered and paged |
-
-`deskPath(id)` builds the second; a host that shows one entry per desk navigates there.
+- Serve the translations: copy `node_modules/@weaver-apps/service-desk/i18n/weaver-apps-service-desk` to
+  `i18n/weaver-apps-service-desk`.
+- Install AG Grid, a peer dependency the list is drawn with: `npm i ag-grid-community@^36.2 ag-grid-angular@^36.2
+  @ag-grid-community/locale@^36.2`. `@weaver-apps/data-grid`, the grid both Weaver Apps weavers share, comes along as a
+  dependency; the host composes nothing for it.
+- If the host compiles the shell's theme with Tailwind, add the package and `@weaver-apps/data-grid` as an `@source`.
+
+## Names in the host
+
+The plugin id is `weaver-apps-service-desk` (`serviceDeskPluginId`). Every id the plugin registers and every
+icon it contributes starts with `weaver-apps-service-desk.`, its routes live under
+`weaver-apps-service-desk/`, and its translations are the namespace `weaver-apps-service-desk`. The ids are
+exported as `serviceDeskContributionIds`.
+
+| Id | Path | What it shows |
+|---|---|---|
+| `weaver-apps-service-desk.desks` | `weaver-apps-service-desk` | the tenant's desks |
+| `weaver-apps-service-desk.desk` | `weaver-apps-service-desk/:deskId` | one desk's requests, filtered and paged |
+| `weaver-apps-service-desk.rail` | | the rail item, only with `railItem: true` |
+
+A desk's requests are a grid that loads more as the person scrolls and shows how many match. A click on the
+title, priority, status, raised or due header sorts them on the server (newest first by default); title and
+description, the contact, and type, status and priority filter per column, the last three by any number of values.
+By default the status filter holds open, in progress and completed.
+
+`deskPath(id)` builds the address of one desk; a host that shows one entry per desk navigates there.
+
+## Moving from 0.1.x
+
+0.2.0 draws the list with AG Grid, so a host installs it (see above). It also renamed everything the plugin puts
+into a host; a host composing it changes three places: the key of
+its capability grant (`service-desk` becomes `weaver-apps-service-desk`), the translation namespace it
+declares, and the folder it serves the translations from (`i18n/service-desk` becomes
+`i18n/weaver-apps-service-desk`). Addresses saved under `service-desk/...` no longer resolve; build them with
+`deskPath`.