@spacefast/common 0.0.26 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/agents/connect-targets.d.ts +6 -146
- package/dist/agents/connect-targets.js +63 -295
- package/dist/agents/private-key-oauth.d.ts +31 -1
- package/dist/agents/private-key-oauth.js +124 -33
- package/dist/agents/registry/core.d.ts +292 -0
- package/dist/agents/registry/core.js +1388 -0
- package/dist/agents/registry/deeplink-probes.d.ts +23 -0
- package/dist/agents/registry/deeplink-probes.js +18 -0
- package/dist/agents/registry/node.d.ts +56 -0
- package/dist/agents/registry/node.js +339 -0
- package/dist/brand-assets-build.js +1 -2
- package/dist/brand-assets.js +4 -7
- package/dist/brand.d.ts +17 -0
- package/dist/brand.js +24 -4
- package/dist/config/domains.d.ts +55 -28
- package/dist/config/domains.js +85 -41
- package/dist/config/index.js +1 -2
- package/dist/contracts/abuse.js +9 -24
- package/dist/contracts/access-profiles.d.ts +86 -0
- package/dist/contracts/access-profiles.js +89 -0
- package/dist/contracts/access.d.ts +21 -27
- package/dist/contracts/access.js +33 -64
- package/dist/contracts/activity.d.ts +18 -1
- package/dist/contracts/activity.js +70 -26
- package/dist/contracts/analytics.js +8 -10
- package/dist/contracts/api-keys.d.ts +77 -52
- package/dist/contracts/api-keys.js +44 -24
- package/dist/contracts/application-journal.d.ts +216 -0
- package/dist/contracts/application-journal.js +167 -0
- package/dist/contracts/auth.d.ts +90 -17
- package/dist/contracts/auth.js +86 -17
- package/dist/contracts/beta.d.ts +9 -4
- package/dist/contracts/beta.js +20 -16
- package/dist/contracts/billing.js +7 -11
- package/dist/contracts/bootstrap.d.ts +791 -0
- package/dist/contracts/bootstrap.js +51 -0
- package/dist/contracts/builds.d.ts +192 -7
- package/dist/contracts/builds.js +84 -21
- package/dist/contracts/channels.d.ts +43 -0
- package/dist/contracts/channels.js +25 -9
- package/dist/contracts/cli.d.ts +7 -0
- package/dist/contracts/cli.js +6 -0
- package/dist/contracts/collab-public.d.ts +1 -1
- package/dist/contracts/collab-public.js +5 -8
- package/dist/contracts/comments.d.ts +45 -35
- package/dist/contracts/comments.js +107 -77
- package/dist/contracts/commerce.d.ts +165 -0
- package/dist/contracts/commerce.js +146 -0
- package/dist/contracts/common.d.ts +3 -3
- package/dist/contracts/common.js +18 -29
- package/dist/contracts/content-contract-verification.d.ts +521 -0
- package/dist/contracts/content-contract-verification.js +320 -0
- package/dist/contracts/content-platform-fixture.d.ts +1278 -0
- package/dist/contracts/content-platform-fixture.js +44 -0
- package/dist/contracts/content-program.d.ts +994 -0
- package/dist/contracts/content-program.js +658 -0
- package/dist/contracts/content-sync.d.ts +290 -0
- package/dist/contracts/content-sync.js +167 -0
- package/dist/contracts/content.d.ts +432 -0
- package/dist/contracts/content.js +303 -0
- package/dist/contracts/continuation.d.ts +17 -1
- package/dist/contracts/continuation.js +23 -23
- package/dist/contracts/countries.js +3 -4
- package/dist/contracts/crons.d.ts +17 -0
- package/dist/contracts/crons.js +33 -15
- package/dist/contracts/dashboard-prefs.d.ts +56 -0
- package/dist/contracts/dashboard-prefs.js +51 -0
- package/dist/contracts/device-auth.d.ts +234 -37
- package/dist/contracts/device-auth.js +267 -53
- package/dist/contracts/docs.d.ts +6 -10
- package/dist/contracts/docs.js +5 -13
- package/dist/contracts/domains.d.ts +499 -102
- package/dist/contracts/domains.js +169 -58
- package/dist/contracts/email-preferences.d.ts +3 -3
- package/dist/contracts/email-preferences.js +6 -7
- package/dist/contracts/enums.d.ts +26 -26
- package/dist/contracts/enums.js +61 -54
- package/dist/contracts/error-code-meta.d.ts +273 -7
- package/dist/contracts/error-code-meta.js +81 -5
- package/dist/contracts/error-codes.d.ts +5 -5
- package/dist/contracts/error-codes.js +79 -16
- package/dist/contracts/events.d.ts +100 -20
- package/dist/contracts/events.js +107 -20
- package/dist/contracts/execution.d.ts +47 -66
- package/dist/contracts/execution.js +51 -64
- package/dist/contracts/feature-lifecycle.d.ts +70 -14
- package/dist/contracts/feature-lifecycle.js +86 -15
- package/dist/contracts/features.d.ts +100 -37
- package/dist/contracts/features.js +21 -27
- package/dist/contracts/fixtures/content-platform-v1.json +1108 -0
- package/dist/contracts/frame-session.d.ts +192 -0
- package/dist/contracts/frame-session.js +164 -0
- package/dist/contracts/functions.d.ts +218 -211
- package/dist/contracts/functions.js +273 -260
- package/dist/contracts/grant-copy.d.ts +43 -0
- package/dist/contracts/grant-copy.js +44 -0
- package/dist/contracts/grants.d.ts +64 -56
- package/dist/contracts/grants.js +124 -23
- package/dist/contracts/ids.d.ts +4 -1
- package/dist/contracts/ids.js +4 -1
- package/dist/contracts/internal.d.ts +5 -4
- package/dist/contracts/internal.js +12 -3
- package/dist/contracts/mcp.d.ts +17 -0
- package/dist/contracts/mcp.js +23 -0
- package/dist/contracts/me.d.ts +6 -1
- package/dist/contracts/me.js +12 -6
- package/dist/contracts/notifications.d.ts +27 -29
- package/dist/contracts/notifications.js +9 -4
- package/dist/contracts/oauth-resources.d.ts +121 -10
- package/dist/contracts/oauth-resources.js +130 -11
- package/dist/contracts/oauth-scope-actions.d.ts +90 -0
- package/dist/contracts/oauth-scope-actions.js +126 -0
- package/dist/contracts/operations.d.ts +27 -4
- package/dist/contracts/operations.js +11 -5
- package/dist/contracts/pages.d.ts +29 -5
- package/dist/contracts/pages.js +22 -5
- package/dist/contracts/partner-notifications.d.ts +3 -0
- package/dist/contracts/partner-notifications.js +65 -0
- package/dist/contracts/{platform.d.ts → partner.d.ts} +29 -42
- package/dist/contracts/{platform.js → partner.js} +27 -40
- package/dist/contracts/plan-policy.d.ts +1 -1
- package/dist/contracts/principal-assertion.d.ts +43 -0
- package/dist/contracts/principal-assertion.js +67 -0
- package/dist/contracts/principals.d.ts +73 -0
- package/dist/contracts/principals.js +59 -0
- package/dist/contracts/privacy.d.ts +11 -0
- package/dist/contracts/privacy.js +17 -0
- package/dist/contracts/problem-document.js +3 -4
- package/dist/contracts/publish-archive.d.ts +116 -18
- package/dist/contracts/publish-archive.js +6 -3
- package/dist/contracts/push-new.d.ts +4 -4
- package/dist/contracts/quotas.js +3 -3
- package/dist/contracts/realtime.d.ts +52 -0
- package/dist/contracts/realtime.js +54 -0
- package/dist/contracts/repository-connections.d.ts +1 -1
- package/dist/contracts/repository-connections.js +6 -2
- package/dist/contracts/resources.d.ts +105 -14
- package/dist/contracts/resources.js +145 -21
- package/dist/contracts/route-inventory.d.ts +358 -0
- package/dist/contracts/route-inventory.js +141 -0
- package/dist/contracts/runtime-api.d.ts +112 -35
- package/dist/contracts/runtime-api.js +86 -66
- package/dist/contracts/runtime-app.d.ts +11 -21
- package/dist/contracts/runtime-app.js +39 -24
- package/dist/contracts/runtime-components.d.ts +143 -0
- package/dist/contracts/runtime-components.js +199 -0
- package/dist/contracts/runtime-db.d.ts +45 -19
- package/dist/contracts/runtime-db.js +85 -20
- package/dist/contracts/runtime-purge.js +3 -5
- package/dist/contracts/runtime-services.d.ts +43 -75
- package/dist/contracts/runtime-services.js +29 -49
- package/dist/contracts/runtime-storage.d.ts +14 -14
- package/dist/contracts/runtime-storage.js +28 -13
- package/dist/contracts/sf-config-v1.d.ts +14 -18
- package/dist/contracts/slugs.js +13 -4
- package/dist/contracts/space-config.d.ts +235 -28
- package/dist/contracts/space-config.js +246 -91
- package/dist/contracts/spaces.d.ts +360 -255
- package/dist/contracts/spaces.js +190 -122
- package/dist/contracts/superadmin-activity.d.ts +3 -43
- package/dist/contracts/superadmin-activity.js +6 -30
- package/dist/contracts/superadmin-emails.d.ts +1 -0
- package/dist/contracts/superadmin-emails.js +17 -1
- package/dist/contracts/superadmin-runtime.d.ts +199 -0
- package/dist/contracts/superadmin-runtime.js +141 -0
- package/dist/contracts/superadmin-search.d.ts +22 -2
- package/dist/contracts/superadmin-search.js +14 -6
- package/dist/contracts/superadmin-spaces.d.ts +435 -186
- package/dist/contracts/superadmin-spaces.js +131 -25
- package/dist/contracts/superadmin-teams.d.ts +3 -0
- package/dist/contracts/superadmin-teams.js +1 -2
- package/dist/contracts/superadmin-tenants.d.ts +627 -6
- package/dist/contracts/superadmin-tenants.js +32 -7
- package/dist/contracts/superadmin.d.ts +98 -16
- package/dist/contracts/superadmin.js +63 -10
- package/dist/contracts/tags.d.ts +85 -58
- package/dist/contracts/tags.js +44 -34
- package/dist/contracts/teams.d.ts +72 -9
- package/dist/contracts/teams.js +84 -25
- package/dist/contracts/tenants.d.ts +135 -0
- package/dist/contracts/tenants.js +120 -0
- package/dist/contracts/test-triggers.d.ts +70 -0
- package/dist/contracts/test-triggers.js +116 -0
- package/dist/contracts/theme-json.js +3 -8
- package/dist/contracts/transfers.d.ts +1 -0
- package/dist/contracts/transfers.js +1 -0
- package/dist/contracts/usage.d.ts +209 -0
- package/dist/contracts/usage.js +124 -12
- package/dist/contracts/variables.d.ts +2 -2
- package/dist/contracts/variables.js +9 -13
- package/dist/contracts/webhooks.d.ts +13 -5
- package/dist/contracts/webhooks.js +3 -1
- package/dist/contracts/zero.d.ts +57 -64
- package/dist/contracts/zero.js +68 -66
- package/dist/dashboard-paths/index.d.ts +24 -21
- package/dist/dashboard-paths/index.js +35 -47
- package/dist/dashboard-paths/route-reservations.generated.d.ts +2 -0
- package/dist/dashboard-paths/route-reservations.generated.js +36 -0
- package/dist/docs/agent-arrival.d.ts +92 -0
- package/dist/docs/agent-arrival.js +227 -0
- package/dist/docs/agent-output-policy.d.ts +6 -0
- package/dist/docs/agent-output-policy.js +22 -0
- package/dist/docs/agent-prose.d.ts +11 -17
- package/dist/docs/agent-prose.js +62 -37
- package/dist/docs/agent-setup.d.ts +72 -41
- package/dist/docs/agent-setup.js +336 -436
- package/dist/docs/catalog.d.ts +147 -89
- package/dist/docs/catalog.js +157 -42
- package/dist/docs/error-docs.d.ts +2102 -1
- package/dist/docs/error-docs.js +285 -16
- package/dist/docs/index-build.d.ts +0 -1
- package/dist/docs/index-build.js +2 -3
- package/dist/docs/page-context-prompt.d.ts +77 -0
- package/dist/docs/page-context-prompt.js +131 -0
- package/dist/docs/reference-urls.d.ts +46 -0
- package/dist/docs/reference-urls.js +79 -0
- package/dist/docs/search.d.ts +6 -8
- package/dist/docs/search.js +10 -13
- package/dist/docs/skill-distribution.d.ts +4 -1
- package/dist/docs/skill-distribution.js +10 -5
- package/dist/docs/skills.d.ts +117 -117
- package/dist/docs/skills.js +120 -72
- package/dist/docs/start-prompts.d.ts +45 -0
- package/dist/docs/start-prompts.js +62 -0
- package/dist/domain-exploration.js +9 -13
- package/dist/og-template.d.ts +56 -0
- package/dist/og-template.js +56 -0
- package/dist/slug-policy/index.js +5 -11
- package/dist/utils/browser-credential.d.ts +13 -6
- package/dist/utils/browser-credential.js +14 -7
- package/dist/utils/build-settings.d.ts +16 -0
- package/dist/utils/build-settings.js +63 -17
- package/dist/utils/canonical-json.d.ts +3 -5
- package/dist/utils/canonical-json.js +3 -5
- package/dist/utils/cast-transport.d.ts +5 -17
- package/dist/utils/cast-transport.js +6 -19
- package/dist/utils/claim-token.js +1 -2
- package/dist/utils/comment-avatars.js +4 -6
- package/dist/utils/concurrency.js +2 -3
- package/dist/utils/content-type.d.ts +7 -6
- package/dist/utils/content-type.js +73 -51
- package/dist/utils/credential-policy.d.ts +50 -6
- package/dist/utils/credential-policy.js +123 -57
- package/dist/utils/egress-policy.fixtures.json +1 -1
- package/dist/utils/generate-space-name.d.ts +3 -8
- package/dist/utils/generate-space-name.js +3 -8
- package/dist/utils/grants.d.ts +0 -1
- package/dist/utils/grants.js +4 -7
- package/dist/utils/gravatar.d.ts +2 -4
- package/dist/utils/gravatar.js +6 -12
- package/dist/utils/id-hints.js +14 -23
- package/dist/utils/idempotency.d.ts +3 -3
- package/dist/utils/idempotency.js +6 -7
- package/dist/utils/local-space-state.d.ts +15 -15
- package/dist/utils/local-space-state.js +34 -23
- package/dist/utils/oauth-signed-query.d.ts +3 -5
- package/dist/utils/oauth-signed-query.js +6 -9
- package/dist/utils/one-shot-replay.d.ts +3 -5
- package/dist/utils/one-shot-replay.js +3 -5
- package/dist/utils/page-colors.d.ts +4 -10
- package/dist/utils/page-colors.js +11 -35
- package/dist/utils/page-fonts.js +6 -11
- package/dist/utils/page-preview.d.ts +0 -1
- package/dist/utils/page-preview.js +0 -1
- package/dist/utils/pages.d.ts +22 -11
- package/dist/utils/pages.js +70 -30
- package/dist/utils/privacy-regions.d.ts +19 -0
- package/dist/utils/privacy-regions.js +91 -0
- package/dist/utils/publish-form-data.d.ts +4 -5
- package/dist/utils/publish-form-data.js +2 -3
- package/dist/utils/publish-policy.d.ts +10 -23
- package/dist/utils/publish-policy.js +63 -116
- package/dist/utils/query-client.d.ts +2 -0
- package/dist/utils/query-client.js +10 -1
- package/dist/utils/runtime-paths.d.ts +4 -4
- package/dist/utils/runtime-paths.js +6 -8
- package/dist/utils/runtime-upload.d.ts +4 -0
- package/dist/utils/runtime-upload.js +5 -0
- package/dist/utils/secure-local-file.d.ts +3 -3
- package/dist/utils/secure-local-file.js +18 -24
- package/dist/utils/space-config.d.ts +11 -14
- package/dist/utils/space-config.js +10 -16
- package/dist/utils/static-runtime-policy.d.ts +5 -8
- package/dist/utils/static-runtime-policy.generated.d.ts +16 -0
- package/dist/utils/static-runtime-policy.generated.js +70 -0
- package/dist/utils/static-runtime-policy.js +17 -84
- package/dist/utils/storage-policy.js +1 -2
- package/dist/utils/upload-session.js +8 -14
- package/dist/utils/version-path.js +11 -19
- package/dist/utils/wpcom-auth-redirects.d.ts +5 -14
- package/dist/utils/wpcom-auth-redirects.js +1 -4
- package/dist/vocabulary.d.ts +7 -7
- package/dist/vocabulary.js +30 -16
- package/package.json +14 -2
- package/dist/agents/client-registry.d.ts +0 -22
- package/dist/agents/client-registry.js +0 -41
- package/dist/docs/agent-handoff-document.d.ts +0 -15
- package/dist/docs/agent-handoff-document.js +0 -180
- package/dist/docs/agent-solutions.d.ts +0 -110
- package/dist/docs/agent-solutions.js +0 -183
- package/dist/utils/query-keys.d.ts +0 -84
- package/dist/utils/query-keys.js +0 -108
|
@@ -3,46 +3,33 @@ import { type ExecutionCapabilities } from "./execution.js";
|
|
|
3
3
|
/**
|
|
4
4
|
* Spacefast Functions: tenant workers run as Cloudflare Dynamic Workers.
|
|
5
5
|
*
|
|
6
|
-
*
|
|
7
|
-
* negotiable and that together rule out the obvious architecture:
|
|
6
|
+
* Two constraints shape the product:
|
|
8
7
|
*
|
|
9
|
-
* 1.
|
|
10
|
-
*
|
|
8
|
+
* 1. Cloudflare is reached from wp.cloud, never from the control plane. The
|
|
9
|
+
* control plane records intent; the space's own origin makes every
|
|
11
10
|
* Cloudflare call.
|
|
12
|
-
* 2.
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* `/_next/static/*` and friends never leave our origin.
|
|
11
|
+
* 2. Every asset is served by wp.cloud. A worker receives only the requests
|
|
12
|
+
* that could not be answered from bytes on disk, so `/_next/static/*` and
|
|
13
|
+
* friends never leave our origin.
|
|
16
14
|
*
|
|
17
|
-
* Dynamic Workers
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
* script lifecycle
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
* cache, not a record.
|
|
24
|
-
*
|
|
25
|
-
* That also keeps the exit cheap. The contract below is "here is a module
|
|
26
|
-
* graph, here is its configuration, run it", which is workerd's own shape; the
|
|
27
|
-
* managed runtime is an implementation of it rather than the thing we built
|
|
28
|
-
* against.
|
|
29
|
-
*
|
|
30
|
-
* What the worker gets in exchange is the thing we could not build: a real V8
|
|
31
|
-
* isolate that runs npm packages and framework output — OpenNext Next.js among
|
|
32
|
-
* them — without us having to sandbox any of it.
|
|
15
|
+
* Dynamic Workers holds both at once. There is no upload: a version's bundle
|
|
16
|
+
* stays in its own content store on wp.cloud and the host worker pulls it
|
|
17
|
+
* through the Worker Loader binding, so no artefact of ours lives on Cloudflare
|
|
18
|
+
* and there is no script lifecycle to manage. What the worker buys is a real V8
|
|
19
|
+
* isolate running npm packages and framework output, OpenNext Next.js among
|
|
20
|
+
* them, without us sandboxing any of it.
|
|
33
21
|
*
|
|
34
22
|
* The cost is that the worker is a continent away from the space's MySQL.
|
|
35
23
|
* `ctx.db` therefore travels back over an HTTPS relay to the same PHP broker
|
|
36
24
|
* the local tier speaks to over a pipe, which is slower and batched rather
|
|
37
25
|
* than transactional. That is why capsules are a different product rather
|
|
38
|
-
* than a placement option
|
|
26
|
+
* than a placement option. See `endpointIsPortable` in `./execution.js`.
|
|
39
27
|
*/
|
|
40
28
|
/**
|
|
41
|
-
* The tag a compiled worker artifact carries
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
* version declares: a publish can carry this beside a capsule.
|
|
29
|
+
* The tag a compiled worker artifact carries, so the PHP origin can tell what
|
|
30
|
+
* it is dispatching. `functions-dispatch.php` refuses any other tag. It is a
|
|
31
|
+
* property of the artifact, not a kind a space or a version declares: a publish
|
|
32
|
+
* can carry this beside a capsule.
|
|
46
33
|
*/
|
|
47
34
|
export declare const FUNCTIONS_RUNTIME_KIND = "functions";
|
|
48
35
|
export declare const FUNCTIONS_SOURCE_METADATA_KEY = "spacefastFunctions";
|
|
@@ -52,7 +39,7 @@ export declare const FUNCTIONS_RUNTIME_ROUTE_PATHS: {
|
|
|
52
39
|
/** Where a dispatched worker calls back for brokered capabilities. */
|
|
53
40
|
readonly relay: "/__spacefast/functions/relay";
|
|
54
41
|
/**
|
|
55
|
-
* Where the execution host asks the space origin to drop cached responses
|
|
42
|
+
* Where the execution host asks the space origin to drop cached responses:
|
|
56
43
|
* an OpenNext `revalidatePath` must reach the CDN in front of wp.cloud, and
|
|
57
44
|
* only the origin can speak for its own cache. Authenticated with the
|
|
58
45
|
* version-scoped purge credential in the `sf-purge-token` request header.
|
|
@@ -61,85 +48,140 @@ export declare const FUNCTIONS_RUNTIME_ROUTE_PATHS: {
|
|
|
61
48
|
};
|
|
62
49
|
/**
|
|
63
50
|
* The header the execution host presents at the origin purge route. Outside the
|
|
64
|
-
* `sf-fx-` namespace
|
|
65
|
-
*
|
|
66
|
-
* purge call is the host speaking for itself, like a relay call.
|
|
51
|
+
* `sf-fx-` namespace because that prefix names dispatch instructions the origin
|
|
52
|
+
* SENDS, and is stripped from anything inbound before tenant code.
|
|
67
53
|
*/
|
|
68
54
|
export declare const FUNCTIONS_PURGE_TOKEN_HEADER = "sf-purge-token";
|
|
55
|
+
/**
|
|
56
|
+
* The credential a space origin presents to the execution host on every
|
|
57
|
+
* dispatch (`sf-fx-dispatch-token`), and the audience that identifies it.
|
|
58
|
+
*
|
|
59
|
+
* It is a PER-SITE token, not a fleet secret. The control plane mints one
|
|
60
|
+
* Ed25519 JWT per wp.cloud box, bound to that box's `runtime_instance_id`, and
|
|
61
|
+
* writes it into that box's persistent data. The host verifies the signature
|
|
62
|
+
* against the control plane's public key and takes the site identity from the
|
|
63
|
+
* verified claim rather than from anything the caller asserts.
|
|
64
|
+
*
|
|
65
|
+
* Tenant PHP runs on the same box and can read the box's own configuration, so
|
|
66
|
+
* assume the tenant can read this credential. A per-site token read once still
|
|
67
|
+
* speaks only for its own site: the host refuses any bundle whose signed token
|
|
68
|
+
* names a different `runtime_instance_id`. Signing is EdDSA rather than HMAC so
|
|
69
|
+
* that no signing material sits on the edge, where a host compromise would mint
|
|
70
|
+
* dispatch credentials for the whole fleet.
|
|
71
|
+
*/
|
|
72
|
+
export declare const FUNCTIONS_DISPATCH_TOKEN_AUD = "spacefast-functions-dispatch";
|
|
73
|
+
/**
|
|
74
|
+
* Pinned by every verifier rather than read from the token's own header.
|
|
75
|
+
* Accepting the presented `alg` is how `alg: none` forgeries work.
|
|
76
|
+
*/
|
|
77
|
+
export declare const FUNCTIONS_TOKEN_ALG = "EdDSA";
|
|
78
|
+
/**
|
|
79
|
+
* Ten years, like the bundle and relay credentials: the token is not re-mintable
|
|
80
|
+
* on any request path. It reaches a box only through a wp.cloud persistent-data
|
|
81
|
+
* sync at provisioning and on maintenance sweeps, so a shorter clock would take
|
|
82
|
+
* a quiet box offline rather than protect it. Scope is the boundary, and
|
|
83
|
+
* rotating the platform signing key invalidates every token at once.
|
|
84
|
+
*/
|
|
85
|
+
export declare const FUNCTIONS_DISPATCH_TOKEN_TTL_SECONDS: number;
|
|
86
|
+
/**
|
|
87
|
+
* What the execution host requires of a dispatch credential before it believes
|
|
88
|
+
* anything else in the request. One signing key mints every platform token, so
|
|
89
|
+
* the pinned audience is what keeps them from meaning one authority.
|
|
90
|
+
*/
|
|
91
|
+
export declare const functionsDispatchTokenClaimsSchema: z.ZodObject<{
|
|
92
|
+
aud: z.ZodLiteral<"spacefast-functions-dispatch">;
|
|
93
|
+
runtime_instance_id: z.ZodString;
|
|
94
|
+
exp: z.ZodNumber;
|
|
95
|
+
nbf: z.ZodOptional<z.ZodNumber>;
|
|
96
|
+
}, z.core.$strip>;
|
|
97
|
+
export type FunctionsDispatchTokenClaims = z.infer<typeof functionsDispatchTokenClaimsSchema>;
|
|
98
|
+
/**
|
|
99
|
+
* The claims carried by the token inside a signed bundle or seed URL. The
|
|
100
|
+
* audience stays open because both artifacts share this shape and are separated
|
|
101
|
+
* by their own audience check at the point of use: a bundle grant must never
|
|
102
|
+
* authorise a seed read.
|
|
103
|
+
*/
|
|
104
|
+
export declare const functionsArtifactTokenClaimsSchema: z.ZodObject<{
|
|
105
|
+
aud: z.ZodString;
|
|
106
|
+
runtime_instance_id: z.ZodString;
|
|
107
|
+
space_id: z.ZodString;
|
|
108
|
+
version_id: z.ZodString;
|
|
109
|
+
sha256: z.ZodString;
|
|
110
|
+
exp: z.ZodNumber;
|
|
111
|
+
nbf: z.ZodOptional<z.ZodNumber>;
|
|
112
|
+
}, z.core.$strip>;
|
|
113
|
+
export type FunctionsArtifactTokenClaims = z.infer<typeof functionsArtifactTokenClaimsSchema>;
|
|
114
|
+
/**
|
|
115
|
+
* Whether a compact JWT's protected header declares the one algorithm this
|
|
116
|
+
* platform signs with. Pinned rather than trusted: a verifier that takes the
|
|
117
|
+
* token's own word for `alg` accepts `alg: none`.
|
|
118
|
+
*/
|
|
119
|
+
export declare function functionsTokenHeaderIsSigned(headerJson: string): boolean;
|
|
120
|
+
/**
|
|
121
|
+
* Claim readers for an already signature-verified payload. They live beside the
|
|
122
|
+
* mint-side constants so the control plane's audiences and the host's required
|
|
123
|
+
* claims stay one definition rather than two that agree today.
|
|
124
|
+
*/
|
|
125
|
+
export declare function parseFunctionsDispatchTokenClaims(claimsJson: string): FunctionsDispatchTokenClaims | null;
|
|
126
|
+
export declare function parseFunctionsArtifactTokenClaims(claimsJson: string): FunctionsArtifactTokenClaims | null;
|
|
69
127
|
/**
|
|
70
128
|
* Where invocation counts are reported, on the CONTROL PLANE rather than the
|
|
71
|
-
* space origin.
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
* and stay on their own origin; usage is a number the platform bills from and
|
|
75
|
-
* goes straight to us. Sharing one channel would make either destination a
|
|
76
|
-
* plausible place to look for the other's data, and would put log volume on the
|
|
77
|
-
* path that has to stay cheap.
|
|
129
|
+
* space origin. Logs are the tenant's content and stay on their own origin;
|
|
130
|
+
* usage is a number the platform bills from. One shared channel would put log
|
|
131
|
+
* volume on the path that has to stay cheap.
|
|
78
132
|
*/
|
|
79
133
|
export declare const FUNCTIONS_USAGE_INTAKE_PATH = "/v1/runtime/functions/usage";
|
|
80
134
|
/** Public, signed read path. Distinct from storage so the token is never a filename. */
|
|
81
135
|
export declare const FUNCTIONS_BUNDLE_ROUTE_PREFIX = "/__spacefast/functions/b";
|
|
82
136
|
export declare const FUNCTIONS_RUNTIME_STORAGE_ROOT = "__spacefast/functions";
|
|
83
137
|
/**
|
|
84
|
-
* Where a version's compiled bundle lives
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
* -
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
* The dispatch configuration — host, capabilities, relay credential — is not
|
|
99
|
-
* here and is not content at all. The engine writes it beside the version's
|
|
100
|
-
* file tree rather than inside it, exactly as it does for Zero, so a publish
|
|
101
|
-
* cannot reach it: no carve-out, no upload path, nothing to guard. A publish
|
|
102
|
-
* able to write that file would be a publish able to grant itself authority it
|
|
103
|
-
* was never given.
|
|
138
|
+
* Where a version's compiled bundle lives, under the same `__spacefast/` prefix
|
|
139
|
+
* as every other platform-owned path. Two consequences, both wanted:
|
|
140
|
+
*
|
|
141
|
+
* - Not servable as static content. The runtime treats the whole prefix as
|
|
142
|
+
* control paths, so a tenant's compiled source is not readable at a guessable
|
|
143
|
+
* URL, and the digest that would make it guessable appears in build output.
|
|
144
|
+
* - Written by the ordinary publish path. The upload policy carves out exactly
|
|
145
|
+
* this subtree (`publish-policy.ts`), so the bundle rides the normal manifest
|
|
146
|
+
* and upload passes.
|
|
147
|
+
*
|
|
148
|
+
* The dispatch configuration is not here and is not content at all. The engine
|
|
149
|
+
* writes it beside the version's file tree, as it does for Zero, so a publish
|
|
150
|
+
* cannot reach it and cannot grant itself authority it was never given.
|
|
104
151
|
*/
|
|
105
152
|
export declare const FUNCTIONS_RUNTIME_BUNDLE_ROOT = "__spacefast/functions/bundles";
|
|
106
153
|
/**
|
|
107
|
-
* Where a version's Next-cache seed document lives
|
|
108
|
-
* and fetch-cache entries that warm the execution host's cache object so the
|
|
109
|
-
* first visitor gets the page the build rendered
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
154
|
+
* Where a version's Next-cache seed document lives: the build-time prerender
|
|
155
|
+
* and fetch-cache entries that warm the execution host's cache object, so the
|
|
156
|
+
* first visitor gets the page the build rendered. A sibling of `bundles/` with
|
|
157
|
+
* the same properties, publishable through the ordinary upload path with its
|
|
158
|
+
* own carve-out in publish-policy, never servable as static content, read back
|
|
159
|
+
* only through the signed artifact route.
|
|
113
160
|
*/
|
|
114
161
|
export declare const FUNCTIONS_RUNTIME_SEED_ROOT = "__spacefast/functions/seeds";
|
|
115
162
|
export declare const FUNCTIONS_BUNDLE_FORMAT = "spacefast.functions.bundle.v1";
|
|
116
163
|
export declare const FUNCTIONS_SEED_FORMAT = "spacefast.functions.seed.v1";
|
|
117
164
|
/**
|
|
118
|
-
* Ceiling on a bundle's decoded size
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
* memory before instantiating anything. Set below the runtime's own script
|
|
123
|
-
* limit so an oversized build fails in our tooling, where we can say which
|
|
165
|
+
* Ceiling on a bundle's decoded size, and so on how much the host holds in
|
|
166
|
+
* memory before instantiating: the whole module graph arrives in one response,
|
|
167
|
+
* so a cold isolate costs a single round trip. Set below the runtime's own
|
|
168
|
+
* script limit, so an oversized build fails in our tooling, which can say which
|
|
124
169
|
* modules are large, rather than at dispatch, where the tenant sees a 502.
|
|
125
170
|
*/
|
|
126
171
|
export declare const FUNCTIONS_BUNDLE_MAX_BYTES: number;
|
|
127
172
|
/**
|
|
128
|
-
* Ceilings on the cache seed document. Per-entry mirrors the cache object's
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
* were left out — an omitted entry is not an error, it just renders live on
|
|
133
|
-
* first request like any cache miss.
|
|
173
|
+
* Ceilings on the cache seed document. Per-entry mirrors the cache object's own
|
|
174
|
+
* row limit; the total bounds what the host pulls and ingests on a cold cache.
|
|
175
|
+
* Both are enforced in the CLI, where an overflow can say WHICH pages were left
|
|
176
|
+
* out. An omitted entry renders live on first request like any cache miss.
|
|
134
177
|
*/
|
|
135
178
|
export declare const FUNCTIONS_SEED_ENTRY_MAX_BYTES: number;
|
|
136
179
|
export declare const FUNCTIONS_SEED_MAX_BYTES: number;
|
|
137
180
|
/**
|
|
138
|
-
* One warm-cache entry:
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
* and the cache client to disagree about serialization.
|
|
181
|
+
* One warm-cache entry: what the runtime's incremental-cache client would have
|
|
182
|
+
* written for `key` had it rendered the page itself. `valueJson` stays the JSON
|
|
183
|
+
* string it already is on disk (OpenNext's `.cache` / fetch-cache files), so the
|
|
184
|
+
* seed writer and the cache client cannot disagree about serialization.
|
|
143
185
|
*/
|
|
144
186
|
export declare const functionsSeedEntrySchema: z.ZodObject<{
|
|
145
187
|
key: z.ZodString;
|
|
@@ -166,25 +208,20 @@ export declare const functionsSeedManifestSchema: z.ZodObject<{
|
|
|
166
208
|
}, z.core.$strict>;
|
|
167
209
|
export type FunctionsSeedManifest = z.infer<typeof functionsSeedManifestSchema>;
|
|
168
210
|
/**
|
|
169
|
-
* How many entries the origin's dispatch table accepts.
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
* assembling the artifact — discovering the ceiling as a validation error at
|
|
173
|
-
* finalize would mean a build that classified fine fails at the last step — so
|
|
174
|
-
* the ceiling has to be a value both sides can read, not a literal each side
|
|
175
|
-
* spells for itself.
|
|
211
|
+
* How many entries the origin's dispatch table accepts. Exported because the CLI
|
|
212
|
+
* classifier compacts its route claims BEFORE assembling the artifact: meeting
|
|
213
|
+
* the ceiling as a finalize error would fail a build that classified fine.
|
|
176
214
|
*/
|
|
177
215
|
export declare const FUNCTIONS_MAX_ROUTES = 256;
|
|
178
216
|
/**
|
|
179
|
-
* A worker's dynamic route table. Anything not matched here is answered from
|
|
180
|
-
*
|
|
181
|
-
* is both the cheaper path and the one that keeps assets ours.
|
|
217
|
+
* A worker's dynamic route table. Anything not matched here is answered from the
|
|
218
|
+
* version's static content by wp.cloud and never reaches Cloudflare.
|
|
182
219
|
*
|
|
183
220
|
* A `subtree` entry covers its own path AND everything below it: the engine
|
|
184
221
|
* expands one into both `path` and `path/:splat`
|
|
185
|
-
* (`_stattic_runtime_functions_routes_artifact`, runtime/engine/admin/management.php)
|
|
186
|
-
*
|
|
187
|
-
*
|
|
222
|
+
* (`_stattic_runtime_functions_routes_artifact`, runtime/engine/admin/management.php).
|
|
223
|
+
* So `wholeSiteRoutes()` is a single `/` subtree entry, and an exact entry beside
|
|
224
|
+
* a subtree entry at the same path is dead weight.
|
|
188
225
|
*/
|
|
189
226
|
export declare const functionsRouteSchema: z.ZodObject<{
|
|
190
227
|
method: z.ZodDefault<z.ZodNullable<z.ZodEnum<{
|
|
@@ -223,12 +260,9 @@ export declare const functionsBundleModuleSchema: z.ZodUnion<readonly [z.ZodObje
|
|
|
223
260
|
}, z.core.$strict>]>;
|
|
224
261
|
export type FunctionsBundleModule = z.infer<typeof functionsBundleModuleSchema>;
|
|
225
262
|
/**
|
|
226
|
-
* The document served at a bundle URL and parsed by the host.
|
|
227
|
-
*
|
|
228
|
-
*
|
|
229
|
-
* of it living here: the CLI's bundler and the host's loader are separate
|
|
230
|
-
* deployments that must agree, and the only thing keeping them honest is a
|
|
231
|
-
* shared definition of the bytes in between.
|
|
263
|
+
* The document served at a bundle URL and parsed by the host. The CLI's bundler
|
|
264
|
+
* and the host's loader are separate deployments, and this shared definition is
|
|
265
|
+
* the only thing keeping them agreed on the bytes in between.
|
|
232
266
|
*/
|
|
233
267
|
export declare const functionsBundleManifestSchema: z.ZodObject<{
|
|
234
268
|
format: z.ZodLiteral<"spacefast.functions.bundle.v1">;
|
|
@@ -250,10 +284,9 @@ export declare const functionsBundleManifestSchema: z.ZodObject<{
|
|
|
250
284
|
export type FunctionsBundleManifest = z.infer<typeof functionsBundleManifestSchema>;
|
|
251
285
|
/**
|
|
252
286
|
* Where the worker's compiled bytes live in the version's own content store.
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
* forbids.
|
|
287
|
+
* Not inline in the finalize payload like Zero's bundles: framework output runs
|
|
288
|
+
* to megabytes, and inlining it would push the whole thing through the control
|
|
289
|
+
* plane, which the direct-from-wp.cloud rule forbids.
|
|
257
290
|
*/
|
|
258
291
|
export declare const functionsBundleRefSchema: z.ZodObject<{
|
|
259
292
|
path: z.ZodString;
|
|
@@ -262,9 +295,9 @@ export declare const functionsBundleRefSchema: z.ZodObject<{
|
|
|
262
295
|
}, z.core.$strict>;
|
|
263
296
|
export type FunctionsBundleRef = z.infer<typeof functionsBundleRefSchema>;
|
|
264
297
|
/**
|
|
265
|
-
* Where a version's cache seed document sits in its content store
|
|
266
|
-
*
|
|
267
|
-
*
|
|
298
|
+
* Where a version's cache seed document sits in its content store, the bundle
|
|
299
|
+
* ref's sibling with the seed's own root and ceiling. `entries` is carried so
|
|
300
|
+
* status surfaces can say what the seed holds without fetching it.
|
|
268
301
|
*/
|
|
269
302
|
export declare const functionsSeedRefSchema: z.ZodObject<{
|
|
270
303
|
path: z.ZodString;
|
|
@@ -274,41 +307,36 @@ export declare const functionsSeedRefSchema: z.ZodObject<{
|
|
|
274
307
|
}, z.core.$strict>;
|
|
275
308
|
export type FunctionsSeedRef = z.infer<typeof functionsSeedRefSchema>;
|
|
276
309
|
/**
|
|
277
|
-
* The path a bundle is served from.
|
|
278
|
-
*
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
*
|
|
282
|
-
*
|
|
283
|
-
*
|
|
284
|
-
*
|
|
285
|
-
*
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
*
|
|
289
|
-
* lacks the bytes, but it is derivable by anyone who *has* them, and it shows up
|
|
290
|
-
* in build output and `sf runtime status`. The token adds the dimension the
|
|
291
|
-
* digest cannot: holding the code does not entitle you to fetch it from us, and
|
|
292
|
-
* rotating the site secret invalidates every URL at once.
|
|
310
|
+
* The path a bundle is served from. Content-addressed, so the response is
|
|
311
|
+
* immutable and cacheable at our edge forever: a cold isolate anywhere costs one
|
|
312
|
+
* CDN hit rather than a round trip to the space's origin.
|
|
313
|
+
*
|
|
314
|
+
* The token rides in the path rather than the query string for the same reason.
|
|
315
|
+
* A query parameter is subject to cache-key normalisation, and a token stripped
|
|
316
|
+
* from the key would let one space's cached bundle answer another space's URL.
|
|
317
|
+
*
|
|
318
|
+
* Both halves are load-bearing. The digest is derivable by anyone holding the
|
|
319
|
+
* bytes and shows up in build output and `sf runtime status`. The token adds
|
|
320
|
+
* what the digest cannot: holding the code does not entitle you to fetch it from
|
|
321
|
+
* us, and rotating the site secret invalidates every URL at once.
|
|
293
322
|
*/
|
|
294
323
|
export declare function functionsBundlePath(input: {
|
|
295
324
|
sha256: string;
|
|
296
325
|
token: string;
|
|
297
326
|
}): string;
|
|
298
327
|
/**
|
|
299
|
-
* The seed document's read path
|
|
300
|
-
* filename and its own token audience. One signed artifact route on the
|
|
301
|
-
*
|
|
302
|
-
* audience says what the caller was authorised to read.
|
|
328
|
+
* The seed document's read path: the bundle route with a different terminal
|
|
329
|
+
* filename and its own token audience. One signed artifact route on the origin
|
|
330
|
+
* serves both.
|
|
303
331
|
*/
|
|
304
332
|
export declare function functionsSeedPath(input: {
|
|
305
333
|
sha256: string;
|
|
306
334
|
token: string;
|
|
307
335
|
}): string;
|
|
308
336
|
/**
|
|
309
|
-
* Where the bundle
|
|
310
|
-
*
|
|
311
|
-
*
|
|
337
|
+
* Where the bundle sits in the published version, the same path minus the token
|
|
338
|
+
* segment. The token authorises the read; it does not name the file, so rotating
|
|
339
|
+
* the signing key changes every URL without moving a byte.
|
|
312
340
|
*/
|
|
313
341
|
export declare function functionsBundleStoragePath(input: {
|
|
314
342
|
sha256: string;
|
|
@@ -359,6 +387,7 @@ export declare const functionsWorkerArtifactSchema: z.ZodObject<{
|
|
|
359
387
|
gravatar: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
360
388
|
spam: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
361
389
|
email: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
390
|
+
content: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
362
391
|
}, z.core.$strip>>;
|
|
363
392
|
platform: z.ZodDefault<z.ZodObject<{
|
|
364
393
|
nextCache: z.ZodDefault<z.ZodBoolean>;
|
|
@@ -367,12 +396,10 @@ export declare const functionsWorkerArtifactSchema: z.ZodObject<{
|
|
|
367
396
|
export type FunctionsWorkerArtifact = z.infer<typeof functionsWorkerArtifactSchema>;
|
|
368
397
|
/**
|
|
369
398
|
* The authority a dispatched worker may exercise, in the vocabulary the host
|
|
370
|
-
* speaks on the wire.
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
* *grants*, resolved by the control plane at finalize so the origin forwards a
|
|
375
|
-
* decision rather than making one. Anything absent fails closed at the relay.
|
|
399
|
+
* speaks on the wire. Narrower than `executionCapabilitiesSchema`, which records
|
|
400
|
+
* what a build *declared* it uses; this is what the origin *grants*, resolved by
|
|
401
|
+
* the control plane at finalize so the origin forwards a decision rather than
|
|
402
|
+
* making one. Anything absent fails closed at the relay.
|
|
376
403
|
*/
|
|
377
404
|
export declare const FUNCTIONS_DISPATCH_CAPABILITIES: readonly ["storage.read", "storage.write", "db.read", "db.write", "fetch", "log", "next.cache", "gravatar.profile", "spam.check", "email.send"];
|
|
378
405
|
export declare const functionsDispatchCapabilitySchema: z.ZodEnum<{
|
|
@@ -391,24 +418,17 @@ export type FunctionsDispatchCapability = z.infer<typeof functionsDispatchCapabi
|
|
|
391
418
|
/**
|
|
392
419
|
* Resolves a build's declared capabilities into the grant a dispatch carries.
|
|
393
420
|
*
|
|
394
|
-
* Three declared capabilities have no dispatch counterpart
|
|
395
|
-
* reason:
|
|
421
|
+
* Three declared capabilities have no dispatch counterpart:
|
|
396
422
|
*
|
|
397
423
|
* - `env` is not a runtime call at all. Values are resolved at finalize and
|
|
398
424
|
* travel in the config, so a worker reading `env` reaches nothing.
|
|
399
|
-
* - `auth` and `realtime` bind a handler to the local tier
|
|
400
|
-
*
|
|
401
|
-
* never arrives here.
|
|
425
|
+
* - `auth` and `realtime` bind a handler to the local tier, so code declaring
|
|
426
|
+
* them deploys as a capsule and never arrives here. See `endpointIsPortable`.
|
|
402
427
|
*
|
|
403
|
-
* `db` widens to both read and write
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
*
|
|
408
|
-
* The three platform-service grants are named for the operation an author
|
|
409
|
-
* reaches for, and each covers its service's whole operation set for the same
|
|
410
|
-
* reason `db` widens: a declaration says a handler uses spam checking, not that
|
|
411
|
-
* it never files a correction.
|
|
428
|
+
* `db` widens to both read and write, and each platform-service grant covers its
|
|
429
|
+
* service's whole operation set, because a declaration says a handler touches
|
|
430
|
+
* the database or checks for spam, not how. Narrowing would take per-statement
|
|
431
|
+
* analysis we do not do.
|
|
412
432
|
*/
|
|
413
433
|
export declare function functionsDispatchCapabilities(capabilities: ExecutionCapabilities, platform?: {
|
|
414
434
|
nextCache?: boolean;
|
|
@@ -416,12 +436,11 @@ export declare function functionsDispatchCapabilities(capabilities: ExecutionCap
|
|
|
416
436
|
/** Logs and the host-local Next cache do not transit the origin relay. */
|
|
417
437
|
export declare function functionsGrantNeedsRelay(granted: readonly FunctionsDispatchCapability[]): boolean;
|
|
418
438
|
/**
|
|
419
|
-
* What the space origin needs
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
*
|
|
423
|
-
*
|
|
424
|
-
* over HTTPS and holds no Cloudflare API credential at all.
|
|
439
|
+
* What the space origin needs to dispatch to the host on its own. The shared
|
|
440
|
+
* secret is a wp.cloud site secret, never part of a version's content and never
|
|
441
|
+
* reachable by tenant code, so it is not modelled here. There is no account id
|
|
442
|
+
* and no namespace: the origin talks to one host worker over HTTPS and holds no
|
|
443
|
+
* Cloudflare API credential.
|
|
425
444
|
*/
|
|
426
445
|
export declare const functionsHostConfigSchema: z.ZodObject<{
|
|
427
446
|
hostname: z.ZodString;
|
|
@@ -432,13 +451,11 @@ export type FunctionsHostConfig = z.infer<typeof functionsHostConfigSchema>;
|
|
|
432
451
|
/**
|
|
433
452
|
* The callback a dispatched worker uses for `ctx.db`, `ctx.fetch` and logging.
|
|
434
453
|
*
|
|
435
|
-
* Each relay call re-enters the space's PHP-FPM pool,
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
* against the PHP broker, batching twenty writes into one call is 8.3x faster
|
|
441
|
-
* than twenty separate ones.
|
|
454
|
+
* Each relay call re-enters the space's PHP-FPM pool, the deadlock hazard this
|
|
455
|
+
* product's admission control bounds: a proxied request occupies a worker for
|
|
456
|
+
* its whole life while its relay calls demand more. Batching is the other half.
|
|
457
|
+
* Against the PHP broker, twenty writes in one call is 8.3x faster than twenty
|
|
458
|
+
* separate ones.
|
|
442
459
|
*/
|
|
443
460
|
export declare const functionsRelayConfigSchema: z.ZodObject<{
|
|
444
461
|
url: z.ZodString;
|
|
@@ -448,12 +465,10 @@ export declare const functionsRelayConfigSchema: z.ZodObject<{
|
|
|
448
465
|
}, z.core.$strict>;
|
|
449
466
|
export type FunctionsRelayConfig = z.infer<typeof functionsRelayConfigSchema>;
|
|
450
467
|
/**
|
|
451
|
-
* Where the execution host reports how much this version ran.
|
|
452
|
-
*
|
|
453
|
-
*
|
|
454
|
-
*
|
|
455
|
-
* the control plane must never fail a request over it. Counting is reporting
|
|
456
|
-
* only — nothing here throttles, and no limit is enforced anywhere from it.
|
|
468
|
+
* Where the execution host reports how much this version ran. Absent means
|
|
469
|
+
* uncounted, not refused: a space whose configuration predates usage reporting
|
|
470
|
+
* must keep serving, and a tier that cannot reach the control plane must never
|
|
471
|
+
* fail a request over it. Nothing here throttles.
|
|
457
472
|
*/
|
|
458
473
|
export declare const functionsUsageConfigSchema: z.ZodObject<{
|
|
459
474
|
url: z.ZodString;
|
|
@@ -464,28 +479,25 @@ export type FunctionsUsageConfig = z.infer<typeof functionsUsageConfigSchema>;
|
|
|
464
479
|
* The credential the execution host presents at the origin's purge route.
|
|
465
480
|
*
|
|
466
481
|
* Only the token lives here: the purge route is on whichever hostname the
|
|
467
|
-
* visitor
|
|
468
|
-
*
|
|
469
|
-
*
|
|
470
|
-
*
|
|
471
|
-
*
|
|
472
|
-
* rendered. Version-scoped and folded into the host's isolate identity like its
|
|
473
|
-
* siblings, so a republish revokes it.
|
|
482
|
+
* visitor hit, so the origin composes the URL from the request host at dispatch
|
|
483
|
+
* time rather than freezing one hostname at finalize. A third credential rather
|
|
484
|
+
* than a reuse of the relay's, because a worker whose relay is unusable must
|
|
485
|
+
* still be able to invalidate what it rendered. Version-scoped, so a republish
|
|
486
|
+
* revokes it.
|
|
474
487
|
*/
|
|
475
488
|
export declare const functionsPurgeConfigSchema: z.ZodObject<{
|
|
476
489
|
token: z.ZodString;
|
|
477
490
|
}, z.core.$strict>;
|
|
478
491
|
export type FunctionsPurgeConfig = z.infer<typeof functionsPurgeConfigSchema>;
|
|
479
492
|
/**
|
|
480
|
-
* What a build declares about its worker
|
|
493
|
+
* What a build declares about its worker, everything the CLI can know from the
|
|
481
494
|
* author's project alone.
|
|
482
495
|
*
|
|
483
|
-
* Unlike Zero, this is *not* the
|
|
484
|
-
*
|
|
485
|
-
*
|
|
486
|
-
*
|
|
487
|
-
*
|
|
488
|
-
* field in which to assert authority it was not given.
|
|
496
|
+
* Unlike Zero, this is *not* the document the runtime receives. A build cannot
|
|
497
|
+
* name the host it is dispatched to, mint the credential its relay calls carry,
|
|
498
|
+
* or decide what authority it is granted. Keeping all three out of this schema
|
|
499
|
+
* leaves a version's own metadata no field in which to assert authority it was
|
|
500
|
+
* not given.
|
|
489
501
|
*/
|
|
490
502
|
export declare const functionsSourceFinalizeSchema: z.ZodObject<{
|
|
491
503
|
runtimeKind: z.ZodLiteral<"functions">;
|
|
@@ -531,6 +543,7 @@ export declare const functionsSourceFinalizeSchema: z.ZodObject<{
|
|
|
531
543
|
gravatar: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
532
544
|
spam: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
533
545
|
email: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
546
|
+
content: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
534
547
|
}, z.core.$strip>>;
|
|
535
548
|
platform: z.ZodDefault<z.ZodObject<{
|
|
536
549
|
nextCache: z.ZodDefault<z.ZodBoolean>;
|
|
@@ -546,10 +559,9 @@ export type FunctionsSourceFinalize = z.infer<typeof functionsSourceFinalizeSche
|
|
|
546
559
|
* The document the control plane sends to the runtime, which the engine stores
|
|
547
560
|
* beside the version's files and the origin reads on every dispatch.
|
|
548
561
|
*
|
|
549
|
-
* It is the build's declaration plus
|
|
550
|
-
*
|
|
551
|
-
*
|
|
552
|
-
* variables.
|
|
562
|
+
* It is the build's declaration plus what only the platform can supply: where to
|
|
563
|
+
* dispatch, what the worker may do, the credentials for doing and reporting it,
|
|
564
|
+
* and the resolved variable values.
|
|
553
565
|
*/
|
|
554
566
|
export declare const functionsRuntimeConfigSchema: z.ZodObject<{
|
|
555
567
|
runtimeKind: z.ZodLiteral<"functions">;
|
|
@@ -595,6 +607,7 @@ export declare const functionsRuntimeConfigSchema: z.ZodObject<{
|
|
|
595
607
|
gravatar: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
596
608
|
spam: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
597
609
|
email: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
610
|
+
content: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
598
611
|
}, z.core.$strip>>;
|
|
599
612
|
platform: z.ZodDefault<z.ZodObject<{
|
|
600
613
|
nextCache: z.ZodDefault<z.ZodBoolean>;
|
|
@@ -683,6 +696,7 @@ export declare const functionsDeployMetadataSchema: z.ZodObject<{
|
|
|
683
696
|
gravatar: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
684
697
|
spam: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
685
698
|
email: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
699
|
+
content: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
686
700
|
}, z.core.$strip>>;
|
|
687
701
|
platform: z.ZodDefault<z.ZodObject<{
|
|
688
702
|
nextCache: z.ZodDefault<z.ZodBoolean>;
|
|
@@ -696,11 +710,9 @@ export declare const functionsDeployMetadataSchema: z.ZodObject<{
|
|
|
696
710
|
}, z.core.$strict>;
|
|
697
711
|
export type FunctionsDeployMetadata = z.infer<typeof functionsDeployMetadataSchema>;
|
|
698
712
|
/**
|
|
699
|
-
* Builds the declaration a publish attaches to its version
|
|
700
|
-
*
|
|
701
|
-
*
|
|
702
|
-
* version agree on the shape by construction rather than by copying an object
|
|
703
|
-
* literal around — the same reason `createZeroRuntimeFinalizePayload` exists.
|
|
713
|
+
* Builds the declaration a publish attaches to its version, so the CLI's publish
|
|
714
|
+
* step and every test needing a Functions version agree on the shape by
|
|
715
|
+
* construction. Mirrors `createZeroRuntimeFinalizePayload`.
|
|
704
716
|
*/
|
|
705
717
|
export declare function createFunctionsSourceFinalize(input: {
|
|
706
718
|
appName: string;
|
|
@@ -718,12 +730,9 @@ export declare function createFunctionsSourceFinalize(input: {
|
|
|
718
730
|
}): FunctionsSourceFinalize;
|
|
719
731
|
/**
|
|
720
732
|
* What a version's worker is currently doing, as an observer of the space can
|
|
721
|
-
*
|
|
722
|
-
*
|
|
723
|
-
*
|
|
724
|
-
* content store or it is not, and dispatch is decided by which version is
|
|
725
|
-
* serving — so these three cover the whole space of answers, and each one is
|
|
726
|
-
* checkable rather than inferred from a job we ran earlier.
|
|
733
|
+
* determine. There is no upload state: a bundle is either in the version's
|
|
734
|
+
* content store or it is not, and dispatch follows whichever version is serving,
|
|
735
|
+
* so each of these three is checkable rather than inferred from an earlier job.
|
|
727
736
|
*/
|
|
728
737
|
export declare const functionsExecutionStateSchema: z.ZodEnum<{
|
|
729
738
|
ready: "ready";
|
|
@@ -734,17 +743,14 @@ export type FunctionsExecutionState = z.infer<typeof functionsExecutionStateSche
|
|
|
734
743
|
/**
|
|
735
744
|
* What a live worker is, as the `worker` member of a space's runtime status.
|
|
736
745
|
*
|
|
737
|
-
*
|
|
738
|
-
*
|
|
739
|
-
*
|
|
740
|
-
*
|
|
741
|
-
*
|
|
742
|
-
* version.
|
|
746
|
+
* No kind tag: the member it rides in already says which product answered, and
|
|
747
|
+
* the same tree can carry a capsule beside it. No `versionId`: the status
|
|
748
|
+
* response already names the live version. No `database` field:
|
|
749
|
+
* `capabilities.db` is the fact the whole `/db` family branches on, and stating
|
|
750
|
+
* it twice invites the two to disagree.
|
|
743
751
|
*
|
|
744
|
-
* Everything but `executionState`
|
|
745
|
-
*
|
|
746
|
-
* `database` field: `capabilities.db` is the fact the whole `/db` family
|
|
747
|
-
* branches on, and stating it twice invites the two to disagree.
|
|
752
|
+
* Everything but `executionState` comes from the version's finalize metadata, so
|
|
753
|
+
* this answers whether or not the origin is reachable.
|
|
748
754
|
*/
|
|
749
755
|
export declare const functionsAppSchema: z.ZodObject<{
|
|
750
756
|
artifactId: z.ZodString;
|
|
@@ -775,6 +781,7 @@ export declare const functionsAppSchema: z.ZodObject<{
|
|
|
775
781
|
gravatar: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
776
782
|
spam: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
777
783
|
email: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
784
|
+
content: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
778
785
|
}, z.core.$strip>>;
|
|
779
786
|
executionState: z.ZodEnum<{
|
|
780
787
|
ready: "ready";
|