handbook-page-refreshes
Refresh web pages while preserving scroll position and DOM state using morphing techniques. Learn to update content without full reloads, exclude specific sections, and manage refresh streams for improved user experience.
Instructions
Page refresh techniques with morphing - learn about smooth page updates using DOM morphing with idiomorph, scroll preservation, excluding sections from morphing, and broadcasting refresh streams
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:21-43 (handler)The anonymous async handler function for the 'handbook-page-refreshes' tool (shared with other doc tools). It reads the specific markdown file using readMarkdownFile and returns the content as a text block, or an error message.async () => { try { const content = await readMarkdownFile(path.join(folder, file)); return { content: [ { type: "text", text: content } ] }; } catch (error) { const errorMessage = error instanceof Error ? error.message : String(error); return { content: [ { type: "text", text: `Error reading ${file}: ${errorMessage}` } ] }; } }
- src/index.ts:17-45 (registration)Registers all documentation tools, including 'handbook-page-refreshes', by iterating over docFiles config and calling server.tool(name, description, handlerFn).docFiles.forEach(({ folder, file, name, description }) => { server.tool( name, description, async () => { try { const content = await readMarkdownFile(path.join(folder, file)); return { content: [ { type: "text", text: content } ] }; } catch (error) { const errorMessage = error instanceof Error ? error.message : String(error); return { content: [ { type: "text", text: `Error reading ${file}: ${errorMessage}` } ] }; } } ); });
- src/config.ts:27-31 (schema)Configuration entry defining the name, description, folder, and file for the 'handbook-page-refreshes' tool.folder: 'handbook', file: '03_page_refreshes.md', name: 'handbook-page-refreshes' , description: 'Page refresh techniques with morphing - learn about smooth page updates using DOM morphing with idiomorph, scroll preservation, excluding sections from morphing, and broadcasting refresh streams' },
- src/documentReader.ts:14-61 (helper)Supporting utility function readMarkdownFile that loads the markdown content for handbook/03_page_refreshes.md from cache, GitHub raw, or local fallback.export async function readMarkdownFile(filename: string): Promise<string> { const filePath = path.join(docsFolder, filename); if (!filePath.startsWith(docsFolder)) { throw new Error("Invalid file path"); } // Get current commit info if we don't have it yet if (!mainBranchInfo) { try { const commitInfo = await fetchMainBranchInformation(); const cacheKey = `${commitInfo.sha.substring(0, 7)}-${commitInfo.timestamp}`; mainBranchInfo = { ...commitInfo, cacheKey }; } catch (shaError) { console.error('Failed to get GitHub commit info, falling back to direct fetch'); } } // Try to read from cache first if we have commit info if (mainBranchInfo) { const cachedFilePath = path.join(cacheFolder, mainBranchInfo.cacheKey, filename); try { const content = await fs.promises.readFile(cachedFilePath, "utf-8"); console.error(`Using cached content for ${mainBranchInfo.cacheKey}: ${filename}`); return content; } catch (cacheError) { // Cache miss, continue to fetch from GitHub } } // Fetch from GitHub try { return await fetchFromGitHub(filename, mainBranchInfo?.cacheKey); } catch (githubError) { console.error(`GitHub fetch failed: ${githubError}, attempting to read from local files...`); // Fallback: read from local files try { return await fs.promises.readFile(filePath, "utf-8"); } catch (localError) { const githubErrorMessage = githubError instanceof Error ? githubError.message : String(githubError); const localErrorMessage = localError instanceof Error ? localError.message : String(localError); throw new Error(`Failed to read file from GitHub (${githubErrorMessage}) and locally (${localErrorMessage})`); } } }