@prairielearn/html-ejs 1.0.1

package/.turbo/turbo-build.log

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

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# @prairielearn/html-ejs
+
+## 1.0.1
+
+### Patch Changes
+
+- Updated dependencies [56f1333fc]
+  - @prairielearn/html@2.0.0

package/README.md

@@ -0,0 +1,22 @@
+# `@prairielearn/html-ejs`
+
+Utilities for rendering EJS templates for use with the `@prairielearn/html` package.
+
+If you have an EJS partial that you'd like to use inside of an `html` tagged template literal, you can use the `renderEjs` helper:
+
+```html
+<!-- hello.ejs -->
+Hello, <%= name %>!
+```
+
+```js
+import { html } from '@prairielearn/html';
+import { renderEjs } from '@prairielearn/html-ejs';
+
+console.log(
+  html`
+    <div>Hello, world!</div>
+    <div>${renderEjs(__filename, "<%- include('./hello'); %>", { name: 'Anjali' })}</div>
+  `.toString()
+);
+```

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import { type HtmlSafeString } from '@prairielearn/html';
+/**
+ * This is a shim to allow for the use of EJS templates inside of HTML tagged
+ * template literals.
+ *
+ * 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 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;

package/dist/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderEjs = void 0;
+const ejs_1 = __importDefault(require("ejs"));
+const path_1 = __importDefault(require("path"));
+const html_1 = require("@prairielearn/html");
+/**
+ * This is a shim to allow for the use of EJS templates inside of HTML tagged
+ * template literals.
+ *
+ * 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 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)] }));
+}
+exports.renderEjs = renderEjs;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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"}

package/dist/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.test.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const index_1 = require("./index");
+describe('renderEjs', () => {
+    it('renders EJS template without data', () => {
+        chai_1.assert.equal((0, index_1.renderEjs)(__filename, '<p>Hello</p>', {}).toString(), '<p>Hello</p>');
+    });
+    it('renders EJS template with data', () => {
+        chai_1.assert.equal((0, index_1.renderEjs)(__filename, '<p>Hello <%= name %></p>', { name: 'Divya' }).toString(), '<p>Hello Divya</p>');
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAE9B,mCAAoC;AAEpC,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,aAAM,CAAC,KAAK,CAAC,IAAA,iBAAS,EAAC,UAAU,EAAE,cAAc,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,cAAc,CAAC,CAAC;IACrF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,aAAM,CAAC,KAAK,CACV,IAAA,iBAAS,EAAC,UAAU,EAAE,0BAA0B,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,EAC/E,oBAAoB,CACrB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@prairielearn/html-ejs",
+  "version": "1.0.1",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch --preserveWatchOutput",
+    "test": "mocha --no-config --require ts-node/register src/index.test.ts"
+  },
+  "dependencies": {
+    "@prairielearn/html": "^2.0.0",
+    "ejs": "^3.1.6"
+  },
+  "devDependencies": {
+    "@prairielearn/tsconfig": "*",
+    "@types/ejs": "^3.1.0",
+    "mocha": "^9.2.2",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.3"
+  }
+}

package/src/index.test.ts

@@ -0,0 +1,16 @@
+import { assert } from 'chai';
+
+import { renderEjs } from './index';
+
+describe('renderEjs', () => {
+  it('renders EJS template without data', () => {
+    assert.equal(renderEjs(__filename, '<p>Hello</p>', {}).toString(), '<p>Hello</p>');
+  });
+
+  it('renders EJS template with data', () => {
+    assert.equal(
+      renderEjs(__filename, '<p>Hello <%= name %></p>', { name: 'Divya' }).toString(),
+      '<p>Hello Divya</p>'
+    );
+  });
+});

package/src/index.ts

@@ -0,0 +1,19 @@
+import ejs from 'ejs';
+import path from 'path';
+
+import { unsafeHtml, type HtmlSafeString } from '@prairielearn/html';
+/**
+ * This is a shim to allow for the use of EJS templates inside of HTML tagged
+ * template literals.
+ *
+ * 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 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)] }));
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@prairielearn/tsconfig",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+  }
+}