kempo-server 2.1.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (89) hide show
  1. package/CONFIG.md +295 -187
  2. package/README.md +31 -4
  3. package/SPA.md +14 -14
  4. package/UTILS.md +39 -0
  5. package/dist/defaultConfig.js +1 -1
  6. package/dist/index.js +1 -1
  7. package/dist/render.js +2 -0
  8. package/dist/rescan.js +1 -0
  9. package/dist/router.js +1 -1
  10. package/dist/serveFile.js +1 -1
  11. package/dist/templating/index.js +1 -0
  12. package/dist/templating/parse.js +1 -0
  13. package/docs/dist/caching.html +324 -0
  14. package/docs/dist/cli-utils.html +175 -0
  15. package/docs/dist/configuration.html +414 -0
  16. package/docs/dist/examples.html +296 -0
  17. package/docs/dist/fs-utils.html +206 -0
  18. package/docs/dist/getting-started.html +167 -0
  19. package/docs/dist/index.html +183 -0
  20. package/docs/dist/middleware.html +237 -0
  21. package/docs/dist/request-response.html +200 -0
  22. package/docs/dist/routing.html +177 -0
  23. package/docs/dist/templating.html +292 -0
  24. package/docs/{theme.css → dist/theme.css} +1 -3
  25. package/docs/src/.config.js +11 -0
  26. package/docs/{caching.html → src/caching.page.html} +4 -19
  27. package/docs/{cli-utils.html → src/cli-utils.page.html} +4 -20
  28. package/docs/{configuration.html → src/configuration.page.html} +4 -18
  29. package/docs/src/default.template.html +35 -0
  30. package/docs/{examples.html → src/examples.page.html} +9 -18
  31. package/docs/{fs-utils.html → src/fs-utils.page.html} +4 -20
  32. package/docs/{getting-started.html → src/getting-started.page.html} +4 -18
  33. package/docs/src/index.page.html +79 -0
  34. package/docs/{middleware.html → src/middleware.page.html} +4 -18
  35. package/docs/src/nav.fragment.html +73 -0
  36. package/docs/{request-response.html → src/request-response.page.html} +4 -18
  37. package/docs/{routing.html → src/routing.page.html} +4 -18
  38. package/docs/src/templating.page.html +188 -0
  39. package/{llm.txt → llms.txt} +100 -30
  40. package/package.json +7 -3
  41. package/scripts/build.js +19 -11
  42. package/scripts/render.js +58 -0
  43. package/src/defaultConfig.js +14 -2
  44. package/src/index.js +1 -1
  45. package/src/rescan.js +14 -0
  46. package/src/router.js +82 -11
  47. package/src/serveFile.js +27 -0
  48. package/src/templating/index.js +132 -0
  49. package/src/templating/parse.js +285 -0
  50. package/tests/cacheConfig.node-test.js +2 -2
  51. package/tests/config-flag.node-test.js +61 -25
  52. package/tests/customRoute-outside-root.node-test.js +1 -1
  53. package/tests/rescan.node-test.js +69 -0
  54. package/tests/router-wildcard.node-test.js +47 -2
  55. package/tests/templating-parse.node-test.js +243 -0
  56. package/tests/templating-render.node-test.js +188 -0
  57. package/tests/utils/test-scenario.js +4 -4
  58. package/docs/.config.json.example +0 -29
  59. package/docs/api/_admin/cache/DELETE.js +0 -28
  60. package/docs/api/_admin/cache/GET.js +0 -53
  61. package/docs/api/user/[id]/GET.js +0 -15
  62. package/docs/api/user/[id]/[info]/DELETE.js +0 -12
  63. package/docs/api/user/[id]/[info]/GET.js +0 -17
  64. package/docs/api/user/[id]/[info]/POST.js +0 -18
  65. package/docs/api/user/[id]/[info]/PUT.js +0 -19
  66. package/docs/index.html +0 -88
  67. package/docs/init.js +0 -0
  68. package/docs/kempo.min.css +0 -1
  69. package/docs/nav.inc.html +0 -41
  70. package/docs/nav.inc.js +0 -16
  71. /package/docs/{manifest.json → dist/manifest.json} +0 -0
  72. /package/docs/{media → dist/media}/hexagon.svg +0 -0
  73. /package/docs/{media → dist/media}/icon-maskable.png +0 -0
  74. /package/docs/{media → dist/media}/icon.svg +0 -0
  75. /package/docs/{media → dist/media}/icon128.png +0 -0
  76. /package/docs/{media → dist/media}/icon144.png +0 -0
  77. /package/docs/{media → dist/media}/icon152.png +0 -0
  78. /package/docs/{media → dist/media}/icon16-48.svg +0 -0
  79. /package/docs/{media → dist/media}/icon16.png +0 -0
  80. /package/docs/{media → dist/media}/icon192.png +0 -0
  81. /package/docs/{media → dist/media}/icon256.png +0 -0
  82. /package/docs/{media → dist/media}/icon32.png +0 -0
  83. /package/docs/{media → dist/media}/icon384.png +0 -0
  84. /package/docs/{media → dist/media}/icon48.png +0 -0
  85. /package/docs/{media → dist/media}/icon512.png +0 -0
  86. /package/docs/{media → dist/media}/icon64.png +0 -0
  87. /package/docs/{media → dist/media}/icon72.png +0 -0
  88. /package/docs/{media → dist/media}/icon96.png +0 -0
  89. /package/docs/{media → dist/media}/kempo-fist.svg +0 -0
package/docs/dist/examples.html ADDED
@@ -0,0 +1,296 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8" />
5
+ <meta
6
+ name="viewport"
7
+ content="width=device-width, initial-scale=1.0"
8
+ />
9
+ <title>Examples &amp; Demos - Kempo Server</title>
10
+ <link rel="icon" type="image/svg+xml" href="./media/icon.svg" />
11
+ <link rel="icon" type="image/png" sizes="32x32" href="./media/icon32.png" />
12
+ <link rel="manifest" href="./manifest.json" />
13
+ <link
14
+ rel="stylesheet"
15
+ href="https://cdn.jsdelivr.net/npm/kempo-css@2/dist/kempo.min.css"
16
+ />
17
+ <link rel="stylesheet" href="./theme.css" />
18
+ <script>
19
+ window.litDisableBundleWarning = true;
20
+ window.kempo = { pathsToIcons: ['https://cdn.jsdelivr.net/npm/kempo-ui@0.0.42/icons/'] };
21
+ </script>
22
+ </head>
23
+ <body>
24
+
25
+ <k-nav
26
+ fixed
27
+ class="bg-primary"
28
+ >
29
+ <button
30
+ id="toggleNavSideMenu"
31
+ class="link"
32
+ >
33
+ <k-icon name="menu"></k-icon>
34
+ </button>
35
+ <a
36
+ href="./"
37
+ class="d-if ph"
38
+ style="align-items: center"
39
+ >
40
+ <img src="./media/icon32.png" alt="Kempo Server Icon" class="pr" />
41
+ Kempo Server
42
+ </a>
43
+ <div class="flex"></div>
44
+ <a href="https://github.com/dustinpoissant/kempo-ui?tab=License-1-ov-file#creative-commons-attribution-noncommercial-sharealike-20" target="_blank"><k-icon name="license"></k-icont></a>
45
+ <a href="https://github.com/dustinpoissant/kempo-ui" target="_blank"><k-icon name="github-mark"></k-icont></a>
46
+ <k-theme-switcher></k-theme-switcher>
47
+ </k-nav>
48
+ <div style="width: 100%; height: 4rem;"></div>
49
+ <k-aside
50
+ id="navSideMenu"
51
+ state="offscreen"
52
+ >
53
+ <menu>
54
+ <a href="./" class="ta-center bb mb r0">
55
+ <h1 class="tc-primary">Kempo Server</h1>
56
+ <img src="./media/icon128.png" alt="Kempo UI Icon" />
57
+ </a>
58
+ <h3>Getting Started</h3>
59
+ <a href="./" class="d-b pq pl">Quick Start</a>
60
+ <a href="./routing.html" class="d-b pq pl">Routing</a>
61
+ <a href="./request-response.html" class="d-b pq pl">Request & Response</a>
62
+ <br /><br />
63
+ <h3>Advanced Features</h3>
64
+ <a href="configuration.html" class="d-b pq pl">Configuration</a>
65
+ <a href="templating.html" class="d-b pq pl">Templating</a>
66
+ <a href="middleware.html" class="d-b pq pl">Middleware</a>
67
+ <a href="caching.html" class="d-b pq pl">Module Caching</a>
68
+ <a href="cli-utils.html" class="d-b pq pl">CLI Utilities</a>
69
+ <a href="fs-utils.html" class="d-b pq pl">File System Utilities</a>
70
+ <a href="examples.html" class="d-b pq pl">Examples & Demos</a>
71
+ </menu>
72
+ </k-aside>
73
+ <script src="https://cdn.jsdelivr.net/npm/kempo-ui@0.3.5/src/components/Aside.js" type="module"></script>
74
+ <script src="https://cdn.jsdelivr.net/npm/kempo-ui@0.3.5/src/components/Main.js" type="module"></script>
75
+ <script src="https://cdn.jsdelivr.net/npm/kempo-ui@0.3.5/src/components/Nav.js" type="module"></script>
76
+ <script src="https://cdn.jsdelivr.net/npm/kempo-ui@0.3.5/src/components/Icon.js" type="module"></script>
77
+ <script src="https://cdn.jsdelivr.net/npm/kempo-ui@0.3.5/src/components/ThemeSwitcher.js" type="module"></script>
78
+ <script>
79
+ document.getElementById('toggleNavSideMenu').addEventListener('click', async () => {
80
+ await window.customElements.whenDefined('k-aside');
81
+ document.getElementById('navSideMenu').toggle();
82
+ });
83
+ document.addEventListener('click', function(e) {
84
+ if (e.target.matches('a[href^="#"]')) {
85
+ e.preventDefault();
86
+ const targetId = e.target.getAttribute('href').replace('#', '');
87
+ const target = document.getElementById(targetId);
88
+ if (target) {
89
+ target.scrollIntoView({ behavior: 'smooth' });
90
+ const url = window.location.pathname + window.location.search + '#' + targetId;
91
+ history.replaceState(null, '', url);
92
+ }
93
+ }
94
+ });
95
+ </script>
96
+
97
+ <main>
98
+ <h1 class="ta-center">Examples &amp; Demos</h1>
99
+
100
+ <p>Explore practical examples and try interactive demos of Kempo Server features.</p>
101
+
102
+ <h2>Code Examples</h2>
103
+
104
+ <h3>Simple API Route</h3>
105
+ <pre><code class="hljs javascript"><span class="hljs-comment">// api/hello/GET.js</span><br /><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">request, response</span>) </span>{<br /> <span class="hljs-keyword">const</span> { name } = request.query;<br /> <span class="hljs-keyword">const</span> message = name ? <span class="hljs-string">`Hello ${name}!`</span> : <span class="hljs-string">'Hello World!'</span>;<br /> <br /> response.json({ message });<br />}</code></pre>
106
+
107
+ <h3>Dynamic User Profile Route</h3>
108
+ <pre><code class="hljs javascript"><span class="hljs-comment">// api/users/[id]/GET.js</span><br /><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">request, response</span>) </span>{<br /> <span class="hljs-keyword">const</span> { id } = request.params;<br /> <span class="hljs-keyword">const</span> { includeProfile } = request.query;<br /> <br /> <span class="hljs-comment">// Simulate database lookup</span><br /> <span class="hljs-keyword">const</span> user = {<br /> id: id,<br /> name: <span class="hljs-string">`User ${id}`</span>,<br /> email: <span class="hljs-string">`user${id}@example.com`</span><br /> };<br /> <br /> <span class="hljs-keyword">if</span> (includeProfile === <span class="hljs-string">'true'</span>) {<br /> user.profile = {<br /> bio: <span class="hljs-string">`Bio for user ${id}`</span>,<br /> joinDate: <span class="hljs-string">'2024-01-01'</span><br /> };<br /> }<br /> <br /> response.json(user);<br />}</code></pre>
109
+
110
+ <h3>Form Handling Route</h3>
111
+ <pre><code class="hljs javascript"><span class="hljs-comment">// contact/POST.js</span><br /><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">request, response</span>) </span>{<br /> <span class="hljs-keyword">try</span> {<br /> <span class="hljs-keyword">const</span> body = <span class="hljs-keyword">await</span> request.text();<br /> <span class="hljs-keyword">const</span> formData = <span class="hljs-keyword">new</span> URLSearchParams(body);<br /> <span class="hljs-keyword">const</span> name = formData.get(<span class="hljs-string">'name'</span>);<br /> <span class="hljs-keyword">const</span> email = formData.get(<span class="hljs-string">'email'</span>);<br /> <span class="hljs-keyword">const</span> message = formData.get(<span class="hljs-string">'message'</span>);<br /> <br /> <span class="hljs-comment">// Process form data...</span><br /> <span class="hljs-keyword">await</span> sendContactEmail({ name, email, message });<br /> <br /> response.html(<span class="hljs-string">'&lt;h1&gt;Thank you for your message!&lt;/h1&gt;'</span>);<br /> } <span class="hljs-keyword">catch</span> (error) {<br /> response.status(<span class="hljs-number">400</span>).html(<span class="hljs-string">'&lt;h1&gt;Error processing form&lt;/h1&gt;'</span>);<br /> }<br />}</code></pre>
112
+
113
+ <h3>File Upload Handling</h3>
114
+ <pre><code class="hljs javascript"><span class="hljs-comment">// api/upload/POST.js</span><br /><span class="hljs-keyword">import</span> fs <span class="hljs-keyword">from</span> <span class="hljs-string">'fs/promises'</span>;<br /><span class="hljs-keyword">import</span> path <span class="hljs-keyword">from</span> <span class="hljs-string">'path'</span>;<br /><br /><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">request, response</span>) </span>{<br /> <span class="hljs-keyword">try</span> {<br /> <span class="hljs-keyword">const</span> buffer = <span class="hljs-keyword">await</span> request.buffer();<br /> <span class="hljs-keyword">const</span> contentType = request.get(<span class="hljs-string">'content-type'</span>);<br /> <br /> <span class="hljs-comment">// Generate filename</span><br /> <span class="hljs-keyword">const</span> extension = getExtensionFromMimeType(contentType);<br /> <span class="hljs-keyword">const</span> filename = <span class="hljs-string">`upload_${Date.now()}.${extension}`</span>;<br /> <span class="hljs-keyword">const</span> filepath = path.join(<span class="hljs-string">'./uploads'</span>, filename);<br /> <br /> <span class="hljs-comment">// Ensure uploads directory exists</span><br /> <span class="hljs-keyword">await</span> fs.mkdir(<span class="hljs-string">'./uploads'</span>, { recursive: <span class="hljs-literal">true</span> });<br /> <br /> <span class="hljs-comment">// Save file</span><br /> <span class="hljs-keyword">await</span> fs.writeFile(filepath, buffer);<br /> <br /> response.json({<br /> message: <span class="hljs-string">'File uploaded successfully'</span>,<br /> filename: filename,<br /> size: buffer.length,<br /> type: contentType<br /> });<br /> } <span class="hljs-keyword">catch</span> (error) {<br /> response.status(<span class="hljs-number">500</span>).json({<br /> error: <span class="hljs-string">'Upload failed'</span>,<br /> message: error.message<br /> });<br /> }<br />}<br /><br /><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">getExtensionFromMimeType</span>(<span class="hljs-params">mimeType</span>) </span>{<br /> <span class="hljs-keyword">const</span> mimeMap = {<br /> <span class="hljs-string">'image/jpeg'</span>: <span class="hljs-string">'jpg'</span>,<br /> <span class="hljs-string">'image/png'</span>: <span class="hljs-string">'png'</span>,<br /> <span class="hljs-string">'image/gif'</span>: <span class="hljs-string">'gif'</span>,<br /> <span class="hljs-string">'text/plain'</span>: <span class="hljs-string">'txt'</span>,<br /> <span class="hljs-string">'application/pdf'</span>: <span class="hljs-string">'pdf'</span><br /> };<br /> <span class="hljs-keyword">return</span> mimeMap[mimeType] || <span class="hljs-string">'bin'</span>;<br />}</code></pre>
115
+
116
+ <h3>Authentication Route</h3>
117
+ <pre><code class="hljs javascript"><span class="hljs-comment">// api/auth/login/POST.js</span><br /><span class="hljs-keyword">import</span> crypto <span class="hljs-keyword">from</span> <span class="hljs-string">'crypto'</span>;<br /><br /><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">request, response</span>) </span>{<br /> <span class="hljs-keyword">try</span> {<br /> <span class="hljs-keyword">const</span> { username, password } = <span class="hljs-keyword">await</span> request.json();<br /> <br /> <span class="hljs-comment">// Validate credentials</span><br /> <span class="hljs-keyword">const</span> user = <span class="hljs-keyword">await</span> authenticateUser(username, password);<br /> <br /> <span class="hljs-keyword">if</span> (!user) {<br /> <span class="hljs-keyword">return</span> response.status(<span class="hljs-number">401</span>).json({<br /> error: <span class="hljs-string">'Invalid credentials'</span><br /> });<br /> }<br /> <br /> <span class="hljs-comment">// Generate session token</span><br /> <span class="hljs-keyword">const</span> sessionToken = crypto.randomBytes(<span class="hljs-number">32</span>).toString(<span class="hljs-string">'hex'</span>);<br /> <span class="hljs-keyword">await</span> createSession(user.id, sessionToken);<br /> <br /> <span class="hljs-comment">// Set secure cookie</span><br /> response<br /> .cookie(<span class="hljs-string">'session'</span>, sessionToken, {<br /> httpOnly: <span class="hljs-literal">true</span>,<br /> secure: <span class="hljs-literal">true</span>,<br /> sameSite: <span class="hljs-string">'strict'</span>,<br /> maxAge: <span class="hljs-number">24</span> * <span class="hljs-number">60</span> * <span class="hljs-number">60</span> * <span class="hljs-number">1000</span> <span class="hljs-comment">// 24 hours</span><br /> })<br /> .json({<br /> message: <span class="hljs-string">'Login successful'</span>,<br /> user: {<br /> id: user.id,<br /> username: user.username,<br /> email: user.email<br /> }<br /> });<br /> } <span class="hljs-keyword">catch</span> (error) {<br /> response.status(<span class="hljs-number">400</span>).json({<br /> error: <span class="hljs-string">'Invalid request'</span>,<br /> message: error.message<br /> });<br /> }<br />}</code></pre>
118
+
119
+ <h2>Interactive Demos</h2>
120
+ <p>Try out the example API endpoints below. These demonstrations show the actual routes working in this documentation site.</p>
121
+
122
+ <div class="mb">
123
+ <h3 class="mt0">Get User Profile</h3>
124
+ <p><code>GET /api/user/[id]</code></p>
125
+ <div class="row -mx">
126
+ <div class="col m-span-12 d-span-6 px">
127
+ <pre><code class="hljs javascript"><span class="hljs-comment">// api/user/[id]/GET.js</span><br /><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">request, response</span>) </span>{<br /> <span class="hljs-keyword">const</span> { id } = request.params;<br /> <br /> <span class="hljs-keyword">const</span> userData = {<br /> id: id,<br /> profile: {<br /> name: <span class="hljs-string">`${id.charAt(0).toUpperCase()}${id.slice(1)}`</span>,<br /> joinDate: <span class="hljs-string">'2024-01-15'</span>,<br /> posts: <span class="hljs-number">42</span><br /> }<br /> };<br /> <br /> response.json(userData);<br />}</code></pre>
128
+ <div class="mb">
129
+ <input type="text" id="userId" placeholder="Enter user ID (e.g., john)" value="john" class="mb mr">
130
+ <button onclick="fetchUser()" class="primary">GET User</button>
131
+ </div>
132
+ </div>
133
+ <div class="col m-span-12 d-span-6 px">
134
+ <h4>Response:</h4>
135
+ <pre><output id="userOutput" class="pb">Click "GET User" to see the response</output></pre>
136
+ </div>
137
+ </div>
138
+ </div>
139
+
140
+ <div class="mb">
141
+ <h3 class="mt0">Get User Info</h3>
142
+ <p><code>GET /api/user/[id]/[info]</code></p>
143
+ <div class="row -mx">
144
+ <div class="col m-span-12 d-span-6 px">
145
+ <pre><code class="hljs javascript"><span class="hljs-comment">// api/user/[id]/[info]/GET.js</span><br /><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">request, response</span>) </span>{<br /> <span class="hljs-keyword">const</span> { id, info } = request.params;<br /> <br /> <span class="hljs-keyword">const</span> userInfo = {<br /> id: id,<br /> details: {<br /> bio: <span class="hljs-string">`This is ${id}'s bio`</span>,<br /> location: <span class="hljs-string">'Earth'</span>,<br /> website: <span class="hljs-string">`https://${id}.dev`</span>,<br /> followers: <span class="hljs-number">123</span>,<br /> following: <span class="hljs-number">456</span><br /> }<br /> };<br /> <br /> response.json(userInfo);<br />}</code></pre>
146
+ <div class="mb">
147
+ <input type="text" id="userInfoId" placeholder="Enter user ID" value="alice" class="mb mr">
148
+ <button onclick="fetchUserInfo()" class="primary">GET User Info</button>
149
+ </div>
150
+ </div>
151
+ <div class="col m-span-12 d-span-6 px">
152
+ <h4>Response:</h4>
153
+ <pre><output id="userInfoOutput" class="pb">Click "GET User Info" to see the response</output></pre>
154
+ </div>
155
+ </div>
156
+ </div>
157
+
158
+ <div class="mb">
159
+ <h3 class="mt0">Update User Info</h3>
160
+ <p><code>POST /api/user/[id]/[info]</code></p>
161
+ <div class="row -mx">
162
+ <div class="col m-span-12 d-span-6 px">
163
+ <pre><code class="hljs javascript"><span class="hljs-comment">// api/user/[id]/[info]/POST.js</span><br /><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">request, response</span>) </span>{<br /> <span class="hljs-keyword">const</span> { id, info } = request.params;<br /> <br /> <span class="hljs-keyword">try</span> {<br /> <span class="hljs-keyword">const</span> updateData = <span class="hljs-keyword">await</span> request.json();<br /> <br /> <span class="hljs-keyword">const</span> updatedUser = {<br /> id: id,<br /> message: <span class="hljs-string">'User info updated successfully'</span>,<br /> updatedFields: updateData<br /> };<br /> <br /> response.json(updatedUser);<br /> } <span class="hljs-keyword">catch</span> (error) {<br /> response.status(<span class="hljs-number">400</span>).json({ error: <span class="hljs-string">'Invalid JSON'</span> });<br /> }<br />}</code></pre>
164
+ <div class="mb">
165
+ <input type="text" id="postUserId" placeholder="Enter user ID" value="bob" class="mb">
166
+ <textarea id="postData" placeholder="Enter JSON data to update" class="mb">{
167
+ "bio": "Updated bio text",
168
+ "location": "New York"
169
+ }</textarea>
170
+ <button onclick="updateUserInfo()" class="primary">POST Update</button>
171
+ </div>
172
+ </div>
173
+ <div class="col m-span-12 d-span-6 px">
174
+ <h4>Response:</h4>
175
+ <pre><output id="postOutput" class="pb">Click "POST Update" to see the response</output></pre>
176
+ </div>
177
+ </div>
178
+ </div>
179
+
180
+ <div class="mb">
181
+ <h3 class="mt0">Delete User Info</h3>
182
+ <p><code>DELETE /api/user/[id]/[info]</code></p>
183
+ <div class="row -mx">
184
+ <div class="col m-span-12 d-span-6 px">
185
+ <pre><code class="hljs javascript"><span class="hljs-comment">// api/user/[id]/[info]/DELETE.js</span><br /><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">request, response</span>) </span>{<br /> <span class="hljs-keyword">const</span> { id, info } = request.params;<br /> <br /> <span class="hljs-keyword">const</span> result = {<br /> id: id,<br /> message: <span class="hljs-string">'User info deleted successfully'</span>,<br /> deletedAt: <span class="hljs-keyword">new</span> <span class="hljs-built_in">Date</span>().toISOString()<br /> };<br /> <br /> response.json(result);<br />}</code></pre>
186
+ <div class="mb">
187
+ <input type="text" id="deleteUserId" placeholder="Enter user ID" value="charlie" class="mr">
188
+ <button onclick="deleteUserInfo()" class="primary">DELETE Info</button>
189
+ </div>
190
+ </div>
191
+ <div class="col m-span-12 d-span-6 px">
192
+ <h4>Response:</h4>
193
+ <pre><output id="deleteOutput" class="pb">Click "DELETE Info" to see the response</output></pre>
194
+ </div>
195
+ </div>
196
+ </div>
197
+
198
+ <h2>Project Structure Examples</h2>
199
+
200
+ <h3>Basic Blog API</h3>
201
+ <pre><code class="hljs markdown">blog-api/<br />├─ public/ # Web root<br />│ ├─ index.html # Homepage<br />│ ├─ api/<br />│ │ ├─ posts/<br />│ │ │ ├─ GET.js # Get all posts<br />│ │ │ ├─ POST.js # Create new post<br />│ │ │ ├─ [id]/<br />│ │ │ │ ├─ GET.js # Get specific post<br />│ │ │ │ ├─ PUT.js # Update post<br />│ │ │ │ ├─ DELETE.js # Delete post<br />│ │ │ │ ├─ comments/<br />│ │ │ │ │ ├─ GET.js # Get post comments<br />│ │ │ │ │ ├─ POST.js # Add comment<br />│ │ ├─ users/<br />│ │ │ ├─ GET.js # Get all users<br />│ │ │ ├─ POST.js # Create user<br />│ │ │ ├─ [id]/<br />│ │ │ │ ├─ GET.js # Get user profile<br />│ │ │ │ ├─ PUT.js # Update user<br />│ │ │ │ ├─ DELETE.js # Delete user<br />│ │ ├─ auth/<br />│ │ │ ├─ login/<br />│ │ │ │ ├─ POST.js # User login<br />│ │ │ ├─ logout/<br />│ │ │ │ ├─ POST.js # User logout<br />│ │ │ ├─ register/<br />│ │ │ │ ├─ POST.js # User registration<br />├─ middleware/<br />│ ├─ auth.js # Authentication middleware<br />│ ├─ logging.js # Request logging<br />├─ .config.json # Server configuration<br />├─ package.json<br /></code></pre>
202
+
203
+ <h3>E-commerce API</h3>
204
+ <pre><code class="hljs markdown">ecommerce-api/<br />├─ public/<br />│ ├─ api/<br />│ │ ├─ products/<br />│ │ │ ├─ GET.js # Get all products<br />│ │ │ ├─ POST.js # Create product<br />│ │ │ ├─ [id]/<br />│ │ │ │ ├─ GET.js # Get product details<br />│ │ │ │ ├─ PUT.js # Update product<br />│ │ │ │ ├─ DELETE.js # Delete product<br />│ │ │ │ ├─ reviews/<br />│ │ │ │ │ ├─ GET.js # Get product reviews<br />│ │ │ │ │ ├─ POST.js # Add review<br />│ │ │ ├─ categories/<br />│ │ │ │ ├─ [category]/<br />│ │ │ │ │ ├─ GET.js # Get products by category<br />│ │ ├─ cart/<br />│ │ │ ├─ GET.js # Get cart contents<br />│ │ │ ├─ POST.js # Add item to cart<br />│ │ │ ├─ [id]/<br />│ │ │ │ ├─ PUT.js # Update cart item<br />│ │ │ │ ├─ DELETE.js # Remove cart item<br />│ │ ├─ orders/<br />│ │ │ ├─ GET.js # Get user orders<br />│ │ │ ├─ POST.js # Create order<br />│ │ │ ├─ [id]/<br />│ │ │ │ ├─ GET.js # Get order details<br />│ │ │ │ ├─ PUT.js # Update order status<br />│ │ ├─ users/<br />│ │ │ ├─ [id]/<br />│ │ │ │ ├─ profile/<br />│ │ │ │ │ ├─ GET.js # Get user profile<br />│ │ │ │ │ ├─ PUT.js # Update profile<br />│ │ │ │ ├─ addresses/<br />│ │ │ │ │ ├─ GET.js # Get addresses<br />│ │ │ │ │ ├─ POST.js # Add address<br />│ │ │ │ │ ├─ [addressId]/<br />│ │ │ │ │ │ ├─ PUT.js # Update address<br />│ │ │ │ │ │ ├─ DELETE.js # Delete address<br />├─ middleware/<br />│ ├─ auth.js # User authentication<br />│ ├─ admin.js # Admin-only routes<br />│ ├─ cors.js # CORS configuration<br />├─ .config.json<br /></code></pre>
205
+
206
+ <h3>SaaS Application API</h3>
207
+ <pre><code class="hljs markdown">saas-api/<br />├─ public/<br />│ ├─ api/<br />│ │ ├─ auth/<br />│ │ │ ├─ login/<br />│ │ │ ├─ register/<br />│ │ │ ├─ reset-password/<br />│ │ │ ├─ verify-email/<br />│ │ ├─ organizations/<br />│ │ │ ├─ [orgId]/<br />│ │ │ │ ├─ GET.js # Get organization<br />│ │ │ │ ├─ PUT.js # Update organization<br />│ │ │ │ ├─ members/<br />│ │ │ │ │ ├─ GET.js # Get members<br />│ │ │ │ │ ├─ POST.js # Invite member<br />│ │ │ │ │ ├─ [userId]/<br />│ │ │ │ │ │ ├─ PUT.js # Update member role<br />│ │ │ │ │ │ ├─ DELETE.js # Remove member<br />│ │ │ │ ├─ projects/<br />│ │ │ │ │ ├─ GET.js # Get projects<br />│ │ │ │ │ ├─ POST.js # Create project<br />│ │ │ │ │ ├─ [projectId]/<br />│ │ │ │ │ │ ├─ GET.js # Get project<br />│ │ │ │ │ │ ├─ PUT.js # Update project<br />│ │ │ │ │ │ ├─ DELETE.js # Delete project<br />│ │ │ │ │ │ ├─ tasks/<br />│ │ │ │ │ │ │ ├─ GET.js # Get tasks<br />│ │ │ │ │ │ │ ├─ POST.js # Create task<br />│ │ │ │ │ │ │ ├─ [taskId]/<br />│ │ │ │ │ │ │ │ ├─ GET.js # Get task<br />│ │ │ │ │ │ │ │ ├─ PUT.js # Update task<br />│ │ │ │ │ │ │ │ ├─ DELETE.js # Delete task<br />│ │ ├─ billing/<br />│ │ │ ├─ subscriptions/<br />│ │ │ ├─ invoices/<br />│ │ │ ├─ payment-methods/<br />│ │ ├─ analytics/<br />│ │ │ ├─ dashboard/<br />│ │ │ ├─ reports/<br />├─ middleware/<br />│ ├─ auth.js # Authentication<br />│ ├─ organization.js # Organization context<br />│ ├─ permissions.js # Permission checking<br />│ ├─ rate-limit.js # API rate limiting<br />│ ├─ analytics.js # Usage analytics<br />├─ .config.json<br /></code></pre>
208
+
209
+ <h2>Configuration Examples</h2>
210
+
211
+ <h3>Development Configuration</h3>
212
+ <pre><code class="hljs json">{<br /> <span class="hljs-attr">"allowedMimes"</span>: {<br /> <span class="hljs-attr">"html"</span>: <span class="hljs-string">"text/html"</span>,<br /> <span class="hljs-attr">"css"</span>: <span class="hljs-string">"text/css"</span>,<br /> <span class="hljs-attr">"js"</span>: <span class="hljs-string">"application/javascript"</span>,<br /> <span class="hljs-attr">"json"</span>: <span class="hljs-string">"application/json"</span>,<br /> <span class="hljs-attr">"map"</span>: <span class="hljs-string">"application/json"</span>,<br /> <span class="hljs-attr">"png"</span>: <span class="hljs-string">"image/png"</span>,<br /> <span class="hljs-attr">"jpg"</span>: <span class="hljs-string">"image/jpeg"</span><br /> },<br /> <span class="hljs-attr">"middleware"</span>: {<br /> <span class="hljs-attr">"cors"</span>: {<br /> <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>,<br /> <span class="hljs-attr">"origin"</span>: <span class="hljs-string">"*"</span><br /> },<br /> <span class="hljs-attr">"compression"</span>: {<br /> <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">false</span><br /> },<br /> <span class="hljs-attr">"custom"</span>: [<br /> <span class="hljs-string">"./middleware/logging.js"</span><br /> ]<br /> }<br />}</code></pre>
213
+
214
+ <h3>Production Configuration</h3>
215
+ <pre><code class="hljs json">{<br /> <span class="hljs-attr">"allowedMimes"</span>: {<br /> <span class="hljs-attr">"html"</span>: <span class="hljs-string">"text/html"</span>,<br /> <span class="hljs-attr">"css"</span>: <span class="hljs-string">"text/css"</span>,<br /> <span class="hljs-attr">"js"</span>: <span class="hljs-string">"application/javascript"</span>,<br /> <span class="hljs-attr">"json"</span>: <span class="hljs-string">"application/json"</span>,<br /> <span class="hljs-attr">"png"</span>: <span class="hljs-string">"image/png"</span>,<br /> <span class="hljs-attr">"jpg"</span>: <span class="hljs-string">"image/jpeg"</span>,<br /> <span class="hljs-attr">"svg"</span>: <span class="hljs-string">"image/svg+xml"</span>,<br /> <span class="hljs-attr">"woff"</span>: <span class="hljs-string">"font/woff"</span>,<br /> <span class="hljs-attr">"woff2"</span>: <span class="hljs-string">"font/woff2"</span><br /> },<br /> <span class="hljs-attr">"disallowedRegex"</span>: [<br /> <span class="hljs-string">"^/\\..*"</span>,<br /> <span class="hljs-string">"\\.env$"</span>,<br /> <span class="hljs-string">"\\.config$"</span>,<br /> <span class="hljs-string">"password"</span>,<br /> <span class="hljs-string">"secret"</span>,<br /> <span class="hljs-string">"node_modules"</span>,<br /> <span class="hljs-string">"\\.git"</span>,<br /> <span class="hljs-string">"\\.map$"</span><br /> ],<br /> <span class="hljs-attr">"middleware"</span>: {<br /> <span class="hljs-attr">"cors"</span>: {<br /> <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>,<br /> <span class="hljs-attr">"origin"</span>: <span class="hljs-string">"https://yourdomain.com"</span>,<br /> <span class="hljs-attr">"credentials"</span>: <span class="hljs-literal">true</span><br /> },<br /> <span class="hljs-attr">"compression"</span>: {<br /> <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>,<br /> <span class="hljs-attr">"threshold"</span>: <span class="hljs-number">1024</span><br /> },<br /> <span class="hljs-attr">"security"</span>: {<br /> <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>,<br /> <span class="hljs-attr">"headers"</span>: {<br /> <span class="hljs-attr">"X-Content-Type-Options"</span>: <span class="hljs-string">"nosniff"</span>,<br /> <span class="hljs-attr">"X-Frame-Options"</span>: <span class="hljs-string">"DENY"</span>,<br /> <span class="hljs-attr">"X-XSS-Protection"</span>: <span class="hljs-string">"1; mode=block"</span>,<br /> <span class="hljs-attr">"Strict-Transport-Security"</span>: <span class="hljs-string">"max-age=31536000; includeSubDomains"</span><br /> }<br /> },<br /> <span class="hljs-attr">"rateLimit"</span>: {<br /> <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>,<br /> <span class="hljs-attr">"maxRequests"</span>: <span class="hljs-number">100</span>,<br /> <span class="hljs-attr">"windowMs"</span>: <span class="hljs-number">60000</span><br /> },<br /> <span class="hljs-attr">"custom"</span>: [<br /> <span class="hljs-string">"./middleware/auth.js"</span>,<br /> <span class="hljs-string">"./middleware/logging.js"</span>,<br /> <span class="hljs-string">"./middleware/analytics.js"</span><br /> ]<br /> }<br />}</code></pre>
216
+
217
+ <h3>Programmatic File Rescan</h3>
218
+ <p>When your code creates or removes files at runtime (e.g., a CMS generating static pages), you can trigger a file rescan without restarting the server. Import the <code>rescan</code> function from anywhere in the same Node process:</p>
219
+ <pre><code class="hljs javascript"><span class="hljs-comment">// api/pages/POST.js</span><br /><span class="hljs-keyword">import</span> { writeFile } <span class="hljs-keyword">from</span> <span class="hljs-string">'fs/promises'</span>;<br /><span class="hljs-keyword">import</span> rescan <span class="hljs-keyword">from</span> <span class="hljs-string">'kempo-server/rescan'</span>;<br /><br /><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">async</span> (req, res) =&gt; {<br /> <span class="hljs-keyword">const</span> { slug, html } = req.body;<br /> <span class="hljs-keyword">await</span> writeFile(<span class="hljs-string">`./pages/${slug}.html`</span>, html);<br /> <span class="hljs-keyword">const</span> fileCount = <span class="hljs-keyword">await</span> rescan();<br /> res.json({ published: <span class="hljs-literal">true</span>, fileCount });<br />};</code></pre>
220
+ <p>The <code>rescan()</code> function returns a promise that resolves with the number of files found. It works from route handlers, middleware, file watchers, scheduled tasks, or any other code running in the same Node process.</p>
221
+
222
+ <script>
223
+ async function fetchUser() {
224
+ const userId = document.getElementById('userId').value || 'john';
225
+ const output = document.getElementById('userOutput');
226
+
227
+ try {
228
+ output.textContent = 'Loading...';
229
+ const response = await fetch(`/api/user/${userId}`);
230
+ const data = await response.json();
231
+ output.textContent = JSON.stringify(data, null, 2);
232
+ } catch (error) {
233
+ output.textContent = `Error: ${error.message}`;
234
+ }
235
+ }
236
+
237
+ async function fetchUserInfo() {
238
+ const userId = document.getElementById('userInfoId').value || 'alice';
239
+ const output = document.getElementById('userInfoOutput');
240
+
241
+ try {
242
+ output.textContent = 'Loading...';
243
+ const response = await fetch(`/api/user/${userId}/info`);
244
+ const data = await response.json();
245
+ output.textContent = JSON.stringify(data, null, 2);
246
+ } catch (error) {
247
+ output.textContent = `Error: ${error.message}`;
248
+ }
249
+ }
250
+
251
+ async function updateUserInfo() {
252
+ const userId = document.getElementById('postUserId').value || 'bob';
253
+ const postData = document.getElementById('postData').value;
254
+ const output = document.getElementById('postOutput');
255
+
256
+ try {
257
+ output.textContent = 'Loading...';
258
+ const response = await fetch(`/api/user/${userId}/info`, {
259
+ method: 'POST',
260
+ headers: {
261
+ 'Content-Type': 'application/json',
262
+ },
263
+ body: postData
264
+ });
265
+ const data = await response.json();
266
+ output.textContent = JSON.stringify(data, null, 2);
267
+ } catch (error) {
268
+ output.textContent = `Error: ${error.message}`;
269
+ }
270
+ }
271
+
272
+ async function deleteUserInfo() {
273
+ const userId = document.getElementById('deleteUserId').value || 'charlie';
274
+ const output = document.getElementById('deleteOutput');
275
+
276
+ try {
277
+ output.textContent = 'Loading...';
278
+ const response = await fetch(`/api/user/${userId}/info`, {
279
+ method: 'DELETE'
280
+ });
281
+ const data = await response.json();
282
+ output.textContent = JSON.stringify(data, null, 2);
283
+ } catch (error) {
284
+ output.textContent = `Error: ${error.message}`;
285
+ }
286
+ }
287
+ </script>
288
+
289
+ </main>
290
+ <div style="height:25vh"></div>
291
+ <script
292
+ type="module"
293
+ src="https://cdn.jsdelivr.net/npm/kempo-ui@0.0.42/dist/components/Import.js"
294
+ ></script>
295
+ </body>
296
+ </html>
package/docs/dist/fs-utils.html ADDED
@@ -0,0 +1,206 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8" />
5
+ <meta
6
+ name="viewport"
7
+ content="width=device-width, initial-scale=1.0"
8
+ />
9
+ <title>File System Utilities - Kempo Server</title>
10
+ <link rel="icon" type="image/svg+xml" href="./media/icon.svg" />
11
+ <link rel="icon" type="image/png" sizes="32x32" href="./media/icon32.png" />
12
+ <link rel="manifest" href="./manifest.json" />
13
+ <link
14
+ rel="stylesheet"
15
+ href="https://cdn.jsdelivr.net/npm/kempo-css@2/dist/kempo.min.css"
16
+ />
17
+ <link rel="stylesheet" href="./theme.css" />
18
+ <script>
19
+ window.litDisableBundleWarning = true;
20
+ window.kempo = { pathsToIcons: ['https://cdn.jsdelivr.net/npm/kempo-ui@0.0.42/icons/'] };
21
+ </script>
22
+ </head>
23
+ <body>
24
+
25
+ <k-nav
26
+ fixed
27
+ class="bg-primary"
28
+ >
29
+ <button
30
+ id="toggleNavSideMenu"
31
+ class="link"
32
+ >
33
+ <k-icon name="menu"></k-icon>
34
+ </button>
35
+ <a
36
+ href="./"
37
+ class="d-if ph"
38
+ style="align-items: center"
39
+ >
40
+ <img src="./media/icon32.png" alt="Kempo Server Icon" class="pr" />
41
+ Kempo Server
42
+ </a>
43
+ <div class="flex"></div>
44
+ <a href="https://github.com/dustinpoissant/kempo-ui?tab=License-1-ov-file#creative-commons-attribution-noncommercial-sharealike-20" target="_blank"><k-icon name="license"></k-icont></a>
45
+ <a href="https://github.com/dustinpoissant/kempo-ui" target="_blank"><k-icon name="github-mark"></k-icont></a>
46
+ <k-theme-switcher></k-theme-switcher>
47
+ </k-nav>
48
+ <div style="width: 100%; height: 4rem;"></div>
49
+ <k-aside
50
+ id="navSideMenu"
51
+ state="offscreen"
52
+ >
53
+ <menu>
54
+ <a href="./" class="ta-center bb mb r0">
55
+ <h1 class="tc-primary">Kempo Server</h1>
56
+ <img src="./media/icon128.png" alt="Kempo UI Icon" />
57
+ </a>
58
+ <h3>Getting Started</h3>
59
+ <a href="./" class="d-b pq pl">Quick Start</a>
60
+ <a href="./routing.html" class="d-b pq pl">Routing</a>
61
+ <a href="./request-response.html" class="d-b pq pl">Request & Response</a>
62
+ <br /><br />
63
+ <h3>Advanced Features</h3>
64
+ <a href="configuration.html" class="d-b pq pl">Configuration</a>
65
+ <a href="templating.html" class="d-b pq pl">Templating</a>
66
+ <a href="middleware.html" class="d-b pq pl">Middleware</a>
67
+ <a href="caching.html" class="d-b pq pl">Module Caching</a>
68
+ <a href="cli-utils.html" class="d-b pq pl">CLI Utilities</a>
69
+ <a href="fs-utils.html" class="d-b pq pl">File System Utilities</a>
70
+ <a href="examples.html" class="d-b pq pl">Examples & Demos</a>
71
+ </menu>
72
+ </k-aside>
73
+ <script src="https://cdn.jsdelivr.net/npm/kempo-ui@0.3.5/src/components/Aside.js" type="module"></script>
74
+ <script src="https://cdn.jsdelivr.net/npm/kempo-ui@0.3.5/src/components/Main.js" type="module"></script>
75
+ <script src="https://cdn.jsdelivr.net/npm/kempo-ui@0.3.5/src/components/Nav.js" type="module"></script>
76
+ <script src="https://cdn.jsdelivr.net/npm/kempo-ui@0.3.5/src/components/Icon.js" type="module"></script>
77
+ <script src="https://cdn.jsdelivr.net/npm/kempo-ui@0.3.5/src/components/ThemeSwitcher.js" type="module"></script>
78
+ <script>
79
+ document.getElementById('toggleNavSideMenu').addEventListener('click', async () => {
80
+ await window.customElements.whenDefined('k-aside');
81
+ document.getElementById('navSideMenu').toggle();
82
+ });
83
+ document.addEventListener('click', function(e) {
84
+ if (e.target.matches('a[href^="#"]')) {
85
+ e.preventDefault();
86
+ const targetId = e.target.getAttribute('href').replace('#', '');
87
+ const target = document.getElementById(targetId);
88
+ if (target) {
89
+ target.scrollIntoView({ behavior: 'smooth' });
90
+ const url = window.location.pathname + window.location.search + '#' + targetId;
91
+ history.replaceState(null, '', url);
92
+ }
93
+ }
94
+ });
95
+ </script>
96
+
97
+ <main>
98
+ <h1 class="ta-center">File System Utilities</h1>
99
+
100
+ <p>The file system utilities provide common file and directory operations with Promise-based APIs for Node.js applications.</p>
101
+
102
+ <h2>Installation</h2>
103
+ <p>Import the utilities from the kempo-server package:</p>
104
+ <pre><code class="hljs javascript">import { ensureDir, copyDir, emptyDir } from 'kempo-server/utils/fs-utils';</code></pre>
105
+
106
+ <h2>ensureDir(dirPath)</h2>
107
+ <p>Ensures that a directory exists, creating it and any necessary parent directories if they don't exist. Similar to <code>mkdir -p</code>.</p>
108
+
109
+ <h3>Parameters</h3>
110
+ <ul>
111
+ <li><code>dirPath</code> (string) - The directory path to ensure exists</li>
112
+ </ul>
113
+
114
+ <h3>Returns</h3>
115
+ <p>Promise that resolves when the directory is confirmed to exist.</p>
116
+
117
+ <h3>Example</h3>
118
+ <pre><code class="hljs javascript">import { ensureDir } from 'kempo-server/utils/fs-utils';
119
+
120
+ await ensureDir('./dist/assets');
121
+ await ensureDir('./logs/app');
122
+ // Creates ./dist/assets and ./logs/app directories if they don't exist</code></pre>
123
+
124
+ <h2>copyDir(srcPath, destPath)</h2>
125
+ <p>Recursively copies an entire directory structure from source to destination.</p>
126
+
127
+ <h3>Parameters</h3>
128
+ <ul>
129
+ <li><code>srcPath</code> (string) - The source directory to copy from</li>
130
+ <li><code>destPath</code> (string) - The destination directory to copy to</li>
131
+ </ul>
132
+
133
+ <h3>Returns</h3>
134
+ <p>Promise that resolves when the copy operation is complete.</p>
135
+
136
+ <h3>Example</h3>
137
+ <pre><code class="hljs javascript">import { copyDir } from 'kempo-server/utils/fs-utils';
138
+
139
+ await copyDir('./src/assets', './dist/assets');
140
+ await copyDir('./public', './dist');
141
+ // Copies all files and subdirectories from src to dest</code></pre>
142
+
143
+ <h2>emptyDir(dirPath)</h2>
144
+ <p>Removes all contents of a directory without deleting the directory itself.</p>
145
+
146
+ <h3>Parameters</h3>
147
+ <ul>
148
+ <li><code>dirPath</code> (string) - The directory path to empty</li>
149
+ </ul>
150
+
151
+ <h3>Returns</h3>
152
+ <p>Promise that resolves when the directory has been emptied.</p>
153
+
154
+ <h3>Example</h3>
155
+ <pre><code class="hljs javascript">import { emptyDir } from 'kempo-server/utils/fs-utils';
156
+
157
+ await emptyDir('./dist');
158
+ await emptyDir('./temp');
159
+ // Removes all files and subdirectories inside ./dist and ./temp</code></pre>
160
+
161
+ <h2>Common Use Cases</h2>
162
+
163
+ <h3>Build Script</h3>
164
+ <pre><code class="hljs javascript">import { ensureDir, copyDir, emptyDir } from 'kempo-server/utils/fs-utils';
165
+
166
+ async function buildProject() {
167
+ // Clean previous build
168
+ await emptyDir('./dist');
169
+
170
+ // Ensure build directories exist
171
+ await ensureDir('./dist/assets');
172
+ await ensureDir('./dist/components');
173
+
174
+ // Copy static assets
175
+ await copyDir('./src/assets', './dist/assets');
176
+ await copyDir('./src/public', './dist');
177
+ }</code></pre>
178
+
179
+ <h3>Backup Script</h3>
180
+ <pre><code class="hljs javascript">import { ensureDir, copyDir } from 'kempo-server/utils/fs-utils';
181
+
182
+ async function backupProject() {
183
+ const timestamp = new Date().toISOString().slice(0, 10);
184
+ const backupPath = `./backups/${timestamp}`;
185
+
186
+ await ensureDir(backupPath);
187
+ await copyDir('./src', `${backupPath}/src`);
188
+ await copyDir('./config', `${backupPath}/config`);
189
+ }</code></pre>
190
+
191
+ <h2>Notes</h2>
192
+ <ul>
193
+ <li>All functions use Node.js's Promise-based fs APIs</li>
194
+ <li>Operations are asynchronous and should be awaited</li>
195
+ <li>Functions handle errors appropriately (e.g., ensureDir ignores EEXIST)</li>
196
+ <li>copyDir preserves directory structure recursively</li>
197
+ </ul>
198
+
199
+ </main>
200
+ <div style="height:25vh"></div>
201
+ <script
202
+ type="module"
203
+ src="https://cdn.jsdelivr.net/npm/kempo-ui@0.0.42/dist/components/Import.js"
204
+ ></script>
205
+ </body>
206
+ </html>