@brickkit/cli 0.16.0-beta.1 → 0.16.0-beta.2

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 (33) hide show
  1. package/README.md +13 -8
  2. package/dashboard-dist/{api-reference-C2_JX174.js → api-reference-FojtkYBA.js} +4 -4
  3. package/dashboard-dist/app.js +10 -10
  4. package/dashboard-dist/{client-DsITZplk.js → client-Cnm0Im6o.js} +1 -1
  5. package/dashboard-dist/{core-sW89OSz5.js → core-SiSejpN2.js} +1 -1
  6. package/dashboard-dist/{docs-D3U7gUWq.js → docs-D1HrRL0z.js} +2 -2
  7. package/dashboard-dist/kit.js +1 -1
  8. package/dashboard-dist/{popover-Bb2Q3jiK.js → popover-Da7zBKDq.js} +1 -1
  9. package/dist/bin.js +1 -1
  10. package/dist/dashboard-host.js +17 -8
  11. package/dist/dashboard-host.js.map +1 -1
  12. package/dist/dashboard-protocol.js +6 -6
  13. package/dist/dashboard-protocol.js.map +1 -1
  14. package/dist/dev-inspector.js +111 -0
  15. package/dist/dev-inspector.js.map +1 -0
  16. package/dist/dev-worker.js +1 -102
  17. package/dist/dev-worker.js.map +1 -1
  18. package/dist/production-dashboard.js +26 -2
  19. package/dist/production-dashboard.js.map +1 -1
  20. package/dist/production-dashboard2.d.ts +5 -0
  21. package/dist/project.js +1 -1
  22. package/dist/vite.js +1 -1
  23. package/inspector-dist/NOTICE +3 -1
  24. package/inspector-dist/server/assets/{app-w0nTXgJd.js → app-DUrMEdTr.js} +49 -11
  25. package/inspector-dist/server/assets/{functions-B9XwHSzK.js → functions-CvYRS9L5.js} +2 -2
  26. package/inspector-dist/server/assets/{serialization-DsMds3lJ.js → serialization-BMjuH1Dy.js} +1 -1
  27. package/inspector-dist/server/assets/{token-CvvD8Y5H.js → token-B03I2FMb.js} +1 -1
  28. package/inspector-dist/server/assets/{token-CxjWFNNq.js → token-CXQG49kq.js} +1 -1
  29. package/inspector-dist/server/assets/token-util-DQqrmFHy.js +3 -0
  30. package/inspector-dist/server/assets/{ws-transport-CamzQ5O8.js → ws-transport-CMidAEKi.js} +1 -1
  31. package/inspector-dist/server/index.js +1 -1
  32. package/package.json +2 -2
  33. package/inspector-dist/server/assets/token-util-D9IsWeEs.js +0 -3
package/README.md CHANGED
@@ -200,10 +200,12 @@ export default brick({
200
200
 
201
201
  It listens on a port of its own, so it can be kept private or mounted at another
202
202
  address, and it answers while the app's routes do not. It shows Requests, Logs,
203
- Errors, Overview, and Reloads; there is no restart, API proxy, APIs, Docs, or Workflows, and
204
- OpenAPI documents are not served. Setting it turns `telemetry` on, and from then
205
- `ctx.logger` and `console` lines written during a request go to the dashboard
206
- and not to the container's console.
203
+ Errors, Overview, and Reloads; there is no restart, API proxy, APIs, or Docs, and
204
+ OpenAPI documents are not served. `dashboard: { inspector: true }` adds
205
+ Schedules and Workflows, where only a signed-in user can change anything.
206
+ Setting it turns `telemetry` on, and from then `ctx.logger` and `console`
207
+ lines written during a request go to the dashboard and not to the container's
208
+ console.
207
209
 
208
210
  Beyond loopback, access control is required, and `brick start` will not run the
209
211
  dashboard without it. `auth.token` is a secret (or several, to rotate), at least
@@ -211,13 +213,16 @@ dashboard without it. `auth.token` is a secret (or several, to rotate), at least
211
213
  secret as the password), and monitors send `Authorization: Bearer <secret>`.
212
214
  `auth.authorize(request)` is your own check, for the auth the app already has
213
215
  (Better Auth, Clerk, a header from a proxy): it gets a standard `Request` without
214
- a body and returns `true`, `false`, or a `Response` such as a redirect to a login
215
- page; a throw or five seconds without an answer refuses the request with 503. A
216
- request passes with a valid token or when `authorize` allows it.
216
+ a body and returns `true`, `false`, `{ user }` for someone signed in, or a
217
+ `Response` such as a redirect to a login page; a throw or five seconds without
218
+ an answer refuses the request with 503. A request passes with a valid token or
219
+ when `authorize` allows it.
217
220
 
218
221
  `GET /_health` on the dashboard's port needs no sign-in: 200 while the app answers
219
222
  its own `/_health`, 503 when it does not, for uptime monitors. Responses are
220
- `no-store`, with a strict Content-Security-Policy and `X-Frame-Options: DENY`;
223
+ `no-store`, with a strict Content-Security-Policy and `X-Frame-Options: DENY`
224
+ (the Workflows page and an extension's `/app` pages may be framed by the
225
+ dashboard itself);
221
226
  serve it over HTTPS. Failed sign-ins are not rate limited, so use long random
222
227
  tokens. The dashboard runs in the app's process: it survives errors in handlers,
223
228
  not the process dying. `brick dev` has its own dashboard and ignores the option.