@jimhoyd/urlcode 0.4.2 → 0.4.6

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 (214) hide show
  1. package/.claude/skills/urlcode-authoring/SKILL.md +57 -14
  2. package/.claude/skills/urlcode-operations/SKILL.md +4 -0
  3. package/README.md +19 -15
  4. package/SECURITY.md +5 -3
  5. package/dist/BUILD-MANIFEST.json +30 -27
  6. package/dist/agent-context.js +82 -0
  7. package/dist/agents-guide.js +42 -42
  8. package/dist/authoring.js +12 -2
  9. package/dist/body-schema.js +159 -0
  10. package/dist/build-cloudflare.js +2 -0
  11. package/dist/capabilities.js +1 -1
  12. package/dist/cli.js +28 -12
  13. package/dist/config.js +74 -6
  14. package/dist/context.js +4 -6
  15. package/dist/errors.js +3 -1
  16. package/dist/examples.js +1 -1
  17. package/dist/extensions.js +60 -2
  18. package/dist/http-policy.js +19 -4
  19. package/dist/http-response.js +2 -2
  20. package/dist/init-with.js +71 -9
  21. package/dist/mcp.js +15 -2
  22. package/dist/pattern-guard.js +32 -0
  23. package/dist/policies/security.js +0 -0
  24. package/dist/project-tests.js +35 -11
  25. package/dist/readiness.js +184 -32
  26. package/dist/recipes.js +1 -1
  27. package/dist/router.js +17 -0
  28. package/dist/runtime.js +26 -3
  29. package/dist/scaffold.js +0 -0
  30. package/dist/server.js +26 -3
  31. package/dist/site.js +0 -0
  32. package/dist/tooling.js +2 -1
  33. package/dist/types/agent-context.d.ts +44 -0
  34. package/dist/types/authoring.d.ts +3 -1
  35. package/dist/types/body-schema.d.ts +58 -0
  36. package/dist/types/config.d.ts +10 -2
  37. package/dist/types/context.d.ts +1 -1
  38. package/dist/types/errors.d.ts +9 -1
  39. package/dist/types/examples.d.ts +1 -1
  40. package/dist/types/extensions.d.ts +47 -2
  41. package/dist/types/http-policy.d.ts +3 -0
  42. package/dist/types/init-with.d.ts +10 -1
  43. package/dist/types/pattern-guard.d.ts +10 -0
  44. package/dist/types/project-tests.d.ts +9 -0
  45. package/dist/types/readiness.d.ts +68 -0
  46. package/dist/types/recipes.d.ts +1 -1
  47. package/dist/types/runtime.d.ts +4 -0
  48. package/dist/types/server.d.ts +9 -1
  49. package/dist/types/tooling.d.ts +1 -0
  50. package/dist/types/types.d.ts +13 -0
  51. package/dist/types.js +10 -2
  52. package/dist/typescript-authoring.js +5 -3
  53. package/dist/verify-deployment.js +16 -10
  54. package/examples/body-validation/README.md +16 -0
  55. package/examples/body-validation/example.yaml +17 -0
  56. package/examples/body-validation/tests/requests.json +15 -0
  57. package/examples/body-validation/urlcode.yaml +34 -0
  58. package/examples/coverage-waiver/README.md +8 -0
  59. package/examples/coverage-waiver/example.yaml +16 -0
  60. package/examples/coverage-waiver/functions/notes.mjs +2 -0
  61. package/examples/coverage-waiver/tests/requests.json +3 -0
  62. package/examples/coverage-waiver/urlcode.yaml +10 -0
  63. package/examples/data-dir/README.md +39 -0
  64. package/examples/data-dir/data/welcome.txt +1 -0
  65. package/examples/data-dir/example.yaml +22 -0
  66. package/examples/data-dir/functions/note.mjs +18 -0
  67. package/examples/data-dir/tests/requests.json +6 -0
  68. package/examples/data-dir/urlcode.yaml +6 -0
  69. package/examples/lifecycle/README.md +15 -0
  70. package/examples/lifecycle/example.yaml +19 -0
  71. package/examples/lifecycle/functions/notes.mjs +29 -0
  72. package/examples/lifecycle/tests/requests.json +12 -0
  73. package/examples/lifecycle/urlcode.yaml +29 -0
  74. package/examples/not-found/README.md +10 -0
  75. package/examples/not-found/example.yaml +17 -0
  76. package/examples/not-found/public/404.html +3 -0
  77. package/examples/not-found/public/index.html +3 -0
  78. package/examples/not-found/tests/requests.json +7 -0
  79. package/examples/not-found/urlcode.yaml +7 -0
  80. package/examples/shared-blocks/README.md +11 -0
  81. package/examples/shared-blocks/example.yaml +17 -0
  82. package/examples/shared-blocks/tests/requests.json +7 -0
  83. package/examples/shared-blocks/urlcode.yaml +37 -0
  84. package/llms-full.txt +364 -49
  85. package/llms.txt +43 -5
  86. package/package.json +15 -22
  87. package/recipes/static-page/README.md +9 -0
  88. package/recipes/static-page/public/index.html +11 -0
  89. package/recipes/static-page/recipe.yaml +21 -0
  90. package/recipes/static-page/tests/requests.json +22 -0
  91. package/recipes/static-page/urlcode.yaml +7 -0
  92. package/recipes/static-plus-api/README.md +6 -0
  93. package/recipes/static-plus-api/urlcode.yaml +4 -0
  94. package/recipes/store-crud/README.md +53 -0
  95. package/recipes/store-crud/recipe.yaml +31 -0
  96. package/recipes/store-crud/tests/requests.json +18 -0
  97. package/recipes/store-crud/urlcode.yaml +18 -0
  98. package/schemas/urlcode.schema.json +125 -60
  99. package/skills/urlcode/SKILL.md +47 -27
  100. package/starters/default/AGENTS.md +43 -43
  101. package/starters/page/README.md +14 -0
  102. package/starters/page/public/index.html +12 -0
  103. package/starters/page/tests/requests.json +17 -0
  104. package/starters/page/urlcode.yaml +6 -0
  105. package/.claude-plugin/marketplace.json +0 -18
  106. package/CONTRIBUTING.md +0 -148
  107. package/ROADMAP.md +0 -70
  108. package/docs/AI-AUTHORING.md +0 -339
  109. package/docs/ASSETS.md +0 -107
  110. package/docs/AUTH-BACKUP.md +0 -32
  111. package/docs/AWS.md +0 -86
  112. package/docs/BEST-PRACTICES.md +0 -276
  113. package/docs/BULK.md +0 -79
  114. package/docs/CAPABILITIES.md +0 -192
  115. package/docs/CAPACITY.md +0 -305
  116. package/docs/CI-FOLLOWUP-2026-09-19.md +0 -97
  117. package/docs/CI-RELEASE-AUDIT-2026-09-19.md +0 -322
  118. package/docs/CI.md +0 -147
  119. package/docs/CLOUDFLARE.md +0 -109
  120. package/docs/CODEBASE-AUDIT-2026-09-20.md +0 -284
  121. package/docs/COMPLIANCE.md +0 -239
  122. package/docs/COMPOSING-A-SITE.md +0 -287
  123. package/docs/CONDITIONS.md +0 -74
  124. package/docs/CONTAINER-PROMOTION.md +0 -74
  125. package/docs/DEPLOYMENT-CHECKS.md +0 -108
  126. package/docs/DEVELOPMENT-PIPELINE.md +0 -304
  127. package/docs/EGRESS.md +0 -125
  128. package/docs/EXTENSIONS.md +0 -403
  129. package/docs/FRAMEWORK.md +0 -217
  130. package/docs/FUNCTION-SECURITY.md +0 -251
  131. package/docs/HTTP.md +0 -129
  132. package/docs/INSTALL.md +0 -128
  133. package/docs/INTERCHANGE.md +0 -134
  134. package/docs/LOAD-TESTING.md +0 -91
  135. package/docs/LOCAL-DEVELOPMENT.md +0 -102
  136. package/docs/MIDDLEWARE-EXAMPLES.md +0 -75
  137. package/docs/MIDDLEWARE.md +0 -102
  138. package/docs/MONITORING.md +0 -115
  139. package/docs/OBSERVABILITY.md +0 -222
  140. package/docs/OPEN-DECISIONS.md +0 -149
  141. package/docs/OPERATIONAL-PROOF.md +0 -41
  142. package/docs/OPERATIONS.md +0 -201
  143. package/docs/ORGANIZATION.md +0 -135
  144. package/docs/PERFORMANCE.md +0 -72
  145. package/docs/PLUGINS.md +0 -271
  146. package/docs/POLICIES.md +0 -211
  147. package/docs/PRERENDER.md +0 -245
  148. package/docs/PROJECT-DIRECTION.md +0 -118
  149. package/docs/PROVIDER-VERIFICATION.md +0 -84
  150. package/docs/READINESS.md +0 -153
  151. package/docs/README.md +0 -93
  152. package/docs/RECIPES.md +0 -99
  153. package/docs/RELEASE-0.4.0-alpha.3.md +0 -50
  154. package/docs/RELEASE-0.4.1.md +0 -73
  155. package/docs/RELEASE-0.4.2.md +0 -30
  156. package/docs/RELEASE-READINESS.md +0 -146
  157. package/docs/RELEASE-SECURITY.md +0 -100
  158. package/docs/RESILIENCE.md +0 -161
  159. package/docs/ROUTING.md +0 -92
  160. package/docs/SANDBOX-REVIEW.md +0 -72
  161. package/docs/SCAFFOLDING.md +0 -70
  162. package/docs/SECURITY-AUDIT.md +0 -164
  163. package/docs/SITE.md +0 -150
  164. package/docs/SPECIFICATION.md +0 -359
  165. package/docs/SPIKE-AI-FRAMEWORK-BENCHMARK.md +0 -288
  166. package/docs/SPIKE-BUSINESS-SUITE.md +0 -1029
  167. package/docs/SPIKE-CORE-LAYERING.md +0 -368
  168. package/docs/SPIKE-DEFAULT-TRUST-MODEL.md +0 -207
  169. package/docs/STANDARDS.md +0 -311
  170. package/docs/STARTERS.md +0 -83
  171. package/docs/STATIC.md +0 -105
  172. package/docs/TOOLING.md +0 -298
  173. package/docs/TUNNELS.md +0 -72
  174. package/docs/TYPESCRIPT-AUTHORING.md +0 -87
  175. package/docs/TYPESCRIPT.md +0 -123
  176. package/docs/VERCEL.md +0 -114
  177. package/docs/VERSION-ALIGNMENT.md +0 -88
  178. package/docs/YAML-GUIDE.md +0 -57
  179. package/docs/YAML-REFERENCE.md +0 -449
  180. package/docs/archive/2026-09-19/EXTENSION-IMPLEMENTATION.md +0 -68
  181. package/docs/archive/2026-09-19/MANAGEMENT-SECURITY.md +0 -102
  182. package/docs/archive/2026-09-19/NEXT-PHASE-PLAN.md +0 -108
  183. package/docs/archive/2026-09-19/NEXT-STEPS.md +0 -646
  184. package/docs/archive/2026-09-19/OPEN-DECISIONS.md +0 -277
  185. package/docs/archive/2026-09-19/RELEASE-SECURITY.md +0 -186
  186. package/docs/archive/2026-09-19/ROADMAP.md +0 -387
  187. package/docs/archive/2026-09-19/SPIKE-EXTENSION-MODEL.md +0 -430
  188. package/docs/archive/2026-09-19/SPIKE-EXTENSIONS.md +0 -492
  189. package/docs/archive/2026-09-19/SPIKE-LAMBDA-COMPILE.md +0 -365
  190. package/docs/archive/2026-09-19/SPIKE-MONOREPO.md +0 -778
  191. package/docs/archive/2026-09-19/USABILITY-REVIEW.md +0 -139
  192. package/docs/archive/2026-09-20/OPEN-DECISIONS-COMPLETED.md +0 -116
  193. package/docs/archive/README.md +0 -29
  194. package/docs/policies/agents.md +0 -182
  195. package/docs/policies/cache.md +0 -152
  196. package/docs/policies/compression.md +0 -169
  197. package/docs/policies/contract.md +0 -52
  198. package/docs/policies/hardened.md +0 -56
  199. package/docs/policies/interoperability.md +0 -169
  200. package/docs/policies/operations.md +0 -45
  201. package/docs/policies/security.md +0 -161
  202. package/docs/policies/throttle.md +0 -103
  203. package/docs/yaml/assets.md +0 -36
  204. package/docs/yaml/conditions.md +0 -20
  205. package/docs/yaml/functions.md +0 -168
  206. package/docs/yaml/middleware.md +0 -31
  207. package/docs/yaml/organization.md +0 -74
  208. package/docs/yaml/policies.md +0 -37
  209. package/docs/yaml/redirects.md +0 -64
  210. package/docs/yaml/responses.md +0 -57
  211. package/docs/yaml/site.md +0 -24
  212. package/packaging/claude-plugin/.claude-plugin/plugin.json +0 -19
  213. package/packaging/claude-plugin/skills/urlcode-authoring/SKILL.md +0 -130
  214. package/packaging/claude-plugin/skills/urlcode-operations/SKILL.md +0 -108
package/docs/READINESS.md DELETED
@@ -1,153 +0,0 @@
1
- # Test every route, then measure it
2
-
3
- Alpha.5 includes a local coverage gate and an assertion-aware project benchmark.
4
- These validate a local snapshot, not the reachability of external redirect
5
- services or the correctness of an entire production deployment.
6
-
7
- ```sh
8
- urlcode routes --project ../my-links
9
- urlcode audit --project ../my-links --expect-routes 2
10
- urlcode benchmark --project ../my-links --requests 1000 --concurrency 2 --max-p95-ms 50
11
- ```
12
-
13
- All three activate/validate the project with the same runtime that serves it --
14
- each route in its own declared trust mode, trusted in-process unless it declares
15
- `sandbox: true` -- and use local environment loading like `test`. Pass an
16
- external `--policy` for explicitly authorized bindings. No destination redirects are followed, credentials are not
17
- printed, and no remote load-test target is accepted.
18
-
19
- ## Inventory and count reconciliation
20
-
21
- `routes` reports each configured route's pattern, handler, exact allowed methods,
22
- execution mode (`sandbox`, with `sandboxReason` when the route declares one)
23
- and active/disabled/expired state. It includes routes from YAML includes. A
24
- parameter pattern is one route; its possible URLs are not a finite route count.
25
- A static mount is one route, even when it contains many files.
26
-
27
- `routes --compare previous.json` diffs the current inventory against a saved
28
- `routes` report: added, removed and changed routes (handler, methods, state,
29
- execution mode and its reason, middleware count, policies, generated marker and
30
- the policy description). A route that flips between trusted and sandboxed
31
- execution is a change, including when its handler is native and only its
32
- middleware runs project code. It
33
- prints JSON, or Markdown tables with `--format markdown`, and always exits 0;
34
- it reports, it does not judge. The [GitHub action](CI.md) posts this diff on
35
- pull requests.
36
-
37
- `audit --expect-routes N` compares N with the total configured count. Its summary
38
- separately counts active, disabled and expired routes and groups by handler.
39
- A mismatch exits nonzero. Keep N reviewed in your application CI so accidentally
40
- removing a route cannot silently reduce the test workload. Change it intentionally
41
- when adding/removing routes; do not calculate the expected value from the same YAML.
42
-
43
- ## Generated checks plus explicit examples
44
-
45
- The audit generates GET/HEAD checks for concrete native redirects, declared
46
- responses, pages/downloads and every snapshotted static file. It checks status,
47
- redirect Location, file metadata/length and declared bodies where applicable.
48
- It also checks literal disabled/expired routes for 404/410. Generated checks are
49
- contract consistency checks; they cannot decide whether your intended destination
50
- or content is correct. Keep independent expected outcomes in fixtures too.
51
-
52
- Functions, parameterized routes, required inputs/bodies and non-GET/HEAD methods
53
- need fixtures in `tests/requests.json`:
54
-
55
- ```json
56
- [
57
- {"path":"/hello/Ada","status":200,"expectBody":"{\"message\":\"Hello, Ada!\"}"},
58
- {"path":"/hello/Ada","method":"HEAD","status":200,"expectBody":""},
59
- {"path":"/go","status":302,"expectHeaders":{"location":"https://example.com/"}},
60
- {"path":"/go","method":"POST","status":405,"expectHeaders":{"allow":"GET, HEAD"}},
61
- {"path":"/missing","status":404}
62
- ]
63
- ```
64
-
65
- Each case may supply `method`, string-valued `headers`, a text `body`, expected
66
- `status`, string-valued `expectHeaders`, and exact UTF-8 `expectBody`. Status is
67
- required. A passing case needs at least one body/header assertion to count toward
68
- coverage; status-only successes appear in `unassertedCases`. Choose assertions
69
- that verify your intended business result, not just a generic header. Fixtures
70
- are limited to 10,000 cases/16 MiB; checked response bodies to 16 MiB. Requests have
71
- 10-second transport timeouts. Failures do not stop subsequent checks. Status 0
72
- means a transport/response-limit failure. Output reports case numbers/statuses,
73
- not response bodies, header values or fixture URLs that may contain private data.
74
-
75
- Coverage uses the route that actually matched. A literal route shadowing a
76
- parameter example cannot count toward parameter coverage. Each active route and
77
- allowed method needs a passing normal response (below 400); an intentionally
78
- error-valued native `respond` check can cover its declared outcome. A negative
79
- fixture alone cannot prove a function works normally. Disabled/expired routes
80
- are counted separately and excluded from active coverage requirements. Inactive
81
- parameter patterns still need explicit negative fixtures to exercise them.
82
-
83
- `ready: true` requires a nonempty active project, matching expected count (when
84
- supplied), zero failed checks and no uncovered active route/method combinations.
85
- When `ready` is false, `notReadyReasons` lists each failed condition:
86
- `no-active-routes`, `route-count-mismatch`, `failed-checks` and
87
- `uncovered-route-methods` (see `uncovered` for the pairs). `unassertedCases` never
88
- affects `ready`. It means this local gate passed, not that all branches, parameter values or assets
89
- have independent business assertions. Function routes intentionally serving only
90
- errors cannot satisfy normal-response coverage in this release. Time-dependent
91
- expiry is evaluated at audit start; avoid running a gate exactly at expiry.
92
-
93
- `urlcode test` runs only explicit fixtures. `audit` adds generated native checks,
94
- counts and coverage. Both execute locally and never follow redirect destinations.
95
- Audits run sequentially to avoid mistaking worker saturation for a routing failure.
96
-
97
- ## Benchmark your actual project
98
-
99
- The benchmark cycles generated checks and explicit successful GET/HEAD fixtures.
100
- POST/PUT/PATCH/DELETE/OPTIONS and expected error cases are excluded. Function
101
- GET/HEAD handlers still execute: use synthetic test data and reviewed bindings.
102
- The workload is case-weighted, not a simulation of real user traffic. A short run
103
- may not reach every case; compare `exercisedWorkloadCases` with `workloadCases`.
104
-
105
- Output includes requested/completed count, assertion failures, status histogram,
106
- startup time, throughput, p50/p95/p99 response time, process RSS, Node and OS.
107
- Any wrong status/header/body, incomplete run or exceeded `--max-p95-ms` budget
108
- exits nonzero. Warmup is zero and is reported explicitly. Client/server share one
109
- process; RSS and latency are local measurements, not server-only production SLAs.
110
-
111
- Defaults: 1,000 requests, concurrency 2, 30-second scheduling budget. Bounds:
112
- 1–100,000 requests, 1–32 concurrent requests, `--seconds` 1–300. In-flight requests
113
- may finish after the scheduling budget, bounded by their timeout. Higher function
114
- concurrency can legitimately cause 503 because the default pool has two workers.
115
- Choose a latency budget from repeatable measurements on your intended host.
116
- The existing synthetic `npm run benchmark -- 10000` is still a separate scale test.
117
-
118
- ## What a release should prove
119
-
120
- | Check | Evidence to require |
121
- |---|---|
122
- | Counts and coverage | Reviewed expected count; every active route/method covered; disabled/expired routes accounted for |
123
- | Correct happy paths | Exact redirect destinations/status/query handling; function bodies/headers; representative parameter and asset examples |
124
- | Invalid inputs | Missing/duplicate/wrong-type inputs; malformed paths/encoding; wrong methods; bad JSON/media type; oversized bodies |
125
- | Response contracts | HEAD empty bodies, Allow headers, cookies, cache policy, download names/MIME; ETag/304 and range/206/416 fixtures |
126
- | Configuration changes | Invalid candidate keeps last-good routes; valid reload updates behavior; removed routes are intentional |
127
- | Code containment | Runtime security suite passes; no ambient filesystem/network access; grants narrow and revision-pinned |
128
- | Capacity and failure | Representative mix and concurrency; low errors and repeatable latency; timeouts, overload recovery and memory over sustained runs |
129
- | Deployment | Fresh install; real HTTPS/domain/health smoke; rollback; shutdown; logs/alerts; explicitly authorized destination reachability checks |
130
-
131
- The runtime suite covers many generic protocol/security/reload cases. Apps must
132
- supply their own business and boundary fixtures. Automated remote destination
133
- health, redirect-chain/loop analysis, DNS/TLS checks, sustained soak/load profiles,
134
- coverage by function branch and historical performance comparison remain planned.
135
- Run the local audit in CI now (the [project action](CI.md) wires validate, test,
136
- audit and the route diff into GitHub pull requests); do not label a passing local
137
- audit “production certified.”
138
- Once a candidate is deployed, `urlcode verify-deployment --target` compares its
139
- responses with this project; see [deployment checks](DEPLOYMENT-CHECKS.md).
140
-
141
- Before writing fixtures, `urlcode explain /route` shows what the compiled
142
- configuration will do for a path: effective methods, the handler, the middleware
143
- chain, validated inputs, the policies in effect and the cache outcome, so a
144
- fixture asserts declared behavior rather than a guess. `urlcode manifest --json`
145
- (also written by `build` as `manifest.json`) lists every route, the capabilities
146
- in use, external requirements and per-target support with the revision digest,
147
- which is the document to attach to a release review. Both read the
148
- configuration only; they are not evidence that a deployment serves it.
149
-
150
- Routes with middleware need explicit request fixtures with meaningful response
151
- assertions for every active method. Audit cannot infer their behavior from the
152
- underlying redirect or asset handler, so it does not generate native checks for
153
- those routes. The route inventory includes a middleware count.
package/docs/README.md DELETED
@@ -1,93 +0,0 @@
1
- # URLCode documentation
2
-
3
- Choose a starting point, then use the topic directory below when you need detail.
4
- Use documentation from the same pinned revision as your runtime.
5
-
6
- | I want to… | Start here |
7
- |---|---|
8
- | Understand what URLCode does | [Framework](FRAMEWORK.md) |
9
- | Build my first project | [Installation](INSTALL.md), then [YAML guide](YAML-GUIDE.md) |
10
- | Build a site with UI, accounts and admin | [Composing a site](COMPOSING-A-SITE.md) |
11
- | Have an AI author a project | [AI authoring](AI-AUTHORING.md), [agent index](../llms.txt) |
12
- | Deploy and operate a project | [Operations](OPERATIONS.md) |
13
- | Contribute to URLCode | [Contributing](../CONTRIBUTING.md), [local development](LOCAL-DEVELOPMENT.md) |
14
-
15
- The [specification](SPECIFICATION.md) owns implemented semantics; the
16
- [generated field reference](YAML-REFERENCE.md) lists accepted fields.
17
- [Project direction](PROJECT-DIRECTION.md) explains the product boundary.
18
-
19
- ## Author a project
20
-
21
- | Goal | Start here |
22
- |---|---|
23
- | Install the CLI | [Installation](INSTALL.md) |
24
- | Write YAML with examples | [YAML guide and recipes](YAML-GUIDE.md) |
25
- | Look up every accepted field | [Generated field reference](YAML-REFERENCE.md), [JSON Schema](../schemas/urlcode.schema.json) |
26
- | Load authoring/operations rules into an agent | [Authoring skill](../.claude/skills/urlcode-authoring/SKILL.md), [operations skill](../.claude/skills/urlcode-operations/SKILL.md), [how they are distributed](AI-AUTHORING.md#agent-skills) |
27
- | Understand exact behavior | [Specification](SPECIFICATION.md), [routing](ROUTING.md), [HTTP](HTTP.md) |
28
- | Run examples | [Executable cookbook](../examples/cookbook/README.md), [prerender recipe](../examples/prerender/README.md), [small starter](STARTERS.md) |
29
- | Let an AI build routes | [The framework](FRAMEWORK.md), [AI authoring guide](AI-AUTHORING.md), [llms.txt](../llms.txt), [SDK and read-only MCP](TOOLING.md) |
30
- | Reuse code around routes | [Middleware](MIDDLEWARE.md), [middleware examples](MIDDLEWARE-EXAMPLES.md) |
31
- | Handle secrets and decide what to sandbox | [Function security](FUNCTION-SECURITY.md) |
32
- | Author guest functions in TypeScript | [Build-time guest transpilation](TYPESCRIPT-AUTHORING.md) |
33
- | Serve pages, files and downloads | [Assets](ASSETS.md) |
34
- | Publish a site with no request-time guest code | [Prerendering helper and recipe](PRERENDER.md) |
35
- | Select response branches | [Exact conditions](CONDITIONS.md) |
36
- | Proxy an API or emit a webhook | [Bounded egress and operator grants](EGRESS.md) |
37
- | Throttle, block agents, set security headers, compress or cache | [Policies](POLICIES.md): [throttle](policies/throttle.md), [agents](policies/agents.md), [security](policies/security.md), [compression](policies/compression.md), [cache](policies/cache.md) |
38
- | Generate robots.txt, sitemap.xml, favicon, security.txt and llms.txt | [Site conventions](SITE.md) |
39
- | Organize YAML across folders | [Organization](ORGANIZATION.md), [readability practices](BEST-PRACTICES.md) |
40
- | Generate placeholders from YAML | [Scaffolding](SCAFFOLDING.md) |
41
- | Convert provider redirect files | [Strict interchange and conversion reports](INTERCHANGE.md) |
42
- | Import thousands of redirects | [Bulk import and scale evidence](BULK.md) |
43
- | Reuse local project recipes | [Recipe catalog](RECIPES.md) |
44
- | Check declared configuration against standards-referenced rules | [Compliance](COMPLIANCE.md) |
45
-
46
- ## Extend the runtime
47
-
48
- | Goal | Start here |
49
- |---|---|
50
- | Add accounts, sign-in and protected routes | [urlcode-auth](../packages/auth#readme), [auth security](../packages/auth/SECURITY.md) |
51
- | Manage users, sessions, roles and audit | [urlcode-admin](../packages/admin#readme) |
52
- | Restyle every extension page and translate copy | [urlcode-ui](../packages/ui#readme), [ui contract](../packages/ui/CONTRACT.md) |
53
- | Write or install a versioned extension | [Extensions](EXTENSIONS.md), [example fixture](../examples/extensions/README.md) |
54
- | Know which core version an extension package supports, and how it says so | [Core version alignment](VERSION-ALIGNMENT.md) |
55
- | Add host behavior in operator code | [Plugins](PLUGINS.md) |
56
- | Use the API from TypeScript | [TypeScript: shipped declarations, exports, build and fidelity](TYPESCRIPT.md) |
57
-
58
- ## Operate and deploy
59
-
60
- | Goal | Start here |
61
- |---|---|
62
- | Work locally | [Local development](LOCAL-DEVELOPMENT.md), [tunnels](TUNNELS.md) |
63
- | Prove responses and counts | [Readiness](READINESS.md) |
64
- | Check pull requests of a project on GitHub | [CI action, route diffs and the starter workflow](CI.md) |
65
- | Deploy and roll back | [Operations](OPERATIONS.md) |
66
- | Review security findings and gaps | [Internal security audit](SECURITY-AUDIT.md) |
67
- | Assess release readiness | [Evidence and open gates](RELEASE-READINESS.md) |
68
- | See unfinished work | [Roadmap](../ROADMAP.md) |
69
- | Verify a running deployment matches the project | [Deployment checks](DEPLOYMENT-CHECKS.md) |
70
- | Inspect target support | [Capabilities and normalized representation](CAPABILITIES.md) |
71
- | Deploy to Vercel, AWS Lambda or Cloudflare Workers | [Vercel](VERCEL.md), [AWS](AWS.md), [Cloudflare](CLOUDFLARE.md), [provider verification evidence](PROVIDER-VERIFICATION.md) |
72
- | Watch a deployment | [Monitoring](MONITORING.md), [observability](OBSERVABILITY.md) |
73
- | Estimate concurrency and memory | [Capacity and limits](CAPACITY.md), [measurements](PERFORMANCE.md), [load testing](LOAD-TESTING.md) |
74
- | Prepare for overload, DDoS and recovery | [Resilience playbook](RESILIENCE.md) |
75
-
76
- ## Direction and evidence
77
-
78
- Start with [principles and open decisions](OPEN-DECISIONS.md) for a plain-language
79
- review and [the roadmap](../ROADMAP.md) for next work. Current behavior belongs
80
- in the guides above and the [specification](SPECIFICATION.md).
81
-
82
- - [Release readiness](RELEASE-READINESS.md), [security audit](SECURITY-AUDIT.md),
83
- [sandbox review](SANDBOX-REVIEW.md) and [provider evidence](PROVIDER-VERIFICATION.md)
84
- distinguish implementation from evidence still missing.
85
- - [Version alignment](VERSION-ALIGNMENT.md) and [release security](RELEASE-SECURITY.md)
86
- describe peer compatibility and publication.
87
- - Open proposals: [middleware layering](SPIKE-CORE-LAYERING.md),
88
- [agent benchmark](SPIKE-AI-FRAMEWORK-BENCHMARK.md), and
89
- [business suite](SPIKE-BUSINESS-SUITE.md). None is an implementation promise.
90
- - [Historical plans and reviews](archive/README.md) are archived separately.
91
-
92
- Examples are educational unless backed by runnable fixtures. Infrastructure
93
- limits are deployment settings, not fields to invent in route YAML.
package/docs/RECIPES.md DELETED
@@ -1,99 +0,0 @@
1
- # Local recipes
2
-
3
- Recipes are ordinary version-controlled URLCode projects shipped with the
4
- runtime. There is no network registry, install script, provider account or
5
- project-code execution during authoring. Search them before writing a common
6
- route by hand: the catalog is the vocabulary of behavior the runtime already
7
- supports, and every recipe validates, tests and audits.
8
-
9
- ```sh
10
- urlcode recipes list
11
- urlcode recipes search "webhook json" # id, description, tags, capabilities
12
- urlcode recipes search webhook --json
13
- urlcode recipes show webhook-receiver # metadata first, then every file
14
- urlcode recipes add webhook-receiver --out ./orders-hook --dry-run
15
- urlcode recipes add webhook-receiver --out ./orders-hook
16
- urlcode validate --local --project ./orders-hook
17
- ```
18
-
19
- ## The catalog
20
-
21
- | Recipe | Complexity | What it shows | Needs |
22
- |---|---|---|---|
23
- | `redirect` | starter | Permanent redirect forwarding one allowlisted query key | nothing |
24
- | `health-page` | starter | Native `/health` text and `/status` JSON, no-store | nothing |
25
- | `json-api` | starter | Bounded JSON body echoed by a sandboxed function | self-hosted runtime |
26
- | `webhook-receiver` | starter | JSON event with a type header, shape-checked, `202` | self-hosted runtime |
27
- | `typescript` | intermediate | Typed guest transpiled by `build-typescript` | build step |
28
- | `static-plus-api` | intermediate | Page, static directory and one JSON function | self-hosted runtime |
29
- | `cors-api` | intermediate | Preflight and CORS headers from route middleware | self-hosted runtime |
30
- | `contact-form` | intermediate | Validated message, fixed signal to a hook after the response | signal grant (`--policy`) |
31
- | `middleware` | advanced | Fourteen reusable middleware patterns ([described here](MIDDLEWARE-EXAMPLES.md)) | self-hosted runtime |
32
- | `authenticated-json-api` | advanced | Function behind `auth: true` | operator auth extension, `--host-file`, `--origin` |
33
- | `protected-download` | advanced | Native attachment behind `auth: true` | operator auth extension, `--host-file`, `--origin` |
34
-
35
- Each recipe contains a README, `tests/requests.json` and editable files.
36
- Replace example destinations and review the resulting files before use. The
37
- authenticated recipes declare `extensions.auth` and protect their route with
38
- the short form described in [extensions](EXTENSIONS.md); their README shows the
39
- minimal host-file fixture that reproduces the bundled tests. Nothing in the
40
- catalog verifies webhook signatures: the sandbox has no crypto or network API,
41
- so signed webhooks belong behind an operator extension or a trusted host.
42
-
43
- ## `recipe.yaml`
44
-
45
- Every recipe carries `recipe.yaml`, validated against
46
- [`schemas/recipe.schema.json`](../schemas/recipe.schema.json) by `npm run check`:
47
-
48
- - `id`, `description`, `tags`, `complexity` (`starter`, `intermediate`,
49
- `advanced`): written by hand; `search` matches id, description, tags and
50
- capabilities, every word must match, and whole-tag or id hits rank first.
51
- - `capabilities`, `targets`, `routes`: derived from the capability preflight
52
- (`analyzeProjectCapabilities` per target after site expansion). The check
53
- refuses a hand-edited value that differs, so a recipe cannot claim a target
54
- it does not activate on. `targets` is `compatible`, or the strongest issue
55
- (`conditional`, `unknown`, `refused`); `routes` is the `--expect-routes` value.
56
- - `services` (external services), `grants` (operator grants, never from project
57
- files), `inputs` (what to edit), `files` (the copy list), `tests` (fixtures
58
- and the exact commands) and `behavior` (one observable statement per line).
59
-
60
- `show` prints this metadata before the file contents so a reader sees what a
61
- recipe needs before its files scroll past; `--json` returns the same object with
62
- a `content` map. `list` prints one line per recipe, or the metadata with `--json`.
63
-
64
- ## Examples
65
-
66
- `examples/*/example.yaml` uses the same schema, and `urlcode examples search
67
- <text> [--json]` returns the smallest matching runnable example first with the
68
- file to read. The cookbook's forty routes are indexed per route in the generated
69
- [`examples/cookbook/route-index.json`](../examples/cookbook/route-index.json)
70
- (handler, methods, capabilities, policies and middleware module names as tags;
71
- `npm run docs:cookbook-index` regenerates it and `npm run check` refuses a stale
72
- copy), so a search for `etag` answers the cookbook and its `/versioned` route.
73
- Entries without a `urlcode.yaml` (operator rules, monitoring configuration,
74
- scripts) are `runnable: false` and carry no derived fields.
75
-
76
- ## Adding a recipe
77
-
78
- `add` creates a new standalone directory. It refuses an existing destination,
79
- even an empty directory; it never merges or overwrites existing project routes.
80
- Review or copy selected declarations manually when combining projects. Dry-run
81
- reads and validates the packaged recipe and checks the destination, but writes
82
- nothing. The output parent must already exist and be owned by the caller.
83
- Dependencies are written first and the complete `urlcode.yaml` is published by
84
- rename last. A failed write removes the new directory. This is atomic project
85
- activation, not an atomic directory replacement or a guarantee against a local
86
- attacker concurrently replacing the caller's output directories.
87
-
88
- ## SDK and MCP
89
-
90
- The SDK provides `listRecipes()`, `searchRecipes(text)`, `showRecipe(name)`,
91
- `addRecipe(name, output, {dryRun})`, `listExamples()` and `searchExamples(text)`.
92
- Catalog names are a fixed list in code; metadata and file lists come from each
93
- schema-checked `recipe.yaml` and are returned as copies. Unknown names and
94
- arbitrary paths/URLs fail closed. The stdio MCP server adds `search_recipes` and
95
- `search_examples` beside `recipes_list` and `recipes_show`
96
- ([tooling](TOOLING.md)). Integration tests run every recipe through the real
97
- runtime with its fixtures and audit it with its declared route count (after
98
- building the TypeScript recipe, with a fixture registry for the authenticated
99
- ones and the generated policy for the contact form).
@@ -1,50 +0,0 @@
1
- # Coordinated 0.4.0-alpha.3 release
2
-
3
- This release prepares core, UI, auth and admin at `0.4.0-alpha.3`, as explicitly
4
- selected by the maintainer. The shared number identifies this tested package
5
- set; it does not enable permanent fixed versioning or leave the alpha channel.
6
- Existing versions, tags, and npm `latest` channels are preserved.
7
-
8
- ## Included changes
9
-
10
- Core includes the monorepo consolidation, corrected Windows npm invocation,
11
- current trust-by-default authoring guidance, and support for a TypeScript module
12
- shared by trusted and sandboxed routes without weakening the sandbox checks.
13
- The CLI and MCP report the new runtime version. The runtime remains independent
14
- of the extension implementations.
15
-
16
- Auth includes deterministic worker cleanup on rejected initialization and
17
- Windows backup flushing. Auth/admin refresh a lifecycle hook's entry module on
18
- each activation; changes to the entry module's own imports still require restart.
19
- The extension changelogs record their package-specific changes.
20
-
21
- All four packages use the shared release coordinator, immutable release tags,
22
- exact-commit full verification, retained retry artifacts and trusted npm
23
- publication. The candidate rehearsal installs their tarballs together outside
24
- the workspace and checks peers, public imports and scaffolding.
25
-
26
- ## Installation and compatibility
27
-
28
- Once publication has completed, install an exact, coordinated set in the
29
- consumer application's directory:
30
-
31
- ```sh
32
- npm install --save-exact @jimhoyd/urlcode@0.4.0-alpha.3 @jimhoyd/urlcode-ui@0.4.0-alpha.3 @jimhoyd/urlcode-auth@0.4.0-alpha.3 @jimhoyd/urlcode-admin@0.4.0-alpha.3
33
- ```
34
-
35
- Applications only need the extensions they actually use; admin requires auth
36
- and UI, and auth requires UI. Auth/admin peer floors for this release are
37
- `>=0.4.0-alpha.3 <0.5.0`. Update their dependencies together when crossing from
38
- the former `0.1.x` extension line. Commit the resulting lockfile and use `npm ci`
39
- in deployment. This release changes package peer compatibility intentionally;
40
- it does not imply all previously mixed versions are supported.
41
-
42
- Publication order is core, UI, auth, admin. A partial release stops before the
43
- next package; diagnose and rerun its original workflow without moving tags.
44
- The standalone template remains an exact core consumer and is updated through
45
- its own PR after core is published. Archived extension repositories are not
46
- publication targets.
47
-
48
- CI and candidate success are not independent security assessment, live-provider
49
- acceptance, or operational recovery proof. The intermittent Windows startup
50
- timeout remains tracked in #202.
@@ -1,73 +0,0 @@
1
- # URLCode 0.4.1
2
-
3
- Core, UI, auth and admin share this explicitly selected stable version. This does not enable permanent fixed versioning. Internal peer minimums advance to this version; install the coordinated set together.
4
-
5
- ```sh
6
- npm install --save-exact @jimhoyd/urlcode@0.4.1 @jimhoyd/urlcode-ui@0.4.1 @jimhoyd/urlcode-auth@0.4.1 @jimhoyd/urlcode-admin@0.4.1
7
- ```
8
-
9
- This coordinated release moves core, UI, auth and admin from `0.4.0-alpha.3` to stable `0.4.1`. It makes the reviewed monorepo release line available through npm `latest` and keeps the four packages' peer minimums aligned.
10
-
11
- The runtime retains its existing trust model: project functions and middleware run trusted in Node by default; routes declaring `sandbox: true` retain QuickJS/WASM isolation. The stable label is a distribution decision, not an independent security assessment or hostile multi-tenant readiness claim.
12
-
13
- Release preparation now supports an explicit exit from alpha. Publication promotes the exact signed candidate archives, pins their manifest digest in immutable tags, checks actual npm installability, and updates the standalone starter to the published core version. Historical alpha versions and tags remain unchanged.
14
-
15
- ### admin-kit-only-console.md
16
-
17
- **Breaking:** the console renders only through the urlcode-ui kit. `ui` is now a
18
- required option of `adminExtension` and of `createAdministrationRuntime`'s
19
- `admin` block, which is itself no longer optional.
20
-
21
- `@jimhoyd/urlcode-ui` was already a required peer dependency, so nothing new has
22
- to be installed. What changed is that the `ui` *extension* must now be supplied
23
- and active: the primitive render path — the same `admin/*` templates rendered
24
- through the shared primitives inside a console shell admin built itself — is
25
- gone, along with the `RenderPath` seam, the `activeKit()` helper, the
26
- `ScreenOptions.shell.sidebar` markup and `src/admin-presentation.ts`. The kit
27
- builds the sidebar, page header and skip target from the `nav` items and account
28
- `menu` admin supplies, so the console shell has one representation instead of
29
- two. `ScreenOptions.preferences` is gone too: the kit layout now renders through
30
- the same resolved presentation as the body, so the document's `lang` matches the
31
- copy on the page.
32
-
33
- Activation refuses up front, rather than failing per request in production, when
34
-
35
- - `ui` is missing,
36
- - `ui` is supplied but not active yet — declare `ui` before `admin` under
37
- `extensions` in `urlcode.yaml`, since the runtime activates in declaration
38
- order, and mount its assets route, or
39
- - the kit was built without `adminUiTemplates`.
40
-
41
- To migrate, build the extension with admin's templates and pass it:
42
-
43
- ```js
44
- const ui = createUiExtension({projectSha256, projectRoot, sources: [authCatalogue], extensions: [authUiTemplates, adminUiTemplates]});
45
- adminExtension({service, csrfKey, projectSha256, ui});
46
- ```
47
-
48
- Scaffolding emits that wiring for you: `scaffold()`, `initAdministration` and
49
- `urlcode init --with ui,auth,admin` compose the kit and register the admin
50
- templates with it. `ui` is now required, and must come before `admin`; the
51
- scaffold refuses otherwise before writing anything.
52
-
53
- ### auth-kit-only-render.md
54
-
55
- Breaking: the `ui` extension is now required. Every account screen renders through the `urlcode-ui` kit; the shared-primitive fallback is gone. `authExtension({ui, ...})` refuses activation when `ui` is absent or when the runtime has not activated it, naming the missing piece instead of failing per request. Declare `ui` before `auth` in `urlcode.yaml` (with its asset route) and list `ui.registration` before `authExtension` in the host: the runtime activates extensions in the order `urlcode.yaml` declares them. `@jimhoyd/urlcode-ui` was already a required peer dependency, so nothing new needs installing; what changes is that the extension must be supplied and active. `ScreenOptions.ui` is no longer optional and `screenObserver` no longer reports a render path.
56
-
57
- Scaffolding composes the kit for you: `urlcode init --with ui,auth` and the standalone `initAuthentication` now write a project whose `urlcode.yaml` declares `ui` first and whose host passes it to `authExtension`. The scaffold refuses when `ui` is missing, or ordered after `auth`, before anything is written.
58
-
59
- ### auth-store-startup-diagnostics.md
60
-
61
- Report which startup phase an auth store worker reached when its 15-second bound elapses, and reject at once when the worker fails or exits before reporting readiness instead of waiting the bound out. The status and code are unchanged; the detail is attached as the error's cause for operator logs and never reaches a response.
62
-
63
- ### pin-generated-site-dependencies.md
64
-
65
- `urlcode-auth init` now writes a `package.json` that pins this package and each declared peer at the exact version installed beside it, instead of a manifest with no dependencies at all; `initAuthentication` returns those pins and names any peer it could not resolve. Nothing is installed: running `npm install` in the generated directory to produce a lockfile stays the operator's explicit step, and no upgrade command exists.
66
-
67
- ### ui-scaffold-peer-registration.md
68
-
69
- The scaffold wires kit-rendering peers into the host it generates. `scaffold()` reads the composed `names` and emits `createUiExtension({..., sources: [authCatalogue], extensions: [authUiTemplates, adminUiTemplates]})`, importing each peer it needs, so `urlcode init --with ui,auth,admin` produces a project that activates. Previously it always wrote `sources: []` and no `extensions`, which left auth and admin without their copy and templates. `ui` alone still registers nothing and imports no peer.
70
-
71
- Name `ui` first: the runtime activates extensions in the order `urlcode.yaml` declares them, core writes that file in `--with` order, and auth and admin both refuse to activate before the kit is active.
72
-
73
- Publish to the npm `latest` channel in core → UI → auth → admin order after exact-commit CI and candidate verification. Existing tags and the `alpha` channel stay unchanged; this stable release advances `latest`. Changesets prerelease mode is exited. Update the standalone starter's exact core pin after registry installability is verified. This preparation is not evidence of publication or an independent security assessment.
@@ -1,30 +0,0 @@
1
- # URLCode 0.4.2
2
-
3
- Core, UI, auth and admin share this explicitly selected stable version. Independent package versioning remains enabled.
4
-
5
- ```sh
6
- npm install --save-exact @jimhoyd/urlcode@0.4.2 @jimhoyd/urlcode-ui@0.4.2 @jimhoyd/urlcode-auth@0.4.2 @jimhoyd/urlcode-admin@0.4.2
7
- ```
8
-
9
- ### admin-copy-project-override.md
10
-
11
- Project translations of `adminUi.*` ids in `ui/copy/<locale>.json` now reach the admin console.
12
-
13
- In a composed site the console copy source is built with `createAdminPresentation({ base: kit.presentation })`, and the admin ids were resolved only from the bundled English, so a project's `adminUi.*` entries were silently ignored. When a base presentation is given, an admin id the base resolves for the request's locale now wins; otherwise the bundled admin English still answers. Hosts that pass no `base` and hosts that supply their own presentation are unchanged.
14
-
15
- ### ui-styles-once-per-verify.md
16
-
17
- Compile Tailwind once per `npm run verify`.
18
-
19
- No API change and no change to the generated stylesheet. `verify` used to run
20
- `typecheck` then `build`, and each of those runs `styles`, so
21
- `scripts/build-styles.mjs` compiled the same minified CSS twice per
22
- verification. `verify` now runs `styles` once and then the compiler-only
23
- `typecheck:tsc` and `build:tsc` scripts. `typecheck` and `build` are unchanged
24
- from a caller's point of view: each still runs `styles` first, so either one
25
- works on its own from a fresh checkout.
26
-
27
- Nothing is cached and nothing is skipped because an output already exists; the
28
- single run is unconditional, so a source change is still picked up.
29
-
30
- Publish to the npm `latest` channel only after exact-commit CI and candidate verification. Existing tags and the `alpha` channel stay unchanged. Update the standalone starter after core registry installability is verified. This preparation is not evidence of publication or an independent security assessment.