memory-journal-mcp 7.7.1 → 8.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +126 -56
- package/dist/chunk-6OHRCNYW.js +3231 -0
- package/dist/chunk-JFMITANR.js +5168 -0
- package/dist/{chunk-6LPTBIB6.js → chunk-MWNLAEHR.js} +309 -4332
- package/dist/{chunk-ARLYSFSI.js → chunk-UHSO65A4.js} +4242 -6092
- package/dist/cli.js +21 -3
- package/dist/index.d.ts +16 -13
- package/dist/index.js +4 -2
- package/dist/resources-IJVKDFGS.js +2 -0
- package/dist/tools-44DGXE3V.js +2 -0
- package/dist/worker-script.js +201 -20
- package/package.json +6 -4
- package/skills/README.md +62 -25
- package/skills/adversarial-performance/SKILL.md +139 -0
- package/skills/adversarial-performance/references/audit-categories.md +462 -0
- package/skills/adversarial-performance/references/copilot-performance-prompts.md +44 -0
- package/skills/adversarial-performance/references/copilot-usage.md +16 -0
- package/skills/adversarial-performance/references/feedback-loop.md +177 -0
- package/skills/adversarial-performance/references/multi-pass-performance-protocol.md +398 -0
- package/skills/adversarial-planner/SKILL.md +23 -54
- package/skills/adversarial-planner/references/copilot-integration.md +25 -40
- package/skills/adversarial-planner/references/copilot-usage.md +16 -0
- package/skills/adversarial-planner/references/multi-pass-protocol.md +4 -0
- package/skills/adversarial-security/SKILL.md +149 -0
- package/skills/adversarial-security/references/adversarial-base-protocol.md +44 -0
- package/skills/adversarial-security/references/audit-categories.md +723 -0
- package/skills/adversarial-security/references/copilot-security-prompts.md +142 -0
- package/skills/adversarial-security/references/copilot-usage.md +16 -0
- package/skills/adversarial-security/references/feedback-loop.md +206 -0
- package/skills/adversarial-security/references/journal-opt-out.md +7 -0
- package/skills/adversarial-security/references/multi-pass-security-protocol.md +403 -0
- package/skills/adversarial-skill-audit/SKILL.md +118 -0
- package/skills/adversarial-skill-audit/references/audit-categories.md +308 -0
- package/skills/adversarial-skill-audit/references/copilot-skill-prompts.md +68 -0
- package/skills/adversarial-skill-audit/references/copilot-usage.md +16 -0
- package/skills/adversarial-skill-audit/references/feedback-loop.md +155 -0
- package/skills/adversarial-skill-audit/references/multi-pass-skill-protocol.md +367 -0
- package/skills/adversarial-skill-audit/scripts/check-skills.ps1 +48 -0
- package/skills/adversarial-skill-audit/scripts/run-copilot.ps1 +52 -0
- package/skills/adversarial-workflow-audit/SKILL.md +82 -0
- package/skills/adversarial-workflow-audit/references/audit-categories.md +28 -0
- package/skills/adversarial-workflow-audit/references/copilot-usage.md +16 -0
- package/skills/adversarial-workflow-audit/scripts/check-workflows.ps1 +24 -0
- package/skills/agents-sdk/SKILL.md +220 -0
- package/skills/agents-sdk/references/callable.md +92 -0
- package/skills/agents-sdk/references/codemode.md +209 -0
- package/skills/agents-sdk/references/email.md +144 -0
- package/skills/agents-sdk/references/mcp/SKILL.md +65 -0
- package/skills/agents-sdk/references/mcp/code-mode-reference.md +245 -0
- package/skills/agents-sdk/references/mcp/oauth-reference.md +359 -0
- package/skills/agents-sdk/references/mcp/references/architecture-reference.md +208 -0
- package/skills/agents-sdk/references/mcp/references/cloudflare-quickstart.md +156 -0
- package/skills/agents-sdk/references/mcp/references/error-handling.md +343 -0
- package/skills/agents-sdk/references/mcp/references/http-security.md +164 -0
- package/skills/agents-sdk/references/mcp/references/implementation-guide.md +507 -0
- package/skills/agents-sdk/references/mcp/references/testing-reference.md +171 -0
- package/skills/agents-sdk/references/mcp.md +157 -0
- package/skills/agents-sdk/references/state-scheduling.md +164 -0
- package/skills/agents-sdk/references/streaming-chat.md +168 -0
- package/skills/agents-sdk/references/workflows.md +136 -0
- package/skills/auth-identity/SKILL.md +48 -0
- package/skills/autonomous-dev/SKILL.md +46 -23
- package/skills/autonomous-dev/references/workflow_orchestration.md +22 -0
- package/skills/aws/SKILL.md +39 -0
- package/skills/azure/SKILL.md +38 -0
- package/skills/bin/sync.js +7 -1
- package/skills/biome/SKILL.md +59 -0
- package/skills/bun/SKILL.md +8 -2
- package/skills/cloudflare/SKILL.md +37 -0
- package/skills/cloudflare/references/agents-sdk/README.md +95 -0
- package/skills/cloudflare/references/agents-sdk/api.md +195 -0
- package/skills/cloudflare/references/agents-sdk/configuration.md +178 -0
- package/skills/cloudflare/references/agents-sdk/gotchas.md +173 -0
- package/skills/cloudflare/references/agents-sdk/patterns.md +215 -0
- package/skills/cloudflare/references/ai-gateway/README.md +176 -0
- package/skills/cloudflare/references/ai-gateway/configuration.md +117 -0
- package/skills/cloudflare/references/ai-gateway/dynamic-routing.md +88 -0
- package/skills/cloudflare/references/ai-gateway/features.md +96 -0
- package/skills/cloudflare/references/ai-gateway/sdk-integration.md +110 -0
- package/skills/cloudflare/references/ai-gateway/troubleshooting.md +90 -0
- package/skills/cloudflare/references/ai-search/README.md +145 -0
- package/skills/cloudflare/references/ai-search/api.md +87 -0
- package/skills/cloudflare/references/ai-search/configuration.md +91 -0
- package/skills/cloudflare/references/ai-search/gotchas.md +92 -0
- package/skills/cloudflare/references/ai-search/patterns.md +87 -0
- package/skills/cloudflare/references/analytics-engine/README.md +96 -0
- package/skills/cloudflare/references/analytics-engine/api.md +112 -0
- package/skills/cloudflare/references/analytics-engine/configuration.md +107 -0
- package/skills/cloudflare/references/analytics-engine/gotchas.md +87 -0
- package/skills/cloudflare/references/analytics-engine/patterns.md +83 -0
- package/skills/cloudflare/references/api/README.md +66 -0
- package/skills/cloudflare/references/api/api.md +205 -0
- package/skills/cloudflare/references/api/configuration.md +158 -0
- package/skills/cloudflare/references/api/gotchas.md +231 -0
- package/skills/cloudflare/references/api/patterns.md +208 -0
- package/skills/cloudflare/references/api-shield/README.md +44 -0
- package/skills/cloudflare/references/api-shield/api.md +153 -0
- package/skills/cloudflare/references/api-shield/configuration.md +210 -0
- package/skills/cloudflare/references/api-shield/gotchas.md +132 -0
- package/skills/cloudflare/references/api-shield/patterns.md +185 -0
- package/skills/cloudflare/references/argo-smart-routing/README.md +96 -0
- package/skills/cloudflare/references/argo-smart-routing/api.md +253 -0
- package/skills/cloudflare/references/argo-smart-routing/configuration.md +205 -0
- package/skills/cloudflare/references/argo-smart-routing/gotchas.md +115 -0
- package/skills/cloudflare/references/argo-smart-routing/patterns.md +107 -0
- package/skills/cloudflare/references/bindings/README.md +127 -0
- package/skills/cloudflare/references/bindings/api.md +214 -0
- package/skills/cloudflare/references/bindings/configuration.md +200 -0
- package/skills/cloudflare/references/bindings/gotchas.md +210 -0
- package/skills/cloudflare/references/bindings/patterns.md +205 -0
- package/skills/cloudflare/references/bot-management/README.md +95 -0
- package/skills/cloudflare/references/bot-management/api.md +175 -0
- package/skills/cloudflare/references/bot-management/configuration.md +175 -0
- package/skills/cloudflare/references/bot-management/gotchas.md +116 -0
- package/skills/cloudflare/references/bot-management/patterns.md +181 -0
- package/skills/cloudflare/references/browser-rendering/README.md +84 -0
- package/skills/cloudflare/references/browser-rendering/api.md +108 -0
- package/skills/cloudflare/references/browser-rendering/configuration.md +78 -0
- package/skills/cloudflare/references/browser-rendering/gotchas.md +91 -0
- package/skills/cloudflare/references/browser-rendering/patterns.md +93 -0
- package/skills/cloudflare/references/c3/README.md +111 -0
- package/skills/cloudflare/references/c3/api.md +71 -0
- package/skills/cloudflare/references/c3/configuration.md +85 -0
- package/skills/cloudflare/references/c3/gotchas.md +97 -0
- package/skills/cloudflare/references/c3/patterns.md +84 -0
- package/skills/cloudflare/references/cache-reserve/README.md +150 -0
- package/skills/cloudflare/references/cache-reserve/api.md +184 -0
- package/skills/cloudflare/references/cache-reserve/configuration.md +170 -0
- package/skills/cloudflare/references/cache-reserve/gotchas.md +136 -0
- package/skills/cloudflare/references/cache-reserve/patterns.md +197 -0
- package/skills/cloudflare/references/containers/README.md +87 -0
- package/skills/cloudflare/references/containers/api.md +197 -0
- package/skills/cloudflare/references/containers/configuration.md +191 -0
- package/skills/cloudflare/references/containers/gotchas.md +182 -0
- package/skills/cloudflare/references/containers/patterns.md +204 -0
- package/skills/cloudflare/references/cron-triggers/README.md +101 -0
- package/skills/cloudflare/references/cron-triggers/api.md +224 -0
- package/skills/cloudflare/references/cron-triggers/configuration.md +190 -0
- package/skills/cloudflare/references/cron-triggers/gotchas.md +207 -0
- package/skills/cloudflare/references/cron-triggers/patterns.md +274 -0
- package/skills/cloudflare/references/d1/README.md +137 -0
- package/skills/cloudflare/references/d1/api.md +213 -0
- package/skills/cloudflare/references/d1/configuration.md +198 -0
- package/skills/cloudflare/references/d1/gotchas.md +98 -0
- package/skills/cloudflare/references/d1/patterns.md +240 -0
- package/skills/cloudflare/references/ddos/README.md +42 -0
- package/skills/cloudflare/references/ddos/api.md +158 -0
- package/skills/cloudflare/references/ddos/configuration.md +94 -0
- package/skills/cloudflare/references/ddos/gotchas.md +114 -0
- package/skills/cloudflare/references/ddos/patterns.md +220 -0
- package/skills/cloudflare/references/decision-trees.md +95 -0
- package/skills/cloudflare/references/do-storage/README.md +79 -0
- package/skills/cloudflare/references/do-storage/api.md +107 -0
- package/skills/cloudflare/references/do-storage/configuration.md +114 -0
- package/skills/cloudflare/references/do-storage/gotchas.md +153 -0
- package/skills/cloudflare/references/do-storage/patterns.md +210 -0
- package/skills/cloudflare/references/do-storage/testing.md +186 -0
- package/skills/cloudflare/references/durable-objects/README.md +194 -0
- package/skills/cloudflare/references/durable-objects/api.md +205 -0
- package/skills/cloudflare/references/durable-objects/configuration.md +160 -0
- package/skills/cloudflare/references/durable-objects/gotchas.md +200 -0
- package/skills/cloudflare/references/durable-objects/patterns.md +205 -0
- package/skills/cloudflare/references/email-routing/README.md +89 -0
- package/skills/cloudflare/references/email-routing/api.md +192 -0
- package/skills/cloudflare/references/email-routing/configuration.md +187 -0
- package/skills/cloudflare/references/email-routing/gotchas.md +203 -0
- package/skills/cloudflare/references/email-routing/patterns.md +241 -0
- package/skills/cloudflare/references/email-workers/README.md +153 -0
- package/skills/cloudflare/references/email-workers/api.md +227 -0
- package/skills/cloudflare/references/email-workers/configuration.md +115 -0
- package/skills/cloudflare/references/email-workers/gotchas.md +133 -0
- package/skills/cloudflare/references/email-workers/patterns.md +108 -0
- package/skills/cloudflare/references/graphql-api/README.md +147 -0
- package/skills/cloudflare/references/graphql-api/api.md +175 -0
- package/skills/cloudflare/references/graphql-api/configuration.md +151 -0
- package/skills/cloudflare/references/graphql-api/gotchas.md +111 -0
- package/skills/cloudflare/references/graphql-api/patterns.md +276 -0
- package/skills/cloudflare/references/hyperdrive/README.md +84 -0
- package/skills/cloudflare/references/hyperdrive/api.md +149 -0
- package/skills/cloudflare/references/hyperdrive/configuration.md +166 -0
- package/skills/cloudflare/references/hyperdrive/gotchas.md +77 -0
- package/skills/cloudflare/references/hyperdrive/patterns.md +203 -0
- package/skills/cloudflare/references/images/README.md +65 -0
- package/skills/cloudflare/references/images/api.md +101 -0
- package/skills/cloudflare/references/images/configuration.md +206 -0
- package/skills/cloudflare/references/images/gotchas.md +106 -0
- package/skills/cloudflare/references/images/patterns.md +126 -0
- package/skills/cloudflare/references/kv/README.md +90 -0
- package/skills/cloudflare/references/kv/api.md +163 -0
- package/skills/cloudflare/references/kv/configuration.md +148 -0
- package/skills/cloudflare/references/kv/gotchas.md +133 -0
- package/skills/cloudflare/references/kv/patterns.md +195 -0
- package/skills/cloudflare/references/miniflare/README.md +113 -0
- package/skills/cloudflare/references/miniflare/api.md +204 -0
- package/skills/cloudflare/references/miniflare/configuration.md +174 -0
- package/skills/cloudflare/references/miniflare/gotchas.md +179 -0
- package/skills/cloudflare/references/miniflare/patterns.md +187 -0
- package/skills/cloudflare/references/network-interconnect/README.md +104 -0
- package/skills/cloudflare/references/network-interconnect/api.md +220 -0
- package/skills/cloudflare/references/network-interconnect/configuration.md +123 -0
- package/skills/cloudflare/references/network-interconnect/gotchas.md +175 -0
- package/skills/cloudflare/references/network-interconnect/patterns.md +174 -0
- package/skills/cloudflare/references/observability/README.md +93 -0
- package/skills/cloudflare/references/observability/api.md +168 -0
- package/skills/cloudflare/references/observability/configuration.md +178 -0
- package/skills/cloudflare/references/observability/gotchas.md +125 -0
- package/skills/cloudflare/references/observability/patterns.md +105 -0
- package/skills/cloudflare/references/pages/README.md +92 -0
- package/skills/cloudflare/references/pages/api.md +205 -0
- package/skills/cloudflare/references/pages/configuration.md +216 -0
- package/skills/cloudflare/references/pages/gotchas.md +218 -0
- package/skills/cloudflare/references/pages/patterns.md +215 -0
- package/skills/cloudflare/references/pages-functions/README.md +104 -0
- package/skills/cloudflare/references/pages-functions/api.md +159 -0
- package/skills/cloudflare/references/pages-functions/configuration.md +130 -0
- package/skills/cloudflare/references/pages-functions/gotchas.md +102 -0
- package/skills/cloudflare/references/pages-functions/patterns.md +148 -0
- package/skills/cloudflare/references/pipelines/README.md +109 -0
- package/skills/cloudflare/references/pipelines/api.md +214 -0
- package/skills/cloudflare/references/pipelines/configuration.md +98 -0
- package/skills/cloudflare/references/pipelines/gotchas.md +84 -0
- package/skills/cloudflare/references/pipelines/patterns.md +87 -0
- package/skills/cloudflare/references/product-index.md +112 -0
- package/skills/cloudflare/references/pulumi/README.md +113 -0
- package/skills/cloudflare/references/pulumi/api.md +230 -0
- package/skills/cloudflare/references/pulumi/configuration.md +213 -0
- package/skills/cloudflare/references/pulumi/gotchas.md +205 -0
- package/skills/cloudflare/references/pulumi/patterns.md +260 -0
- package/skills/cloudflare/references/queues/README.md +99 -0
- package/skills/cloudflare/references/queues/api.md +211 -0
- package/skills/cloudflare/references/queues/configuration.md +151 -0
- package/skills/cloudflare/references/queues/gotchas.md +210 -0
- package/skills/cloudflare/references/queues/patterns.md +220 -0
- package/skills/cloudflare/references/r2/README.md +97 -0
- package/skills/cloudflare/references/r2/api.md +235 -0
- package/skills/cloudflare/references/r2/configuration.md +176 -0
- package/skills/cloudflare/references/r2/gotchas.md +190 -0
- package/skills/cloudflare/references/r2/patterns.md +203 -0
- package/skills/cloudflare/references/r2-data-catalog/README.md +157 -0
- package/skills/cloudflare/references/r2-data-catalog/api.md +199 -0
- package/skills/cloudflare/references/r2-data-catalog/configuration.md +205 -0
- package/skills/cloudflare/references/r2-data-catalog/gotchas.md +170 -0
- package/skills/cloudflare/references/r2-data-catalog/patterns.md +191 -0
- package/skills/cloudflare/references/r2-sql/README.md +138 -0
- package/skills/cloudflare/references/r2-sql/SKILL.md.backup +512 -0
- package/skills/cloudflare/references/r2-sql/api.md +159 -0
- package/skills/cloudflare/references/r2-sql/configuration.md +152 -0
- package/skills/cloudflare/references/r2-sql/gotchas.md +228 -0
- package/skills/cloudflare/references/r2-sql/patterns.md +230 -0
- package/skills/cloudflare/references/realtime-sfu/README.md +66 -0
- package/skills/cloudflare/references/realtime-sfu/api.md +164 -0
- package/skills/cloudflare/references/realtime-sfu/configuration.md +141 -0
- package/skills/cloudflare/references/realtime-sfu/gotchas.md +138 -0
- package/skills/cloudflare/references/realtime-sfu/patterns.md +187 -0
- package/skills/cloudflare/references/realtimekit/README.md +118 -0
- package/skills/cloudflare/references/realtimekit/api.md +234 -0
- package/skills/cloudflare/references/realtimekit/configuration.md +226 -0
- package/skills/cloudflare/references/realtimekit/gotchas.md +206 -0
- package/skills/cloudflare/references/realtimekit/patterns.md +240 -0
- package/skills/cloudflare/references/sandbox/README.md +104 -0
- package/skills/cloudflare/references/sandbox/api.md +200 -0
- package/skills/cloudflare/references/sandbox/configuration.md +154 -0
- package/skills/cloudflare/references/sandbox/gotchas.md +201 -0
- package/skills/cloudflare/references/sandbox/patterns.md +195 -0
- package/skills/cloudflare/references/secrets-store/README.md +77 -0
- package/skills/cloudflare/references/secrets-store/api.md +199 -0
- package/skills/cloudflare/references/secrets-store/configuration.md +187 -0
- package/skills/cloudflare/references/secrets-store/gotchas.md +97 -0
- package/skills/cloudflare/references/secrets-store/patterns.md +218 -0
- package/skills/cloudflare/references/smart-placement/README.md +143 -0
- package/skills/cloudflare/references/smart-placement/api.md +192 -0
- package/skills/cloudflare/references/smart-placement/configuration.md +202 -0
- package/skills/cloudflare/references/smart-placement/gotchas.md +180 -0
- package/skills/cloudflare/references/smart-placement/patterns.md +190 -0
- package/skills/cloudflare/references/snippets/README.md +74 -0
- package/skills/cloudflare/references/snippets/api.md +214 -0
- package/skills/cloudflare/references/snippets/configuration.md +239 -0
- package/skills/cloudflare/references/snippets/gotchas.md +104 -0
- package/skills/cloudflare/references/snippets/patterns.md +135 -0
- package/skills/cloudflare/references/spectrum/README.md +52 -0
- package/skills/cloudflare/references/spectrum/api.md +184 -0
- package/skills/cloudflare/references/spectrum/configuration.md +203 -0
- package/skills/cloudflare/references/spectrum/gotchas.md +155 -0
- package/skills/cloudflare/references/spectrum/patterns.md +206 -0
- package/skills/cloudflare/references/static-assets/README.md +65 -0
- package/skills/cloudflare/references/static-assets/api.md +201 -0
- package/skills/cloudflare/references/static-assets/configuration.md +186 -0
- package/skills/cloudflare/references/static-assets/gotchas.md +164 -0
- package/skills/cloudflare/references/static-assets/patterns.md +189 -0
- package/skills/cloudflare/references/stream/README.md +123 -0
- package/skills/cloudflare/references/stream/api-live.md +202 -0
- package/skills/cloudflare/references/stream/api.md +206 -0
- package/skills/cloudflare/references/stream/configuration.md +151 -0
- package/skills/cloudflare/references/stream/gotchas.md +139 -0
- package/skills/cloudflare/references/stream/patterns.md +217 -0
- package/skills/cloudflare/references/tail-workers/README.md +92 -0
- package/skills/cloudflare/references/tail-workers/api.md +203 -0
- package/skills/cloudflare/references/tail-workers/configuration.md +178 -0
- package/skills/cloudflare/references/tail-workers/gotchas.md +206 -0
- package/skills/cloudflare/references/tail-workers/patterns.md +190 -0
- package/skills/cloudflare/references/terraform/README.md +100 -0
- package/skills/cloudflare/references/terraform/api.md +178 -0
- package/skills/cloudflare/references/terraform/configuration.md +197 -0
- package/skills/cloudflare/references/terraform/gotchas.md +150 -0
- package/skills/cloudflare/references/terraform/patterns.md +174 -0
- package/skills/cloudflare/references/tunnel/README.md +137 -0
- package/skills/cloudflare/references/tunnel/api.md +205 -0
- package/skills/cloudflare/references/tunnel/configuration.md +163 -0
- package/skills/cloudflare/references/tunnel/gotchas.md +159 -0
- package/skills/cloudflare/references/tunnel/networking.md +174 -0
- package/skills/cloudflare/references/tunnel/patterns.md +199 -0
- package/skills/cloudflare/references/turn/README.md +86 -0
- package/skills/cloudflare/references/turn/api.md +236 -0
- package/skills/cloudflare/references/turn/configuration.md +181 -0
- package/skills/cloudflare/references/turn/gotchas.md +236 -0
- package/skills/cloudflare/references/turn/patterns.md +228 -0
- package/skills/cloudflare/references/turnstile/README.md +102 -0
- package/skills/cloudflare/references/turnstile/api.md +253 -0
- package/skills/cloudflare/references/turnstile/configuration.md +242 -0
- package/skills/cloudflare/references/turnstile/gotchas.md +253 -0
- package/skills/cloudflare/references/turnstile/patterns.md +195 -0
- package/skills/cloudflare/references/vectorize/README.md +133 -0
- package/skills/cloudflare/references/vectorize/api.md +89 -0
- package/skills/cloudflare/references/vectorize/configuration.md +91 -0
- package/skills/cloudflare/references/vectorize/gotchas.md +83 -0
- package/skills/cloudflare/references/vectorize/patterns.md +92 -0
- package/skills/cloudflare/references/waf/README.md +125 -0
- package/skills/cloudflare/references/waf/api.md +203 -0
- package/skills/cloudflare/references/waf/configuration.md +215 -0
- package/skills/cloudflare/references/waf/gotchas.md +208 -0
- package/skills/cloudflare/references/waf/patterns.md +236 -0
- package/skills/cloudflare/references/web-analytics/README.md +149 -0
- package/skills/cloudflare/references/web-analytics/configuration.md +81 -0
- package/skills/cloudflare/references/web-analytics/gotchas.md +86 -0
- package/skills/cloudflare/references/web-analytics/integration.md +63 -0
- package/skills/cloudflare/references/web-analytics/patterns.md +98 -0
- package/skills/cloudflare/references/workerd/README.md +85 -0
- package/skills/cloudflare/references/workerd/api.md +219 -0
- package/skills/cloudflare/references/workerd/configuration.md +200 -0
- package/skills/cloudflare/references/workerd/gotchas.md +151 -0
- package/skills/cloudflare/references/workerd/patterns.md +205 -0
- package/skills/cloudflare/references/workers/README.md +110 -0
- package/skills/cloudflare/references/workers/api.md +197 -0
- package/skills/cloudflare/references/workers/configuration.md +184 -0
- package/skills/cloudflare/references/workers/frameworks.md +200 -0
- package/skills/cloudflare/references/workers/gotchas.md +145 -0
- package/skills/cloudflare/references/workers/patterns.md +220 -0
- package/skills/cloudflare/references/workers-ai/README.md +206 -0
- package/skills/cloudflare/references/workers-ai/api.md +115 -0
- package/skills/cloudflare/references/workers-ai/configuration.md +98 -0
- package/skills/cloudflare/references/workers-ai/gotchas.md +130 -0
- package/skills/cloudflare/references/workers-ai/patterns.md +122 -0
- package/skills/cloudflare/references/workers-for-platforms/README.md +95 -0
- package/skills/cloudflare/references/workers-for-platforms/api.md +212 -0
- package/skills/cloudflare/references/workers-for-platforms/configuration.md +178 -0
- package/skills/cloudflare/references/workers-for-platforms/gotchas.md +134 -0
- package/skills/cloudflare/references/workers-for-platforms/patterns.md +210 -0
- package/skills/cloudflare/references/workers-playground/README.md +131 -0
- package/skills/cloudflare/references/workers-playground/api.md +101 -0
- package/skills/cloudflare/references/workers-playground/configuration.md +169 -0
- package/skills/cloudflare/references/workers-playground/gotchas.md +88 -0
- package/skills/cloudflare/references/workers-playground/patterns.md +134 -0
- package/skills/cloudflare/references/workers-vpc/README.md +130 -0
- package/skills/cloudflare/references/workers-vpc/api.md +196 -0
- package/skills/cloudflare/references/workers-vpc/configuration.md +151 -0
- package/skills/cloudflare/references/workers-vpc/gotchas.md +171 -0
- package/skills/cloudflare/references/workers-vpc/patterns.md +235 -0
- package/skills/cloudflare/references/workflows/README.md +72 -0
- package/skills/cloudflare/references/workflows/api.md +237 -0
- package/skills/cloudflare/references/workflows/configuration.md +158 -0
- package/skills/cloudflare/references/workflows/gotchas.md +97 -0
- package/skills/cloudflare/references/workflows/patterns.md +245 -0
- package/skills/cloudflare/references/wrangler/README.md +143 -0
- package/skills/cloudflare/references/wrangler/api.md +188 -0
- package/skills/cloudflare/references/wrangler/configuration.md +198 -0
- package/skills/cloudflare/references/wrangler/gotchas.md +212 -0
- package/skills/cloudflare/references/wrangler/patterns.md +211 -0
- package/skills/cloudflare/references/zaraz/IMPLEMENTATION_SUMMARY.md +131 -0
- package/skills/cloudflare/references/zaraz/README.md +114 -0
- package/skills/cloudflare/references/zaraz/api.md +118 -0
- package/skills/cloudflare/references/zaraz/configuration.md +94 -0
- package/skills/cloudflare/references/zaraz/gotchas.md +88 -0
- package/skills/cloudflare/references/zaraz/patterns.md +77 -0
- package/skills/docker/SKILL.md +7 -101
- package/skills/docker/references/advanced-examples.md +71 -0
- package/skills/docker/references/templates.md +34 -0
- package/skills/docs-marketer/SKILL.md +178 -0
- package/skills/docs-marketer/references/audit-categories.md +328 -0
- package/skills/docs-marketer/references/copilot-docs-prompts.md +88 -0
- package/skills/docs-marketer/references/copilot-usage.md +16 -0
- package/skills/docs-marketer/references/feedback-loop.md +155 -0
- package/skills/docs-marketer/references/multi-pass-docs-protocol.md +410 -0
- package/skills/drizzle-orm/SKILL.md +82 -0
- package/skills/durable-objects/SKILL.md +167 -0
- package/skills/durable-objects/references/advanced_features.md +29 -0
- package/skills/durable-objects/references/rules.md +300 -0
- package/skills/durable-objects/references/testing.md +261 -0
- package/skills/durable-objects/references/workers.md +336 -0
- package/skills/gcp/SKILL.md +37 -0
- package/skills/github-actions/SKILL.md +5 -58
- package/skills/github-actions/references/templates.md +65 -0
- package/skills/github-commander/SKILL.md +13 -21
- package/skills/github-commander/workflows/copilot-audit.md +12 -12
- package/skills/github-copilot-cli/SKILL.md +21 -26
- package/skills/github-repo-setup/SKILL.md +136 -0
- package/skills/github-repo-setup/references/community-standards.md +136 -0
- package/skills/github-repo-setup/references/github-automation.md +490 -0
- package/skills/github-repo-setup/references/inline-templates.md +205 -0
- package/skills/github-repo-setup/references/project-config.md +320 -0
- package/skills/gitlab/SKILL.md +7 -2
- package/skills/gitlab/package-lock.json +389 -389
- package/skills/golang/SKILL.md +8 -1
- package/skills/graphql/SKILL.md +30 -0
- package/skills/hono/SKILL.md +82 -0
- package/skills/journal-optimizer/SKILL.md +206 -0
- package/skills/journal-optimizer/references/optimizer-scripts.md +169 -0
- package/skills/llm-app-engineering/SKILL.md +18 -0
- package/skills/monorepo/SKILL.md +56 -0
- package/skills/multi-agent-orchestration/SKILL.md +14 -0
- package/skills/mysql/SKILL.md +6 -2
- package/skills/next-best-practices/SKILL.md +86 -0
- package/skills/next-best-practices/references/cache-components-examples.md +234 -0
- package/skills/next-best-practices/references/cache-components.md +210 -0
- package/skills/next-best-practices/references/upgrade-decision-tree.md +33 -0
- package/skills/next-best-practices/references/upgrade.md +43 -0
- package/skills/next-cache-components/SKILL.md +441 -0
- package/skills/next-upgrade/SKILL.md +43 -0
- package/skills/next-upgrade/references/decision-tree.md +33 -0
- package/skills/nodejs/SKILL.md +46 -0
- package/skills/opentelemetry/SKILL.md +62 -0
- package/skills/package.json +39 -4
- package/skills/playwright-standard/SKILL.md +6 -11
- package/skills/playwright-standard/references/locators.md +7 -0
- package/skills/postgres/SKILL.md +6 -1
- package/skills/python/SKILL.md +8 -70
- package/skills/python/references/advanced-patterns.md +37 -0
- package/skills/python/references/config-templates.md +48 -0
- package/skills/rag-pipelines/SKILL.md +14 -0
- package/skills/redis/SKILL.md +31 -0
- package/skills/render/SKILL.md +35 -0
- package/skills/rust/SKILL.md +15 -25
- package/skills/rust/references/borrow-checker.md +13 -0
- package/skills/rust/references/ecosystem.md +11 -0
- package/skills/sandbox-sdk/SKILL.md +186 -0
- package/skills/sandbox-sdk/references/api-quick-ref.md +113 -0
- package/skills/sandbox-sdk/references/examples.md +52 -0
- package/skills/shadcn-ui/SKILL.md +22 -57
- package/skills/skill-builder/SKILL.md +23 -424
- package/skills/skill-builder/references/tutorial.md +457 -0
- package/skills/sqlite/SKILL.md +16 -5
- package/skills/table.md +59 -0
- package/skills/tailwind-css/SKILL.md +11 -60
- package/skills/tailwind-css/references/component-patterns.md +52 -0
- package/skills/trpc/SKILL.md +56 -0
- package/skills/typescript/SKILL.md +30 -433
- package/skills/typescript/references/tutorial.md +453 -0
- package/skills/vercel-ai-sdk/SKILL.md +48 -0
- package/skills/vitest-standard/SKILL.md +5 -11
- package/skills/vitest-standard/references/assertions.md +11 -0
- package/skills/web-perf/SKILL.md +207 -0
- package/skills/workers-best-practices/SKILL.md +120 -0
- package/skills/workers-best-practices/references/anti-patterns.md +18 -0
- package/skills/workers-best-practices/references/review.md +174 -0
- package/skills/workers-best-practices/references/rules.md +485 -0
- package/skills/wrangler/SKILL.md +43 -0
- package/skills/wrangler/references/cli-commands.md +861 -0
- package/skills/zod/SKILL.md +48 -0
- package/dist/tools-P4VGG4FH.js +0 -1
- package/skills/react-best-practices/AGENTS.md +0 -2883
- package/skills/react-best-practices/SKILL.md +0 -138
- /package/skills/{react-best-practices → next-best-practices}/README.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/metadata.json +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/_sections.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/_template.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/advanced-event-handler-refs.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/advanced-init-once.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/advanced-use-latest.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/async-api-routes.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/async-defer-await.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/async-dependencies.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/async-parallel.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/async-suspense-boundaries.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/bundle-barrel-imports.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/bundle-conditional.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/bundle-defer-third-party.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/bundle-dynamic-imports.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/bundle-preload.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/client-event-listeners.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/client-localstorage-schema.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/client-passive-event-listeners.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/client-swr-dedup.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/js-batch-dom-css.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/js-cache-function-results.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/js-cache-property-access.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/js-cache-storage.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/js-combine-iterations.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/js-early-exit.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/js-hoist-regexp.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/js-index-maps.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/js-length-check-first.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/js-min-max-loop.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/js-set-map-lookups.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/js-tosorted-immutable.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rendering-activity.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rendering-animate-svg-wrapper.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rendering-conditional-render.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rendering-content-visibility.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rendering-hoist-jsx.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rendering-hydration-no-flicker.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rendering-hydration-suppress-warning.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rendering-svg-precision.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rendering-usetransition-loading.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rerender-defer-reads.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rerender-dependencies.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rerender-derived-state-no-effect.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rerender-derived-state.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rerender-functional-setstate.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rerender-lazy-state-init.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rerender-memo-with-default-value.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rerender-memo.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rerender-move-effect-to-event.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rerender-simple-expression-in-memo.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rerender-transitions.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/rerender-use-ref-transient-values.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/server-after-nonblocking.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/server-auth-actions.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/server-cache-lru.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/server-cache-react.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/server-dedup-props.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/server-parallel-fetching.md +0 -0
- /package/skills/{react-best-practices → next-best-practices}/rules/server-serialization.md +0 -0
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
# Gotchas
|
|
2
|
+
|
|
3
|
+
## Common Errors
|
|
4
|
+
|
|
5
|
+
### ".get() Throws on Error"
|
|
6
|
+
|
|
7
|
+
**Cause:** Assuming `.get()` returns null on failure instead of throwing
|
|
8
|
+
**Solution:** Always wrap `.get()` calls in try/catch blocks to handle errors gracefully
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
try {
|
|
12
|
+
const key = await env.API_KEY.get()
|
|
13
|
+
} catch (error) {
|
|
14
|
+
return new Response('Configuration error', { status: 500 })
|
|
15
|
+
}
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### "Logging Secret Values"
|
|
19
|
+
|
|
20
|
+
**Cause:** Accidentally logging secret values in console or error messages
|
|
21
|
+
**Solution:** Only log metadata (e.g., "Retrieved API_KEY") never the actual secret value
|
|
22
|
+
|
|
23
|
+
### "Module-Level Secret Access"
|
|
24
|
+
|
|
25
|
+
**Cause:** Attempting to access secrets during module initialization before env is available
|
|
26
|
+
**Solution:** Cache secrets in request scope only, not at module level
|
|
27
|
+
|
|
28
|
+
### "Secret not found in store"
|
|
29
|
+
|
|
30
|
+
**Cause:** Secret name doesn't exist, case mismatch, missing workers scope, or incorrect store_id
|
|
31
|
+
**Solution:** Verify secret exists with `wrangler secrets-store secret list <store-id> --remote`, check name matches exactly (case-sensitive), ensure secret has `workers` scope, and verify correct store_id
|
|
32
|
+
|
|
33
|
+
### "Scope Mismatch"
|
|
34
|
+
|
|
35
|
+
**Cause:** Secret exists but missing `workers` scope (only has `ai-gateway` scope)
|
|
36
|
+
**Solution:** Update secret scopes: `wrangler secrets-store secret update <store-id> --name SECRET --scopes workers --remote` or add via Dashboard
|
|
37
|
+
|
|
38
|
+
### "JSON Parsing Failure"
|
|
39
|
+
|
|
40
|
+
**Cause:** Storing invalid JSON in secret, then failing to parse during runtime
|
|
41
|
+
**Solution:** Validate JSON before storing:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
# Validate before storing
|
|
45
|
+
echo '{"key":"value"}' | jq . && \
|
|
46
|
+
echo '{"key":"value"}' | wrangler secrets-store secret create <store-id> \
|
|
47
|
+
--name CONFIG --scopes workers --remote
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Runtime parsing with error handling:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
try {
|
|
54
|
+
const configStr = await env.CONFIG.get()
|
|
55
|
+
const config = JSON.parse(configStr)
|
|
56
|
+
} catch (error) {
|
|
57
|
+
console.error('Invalid config JSON:', error)
|
|
58
|
+
return new Response('Invalid configuration', { status: 500 })
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### "Cannot access secret in local dev"
|
|
63
|
+
|
|
64
|
+
**Cause:** Attempting to access production secrets in local development environment
|
|
65
|
+
**Solution:** Create local-only secrets (without `--remote` flag) for development: `wrangler secrets-store secret create <store-id> --name API_KEY --scopes workers`
|
|
66
|
+
|
|
67
|
+
### "Property 'get' does not exist"
|
|
68
|
+
|
|
69
|
+
**Cause:** Missing TypeScript type definition for secret binding
|
|
70
|
+
**Solution:** Define interface with get method: `interface Env { API_KEY: { get(): Promise<string> }; }`
|
|
71
|
+
|
|
72
|
+
### "Binding already exists"
|
|
73
|
+
|
|
74
|
+
**Cause:** Duplicate binding in dashboard or conflict between wrangler.jsonc and dashboard
|
|
75
|
+
**Solution:** Remove duplicate from dashboard Settings → Bindings, check for conflicts, or delete old Worker secret with `wrangler secret delete API_KEY`
|
|
76
|
+
|
|
77
|
+
### "Account secret quota exceeded"
|
|
78
|
+
|
|
79
|
+
**Cause:** Account has reached 100 secret limit (beta)
|
|
80
|
+
**Solution:** Check quota with `wrangler secrets-store quota --remote`, delete unused secrets, consolidate duplicates, or contact Cloudflare for increase
|
|
81
|
+
|
|
82
|
+
## Limits
|
|
83
|
+
|
|
84
|
+
| Limit | Value | Notes |
|
|
85
|
+
| ----------------------- | --------------------------- | ------------------------------------- |
|
|
86
|
+
| Max secrets per account | 100 | Beta limit |
|
|
87
|
+
| Max stores per account | 1 | Beta limit |
|
|
88
|
+
| Max secret size | 1024 bytes | Per secret |
|
|
89
|
+
| Local secrets | Don't count toward limit | Only production secrets count |
|
|
90
|
+
| Scopes available | `workers`, `ai-gateway` | Must have correct scope for access |
|
|
91
|
+
| Scope | Account-level | Can be reused across multiple Workers |
|
|
92
|
+
| Access method | `await env.BINDING.get()` | Async only, throws on error |
|
|
93
|
+
| Management | Centralized | Via secrets-store commands |
|
|
94
|
+
| Local dev | Separate local secrets | Use without `--remote` flag |
|
|
95
|
+
| Regional availability | Global except China Network | Unavailable in China Network |
|
|
96
|
+
|
|
97
|
+
See: [configuration.md](./configuration.md), [api.md](./api.md), [patterns.md](./patterns.md)
|
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
# Patterns
|
|
2
|
+
|
|
3
|
+
## Secret Rotation
|
|
4
|
+
|
|
5
|
+
Zero-downtime rotation with versioned naming (`api_key_v1`, `api_key_v2`):
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
interface Env {
|
|
9
|
+
PRIMARY_KEY: { get(): Promise<string> }
|
|
10
|
+
FALLBACK_KEY?: { get(): Promise<string> }
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
async function fetchWithAuth(url: string, key: string) {
|
|
14
|
+
return fetch(url, { headers: { Authorization: `Bearer ${key}` } })
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export default {
|
|
18
|
+
async fetch(request: Request, env: Env): Promise<Response> {
|
|
19
|
+
let resp = await fetchWithAuth('https://api.example.com', await env.PRIMARY_KEY.get())
|
|
20
|
+
|
|
21
|
+
// Fallback during rotation
|
|
22
|
+
if (!resp.ok && env.FALLBACK_KEY) {
|
|
23
|
+
resp = await fetchWithAuth('https://api.example.com', await env.FALLBACK_KEY.get())
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
return resp
|
|
27
|
+
},
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Workflow: Create `api_key_v2` → add fallback binding → deploy → swap primary → deploy → remove `v1`
|
|
32
|
+
|
|
33
|
+
## Encryption with KV
|
|
34
|
+
|
|
35
|
+
```typescript
|
|
36
|
+
interface Env {
|
|
37
|
+
CACHE: KVNamespace
|
|
38
|
+
ENCRYPTION_KEY: { get(): Promise<string> }
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
async function encryptValue(value: string, key: string): Promise<string> {
|
|
42
|
+
const enc = new TextEncoder()
|
|
43
|
+
const keyMaterial = await crypto.subtle.importKey(
|
|
44
|
+
'raw',
|
|
45
|
+
enc.encode(key),
|
|
46
|
+
{ name: 'AES-GCM' },
|
|
47
|
+
false,
|
|
48
|
+
['encrypt']
|
|
49
|
+
)
|
|
50
|
+
const iv = crypto.getRandomValues(new Uint8Array(12))
|
|
51
|
+
const encrypted = await crypto.subtle.encrypt(
|
|
52
|
+
{ name: 'AES-GCM', iv },
|
|
53
|
+
keyMaterial,
|
|
54
|
+
enc.encode(value)
|
|
55
|
+
)
|
|
56
|
+
|
|
57
|
+
const combined = new Uint8Array(iv.length + encrypted.byteLength)
|
|
58
|
+
combined.set(iv)
|
|
59
|
+
combined.set(new Uint8Array(encrypted), iv.length)
|
|
60
|
+
return btoa(String.fromCharCode(...combined))
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export default {
|
|
64
|
+
async fetch(request: Request, env: Env): Promise<Response> {
|
|
65
|
+
const key = await env.ENCRYPTION_KEY.get()
|
|
66
|
+
const encrypted = await encryptValue('sensitive-data', key)
|
|
67
|
+
await env.CACHE.put('user:123:data', encrypted)
|
|
68
|
+
return Response.json({ ok: true })
|
|
69
|
+
},
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## HMAC Signing
|
|
74
|
+
|
|
75
|
+
```typescript
|
|
76
|
+
interface Env {
|
|
77
|
+
HMAC_SECRET: { get(): Promise<string> }
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
async function signRequest(data: string, secret: string): Promise<string> {
|
|
81
|
+
const enc = new TextEncoder()
|
|
82
|
+
const key = await crypto.subtle.importKey(
|
|
83
|
+
'raw',
|
|
84
|
+
enc.encode(secret),
|
|
85
|
+
{ name: 'HMAC', hash: 'SHA-256' },
|
|
86
|
+
false,
|
|
87
|
+
['sign']
|
|
88
|
+
)
|
|
89
|
+
const sig = await crypto.subtle.sign('HMAC', key, enc.encode(data))
|
|
90
|
+
return btoa(String.fromCharCode(...new Uint8Array(sig)))
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
export default {
|
|
94
|
+
async fetch(request: Request, env: Env): Promise<Response> {
|
|
95
|
+
const secret = await env.HMAC_SECRET.get()
|
|
96
|
+
const payload = await request.text()
|
|
97
|
+
const signature = await signRequest(payload, secret)
|
|
98
|
+
return Response.json({ signature })
|
|
99
|
+
},
|
|
100
|
+
}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Audit & Monitoring
|
|
104
|
+
|
|
105
|
+
```typescript
|
|
106
|
+
export default {
|
|
107
|
+
async fetch(request: Request, env: Env, ctx: ExecutionContext) {
|
|
108
|
+
const startTime = Date.now()
|
|
109
|
+
try {
|
|
110
|
+
const apiKey = await env.API_KEY.get()
|
|
111
|
+
const resp = await fetch('https://api.example.com', {
|
|
112
|
+
headers: { Authorization: `Bearer ${apiKey}` },
|
|
113
|
+
})
|
|
114
|
+
|
|
115
|
+
ctx.waitUntil(
|
|
116
|
+
fetch('https://log.example.com/log', {
|
|
117
|
+
method: 'POST',
|
|
118
|
+
body: JSON.stringify({
|
|
119
|
+
event: 'secret_used',
|
|
120
|
+
secret_name: 'API_KEY',
|
|
121
|
+
timestamp: new Date().toISOString(),
|
|
122
|
+
duration_ms: Date.now() - startTime,
|
|
123
|
+
success: resp.ok,
|
|
124
|
+
}),
|
|
125
|
+
})
|
|
126
|
+
)
|
|
127
|
+
return resp
|
|
128
|
+
} catch (error) {
|
|
129
|
+
ctx.waitUntil(
|
|
130
|
+
fetch('https://log.example.com/log', {
|
|
131
|
+
method: 'POST',
|
|
132
|
+
body: JSON.stringify({
|
|
133
|
+
event: 'secret_access_failed',
|
|
134
|
+
secret_name: 'API_KEY',
|
|
135
|
+
error: error instanceof Error ? error.message : 'Unknown',
|
|
136
|
+
}),
|
|
137
|
+
})
|
|
138
|
+
)
|
|
139
|
+
return new Response('Error', { status: 500 })
|
|
140
|
+
}
|
|
141
|
+
},
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## Migration from Worker Secrets
|
|
146
|
+
|
|
147
|
+
Change `env.SECRET` (direct) to `await env.SECRET.get()` (async).
|
|
148
|
+
|
|
149
|
+
Steps:
|
|
150
|
+
|
|
151
|
+
1. Create in Secrets Store: `wrangler secrets-store secret create <store-id> --name API_KEY --scopes workers --remote`
|
|
152
|
+
2. Add binding to `wrangler.jsonc`: `{"binding": "API_KEY", "store_id": "abc123", "secret_name": "api_key"}`
|
|
153
|
+
3. Update code: `const key = await env.API_KEY.get();`
|
|
154
|
+
4. Test staging, deploy
|
|
155
|
+
5. Remove old: `wrangler secret delete API_KEY`
|
|
156
|
+
|
|
157
|
+
## Sharing Across Workers
|
|
158
|
+
|
|
159
|
+
Same secret, different binding names:
|
|
160
|
+
|
|
161
|
+
```jsonc
|
|
162
|
+
// worker-1: binding="SHARED_DB", secret_name="postgres_url"
|
|
163
|
+
// worker-2: binding="DB_CONN", secret_name="postgres_url"
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
## JSON Secret Parsing
|
|
167
|
+
|
|
168
|
+
Store structured config as JSON secrets:
|
|
169
|
+
|
|
170
|
+
```typescript
|
|
171
|
+
interface Env {
|
|
172
|
+
DB_CONFIG: { get(): Promise<string> }
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
interface DbConfig {
|
|
176
|
+
host: string
|
|
177
|
+
port: number
|
|
178
|
+
username: string
|
|
179
|
+
password: string
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
export default {
|
|
183
|
+
async fetch(request: Request, env: Env): Promise<Response> {
|
|
184
|
+
try {
|
|
185
|
+
const configStr = await env.DB_CONFIG.get()
|
|
186
|
+
const config: DbConfig = JSON.parse(configStr)
|
|
187
|
+
|
|
188
|
+
// Use parsed config
|
|
189
|
+
const dbUrl = `postgres://${config.username}:${config.password}@${config.host}:${config.port}`
|
|
190
|
+
|
|
191
|
+
return Response.json({ connected: true })
|
|
192
|
+
} catch (error) {
|
|
193
|
+
if (error instanceof SyntaxError) {
|
|
194
|
+
return new Response('Invalid config JSON', { status: 500 })
|
|
195
|
+
}
|
|
196
|
+
throw error
|
|
197
|
+
}
|
|
198
|
+
},
|
|
199
|
+
}
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
Store JSON secret:
|
|
203
|
+
|
|
204
|
+
```bash
|
|
205
|
+
echo '{"host":"db.example.com","port":5432,"username":"app","password":"secret"}' | \
|
|
206
|
+
wrangler secrets-store secret create <store-id> \
|
|
207
|
+
--name DB_CONFIG --scopes workers --remote
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
## Integration
|
|
211
|
+
|
|
212
|
+
### Service Bindings
|
|
213
|
+
|
|
214
|
+
Auth Worker signs JWT with Secrets Store; API Worker verifies via service binding.
|
|
215
|
+
|
|
216
|
+
See: [workers](../workers/) for service binding patterns.
|
|
217
|
+
|
|
218
|
+
See: [api.md](./api.md), [gotchas.md](./gotchas.md)
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
# Cloudflare Workers Smart Placement
|
|
2
|
+
|
|
3
|
+
Automatic workload placement optimization to minimize latency by running Workers closer to backend infrastructure rather than end users.
|
|
4
|
+
|
|
5
|
+
## Core Concept
|
|
6
|
+
|
|
7
|
+
Smart Placement automatically analyzes Worker request duration across Cloudflare's global network and intelligently routes requests to optimal data center locations. Instead of defaulting to the location closest to the end user, Smart Placement can forward requests to locations closer to backend infrastructure when this reduces overall request duration.
|
|
8
|
+
|
|
9
|
+
### When to Use
|
|
10
|
+
|
|
11
|
+
**Enable Smart Placement when:**
|
|
12
|
+
|
|
13
|
+
- Worker makes multiple round trips to backend services/databases
|
|
14
|
+
- Backend infrastructure is geographically concentrated
|
|
15
|
+
- Request duration dominated by backend latency rather than network latency from user
|
|
16
|
+
- Running backend logic in Workers (APIs, data aggregation, SSR with DB calls)
|
|
17
|
+
- Worker uses `fetch` handler (not RPC methods)
|
|
18
|
+
|
|
19
|
+
**Do NOT enable for:**
|
|
20
|
+
|
|
21
|
+
- Workers serving only static content or cached responses
|
|
22
|
+
- Workers without significant backend communication
|
|
23
|
+
- Pure edge logic (auth checks, redirects, simple transformations)
|
|
24
|
+
- Workers without fetch event handlers
|
|
25
|
+
- Workers with RPC methods or named entrypoints (only `fetch` handlers are affected)
|
|
26
|
+
- Pages/Assets Workers with `run_worker_first = true` (degrades asset serving)
|
|
27
|
+
|
|
28
|
+
### Decision Tree
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
Does your Worker have a fetch handler?
|
|
32
|
+
├─ No → Smart Placement won't work (skip)
|
|
33
|
+
└─ Yes
|
|
34
|
+
│
|
|
35
|
+
Does it make multiple backend calls (DB/API)?
|
|
36
|
+
├─ No → Don't enable (won't help)
|
|
37
|
+
└─ Yes
|
|
38
|
+
│
|
|
39
|
+
Is backend geographically concentrated?
|
|
40
|
+
├─ No (globally distributed) → Probably won't help
|
|
41
|
+
└─ Yes or uncertain
|
|
42
|
+
│
|
|
43
|
+
Does it serve static assets with run_worker_first=true?
|
|
44
|
+
├─ Yes → Don't enable (will hurt performance)
|
|
45
|
+
└─ No → Enable Smart Placement
|
|
46
|
+
│
|
|
47
|
+
After 15min, check placement_status
|
|
48
|
+
├─ SUCCESS → Monitor metrics
|
|
49
|
+
├─ INSUFFICIENT_INVOCATIONS → Need more traffic
|
|
50
|
+
└─ UNSUPPORTED_APPLICATION → Disable (hurting performance)
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Key Architecture Pattern
|
|
54
|
+
|
|
55
|
+
**Recommended:** Split full-stack applications into separate Workers:
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
User → Frontend Worker (at edge, close to user)
|
|
59
|
+
↓ Service Binding
|
|
60
|
+
Backend Worker (Smart Placement enabled, close to DB/API)
|
|
61
|
+
↓
|
|
62
|
+
Database/Backend Service
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
This maintains fast, reactive frontends while optimizing backend latency.
|
|
66
|
+
|
|
67
|
+
## Quick Start
|
|
68
|
+
|
|
69
|
+
```jsonc
|
|
70
|
+
// wrangler.jsonc
|
|
71
|
+
{
|
|
72
|
+
"placement": {
|
|
73
|
+
"mode": "smart", // or "off" to explicitly disable
|
|
74
|
+
},
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Deploy and wait 15 minutes for analysis. Check status via API or dashboard metrics.
|
|
79
|
+
|
|
80
|
+
**To disable:** Set `"mode": "off"` or remove `placement` field entirely (both equivalent).
|
|
81
|
+
|
|
82
|
+
## Requirements
|
|
83
|
+
|
|
84
|
+
- Wrangler 2.20.0+
|
|
85
|
+
- Analysis time: Up to 15 minutes after enabling
|
|
86
|
+
- Traffic requirements: Consistent traffic from multiple global locations
|
|
87
|
+
- Available on all Workers plans (Free, Paid, Enterprise)
|
|
88
|
+
|
|
89
|
+
## Placement Status Values
|
|
90
|
+
|
|
91
|
+
```typescript
|
|
92
|
+
type PlacementStatus =
|
|
93
|
+
| undefined // Not yet analyzed
|
|
94
|
+
| 'SUCCESS' // Successfully optimized
|
|
95
|
+
| 'INSUFFICIENT_INVOCATIONS' // Not enough traffic
|
|
96
|
+
| 'UNSUPPORTED_APPLICATION' // Made Worker slower (reverted)
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## CLI Commands
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
# Deploy with Smart Placement
|
|
103
|
+
wrangler deploy
|
|
104
|
+
|
|
105
|
+
# Check placement status
|
|
106
|
+
curl -H "Authorization: Bearer $TOKEN" \
|
|
107
|
+
https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/workers/services/$WORKER_NAME \
|
|
108
|
+
| jq .result.placement_status
|
|
109
|
+
|
|
110
|
+
# Monitor
|
|
111
|
+
wrangler tail your-worker-name --header cf-placement
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## Reading Order
|
|
115
|
+
|
|
116
|
+
**First time?** Start here:
|
|
117
|
+
|
|
118
|
+
1. This README - understand core concepts and when to use Smart Placement
|
|
119
|
+
2. [configuration.md](./configuration.md) - set up wrangler.jsonc and understand limitations
|
|
120
|
+
3. [patterns.md](./patterns.md) - see practical examples for your use case
|
|
121
|
+
4. [api.md](./api.md) - monitor and verify Smart Placement is working
|
|
122
|
+
5. [gotchas.md](./gotchas.md) - troubleshoot common issues
|
|
123
|
+
|
|
124
|
+
**Quick lookup:**
|
|
125
|
+
|
|
126
|
+
- "Should I enable Smart Placement?" → See "When to Use" above
|
|
127
|
+
- "How do I configure it?" → [configuration.md](./configuration.md)
|
|
128
|
+
- "How do I split frontend/backend?" → [patterns.md](./patterns.md)
|
|
129
|
+
- "Why isn't it working?" → [gotchas.md](./gotchas.md)
|
|
130
|
+
|
|
131
|
+
## In This Reference
|
|
132
|
+
|
|
133
|
+
- [configuration.md](./configuration.md) - wrangler.jsonc setup, mode values, validation rules
|
|
134
|
+
- [api.md](./api.md) - Placement Status API, cf-placement header, monitoring
|
|
135
|
+
- [patterns.md](./patterns.md) - Frontend/backend split, database workers, SSR patterns
|
|
136
|
+
- [gotchas.md](./gotchas.md) - Troubleshooting INSUFFICIENT_INVOCATIONS, performance issues
|
|
137
|
+
|
|
138
|
+
## See Also
|
|
139
|
+
|
|
140
|
+
- [workers](../workers/) - Worker runtime and fetch handlers
|
|
141
|
+
- [d1](../d1/) - D1 database that benefits from Smart Placement
|
|
142
|
+
- [durable-objects](../durable-objects/) - Durable Objects with backend logic
|
|
143
|
+
- [bindings](../bindings/) - Service bindings for frontend/backend split
|
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
# Smart Placement API
|
|
2
|
+
|
|
3
|
+
## Placement Status API
|
|
4
|
+
|
|
5
|
+
Query Worker placement status via Cloudflare API:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
curl -X GET "https://api.cloudflare.com/client/v4/accounts/{ACCOUNT_ID}/workers/services/{WORKER_NAME}" \
|
|
9
|
+
-H "Authorization: Bearer <TOKEN>" \
|
|
10
|
+
-H "Content-Type: application/json"
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Response includes `placement_status` field:
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
type PlacementStatus =
|
|
17
|
+
| undefined // Not yet analyzed
|
|
18
|
+
| 'SUCCESS' // Successfully optimized
|
|
19
|
+
| 'INSUFFICIENT_INVOCATIONS' // Not enough traffic
|
|
20
|
+
| 'UNSUPPORTED_APPLICATION' // Made Worker slower (reverted)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Status Meanings
|
|
24
|
+
|
|
25
|
+
**`undefined` (not present)**
|
|
26
|
+
|
|
27
|
+
- Worker not yet analyzed
|
|
28
|
+
- Always runs at default edge location closest to user
|
|
29
|
+
|
|
30
|
+
**`SUCCESS`**
|
|
31
|
+
|
|
32
|
+
- Analysis complete, Smart Placement active
|
|
33
|
+
- Worker runs in optimal location (may be edge or remote)
|
|
34
|
+
|
|
35
|
+
**`INSUFFICIENT_INVOCATIONS`**
|
|
36
|
+
|
|
37
|
+
- Not enough requests to make placement decision
|
|
38
|
+
- Requires consistent multi-region traffic
|
|
39
|
+
- Always runs at default edge location
|
|
40
|
+
|
|
41
|
+
**`UNSUPPORTED_APPLICATION`** (rare, <1% of Workers)
|
|
42
|
+
|
|
43
|
+
- Smart Placement made Worker slower
|
|
44
|
+
- Placement decision reverted
|
|
45
|
+
- Always runs at edge location
|
|
46
|
+
- Won't be re-analyzed until redeployed
|
|
47
|
+
|
|
48
|
+
## cf-placement Header (Beta)
|
|
49
|
+
|
|
50
|
+
Smart Placement adds response header indicating routing decision:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
// Remote placement (Smart Placement routed request)
|
|
54
|
+
'cf-placement: remote-LHR' // Routed to London
|
|
55
|
+
|
|
56
|
+
// Local placement (default edge routing)
|
|
57
|
+
'cf-placement: local-EWR' // Stayed at Newark edge
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Format: `{placement-type}-{IATA-code}`
|
|
61
|
+
|
|
62
|
+
- `remote-*` = Smart Placement routed to remote location
|
|
63
|
+
- `local-*` = Stayed at default edge location
|
|
64
|
+
- IATA code = nearest airport to data center
|
|
65
|
+
|
|
66
|
+
**Warning:** Beta feature, may be removed before GA.
|
|
67
|
+
|
|
68
|
+
## Detecting Smart Placement in Code
|
|
69
|
+
|
|
70
|
+
**Note:** `cf-placement` header is a beta feature and may change or be removed.
|
|
71
|
+
|
|
72
|
+
```typescript
|
|
73
|
+
export default {
|
|
74
|
+
async fetch(request: Request, env: Env): Promise<Response> {
|
|
75
|
+
const placementHeader = request.headers.get('cf-placement')
|
|
76
|
+
|
|
77
|
+
if (placementHeader?.startsWith('remote-')) {
|
|
78
|
+
const location = placementHeader.split('-')[1]
|
|
79
|
+
console.log(`Smart Placement routed to ${location}`)
|
|
80
|
+
} else if (placementHeader?.startsWith('local-')) {
|
|
81
|
+
const location = placementHeader.split('-')[1]
|
|
82
|
+
console.log(`Running at edge location ${location}`)
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
return new Response('OK')
|
|
86
|
+
},
|
|
87
|
+
} satisfies ExportedHandler<Env>
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Request Duration Metrics
|
|
91
|
+
|
|
92
|
+
Available in Cloudflare dashboard when Smart Placement enabled:
|
|
93
|
+
|
|
94
|
+
**Workers & Pages → [Your Worker] → Metrics → Request Duration**
|
|
95
|
+
|
|
96
|
+
Shows histogram comparing:
|
|
97
|
+
|
|
98
|
+
- Request duration WITH Smart Placement (99% of traffic)
|
|
99
|
+
- Request duration WITHOUT Smart Placement (1% baseline)
|
|
100
|
+
|
|
101
|
+
**Request Duration vs Execution Duration:**
|
|
102
|
+
|
|
103
|
+
- **Request duration:** Total time from request arrival to response delivery (includes network latency)
|
|
104
|
+
- **Execution duration:** Time Worker code actively executing (excludes network waits)
|
|
105
|
+
|
|
106
|
+
Use request duration to measure Smart Placement impact.
|
|
107
|
+
|
|
108
|
+
### Interpreting Metrics
|
|
109
|
+
|
|
110
|
+
| Metric Comparison | Interpretation | Action |
|
|
111
|
+
| ----------------- | ----------------------- | ------------------------------------ |
|
|
112
|
+
| WITH < WITHOUT | Smart Placement helping | Keep enabled |
|
|
113
|
+
| WITH ≈ WITHOUT | Neutral impact | Consider disabling to free resources |
|
|
114
|
+
| WITH > WITHOUT | Smart Placement hurting | Disable with `mode: "off"` |
|
|
115
|
+
|
|
116
|
+
**Why Smart Placement might hurt performance:**
|
|
117
|
+
|
|
118
|
+
- Worker primarily serves static assets or cached content
|
|
119
|
+
- Backend services are globally distributed (no single optimal location)
|
|
120
|
+
- Worker has minimal backend communication
|
|
121
|
+
- Using Pages with `assets.run_worker_first = true`
|
|
122
|
+
|
|
123
|
+
**Typical improvements when Smart Placement helps:**
|
|
124
|
+
|
|
125
|
+
- 20-50% reduction in request duration for database-heavy Workers
|
|
126
|
+
- 30-60% reduction for Workers making multiple backend API calls
|
|
127
|
+
- Larger improvements when backend is geographically concentrated
|
|
128
|
+
|
|
129
|
+
## Monitoring Commands
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
# Tail Worker logs
|
|
133
|
+
wrangler tail your-worker-name
|
|
134
|
+
|
|
135
|
+
# Tail with filters
|
|
136
|
+
wrangler tail your-worker-name --status error
|
|
137
|
+
wrangler tail your-worker-name --header cf-placement
|
|
138
|
+
|
|
139
|
+
# Check placement status via API
|
|
140
|
+
curl -H "Authorization: Bearer $TOKEN" \
|
|
141
|
+
https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/workers/services/$WORKER_NAME \
|
|
142
|
+
| jq .result.placement_status
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## TypeScript Types
|
|
146
|
+
|
|
147
|
+
```typescript
|
|
148
|
+
// Placement status returned by API (field may be absent)
|
|
149
|
+
type PlacementStatus =
|
|
150
|
+
| 'SUCCESS'
|
|
151
|
+
| 'INSUFFICIENT_INVOCATIONS'
|
|
152
|
+
| 'UNSUPPORTED_APPLICATION'
|
|
153
|
+
| undefined
|
|
154
|
+
|
|
155
|
+
// Placement configuration in wrangler.jsonc
|
|
156
|
+
type PlacementMode = 'smart' | 'off'
|
|
157
|
+
|
|
158
|
+
interface PlacementConfig {
|
|
159
|
+
mode: PlacementMode
|
|
160
|
+
// Legacy fields (deprecated/removed):
|
|
161
|
+
// hint?: string; // REMOVED - no longer supported
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
// Explicit placement (separate feature from Smart Placement)
|
|
165
|
+
interface ExplicitPlacementConfig {
|
|
166
|
+
region?: string
|
|
167
|
+
host?: string
|
|
168
|
+
hostname?: string
|
|
169
|
+
// Cannot combine with mode field
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
// Worker metadata from API response
|
|
173
|
+
interface WorkerMetadata {
|
|
174
|
+
placement?: PlacementConfig | ExplicitPlacementConfig
|
|
175
|
+
placement_status?: PlacementStatus
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
// Service Binding for backend Worker
|
|
179
|
+
interface Env {
|
|
180
|
+
BACKEND_SERVICE: Fetcher // Service Binding to backend Worker
|
|
181
|
+
DATABASE: D1Database
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
// Example Worker with Service Binding
|
|
185
|
+
export default {
|
|
186
|
+
async fetch(request: Request, env: Env): Promise<Response> {
|
|
187
|
+
// Forward to backend Worker with Smart Placement enabled
|
|
188
|
+
const response = await env.BACKEND_SERVICE.fetch(request)
|
|
189
|
+
return response
|
|
190
|
+
},
|
|
191
|
+
} satisfies ExportedHandler<Env>
|
|
192
|
+
```
|