@uidu/skills 0.6.0 → 0.6.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uidu/skills",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Agent skills for the uidu SDK — installable via the open agent skills ecosystem (skills.sh).",
   "license": "MIT",
   "author": "uidu",

package/skills/uidu/SKILL.md

@@ -72,11 +72,51 @@ uidu workspace credentials --json                  # api key + secret
 uidu create my-app -t events                       # delegates to create-uidu-app
 ```
 
-Entities: `events, stories, donations, courses, forms, contacts, deals, employees,
-bookings, calls, campaigns, kb-collections, kb-articles, channel` (read) and
-`tasks, notes, spaces` (write-only). Not every verb exists for every entity — the CLI
-reports `does not support <verb>` when it doesn't. Config resolves **flags → env
-(`UIDU_*`) → `~/.uidu/config.json`** (written by `uidu login`).
+Entities and the verbs each supports (generated from the CLI's registry — a verb marked `—`
+fails with `does not support <verb>`):
+
+<!-- BEGIN sdk:cli-resources — generated by scripts/sdk-manifest.mjs, do not edit -->
+
+| Entity                | list | get | create | update | delete |
+| --------------------- | :--: | :-: | :----: | :----: | :----: |
+| `events`              |  ✓   |  ✓  |   ✓    |   ✓    |   —    |
+| `attendances`         |  —   |  —  |   ✓    |   —    |   —    |
+| `stories`             |  ✓   |  ✓  |   ✓    |   ✓    |   —    |
+| `donations`           |  ✓   |  ✓  |   ✓    |   ✓    |   ✓    |
+| `courses`             |  ✓   |  ✓  |   ✓    |   ✓    |   ✓    |
+| `forms`               |  ✓   |  ✓  |   ✓    |   ✓    |   ✓    |
+| `contacts`            |  ✓   |  ✓  |   ✓    |   —    |   ✓    |
+| `deals`               |  ✓   |  ✓  |   ✓    |   ✓    |   —    |
+| `goals`               |  ✓   |  ✓  |   —    |   ✓    |   —    |
+| `timeframes`          |  ✓   |  —  |   —    |   —    |   —    |
+| `employees`           |  ✓   |  —  |   ✓    |   ✓    |   —    |
+| `employments`         |  —   |  —  |   ✓    |   ✓    |   ✓    |
+| `offices`             |  ✓   |  —  |   —    |   —    |   —    |
+| `roles`               |  ✓   |  —  |   —    |   —    |   —    |
+| `ccnls`               |  ✓   |  —  |   ✓    |   —    |   —    |
+| `bookings`            |  ✓   |  ✓  |   —    |   —    |   —    |
+| `calls`               |  ✓   |  ✓  |   —    |   —    |   —    |
+| `jobs`                |  ✓   |  ✓  |   —    |   —    |   —    |
+| `applications`        |  ✓   |  —  |   ✓    |   —    |   —    |
+| `campaigns`           |  ✓   |  ✓  |   —    |   —    |   —    |
+| `kb-collections`      |  ✓   |  ✓  |   ✓    |   ✓    |   ✓    |
+| `kb-articles`         |  ✓   |  ✓  |   ✓    |   ✓    |   ✓    |
+| `channel`             |  ✓   |  ✓  |   ✓    |   ✓    |   ✓    |
+| `time-clocks`         |  —   |  —  |   ✓    |   —    |   —    |
+| `compensations`       |  —   |  —  |   ✓    |   ✓    |   ✓    |
+| `tasks`               |  —   |  —  |   ✓    |   ✓    |   ✓    |
+| `benefits`            |  —   |  —  |   ✓    |   —    |   —    |
+| `benefit-enrollments` |  —   |  —  |   ✓    |   —    |   —    |
+| `notes`               |  —   |  —  |   ✓    |   ✓    |   ✓    |
+| `projects`            |  ✓   |  —  |   —    |   —    |   —    |
+| `sites`               |  —   |  —  |   ✓    |   —    |   —    |
+| `spaces`              |  —   |  —  |   ✓    |   ✓    |   ✓    |
+
+<!-- END sdk:cli-resources -->
+
+Anything the backend exposes as a tool-flagged action but the CLI has no noun for yet:
+`uidu tools call <ActionKey> --attributes '<json>'` (associations as GlobalIDs). Config resolves
+**flags → env (`UIDU_*`) → `~/.uidu/config.json`** (written by `uidu login`).
 
 ## Who the app acts for — one rule
 
@@ -210,16 +250,16 @@ open deals" is asking about data uidu has — read it. **Create a Model only for
 place for** (the app's own bookings, a checklist, a log). Copying existing records into a Model
 gives the person a second copy that drifts from the real one.
 
-| The workspace's…                    | Functions (`@uidu/client`)                                        | Inside a custom app            |
-| ----------------------------------- | ----------------------------------------------------------------- | ------------------------------ |
-| Goals / OKRs (key results = subgoals) | `listGoals`, `getGoal`, `listTimeframes`; `updateGoal`            | **read** (no `updateGoal`)     |
-| Contacts, organisations             | `listContacts`, `getContact`; `createContact`                     | not yet                        |
-| Deals (CRM)                         | `listDeals`, `getDeal`; `createDeal`, `updateDeal`                | not yet                        |
-| People (employees)                  | `listEmployees`, `getEmployee`, `listOffices`, `listCircles`, `listRoles` | not yet                 |
-| Tasks, notes                        | `updateTask`, `createTask`, `updateNote`, `createNote` (no list)  | not yet                        |
-| Events, courses, bookings, calendars | `listEvents`, `listCourses`, `listBookings`, `listCalendars`, …  | not yet                        |
-| Forms, donations, stories, help center | see [Patterns by Scope](#patterns-by-scope)                    | not yet                        |
-| The app's own Models                | `ensureModel`, `listModelItems`, `createModelItem`, …             | read and write                 |
+| The workspace's…                       | Functions (`@uidu/client`)                                                | Inside a custom app        |
+| -------------------------------------- | ------------------------------------------------------------------------- | -------------------------- |
+| Goals / OKRs (key results = subgoals)  | `listGoals`, `getGoal`, `listTimeframes`; `updateGoal`                    | **read** (no `updateGoal`) |
+| Contacts, organisations                | `listContacts`, `getContact`; `createContact`                             | not yet                    |
+| Deals (CRM)                            | `listDeals`, `getDeal`; `createDeal`, `updateDeal`                        | not yet                    |
+| People (employees)                     | `listEmployees`, `getEmployee`, `listOffices`, `listCircles`, `listRoles` | not yet                    |
+| Tasks, notes                           | `updateTask`, `createTask`, `updateNote`, `createNote` (no list)          | not yet                    |
+| Events, courses, bookings, calendars   | `listEvents`, `listCourses`, `listBookings`, `listCalendars`, …           | not yet                    |
+| Forms, donations, stories, help center | see [Patterns by Scope](#patterns-by-scope)                               | not yet                    |
+| The app's own Models                   | `ensureModel`, `listModelItems`, `createModelItem`, …                     | read and write             |
 
 On a server with an account token (`apiKey`) every row works; "not yet" means a custom app's
 session token is refused for it. **When the data exists in uidu but is not reachable from a custom
@@ -244,7 +284,7 @@ const objectives = goals.filter((g) => !g.parentId);
 const behind = objectives.filter((g) => isGoalBehind(g, { tolerance: 0.1 }));
 
 goalValue(goal, goal.targetValue); // 45 for a 45% target, 1200 for €1,200
-goalProgress(goal);                // 0.45 — done fraction
+goalProgress(goal); // 0.45 — done fraction
 ```
 
 `isGoalBehind` compares progress with the share of the timeframe already gone (`goalTimeElapsed`);
@@ -656,6 +696,48 @@ offers to fill it in for you). The site templates add a configured `src/lib/uidu
 server-rendered listing + dynamic detail page; `custom-app` has no token to configure and
 reads everything in client components.
 
+## Full API Index
+
+Every `@uidu/client` function, by domain — generated from the source, so if a function isn't
+here it doesn't exist (yet). Domains marked "reads need Bearer" hold private data: a public token
+sees nothing. Per-function auth, signatures and descriptions: https://docs.uidu.org/docs/reference/client.
+
+<!-- BEGIN sdk:domain-index — generated by scripts/sdk-manifest.mjs, do not edit -->
+
+- **Client & utilities** — `createClient`, `fromBridge`, `normalizeFieldValueContent`, `normalizeFieldValuesAttributes`, `paginate`
+- **CMS — Sites** · CLI: `sites` — `createSite`, `getPageBySlug`, `getSingletonBlock`, `getSite`, `getSiteByDomain`, `listSitePages`
+- **CMS — Projects (legacy)** · CLI: `projects` — `createFieldValue`, `createPage`, `createPageBlock`, `createProject`, `getPage`, `getTemplate`, `listPages`, `listProjects`
+- **Models (custom data)** — `createField`, `createFieldOption`, `createModel`, `createModelItem`, `deleteField`, `deleteFieldOption`, `deleteFieldValue`, `deleteModelItem`, `ensureModel`, `getModel`, `getModelItem`, `listModelItems`, `listModels`, `toFieldValuesAttributes`, `updateField`, `updateFieldOption`, `updateFieldValue`, `updateModel`, `updateModelItem`
+- **Forms** · CLI: `forms` — `createForm`, `createFormResponse`, `deleteForm`, `getForm`, `listForms`, `updateForm`, `updateFormResponse`
+- **Events** · CLI: `events`, `attendances` — `createAttendance`, `createEvent`, `getEvent`, `listEvents`, `updateEvent`
+- **Calls** · CLI: `calls` — `getCall`, `listCalls`
+- **Jobs & applications** · CLI: `jobs`, `applications` — `completeApplication`, `createApplication`, `getJob`, `listApplications`, `listJobs`, `updateApplication`
+- **Donations** · CLI: `donations` — `createDonation`, `createDonationCampaign`, `deleteDonationCampaign`, `getDonationCampaign`, `listDonationCampaigns`, `updateDonationCampaign`
+- **Stories** · CLI: `stories` — `createStory`, `getStory`, `listStories`, `updateStory`
+- **Help center** · CLI: `channel` — `createChannel`, `deleteChannel`, `getChannel`, `listChannels`, `updateChannel`
+- **Knowledge base** · CLI: `kb-collections`, `kb-articles` — `createKbArticle`, `createKbCollection`, `deleteKbArticle`, `deleteKbCollection`, `getKbArticle`, `getKbCollection`, `listKbArticles`, `listKbCollections`, `updateKbArticle`, `updateKbCollection`
+- **Search** — `search`
+- **Courses** · CLI: `courses` — `createCourse`, `deleteCourse`, `getCourse`, `getEnrollment`, `getLecture`, `listCourses`, `listEnrollments`, `listLectures`, `updateCourse`
+- **Bookings & calendars** · reads need Bearer · CLI: `bookings` — `getBooking`, `getCalendar`, `getCalendarEvent`, `listBookings`, `listCalendarEvents`, `listCalendars`
+- **Campaigns** · reads need Bearer · CLI: `campaigns` — `getCampaign`, `listCampaigns`, `listEmailCampaigns`
+- **Contacts & deals** · reads need Bearer · CLI: `contacts`, `deals` — `createContact`, `createDeal`, `deleteContact`, `getContact`, `getDeal`, `listContacts`, `listDeals`, `updateDeal`
+- **Goals (OKRs)** · reads need Bearer · CLI: `goals`, `timeframes` — `getGoal`, `goalProgress`, `goalTimeElapsed`, `goalValue`, `isGoalBehind`, `listGoals`, `listTimeframes`, `toGoalRaw`, `updateGoal`
+- **People (HR)** · reads need Bearer · CLI: `employees`, `employments`, `offices`, `roles`, `ccnls`, `time-clocks`, `compensations`, `benefits`, `benefit-enrollments` — `contractEvents`, `createBenefit`, `createBenefitEnrollment`, `createCcnl`, `createCompensation`, `createEmployee`, `createEmployment`, `createTimeClock`, `deleteCompensation`, `deleteEmployment`, `getEmployee`, `listCcnls`, `listCircles`, `listEmployees`, `listEmploymentHistory`, `listKinds`, `listOffices`, `listRoles`, `terminateEmployment`, `updateCompensation`, `updateEmployee`, `updateEmployment`, `weekStartFor`
+- **Spaces, tasks & notes** · CLI: `tasks`, `notes`, `spaces` — `createNote`, `createSpace`, `createTask`, `deleteNote`, `deleteSpace`, `deleteTask`, `updateNote`, `updateSpace`, `updateTask`
+- **Provisioning & actions** — `createWorkspace`, `executeAction`, `generateWorkspaceApiCredentials`
+
+<!-- END sdk:domain-index -->
+
+`@uidu/react`:
+
+<!-- BEGIN sdk:react-surface — generated by scripts/sdk-manifest.mjs, do not edit -->
+
+- **Components:** `BlockRenderer` — Render exactly one block from a page's `pageBlocks` array, by shortname.; `DynamicForm` — Render a uidu form (from `getForm`, `call.form`, …) as HTML inputs and hand the parsed values to your `action`, typically a `createFormResponse` Server Action.; `PageBlocks` — Render a page's blocks in order, each with the component keyed by its shortname in `components`; blocks with no match render `fallback`, or nothing.; `RichText` — Render a Tiptap (ProseMirror) JSON document as React elements.; `UiduAppProvider` — Connects a custom app to the uidu page framing it (`@uidu/app-bridge`) and hands the tree its state through `useUiduApp`. Once connected, the children also sit inside a `<UiduProvider>` with a session-backed client, so `useUiduClient()` works as anywhere else.; `UiduProvider` — Provide a `UiduClient` to the tree, either a `client` you built or one made from `workspace`/`publicToken`/`endpoint`, plus an SWR fetcher backed by it.
+- **Hooks:** `useFields` — Normalize a `fieldValues` array into a `{ shortname: value }` map so blocks can access their fields by name without walking the GraphQL shape.; `useQuery` — Generic client-side data-fetching hook: runs `document` against the `UiduClient` from the nearest `<UiduProvider>` via SWR, so calls are cached and deduplicated by operation name + variables.; `useUidu` — The nearest `UiduProvider`'s `{ client, endpoint }`; throws outside a provider.; `useUiduApp` — The custom app's bridge state: `connecting`, `ready` or `error`.; `useUiduClient` — The `UiduClient` from the nearest `UiduProvider`; throws outside a provider.
+- **Utilities:** `formatSalaryRange` — Format a job's salary range (`salaryMin`/`salaryMax`) into a display string. Returns `null` when the job advertises no salary, so callers can hide the field. Handles open-ended ranges ("From …", "Up to …") and a single figure.; `getBlockShortname` — The shortname a page block is rendered by (its template block's, else its own), or null.; `toText` — Flatten any uidu field-content value into a plain string. Handles raw strings, numbers, Slate-style rich text nodes (`{ type, children }`, `{ text }`), arrays of nodes, and wrapper objects with a `value` field.
+
+<!-- END sdk:react-surface -->
+
 ## See Also
 
 - uidu docs: https://docs.uidu.org
@@ -663,3 +745,4 @@ reads everything in client components.
 - `@uidu/client`: https://github.com/uidu-org/api.js/tree/main/packages/client
 - `@uidu/react`: https://github.com/uidu-org/api.js/tree/main/packages/react
 - `create-uidu-app`: https://github.com/uidu-org/api.js/tree/main/packages/create-uidu-app
+- Machine-readable manifest of the whole SDK (exports, domains, auth, CLI verbs): https://github.com/uidu-org/api.js/blob/main/docs/sdk-manifest.json