spooder 4.0.0 → 4.0.2

package/README.md

@@ -404,6 +404,7 @@ In addition to the information provided by the developer, `spooder` also include
 	- [`panic(err_message_or_obj: string | object, ...err: object[]): Promise<void>`](#api-error-handling-panic)
 - [API > Content](#api-content)
 	- [`template_sub(template: string, replacements: Record<string, string>): string`](#api-content-template-sub)
+	- [`template_sub_file(template_file: string, replacements: Record<string, string>): Promise<string>`](#api-content-template-sub-file)
 	- [`generate_hash_subs(length: number, prefix: string): Promise<Record<string, string>>`](#api-content-generate-hash-subs)
 	- [`apply_range(file: BunFile, request: Request): HandlerReturnType`](#api-content-apply-range)
 - [API > State Management](#api-state-management)
@@ -457,6 +458,20 @@ server.route('/test/route', (req, url) => {
 server.route('/redirect', () => Response.redirect('/redirected', 301));
 ```
 
+### Status Code Text
+
+`spooder` exposes `HTTP_STATUS_CODE` to convieniently access status code text.
+
+```ts
+import { HTTP_STATUS_CODE } from 'spooder';
+
+server.default((req, status_code) => {
+	// status_code: 404
+	// Body: Not Found
+	return new Response(HTTP_STATUS_CODE[status_code], { status: status_code });
+});
+```
+
 <a id="api-routing-request-handler"></a>
 ## API > Routing > RequestHandler
 
@@ -876,6 +891,24 @@ const html = template_sub(template, replacements);
 </html>
 ```
 
+<a id="api-content-template-sub-file"></a>
+### 🔧 `template_sub_file(template_file: string, replacements: Record<string, string>): Promise<string>`
+
+Replace placeholders in a template file with values from a replacement object.
+
+> [!NOTE]
+> This function is a convenience wrapper around `template_sub` and `Bun.file().text()` to reduce boilerplate. See `template_sub` for more information.
+
+```ts
+const html = await template_sub_file('./template.html', replacements);
+
+// Is equivalent to:
+const file = Bun.file('./template.html');
+const file_contents = await file.text();
+const html = await template_sub(file_contents, replacements);
+```
+
+
 <a id="api-content-generate-hash-subs"></a>
 ### 🔧 `generate_hash_subs(prefix: string): Promise<Record<string, string>>`
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "spooder",
 	"type": "module",
-	"version": "4.0.0",
+	"version": "4.0.2",
 	"exports": {
 		".": {
 			"bun": "./src/api.ts",

package/src/api.d.ts

@@ -4,6 +4,10 @@
 /// <reference types="node" />
 import fs from 'node:fs/promises';
 import { Blob } from 'node:buffer';
+export declare const HTTP_STATUS_CODE: {
+    [errorCode: number]: string | undefined;
+    [errorCode: string]: string | undefined;
+};
 export declare class ErrorWithMetadata extends Error {
     metadata: Record<string, unknown>;
     constructor(message: string, metadata: Record<string, unknown>);
@@ -11,6 +15,7 @@ export declare class ErrorWithMetadata extends Error {
 }
 export declare function panic(err_message_or_obj: string | object, ...err: object[]): Promise<void>;
 export declare function caution(err_message_or_obj: string | object, ...err: object[]): Promise<void>;
+export declare function template_sub_file(template_file: string, replacements: Record<string, string>): Promise<string>;
 export declare function template_sub(template: string, replacements: Record<string, string>): string;
 export declare function generate_hash_subs(length?: number, prefix?: string): Promise<Record<string, string>>;
 type CookieOptions = {

package/src/api.ts

@@ -7,6 +7,8 @@ import { log } from './utils';
 import crypto from 'crypto';
 import { Blob } from 'node:buffer';
 
+export const HTTP_STATUS_CODE = http.STATUS_CODES;
+
 export class ErrorWithMetadata extends Error {
 	constructor(message: string, public metadata: Record<string, unknown>) {
 		super(message);
@@ -82,6 +84,13 @@ export async function caution(err_message_or_obj: string | object, ...err: objec
 	await handle_error('caution: ', err_message_or_obj, ...err);
 }
 
+export async function template_sub_file(template_file: string, replacements: Record<string, string>): Promise<string> {
+	const file = Bun.file(template_file);
+	const file_contents = await file.text();
+
+	return template_sub(file_contents, replacements);
+}
+
 export function template_sub(template: string, replacements: Record<string, string>): string {
 	let result = '';
 	let buffer = '';