@gjsify/http 0.0.2

package/README.md

@@ -0,0 +1,4 @@
+# @gjsify/http
+
+## Inspirations
+- https://github.com/node-fetch/node-fetch/blob/main/src/headers.js

package/lib/cjs/index.js

@@ -0,0 +1,37 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var src_exports = {};
+__export(src_exports, {
+  validateHeaderName: () => validateHeaderName,
+  validateHeaderValue: () => validateHeaderValue
+});
+module.exports = __toCommonJS(src_exports);
+function validateHeaderName(name) {
+  if (!/^[\^`\-\w!#$%&'*+.|~]+$/.test(name)) {
+    const error = new TypeError(`Header name must be a valid HTTP token ["${name}"]`);
+    Object.defineProperty(error, "code", { value: "ERR_INVALID_HTTP_TOKEN" });
+    throw error;
+  }
+}
+function validateHeaderValue(name, value) {
+  if (/[^\t\u0020-\u007E\u0080-\u00FF]/.test(value)) {
+    const error = new TypeError(`Invalid character in header content ["${name}"]`);
+    Object.defineProperty(error, "code", { value: "ERR_INVALID_CHAR" });
+    throw error;
+  }
+}

package/lib/esm/index.js

@@ -0,0 +1,18 @@
+function validateHeaderName(name) {
+  if (!/^[\^`\-\w!#$%&'*+.|~]+$/.test(name)) {
+    const error = new TypeError(`Header name must be a valid HTTP token ["${name}"]`);
+    Object.defineProperty(error, "code", { value: "ERR_INVALID_HTTP_TOKEN" });
+    throw error;
+  }
+}
+function validateHeaderValue(name, value) {
+  if (/[^\t\u0020-\u007E\u0080-\u00FF]/.test(value)) {
+    const error = new TypeError(`Invalid character in header content ["${name}"]`);
+    Object.defineProperty(error, "code", { value: "ERR_INVALID_CHAR" });
+    throw error;
+  }
+}
+export {
+  validateHeaderName,
+  validateHeaderValue
+};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@gjsify/http",
+  "version": "0.0.2",
+  "description": "Node.js http module for Gjs",
+  "main": "lib/cjs/index.js",
+  "module": "lib/esm/index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/types/index.d.ts",
+        "default": "./lib/esm/index.js"
+      },
+      "require": {
+        "types": "./lib/types/index.d.ts",
+        "default": "./lib/cjs/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "clear": "rm -rf lib tsconfig.tsbuildinfo tsconfig.types.tsbuildinfo || exit 0",
+    "print:name": "echo '@gjsify/http'",
+    "build": "yarn print:name && yarn build:gjsify",
+    "build:gjsify": "gjsify build --library 'src/**/*.{ts,js}' --exclude 'src/**/*.spec.{mts,ts}' 'src/test.{mts,ts}'",
+    "build:types": "tsc --project tsconfig.types.json || exit 0",
+    "build:test": "yarn build:test:gjs && yarn build:test:node",
+    "build:test:gjs": "gjsify build src/test.mts --app gjs --outfile test.gjs.mjs",
+    "build:test:node": "gjsify build src/test.mts --app node --outfile test.node.mjs",
+    "test": "yarn print:name && yarn build:gjsify && yarn build:test && yarn test:node && yarn test:gjs",
+    "test:gjs": "gjs -m test.gjs.mjs",
+    "test:node": "node test.node.mjs"
+  },
+  "keywords": [
+    "gjs",
+    "node",
+    "http"
+  ],
+  "devDependencies": {
+    "@gjsify/cli": "^0.0.2",
+    "@gjsify/unit": "^0.0.2",
+    "@types/node": "^20.3.1"
+  }
+}

package/src/index.spec.ts

@@ -0,0 +1,74 @@
+import { describe, it, expect } from '@gjsify/unit';
+
+import * as http from 'http';
+import type { validateHeaderName as gjsifyValidateHeaderName, validateHeaderValue as gjsifyValidateHeaderValue } from './index.js';
+
+// TODO: Add types to @types/node
+const validateHeaderName: typeof gjsifyValidateHeaderName = (http as any).validateHeaderName;
+const validateHeaderValue: typeof gjsifyValidateHeaderValue = (http as any).validateHeaderValue;
+
+export default async () => {
+
+	const validNames = ['Content-Type', 'set-cookie', 'alfa-beta'];
+	const invalidNames = ['@@wdjhgw'];
+	const expectedErrorMessage = (name: any) => `Header name must be a valid HTTP token ["${name}"]`;
+
+	await describe('http.validateHeaderName', async () => {
+		await it('should be a function', async () => {
+			expect(typeof validateHeaderName).toBe("function");
+		});
+
+		await it('an empty string should be not valid and throw an error', async () => {
+			expect(() => {
+				validateHeaderName('');
+			}).toThrow();
+		});
+
+		await it('an empty string should be throw an error which is an instance of TypeError', async () => {
+			try {
+				validateHeaderName('');
+			} catch (error) {
+				expect(error instanceof TypeError).toBeTruthy();			
+			}			
+		});
+
+		await it(`an empty string should be throw an error with the message of "${expectedErrorMessage('')}"`, async () => {
+			try {
+				validateHeaderName('');
+			} catch (error) {
+				expect(error.message).toBe(expectedErrorMessage(''));			
+			}			
+		});
+
+		await it(`a number should be throw an error with the message of "${expectedErrorMessage(100)}"`, async () => {
+			try {
+				validateHeaderName(100 as any);
+			} catch (error) {
+				expect(error.message).toBe(expectedErrorMessage(100));			
+			}			
+		});
+
+		for (const validName of validNames) {
+			await it(`"${validName}" should be valid and not throw any error`, async () => {
+				expect(() => {
+					validateHeaderName(validName);
+				}).not?.toThrow();	
+			});
+		}
+
+		for (const invalidName of invalidNames) {
+			await it(`"${invalidName}" should be not valid and throw an error`, async () => {
+				expect(() => {
+					validateHeaderName(invalidName);
+				}).toThrow();				
+			});
+		}
+	});
+
+	await describe('http.validateHeaderValue', async () => {
+		await it('should be a function', async () => {
+			expect(typeof validateHeaderValue).toBe("function");
+		});
+	});
+
+}

package/src/index.ts

@@ -0,0 +1,31 @@
+/**
+ * Performs the low-level validations on the provided `name` that are done when `res.setHeader(name, value)` is called.
+ * Passing illegal value as `name` will result in a `TypeError` being thrown, identified by `code: 'ERR_INVALID_HTTP_TOKEN'`.
+ * It is not necessary to use this method before passing headers to an HTTP request or response. The HTTP module will automatically validate such headers.
+ * @param name
+ * @since v14.3.0
+ */
+export function validateHeaderName(name: string) {
+    if (!/^[\^`\-\w!#$%&'*+.|~]+$/.test(name)) {
+        const error = new TypeError(`Header name must be a valid HTTP token ["${name}"]`);
+        Object.defineProperty(error, 'code', { value: 'ERR_INVALID_HTTP_TOKEN' });
+        throw error;
+    }
+}
+
+/**
+ * Performs the low-level validations on the provided `value` that are done when `res.setHeader(name, value)` is called.
+ * Passing illegal value as `value` will result in a `TypeError` being thrown.
+ *  * Undefined value error is identified by `code: 'ERR_HTTP_INVALID_HEADER_VALUE'`.
+ *  * Invalid value character error is identified by `code: 'ERR_INVALID_CHAR'`.
+ * It is not necessary to use this method before passing headers to an HTTP request or response. The HTTP module will automatically validate such headers.
+ * @param name 
+ * @param value 
+ */
+export function validateHeaderValue(name: string, value: any) {
+    if (/[^\t\u0020-\u007E\u0080-\u00FF]/.test(value)) {
+        const error = new TypeError(`Invalid character in header content ["${name}"]`);
+        Object.defineProperty(error, 'code', {value: 'ERR_INVALID_CHAR'});
+        throw error;
+    }
+}

package/src/test.mts

@@ -0,0 +1,6 @@
+
+import { run } from '@gjsify/unit';
+
+import testSuite from './index.spec.js';
+
+run({testSuite});