UNPKG

wcz-layout

Version:

35 lines (26 loc) • 1.97 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
--- name: services description: "Use when a feature needs a built-in wcz-layout backend service: file upload, download, thumbnails; approval requests, approvers and flows; PeopleSoft employee, manager, department lookups; or sending email." metadata: type: integration library: wcz-layout --- ## Info You can read about each service in the links below. Services are categorized as either client or server exports, depending on their intended usage. - **Client exports** — React Query option factories from `wcz-layout/data/client`. - **Server exports** — Direct service operations from `wcz-layout/data/server`; import themonly in server code. - Invalidating mutation factories take `{ queryClient }`. - Access `queryClient` with `Route.useRouteContext()` in a route file, or `useRouteContext({ from: "path" })` in a component. - To read about a service, open the linked file in the **File** column directly. ## Import Paths - Client exports: `wcz-layout/data/client` - Server exports: `wcz-layout/data/server` - Schemas & Models: `wcz-layout/models` ## Services | Service | File | Summary | | ---------- | ----------------------------------- | ----------------------------------------------------------------------- | | file | [file.md](docs/file.md) | File metadata, thumbnails, binary download/open, upload, update, delete | | approval | [approval.md](docs/approval.md) | Approval request lifecycle, approvers, flows, statuses, step results | | peoplesoft | [peoplesoft.md](docs/peoplesoft.md) | Employee, manager, department, and company general manager lookups | | email | [email.md](docs/email.md) | Server-only email sending with optional file attachment references | > The attendance service is not available yet — do not generate code against it; tell the user it is coming in a future release.