[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10},"actionData","errors","root",{"_303":304,"_305":306},"routes/_app.x.$handle.$name",{"_96":95,"_31":44,"_104":86,"_26":52,"_13":14,"_105":-5,"_11":106,"_107":108,"_109":110,"_111":112,"_113":114,"_20":-5,"_115":-5,"_116":-5,"_117":24,"_118":119,"_120":24,"_121":-5,"_122":-5,"_123":124},"routes/_app.x.$handle.$name.branch.$branch.version.$version.diff",{"_11":12,"_13":14,"_15":16,"_17":-5,"_18":-5},"project",{"_42":43,"_31":44,"_37":45,"_46":-5,"_47":24,"_48":49,"_50":49,"_51":52,"_53":-5,"_18":54,"_55":56,"_57":58,"_59":58,"_60":-5,"_61":62,"_63":64,"_65":-5,"_66":-5,"_67":-5,"_68":-5,"_69":70,"_71":70,"_72":73,"_74":73,"_75":73,"_76":70,"_77":70,"_78":79,"_80":81,"_82":83,"_84":24},"version",19,"changes",[19],"aiChatInfo","userId",{"_20":21,"_22":-7,"_23":24,"_25":24,"_26":27,"_28":27},"file",{"_29":30,"_31":32,"_33":34,"_35":36,"_37":38,"_39":14,"_40":41,"_23":24},"previous","deleted",false,"deletedHere","path","frontend/components/FunctionDocCard.tsx","latestPath","fileId","cc9d0a1e-c3e4-11f0-85f8-42dde27851f2","name","FunctionDocCard.tsx","fileType","script","content","/** @jsxImportSource https://esm.sh/react@18.2.0 */\n\nimport type { FunctionDoc } from \"../../shared/docTypes.ts\";\nimport { CodeBlock } from \"./CodeBlock.tsx\";\nimport { DocCommentDisplay } from \"./DocCommentDisplay.tsx\";\n\nexport interface FunctionDocCardProps {\n func: FunctionDoc;\n}\n\nexport function FunctionDocCard(props: FunctionDocCardProps) {\n const { func } = props;\n\n return (\n

\n {func.isAsync && async }\n {func.name}\n

\n \n {func.location.file}:{func.location.line}\n \n

\n {func.isExported && (\n \n exported\n \n )}\n

\n\n {func.comment && }\n\n

Signature

\n \n

\n\n {func.parameters.length > 0 && (\n

Parameters

\n \n \n \n \n \n \n \n \n \n \n {func.parameters.map((param) => (\n \n \n \n \n \n \n ))}\n \n

Name	Type	Optional	Default
{param.name}	{param.type}	{param.optional ? \"Yes\" : \"No\"}	\n {param.defaultValue \|\| \"-\"}\n

\n )}\n\n

Returns

\n {func.returnType}\n

\n );\n}\n","createdAt",["D",1763404790124],"branchVersion","branchId","b75c761a-c3dc-11f0-a370-42dde27851f2","id","b75c3768-c3dc-11f0-a370-42dde27851f2","docs-gen",["D",1763401318495],"deletedAt","legacyEnvVars","privacy","public","httpPrivacy","description","","imageUrl","5d1042a9-7b0b-499d-8a72-3a8ac7a4e185","pinnedFileId","ccc2b142-c3e4-11f0-b160-42dde27851f2","pinPreview",true,"pinMigrated","screenshotVersion","likeCount",0,"orgId","5f80108f-7ca4-4327-b77b-089dbe4b5a82","tursoName","tursoHostname","tursoMeasuredAt","pinned","userPerm","r","valPerm","blobPerm","rw","emailPerm","sqlitePerm","projectPerm","telemetryPerm","user",{"_96":95,"_103":99},"org",{"_96":95,"_97":-5,"_98":99,"_18":54,"_100":101,"_102":24},"branch",{"_13":85,"_31":86,"_42":41,"_87":43,"_88":-5,"_89":-5,"_90":-5,"_91":-5,"_92":-5,"_93":44,"_94":95},"isOwned",181,"main","projectId","forkedBranchId","forkedBranchVersion","forkedProjectPrivacy","forkedProjectId","forkedProjectOrgId","projectName","userHandle","nbbaier","handle","displayName","avatar","https://secure.gravatar.com/avatar/0129a541b7b3574e92c4afd06c5e32da&d=identicon","tier","pro","canRestrictVals","profileImageUrl","branchName","adoptOrgId",{"_42":43,"_31":44,"_37":299,"_46":-5,"_47":24,"_48":49,"_50":49,"_51":52,"_53":-5,"_18":54,"_55":56,"_57":58,"_59":58,"_60":-5,"_61":62,"_63":64,"_65":-5,"_66":-5,"_67":-5,"_68":-5,"_69":70,"_71":70,"_72":73,"_74":73,"_75":73,"_76":70,"_77":70,"_78":300,"_80":301,"_82":302,"_84":24},"tree",[201,204,211,212,213,214,215,216],"files",[201,202,203,204,205,206,207,208,209,210,211,212,213,214,215,216],"counts",{"_191":62,"_192":140,"_193":140,"_194":195,"_196":197},"contents",[125,126,127,128,129,130,131,132],"upstreamProject","upstreamBranch","emptyEnvVars","flags",[],"hasHttpFiles","grants","orgs","customDomains",{},{"_42":185,"_31":186,"_29":187,"_136":-5,"_40":41,"_39":188,"_138":58,"_37":189,"_13":62,"_33":177,"_35":-5,"_23":24,"_142":-5,"_26":190},{"_42":179,"_31":180,"_29":181,"_136":-5,"_40":41,"_39":182,"_138":58,"_37":183,"_13":62,"_33":177,"_35":-5,"_23":24,"_142":-5,"_26":184},{"_42":172,"_31":173,"_29":174,"_136":-5,"_40":41,"_39":175,"_138":58,"_37":176,"_13":62,"_33":177,"_35":-5,"_23":24,"_142":-5,"_26":178},{"_42":165,"_31":166,"_29":167,"_136":-5,"_40":41,"_39":168,"_138":58,"_37":169,"_13":62,"_33":20,"_35":170,"_23":24,"_142":-5,"_26":171},{"_42":158,"_31":159,"_29":160,"_136":-5,"_40":41,"_39":161,"_138":58,"_37":162,"_13":62,"_33":20,"_35":163,"_23":24,"_142":-5,"_26":164},{"_42":151,"_31":152,"_29":153,"_136":-5,"_40":41,"_39":154,"_138":24,"_37":155,"_13":62,"_33":20,"_35":156,"_23":24,"_142":-5,"_26":157},{"_42":144,"_31":145,"_29":146,"_136":-5,"_40":41,"_39":147,"_138":24,"_37":148,"_13":62,"_33":20,"_35":149,"_23":24,"_142":-5,"_26":150},{"_42":133,"_31":134,"_29":135,"_136":-5,"_40":41,"_39":137,"_138":58,"_37":139,"_13":140,"_33":20,"_35":141,"_23":24,"_142":-5,"_26":143},"2e7fb8d0-c3e0-11f0-beda-42dde27851f2","valtown-docs-generator-plan.md","d793abce-c3dc-11f0-b5a6-42dde27851f2","parentId",8,"latest",["D",1763402806837],1,"# Implementation Plan\n\n## Goal\n\n- After completion, visiting the published `docGenerator` HTTP val with a `?val=username/valname` query returns generated API docs < 3s for a representative public val.\n- Success criteria:\n - `GET /api/docs?val=acme/sample` responds 200 with parsed exports (functions, types, constants) in JSON validated against `DocManifest` schema.\n - UI route `/` renders documentation cards for the same sample val with syntax highlighting and navigation.\n - Cache hits logged for repeat requests within 1 hour, cache misses stay under 2 API calls per request and serve cached manifests/HTML within ~20 ms.\n- Scope boundaries:\n - No authentication for private vals, no editing/workspace features.\n - Multi-val/project aggregation and version diffing remain out of scope for v1.\n - UI polish limited to Tailwind-based theming without custom theming engine.\n\n## Analysis\n\n- Key components and responsibilities (to be created under `/backend`, `/frontend`, `/shared` as per AGENTS guidelines):\n - [backend/docGenerator.http.ts](/backend/docGenerator.http.ts#L1-L200) — Planned Hono HTTP entrypoint orchestrating fetch → parse → cache → render.\n - [backend/services/valFetcher.ts](/backend/services/valFetcher.ts#L1-L200) — Planned Val Town API client resolving val metadata and source bundle.\n - [backend/services/tsParser.ts](/backend/services/tsParser.ts#L1-L300) — Planned TypeScript compiler API walker emitting `ParsedDocumentation`.\n - [backend/services/docCache.ts](/backend/services/docCache.ts#L1-L160) — Planned blob-backed cache with memory front.\n - [shared/docTypes.ts](/shared/docTypes.ts#L1-L200) — Planned shared TypeScript interfaces for parser output and UI consumption.\n - [frontend/index.html](/frontend/index.html#L1-L200) & [frontend/App.tsx](/frontend/App.tsx#L1-L200) — Planned React shell rendering docs, search, and navigation.\n- Data/types affected:\n - `DocManifest`, `FunctionDoc`, `TypeDoc`, `ClassDoc`, `ConstantDoc`, `ImportInfo`; caching metadata `{ cacheKey: string; createdAt: number; version: string; }`.\n - Request DTO `{ val: string; refresh?: boolean }`, error envelope `{ code: string; message: string; details?: unknown }`.\n- Current flow:\n 1. Request enters Hono → query param validation.\n 2. Cache lookup by `valIdentifier@version` (memory → blob fallback).\n 3. On miss: fetch val metadata + files → parse AST → build manifest → persist cache.\n 4. API route returns JSON; UI route hydrates React with initial manifest + fetch fallback.\n\n## Approach\n\n- Establish shared documentation schemas and validation helpers first so backend and frontend contract is locked before logic work.\n- Implement val fetching and caching seams prior to TypeScript parsing to minimize external API pressure and enable testability via fixtures.\n- Build the TypeScript parser as a pure module with exhaustive unit tests, then integrate into the fetcher pipeline behind cache lookups.\n- Compose the Hono HTTP val with separate API (`/api/docs`) and UI (`/`) routes, injecting fetch/parse/cache services for easy stubbing.\n- Deliver the React/Twind frontend last, hydrating with server-injected manifest while supporting client-side refresh via the API.\n- Assumptions: `npm:typescript` bundling works in Val Town serverless context; Val Town REST endpoints for public vals require no auth; Tailwind via Twind CDN is acceptable for styling.\n\n## Step-by-Step Implementation\n\n> Sequence logically: refactor → scaffold → integrate (flagged) → validate → cleanup.\n\n### Step 1 — Define shared documentation contract\n\n**Intent:** Lock parser ↔ renderer contract and validation helpers before logic diverges.\n**Files:** [shared/docTypes.ts](/shared/docTypes.ts#L1-L200), [shared/docTypes.test.ts](/shared/docTypes.test.ts#L1-L160)\n**Change sketch:**\n\n```diff\n+ export interface DocManifest {\n+ val: string;\n+ version: string;\n+ generatedAt: string;\n+ exports: {\n+ functions: FunctionDoc[];\n+ classes: ClassDoc[];\n+ interfaces: InterfaceDoc[];\n+ types: TypeAliasDoc[];\n+ constants: ConstantDoc[];\n+ };\n+ imports: ImportInfo[];\n+ metadata: ValMetadata;\n+ }\n+\n+ export function assertDocManifest(data: unknown): asserts data is DocManifest {\n+ // runtime validation leveraging type predicates or zod-like helper (decide on zod dependency vs hand-rolled guards)\n+ }\n```\n\n**Preconditions:** None.\n**Postconditions:** Typed contract with runtime guard available for backend and frontend.\n**Checks:** Unit tests covering validation happy path and failure scenarios.\n\n### Step 2 — Scaffold Val Town fetcher and cache seams\n\n**Intent:** Provide deterministic data sources and caching hooks prior to parser integration.\n**Files:** [backend/services/valFetcher.ts](/backend/services/valFetcher.ts#L1-L200), [backend/services/docCache.ts](/backend/services/docCache.ts#L1-L200), [backend/services/**tests**/valFetcher.test.ts](/backend/services/__tests__/valFetcher.test.ts#L1-L200)\n**Change sketch:**\n\n```diff\n+ export interface ValFetcher {\n+ fetchLatest(val: string): Promise;\n+ }\n+\n+ export const docCache = createDocCache({\n+ ttlMs: 60 * 60 * 1000,\n+ blobPrefix: \"doc-manifest\",\n+ });\n```\n\n**Preconditions:** Step 1 contract finalized.\n**Postconditions:** Fetcher returns mocked data in tests; cache exposes get/set/isFresh with blob-backed implementation (no parser usage yet).\n**Checks:** Unit tests hitting Val Town API via mocked fetch; cache tests verifying TTL & key derivation.\n\n### Step 3 — Implement TypeScript parser module\n\n**Intent:** Build pure parsing logic producing the shared manifest structures without I/O coupling.\n**Files:** [backend/services/tsParser.ts](/backend/services/tsParser.ts#L1-L300), [backend/services/**tests**/tsParser.test.ts](/backend/services/__tests__/tsParser.test.ts#L1-L300), [test-fixtures/vals/simple.ts](/test-fixtures/vals/simple.ts#L1-L200)\n**Change sketch:**\n\n```diff\n+ export function parseValBundle(bundle: ValBundle): DocManifest {\n+ const program = ts.createProgram(\n+ bundle.files.map((file) => file.path),\n+ compilerOptions,\n+ createInMemoryCompilerHost(bundle)\n+ );\n+ // walk AST, fill manifest.exports\n+ return manifest;\n+ }\n```\n\n**Preconditions:** Step 1 types available; Step 2 supplies ValBundle shape.\n**Postconditions:** Parser returns manifest for fixture bundles with deterministic ordering; no cache integration yet.\n**Checks:** Unit tests for functions, classes, interfaces, type aliases, constants, malformed inputs.\n\n### Step 4 — Compose doc generation pipeline with caching\n\n**Intent:** Integrate fetcher, parser, and cache into orchestrated service exposing `generateDocs`, caching manifests and prerendered HTML for <3s responses.\n**Files:** [backend/services/docService.ts](/backend/services/docService.ts#L1-L200), [backend/services/**tests**/docService.test.ts](/backend/services/__tests__/docService.test.ts#L1-L200)\n**Change sketch:**\n\n```diff\n+ export interface CachedDocPayload {\n+ manifest: DocManifest;\n+ ssrHtml?: string;\n+ cachedAt: number;\n+ }\n+\n+ export async function generateDocs(val: string, opts: { refresh?: boolean }) {\n+ const cacheKey = deriveCacheKey(val);\n+ if (!opts.refresh) {\n+ const cached = await docCache.get(cacheKey);\n+ if (cached && !docCache.isExpired(cacheKey)) return cached;\n+ }\n+ const bundle = await valFetcher.fetchLatest(val);\n+ const manifest = parseValBundle(bundle);\n+ const payload: CachedDocPayload = { manifest, cachedAt: Date.now() };\n+ await docCache.set(cacheKey, payload, { version: bundle.version });\n+ return payload;\n+ }\n```\n\n**Preconditions:** Steps 1–3 merged.\n**Postconditions:** Single orchestration entry point with cache hit logging hook, rate-limited fetch usage; cached payload reusable for API and UI routes.\n**Checks:** Service tests mocking cache/fetcher to assert cache strategy, ttl handling, and refresh behavior.\n\n### Step 5 — Build Hono HTTP val routes\n\n**Intent:** Expose API and UI endpoints leveraging docService; ensure error handling & logging.\n**Files:** [backend/docGenerator.http.ts](/backend/docGenerator.http.ts#L1-L200), [backend/routes/apiDocs.ts](/backend/routes/apiDocs.ts#L1-L200), [backend/routes/ui.ts](/backend/routes/ui.ts#L1-L200), [backend/routes/**tests**/apiDocs.test.ts](/backend/routes/__tests__/apiDocs.test.ts#L1-L200)\n**Change sketch:**\n\n```diff\n+ app.get(\"/api/docs\", async (c) => {\n+ const val = c.req.query(\"val\");\n+ if (!val) return c.json({ code: \"BAD_REQUEST\" }, 400);\n+ const { manifest } = await generateDocs(val, { refresh: c.req.query(\"refresh\") === \"true\" });\n+ return c.json(manifest);\n+ });\n+\n+ app.get(\"/\", async (c) => {\n+ const initialVal = c.req.query(\"val\");\n+ const cached = initialVal ? await generateDocs(initialVal, { refresh: false }) : null;\n+ if (!cached?.manifest) {\n+ const emptyHtml = await renderIndexPage({ manifest: null, val: initialVal });\n+ return c.html(emptyHtml);\n+ }\n+ if (!cached.ssrHtml) {\n+ cached.ssrHtml = await renderIndexPage({ manifest: cached.manifest, val: initialVal });\n+ await docCache.set(deriveCacheKey(initialVal), cached, { version: cached.manifest.version });\n+ }\n+ return c.html(cached.ssrHtml);\n+ });\n```\n\n**Preconditions:** Step 4 ready.\n**Postconditions:** HTTP val deployed with API contract, SSR injecting initial manifest, error states handled.\n**Checks:** Integration tests via superdeno hitting API and root route; lint/typecheck.\n\n### Step 6 — Implement React/Twind frontend shell\n\n**Intent:** Deliver interactive documentation UI consuming manifest and supporting client fetch refresh.\n**Files:** [frontend/index.html](/frontend/index.html#L1-L200), [frontend/App.tsx](/frontend/App.tsx#L1-L200), [frontend/components/FunctionDoc.tsx](/frontend/components/FunctionDoc.tsx#L1-L200), [frontend/components/Sidebar.tsx](/frontend/components/Sidebar.tsx#L1-L200), [frontend/**tests**/App.test.tsx](/frontend/__tests__/App.test.tsx#L1-L200)\n**Change sketch:**\n\n```diff\n+ /** @jsxImportSource https://esm.sh/react@18.2.0 */\n+ import { useEffect, useState } from \"https://esm.sh/react@18.2.0\";\n+ export function App(props: { initialManifest?: DocManifest; initialVal?: string }) {\n+ const [manifest, setManifest] = useState(props.initialManifest ?? null);\n+ // render header, sidebar, main, search, dark mode toggle\n+ }\n```\n\n**Preconditions:** Step 5 HTML render helper able to inject `initialManifest`.\n**Postconditions:** Responsive UI with search/filter, syntax highlighting via Prism/Twind, copy-to-clipboard.\n**Checks:** Frontend unit tests with pre-rendered manifest, visual smoke test in Val Town.\n\n### Step 7 — Telemetry, rate limiting, and documentation\n\n**Intent:** Add request logging, cache hit metrics, rate limiting guard, and README instructions.\n**Files:** [backend/services/logger.ts](/backend/services/logger.ts#L1-L120), [backend/docGenerator.http.ts](/backend/docGenerator.http.ts#L1-L200), [README.md](/README.md#L1-L200)\n**Change sketch:**\n\n```diff\n+ app.use(\"/api/docs\", rateLimit({ windowMs: 60_000, max: 30 }));\n+ logger.info({ event: \"doc_cache_hit\", val, cacheKey });\n+ logger.info({ event: \"doc_cache_miss\", val, durationMs });\n+\n+## Usage\n+- Deploy `docGenerator` via Val Town HTTP val.\n```\n\n**Preconditions:** Core functionality stable (Steps 1–6).\n**Postconditions:** Observability and docs in place; rate limiting prevents abuse.\n**Checks:** Manual smoke tests, documentation review.\n\n## Open Questions\n\n- Confirm whether we must support fetching specific val versions (e.g., `?version=` query) in v1 or default to latest only.\n- Clarify if Tailwind via Twind CDN is acceptable for production or if inline Tailwind build step is preferred.\n- Determine acceptable rate limit thresholds and logging retention (where should logs emit?).\n\n## Resources\n\n- Build/test: `deno task check`, `deno test`, `deno lint`, `biome check .`\n- Docs: [Val Town API](https://docs.val.town/api/overview), [TypeScript Compiler API](https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API), [TSDoc Spec](https://tsdoc.org/).\n- Reference vals: `https://www.val.town/v/std/utils@85-main/index.ts`, `https://www.val.town/v/std/blob`.\n","label",[134],"cab59836-c3dc-11f0-9928-42dde27851f2","deno.json","cab598f4-c3dc-11f0-9928-42dde27851f2",2,["D",1763401350955],"{\n \"$schema\": \"https://raw.githubusercontent.com/denoland/deno/348900b8b79f4a434cab4c74b3bc8d4d2fa8ee74/cli/schemas/config-file.v1.json\",\n \"compilerOptions\": {\n \"lib\": [\n \"dom\",\n \"dom.iterable\",\n \"dom.asynciterable\",\n \"deno.ns\",\n \"deno.unstable\"\n ],\n \"noImplicitAny\": false,\n \"strict\": false,\n \"types\": [\"https://www.val.town/types/valtown.d.ts\"]\n },\n \"experimental\": {\n \"unstable-node-globals\": true,\n \"unstable-sloppy-imports\": true,\n \"unstable-temporal\": true,\n \"unstable-worker-options\": true\n },\n \"imports\": {\n \"@biomejs/biome\": \"npm:@biomejs/biome@^2.3.5\"\n },\n \"lint\": {\n \"files\": {\n \"include\": [\"deno:/https/esm.town/**/*\"]\n },\n \"rules\": {\n \"exclude\": [\"no-explicit-any\", \"no-import-prefix\"]\n }\n },\n \"lock\": false,\n \"nodeModulesDir\": \"auto\"\n}",[145],"cac88a18-c3dc-11f0-963c-42dde27851f2","biome.json","cac88aea-c3dc-11f0-963c-42dde27851f2",5,["D",1763401351043],"{\n \"$schema\": \"https://biomejs.dev/schemas/2.3.5/schema.json\",\n \"vcs\": { \"enabled\": true, \"clientKind\": \"git\", \"useIgnoreFile\": true },\n \"files\": { \"ignoreUnknown\": false },\n \"formatter\": { \"enabled\": true, \"indentStyle\": \"tab\" },\n \"linter\": { \"enabled\": true, \"rules\": { \"recommended\": true } },\n \"javascript\": { \"formatter\": { \"quoteStyle\": \"double\" } },\n \"assist\": {\n \"enabled\": true,\n \"actions\": { \"source\": { \"organizeImports\": \"on\" } }\n }\n}",[152],"cabf6d48-c3dc-11f0-8d89-42dde27851f2","AGENTS.md","cabf6dfc-c3dc-11f0-8d89-42dde27851f2",3,["D",1763401351018],"You are an advanced assistant specialized in generating Val Town code.\n\n## Core Guidelines\n\n- Ask clarifying questions when requirements are ambiguous\n- Provide complete, functional solutions rather than skeleton implementations\n- Test your logic against edge cases before presenting the final solution\n- Ensure all code follows Val Town's specific platform requirements\n- If a section of code that you're working on is getting too complex, consider\n refactoring it into subcomponents\n\n## Code Standards\n\n- Generate code in TypeScript or TSX\n- Add appropriate TypeScript types and interfaces for all data structures\n- Prefer official SDKs or libraries than writing API calls directly\n- Ask the user to supply API or library documentation if you are at all unsure\n about it\n- **Never bake in secrets into the code** - always use environment variables\n- Include comments explaining complex logic (avoid commenting obvious\n operations)\n- Follow modern ES6+ conventions and functional programming practices if\n possible\n\n## Types of triggers\n\n### 1. HTTP Trigger\n\n- Create web APIs and endpoints\n- Handle HTTP requests and responses\n- Example structure:\n\n```ts\nexport default async function (req: Request) {\n return new Response(\"Hello World\");\n}\n```\n\nFiles that are HTTP triggers have http in their name like `foobar.http.tsx`\n\n### 2. Cron Triggers\n\n- Run on a schedule\n- Use cron expressions for timing\n- Example structure:\n\n```ts\nexport default async function () {\n // Scheduled task code\n}\n```\n\nFiles that are Cron triggers have cron in their name like `foobar.cron.tsx`\n\n### 3. Email Triggers\n\n- Process incoming emails\n- Handle email-based workflows\n- Example structure:\n\n```ts\nexport default async function (email: Email) {\n // Process email\n}\n```\n\nFiles that are Email triggers have email in their name like `foobar.email.tsx`\n\n## Val Town Standard Libraries\n\nVal Town provides several hosted services and utility functions.\n\n### Blob Storage\n\n```ts\nimport { blob } from \"https://esm.town/v/std/blob\";\nawait blob.setJSON(\"myKey\", { hello: \"world\" });\nlet blobDemo = await blob.getJSON(\"myKey\");\nlet appKeys = await blob.list(\"app_\");\nawait blob.delete(\"myKey\");\n```\n\n### SQLite\n\n```ts\nimport { sqlite } from \"https://esm.town/v/stevekrouse/sqlite\";\nconst TABLE_NAME = \"todo_app_users_2\";\n// Create table - do this before usage and change table name when modifying schema\nawait sqlite.execute(`CREATE TABLE IF NOT EXISTS ${TABLE_NAME} (\n id INTEGER PRIMARY KEY AUTOINCREMENT,\n name TEXT NOT NULL\n)`);\n// Query data\nconst result = await sqlite.execute(\n `SELECT * FROM ${TABLE_NAME} WHERE id = ?`,\n [1],\n);\n```\n\nNote: When changing a SQLite table's schema, change the table's name (e.g., add\n_2 or _3) to create a fresh table.\n\n### OpenAI\n\n```ts\nimport { OpenAI } from \"https://esm.town/v/std/openai\";\nconst openai = new OpenAI();\nconst completion = await openai.chat.completions.create({\n messages: [\n { role: \"user\", content: \"Say hello in a creative way\" },\n ],\n model: \"gpt-4o-mini\",\n max_tokens: 30,\n});\n```\n\n### Email\n\n```ts\nimport { email } from \"https://esm.town/v/std/email\";\n// By default emails the owner of the val\nawait email({\n subject: \"Hi\",\n text: \"Hi\",\n html: \"

Hi

\",\n});\n```\n\n## Val Town Utility Functions\n\nVal Town provides several utility functions to help with common project tasks.\n\n### Importing Utilities\n\nAlways import utilities with version pins to avoid breaking changes:\n\n```ts\nimport {\n parseProject,\n readFile,\n serveFile,\n} from \"https://esm.town/v/std/utils@85-main/index.ts\";\n```\n\n### Available Utilities\n\n#### **serveFile** - Serve project files with proper content types\n\nFor example, in Hono:\n\n```ts\n// serve all files in frontend/ and shared/\napp.get(\"/frontend/*\", (c) => serveFile(c.req.path, import.meta.url));\napp.get(\"/shared/*\", (c) => serveFile(c.req.path, import.meta.url));\n```\n\n#### **readFile** - Read files from within the project:\n\n```ts\n// Read a file from the project\nconst fileContent = await readFile(\"/frontend/index.html\", import.meta.url);\n```\n\n#### **listFiles** - List all files in the project\n\n```ts\nconst files = await listFiles(import.meta.url);\n```\n\n#### **parseProject** - Extract information about the current project from import.meta.url\n\nThis is useful for including info for linking back to a val, ie in \"view source\"\nurls:\n\n```ts\nconst projectVal = parseProject(import.meta.url);\nconsole.log(projectVal.username); // Owner of the project\nconsole.log(projectVal.name); // Project name\nconsole.log(projectVal.version); // Version number\nconsole.log(projectVal.branch); // Branch name\nconsole.log(projectVal.links.self.project); // URL to the project page\n```\n\nHowever, it's _extremely importing_ to note that `parseProject` and other\nStandard Library utilities ONLY RUN ON THE SERVER. If you need access to this\ndata on the client, run it in the server and pass it to the client by splicing\nit into the HTML page or by making an API request for it.\n\n## Val Town Platform Specifics\n\n- **Redirects:** Use\n `return new Response(null, { status: 302, headers: { Location: \"/place/to/redirect\" }})`\n instead of `Response.redirect` which is broken\n- **Images:** Avoid external images or base64 images. Use emojis, unicode\n symbols, or icon fonts/libraries instead\n- **AI Image:** To inline generate an AI image use:\n `

`\n- **Storage:** DO NOT use the Deno KV module for storage\n- **Browser APIs:** DO NOT use the `alert()`, `prompt()`, or `confirm()` methods\n- **Weather Data:** Use open-meteo for weather data (doesn't require API keys)\n unless otherwise specified\n- **View Source:** Add a view source link by importing & using\n `import.meta.url.replace(\"ems.sh\", \"val.town)\"` (or passing this data to the\n client) and include `target=\"_top\"` attribute\n- **Error Debugging:** Add\n `` to HTML to capture\n client-side errors\n- **Error Handling:** Only use try...catch when there's a clear local\n resolution; Avoid catches that merely log or return 500s. Let errors bubble up\n with full context\n- **Environment Variables:** Use `Deno.env.get('keyname')` when you need to, but\n generally prefer APIs that don't require keys\n- **Imports:** Use `https://esm.sh` for npm and Deno dependencies to ensure\n compatibility on server and browser\n- **Storage Strategy:** Only use backend storage if explicitly required; prefer\n simple static client-side sites\n- **React Configuration:** When using React libraries, pin versions with\n `?deps=react@18.2.0,react-dom@18.2.0` and start the file with\n `/** @jsxImportSource https://esm.sh/react@18.2.0 */`\n- Ensure all React dependencies and sub-dependencies are pinned to the same\n version\n- **Styling:** Default to using TailwindCSS via\n `` unless otherwise\n specified\n\n## Project Structure and Design Patterns\n\n### Recommended Directory Structure\n\n```\n├── backend/\n│ ├── database/\n│ │ ├── migrations.ts # Schema definitions\n│ │ ├── queries.ts # DB query functions\n│ │ └── README.md\n│ └── routes/ # Route modules\n│ ├── [route].ts\n│ └── static.ts # Static file serving\n│ ├── index.ts # Main entry point\n│ └── README.md\n├── frontend/\n│ ├── components/\n│ │ ├── App.tsx\n│ │ └── [Component].tsx\n│ ├── favicon.svg\n│ ├── index.html # Main HTML template\n│ ├── index.tsx # Frontend JS entry point\n│ ├── README.md\n│ └── style.css\n├── README.md\n└── shared/\n ├── README.md\n └── utils.ts # Shared types and functions\n```\n\n### Backend (Hono) Best Practices\n\n- Hono is the recommended API framework\n- Main entry point should be `backend/index.ts`\n- **Static asset serving:** Use the utility functions to read and serve project\n files:\n ```ts\n import {\n readFile,\n serveFile,\n } from \"https://esm.town/v/std/utils@85-main/index.ts\";\n\n // serve all files in frontend/ and shared/\n app.get(\"/frontend/*\", (c) => serveFile(c.req.path, import.meta.url));\n app.get(\"/shared/*\", (c) => serveFile(c.req.path, import.meta.url));\n\n // For index.html, often you'll want to bootstrap with initial data\n app.get(\"/\", async (c) => {\n let html = await readFile(\"/frontend/index.html\", import.meta.url);\n\n // Inject data to avoid extra round-trips\n const initialData = await fetchInitialData();\n const dataScript = ``;\n\n html = html.replace(\"\", `${dataScript}`);\n return c.html(html);\n });\n ```\n- Create RESTful API routes for CRUD operations\n- Always include this snippet at the top-level Hono app to re-throwing errors to\n see full stack traces:\n ```ts\n // Unwrap Hono errors to see original error details\n app.onError((err, c) => {\n throw err;\n });\n ```\n\n### Database Patterns\n\n- Run migrations on startup or comment out for performance\n- Change table names when modifying schemas rather than altering\n- Export clear query functions with proper TypeScript typing\n\n## Common Gotchas and Solutions\n\n1. **Environment Limitations:**\n - Val Town runs on Deno in a serverless context, not Node.js\n - Code in `shared/` must work in both frontend and backend environments\n - Cannot use `Deno` keyword in shared code\n - Use `https://esm.sh` for imports that work in both environments\n\n2. **SQLite Peculiarities:**\n - Limited support for ALTER TABLE operations\n - Create new tables with updated schemas and copy data when needed\n - Always run table creation before querying\n\n3. **React Configuration:**\n - All React dependencies must be pinned to 18.2.0\n - Always include `@jsxImportSource https://esm.sh/react@18.2.0` at the top of\n React files\n - Rendering issues often come from mismatched React versions\n\n4. **File Handling:**\n - Val Town only supports text files, not binary\n - Use the provided utilities to read files across branches and forks\n - For files in the project, use `readFile` helpers\n\n5. **API Design:**\n - `fetch` handler is the entry point for HTTP vals\n - Run the Hono app with\n `export default app.fetch // This is the entry point for HTTP vals`",[159],"cac32640-c3dc-11f0-9928-42dde27851f2",".vtignore","cac3271c-c3dc-11f0-9928-42dde27851f2",4,["D",1763401351042],".git\n.vscode\n.cursor\n.DS_Store\nnode_modules\nvendor",[166],"cc47c946-c3e4-11f0-8a14-42dde27851f2","shared","cc47c9fa-c3e4-11f0-8a14-42dde27851f2",11,["D",1763404789566],"directory",[173],"cc29d652-c3e4-11f0-8a14-42dde27851f2","frontend","cc29d738-c3e4-11f0-8a14-42dde27851f2",9,["D",1763404789368],[180],"cc382342-c3e4-11f0-8a14-42dde27851f2","backend","cc382428-c3e4-11f0-8a14-42dde27851f2",10,["D",1763404789463],[186],"pulls","branches","forks","envVars",{"_198":140,"_200":62},"connections",{"_198":62,"_199":62},"count","unfilledCount","emptyCount",{"_42":185,"_31":186,"_29":187,"_136":-5,"_40":41,"_39":188,"_138":58,"_37":296,"_13":62,"_33":177,"_35":-5,"_23":24,"_142":-5,"_218":297,"_26":298},{"_42":289,"_31":290,"_29":291,"_136":187,"_40":41,"_39":292,"_138":58,"_37":293,"_13":62,"_33":177,"_35":-5,"_23":24,"_142":-5,"_218":294,"_26":295},{"_42":282,"_31":283,"_29":284,"_136":187,"_40":41,"_39":285,"_138":58,"_37":286,"_13":62,"_33":177,"_35":-5,"_23":24,"_142":-5,"_218":287,"_26":288},{"_42":179,"_31":180,"_29":181,"_136":-5,"_40":41,"_39":182,"_138":58,"_37":279,"_13":62,"_33":177,"_35":-5,"_23":24,"_142":-5,"_218":280,"_26":281},{"_42":274,"_31":257,"_29":253,"_136":181,"_40":41,"_39":275,"_138":58,"_37":276,"_13":62,"_33":177,"_35":-5,"_23":24,"_142":-5,"_218":277,"_26":278},{"_42":266,"_31":267,"_29":268,"_136":253,"_40":41,"_39":269,"_138":24,"_37":270,"_13":62,"_33":34,"_35":271,"_23":24,"_142":-5,"_218":272,"_26":273},{"_42":258,"_31":259,"_29":260,"_136":253,"_40":41,"_39":261,"_138":24,"_37":262,"_13":62,"_33":34,"_35":263,"_23":24,"_142":-5,"_218":264,"_26":265},{"_42":252,"_31":32,"_29":30,"_136":253,"_40":41,"_39":14,"_138":24,"_37":254,"_13":62,"_33":34,"_35":36,"_23":24,"_142":-5,"_218":255,"_26":256},{"_42":244,"_31":245,"_29":246,"_136":181,"_40":41,"_39":247,"_138":24,"_37":248,"_13":62,"_33":20,"_35":249,"_23":24,"_142":-5,"_218":250,"_26":251},{"_42":236,"_31":237,"_29":238,"_136":181,"_40":41,"_39":239,"_138":24,"_37":240,"_13":62,"_33":34,"_35":241,"_23":24,"_142":-5,"_218":242,"_26":243},{"_42":172,"_31":173,"_29":174,"_136":-5,"_40":41,"_39":175,"_138":58,"_37":233,"_13":62,"_33":177,"_35":-5,"_23":24,"_142":-5,"_218":234,"_26":235},{"_42":165,"_31":166,"_29":167,"_136":-5,"_40":41,"_39":168,"_138":58,"_37":230,"_13":62,"_33":20,"_35":170,"_23":24,"_142":-5,"_218":231,"_26":232},{"_42":158,"_31":159,"_29":160,"_136":-5,"_40":41,"_39":161,"_138":58,"_37":227,"_13":62,"_33":20,"_35":163,"_23":24,"_142":-5,"_218":228,"_26":229},{"_42":151,"_31":152,"_29":153,"_136":-5,"_40":41,"_39":154,"_138":24,"_37":224,"_13":62,"_33":20,"_35":156,"_23":24,"_142":-5,"_218":225,"_26":226},{"_42":144,"_31":145,"_29":146,"_136":-5,"_40":41,"_39":147,"_138":24,"_37":221,"_13":62,"_33":20,"_35":149,"_23":24,"_142":-5,"_218":222,"_26":223},{"_42":133,"_31":134,"_29":135,"_136":-5,"_40":41,"_39":137,"_138":58,"_37":217,"_13":140,"_33":20,"_35":141,"_23":24,"_142":-5,"_218":219,"_26":220},["D",1763402806837],"children",[],[134],["D",1763401350955],[],[145],["D",1763401351043],[],[152],["D",1763401351018],[],[159],["D",1763401351042],[],[166],["D",1763404789566],[],[173],"cc81206a-c3e4-11f0-8120-42dde27851f2","index.tsx","cc81213c-c3e4-11f0-8120-42dde27851f2",15,["D",1763404789941],"/** @jsxImportSource https://esm.sh/react@18.2.0 */\n\nimport React from \"https://esm.sh/react@18.2.0\";\nimport { createRoot } from \"https://esm.sh/react-dom@18.2.0/client\";\nimport { App } from \"./components/App.tsx\";\n\n// Get initial data injected by server\nconst initialData = (window as any).__INITIAL_DATA__ || {};\n\nconst root = createRoot(document.getElementById(\"root\")!);\nroot.render(\n \n \n \n);\n",[],[180,237],"cc8da0d8-c3e4-11f0-85f8-42dde27851f2","index.html","cc8da1a0-c3e4-11f0-85f8-42dde27851f2",17,["D",1763404789982],"\n\n\n \n \n Val Town Documentation Generator\n\n \n \n\n \n \n\n \n\n\n

\n\n \n \n\n\n",[],[180,245],"cc9d0924-c3e4-11f0-85f8-42dde27851f2","cc53b332-c3e4-11f0-8a14-42dde27851f2",["D",1763404790124],[],[180,257,32],"components","cc959216-c3e4-11f0-982c-42dde27851f2","ClassDocCard.tsx","cc959324-c3e4-11f0-982c-42dde27851f2",18,["D",1763404789982],"/** @jsxImportSource https://esm.sh/react@18.2.0 */\n\nimport type { ClassDoc } from \"../../shared/docTypes.ts\";\nimport { CodeBlock } from \"./CodeBlock.tsx\";\nimport { DocCommentDisplay } from \"./DocCommentDisplay.tsx\";\n\nexport interface ClassDocCardProps {\n cls: ClassDoc;\n}\n\nexport function ClassDocCard(props: ClassDocCardProps) {\n const { cls } = props;\n\n return (\n

\n {cls.isAbstract && abstract }\n class {cls.name}\n

\n \n {cls.location.file}:{cls.location.line}\n \n {cls.extends && (\n

\n extends {cls.extends}\n

\n )}\n {cls.implements && cls.implements.length > 0 && (\n

\n implements{\" \"}\n {cls.implements.map((impl, i) => (\n \n {impl}\n {i < cls.implements!.length - 1 && \", \"}\n \n ))}\n

\n )}\n

\n {cls.isExported && (\n \n exported\n \n )}\n

\n\n {cls.comment && }\n\n {cls.constructor && (\n

Constructor

\n {cls.constructor.parameters.length > 0 && (\n \n \n \n \n \n \n \n \n {cls.constructor.parameters.map((param) => (\n \n \n \n \n ))}\n \n

Parameter	Type
{param.name}	{param.type}

\n )}\n

\n )}\n\n {cls.properties.length > 0 && (\n

Properties

\n {cls.properties.map((prop) => (\n

\n \n {prop.visibility !== \"public\" && (\n {prop.visibility} \n )}\n {prop.isReadonly && readonly }\n {prop.name}: {prop.type}\n \n {prop.isOptional && (\n optional\n )}\n

\n {prop.comment && (\n

\n {prop.comment.description}\n

\n )}\n

\n ))}\n

\n )}\n\n {cls.methods.length > 0 && (\n

Methods

\n {cls.methods.map((method) => (\n

\n {method.visibility !== \"public\" && (\n {method.visibility} \n )}\n {method.isStatic && static }\n {method.isAsync && async }\n {method.name}()\n

\n {method.comment && (\n

\n {method.comment.description}\n

\n )}\n

\n ))}\n

\n )}\n

\n );\n}\n",[],[180,257,259],"cc8686b8-c3e4-11f0-83ba-42dde27851f2","App.tsx","cc86876c-c3e4-11f0-83ba-42dde27851f2",16,["D",1763404789974],"/** @jsxImportSource https://esm.sh/react@18.2.0 */\n\nimport { useState, useEffect } from \"https://esm.sh/react@18.2.0\";\nimport type { DocManifest } from \"../../shared/docTypes.ts\";\nimport { Header } from \"./Header.tsx\";\nimport { Sidebar } from \"./Sidebar.tsx\";\nimport { MainContent } from \"./MainContent.tsx\";\nimport { ErrorMessage } from \"./ErrorMessage.tsx\";\nimport { LoadingSpinner } from \"./LoadingSpinner.tsx\";\n\nexport interface AppProps {\n initialManifest?: DocManifest;\n initialVal?: string;\n error?: string;\n}\n\nexport function App(props: AppProps) {\n const [manifest, setManifest] = useState(\n props.initialManifest || null,\n );\n const [val, setVal] = useState(props.initialVal || \"\");\n const [loading, setLoading] = useState(false);\n const [error, setError] = useState(props.error || null);\n const [searchQuery, setSearchQuery] = useState(\"\");\n\n // Fetch documentation for a val\n const fetchDocs = async (valIdentifier: string, refresh = false) => {\n if (!valIdentifier) return;\n\n setLoading(true);\n setError(null);\n\n try {\n const url = `/api/docs?val=${encodeURIComponent(valIdentifier)}${\n refresh ? \"&refresh=true\" : \"\"\n }`;\n const response = await fetch(url);\n\n if (!response.ok) {\n const errorData = await response.json();\n throw new Error(errorData.message || \"Failed to fetch documentation\");\n }\n\n const data = await response.json();\n setManifest(data);\n setVal(valIdentifier);\n\n // Update URL without reload\n const newUrl = `/?val=${encodeURIComponent(valIdentifier)}`;\n window.history.pushState({}, \"\", newUrl);\n } catch (err) {\n setError(err instanceof Error ? err.message : \"Unknown error\");\n setManifest(null);\n } finally {\n setLoading(false);\n }\n };\n\n // Handle val input submission\n const handleSubmit = (valIdentifier: string) => {\n fetchDocs(valIdentifier, false);\n };\n\n // Handle refresh\n const handleRefresh = () => {\n if (val) {\n fetchDocs(val, true);\n }\n };\n\n return (\n

\n \n\n {error && (\n

\n \n

\n )}\n\n {loading && (\n

\n \n

\n )}\n\n {!loading && !error && manifest && (\n

\n \n \n

\n )}\n\n {!loading && !error && !manifest && (\n

\n Val Town Documentation Generator\n

\n Enter a val identifier (e.g., \"username/valname\") above to generate\n documentation\n

Features

\n 📝\n Automatic extraction of functions, classes, interfaces, types, and constants\n
\n 💬\n JSDoc comment parsing with @param, @returns, and @example tags\n
\n 🔍\n Search and filter functionality\n
\n ⚡\n Fast caching for quick subsequent loads\n
\n 🎨\n Clean, responsive UI with syntax highlighting\n

\n )}\n

\n );\n}\n",[],[180,257,267],"cc53b27e-c3e4-11f0-8a14-42dde27851f2",12,["D",1763404789643],[206,207,208],[180,257],["D",1763404789368],[205,209,210],[180],"cc6fffce-c3e4-11f0-8120-42dde27851f2","services","cc70008c-c3e4-11f0-8120-42dde27851f2",14,["D",1763404789828],[],[186,283],"cc622fd4-c3e4-11f0-8120-42dde27851f2","routes","cc62307e-c3e4-11f0-8120-42dde27851f2",13,["D",1763404789730],[],[186,290],["D",1763404789463],[202,203],[186],["D",1763401318495],{"_96":95,"_103":99},{"_96":95,"_97":-5,"_98":99,"_18":54,"_100":101,"_102":24},{"_13":85,"_31":86,"_42":41,"_87":43,"_88":-5,"_89":-5,"_90":-5,"_91":-5,"_92":-5,"_93":44,"_94":95},"ctx",{"_78":-5,"_122":336,"_337":338,"_339":340,"_341":24,"_342":24,"_343":24,"_344":58,"_345":-5,"_346":-7,"_347":-7,"_348":62,"_349":24,"_350":24,"_351":-5,"_352":24,"_353":24,"_354":24,"_355":-5},"ENV",{"_307":308,"_309":310,"_311":86,"_312":313,"_314":315,"_316":317,"_318":319,"_320":321,"_322":323,"_324":325,"_326":327,"_328":329,"_330":331,"_332":333,"_334":335},"REACT_APP_SENTRY_DSN","https://586020d86f05489db63a554690acf1e9@o1398359.ingest.sentry.io/6724499","RENDER_GIT_COMMIT","71c1b20804b3232a7e513be260cfffc1932a9e97","RENDER_GIT_BRANCH","POSTHOG_API_TOKEN","phc_nmoyuAkStEZuUp69rYlg1DZgrIt19Gx0Y4Hwf8tGgJP","POSTHOG_API_HOST","https://wart.val.town","WEB_API_TEMPLATE","https://{val}.web.val.run","APP_URL","https://www.val.town","MODULE_URL","https://esm.town","VANITY_WEB_API_TEMPLATE","https://{label}.val.run/","DENOLS_URL","https://lsp.val.town","NODE_ENV","production","CLOUDFLARE_TURNSTILE_SITE_KEY","0x4AAAAAACtaIZJH7s9rBMZ6","GOOGLE_CLIENT_ID","875989696899-jtsqkhlbdv5jrlsk8631p7ipjg3c6o62.apps.googleusercontent.com","STRIPE_PUBLISHABLE_KEY","pk_live_51N2zvWEpZTTLipIkVEwXrUG9AT0yeOOEYxszarZT1jpsZV58Ly6wlg3SltZpHN26CUalOBmUSY7adQRQiSkCZz2500qSXNkf8Y","API_URL","https://api.val.town",[],"preferencesKeybindings","default","preferencesTheme","light","preferencesFixers","preferencesCopilot","preferencesSelectionAi","preferencesCloseBrackets","preferencesChatPanelState","preferencesDprint","preferencesDenofmt","notificationCount","flagDenols","isBusinessOrgMember","businessOrgHandle","isBusinessOrgAdmin","isHigherTownieTier","navCollapsed","currentOrgId"]

Diff · v19