@zipadee/javascript 0.0.6

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Justin Fagnani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,35 @@
+# @zipadee/javascript
+
+Zipadee middleware for serving JavaScript modules
+
+> [!CAUTION] Zipadee is very early, under construction, will change a lot, and
+> may never be sufficiently maintained for any level of use. If you want to try
+> it, please consider contributing!
+
+`@zipadee/javascript` serves static JavaScript files from disk and transforms
+them to resolve bare import specifiers to relative paths.
+
+## Usage
+
+```ts
+import {App} from 'zipadee';
+import {serve as serveJS} from '@zipadee/javascript';
+import {serve} from '@zipadee/static';
+
+const app = new App();
+
+// Serves all JS files in the directory {cwd}/files/
+app.use(serveJS({root: 'files'}));
+
+// Serves all other files in the directory {cwd}/files/
+app.use(serve({root: 'files'}));
+
+app.listen();
+```
+
+## Options
+
+- `base`: The directory that paths are resolved against to find on disk. This directory is typically where first-party JavaScript files are located. Must be a subpath of `root`. Defaults to the value of `root`.
+- `root`: The root directory that files are restricted to. Import specifiers can resolve to a path outside of `base` (this is common with npm dependencies, and monorepos), but they are disallowed to be served from outside of `root`. Defaults to the current working directory.
+- `rootPathPrefix`: Imports that resolve to outside of the base directory are prefixed with the `rootPathPrefix` in order to resolve them against the `root` directory instead of the `base` directory. Defaults to `'/__root__'`.
+- `extensions`: Array of file extensions to serve. Defaults to `['.js', '.mjs']`. Files not matching these extensions will not be handled by this middleware. They can be served by other downstream middleware.

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/serve.js';
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC"}

package/index.js

@@ -0,0 +1,2 @@
+export * from './lib/serve.js';
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC"}

package/lib/serve.d.ts

@@ -0,0 +1,27 @@
+import {type Middleware} from '@zipadee/core';
+export interface Options {
+  /**
+   * Root directory to restrict file access. Defaults to the current working
+   * directory.
+   */
+  root?: string;
+  /**
+   * Base path to resolve imports from. Defaults to the current working
+   * directory.
+   */
+  base?: string;
+  /**
+   * Imports resolved to outside of the base path will be prefixed with this
+   * string. Defaults to `/__root__`.
+   */
+  rootPathPrefix?: string;
+  /**
+   * Array of file extensions to serve. Defaults to `['.js', '.mjs']`.
+   */
+  extensions?: string[];
+}
+/**
+ * Serve static JavaScript files from a `root` directory.
+ */
+export declare const serve: (opts: Options) => Middleware;
+//# sourceMappingURL=serve.d.ts.map

package/lib/serve.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve.d.ts","sourceRoot":"","sources":["../src/lib/serve.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,UAAU,EAAC,MAAM,eAAe,CAAC;AAczD,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAYD;;GAEG;AACH,eAAO,MAAM,KAAK,SAAU,OAAO,KAAG,UAiFrC,CAAC"}

package/lib/serve.js

@@ -0,0 +1,93 @@
+import {HttpError} from '@zipadee/core';
+import {
+  decodePath,
+  pathIsHidden,
+  resolvePath,
+  stat,
+} from '@zipadee/static/lib/utils.js';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import {parse, init} from 'es-module-lexer';
+import {moduleResolve} from 'import-meta-resolve';
+await init;
+// TODO:
+// - Add caching for both specifier resolution and files
+// - Prepopulate the cache based on the module graph
+// - Add support for dynamic imports
+// - Add support for import maps?
+// - Test support for import attributes
+// - Add option for import conditions
+// - Add support for transforming <script type="module"> tags in HTML
+// - Automatically handle CORS requests?
+/**
+ * Serve static JavaScript files from a `root` directory.
+ */
+export const serve = (opts) => {
+  const root =
+    opts.root === undefined ? process.cwd() : path.resolve(opts.root);
+  const base = opts.base === undefined ? root : resolvePath(root, opts.base);
+  const rootFolderName = opts.rootPathPrefix ?? '/__root__';
+  const extensions = opts.extensions ?? ['.js', '.mjs'];
+  return async (req, res, next) => {
+    if (!(req.method === 'HEAD' || req.method === 'GET')) {
+      // TODO: implement HEAD?
+      return await next();
+    }
+    let filePath = decodePath(req.path);
+    const parsedPath = path.parse(filePath);
+    // Only serve JavaScript files
+    if (!extensions.includes(parsedPath.ext)) {
+      return await next();
+    }
+    if (filePath.startsWith(rootFolderName)) {
+      filePath = filePath.substring(rootFolderName.length);
+      filePath = filePath.slice(parsedPath.root.length);
+      filePath = resolvePath(root, filePath);
+    } else {
+      filePath = filePath.slice(parsedPath.root.length);
+      filePath = resolvePath(base, filePath);
+    }
+    if (pathIsHidden(base, filePath)) {
+      return await next();
+    }
+    const stats = await stat(filePath);
+    if (stats.isDirectory()) {
+      return await next();
+    }
+    const source = await fs.readFile(filePath, 'utf8');
+    const [imports, _exports, _facade, _hasModuleSyntax] = parse(
+      source,
+      filePath,
+    );
+    let output = '';
+    let lastIndex = 0;
+    for (const impt of imports) {
+      const {t: type, s: start, e: end, n: unescaped} = impt;
+      if (type === 1) {
+        // Static import
+        const importSpecifier = unescaped || source.substring(start, end);
+        const fileURL = new URL(filePath, 'file://');
+        const resolvedImportURL = moduleResolve(importSpecifier, fileURL);
+        const resolvedImportPath = resolvedImportURL.pathname;
+        if (!resolvedImportPath.startsWith(root)) {
+          console.log('A', resolvedImportPath);
+          throw new HttpError(500);
+        }
+        let resolvedimport;
+        if (resolvedImportPath.startsWith(base)) {
+          resolvedimport = resolvedImportPath.substring(base.length);
+        } else {
+          resolvedimport = path.join(
+            rootFolderName,
+            resolvedImportPath.substring(root.length),
+          );
+        }
+        output += `${source.substring(lastIndex, start)}${resolvedimport}`;
+        lastIndex = end;
+      }
+    }
+    res.type = 'text/javascript';
+    res.body = output + source.substring(lastIndex);
+  };
+};
+//# sourceMappingURL=serve.js.map

package/lib/serve.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve.js","sourceRoot":"","sources":["../src/lib/serve.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAkB,MAAM,eAAe,CAAC;AACzD,OAAO,EACL,UAAU,EACV,YAAY,EACZ,WAAW,EACX,IAAI,GACL,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAC,KAAK,EAAE,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAElD,MAAM,IAAI,CAAC;AA2BX,QAAQ;AACR,wDAAwD;AACxD,oDAAoD;AACpD,oCAAoC;AACpC,iCAAiC;AACjC,uCAAuC;AACvC,qCAAqC;AACrC,qEAAqE;AACrE,wCAAwC;AAExC;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,IAAa,EAAc,EAAE;IACjD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3E,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,WAAW,CAAC;IAC1D,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAEtD,OAAO,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC9B,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,KAAK,MAAM,IAAI,GAAG,CAAC,MAAM,KAAK,KAAK,CAAC,EAAE,CAAC;YACrD,wBAAwB;YACxB,OAAO,MAAM,IAAI,EAAE,CAAC;QACtB,CAAC;QAED,IAAI,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEpC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAExC,8BAA8B;QAC9B,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACzC,OAAO,MAAM,IAAI,EAAE,CAAC;QACtB,CAAC;QAED,IAAI,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;YACxC,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YACrD,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAClD,QAAQ,GAAG,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAClD,QAAQ,GAAG,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACzC,CAAC;QAED,IAAI,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC;YACjC,OAAO,MAAM,IAAI,EAAE,CAAC;QACtB,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEnC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,OAAO,MAAM,IAAI,EAAE,CAAC;QACtB,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,gBAAgB,CAAC,GAAG,KAAK,CAC1D,MAAM,EACN,QAAQ,CACT,CAAC;QACF,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,SAAS,GAAG,CAAC,CAAC;QAElB,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,EAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,SAAS,EAAC,GAAG,IAAI,CAAC;YACvD,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,gBAAgB;gBAChB,MAAM,eAAe,GAAG,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;gBAElE,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;gBAC7C,MAAM,iBAAiB,GAAG,aAAa,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;gBAClE,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,QAAQ,CAAC;gBAEtD,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBACzC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;oBACrC,MAAM,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;gBAC3B,CAAC;gBAED,IAAI,cAAsB,CAAC;gBAC3B,IAAI,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBACxC,cAAc,GAAG,kBAAkB,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC7D,CAAC;qBAAM,CAAC;oBACN,cAAc,GAAG,IAAI,CAAC,IAAI,CACxB,cAAc,EACd,kBAAkB,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAC1C,CAAC;gBACJ,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,GAAG,cAAc,EAAE,CAAC;gBACnE,SAAS,GAAG,GAAG,CAAC;YAClB,CAAC;QACH,CAAC;QAED,GAAG,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC7B,GAAG,CAAC,IAAI,GAAG,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAClD,CAAC,CAAC;AACJ,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@zipadee/javascript",
+  "version": "0.0.6",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "build": "wireit",
+    "test": "wireit"
+  },
+  "keywords": [],
+  "author": "",
+  "homepage": "https://github.com/justinfagnani/zipadee#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/justinfagnani/zipadee.git",
+    "directory": "packages/javascript"
+  },
+  "license": "MIT",
+  "description": "Zipadee middleware for serving JavaScript files",
+  "files": [
+    "/index.{d.ts.map,d.ts,js.map,js}",
+    "/lib/"
+  ],
+  "devDependencies": {
+    "@types/es-module-lexer": "^0.4.1",
+    "@types/node": "^20.14.10",
+    "@types/supertest": "^6.0.2",
+    "supertest": "^7.0.0"
+  },
+  "wireit": {
+    "build": {
+      "command": "tsc",
+      "dependencies": [
+        "../core:build",
+        "../static:build"
+      ],
+      "files": [
+        "src/**/*.ts",
+        "tsconfig.json"
+      ],
+      "output": [
+        "index.{js,js.map,d.ts,d.ts.map}",
+        ".tsbuildinfo",
+        "lib"
+      ],
+      "clean": "if-file-deleted"
+    },
+    "test": {
+      "command": "node --enable-source-maps --test --test-reporter=spec \"test/**/*_test.js\"",
+      "dependencies": [
+        "build"
+      ],
+      "files": [
+        "test/fixtures/**/*"
+      ]
+    }
+  },
+  "dependencies": {
+    "@zipadee/core": "^0.0.6",
+    "@zipadee/static": "^0.0.6",
+    "import-meta-resolve": "^4.1.0"
+  }
+}