@nx.js/http 0.0.4 → 0.0.5

package/dist/index.d.ts

@@ -4,7 +4,7 @@ export { createStaticFileHandler, type StaticFileHandlerOpts } from './static';
  */
 export type ServerHandler = (req: Request) => Response | Promise<Response>;
 /**
- * Options object for the {@link listen | `http.listen()`} function.
+ * Options object for the {@link listen | `listen()`} function.
  */
 export interface ListenOptions extends Omit<Switch.ListenOptions, 'accept'> {
     fetch: ServerHandler;
@@ -13,11 +13,13 @@ export interface ListenOptions extends Omit<Switch.ListenOptions, 'accept'> {
  * Creates a socket handler function which accepts a socket
  * event and parses the incoming data as an HTTP request.
  *
- * @note This is a low-level function which usually should not be used directly. See {@link listen | `http.listen()`} instead.
+ * > NOTE: This is a low-level function which usually should not be used directly.
+ * > See {@link listen | `listen()`} instead, which is a higher-level wrapper
+ * > around this function.
  *
  * @param handler The HTTP handler function to invoke when an HTTP request is received
  */
-export declare function createServerHandler(handler: ServerHandler): ({ socket }: Switch.SocketEvent) => Promise<void>;
+export declare function createServerHandler(handler: ServerHandler): (event: Switch.SocketEvent) => Promise<void>;
 /**
  * Creates an HTTP server and listens on the `port` number specified in the options object.
  * The `fetch` function will be invoked upon receiving an HTTP request.
@@ -25,7 +27,9 @@ export declare function createServerHandler(handler: ServerHandler): ({ socket }
  * @example
  *
  * ```typescript
- * http.listen({
+ * import { listen } from '@nx.js/http';
+ *
+ * listen({
  *   port: 8080,
  *   fetch(req) {
  *     console.log(`Got HTTP ${req.method} request for "${req.url}"`);

package/dist/index.js

@@ -5,21 +5,24 @@ export { createStaticFileHandler } from './static';
  * Creates a socket handler function which accepts a socket
  * event and parses the incoming data as an HTTP request.
  *
- * @note This is a low-level function which usually should not be used directly. See {@link listen | `http.listen()`} instead.
+ * > NOTE: This is a low-level function which usually should not be used directly.
+ * > See {@link listen | `listen()`} instead, which is a higher-level wrapper
+ * > around this function.
  *
  * @param handler The HTTP handler function to invoke when an HTTP request is received
  */
 export function createServerHandler(handler) {
-    return async ({ socket }) => {
-        const unshiftable = new UnshiftableStream(socket.readable);
+    return async (event) => {
+        const s = event.socket;
+        const unshiftable = new UnshiftableStream(s.readable);
         while (true) {
             const req = await readRequest(unshiftable);
             if (!req)
                 break;
             const res = await handler(req);
-            writeResponse(socket.writable, res, 'HTTP/1.1');
+            writeResponse(s.writable, res, 'HTTP/1.1');
         }
-        socket.close();
+        s.close();
     };
 }
 /**
@@ -29,7 +32,9 @@ export function createServerHandler(handler) {
  * @example
  *
  * ```typescript
- * http.listen({
+ * import { listen } from '@nx.js/http';
+ *
+ * listen({
  *   port: 8080,
  *   fetch(req) {
  *     console.log(`Got HTTP ${req.method} request for "${req.url}"`);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEtD,OAAO,EAAE,uBAAuB,EAA8B,MAAM,UAAU,CAAC;AAc/E;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAsB;IACzD,OAAO,KAAK,EAAE,EAAE,MAAM,EAAsB,EAAE,EAAE;QAC/C,MAAM,WAAW,GAAG,IAAI,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC3D,OAAO,IAAI,EAAE,CAAC;YACb,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,CAAC;YAC3C,IAAI,CAAC,GAAG;gBAAE,MAAM;YAChB,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;YAC/B,aAAa,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,CAAC,KAAK,EAAE,CAAC;IAChB,CAAC,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,MAAM,CAAC,IAAmB;IACzC,MAAM,MAAM,GAAG,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/C,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AAC3C,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEtD,OAAO,EAAE,uBAAuB,EAA8B,MAAM,UAAU,CAAC;AAc/E;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAsB;IACzD,OAAO,KAAK,EAAE,KAAyB,EAAE,EAAE;QAC1C,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;QACvB,MAAM,WAAW,GAAG,IAAI,iBAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACtD,OAAO,IAAI,EAAE,CAAC;YACb,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,CAAC;YAC3C,IAAI,CAAC,GAAG;gBAAE,MAAM;YAChB,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;YAC/B,aAAa,CAAC,CAAC,CAAC,QAAQ,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;QAC5C,CAAC;QACD,CAAC,CAAC,KAAK,EAAE,CAAC;IACX,CAAC,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,MAAM,CAAC,IAAmB;IACzC,MAAM,MAAM,GAAG,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/C,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AAC3C,CAAC"}

package/dist/static.d.ts

@@ -1,4 +1,11 @@
+/**
+ * Options object for the {@link createStaticFileHandler | `createStaticFileHandler()`} function.
+ */
 export interface StaticFileHandlerOpts {
+    /**
+     * Addional HTTP headers to include in the response. Can be a static
+     * `Headers` object, or a function which returns a `Headers` object.
+     */
     headers?: HeadersInit | ((req: Request, path: URL) => HeadersInit);
 }
 export declare function resolvePath(url: string, root: string): URL;
@@ -8,9 +15,11 @@ export declare function resolvePath(url: string, root: string): URL;
  * @example
  *
  * ```typescript
- * const fileHandler = http.createStaticFileHandler('sdmc:/switch/');
+ * import { createStaticFileHandler, listen } from '@nx.js/http';
+ *
+ * const fileHandler = createStaticFileHandler('sdmc:/switch/');
  *
- * http.listen({
+ * listen({
  *   port: 8080,
  *   async fetch(req) {
  *     let res = await fileHandler(req);
@@ -23,5 +32,6 @@ export declare function resolvePath(url: string, root: string): URL;
  * ```
  *
  * @param root Root directory where static files are served from
+ * @param opts Optional options object
  */
 export declare function createStaticFileHandler(root: Switch.PathLike, opts?: StaticFileHandlerOpts): (req: Request) => Promise<Response | null>;

package/dist/static.js

@@ -10,9 +10,11 @@ export function resolvePath(url, root) {
  * @example
  *
  * ```typescript
- * const fileHandler = http.createStaticFileHandler('sdmc:/switch/');
+ * import { createStaticFileHandler, listen } from '@nx.js/http';
  *
- * http.listen({
+ * const fileHandler = createStaticFileHandler('sdmc:/switch/');
+ *
+ * listen({
  *   port: 8080,
  *   async fetch(req) {
  *     let res = await fileHandler(req);
@@ -25,11 +27,13 @@ export function resolvePath(url, root) {
  * ```
  *
  * @param root Root directory where static files are served from
+ * @param opts Optional options object
  */
-export function createStaticFileHandler(root, opts = {}) {
+export function createStaticFileHandler(root, opts) {
     let rootStr = String(root);
     if (!rootStr.endsWith('/'))
         rootStr += '/';
+    const oHeaders = opts?.headers;
     return async (req) => {
         const url = resolvePath(req.url, rootStr);
         const stat = await Switch.stat(url);
@@ -39,9 +43,7 @@ export function createStaticFileHandler(root, opts = {}) {
         const data = await Switch.readFile(url);
         if (!data)
             return null;
-        const headers = new Headers(typeof opts.headers === 'function'
-            ? opts.headers(req, url)
-            : opts.headers);
+        const headers = new Headers(typeof oHeaders === 'function' ? oHeaders(req, url) : oHeaders);
         headers.set('content-length', String(data.byteLength));
         headers.set('content-type', mime.getType(url.pathname) || 'application/octet-stream');
         return new Response(data, { headers });

package/dist/static.js.map

@@ -1 +1 @@
-{"version":3,"file":"static.js","sourceRoot":"","sources":["../src/static.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAMxB,MAAM,UAAU,WAAW,CAAC,GAAW,EAAE,IAAY;IACpD,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IAC7D,OAAO,QAAQ,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,uBAAuB,CACtC,IAAqB,EACrB,OAA8B,EAAE;IAEhC,IAAI,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC3B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,GAAG,CAAC;IAC3C,OAAO,KAAK,EAAE,GAAY,EAA4B,EAAE;QACvD,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QACvB,yCAAyC;QACzC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QACvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAC1B,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU;YACjC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC;YACxB,CAAC,CAAC,IAAI,CAAC,OAAO,CACf,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QACvD,OAAO,CAAC,GAAG,CACV,cAAc,EACd,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,0BAA0B,CACxD,CAAC;QACF,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC,CAAC;AACH,CAAC"}
+{"version":3,"file":"static.js","sourceRoot":"","sources":["../src/static.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAaxB,MAAM,UAAU,WAAW,CAAC,GAAW,EAAE,IAAY;IACpD,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IAC7D,OAAO,QAAQ,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,uBAAuB,CACtC,IAAqB,EACrB,IAA4B;IAE5B,IAAI,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC3B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,GAAG,CAAC;IAC3C,MAAM,QAAQ,GAAG,IAAI,EAAE,OAAO,CAAC;IAC/B,OAAO,KAAK,EAAE,GAAY,EAA4B,EAAE;QACvD,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QACvB,yCAAyC;QACzC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QACvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAC1B,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAC9D,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QACvD,OAAO,CAAC,GAAG,CACV,cAAc,EACd,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,0BAA0B,CACxD,CAAC;QACF,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC,CAAC;AACH,CAAC"}

package/package.json

@@ -1,7 +1,13 @@
 {
   "name": "@nx.js/http",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "HTTP server for nx.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TooTallNate/nx.js.git",
+    "directory": "packages/http"
+  },
+  "homepage": "https://nxjs.n8.io/http",
   "main": "dist/index.js",
   "files": [
     "dist"
@@ -12,7 +18,7 @@
   "devDependencies": {
     "vite": "^5.1.6",
     "vitest": "^1.3.1",
-    "nxjs-runtime": "0.0.47"
+    "nxjs-runtime": "0.0.48"
   },
   "keywords": [
     "nx.js",
@@ -27,6 +33,7 @@
   },
   "scripts": {
     "build": "tsc",
-    "test": "vitest"
+    "test": "vitest",
+    "docs": "typedoc && ../../type-aliases-meta.sh"
   }
 }