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 { parseProject, readFile, serveFile } from \"https://esm.town/v/std/utils@85-main/index.ts\";\n```\n\n### Available Utilities\n\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\" urls:\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 Standard Library utilities ONLY RUN ON THE SERVER.\nIf you need access to this data on the client, run it in the server and pass it to the client by splicing it into the HTML page\nor by making an API request for it.\n\n## Val Town Platform Specifics\n\n- **Redirects:** Use `return new Response(null, { status: 302, headers: { Location: \"/place/to/redirect\" }})` instead of `Response.redirect` which is broken\n- **Images:** Avoid external images or base64 images. Use emojis, unicode symbols, or icon fonts/libraries instead\n- **AI Image:** To inline generate an AI image use: `

`\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) unless otherwise specified\n- **View Source:** Add a view source link by importing & using `import.meta.url.replace(\"ems.sh\", \"val.town)\"` (or passing this data to the client) and include `target=\"_top\"` attribute\n- **Error Debugging:** Add `` to HTML to capture client-side errors\n- **Error Handling:** Only use try...catch when there's a clear local resolution; Avoid catches that merely log or return 500s. Let errors bubble up with full context\n- **Environment Variables:** Use `Deno.env.get('keyname')` when you need to, but generally prefer APIs that don't require keys\n- **Imports:** Use `https://esm.sh` for npm and Deno dependencies to ensure compatibility on server and browser\n- **Storage Strategy:** Only use backend storage if explicitly required; prefer simple static client-side sites\n- **React Configuration:** When using React libraries, pin versions with `?deps=react@18.2.0,react-dom@18.2.0` and start the file with `/** @jsxImportSource https://esm.sh/react@18.2.0 */`\n- Ensure all React dependencies and sub-dependencies are pinned to the same version\n- **Styling:** Default to using TailwindCSS via `` unless otherwise specified\n\n## Project Structure and Design Patterns\n\n### Recommended Directory Structure\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 files:\n ```ts\n import { readFile, serveFile } 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 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- 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 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 `export default app.fetch // This is the entry point for HTTP vals`\n\n",[],[249],"6c9796c2-8f12-11f0-950d-0224a6c84d84",".vtignore","ee2f49b8-8e87-11f0-a784-0224a6c84d84",46,["D",1757596974212],".git\n.vscode\n.cursorrules\n.DS_Store\nnode_modules\nvendor\nbible-sdk-*",[],[257],"6cb77870-8f12-11f0-bfab-0224a6c84d84",".npmignore","6cb77924-8f12-11f0-bfab-0224a6c84d84",["D",1757596974001],".vscode/\n.vt/\nnode_modules/\ndist/\n*.ts\n*.json\n!README.md\n!LICENSE\ndeno.json\nopenapi.json\nexample.ts",[],[265],"6c786be4-8f12-11f0-8642-0224a6c84d84",".gitignore","6c786c70-8f12-11f0-8642-0224a6c84d84",40,["D",1757596974043],[],[272],"6c74a2fc-8f12-11f0-ac83-0224a6c84d84","bible-sdk.js","6c74a3b0-8f12-11f0-ac83-0224a6c84d84","6c65fcac-8f12-11f0-bfab-0224a6c84d84",39,["D",1757596974006],"// Auto-generated by https://github.com/vladkens/apigen-ts\n// Source: ./openapi.json\nexport class FreeUseBibleSDK {\n constructor(config) {\n this.general = {\n getAvailableTranslations: () => {\n return this.Fetch('get', '/api/available_translations.json', {});\n },\n getBooksForTranslation: (translation) => {\n return this.Fetch('get', `/api/${translation}/books.json`, {});\n },\n getChapterFromTranslation: (translation, book, chapter) => {\n return this.Fetch('get', `/api/${translation}/${book}/${chapter}.json`, {});\n },\n getAvailableCommentaries: () => {\n return this.Fetch('get', '/api/available_commentaries.json', {});\n },\n getBooksForCommentary: (commentary) => {\n return this.Fetch('get', `/api/c/${commentary}/books.json`, {});\n },\n getChapterFromCommentary: (commentary, book, chapter) => {\n return this.Fetch('get', `/api/c/${commentary}/${book}/${chapter}.json`, {});\n },\n getProfilesForCommentary: (commentary) => {\n return this.Fetch('get', `/api/c/${commentary}/profiles.json`, {});\n },\n getProfileFromCommentary: (commentary, profile) => {\n return this.Fetch('get', `/api/c/${commentary}/profiles/${profile}.json`, {});\n },\n };\n this.Config = { baseUrl: '/', headers: {}, ...config };\n }\n async ParseError(rep) {\n try {\n return await rep.json();\n }\n catch (e) {\n throw rep;\n }\n }\n PrepareFetchUrl(path) {\n let base = this.Config.baseUrl;\n if ('location' in globalThis && (base === '' || base.startsWith('/'))) {\n const { location } = globalThis;\n base = `${location.origin}${base.endsWith('/') ? base : `/${base}`}`;\n }\n return new URL(path, base);\n }\n async Fetch(method, path, opts = {}) {\n const url = this.PrepareFetchUrl(path);\n for (const [k, v] of Object.entries(opts?.search ?? {})) {\n url.searchParams.append(k, Array.isArray(v) ? v.join(',') : v);\n }\n const configHeaders = typeof this.Config.headers === 'function' ? await this.Config.headers(method, path) : this.Config.headers;\n const headers = new Headers({ ...configHeaders, ...opts.headers });\n const ct = headers.get('content-type') ?? 'application/json';\n let body = undefined;\n if (ct === 'multipart/form-data' || ct === 'application/x-www-form-urlencoded') {\n headers.delete('content-type');\n body = ct === 'multipart/form-data' ? new FormData() : new URLSearchParams();\n for (const [k, v] of Object.entries(opts.body)) {\n body.append(k, v);\n }\n }\n if (ct === 'application/json' && typeof opts.body !== 'string') {\n headers.set('content-type', 'application/json');\n body = JSON.stringify(opts.body);\n }\n const credentials = opts.credentials ?? 'include';\n const rep = await fetch(url.toString(), { method, ...opts, headers, body, credentials });\n if (!rep.ok)\n throw await this.ParseError(rep);\n const rs = await rep.text();\n try {\n return JSON.parse(rs);\n }\n catch (e) {\n return rs;\n }\n }\n}\n",[],[287,279],"dist","6c7e642c-8f12-11f0-be33-0224a6c84d84","bible-sdk.d.ts","6c7e6508-8f12-11f0-be33-0224a6c84d84",41,["D",1757596974004],"type Headers = Record;\nexport type ApigenHeaders = Headers | ((method: string, path: string) => Headers | Promise);\nexport interface ApigenConfig {\n baseUrl: string;\n headers: ApigenHeaders;\n}\nexport interface ApigenRequest extends Omit {\n search?: Record;\n body?: unknown;\n}\nexport declare class FreeUseBibleSDK {\n Config: ApigenConfig;\n constructor(config?: Partial);\n ParseError(rep: Response): Promise;\n PrepareFetchUrl(path: string): URL;\n Fetch(method: string, path: string, opts?: ApigenRequest): Promise;\n general: {\n getAvailableTranslations: () => Promise;\n getBooksForTranslation: (translation: string) => Promise;\n getChapterFromTranslation: (translation: string, book: string, chapter: number) => Promise;\n getAvailableCommentaries: () => Promise;\n getBooksForCommentary: (commentary: string) => Promise;\n getChapterFromCommentary: (commentary: string, book: string, chapter: number) => Promise;\n getProfilesForCommentary: (commentary: string) => Promise;\n getProfileFromCommentary: (commentary: string, profile: string) => Promise;\n };\n}\nexport type AudioLinks = Record;\nexport type AvailableCommentaries = {\n commentaries: Commentary[];\n};\nexport type AvailableTranslations = {\n translations: Translation[];\n};\nexport type ChapterContent = ChapterHeading | ChapterLineBreak | ChapterHebrewSubtitle | ChapterVerse;\nexport type ChapterData = {\n number: number;\n content: ChapterContent[];\n footnotes: ChapterFootnote[];\n};\nexport type ChapterFootnote = {\n noteId: number;\n text: string;\n reference?: {\n chapter?: number;\n verse?: number;\n } | null;\n caller: string | null;\n};\nexport type ChapterHeading = {\n type: 'heading';\n content: string[];\n};\nexport type ChapterHebrewSubtitle = {\n type: 'hebrew_subtitle';\n content: (string | FormattedText | VerseFootnoteReference)[];\n};\nexport type ChapterLineBreak = {\n type: 'line_break';\n};\nexport type ChapterVerse = {\n type: 'verse';\n number: number;\n content: (string | FormattedText | InlineHeading | InlineLineBreak | VerseFootnoteReference)[];\n};\nexport type Commentary = {\n id: string;\n name: string;\n englishName: string;\n website: string;\n licenseUrl: string;\n shortName: string;\n language: string;\n languageName?: string | null;\n languageEnglishName?: string | null;\n textDirection: 'ltr' | 'rtl';\n availableFormats: ('json' | 'usfm')[];\n listOfBooksApiLink: string;\n numberOfBooks: number;\n totalNumberOfChapters: number;\n totalNumberOfVerses: number;\n};\nexport type CommentaryBook = {\n id: string;\n name: string;\n commonName: string;\n introduction?: string | null;\n order: number;\n firstChapterApiLink: string;\n lastChapterApiLink: string;\n numberOfChapters: number;\n totalNumberOfVerses: number;\n};\nexport type CommentaryBookChapter = {\n commentary: Commentary;\n book: CommentaryBook;\n thisChapterLink: string;\n nextChapterApiLink?: string | null;\n previousChapterApiLink?: string | null;\n numberOfVerses: number;\n chapter: CommentaryChapterData;\n};\nexport type CommentaryBooks = {\n commentary: Commentary;\n books: CommentaryBook[];\n};\nexport type CommentaryChapterData = {\n number: number;\n introduction?: string | null;\n content: ChapterVerse[];\n};\nexport type CommentaryProfile = {\n id: string;\n subject: string;\n reference?: VerseRef | null;\n thisProfileLink: string;\n referenceChapterLink?: string | null;\n};\nexport type CommentaryProfileContent = {\n commentary: Commentary;\n profile: CommentaryProfile;\n content: string[];\n};\nexport type CommentaryProfiles = {\n commentary: Commentary;\n profiles: CommentaryProfile[];\n};\nexport type FormattedText = {\n text: string;\n poem?: number | null;\n wordsOfJesus?: boolean | null;\n};\nexport type InlineHeading = {\n heading: string;\n};\nexport type InlineLineBreak = {\n lineBreak: boolean;\n};\nexport type Translation = {\n id: string;\n name: string;\n englishName: string;\n website: string;\n licenseUrl: string;\n shortName: string;\n language: string;\n languageName?: string | null;\n languageEnglishName?: string | null;\n textDirection: 'ltr' | 'rtl';\n availableFormats: ('json' | 'usfm')[];\n listOfBooksApiLink: string;\n numberOfBooks: number;\n totalNumberOfChapters: number;\n totalNumberOfVerses: number;\n numberOfApocryphalBooks?: number | null;\n totalNumberOfApocryphalChapters?: number | null;\n totalNumberOfApocryphalVerses?: number | null;\n};\nexport type TranslationBook = {\n id: string;\n translationId: string;\n name: string;\n commonName: string;\n title?: string | null;\n order: number;\n numberOfChapters: number;\n firstChapterApiLink: string;\n lastChapterApiLink: string;\n totalNumberOfVerses: number;\n isApocryphal?: boolean | null;\n};\nexport type TranslationBookChapter = {\n translation: Translation;\n book: TranslationBook;\n thisChapterLink: string;\n thisChapterAudioLinks: AudioLinks;\n nextChapterApiLink?: string | null;\n nextChapterAudioLinks?: AudioLinks | null;\n previousChapterApiLink?: string | null;\n previousChapterAudioLinks?: AudioLinks | null;\n numberOfVerses: number;\n chapter: ChapterData;\n};\nexport type TranslationBooks = {\n translation: Translation;\n books: TranslationBook[];\n};\nexport type VerseFootnoteReference = {\n noteId: number;\n};\nexport type VerseRef = {\n book: string;\n chapter: number;\n verse: number;\n endChapter?: number | null;\n endVerse?: number | null;\n};\nexport {};\n",[],[287,289],"6c65fbe4-8f12-11f0-bfab-0224a6c84d84",37,["D",1757596973921],"directory",[160,161],[287],["D",1757536946176],{"_11":12,"_119":67},{"_11":12,"_114":115,"_66":67,"_30":65,"_116":117,"_118":24},{"_38":105,"_13":16,"_32":35,"_106":69,"_107":-5,"_108":-5,"_109":-5,"_110":-5,"_111":-5,"_112":14,"_113":12},"ctx",{"_51":-5,"_138":339,"_340":341,"_342":343,"_344":24,"_345":24,"_346":24,"_347":180,"_348":-5,"_349":-7,"_350":-7,"_351":26,"_352":24,"_353":24,"_354":-5,"_355":24,"_356":24,"_357":24,"_358":-5},"ENV",{"_310":311,"_312":313,"_314":16,"_315":316,"_317":318,"_319":320,"_321":322,"_323":324,"_325":326,"_327":328,"_329":330,"_331":332,"_333":334,"_335":336,"_337":338},"REACT_APP_SENTRY_DSN","https://586020d86f05489db63a554690acf1e9@o1398359.ingest.sentry.io/6724499","RENDER_GIT_COMMIT","e87eb04e707cf64e7e532c8e8ec395f209e17f15","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 · LICENSE