@wokuapp/ai-toolkit 0.4.0 → 0.6.0

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.
@@ -11,7 +11,7 @@
11
11
  "name": "woku",
12
12
  "source": "./",
13
13
  "description": "Design a listening program for your customer journey, run the VoC instruments (NPS, CSAT, CES, wokus), and turn every signal into a support ticket or an action plan, through woku's MCP server.",
14
- "version": "0.4.0",
14
+ "version": "0.6.0",
15
15
  "author": { "name": "woku" },
16
16
  "license": "MIT",
17
17
  "homepage": "https://woku.app",
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "woku",
3
3
  "description": "Voice-of-customer for Claude Code. Design a listening program for your customer journey, run the fast VoC instruments (NPS, CSAT, CES, wokus), and turn every signal into a support ticket or an action plan, through woku's MCP server. Bundles the woku method so the agent acts as a CX consultant.",
4
- "version": "0.4.0",
4
+ "version": "0.6.0",
5
5
  "author": {
6
6
  "name": "woku"
7
7
  },
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "woku",
3
- "version": "0.4.0",
3
+ "version": "0.6.0",
4
4
  "description": "Voice-of-customer for OpenAI Codex. Design a listening program, run the VoC instruments (NPS, CSAT, CES, wokus), and turn every signal into a support ticket or an action plan, through woku's MCP server.",
5
5
  "author": {
6
6
  "name": "woku"
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.6.0
4
+
5
+ Support and plans by folder. The woku skill documents `scopeKind: "folder"` with `folderId` on `create_ticket_destination`, `update_ticket_destination`, `create_action_plan_group` and `update_action_plan_group` (the destination or group listens to every tool inside the folder, at any depth, never mixed with tracker rows), the `folderId` filter on `list_ticket_destinations`, `list_action_plan_groups` and `list_tickets`, and the `FOLDER_HAS_DEPENDENTS` confirmation (`confirmDependents: true`) of `delete_folder`. The SDK skills add the same options (`scopeKind`/`folderId`, `folderId` filters, `confirmDependents` / `confirm_dependents`). Requires the server and SDK releases that ship them.
6
+
7
+ ## 0.5.0
8
+
9
+ The woku skill documents folder participants (`get_folder_participants`, `set_folder_participants`, `remove_folder_participant`, `resend_to_missing_participants`), scheduled report emails (`list_scheduled_reports`, `schedule_report`, `update_scheduled_report`, `delete_scheduled_report`, `send_scheduled_report_now`), the period on the folder CSV and the `lastResponse` sort of `search_voc_tools`. The SDK skills add `folderParticipants` / `folder_participants`, `reportSubscriptions` / `report_subscriptions`, the CSV period and the sort. Requires the server and SDK releases that ship them.
10
+
11
+ The woku skill documents `allReviews` on the `whatsappAlertRecipients` of `update_folder`: the admin switch "All reviews" that alerts a number for recognitions too (off by default, improvements only). Requires the server release that ships it.
12
+
13
+ The woku skill documents the response settings of NPS, CSAT and CES (`anonymousDisabled`, `onlyOneResponsePerClient` on `create_*_tool` and `update_*_tool`), editable even after a survey has responses. Requires the server release that ships it.
14
+
3
15
  ## 0.4.0
4
16
 
5
17
  Follow the admin period picker, search box and Sends tab. The woku skill documents `from`/`to` on `get_woku_report`, `get_folder_report` and `get_company_nps_report` (period reports generated on demand, with `periodFrom`/`periodTo`), the custom `from`/`to` range on `get_folder_tools_metrics`, the `q` text search on `list_woku_reviews`, `list_nps_responses`, `list_csat_responses` and `list_ces_responses`, and the read-only `invitations` toolset (`get_invitation_stats`, `list_invitations_by_tool`, `list_invitation_recipients`). It adds the reports the admin opens and the MCP now serves (`get_nps_tool_report`, `get_csat_report`, `get_ces_report`, `scope` on `get_company_nps_report`, `regenerate` on every report tool), and the SDK skills drop `quarantines`, which left the public API. Requires the server and SDK releases that ship them.
package/README.md CHANGED
@@ -100,6 +100,28 @@ Every connection is bound to one company, chosen when you approve access. Read t
100
100
 
101
101
  MIT. See [LICENSE](./LICENSE).
102
102
 
103
+ ### Support and plans by folder update (0.6.0)
104
+
105
+ Support destinations and action plan groups can listen to one tool folder instead
106
+ of tracker rows (`scopeKind: "folder"` with `folderId`; every tool inside it, at
107
+ any depth). Destination, group and ticket lists filter by `folderId`, and
108
+ `delete_folder` asks for `confirmDependents: true` before deleting the destinations
109
+ and groups configured on the folder (with their tickets and plans). The SDK skills
110
+ cover the same options. Verify the server and SDK releases before using them.
111
+
112
+ ### Participants, scheduled reports and survey settings update (0.5.0)
113
+
114
+ The woku skill covers folder participant lists (`get_folder_participants`,
115
+ `set_folder_participants`, `remove_folder_participant`, `resend_to_missing_participants`),
116
+ scheduled report emails (`list_scheduled_reports`, `schedule_report`,
117
+ `update_scheduled_report`, `delete_scheduled_report`, `send_scheduled_report_now`),
118
+ the period on the folder CSV of `get_folder_report`, the `lastResponse` sort of
119
+ `search_voc_tools`, `allReviews` on folder WhatsApp alerts, and the NPS, CSAT and CES
120
+ response settings (`anonymousDisabled`, `onlyOneResponsePerClient`). Sends and deletions
121
+ need `confirm: true`. The SDK skills add `folderParticipants` / `folder_participants` and
122
+ `reportSubscriptions` / `report_subscriptions` (SDK 0.8.0). Verify the server and SDK
123
+ releases before using them.
124
+
103
125
  ### Periods, search and sends update (0.4.0)
104
126
 
105
127
  The woku skill follows the admin period picker, search box and Sends tab: `from`/`to`
@@ -2,7 +2,7 @@
2
2
  "id": "woku-ai-toolkit",
3
3
  "name": "woku AI Toolkit",
4
4
  "description": "Voice-of-customer for your agent. Design a listening program, run the VoC instruments (NPS, CSAT, CES, wokus), and turn every signal into a support ticket or an action plan, through woku's MCP server.",
5
- "version": "0.4.0",
5
+ "version": "0.6.0",
6
6
  "skills": [
7
7
  "./skills"
8
8
  ],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wokuapp/ai-toolkit",
3
- "version": "0.4.0",
3
+ "version": "0.6.0",
4
4
  "description": "woku AI Toolkit: connect your agent to woku's voice-of-customer platform. Design VoC programs and turn customer feedback into support tickets and action plans, through woku's MCP server.",
5
5
  "author": "woku",
6
6
  "license": "MIT",
@@ -68,10 +68,13 @@ One folder tree holds wokus and NPS, CSAT and CES tools together. Call `woku_gui
68
68
  - `search_voc_tools` also takes `trackers` (`"name:value"` chips, up to 10; a tool must have every one; the tracker name is matched exactly and the value partially and ignoring case, so `482` also matches `00482`; company-wide, no folders; a chip without name or value is an error) to find tools by tracker.
69
69
  - `get_folder_tools_metrics` gives, for a folder and its subfolders, per-tool figures for 7, 30 (default) or 90 days, or a custom `from`/`to` range of days (`YYYY-MM-DD`, both inclusive, up to 731 days), against the period before (0 = whole history) and the histogram of scores. It returns `toolCount` and the busiest tools (`limit`, default 50); the daily sums only with `includeDaily: true`. Use it for trends and to find the weakest tools; never average across types.
70
70
  - `get_voc_tools_stats` gives reviews and the headline of each type (woku stars, NPS score, CSAT satisfied %, CES mean) for the company or one folder. Never average across types: the scales differ.
71
- - `create_folder`, `update_folder` (rename, recolor, or set `whatsappAlertRecipients`: the WhatsApp numbers alerted when a comment of any tool in the folder is an improvement) and `move_voc_tools` (items of mixed types, `folderId: null` for the root) organize the tree; `create_nps_tool`, `create_csat_tool` and `create_ces_tool` accept `folderId`.
72
- - `get_folder_report` with `scope: "all"` returns the mixed AI report of a folder and its subfolders, and with `format: "csv"` the responses as CSV text. `search_voc_tools` accepts `foldersLimit` and `foldersCursor` to page the folders ("see more"; `foldersNextCursor` in the result). The folder PDF is binary, so it is only on the API and the SDKs (`GET /v1/folders/{id}/pdf`).
71
+ - `create_folder`, `update_folder` (rename, recolor, or set `whatsappAlertRecipients`: the WhatsApp numbers alerted when a comment of any tool in the folder is an improvement; `allReviews: true` on a number alerts every review, recognitions too) and `move_voc_tools` (items of mixed types, `folderId: null` for the root) organize the tree; `create_nps_tool`, `create_csat_tool` and `create_ces_tool` accept `folderId`. `create_*_tool` and `update_*_tool` for NPS, CSAT and CES also take `anonymousDisabled` (identified answers only) and `onlyOneResponsePerClient` (one answer per identified client; a repeat answer gets HTTP 409 `ALREADY_RESPONDED`); both can change on a survey that already has responses, sending only those fields.
72
+ - `get_folder_report` with `scope: "all"` returns the mixed AI report of a folder and its subfolders, and with `format: "csv"` the responses as CSV text (`from`/`to` also limit the CSV). `search_voc_tools` sorts by the latest response with `sort: "-lastResponse"`. `search_voc_tools` accepts `foldersLimit` and `foldersCursor` to page the folders ("see more"; `foldersNextCursor` in the result). The folder PDF is binary, so it is only on the API and the SDKs (`GET /v1/folders/{id}/pdf`).
73
73
  - Journeys can live in folders (`Viajes > journey > moment`): `get_journey_folders_status` shows whether the company organizes them and what is pending, and `organize_journey_folders` switches it on and runs a background pass that only moves tools without a folder (propose it and wait for approval; it returns a conflict while a pass is running). `get_journey` and `list_journeys` show `folderId` and `momentFolders`, and folders created by woku carry an `origin` (`journeys-root`, `journey`, `journey-moment`, `integration`; integration folders also carry `integrationProvider`, for example `shopify`); read `origin`, `integrationProvider` and the stats of a folder with `search_voc_tools`, not with `get_folder` or `list_folders`, which only count wokus.
74
- - `delete_folder` needs `confirm: true`; nothing inside is deleted, the content moves up to the parent. Moving or deleting folders is a user decision: propose the new structure and wait for approval.
74
+ - A folder can keep a participant list (a program's enrolled): `get_folder_participants` returns it and, per tool of the subtree, the indexes of who answered (`responded`), who did not (`missing`) and who answered more than once (`repeated`), plus `outsideList` and `anonymousAllowed` (anonymous responses cannot be matched). `set_folder_participants` replaces the list (`mode: "replace"`) or adds to it (`mode: "add"`) from text, one person per line with a name, an email and/or a phone; `remove_folder_participant` removes one person or the whole list; `resend_to_missing_participants` sends a tool again to the missing by email or WhatsApp. Removing and resending need `confirm: true`; propose them and wait for approval.
75
+ - `schedule_report` emails the PDF report of a folder or a tool on a schedule (`monthly`, `biweekly`, `weekly` at 12:00 UTC with the previous complete period, or `once` with `periodFrom`/`periodTo`) to up to 10 recipients; `list_scheduled_reports`, `update_scheduled_report` (edit, pause, resume), `delete_scheduled_report` and `send_scheduled_report_now` manage them. Scheduling, sending now and deleting need `confirm: true`: they email real people.
76
+ - `delete_folder` needs `confirm: true`; the content moves up to the parent. Support destinations and action plan groups configured ON that folder are deleted with it, with their tickets and plans: the call then fails with `FOLDER_HAS_DEPENDENTS` and the list; show it and repeat with `confirmDependents: true` only if the user agrees. Moving or deleting folders is a user decision: propose the new structure and wait for approval.
77
+ - Support and plans by folder: `create_ticket_destination` and `create_action_plan_group` (and their `update_*`) take `scopeKind: "folder"` with a `folderId` instead of tracker rows: the destination or group then listens to every tool inside that folder, at any depth, resolved when each review arrives (moving a tool out stops it counting). Never both. A ticket reaches every enabled destination that matches it (trackers, a folder and its subfolders), as one ticket with `destinationIds` (`destinationId` is the highest-priority one); all its email destinations share one email to each address once, listing who got it. `list_ticket_destinations`, `list_action_plan_groups` and `list_tickets` accept `folderId`. When the company already organizes its tools in folders by store, team or moment, propose a folder scope before designing trackers.
75
78
 
76
79
  ## Periods and text search
77
80
 
@@ -72,7 +72,7 @@ await woku.actionPlans.complete('plan_123');
72
72
  Namespaces: `trackers`, `npsTools` / `csatTools` / `cesTools`, `nps` / `csat` /
73
73
  `ces`, `wokus`, `forms`, `flows`, `actionPlans`, `actionPlanGroups`, `tickets`,
74
74
  `ticketDestinations`, `dispatches`, `reports`, `company`, `journeys`, `media`,
75
- `folders`, `tools`, `journeyFolders`.
75
+ `folders`, `folderParticipants`, `tools`, `journeyFolders`, `reportSubscriptions`.
76
76
 
77
77
  ## Pagination, errors, retries
78
78
 
@@ -114,12 +114,22 @@ const metrics = await woku.folders.metrics(folder.id, { days: 30 }); // per tool
114
114
  await woku.tools.move({ items: [{ type: 'csat', id: toolId }], folderId: null }); // null = root
115
115
  const csv: string = await woku.folders.csv(folder.id);
116
116
  const pdf: Uint8Array = await woku.folders.pdf(folder.id, { lang: 'en' }); // folder report as PDF bytes
117
- await woku.folders.delete(folder.id); // content moves up to the parent, nothing is deleted
117
+ await woku.folders.delete(folder.id); // content moves up; 409 FOLDER_HAS_DEPENDENTS if destinations or groups are configured on it
118
+ await woku.folders.delete(folder.id, { confirmDependents: true }); // also deletes those destinations and groups (tickets and plans)
119
+ ```
120
+
121
+ Support and plans by folder: a destination or plan group listens to tracker rows or to one folder (every tool inside it, at any depth), never both.
122
+
123
+ ```ts
124
+ await woku.ticketDestinations.create({ name: 'Store support', kind: 'email', config: { emails: ['support@acme.com'] }, scopeKind: 'folder', folderId: folder.id });
125
+ await woku.actionPlanGroups.create({ name: 'Stores', scopeKind: 'folder', folderId: folder.id, members: [{ userId, role: 'admin' }] });
126
+ const listening = await woku.ticketDestinations.list({ folderId: folder.id }); // on the folder or an ancestor
127
+ for await (const ticket of await woku.tickets.list({ folderId: folder.id })) console.log(ticket.origin?.folder?.path);
118
128
  ```
119
129
 
120
130
  Journeys in folders: `await woku.journeyFolders.status()` and `await woku.journeyFolders.organize()` (background pass, 409 while running); `journeys.get` returns `folderId` and `momentFolders`, and folders expose `origin`.
121
131
 
122
- `folders`: `list`, `get`, `create`, `update`, `move`, `delete`, `report`, `csv`, `pdf`. `tools`: `list` (cursor iterable; `foldersLimit` pages the folders with `page.hasMoreFolders()` / `page.getMoreFolders()`), `stats`, `move`. `npsTools` / `csatTools` / `cesTools` accept `folderId` on `create` and have `move(id, { folderId })`.
132
+ `folders`: `list`, `get`, `create`, `update`, `move`, `delete`, `report`, `csv` (optional `{ from, to }`), `pdf`. `folderParticipants`: `get`, `replace`, `add`, `remove`, `clear`, `resendToMissing`. `reportSubscriptions`: `list`, `create`, `update`, `delete`, `send`. `tools`: `list` (`sort: '-lastResponse'` for the latest responses; cursor iterable; `foldersLimit` pages the folders with `page.hasMoreFolders()` / `page.getMoreFolders()`), `stats`, `move`. `npsTools` / `csatTools` / `cesTools` accept `folderId` on `create` and have `move(id, { folderId })`. They also take `anonymousDisabled` and `onlyOneResponsePerClient` on `create` and `update` (both editable after responses; a repeat answer is HTTP 409 `ALREADY_RESPONDED`).
123
133
 
124
134
  ## Flows
125
135
 
@@ -135,12 +135,23 @@ metrics = woku.folders.metrics(folder["id"], {"days": 30}) # per tool, period v
135
135
  woku.tools.move({"items": [{"type": "csat", "id": tool_id}], "folderId": None}) # None = root
136
136
  csv_text = woku.folders.csv(folder["id"])
137
137
  pdf_bytes = woku.folders.pdf(folder["id"], {"lang": "en"}) # folder report as PDF bytes
138
- woku.folders.delete(folder["id"]) # content moves up to the parent, nothing is deleted
138
+ woku.folders.delete(folder["id"]) # content moves up; 409 FOLDER_HAS_DEPENDENTS if destinations or groups are configured on it
139
+ woku.folders.delete(folder["id"], confirm_dependents=True) # also deletes those destinations and groups (tickets and plans)
140
+ ```
141
+
142
+ Support and plans by folder: a destination or plan group listens to tracker rows or to one folder (every tool inside it, at any depth), never both.
143
+
144
+ ```python
145
+ woku.ticket_destinations.create({"name": "Store support", "kind": "email", "config": {"emails": ["support@acme.com"]}, "scopeKind": "folder", "folderId": folder["id"]})
146
+ woku.action_plan_groups.create({"name": "Stores", "scopeKind": "folder", "folderId": folder["id"], "members": [{"userId": user_id, "role": "admin"}]})
147
+ listening = woku.ticket_destinations.list(params={"folderId": folder["id"]}) # on the folder or an ancestor
148
+ for ticket in woku.tickets.list({"folderId": folder["id"]}):
149
+ print(ticket.get("origin", {}).get("folder", {}).get("path"))
139
150
  ```
140
151
 
141
152
  Journeys in folders: `woku.journey_folders.status()` and `woku.journey_folders.organize()` (background pass, `ConflictError` while running); `journeys.get` returns `folderId` and `momentFolders`, and folders expose `origin`.
142
153
 
143
- `folders`: `list`, `get`, `create`, `update`, `move`, `delete`, `report`, `csv`, `pdf`. `tools`: `list` (iterates across cursor pages; `foldersLimit` pages the folders with `has_more_folders()` / `get_more_folders()`), `stats`, `move`. `nps_tools` / `csat_tools` / `ces_tools` accept `folderId` on `create` and have `move(tool_id, {"folderId": ...})`. `AsyncWoku` mirrors all of it.
154
+ `folders`: `list`, `get`, `create`, `update`, `move`, `delete`, `report`, `csv` (optional `{"from", "to"}`), `pdf`. `folder_participants`: `get`, `replace`, `add`, `remove`, `clear`, `resend_to_missing`. `report_subscriptions`: `list`, `create`, `update`, `delete`, `send`. `tools`: `list` (`{"sort": "-lastResponse"}` for the latest responses; iterates across cursor pages; `foldersLimit` pages the folders with `has_more_folders()` / `get_more_folders()`), `stats`, `move`. `nps_tools` / `csat_tools` / `ces_tools` accept `folderId` on `create` and have `move(tool_id, {"folderId": ...})`. They also take `anonymousDisabled` and `onlyOneResponsePerClient` on `create` and `update` (both editable after responses; a repeat answer is HTTP 409 `ALREADY_RESPONDED`). `AsyncWoku` mirrors all of it.
144
155
 
145
156
  ## Flows
146
157