@seliseblocks/cli-os 0.2.7 → 0.2.9
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/AI_USAGE_GUIDE.md +560 -560
- package/LICENSE +21 -21
- package/README.md +173 -173
- package/bin/run.js +2 -2
- package/dist/commands/data/rules/deploy.js +84 -9
- package/dist/commands/data/rules/pull.js +13 -7
- package/dist/commands/data/schema/get.js +31 -0
- package/dist/commands/data/schema/list.js +8 -1
- package/dist/commands/data/schema/pull.js +22 -9
- package/dist/commands/data/schema/push.js +31 -9
- package/dist/index.js +702 -692
- package/dist/lib/data-files.d.ts +14 -0
- package/dist/lib/data-files.js +91 -0
- package/dist/lib/data-response.d.ts +13 -0
- package/dist/lib/data-response.js +26 -0
- package/dist/skills/blocks-data-gateway-configuration/SKILL.md +204 -204
- package/dist/skills/blocks-data-gateway-crud/SKILL.md +223 -223
- package/dist/skills/blocks-data-storage/SKILL.md +253 -253
- package/dist/skills/blocks-data-storage/flows/object-management.md +124 -124
- package/dist/skills/blocks-frontend-local-https/SKILL.md +100 -100
- package/dist/skills/blocks-iam-access-control/SKILL.md +49 -49
- package/dist/skills/blocks-iam-access-control/flows/feature-gating.md +38 -38
- package/dist/skills/blocks-iam-access-control/flows/manage-roles-permissions.md +110 -110
- package/dist/skills/blocks-iam-account/SKILL.md +169 -169
- package/dist/skills/blocks-iam-mfa/SKILL.md +124 -124
- package/dist/skills/blocks-iam-organizations/SKILL.md +43 -43
- package/dist/skills/blocks-iam-organizations/flows/admin-mutations.md +89 -89
- package/dist/skills/blocks-iam-organizations/flows/read-and-switch.md +57 -57
- package/dist/skills/blocks-iam-sso-oidc-configuration/SKILL.md +105 -105
- package/dist/skills/blocks-iam-sso-oidc-implementation/SKILL.md +80 -80
- package/dist/skills/blocks-iam-users/SKILL.md +131 -131
- package/dist/skills/blocks-localization-configuration/SKILL.md +149 -149
- package/dist/skills/blocks-localization-implementation/SKILL.md +63 -63
- package/dist/skills/blocks-mail/SKILL.md +95 -95
- package/dist/skills/blocks-notification/SKILL.md +69 -69
- package/dist/skills/blocks-notifier/SKILL.md +107 -107
- package/dist/skills/blocks-onboarding/SKILL.md +77 -78
- package/dist/skills/blocks-release-deployment/SKILL.md +81 -81
- package/dist/skills/blocks-secrets/SKILL.md +81 -81
- package/dist/skills/blocks-storage-configuration/SKILL.md +93 -93
- package/dist/skills/lint.mjs +168 -168
- package/package.json +47 -47
|
@@ -1,107 +1,107 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: blocks-notifier
|
|
3
|
-
description: "Push real-time/offline notifications and manage a signed-in user's own notification inbox, via both the SDK (`blocksClient.notifier.*`) and the CLI (`blocks notifier notify|list|unread|mark-read|mark-all-read`). Distinct from the sibling blocks-notification skill, which configures tenant notification-*channel* settings on a different backing service, not sending. `notifier unread` flattens its subscription filter into GET query params since Fetch forbids a GET body. `--dry-run` before `--yes` on CLI `notify`/`mark-read`/`mark-all-read`."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Blocks Notifier — Send & Inbox
|
|
7
|
-
|
|
8
|
-
`notifier` pushes real-time/offline notifications to users, roles, or subscription-filter matches, and reads/manages the signed-in user's own notification inbox. This is a **separate, deliberate concern from the blocks-notification skill**, which manages a tenant's notification-*channel configuration* — which channel/method a notification type uses — on an unrelated backing service. Both this skill and the sibling skill confirm the same distinction from their own side. Don't merge them, and don't reconcile them as if one were a typo for the other — they hit different backing services. If the ask is "configure which channel a notification type uses," route to the blocks-notification skill instead.
|
|
9
|
-
|
|
10
|
-
Unlike `blocks-notification` (100% CLI, no SDK path), **`notifier` has both a CLI and an SDK surface**, and every one of the five operations exists on both:
|
|
11
|
-
|
|
12
|
-
| Operation | CLI | SDK (`blocksClient.notifier.*`) |
|
|
13
|
-
|---|---|---|
|
|
14
|
-
| Send a notification | `blocks notifier notify` | `notify(request)` |
|
|
15
|
-
| List the inbox | `blocks notifier list` | `getNotifications(options)` |
|
|
16
|
-
| Unread by subscription filter | `blocks notifier unread` | `getUnreadNotificationsBySubscriptionFilter(request)` |
|
|
17
|
-
| Mark one read | `blocks notifier mark-read <id>` | `markNotificationAsRead(request)` |
|
|
18
|
-
| Mark all read | `blocks notifier mark-all-read` | `markAllNotificationAsRead()` |
|
|
19
|
-
|
|
20
|
-
## CLI — `blocks notifier *`
|
|
21
|
-
|
|
22
|
-
Every CLI command is project-scoped: each requires an impersonated project session — there is no account-level mode for any of the five. Project resolution follows the same order as everywhere else in this CLI: `--project <tenantId>` flag, then the workspace's `blocks.json`, then the globally selected project from `blocks use <tenantId>`. See the blocks-onboarding skill if no project is selected yet.
|
|
23
|
-
|
|
24
|
-
- **`blocks notifier notify [--user-ids a,b] [--roles a,b] [--connection-id <id>] [--configuration-name <n>] [--subscription-filters '<json>'] [--denormalized-payload <text>] [--save-denormalized-payload-as-object] [--content-available] [--response-key <k>] [--response-value <v>] [--body '<json>'|--file <path>] [--dry-run] [--yes] [--json]`** — target with at least one of `--user-ids`/`--roles`/`--subscription-filters`. `--user-ids` and `--roles` are comma-separated lists; `--subscription-filters` is a raw JSON array string (e.g. `[{"context":"orders","actionName":"created","value":"*"}]`, matching `BlocksNotifierSubscriptionFilter[]`). The body is built by merging `--body`/`--file` first, then layering the convenience flags on top — so an explicit convenience flag always wins over the same field in `--body`/`--file`, and an unset one never overwrites what `--body`/`--file` supplied. `--content-available` and `--save-denormalized-payload-as-object` are true-only booleans (absent when not passed, never an explicit `false`).
|
|
25
|
-
- **`blocks notifier list [--unread-only] [--page <n>] [--page-size <n>] [--sort-by <property>] [--sort-desc] [--filter <text>] [--json]`** — read-only.
|
|
26
|
-
- **`blocks notifier unread [--user-id <id>] [--context <c>] [--action-name <a>] [--value <v>] [--order-by <1|2>] [--json]`** — read-only. See "The GET-with-a-body quirk" below.
|
|
27
|
-
- **`blocks notifier mark-read <id> [--dry-run] [--yes] [--json]`** — `id` may be positional or `--id`; one of the two is required (`Missing --id` if neither given).
|
|
28
|
-
- **`blocks notifier mark-all-read [--dry-run] [--yes] [--json]`** — no body/arguments needed.
|
|
29
|
-
|
|
30
|
-
### The GET-with-a-body quirk (`unread`)
|
|
31
|
-
|
|
32
|
-
This operation is documented upstream as a read with a JSON request body, which the Fetch spec forbids sending on a plain GET-style read. Both the CLI and SDK work around it the same way: flatten the filter fields into the query string instead. Confirmed field names, read directly from source:
|
|
33
|
-
|
|
34
|
-
```
|
|
35
|
-
UserId
|
|
36
|
-
SubscriptionFilterData.Context
|
|
37
|
-
SubscriptionFilterData.ActionName
|
|
38
|
-
SubscriptionFilterData.Value
|
|
39
|
-
OrderBy
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
CLI flags map to them as `--user-id` -> `UserId`, `--context` -> `SubscriptionFilterData.Context`, `--action-name` -> `SubscriptionFilterData.ActionName`, `--value` -> `SubscriptionFilterData.Value`, `--order-by` -> `OrderBy` (an integer, `1|2` per the SDK type — its enum meaning isn't published anywhere, so treat it as opaque and confirm with the user rather than guessing which value means what).
|
|
43
|
-
|
|
44
|
-
This flattening is a **client-side inference, not something verified against a live call** — both the CLI and SDK made the same choice independently, which is corroborating but not proof the real backend accepts it. If a live `notifier unread` call ever errors, re-check this against the actual API response rather than assuming the flattening above is still correct.
|
|
45
|
-
|
|
46
|
-
## SDK — `blocksClient.notifier.*`
|
|
47
|
-
|
|
48
|
-
```ts
|
|
49
|
-
import { blocksClient } from "../../lib/blocks/client";
|
|
50
|
-
|
|
51
|
-
await blocksClient.notifier.notify({
|
|
52
|
-
userIds: ["user-1"],
|
|
53
|
-
roles: ["admin"],
|
|
54
|
-
denormalizedPayload: '{"orderId":"123"}',
|
|
55
|
-
saveDenormalizedPayloadAsAnObject: true
|
|
56
|
-
});
|
|
57
|
-
|
|
58
|
-
const inbox = await blocksClient.notifier.getNotifications({ isUnreadOnly: true, page: 1, pageSize: 20 });
|
|
59
|
-
|
|
60
|
-
const unread = await blocksClient.notifier.getUnreadNotificationsBySubscriptionFilter({
|
|
61
|
-
userId: "user-1",
|
|
62
|
-
subscriptionFilterData: { context: "orders", actionName: "created" }
|
|
63
|
-
});
|
|
64
|
-
|
|
65
|
-
await blocksClient.notifier.markNotificationAsRead({ id: notificationId });
|
|
66
|
-
await blocksClient.notifier.markAllNotificationAsRead();
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
- **`notify(request: BlocksNotifyRequest)`** — fields: `configurationName?`, `connectionId?`, `contentAvailable?: boolean`, `denormalizedPayload?: string`, `responseKey?`, `responseValue?`, `roles?: string[]`, `saveDenormalizedPayloadAsAnObject?: boolean`, `subscriptionFilters?: BlocksNotifierSubscriptionFilter[]`, `userIds?: string[]`.
|
|
70
|
-
- **`getUnreadNotificationsBySubscriptionFilter(request)`** — fields: `orderBy?: 1 | 2` (opaque enum), `subscriptionFilterData?: { actionName?, context?, value? }`, `userId?`. Internally builds the same flattened query as the CLI (see above) — this is the SDK-side half of the same documented workaround.
|
|
71
|
-
- **`getNotifications(options: BlocksGetNotificationsOptions = {})`** — options: `filter?`, `isUnreadOnly?`, `page?`, `pageSize?`, `sortBy?`, `sortDescending?`. Response shape: `{ notifications: Record<string, unknown>[], totalNotificationsCount: number, unReadNotificationsCount: number }`.
|
|
72
|
-
- **`markAllNotificationAsRead()`** — no arguments.
|
|
73
|
-
- **`markNotificationAsRead(request: BlocksMarkNotificationAsReadRequest)`** — request: `{ id: string }`.
|
|
74
|
-
|
|
75
|
-
`BlocksOfflineNotification` (the shape of items `getUnreadNotificationsBySubscriptionFilter` resolves to) is a loose `Record<string, unknown>` plus known fields `correlationId?`, `createdTime?`, `denormalizedPayload?`, `id?`, `isRead?`, `payload?`, `readByRoles?: string[]`, `readByUserIds?: string[]`. `BlocksNotifierPassThroughResponse` (the `notify`/mark-read/mark-all-read return type) is an untyped `Record<string, unknown>` — the SDK doesn't shape it further; don't assume fields beyond what a live response actually contains.
|
|
76
|
-
|
|
77
|
-
The SDK methods don't take a project/tenant argument per call — project context comes from however the app's shared `blocksClient` instance was constructed (its `xBlocksKey`/`appDomain`), same as every other `blocksClient.*` namespace. Don't create a second client just for notifier calls.
|
|
78
|
-
|
|
79
|
-
## Mutation discipline (CLI only)
|
|
80
|
-
|
|
81
|
-
`notify`, `mark-read`, and `mark-all-read` are the three CLI mutations, and all three follow the same two-gate pattern used throughout this CLI:
|
|
82
|
-
|
|
83
|
-
1. **`--dry-run`** short-circuits before any network call or confirmation prompt, printing a preview of what would be sent (`mark-all-read`'s preview has no request body since it sends none).
|
|
84
|
-
2. Without `--dry-run`, a confirmation step accepts `--yes` outright or, interactively, prompts to type "yes" to continue, and cancels on anything else.
|
|
85
|
-
|
|
86
|
-
Always show the `--dry-run` output and get explicit approval before re-running with `--yes`. `list` and `unread` are read-only and have neither flag — don't tell a user to `--dry-run` a `list` or `unread` call. The SDK methods have no equivalent gate at all; that discipline is a CLI-only convention for terminal/CI operators, not something app code needs to replicate.
|
|
87
|
-
|
|
88
|
-
## Gotchas
|
|
89
|
-
|
|
90
|
-
- **`notifier` and `notification` are not the same thing, and this is not an oversight to fix.** `notifier` (this skill) sends notifications and reads a user's inbox, on both CLI and SDK. `notification` (the sibling skill) configures a tenant's notification channel settings, CLI-only. Don't answer a "send a notification" ask with `notification save`, and don't answer a "configure the channel" ask with `notifier`.
|
|
91
|
-
- **`notifier unread`'s query-param flattening is an inferred client-side workaround for a Fetch-spec conflict, not verified against a live call.** See "The GET-with-a-body quirk" above. If it ever errors in practice, re-check whether the real endpoint tolerates a body server-side (some non-browser/non-Node HTTP stacks do) before assuming the flattening itself is broken.
|
|
92
|
-
- **`--content-available` and `--save-denormalized-payload-as-object` on `notify` are true-only flags.** Passing them sends `true`; omitting them omits the field entirely — there's no way to send an explicit `false` through the convenience flags (use `--body`/`--file` for that).
|
|
93
|
-
- **Convenience flags on `notify` win over `--body`/`--file`.** The merge order is `--body`/`--file` first, then the individual flags spread on top — so a flag like `--connection-id` always overrides the same key in `--body` if both are given.
|
|
94
|
-
- **`order-by` (both CLI `--order-by` and SDK `orderBy`) is an opaque `1|2` enum** — its meaning isn't published anywhere. Ask the user or confirm from the live API rather than guessing which value sorts which way.
|
|
95
|
-
- **Every CLI command is project-scoped**; there's no account-level mode. The SDK has no per-call project argument — it inherits whatever project the shared `blocksClient` was configured for.
|
|
96
|
-
- **`mark-read`'s `id` (positional or `--id`) is always required** — never guessed or defaulted.
|
|
97
|
-
- **`--dry-run` before `--yes`, always**, on the three CLI mutations — same discipline as every other mutating `blocks` command in this pack.
|
|
98
|
-
|
|
99
|
-
## Example trigger prompts
|
|
100
|
-
|
|
101
|
-
- "Send a notification to these user IDs from my app." -> SDK `blocksClient.notifier.notify({ userIds: [...] })`.
|
|
102
|
-
- "Push a notification to everyone matching this subscription filter." -> SDK `notify({ subscriptionFilters: [...] })`, or `blocks notifier notify --subscription-filters '<json>' --dry-run --json` from the terminal.
|
|
103
|
-
- "Show me a user's unread notifications for the 'orders' context." -> `blocks notifier unread --user-id <id> --context orders --json`, or SDK `getUnreadNotificationsBySubscriptionFilter({ userId, subscriptionFilterData: { context: "orders" } })`.
|
|
104
|
-
- "List my notification inbox, unread only." -> `blocks notifier list --unread-only --json`, or SDK `getNotifications({ isUnreadOnly: true })`.
|
|
105
|
-
- "Mark this notification as read." -> `blocks notifier mark-read <id> --dry-run --json`, then `--yes`.
|
|
106
|
-
- "Mark everything in the inbox as read." -> `blocks notifier mark-all-read --dry-run --json`, then `--yes`.
|
|
107
|
-
- "Configure which channel the order-shipped notification uses." -> not this skill; that's the blocks-notification skill.
|
|
1
|
+
---
|
|
2
|
+
name: blocks-notifier
|
|
3
|
+
description: "Push real-time/offline notifications and manage a signed-in user's own notification inbox, via both the SDK (`blocksClient.notifier.*`) and the CLI (`blocks notifier notify|list|unread|mark-read|mark-all-read`). Distinct from the sibling blocks-notification skill, which configures tenant notification-*channel* settings on a different backing service, not sending. `notifier unread` flattens its subscription filter into GET query params since Fetch forbids a GET body. `--dry-run` before `--yes` on CLI `notify`/`mark-read`/`mark-all-read`."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Blocks Notifier — Send & Inbox
|
|
7
|
+
|
|
8
|
+
`notifier` pushes real-time/offline notifications to users, roles, or subscription-filter matches, and reads/manages the signed-in user's own notification inbox. This is a **separate, deliberate concern from the blocks-notification skill**, which manages a tenant's notification-*channel configuration* — which channel/method a notification type uses — on an unrelated backing service. Both this skill and the sibling skill confirm the same distinction from their own side. Don't merge them, and don't reconcile them as if one were a typo for the other — they hit different backing services. If the ask is "configure which channel a notification type uses," route to the blocks-notification skill instead.
|
|
9
|
+
|
|
10
|
+
Unlike `blocks-notification` (100% CLI, no SDK path), **`notifier` has both a CLI and an SDK surface**, and every one of the five operations exists on both:
|
|
11
|
+
|
|
12
|
+
| Operation | CLI | SDK (`blocksClient.notifier.*`) |
|
|
13
|
+
|---|---|---|
|
|
14
|
+
| Send a notification | `blocks notifier notify` | `notify(request)` |
|
|
15
|
+
| List the inbox | `blocks notifier list` | `getNotifications(options)` |
|
|
16
|
+
| Unread by subscription filter | `blocks notifier unread` | `getUnreadNotificationsBySubscriptionFilter(request)` |
|
|
17
|
+
| Mark one read | `blocks notifier mark-read <id>` | `markNotificationAsRead(request)` |
|
|
18
|
+
| Mark all read | `blocks notifier mark-all-read` | `markAllNotificationAsRead()` |
|
|
19
|
+
|
|
20
|
+
## CLI — `blocks notifier *`
|
|
21
|
+
|
|
22
|
+
Every CLI command is project-scoped: each requires an impersonated project session — there is no account-level mode for any of the five. Project resolution follows the same order as everywhere else in this CLI: `--project <tenantId>` flag, then the workspace's `blocks.json`, then the globally selected project from `blocks use <tenantId>`. See the blocks-onboarding skill if no project is selected yet.
|
|
23
|
+
|
|
24
|
+
- **`blocks notifier notify [--user-ids a,b] [--roles a,b] [--connection-id <id>] [--configuration-name <n>] [--subscription-filters '<json>'] [--denormalized-payload <text>] [--save-denormalized-payload-as-object] [--content-available] [--response-key <k>] [--response-value <v>] [--body '<json>'|--file <path>] [--dry-run] [--yes] [--json]`** — target with at least one of `--user-ids`/`--roles`/`--subscription-filters`. `--user-ids` and `--roles` are comma-separated lists; `--subscription-filters` is a raw JSON array string (e.g. `[{"context":"orders","actionName":"created","value":"*"}]`, matching `BlocksNotifierSubscriptionFilter[]`). The body is built by merging `--body`/`--file` first, then layering the convenience flags on top — so an explicit convenience flag always wins over the same field in `--body`/`--file`, and an unset one never overwrites what `--body`/`--file` supplied. `--content-available` and `--save-denormalized-payload-as-object` are true-only booleans (absent when not passed, never an explicit `false`).
|
|
25
|
+
- **`blocks notifier list [--unread-only] [--page <n>] [--page-size <n>] [--sort-by <property>] [--sort-desc] [--filter <text>] [--json]`** — read-only.
|
|
26
|
+
- **`blocks notifier unread [--user-id <id>] [--context <c>] [--action-name <a>] [--value <v>] [--order-by <1|2>] [--json]`** — read-only. See "The GET-with-a-body quirk" below.
|
|
27
|
+
- **`blocks notifier mark-read <id> [--dry-run] [--yes] [--json]`** — `id` may be positional or `--id`; one of the two is required (`Missing --id` if neither given).
|
|
28
|
+
- **`blocks notifier mark-all-read [--dry-run] [--yes] [--json]`** — no body/arguments needed.
|
|
29
|
+
|
|
30
|
+
### The GET-with-a-body quirk (`unread`)
|
|
31
|
+
|
|
32
|
+
This operation is documented upstream as a read with a JSON request body, which the Fetch spec forbids sending on a plain GET-style read. Both the CLI and SDK work around it the same way: flatten the filter fields into the query string instead. Confirmed field names, read directly from source:
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
UserId
|
|
36
|
+
SubscriptionFilterData.Context
|
|
37
|
+
SubscriptionFilterData.ActionName
|
|
38
|
+
SubscriptionFilterData.Value
|
|
39
|
+
OrderBy
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
CLI flags map to them as `--user-id` -> `UserId`, `--context` -> `SubscriptionFilterData.Context`, `--action-name` -> `SubscriptionFilterData.ActionName`, `--value` -> `SubscriptionFilterData.Value`, `--order-by` -> `OrderBy` (an integer, `1|2` per the SDK type — its enum meaning isn't published anywhere, so treat it as opaque and confirm with the user rather than guessing which value means what).
|
|
43
|
+
|
|
44
|
+
This flattening is a **client-side inference, not something verified against a live call** — both the CLI and SDK made the same choice independently, which is corroborating but not proof the real backend accepts it. If a live `notifier unread` call ever errors, re-check this against the actual API response rather than assuming the flattening above is still correct.
|
|
45
|
+
|
|
46
|
+
## SDK — `blocksClient.notifier.*`
|
|
47
|
+
|
|
48
|
+
```ts
|
|
49
|
+
import { blocksClient } from "../../lib/blocks/client";
|
|
50
|
+
|
|
51
|
+
await blocksClient.notifier.notify({
|
|
52
|
+
userIds: ["user-1"],
|
|
53
|
+
roles: ["admin"],
|
|
54
|
+
denormalizedPayload: '{"orderId":"123"}',
|
|
55
|
+
saveDenormalizedPayloadAsAnObject: true
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
const inbox = await blocksClient.notifier.getNotifications({ isUnreadOnly: true, page: 1, pageSize: 20 });
|
|
59
|
+
|
|
60
|
+
const unread = await blocksClient.notifier.getUnreadNotificationsBySubscriptionFilter({
|
|
61
|
+
userId: "user-1",
|
|
62
|
+
subscriptionFilterData: { context: "orders", actionName: "created" }
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
await blocksClient.notifier.markNotificationAsRead({ id: notificationId });
|
|
66
|
+
await blocksClient.notifier.markAllNotificationAsRead();
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
- **`notify(request: BlocksNotifyRequest)`** — fields: `configurationName?`, `connectionId?`, `contentAvailable?: boolean`, `denormalizedPayload?: string`, `responseKey?`, `responseValue?`, `roles?: string[]`, `saveDenormalizedPayloadAsAnObject?: boolean`, `subscriptionFilters?: BlocksNotifierSubscriptionFilter[]`, `userIds?: string[]`.
|
|
70
|
+
- **`getUnreadNotificationsBySubscriptionFilter(request)`** — fields: `orderBy?: 1 | 2` (opaque enum), `subscriptionFilterData?: { actionName?, context?, value? }`, `userId?`. Internally builds the same flattened query as the CLI (see above) — this is the SDK-side half of the same documented workaround.
|
|
71
|
+
- **`getNotifications(options: BlocksGetNotificationsOptions = {})`** — options: `filter?`, `isUnreadOnly?`, `page?`, `pageSize?`, `sortBy?`, `sortDescending?`. Response shape: `{ notifications: Record<string, unknown>[], totalNotificationsCount: number, unReadNotificationsCount: number }`.
|
|
72
|
+
- **`markAllNotificationAsRead()`** — no arguments.
|
|
73
|
+
- **`markNotificationAsRead(request: BlocksMarkNotificationAsReadRequest)`** — request: `{ id: string }`.
|
|
74
|
+
|
|
75
|
+
`BlocksOfflineNotification` (the shape of items `getUnreadNotificationsBySubscriptionFilter` resolves to) is a loose `Record<string, unknown>` plus known fields `correlationId?`, `createdTime?`, `denormalizedPayload?`, `id?`, `isRead?`, `payload?`, `readByRoles?: string[]`, `readByUserIds?: string[]`. `BlocksNotifierPassThroughResponse` (the `notify`/mark-read/mark-all-read return type) is an untyped `Record<string, unknown>` — the SDK doesn't shape it further; don't assume fields beyond what a live response actually contains.
|
|
76
|
+
|
|
77
|
+
The SDK methods don't take a project/tenant argument per call — project context comes from however the app's shared `blocksClient` instance was constructed (its `xBlocksKey`/`appDomain`), same as every other `blocksClient.*` namespace. Don't create a second client just for notifier calls.
|
|
78
|
+
|
|
79
|
+
## Mutation discipline (CLI only)
|
|
80
|
+
|
|
81
|
+
`notify`, `mark-read`, and `mark-all-read` are the three CLI mutations, and all three follow the same two-gate pattern used throughout this CLI:
|
|
82
|
+
|
|
83
|
+
1. **`--dry-run`** short-circuits before any network call or confirmation prompt, printing a preview of what would be sent (`mark-all-read`'s preview has no request body since it sends none).
|
|
84
|
+
2. Without `--dry-run`, a confirmation step accepts `--yes` outright or, interactively, prompts to type "yes" to continue, and cancels on anything else.
|
|
85
|
+
|
|
86
|
+
Always show the `--dry-run` output and get explicit approval before re-running with `--yes`. `list` and `unread` are read-only and have neither flag — don't tell a user to `--dry-run` a `list` or `unread` call. The SDK methods have no equivalent gate at all; that discipline is a CLI-only convention for terminal/CI operators, not something app code needs to replicate.
|
|
87
|
+
|
|
88
|
+
## Gotchas
|
|
89
|
+
|
|
90
|
+
- **`notifier` and `notification` are not the same thing, and this is not an oversight to fix.** `notifier` (this skill) sends notifications and reads a user's inbox, on both CLI and SDK. `notification` (the sibling skill) configures a tenant's notification channel settings, CLI-only. Don't answer a "send a notification" ask with `notification save`, and don't answer a "configure the channel" ask with `notifier`.
|
|
91
|
+
- **`notifier unread`'s query-param flattening is an inferred client-side workaround for a Fetch-spec conflict, not verified against a live call.** See "The GET-with-a-body quirk" above. If it ever errors in practice, re-check whether the real endpoint tolerates a body server-side (some non-browser/non-Node HTTP stacks do) before assuming the flattening itself is broken.
|
|
92
|
+
- **`--content-available` and `--save-denormalized-payload-as-object` on `notify` are true-only flags.** Passing them sends `true`; omitting them omits the field entirely — there's no way to send an explicit `false` through the convenience flags (use `--body`/`--file` for that).
|
|
93
|
+
- **Convenience flags on `notify` win over `--body`/`--file`.** The merge order is `--body`/`--file` first, then the individual flags spread on top — so a flag like `--connection-id` always overrides the same key in `--body` if both are given.
|
|
94
|
+
- **`order-by` (both CLI `--order-by` and SDK `orderBy`) is an opaque `1|2` enum** — its meaning isn't published anywhere. Ask the user or confirm from the live API rather than guessing which value sorts which way.
|
|
95
|
+
- **Every CLI command is project-scoped**; there's no account-level mode. The SDK has no per-call project argument — it inherits whatever project the shared `blocksClient` was configured for.
|
|
96
|
+
- **`mark-read`'s `id` (positional or `--id`) is always required** — never guessed or defaulted.
|
|
97
|
+
- **`--dry-run` before `--yes`, always**, on the three CLI mutations — same discipline as every other mutating `blocks` command in this pack.
|
|
98
|
+
|
|
99
|
+
## Example trigger prompts
|
|
100
|
+
|
|
101
|
+
- "Send a notification to these user IDs from my app." -> SDK `blocksClient.notifier.notify({ userIds: [...] })`.
|
|
102
|
+
- "Push a notification to everyone matching this subscription filter." -> SDK `notify({ subscriptionFilters: [...] })`, or `blocks notifier notify --subscription-filters '<json>' --dry-run --json` from the terminal.
|
|
103
|
+
- "Show me a user's unread notifications for the 'orders' context." -> `blocks notifier unread --user-id <id> --context orders --json`, or SDK `getUnreadNotificationsBySubscriptionFilter({ userId, subscriptionFilterData: { context: "orders" } })`.
|
|
104
|
+
- "List my notification inbox, unread only." -> `blocks notifier list --unread-only --json`, or SDK `getNotifications({ isUnreadOnly: true })`.
|
|
105
|
+
- "Mark this notification as read." -> `blocks notifier mark-read <id> --dry-run --json`, then `--yes`.
|
|
106
|
+
- "Mark everything in the inbox as read." -> `blocks notifier mark-all-read --dry-run --json`, then `--yes`.
|
|
107
|
+
- "Configure which channel the order-shipped notification uses." -> not this skill; that's the blocks-notification skill.
|
|
@@ -1,78 +1,77 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: blocks-onboarding
|
|
3
|
-
description: "Onboard a user into SELISE Blocks before any other Blocks skill can run, using the `blocks` CLI — never raw API calls. Detects
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Blocks — Onboarding
|
|
7
|
-
|
|
8
|
-
Every other Blocks skill assumes: the `blocks` CLI is installed, the user is logged in (`login`), and a project is selected (`use`). This skill detects which of those is missing and closes the gap. **Everything here goes through `blocks` — never a raw `fetch`/`curl` against `api.seliseblocks.com`.**
|
|
9
|
-
|
|
10
|
-
The CLI's own usage guide (bundled with the `blocks-cli` package) is the command-level ground truth (exact flags, defaults, failure codes); this skill is the conversational flow around it — what to ask, what's portal-only, and in what order.
|
|
11
|
-
|
|
12
|
-
## Probe first, ask second
|
|
13
|
-
|
|
14
|
-
Run `blocks auth status --json` and branch on the result — don't interrogate the user about state that's discoverable:
|
|
15
|
-
|
|
16
|
-
| Signal | State | Do this |
|
|
17
|
-
|---|---|---|
|
|
18
|
-
| command not found | CLI not installed | `npm install -g @seliseblocks/cli-os`, then re-probe |
|
|
19
|
-
| `accountAccessToken`/`accountRefreshToken` both `"missing"` | Never logged in | Step 1 — `login` |
|
|
20
|
-
| logged in, no project selected (check `blocks doctor --json`'s "Project selected" check) | No project selected | Step 2 — list/`use` |
|
|
21
|
-
| logged in, project selected | Ready | Confirm the project with the user — always show the full accessible-project list and which one is currently selected, never silently continue on a prior session's selection — then hand off to the skill/task that brought you here |
|
|
22
|
-
|
|
23
|
-
If anything looks broken rather than simply "not yet done" (unreadable/stale local token storage after a machine migration, Windows profile change, Keychain reset), run `blocks doctor --json` for the fuller diagnostic — it checks Node version, config/token/secret file locations, and token freshness in one pass. If storage itself is unreadable or corrupted, `blocks auth remove <account>` clears cached tokens and stored local credentials (restoring the packaged default account), then re-run `login`.
|
|
24
|
-
|
|
25
|
-
## Step 1 — Log in
|
|
26
|
-
|
|
27
|
-
The CLI authenticates itself with no setup. There is no OIDC client to register in the portal for this, no client id/secret to collect from the user, and nothing about how the CLI does it to look up, print, or report — just log in:
|
|
28
|
-
|
|
29
|
-
```bash
|
|
30
|
-
blocks login
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
Device-code flow: it prints a verification URL and user code, opens the browser to the verification page when possible so the user only needs to click approve, then polls until the device is authorized; stores account access and refresh tokens and auto-refreshes later. Run it yourself rather than only telling the user to run it, so you can read the printed code/URL and confirm the result right after.
|
|
34
|
-
|
|
35
|
-
Verify with `blocks auth status --json` — re-run after login rather than assuming it worked.
|
|
36
|
-
|
|
37
|
-
## Step 2 — Project
|
|
38
|
-
|
|
39
|
-
Ask **what the user wants to build** and whether they already have a project, rather than assuming:
|
|
40
|
-
|
|
41
|
-
```bash
|
|
42
|
-
blocks projects list --json
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
Always show the full list of accessible projects, and if one already appears selected, say which one — never silently continue on a prior session's selection. If projects exist, confirm which one (and which environment) the user wants; never guess.
|
|
46
|
-
|
|
47
|
-
**`projects create` is currently disabled in this CLI build** (commented out pending a product decision — there is no CLI path to create a new project). If none of the listed projects fit, tell the user a new project must be created from the Blocks portal first; once they confirm it exists, re-run `blocks projects list --json` and continue from here.
|
|
48
|
-
|
|
49
|
-
Then select it:
|
|
50
|
-
|
|
51
|
-
```bash
|
|
52
|
-
blocks use <x-blocks-key>
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
Project (impersonation) tokens are created lazily from the account session the first time a project-scoped command needs one — never ask the user for a project token directly. If an impersonated project token later gets stuck, rejected, or expired and `blocks auth refresh --project --json` doesn't fix it, recover with:
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
blocks deselect # drops the selection and its cached impersonation token
|
|
59
|
-
blocks use <x-blocks-key> # reselect the same x-blocks-key to force a fresh impersonation
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
## Step 3 — Local workspace + hand off
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
-
|
|
68
|
-
- `blocks
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
-
|
|
75
|
-
-
|
|
76
|
-
- **
|
|
77
|
-
-
|
|
78
|
-
- **`--dry-run` before `--yes`** on every mutating command (`auth oidc-clients save`, `data schema push`/`data rules deploy`, `localization push`, `release deploy`) — this recurs in every skill that mutates project state.
|
|
1
|
+
---
|
|
2
|
+
name: blocks-onboarding
|
|
3
|
+
description: "Onboard a user into SELISE Blocks before any other Blocks skill can run, using the `blocks` CLI — never raw API calls. Detects CLI/login/project state via `blocks auth status --json`/`doctor --json`, closes install/login/project gaps, resolves the app OIDC client, scaffolds with `blocks new web`, then runs `blocks init` only inside the generated/existing app directory when local Blocks files are needed. Use for new users or `not_logged_in`/`project_not_selected`."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Blocks — Onboarding
|
|
7
|
+
|
|
8
|
+
Every other Blocks skill assumes: the `blocks` CLI is installed, the user is logged in (`login`), and a project is selected (`use`). This skill detects which of those is missing and closes the gap. **Everything here goes through `blocks` — never a raw `fetch`/`curl` against `api.seliseblocks.com`.**
|
|
9
|
+
|
|
10
|
+
The CLI's own usage guide (bundled with the `blocks-cli` package) is the command-level ground truth (exact flags, defaults, failure codes); this skill is the conversational flow around it — what to ask, what's portal-only, and in what order.
|
|
11
|
+
|
|
12
|
+
## Probe first, ask second
|
|
13
|
+
|
|
14
|
+
Run `blocks auth status --json` and branch on the result — don't interrogate the user about state that's discoverable:
|
|
15
|
+
|
|
16
|
+
| Signal | State | Do this |
|
|
17
|
+
|---|---|---|
|
|
18
|
+
| command not found | CLI not installed | `npm install -g @seliseblocks/cli-os`, then re-probe |
|
|
19
|
+
| `accountAccessToken`/`accountRefreshToken` both `"missing"` | Never logged in | Step 1 — `login` |
|
|
20
|
+
| logged in, no project selected (check `blocks doctor --json`'s "Project selected" check) | No project selected | Step 2 — list/`use` |
|
|
21
|
+
| logged in, project selected | Ready | Confirm the project with the user — always show the full accessible-project list and which one is currently selected, never silently continue on a prior session's selection — then hand off to the skill/task that brought you here |
|
|
22
|
+
|
|
23
|
+
If anything looks broken rather than simply "not yet done" (unreadable/stale local token storage after a machine migration, Windows profile change, Keychain reset), run `blocks doctor --json` for the fuller diagnostic — it checks Node version, config/token/secret file locations, and token freshness in one pass. If storage itself is unreadable or corrupted, `blocks auth remove <account>` clears cached tokens and stored local credentials (restoring the packaged default account), then re-run `login`.
|
|
24
|
+
|
|
25
|
+
## Step 1 — Log in
|
|
26
|
+
|
|
27
|
+
The CLI authenticates itself with no setup. There is no OIDC client to register in the portal for this, no client id/secret to collect from the user, and nothing about how the CLI does it to look up, print, or report — just log in:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
blocks login
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Device-code flow: it prints a verification URL and user code, opens the browser to the verification page when possible so the user only needs to click approve, then polls until the device is authorized; stores account access and refresh tokens and auto-refreshes later. Run it yourself rather than only telling the user to run it, so you can read the printed code/URL and confirm the result right after.
|
|
34
|
+
|
|
35
|
+
Verify with `blocks auth status --json` — re-run after login rather than assuming it worked.
|
|
36
|
+
|
|
37
|
+
## Step 2 — Project
|
|
38
|
+
|
|
39
|
+
Ask **what the user wants to build** and whether they already have a project, rather than assuming:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
blocks projects list --json
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Always show the full list of accessible projects, and if one already appears selected, say which one — never silently continue on a prior session's selection. If projects exist, confirm which one (and which environment) the user wants; never guess.
|
|
46
|
+
|
|
47
|
+
**`projects create` is currently disabled in this CLI build** (commented out pending a product decision — there is no CLI path to create a new project). If none of the listed projects fit, tell the user a new project must be created from the Blocks portal first; once they confirm it exists, re-run `blocks projects list --json` and continue from here.
|
|
48
|
+
|
|
49
|
+
Then select it:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
blocks use <x-blocks-key>
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Project (impersonation) tokens are created lazily from the account session the first time a project-scoped command needs one — never ask the user for a project token directly. If an impersonated project token later gets stuck, rejected, or expired and `blocks auth refresh --project --json` doesn't fix it, recover with:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
blocks deselect # drops the selection and its cached impersonation token
|
|
59
|
+
blocks use <x-blocks-key> # reselect the same x-blocks-key to force a fresh impersonation
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Step 3 — Local workspace + hand off
|
|
63
|
+
|
|
64
|
+
Route to what the user actually wants. Do **not** run `blocks init` from a parent workspace before scaffolding a new app; it creates `blocks.json` and `blocks/` in the current directory. For a new frontend, scaffold first, `cd <appName>`, then run `blocks init` there only when the work needs project-local Blocks files such as data schemas or rules. For an existing app, run `blocks init` from that app's root. Safe to re-run: it never overwrites files that already exist. (`init` does not create a localization folder or any release-related file — `blocks/localization/` only appears later, lazily, the first time `blocks localization pull` writes to it, and there is no `blocks/release/*` file at all.)
|
|
65
|
+
|
|
66
|
+
- Building a frontend from scratch → resolve the app's public OIDC client first, then scaffold:
|
|
67
|
+
- `blocks auth oidc-clients list --json` — check whether a client already registered for this project fits. If none fits, create one directly (no portal visit needed): `blocks auth oidc-clients save --client-display-name <appName> --client-type public --redirect-uris https://<domain>:5173/login/callback --scope "openid profile" --require-pkce --register-as-identity-provider --auto-redirect --dry-run --json`, then re-run with `--yes` after showing the dry-run output and getting approval. `--client-type public` is required — IAM derives `tokenEndpointAuthMethod` from it, so omitting it stores a browser client as confidential. `--register-as-identity-provider` creates the linked identity provider in the same call; nothing further to run. `--auto-redirect` matters too — the scaffolded login page already navigates straight to the provider itself, so without it IAM's hosted login page shows a redundant manual "continue" click. When updating an *existing* client instead of creating one, always pass `--item-id` — the save endpoint replaces the whole client document, and the CLI fetches the current one first to merge your change into it rather than resetting the rest. See the blocks-iam-sso-oidc-configuration skill for the full decision tree and field-level gotchas.
|
|
68
|
+
- `blocks new web <name> --x-blocks-key <tenantId> --app-domain <domain> --client-id <the-resolved-client-id>`. **Always pass `--client-id` and `--app-domain` explicitly** — omitting either drops `new web` into an interactive pick-list prompt with no non-interactive escape (not even to "skip"), which hangs a scripted/agent run with no stdin to answer it. Omit `--blocks-api-url` unless the project uses a non-default gateway; the scaffold derives it from the app domain, e.g. `https://dqrsf.slsblx.com` -> `https://blocksapi.slsblx.com`. After scaffolding, `cd <name>` before installing packages, running `blocks init`, or adding local skill files so `blocks.json` and `blocks/` stay inside the app. Once it resolves the client id, `new web` also checks the tenant's AuthController config and turns on `isOidcEnabled` if it's off — nothing further to do for login to actually work; if you're wiring an existing app instead (`blocks sdk client`, no `new web` call), check that yourself first: `blocks auth config get --json`, and if `isOidcEnabled` is `false`, `blocks auth config save --oidc-enabled --dry-run --json` then `--yes`.
|
|
69
|
+
- Defining data / CRUD / localization / release on an existing project → hand off to the matching skill; the project is already selected via `blocks use`, so its commands can proceed directly.
|
|
70
|
+
|
|
71
|
+
## Gotchas
|
|
72
|
+
|
|
73
|
+
- **Only one OIDC client matters here, and it's not the CLI's.** The CLI authenticates itself with no setup — nothing to register, nothing portal-only about `blocks login` itself, and nothing about how it does so to look up or mention. The only OIDC client involved is the scaffolded app's *public* browser client for its own end-user login (Step 3) — and that no longer requires the portal either: `blocks auth oidc-clients list`/`save` resolve or create it entirely through the CLI on the project's impersonated token. The portal remains available if the user prefers it, but it's an alternative, not a requirement. Don't tell a user they need to register anything before `blocks login` will work, and don't send them to the portal for the app's OIDC client by default.
|
|
74
|
+
- **`blocks new web` hangs a non-interactive run if `--client-id` or `--app-domain` is omitted** — it drops into an interactive pick-list (even to offer "skip") with no stdin to answer it in an agent-driven session. Always resolve both explicitly first (Step 3) rather than omitting either and hoping for a graceful default.
|
|
75
|
+
- **Never open, read, print, or expose the CLI's local storage files** (its config/token/secret files on disk) or anything inside them — client ids, root tenant id, account names, tokens. Only ever interact with them through `blocks` commands, never by inspecting the files directly. `auth status`/`doctor` only ever report token state (`missing`/`valid`/`expired`), never the value.
|
|
76
|
+
- **Known CLI error codes and fixes** (from the CLI's own error handling): `not_logged_in` → `blocks login`; `refresh_token_rejected` → `blocks login`; unreadable/stale local auth storage → `blocks auth remove <account>` then `blocks login`; `project_not_selected` → `blocks use <x-blocks-key>` (or pass `--project <tenantId>` for a single one-off command); `api_auth_failed` → `blocks auth status --json` then log in again; `impersonation_invalid_client` → not a stale-token problem, the account's OIDC client isn't registered for impersonation — check `blocks auth config get` and have an admin register it, `login`/`deselect`+`use` won't fix this one.
|
|
77
|
+
- **`--dry-run` before `--yes`** on every mutating command (`auth oidc-clients save`, `data schema push`/`data rules deploy`, `localization push`, `release deploy`) — this recurs in every skill that mutates project state.
|