npm - spooder - Versions diffs - 4.2.8 → 4.2.10 - Mend

spooder 4.2.8 → 4.2.10

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 (5) hide show

package/README.md CHANGED Viewed

@@ -158,7 +158,7 @@ The following differences will be observed when running in development mode:
 It is possible to detect in userland if a server is running in development mode by checking the `SPOODER_ENV` environment variable.
 ```ts
-if (process.env.SPOODER_DEV === 'dev') {
+if (process.env.SPOODER_ENV === 'dev') {
 	// Server is running in development mode.
 }
 ```
@@ -728,6 +728,16 @@ server.dir('/static', '/static', (file_path, file, stat, request, url) => {
 > [!NOTE]
 > The directory handler function is only called for files that exist on disk - including directories.
+Asynchronous directory handlers are supported and will be awaited.
+```js
+server.dir('/static', '/static', async (file_path, file) => {
+	let file_contents = await file.text();
+	// do something with file_contents
+	return file_contents;
+});
+```
 <a id="api-routing-server-sse"></a>
 ## API > Routing > Server-Sent Events
@@ -937,7 +947,7 @@ await safe(() => {
 ## API > Content
 <a id="api-content-parse-template"></a>
-### 🔧 `parse_template(template: string, replacements: Record<string, string>, drop_missing: boolean): string`
+### 🔧 `parse_template(template: string, replacements: Replacements, drop_missing: boolean): string`
 Replace placeholders in a template string with values from a replacement object.
@@ -995,6 +1005,29 @@ parse_template(template, replacements, true);
 </html>
 ```
+`parse_template` supports passing a function instead of a replacement object. This function will be called for each placeholder and the return value will be used as the replacement.
+```ts
+const replacer = (placeholder: string) => {
+	return placeholder.toUpperCase();
+};
+parse_template('Hello {$world}', replacer);
+```
+```html
+<html>
+	<head>
+		<title>TITLE</title>
+	</head>
+	<body>
+		<h1>TITLE</h1>
+		<p>CONTENT</p>
+		<p>IGNORED</p>
+	</body>
+</html>
+```
 `parse_template` supports looping arrays with the following syntax.
 ```html

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
 	"name": "spooder",
 	"type": "module",
-	"version": "4.2.8",
+	"version": "4.2.10",
 	"exports": {
 		".": {
 			"bun": "./src/api.ts",
@@ -10,8 +10,7 @@
 	},
 	"module": "./src/api.ts",
 	"devDependencies": {
-		"@types/node": "^20.0.0",
-		"bun-types": "^0.5.0"
+		"@types/bun": "^1.0.5"
 	},
 	"bin": {
 		"spooder": "./src/cli.ts"

package/src/api.d.ts CHANGED Viewed

@@ -1,6 +1,4 @@
 /// <reference types="node" />
-/// <reference types="bun-types" />
-/// <reference types="node" />
 /// <reference types="node" />
 import fs from 'node:fs/promises';
 import { Blob } from 'node:buffer';
@@ -20,7 +18,9 @@ export declare function caution(err_message_or_obj: string | object, ...err: obj
 type CallableFunction = (...args: any[]) => any;
 type Callable = Promise<any> | CallableFunction;
 export declare function safe(target_fn: Callable): Promise<void>;
-export declare function parse_template(template: string, replacements: Record<string, string | Array<string>>, drop_missing?: boolean): string;
+type ReplacerFn = (key: string) => string | Array<string>;
+type Replacements = Record<string, string | Array<string>> | ReplacerFn;
+export declare function parse_template(template: string, replacements: Replacements, drop_missing?: boolean): string;
 export declare function generate_hash_subs(length?: number, prefix?: string): Promise<Record<string, string>>;
 type CookieOptions = {
     same_site?: 'Strict' | 'Lax' | 'None';

package/src/api.ts CHANGED Viewed

@@ -107,11 +107,16 @@ export async function safe(target_fn: Callable) {
 	}
 }
-export function parse_template(template: string, replacements: Record<string, string | Array<string>>, drop_missing = false): string {
+type ReplacerFn = (key: string) => string | Array<string>;
+type Replacements = Record<string, string | Array<string>> | ReplacerFn;
+export function parse_template(template: string, replacements: Replacements, drop_missing = false): string {
 	let result = '';
 	let buffer = '';
 	let buffer_active = false;
+	const is_replacer_fn = typeof replacements === 'function';
 	const template_length = template.length;
 	for (let i = 0; i < template_length; i++) {
 		const char = template[i];
@@ -126,7 +131,7 @@ export function parse_template(template: string, replacements: Record<string, st
 			if (buffer.startsWith('for:')) {
 				const loop_key = buffer.substring(4);
-				const loop_entries = replacements[loop_key];
+				const loop_entries = is_replacer_fn ? replacements(loop_key) : replacements[loop_key];
 				const loop_content_start_index = i + 1;
 				const loop_close_index = template.indexOf('{/for}', loop_content_start_index);
@@ -147,7 +152,7 @@ export function parse_template(template: string, replacements: Record<string, st
 					i += loop_content.length + 6;
 				}
 			} else {
-				const replacement = replacements[buffer];
+				const replacement = is_replacer_fn ? replacements(buffer) : replacements[buffer];
 				if (replacement !== undefined)
 					result += replacement;
 				else if (!drop_missing)
@@ -326,7 +331,7 @@ function route_directory(route_path: string, dir: string, handler: DirHandler):
 			const file_stat = await fs.stat(file_path);
 			const bun_file = Bun.file(file_path);
-			return handler(file_path, bun_file, file_stat, req, url);
+			return await handler(file_path, bun_file, file_stat, req, url);
 		} catch (e) {
 			const err = e as NodeJS.ErrnoException;
 			if (err?.code === 'ENOENT')
@@ -380,7 +385,8 @@ export function serve(port: number) {
 		// Content-type/content-length are automatically set for blobs.
 		if (response instanceof Blob)
-			return new Response(response as Blob, { status: status_code });
+			// @ts-ignore Response does accept Blob in Bun, typing disagrees.
+			return new Response(response, { status: status_code });
 		// Status codes can be returned from some handlers.
 		if (return_status_code && typeof response === 'number')
@@ -554,14 +560,16 @@ export function serve(port: number) {
 				const queue = Array<string>();
 				const stream = new ReadableStream({
+					// @ts-ignore Bun implements a "direct" mode which does not exist in the spec.
 					type: 'direct',
-					async pull(controller: ReadableStreamDirectController) {
-						stream_controller = controller;
+					async pull(controller) {
+						// @ts-ignore `controller` in "direct" mode is ReadableStreamDirectController.
+						stream_controller = controller as ReadableStreamDirectController;
 						while (!req.signal.aborted) {
 							if (queue.length > 0) {
-								controller.write(queue.shift()!);
-								controller.flush();
+								stream_controller.write(queue.shift()!);
+								stream_controller.flush();
 							} else {
 								await Bun.sleep(50);
 							}

package/src/cli.ts CHANGED Viewed

@@ -64,7 +64,7 @@ async function start_server() {
 		function capture_stream(stream: ReadableStream, output: NodeJS.WritableStream) {
 			const reader = stream.getReader();
-			reader.read().then(function read_chunk(chunk: ReadableStreamDefaultReadResult<Uint8Array>) {
+			reader.read().then(function read_chunk(chunk) {
 				if (chunk.done)
 					return;