@mediamonks/canopy-cli 0.7.27 → 0.7.29

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.
Files changed (42) hide show
  1. package/dist/{db-DVMwCLlU.mjs → db-KTLn8J1u.mjs} +2 -2
  2. package/dist/{deploy-CTMcwHhI.mjs → deploy-CBf44bvG.mjs} +2 -2
  3. package/dist/dev-DGCu9MjB.mjs +2 -0
  4. package/dist/{dev-BvjbJcse.mjs → dev-JlzMZJow.mjs} +50 -21
  5. package/dist/{dev-worker-BerdPJ_U.mjs → dev-worker-DjJGSUGj.mjs} +1 -1
  6. package/dist/docs/cli-db.md +2 -0
  7. package/dist/docs/cli-index.md +1 -1
  8. package/dist/docs/getting-started.md +1 -1
  9. package/dist/docs/index.json +12 -2
  10. package/dist/docs/platform-egress.md +25 -0
  11. package/dist/docs/platform-members-and-access.md +13 -4
  12. package/dist/docs/platform-slack.md +6 -0
  13. package/dist/docs/sdk-notify.md +140 -0
  14. package/dist/docs/sdk-realtime.md +149 -0
  15. package/dist/docs/sdk-slack.md +3 -0
  16. package/dist/docs/sdk.md +5 -4
  17. package/dist/docs/static-serving.md +19 -0
  18. package/dist/{docs-CuS9nIXm.mjs → docs-ZQnhFSKT.mjs} +2 -2
  19. package/dist/{egress-Cn-P46O3.mjs → egress-Cn9zDfDT.mjs} +1 -1
  20. package/dist/{feedback-DormOsQa.mjs → feedback-CNfUjjNw.mjs} +2 -2
  21. package/dist/index.mjs +26 -26
  22. package/dist/{local-laAZEDVJ.mjs → local-BA_TPWpN.mjs} +56 -4
  23. package/dist/{login-C4MDP5NM.mjs → login-MX0xq8UE.mjs} +1 -1
  24. package/dist/{logs-CfDINw7U.mjs → logs-D5RWqsWl.mjs} +1 -1
  25. package/dist/{migrations-B9fXxMDj.mjs → migrations-C8yRPJIX.mjs} +1 -1
  26. package/dist/{open-rS1ARzOy.mjs → open-BJgd0R61.mjs} +1 -1
  27. package/dist/{package-CsmBH_fN.mjs → package-DzU_2IJi.mjs} +1 -1
  28. package/dist/{projects-Dmm_976k.mjs → projects-BG7Injpb.mjs} +1 -1
  29. package/dist/{schedule-Buu71RWQ.mjs → schedule-CLuksxSM.mjs} +1 -1
  30. package/dist/{secrets-BD3DaTih.mjs → secrets-Bl3uOx4l.mjs} +1 -1
  31. package/dist/skill/canopy/SKILL.md +1 -1
  32. package/dist/{skill-DX18WOap.mjs → skill-CQ4a__Ga.mjs} +2 -2
  33. package/dist/{src-CwSKZwNK.mjs → src-C7zPhbxi.mjs} +238 -1
  34. package/dist/{staging-CKEoDnac.mjs → staging-D06zobnf.mjs} +1 -1
  35. package/dist/templates/spa/.github/workflows/canopy-deploy.yml +3 -3
  36. package/dist/templates/worker/.github/workflows/canopy-deploy.yml +3 -3
  37. package/dist/{token-Dp2CoIYj.mjs → token-C_PFNqcv.mjs} +1 -1
  38. package/dist/{ui-DR-siu2S.mjs → ui-CeupNHNa.mjs} +4 -0
  39. package/dist/{upgrade-PfdH0NPe.mjs → upgrade-BzmIrnjs.mjs} +2 -2
  40. package/dist/{usage-81JSiWIx.mjs → usage-CV7TjTO8.mjs} +1 -1
  41. package/package.json +2 -2
  42. package/dist/dev-BOvMCaML.mjs +0 -2
@@ -1,6 +1,6 @@
1
1
  import { c as resolveProject, o as projectFlagArgs } from "./site-DM2J10CB.mjs";
2
- import { a as unwrap, d as withContext, i as requireTty, l as apiRequest, r as reportErrors, s as apiDataRequest } from "./ui-DR-siu2S.mjs";
3
- import { n as migrateProject, r as readMigrationFiles, t as describeMigrateResult } from "./migrations-B9fXxMDj.mjs";
2
+ import { a as unwrap, d as withContext, i as requireTty, l as apiRequest, r as reportErrors, s as apiDataRequest } from "./ui-CeupNHNa.mjs";
3
+ import { n as migrateProject, r as readMigrationFiles, t as describeMigrateResult } from "./migrations-C8yRPJIX.mjs";
4
4
  import { defineCommand } from "citty";
5
5
  import { readFileSync, writeFileSync } from "node:fs";
6
6
  import * as p from "@clack/prompts";
@@ -1,6 +1,6 @@
1
1
  import { a as projectDirArgs, c as resolveProject, l as stagingUrl, n as siteConfig, o as projectFlagArgs, s as projectUrl, u as tryReadCanopyJson } from "./site-DM2J10CB.mjs";
2
- import { a as unwrap, c as apiDownload, d as withContext, l as apiRequest, r as reportErrors, s as apiDataRequest, t as formatDateTime } from "./ui-DR-siu2S.mjs";
3
- import { n as migrateProject, r as readMigrationFiles, t as describeMigrateResult } from "./migrations-B9fXxMDj.mjs";
2
+ import { a as unwrap, c as apiDownload, d as withContext, l as apiRequest, r as reportErrors, s as apiDataRequest, t as formatDateTime } from "./ui-CeupNHNa.mjs";
3
+ import { n as migrateProject, r as readMigrationFiles, t as describeMigrateResult } from "./migrations-C8yRPJIX.mjs";
4
4
  import { defineCommand } from "citty";
5
5
  import { mkdtempSync, readFileSync, readdirSync, rmSync, statSync, writeFileSync } from "node:fs";
6
6
  import { tmpdir } from "node:os";
@@ -0,0 +1,2 @@
1
+ import { n as devCommand } from "./dev-JlzMZJow.mjs";
2
+ export { devCommand };
@@ -1,7 +1,7 @@
1
1
  import { a as projectDirArgs, c as resolveProject, i as projectDialect, n as siteConfig, u as tryReadCanopyJson } from "./site-DM2J10CB.mjs";
2
- import { d as withContext, l as apiRequest, o as ApiError, r as reportErrors, t as formatDateTime } from "./ui-DR-siu2S.mjs";
3
- import { r as readMigrationFiles } from "./migrations-B9fXxMDj.mjs";
4
- import { n as stampWorkerHeaders } from "./src-CwSKZwNK.mjs";
2
+ import { d as withContext, l as apiRequest, o as ApiError, r as reportErrors, t as formatDateTime } from "./ui-CeupNHNa.mjs";
3
+ import { r as readMigrationFiles } from "./migrations-C8yRPJIX.mjs";
4
+ import { n as stampWorkerHeaders } from "./src-C7zPhbxi.mjs";
5
5
  import { createRequire } from "node:module";
6
6
  import { defineCommand } from "citty";
7
7
  import { existsSync } from "node:fs";
@@ -38,7 +38,7 @@ async function workerPlugin(flags, slug) {
38
38
  console.log(`note: canopy.json points "worker" at ${entry}, which does not exist — skipping.`);
39
39
  return;
40
40
  }
41
- const { missingSecretNames, readDevVars, workerDevPlugin } = await import("./dev-worker-BerdPJ_U.mjs");
41
+ const { missingSecretNames, readDevVars, workerDevPlugin } = await import("./dev-worker-DjJGSUGj.mjs");
42
42
  const secrets = readDevVars(flags.dir);
43
43
  const email = siteConfig().email;
44
44
  const plugin = workerDevPlugin({
@@ -146,6 +146,48 @@ function devProxyHeaders(token, slug, channel) {
146
146
  });
147
147
  return Object.fromEntries(headers);
148
148
  }
149
+ /**
150
+ * One request from Vite's /_api proxy into the --local sandbox. The response
151
+ * body is streamed, not buffered — realtime subscriptions (docs/48) are
152
+ * long-lived SSE responses — and a client that goes away aborts the sandbox
153
+ * request and cancels its body, so the subscription is released.
154
+ */
155
+ async function bridgeToSandbox(sandbox, req, res) {
156
+ const gone = new AbortController();
157
+ res.on("close", () => gone.abort());
158
+ const chunks = [];
159
+ for await (const chunk of req) chunks.push(chunk);
160
+ const body = Buffer.concat(chunks);
161
+ const headers = new Headers();
162
+ if (req.headers["content-type"]) headers.set("content-type", req.headers["content-type"]);
163
+ if (req.headers["accept"]) headers.set("accept", req.headers["accept"]);
164
+ const response = await sandbox.handle(new Request(`http://canopy.local${req.url ?? ""}`, {
165
+ method: req.method,
166
+ headers,
167
+ body: body.length === 0 ? void 0 : new Uint8Array(body),
168
+ signal: gone.signal
169
+ }));
170
+ if (gone.signal.aborted) {
171
+ await response.body?.cancel().catch(() => {});
172
+ return;
173
+ }
174
+ res.writeHead(response.status, Object.fromEntries(response.headers));
175
+ if (!response.body) {
176
+ res.end();
177
+ return;
178
+ }
179
+ const reader = response.body.getReader();
180
+ gone.signal.addEventListener("abort", () => void reader.cancel().catch(() => {}), { once: true });
181
+ try {
182
+ for (;;) {
183
+ const { done, value } = await reader.read();
184
+ if (done) break;
185
+ res.write(value);
186
+ }
187
+ } catch {} finally {
188
+ res.end();
189
+ }
190
+ }
149
191
  async function devRemote(flags, slug) {
150
192
  const { token, expires_at } = await withContext(apiRequest("POST", `/projects/${slug}/dev-token`), devTokenContext(slug));
151
193
  const { apiUrl } = siteConfig();
@@ -176,7 +218,7 @@ async function devRemote(flags, slug) {
176
218
  async function devLocal(flags, slug) {
177
219
  let dump;
178
220
  if (flags.pull) {
179
- const { fetchProjectDump } = await import("./local-laAZEDVJ.mjs");
221
+ const { fetchProjectDump } = await import("./local-BA_TPWpN.mjs");
180
222
  console.log(`Pulling a fresh export of ${slug}${flags.staging ? " [staging]" : ""}…`);
181
223
  dump = await fetchProjectDump(slug, flags.staging ? "staging" : "live");
182
224
  }
@@ -191,7 +233,7 @@ async function devLocal(flags, slug) {
191
233
  const reason = err instanceof ApiError ? err.explain().why : String(err);
192
234
  console.log(`Note: ai/services will be unavailable — could not reach the platform (${reason}).`);
193
235
  }
194
- const { createSandbox } = await import("./local-laAZEDVJ.mjs");
236
+ const { createSandbox } = await import("./local-BA_TPWpN.mjs");
195
237
  const sandbox = await createSandbox({
196
238
  slug,
197
239
  persistDir: join(flags.dir, ".canopy", "local"),
@@ -207,20 +249,7 @@ async function devLocal(flags, slug) {
207
249
  const { applied } = await sandbox.applyMigrations(migrationFiles);
208
250
  if (applied.length > 0) console.log(`Applied ${applied.length} pending migration(s): ${applied.join(", ")}`);
209
251
  }
210
- const handleApi = async (req, res) => {
211
- const chunks = [];
212
- for await (const chunk of req) chunks.push(chunk);
213
- const body = Buffer.concat(chunks);
214
- const headers = new Headers();
215
- if (req.headers["content-type"]) headers.set("content-type", req.headers["content-type"]);
216
- const response = await sandbox.handle(new Request(`http://canopy.local${req.url ?? ""}`, {
217
- method: req.method,
218
- headers,
219
- body: body.length === 0 ? void 0 : new Uint8Array(body)
220
- }));
221
- res.writeHead(response.status, Object.fromEntries(response.headers));
222
- res.end(Buffer.from(await response.arrayBuffer()));
223
- };
252
+ const handleApi = (req, res) => bridgeToSandbox(sandbox, req, res);
224
253
  const { createServer: createHttpServer } = await import("node:http");
225
254
  const apiServer = createHttpServer((req, res) => {
226
255
  handleApi(req, res).catch((err) => {
@@ -312,4 +341,4 @@ const devCommand = defineCommand({
312
341
  })
313
342
  });
314
343
  //#endregion
315
- export { devProxyHeaders as n, rewriteApiPath as r, devCommand as t };
344
+ export { rewriteApiPath as i, devCommand as n, devProxyHeaders as r, bridgeToSandbox as t };
@@ -1,4 +1,4 @@
1
- import { n as stampWorkerHeaders, t as redactCanopyCredentials } from "./src-CwSKZwNK.mjs";
1
+ import { n as stampWorkerHeaders, t as redactCanopyCredentials } from "./src-C7zPhbxi.mjs";
2
2
  import { readFileSync } from "node:fs";
3
3
  import { relative, resolve, sep } from "node:path";
4
4
  //#region src/dev-worker.ts
@@ -53,6 +53,8 @@ Behavior:
53
53
  2. Unless `--yes` is passed, it asks you to **type the project slug** to confirm — a deliberate speed bump, since restore is destructive. A non-TTY without `--yes` errors instead of guessing.
54
54
  3. The chosen snapshot or file replaces the entire database, and the CLI confirms `Restored <slug>.`
55
55
 
56
+ A dump only restores into a database of the same kind. Feeding a dump from a SQLite-based project to a Postgres-based one (or the other way round) is refused up front with `dump_dialect_mismatch`, before anything is wiped. Check with `canopy db pull` on both sides: a SQLite dump opens with a `PRAGMA` line, a Postgres dump with a `-- Canopy project dump (postgres)` banner. For a project that uses **document collections only**, the collection table has the same layout everywhere, so deleting that leading `PRAGMA` line makes a SQLite dump restore on Postgres. Custom tables need their column types adapted by hand.
57
+
56
58
  ### canopy db migrate
57
59
 
58
60
  Applies pending schema migrations to the project's **live** database, without deploying. Requires a `"migrations"` directory in `canopy.json` (for example your `drizzle-kit generate` output — see the [migrations guide](https://docs.canopy.website/guides/migrations)).
@@ -7,7 +7,7 @@ Everything on Canopy is driven by one command-line tool: `canopy`. It scaffolds
7
7
 
8
8
  ## Install
9
9
 
10
- The CLI is published on npm as `@mediamonks/canopy-cli`. You need Node.js 20 or newer; then install it globally:
10
+ The CLI is published on npm as `@mediamonks/canopy-cli`. You need Node.js 24 or newer; then install it globally:
11
11
 
12
12
  ```bash
13
13
  npm install -g @mediamonks/canopy-cli
@@ -24,7 +24,7 @@ Confirm it's on your PATH:
24
24
  canopy --version
25
25
  ```
26
26
 
27
- If `npm` isn't available, install Node.js 20+ first (https://nodejs.org), then
27
+ If `npm` isn't available, install Node.js 24+ first (https://nodejs.org), then
28
28
  re-run the install.
29
29
 
30
30
  ## 2. Sign in
@@ -306,12 +306,12 @@
306
306
  {
307
307
  "key": "sdk",
308
308
  "title": "SDK reference",
309
- "description": "The typed client your project code uses — auth, data, files, AI, services.",
309
+ "description": "The typed client your project code uses — auth, data, files, AI, email, notify, realtime, services.",
310
310
  "topics": [
311
311
  {
312
312
  "slug": "sdk",
313
313
  "title": "Using the SDK",
314
- "summary": "One typed client for auth, data, files, AI, email, and services — no keys, no connection strings, the platform authenticates for you."
314
+ "summary": "One typed client for auth, data, files, AI, email, notify, realtime, and services — no keys, no connection strings, the platform authenticates for you."
315
315
  },
316
316
  {
317
317
  "slug": "sdk-auth",
@@ -338,6 +338,16 @@
338
338
  "title": "Email",
339
339
  "summary": "Send email from your project without a mail server or an API key — Monks recipients only, with a per-project daily quota and a sent log."
340
340
  },
341
+ {
342
+ "slug": "sdk-notify",
343
+ "title": "Notify",
344
+ "summary": "Post a Slack message from your project through the Canopy bot — to your linked channels or a colleague's DMs — with nothing to set up."
345
+ },
346
+ {
347
+ "slug": "sdk-realtime",
348
+ "title": "Realtime",
349
+ "summary": "Live updates between the people using your app — subscribe to a topic, publish to it, no backend needed."
350
+ },
341
351
  {
342
352
  "slug": "sdk-google",
343
353
  "title": "Google",
@@ -112,6 +112,31 @@ Switching back is one command (`canopy egress mode allowlist`), and the
112
112
  dashboard offers to **seed the allowlist from the observed hosts** so
113
113
  tightening up later doesn't break the app.
114
114
 
115
+ ## Allowlisting Canopy on the other side
116
+
117
+ Some external services only accept calls from IP addresses you register with
118
+ them first — a partner API, a corporate database, a payment provider's
119
+ allowlist. Projects hosted on **Google Cloud** (the `gcp-pilot` site,
120
+ `canopy.monks.zone`) make every outbound request from a fixed pair of
121
+ addresses, so you can hand them over:
122
+
123
+ | Address |
124
+ | ---------------- |
125
+ | `34.187.107.103` |
126
+ | `34.158.168.43` |
127
+
128
+ Register **both**. Traffic may leave from either one, and the second gives the
129
+ platform room to grow without asking you to update your allowlist. These
130
+ addresses are shared by every project on that site, so registering them lets
131
+ any Canopy project on Google Cloud reach the service — the other service's own
132
+ authentication (API keys, tokens) still decides who gets in.
133
+
134
+ The addresses are a platform commitment: they will not change without notice
135
+ and a migration period. Projects hosted on Cloudflare have **no** fixed
136
+ outbound address (requests leave from Cloudflare's shared edge), so if a
137
+ service you depend on insists on IP allowlisting, run that project on the
138
+ Google Cloud site.
139
+
115
140
  ## The outbound traffic log
116
141
 
117
142
  In both modes, the platform keeps a per-project log of the hosts the worker
@@ -35,10 +35,19 @@ nobody outside the team can touch its data or settings.
35
35
 
36
36
  ## Inviting collaborators
37
37
 
38
- Open the project's **Settings** tab and use the **Collaborators** card. A
39
- searchable people picker finds anyone who has signed in to Canopy; adding
40
- them takes effect immediately. Owners (and admins) can also remove people
41
- from the same card.
38
+ Open the project's **Settings** tab and use the **Collaborators** card. Start
39
+ typing a name or email: colleagues who have signed in to Canopy before show up
40
+ as suggestions, and picking one adds them immediately.
41
+
42
+ Someone who has never opened Canopy can be added too — type their full
43
+ company email and choose **Invite by email**. They appear on the roster as
44
+ **invited** and become a collaborator automatically the first time they sign
45
+ in, whether that's opening the project's URL or running `canopy login`. Until
46
+ then the invite grants nothing. You can withdraw a pending invite from the
47
+ same card. Canopy doesn't send them a message, so let them know yourself.
48
+
49
+ Only company addresses that can sign in to Canopy can be invited. Owners (and
50
+ admins) can also remove people from the same card.
42
51
 
43
52
  ## Collaborators-only mode
44
53
 
@@ -3,6 +3,12 @@ title: Slack
3
3
  description: Give your project its own Slack bot — Canopy creates and manages the app, your code handles the events.
4
4
  ---
5
5
 
6
+ > **A bot, or just a message?** If all your project needs is to post to a
7
+ > channel or DM a colleague, skip this page: `canopy.notify.slack` does that
8
+ > through the Canopy bot with nothing to set up. Read
9
+ > [Notify](https://docs.canopy.website/sdk/notify). Come back here when people need to talk to your
10
+ > bot, run slash commands, or see your project's own name and icon.
11
+
6
12
  Your project can have its own Slack app: its own name and bot, in whatever
7
13
  workspace you choose. Canopy creates the app, keeps its settings in sync,
8
14
  holds every credential, and routes Slack's traffic to your backend. Your
@@ -0,0 +1,140 @@
1
+ ---
2
+ title: Notify
3
+ description: Post a Slack message from your project through the Canopy bot — to your linked channels or a colleague's DMs — with nothing to set up.
4
+ ---
5
+
6
+ `canopy.notify` tells people things on your project's behalf. The Canopy bot,
7
+ the one that already DMs you about reports and deploys, delivers the message
8
+ and says which project sent it. There is no Slack app to create, no token, no
9
+ install: it works the moment your project has something to say.
10
+
11
+ Two rules are enforced by the platform, not by your code:
12
+
13
+ - **You reach people your project has a relationship with.** Channels are the
14
+ ones a project member linked with `/canopy link`; people are Canopy users,
15
+ named by the email they sign in with. Nothing else is addressable.
16
+ - **A daily quota per project**, 200 deliveries by default. Each person and
17
+ each channel a message goes to counts as one.
18
+
19
+ ## notify.slack(options)
20
+
21
+ Resolves once the platform has queued the message:
22
+
23
+ ```ts
24
+ // Every channel linked to the project.
25
+ await canopy.notify.slack({ text: "Export finished: *1,204* rows." });
26
+
27
+ // A colleague, and nobody else.
28
+ await canopy.notify.slack({
29
+ to: "someone@monks.com",
30
+ text: "Your approval is needed on <https://…|request #42>.",
31
+ });
32
+
33
+ // People and the linked channels together.
34
+ await canopy.notify.slack({ to: ["a@monks.com", "b@monks.com"], channels: true, text: "…" });
35
+ ```
36
+
37
+ **`NotifySlackOptions`:**
38
+
39
+ - `text` — required, up to 2000 characters of Slack mrkdwn. Bold, links and
40
+ `<@U…>` mentions work.
41
+ - `to` — optional. One email or an array of up to 20, each the address a
42
+ Canopy user signs in with. Leave it out to post to the linked channels
43
+ instead.
44
+ - `channels` — optional. With `to`, also post to the linked channels. Without
45
+ `to` it is always on.
46
+
47
+ **Returns** `{ queued }`, the number of deliveries queued: people plus
48
+ channels. Delivery happens right after, with retries if Slack is slow; the
49
+ outcome shows on the project's Usage tab.
50
+
51
+ ## What the message looks like
52
+
53
+ Every message opens with a line the platform writes: your project's name,
54
+ linked to its dashboard page, and "sent by this project via Canopy". Your
55
+ text follows as a new top-level message. Nothing threads onto earlier
56
+ messages, and there are no buttons or blocks: this is a notification, not a
57
+ conversation.
58
+
59
+ If someone replies under it, the Canopy assistant answers that the message
60
+ came from your project and that replies don't reach it. If you want replies
61
+ to reach your code, you want [a bot of your own](https://docs.canopy.website/platform/slack).
62
+
63
+ ## Who receives it
64
+
65
+ Channels get every message. People are protected the same way platform
66
+ notifications protect them: a colleague who muted your project hears
67
+ nothing, and anyone can turn off "Messages from projects" in their
68
+ notification settings. Someone whose email has no Slack account is skipped.
69
+ None of this is reported back to your code, so `queued` counts what was
70
+ sent, not what arrived.
71
+
72
+ An email that is not a Canopy user is refused outright, so you notice the
73
+ typo. Everyone at Monks becomes a Canopy user by opening the dashboard once.
74
+
75
+ ## Linking a channel
76
+
77
+ Type `/canopy link <your-project-slug>` in the channel, then invite `@Canopy`
78
+ to it. The channel now receives the project's messages, and its activity
79
+ too: reports, project events, deploys. Linked channels are listed under the
80
+ project's **Services → Slack**, where any member can unlink one.
81
+
82
+ Until a channel is linked, a send without `to` fails with a 404 rather than
83
+ disappearing silently.
84
+
85
+ ## Sending from the backend
86
+
87
+ Like email, this is meant for code that runs with nobody signed in: a
88
+ [scheduled](https://docs.canopy.website/platform/schedules) job, a worker route reacting to a webhook.
89
+ It authenticates as the project itself. Browser code cannot call it.
90
+
91
+ ```ts
92
+ export default {
93
+ async scheduled(event, env) {
94
+ const canopy = createCanopy({ fetch: env.CANOPY.fetch.bind(env.CANOPY) });
95
+ const stale = await staleRequests(env.DB);
96
+ if (stale.length === 0) return;
97
+
98
+ await canopy.notify.slack({
99
+ text: `${stale.length} approval request${stale.length === 1 ? "" : "s"} waiting longer than a week.`,
100
+ });
101
+ },
102
+ };
103
+ ```
104
+
105
+ ## Seeing what was sent
106
+
107
+ The project's **Usage** tab shows today's count against the quota and the
108
+ recent sends: when, to whom, the first line, and whether it was delivered.
109
+ Only that first line is kept.
110
+
111
+ ## When it fails
112
+
113
+ Every failure is a `CanopyError` with a status you can branch on:
114
+
115
+ - **400** — the text is empty or too long, `to` has more than 20 entries, or
116
+ an address is not a Canopy user (`unknown_recipient`, naming it).
117
+ - **404** — no `to` and no linked channel (`no_linked_channel`).
118
+ - **429** — the project used its daily quota, or the platform-wide ceiling is
119
+ reached. Both reset at UTC midnight.
120
+ - **501** — this Canopy site has no Canopy bot.
121
+
122
+ ```ts
123
+ import { CanopyError } from "@mediamonks/canopy";
124
+
125
+ try {
126
+ await canopy.notify.slack({ text });
127
+ } catch (err) {
128
+ if (err instanceof CanopyError && err.status === 404) {
129
+ // Nobody has linked a channel yet — tell a member to run /canopy link.
130
+ }
131
+ }
132
+ ```
133
+
134
+ ## What this is not
135
+
136
+ This is not a bot. It cannot listen, answer, show buttons, run slash
137
+ commands, post in a client's workspace or carry your project's name and
138
+ icon. The moment you want any of that, give the project [its own Slack
139
+ app](https://docs.canopy.website/platform/slack): a few minutes of setup, and `canopy.slack` does the
140
+ rest.
@@ -0,0 +1,149 @@
1
+ ---
2
+ title: Realtime
3
+ description: Live updates between the people using your app — subscribe to a topic, publish to it, no backend needed.
4
+ ---
5
+
6
+ `canopy.realtime` sends small messages to everyone who has your app open,
7
+ the moment something happens. A teammate adds a card and everyone's board
8
+ refreshes; someone starts editing and the others see a "being edited" badge.
9
+ It works from the browser alone, with nothing to set up.
10
+
11
+ ## Messages are hints, not a log
12
+
13
+ Nothing is stored. A message reaches the pages that are connected when it's
14
+ sent, and nobody else. A laptop that went to sleep, a tab that was in the
15
+ background, a page that reconnected: each of them missed whatever was sent
16
+ meanwhile.
17
+
18
+ So build it like this: keep your data in [`canopy.db`](https://docs.canopy.website/sdk/database),
19
+ send a message to say _what changed_, and reload from the database whenever
20
+ the connection opens.
21
+
22
+ ```ts
23
+ const off = canopy.realtime.subscribe(
24
+ "board",
25
+ (message) => refreshCard(message.data.cardId),
26
+ { onOpen: () => reloadBoard() }, // first connect and every reconnect
27
+ );
28
+
29
+ // …somewhere else, after saving the change:
30
+ await canopy.db.collection("cards").update(card.id, { column: "done" });
31
+ await canopy.realtime.publish("board", { cardId: card.id });
32
+
33
+ off(); // stop listening
34
+ ```
35
+
36
+ ## realtime.subscribe(topic, onMessage, options?)
37
+
38
+ Starts listening to `topic` and returns a function that stops. Every
39
+ subscription on a page shares one connection, so subscribe to as many topics
40
+ as you need (up to 20 per page).
41
+
42
+ - `onMessage(message)` runs for each message on the topic, including the ones
43
+ this page published itself. Ignore your own by comparing `message.id` with
44
+ what `publish` returned.
45
+ - `onOpen()` runs whenever the connection opens: the first time, and after
46
+ every reconnect. Reload what you show from the database here.
47
+ - `onError(error)` reports connection problems. `error.code` says which. The
48
+ SDK keeps retrying on its own unless retrying can't help (see
49
+ [When it's off](#when-its-off)).
50
+
51
+ A message looks like this:
52
+
53
+ ```ts
54
+ {
55
+ id: "0muz…", // the id publish() returned to the sender
56
+ topic: "board",
57
+ data: { cardId: "c-7" }, // whatever was published
58
+ from: { kind: "monk", email: "ada@monks.com" },
59
+ ts: "2026-10-08T12:00:00.000Z",
60
+ }
61
+ ```
62
+
63
+ `from` is filled in by Canopy, never by the sender, so you can trust it:
64
+ `monk` (with their sign-in email), `external` for a visitor who came in with
65
+ the [client password](https://docs.canopy.website/platform/client-access), or `worker` for your
66
+ project's backend. Client visitors never see a monk's email; for them the
67
+ sender is just `monk`.
68
+
69
+ ## realtime.publish(topic, data)
70
+
71
+ Sends `data` (any JSON value, up to 4 KB) to everyone subscribed to `topic`,
72
+ and resolves with `{ id }`. Send an id and let pages load the rest from the
73
+ database; a message over 4 KB is refused with `message_too_large`.
74
+
75
+ Topic names are 1 to 64 letters, digits, `-`, `_` or `.`. They belong to your
76
+ project only: another project's `board` is a different topic, and so is your
77
+ own staging site's.
78
+
79
+ ## Topics only your backend can publish to
80
+
81
+ Topics that start with `worker:` take messages from your project's backend
82
+ only. Pages can listen to them, but anything else that tries to publish gets
83
+ `topic_worker_only`: a page, the dashboard, or a personal token like the one
84
+ `canopy dev` uses. Use them for news that has to come from the server: a
85
+ job finished, a payment cleared, an import is done.
86
+
87
+ ```ts
88
+ // In your worker (worker/index.ts):
89
+ const canopy = createCanopy({ fetch: c.env.CANOPY.fetch.bind(c.env.CANOPY) });
90
+ await canopy.realtime.publish("worker:imports", { importId, status: "done" });
91
+ ```
92
+
93
+ Messages from the backend arrive with `from.kind: "worker"`, also when the
94
+ backend is handling a signed-in visitor's request. A scheduled job can
95
+ publish too.
96
+
97
+ ## Limits
98
+
99
+ - **4 KB** of data per message.
100
+ - **20 topics** per page.
101
+ - **100 open connections** per project at a time, and **10 per person**. One
102
+ more gets `too_many_subscribers` through `onError` and keeps retrying until
103
+ a connection closes.
104
+ - **A daily quota** per project: 100,000 messages by default, and a share of
105
+ data delivered (big messages to many people use it up faster). When either
106
+ is used up, `publish` is refused with `realtime_quota_exceeded` until
107
+ midnight UTC; subscriptions stay open. The Usage tab shows today's count. A
108
+ Canopy admin can raise the message quota if you need more.
109
+ - If many projects are busy at once, the whole site can reach its own daily
110
+ limit. Publishes then fail with `realtime_platform_limit`; that one isn't
111
+ about your project.
112
+
113
+ For cursors or presence, throttle updates to at most a few per second per
114
+ person. That's smooth to look at and keeps you well inside the quota.
115
+
116
+ ## Background tabs
117
+
118
+ A tab that has been in the background for two minutes stops receiving
119
+ messages and lets its connection go. When you switch back, it reconnects
120
+ right away and `onOpen` runs, so the page catches up from the database. A
121
+ quick switch away and back keeps the connection.
122
+
123
+ Every connection also renews itself about every quarter of an hour, and
124
+ whenever access to the project changes (the client password, collaborators
125
+ only, someone removed). Each renewal runs `onOpen` again, which is what
126
+ keeps the reload-on-open pattern correct.
127
+
128
+ ## When it's off
129
+
130
+ Realtime is a per-project setting that Canopy admins manage. If it's off for
131
+ your project, `subscribe` reports `realtime_not_enabled` through `onError`
132
+ once and `publish` is refused with the same code. Ask a Canopy admin to turn
133
+ it on. The Usage tab shows whether it's on.
134
+
135
+ Some Canopy sites don't run realtime at all; there the error is
136
+ `not_supported_on_target`. In both cases the SDK doesn't keep retrying.
137
+
138
+ ## Topics are not secrets
139
+
140
+ Anyone who can open your app can subscribe to any of its topics. Don't put
141
+ anything in a message that the people using the app shouldn't see, and don't
142
+ treat a hard-to-guess topic name as a password.
143
+
144
+ ## In local development
145
+
146
+ `canopy dev` connects to the real topics of your live project, so a local tab
147
+ and the deployed site see each other's messages. `canopy dev --local` keeps
148
+ everything on your laptop: open two tabs and they talk to each other, with no
149
+ quota and no `worker:` rule (like the local database, nothing is guarded).
@@ -3,6 +3,9 @@ title: Slack
3
3
  description: Handle your bot's events and slash commands in your worker, and post to Slack as the bot — no tokens in project code.
4
4
  ---
5
5
 
6
+ > Only want to post a message? [`canopy.notify.slack`](https://docs.canopy.website/sdk/notify) does it
7
+ > through the Canopy bot, no app needed. This page is for a bot of your own.
8
+
6
9
  Once your project has a Slack app ([set up on the Services
7
10
  tab](https://docs.canopy.website/platform/slack)), the integration is two halves: inbound events arrive
8
11
  at a `slack()` export in your worker, and outbound calls go through
package/dist/docs/sdk.md CHANGED
@@ -1,11 +1,11 @@
1
1
  ---
2
2
  title: Using the SDK
3
- description: One typed client for auth, data, files, AI, email, and services — no keys, no connection strings, the platform authenticates for you.
3
+ description: One typed client for auth, data, files, AI, email, notify, realtime, and services — no keys, no connection strings, the platform authenticates for you.
4
4
  ---
5
5
 
6
6
  `@mediamonks/canopy` is a thin, typed client over the platform's project API.
7
- One `createCanopy()` call gives you seven modules — `auth`, `db`, `blob`, `ai`,
8
- `email`, `google`, and `services` — and that is the entire surface. There are no API keys,
7
+ One `createCanopy()` call gives you its modules — `auth`, `db`, `blob`, `ai`,
8
+ `email`, `notify`, `realtime`, `google`, `slack`, and `services` — and that is the entire surface. There are no API keys,
9
9
  connection strings, or environment variables to manage: every call rides the
10
10
  session the platform already established before your code ran.
11
11
 
@@ -35,7 +35,8 @@ import { createCanopy } from "/_api/data/v1/sdk.js";
35
35
  import { createCanopy } from "@mediamonks/canopy";
36
36
 
37
37
  const canopy = createCanopy();
38
- // canopy.auth, canopy.db, canopy.blob, canopy.ai, canopy.email, canopy.google, canopy.services
38
+ // canopy.auth, canopy.db, canopy.blob, canopy.ai, canopy.email, canopy.notify,
39
+ // canopy.realtime, canopy.google, canopy.slack, canopy.services
39
40
  ```
40
41
 
41
42
  | Option | Type | Default | What it does |
@@ -77,5 +77,24 @@ belong in [file storage](https://docs.canopy.website/sdk/files) instead of the b
77
77
  reachable, deploy it, or put it in [file storage](https://docs.canopy.website/sdk/files) and hand out a
78
78
  signed link.
79
79
 
80
+ ## Moving a project to a new address
81
+
82
+ When a project lives somewhere else now — it was rebuilt under another name,
83
+ or it graduated to its own domain — you can point the old address at the new
84
+ one. On the project's **Settings** page, the **Move project** card takes an
85
+ `https://` URL. From then on every request to the old address, including deep
86
+ links with their path and query, lands on the new URL.
87
+
88
+ A few things to know:
89
+
90
+ - **Visitors still sign in on the old address first.** The redirect happens
91
+ behind the same sign-in wall as everything else, so a colleague signs in once
92
+ and is sent on; a client-password visitor types the old password once.
93
+ - **The old project goes quiet.** Deploys are refused, the backend and
94
+ schedules stop. Its database and files stay put, and `canopy db pull` still
95
+ works, so you can take the data with you after the move.
96
+ - **It's reversible.** Undo the move on the same card and the last deployed
97
+ build is served again right away.
98
+
80
99
  Porting an app that assumed a server? [Porting a Next.js app](https://docs.canopy.website/guides/porting-nextjs)
81
100
  walks through the restructure.
@@ -1,7 +1,7 @@
1
- import { t as version } from "./package-CsmBH_fN.mjs";
1
+ import { t as version } from "./package-DzU_2IJi.mjs";
2
2
  import { n as siteConfig } from "./site-DM2J10CB.mjs";
3
3
  import { i as latestKnownVersion, r as compareSemver } from "./version-check-CcsA1QjI.mjs";
4
- import { r as reportErrors } from "./ui-DR-siu2S.mjs";
4
+ import { r as reportErrors } from "./ui-CeupNHNa.mjs";
5
5
  import { defineCommand } from "citty";
6
6
  import { existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from "node:fs";
7
7
  import { homedir } from "node:os";
@@ -1,5 +1,5 @@
1
1
  import { a as projectDirArgs, c as resolveProject } from "./site-DM2J10CB.mjs";
2
- import { a as unwrap, d as withContext, i as requireTty, l as apiRequest, r as reportErrors, t as formatDateTime } from "./ui-DR-siu2S.mjs";
2
+ import { a as unwrap, d as withContext, i as requireTty, l as apiRequest, r as reportErrors, t as formatDateTime } from "./ui-CeupNHNa.mjs";
3
3
  import { defineCommand } from "citty";
4
4
  import * as p from "@clack/prompts";
5
5
  //#region src/egress.ts