@weaver-apps/service-desk 0.0.0-stage → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,3 +1,32 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @weaver-apps/service-desk
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The service-desk app's weaver for a LoomWeaver distribution: a desk's service requests, filtered and paged,
|
|
4
|
+
with raising, editing, completing, cancelling and deleting. It talks to the Weaver Apps server through a
|
|
5
|
+
gateway the host supplies, and holds no key.
|
|
6
|
+
|
|
7
|
+
## Compose it
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import { createServiceDeskPlugin, createHttpServiceDeskGateway, provideServiceDeskGateway } from '@weaver-apps/service-desk';
|
|
11
|
+
|
|
12
|
+
provideTranslationNamespaces('service-desk'),
|
|
13
|
+
provideCapabilityGrants({ 'service-desk': ['contributions', 'navigation', 'ui'] }),
|
|
14
|
+
...providePlugins(createServiceDeskPlugin({ railItem: true })),
|
|
15
|
+
provideServiceDeskGateway(createHttpServiceDeskGateway({ baseUrl: '/weaver-apps' })),
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
- `baseUrl` is a same-origin path the host's backend forwards to the server with the forwarding key and the
|
|
19
|
+
signed-in person's tenant. The gateway appends the server's routes, such as
|
|
20
|
+
`/service-desk/desks/{id}/requests`.
|
|
21
|
+
- Serve the translations: copy `node_modules/@weaver-apps/service-desk/i18n/service-desk` to
|
|
22
|
+
`i18n/service-desk`.
|
|
23
|
+
- If the host compiles the shell's theme with Tailwind, add the package as an `@source`.
|
|
24
|
+
|
|
25
|
+
## Surfaces
|
|
26
|
+
|
|
27
|
+
| Path | What it shows |
|
|
28
|
+
|---|---|
|
|
29
|
+
| `service-desk` | the tenant's desks |
|
|
30
|
+
| `service-desk/:deskId` | one desk's requests, filtered and paged |
|
|
31
|
+
|
|
32
|
+
`deskPath(id)` builds the second; a host that shows one entry per desk navigates there.
|