Weekly Product Demo

\"\n },\n \"recording_enabled\": {\n \"type\": \"boolean\",\n \"x-nullable\": false,\n \"description\": \"\",\n \"example\": false\n },\n \"recording_public\": {\n \"type\": \"boolean\",\n \"x-nullable\": false,\n \"description\": \"\",\n \"example\": false\n },\n \"show_in_company_page\": {\n \"type\": \"boolean\",\n \"x-nullable\": false,\n \"description\": \"\",\n \"example\": false\n },\n \"chat_enabled\": {\n \"type\": \"boolean\",\n \"x-nullable\": false,\n \"description\": \"\",\n \"example\": false\n },\n \"questions_enabled\": {\n \"type\": \"boolean\",\n \"x-nullable\": false,\n \"description\": \"\",\n \"example\": false\n },\n \"polls_enabled\": {\n \"type\": \"boolean\",\n \"x-nullable\": false,\n \"description\": \"\",\n \"example\": false\n }\n }\n },\n \"relationships\": {\n \"type\": \"object\",\n \"properties\": {\n \"sessions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"x-nullable\": false,\n \"description\": \"\",\n \"example\": \"sessions\"\n },\n \"attributes\": {\n \"type\": \"object\",\n \"properties\": {\n \"estimated_started_at\": {\n \"type\": \"string\"\n },\n \"timezone\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"example\": [\n {\n \"type\": \"sessions\",\n \"attributes\": {\n \"estimated_started_at\": \"2020-11-28 10:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n }\n ],\n \"x-nullable\": true,\n \"description\": \"\"\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}",[],[211,221,213],"fixtures","3d15c0ee-41ed-11f0-9b5d-76b3cceeab13",237,["D",1749114763630],"directory",[166],[211,221],"3cfc9588-41ed-11f0-bf2d-76b3cceeab13",236,["D",1749114763467],[165,167],[211],"3d4a4cc4-41ed-11f0-b765-76b3cceeab13","types.ts","897e97ea-3a44-11f0-ba91-9e149126039e","24db8e42-3a3a-11f0-b6b1-9e149126039e",240,["D",1749114763958],2,"\n// Types for OpenAPI schema\nexport interface OpenApiSchema {\n paths: Record;\n // Other OpenAPI properties we might need\n}\n\nexport interface PathItem {\n get?: OperationObject;\n post?: OperationObject;\n put?: OperationObject;\n delete?: OperationObject;\n // Other HTTP methods\n}\n\nexport interface OperationObject {\n summary?: string;\n description?: string;\n operationId?: string;\n parameters?: ParameterObject[];\n requestBody?: RequestBodyObject;\n responses?: Record;\n // Other operation properties\n}\n\nexport interface ParameterObject {\n name: string;\n in: string; // \"query\", \"header\", \"path\", \"cookie\"\n description?: string;\n required?: boolean;\n schema?: SchemaObject;\n}\n\nexport interface SchemaObject {\n type?: string;\n format?: string;\n description?: string;\n properties?: Record;\n items?: SchemaObject;\n required?: string[];\n enum?: any[];\n default?: any;\n minimum?: number;\n maximum?: number;\n minLength?: number;\n maxLength?: number;\n pattern?: string;\n nullable?: boolean;\n oneOf?: SchemaObject[];\n anyOf?: SchemaObject[];\n allOf?: SchemaObject[];\n additionalProperties?: boolean | SchemaObject;\n}\n\nexport interface RequestBodyObject {\n description?: string;\n content?: Record;\n required?: boolean;\n}\n\nexport interface MediaTypeObject {\n schema?: SchemaObject;\n}\n\nexport interface ResponseObject {\n description: string;\n content?: Record;\n}",[],[243,234],"src","3d46ac18-41ed-11f0-bf2d-76b3cceeab13","mcp.ts","99adff20-3229-11f0-a2d7-569c3dd06744",239,["D",1749114763950],85,"import {\n McpServer,\n ResourceTemplate,\n} from \"npm:@modelcontextprotocol/sdk/server/mcp.js\";\nimport {\n extractGetEndpoints,\n extractMutationEndpoints,\n fetchOpenApiSpec,\n proxyRequest,\n} from \"../src/livestorm.ts\";\nimport { z } from \"npm:zod\";\nimport type { OperationObject, SchemaObject } from \"./types.ts\";\n\ntype ZodTypeAny = z.ZodTypeAny;\ntype ZodObject = z.ZodObject;\n\n// Cache for the MCP server instance\nlet mcpServerInstance: McpServer | null = null;\n\n// Helper type for parameter schemas\ntype ParameterSchema = {\n type: \"string\" | \"number\" | \"boolean\" | \"object\" | \"array\";\n description?: string;\n required?: boolean;\n items?: ParameterSchema;\n properties?: Record;\n};\n\n/**\n * Sets up the MCP server with resources and tools based on the Livestorm API\n * Uses a cached instance if available\n */\nexport async function setupMcpServer(): Promise {\n // Return cached instance if available\n if (mcpServerInstance) {\n return mcpServerInstance;\n }\n\n // Create a new MCP server\n const server = new McpServer({\n name: \"livestorm-api-server\",\n version: \"1.0.0\",\n description: \"MCP server that provides access to Livestorm API endpoints\",\n }, { capabilities: { logging: {} } });\n\n try {\n console.log(\"Fetching Livestorm API OpenAPI spec...\");\n // Fetch the OpenAPI spec\n const openApiSpec = await fetchOpenApiSpec();\n\n // Extract GET endpoints (Resources)\n const getEndpoints = extractGetEndpoints(openApiSpec);\n\n // Extract mutation endpoints (Tools)\n const mutationEndpoints = extractMutationEndpoints(openApiSpec);\n\n // Register Resources\n for (const [operationId, endpoint] of Object.entries(getEndpoints)) {\n registerResource(server, operationId, endpoint);\n }\n\n // Register Tools\n for (const [operationId, endpoint] of Object.entries(mutationEndpoints)) {\n registerTool(server, operationId, endpoint);\n }\n\n // Cache the server instance\n mcpServerInstance = server;\n\n return server;\n } catch (error) {\n console.error(\"Error setting up MCP server:\", error);\n throw error;\n }\n}\n\n/**\n * Registers a GET endpoint as an MCP Resource\n */\nfunction registerResource(\n server: McpServer,\n operationId: string,\n endpoint: { path: string; operation: any },\n) {\n const { path, operation } = endpoint;\n const name = operation.summary?.replace(/\\s+/g, \"_\").toLowerCase() ||\n nameFromOperationId(operationId);\n const resourcePath = `livestorm:/${path}` as string;\n const resourceTpl = new ResourceTemplate(resourcePath, {\n list: undefined,\n }) as ResourceTemplate;\n\n const resourceCallback = async (uri: URL, params: any) => {\n console.log(\"Resource callback called for endpoint:\", endpoint);\n console.log(\"Resource callback called with params:\", params);\n try {\n // Extract path parameters from the URL\n const pathParams: Record = {};\n const queryParams: Record = {};\n const headers: Headers = new Headers();\n\n // Process path and query parameters\n if (operation.parameters) {\n for (const param of operation.parameters) {\n if (param.in === \"query\" && params[param.name] !== undefined) {\n queryParams[param.name] = String(params[param.name]);\n } else if (param.in === \"path\") {\n // Extract path parameters from the URL\n const paramName = param.name;\n const paramValue = uri.pathname.split(\"/\").pop();\n if (paramValue) {\n pathParams[paramName] = paramValue;\n }\n }\n }\n }\n\n // Add any additional headers from params if they exist\n if (params.headers) {\n Object.entries(params.headers as Record).forEach(\n ([key, value]) => {\n if (value !== undefined && value !== null) {\n headers.set(key, `${value}`);\n }\n },\n );\n }\n\n // Make the request to the Livestorm API\n const response = await proxyRequest(\n path,\n \"GET\",\n { ...pathParams, ...queryParams },\n );\n\n if (!response.ok) {\n const errorText = await response.text();\n throw new Error(\n `Livestorm API error: ${response.status} ${response.statusText} - ${errorText}`,\n );\n }\n\n const data = await response.json();\n return {\n contents: [{\n uri: uri.href,\n text: JSON.stringify(data),\n }],\n };\n } catch (error) {\n console.error(`Error in resource ${operationId}:`, error);\n throw error;\n }\n };\n\n // Create a resource template with the path\n if (resourcePath.includes(\"id}\")) {\n server.resource(name, resourceTpl, resourceCallback);\n } else {\n server.resource(name, resourcePath, resourceCallback);\n }\n}\n\n/**\n * Registers a POST, PUT, or DELETE endpoint as an MCP Tool\n */\nfunction registerTool(\n server: McpServer,\n operationId: string,\n endpoint: { method: string; path: string; operation: any },\n) {\n const { method, path, operation } = endpoint;\n\n // Create parameter schema from the operation\n const parameterSchema = createParameterSchema(operation);\n\n // Register the tool with the server\n server.tool(\n operation.summary?.replace(/\\s+/g, \"_\").toLowerCase() ||\n nameFromOperationId(operationId),\n operation.summary,\n parameterSchema.inputSchema,\n async (params: Record = {}) => {\n try {\n console.log(\n \"Tool callback called for operationId:\",\n nameFromOperationId(operationId),\n );\n console.log(\"Tool callback called with params:\", params);\n\n // Extract path and query parameters\n const pathParams: Record = {};\n const queryParams: Record = {};\n const headers: Record = {};\n\n // Process parameters based on their location\n if (operation.parameters) {\n for (const param of operation.parameters) {\n const paramValue = params[param.name];\n if (param.in === \"path\" && paramValue !== undefined) {\n pathParams[param.name] = `${paramValue}`;\n } else if (param.in === \"query\" && paramValue !== undefined) {\n queryParams[param.name] = `${paramValue}`;\n } else if (param.in === \"header\" && paramValue !== undefined) {\n headers[param.name] = `${paramValue}`;\n }\n }\n }\n\n // Process request body if present\n let body: any = undefined;\n if (params.body !== undefined) {\n body = params.body;\n }\n\n // Create a new Headers instance\n const requestHeaders = new Headers();\n\n // Copy existing headers\n for (const [key, value] of Object.entries(headers)) {\n requestHeaders.set(key, `${value}`);\n }\n\n // Add Authorization header if not already present\n if (\n !requestHeaders.has(\"Authorization\") && params.headers?.Authorization\n ) {\n const authValue = params.headers.Authorization;\n if (typeof authValue === \"string\") {\n requestHeaders.set(\"Authorization\", authValue);\n } else if (authValue && typeof authValue === \"object\") {\n requestHeaders.set(\"Authorization\", JSON.stringify(authValue));\n } else if (authValue !== undefined && authValue !== null) {\n requestHeaders.set(\"Authorization\", `${authValue}`);\n }\n }\n\n // Make the request to the Livestorm API\n const response = await proxyRequest(\n path,\n method,\n { ...pathParams, ...queryParams },\n body,\n );\n\n if (!response.ok) {\n const errorText = await response.text();\n throw new Error(\n `Livestorm API error: ${response.status} ${response.statusText} - ${errorText}`,\n );\n }\n\n // Return the response data\n const data = await response.json();\n return {\n content: [{\n type: \"text\",\n text: JSON.stringify(data),\n }],\n };\n } catch (error) {\n console.error(`Error in tool ${operationId}:`, error);\n throw error;\n }\n },\n );\n}\n\n/**\n * Converts an operation ID to a name for the MCP server\n */\nfunction nameFromOperationId(operationId: string): string {\n return operationId\n // Replace {id} with 'by ID'\n .replace(/\\{id\\}/g, \" by ID\")\n // Replace {resource_id} with 'by Resource ID'\n .replace(/\\{(\\w+)_id\\}/g, \" by $1 ID\")\n // Convert to title case\n .replace(/^[a-z]+/, (verb) => verb.charAt(0).toUpperCase() + verb.slice(1))\n // Convert to lower case\n .toLowerCase();\n}\n\n/**\n * Creates a tool schema from an OpenAPI operation\n * Returns an object with input and output schemas using Zod\n *\n * Example output:\n * {\n * description: \"Get weather information for a city\",\n * inputSchema: {\n * city: z.string().describe(\"City name\"),\n * country: z.string().describe(\"Country code (e.g., US, UK)\")\n * },\n * outputSchema: {\n * temperature: z.object({\n * celsius: z.number(),\n * fahrenheit: z.number()\n * }),\n * conditions: z.enum([\"sunny\", \"cloudy\", \"rainy\", \"stormy\", \"snowy\"]),\n * humidity: z.number().min(0).max(100),\n * wind: z.object({\n * speed_kmh: z.number(),\n * direction: z.string()\n * })\n * }\n * }\n */\nexport function createParameterSchema(operation: OperationObject): {\n description: string;\n inputSchema: Record;\n} {\n const inputSchema: Record = {};\n\n const requestSchema = operation.requestBody\n ?.content[\"application/vnd.api+json\"]?.schema;\n const responseSchema = operation.responses[\"201\"]\n ?.content[\"application/vnd.api+json\"]?.schema?.properties?.data.allOf[1];\n\n // Iterate through the schema elements and add those to the inputSchema as Zod types\n for (\n const [key, schema] of Object.entries(requestSchema?.properties || {})\n ) {\n inputSchema[key] = createZodSchema(schema);\n }\n\n return {\n description: operation.description || operation.summary ||\n \"No description available\",\n inputSchema,\n };\n}\n\nfunction createZodSchema(schema: SchemaObject): z.ZodTypeAny {\n // if the type of this schema is an object then recursively create a zod schema for each property\n let property: z.ZodTypeAny;\n const properties: Record = {};\n switch (schema.type) {\n case \"object\":\n for (const [key, schm] of Object.entries(schema.properties)) {\n properties[key] = createZodSchema(schm);\n }\n return z.object(properties);\n case \"array\":\n property = z.array(createZodSchema(schema.items));\n break;\n case \"string\":\n property = z.string();\n break;\n case \"number\":\n property = z.number();\n break;\n case \"boolean\":\n property = z.boolean();\n break;\n default:\n return z.object({});\n }\n\n if (schema.default) {\n property.default(schema.default);\n }\n\n return property;\n}\n",[],[243,245],"3d359cd4-41ed-11f0-85c3-76b3cceeab13","livestorm.ts","8cb46c32-3229-11f0-a36c-569c3dd06744",238,["D",1749114763837],17,"import \"https://deno.land/std@0.224.0/dotenv/load.ts\";\nimport { parse as parseYaml } from \"https://esm.sh/yaml@2.3.1\";\nimport { OpenApiSchema, OperationObject } from \"./types.ts\";\nimport { blob } from \"https://esm.town/v/std/blob\";\nimport { ValTownBlobNotFoundError } from \"https://esm.town/v/std/ValTownBlobNotFoundError\";\nimport { ValTownBlobError } from \"https://esm.town/v/std/ValTownBlobError\";\n\n// URL of the Livestorm API OpenAPI definition\nconst LIVESTORM_API_SPEC_URL =\n \"https://api.livestorm.co/api-docs/v1/swagger.yaml\";\nconst LIVESTORM_API_BASE_URL = \"https://api.livestorm.co/v1\";\n\n// Cache key for storing the OpenAPI spec in Blob storage\nconst OPENAPI_SPEC_CACHE_KEY = \"livestorm-openapi-spec\";\n\n/**\n * Fetches the Livestorm API OpenAPI definition\n */\nexport async function fetchOpenApiSpec(): Promise {\n try {\n // Check if the OpenAPI spec is cached in Blob storage\n let response;\n try {\n response = await blob.get(OPENAPI_SPEC_CACHE_KEY);\n console.log(`Using cached OpenAPI spec from Blob storage`);\n } catch (e) {\n if (\n e instanceof ValTownBlobNotFoundError || e instanceof ValTownBlobError\n ) {\n console.log(`Fetching OpenAPI spec from ${LIVESTORM_API_SPEC_URL}...`);\n response = await fetch(LIVESTORM_API_SPEC_URL);\n if (!response.ok) {\n const errorText = await response.text();\n console.error(\n `Failed to fetch OpenAPI spec: ${response.status} ${response.statusText}`,\n );\n console.error(`Response body: ${errorText}`);\n throw new Error(\n `Failed to fetch OpenAPI spec: ${response.status} ${response.statusText}`,\n );\n }\n } else {\n throw e;\n }\n }\n\n const yamlText = await response.text();\n let parsedSpec: OpenApiSchema;\n try {\n parsedSpec = parseYaml(yamlText);\n // Validate the parsed spec has the expected structure\n if (!parsedSpec || !parsedSpec.paths) {\n throw new Error(\"Invalid OpenAPI spec: missing paths property\");\n }\n } catch (parseError) {\n console.error(\"Error parsing OpenAPI spec YAML:\", parseError);\n throw new Error(\n `Failed to parse OpenAPI spec: ${\n parseError instanceof Error ? parseError.message : String(parseError)\n }`,\n );\n }\n\n // Cache the OpenAPI spec in Blob storage\n try {\n await blob.set(OPENAPI_SPEC_CACHE_KEY, yamlText);\n } catch (e) {\n console.error(\"Error caching OpenAPI spec:\", e);\n }\n\n return parsedSpec;\n } catch (error) {\n console.error(\"Error fetching OpenAPI spec:\", error);\n throw error;\n }\n}\n\n/**\n * Extracts GET endpoints from the OpenAPI spec\n */\nexport function extractGetEndpoints(spec: OpenApiSchema) {\n const getEndpoints: Record<\n string,\n { path: string; operation: OperationObject }\n > = {};\n\n for (const [path, pathItem] of Object.entries(spec.paths)) {\n if (pathItem.get) {\n const operationId = pathItem.get.operationId ||\n `get${path.replace(/\\//g, \"_\")}`;\n getEndpoints[operationId] = {\n path,\n operation: pathItem.get,\n };\n }\n }\n return getEndpoints;\n}\n\n/**\n * Extracts POST, PUT, DELETE endpoints from the OpenAPI spec\n */\nexport function extractMutationEndpoints(spec: OpenApiSchema) {\n const mutationEndpoints: Record<\n string,\n { method: string; path: string; operation: OperationObject }\n > = {};\n\n for (const [path, pathItem] of Object.entries(spec.paths)) {\n if (pathItem.post) {\n const operationId = pathItem.post.operationId ||\n `post${path.replace(/\\//g, \"_\")}`;\n mutationEndpoints[operationId] = {\n method: \"POST\",\n path,\n operation: pathItem.post,\n };\n }\n\n if (pathItem.put) {\n const operationId = pathItem.put.operationId ||\n `put${path.replace(/\\//g, \"_\")}`;\n mutationEndpoints[operationId] = {\n method: \"PUT\",\n path,\n operation: pathItem.put,\n };\n }\n\n if (pathItem.delete) {\n const operationId = pathItem.delete.operationId ||\n `delete${path.replace(/\\//g, \"_\")}`;\n mutationEndpoints[operationId] = {\n method: \"DELETE\",\n path,\n operation: pathItem.delete,\n };\n }\n }\n\n console.log(\n `Found ${\n Object.keys(mutationEndpoints).length\n } mutation endpoints to register as Tools`,\n );\n return mutationEndpoints;\n}\n\n/**\n * Proxies a request to the Livestorm API\n */\nexport async function proxyRequest(\n path: string,\n method: string,\n queryParams: Record,\n body?: any,\n): Promise {\n // Replace path parameters in the URL\n let url = `${LIVESTORM_API_BASE_URL}${path}`;\n\n // Extract path parameters and replace them in the URL\n const pathParamRegex = /{([^}]+)}/g;\n let match;\n while ((match = pathParamRegex.exec(url)) !== null) {\n const paramName = match[1];\n if (queryParams[paramName]) {\n url = url.replace(\n `{${paramName}}`,\n encodeURIComponent(queryParams[paramName]),\n );\n delete queryParams[paramName]; // Remove from query params after using\n } else {\n throw new Error(`Missing required path parameter: ${paramName}`);\n }\n }\n\n // Add remaining query parameters\n const queryString = Object.entries(queryParams)\n .filter(([_, value]) =>\n value !== undefined && value !== null && value !== \"\"\n )\n .map(([key, value]) =>\n `${encodeURIComponent(key)}=${encodeURIComponent(value)}`\n )\n .join(\"&\");\n\n if (queryString) {\n url += `?${queryString}`;\n }\n\n // Prepare headers\n const requestHeaders = new Headers();\n\n // Forward the Authorization header\n const authHeader = Deno.env.get(\"LIVESTORM_API_TOKEN\");\n if (!authHeader) {\n throw new Error(\n \"Authorization header is required for Livestorm API requests\",\n );\n }\n requestHeaders.set(\"Authorization\", authHeader);\n\n requestHeaders.set(\"Content-Type\", \"application/json\");\n requestHeaders.set(\"Accept\", \"application/json\");\n\n // Prepare request options\n const requestOptions: RequestInit = {\n method,\n headers: requestHeaders,\n };\n\n // Add body for POST, PUT methods\n if (body && (method === \"POST\" || method === \"PUT\")) {\n requestOptions.body = typeof body === \"string\"\n ? body\n : JSON.stringify(body);\n }\n\n console.log(\n `Proxying ${method} request to ${url} with body: ${JSON.stringify(body)}`,\n );\n\n try {\n // Make the request to Livestorm API\n const response = await fetch(url, requestOptions);\n\n // Return the response\n return response;\n } catch (error) {\n console.error(`Error proxying request to ${url}:`, error);\n throw new Error(\n `Failed to proxy request to Livestorm API: ${\n error instanceof Error ? error.message : String(error)\n }`,\n );\n }\n}\n",[],[243,254],"24db8d84-3a3a-11f0-b6b1-9e149126039e",146,["D",1748268184928],[161,162,163],[243],"8a580f2e-322f-11f0-8f74-569c3dd06744","rules","8a580fec-322f-11f0-8f74-569c3dd06744","8a3ae926-322f-11f0-b9a4-569c3dd06744",23,["D",1747384021429],"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`\n",[],[276,268],".windsurf","8a3ae886-322f-11f0-b9a4-569c3dd06744",22,["D",1747384021237],[159],[276],["D",1747380605211],{"_11":12,"_117":67},{"_11":12,"_113":-5,"_66":67,"_30":65,"_114":115,"_116":24},{"_38":104,"_13":16,"_32":35,"_105":69,"_106":-5,"_107":-5,"_108":-5,"_109":-5,"_110":-5,"_111":14,"_112":12},"ctx",{"_51":-5,"_136":319,"_320":321,"_322":323,"_324":24,"_325":24,"_326":24,"_327":81,"_328":-5,"_329":-7,"_330":-7,"_331":26,"_332":24,"_333":24,"_334":-5,"_335":24,"_336":24,"_337":24,"_338":-5},"ENV",{"_290":291,"_292":293,"_294":16,"_295":296,"_297":298,"_299":300,"_301":302,"_303":304,"_305":306,"_307":308,"_309":310,"_311":312,"_313":314,"_315":316,"_317":318},"REACT_APP_SENTRY_DSN","https://586020d86f05489db63a554690acf1e9@o1398359.ingest.sentry.io/6724499","RENDER_GIT_COMMIT","81405aa0531e90dfbb71a5bf473aaa0cf4c8702f","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"]

History · .vtignore