@prairielearn/html-ejs 1.0.1 → 1.1.0

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-@prairielearn/html-ejs:build: cache hit, replaying output 23880d36fc6dfce7
+@prairielearn/html-ejs:build: cache hit, replaying output f31190aa13d9e859
 @prairielearn/html-ejs:build: warning package.json: No license field
 @prairielearn/html-ejs:build: $ tsc

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @prairielearn/html-ejs
 
+## 1.1.0
+
+### Minor Changes
+
+- 1aa43c734: Allow file URLs to be passed to `renderEjs`
+
 ## 1.0.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -6,9 +6,9 @@ import { type HtmlSafeString } from '@prairielearn/html';
  * The resulting string is assumed to be appropriately escaped and will be used
  * verbatim in the resulting HTML.
  *
- * @param filename The name of the file from which relative includes should be resolved.
+ * @param filePathOrUrl The path or file URL of the file from which relative includes should be resolved.
  * @param template The raw EJS template string.
  * @param data Any data to be made available to the template.
  * @returns The rendered EJS.
  */
-export declare function renderEjs(filename: string, template: string, data?: any): HtmlSafeString;
+export declare function renderEjs(filePathOrUrl: string, template: string, data?: any): HtmlSafeString;

package/dist/index.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.renderEjs = void 0;
 const ejs_1 = __importDefault(require("ejs"));
 const path_1 = __importDefault(require("path"));
+const url_1 = require("url");
 const html_1 = require("@prairielearn/html");
 /**
  * This is a shim to allow for the use of EJS templates inside of HTML tagged
@@ -14,13 +15,19 @@ const html_1 = require("@prairielearn/html");
  * The resulting string is assumed to be appropriately escaped and will be used
  * verbatim in the resulting HTML.
  *
- * @param filename The name of the file from which relative includes should be resolved.
+ * @param filePathOrUrl The path or file URL of the file from which relative includes should be resolved.
  * @param template The raw EJS template string.
  * @param data Any data to be made available to the template.
  * @returns The rendered EJS.
  */
-function renderEjs(filename, template, data = {}) {
-    return (0, html_1.unsafeHtml)(ejs_1.default.render(template, data, { views: [path_1.default.dirname(filename)] }));
+function renderEjs(filePathOrUrl, template, data = {}) {
+    let resolvedPath = filePathOrUrl;
+    // This allows for us to pass `import.meta.url` to this function in ES Modules
+    // environments where `__filename` is not available.
+    if (filePathOrUrl.startsWith('file://')) {
+        resolvedPath = (0, url_1.fileURLToPath)(filePathOrUrl);
+    }
+    return (0, html_1.unsafeHtml)(ejs_1.default.render(template, data, { views: [path_1.default.dirname(resolvedPath)] }));
 }
 exports.renderEjs = renderEjs;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAsB;AACtB,gDAAwB;AAExB,6CAAqE;AACrE;;;;;;;;;;;GAWG;AACH,SAAgB,SAAS,CAAC,QAAgB,EAAE,QAAgB,EAAE,OAAY,EAAE;IAC1E,OAAO,IAAA,iBAAU,EAAC,aAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACrF,CAAC;AAFD,8BAEC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAsB;AACtB,gDAAwB;AACxB,6BAAoC;AAEpC,6CAAqE;AACrE;;;;;;;;;;;GAWG;AACH,SAAgB,SAAS,CAAC,aAAqB,EAAE,QAAgB,EAAE,OAAY,EAAE;IAC/E,IAAI,YAAY,GAAG,aAAa,CAAC;IAEjC,8EAA8E;IAC9E,oDAAoD;IACpD,IAAI,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QACvC,YAAY,GAAG,IAAA,mBAAa,EAAC,aAAa,CAAC,CAAC;KAC7C;IAED,OAAO,IAAA,iBAAU,EAAC,aAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,cAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACzF,CAAC;AAVD,8BAUC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/html-ejs",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc",
@@ -9,13 +9,13 @@
   },
   "dependencies": {
     "@prairielearn/html": "^2.0.0",
-    "ejs": "^3.1.6"
+    "ejs": "^3.1.8"
   },
   "devDependencies": {
     "@prairielearn/tsconfig": "*",
-    "@types/ejs": "^3.1.0",
-    "mocha": "^9.2.2",
-    "ts-node": "^10.7.0",
-    "typescript": "^4.6.3"
+    "@types/ejs": "^3.1.1",
+    "mocha": "^10.0.0",
+    "ts-node": "^10.8.1",
+    "typescript": "^4.7.4"
   }
 }

package/src/index.ts

@@ -1,5 +1,6 @@
 import ejs from 'ejs';
 import path from 'path';
+import { fileURLToPath } from 'url';
 
 import { unsafeHtml, type HtmlSafeString } from '@prairielearn/html';
 /**
@@ -9,11 +10,19 @@ import { unsafeHtml, type HtmlSafeString } from '@prairielearn/html';
  * The resulting string is assumed to be appropriately escaped and will be used
  * verbatim in the resulting HTML.
  *
- * @param filename The name of the file from which relative includes should be resolved.
+ * @param filePathOrUrl The path or file URL of the file from which relative includes should be resolved.
  * @param template The raw EJS template string.
  * @param data Any data to be made available to the template.
  * @returns The rendered EJS.
  */
-export function renderEjs(filename: string, template: string, data: any = {}): HtmlSafeString {
-  return unsafeHtml(ejs.render(template, data, { views: [path.dirname(filename)] }));
+export function renderEjs(filePathOrUrl: string, template: string, data: any = {}): HtmlSafeString {
+  let resolvedPath = filePathOrUrl;
+
+  // This allows for us to pass `import.meta.url` to this function in ES Modules
+  // environments where `__filename` is not available.
+  if (filePathOrUrl.startsWith('file://')) {
+    resolvedPath = fileURLToPath(filePathOrUrl);
+  }
+
+  return unsafeHtml(ejs.render(template, data, { views: [path.dirname(resolvedPath)] }));
 }

package/tsconfig.json

@@ -3,5 +3,6 @@
   "compilerOptions": {
     "outDir": "./dist",
     "rootDir": "./src",
+    "types": ["mocha", "node"],
   }
 }