@spacefast/common 0.0.13 → 0.0.17

package/dist/docs/catalog.d.ts

@@ -92,7 +92,7 @@ export declare const DOCS_CATALOG: readonly [{
     readonly title: "Publish receipt fields";
     readonly kind: "workflow";
     readonly tier: "full";
-    readonly summary: "Use the receipt as the source of truth: space.liveUrl, open.url, version.immutableUrl, claim.url, claim.expiresAt, links, diagnostics, and errors.";
+    readonly summary: "Use the receipt as the source of truth. Present open.url and claim.url as the two user-facing links; liveUrl and immutableUrl identify resources for automation.";
     readonly keywords: readonly ["receipt", "share", "claim", "diagnostics"];
     readonly url: "https://spacefast.com/docs/api#publish";
     readonly body: "receipt liveUrl open url immutableUrl claim expiresAt diagnostics links finalize promote upload errors docsUrl";
@@ -104,7 +104,7 @@ export declare const DOCS_CATALOG: readonly [{
     readonly summary: "After the owner claims an anonymous space with continuation enabled, exchange the saved claim token once for a durable space-scoped access token, save it over the claim token, and keep publishing.";
     readonly keywords: readonly ["continue", "exchange", "claim token", "space_claimed_credential_available", "continuation"];
     readonly url: "https://spacefast.com/docs/agents#continue-after-claim";
-    readonly body: "continue continuation claim token exchange voucher continue_space POST /v1/anonymous-claim/exchange space_claimed_credential_available continuation_used continuation_unavailable durable access token state.json update after claim claim_status";
+    readonly body: "continue continuation claim token exchange voucher publish execute POST /v1/anonymous-claim/exchange space_claimed_credential_available continuation_used continuation_unavailable durable access token state.json update after claim";
 }, {
     readonly slug: "workflow/secret-handling";
     readonly title: "Secret handling rules";
@@ -132,24 +132,6 @@ export declare const DOCS_CATALOG: readonly [{
     readonly keywords: readonly ["mcp", "stdio", "streamable http", "on-device", "local"];
     readonly url: "https://spacefast.com/docs/agents#mcp";
     readonly body: "MCP on-device local CLI stdio streamable HTTP sf mcp roots files workspace tool calls structuredContent apps";
-}, {
-    readonly slug: "workflow/workspace-files";
-    readonly title: "Agent workspace files";
-    readonly kind: "workflow";
-    readonly tier: "full";
-    readonly summary: "Hosted MCP workspace tools edit, import, export, and publish a durable virtual workspace; On-Device MCP workspace tools edit the bounded local root.";
-    readonly keywords: readonly ["workspace", "files", "patch", "diff", "virtual workspace", "workspace import", "workspace export", "just-bash"];
-    readonly url: "https://spacefast.com/docs/agents#workspace-files";
-    readonly body: "workspace file editing read write patch diff list manifest import export import_url hosted virtual workspace just-bash shell handoff on-device root SPACEFAST_MCP_WORKSPACE_ROOT secret scanning bounded files";
-}, {
-    readonly slug: "workflow/mcp-resources";
-    readonly title: "MCP resources for account, teams, spaces, and policy";
-    readonly kind: "workflow";
-    readonly tier: "full";
-    readonly summary: "Use read-only resources for bounded context before tools: account/current, teams/current, spaces/recent, space detail, recent versions, policy/current, and workspace/manifest.";
-    readonly keywords: readonly ["resources", "account", "teams", "spaces", "policy", "context"];
-    readonly url: "https://spacefast.com/docs/agents#mcp-resources";
-    readonly body: "MCP resources account current teams current list spaces recent space detail versions recent domains logs summary policy current workspace manifest tools catalog read-only context redacted";
 }, {
     readonly slug: "workflow/space-files";
     readonly title: "Space file conventions";
@@ -249,6 +231,33 @@ export declare const DOCS_CATALOG: readonly [{
     readonly keywords: readonly ["build", "git", "github", "ci", "push", "connect", "preview"];
     readonly url: "https://spacefast.com/docs/builds";
     readonly body: "Connect a repository with `sf git connect`; each push runs your build on Spacefast and publishes a version. Branch and pull-request previews are private by default; use Open for yourself or create a scoped Link for reviewers.";
+}, {
+    readonly slug: "runtimes";
+    readonly title: "Runtimes";
+    readonly kind: "guide";
+    readonly tier: "full";
+    readonly summary: "Run code on a space with Zero or Functions.";
+    readonly keywords: readonly ["runtime", "zero", "functions", "server", "dynamic", "code", "backend", "sf.jsonc"];
+    readonly url: "https://spacefast.com/docs/runtimes";
+    readonly body: "A space serves static files until you declare a `runtime` block in sf.jsonc. Zero is a capsule with its own database and transactions; Functions is a worker with one `fetch` handler and any npm package. Both compile during `sf publish`. Zero runs on plans with dedicated runtime isolation; Functions remains in private beta.";
+}, {
+    readonly slug: "runtimes/zero";
+    readonly title: "Spacefast Zero";
+    readonly kind: "guide";
+    readonly tier: "full";
+    readonly summary: "A capsule with a database: schema, queries, mutations, endpoints.";
+    readonly keywords: readonly ["zero", "capsule", "database", "schema", "query", "mutation", "endpoint", "transaction", "sql", "sf dev"];
+    readonly url: "https://spacefast.com/docs/runtimes/zero";
+    readonly body: "Zero is for apps where the data is the point. Write one capsule — schema, queries, mutations, endpoints — start it locally with `sf dev`, and `sf publish` puts it live with its own database on a plan with dedicated runtime isolation.";
+}, {
+    readonly slug: "runtimes/functions";
+    readonly title: "Spacefast Functions";
+    readonly kind: "guide";
+    readonly tier: "full";
+    readonly summary: "A worker for your space: one `fetch` handler, any npm package.";
+    readonly keywords: readonly ["functions", "worker", "fetch", "ssr", "cloudflare", "npm", "handler", "server", "api"];
+    readonly url: "https://spacefast.com/docs/runtimes/functions";
+    readonly body: "Functions runs a worker for your space: a default export with a `fetch` method, served from your space's own origin, so requests no file answers reach your code. Opt into a database with `\"database\": true`. Private beta — the team needs the flag.";
 }, {
     readonly slug: "collab";
     readonly title: "Comments";
@@ -591,58 +600,4 @@ export declare const DOCS_CATALOG: readonly [{
     readonly keywords: readonly ["api", "platform", "tenant", "infra", "openapi", "multi-tenant"];
     readonly url: "https://spacefast.com/docs/platforms";
     readonly body: "The platform API is the tenant-facing surface for operating Spacefast as hosting infra. It shares the `{ data }` / `{ error }` envelope and is documented via OpenAPI.";
-}, {
-    readonly slug: "recipes/github-deploys";
-    readonly title: "Publish from GitHub";
-    readonly kind: "recipe";
-    readonly tier: "full";
-    readonly summary: "Connect a repository so pushes publish automatically.";
-    readonly keywords: readonly ["github", "git", "ci", "push", "connect", "automatic", "recipe"];
-    readonly url: "https://spacefast.com/docs/builds";
-    readonly body: "Connect a repository with `sf git connect`; each push builds on Spacefast and publishes a version. Pull-request previews stay private until you create a scoped Link for reviewers.";
-}, {
-    readonly slug: "recipes/preview-channels";
-    readonly title: "Preview channels for pull requests";
-    readonly kind: "recipe";
-    readonly tier: "full";
-    readonly summary: "Give every branch a private preview with explicit sharing.";
-    readonly keywords: readonly ["preview", "channel", "branch", "pull request", "staging", "recipe"];
-    readonly url: "https://spacefast.com/docs/builds";
-    readonly body: "Push a branch or open a pull request on a connected repository, or publish to a named channel, to get an isolated private preview without touching production. Use Open for your own browser or create a scoped Link when someone else needs access.";
-}, {
-    readonly slug: "recipes/agent-publish";
-    readonly title: "Let an agent publish for you";
-    readonly kind: "recipe";
-    readonly tier: "full";
-    readonly summary: "Drive a first publish from an AI agent, then claim it.";
-    readonly keywords: readonly ["agent", "ai", "mcp", "anonymous", "claim", "automation", "recipe"];
-    readonly url: "https://spacefast.com/docs/anonymous-publish";
-    readonly body: "Let an agent publish anonymously for an instant URL and a claim token, then hand the token to a human who runs `sf spaces claim`.";
-}, {
-    readonly slug: "recipes/custom-domain";
-    readonly title: "Add a custom domain";
-    readonly kind: "recipe";
-    readonly tier: "full";
-    readonly summary: "Point your own domain at a space with automatic TLS.";
-    readonly keywords: readonly ["domain", "custom domain", "dns", "tls", "https", "recipe"];
-    readonly url: "https://spacefast.com/help/domains";
-    readonly body: "Add the domain with `sf domains add`, set the DNS records Spacefast prints, and wait for `sf domains check` to report a ready certificate.";
-}, {
-    readonly slug: "recipes/redirects";
-    readonly title: "Set up redirects";
-    readonly kind: "recipe";
-    readonly tier: "reference";
-    readonly summary: "Add redirect rules that ship and roll back with a version.";
-    readonly keywords: readonly ["redirect", "rewrite", "routing", "301", "recipe"];
-    readonly url: "https://spacefast.com/help/redirects";
-    readonly body: "Add redirect rules to a `_redirects` file at your publish root so they publish as part of the version and roll back with it.";
-}, {
-    readonly slug: "recipes/migrate-dns";
-    readonly title: "Migrate DNS to a custom domain";
-    readonly kind: "recipe";
-    readonly tier: "reference";
-    readonly summary: "Cut traffic over to a Spacefast-served domain safely.";
-    readonly keywords: readonly ["dns", "migrate", "cutover", "domain", "nameserver", "recipe"];
-    readonly url: "https://spacefast.com/help/domains";
-    readonly body: "Pre-stage the domain with `sf domains add`, verify the certificate is ready with `sf domains check`, then update DNS to flip traffic with zero downtime.";
 }, ...DocEntry[]];

package/dist/docs/catalog.js

@@ -17,6 +17,7 @@
 // and MCP search without a second hand-maintained corpus to drift.
 import { errorDocsUrl } from "../contracts/error-codes.js";
 import { ERROR_DOCS } from "./error-docs.js";
+import { renderSpacefastSkill, SPACEFAST_RECIPE_SKILLS } from "./skills.js";
 /** Which part of the docs a page belongs to (runtime list + derived type). */
 export const DOC_KINDS = ["guide", "cli", "api", "recipe", "workflow", "error"];
 /** Base URL all bundled docs links resolve against. */
@@ -99,7 +100,7 @@ const HAND_WRITTEN_DOCS_CATALOG = [
         title: "Publish receipt fields",
         kind: "workflow",
         tier: "full",
-        summary: "Use the receipt as the source of truth: space.liveUrl, open.url, version.immutableUrl, claim.url, claim.expiresAt, links, diagnostics, and errors.",
+        summary: "Use the receipt as the source of truth. Present open.url and claim.url as the two user-facing links; liveUrl and immutableUrl identify resources for automation.",
         keywords: ["receipt", "share", "claim", "diagnostics"],
         url: `${DOCS_BASE_URL}/api#publish`,
         body: "receipt liveUrl open url immutableUrl claim expiresAt diagnostics links finalize promote upload errors docsUrl",
@@ -118,7 +119,7 @@ const HAND_WRITTEN_DOCS_CATALOG = [
             "continuation",
         ],
         url: `${DOCS_BASE_URL}/agents#continue-after-claim`,
-        body: "continue continuation claim token exchange voucher continue_space POST /v1/anonymous-claim/exchange space_claimed_credential_available continuation_used continuation_unavailable durable access token state.json update after claim claim_status",
+        body: "continue continuation claim token exchange voucher publish execute POST /v1/anonymous-claim/exchange space_claimed_credential_available continuation_used continuation_unavailable durable access token state.json update after claim",
     },
     {
         slug: "workflow/secret-handling",
@@ -150,35 +151,6 @@ const HAND_WRITTEN_DOCS_CATALOG = [
         url: `${DOCS_BASE_URL}/agents#mcp`,
         body: "MCP on-device local CLI stdio streamable HTTP sf mcp roots files workspace tool calls structuredContent apps",
     },
-    {
-        slug: "workflow/workspace-files",
-        title: "Agent workspace files",
-        kind: "workflow",
-        tier: "full",
-        summary: "Hosted MCP workspace tools edit, import, export, and publish a durable virtual workspace; On-Device MCP workspace tools edit the bounded local root.",
-        keywords: [
-            "workspace",
-            "files",
-            "patch",
-            "diff",
-            "virtual workspace",
-            "workspace import",
-            "workspace export",
-            "just-bash",
-        ],
-        url: `${DOCS_BASE_URL}/agents#workspace-files`,
-        body: "workspace file editing read write patch diff list manifest import export import_url hosted virtual workspace just-bash shell handoff on-device root SPACEFAST_MCP_WORKSPACE_ROOT secret scanning bounded files",
-    },
-    {
-        slug: "workflow/mcp-resources",
-        title: "MCP resources for account, teams, spaces, and policy",
-        kind: "workflow",
-        tier: "full",
-        summary: "Use read-only resources for bounded context before tools: account/current, teams/current, spaces/recent, space detail, recent versions, policy/current, and workspace/manifest.",
-        keywords: ["resources", "account", "teams", "spaces", "policy", "context"],
-        url: `${DOCS_BASE_URL}/agents#mcp-resources`,
-        body: "MCP resources account current teams current list spaces recent space detail versions recent domains logs summary policy current workspace manifest tools catalog read-only context redacted",
-    },
     {
         slug: "workflow/space-files",
         title: "Space file conventions",
@@ -289,6 +261,57 @@ const HAND_WRITTEN_DOCS_CATALOG = [
         url: `${DOCS_BASE_URL}/builds`,
         body: "Connect a repository with `sf git connect`; each push runs your build on Spacefast and publishes a version. Branch and pull-request previews are private by default; use Open for yourself or create a scoped Link for reviewers.",
     },
+    {
+        slug: "runtimes",
+        title: "Runtimes",
+        kind: "guide",
+        tier: "full",
+        summary: "Run code on a space with Zero or Functions.",
+        keywords: ["runtime", "zero", "functions", "server", "dynamic", "code", "backend", "sf.jsonc"],
+        url: `${DOCS_BASE_URL}/runtimes`,
+        body: "A space serves static files until you declare a `runtime` block in sf.jsonc. Zero is a capsule with its own database and transactions; Functions is a worker with one `fetch` handler and any npm package. Both compile during `sf publish`. Zero runs on plans with dedicated runtime isolation; Functions remains in private beta.",
+    },
+    {
+        slug: "runtimes/zero",
+        title: "Spacefast Zero",
+        kind: "guide",
+        tier: "full",
+        summary: "A capsule with a database: schema, queries, mutations, endpoints.",
+        keywords: [
+            "zero",
+            "capsule",
+            "database",
+            "schema",
+            "query",
+            "mutation",
+            "endpoint",
+            "transaction",
+            "sql",
+            "sf dev",
+        ],
+        url: `${DOCS_BASE_URL}/runtimes/zero`,
+        body: "Zero is for apps where the data is the point. Write one capsule — schema, queries, mutations, endpoints — start it locally with `sf dev`, and `sf publish` puts it live with its own database on a plan with dedicated runtime isolation.",
+    },
+    {
+        slug: "runtimes/functions",
+        title: "Spacefast Functions",
+        kind: "guide",
+        tier: "full",
+        summary: "A worker for your space: one `fetch` handler, any npm package.",
+        keywords: [
+            "functions",
+            "worker",
+            "fetch",
+            "ssr",
+            "cloudflare",
+            "npm",
+            "handler",
+            "server",
+            "api",
+        ],
+        url: `${DOCS_BASE_URL}/runtimes/functions`,
+        body: 'Functions runs a worker for your space: a default export with a `fetch` method, served from your space\'s own origin, so requests no file answers reach your code. Opt into a database with `"database": true`. Private beta — the team needs the flag.',
+    },
     {
         slug: "collab",
         title: "Comments",
@@ -671,68 +694,17 @@ const HAND_WRITTEN_DOCS_CATALOG = [
         url: `${DOCS_BASE_URL}/platforms`,
         body: "The platform API is the tenant-facing surface for operating Spacefast as hosting infra. It shares the `{ data }` / `{ error }` envelope and is documented via OpenAPI.",
     },
-    // ----- Recipes ----------------------------------------------------------
-    {
-        slug: "recipes/github-deploys",
-        title: "Publish from GitHub",
-        kind: "recipe",
-        tier: "full",
-        summary: "Connect a repository so pushes publish automatically.",
-        keywords: ["github", "git", "ci", "push", "connect", "automatic", "recipe"],
-        url: `${DOCS_BASE_URL}/builds`,
-        body: "Connect a repository with `sf git connect`; each push builds on Spacefast and publishes a version. Pull-request previews stay private until you create a scoped Link for reviewers.",
-    },
-    {
-        slug: "recipes/preview-channels",
-        title: "Preview channels for pull requests",
-        kind: "recipe",
-        tier: "full",
-        summary: "Give every branch a private preview with explicit sharing.",
-        keywords: ["preview", "channel", "branch", "pull request", "staging", "recipe"],
-        url: `${DOCS_BASE_URL}/builds`,
-        body: "Push a branch or open a pull request on a connected repository, or publish to a named channel, to get an isolated private preview without touching production. Use Open for your own browser or create a scoped Link when someone else needs access.",
-    },
-    {
-        slug: "recipes/agent-publish",
-        title: "Let an agent publish for you",
-        kind: "recipe",
-        tier: "full",
-        summary: "Drive a first publish from an AI agent, then claim it.",
-        keywords: ["agent", "ai", "mcp", "anonymous", "claim", "automation", "recipe"],
-        url: `${DOCS_BASE_URL}/anonymous-publish`,
-        body: "Let an agent publish anonymously for an instant URL and a claim token, then hand the token to a human who runs `sf spaces claim`.",
-    },
-    {
-        slug: "recipes/custom-domain",
-        title: "Add a custom domain",
-        kind: "recipe",
-        tier: "full",
-        summary: "Point your own domain at a space with automatic TLS.",
-        keywords: ["domain", "custom domain", "dns", "tls", "https", "recipe"],
-        url: "https://spacefast.com/help/domains",
-        body: "Add the domain with `sf domains add`, set the DNS records Spacefast prints, and wait for `sf domains check` to report a ready certificate.",
-    },
-    {
-        slug: "recipes/redirects",
-        title: "Set up redirects",
-        kind: "recipe",
-        tier: "reference",
-        summary: "Add redirect rules that ship and roll back with a version.",
-        keywords: ["redirect", "rewrite", "routing", "301", "recipe"],
-        url: "https://spacefast.com/help/redirects",
-        body: "Add redirect rules to a `_redirects` file at your publish root so they publish as part of the version and roll back with it.",
-    },
-    {
-        slug: "recipes/migrate-dns",
-        title: "Migrate DNS to a custom domain",
-        kind: "recipe",
-        tier: "reference",
-        summary: "Cut traffic over to a Spacefast-served domain safely.",
-        keywords: ["dns", "migrate", "cutover", "domain", "nameserver", "recipe"],
-        url: "https://spacefast.com/help/domains",
-        body: "Pre-stage the domain with `sf domains add`, verify the certificate is ready with `sf domains check`, then update DNS to flip traffic with zero downtime.",
-    },
 ];
+const SKILL_RECIPE_DOCS = SPACEFAST_RECIPE_SKILLS.map((skill) => ({
+    slug: skill.recipe.slug,
+    title: skill.title,
+    kind: "recipe",
+    tier: skill.recipe.tier,
+    summary: skill.description,
+    keywords: [...skill.keywords, "recipe", "skill"],
+    url: skill.recipe.url,
+    body: renderSpacefastSkill(skill, "local"),
+}));
 // ----- Error reference (generated) -----------------------------------------
 // One reference-tier catalog entry per ERROR_DOCS member, so `sf docs <code>`,
 // `GET /v1/docs?q=<code>`, and MCP search all resolve error codes in a single
@@ -752,5 +724,6 @@ function errorDocsCatalogEntries() {
 }
 export const DOCS_CATALOG = [
     ...HAND_WRITTEN_DOCS_CATALOG,
+    ...SKILL_RECIPE_DOCS,
     ...errorDocsCatalogEntries(),
 ];