+
+
+
+
+
+
diff --git a/packages/bench/src/scenarios/all/hydration/main.ts b/packages/bench/src/scenarios/all/hydration/main.ts
new file mode 100644
index 00000000000..6559a23726f
--- /dev/null
+++ b/packages/bench/src/scenarios/all/hydration/main.ts
@@ -0,0 +1,17 @@
+import { RenderableFASTElement, TemplateElement } from "@microsoft/fast-html";
+import { signalDone } from "../../harness.js";
+import { BenchElement } from "../element.js";
+
+RenderableFASTElement(BenchElement).defineAsync({
+ name: "all-bench-element",
+ templateOptions: "defer-and-hydrate",
+});
+
+performance.mark("bench-start");
+
+TemplateElement.config({
+ hydrationComplete() {
+ performance.mark("bench-end");
+ signalDone();
+ },
+}).define({ name: "f-template" });
diff --git a/packages/bench/src/scenarios/attr-reflect/csr/main.ts b/packages/bench/src/scenarios/attr-reflect/csr/main.ts
index 258bb980ded..497eea9005b 100644
--- a/packages/bench/src/scenarios/attr-reflect/csr/main.ts
+++ b/packages/bench/src/scenarios/attr-reflect/csr/main.ts
@@ -1,19 +1,16 @@
-import { html } from "@microsoft/fast-element";
import { runBenchmark } from "../../harness.js";
-import { BenchElement } from "../element.js";
+import { BenchElement, template } from "../element.js";
BenchElement.define({
- name: "bench-element",
- template: html
Jane
@@ -8,6 +8,6 @@ export function render(): string {
47.6
-
{{user.name}}
diff --git a/packages/bench/src/scenarios/ref-slotted/csr/main.ts b/packages/bench/src/scenarios/ref-slotted/csr/main.ts
index 83ba22f5426..9fe7ae025a7 100644
--- a/packages/bench/src/scenarios/ref-slotted/csr/main.ts
+++ b/packages/bench/src/scenarios/ref-slotted/csr/main.ts
@@ -1,17 +1,13 @@
-import { html, ref, slotted } from "@microsoft/fast-element";
import { runBenchmark } from "../../harness.js";
-import { BenchElement } from "../element.js";
+import { BenchElement, template } from "../element.js";
BenchElement.define({
- name: "bench-element",
- template: html`
- `
+
+
+
`;
}
diff --git a/packages/bench/src/scenarios/ref-slotted/template.html b/packages/bench/src/scenarios/ref-slotted/template.html
index 3e26d425821..a9366c44068 100644
--- a/packages/bench/src/scenarios/ref-slotted/template.html
+++ b/packages/bench/src/scenarios/ref-slotted/template.html
@@ -1,4 +1,4 @@
-
+
`
- `
+ ${item} `
+ `${item} `,
)
.join("");
@@ -10,8 +10,8 @@ const shadowContent = `
-
+
`;
}
diff --git a/packages/bench/src/scenarios/when/template.html b/packages/bench/src/scenarios/when/template.html
index 526f74f0447..3b4a0c89eae 100644
--- a/packages/bench/src/scenarios/when/template.html
+++ b/packages/bench/src/scenarios/when/template.html
@@ -1,4 +1,4 @@
-
+
Visible
Hidden
diff --git a/packages/bench/vite.config.ts b/packages/bench/vite.config.ts
index c1267385824..1dff1501f21 100644
--- a/packages/bench/vite.config.ts
+++ b/packages/bench/vite.config.ts
@@ -1,18 +1,41 @@
import { existsSync, readdirSync, readFileSync } from "node:fs";
import { dirname, resolve } from "node:path";
-import { fileURLToPath, pathToFileURL } from "node:url";
+import { fileURLToPath } from "node:url";
import { defineConfig } from "vite";
+import { render as attrReflectRender } from "./src/scenarios/attr-reflect/hydration/render.ts";
+import { render as basicRender } from "./src/scenarios/basic/hydration/render.ts";
+import { render as bindEventRender } from "./src/scenarios/bind-event/hydration/render.ts";
+import { render as dotSyntaxRender } from "./src/scenarios/dot-syntax/hydration/render.ts";
+import { render as refSlottedRender } from "./src/scenarios/ref-slotted/hydration/render.ts";
+import { render as repeatRender } from "./src/scenarios/repeat/hydration/render.ts";
import {
BENCH_TREE_CONFIG,
buildTree,
renderTreeToHTMLWith,
} from "./src/scenarios/tree.js";
+import { render as whenRender } from "./src/scenarios/when/hydration/render.ts";
const __dirname = dirname(fileURLToPath(import.meta.url));
const benchmarksDir = resolve(__dirname, "src", "scenarios");
const buildId = process.env.BUILD_ID;
const base = buildId ? `/${buildId}/` : "/";
+const scenarioRenders: Record string> = {
+ "attr-reflect": attrReflectRender,
+ basic: basicRender,
+ "bind-event": bindEventRender,
+ "dot-syntax": dotSyntaxRender,
+ "ref-slotted": refSlottedRender,
+ repeat: repeatRender,
+ when: whenRender,
+};
+
+function allRender(index: number): string {
+ return Object.values(scenarioRenders)
+ .map(render => render(index))
+ .join("");
+}
+
function discoverBenchmarkInputs(): Record {
const inputs: Record = {
main: resolve(benchmarksDir, "index.html"),
@@ -25,7 +48,7 @@ function discoverBenchmarkInputs(): Record {
const scenarioDir = resolve(benchmarksDir, scenario.name);
const variants = readdirSync(scenarioDir, { withFileTypes: true }).filter(d =>
- d.isDirectory()
+ d.isDirectory(),
);
for (const variant of variants) {
@@ -49,17 +72,34 @@ export default defineConfig({
name: "html-transform",
enforce: "pre",
async transformIndexHtml(html, { filename }) {
- // Render-function driven SSR: builds a deterministic
- // tree (~1 000 nodes) and calls the scenario's render()
- // function discovered next to the index.html being processed.
- //
- const renderModulePath = resolve(dirname(filename), "render.ts");
+ if (html.includes("")) {
+ const allTemplates: string[] = [];
+ for (const entry of readdirSync(benchmarksDir, {
+ withFileTypes: true,
+ })) {
+ if (!entry.isDirectory() || entry.name === "all") {
+ continue;
+ }
+ const tplPath = resolve(
+ benchmarksDir,
+ entry.name,
+ "template.html",
+ );
+ if (existsSync(tplPath)) {
+ allTemplates.push(readFileSync(tplPath, "utf-8"));
+ }
+ }
+ html = html.replace(
+ "",
+ allTemplates.join("\n"),
+ );
+ }
if (html.includes("")) {
const templatePath = resolve(
dirname(filename),
"..",
- "template.html"
+ "template.html",
);
if (existsSync(templatePath)) {
const template = readFileSync(templatePath, "utf-8");
@@ -67,10 +107,11 @@ export default defineConfig({
}
}
- if (html.includes("@bench-ssr-render") && existsSync(renderModulePath)) {
- const { render } = (await import(
- pathToFileURL(renderModulePath).href
- )) as { render: (index: number) => string };
+ if (html.includes("@bench-ssr-render")) {
+ const scenarioName = resolve(dirname(filename), "..")
+ .split("/")
+ .pop()!;
+ const render = scenarioRenders[scenarioName] ?? allRender;
html = html.replace(
//g,
@@ -83,7 +124,7 @@ export default defineConfig({
: BENCH_TREE_CONFIG;
const tree = buildTree(config);
return renderTreeToHTMLWith(tree, render);
- }
+ },
);
}
@@ -93,7 +134,7 @@ export default defineConfig({
Object.keys(discoverBenchmarkInputs())
.filter(key => key !== "main")
.map(key => `${key} `)
- .join("\n")
+ .join("\n"),
);
return html;
From 6bedad915e88e6d0d4c4cf38d91da1d59abc3618 Mon Sep 17 00:00:00 2001
From: Jane Chu <7559015+janechu@users.noreply.github.com>
Date: Mon, 20 Apr 2026 15:20:20 -0700
Subject: [PATCH 03/11] refactor: move bench package from packages/bench to
sites/benchmarks (#7459)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
# Pull Request
## 📖 Description
Moves the private `@microsoft/fast-bench` package from `packages/bench/` to `sites/benchmarks/` to better reflect its role as an internal site/tool rather than a publishable package. Also simplifies the root `package.json` workspaces by using glob patterns (`sites/*`, `examples/*`) instead of listing each workspace explicitly.
**Changes:**
- Move `packages/bench/` → `sites/benchmarks/` via `git mv`
- Update root `package.json` workspaces to use `sites/*` and `examples/*` globs
- Update `copilot-instructions.md` to reflect new location
- Update `README.md` folder path reference
- Regenerate `package-lock.json`
## 📑 Test Plan
- All existing tests pass — the bench package is private with no dependents
- `npm run checkchange` confirms no change files are needed (private package excluded from beachball scope)
- Workspace resolution verified via `npm ls`
## ✅ Checklist
### General
- [x] I have included a change request file using `$ npm run change`
- [ ] I have added tests for my changes.
- [x] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/main/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/main/CODE_OF_CONDUCT.md#our-standards) for this project.
---
.github/copilot-instructions.md | 2 +-
package-lock.json | 209 ++++--------------
package.json | 5 +-
.../bench => sites/benchmarks}/.gitignore | 0
.../bench => sites/benchmarks}/README.md | 2 +-
.../bench => sites/benchmarks}/package.json | 0
.../benchmarks}/server/package.json | 0
.../benchmarks}/server/server.mjs | 0
.../bench => sites/benchmarks}/src/bench.ts | 0
.../bench => sites/benchmarks}/src/chart.ts | 0
.../bench => sites/benchmarks}/src/report.ts | 0
.../src/scenarios/all/csr/index.html | 0
.../benchmarks}/src/scenarios/all/csr/main.ts | 0
.../benchmarks}/src/scenarios/all/element.ts | 0
.../src/scenarios/all/hydration/index.html | 0
.../src/scenarios/all/hydration/main.ts | 0
.../src/scenarios/attr-reflect/csr/index.html | 0
.../src/scenarios/attr-reflect/csr/main.ts | 0
.../src/scenarios/attr-reflect/element.ts | 0
.../attr-reflect/hydration/index.html | 0
.../scenarios/attr-reflect/hydration/main.ts | 0
.../attr-reflect/hydration/render.ts | 0
.../src/scenarios/attr-reflect/template.html | 0
.../src/scenarios/basic/csr/index.html | 0
.../src/scenarios/basic/csr/main.ts | 0
.../src/scenarios/basic/element.ts | 0
.../src/scenarios/basic/hydration/index.html | 0
.../src/scenarios/basic/hydration/main.ts | 0
.../src/scenarios/basic/hydration/render.ts | 0
.../src/scenarios/basic/template.html | 0
.../src/scenarios/bind-event/csr/index.html | 0
.../src/scenarios/bind-event/csr/main.ts | 0
.../src/scenarios/bind-event/element.ts | 0
.../scenarios/bind-event/hydration/index.html | 0
.../scenarios/bind-event/hydration/main.ts | 0
.../scenarios/bind-event/hydration/render.ts | 0
.../src/scenarios/bind-event/template.html | 0
.../src/scenarios/dot-syntax/csr/index.html | 0
.../src/scenarios/dot-syntax/csr/main.ts | 0
.../src/scenarios/dot-syntax/element.ts | 0
.../scenarios/dot-syntax/hydration/index.html | 0
.../scenarios/dot-syntax/hydration/main.ts | 0
.../scenarios/dot-syntax/hydration/render.ts | 0
.../src/scenarios/dot-syntax/template.html | 0
.../benchmarks}/src/scenarios/harness.ts | 0
.../benchmarks}/src/scenarios/index.html | 0
.../src/scenarios/ref-slotted/csr/index.html | 0
.../src/scenarios/ref-slotted/csr/main.ts | 0
.../src/scenarios/ref-slotted/element.ts | 0
.../ref-slotted/hydration/index.html | 0
.../scenarios/ref-slotted/hydration/main.ts | 0
.../scenarios/ref-slotted/hydration/render.ts | 0
.../src/scenarios/ref-slotted/template.html | 0
.../src/scenarios/repeat/csr/index.html | 0
.../src/scenarios/repeat/csr/main.ts | 0
.../src/scenarios/repeat/element.ts | 0
.../src/scenarios/repeat/hydration/index.html | 0
.../src/scenarios/repeat/hydration/main.ts | 0
.../src/scenarios/repeat/hydration/render.ts | 0
.../src/scenarios/repeat/template.html | 0
.../benchmarks}/src/scenarios/report.css | 0
.../benchmarks}/src/scenarios/report.js | 0
.../benchmarks}/src/scenarios/tree.ts | 0
.../src/scenarios/when/csr/index.html | 0
.../src/scenarios/when/csr/main.ts | 0
.../benchmarks}/src/scenarios/when/element.ts | 0
.../src/scenarios/when/hydration/index.html | 0
.../src/scenarios/when/hydration/main.ts | 0
.../src/scenarios/when/hydration/render.ts | 0
.../src/scenarios/when/template.html | 0
.../bench => sites/benchmarks}/src/trace.ts | 0
.../bench => sites/benchmarks}/tsconfig.json | 0
.../bench => sites/benchmarks}/vite.config.ts | 0
73 files changed, 50 insertions(+), 168 deletions(-)
rename {packages/bench => sites/benchmarks}/.gitignore (100%)
rename {packages/bench => sites/benchmarks}/README.md (98%)
rename {packages/bench => sites/benchmarks}/package.json (100%)
rename {packages/bench => sites/benchmarks}/server/package.json (100%)
rename {packages/bench => sites/benchmarks}/server/server.mjs (100%)
rename {packages/bench => sites/benchmarks}/src/bench.ts (100%)
rename {packages/bench => sites/benchmarks}/src/chart.ts (100%)
rename {packages/bench => sites/benchmarks}/src/report.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/all/csr/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/all/csr/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/all/element.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/all/hydration/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/all/hydration/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/attr-reflect/csr/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/attr-reflect/csr/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/attr-reflect/element.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/attr-reflect/hydration/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/attr-reflect/hydration/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/attr-reflect/hydration/render.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/attr-reflect/template.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/basic/csr/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/basic/csr/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/basic/element.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/basic/hydration/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/basic/hydration/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/basic/hydration/render.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/basic/template.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/bind-event/csr/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/bind-event/csr/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/bind-event/element.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/bind-event/hydration/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/bind-event/hydration/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/bind-event/hydration/render.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/bind-event/template.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/dot-syntax/csr/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/dot-syntax/csr/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/dot-syntax/element.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/dot-syntax/hydration/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/dot-syntax/hydration/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/dot-syntax/hydration/render.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/dot-syntax/template.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/harness.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/ref-slotted/csr/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/ref-slotted/csr/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/ref-slotted/element.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/ref-slotted/hydration/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/ref-slotted/hydration/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/ref-slotted/hydration/render.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/ref-slotted/template.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/repeat/csr/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/repeat/csr/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/repeat/element.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/repeat/hydration/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/repeat/hydration/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/repeat/hydration/render.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/repeat/template.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/report.css (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/report.js (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/tree.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/when/csr/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/when/csr/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/when/element.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/when/hydration/index.html (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/when/hydration/main.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/when/hydration/render.ts (100%)
rename {packages/bench => sites/benchmarks}/src/scenarios/when/template.html (100%)
rename {packages/bench => sites/benchmarks}/src/trace.ts (100%)
rename {packages/bench => sites/benchmarks}/tsconfig.json (100%)
rename {packages/bench => sites/benchmarks}/vite.config.ts (100%)
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
index f8a84e735df..dd1f5e1b04a 100644
--- a/.github/copilot-instructions.md
+++ b/.github/copilot-instructions.md
@@ -27,8 +27,8 @@ FAST (`@microsoft/fast`) is a Microsoft open-source monorepo for building W3C-st
| Package | Status | Purpose |
|---|---|---|
-| `@microsoft/fast-bench` | Private (not published as a package) | Benchmarking utilities |
| `sites/website` | Private (not published as a package) | Documentation website source |
+| `sites/benchmarks` | Private (not published as a package) | Benchmarking utilities |
| `@microsoft/fast-ssr` | Alpha (not actively maintained) | Server-side rendering utilities |
### Example projects
diff --git a/package-lock.json b/package-lock.json
index b24f9f73030..d5a5976c200 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -11,9 +11,8 @@
"workspaces": [
"build",
"packages/*",
- "sites/website",
- "examples/todo-app",
- "examples/ssr"
+ "sites/*",
+ "examples/*"
],
"devDependencies": {
"@ast-grep/cli": "0.37.0",
@@ -1415,9 +1414,9 @@
}
},
"node_modules/@github/catalyst": {
- "version": "1.8.0",
- "resolved": "https://registry.npmjs.org/@github/catalyst/-/catalyst-1.8.0.tgz",
- "integrity": "sha512-uLpi/D/mKfylYaFLfzNuloXNENi0AlcM0Z7hwYLH8Z030jBCr+ueMdX2xLxCzpMH/keYXKh0uPrHSMfcbxU6KA==",
+ "version": "1.8.1",
+ "resolved": "https://registry.npmjs.org/@github/catalyst/-/catalyst-1.8.1.tgz",
+ "integrity": "sha512-dnN4WWpbeuQvA17LvsGdlXEueJdBk9y+I+WO5pdNpoHNOXPsFcz3hJrq1iRmdsNgQOf4S8e83axtwIxvG62eWA==",
"dev": true,
"license": "MIT"
},
@@ -1555,7 +1554,7 @@
}
},
"node_modules/@microsoft/fast-bench": {
- "resolved": "packages/bench",
+ "resolved": "sites/benchmarks",
"link": true
},
"node_modules/@microsoft/fast-build": {
@@ -4595,9 +4594,9 @@
}
},
"node_modules/fsevents": {
- "version": "2.3.2",
- "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz",
- "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==",
+ "version": "2.3.3",
+ "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz",
+ "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==",
"hasInstallScript": true,
"license": "MIT",
"optional": true,
@@ -4678,9 +4677,9 @@
}
},
"node_modules/get-tsconfig": {
- "version": "4.13.7",
- "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.13.7.tgz",
- "integrity": "sha512-7tN6rFgBlMgpBML5j8typ92BKFi2sFQvIdpAqLA2beia5avZDrMs0FLZiM5etShWq5irVyGcGMEA1jcDaK7A/Q==",
+ "version": "4.14.0",
+ "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.14.0.tgz",
+ "integrity": "sha512-yTb+8DXzDREzgvYmh6s9vHsSVCHeC0G3PI5bEXNBHtmshPnO+S5O7qgLEOn0I5QvMy6kpZN8K1NKGyilLb93wA==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -4992,9 +4991,9 @@
}
},
"node_modules/hasown": {
- "version": "2.0.2",
- "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz",
- "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==",
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.3.tgz",
+ "integrity": "sha512-ej4AhfhfL2Q2zpMmLo7U1Uv9+PyhIZpgQLGT1F9miIGmiCJIoCgSmczFdrc97mWT4kVY72KA+WnnhJ5pghSvSg==",
"license": "MIT",
"dependencies": {
"function-bind": "^1.1.2"
@@ -5470,12 +5469,6 @@
"node": ">=0.12.0"
}
},
- "node_modules/is-promise": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/is-promise/-/is-promise-4.0.0.tgz",
- "integrity": "sha512-hvpoI6korhJMnej285dSg6nu1+e6uxs7zG3BYAm5byqDsgJNWwxzM6z6iZiAgQR4TJ30JmBTOwqZUw3WlyH3AQ==",
- "license": "MIT"
- },
"node_modules/is-ssh": {
"version": "1.4.1",
"resolved": "https://registry.npmjs.org/is-ssh/-/is-ssh-1.4.1.tgz",
@@ -5576,9 +5569,9 @@
"license": "MIT"
},
"node_modules/jsonfile": {
- "version": "6.2.0",
- "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz",
- "integrity": "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==",
+ "version": "6.2.1",
+ "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.1.tgz",
+ "integrity": "sha512-zwOTdL3rFQ/lRdBnntKVOX6k5cKJwEc1HdilT71BWEu7J41gXIB2MRp+vxduPSwZJPWBxEzv4yH1wYLJGUHX4Q==",
"license": "MIT",
"dependencies": {
"universalify": "^2.0.0"
@@ -5824,9 +5817,9 @@
}
},
"node_modules/liquidjs": {
- "version": "10.25.5",
- "resolved": "https://registry.npmjs.org/liquidjs/-/liquidjs-10.25.5.tgz",
- "integrity": "sha512-GKiKeZjJDdVoQAu+S9rzkYsYnYhcep5W3WwZXgb5f+yq484P/k9JqamBbGYu+LBEixcUAXZr2jogdAIjB3ki1w==",
+ "version": "10.25.6",
+ "resolved": "https://registry.npmjs.org/liquidjs/-/liquidjs-10.25.6.tgz",
+ "integrity": "sha512-h5ki5HS1PiL9/NmLw3iUcTF1jQswKJd8KLEXNrtSf8XHF0v3c5+d+8llz3N9I5IUdc5rsOuVLb9AVnqvqqscPg==",
"license": "MIT",
"dependencies": {
"commander": "^10.0.0"
@@ -6604,15 +6597,6 @@
"node": ">= 0.8"
}
},
- "node_modules/once": {
- "version": "1.4.0",
- "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
- "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==",
- "license": "ISC",
- "dependencies": {
- "wrappy": "1"
- }
- },
"node_modules/onetime": {
"version": "5.1.2",
"resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz",
@@ -6879,6 +6863,20 @@
"node": ">=18"
}
},
+ "node_modules/playwright/node_modules/fsevents": {
+ "version": "2.3.2",
+ "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz",
+ "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==",
+ "hasInstallScript": true,
+ "license": "MIT",
+ "optional": true,
+ "os": [
+ "darwin"
+ ],
+ "engines": {
+ "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
+ }
+ },
"node_modules/please-upgrade-node": {
"version": "3.2.0",
"resolved": "https://registry.npmjs.org/please-upgrade-node/-/please-upgrade-node-3.2.0.tgz",
@@ -6889,9 +6887,9 @@
}
},
"node_modules/postcss": {
- "version": "8.5.9",
- "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.9.tgz",
- "integrity": "sha512-7a70Nsot+EMX9fFU3064K/kdHWZqGVY+BADLyXc8Dfv+mTLLVl6JzJpPaCZ2kQL9gIJvKXSLMHhqdRRjwQeFtw==",
+ "version": "8.5.10",
+ "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.10.tgz",
+ "integrity": "sha512-pMMHxBOZKFU6HgAZ4eyGnwXF/EvPGGqUr0MnZ5+99485wwW41kW91A4LOGxSHhgugZmSChL5AlElNdwlNgcnLQ==",
"funding": [
{
"type": "opencollective",
@@ -7300,55 +7298,6 @@
"node": ">=16.0.0"
}
},
- "node_modules/router": {
- "version": "2.2.0",
- "resolved": "https://registry.npmjs.org/router/-/router-2.2.0.tgz",
- "integrity": "sha512-nLTrUKm2UyiL7rlhapu/Zl45FwNgkZGaCpZbIHajDYgwlJCOzLSk+cIPAnsEqV955GjILJnKbdQC1nVPz+gAYQ==",
- "license": "MIT",
- "dependencies": {
- "debug": "^4.4.0",
- "depd": "^2.0.0",
- "is-promise": "^4.0.0",
- "parseurl": "^1.3.3",
- "path-to-regexp": "^8.0.0"
- },
- "engines": {
- "node": ">= 18"
- }
- },
- "node_modules/router/node_modules/debug": {
- "version": "4.4.3",
- "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz",
- "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==",
- "license": "MIT",
- "dependencies": {
- "ms": "^2.1.3"
- },
- "engines": {
- "node": ">=6.0"
- },
- "peerDependenciesMeta": {
- "supports-color": {
- "optional": true
- }
- }
- },
- "node_modules/router/node_modules/ms": {
- "version": "2.1.3",
- "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
- "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
- "license": "MIT"
- },
- "node_modules/router/node_modules/path-to-regexp": {
- "version": "8.4.2",
- "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-8.4.2.tgz",
- "integrity": "sha512-qRcuIdP69NPm4qbACK+aDogI5CBDMi1jKe0ry5rSQJz8JVLsC7jV8XpiJjGRLLol3N+R5ihGYcrPLTno6pAdBA==",
- "license": "MIT",
- "funding": {
- "type": "opencollective",
- "url": "https://opencollective.com/express"
- }
- },
"node_modules/run-parallel": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
@@ -8349,20 +8298,6 @@
}
}
},
- "node_modules/vite/node_modules/fsevents": {
- "version": "2.3.3",
- "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz",
- "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==",
- "hasInstallScript": true,
- "license": "MIT",
- "optional": true,
- "os": [
- "darwin"
- ],
- "engines": {
- "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
- }
- },
"node_modules/which": {
"version": "2.0.2",
"resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
@@ -8548,12 +8483,6 @@
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
}
},
- "node_modules/wrappy": {
- "version": "1.0.2",
- "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
- "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==",
- "license": "ISC"
- },
"node_modules/ws": {
"version": "8.20.0",
"resolved": "https://registry.npmjs.org/ws/-/ws-8.20.0.tgz",
@@ -8682,14 +8611,6 @@
"url": "https://github.com/sponsors/sindresorhus"
}
},
- "packages/bench": {
- "name": "@microsoft/fast-bench",
- "version": "0.0.0",
- "dependencies": {
- "@microsoft/fast-element": "*",
- "@microsoft/fast-html": "*"
- }
- },
"packages/fast-build": {
"name": "@microsoft/fast-build",
"version": "0.4.0",
@@ -8784,8 +8705,6 @@
},
"packages/fast-test-harness/node_modules/accepts": {
"version": "2.0.0",
- "resolved": "https://registry.npmjs.org/accepts/-/accepts-2.0.0.tgz",
- "integrity": "sha512-5cvg6CtKwfgdmVqY1WIiXKc3Q1bkRqGLi+2W/6ao+6Y7gu/RCwRuAhGEzh5B4KlszSuTLgZYuqFqo5bImjNKng==",
"license": "MIT",
"dependencies": {
"mime-types": "^3.0.0",
@@ -8797,8 +8716,6 @@
},
"packages/fast-test-harness/node_modules/body-parser": {
"version": "2.2.2",
- "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-2.2.2.tgz",
- "integrity": "sha512-oP5VkATKlNwcgvxi0vM0p/D3n2C3EReYVX+DNYs5TjZFn/oQt2j+4sVJtSMr18pdRr8wjTcBl6LoV+FUwzPmNA==",
"license": "MIT",
"dependencies": {
"bytes": "^3.1.2",
@@ -8821,8 +8738,6 @@
},
"packages/fast-test-harness/node_modules/content-disposition": {
"version": "1.1.0",
- "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-1.1.0.tgz",
- "integrity": "sha512-5jRCH9Z/+DRP7rkvY83B+yGIGX96OYdJmzngqnw2SBSxqCFPd0w2km3s5iawpGX8krnwSGmF0FW5Nhr0Hfai3g==",
"license": "MIT",
"engines": {
"node": ">=18"
@@ -8834,8 +8749,6 @@
},
"packages/fast-test-harness/node_modules/cookie-signature": {
"version": "1.2.2",
- "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.2.2.tgz",
- "integrity": "sha512-D76uU73ulSXrD1UXF4KE2TMxVVwhsnCgfAyTg9k8P6KGZjlXKrOLe4dJQKI3Bxi5wjesZoFXJWElNWBjPZMbhg==",
"license": "MIT",
"engines": {
"node": ">=6.6.0"
@@ -8843,8 +8756,6 @@
},
"packages/fast-test-harness/node_modules/debug": {
"version": "4.4.3",
- "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz",
- "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==",
"license": "MIT",
"dependencies": {
"ms": "^2.1.3"
@@ -8860,8 +8771,6 @@
},
"packages/fast-test-harness/node_modules/express": {
"version": "5.2.1",
- "resolved": "https://registry.npmjs.org/express/-/express-5.2.1.tgz",
- "integrity": "sha512-hIS4idWWai69NezIdRt2xFVofaF4j+6INOpJlVOLDO8zXGpUVEVzIYk12UUi2JzjEzWL3IOAxcTubgz9Po0yXw==",
"license": "MIT",
"dependencies": {
"accepts": "^2.0.0",
@@ -8903,8 +8812,6 @@
},
"packages/fast-test-harness/node_modules/finalhandler": {
"version": "2.1.1",
- "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-2.1.1.tgz",
- "integrity": "sha512-S8KoZgRZN+a5rNwqTxlZZePjT/4cnm0ROV70LedRHZ0p8u9fRID0hJUZQpkKLzro8LfmC8sx23bY6tVNxv8pQA==",
"license": "MIT",
"dependencies": {
"debug": "^4.4.0",
@@ -8924,8 +8831,6 @@
},
"packages/fast-test-harness/node_modules/fresh": {
"version": "2.0.0",
- "resolved": "https://registry.npmjs.org/fresh/-/fresh-2.0.0.tgz",
- "integrity": "sha512-Rx/WycZ60HOaqLKAi6cHRKKI7zxWbJ31MhntmtwMoaTeF7XFH9hhBp8vITaMidfljRQ6eYWCKkaTK+ykVJHP2A==",
"license": "MIT",
"engines": {
"node": ">= 0.8"
@@ -8933,8 +8838,6 @@
},
"packages/fast-test-harness/node_modules/iconv-lite": {
"version": "0.7.2",
- "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.7.2.tgz",
- "integrity": "sha512-im9DjEDQ55s9fL4EYzOAv0yMqmMBSZp6G0VvFyTMPKWxiSBHUj9NW/qqLmXUwXrrM7AvqSlTCfvqRb0cM8yYqw==",
"license": "MIT",
"dependencies": {
"safer-buffer": ">= 2.1.2 < 3.0.0"
@@ -8949,8 +8852,6 @@
},
"packages/fast-test-harness/node_modules/media-typer": {
"version": "1.1.0",
- "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-1.1.0.tgz",
- "integrity": "sha512-aisnrDP4GNe06UcKFnV5bfMNPBUw4jsLGaWwWfnH3v02GnBuXX2MCVn5RbrWo0j3pczUilYblq7fQ7Nw2t5XKw==",
"license": "MIT",
"engines": {
"node": ">= 0.8"
@@ -8958,8 +8859,6 @@
},
"packages/fast-test-harness/node_modules/merge-descriptors": {
"version": "2.0.0",
- "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-2.0.0.tgz",
- "integrity": "sha512-Snk314V5ayFLhp3fkUREub6WtjBfPdCPY1Ln8/8munuLuiYhsABgBVWsozAG+MWMbVEvcdcpbi9R7ww22l9Q3g==",
"license": "MIT",
"engines": {
"node": ">=18"
@@ -8970,8 +8869,6 @@
},
"packages/fast-test-harness/node_modules/mime-db": {
"version": "1.54.0",
- "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz",
- "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==",
"license": "MIT",
"engines": {
"node": ">= 0.6"
@@ -8979,8 +8876,6 @@
},
"packages/fast-test-harness/node_modules/mime-types": {
"version": "3.0.2",
- "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-3.0.2.tgz",
- "integrity": "sha512-Lbgzdk0h4juoQ9fCKXW4by0UJqj+nOOrI9MJ1sSj4nI8aI2eo1qmvQEie4VD1glsS250n15LsWsYtCugiStS5A==",
"license": "MIT",
"dependencies": {
"mime-db": "^1.54.0"
@@ -8995,14 +8890,10 @@
},
"packages/fast-test-harness/node_modules/ms": {
"version": "2.1.3",
- "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
- "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
"license": "MIT"
},
"packages/fast-test-harness/node_modules/negotiator": {
"version": "1.0.0",
- "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-1.0.0.tgz",
- "integrity": "sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg==",
"license": "MIT",
"engines": {
"node": ">= 0.6"
@@ -9010,8 +8901,6 @@
},
"packages/fast-test-harness/node_modules/raw-body": {
"version": "3.0.2",
- "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-3.0.2.tgz",
- "integrity": "sha512-K5zQjDllxWkf7Z5xJdV0/B0WTNqx6vxG70zJE4N0kBs4LovmEYWJzQGxC9bS9RAKu3bgM40lrd5zoLJ12MQ5BA==",
"license": "MIT",
"dependencies": {
"bytes": "~3.1.2",
@@ -9025,8 +8914,6 @@
},
"packages/fast-test-harness/node_modules/send": {
"version": "1.2.1",
- "resolved": "https://registry.npmjs.org/send/-/send-1.2.1.tgz",
- "integrity": "sha512-1gnZf7DFcoIcajTjTwjwuDjzuz4PPcY2StKPlsGAQ1+YH20IRVrBaXSWmdjowTJ6u8Rc01PoYOGHXfP1mYcZNQ==",
"license": "MIT",
"dependencies": {
"debug": "^4.4.3",
@@ -9051,8 +8938,6 @@
},
"packages/fast-test-harness/node_modules/serve-static": {
"version": "2.2.1",
- "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-2.2.1.tgz",
- "integrity": "sha512-xRXBn0pPqQTVQiC8wyQrKs2MOlX24zQ0POGaj0kultvoOCstBQM5yvOhAVSUwOMjQtTvsPWoNCHfPGwaaQJhTw==",
"license": "MIT",
"dependencies": {
"encodeurl": "^2.0.0",
@@ -9070,8 +8955,6 @@
},
"packages/fast-test-harness/node_modules/type-is": {
"version": "2.0.1",
- "resolved": "https://registry.npmjs.org/type-is/-/type-is-2.0.1.tgz",
- "integrity": "sha512-OZs6gsjF4vMp32qrCbiVSkrFmXtG/AZhY3t0iAMrMBiAZyV9oALtXO8hsrHbMXF9x6L3grlFuwW2oAz7cav+Gw==",
"license": "MIT",
"dependencies": {
"content-type": "^1.0.5",
@@ -9082,6 +8965,14 @@
"node": ">= 0.6"
}
},
+ "sites/benchmarks": {
+ "name": "@microsoft/fast-bench",
+ "version": "0.0.0",
+ "dependencies": {
+ "@microsoft/fast-element": "*",
+ "@microsoft/fast-html": "*"
+ }
+ },
"sites/website": {
"name": "@microsoft/fast-site",
"version": "0.6.2",
@@ -9114,8 +9005,6 @@
},
"sites/website/node_modules/@microsoft/api-extractor-model": {
"version": "7.33.4",
- "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.33.4.tgz",
- "integrity": "sha512-u1LTaNTikZAQ9uK6KG1Ms7nvNedsnODnspq/gH2dcyETWvH4hVNGNDvRAEutH66kAmxA4/necElqGNs1FggC8w==",
"license": "MIT",
"dependencies": {
"@microsoft/tsdoc": "~0.16.0",
@@ -9125,8 +9014,6 @@
},
"sites/website/node_modules/@rushstack/node-core-library": {
"version": "5.20.3",
- "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-5.20.3.tgz",
- "integrity": "sha512-95JgEPq2k7tHxhF9/OJnnyHDXfC9cLhhta0An/6MlkDsX2A6dTzDrTUG18vx4vjc280V0fi0xDH9iQczpSuWsw==",
"license": "MIT",
"dependencies": {
"ajv": "~8.18.0",
@@ -9149,8 +9036,6 @@
},
"sites/website/node_modules/@rushstack/terminal": {
"version": "0.22.3",
- "resolved": "https://registry.npmjs.org/@rushstack/terminal/-/terminal-0.22.3.tgz",
- "integrity": "sha512-gHC9pIMrUPzAbBiI4VZMU7Q+rsCzb8hJl36lFIulIzoceKotyKL3Rd76AZ2CryCTKEg+0bnTj406HE5YY5OQvw==",
"license": "MIT",
"dependencies": {
"@rushstack/node-core-library": "5.20.3",
@@ -9168,8 +9053,6 @@
},
"sites/website/node_modules/@rushstack/ts-command-line": {
"version": "5.3.3",
- "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-5.3.3.tgz",
- "integrity": "sha512-c+ltdcvC7ym+10lhwR/vWiOhsrm/bP3By2VsFcs5qTKv+6tTmxgbVrtJ5NdNjANiV5TcmOZgUN+5KYQ4llsvEw==",
"license": "MIT",
"dependencies": {
"@rushstack/terminal": "0.22.3",
diff --git a/package.json b/package.json
index 80308cfcaee..c8c7e0bd438 100644
--- a/package.json
+++ b/package.json
@@ -11,9 +11,8 @@
"workspaces": [
"build",
"packages/*",
- "sites/website",
- "examples/todo-app",
- "examples/ssr"
+ "sites/*",
+ "examples/*"
],
"engines": {
"npm": ">=10.0.0",
diff --git a/packages/bench/.gitignore b/sites/benchmarks/.gitignore
similarity index 100%
rename from packages/bench/.gitignore
rename to sites/benchmarks/.gitignore
diff --git a/packages/bench/README.md b/sites/benchmarks/README.md
similarity index 98%
rename from packages/bench/README.md
rename to sites/benchmarks/README.md
index 251a11ffc58..d6c1be5111b 100644
--- a/packages/bench/README.md
+++ b/sites/benchmarks/README.md
@@ -14,7 +14,7 @@ npm install
## Running benchmarks
-From this folder (`packages/bench`):
+From this folder (`sites/benchmarks`):
```bash
npm run bench
diff --git a/packages/bench/package.json b/sites/benchmarks/package.json
similarity index 100%
rename from packages/bench/package.json
rename to sites/benchmarks/package.json
diff --git a/packages/bench/server/package.json b/sites/benchmarks/server/package.json
similarity index 100%
rename from packages/bench/server/package.json
rename to sites/benchmarks/server/package.json
diff --git a/packages/bench/server/server.mjs b/sites/benchmarks/server/server.mjs
similarity index 100%
rename from packages/bench/server/server.mjs
rename to sites/benchmarks/server/server.mjs
diff --git a/packages/bench/src/bench.ts b/sites/benchmarks/src/bench.ts
similarity index 100%
rename from packages/bench/src/bench.ts
rename to sites/benchmarks/src/bench.ts
diff --git a/packages/bench/src/chart.ts b/sites/benchmarks/src/chart.ts
similarity index 100%
rename from packages/bench/src/chart.ts
rename to sites/benchmarks/src/chart.ts
diff --git a/packages/bench/src/report.ts b/sites/benchmarks/src/report.ts
similarity index 100%
rename from packages/bench/src/report.ts
rename to sites/benchmarks/src/report.ts
diff --git a/packages/bench/src/scenarios/all/csr/index.html b/sites/benchmarks/src/scenarios/all/csr/index.html
similarity index 100%
rename from packages/bench/src/scenarios/all/csr/index.html
rename to sites/benchmarks/src/scenarios/all/csr/index.html
diff --git a/packages/bench/src/scenarios/all/csr/main.ts b/sites/benchmarks/src/scenarios/all/csr/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/all/csr/main.ts
rename to sites/benchmarks/src/scenarios/all/csr/main.ts
diff --git a/packages/bench/src/scenarios/all/element.ts b/sites/benchmarks/src/scenarios/all/element.ts
similarity index 100%
rename from packages/bench/src/scenarios/all/element.ts
rename to sites/benchmarks/src/scenarios/all/element.ts
diff --git a/packages/bench/src/scenarios/all/hydration/index.html b/sites/benchmarks/src/scenarios/all/hydration/index.html
similarity index 100%
rename from packages/bench/src/scenarios/all/hydration/index.html
rename to sites/benchmarks/src/scenarios/all/hydration/index.html
diff --git a/packages/bench/src/scenarios/all/hydration/main.ts b/sites/benchmarks/src/scenarios/all/hydration/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/all/hydration/main.ts
rename to sites/benchmarks/src/scenarios/all/hydration/main.ts
diff --git a/packages/bench/src/scenarios/attr-reflect/csr/index.html b/sites/benchmarks/src/scenarios/attr-reflect/csr/index.html
similarity index 100%
rename from packages/bench/src/scenarios/attr-reflect/csr/index.html
rename to sites/benchmarks/src/scenarios/attr-reflect/csr/index.html
diff --git a/packages/bench/src/scenarios/attr-reflect/csr/main.ts b/sites/benchmarks/src/scenarios/attr-reflect/csr/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/attr-reflect/csr/main.ts
rename to sites/benchmarks/src/scenarios/attr-reflect/csr/main.ts
diff --git a/packages/bench/src/scenarios/attr-reflect/element.ts b/sites/benchmarks/src/scenarios/attr-reflect/element.ts
similarity index 100%
rename from packages/bench/src/scenarios/attr-reflect/element.ts
rename to sites/benchmarks/src/scenarios/attr-reflect/element.ts
diff --git a/packages/bench/src/scenarios/attr-reflect/hydration/index.html b/sites/benchmarks/src/scenarios/attr-reflect/hydration/index.html
similarity index 100%
rename from packages/bench/src/scenarios/attr-reflect/hydration/index.html
rename to sites/benchmarks/src/scenarios/attr-reflect/hydration/index.html
diff --git a/packages/bench/src/scenarios/attr-reflect/hydration/main.ts b/sites/benchmarks/src/scenarios/attr-reflect/hydration/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/attr-reflect/hydration/main.ts
rename to sites/benchmarks/src/scenarios/attr-reflect/hydration/main.ts
diff --git a/packages/bench/src/scenarios/attr-reflect/hydration/render.ts b/sites/benchmarks/src/scenarios/attr-reflect/hydration/render.ts
similarity index 100%
rename from packages/bench/src/scenarios/attr-reflect/hydration/render.ts
rename to sites/benchmarks/src/scenarios/attr-reflect/hydration/render.ts
diff --git a/packages/bench/src/scenarios/attr-reflect/template.html b/sites/benchmarks/src/scenarios/attr-reflect/template.html
similarity index 100%
rename from packages/bench/src/scenarios/attr-reflect/template.html
rename to sites/benchmarks/src/scenarios/attr-reflect/template.html
diff --git a/packages/bench/src/scenarios/basic/csr/index.html b/sites/benchmarks/src/scenarios/basic/csr/index.html
similarity index 100%
rename from packages/bench/src/scenarios/basic/csr/index.html
rename to sites/benchmarks/src/scenarios/basic/csr/index.html
diff --git a/packages/bench/src/scenarios/basic/csr/main.ts b/sites/benchmarks/src/scenarios/basic/csr/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/basic/csr/main.ts
rename to sites/benchmarks/src/scenarios/basic/csr/main.ts
diff --git a/packages/bench/src/scenarios/basic/element.ts b/sites/benchmarks/src/scenarios/basic/element.ts
similarity index 100%
rename from packages/bench/src/scenarios/basic/element.ts
rename to sites/benchmarks/src/scenarios/basic/element.ts
diff --git a/packages/bench/src/scenarios/basic/hydration/index.html b/sites/benchmarks/src/scenarios/basic/hydration/index.html
similarity index 100%
rename from packages/bench/src/scenarios/basic/hydration/index.html
rename to sites/benchmarks/src/scenarios/basic/hydration/index.html
diff --git a/packages/bench/src/scenarios/basic/hydration/main.ts b/sites/benchmarks/src/scenarios/basic/hydration/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/basic/hydration/main.ts
rename to sites/benchmarks/src/scenarios/basic/hydration/main.ts
diff --git a/packages/bench/src/scenarios/basic/hydration/render.ts b/sites/benchmarks/src/scenarios/basic/hydration/render.ts
similarity index 100%
rename from packages/bench/src/scenarios/basic/hydration/render.ts
rename to sites/benchmarks/src/scenarios/basic/hydration/render.ts
diff --git a/packages/bench/src/scenarios/basic/template.html b/sites/benchmarks/src/scenarios/basic/template.html
similarity index 100%
rename from packages/bench/src/scenarios/basic/template.html
rename to sites/benchmarks/src/scenarios/basic/template.html
diff --git a/packages/bench/src/scenarios/bind-event/csr/index.html b/sites/benchmarks/src/scenarios/bind-event/csr/index.html
similarity index 100%
rename from packages/bench/src/scenarios/bind-event/csr/index.html
rename to sites/benchmarks/src/scenarios/bind-event/csr/index.html
diff --git a/packages/bench/src/scenarios/bind-event/csr/main.ts b/sites/benchmarks/src/scenarios/bind-event/csr/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/bind-event/csr/main.ts
rename to sites/benchmarks/src/scenarios/bind-event/csr/main.ts
diff --git a/packages/bench/src/scenarios/bind-event/element.ts b/sites/benchmarks/src/scenarios/bind-event/element.ts
similarity index 100%
rename from packages/bench/src/scenarios/bind-event/element.ts
rename to sites/benchmarks/src/scenarios/bind-event/element.ts
diff --git a/packages/bench/src/scenarios/bind-event/hydration/index.html b/sites/benchmarks/src/scenarios/bind-event/hydration/index.html
similarity index 100%
rename from packages/bench/src/scenarios/bind-event/hydration/index.html
rename to sites/benchmarks/src/scenarios/bind-event/hydration/index.html
diff --git a/packages/bench/src/scenarios/bind-event/hydration/main.ts b/sites/benchmarks/src/scenarios/bind-event/hydration/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/bind-event/hydration/main.ts
rename to sites/benchmarks/src/scenarios/bind-event/hydration/main.ts
diff --git a/packages/bench/src/scenarios/bind-event/hydration/render.ts b/sites/benchmarks/src/scenarios/bind-event/hydration/render.ts
similarity index 100%
rename from packages/bench/src/scenarios/bind-event/hydration/render.ts
rename to sites/benchmarks/src/scenarios/bind-event/hydration/render.ts
diff --git a/packages/bench/src/scenarios/bind-event/template.html b/sites/benchmarks/src/scenarios/bind-event/template.html
similarity index 100%
rename from packages/bench/src/scenarios/bind-event/template.html
rename to sites/benchmarks/src/scenarios/bind-event/template.html
diff --git a/packages/bench/src/scenarios/dot-syntax/csr/index.html b/sites/benchmarks/src/scenarios/dot-syntax/csr/index.html
similarity index 100%
rename from packages/bench/src/scenarios/dot-syntax/csr/index.html
rename to sites/benchmarks/src/scenarios/dot-syntax/csr/index.html
diff --git a/packages/bench/src/scenarios/dot-syntax/csr/main.ts b/sites/benchmarks/src/scenarios/dot-syntax/csr/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/dot-syntax/csr/main.ts
rename to sites/benchmarks/src/scenarios/dot-syntax/csr/main.ts
diff --git a/packages/bench/src/scenarios/dot-syntax/element.ts b/sites/benchmarks/src/scenarios/dot-syntax/element.ts
similarity index 100%
rename from packages/bench/src/scenarios/dot-syntax/element.ts
rename to sites/benchmarks/src/scenarios/dot-syntax/element.ts
diff --git a/packages/bench/src/scenarios/dot-syntax/hydration/index.html b/sites/benchmarks/src/scenarios/dot-syntax/hydration/index.html
similarity index 100%
rename from packages/bench/src/scenarios/dot-syntax/hydration/index.html
rename to sites/benchmarks/src/scenarios/dot-syntax/hydration/index.html
diff --git a/packages/bench/src/scenarios/dot-syntax/hydration/main.ts b/sites/benchmarks/src/scenarios/dot-syntax/hydration/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/dot-syntax/hydration/main.ts
rename to sites/benchmarks/src/scenarios/dot-syntax/hydration/main.ts
diff --git a/packages/bench/src/scenarios/dot-syntax/hydration/render.ts b/sites/benchmarks/src/scenarios/dot-syntax/hydration/render.ts
similarity index 100%
rename from packages/bench/src/scenarios/dot-syntax/hydration/render.ts
rename to sites/benchmarks/src/scenarios/dot-syntax/hydration/render.ts
diff --git a/packages/bench/src/scenarios/dot-syntax/template.html b/sites/benchmarks/src/scenarios/dot-syntax/template.html
similarity index 100%
rename from packages/bench/src/scenarios/dot-syntax/template.html
rename to sites/benchmarks/src/scenarios/dot-syntax/template.html
diff --git a/packages/bench/src/scenarios/harness.ts b/sites/benchmarks/src/scenarios/harness.ts
similarity index 100%
rename from packages/bench/src/scenarios/harness.ts
rename to sites/benchmarks/src/scenarios/harness.ts
diff --git a/packages/bench/src/scenarios/index.html b/sites/benchmarks/src/scenarios/index.html
similarity index 100%
rename from packages/bench/src/scenarios/index.html
rename to sites/benchmarks/src/scenarios/index.html
diff --git a/packages/bench/src/scenarios/ref-slotted/csr/index.html b/sites/benchmarks/src/scenarios/ref-slotted/csr/index.html
similarity index 100%
rename from packages/bench/src/scenarios/ref-slotted/csr/index.html
rename to sites/benchmarks/src/scenarios/ref-slotted/csr/index.html
diff --git a/packages/bench/src/scenarios/ref-slotted/csr/main.ts b/sites/benchmarks/src/scenarios/ref-slotted/csr/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/ref-slotted/csr/main.ts
rename to sites/benchmarks/src/scenarios/ref-slotted/csr/main.ts
diff --git a/packages/bench/src/scenarios/ref-slotted/element.ts b/sites/benchmarks/src/scenarios/ref-slotted/element.ts
similarity index 100%
rename from packages/bench/src/scenarios/ref-slotted/element.ts
rename to sites/benchmarks/src/scenarios/ref-slotted/element.ts
diff --git a/packages/bench/src/scenarios/ref-slotted/hydration/index.html b/sites/benchmarks/src/scenarios/ref-slotted/hydration/index.html
similarity index 100%
rename from packages/bench/src/scenarios/ref-slotted/hydration/index.html
rename to sites/benchmarks/src/scenarios/ref-slotted/hydration/index.html
diff --git a/packages/bench/src/scenarios/ref-slotted/hydration/main.ts b/sites/benchmarks/src/scenarios/ref-slotted/hydration/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/ref-slotted/hydration/main.ts
rename to sites/benchmarks/src/scenarios/ref-slotted/hydration/main.ts
diff --git a/packages/bench/src/scenarios/ref-slotted/hydration/render.ts b/sites/benchmarks/src/scenarios/ref-slotted/hydration/render.ts
similarity index 100%
rename from packages/bench/src/scenarios/ref-slotted/hydration/render.ts
rename to sites/benchmarks/src/scenarios/ref-slotted/hydration/render.ts
diff --git a/packages/bench/src/scenarios/ref-slotted/template.html b/sites/benchmarks/src/scenarios/ref-slotted/template.html
similarity index 100%
rename from packages/bench/src/scenarios/ref-slotted/template.html
rename to sites/benchmarks/src/scenarios/ref-slotted/template.html
diff --git a/packages/bench/src/scenarios/repeat/csr/index.html b/sites/benchmarks/src/scenarios/repeat/csr/index.html
similarity index 100%
rename from packages/bench/src/scenarios/repeat/csr/index.html
rename to sites/benchmarks/src/scenarios/repeat/csr/index.html
diff --git a/packages/bench/src/scenarios/repeat/csr/main.ts b/sites/benchmarks/src/scenarios/repeat/csr/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/repeat/csr/main.ts
rename to sites/benchmarks/src/scenarios/repeat/csr/main.ts
diff --git a/packages/bench/src/scenarios/repeat/element.ts b/sites/benchmarks/src/scenarios/repeat/element.ts
similarity index 100%
rename from packages/bench/src/scenarios/repeat/element.ts
rename to sites/benchmarks/src/scenarios/repeat/element.ts
diff --git a/packages/bench/src/scenarios/repeat/hydration/index.html b/sites/benchmarks/src/scenarios/repeat/hydration/index.html
similarity index 100%
rename from packages/bench/src/scenarios/repeat/hydration/index.html
rename to sites/benchmarks/src/scenarios/repeat/hydration/index.html
diff --git a/packages/bench/src/scenarios/repeat/hydration/main.ts b/sites/benchmarks/src/scenarios/repeat/hydration/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/repeat/hydration/main.ts
rename to sites/benchmarks/src/scenarios/repeat/hydration/main.ts
diff --git a/packages/bench/src/scenarios/repeat/hydration/render.ts b/sites/benchmarks/src/scenarios/repeat/hydration/render.ts
similarity index 100%
rename from packages/bench/src/scenarios/repeat/hydration/render.ts
rename to sites/benchmarks/src/scenarios/repeat/hydration/render.ts
diff --git a/packages/bench/src/scenarios/repeat/template.html b/sites/benchmarks/src/scenarios/repeat/template.html
similarity index 100%
rename from packages/bench/src/scenarios/repeat/template.html
rename to sites/benchmarks/src/scenarios/repeat/template.html
diff --git a/packages/bench/src/scenarios/report.css b/sites/benchmarks/src/scenarios/report.css
similarity index 100%
rename from packages/bench/src/scenarios/report.css
rename to sites/benchmarks/src/scenarios/report.css
diff --git a/packages/bench/src/scenarios/report.js b/sites/benchmarks/src/scenarios/report.js
similarity index 100%
rename from packages/bench/src/scenarios/report.js
rename to sites/benchmarks/src/scenarios/report.js
diff --git a/packages/bench/src/scenarios/tree.ts b/sites/benchmarks/src/scenarios/tree.ts
similarity index 100%
rename from packages/bench/src/scenarios/tree.ts
rename to sites/benchmarks/src/scenarios/tree.ts
diff --git a/packages/bench/src/scenarios/when/csr/index.html b/sites/benchmarks/src/scenarios/when/csr/index.html
similarity index 100%
rename from packages/bench/src/scenarios/when/csr/index.html
rename to sites/benchmarks/src/scenarios/when/csr/index.html
diff --git a/packages/bench/src/scenarios/when/csr/main.ts b/sites/benchmarks/src/scenarios/when/csr/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/when/csr/main.ts
rename to sites/benchmarks/src/scenarios/when/csr/main.ts
diff --git a/packages/bench/src/scenarios/when/element.ts b/sites/benchmarks/src/scenarios/when/element.ts
similarity index 100%
rename from packages/bench/src/scenarios/when/element.ts
rename to sites/benchmarks/src/scenarios/when/element.ts
diff --git a/packages/bench/src/scenarios/when/hydration/index.html b/sites/benchmarks/src/scenarios/when/hydration/index.html
similarity index 100%
rename from packages/bench/src/scenarios/when/hydration/index.html
rename to sites/benchmarks/src/scenarios/when/hydration/index.html
diff --git a/packages/bench/src/scenarios/when/hydration/main.ts b/sites/benchmarks/src/scenarios/when/hydration/main.ts
similarity index 100%
rename from packages/bench/src/scenarios/when/hydration/main.ts
rename to sites/benchmarks/src/scenarios/when/hydration/main.ts
diff --git a/packages/bench/src/scenarios/when/hydration/render.ts b/sites/benchmarks/src/scenarios/when/hydration/render.ts
similarity index 100%
rename from packages/bench/src/scenarios/when/hydration/render.ts
rename to sites/benchmarks/src/scenarios/when/hydration/render.ts
diff --git a/packages/bench/src/scenarios/when/template.html b/sites/benchmarks/src/scenarios/when/template.html
similarity index 100%
rename from packages/bench/src/scenarios/when/template.html
rename to sites/benchmarks/src/scenarios/when/template.html
diff --git a/packages/bench/src/trace.ts b/sites/benchmarks/src/trace.ts
similarity index 100%
rename from packages/bench/src/trace.ts
rename to sites/benchmarks/src/trace.ts
diff --git a/packages/bench/tsconfig.json b/sites/benchmarks/tsconfig.json
similarity index 100%
rename from packages/bench/tsconfig.json
rename to sites/benchmarks/tsconfig.json
diff --git a/packages/bench/vite.config.ts b/sites/benchmarks/vite.config.ts
similarity index 100%
rename from packages/bench/vite.config.ts
rename to sites/benchmarks/vite.config.ts
From 0835f29e43a77390669025a1be051c3f025498ec Mon Sep 17 00:00:00 2001
From: Microsoft FAST Builds
Date: Tue, 21 Apr 2026 00:05:17 +0000
Subject: [PATCH 04/11] applying package updates
---
...html-ee5e1a5d-0ff4-46fe-96c9-ed982e93e391.json | 7 -------
packages/fast-html/CHANGELOG.json | 15 +++++++++++++++
2 files changed, 15 insertions(+), 7 deletions(-)
delete mode 100644 change/@microsoft-fast-html-ee5e1a5d-0ff4-46fe-96c9-ed982e93e391.json
diff --git a/change/@microsoft-fast-html-ee5e1a5d-0ff4-46fe-96c9-ed982e93e391.json b/change/@microsoft-fast-html-ee5e1a5d-0ff4-46fe-96c9-ed982e93e391.json
deleted file mode 100644
index 293e17774d4..00000000000
--- a/change/@microsoft-fast-html-ee5e1a5d-0ff4-46fe-96c9-ed982e93e391.json
+++ /dev/null
@@ -1,7 +0,0 @@
-{
- "type": "none",
- "comment": "chore: update webui to 0.0.10",
- "packageName": "@microsoft/fast-html",
- "email": "7559015+janechu@users.noreply.github.com",
- "dependentChangeType": "none"
-}
diff --git a/packages/fast-html/CHANGELOG.json b/packages/fast-html/CHANGELOG.json
index b6ff6bcac02..d692f446219 100644
--- a/packages/fast-html/CHANGELOG.json
+++ b/packages/fast-html/CHANGELOG.json
@@ -1,6 +1,21 @@
{
"name": "@microsoft/fast-html",
"entries": [
+ {
+ "date": "Tue, 21 Apr 2026 00:05:17 GMT",
+ "version": "1.0.0-alpha.49",
+ "tag": "@microsoft/fast-html_v1.0.0-alpha.49",
+ "comments": {
+ "none": [
+ {
+ "author": "7559015+janechu@users.noreply.github.com",
+ "package": "@microsoft/fast-html",
+ "commit": "713e4f5274ce8561268e8348da21968be0350a99",
+ "comment": "chore: update webui to 0.0.10"
+ }
+ ]
+ }
+ },
{
"date": "Sat, 18 Apr 2026 00:05:00 GMT",
"version": "1.0.0-alpha.49",
From f28432a100e1ee2e2bcd0c6dcd6e61953f777854 Mon Sep 17 00:00:00 2001
From: Jane Chu <7559015+janechu@users.noreply.github.com>
Date: Mon, 20 Apr 2026 20:44:47 -0700
Subject: [PATCH 05/11] chore: remove @microsoft/fast-ssr (#7461)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
# Pull Request
## 📖 Description
As the `@microsoft/fast-element` package moves towards a declarative templating solution, the `@microsoft/fast-ssr` is being removed. We have posted and published a deprecation notice with a project that will fill this gap.
## 👩💻 Reviewer Notes
This is a simple removal.
## ✅ Checklist
### General
- [x] I have included a change request file using `$ npm run change`
- [ ] I have added tests for my changes.
- [x] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/main/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/main/CODE_OF_CONDUCT.md#our-standards) for this project.
---
.github/copilot-instructions.md | 2 -
...-30f1b1bf-454c-4952-a54c-7a0a5131b741.json | 7 +
examples/ssr/CHANGELOG.json | 20 -
examples/ssr/CHANGELOG.md | 13 -
examples/ssr/README.md | 7 -
examples/ssr/package.json | 30 -
examples/ssr/server.js | 63 -
examples/ssr/src/main.ts | 6 -
examples/ssr/todo-data.json | 14 -
examples/ssr/tsconfig.json | 22 -
examples/ssr/vite.config.ts | 15 -
package-lock.json | 48 -
packages/README.md | 7 -
packages/fast-html/RENDERING.md | 2 +-
packages/fast-ssr/.npmignore | 11 -
packages/fast-ssr/ACKNOWLEDGEMENTS.md | 41 -
packages/fast-ssr/CHANGELOG.json | 1476 -----------------
packages/fast-ssr/CHANGELOG.md | 381 -----
packages/fast-ssr/README.md | 374 -----
packages/fast-ssr/api-extractor.json | 10 -
packages/fast-ssr/biome.json | 4 -
packages/fast-ssr/docs/api-report.api.md | 196 ---
packages/fast-ssr/package.json | 75 -
packages/fast-ssr/playwright.config.ts | 18 -
packages/fast-ssr/scripts/run-tests.mjs | 8 -
packages/fast-ssr/server/README.md | 2 -
packages/fast-ssr/server/placeholder.png | Bin 1617 -> 0 bytes
packages/fast-ssr/server/server.ts | 89 -
packages/fast-ssr/server/tsconfig.json | 9 -
.../fast-ssr/src/configure-fast-element.ts | 34 -
.../src/declarative-shadow-dom-polyfill.ts | 38 -
packages/fast-ssr/src/dom-shim.spec.ts | 184 --
packages/fast-ssr/src/dom-shim.ts | 443 -----
packages/fast-ssr/src/element-controller.ts | 14 -
.../element-renderer/element-renderer.spec.ts | 551 ------
.../src/element-renderer/element-renderer.ts | 163 --
.../element-renderer/fast-element-renderer.ts | 336 ----
.../src/element-renderer/interfaces.ts | 70 -
packages/fast-ssr/src/escape-html.ts | 21 -
packages/fast-ssr/src/event-utilities.ts | 3 -
packages/fast-ssr/src/exports.spec.ts | 87 -
packages/fast-ssr/src/exports.ts | 207 ---
.../fast-command-buffer/index.fixture.html | 301 ----
.../fast-ssr/src/fast-command-buffer/index.ts | 149 --
packages/fast-ssr/src/install-dom-shim.ts | 3 -
packages/fast-ssr/src/render-info.spec.ts | 65 -
packages/fast-ssr/src/render-info.ts | 61 -
packages/fast-ssr/src/request-storage.spec.ts | 237 ---
packages/fast-ssr/src/request-storage.ts | 300 ----
.../fast-ssr/src/styles/fast-style-config.ts | 1 -
.../src/styles/fast-style.fixture.html | 416 -----
.../fast-ssr/src/styles/fast-style.pw.spec.ts | 78 -
packages/fast-ssr/src/styles/fast-style.ts | 81 -
.../src/styles/style-renderer.spec.ts | 74 -
.../fast-ssr/src/styles/style-renderer.ts | 73 -
.../fast-ssr/src/styles/style-strategy.ts | 35 -
.../src/template-cache/controller.spec.ts | 44 -
.../fast-ssr/src/template-cache/controller.ts | 53 -
.../src/template-parser/id-generator.ts | 55 -
.../fast-ssr/src/template-parser/op-codes.ts | 147 --
.../template-parser/template-parser.spec.ts | 216 ---
.../src/template-parser/template-parser.ts | 438 -----
.../src/template-renderer/directives.spec.ts | 41 -
.../src/template-renderer/directives.ts | 204 ---
.../hydration-marker-emitter.ts | 15 -
.../template-renderer.spec.ts | 887 ----------
.../template-renderer/template-renderer.ts | 379 -----
.../src/test-utilities/consolidate.ts | 22 -
.../fast-ssr/src/test-utilities/validators.ts | 32 -
packages/fast-ssr/src/tsconfig.json | 13 -
packages/fast-ssr/src/view.ts | 62 -
packages/fast-ssr/tsconfig.json | 18 -
72 files changed, 8 insertions(+), 9593 deletions(-)
create mode 100644 change/@microsoft-fast-html-30f1b1bf-454c-4952-a54c-7a0a5131b741.json
delete mode 100644 examples/ssr/CHANGELOG.json
delete mode 100644 examples/ssr/CHANGELOG.md
delete mode 100644 examples/ssr/README.md
delete mode 100644 examples/ssr/package.json
delete mode 100644 examples/ssr/server.js
delete mode 100644 examples/ssr/src/main.ts
delete mode 100644 examples/ssr/todo-data.json
delete mode 100644 examples/ssr/tsconfig.json
delete mode 100644 examples/ssr/vite.config.ts
delete mode 100644 packages/fast-ssr/.npmignore
delete mode 100644 packages/fast-ssr/ACKNOWLEDGEMENTS.md
delete mode 100644 packages/fast-ssr/CHANGELOG.json
delete mode 100644 packages/fast-ssr/CHANGELOG.md
delete mode 100644 packages/fast-ssr/README.md
delete mode 100644 packages/fast-ssr/api-extractor.json
delete mode 100644 packages/fast-ssr/biome.json
delete mode 100644 packages/fast-ssr/docs/api-report.api.md
delete mode 100644 packages/fast-ssr/package.json
delete mode 100644 packages/fast-ssr/playwright.config.ts
delete mode 100644 packages/fast-ssr/scripts/run-tests.mjs
delete mode 100644 packages/fast-ssr/server/README.md
delete mode 100644 packages/fast-ssr/server/placeholder.png
delete mode 100644 packages/fast-ssr/server/server.ts
delete mode 100644 packages/fast-ssr/server/tsconfig.json
delete mode 100644 packages/fast-ssr/src/configure-fast-element.ts
delete mode 100644 packages/fast-ssr/src/declarative-shadow-dom-polyfill.ts
delete mode 100644 packages/fast-ssr/src/dom-shim.spec.ts
delete mode 100644 packages/fast-ssr/src/dom-shim.ts
delete mode 100644 packages/fast-ssr/src/element-controller.ts
delete mode 100644 packages/fast-ssr/src/element-renderer/element-renderer.spec.ts
delete mode 100644 packages/fast-ssr/src/element-renderer/element-renderer.ts
delete mode 100644 packages/fast-ssr/src/element-renderer/fast-element-renderer.ts
delete mode 100644 packages/fast-ssr/src/element-renderer/interfaces.ts
delete mode 100644 packages/fast-ssr/src/escape-html.ts
delete mode 100644 packages/fast-ssr/src/event-utilities.ts
delete mode 100644 packages/fast-ssr/src/exports.spec.ts
delete mode 100644 packages/fast-ssr/src/exports.ts
delete mode 100644 packages/fast-ssr/src/fast-command-buffer/index.fixture.html
delete mode 100644 packages/fast-ssr/src/fast-command-buffer/index.ts
delete mode 100644 packages/fast-ssr/src/install-dom-shim.ts
delete mode 100644 packages/fast-ssr/src/render-info.spec.ts
delete mode 100644 packages/fast-ssr/src/render-info.ts
delete mode 100644 packages/fast-ssr/src/request-storage.spec.ts
delete mode 100644 packages/fast-ssr/src/request-storage.ts
delete mode 100644 packages/fast-ssr/src/styles/fast-style-config.ts
delete mode 100644 packages/fast-ssr/src/styles/fast-style.fixture.html
delete mode 100644 packages/fast-ssr/src/styles/fast-style.pw.spec.ts
delete mode 100644 packages/fast-ssr/src/styles/fast-style.ts
delete mode 100644 packages/fast-ssr/src/styles/style-renderer.spec.ts
delete mode 100644 packages/fast-ssr/src/styles/style-renderer.ts
delete mode 100644 packages/fast-ssr/src/styles/style-strategy.ts
delete mode 100644 packages/fast-ssr/src/template-cache/controller.spec.ts
delete mode 100644 packages/fast-ssr/src/template-cache/controller.ts
delete mode 100644 packages/fast-ssr/src/template-parser/id-generator.ts
delete mode 100644 packages/fast-ssr/src/template-parser/op-codes.ts
delete mode 100644 packages/fast-ssr/src/template-parser/template-parser.spec.ts
delete mode 100644 packages/fast-ssr/src/template-parser/template-parser.ts
delete mode 100644 packages/fast-ssr/src/template-renderer/directives.spec.ts
delete mode 100644 packages/fast-ssr/src/template-renderer/directives.ts
delete mode 100644 packages/fast-ssr/src/template-renderer/hydration-marker-emitter.ts
delete mode 100644 packages/fast-ssr/src/template-renderer/template-renderer.spec.ts
delete mode 100644 packages/fast-ssr/src/template-renderer/template-renderer.ts
delete mode 100644 packages/fast-ssr/src/test-utilities/consolidate.ts
delete mode 100644 packages/fast-ssr/src/test-utilities/validators.ts
delete mode 100644 packages/fast-ssr/src/tsconfig.json
delete mode 100644 packages/fast-ssr/src/view.ts
delete mode 100644 packages/fast-ssr/tsconfig.json
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
index dd1f5e1b04a..8c826e19b20 100644
--- a/.github/copilot-instructions.md
+++ b/.github/copilot-instructions.md
@@ -29,12 +29,10 @@ FAST (`@microsoft/fast`) is a Microsoft open-source monorepo for building W3C-st
|---|---|---|
| `sites/website` | Private (not published as a package) | Documentation website source |
| `sites/benchmarks` | Private (not published as a package) | Benchmarking utilities |
-| `@microsoft/fast-ssr` | Alpha (not actively maintained) | Server-side rendering utilities |
### Example projects
- `examples/todo-app/` — A simple To-Do app demonstrating FAST usage patterns.
-- `examples/ssr/` — Server-side rendering example using `@microsoft/fast-ssr`.
## Skills
diff --git a/change/@microsoft-fast-html-30f1b1bf-454c-4952-a54c-7a0a5131b741.json b/change/@microsoft-fast-html-30f1b1bf-454c-4952-a54c-7a0a5131b741.json
new file mode 100644
index 00000000000..6861e2da194
--- /dev/null
+++ b/change/@microsoft-fast-html-30f1b1bf-454c-4952-a54c-7a0a5131b741.json
@@ -0,0 +1,7 @@
+{
+ "type": "none",
+ "comment": "chore: remove @microsoft/fast-ssr",
+ "packageName": "@microsoft/fast-html",
+ "email": "7559015+janechu@users.noreply.github.com",
+ "dependentChangeType": "none"
+}
diff --git a/examples/ssr/CHANGELOG.json b/examples/ssr/CHANGELOG.json
deleted file mode 100644
index 5e9873a0e4b..00000000000
--- a/examples/ssr/CHANGELOG.json
+++ /dev/null
@@ -1,20 +0,0 @@
-{
- "name": "fast-ssr",
- "entries": [
- {
- "date": "Wed, 22 Jun 2022 20:17:50 GMT",
- "tag": "fast-ssr_v1.0.0",
- "version": "1.0.0",
- "comments": {
- "prerelease": [
- {
- "comment": "Bump @microsoft/fast-ssr to v1.0.0-beta.4",
- "author": "nicholasrice@users.noreply.github.com",
- "commit": "f28cdb9fdba9cb27904acfad7444de82d447f39e",
- "package": "fast-ssr"
- }
- ]
- }
- }
- ]
-}
diff --git a/examples/ssr/CHANGELOG.md b/examples/ssr/CHANGELOG.md
deleted file mode 100644
index 1e74f733696..00000000000
--- a/examples/ssr/CHANGELOG.md
+++ /dev/null
@@ -1,13 +0,0 @@
-# Change Log - fast-ssr
-
-This log was last generated on Wed, 22 Jun 2022 20:17:50 GMT and should not be manually modified.
-
-
-
-## 1.0.0
-
-Wed, 22 Jun 2022 20:17:50 GMT
-
-### Changes
-
-- Bump @microsoft/fast-ssr to v1.0.0-beta.4 (nicholasrice@users.noreply.github.com)
diff --git a/examples/ssr/README.md b/examples/ssr/README.md
deleted file mode 100644
index d2bb1c7b93f..00000000000
--- a/examples/ssr/README.md
+++ /dev/null
@@ -1,7 +0,0 @@
-# Server-Side Rendering (SSR) Tutorial
-
-An SSR implementation of the Todo App Tutorial. All components are defined by the [Todo App tutorial](../todo-app/), and the SSR implementation exists in [server.js](./server.js)
-
-## Running the experience
-
-To build the app and start the web server, run `npm start`.
diff --git a/examples/ssr/package.json b/examples/ssr/package.json
deleted file mode 100644
index 9fae1024e57..00000000000
--- a/examples/ssr/package.json
+++ /dev/null
@@ -1,30 +0,0 @@
-{
- "name": "@microsoft/fast-ssr-example",
- "version": "1.0.0",
- "description": "",
- "main": "dist/exports.js",
- "type": "module",
- "private": true,
- "scripts": {
- "build": "vite build",
- "watch": "tsc -p tsconfig.json --watch",
- "start": "npm run build && node server.js",
- "test": "npm run build"
- },
- "author": {
- "name": "Microsoft",
- "url": "https://discord.gg/FcSNfg4"
- },
- "homepage": "https://www.fast.design/",
- "license": "MIT",
- "repository": {
- "type": "git",
- "url": "git+https://github.com/Microsoft/fast.git",
- "directory": "examples/ssr"
- },
- "dependencies": {
- "@microsoft/fast-element": "^2.10.4",
- "@microsoft/fast-ssr": "^1.0.0-beta.40",
- "@microsoft/fast-todo-app-example": "1.0.0"
- }
-}
diff --git a/examples/ssr/server.js b/examples/ssr/server.js
deleted file mode 100644
index 43c37223fdd..00000000000
--- a/examples/ssr/server.js
+++ /dev/null
@@ -1,63 +0,0 @@
-/* eslint-disable no-undef */
-import "@microsoft/fast-ssr/install-dom-shim.js";
-import fs from "fs";
-import { html } from "@microsoft/fast-element";
-import fastSSR, {
- DeclarativeShadowDOMPolyfill,
- RequestStorageManager,
-} from "@microsoft/fast-ssr";
-import express from "express";
-import { DefaultTodoList, app as todoApp, TodoList } from "@microsoft/fast-todo-app-example";
-
-const app = express();
-const port = 8080;
-const { templateRenderer } = fastSSR();
-
-todoApp.define();
-
-app.use(RequestStorageManager.middleware());
-app.use(express.static("./www"));
-
-const template = html`
-
-
-
-
-
- SSR Example
-
-
-
Title
-Title
+Title
Title
-
- ${repeat(
- x => x.items,
- html
- ${x => x} - ` - )} -
-
+ ${repeat(
+ x => x.items,
+ html
- ${x => x} + `, + )} +
- ${listItems}Visible
`, ``, which allows the result to be streamed to the client before the entire template has been rendered.
-
-```js
-const result = templateRenderer.render(html`
-
-
-
- ${color => color} `)}
- `)}
-`, templateRenderer.createRenderInfo(), { shouldRender: true, data: ["red", "green", "blue"] });
-```
-
-##### Directive Support Matrix
-
-|Directive Name|Support|
-|-|-|
-|[`children`](https://www.fast.design/docs/fast-element/using-directives#the-children-directive)|[]()|
-|[`ref`](https://www.fast.design/docs/fast-element/using-directives#the-ref-directive)|[]()|
-|`render`|[]()|
-|[`repeat`](https://www.fast.design/docs/fast-element/using-directives#the-repeat-directive)|[]()|
-|[`slotted`](https://www.fast.design/docs/fast-element/using-directives#the-slotted-directive)|[]()|
-|[`when`](https://www.fast.design/docs/fast-element/using-directives#the-when-directive)|[]()|
-
-> Unsupported directives are no-ops. To understand more about why, see the [Design Philosophy.](#design-philosophy)
-
-##### Rendering Custom Directives
-`@microsoft/fast-element` supports creating custom directives, and `@microsoft/fast-ssr` supports *rendering*
-those custom directives by associating a SSR *renderer* to the custom directive.
-
-> This section does not cover *creating* a FAST directives - that documentation is coming to fast-element.
-
-With your directive (`MyDirective`) created, create a `ViewBehaviorFactoryRenderer` using the Directive
-
-```ts
-const MyDirectiveRenderer: ViewBehaviorFactoryRenderer = {
- // Instructs the TemplateRenderer to use this renderer when instances of
- // 'MyDirective' are found in a template
- matches: MyDirective,
- *render(directive, renderInfo, source, templateRenderer, context) {
- // Yield something, or do nothing
- }
-}
-```
-
-What a custom directive should *do* on the server depends highly on the scenario. As discussed above, several FAST directives are no-ops because the use-case doesn't make sense in an SSR context. The `render()` function is provided the directive instance, the SSR renderInfo object, any source data, the `TemplateRenderer`, and the `ExecutionContext` - use these to render what makes sense for the custom directive.
-
-To use the custom renderer, you must configure `fastSSR`:
-```ts
-import fastSSR from "@microsoft/fast-ssr";
-
-const { templateRenderer} = fastSSR({viewBehaviorFactoryRenderers: [MyDirectiveRenderer]});
-```
-
-Then, templates that use `MyDirective` can be rendered:
-
-```ts
-templateRenderer.render(html``);
-```
-#### Rendering Asynchronous Components
-Sometimes it is necessary for a component to do asynchronous work prior to rending it's template, and `@microsoft/fast-ssr` can be configured to support async work by supplying the `renderMode: "async"` configuration to the SSR factory:
-
-```ts
-import fastSSR from "@microsoft/fast-ssr";
-
-const { templateRenderer } = fastSSR({
- renderMode: "async"
-});
-```
-
-Communication that an element requires asynchronous rendering is facilitated by the [PendingTask](https://github.com/webcomponents-cg/community-protocols/blob/main/proposals/pending-task.md) community protocol. The component should emit a `PendingTaskEvent` during it's `connectedCallback()`. Doing so instructs the `TemplateRenderer` to resolve all pending tasks before continuing rendering:
-```ts
-import { PendingTaskEvent } from "@microsoft/fast-element/pending-task";
-// ...
-class AsyncElement extends FASTElement {
- async doWork() {
- // ...
- }
-
- connectedCallback() {
- super.connectedCallback();
-
- this.dispatchEvent(new PendingTaskEvent(this.doWork()));
- }
-}
-```
-
-When yielding the results of an async renderer, ensure that any `Promise` encountered is awaited:
-
-```ts
-
-for await (const part of templateRenderer.render(someAsyncTemplate)) {
- res.write(part);
-}
-```
-
-> It's important to note that to accurately render asynchronous components, template rendering must be effectively paused until async work is complete. This is inherently inefficient because that work gets initiated iteratively, during template rendering. If possible, it is best to architect your components and application in such a way that async work happens prior to template rendering, where initiation of async work can be better coordinated.
-
-#### Disabling Rendering for Specific Components
-In cases where an author doesn't want a FAST component to render in SSR environments, but it is impractical to prevent *defining* that element in the custom element registry, the `ElementRenderer` exposes a mechanism to prevent matching elements it would otherwise match. Components can be disabled by tag-name (`"element-name"`), class constructor (`class MyElement extends FASTElement {}`), or `FASTElementDefinition` (`MyElement.compose({/* config */})`)
-
-```ts
-// The element gets defined somewhere in an application
-const name = "my-element";
-class MyElement extends FASTElement {}
-const definition = MyElement.compose({name, template: html` {
- // (undocumented)
- renderAttributes(): IterableIterator>;
- // (undocumented)
- renderShadow(renderInfo: RenderInfo): IterableIterator>;
-}
-
-// @beta (undocumented)
-export interface AsyncTemplateRenderer extends EventEmitter {
- // (undocumented)
- createRenderInfo(): RenderInfo;
- // (undocumented)
- readonly emitHydratableMarkup: boolean;
- // (undocumented)
- render(template: ViewTemplate | string, renderInfo?: RenderInfo, source?: unknown, context?: ExecutionContext): IterableIterator>;
- // (undocumented)
- withDefaultElementRenderers(...renderers: ConstructableElementRenderer[]): void;
-}
-
-// @beta (undocumented)
-export interface ConstructableElementRenderer {
- // (undocumented)
- new (tagName: string, renderInfo: RenderInfo): T;
- // Warning: (ae-forgotten-export) The symbol "AttributesMap" needs to be exported by the entry point exports.d.ts
- matchesClass(ctor: typeof HTMLElement, tagName: string, attributes: AttributesMap): boolean;
-}
-
-// @beta (undocumented)
-export interface ConstructableFASTElementRenderer extends ConstructableElementRenderer {
- disable(...args: Array): void;
-}
-
-// @beta
-export const DeclarativeShadowDOMPolyfill: Readonly<{
- undefinedElementStyles: string;
- nonStreamingTemplateUpgrade: string;
-}>;
-
-// @beta (undocumented)
-export interface ElementRenderer {
- // (undocumented)
- attributeChangedCallback(name: string, prev: string | null, next: string | null): void;
- // (undocumented)
- connectedCallback(): void;
- // (undocumented)
- disconnectedCallback(): void;
- // (undocumented)
- dispatchEvent(event: Event): boolean;
- // (undocumented)
- renderAttributes(): IterableIterator;
- // (undocumented)
- renderShadow(renderInfo: RenderInfo): IterableIterator;
- // (undocumented)
- setAttribute(name: string, value: string): void;
- // (undocumented)
- setProperty(name: string, value: unknown): void;
- // (undocumented)
- readonly tagName: string;
-}
-
-// @beta (undocumented)
-function fastSSR(): {
- templateRenderer: TemplateRenderer;
- ElementRenderer: ConstructableFASTElementRenderer;
-};
-
-// @beta (undocumented)
-function fastSSR(config: Omit): {
- templateRenderer: TemplateRenderer;
- ElementRenderer: ConstructableFASTElementRenderer;
-};
-
-// @beta (undocumented)
-function fastSSR(config: SSRConfiguration & Record<"renderMode", "sync">): {
- templateRenderer: TemplateRenderer;
- ElementRenderer: ConstructableFASTElementRenderer;
-};
-
-// @beta (undocumented)
-function fastSSR(config: SSRConfiguration & Record<"renderMode", "async">): {
- templateRenderer: AsyncTemplateRenderer;
- ElementRenderer: ConstructableFASTElementRenderer;
-};
-export default fastSSR;
-
-// @beta
-export type Middleware = (req: any, res: any, next: () => any) => void;
-
-// @beta (undocumented)
-export interface RenderInfo extends Disposable_2 {
- // @deprecated
- customElementHostStack: ElementRenderer[];
- customElementInstanceStack: ElementRenderer[];
- elementRenderers: ConstructableElementRenderer[];
- renderedCustomElementList: ElementRenderer[];
-}
-
-// @beta
-export const RequestStorage: Readonly<{
- readonly container: DOMContainer;
- set(key: any, value: any): any;
- get: typeof getItem;
- clear(): void;
- delete(key: any): boolean;
- has(key: any): boolean;
-}>;
-
-// @beta
-export const RequestStorageManager: Readonly<{
- backend: AsyncLocalStorage;
- installDOMShim(): void;
- uninstallDOMShim(): void;
- installDIContextRequestStrategy(): void;
- createStorage(options?: StorageOptions, req?: any): Map;
- run(storage: Map, callback: () => T): T;
- middleware(options?: StorageOptions): Middleware;
-}>;
-
-// @beta
-export interface SSRConfiguration {
- deferHydration?: boolean | ((tagName: string) => boolean);
- emitHydratableMarkup?: boolean;
- renderMode?: "sync" | "async";
- styleRenderer?: StyleRenderer;
- tryRecoverFromError?: boolean | ((e: unknown) => void);
- viewBehaviorFactoryRenderers?: ViewBehaviorFactoryRenderer[];
-}
-
-// @beta
-export type StorageOptions = {
- createWindow?: (req: any) => {
- [key: string]: unknown;
- };
- storage?: Map;
-};
-
-// @beta
-export interface StyleRenderer {
- render(styles: Set): string;
-}
-
-// Warning: (ae-forgotten-export) The symbol "TemplateCacheController" needs to be exported by the entry point exports.d.ts
-//
-// @public (undocumented)
-export const templateCacheController: TemplateCacheController;
-
-// @beta (undocumented)
-export interface TemplateRenderer extends EventEmitter {
- // (undocumented)
- createRenderInfo(): RenderInfo;
- // (undocumented)
- readonly emitHydratableMarkup: boolean;
- // (undocumented)
- render(template: ViewTemplate | string, renderInfo?: RenderInfo, source?: unknown, context?: ExecutionContext): IterableIterator;
- // (undocumented)
- withDefaultElementRenderers(...renderers: ConstructableElementRenderer[]): void;
-}
-
-// @beta
-export interface ViewBehaviorFactoryRenderer {
- matcher: Constructable;
- // Warning: (ae-forgotten-export) The symbol "DefaultTemplateRenderer" needs to be exported by the entry point exports.d.ts
- render(behaviorFactory: T, renderInfo: RenderInfo, source: any, renderer: DefaultTemplateRenderer, context: ExecutionContext): IterableIterator;
-}
-
-// Warnings were encountered during analysis:
-//
-// dist/dts/exports.d.ts:60:5 - (ae-forgotten-export) The symbol "SyncFASTElementRenderer" needs to be exported by the entry point exports.d.ts
-// dist/dts/exports.d.ts:75:5 - (ae-forgotten-export) The symbol "AsyncFASTElementRenderer" needs to be exported by the entry point exports.d.ts
-// dist/dts/request-storage.d.ts:33:5 - (ae-forgotten-export) The symbol "getItem" needs to be exported by the entry point exports.d.ts
-
-// (No @packageDocumentation comment for this package)
-
-```
diff --git a/packages/fast-ssr/package.json b/packages/fast-ssr/package.json
deleted file mode 100644
index 5a2b717e9e3..00000000000
--- a/packages/fast-ssr/package.json
+++ /dev/null
@@ -1,75 +0,0 @@
-{
- "name": "@microsoft/fast-ssr",
- "version": "1.0.0-beta.40",
- "type": "module",
- "author": {
- "name": "Microsoft",
- "url": "https://discord.gg/FcSNfg4"
- },
- "homepage": "https://www.fast.design/",
- "license": "MIT",
- "repository": {
- "type": "git",
- "url": "git+https://github.com/Microsoft/fast.git",
- "directory": "packages/fast-ssr"
- },
- "bugs": {
- "url": "https://github.com/Microsoft/fast/issues/new/choose"
- },
- "scripts": {
- "clean": "tsc -b --clean src",
- "build": "tsc -b src && npm run doc",
- "doc": "api-extractor run --local",
- "doc:ci": "api-extractor run",
- "prepublishOnly": "npm run clean && npm run build",
- "build-server": "tsc -b server",
- "lint": "biome-changed",
- "lint:fix": "biome-changed -- --fix",
- "pretest": "npm run build-server && npm run build",
- "test": "npm run test:node && npm run test:playwright",
- "test:node": "node scripts/run-tests.mjs",
- "test:playwright": "npm run pretest && playwright test",
- "test:chromium": "npm run pretest && playwright test --project=chromium",
- "test-server": "node server/dist/server.js"
- },
- "deprecated": "This package is deprecated. Please use @microsoft/fast-build and @microsoft/webui instead.",
- "description": "A package for rendering FAST Web Components outside the browser.",
- "main": "dist/esm/exports.js",
- "types": "dist/dts/exports.d.ts",
- "exports": {
- ".": {
- "types": "./dist/dts/exports.d.ts",
- "default": "./dist/esm/exports.js"
- },
- "./install-dom-shim.js": "./dist/esm/install-dom-shim.js",
- "./dom-shim": {
- "types": "./dist/dts/dom-shim.d.ts",
- "default": "./dist/esm/dom-shim.js"
- },
- "./request-storage.js": {
- "types": "./dist/dts/request-storage.d.ts",
- "default": "./dist/esm/request-storage.js"
- },
- "./package.json": "./package.json"
- },
- "dependencies": {
- "parse5": "^6.0.1",
- "tslib": "^2.6.3"
- },
- "peerDependencies": {
- "@microsoft/fast-element": "^2.10.4"
- },
- "devDependencies": {
- "@types/parse5": "^5.0.0",
- "@microsoft/fast-element": "^2.10.4"
- },
- "beachball": {
- "disallowedChangeTypes": [
- "major",
- "minor",
- "patch"
- ],
- "tag": "latest",
- "prereleasePrefix": "beta"
- }
-}
diff --git a/packages/fast-ssr/playwright.config.ts b/packages/fast-ssr/playwright.config.ts
deleted file mode 100644
index 0d600049552..00000000000
--- a/packages/fast-ssr/playwright.config.ts
+++ /dev/null
@@ -1,18 +0,0 @@
-import { defineConfig, devices } from "@playwright/test";
-
-export default defineConfig({
- testDir: "./dist/esm",
- testMatch: "**/*.pw.spec.js",
- retries: 3,
- projects: [
- { name: "chromium", use: { ...devices["Desktop Chrome"] } },
- { name: "firefox", use: { ...devices["Desktop Firefox"] } },
- { name: "webkit", use: { ...devices["Desktop Safari"] } },
- ],
- webServer: {
- command: "npm run test-server",
- port: 8080,
- timeout: 120 * 1000,
- reuseExistingServer: false,
- },
-});
diff --git a/packages/fast-ssr/scripts/run-tests.mjs b/packages/fast-ssr/scripts/run-tests.mjs
deleted file mode 100644
index 12de7159510..00000000000
--- a/packages/fast-ssr/scripts/run-tests.mjs
+++ /dev/null
@@ -1,8 +0,0 @@
-import { globSync } from "node:fs";
-import { execSync } from "node:child_process";
-
-const files = globSync("dist/esm/**/*.spec.js", {
- exclude: ["dist/esm/**/*.pw.spec.js"],
-});
-
-execSync(`node --test ${files.join(" ")}`, { stdio: "inherit" });
diff --git a/packages/fast-ssr/server/README.md b/packages/fast-ssr/server/README.md
deleted file mode 100644
index c41dd618a80..00000000000
--- a/packages/fast-ssr/server/README.md
+++ /dev/null
@@ -1,2 +0,0 @@
-# Server
-This project contains the web server that playwright tests are run against. To build, run `npm run build-server`.
\ No newline at end of file
diff --git a/packages/fast-ssr/server/placeholder.png b/packages/fast-ssr/server/placeholder.png
deleted file mode 100644
index 300ae8d0766da103602bc15c6b5392e95cb43f6f..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 1617
zcmdUw`#aMM0LC|EgzTYmSy|^G$H|IvnOqtNv7TJcbXZO1GERs@MmSr?ZAUmudh$4K
zl~i&m$vviKYjasiW?ODwi^;~uTvi&#`2)@$&@b=vKJWAX_&%RE*U!guw+2iD1On|w
zd%0skATVOvv(&c*l>8zy7X*SBpxs^1rU(|s&-ufm3>Ztp%(8
z@Iz#T>FmwBi`~gEHrI3g&LXc~=Vupa#L$_Fy-ZwO*HCr|-+cdi>|j+=!h#BsWU;DF
z-zwLUk`=(ga%f;}8XK6O?=eIK1Wz>Cs)?qe+m0hGP7TmSp-PyzO=$f?>p815*Y%Ez
zyW=*xHPfmHYZ(*HIQfgzQI+T7>K8)QBdCK?S$ppWEBb(9wkZizp6u*YlY^W1sK+IG
z-))*K@3N&<`J3Xi3Ni#yA&dLMjZPM0p|V#c)PiUGp1(a~ld2@e5^4co_Tu?A35WNO
z+f#6rfb3-Gcu1k&sJ*qTG0ws3wpxFk>bjj|{gBJG_&Mw#CD}e92EG8t)Y6mqz224_
z0QI9@fMi9M)Mur$6A%KB+@T8tI|7Gra@n4M=&La
zGxqJIYs#dEM-Un^q?hk<2CTiTbFTe9uq(qN6*P(7u#
z$WGFij}w)vvCKXLnt4hsxV^Im?M?;t)W=CYqvFdTf5G?FXc)L4(ZI39F!1a9oc7J@
zKwfH=XTVlIc%gsuPey6?fYc+-+gyKYv~01ETF`8Wx_eI3ZvaJ5WWa&K2q*NoUFtY>
z&^ht!QR7)eWc9eX%>KfsmdGIC{5!V>hj2{Y6_QJx5oko{Z{yQ)aM^}^iLAv@F@0hk
z{N{BlsYW0DZB8^L?1I5YY^UCr*bB7DWk&6`5nWjz=Gy6%Pfs_rF;CSzo7A-MOl(h1
zcHAS{ayRW==Q=JK;}XdPizS&9iDk)#**Gfw=kN%OvMMHW+G_fQa?i+L^-=gv7m;!F
zIkw*n!=J*=i3rW%*YREWB@n$$6u)9gIM>YL2CET^@?G6`%a(
zrA!&BI2xBObbe4&h$|X1(XZAW6G|(5HeGk{c>5>GB!w@pd;T{vnpHk|Ah~pMkd&&Q<=VcYH2gz4BLJ6cfqh
z8aV&nocr%9&>lYS
J4ZnnB{0q?B_L%?x
diff --git a/packages/fast-ssr/server/server.ts b/packages/fast-ssr/server/server.ts
deleted file mode 100644
index 76b0e5e4a32..00000000000
--- a/packages/fast-ssr/server/server.ts
+++ /dev/null
@@ -1,89 +0,0 @@
-import fs from "fs";
-import path from "path";
-import { Readable } from "stream";
-
-import express, { Request, Response } from "express";
-
-const __dirname = path.resolve(path.dirname(""));
-const PORT = 8080;
-function handleRequest(req: Request, res: Response) {
- res.set("Content-Type", "text/html");
- const stream = (Readable as any).from("hello world");
- stream.on("readable", function (this: any) {
- let data: string;
-
- while ((data = this.read())) {
- res.write(data);
- }
- });
-
- stream.on("close", () => res.end());
- stream.on("error", (e: Error) => {
- console.error(e);
- process.exit(1);
- });
-}
-
-function handlePathRequest(
- mapPath: string,
- contentType: string,
- req: Request,
- res: Response
-) {
- res.set("Content-Type", contentType);
- fs.readFile(path.resolve(__dirname, mapPath), { encoding: "utf8" }, (err, data) => {
- const stream = (Readable as any).from(data);
- stream.on("readable", function (this: any) {
- while ((data = this.read())) {
- res.write(data);
- }
- });
- stream.on("close", () => res.end());
- stream.on("error", (e: Error) => {
- console.error(e);
- process.exit(1);
- });
- });
-}
-
-const app = express();
-app.get("/", handleRequest);
-app.get("/fast-style", (req: Request, res: Response) =>
- handlePathRequest("./src/styles/fast-style.fixture.html", "text/html", req, res)
-);
-app.get("/fast-style.js", (req: Request, res: Response) =>
- handlePathRequest(
- "./dist/esm/styles/fast-style.js",
- "application/javascript",
- req,
- res
- )
-);
-app.get("/fast-style-config.js", (req: Request, res: Response) =>
- handlePathRequest(
- "./dist/esm/styles/fast-style-config.js",
- "application/javascript",
- req,
- res
- )
-);
-app.get("/fast-command-buffer", (req: Request, res: Response) =>
- handlePathRequest(
- "./src/fast-command-buffer/index.fixture.html",
- "text/html",
- req,
- res
- )
-);
-app.get("/fast-command-buffer.js", (req: Request, res: Response) =>
- handlePathRequest(
- "./dist/esm/fast-command-buffer/index.js",
- "application/javascript",
- req,
- res
- )
-);
-app.get("/placeholder.png", (req, res) =>
- res.sendFile(path.resolve(__dirname, "./server/placeholder.png"))
-);
-app.listen(PORT);
diff --git a/packages/fast-ssr/server/tsconfig.json b/packages/fast-ssr/server/tsconfig.json
deleted file mode 100644
index fc7f3f2b6e1..00000000000
--- a/packages/fast-ssr/server/tsconfig.json
+++ /dev/null
@@ -1,9 +0,0 @@
-{
- "extends": "../tsconfig.json",
- "compilerOptions": {
- "composite": true,
- "rootDir": ".",
- "outDir": "dist"
- },
- "references": [{ "path": "../src"}]
-}
diff --git a/packages/fast-ssr/src/configure-fast-element.ts b/packages/fast-ssr/src/configure-fast-element.ts
deleted file mode 100644
index 6dbdf407faf..00000000000
--- a/packages/fast-ssr/src/configure-fast-element.ts
+++ /dev/null
@@ -1,34 +0,0 @@
-import {
- Compiler,
- ElementController,
- ElementStyles,
- Updates,
- ViewBehaviorFactory,
-} from "@microsoft/fast-element";
-import { SSRElementController } from "./element-controller.js";
-import { FASTSSRStyleStrategy } from "./styles/style-strategy.js";
-import { SSRView } from "./view.js";
-
-Compiler.setDefaultStrategy(
- (
- html: string | HTMLTemplateElement,
- factories: Record
- ) => {
- if (typeof html !== "string") {
- throw new Error(
- "SSR compiler does not support HTMLTemplateElement templates"
- );
- }
-
- return new SSRView(html, factories) as any;
- }
-);
-
-ElementStyles.setDefaultStrategy(FASTSSRStyleStrategy);
-
-// Set update mode to synchronous, so that mutations happen immediately.
-// This is required due to the synchronous nature of rendering templates
-// to a string.
-Updates.setMode(false);
-
-ElementController.setStrategy(SSRElementController);
diff --git a/packages/fast-ssr/src/declarative-shadow-dom-polyfill.ts b/packages/fast-ssr/src/declarative-shadow-dom-polyfill.ts
deleted file mode 100644
index cd233b3707d..00000000000
--- a/packages/fast-ssr/src/declarative-shadow-dom-polyfill.ts
+++ /dev/null
@@ -1,38 +0,0 @@
-// Reference: https://web.dev/declarative-shadow-dom/
-
-/**
- * Provides style and JavaScript code snippets for polyfills related
- * to Declarative Shadow DOM (DSD).
- * @beta
- */
-export const DeclarativeShadowDOMPolyfill = Object.freeze({
- /**
- * Styles that hide undefined elements, taking account of the
- * fact that undefined elements with DSD should not be hidden.
- * @remarks
- * These styles should be used in a style element tag in the head
- * of the HTML document.
- */
- undefinedElementStyles: `:not(:defined) > template[shadowroot] ~ * {
- display: none;
-}` as string,
- /**
- * A JavaScript polyfill for DSD that recursively converts all templates
- * in the document with the shadowroot attribute into actual shadow roots.
- * @remarks
- * This is a one-time operation that should be placed at the end of the SSR'd
- * HTML but before any other scripts run.
- */
- nonStreamingTemplateUpgrade:
- `if (!HTMLTemplateElement.prototype.hasOwnProperty('shadowRoot')) {
- (function attachShadowRoots(root) {
- root.querySelectorAll("template[shadowroot]").forEach(template => {
- const mode = template.getAttribute("shadowroot");
- const shadowRoot = template.parentNode.attachShadow({ mode });
- shadowRoot.appendChild(template.content);
- template.remove();
- attachShadowRoots(shadowRoot);
- });
- })(document);
-}` as string,
-});
diff --git a/packages/fast-ssr/src/dom-shim.spec.ts b/packages/fast-ssr/src/dom-shim.spec.ts
deleted file mode 100644
index ff73206d96d..00000000000
--- a/packages/fast-ssr/src/dom-shim.spec.ts
+++ /dev/null
@@ -1,184 +0,0 @@
-import "./install-dom-shim.js";
-import { deepStrictEqual, doesNotThrow, ok, strictEqual } from "node:assert/strict";
-import { describe, test } from "node:test";
-import { FASTElement, html } from "@microsoft/fast-element";
-import { createWindow } from "./dom-shim.js";
-import fastSSR from "./exports.js";
-import { uniqueElementName } from "@microsoft/fast-element/testing.js";
-
-describe("createWindow", () => {
- test("should create a window with a document property that is an instance of the window's Document constructor", () => {
- const window = createWindow();
-
- strictEqual(window.document instanceof (window.Document as any), true);
-
- class MyDocument {}
- const windowOverride = createWindow({ Document: MyDocument });
- strictEqual(windowOverride.document instanceof MyDocument, true);
- });
- test("should create a window with a customElements property that is an instance of the window's CustomElementRegistry constructor", () => {
- const window = createWindow();
-
- strictEqual(
- window.customElements instanceof (window.CustomElementRegistry as any)
- , true);
-
- class MyRegistry {}
- const windowOverride = createWindow({ CustomElementRegistry: MyRegistry });
- strictEqual(windowOverride.customElements instanceof MyRegistry, true);
- });
-});
-
-describe("The DOM shim", () => {
- test(`should support construction and connection of a component and template during SSR rendering`, () => {
- class MyComponent extends FASTElement {}
-
- const name = "my-component";
-
- MyComponent.define({
- name,
- template: html``
- });
-
- const { templateRenderer } = fastSSR();
- const templateString = `<${name}>`;
- doesNotThrow(() => templateRenderer.render(templateString));
- });
-
- describe("has a CSSStyleSheet implementation", () => {
- test("that is constructable", () => {
- doesNotThrow(() => new CSSStyleSheet());
- });
- test("that supports adding :host{} and :root{} rules", () => {
- const sheet = new CSSStyleSheet();
- const hostIndex = sheet.insertRule(":host{}");
- strictEqual(sheet.cssRules[hostIndex].cssText, ":host { }");
- const rootIndex = sheet.insertRule(":root{}");
- strictEqual(sheet.cssRules[rootIndex].cssText, ":root { }");
- });
-
- describe("with rule implementations", () => {
- test("that support setting properties from the style declaration", () => {
- const sheet = new CSSStyleSheet();
- const index = sheet.insertRule(":host{}");
- const rule = sheet.cssRules[index] as CSSStyleRule;
- rule.style.setProperty("--test", "value");
-
- strictEqual(rule.cssText, ":host { --test: value; }");
- });
- test("that support removing properties from the style declaration", () => {
- const sheet = new CSSStyleSheet();
- const index = sheet.insertRule(":host{}");
- const rule = sheet.cssRules[index] as CSSStyleRule;
- rule.style.setProperty("--test", "value");
- rule.style.removeProperty("--test");
-
- strictEqual(rule.cssText, ":host { }");
- });
- });
- });
-
- describe("has a matchMedia method", () => {
- test("that can returns the MediaQueryList supplied to createWindow", () => {
- class MyMediaQueryList {}
-
- const win: any = createWindow({ MediaQueryList: MyMediaQueryList });
- const list = win.matchMedia();
-
- ok(list instanceof MyMediaQueryList);
- });
- });
-
- describe("DOMTokenList", () => {
- class TestElement extends FASTElement {}
- TestElement.define({ name: uniqueElementName() });
-
- test("adds a token", () => {
- const element = new TestElement();
- const cList = element.classList;
-
- cList.toggle("c1");
- ok(cList.contains("c1"), "adds a token that is not present");
-
- deepStrictEqual(cList.toggle("c2"),
- true
- , "returns true when token is added");
- });
-
- test("removes a token", () => {
- const element = new TestElement();
- const cList = element.classList;
-
- cList.add("c1");
- cList.toggle("c1");
-
- ok(!cList.contains("c1"), "removes a token that is present");
-
- cList.add("c2");
- deepStrictEqual(
- cList.toggle("c2"), false, "return false when token is removed"
- );
- });
-
- test("adds token with second argument", () => {
- const element = new TestElement();
- const cList = element.classList;
-
- cList.toggle("c1", true);
- ok(cList.contains("c1"), "adds a token");
-
- deepStrictEqual(
- cList.toggle("c2", true), true, "returns true when token is added"
- );
-
- cList.add("c3");
- cList.toggle("c3", true);
-
- ok(
- cList.contains("c3"), "does not remove a token that is already present"
- );
-
- cList.add("c4");
-
- deepStrictEqual(
- cList.toggle("c4", true), true, "returns true when token is already present"
- );
- });
-
- test("removes token with second argument", () => {
- const element = new TestElement();
- const cList = element.classList;
-
- cList.add("c1");
- cList.toggle("c1", false);
-
- ok(!cList.contains("c1"), "removes a token");
-
- deepStrictEqual(
- cList.toggle("c2", false), false, "returns false when token is removed"
- );
-
- cList.toggle("c3", false);
-
- ok(
- !cList.contains("c3"), "does not add a token that is not present"
- );
-
- deepStrictEqual(
- cList.toggle("c4", false), false, "returns false when token was not present"
- );
- });
-
- test("removes duplicated tokens", () => {
- const element = new TestElement();
- element.className = "ho ho ho";
-
- const cList = element.classList;
- cList.remove("ho");
- ok(
- !cList.contains("ho"), "should remove all instances of 'ho'"
- );
- deepStrictEqual(element.className, "");
- });
- });
-});
diff --git a/packages/fast-ssr/src/dom-shim.ts b/packages/fast-ssr/src/dom-shim.ts
deleted file mode 100644
index 945853b50a6..00000000000
--- a/packages/fast-ssr/src/dom-shim.ts
+++ /dev/null
@@ -1,443 +0,0 @@
-/**
- * This file was heavily inspired by {@link https://github.com/lit/lit/tree/main/packages/labs/ssr} with some adjustments made.
- * Please see {@link ../ACKNOWLEDGEMENTS.md}
- */
-
-import { shouldBubble } from "./event-utilities.js";
-
-/**
- * @beta
- */
-export class Node extends EventTarget {}
-
-/**
- * @beta
- */
-export class Element extends Node {}
-
-function checkTokenAndGetIndex(classList: DOMTokenList, token: string) {
- if (token === "") {
- throw new Error("The token must not be empty.");
- }
-
- if (/\s/.test(token)) {
- throw new Error("The token must not contain space characters.");
- }
-
- return classList.indexOf(token);
-}
-
-/*
- * Based on classList.js: Cross-browser full element.classList implementation.
- * 1.2.20171210
- *
- * Credit to Eli Grey, http://eligrey.com
- * License: Dedicated to the public domain.
- * See https://github.com/eligrey/classList.js/blob/master/LICENSE.md
- */
-
-/**
- * @beta
- */
-export class DOMTokenList {
- private tokens: string[] = [];
-
- public constructor(private element: HTMLElement, private attributeName: string) {
- const trimmedClasses = (element.getAttribute(attributeName) || "").trim();
- const classes = trimmedClasses ? trimmedClasses.split(/\s+/) : [];
-
- for (let i = 0, len = classes.length; i < len; i++) {
- this.tokens.push(classes[i]);
- }
- }
-
- public item(i: number) {
- return this.tokens[i] || null;
- }
-
- public contains(token: string) {
- return ~checkTokenAndGetIndex(this, token + "");
- }
-
- public indexOf(token: string) {
- return this.tokens.indexOf(token);
- }
-
- public add(...tokens: string[]) {
- const length = tokens.length;
- let index = 0;
- let updated = false;
-
- do {
- const token = tokens[index] + "";
-
- if (!~checkTokenAndGetIndex(this, token)) {
- this.tokens.push(token);
- updated = true;
- }
- } while (++index < length);
-
- if (updated) {
- this.updateClassName();
- }
- }
-
- public remove(...tokens: string[]) {
- const length = tokens.length;
- let index = 0;
- let updated = false;
-
- do {
- const token = tokens[index] + "";
- let result = checkTokenAndGetIndex(this, token);
-
- while (~result) {
- this.tokens.splice(result, 1);
- updated = true;
- result = checkTokenAndGetIndex(this, token);
- }
- } while (++index < length);
-
- if (updated) {
- this.updateClassName();
- }
- }
-
- public toggle(token: string, force: boolean): boolean {
- const result = this.contains(token);
- const method = result ? force !== true && "remove" : force !== false && "add";
-
- if (method) {
- this[method](token);
- }
-
- if (force === true || force === false) {
- return force;
- } else {
- return !result;
- }
- }
-
- public replace(token: string, replacement: string) {
- const index = checkTokenAndGetIndex(this, token + "");
-
- if (~index) {
- this.tokens.splice(index, 1, replacement);
- this.updateClassName();
- }
- }
-
- public toString(): string {
- return this.tokens.join(" ");
- }
-
- private updateClassName() {
- this.element.setAttribute(this.attributeName, this.toString());
- }
-}
-
-/**
- * @beta
- */
-export abstract class HTMLElement extends Element {
- private static elementAttributes: WeakMap> =
- new WeakMap();
- private static getOrCreateAttributesForElement(element: HTMLElement) {
- let attrs = HTMLElement.elementAttributes.get(element);
- if (!attrs) {
- HTMLElement.elementAttributes.set(element, (attrs = new Map()));
- }
- return attrs;
- }
-
- private _shadowRoot: null | ShadowRoot = null;
-
- get attributes() {
- return Array.from(HTMLElement.getOrCreateAttributesForElement(this)).map(
- ([name, value]) => ({
- name,
- value,
- })
- );
- }
-
- get shadowRoot() {
- return this._shadowRoot;
- }
-
- get part(): DOMTokenList {
- return new DOMTokenList(this, "part");
- }
-
- get classList(): DOMTokenList {
- return new DOMTokenList(this, "class");
- }
-
- get className(): string | null {
- return this.getAttribute("class");
- }
-
- set className(value: string | null) {
- if (value === null) {
- this.removeAttribute("class");
- } else {
- this.setAttribute("class", value);
- }
- }
-
- abstract attributeChangedCallback?(
- name: string,
- old: string | null,
- value: string | null
- ): void;
-
- setAttribute(name: string, value: string) {
- HTMLElement.getOrCreateAttributesForElement(this).set(name, value);
- }
-
- removeAttribute(name: string) {
- HTMLElement.getOrCreateAttributesForElement(this).delete(name);
- }
-
- hasAttribute(name: string) {
- return HTMLElement.getOrCreateAttributesForElement(this).has(name);
- }
-
- attachShadow(init: ShadowRootInit): ShadowRoot {
- const shadowRoot = { host: this };
- if (init && init.mode === "open") {
- this._shadowRoot = shadowRoot;
- }
- return shadowRoot;
- }
-
- getAttribute(name: string) {
- const value = HTMLElement.getOrCreateAttributesForElement(this).get(name);
- return value === undefined ? null : value;
- }
-}
-
-/**
- * @beta
- */
-export interface CustomHTMLElement {
- new (): HTMLElement;
- observedAttributes?: string[];
-}
-
-/**
- * @beta
- */
-export class ShadowRoot {}
-
-/**
- * @beta
- */
-export class Document extends Node {
- public adoptedStyleSheets: ReadonlyArray = [];
- createTreeWalker() {
- return {};
- }
- createTextNode() {
- return {};
- }
- createElement() {
- return {};
- }
-
- public dispatchEvent(event: Event): boolean {
- let canceled = super.dispatchEvent(event);
-
- if (shouldBubble(event)) {
- canceled = window.dispatchEvent(event);
- }
-
- return canceled;
- }
-}
-
-/**
- * @beta
- */
-export class CustomEvent extends Event {
- public detail: T | null = null;
- constructor(type: string, init?: CustomEventInit) {
- super(type, init);
-
- if (init && "detail" in init) {
- this.detail = init.detail as T;
- }
- }
-}
-
-/**
- * @beta
- */
-export class CSSStyleRule {
- public selectorText: string | undefined;
- public readonly style = new CSSStyleDeclaration();
-
- public get cssText(): string {
- if (typeof this.selectorText !== "string") {
- throw new Error(
- "Cannot format cssText for CSSStyleRule. No selectorText property is assigned."
- );
- }
-
- return `${this.selectorText} { ${this.style.cssText} }`;
- }
-}
-
-/**
- * @beta
- */
-export class CSSStyleDeclaration {
- private rules = new Map();
- public setProperty(name: string, value: string = "") {
- this.rules.set(name, value);
- }
- public removeProperty(name: string) {
- this.rules.delete(name);
- }
-
- public get cssText() {
- let text = "";
-
- for (const [key, value] of this.rules) {
- text += `${key}: ${value};`;
- }
-
- return text;
- }
-}
-
-/**
- * @beta
- */
-export class CSSStyleSheet {
- replace() {}
- public readonly cssRules: CSSRule[] = [];
- insertRule(rule: string, index: number = 0) {
- const selectorText = rule.split("{")[0];
- const styleRule = new window.CSSStyleRule();
- styleRule.selectorText = selectorText;
- this.cssRules.splice(index, 0, styleRule);
-
- return index;
- }
-}
-
-/**
- * @beta
- */
-export type CustomElementRegistration = {
- ctor: { new (): HTMLElement };
- observedAttributes: string[];
-};
-
-/**
- * @beta
- */
-export class CustomElementRegistry {
- private __definitions = new Map();
-
- define(name: string, ctor: CustomHTMLElement) {
- this.__definitions.set(name, {
- ctor,
- observedAttributes: (ctor as CustomHTMLElement).observedAttributes ?? [],
- });
- }
-
- get(name: string) {
- const definition = this.__definitions.get(name);
- return definition && definition.ctor;
- }
-}
-
-/**
- * @beta
- */
-export class MutationObserver {
- observe() {}
-}
-
-/**
- * Shim of MediaQueryList.
- * {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaQueryList} */
-export class MediaQueryList {
- /** No-op */
- addEventListener() {}
-
- /** No-op */
- removeEventListener() {}
-
- /** Always false */
- matches = false;
-}
-
-/**
- * @beta
- */
-export class Window extends EventTarget {
- public Node = Node;
- public Element = Element;
- public HTMLElement = HTMLElement;
- public Document = Document;
- public CustomEvent = CustomEvent;
- public CSSStyleSheet = CSSStyleSheet;
- public CSSStyleDeclaration = CSSStyleDeclaration;
- public CSSStyleRule = CSSStyleRule;
- public ShadowRoot = ShadowRoot;
- public CustomElementRegistry = CustomElementRegistry;
- public MutationObserver = MutationObserver;
- public MediaQueryList = MediaQueryList;
- public matchMedia = () => new this.MediaQueryList();
-
- // Defined in constructor
- public window: unknown;
- public document: unknown;
- public customElements: unknown;
- public dispatchEvent: any;
- public addEventListener: any;
- public removeEventListener: any;
-
- constructor(props?: Record) {
- super();
-
- /**
- * Methods of EventTarget must be assigned explicitly, otherwise they get omitted
- * when the window is merged into the `globalThis` in {@link installWindowOnGlobal}.
- */
- this.dispatchEvent = EventTarget.prototype.dispatchEvent.bind(this);
- this.addEventListener = EventTarget.prototype.addEventListener.bind(this);
- this.removeEventListener = EventTarget.prototype.removeEventListener.bind(this);
-
- Object.assign(this, props);
- this.window = this;
- this.document = new this.Document();
- this.customElements = new this.CustomElementRegistry();
- }
-}
-
-/**
- * Creates a window object.
- * @param props - Additional properties to expose on the window.
- *
- * @beta
- */
-export function createWindow>(props?: T): Window & T {
- return new Window(props) as Window & T;
-}
-
-/**
- * Installs a window object on the global, exposing properties directly on globalThis and globalthis.window
- * @param window - The Window object to install
- *
- * @beta
- */
-export function installWindowOnGlobal(window: Record) {
- if (globalThis.window === undefined) {
- Object.assign(globalThis, window);
- globalThis.window = globalThis as any;
- }
-}
diff --git a/packages/fast-ssr/src/element-controller.ts b/packages/fast-ssr/src/element-controller.ts
deleted file mode 100644
index b12dd9390ac..00000000000
--- a/packages/fast-ssr/src/element-controller.ts
+++ /dev/null
@@ -1,14 +0,0 @@
-import { ElementController } from "@microsoft/fast-element";
-
-export class SSRElementController extends ElementController {
- disconnect(): void {
- super.disconnect();
-
- // remove all behaviors to avoid memory leak
- if (this.behaviors !== null) {
- for (const [behavior] of this.behaviors) {
- this.removeBehavior(behavior, true);
- }
- }
- }
-}
diff --git a/packages/fast-ssr/src/element-renderer/element-renderer.spec.ts b/packages/fast-ssr/src/element-renderer/element-renderer.spec.ts
deleted file mode 100644
index 7bc92b5cfd0..00000000000
--- a/packages/fast-ssr/src/element-renderer/element-renderer.spec.ts
+++ /dev/null
@@ -1,551 +0,0 @@
-import "../install-dom-shim.js";
-
-import { deepStrictEqual, doesNotThrow, ok, strictEqual, throws } from "node:assert/strict";
-import { describe, test } from "node:test";
-import { attr, css, customElement, FASTElement, html, observable, when } from "@microsoft/fast-element";
-import { PendingTaskEvent } from "@microsoft/fast-element/pending-task.js";
-import { uniqueElementName } from "@microsoft/fast-element/testing.js";
-import fastSSR from "../exports.js";
-import { consolidate, consolidateAsync } from "../test-utilities/consolidate.js";
-import { SyncFASTElementRenderer } from "./fast-element-renderer.js";
-
-@customElement({
- name: "bare-element",
-})
-export class BareElement extends FASTElement {}
-@customElement({
- name: "styled-element",
- styles: css`:host { display: block; }${css`:host { color: red; }`}
- `
-})
-export class StyledElement extends FASTElement {}
-@customElement({
- name: "host-binding-element",
- template: html`
-
- `
-})
-export class HostBindingElement extends FASTElement {}
-
-describe("FallbackRenderer", () => {
- // Define custom element that is not a FAST elmeent.
- const name = uniqueElementName();
- customElements.define(name, class extends HTMLElement{});
- describe("rendering an element with attributes", () => {
- test("should not render the attribute when binding evaluates null", () => {
- const { templateRenderer } = fastSSR();
- const result = consolidate(templateRenderer.render(html`
- <${html.partial(name)} attr="${x => null}">
- `));
- strictEqual(result, `
- <${name} >
- `);
- });
-
- test("should not render the attribute when the binding evaluates undefined", () => {
- const { templateRenderer } = fastSSR();
- const result = consolidate(templateRenderer.render(html`
- <${html.partial(name)} attr="${x => undefined}">
- `));
- strictEqual(result, `
- <${name} >
- `);
- });
-
- test("should render a boolean attribute with the values of true or false", () => {
- const { templateRenderer } = fastSSR();
- const result = consolidate(templateRenderer.render(html`
- <${html.partial(name)} ?attr="${x => true}">
- <${html.partial(name)} ?attr="${x => false}">
- `));
- strictEqual(result, `
- <${name} attr>
- <${name} >
- `);
- });
-
- test("should render a non-boolean attribute with the values of true or false", () => {
- const { templateRenderer } = fastSSR();
- const result = consolidate(templateRenderer.render(html`
- <${html.partial(name)} aria-expanded="${x => true}">
- <${html.partial(name)} aria-expanded="${x => false}">
- `));
- strictEqual(result, `
- <${name} aria-expanded="true">
- <${name} aria-expanded="false">
- `);
- });
-
- test("should render an attribute with the value of a number", () => {
- const { templateRenderer } = fastSSR();
- const result = consolidate(templateRenderer.render(html`
- <${html.partial(name)} number="${x => 12}">
- <${html.partial(name)} number="${x => NaN}">
- `));
- strictEqual(result, `
- <${name} number="12">
- <${name} number="NaN">
- `);
- });
-
- test("should render an attribute with a string value", () => {
- const { templateRenderer } = fastSSR();
- const result = consolidate(templateRenderer.render(html`
- <${html.partial(name)} attr="${x => 'my-str-value'}">
- `));
- strictEqual(result, `
- <${name} attr="my-str-value">
- `);
- });
-
- test("should throw error when rendering an attribute with an object value", () => {
- const { templateRenderer } = fastSSR();
-
- throws(() => {
- consolidate(templateRenderer.render(html`<${html.partial(name)} attr="${x => ({ key: 'my-value' })}">`));
- })
- });
- });
-});
-
-describe("FASTElementRenderer", () => {
- describe("should have a 'matchesClass' method", () => {
- test("that returns true when invoked with a class that extends FASTElement ", () => {
- class MyElement extends FASTElement {}
- strictEqual(SyncFASTElementRenderer.matchesClass(MyElement, "", new Map()), true);
- });
- test("that returns false when invoked with a class that does not extend FASTElement ", () => {
- class MyElement extends HTMLElement {}
- strictEqual(SyncFASTElementRenderer.matchesClass(MyElement, "", new Map()), false);
- });
-
- test("should return false when the provided class has been disabled", () => {
- class MyElement extends FASTElement {}
- const { ElementRenderer } = fastSSR();
-
- ElementRenderer.disable(MyElement);
-
- strictEqual(ElementRenderer.matchesClass(MyElement, "", new Map()), false)
- });
- test("should return false when the provided tag-name has been disabled", () => {
- const name = uniqueElementName();
- class MyElement extends FASTElement {}
- const { ElementRenderer } = fastSSR();
-
- ElementRenderer.disable(name);
-
- strictEqual(ElementRenderer.matchesClass(MyElement, name, new Map()), false)
- });
- test("should return false when the provided element definition has been disabled", () => {
- const name = uniqueElementName();
- class MyElement extends FASTElement {}
- const definition = MyElement.compose(name);
- const { ElementRenderer } = fastSSR();
-
- ElementRenderer.disable(definition);
-
- strictEqual(ElementRenderer.matchesClass(MyElement, name, new Map()), false)
- });
- });
-
- describe("rendering stylesheets", () => {
- test(`should render stylesheets as 'style' elements by default`, () => {
- const { templateRenderer } = fastSSR();
- const result = consolidate(templateRenderer.render(html``
-{
- private parent: ElementRenderer | null = null;
- private restoreElementDispatchEvent: (() => void) | null = null;
- @observable
- abstract element?: HTMLElement;
- elementChanged() {
- this.restoreElementDispatchEvent?.();
- if (this.element) {
- const element = this.element;
- const dispatch = element.dispatchEvent;
- Reflect.defineProperty(element, "dispatchEvent", {
- value: (event: Event) => {
- let canceled = dispatch.call(element, event);
-
- if (shouldBubble(event)) {
- if (this.parent) {
- canceled = this.parent.dispatchEvent(event);
- } else if (element instanceof ShimHTMLElement) {
- // Only emit on document if the the element is the DOM shim's element.
- // Otherwise, the installed DOM should implement it's own behavior for bubbling
- // an event from an element to the document and window.
- canceled = document.dispatchEvent(event);
- }
- }
-
- return canceled;
- },
- });
- this.restoreElementDispatchEvent = () => {
- Reflect.defineProperty(element, "dispatchEvent", {
- value: dispatch,
- });
- this.restoreElementDispatchEvent = null;
- };
- }
- }
-
- /**
- * Should return true when the renderer should handle rendering for a custom element ctor or tag name.
- * @param ctor - the custom element class
- * @param tagName - the custom element tag name
- * @param attributes - the attribute map
- * @returns
- */
- static matchesClass(
- ctor: typeof HTMLElement,
- tagName: string,
- attributes: AttributesMap
- ): boolean {
- return false;
- }
-
- constructor(public readonly tagName: string, renderInfo?: RenderInfo) {
- this.parent = renderInfo?.customElementInstanceStack.at(-1) || null;
- }
-
- connectedCallback() {}
- disconnectedCallback() {
- this.restoreElementDispatchEvent?.();
- this.parent = null;
- delete this.element;
- }
- abstract attributeChangedCallback(
- name: string,
- prev: string | null,
- next: string | null
- ): void;
-
- public dispatchEvent(event: Event): boolean {
- return this.element?.dispatchEvent(event) || false;
- }
-
- /**
- * Sets a property for the element if it exists.
- */
- public setProperty(name: string, value: unknown) {
- if (this.element) {
- (this.element as any)[name] = value;
- }
- }
-
- /**
- * Sets an attribute for the element if it exists.
- */
- public setAttribute(name: string, value: string) {
- if (this.element) {
- const prev = this.element.getAttribute(name);
- if (value !== prev) {
- DOM.setAttribute(this.element, name, value);
- this.attributeChangedCallback(name, prev, value);
- }
- }
- }
-}
-
-export function renderAttribute(name: string, value: unknown, tagName?: string) {
- if (value === "" || value === undefined || value === null) {
- return ` ${name}`;
- } else if (typeof value === "string") {
- return ` ${name}="${escapeHtml(value)}"`;
- } else if (typeof value === "boolean" || typeof value === "number") {
- return ` ${name}="${value}"`;
- } else {
- throw new Error(`Cannot assign attribute '${name}' for element ${tagName}.`);
- }
-}
-
-/**
- * An ElementRenderer used as a fallback in the case where a custom element is
- * either unregistered or has no other matching renderer.
- */
-export class FallbackRenderer extends DefaultElementRenderer implements ElementRenderer {
- public element?: HTMLElement | undefined;
-
- /**
- * When true, instructs the ElementRenderer to yield the `defer-hydration` attribute for
- * rendered elements.
- */
- public deferHydration = false;
-
- private readonly _attributes: { [name: string]: string } = {};
-
- public setAttribute(name: string, value: string) {
- if (value === undefined || value === null) {
- this.removeAttribute(name);
- } else {
- this._attributes[name] = value;
- }
- }
-
- public removeAttribute(name: string) {
- delete this._attributes[name];
- }
-
- public *renderAttributes(): IterableIterator {
- if (this.deferHydration) {
- yield " defer-hydration";
- }
- for (const [name, value] of Object.entries(this._attributes)) {
- yield renderAttribute(name, value, this.element?.tagName);
- }
- }
-
- attributeChangedCallback() {}
- /* eslint-disable-next-line */
- *renderShadow() {}
-}
diff --git a/packages/fast-ssr/src/element-renderer/fast-element-renderer.ts b/packages/fast-ssr/src/element-renderer/fast-element-renderer.ts
deleted file mode 100644
index 84581fa3321..00000000000
--- a/packages/fast-ssr/src/element-renderer/fast-element-renderer.ts
+++ /dev/null
@@ -1,336 +0,0 @@
-import {
- DOM,
- DOMAspect,
- ExecutionContext,
- FASTElement,
- FASTElementDefinition,
- HostController,
- Observable,
- observable,
-} from "@microsoft/fast-element";
-import { PendingTaskEvent } from "@microsoft/fast-element/pending-task.js";
-import { RenderInfo } from "../render-info.js";
-import { StyleRenderer } from "../styles/style-renderer.js";
-import { FASTSSRStyleStrategy } from "../styles/style-strategy.js";
-import { DefaultTemplateRenderer } from "../template-renderer/template-renderer.js";
-import { SSRView } from "../view.js";
-import { DefaultElementRenderer, renderAttribute } from "./element-renderer.js";
-import { AsyncElementRenderer, AttributesMap, ElementRenderer } from "./interfaces.js";
-
-/**
- * Sinks to apply aspect operations to an element
- */
-const sinks: Record void> = {
- [DOMAspect.property]: (el: any, name: string, value: any) => {
- el[name] = value;
- },
- [DOMAspect.attribute]: DOM.setAttribute,
- [DOMAspect.booleanAttribute]: DOM.setBooleanAttribute,
-};
-
-/**
- * An {@link ElementRenderer} implementation designed to render components
- * built with FAST.
- *
- */
-abstract class FASTElementRenderer extends DefaultElementRenderer {
- /**
- * The element instance represented by the {@link FASTElementRenderer}.
- */
- public readonly element!: FASTElement;
-
- /**
- * The custom element constructor
- */
- public readonly ctor: CustomElementConstructor;
-
- /**
- * A function that decies if given tagName should defer hydration.
- * When true, instructs the ElementRenderer to yield the `defer-hydration` attribute for
- * rendered elements.
- */
- protected abstract deferHydration: (tagName: string) => boolean;
-
- protected needsHydration: boolean = false;
-
- /**
- * The template renderer to use when rendering a component template
- */
- @observable
- protected abstract templateRenderer: DefaultTemplateRenderer;
- templateRendererChanged() {
- if (this.templateRenderer) {
- this.needsHydration = this.templateRenderer.emitHydratableMarkup;
- }
- }
-
- /**
- * Responsible for rendering stylesheets
- */
- protected abstract styleRenderer: StyleRenderer;
-
- protected attributes: AttributesMap = new Map();
-
- public static matchesClass(
- ctor: typeof HTMLElement,
- tagName: string,
- attributes: AttributesMap
- ): boolean {
- return ctor.prototype instanceof FASTElement;
- }
-
- /**
- * Indicate to the {@link FASTElementRenderer} that the instance should execute DOM connection behavior.
- */
- public connectedCallback(): void {
- super.connectedCallback();
- Observable.getNotifier(this.element.$fastController).subscribe(
- this,
- "isConnected"
- );
-
- try {
- this.element.connectedCallback();
- } catch (e) {
- const { tryRecoverFromErrors } = this.templateRenderer;
- if (tryRecoverFromErrors) {
- this.disableTemplateRendering();
-
- if (typeof tryRecoverFromErrors === "function") {
- tryRecoverFromErrors(e);
- }
- } else {
- throw e;
- }
- }
- }
-
- public disconnectedCallback(): void {
- super.disconnectedCallback();
- Observable.getNotifier(this.element.$fastController).unsubscribe(
- this,
- "isConnected"
- );
- this.element.disconnectedCallback();
- }
-
- public handleChange(source: HostController, property: "isConnected") {
- if (this.element.$fastController.isConnected) {
- const view = this.element.$fastController.view;
-
- if (view && SSRView.isSSRView(view)) {
- if (view.hostStaticAttributes) {
- view.hostStaticAttributes.forEach((value, key) => {
- this.element.setAttribute(key, value);
- });
- }
-
- if (view.hostDynamicAttributes) {
- for (const attr of view.hostDynamicAttributes) {
- const aspect = attr.factory.aspectType;
- if (aspect in sinks && attr.factory.dataBinding) {
- sinks[aspect](
- this.element,
- attr.factory.targetAspect,
- attr.factory.dataBinding.evaluate(
- this.element,
- ExecutionContext.default
- )
- );
- }
- }
- }
- }
- }
- }
-
- /**
- * Disables the rendering of the component's template.
- */
- protected disableTemplateRendering() {
- this.renderShadow = noOpRenderShadow;
- this.yieldAttributes = yieldContextualAttributes;
- this.needsHydration = false;
- }
-
- /**
- * Indicate to the {@link FASTElementRenderer} that an attribute has been changed.
- * @param name - The name of the changed attribute
- * @param old - The old attribute value
- * @param value - The new attribute value
- */
- public attributeChangedCallback(
- name: string,
- old: string | null,
- value: string | null
- ): void {
- this.element.attributeChangedCallback(name, old, value);
- }
-
- public setAttribute(name: string, value: string): void {
- super.setAttribute(name, value);
- this.attributes.set(name, value);
- }
-
- /**
- * Constructs a new {@link FASTElementRenderer}.
- * @param tagName - the tag-name of the element to create.
- */
- constructor(tagName: string, renderInfo: RenderInfo) {
- super(tagName, renderInfo);
-
- const ctor = customElements.get(this.tagName);
-
- if (ctor) {
- this.ctor = ctor;
- this.element = new ctor() as FASTElement;
- (this.element as any).tagName = tagName;
- } else {
- throw new Error(
- `FASTElementRenderer was unable to find a constructor for a custom element with the tag name '${tagName}'.`
- );
- }
- }
-
- /**
- * Yield attributes assigned to the elmeent
- *
- */
- protected *yieldAttributes() {
- const { attributes } = this.element;
- for (
- let i = 0, name, value;
- i < attributes.length && ({ name, value } = attributes[i]);
- i++
- ) {
- yield renderAttribute(name, value, this.element.tagName);
- }
- }
-
- abstract renderShadow:
- | ((renderInfo: RenderInfo) => IterableIterator)
- | ((renderInfo: RenderInfo) => IterableIterator>);
-}
-
-export abstract class SyncFASTElementRenderer
- extends FASTElementRenderer
- implements ElementRenderer
-{
- renderAttributes = renderAttributesSync;
- renderShadow = renderShadow;
-}
-export abstract class AsyncFASTElementRenderer
- extends FASTElementRenderer
- implements AsyncElementRenderer
-{
- constructor(tagName: string, renderInfo: RenderInfo) {
- super(tagName, renderInfo);
-
- this.element.addEventListener(PendingTaskEvent.type, this.pendingTaskHandler);
- }
- public *renderAttributes(
- this: AsyncFASTElementRenderer
- ): IterableIterator> {
- if (this.element !== undefined) {
- if (this.awaiting.size) {
- yield this.pauseRendering()
- .then(() => "")
- .catch(reason => {
- throw reason;
- });
- }
-
- yield* renderAttributesSync.call(this);
- }
- }
- renderShadow = renderShadow;
-
- private async pauseRendering() {
- for (const awaiting of this.awaiting) {
- try {
- await awaiting;
- } catch (e) {
- const { tryRecoverFromErrors } = this.templateRenderer;
-
- if (tryRecoverFromErrors) {
- this.disableTemplateRendering();
-
- if (typeof tryRecoverFromErrors === "function") {
- tryRecoverFromErrors(e);
- }
- } else {
- throw e;
- }
- }
- }
-
- this.awaiting.clear();
- }
-
- private awaiting: Set> = new Set();
-
- private pendingTaskHandler = (e: Event) => {
- if (PendingTaskEvent.isPendingTask(e)) {
- this.awaiting.add(e.complete);
- }
- };
-}
-
-function* renderAttributesSync(this: FASTElementRenderer): IterableIterator {
- yield* this.yieldAttributes();
-
- if (this.deferHydration(this.tagName)) {
- yield " defer-hydration";
- }
-
- if (this.needsHydration) {
- yield " needs-hydration";
- }
-}
-
-function* renderShadow(
- this: FASTElementRenderer,
- renderInfo: RenderInfo
-): IterableIterator {
- const view = this.element.$fastController.view as unknown as SSRView;
- const styles = FASTSSRStyleStrategy.getStylesFor(this.element);
-
- const elementDefinition = FASTElementDefinition.getByType(this.ctor);
- const yieldDSD = elementDefinition?.shadowOptions !== undefined;
- const yieldBoundaryMarker =
- elementDefinition && elementDefinition.shadowOptions === undefined && view;
-
- if (yieldDSD) {
- yield '';
- } else if (yieldBoundaryMarker) {
- yield ``;
- }
-
- if (styles) {
- yield this.styleRenderer.render(styles);
- }
-
- if (view !== null) {
- yield* this.templateRenderer.renderOpCodes(
- (view as unknown as SSRView).codes,
- renderInfo,
- this.element,
- ExecutionContext.default
- );
- }
-
- if (yieldDSD) {
- yield "";
- } else if (yieldBoundaryMarker) {
- yield ``;
- }
-}
-
-// eslint-disable-next-line
-function* noOpRenderShadow() {}
-function* yieldContextualAttributes(this: FASTElementRenderer) {
- const { attributes } = this;
- for (const [key, value] of attributes) {
- yield renderAttribute(key, value, this.element.tagName);
- }
-}
diff --git a/packages/fast-ssr/src/element-renderer/interfaces.ts b/packages/fast-ssr/src/element-renderer/interfaces.ts
deleted file mode 100644
index 0b911127fae..00000000000
--- a/packages/fast-ssr/src/element-renderer/interfaces.ts
+++ /dev/null
@@ -1,70 +0,0 @@
-import { FASTElement, FASTElementDefinition } from "@microsoft/fast-element";
-import { RenderInfo } from "../render-info.js";
-
-/**
- * @beta
- */
-export interface ElementRenderer {
- readonly tagName: string;
- connectedCallback(): void;
- disconnectedCallback(): void;
- attributeChangedCallback(
- name: string,
- prev: string | null,
- next: string | null
- ): void;
- dispatchEvent(event: Event): boolean;
- setProperty(name: string, value: unknown): void;
- setAttribute(name: string, value: string): void;
- renderShadow(renderInfo: RenderInfo): IterableIterator;
- renderAttributes(): IterableIterator;
-}
-
-/**
- * @beta
- */
-export interface AsyncElementRenderer
- extends Omit {
- renderShadow(renderInfo: RenderInfo): IterableIterator>;
- renderAttributes(): IterableIterator>;
-}
-
-/**
- * @beta
- */
-export interface ConstructableElementRenderer<
- T extends ElementRenderer | AsyncElementRenderer = ElementRenderer
-> {
- new (tagName: string, renderInfo: RenderInfo): T;
-
- /**
- * Tests a constructor to determine if it should be managed by the ElementRenderer.
- * @param ctor - The constructor to test.
- */
- matchesClass(
- ctor: typeof HTMLElement,
- tagName: string,
- attributes: AttributesMap
- ): boolean;
-}
-
-/**
- * @beta
- */
-export interface ConstructableFASTElementRenderer<
- T extends ElementRenderer | AsyncElementRenderer = ElementRenderer
-> extends ConstructableElementRenderer {
- /**
- * Prevents this ElementRenderer from matching an element type.
- * @param elements - The elements to disable rendering for.
- *
- * @remarks
- * Elements can be disabled by tag-name, constructor, or FASTElementDefinition.
- */
- disable(...args: Array): void;
-}
-
-/**
- * @internal
- */
-export type AttributesMap = Map;
diff --git a/packages/fast-ssr/src/escape-html.ts b/packages/fast-ssr/src/escape-html.ts
deleted file mode 100644
index 8b1cb954714..00000000000
--- a/packages/fast-ssr/src/escape-html.ts
+++ /dev/null
@@ -1,21 +0,0 @@
-/**
- * This file was ported from {@link https://github.com/lit/lit/tree/main/packages/labs/ssr}.
- * Please see {@link ../ACKNOWLEDGEMENTS.md}
- */
-
-const replacements = {
- "&": "&",
- "<": "<",
- ">": ">",
- '"': """,
- // Note ' was not defined in the HTML4 spec, and is not supported by very
- // old browsers like IE8, so a codepoint entity is used instead.
- "'": "'",
-};
-
-/**
- * Replaces characters which have special meaning in HTML (&<>"') with escaped
- * HTML entities ("&", "<", etc.).
- */
-export const escapeHtml = (str: string) =>
- str.replace(/[&<>"']/g, char => replacements[char as keyof typeof replacements]);
diff --git a/packages/fast-ssr/src/event-utilities.ts b/packages/fast-ssr/src/event-utilities.ts
deleted file mode 100644
index 2719a0a5379..00000000000
--- a/packages/fast-ssr/src/event-utilities.ts
+++ /dev/null
@@ -1,3 +0,0 @@
-export function shouldBubble(event: Event) {
- return event.bubbles && !event.cancelBubble;
-}
diff --git a/packages/fast-ssr/src/exports.spec.ts b/packages/fast-ssr/src/exports.spec.ts
deleted file mode 100644
index e4c45cea7e2..00000000000
--- a/packages/fast-ssr/src/exports.spec.ts
+++ /dev/null
@@ -1,87 +0,0 @@
-import "./install-dom-shim.js";
-
-import { strictEqual } from "node:assert/strict";
-import { describe, test } from "node:test";
-import { FASTElement, html, HTMLDirective, ref, RefDirective, StatelessAttachedAttributeDirective, ViewController } from "@microsoft/fast-element";
-import { uniqueElementName } from "@microsoft/fast-element/testing.js";
-import fastSSR from "./exports.js";
-import { ViewBehaviorFactoryRenderer } from "./template-renderer/directives.js";
-import { consolidate } from "./test-utilities/consolidate.js";
-
-describe("fastSSR default export", () => {
- test("should return a TemplateRenderer configured to create a RenderInfo object using the returned ElementRenderer", () => {
- const { templateRenderer, ElementRenderer } = fastSSR();
- strictEqual(templateRenderer.createRenderInfo().elementRenderers.includes(ElementRenderer), true)
- })
-
- test("should render FAST elements without the `defer-hydration` attribute by default", () => {
- const { templateRenderer } = fastSSR();
- const name = uniqueElementName();
- FASTElement.define(name);
-
- strictEqual(consolidate(templateRenderer.render(`<${name}>`)),
- `<${name}>`
- );
- });
- test("should render FAST elements with the `defer-hydration` attribute when deferHydration is configured to be true", () => {
- const { templateRenderer } = fastSSR({ deferHydration: true });
- const name = uniqueElementName();
- FASTElement.define(name);
-
- strictEqual(consolidate(templateRenderer.render(`<${name}>`)),
- `<${name} defer-hydration>`
- )
- });
- test("should not render FAST elements with the `defer-hydration` attribute when deferHydration is configured to be false", () => {
- const { templateRenderer } = fastSSR({ deferHydration: false });
- const name = uniqueElementName();
- FASTElement.define(name);
-
- strictEqual(consolidate(templateRenderer.render(`<${name}>`)),
- `<${name}>`
- )
- });
-
- test("should render a custom directive using a registered ViewBehaviorFactoryRenderer", () => {
- class Directive extends StatelessAttachedAttributeDirective {
- bind(controller: ViewController) {}
- constructor(public readonly value: string) {
- super(value);
- }
- }
-
- HTMLDirective.define(Directive);
-
- const renderer: ViewBehaviorFactoryRenderer = {
- matcher: Directive,
- *render(behaviorFactory, renderInfo, source, renderer, context) {
- yield `value='${behaviorFactory.value}'`;
- },
- }
-
- const { templateRenderer } = fastSSR({viewBehaviorFactoryRenderers: [renderer]})
- strictEqual(consolidate(templateRenderer.render(html``)),
- ``
- )
- });
- test("should support overriding pre-registered ViewBehaviorFactoryRenderer", () => {
- class Directive extends StatelessAttachedAttributeDirective {
- bind(controller: ViewController) {}
- constructor(public readonly value: string) {
- super(value);
- }
- }
-
- const renderer: ViewBehaviorFactoryRenderer = {
- matcher: RefDirective,
- *render(behaviorFactory, renderInfo, source, renderer, context) {
- yield `ref='some-ref'`;
- },
- }
-
- const { templateRenderer } = fastSSR({viewBehaviorFactoryRenderers: [renderer]})
- strictEqual(consolidate(templateRenderer.render(html``)),
- ``
- )
- });
-});
diff --git a/packages/fast-ssr/src/exports.ts b/packages/fast-ssr/src/exports.ts
deleted file mode 100644
index 990a42d6740..00000000000
--- a/packages/fast-ssr/src/exports.ts
+++ /dev/null
@@ -1,207 +0,0 @@
-import { FASTElement, FASTElementDefinition } from "@microsoft/fast-element";
-import {
- AsyncFASTElementRenderer,
- SyncFASTElementRenderer,
-} from "./element-renderer/fast-element-renderer.js";
-import {
- AsyncElementRenderer,
- AttributesMap,
- ConstructableElementRenderer,
- ConstructableFASTElementRenderer,
- ElementRenderer,
-} from "./element-renderer/interfaces.js";
-import { RenderInfo } from "./render-info.js";
-import { StyleElementStyleRenderer, StyleRenderer } from "./styles/style-renderer.js";
-import {
- defaultViewBehaviorFactoryRenderers,
- ViewBehaviorFactoryRenderer,
-} from "./template-renderer/directives.js";
-import {
- AsyncTemplateRenderer,
- DefaultTemplateRenderer,
- TemplateRenderer,
-} from "./template-renderer/template-renderer.js";
-
-// Perform necessary configuration of FAST-Element library
-// for rendering in NodeJS
-import "./configure-fast-element.js";
-
-/**
- * Configuration for SSR factory.
- * @beta
- */
-export interface SSRConfiguration {
- /**
- * When 'async', configures the renderer to support async rendering.
- * 'async' rendering will yield 'string | Promise'
- *
- * Defaults to 'sync'.
- */
- renderMode?: "sync" | "async";
-
- /**
- * Configures the renderer to yield the `defer-hydration` attribute during element rendering.
- * Can be a boolean or a function that receives tagName and returns a boolean.
- * The `defer-hydration` attribute can be used to prevent immediate hydration of the element
- * by fast-element by importing hydration support in the client bundle.
- *
- * Defaults to `false`
- * @example
- *
- * ```ts
- * import "@microsoft/fast-element/install-element-hydration";
- * ```
- */
- deferHydration?: boolean | ((tagName: string) => boolean);
-
- /**
- * Configures the renderer to emit markup that allows fast-element to hydrate elements.
- *
- * Defaults to `false`
- */
- emitHydratableMarkup?: boolean;
-
- /**
- * Renderers for author-defined ViewBehaviorFactories.
- */
- viewBehaviorFactoryRenderers?: ViewBehaviorFactoryRenderer[];
-
- /**
- * When true or when a error handler is provided, the renderer will
- * attempt to recover from errors that occur at specific points,
- * during rendering, including:
- *
- * connectedCallback(): No declarative shadow-dom will be emitted for the element
- */
- tryRecoverFromError?: boolean | ((e: unknown) => void);
-
- /**
- * Optional custom style renderer instance, used to override StyleElementStyleRenderer
- */
- styleRenderer?: StyleRenderer;
-}
-
-/** @beta */
-function fastSSR(): {
- templateRenderer: TemplateRenderer;
- ElementRenderer: ConstructableFASTElementRenderer;
-};
-/** @beta */
-function fastSSR(config: Omit): {
- templateRenderer: TemplateRenderer;
- ElementRenderer: ConstructableFASTElementRenderer;
-};
-/** @beta */
-function fastSSR(config: SSRConfiguration & Record<"renderMode", "sync">): {
- templateRenderer: TemplateRenderer;
- ElementRenderer: ConstructableFASTElementRenderer;
-};
-/** @beta */
-function fastSSR(config: SSRConfiguration & Record<"renderMode", "async">): {
- templateRenderer: AsyncTemplateRenderer;
- ElementRenderer: ConstructableFASTElementRenderer;
-};
-
-/**
- * Factory for creating SSR rendering assets.
- * @example
- * ```ts
- * import "@microsoft/install-dom-shim";
- * import fastSSR from "@microsoft/fast-ssr";
- * import { html } from "@microsoft/fast-element";
- * const { templateRenderer } = fastSSR();
- *
- * const streamableSSRResult = templateRenderer.render(html`...`);
- * ```
- *
- * @beta
- */
-function fastSSR(config?: SSRConfiguration): any {
- const rConfig: Required = {
- renderMode: "sync",
- deferHydration: false,
- emitHydratableMarkup: false,
- tryRecoverFromError: false,
- ...config,
- } as Required;
- const templateRenderer = new DefaultTemplateRenderer();
- const deferHydration =
- typeof rConfig.deferHydration === "function"
- ? rConfig.deferHydration
- : () => !!rConfig?.deferHydration;
- templateRenderer.deferHydration = deferHydration;
- templateRenderer.emitHydratableMarkup = !!rConfig.emitHydratableMarkup;
- templateRenderer.tryRecoverFromErrors = rConfig.tryRecoverFromError;
-
- const elementRenderer = class extends (rConfig.renderMode !== "async"
- ? SyncFASTElementRenderer
- : AsyncFASTElementRenderer) {
- static #disabledConstructors = new Set();
-
- public static matchesClass(
- ctor: typeof HTMLElement,
- tagName: string,
- attributes: AttributesMap
- ): boolean {
- if (FASTElementDefinition.getByType(ctor) === undefined) {
- return false;
- }
-
- const disabled = elementRenderer.#disabledConstructors;
-
- return !(disabled.has(tagName) || disabled.has(ctor));
- }
-
- public static disable(
- ...elements: Array
- ) {
- for (const element of elements) {
- elementRenderer.#disabledConstructors.add(
- element instanceof FASTElementDefinition ? element.type : element
- );
- }
- }
- protected templateRenderer: DefaultTemplateRenderer = templateRenderer;
- protected styleRenderer =
- rConfig.styleRenderer || new StyleElementStyleRenderer();
- protected deferHydration = deferHydration;
- };
-
- templateRenderer.withDefaultElementRenderers(
- elementRenderer as unknown as ConstructableElementRenderer
- );
-
- // Configure out-of-box ViewBehaviorFactory renderers first
- templateRenderer.withViewBehaviorFactoryRenderers(
- ...defaultViewBehaviorFactoryRenderers
- );
-
- // Add any author-defined ViewBehaviorFactories. This order allows overriding
- // out-of-box renderers.
- if (Array.isArray(rConfig.viewBehaviorFactoryRenderers)) {
- templateRenderer.withViewBehaviorFactoryRenderers(
- ...rConfig.viewBehaviorFactoryRenderers
- );
- }
-
- return {
- templateRenderer,
- ElementRenderer: elementRenderer,
- };
-}
-
-export default fastSSR;
-export * from "./declarative-shadow-dom-polyfill.js";
-export * from "./request-storage.js";
-export { templateCacheController } from "./template-parser/template-parser.js";
-export type {
- ElementRenderer,
- AsyncElementRenderer,
- StyleRenderer,
- TemplateRenderer,
- AsyncTemplateRenderer,
- ViewBehaviorFactoryRenderer,
- RenderInfo,
- ConstructableElementRenderer,
- ConstructableFASTElementRenderer,
-};
diff --git a/packages/fast-ssr/src/fast-command-buffer/index.fixture.html b/packages/fast-ssr/src/fast-command-buffer/index.fixture.html
deleted file mode 100644
index fbfb1bcc383..00000000000
--- a/packages/fast-ssr/src/fast-command-buffer/index.fixture.html
+++ /dev/null
@@ -1,301 +0,0 @@
-
-
-
-
-
- - - - - diff --git a/packages/fast-ssr/src/fast-command-buffer/index.ts b/packages/fast-ssr/src/fast-command-buffer/index.ts deleted file mode 100644 index a44beeb69f1..00000000000 --- a/packages/fast-ssr/src/fast-command-buffer/index.ts +++ /dev/null @@ -1,149 +0,0 @@ -const FASTCommandBufferAttributeName: string = "data-fast-buffer-events"; - -interface CommandCache { - originalNode: HTMLElement; - event: Event; - attachedNode: HTMLElement | null; -} - -/** - * Component for recording user events on SSR rendered FAST components which have not yet hydrated and replaying those - * events when they have. - * During SSR an instance of the = this.templateRoot!.querySelectorAll(
- `[${FASTCommandBufferAttributeName}]`
- );
- elements.forEach((el: Element) => {
- const eventlist: string[] = el
- .getAttribute(FASTCommandBufferAttributeName)!
- .split(",");
- eventlist.forEach((ev: string) => {
- el.addEventListener(ev.trim(), this.recordEvent);
- });
- });
- }
-
- /**
- * Find all instances of elements with the FASTCommandBufferAttributeName attribute and remove the
- * recording event listeners for the specified events.
- */
- private removeEventRecorders() {
- const elements: NodeListOf = this.templateRoot!.querySelectorAll(
- `[${FASTCommandBufferAttributeName}]`
- );
- elements.forEach((el: Element) => {
- const eventlist: string[] = el
- .getAttribute(FASTCommandBufferAttributeName)!
- .split(",");
- eventlist.forEach(ev => {
- el.removeEventListener(ev.trim(), this.recordEvent);
- });
- });
- }
-}
-
-customElements.define("fast-command-buffer", FASTCommandBuffer);
-export { FASTCommandBuffer, FASTCommandBufferAttributeName };
diff --git a/packages/fast-ssr/src/install-dom-shim.ts b/packages/fast-ssr/src/install-dom-shim.ts
deleted file mode 100644
index 2ce958e992d..00000000000
--- a/packages/fast-ssr/src/install-dom-shim.ts
+++ /dev/null
@@ -1,3 +0,0 @@
-import { createWindow, installWindowOnGlobal } from "./dom-shim.js";
-
-installWindowOnGlobal(createWindow());
diff --git a/packages/fast-ssr/src/render-info.spec.ts b/packages/fast-ssr/src/render-info.spec.ts
deleted file mode 100644
index e315c80b050..00000000000
--- a/packages/fast-ssr/src/render-info.spec.ts
+++ /dev/null
@@ -1,65 +0,0 @@
-import "./install-dom-shim.js";
-import { strictEqual } from "node:assert/strict";
-import { describe, test } from "node:test";
-import { FallbackRenderer } from "./element-renderer/element-renderer.js";
-import { AttributesMap } from "./element-renderer/interfaces.js";
-import { DefaultRenderInfo } from "./render-info.js"
-
-describe("RenderInfo", () => {
- class TestRenderer extends FallbackRenderer {
- static matchesClass(ctor: { new(): HTMLElement; prototype: HTMLElement; }, tagName: string, attributes: AttributesMap): boolean {
- return true;
- }
- public connected = false;
-
- connectedCallback() {
- super.connectedCallback();
- this.connected = true;
- }
- disconnectedCallback() {
- super.disconnectedCallback();
- this.connected = false;
- }
- }
-
- describe("should have a 'dispose' method", () => {
- test("that calls the disconnectedCallback for all renderers in 'customElementInstanceStack'", () => {
- const renderInfo = new DefaultRenderInfo([TestRenderer]);
- const renderers = [new TestRenderer("test"), new TestRenderer("test"), new TestRenderer("test")]
- renderInfo.customElementInstanceStack.push(...renderers);
-
- renderers.forEach(x => {x.connectedCallback(); strictEqual(x.connected, true)})
-
- renderInfo.dispose();
-
- renderers.forEach(x => strictEqual(x.connected, false))
- });
- test("that calls the disconnectedCallback for all renderers in 'renderCustomElementList'", () => {
- const renderInfo = new DefaultRenderInfo([TestRenderer]);
- const renderers = [new TestRenderer("test"), new TestRenderer("test"), new TestRenderer("test")]
- renderInfo.renderedCustomElementList.push(...renderers);
-
- renderers.forEach(x => {x.connectedCallback(); strictEqual(x.connected, true)})
-
- renderInfo.dispose();
-
- renderers.forEach(x => strictEqual(x.connected, false))
- });
-
- test("that removes all renderers from 'renderCustomElementList' and 'customElementInstanceStack", () => {
- const renderInfo = new DefaultRenderInfo([TestRenderer]);
- const rendered = [new TestRenderer("test"), new TestRenderer("test"), new TestRenderer("test")];
- const instances = [new TestRenderer("test"), new TestRenderer("test"), new TestRenderer("test")];
- renderInfo.renderedCustomElementList.push(...rendered);
- renderInfo.customElementInstanceStack.push(...instances);
-
- strictEqual(renderInfo.renderedCustomElementList.length, 3);
- strictEqual(renderInfo.customElementInstanceStack.length, 3);
- renderInfo.dispose();
-
- strictEqual(renderInfo.renderedCustomElementList.length, 0);
- strictEqual(renderInfo.customElementInstanceStack.length, 0);
- });
-
- })
-});
diff --git a/packages/fast-ssr/src/render-info.ts b/packages/fast-ssr/src/render-info.ts
deleted file mode 100644
index cea31f1d130..00000000000
--- a/packages/fast-ssr/src/render-info.ts
+++ /dev/null
@@ -1,61 +0,0 @@
-/**
- * This file was ported from {@link https://github.com/lit/lit/tree/main/packages/labs/ssr}.
- * Please see {@link ../ACKNOWLEDGEMENTS.md}
- */
-import { Disposable } from "@microsoft/fast-element";
-import {
- ConstructableElementRenderer,
- ElementRenderer,
-} from "./element-renderer/interfaces.js";
-
-/**
- * @beta
- */
-export interface RenderInfo extends Disposable {
- /**
- * Element renderers to use
- */
- elementRenderers: ConstructableElementRenderer[];
-
- /**
- * Stack of open custom elements (in light dom or shadow dom)
- */
- customElementInstanceStack: ElementRenderer[];
-
- /**
- * Stack of open host custom elements (n-1 will be n's host)
- * @deprecated - use {@link (RenderInfo:interface).customElementInstanceStack}
- */
- customElementHostStack: ElementRenderer[];
-
- /**
- * A list of all Rendered custom elements.
- */
- renderedCustomElementList: ElementRenderer[];
-}
-
-/**
- * Default RenderInfo implementation
- *
- * @internal
- */
-export class DefaultRenderInfo implements RenderInfo {
- public customElementHostStack: ElementRenderer[] = [];
- public customElementInstanceStack: ElementRenderer[] = [];
- public renderedCustomElementList: ElementRenderer[] = [];
- constructor(public elementRenderers: ConstructableElementRenderer[] = []) {}
-
- public dispose(): void {
- for (const rendered of this.renderedCustomElementList) {
- rendered.disconnectedCallback();
- }
-
- for (let i = this.customElementInstanceStack.length - 1; i >= 0; i--) {
- this.customElementInstanceStack[i].disconnectedCallback();
- }
-
- // renderedCustomElementList was kept to cleanup custom elements after render; clear it after disconnect so it can be GC'd if needed
- this.renderedCustomElementList = [];
- this.customElementInstanceStack = [];
- }
-}
diff --git a/packages/fast-ssr/src/request-storage.spec.ts b/packages/fast-ssr/src/request-storage.spec.ts
deleted file mode 100644
index 5451d0a72e8..00000000000
--- a/packages/fast-ssr/src/request-storage.spec.ts
+++ /dev/null
@@ -1,237 +0,0 @@
-import "./install-dom-shim.js";
-import { deepStrictEqual, notStrictEqual, ok, strictEqual, throws } from "node:assert/strict";
-import { describe, test } from "node:test";
-import { createWindow } from "./dom-shim.js";
-import { RequestStorage, RequestStorageManager } from "./request-storage.js";
-
-const noStorageError = { message: "Storage must be accessed from within a request." };
-
-describe("RequestStorageManager", () => {
- test("can create basic backing storage", () => {
- const storage = RequestStorageManager.createStorage();
-
- ok(storage instanceof Map);
- notStrictEqual(storage.get("window"), undefined);
- });
-
- test("can create backing storage with a custom window", () => {
- const w = createWindow();
- const storage = RequestStorageManager.createStorage({
- createWindow: () => w,
- });
-
- ok(storage instanceof Map);
- strictEqual(storage.get("window"), w);
- });
-
- test("should pass in request object to createWindow middleware", () => {
- function createWindowShim(req: any) {
- return {
- id: req.headers["id"]
- };
- }
- const request = { headers: { id: "test" } };
- const storage = RequestStorageManager.createStorage({
- createWindow: createWindowShim,
- }, request);
-
- ok(storage instanceof Map);
- deepStrictEqual(storage.get("window"), {id: "test"});
- });
-
- test("can create backing storage with initial values", () => {
- const initialValues = new Map();
- initialValues.set("hello", "world");
-
- const storage = RequestStorageManager.createStorage({
- storage: initialValues,
- });
-
- ok(storage instanceof Map);
- strictEqual(storage.get("hello"), "world");
- });
-
- test("can run a callback with the provided storage", () => {
- const initialValues = new Map();
- initialValues.set("hello", "world");
-
- const storage = RequestStorageManager.createStorage({
- storage: initialValues,
- });
-
- let captured;
- RequestStorageManager.run(storage, () => {
- captured = RequestStorage.get("hello");
- });
-
- strictEqual(captured, "world");
- throws(() => RequestStorage.get("hello"), noStorageError);
- });
-
- test("can get value from global without being in a storage scope", () => {
- // window is part of perRequestGlobals setup by installDOMShim
- (window as any)["hello"] = "world";
- RequestStorageManager.installDOMShim();
-
- strictEqual((window as any)["hello"], "world");
- });
-
- test("can get different value from global in a storage scope", () => {
- // window is part of perRequestGlobals setup by installDOMShim
- (window as any)["hello"] = "world";
- RequestStorageManager.installDOMShim();
-
- let captured;
- const storage = RequestStorageManager.createStorage();
- RequestStorageManager.run(storage, () => {
- captured = (window as any)["hello"];
- });
-
- notStrictEqual(captured, "world");
- });
-
- test("uninstalling the DOM shim should make previously assigned globals available within callback ", () => {
- // window is part of perRequestGlobals setup by installDOMShim
- (window as any)["hello"] = "world";
- RequestStorageManager.installDOMShim();
- RequestStorageManager.uninstallDOMShim();
-
- let captured;
- const storage = RequestStorageManager.createStorage();
- RequestStorageManager.run(storage, () => {
- captured = (window as any)["hello"];
- });
-
- strictEqual(captured, "world");
- });
- test("invoking installDOMShim multiple times should not impact the ability to uninstall the shim with a single invocation of uninstall", () => {
- // window is part of perRequestGlobals setup by installDOMShim
- (window as any)["hello"] = "world";
- RequestStorageManager.installDOMShim();
- RequestStorageManager.installDOMShim();
- RequestStorageManager.installDOMShim();
- RequestStorageManager.uninstallDOMShim();
-
- let captured;
- const storage = RequestStorageManager.createStorage();
- RequestStorageManager.run(storage, () => {
- captured = (window as any)["hello"];
- });
-
- strictEqual(captured, "world");
- });
- test("invoking uninstall multiple times should not impact the ability to reinstall the shim with a single invocation of install", () => {
- // window is part of perRequestGlobals setup by installDOMShim
- (window as any)["hello"] = "world";
- RequestStorageManager.installDOMShim();
- RequestStorageManager.uninstallDOMShim();
- RequestStorageManager.uninstallDOMShim();
- RequestStorageManager.uninstallDOMShim();
- RequestStorageManager.installDOMShim();
-
- let captured;
- const storage = RequestStorageManager.createStorage();
- RequestStorageManager.run(storage, () => {
- captured = (window as any)["hello"];
- });
-
- notStrictEqual(captured, "world");
- });
-});
-
-describe("RequestStorage", () => {
- test("provides a DOM container", () => {
- const storage = RequestStorageManager.createStorage();
-
- let captured;
- RequestStorageManager.run(storage, () => {
- captured = RequestStorage.container;
- });
-
- notStrictEqual(captured, undefined);
- throws(() => RequestStorage.container, noStorageError);
- });
-
- test("can set and get values", () => {
- const storage = RequestStorageManager.createStorage();
-
- RequestStorageManager.run(storage, () => {
- RequestStorage.set("hello", "world");
- });
-
- let captured;
- RequestStorageManager.run(storage, () => {
- captured = RequestStorage.get("hello");
- });
-
- strictEqual(captured, "world");
- throws(() => RequestStorage.get("hello"), noStorageError);
- });
-
- test("can set and check values", () => {
- const storage = RequestStorageManager.createStorage();
-
- RequestStorageManager.run(storage, () => {
- RequestStorage.set("hello", "world");
- });
-
- let captured;
- RequestStorageManager.run(storage, () => {
- captured = RequestStorage.has("hello");
- });
-
- ok(captured);
- throws(() => RequestStorage.get("hello"), noStorageError);
- });
-
- test("can set and delete values", () => {
- const storage = RequestStorageManager.createStorage();
-
- RequestStorageManager.run(storage, () => {
- RequestStorage.set("hello", "world");
- });
-
- let captured;
- RequestStorageManager.run(storage, () => {
- captured = RequestStorage.has("hello");
- });
-
- ok(captured);
-
- RequestStorageManager.run(storage, () => {
- RequestStorage.delete("hello");
- });
-
- RequestStorageManager.run(storage, () => {
- captured = RequestStorage.has("hello");
- });
-
- ok(!captured);
- });
-
- test("can clear values", () => {
- const storage = RequestStorageManager.createStorage();
-
- RequestStorageManager.run(storage, () => {
- RequestStorage.set("hello", "world");
- RequestStorage.set("foo", "bar");
- });
-
- let captured;
- RequestStorageManager.run(storage, () => {
- captured = RequestStorage.has("hello") && RequestStorage.has("foo");
- });
-
- ok(captured);
-
- RequestStorageManager.run(storage, () => {
- RequestStorage.clear();
- });
-
- RequestStorageManager.run(storage, () => {
- captured = RequestStorage.has("hello") || RequestStorage.has("foo");
- });
-
- ok(!captured);
- });
-});
diff --git a/packages/fast-ssr/src/request-storage.ts b/packages/fast-ssr/src/request-storage.ts
deleted file mode 100644
index f21a1cf8fbf..00000000000
--- a/packages/fast-ssr/src/request-storage.ts
+++ /dev/null
@@ -1,300 +0,0 @@
-import { AsyncLocalStorage } from "async_hooks";
-import { DI, DOMContainer } from "@microsoft/fast-element/di.js";
-import { createWindow } from "./dom-shim.js";
-
-let asyncLocalStorage = new AsyncLocalStorage();
-const defaultOptions = {};
-
-function getStore() {
- const store = asyncLocalStorage.getStore();
-
- if (!store) {
- throw new Error("Storage must be accessed from within a request.");
- }
-
- return store as Map;
-}
-
-function getItem(key: any, fallback: () => T): T;
-function getItem(key: any): T | undefined;
-function getItem(key: any, fallback?: () => T): T | undefined {
- const store = getStore();
- let found = store.get(key);
-
- if (found === void 0 && fallback) {
- found = fallback();
- store.set(key, found);
- }
-
- return found;
-}
-
-/**
- * Get and set values that are local to the current
- * HTTP request.
- * @remarks
- * Also, provides access to a request-scoped DI container.
- * @beta
- */
-export const RequestStorage = Object.freeze({
- /**
- * The request-scoped DI container.
- */
- get container(): DOMContainer {
- return RequestStorage.get("$$container$$", () =>
- DI.getOrCreateDOMContainer(window)
- );
- },
-
- /**
- * Stores a value in request-scoped storage.
- * @param key - The key to store the value under.
- * @param value - The value to store.
- * @returns This RequestStorage instance.
- */
- set(key: any, value: any) {
- getStore().set(key, value);
- return this;
- },
-
- /**
- * Gets a value from request-scoped storage.
- * @param key - The key to get the value for.
- * @param fallback - A function that provides a value if there is nothing stored under the key.
- * @returns The value stored under the key.
- * @remarks
- * The return result of the fallback function will be stored under the key for later access.
- */
- get: getItem,
-
- /**
- * Clears all request-scoped values.
- */
- clear(): void {
- getStore().clear();
- },
-
- /**
- *
- * @param key - The request-scoped key to delete.
- * @returns true if the value was deleted; false otherwise.
- */
- delete(key: any): boolean {
- return getStore().delete(key);
- },
-
- /**
- * Determines whether there's a request-scoped value for the given key.
- * @param key - The key to check.
- * @returns true if the key exists; false otherwise
- */
- has(key: any): boolean {
- return getStore().has(key);
- },
-});
-
-/**
- * Options used in creating the backing storage for RequestStorage.
- * @beta
- */
-export type StorageOptions = {
- /**
- * A custom window creation function.
- */
- createWindow?: (req: any) => { [key: string]: unknown };
-
- /**
- * Initial values to setup in the backing store.
- */
- storage?: Map;
-};
-
-/**
- * An Express-compatible middleware function.
- * @beta
- */
-export type Middleware = (req: any, res: any, next: () => any) => void;
-
-const perRequestGlobals = [
- "dispatchEvent",
- "addEventListener",
- "removeEventListener",
- "window",
- "document",
- "location",
-];
-
-const perRequestGetters = perRequestGlobals.reduce((accum, key) => {
- accum[key] = function get() {
- // Return original global variable if currently not in the storage scope
- const store = asyncLocalStorage.getStore() as Map;
- return store ? store.get("window")[key] : preShimGlobals.get(key);
- };
- return accum;
-}, {} as Record unknown>);
-
-/**
- * Tests whether the {@link RequestStorageManager} has an installed
- * DOM shim for a provided key. Determination is performed by checking
- * the getter instance of the globalThis's property descriptor against the preRequestDescriptors
- * of the same key.
- * @param key - The key of the global check for installation
- */
-function shimIsInstalledFor(key: string): boolean {
- return (
- Object.getOwnPropertyDescriptor(globalThis, key)?.get === perRequestGetters[key]
- );
-}
-
-/**
- * Store the global objects being shimmed so that they be accessed as backup values
- * and restored during uninstall.
- */
-const preShimGlobals = new Map();
-const preShimDescriptors = new Map();
-
-/**
- * APIs used in configuring and managing RequestStorage.
- * @beta
- */
-export const RequestStorageManager = Object.freeze({
- /**
- * Gets the current AsyncLocalStorage instance that provides
- * the backend for the RequestStorageManager.
- */
- get backend(): AsyncLocalStorage {
- return asyncLocalStorage;
- },
-
- /**
- * Sets an AsyncLocalStorage instance to provide
- * a pre-existing backend for the RequestStorageManager.
- * @remarks
- * Replacing the default AsyncLocalStorage backend should not be
- * done under normal circumstances. This capability is intended for
- * advanced integration scenarios only.
- *
- * Avoid setting this property after middleware is installed or in the
- * middle of a RequestStorageManager#run operation. In the event that
- * this timing is necessary, then you must provide a window instance
- * available through the "window" key of your storage, otherwise the
- * necessary requirements for RequestStorage to function will not be met.
- */
- set backend(localStorage: AsyncLocalStorage) {
- asyncLocalStorage = localStorage;
- },
-
- /**
- * Installs a DOM shim that ensures that window, document,
- * and other globals are scoped per-request. Calling this function
- * will have no effect if the shim has already been installed.
- *
- * @throws TypeError when properties cannot be defined on the globalThis.
- */
- installDOMShim(): void {
- for (const key of perRequestGlobals) {
- if (!shimIsInstalledFor(key)) {
- const preShimValue = (globalThis as any)[key];
- preShimGlobals.set(key, (globalThis as any)[key]);
- const preShimDescriptor = Object.getOwnPropertyDescriptor(
- globalThis,
- key
- );
-
- // This will throw if the globalThis already contains a value for the key that is not configurable. Do this work
- // prior to caching value and descriptor so if it does throw, the caches aren't polluted
- Object.defineProperty(globalThis, key, {
- get: perRequestGetters[key],
- enumerable: true,
- configurable: true,
- });
-
- if (preShimDescriptor) {
- preShimDescriptors.set(key, preShimDescriptor);
- }
-
- preShimGlobals.set(key, preShimValue);
- }
- }
- },
-
- /**
- * Uninstalls the DOM shim installed by {@link RequestStorageManager.installDOMShim}.
- * Calling this function will have no effect if there is no shim installed.
- */
- uninstallDOMShim(): void {
- for (const key of perRequestGlobals) {
- if (shimIsInstalledFor(key)) {
- if (preShimDescriptors.has(key)) {
- Object.defineProperty(globalThis, key, preShimDescriptors.get(key)!);
- preShimDescriptors.delete(key);
- } else {
- delete (globalThis as any)[key];
- }
-
- preShimGlobals.delete(key);
- }
- }
- },
-
- /**
- * Installs the dependency injection system as the strategy for
- * handling Context requests. The installed behavior will use
- * RequestStorage.container as the root DI container.
- */
- installDIContextRequestStrategy(): void {
- DI.installAsContextRequestStrategy(() => RequestStorage.container);
- },
-
- /**
- * Creates a backing store for RequestStorage.
- * @param options - The options used when creating the backing store for RequestStorage.
- * @returns A Map suitable as a backing store for RequestStorage.
- */
- createStorage(
- options: StorageOptions = defaultOptions,
- req: any = null
- ): Map {
- const storage = new Map();
- const window = options.createWindow ? options.createWindow(req) : createWindow();
-
- storage.set("window", window);
-
- if (options.storage) {
- for (const [key, value] of options.storage) {
- storage.set(key, value);
- }
- }
-
- return storage;
- },
-
- /**
- * Runs a function with the provided storage available through RequestStorage.
- * @param storage - The storage to scope to the callback.
- * @param callback - The function to execute with the storage context.
- * @returns The result of the invoked function.
- */
- run(storage: Map, callback: () => T): T {
- return asyncLocalStorage.run(storage, callback);
- },
-
- /**
- * Creates an Express-compatible middleware function.
- * @param options - The options used when creating the backing store for RequestStorage.
- * @returns A middleware function.
- * @remarks
- * Invoking this function installs the RequestStorageManager DOM shim and then returns
- * an Express-compatible middleware function. The middleware ensures that a unique
- * storage instance is created for every request and that the following middleware
- * functions in the pipeline are processed in the context of this storage.
- */
- middleware(options: StorageOptions = defaultOptions): Middleware {
- RequestStorageManager.installDOMShim();
-
- return (req: any, res: any, next: () => any): void => {
- const storage = RequestStorageManager.createStorage(options, req);
- RequestStorageManager.run(storage, next);
- };
- },
-});
diff --git a/packages/fast-ssr/src/styles/fast-style-config.ts b/packages/fast-ssr/src/styles/fast-style-config.ts
deleted file mode 100644
index 6c4820d636e..00000000000
--- a/packages/fast-ssr/src/styles/fast-style-config.ts
+++ /dev/null
@@ -1 +0,0 @@
-export const fastStyleTagName = "fast-style";
diff --git a/packages/fast-ssr/src/styles/fast-style.fixture.html b/packages/fast-ssr/src/styles/fast-style.fixture.html
deleted file mode 100644
index a11fd944aab..00000000000
--- a/packages/fast-ssr/src/styles/fast-style.fixture.html
+++ /dev/null
@@ -1,416 +0,0 @@
-
-
-
-
-
-
-
- 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/packages/fast-ssr/src/styles/fast-style.pw.spec.ts b/packages/fast-ssr/src/styles/fast-style.pw.spec.ts
deleted file mode 100644
index 01db31c6630..00000000000
--- a/packages/fast-ssr/src/styles/fast-style.pw.spec.ts
+++ /dev/null
@@ -1,78 +0,0 @@
-import { expect, test } from "@playwright/test";
-
-test("Check that the first element has styles assigned", async ({ page }) => {
- test.slow();
- await page.goto("/fast-style");
-
- const cards = page.locator("fast-card");
- const styles = await cards.evaluateAll(cardList => {
- return cardList.map(card => {
- return window
- .getComputedStyle(card, null)
- .getPropertyValue("background-color");
- });
- });
-
- expect(styles[0]).toEqual("rgb(26, 26, 26)");
-});
-test("Check that the nested element in the first element has styles assigned", async ({
- page,
-}) => {
- test.slow();
- await page.goto("/fast-style");
-
- const cards = page.locator("fast-card");
- const styles = await cards.evaluateAll(cardList => {
- return cardList.map(card => {
- return window
- .getComputedStyle(
- card.shadowRoot?.querySelector("fast-button") as Element,
- null
- )
- .getPropertyValue("background-color");
- });
- });
-
- expect(styles[0]).toEqual("rgb(43, 43, 43)");
-});
-test("Check that all elements have styles assigned", async ({ page }) => {
- test.slow();
- await page.goto("/fast-style");
-
- const cards = page.locator("fast-card");
- const styles = await cards.evaluateAll(cardList => {
- return cardList.map(card => {
- return window
- .getComputedStyle(card, null)
- .getPropertyValue("background-color");
- });
- });
-
- expect(styles).toHaveLength(10);
-
- styles.forEach(style => {
- expect(style).toEqual("rgb(26, 26, 26)");
- });
-});
-test("Check that all nested elements have styles assigned", async ({ page }) => {
- test.slow();
- await page.goto("/fast-style");
-
- const cards = page.locator("fast-card");
- const styles = await cards.evaluateAll(cardList => {
- return cardList.map(card => {
- return window
- .getComputedStyle(
- card.shadowRoot?.querySelector("fast-button") as Element,
- null
- )
- .getPropertyValue("background-color");
- });
- });
-
- expect(styles).toHaveLength(10);
-
- styles.forEach(style => {
- expect(style).toEqual("rgb(43, 43, 43)");
- });
-});
diff --git a/packages/fast-ssr/src/styles/fast-style.ts b/packages/fast-ssr/src/styles/fast-style.ts
deleted file mode 100644
index ba1020e5de5..00000000000
--- a/packages/fast-ssr/src/styles/fast-style.ts
+++ /dev/null
@@ -1,81 +0,0 @@
-import { fastStyleTagName } from "./fast-style-config.js";
-
-interface StyleCache {
- [key: string]: CSSStyleSheet | string;
-}
-
-/**
- * The FASTStyle web component that takes attributes:
- * - css - a string version of the CSS to be applied to the parent web component, this can be omitted if the style-id has been used in the DOM as the cached value will be fetched
- * - style-id - a dataset attribute used as an identifier for the CSS attr string
- */
-export default class FASTStyle extends HTMLElement {
- private static cache: StyleCache = {};
- private static hashIdDataSetName: string = "style-id";
- private static supportsAdoptedStyleSheets: boolean =
- Array.isArray((document as any).adoptedStyleSheets) &&
- "replace" in CSSStyleSheet.prototype;
-
- /**
- * @internal
- */
- public connectedCallback(): void {
- const hashId: string = this.getAttribute(FASTStyle.hashIdDataSetName) as string;
- const css: string = this.getAttribute("css") as string;
- this.registerStyles(hashId, css);
- }
-
- /**
- * Register styles if they are not part of the cache and attach them
- */
- private registerStyles = (hashId: string, css: string): void => {
- if (FASTStyle.supportsAdoptedStyleSheets) {
- if (!(hashId in FASTStyle.cache)) {
- this.memoizeAdoptedStylesheetStyles(hashId, css);
- }
- this.attachAdoptedStylesheetStyles(this.parentNode as ShadowRoot, hashId);
- } else {
- if (!(hashId in FASTStyle.cache)) {
- this.memoizeStyleElementStyles(hashId, css);
- }
- this.attachStyleElementStyles(this.parentNode as ShadowRoot, hashId);
- }
- };
-
- /**
- * Memoize CSSStyleSheets
- */
- private memoizeAdoptedStylesheetStyles(hashId: string, css: string) {
- const sheet = new CSSStyleSheet();
- (sheet as any).replaceSync(css);
- FASTStyle.cache[hashId] = sheet;
- }
-
- /**
- * Attach CSSStyleSheets
- */
- private attachAdoptedStylesheetStyles(shadowRoot: ShadowRoot, hashId: string) {
- (shadowRoot as any).adoptedStyleSheets = [
- ...(shadowRoot as any).adoptedStyleSheets!,
- FASTStyle.cache[hashId] as CSSStyleSheet,
- ];
- }
-
- /**
- * Memoize css strings
- */
- private memoizeStyleElementStyles(hashId: string, css: string) {
- FASTStyle.cache[hashId] = css;
- }
-
- /**
- * Attach style elements
- */
- private attachStyleElementStyles(shadowRoot: ShadowRoot, hashId: string) {
- const element = document.createElement("style");
- element.innerHTML = FASTStyle.cache[hashId] as string;
- shadowRoot.append(element);
- }
-}
-
-customElements.define(fastStyleTagName, FASTStyle);
diff --git a/packages/fast-ssr/src/styles/style-renderer.spec.ts b/packages/fast-ssr/src/styles/style-renderer.spec.ts
deleted file mode 100644
index d762f5ccbe1..00000000000
--- a/packages/fast-ssr/src/styles/style-renderer.spec.ts
+++ /dev/null
@@ -1,74 +0,0 @@
-import "../install-dom-shim.js";
-import { notStrictEqual, strictEqual } from "node:assert/strict";
-import { describe, test, afterEach } from "node:test";
-import "./fast-style.js";
-import { css } from "@microsoft/fast-element";
-import { FASTStyleStyleRenderer } from "./style-renderer.js";
-
-const cssSheetRegex = /css="?(.+)"/m;
-function getSheet(element: string): string | null {
- const result = cssSheetRegex.exec(element);
-
- if (result === null) {
- return null
- } else {
- return result[1];
- }
-}
-
-describe("FASTStyleStyleRenderer", () => {
- const styleCache = new Set();
-
- afterEach(() => {
- styleCache.clear();
- });
-
- test("should return a ' element", () => {
- const style = css``;
- styleCache.add(style);
- const renderer = new FASTStyleStyleRenderer();
- const tester = /<\/fast-style>/;
- notStrictEqual(tester.test(renderer.render(styleCache)), null);
- });
- test("should return a ' element without a 'css' attribute when the sheet has already been rendered", () => {
- const renderer = new FASTStyleStyleRenderer();
- const style = css``;
- styleCache.add(style);
- const firstResult = renderer.render(styleCache);
- strictEqual(cssSheetRegex.test(firstResult), true);
-
- const secondResult = renderer.render(styleCache);
-
- notStrictEqual(firstResult, secondResult);
- strictEqual(cssSheetRegex.test(secondResult), false);
- });
-
- test("should emit the sheet content into the 'css' attribute the first time a sheet instance is rendered", () => {
- const renderer = new FASTStyleStyleRenderer();
- const style = css`:host{ color: red; }`;
- styleCache.add(style);
-
- const result = renderer.render(styleCache);
-
- strictEqual(getSheet(result), `:host{ color: red; }`);
- });
-
- test("should emit the sheet content for embedded ElementStyle instances", () => {
- const renderer = new FASTStyleStyleRenderer();
- const style = css`:host{ color: red; } ${css`:host { background: blue; }`}`;
- styleCache.add(style);
- const result = renderer.render(styleCache);
-
- strictEqual(getSheet(result), ':host{ color: red; } :host { background: blue; }');
- });
-
-
- test("should emit the sheet content for embedded strings", () => {
- const renderer = new FASTStyleStyleRenderer();
- const style = css`:host{ color: red; } ${`:host { background: blue; }`}`;
- styleCache.add(style);
- const result = renderer.render(styleCache);
-
- strictEqual(getSheet(result), `:host{ color: red; } :host { background: blue; }`);
- });
-});
diff --git a/packages/fast-ssr/src/styles/style-renderer.ts b/packages/fast-ssr/src/styles/style-renderer.ts
deleted file mode 100644
index ecf8bf6f4df..00000000000
--- a/packages/fast-ssr/src/styles/style-renderer.ts
+++ /dev/null
@@ -1,73 +0,0 @@
-import { ComposableStyles } from "@microsoft/fast-element";
-import { fastStyleTagName } from "./fast-style-config.js";
-function collectStyles(style: ComposableStyles): string {
- let content: string = "";
- if (typeof style === "string") {
- content = style;
- } else if (style instanceof CSSStyleSheet) {
- const rules = style.cssRules;
-
- for (let i = 0, length = rules.length; i < length; i++) {
- content += rules[i].cssText;
- }
- } else {
- for (const s of style.styles) {
- content += collectStyles(s);
- }
- }
-
- return content;
-}
-
-/**
- * A renderer for {@link @microsoft/fast-element#ComposableStyles}
- * @beta
- */
-export interface StyleRenderer {
- /**
- * Renders composable styles to a string.
- * @param styles - The styles to render.
- */
- render(styles: Set): string;
-}
-
-export class FASTStyleStyleRenderer implements StyleRenderer {
- private static stylesheetCache = new Map();
- private static nextId = (() => {
- let id = 0;
- const prefix = "fast-style";
- return () => `${prefix}-${id++}`;
- })();
-
- public render(styles: Set): string {
- let markup = "";
-
- styles.forEach(style => {
- let id = FASTStyleStyleRenderer.stylesheetCache.get(style);
- const content = id === undefined ? collectStyles(style) : null;
- let contentAttr = "";
-
- if (content !== null) {
- id = FASTStyleStyleRenderer.nextId();
- FASTStyleStyleRenderer.stylesheetCache.set(style, id);
- contentAttr = `css="${content}"`;
- }
-
- markup += `<${fastStyleTagName} style-id="${id}" ${contentAttr}>`;
- });
-
- return markup;
- }
-}
-
-export class StyleElementStyleRenderer implements StyleRenderer {
- public render(styles: Set): string {
- let styleTags = "";
-
- styles.forEach(style => {
- styleTags += ``;
- });
-
- return styleTags;
- }
-}
diff --git a/packages/fast-ssr/src/styles/style-strategy.ts b/packages/fast-ssr/src/styles/style-strategy.ts
deleted file mode 100644
index 8e5aba4bc9c..00000000000
--- a/packages/fast-ssr/src/styles/style-strategy.ts
+++ /dev/null
@@ -1,35 +0,0 @@
-import { StyleStrategy, StyleTarget } from "@microsoft/fast-element";
-
-const sheetsForTarget = new WeakMap>();
-
-function getOrCreateFor(target: StyleTarget): Set {
- let set = sheetsForTarget.get(target);
- if (set) {
- return set;
- }
-
- set = new Set();
- sheetsForTarget.set(target, set);
-
- return set;
-}
-
-export class FASTSSRStyleStrategy implements StyleStrategy {
- addStylesTo(target: StyleTarget) {
- const cache = getOrCreateFor(target);
-
- this.styles.forEach(style => cache?.add(style));
- }
-
- removeStylesFrom(target: StyleTarget) {
- const cache = getOrCreateFor(target);
-
- this.styles.forEach(style => cache?.delete(style));
- }
-
- constructor(private styles: (string | CSSStyleSheet)[]) {}
-
- public static getStylesFor(target: Element): Set | null {
- return sheetsForTarget.get(target) || null;
- }
-}
diff --git a/packages/fast-ssr/src/template-cache/controller.spec.ts b/packages/fast-ssr/src/template-cache/controller.spec.ts
deleted file mode 100644
index 839b6039235..00000000000
--- a/packages/fast-ssr/src/template-cache/controller.spec.ts
+++ /dev/null
@@ -1,44 +0,0 @@
-import "../install-dom-shim.js";
-import { strictEqual } from "node:assert/strict";
-import { describe, test, after, beforeEach } from "node:test";
-import { html, ViewTemplate } from "@microsoft/fast-element";
-import fastSSR, { templateCacheController } from "../exports.js";
-import { consolidate } from "../test-utilities/consolidate.js";
-
-
-
-test("should be enabled by default", () => {
- strictEqual(templateCacheController.disabled, false)
-});
-describe("TemplateCacheController", () => {
- let template: ViewTemplate;
- beforeEach(() => {
- templateCacheController.enable();
- template = html``;
- });
- after(() => {
- templateCacheController.enable();
- });
-
- test("should support being disabled and re-enabled", () => {
- templateCacheController.disable();
- strictEqual(templateCacheController.disabled, true);
- templateCacheController.enable();
- strictEqual(templateCacheController.disabled, false)
- });
-
- test("should cache template results after rendering a template", () => {
- const { templateRenderer } = fastSSR();
- strictEqual(templateCacheController.has(template), false);
- consolidate(templateRenderer.render(template));
- strictEqual(templateCacheController.has(template), true);
- });
-
- test("should not cache template when disabled", () => {
- templateCacheController.disable();
- const { templateRenderer } = fastSSR();
- consolidate(templateRenderer.render(template));
-
- strictEqual(templateCacheController.has(template), false);
- });
-});
diff --git a/packages/fast-ssr/src/template-cache/controller.ts b/packages/fast-ssr/src/template-cache/controller.ts
deleted file mode 100644
index 6075fff1815..00000000000
--- a/packages/fast-ssr/src/template-cache/controller.ts
+++ /dev/null
@@ -1,53 +0,0 @@
-import { ViewTemplate } from "@microsoft/fast-element";
-
-export interface TemplateCacheController {
- /**
- * True when fast-ssr is not caching template results,
- * false when it is leveraging the cache.
- *
- * @default true;
- */
- readonly disabled: boolean;
-
- /**
- * Disables template caching and retrieval of template cache results from the cache.
- */
- disable(): void;
-
- /**
- * Enables template caching.
- */
- enable(): void;
-
- /**
- * Returns true when a provided template has been cached, otherwise false
- */
- has(template: ViewTemplate): boolean;
-}
-
-export class TemplateCacheControllerImpl implements TemplateCacheController {
- constructor(private cache: Pick, "get" | "has" | "set">) {}
- #disabled = false;
-
- public get disabled() {
- return this.#disabled;
- }
-
- public disable(): void {
- this.#disabled = true;
- }
-
- public enable(): void {
- this.#disabled = false;
- }
-
- public has(template: ViewTemplate): boolean {
- return this.cache.has(template);
- }
-
- public static create(
- ...cache: ConstructorParameters
- ): TemplateCacheController {
- return new TemplateCacheControllerImpl(...cache);
- }
-}
diff --git a/packages/fast-ssr/src/template-parser/id-generator.ts b/packages/fast-ssr/src/template-parser/id-generator.ts
deleted file mode 100644
index efb24595b71..00000000000
--- a/packages/fast-ssr/src/template-parser/id-generator.ts
+++ /dev/null
@@ -1,55 +0,0 @@
-const chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz".split("");
-
-/**
- * Gets a random char from {@link chars}
- */
-function getRandomChar() {
- return chars[Math.floor(Math.random() * (chars.length - 1))];
-}
-
-function getId(length: number): string {
- let str = "";
- for (let i = 0; i < length; i++) {
- str += getRandomChar();
- }
-
- return str;
-}
-
-const usedIds = new Set();
-// When id-associated object is garbage-collected,
-// delete the id from usedIds, allowing re-use.
-const gcHandler = new FinalizationRegistry((value: string) => {
- usedIds.delete(value);
-});
-
-/**
- * Generates an ID string. The ID is not guaranteed to be unique.
- * @param length - the number of characters in the id string.
- * @returns
- */
-export const IDManager = Object.freeze({
- /**
- * Returns a unique ID to associate to a specific object reference.
- * This manager does not store any references to the provided object,
- * so calling this more than once for an object will generate multiple
- * ids for the object.
- *
- * @param source - The object to associate the unique id.
- * @param length - The character length of the id string.
- * @returns the ID string.
- */
- getFor(source: T, length = 10): string {
- let str;
-
- // Generate a new ID until there is no collision
- do {
- str = getId(length);
- } while (usedIds.has(str));
-
- usedIds.add(str);
- gcHandler.register(source, str);
-
- return str;
- },
-});
diff --git a/packages/fast-ssr/src/template-parser/op-codes.ts b/packages/fast-ssr/src/template-parser/op-codes.ts
deleted file mode 100644
index eab7670c71a..00000000000
--- a/packages/fast-ssr/src/template-parser/op-codes.ts
+++ /dev/null
@@ -1,147 +0,0 @@
-import { Aspected, ViewBehaviorFactory, ViewTemplate } from "@microsoft/fast-element";
-import { IDManager } from "./id-generator.js";
-
-/**
- * Allows fast identification of operation types
- */
-export const enum OpType {
- customElementOpen,
- customElementClose,
- customElementAttributes,
- customElementShadow,
- attributeBinding,
- attributeBindingMarker,
- viewBehaviorFactory,
- templateElementOpen,
- templateElementClose,
- text,
-}
-
-/**
- * Operation to emit static text
- */
-export type TextOp = {
- type: OpType.text;
- value: string;
-};
-
-export type AttributeBindingMarkerOp = {
- type: OpType.attributeBindingMarker;
- indexes: number[];
-};
-
-/**
- * Operation to open a custom element
- */
-export type CustomElementOpenOp = {
- type: OpType.customElementOpen;
- /**
- * The tagname of the custom element
- */
- tagName: string;
-
- /**
- * The constructor of the custom element
- */
- ctor?: typeof HTMLElement;
-
- /**
- * Attributes of the custom element, non-inclusive of any attributes
- * that are the product of bindings
- */
- staticAttributes: Map;
-};
-
-/**
- * Operation to close a custom element
- */
-export type CustomElementCloseOp = {
- type: OpType.customElementClose;
-};
-
-export type CustomElementShadowOp = {
- type: OpType.customElementShadow;
-};
-
-/**
- * Operation to emit a ViewBehaviorFactory
- */
-export type ViewBehaviorFactoryOp = {
- type: OpType.viewBehaviorFactory;
- factory: ViewBehaviorFactory;
-
- /**
- * The index of the factory in the collection of ViewBehaviorFactories
- * in a template.
- */
- index: number;
-};
-
-/**
- * Operation to emit a bound attribute
- */
-export type AttributeBindingOp = {
- type: OpType.attributeBinding;
- factory: ViewBehaviorFactory & Aspected;
- useCustomElementInstance: boolean;
-
- /**
- * The indexes of the bindings in the collection of ViewBehaviorFactories.
- */
- index: number;
-};
-
-/**
- * Operation to emit a template element open tag
- */
-export type TemplateElementOpenOp = {
- type: OpType.templateElementOpen;
- staticAttributes: Map;
- // We need dynamic attributes here so we can emit the ``
- // from one operation
- dynamicAttributes: AttributeBindingOp[];
-};
-
-/**
- * Operation to emit a template element closing tag
- */
-export type TemplateElementCloseOp = {
- type: OpType.templateElementClose;
-};
-
-/**
- * Operation to emit to custom-element attributes
- */
-export type CustomElementAttributes = {
- type: OpType.customElementAttributes;
-};
-
-export type Op =
- | AttributeBindingOp
- | AttributeBindingMarkerOp
- | CustomElementOpenOp
- | CustomElementCloseOp
- | ViewBehaviorFactoryOp
- | CustomElementAttributes
- | CustomElementShadowOp
- | TemplateElementOpenOp
- | TemplateElementCloseOp
- | TextOp;
-
-export class OpCodes extends Array {
- private static readonly cache: WeakMap = new WeakMap();
- public readonly id = IDManager.getFor(this);
- public hydrationIndexOffset = 0;
-
- static get(key: ViewTemplate) {
- return OpCodes.cache.get(key);
- }
-
- static set(key: ViewTemplate, value: OpCodes) {
- return OpCodes.cache.set(key, value);
- }
-
- static has(key: ViewTemplate) {
- return OpCodes.cache.has(key);
- }
-}
diff --git a/packages/fast-ssr/src/template-parser/template-parser.spec.ts b/packages/fast-ssr/src/template-parser/template-parser.spec.ts
deleted file mode 100644
index d7c3e9ffe96..00000000000
--- a/packages/fast-ssr/src/template-parser/template-parser.spec.ts
+++ /dev/null
@@ -1,216 +0,0 @@
-import "../install-dom-shim.js";
-
-import { deepStrictEqual, doesNotThrow, notStrictEqual, strictEqual, throws } from "node:assert/strict";
-import { describe, test } from "node:test";
-import { customElement, DOMAspect, FASTElement, html, ViewBehaviorFactory, ViewTemplate } from "@microsoft/fast-element";
-import { AttributeBindingOp, CustomElementOpenOp, OpCodes, OpType, TemplateElementOpenOp, TextOp, ViewBehaviorFactoryOp } from "./op-codes.js";
-import { customElementNameExcludeList, parseStringToOpCodes, parseTemplateToOpCodes } from "./template-parser.js";
-
-@customElement("hello-world")
-class HelloWorld extends FASTElement {}
-
-function firstFactory(factories: Record) {
- for (const key in factories) {
- return factories[key];
- }
-
- return null;
-}
-
-describe("parseTemplateToOpCodes", () => {
- test("should throw when invoked with a ViewTemplate with a HTMLTemplateElement template", () => {
- throws(() => {
- parseTemplateToOpCodes(new ViewTemplate(document.createElement("template"), {}));
- });
- });
- test("should not throw when invoked with a ViewTemplate with a string template", () => {
- doesNotThrow(() => {
- parseTemplateToOpCodes(new ViewTemplate("", {}));
- });
- });
-
- test("should emit a single text op for a template with no bindings or directives", () => {
- const codes = parseTemplateToOpCodes(html`"},
- { type: OpType.customElementShadow },
- { type: OpType.customElementClose },
- { type: OpType.text, value: " "}
- ]);
- })
-
- test("should emit custom element open, close, attribute, and shadow ops for a defined custom element", () => {
- const input = html`"},
- {type: OpType.customElementShadow},
- {type: OpType.customElementClose},
- {type: OpType.text, value: ""}
- ])
- });
-
- describe("should emit text op for ", () => {
- customElementNameExcludeList.forEach((name) => {
- test(`${name} in customElementExclude list`, () => {
- const codes = parseTemplateToOpCodes(html`<${html.partial(name)}>`);
- strictEqual(codes.length, 1);
- strictEqual(codes[0].type, OpType.text);
- strictEqual((codes[0] as TextOp).value, `<${name}>`)
- });
- })
- });
- test("should emit static attributes of a custom element custom element open, close, attribute, and shadow ops for a defined custom element", () => {
- const input = html`,
-
- /**
- * Adjust behavior when parsing a template used
- * as a custom element's template
- */
- forCustomElement = false
-): OpCodes {
- const nodeTree = (forCustomElement ? parseFragment : parse)(templateString, {
- sourceCodeLocationInfo: true,
- });
-
- let factoryIndex = 0;
-
- if (!isDefaultTreeParentNode(nodeTree)) {
- // I'm not sure when exactly this is encountered but the type system seems to say it's possible.
- throw new Error(`Error parsing template`);
- }
-
- // TypeScript gets confused about what 'nodeTree' is.
- // Creating a new var clears that up.
- let tree = nodeTree as DefaultTreeParentNode;
-
- /**
- * Tracks the offset location in the source template string where the last
- * flushing / skip took place.
- */
- let lastOffset: number | undefined = 0;
-
- let finalOffset: number = templateString.length;
-
- /**
- * Collection of op codes
- */
- const opCodes = new OpCodes();
-
- let hostBindingTarget: null | DefaultTreeElement = null;
- let hydrationIndexOffset = 0;
-
- /**
- * Parses an Element node, pushing all op codes for the element into
- * the collection of ops for the template
- * @param node - The element node to parse
- */
- function parseElementNode(node: DefaultTreeElement): void {
- // Track whether the opening tag of an element should be augmented.
- // All constructable custom elements will need to be augmented,
- // as well as any element with attribute bindings
- let augmentOpeningTag = false;
- const { tagName } = node;
- const ctor: typeof HTMLElement | undefined = customElements.get(tagName);
- const isCustomElement =
- tagName.includes("-") && !customElementNameExcludeList.includes(tagName);
- node.isCustomElement = isCustomElement;
-
- // Sort attributes by whether they're related to a binding or if they have
- // static value
- const attributes: {
- static: Map;
- dynamic: Map;
- } = node.attrs.reduce(
- (prev, current) => {
- const parsed = Parser.parse(current.value, factories);
- if (parsed) {
- const factory = Compiler.aggregate(parsed) as ViewBehaviorFactory &
- Aspected;
- prev.dynamic.set(current, {
- type: OpType.attributeBinding,
- factory: factory,
- useCustomElementInstance: isCustomElement,
- index: factoryIndex++,
- });
- } else {
- prev.static.set(current.name, current.value);
-
- // FAST's client-side compile step adds factories for all
- // host attributes, even if there is no data-binding. Increment
- // the factoryIndex to account for that behavior
- if (hostBindingTarget === node) {
- factoryIndex++;
- }
- }
-
- return prev;
- },
- {
- static: new Map(),
- dynamic: new Map(),
- }
- );
-
- // Emit a CustomElementOpenOp when the custom element is defined
- if (isCustomElement) {
- augmentOpeningTag = true;
- opCodes.push({
- type: OpType.customElementOpen,
- tagName,
- ctor,
- staticAttributes: attributes.static,
- });
- } else if (node.tagName === "template") {
- // Template elements need special handling due to the host directive behavior
- // when used as the root element in a custom element template
- // (https://www.fast.design/docs/fast-element/using-directives#host-directives).
- flushTo(node.sourceCodeLocation?.startTag.startOffset);
- opCodes.push({
- type: OpType.templateElementOpen,
- staticAttributes: attributes.static,
- dynamicAttributes: Array.from(attributes.dynamic.values()),
- });
- skipTo(node.sourceCodeLocation!.startTag.endOffset);
- if (node === hostBindingTarget) {
- hydrationIndexOffset = factoryIndex;
- }
- return;
- }
-
- // Iterate attributes in-order so that codes can be pushed for dynamic attributes in-order.
- // All dynamic attributes will be rendered from an AttributeBindingOp. Additionally, When the
- // node is a custom element, all static attributes will be rendered via the CustomElementOpenOp,
- // so this code skips over static attributes in that case.
-
- for (const attr of node.attrs) {
- if (attributes.dynamic.has(attr)) {
- const location = node.sourceCodeLocation!.attrs[attr.name];
- const code = attributes.dynamic.get(attr)!;
- flushTo(location.startOffset);
- augmentOpeningTag = true;
- opCodes.push(code);
- skipTo(location.endOffset);
- } else if (isCustomElement) {
- const location = node.sourceCodeLocation!.attrs[attr.name];
- flushTo(location.startOffset);
- skipTo(location.endOffset);
- }
- }
-
- if (augmentOpeningTag && node.tagName !== "template") {
- flushTo(node.sourceCodeLocation!.startTag.endOffset - 1);
- if (attributes.dynamic.size > 0) {
- opCodes.push({
- type: OpType.attributeBindingMarker,
- indexes: Array.from(attributes.dynamic.values()).map(
- attr => attr.index
- ),
- });
- }
-
- if (isCustomElement) {
- opCodes.push({ type: OpType.customElementAttributes });
- flush(">");
- skipTo(node.sourceCodeLocation!.startTag.endOffset);
- } else {
- flushTo(node.sourceCodeLocation!.startTag.endOffset);
- }
- }
-
- if (isCustomElement) {
- opCodes.push({ type: OpType.customElementShadow });
- }
- }
-
- /**
- * Flushes a string value to op codes
- * @param value - The value to flush
- */
- function flush(value: string): void {
- const last = opCodes[opCodes.length - 1];
- if (last?.type === OpType.text) {
- last.value += value;
- } else {
- opCodes.push({ type: OpType.text, value });
- }
- }
-
- /**
- * Flush template content from lastIndex to provided offset
- * @param offset - the offset to flush to
- */
- function flushTo(offset: number = finalOffset) {
- if (lastOffset === undefined) {
- throw new Error(
- `Cannot flush template content from a last offset that is ${typeof lastOffset}.`
- );
- }
-
- const prev = lastOffset;
- lastOffset = offset;
- const value = templateString.substring(prev, offset);
-
- if (value !== "") {
- flush(value);
- }
- }
-
- function skipTo(offset: number) {
- if (lastOffset === undefined) {
- throw new Error("Could not skip from an undefined offset");
- }
- if (offset < lastOffset) {
- throw new Error(`offset must be greater than lastOffset.
- offset: ${offset}
- lastOffset: ${lastOffset}
- `);
- }
-
- lastOffset = offset;
- }
-
- /**
- * FAST leverages any element that is a firstElementChild
- * of the template as a binding target for any directives on the
- * . This block implements that behavior.
- */
- if (forCustomElement) {
- const fec = firstElementChild(tree);
-
- if (fec !== null && fec.tagName === "template") {
- tree = fec as DefaultTreeParentNode;
- hostBindingTarget = fec;
- const location = fec.sourceCodeLocation!;
- finalOffset = location.endTag.endOffset;
- lastOffset = location.startTag.startOffset;
- }
- }
-
- traverse(tree, {
- visit(node: DefaultTreeNode): void {
- if (isCommentNode(node) || isTextNode(node)) {
- const parsed = Parser.parse(
- (node as DefaultTreeCommentNode)?.data ||
- (node as DefaultTreeTextNode).value,
- factories
- );
-
- if (parsed) {
- flushTo(node.sourceCodeLocation!.startOffset);
- for (const part of parsed) {
- if (typeof part === "string") {
- flush(part);
- } else {
- // There are cases where aspects are mis-assigned during template pre-compilation
- // that are patched-up during by the complier prior to rendering client-side. Sometimes,
- // that mis-assignment causes content bindings to be aspected as attribute bindings.
- // If a text node has bindings, the aspect should always be content, so ensure the
- // aspect is assigned accordingly
- if (isTextNode(node)) {
- HTMLDirective.assignAspect(
- part as ViewBehaviorFactory & Aspected
- );
- }
-
- opCodes.push({
- type: OpType.viewBehaviorFactory,
- factory: part,
- index: factoryIndex++,
- });
- }
- }
- skipTo(node.sourceCodeLocation!.endOffset);
- }
- } else if (isElementNode(node)) {
- parseElementNode(node);
- }
- },
-
- leave(node: DefaultTreeNode): void {
- if (isElementNode(node)) {
- if (node.isCustomElement) {
- opCodes.push({ type: OpType.customElementClose });
- } else if (node.tagName === "template") {
- flushTo(node.sourceCodeLocation?.endTag.startOffset);
- opCodes.push({ type: OpType.templateElementClose });
- skipTo(node.sourceCodeLocation!.endTag.endOffset);
- }
- }
- },
- });
-
- // Flush the remaining string content before returning op codes.
- flushTo();
- opCodes.hydrationIndexOffset = hydrationIndexOffset;
-
- return opCodes;
-}
diff --git a/packages/fast-ssr/src/template-renderer/directives.spec.ts b/packages/fast-ssr/src/template-renderer/directives.spec.ts
deleted file mode 100644
index c176161539e..00000000000
--- a/packages/fast-ssr/src/template-renderer/directives.spec.ts
+++ /dev/null
@@ -1,41 +0,0 @@
-import "../install-dom-shim.js";
-import { strictEqual } from "node:assert/strict";
-import { describe, test } from "node:test";
-import { ExecutionContext, HTMLBindingDirective, oneWay } from "@microsoft/fast-element";
-import { consolidate } from "../test-utilities/consolidate.js";
-import { HTMLBindingDirectiveRenderer } from "./directives.js";
-import { DefaultTemplateRenderer } from "./template-renderer.js";
-
-
-describe("HTMLBindingDirective Renderer", () => {
- test("should yield numbers returned from the binding as a string", () => {
- const binding = oneWay(() => 12);
- const directive = new HTMLBindingDirective(binding);
- const templateRenderer = new DefaultTemplateRenderer();
-
- const result = HTMLBindingDirectiveRenderer.render(
- directive,
- templateRenderer.createRenderInfo(),
- {},
- templateRenderer,
- ExecutionContext.default
- );
-
- strictEqual(consolidate(result), "12")
- });
- test("should yield booleans returned from the binding as a string", () => {
- const binding = oneWay(() => true);
- const directive = new HTMLBindingDirective(binding);
- const templateRenderer = new DefaultTemplateRenderer();
-
- const result = HTMLBindingDirectiveRenderer.render(
- directive,
- templateRenderer.createRenderInfo(),
- {},
- templateRenderer,
- ExecutionContext.default
- );
-
- strictEqual(consolidate(result), "true")
- });
-});
diff --git a/packages/fast-ssr/src/template-renderer/directives.ts b/packages/fast-ssr/src/template-renderer/directives.ts
deleted file mode 100644
index bc374f7c558..00000000000
--- a/packages/fast-ssr/src/template-renderer/directives.ts
+++ /dev/null
@@ -1,204 +0,0 @@
-import { HydrationMarkup } from "@microsoft/fast-element/element-hydration.js";
-import {
- ChildrenDirective,
- Constructable,
- DOMAspect,
- ExecutionContext,
- HTMLBindingDirective,
- RefDirective,
- RenderDirective,
- RepeatDirective,
- SlottedDirective,
- ViewBehaviorFactory,
- ViewTemplate,
-} from "@microsoft/fast-element";
-import { escapeHtml } from "../escape-html.js";
-import { RenderInfo } from "../render-info.js";
-import { DefaultTemplateRenderer } from "./template-renderer.js";
-
-/**
- * Describes an implementation that can render a directive.
- *
- * @beta
- */
-export interface ViewBehaviorFactoryRenderer {
- /**
- * Renders a ViewBehaviorFactory
- * @param behaviorFactory - The ViewBehaviorFactory instance to render
- * @param renderInfo - The current RenderInfo context
- * @param source - Source data
- * @param renderer - The TemplateRenderer
- * @param context - The ExecutionContext
- */
- render(
- behaviorFactory: T,
- renderInfo: RenderInfo,
- source: any,
- renderer: DefaultTemplateRenderer,
- context: ExecutionContext
- ): IterableIterator;
-
- /**
- * The behavior constructor to use this renderer for.
- */
- matcher: Constructable;
-}
-
-export const RepeatDirectiveRenderer: ViewBehaviorFactoryRenderer =
- Object.freeze({
- matcher: RepeatDirective,
- *render(
- directive: RepeatDirective,
- renderInfo: RenderInfo,
- source: any,
- renderer: DefaultTemplateRenderer,
- context: ExecutionContext
- ): IterableIterator {
- const items = directive.dataBinding.evaluate(source, context);
- const template = directive.templateBinding.evaluate(source, context);
- const childContext = Object.create(context, {
- parent: { value: source },
- parentContext: { value: context },
- });
-
- const updateChildContext = directive.options.positioning
- ? (index: number, length: number) => {
- childContext.index = index;
- childContext.length = length;
- }
- : noop;
-
- if (template instanceof ViewTemplate) {
- for (let i = 0, length = items.length; i < length; i++) {
- updateChildContext(i, length);
-
- if (renderer.shouldEmitHydrationMarkup(renderInfo)) {
- yield ``;
- }
-
- yield* renderer.render(template, renderInfo, items[i], childContext);
-
- if (renderer.shouldEmitHydrationMarkup(renderInfo)) {
- yield ``;
- }
- }
- } else {
- throw new Error("Unable to render Repeat Directive template");
- }
- },
- });
-
-export const RenderDirectiveRenderer: ViewBehaviorFactoryRenderer =
- Object.freeze({
- matcher: RenderDirective,
- *render(
- directive: RenderDirective,
- renderInfo: RenderInfo,
- source: any,
- renderer: DefaultTemplateRenderer,
- context: ExecutionContext
- ): IterableIterator {
- const data = directive.dataBinding.evaluate(source, context);
- const template = directive.templateBinding.evaluate(source, context);
- const childContext = Object.create(context, {
- parent: { value: source },
- parentContext: { value: context },
- });
-
- if (template instanceof ViewTemplate) {
- yield* renderer.render(template, renderInfo, data, childContext);
- } else {
- throw new Error("Unable to render Render Directive template");
- }
- },
- });
-
-function* noop() {
- yield "";
-}
-
-export const ChildrenDirectiveRenderer: ViewBehaviorFactoryRenderer =
- Object.freeze({
- matcher: ChildrenDirective,
- render: noop,
- });
-
-export const RefDirectiveRenderer: ViewBehaviorFactoryRenderer =
- Object.freeze({
- matcher: RefDirective,
- render: noop,
- });
-
-export const SlottedDirectiveRenderer: ViewBehaviorFactoryRenderer =
- Object.freeze({
- matcher: SlottedDirective,
- render: noop,
- });
-
-export const HTMLBindingDirectiveRenderer: ViewBehaviorFactoryRenderer =
- Object.freeze({
- matcher: HTMLBindingDirective,
- *render(
- directive: HTMLBindingDirective,
- renderInfo: RenderInfo,
- source: any,
- renderer: DefaultTemplateRenderer,
- context: ExecutionContext
- ): IterableIterator {
- if (directive.aspectType === DOMAspect.event) {
- return;
- }
-
- const result = directive.dataBinding.evaluate(source, context);
-
- switch (directive.aspectType) {
- case DOMAspect.attribute:
- if (result !== null && result !== undefined) {
- yield `${directive.targetAspect}="${
- typeof result === "string" ? escapeHtml(result) : result
- }"`;
- }
-
- break;
- case DOMAspect.booleanAttribute:
- if (result) {
- yield directive.targetAspect;
- }
- break;
- case DOMAspect.property:
- // Intentional fall-through
- case DOMAspect.tokenList: {
- const { targetAspect } = directive;
- if (targetAspect === "classList" || targetAspect === "className") {
- yield `class="${result}"`;
- }
- break;
- }
- case DOMAspect.content:
- {
- if (result instanceof ViewTemplate) {
- yield* renderer.render(result, renderInfo, source, context);
- } else if (result === null || result === undefined) {
- yield "";
- } else if (typeof result === "string") {
- yield result;
- } else if (
- typeof result === "number" ||
- typeof result === "boolean"
- ) {
- yield `${result}`;
- }
- }
- break;
- }
- },
- });
-
-export const defaultViewBehaviorFactoryRenderers: ViewBehaviorFactoryRenderer[] = [
- ChildrenDirectiveRenderer,
- HTMLBindingDirectiveRenderer,
- RefDirectiveRenderer,
- RenderDirectiveRenderer,
- RepeatDirectiveRenderer,
- SlottedDirectiveRenderer,
-];
diff --git a/packages/fast-ssr/src/template-renderer/hydration-marker-emitter.ts b/packages/fast-ssr/src/template-renderer/hydration-marker-emitter.ts
deleted file mode 100644
index 5c15f6a6261..00000000000
--- a/packages/fast-ssr/src/template-renderer/hydration-marker-emitter.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-import { HydrationMarkup } from "@microsoft/fast-element/element-hydration.js";
-
-export const hydrationMarker = Object.freeze({
- contentBindingStart(index: number, uniqueId: string) {
- return ``;
- },
- contentBindingEnd(index: number, uniqueId: string) {
- return ``;
- },
- attribute(indexes: number[]) {
- return `${HydrationMarkup.attributeMarkerName}="${indexes.join(
- HydrationMarkup.attributeBindingSeparator
- )}"`;
- },
-});
diff --git a/packages/fast-ssr/src/template-renderer/template-renderer.spec.ts b/packages/fast-ssr/src/template-renderer/template-renderer.spec.ts
deleted file mode 100644
index 1c7573febbc..00000000000
--- a/packages/fast-ssr/src/template-renderer/template-renderer.spec.ts
+++ /dev/null
@@ -1,887 +0,0 @@
-import "../install-dom-shim.js";
-
-import "../configure-fast-element.js";
-
-import { children, css, customElement, ExecutionContext, FASTElement, HostBehavior, html, ref, render, repeat, slotted, when } from "@microsoft/fast-element";
-import { HydrationMarkup } from "@microsoft/fast-element/element-hydration.js";
-import { PendingTaskEvent } from "@microsoft/fast-element/pending-task.js";
-import { uniqueElementName } from "@microsoft/fast-element/testing.js";
-import { deepStrictEqual, doesNotThrow, notStrictEqual, ok, strictEqual } from "node:assert/strict";
-import { describe, test } from "node:test";
-import { DefaultElementRenderer, FallbackRenderer } from "../element-renderer/element-renderer.js";
-import { escapeHtml } from "../escape-html.js";
-import fastSSR from "../exports.js";
-import { RenderInfo } from "../render-info.js";
-import { consolidate, consolidateAsync } from "../test-utilities/consolidate.js";
-import { validateRendererOutput } from "../test-utilities/validators.js";
-import { SSRView } from "../view.js";
-import { hydrationMarker } from "./hydration-marker-emitter.js";
-import { DefaultTemplateRenderer } from "./template-renderer.js";
-
-@customElement("hello-world")
-class HelloWorld extends FASTElement {}
-
-@customElement({name: "with-slot", template: html` {}
- public *renderShadow(renderInfo: RenderInfo): IterableIterator {}
- }
-
- renderer.withDefaultElementRenderers(MyRenderer);
- strictEqual(renderer.createRenderInfo().elementRenderers.includes(MyRenderer), true);
- });
- })
-
- describe("rendering elements", () => {
- test("should render a template element without attributes", () => {
- const { templateRenderer } = fastSSR();
- const result = templateRenderer.render(html``)
-
- strictEqual(consolidate(result), "");
- });
- test("should render a template element with static attributes", () => {
- const { templateRenderer } = fastSSR();
- const result = templateRenderer.render(html``)
-
- strictEqual(consolidate(result), ``);
- });
- test("should render a template element with dynamic attributes", () => {
- const { templateRenderer } = fastSSR();
- const result = templateRenderer.render(html` "bar"} id=${x => "bat"}>`)
-
- strictEqual(consolidate(result), ``);
- });
- test("should render a template element with a boolean attribute binding", () => {
- const { templateRenderer } = fastSSR();
- const result = templateRenderer.render(html` true} ?false=${x => false}>`)
-
- strictEqual(consolidate(result), ``);
- });
- test("should render a template element with a classList property binding", () => {
- const { templateRenderer } = fastSSR();
- const result = templateRenderer.render(html` "a b"}>`)
-
- strictEqual(consolidate(result), ``);
- });
-
- test("should render a template element with both static and dynamic attributes", () => {
- const { templateRenderer } = fastSSR();
- const result = templateRenderer.render(html` "foo"}>`)
-
- strictEqual(consolidate(result), ``);
- });
- test("should render with static attributes preceding dynamic attributes", () => {
- // Attribute order changes are due to attribute categorization during template parsing.
- const { templateRenderer } = fastSSR();
- const result = templateRenderer.render(html` "foo"} id="bar">`)
-
- strictEqual(consolidate(result), ``);
- });
- test("should escape dynamic string attributes", () => {
- const { templateRenderer } = fastSSR();
- const attrValue = JSON.stringify({"dangerousScript": ""})
-
- const result = templateRenderer.render(html``)
-
- strictEqual(consolidate(result), ``);
- })
- test("should render a template with content", () => {
- const { templateRenderer } = fastSSR();
- const result = templateRenderer.render(html`value `);
- });
- });
- describe("rendering a FAST element configured with a null shadowOptions config", () => {
- test("should not render declarative shadow DOM", () => {
- const name = uniqueElementName();
- @customElement({
- name,
- shadowOptions: null
- })
- class MyElement extends FASTElement {}
-
- const { templateRenderer } = fastSSR();
- const result = templateRenderer.render(html`<${html.partial(name)}>`);
-
- strictEqual(consolidate(result), `<${name}>`);
- });
-
- test("should not render element boundary markers when element is not defined", () => {
- const name = uniqueElementName();
-
- const { templateRenderer } = fastSSR();
- const result = templateRenderer.render(html`<${html.partial(name)}>`);
-
- strictEqual(consolidate(result), `<${name}>`);
- });
-
- test("should render it's template inside element boundary markers to the light DOM", () => {
- const name = uniqueElementName();
- const template = "Hello world `)
-
- strictEqual(consolidate(result), "Hello world ");
- });
-
- test("should not render the template for elements that have been disabled via the ElementRenderer", () => {
- const name = uniqueElementName();
- class MyElement extends FASTElement {}
- const definition = MyElement.compose({name, template: html` "foobar"}> `)
-
- strictEqual(consolidate(result), ` "foo bar"}> `))
- strictEqual(result, ``${repeat(x => x.data, html`${(x, c) => {
- strictEqual(c.parent, source);
- strictEqual(c.parentContext, ctx)
- }}`)}`, templateRenderer.createRenderInfo(), source, ctx))
- });
- test("should provide positioning information when invoked with the positioning config", () => {
-
- const { templateRenderer } = fastSSR();
- const source = {
- data: ["foo", "bar", "bat"]
- };
- let i = 0;
- consolidate(templateRenderer.render(html`${repeat(x => x.data, html`${(x, c) => {
- strictEqual(c.index, i);
- i++;
- strictEqual(c.length, c.parent.data.length)
- }}`, { positioning: true})}`, templateRenderer.createRenderInfo(), source))
- });
- test("should render the provided template with the instance as the source data", () => {
- const { templateRenderer } = fastSSR();
- const source = {
- data: ["foo", "bar", "bat"]
- };
- const result = templateRenderer.render(html`${repeat(x => x.data, html`${x => x}`)}`, templateRenderer.createRenderInfo(), source)
- strictEqual(consolidate( result ), "foobarbat");
- });
- });
-
- describe("with a 'render' directive", () => {
- test("should provide parent and parentContext to execution context of bindings in child template", () => {
-
- const { templateRenderer } = fastSSR();
- const source = { data: "test" };
- const ctx = ExecutionContext.default;
- consolidate(templateRenderer.render(html`${render(x => x.data, html`${(x, c) => {
- strictEqual(c.parent, source);
- strictEqual(c.parentContext, ctx)
- }}`)}`, templateRenderer.createRenderInfo(), source, ctx))
- });
-
- test("should render the provided template with the binding's value as the source data", () => {
- const { templateRenderer } = fastSSR();
- const source = { data: "test"};
- const result = templateRenderer.render(html`${render(x => x.data, html`${x => x}`)}`, templateRenderer.createRenderInfo(), source)
- strictEqual(consolidate( result ), "test");
- });
- });
-
- for (const directive of [children, ref, slotted ]) {
- describe(`with '${directive.name}' directive`, () => {
- test("should interpolate empty string", () => {
- const { templateRenderer } = fastSSR();
- const source = {}
- const result = templateRenderer.render(html` {
- throw new Error()
- }
- this.dispatchEvent(new PendingTaskEvent(throwErr()))
- }
- } ).define({name});
- const { templateRenderer } = fastSSR({tryRecoverFromError: true, renderMode: "async"});
-
- let result: string = "";
- const template = `<${name}>`;
- result = await consolidateAsync(templateRenderer.render(template));
- strictEqual(result, template);
- });
- test("should not emit host binding attributes after handling error", () => {
- const name = uniqueElementName();
- (class extends FASTElement {
- connectedCallback(): void {
- super.connectedCallback();
- throw new Error();
- }
- } ).define({name, template: html` {
- throw new Error()
- }
- this.dispatchEvent(new PendingTaskEvent(throwErr()))
- }
- } ).define({name});
- let err: any;
- const handler = (reason: unknown) => {
- err = reason;
- }
- const { templateRenderer } = fastSSR({tryRecoverFromError: handler, renderMode: "async"});
-
- const template = `<${name}>`;
- await consolidateAsync(templateRenderer.render(template));
- strictEqual(err instanceof Error, true);
- });
- });
-});
diff --git a/packages/fast-ssr/src/template-renderer/template-renderer.ts b/packages/fast-ssr/src/template-renderer/template-renderer.ts
deleted file mode 100644
index 3694b6a8969..00000000000
--- a/packages/fast-ssr/src/template-renderer/template-renderer.ts
+++ /dev/null
@@ -1,379 +0,0 @@
-import { EventEmitter } from "node:events";
-import {
- Aspected,
- DOMAspect,
- ExecutionContext,
- ViewBehaviorFactory,
- ViewTemplate,
-} from "@microsoft/fast-element";
-import { DefaultRenderInfo, RenderInfo } from "../render-info.js";
-import {
- AsyncElementRenderer,
- AttributesMap,
- ConstructableElementRenderer,
- ElementRenderer,
-} from "../element-renderer/interfaces.js";
-import { FallbackRenderer } from "../element-renderer/element-renderer.js";
-import { OpCodes, OpType } from "../template-parser/op-codes.js";
-import {
- parseStringToOpCodes,
- parseTemplateToOpCodes,
-} from "../template-parser/template-parser.js";
-import {
- HTMLBindingDirectiveRenderer,
- ViewBehaviorFactoryRenderer,
-} from "./directives.js";
-import { hydrationMarker } from "./hydration-marker-emitter.js";
-
-function getLast(arr: T[]): T | undefined {
- return arr[arr.length - 1];
-}
-
-/** @beta */
-export interface TemplateRenderer extends EventEmitter {
- render(
- template: ViewTemplate | string,
- renderInfo?: RenderInfo,
- source?: unknown,
- context?: ExecutionContext
- ): IterableIterator;
- createRenderInfo(): RenderInfo;
- withDefaultElementRenderers(...renderers: ConstructableElementRenderer[]): void;
- readonly emitHydratableMarkup: boolean;
-}
-
-/** @beta */
-export interface AsyncTemplateRenderer extends EventEmitter {
- render(
- template: ViewTemplate | string,
- renderInfo?: RenderInfo,
- source?: unknown,
- context?: ExecutionContext
- ): IterableIterator>;
- createRenderInfo(): RenderInfo;
- withDefaultElementRenderers(
- ...renderers: ConstructableElementRenderer[]
- ): void;
- readonly emitHydratableMarkup: boolean;
-}
-
-/**
- * A class designed to render HTML templates. The renderer supports
- * rendering {@link @microsoft/fast-element#ViewTemplate} instances as well
- * as arbitrary HTML strings.
- *
- * @internal
- */
-export class DefaultTemplateRenderer extends EventEmitter implements TemplateRenderer {
- private viewBehaviorFactoryRenderers: Map> =
- new Map();
-
- private defaultElementRenderers: ConstructableElementRenderer[] = [];
- public emitHydratableMarkup: boolean = false;
- public deferHydration: (tagName: string) => boolean = () => false;
- public tryRecoverFromErrors: boolean | ((e: unknown) => void) = false;
-
- /**
- * Renders a {@link @microsoft/fast-element#ViewTemplate} or HTML string.
- * @param template - The template to render.
- * @param renderInfo - Information about the rendering context.
- * @param source - Any source data to render the template and evaluate bindings with.
- * @param context - The {@link @microsoft/fast-element#ExecutionContext} to render with.
- */
- public *render(
- template: ViewTemplate | string,
- renderInfo: RenderInfo = this.createRenderInfo(),
- source: unknown = undefined,
- context: ExecutionContext = ExecutionContext.default
- ): IterableIterator {
- const codes =
- template instanceof ViewTemplate
- ? parseTemplateToOpCodes(template)
- : parseStringToOpCodes(template, {});
- yield* this.renderOpCodes(codes, renderInfo, source, context);
-
- // If there are no open custom elements, clean up all rendered
- // custom elements
- if (renderInfo.customElementInstanceStack.length === 0) {
- renderInfo.dispose();
- }
- }
-
- /**
- * Render a set of op codes.
- * @param codes - the op codes to render.
- * @param renderInfo - renderInfo context.
- * @param source - source data.
- *
- * @internal
- */
- public *renderOpCodes(
- codes: OpCodes,
- renderInfo: RenderInfo,
- source: unknown,
- context: ExecutionContext
- ): IterableIterator {
- const hydrationIndexOffset = codes.hydrationIndexOffset ?? 0;
- for (const code of codes) {
- switch (code.type) {
- case OpType.text:
- yield code.value;
- break;
- case OpType.viewBehaviorFactory: {
- const factory = code.factory as ViewBehaviorFactory & Aspected;
- const renderer = this.getFactoryRenderer(factory);
-
- if (this.shouldEmitHydrationMarkup(renderInfo)) {
- yield hydrationMarker.contentBindingStart(
- code.index - hydrationIndexOffset,
- codes.id
- );
- }
-
- if (renderer) {
- yield* renderer.render(
- factory,
- renderInfo,
- source,
- this,
- context
- );
- } else {
- // Throw if a SSR directive implementation cannot be found.
- throw new Error(
- `Unable to process view behavior factory: ${factory}`
- );
- }
-
- if (this.shouldEmitHydrationMarkup(renderInfo)) {
- yield hydrationMarker.contentBindingEnd(
- code.index - hydrationIndexOffset,
- codes.id
- );
- }
-
- break;
- }
- case OpType.customElementOpen: {
- const renderer = this.getElementRenderer(
- renderInfo,
- code.tagName,
- code.ctor,
- code.staticAttributes
- );
-
- if (renderer !== undefined) {
- for (const [name, value] of code.staticAttributes) {
- renderer.setAttribute(name, value);
- }
-
- renderInfo.customElementInstanceStack.push(renderer);
- }
-
- break;
- }
-
- case OpType.customElementClose: {
- const renderer = renderInfo.customElementInstanceStack.pop()!;
- if (renderer) {
- renderInfo.renderedCustomElementList.push(renderer);
- }
- break;
- }
-
- case OpType.customElementAttributes: {
- const currentRenderer = getLast(
- renderInfo.customElementInstanceStack
- );
-
- if (currentRenderer) {
- // simulate DOM connection
- currentRenderer.connectedCallback();
-
- // Allow the renderer to hoist any attribute values it needs to
- yield* currentRenderer.renderAttributes();
- }
-
- break;
- }
-
- case OpType.customElementShadow: {
- const currentRenderer = getLast(
- renderInfo.customElementInstanceStack
- );
- if (!currentRenderer) {
- break;
- }
-
- const content = currentRenderer.renderShadow(renderInfo);
-
- if (content) {
- yield* content;
- }
-
- break;
- }
-
- case OpType.attributeBinding: {
- const { factory } = code;
- const factoryRenderer = this.getFactoryRenderer(factory);
-
- if (
- code.useCustomElementInstance &&
- factoryRenderer === HTMLBindingDirectiveRenderer
- ) {
- if (factory.aspectType === DOMAspect.event) {
- // No-op for event bindings
- break;
- }
- // The attribute needs to be set for the element in this case
- // because the instance will yield out it's own attributes.
- const result = factory.dataBinding!.evaluate(source, context);
- const instance = getLast(renderInfo.customElementInstanceStack);
- const target = factory.targetAspect;
-
- switch (factory.aspectType) {
- case DOMAspect.attribute:
- instance?.setAttribute(target, result);
- break;
- case DOMAspect.booleanAttribute:
- if (result) {
- instance?.setAttribute(target, "");
- }
- break;
- case DOMAspect.property:
- instance?.setProperty(target, result);
- break;
- case DOMAspect.tokenList:
- instance?.setAttribute("class", result);
- break;
- }
- } else if (factoryRenderer) {
- yield* factoryRenderer.render(
- factory,
- renderInfo,
- source,
- this,
- context
- );
- }
-
- break;
- }
-
- case OpType.attributeBindingMarker:
- if (this.shouldEmitHydrationMarkup(renderInfo)) {
- const relativeIndexes = code.indexes.map(
- index => index - hydrationIndexOffset
- );
- yield ` ${hydrationMarker.attribute(relativeIndexes)}`;
- }
-
- break;
-
- case OpType.templateElementOpen:
- yield "";
- break;
- case OpType.templateElementClose:
- yield " ";
- break;
-
- default:
- throw new Error(`Unable to interpret op code '${code}'`);
- }
- }
- }
-
- /**
- * Constructs a new {@link RenderInfo } object.
- * @param renderers - the ElementRenderer constructors the RenderInfo should contain
- * @returns
- */
- public createRenderInfo(
- renderers: ConstructableElementRenderer[] = this.defaultElementRenderers
- ): RenderInfo {
- return new DefaultRenderInfo(renderers.concat());
- }
-
- public getElementRenderer(
- renderInfo: RenderInfo,
- tagName: string,
- ceClass: typeof HTMLElement | undefined = customElements.get(tagName),
- attributes: AttributesMap = new Map()
- ): ElementRenderer {
- if (ceClass) {
- for (const renderer of renderInfo.elementRenderers) {
- if (renderer.matchesClass(ceClass, tagName, attributes)) {
- return new renderer(tagName, renderInfo);
- }
- }
- }
-
- const fallbackRenderer = new FallbackRenderer(tagName, renderInfo);
- fallbackRenderer.deferHydration = this.deferHydration(tagName);
- return fallbackRenderer;
- }
-
- /**
- * Configures the ElementRenderers used during RenderInfo construction by {@link DefaultTemplateRenderer.createRenderInfo}
- * and the default RenderInfo argument used by {@link DefaultTemplateRenderer.render}.
- * @param renderers - The ElementRenderers to use by default.
- */
- public withDefaultElementRenderers(...renderers: ConstructableElementRenderer[]) {
- this.defaultElementRenderers = renderers;
- }
-
- /**
- * Registers DirectiveRenderers to use when rendering templates.
- * @param renderers - The directive renderers to register
- *
- * @internal
- */
- public withViewBehaviorFactoryRenderers(
- ...renderers: ViewBehaviorFactoryRenderer[]
- ): void {
- for (const renderer of renderers) {
- this.viewBehaviorFactoryRenderers.set(renderer.matcher, renderer);
- }
- }
-
- private getFactoryRenderer(
- factory: T
- ): ViewBehaviorFactoryRenderer | null {
- return this.viewBehaviorFactoryRenderers.get(factory.constructor) || null;
- }
-
- /**
- * Format attribute key/value pair into a HTML attribute string.
- * @param name - the attribute name.
- * @param value - the attribute value.
- */
- private static formatAttribute(name: string, value: string) {
- return value === "" ? name : `${name}="${value}"`;
- }
-
- public shouldEmitHydrationMarkup(renderInfo: RenderInfo) {
- return (
- this.emitHydratableMarkup && !!renderInfo.customElementInstanceStack.length
- );
- }
-}
diff --git a/packages/fast-ssr/src/test-utilities/consolidate.ts b/packages/fast-ssr/src/test-utilities/consolidate.ts
deleted file mode 100644
index 983ea153fc9..00000000000
--- a/packages/fast-ssr/src/test-utilities/consolidate.ts
+++ /dev/null
@@ -1,22 +0,0 @@
-export function consolidate(strings: IterableIterator): string {
- let str = "";
- let current = strings.next();
-
- while (!current.done) {
- str = str.concat(current.value);
- current = strings.next();
- }
-
- return str;
-}
-
-export async function consolidateAsync(
- strings: IterableIterator>
-) {
- let value = "";
- for await (const part of strings) {
- value += part;
- }
-
- return value;
-}
diff --git a/packages/fast-ssr/src/test-utilities/validators.ts b/packages/fast-ssr/src/test-utilities/validators.ts
deleted file mode 100644
index 1fc4b1b2b02..00000000000
--- a/packages/fast-ssr/src/test-utilities/validators.ts
+++ /dev/null
@@ -1,32 +0,0 @@
-export function validateRendererOutput(
- strings: IterableIterator,
- expected: (string | ((x: any) => boolean))[]
-): boolean {
- let passed = false;
- let i = 0;
- let current = strings.next();
-
- while (!current.done) {
- const validator = expected[i];
- // check if there are more strings than validators
- if (validator === undefined) {
- passed = false;
- break;
- }
-
- if (typeof validator === "function") {
- passed = validator(current.value);
- } else {
- passed = current.value === expected[i];
- }
-
- if (!passed) {
- break;
- }
-
- current = strings.next();
- i++;
- }
-
- return passed;
-}
diff --git a/packages/fast-ssr/src/tsconfig.json b/packages/fast-ssr/src/tsconfig.json
deleted file mode 100644
index d7363176aab..00000000000
--- a/packages/fast-ssr/src/tsconfig.json
+++ /dev/null
@@ -1,13 +0,0 @@
-{
- "extends": "../tsconfig.json",
- "compilerOptions": {
- "composite": true,
- "rootDir": ".",
- "outDir": "../dist/esm",
- "declarationDir": "../dist/dts",
- "lib": [
- "dom",
- "esnext"
- ],
- },
-}
diff --git a/packages/fast-ssr/src/view.ts b/packages/fast-ssr/src/view.ts
deleted file mode 100644
index e3ec091edcb..00000000000
--- a/packages/fast-ssr/src/view.ts
+++ /dev/null
@@ -1,62 +0,0 @@
-import {
- HTMLTemplateCompilationResult,
- ViewBehaviorFactory,
-} from "@microsoft/fast-element";
-import { OpCodes, OpType, TemplateElementOpenOp } from "./template-parser/op-codes.js";
-import { parseStringToOpCodes } from "./template-parser/template-parser.js";
-
-/**
- * SSR implementation of {@link @microsoft/fast-element#HTMLView}. Due to
- * drastic type difference requirements, it does not extend it directly. Most
- * methods are no-op. SSR op-codes are created during construction to be used
- * by the ElementRenderer.
- */
-export class SSRView {
- public readonly html: string;
- public readonly factories: Record;
- public result: HTMLTemplateCompilationResult | null = null;
- public codes: OpCodes;
- public hostStaticAttributes?: TemplateElementOpenOp["staticAttributes"];
- public hostDynamicAttributes?: TemplateElementOpenOp["dynamicAttributes"];
-
- constructor(html: string, factories: Record) {
- this.html = html;
- this.factories = factories;
- const codes = parseStringToOpCodes(html, factories, true);
-
- /**
- * If the first and last codes are template elements, populate static
- * and dynamic attributes for the host element and remove those op codes.
- */
- if (codes.length) {
- const firstCode = codes[0];
- if (
- firstCode.type === OpType.templateElementOpen &&
- codes[codes.length - 1].type === OpType.templateElementClose
- ) {
- if (firstCode.staticAttributes.size) {
- this.hostStaticAttributes = firstCode.staticAttributes;
- }
-
- if (firstCode.dynamicAttributes.length) {
- this.hostDynamicAttributes = firstCode.dynamicAttributes;
- }
-
- codes.shift();
- codes.pop();
- }
- }
- this.codes = codes;
- }
-
- public createView(): this {
- return this;
- }
- public bind() {}
- public unbind() {}
- public appendTo() {}
-
- public static isSSRView(view: any): view is SSRView {
- return view instanceof SSRView;
- }
-}
diff --git a/packages/fast-ssr/tsconfig.json b/packages/fast-ssr/tsconfig.json
deleted file mode 100644
index 42dcfaa0af8..00000000000
--- a/packages/fast-ssr/tsconfig.json
+++ /dev/null
@@ -1,18 +0,0 @@
-{
- "compilerOptions": {
- "allowSyntheticDefaultImports": true,
- "target": "ES2015",
- "module": "NodeNext",
- "moduleResolution": "NodeNext",
- "importHelpers": true,
- "experimentalDecorators": true,
- "emitDecoratorMetadata": true,
- "noEmitOnError": true,
- "strict": true,
- "skipLibCheck": true,
- "lib": [
- "dom",
- "esnext"
- ],
- },
-}
From 0eb81e0d25fc8d42a032cdba9d6b3d7eac1b5dd2 Mon Sep 17 00:00:00 2001
From: Jane Chu <7559015+janechu@users.noreply.github.com>
Date: Mon, 20 Apr 2026 21:00:33 -0700
Subject: [PATCH 06/11] feat: add properties path tree to ObserverMapConfig in
fast-html (#7448)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
# Pull Request
## 📖 Description
Adds a `properties` key to the `ObserverMapConfig` interface in `@microsoft/fast-html` so that developers can opt specific root properties and nested sub-paths in or out of automatic observer-map observation, rather than the current all-or-nothing approach.
Each path entry can be:
- **`true`** — observe this path and all descendants
- **`false`** — skip this path and all descendants
- **`ObserverMapPathNode`** — an object with optional `$observe` boolean and child overrides, enabling alternating opt-in/opt-out to arbitrary depth
When `properties` is omitted (`observerMap: {}` or `observerMap: "all"`), current behavior is preserved. When `properties` is present but empty (`{ properties: {} }`), no root properties are observed.
### 🎫 Issues
- Resolves https://github.com/microsoft/fast/issues/7445
## 👩💻 Reviewer Notes
Key areas to review:
- **`observer-map.ts`**: New `hasObservedPath` helper and config filtering logic in `defineProperties()`
- **`utilities.ts`**: Config threading through the proxy system (`assignObservables`, `assignProxyToItemsInObject`, `assignProxy`), particularly the `set` trap changes that skip notification for excluded properties
- **`template.ts`**: New types (`ObserverMapPathEntry`, `ObserverMapPathNode`) and config extraction for `ObserverMap` constructor
## 📑 Test Plan
- All 289 existing + new Chromium tests pass
- New unit tests in `observer-map.spec.ts` covering:
- Skipping unlisted root properties
- Skipping `false` root properties
- Observe-all with empty config (`{}`)
- Observe-nothing with empty properties (`{ properties: {} }`)
- New fixture tests in `observer-map-properties/` covering:
- Selective root property observation
- Excluded subtrees (`false`)
- Re-included leaf within `$observe: false` branch
- Unlisted root properties remaining unobserved
- Array observation with selective config
- Empty config object backward compatibility
## ✅ Checklist
### General
- [x] I have included a change request file using `$ npm run change`
- [x] I have added tests for my changes.
- [x] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/main/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/main/CODE_OF_CONDUCT.md#our-standards) for this project.
---
...-2751da26-46f3-4c7d-ae10-4437c26b800b.json | 7 +
packages/fast-html/DESIGN.md | 73 ++++++-
packages/fast-html/README.md | 47 +++++
packages/fast-html/docs/api-report.api.md | 16 +-
packages/fast-html/src/components/index.ts | 2 +
.../src/components/observer-map.spec.ts | 138 ++++++++++++++
.../fast-html/src/components/observer-map.ts | 159 +++++++++++++++-
packages/fast-html/src/components/schema.ts | 42 ++--
packages/fast-html/src/components/template.ts | 49 ++++-
.../fast-html/src/components/utilities.ts | 78 +++++++-
packages/fast-html/src/index.ts | 2 +
.../observer-map-properties/entry.html | 14 ++
.../fast-build.config.json | 6 +
.../observer-map-properties/index.html | 110 +++++++++++
.../fixtures/observer-map-properties/main.ts | 169 +++++++++++++++++
.../observer-map-properties.spec.ts | 179 ++++++++++++++++++
.../observer-map-properties/state.json | 29 +++
.../observer-map-properties/templates.html | 55 ++++++
18 files changed, 1137 insertions(+), 38 deletions(-)
create mode 100644 change/@microsoft-fast-html-2751da26-46f3-4c7d-ae10-4437c26b800b.json
create mode 100644 packages/fast-html/test/fixtures/observer-map-properties/entry.html
create mode 100644 packages/fast-html/test/fixtures/observer-map-properties/fast-build.config.json
create mode 100644 packages/fast-html/test/fixtures/observer-map-properties/index.html
create mode 100644 packages/fast-html/test/fixtures/observer-map-properties/main.ts
create mode 100644 packages/fast-html/test/fixtures/observer-map-properties/observer-map-properties.spec.ts
create mode 100644 packages/fast-html/test/fixtures/observer-map-properties/state.json
create mode 100644 packages/fast-html/test/fixtures/observer-map-properties/templates.html
diff --git a/change/@microsoft-fast-html-2751da26-46f3-4c7d-ae10-4437c26b800b.json b/change/@microsoft-fast-html-2751da26-46f3-4c7d-ae10-4437c26b800b.json
new file mode 100644
index 00000000000..fc4bcbc9cf0
--- /dev/null
+++ b/change/@microsoft-fast-html-2751da26-46f3-4c7d-ae10-4437c26b800b.json
@@ -0,0 +1,7 @@
+{
+ "type": "prerelease",
+ "comment": "feat: add properties path tree to ObserverMapConfig in fast-html",
+ "packageName": "@microsoft/fast-html",
+ "email": "7559015+janechu@users.noreply.github.com",
+ "dependentChangeType": "none"
+}
diff --git a/packages/fast-html/DESIGN.md b/packages/fast-html/DESIGN.md
index fdf8d8312c9..7aeef6683aa 100644
--- a/packages/fast-html/DESIGN.md
+++ b/packages/fast-html/DESIGN.md
@@ -87,7 +87,43 @@ An optional layer that uses the `Schema` to automatically:
- Install property-change handlers that wrap newly assigned objects/arrays in `Proxy` instances.
- Propagate deep property mutations back through FAST's observable system so bindings re-render.
-Enabled via `TemplateElement.options({ "my-element": { observerMap: "all" } })` or by passing a configuration object `TemplateElement.options({ "my-element": { observerMap: {} } })`. Both forms are equivalent; no configuration keys are defined at this time.
+Enabled via `TemplateElement.options({ "my-element": { observerMap: "all" } })` or by passing a configuration object `TemplateElement.options({ "my-element": { observerMap: {} } })`. Both forms are equivalent and observe all root properties.
+
+#### Path-level observation control
+
+The `ObserverMapConfig` interface accepts an optional `properties` key that maps root property names to a recursive path tree controlling observation granularity:
+
+```typescript
+TemplateElement.options({
+ "my-element": {
+ observerMap: {
+ properties: {
+ user: {
+ name: true, // user.name — observed
+ details: {
+ age: true, // user.details.age — observed
+ history: false, // user.details.history — NOT observed
+ },
+ },
+ // root properties not listed here are skipped
+ },
+ },
+ },
+});
+```
+
+Each path entry can be:
+- **`true`** — observe this path and all descendants (unless overridden deeper).
+- **`false`** — skip this path and all descendants (unless overridden deeper).
+- **`ObserverMapPathNode`** — an object with an optional `$observe` boolean and child property overrides, allowing alternating opt-in/opt-out to arbitrary depth.
+
+When `properties` is omitted (`observerMap: {}` or `observerMap: "all"`), all root properties are observed. When `properties` is present but empty (`{ properties: {} }`), no root properties are observed.
+
+The resolution algorithm walks the schema and configuration tree in parallel:
+1. If `properties` is present and a root property is not listed, it is skipped.
+2. `true`/`false` booleans apply to the entire subtree.
+3. `$observe` on a node object controls the current level; children inherit when unspecified.
+4. Paths in the config but not in the schema are silently ignored (forward-compatible).
### `AttributeMap` — automatic `@attr` definitions
@@ -152,6 +188,9 @@ import {
RenderableFASTElement,
TemplateElement,
ObserverMap,
+ type ObserverMapConfig,
+ type ObserverMapPathEntry,
+ type ObserverMapPathNode,
} from "@microsoft/fast-html";
```
@@ -163,6 +202,14 @@ Three primary exports are intended for application code:
| `RenderableFASTElement(Base)` | Mixin applied to your `FASTElement` subclass for hydration support. |
| `ObserverMap` | Advanced: access the observer-map class directly if building tooling. |
+Additionally, the following types are exported for use in `observerMap` configuration:
+
+| Type | Purpose |
+|---|---|
+| `ObserverMapConfig` | Configuration object for the `observerMap` option; accepts optional `properties` key. |
+| `ObserverMapPathEntry` | `boolean \| ObserverMapPathNode` — a node in the observation path tree. |
+| `ObserverMapPathNode` | Object node with optional `$observe` and child property overrides. |
+
---
## Template Syntax
@@ -204,7 +251,7 @@ flowchart TD
G --> H[transformInnerHTML normalises HTML entities]
H --> I["resolveStringsAndValues\nparses bindings and directives\nbuilds Schema, builds strings+values arrays"]
I --> J{observerMap enabled?}
- J -- yes --> K["ObserverMap.defineProperties\n→ Observable.defineProperty for each root prop\n→ install proxy change handlers"]
+ J -- yes --> K["ObserverMap.defineProperties\n→ applyConfigToSchema stamps $observe on schema nodes\n→ Observable.defineProperty for each root prop\n→ install proxy change handlers"]
J -- no --> L
K --> L["ViewTemplate.create strings,values\n→ registeredFastElement.template = viewTemplate"]
L --> M["FASTElementDefinition.composeAsync\n→ element fully registered with platform"]
@@ -290,13 +337,29 @@ flowchart LR
B --> C[schema.addPath\ntype:'access'\npath:'user.details.age'\nrootProperty:'user']
C --> D["Schema.jsonSchemaMap\n{'my-el' => {'user' => JSONSchema}}"]
D --> E[ObserverMap.defineProperties]
- E --> F[Observable.defineProperty on prototype\nfor 'user']
- E --> G[install instanceResolverChanged handler]
- G --> H[when user= is set:\nassignObservables → Proxy wraps user\ndeep mutations → Observable.notify]
+ E --> E1["applyConfigToSchema\nstamps $observe: false on excluded schema nodes"]
+ E1 --> F[Observable.defineProperty on prototype\nfor 'user']
+ E1 --> G[install instanceResolverChanged handler]
+ G --> H["when user= is set:\nassignObservables checks schema.$observe\n→ Proxy wraps observed paths only\ndeep mutations → Observable.notify"]
```
For a deep dive into the schema structure, context tracking, and proxy system see [SCHEMA_OBSERVER_MAP.md](./SCHEMA_OBSERVER_MAP.md).
+### `$observe` flag on schema nodes
+
+When an `ObserverMapConfig` with a `properties` key is provided, `ObserverMap.defineProperties()` calls `applyConfigToSchema()` to stamp `$observe: false` on excluded schema nodes **before** the proxy system runs. This is a one-time pre-processing pass that walks the config and schema trees in parallel:
+
+- `false` in the config → `$observe: false` is stamped recursively on the node and all its descendants.
+- `$observe: false` on a config node → the schema node is stamped, and unlisted children inherit the stamp.
+- `true` in the config → no stamp needed (observed is the default).
+- Config paths not in the schema are silently ignored.
+
+**Convention: stamp-only-when-excluding.** The `$observe` flag is only ever set to `false` — it is never explicitly set to `true`. Absence of `$observe` (i.e. `undefined`) means the node is observed. This means:
+
+- When `observerMap: "all"` or `observerMap: {}` is used, `applyConfigToSchema` is never called and no schema nodes are mutated — zero overhead for the common case.
+- The proxy system uses `isSchemaExcluded(schema)` (checks `$observe === false` with no observed descendants) as the single predicate for all skip/suppress decisions.
+- Schema nodes without `$observe` are always treated as observed.
+
### AttributeMap and leaf bindings
When `attributeMap` is enabled (via `"all"`, `{}`, or a configuration object), `AttributeMap.defineProperties()` is called after parsing. It iterates `Schema.getRootProperties()` and skips any property whose schema entry contains `properties`, `type`, or `anyOf` — keeping only plain leaf bindings. For each leaf:
diff --git a/packages/fast-html/README.md b/packages/fast-html/README.md
index 58938468242..ba7c47f90b6 100644
--- a/packages/fast-html/README.md
+++ b/packages/fast-html/README.md
@@ -217,6 +217,53 @@ if (process.env.NODE_ENV === 'development') {
}
```
+#### `observerMap`
+
+When `observerMap: "all"` (or `observerMap: {}`) is configured for an element, `@microsoft/fast-html` automatically sets up deep reactive observation for all root properties discovered in the template. Both `"all"` and `{}` are equivalent.
+
+For finer control, pass a configuration object with a `properties` key that maps root property names to a recursive path tree:
+
+```typescript
+TemplateElement.options({
+ "user-profile": {
+ observerMap: {
+ properties: {
+ user: {
+ name: true, // user.name — observed
+ details: {
+ age: true, // user.details.age — observed
+ history: false, // user.details.history — NOT observed
+ },
+ },
+ // root properties not listed here are skipped
+ },
+ },
+ },
+}).define({ name: "f-template" });
+```
+
+Each path entry can be:
+- **`true`** — observe this path and all descendants.
+- **`false`** — skip this path and all descendants.
+- **An object** with an optional `$observe` boolean and child property overrides.
+
+Use `$observe: false` on a node to skip it by default, then re-include specific children:
+
+```typescript
+observerMap: {
+ properties: {
+ analytics: {
+ charts: {
+ $observe: false, // charts NOT observed by default
+ activeChart: true, // ...except activeChart IS observed
+ },
+ },
+ },
+}
+```
+
+When `properties` is omitted, all root properties are observed (backward compatible). When `properties` is present but empty (`{ properties: {} }`), no root properties are observed.
+
#### `attributeMap`
When `attributeMap: "all"` (or `attributeMap: {}`) is configured for an element, `@microsoft/fast-html` automatically creates reactive `@attr` properties for every **leaf binding** in the template — simple expressions like `{{foo}}` or `id="{{foo-bar}}"` that have no nested properties. Both `"all"` and `{}` are equivalent and use the default `"none"` attribute name strategy.
diff --git a/packages/fast-html/docs/api-report.api.md b/packages/fast-html/docs/api-report.api.md
index c209b1bc085..4531dcaa3e2 100644
--- a/packages/fast-html/docs/api-report.api.md
+++ b/packages/fast-html/docs/api-report.api.md
@@ -17,13 +17,27 @@ export interface AttributeMapConfig {
// @public
export class ObserverMap {
// Warning: (ae-forgotten-export) The symbol "Schema" needs to be exported by the entry point index.d.ts
- constructor(classPrototype: any, schema: Schema);
+ constructor(classPrototype: any, schema: Schema, config?: ObserverMapConfig);
// (undocumented)
defineProperties(): void;
}
// @public
export interface ObserverMapConfig {
+ properties?: {
+ [rootProperty: string]: ObserverMapPathEntry;
+ };
+}
+
+// @public
+export type ObserverMapPathEntry = boolean | ObserverMapPathNode;
+
+// @public
+export interface ObserverMapPathNode {
+ // (undocumented)
+ $observe?: boolean;
+ // (undocumented)
+ [propertyName: string]: ObserverMapPathEntry | undefined;
}
// @public
diff --git a/packages/fast-html/src/components/index.ts b/packages/fast-html/src/components/index.ts
index 25db3b7df49..0b65205d3e9 100644
--- a/packages/fast-html/src/components/index.ts
+++ b/packages/fast-html/src/components/index.ts
@@ -9,5 +9,7 @@ export {
type HydrationLifecycleCallbacks,
type ObserverMapConfig,
ObserverMapOption,
+ type ObserverMapPathEntry,
+ type ObserverMapPathNode,
TemplateElement,
} from "./template.js";
diff --git a/packages/fast-html/src/components/observer-map.spec.ts b/packages/fast-html/src/components/observer-map.spec.ts
index 456010d7167..6254e27d133 100644
--- a/packages/fast-html/src/components/observer-map.spec.ts
+++ b/packages/fast-html/src/components/observer-map.spec.ts
@@ -49,4 +49,142 @@ test.describe("ObserverMap", async () => {
expect(instance.someData).not.toBe(nextValue);
expect(instance.someData.$isProxy).toBeTruthy();
});
+
+ test.describe("properties config", () => {
+ test("should skip root properties not listed in config.properties", () => {
+ const testName = "test-skip-unlisted";
+ const testSchema = new Schema(testName);
+ class SkipTest {
+ public included: any;
+ public excluded: any;
+ }
+
+ const schemaMap = Schema.jsonSchemaMap.get(testName) as Map<
+ string,
+ JSONSchema
+ >;
+ schemaMap.set("included", {
+ $schema: "https://json-schema.org/draft/2019-09/schema",
+ $id: `https://fast.design/schemas/${testName}/included.json`,
+ type: "object",
+ properties: { val: { type: "string" } },
+ [defsPropertyName]: {},
+ });
+ schemaMap.set("excluded", {
+ $schema: "https://json-schema.org/draft/2019-09/schema",
+ $id: `https://fast.design/schemas/${testName}/excluded.json`,
+ type: "object",
+ properties: { val: { type: "string" } },
+ [defsPropertyName]: {},
+ });
+
+ const om = new ObserverMap(SkipTest.prototype, testSchema, {
+ properties: { included: true },
+ });
+ om.defineProperties();
+
+ const instance = new SkipTest();
+ instance.included = null;
+ instance.included = { val: "hello" };
+
+ // included should be proxied
+ expect(instance.included.$isProxy).toBeTruthy();
+
+ // excluded should remain a plain object
+ instance.excluded = { val: "world" };
+ expect(instance.excluded.$isProxy).toBeUndefined();
+ });
+
+ test("should skip root properties set to false", () => {
+ const testName = "test-skip-false";
+ const testSchema = new Schema(testName);
+ class FalseTest {
+ public skipped: any;
+ }
+
+ const schemaMap = Schema.jsonSchemaMap.get(testName) as Map<
+ string,
+ JSONSchema
+ >;
+ schemaMap.set("skipped", {
+ $schema: "https://json-schema.org/draft/2019-09/schema",
+ $id: `https://fast.design/schemas/${testName}/skipped.json`,
+ type: "object",
+ properties: { val: { type: "string" } },
+ [defsPropertyName]: {},
+ });
+
+ const om = new ObserverMap(FalseTest.prototype, testSchema, {
+ properties: { skipped: false },
+ });
+ om.defineProperties();
+
+ const instance = new FalseTest();
+ instance.skipped = { val: "hello" };
+
+ // skipped should remain a plain object
+ expect(instance.skipped.$isProxy).toBeUndefined();
+ });
+
+ test("should observe all properties when config has no properties key", () => {
+ const testName = "test-observe-all";
+ const testSchema = new Schema(testName);
+ class AllTest {
+ public data: any;
+ }
+
+ const schemaMap = Schema.jsonSchemaMap.get(testName) as Map<
+ string,
+ JSONSchema
+ >;
+ schemaMap.set("data", {
+ $schema: "https://json-schema.org/draft/2019-09/schema",
+ $id: `https://fast.design/schemas/${testName}/data.json`,
+ type: "object",
+ properties: { val: { type: "string" } },
+ [defsPropertyName]: {},
+ });
+
+ // Empty config object = observe all
+ const om = new ObserverMap(AllTest.prototype, testSchema, {});
+ om.defineProperties();
+
+ const instance = new AllTest();
+ instance.data = null;
+ instance.data = { val: "hello" };
+
+ expect(instance.data.$isProxy).toBeTruthy();
+ });
+
+ test("should observe nothing when properties is empty", () => {
+ const testName = "test-observe-nothing";
+ const testSchema = new Schema(testName);
+ class NoneTest {
+ public data: any;
+ }
+
+ const schemaMap = Schema.jsonSchemaMap.get(testName) as Map<
+ string,
+ JSONSchema
+ >;
+ schemaMap.set("data", {
+ $schema: "https://json-schema.org/draft/2019-09/schema",
+ $id: `https://fast.design/schemas/${testName}/data.json`,
+ type: "object",
+ properties: { val: { type: "string" } },
+ [defsPropertyName]: {},
+ });
+
+ // properties: {} = observe nothing
+ const om = new ObserverMap(NoneTest.prototype, testSchema, {
+ properties: {},
+ });
+ om.defineProperties();
+
+ const instance = new NoneTest();
+ instance.data = { val: "hello" };
+
+ expect(instance.data.$isProxy).toBeUndefined();
+ });
+ });
});
diff --git a/packages/fast-html/src/components/observer-map.ts b/packages/fast-html/src/components/observer-map.ts
index 40ab0766d1a..40e63eace54 100644
--- a/packages/fast-html/src/components/observer-map.ts
+++ b/packages/fast-html/src/components/observer-map.ts
@@ -1,6 +1,116 @@
import { Observable } from "@microsoft/fast-element/observable.js";
-import { assignObservables, deepMerge } from "./utilities.js";
import type { JSONSchema, Schema } from "./schema.js";
+import type { ObserverMapConfig, ObserverMapPathEntry } from "./template.js";
+import { assignObservables, deepMerge } from "./utilities.js";
+
+/**
+ * Determines whether a config entry (or any of its descendants) enables observation.
+ * Used to decide whether a root property needs an observable accessor and change handler.
+ */
+function hasObservedPath(entry: ObserverMapPathEntry): boolean {
+ if (typeof entry === "boolean") {
+ return entry;
+ }
+
+ // ObserverMapPathNode
+ if (entry.$observe === true) {
+ return true;
+ }
+
+ for (const key of Object.keys(entry)) {
+ if (key === "$observe") {
+ continue;
+ }
+
+ const child = entry[key];
+
+ if (child !== undefined && hasObservedPath(child)) {
+ return true;
+ }
+ }
+
+ // A node with no explicit $observe and no observed children:
+ // at the root level the default $observe is true, so a node like `{ }` (no children)
+ // is observed. But a node with `$observe: false` and no observed children is not.
+ return entry.$observe !== false;
+}
+
+/**
+ * Stamps `$observe` flags onto schema nodes based on the config tree.
+ * After this one-time pass the proxy system can check `schema.$observe`
+ * instead of needing a separate config parameter threaded through every call.
+ *
+ * @param schema - A schema node (must have `properties` to recurse)
+ * @param entry - The corresponding config path entry
+ * @param inherited - The inherited `$observe` value from the parent
+ */
+function applyConfigToSchema(
+ schema: any,
+ entry: ObserverMapPathEntry,
+ inherited: boolean = true,
+): void {
+ if (entry === false) {
+ stampObserveFalse(schema);
+ return;
+ }
+
+ if (entry === true) {
+ // Explicitly observed — no stamp needed (default is observed)
+ return;
+ }
+
+ // ObserverMapPathNode
+ const nodeObserve = entry.$observe ?? inherited;
+
+ if (!nodeObserve) {
+ schema.$observe = false;
+ }
+
+ if (!schema?.properties) {
+ return;
+ }
+
+ for (const key of Object.keys(entry)) {
+ if (key === "$observe") {
+ continue;
+ }
+
+ const childEntry = entry[key];
+ const childSchema = schema.properties[key];
+
+ // Paths in config but not in schema are silently ignored
+ if (childEntry !== undefined && childSchema) {
+ applyConfigToSchema(childSchema, childEntry, nodeObserve);
+ }
+ }
+
+ // For properties in the schema that are NOT listed in the config,
+ // they inherit the parent's $observe value
+ if (!nodeObserve) {
+ for (const key of Object.keys(schema.properties)) {
+ if (!(key in entry) && schema.properties[key]) {
+ stampObserveFalse(schema.properties[key]);
+ }
+ }
+ }
+}
+
+/**
+ * Recursively stamps `$observe: false` on a schema node and all its descendants.
+ */
+function stampObserveFalse(schema: any): void {
+ if (!schema) {
+ return;
+ }
+
+ schema.$observe = false;
+
+ if (schema.properties) {
+ for (const key of Object.keys(schema.properties)) {
+ stampObserveFalse(schema.properties[key]);
+ }
+ }
+}
/**
* ObserverMap provides functionality for caching binding paths, extracting root properties,
@@ -9,17 +119,51 @@ import type { JSONSchema, Schema } from "./schema.js";
export class ObserverMap {
private schema: Schema;
private classPrototype: any;
+ private config: ObserverMapConfig | undefined;
- constructor(classPrototype: any, schema: Schema) {
+ constructor(classPrototype: any, schema: Schema, config?: ObserverMapConfig) {
this.classPrototype = classPrototype;
this.schema = schema;
+ this.config = config;
}
public defineProperties(): void {
const propertyNames = this.schema.getRootProperties();
const existingAccessors = Observable.getAccessors(this.classPrototype);
+ const configProperties = this.config?.properties;
for (const propertyName of propertyNames) {
+ // When `properties` is present, skip root properties not listed in the config
+ if (configProperties && !(propertyName in configProperties)) {
+ continue;
+ }
+
+ // Resolve the config entry for this root property
+ const configEntry: ObserverMapPathEntry | undefined =
+ configProperties?.[propertyName];
+
+ // Skip root properties explicitly set to `false` with no observed descendants
+ if (configEntry === false) {
+ continue;
+ }
+
+ // Skip ObserverMapPathNode entries with no observed descendants
+ if (
+ typeof configEntry === "object" &&
+ configEntry !== null &&
+ !hasObservedPath(configEntry)
+ ) {
+ continue;
+ }
+
+ // Stamp $observe flags onto the schema so the proxy system
+ // can check schema nodes directly without a separate config tree
+ const rootSchema = this.schema.getSchema(propertyName);
+
+ if (configEntry && rootSchema) {
+ applyConfigToSchema(rootSchema, configEntry);
+ }
+
// Skip if property already has an accessor (from `@attr` or `@observable` decorator)
if (!existingAccessors.some(accessor => accessor.name === propertyName)) {
Observable.defineProperty(this.classPrototype, propertyName);
@@ -30,7 +174,7 @@ export class ObserverMap {
this.classPrototype[changedMethodName] = this.defineChanged(
propertyName,
- existingChangedMethod
+ existingChangedMethod,
);
}
}
@@ -40,13 +184,14 @@ export class ObserverMap {
* @param target - The target instance that owns the root property
* @param rootProperty - The name of the root property for notification purposes
* @param object - The object to wrap with a proxy
+ * @param schema - The schema for the element
* @returns A proxy that triggers notifications on property mutations
*/
private getAndAssignObservables(
target: any,
rootProperty: string,
object: any,
- schema: Schema
+ schema: Schema,
): typeof Proxy {
let proxiedObject = object;
@@ -55,7 +200,7 @@ export class ObserverMap {
schema.getSchema(rootProperty) as JSONSchema,
proxiedObject,
target,
- rootProperty
+ rootProperty,
);
return proxiedObject;
@@ -70,7 +215,7 @@ export class ObserverMap {
*/
private defineChanged = (
propertyName: string,
- existingChangedMethod?: (prev: any, next: any) => void
+ existingChangedMethod?: (prev: any, next: any) => void,
): ((prev: any, next: any) => void) => {
const getAndAssignObservablesAlias = this.getAndAssignObservables;
const schema = this.schema;
@@ -92,7 +237,7 @@ export class ObserverMap {
this,
propertyName,
next,
- schema
+ schema,
);
}
} else if (!isObjectAssignment) {
diff --git a/packages/fast-html/src/components/schema.ts b/packages/fast-html/src/components/schema.ts
index b546b83cc86..dd38de98d0b 100644
--- a/packages/fast-html/src/components/schema.ts
+++ b/packages/fast-html/src/components/schema.ts
@@ -14,6 +14,12 @@ interface JSONSchemaCommon {
items?: any;
anyOf?: Array;
$ref?: string;
+ /**
+ * Stamped by `applyConfigToSchema` when an `ObserverMapConfig` excludes
+ * this path. When `false`, the proxy system skips observation for this
+ * node and (if all descendants are also `false`) its subtree.
+ */
+ $observe?: boolean;
}
export interface JSONSchema extends JSONSchemaCommon {
@@ -118,7 +124,7 @@ export class Schema {
if (config.childrenMap) {
childRef = this.getSchemaId(
config.childrenMap.customElementName,
- config.childrenMap.attributeName
+ config.childrenMap.attributeName,
);
if (splitPath.length === 1) {
@@ -137,7 +143,7 @@ export class Schema {
schema,
splitPath.slice(1),
config.pathConfig.currentContext,
- childRef
+ childRef,
);
} else {
if (!schema[defsPropertyName]?.[splitPath[0]]) {
@@ -151,7 +157,7 @@ export class Schema {
schema[defsPropertyName][splitPath[0]],
splitPath.slice(1),
config.pathConfig.currentContext as string,
- childRef
+ childRef,
);
}
}
@@ -163,7 +169,7 @@ export class Schema {
schema,
splitPath.at(-1) as string, // example items
config.pathConfig.currentContext as string, // example item
- config.pathConfig.parentContext
+ config.pathConfig.parentContext,
);
if (splitPath.length > 2) {
@@ -177,7 +183,7 @@ export class Schema {
],
splitPath.slice(1, -1),
config.pathConfig.parentContext,
- childRef
+ childRef,
);
}
@@ -186,7 +192,7 @@ export class Schema {
hasParentContext ? splitPath.slice(2) : splitPath.slice(1),
config.pathConfig.currentContext,
childRef,
- "array"
+ "array",
);
} else if (splitPath.length > 1) {
let schemaDefinition;
@@ -202,12 +208,12 @@ export class Schema {
splitPath.slice(1),
config.pathConfig.currentContext,
childRef,
- "array"
+ "array",
);
} else {
schema.type = "array";
schema[refPropertyName] = this.getDefsPath(
- config.pathConfig.currentContext as string
+ config.pathConfig.currentContext as string,
);
}
@@ -281,7 +287,7 @@ export class Schema {
$schema: "https://json-schema.org/draft/2019-09/schema",
$id: this.getSchemaId(this.customElementName, propertyName),
[defsPropertyName]: {},
- }
+ },
);
}
@@ -295,7 +301,7 @@ export class Schema {
schema: any,
splitPath: string[],
context: string,
- childRef: string | null
+ childRef: string | null,
) {
schema.type = "object";
@@ -312,7 +318,7 @@ export class Schema {
schema.properties[splitPath[0]],
splitPath.slice(1),
context,
- childRef
+ childRef,
);
} else if (childRef) {
if (schema.properties[splitPath[0]].anyOf) {
@@ -337,7 +343,7 @@ export class Schema {
splitPath: string[],
context: string | null,
childRef: string | null,
- type: string = "object"
+ type: string = "object",
): any {
schema.type = "object";
@@ -355,7 +361,7 @@ export class Schema {
splitPath.slice(1),
context,
childRef,
- type
+ type,
);
} else if (type === "array") {
if (splitPath.length > 1) {
@@ -364,12 +370,12 @@ export class Schema {
splitPath.slice(1),
context,
childRef,
- type
+ type,
);
} else {
return this.addArrayToAnObject(
schema.properties[splitPath[0]],
- context as string
+ context as string,
);
}
}
@@ -409,7 +415,7 @@ export class Schema {
schema: any,
propertyName: string, // e.g items
currentContext: string, // e.g. item
- parentContext: string | null
+ parentContext: string | null,
): void {
if (schema[defsPropertyName][currentContext]) {
return;
@@ -431,7 +437,7 @@ export class Schema {
private getParentContexts(
schema: JSONSchema,
parentContext: string | null,
- contexts: Array = []
+ contexts: Array = [],
): Array {
if (parentContext === null) {
return [null, ...contexts];
@@ -444,7 +450,7 @@ export class Schema {
return this.getParentContexts(
schema,
parentParentContext.at(-1) as string | null,
- [parentContext, ...contexts]
+ [parentContext, ...contexts],
);
}
}
diff --git a/packages/fast-html/src/components/template.ts b/packages/fast-html/src/components/template.ts
index da22428e669..3811e611cbb 100644
--- a/packages/fast-html/src/components/template.ts
+++ b/packages/fast-html/src/components/template.ts
@@ -51,12 +51,47 @@ export const ObserverMapOption = {
all: "all",
} as const;
+/**
+ * A node in the observer-map path tree.
+ *
+ * - `true` → observe this path and all descendants (unless overridden by children).
+ * - `false` → do NOT observe this path or its descendants (unless overridden by children).
+ * - `ObserverMapPathNode` → configure child paths individually;
+ * the node itself is observed if `$observe` is true (default when parent is observed).
+ */
+export type ObserverMapPathEntry = boolean | ObserverMapPathNode;
+
+/**
+ * A node object in the observer-map path tree.
+ *
+ * `$observe` controls whether this node itself is observed.
+ * When omitted the value is inherited from the nearest ancestor
+ * that explicitly sets `$observe`. At the root level the default is `true`.
+ *
+ * Child property overrides are keyed by property name.
+ */
+export interface ObserverMapPathNode {
+ $observe?: boolean;
+ [propertyName: string]: ObserverMapPathEntry | undefined;
+}
+
/**
* Configuration object for the observerMap element option.
- * No configuration keys are defined at this time; passing an empty
- * object (`{}`) is equivalent to `"all"`.
+ * When `properties` is omitted (i.e. `observerMap: {}`), behaves like `"all"` —
+ * every root property is observed. When `properties` is present, only listed
+ * root properties participate in observer-map observation.
*/
-export interface ObserverMapConfig {}
+export interface ObserverMapConfig {
+ /**
+ * Per-root-property observation control.
+ * Keys are root property names discovered in the template schema.
+ * Only root properties listed here participate in observer-map observation.
+ * Omitting this field is equivalent to `"all"`.
+ */
+ properties?: {
+ [rootProperty: string]: ObserverMapPathEntry;
+ };
+}
/**
* Type for the observerMap element option.
@@ -275,9 +310,17 @@ class TemplateElement extends FASTElement {
}
if (isMapOptionEnabled(TemplateElement.elementOptions[name]?.observerMap)) {
+ const observerMapOption =
+ TemplateElement.elementOptions[name]?.observerMap;
+ const observerMapConfig =
+ typeof observerMapOption === "object" && observerMapOption !== null
+ ? observerMapOption
+ : undefined;
+
this.observerMap = new ObserverMap(
value.prototype,
this.schema as Schema,
+ observerMapConfig,
);
}
diff --git a/packages/fast-html/src/components/utilities.ts b/packages/fast-html/src/components/utilities.ts
index 07677a757bf..cd49d159af4 100644
--- a/packages/fast-html/src/components/utilities.ts
+++ b/packages/fast-html/src/components/utilities.ts
@@ -1177,11 +1177,40 @@ function getSchemaProperties(schema: any): any | null {
return null;
}
+/**
+ * Checks whether a schema node (or any of its descendants) has observation enabled.
+ * Returns false only when the node and ALL its descendants are stamped with `$observe: false`.
+ */
+function hasObservedSchemaDescendant(schema: any): boolean {
+ if (schema?.$observe !== false) {
+ return true;
+ }
+
+ const props = getSchemaProperties(schema);
+
+ if (!props) {
+ return false;
+ }
+
+ return Object.keys(props).some(k => hasObservedSchemaDescendant(props[k]));
+}
+
+/**
+ * Checks whether a schema node is fully excluded from observation.
+ * A node is excluded when it is stamped `$observe: false` AND none of
+ * its descendants are observed (no re-included leaves beneath it).
+ */
+function isSchemaExcluded(schema: any): boolean {
+ return schema?.$observe === false && !hasObservedSchemaDescendant(schema);
+}
+
/**
* Assigns Observable properties to items in an array and sets up change notifications
* @param proxiedData - The array data to make observable
* @param schema - The schema defining the structure of array items
* @param rootSchema - The root schema for the entire data structure
+ * @param target - The target element
+ * @param rootProperty - The root property name
* @returns The array with observable properties and change notifications
*/
function assignObservablesToArray(
@@ -1421,6 +1450,13 @@ function assignProxyToItemsInArray(
const schemaProperties = getSchemaProperties(schema);
getObjectProperties(proxiableItem, schemaProperties).forEach(key => {
+ const childSchema = schemaProperties[key];
+
+ // Skip properties fully excluded from observation
+ if (isSchemaExcluded(childSchema)) {
+ return;
+ }
+
// Initialize the property as undefined if it doesn't exist
if (!(key in originalItem)) {
originalItem[key] = undefined;
@@ -1482,6 +1518,13 @@ function assignProxyToItemsInObject(
if (type === "object" && schemaProperties) {
// navigate through all items in the object
getObjectProperties(proxiedData, schemaProperties).forEach(property => {
+ const childSchema = schemaProperties[property];
+
+ // Skip properties fully excluded from observation
+ if (isSchemaExcluded(childSchema)) {
+ return;
+ }
+
proxiedData[property] = assignProxyToItemsInObject(
target,
rootProperty,
@@ -1491,11 +1534,19 @@ function assignProxyToItemsInObject(
);
});
- // assign a Proxy to the object
- proxiedData = assignProxy(schema, rootSchema, target, rootProperty, proxiedData);
+ // Assign a Proxy unless this level is fully excluded from observation
+ if (!isSchemaExcluded(schema)) {
+ proxiedData = assignProxy(
+ schema,
+ rootSchema,
+ target,
+ rootProperty,
+ proxiedData,
+ );
- // Add this target to the object's target list
- addTargetToObject(proxiedData, target, rootProperty);
+ // Add this target to the object's target list
+ addTargetToObject(proxiedData, target, rootProperty);
+ }
} else if (type === "array") {
const context = findDef((schema as JSONSchema).items);
@@ -1585,6 +1636,8 @@ export function assignProxy(
object: any,
): typeof Proxy {
if (!object.$isProxy) {
+ const schemaProperties = getSchemaProperties(schema);
+
// Create a proxy for the object that triggers Observable.notify on mutations
const proxy = new Proxy(object, {
set: (obj: any, prop: string | symbol, value: any) => {
@@ -1594,6 +1647,15 @@ export function assignProxy(
return true;
}
+ const propName = typeof prop === "string" ? prop : String(prop);
+ const childSchema = schemaProperties?.[propName];
+
+ // If the property is fully excluded, assign without proxying or notifying
+ if (isSchemaExcluded(childSchema)) {
+ obj[prop] = value;
+ return true;
+ }
+
obj[prop] = assignObservables(
schema,
rootSchema,
@@ -1615,8 +1677,16 @@ export function assignProxy(
},
deleteProperty: (obj: any, prop: string | symbol) => {
if (prop in obj) {
+ const propName = typeof prop === "string" ? prop : String(prop);
+ const childSchema = schemaProperties?.[propName];
+
delete obj[prop];
+ // Only suppress notification if fully excluded
+ if (isSchemaExcluded(childSchema)) {
+ return true;
+ }
+
notifyObservables(proxy);
return true;
diff --git a/packages/fast-html/src/index.ts b/packages/fast-html/src/index.ts
index 8a8f5883fe1..aeae13fa25e 100644
--- a/packages/fast-html/src/index.ts
+++ b/packages/fast-html/src/index.ts
@@ -7,6 +7,8 @@ export {
type AttributeMapConfig,
ObserverMap,
type ObserverMapConfig,
+ type ObserverMapPathEntry,
+ type ObserverMapPathNode,
RenderableFASTElement,
TemplateElement,
} from "./components/index.js";
diff --git a/packages/fast-html/test/fixtures/observer-map-properties/entry.html b/packages/fast-html/test/fixtures/observer-map-properties/entry.html
new file mode 100644
index 00000000000..bcf07a1e05e
--- /dev/null
+++ b/packages/fast-html/test/fixtures/observer-map-properties/entry.html
@@ -0,0 +1,14 @@
+
+
+
+
+ Alice
+ dark
+
+
+ Alice
+ dark
+
+
+
+
+
+
+
+
+
+ {{user.name}}
+ {{settings.theme}}
+
+
+
+
+
+
+ {{user.name}}
+ {{settings.theme}}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/packages/fast-html/test/fixtures/observer-map-properties/main.ts b/packages/fast-html/test/fixtures/observer-map-properties/main.ts
new file mode 100644
index 00000000000..79ebbfbba56
--- /dev/null
+++ b/packages/fast-html/test/fixtures/observer-map-properties/main.ts
@@ -0,0 +1,169 @@
+import { FASTElement } from "@microsoft/fast-element";
+import { TemplateElement } from "@microsoft/fast-html";
+
+class SelectiveObsElement extends FASTElement {
+ public user = {
+ name: "Alice",
+ age: 28,
+ history: {
+ joined: "2020-01-01",
+ visits: 100,
+ },
+ location: {
+ city: "New York",
+ country: "USA",
+ },
+ };
+
+ public settings = {
+ theme: "dark",
+ language: "en",
+ };
+
+ public analytics = {
+ charts: {
+ activeChart: "line",
+ cachedData: "heavy-data",
+ },
+ summary: "good",
+ };
+
+ public updateUserName = () => {
+ this.user.name = "Bob";
+ };
+
+ public updateUserAge = () => {
+ this.user.age = 29;
+ };
+
+ public updateHistory = () => {
+ this.user.history.visits = 200;
+ };
+
+ public updateLocation = () => {
+ this.user.location.city = "London";
+ };
+
+ public updateSettings = () => {
+ this.settings.theme = "light";
+ };
+
+ public updateActiveChart = () => {
+ this.analytics.charts.activeChart = "bar";
+ };
+
+ public updateCachedData = () => {
+ this.analytics.charts.cachedData = "updated-heavy-data";
+ };
+
+ public updateSummary = () => {
+ this.analytics.summary = "excellent";
+ };
+}
+
+SelectiveObsElement.defineAsync({
+ name: "selective-obs-element",
+});
+
+class AllObsElement extends FASTElement {
+ public user = {
+ name: "Alice",
+ };
+
+ public settings = {
+ theme: "dark",
+ };
+
+ public updateUserName = () => {
+ this.user.name = "Bob";
+ };
+
+ public updateSettings = () => {
+ this.settings.theme = "light";
+ };
+}
+
+AllObsElement.defineAsync({
+ name: "all-obs-element",
+});
+
+class EmptyPropsElement extends FASTElement {
+ public user = {
+ name: "Alice",
+ };
+
+ public settings = {
+ theme: "dark",
+ };
+
+ public updateUserName = () => {
+ this.user.name = "Bob";
+ };
+
+ public updateSettings = () => {
+ this.settings.theme = "light";
+ };
+}
+
+EmptyPropsElement.defineAsync({
+ name: "empty-props-element",
+});
+
+class ArraySelectiveElement extends FASTElement {
+ public items: any[] = [
+ { text: "item-1", meta: { count: 1 } },
+ { text: "item-2", meta: { count: 2 } },
+ ];
+
+ public updateItemText = () => {
+ this.items[0].text = "updated-item-1";
+ };
+
+ public addItem = () => {
+ this.items.push({ text: "item-3", meta: { count: 3 } });
+ };
+}
+
+ArraySelectiveElement.defineAsync({
+ name: "array-selective-element",
+});
+
+TemplateElement.options({
+ "selective-obs-element": {
+ observerMap: {
+ properties: {
+ user: {
+ name: true,
+ age: true,
+ history: false,
+ location: true,
+ },
+ // settings is NOT listed → skipped
+ analytics: {
+ charts: {
+ $observe: false,
+ activeChart: true,
+ },
+ summary: true,
+ },
+ },
+ },
+ },
+ "all-obs-element": {
+ observerMap: {},
+ },
+ "empty-props-element": {
+ observerMap: {
+ properties: {},
+ },
+ },
+ "array-selective-element": {
+ observerMap: {
+ properties: {
+ items: true,
+ },
+ },
+ },
+}).define({
+ name: "f-template",
+});
diff --git a/packages/fast-html/test/fixtures/observer-map-properties/observer-map-properties.spec.ts b/packages/fast-html/test/fixtures/observer-map-properties/observer-map-properties.spec.ts
new file mode 100644
index 00000000000..36f2a1e9c2f
--- /dev/null
+++ b/packages/fast-html/test/fixtures/observer-map-properties/observer-map-properties.spec.ts
@@ -0,0 +1,179 @@
+import { expect, test } from "@playwright/test";
+
+test.describe("ObserverMap properties", async () => {
+ test.beforeEach(async ({ page }) => {
+ await page.goto("/fixtures/observer-map-properties/");
+ await page.waitForSelector("selective-obs-element");
+ });
+
+ test.describe("selective observation", () => {
+ test("should render initial values", async ({ page }) => {
+ const el = page.locator("selective-obs-element");
+
+ await expect(el.locator(".user-name")).toHaveText("Alice");
+ await expect(el.locator(".user-age")).toHaveText("28");
+ await expect(el.locator(".user-location-city")).toHaveText("New York");
+ await expect(el.locator(".active-chart")).toHaveText("line");
+ await expect(el.locator(".analytics-summary")).toHaveText("good");
+ });
+
+ test("should update observed property: user.name", async ({ page }) => {
+ const el = page.locator("selective-obs-element");
+ await el.locator("button:has-text('Update Name')").click();
+
+ await expect(el.locator(".user-name")).toHaveText("Bob");
+ });
+
+ test("should update observed property: user.age", async ({ page }) => {
+ const el = page.locator("selective-obs-element");
+ await el.locator("button:has-text('Update Age')").click();
+
+ await expect(el.locator(".user-age")).toHaveText("29");
+ });
+
+ test("should NOT update excluded property: user.history (false)", async ({
+ page,
+ }) => {
+ const el = page.locator("selective-obs-element");
+ const initialValue = await el.locator(".user-history-visits").textContent();
+
+ await el.locator("button:has-text('Update History')").click();
+
+ // Wait a frame
+ await page.evaluate(
+ () => new Promise(resolve => requestAnimationFrame(() => resolve(true))),
+ );
+
+ // The text should NOT have updated because history is excluded
+ await expect(el.locator(".user-history-visits")).toHaveText(initialValue!);
+ });
+
+ test("should update observed property: user.location (true)", async ({
+ page,
+ }) => {
+ const el = page.locator("selective-obs-element");
+ await el.locator("button:has-text('Update Location')").click();
+
+ await expect(el.locator(".user-location-city")).toHaveText("London");
+ });
+
+ test("should NOT update unlisted root property: settings", async ({ page }) => {
+ const el = page.locator("selective-obs-element");
+ const initialValue = await el.locator(".settings-theme").textContent();
+
+ await el.locator("button:has-text('Update Settings')").click();
+
+ await page.evaluate(
+ () => new Promise(resolve => requestAnimationFrame(() => resolve(true))),
+ );
+
+ // settings is not listed in properties → skipped
+ await expect(el.locator(".settings-theme")).toHaveText(initialValue!);
+ });
+
+ test("should update observed property inside $observe:false branch: analytics.charts.activeChart", async ({
+ page,
+ }) => {
+ const el = page.locator("selective-obs-element");
+ await el.locator("button:has-text('Update Active Chart')").click();
+
+ await expect(el.locator(".active-chart")).toHaveText("bar");
+ });
+
+ test("should NOT update excluded property: analytics.charts.cachedData (inherits $observe:false)", async ({
+ page,
+ }) => {
+ const el = page.locator("selective-obs-element");
+ const initialValue = await el.locator(".cached-data").textContent();
+
+ await el.locator("button:has-text('Update Cached Data')").click();
+
+ await page.evaluate(
+ () => new Promise(resolve => requestAnimationFrame(() => resolve(true))),
+ );
+
+ // cachedData inherits $observe:false from charts node
+ await expect(el.locator(".cached-data")).toHaveText(initialValue!);
+ });
+
+ test("should update observed property: analytics.summary (true)", async ({
+ page,
+ }) => {
+ const el = page.locator("selective-obs-element");
+ await el.locator("button:has-text('Update Summary')").click();
+
+ await expect(el.locator(".analytics-summary")).toHaveText("excellent");
+ });
+ });
+
+ test.describe("empty config object (observe all)", () => {
+ test("should update user.name with observerMap: {}", async ({ page }) => {
+ const el = page.locator("all-obs-element");
+ await el.locator("button:has-text('Update Name')").click();
+
+ await expect(el.locator(".user-name")).toHaveText("Bob");
+ });
+
+ test("should update settings.theme with observerMap: {}", async ({ page }) => {
+ const el = page.locator("all-obs-element");
+ await el.locator("button:has-text('Update Settings')").click();
+
+ await expect(el.locator(".settings-theme")).toHaveText("light");
+ });
+ });
+
+ test.describe("empty properties object (observe nothing)", () => {
+ test("should NOT update user.name with properties: {}", async ({ page }) => {
+ const el = page.locator("empty-props-element");
+ const initialValue = await el.locator(".user-name").textContent();
+
+ await el.locator("button:has-text('Update Name')").click();
+
+ await page.evaluate(
+ () => new Promise(resolve => requestAnimationFrame(() => resolve(true))),
+ );
+
+ await expect(el.locator(".user-name")).toHaveText(initialValue!);
+ });
+
+ test("should NOT update settings.theme with properties: {}", async ({ page }) => {
+ const el = page.locator("empty-props-element");
+ const initialValue = await el.locator(".settings-theme").textContent();
+
+ await el.locator("button:has-text('Update Settings')").click();
+
+ await page.evaluate(
+ () => new Promise(resolve => requestAnimationFrame(() => resolve(true))),
+ );
+
+ await expect(el.locator(".settings-theme")).toHaveText(initialValue!);
+ });
+ });
+
+ test.describe("array with selective observation", () => {
+ test("should render initial array items", async ({ page }) => {
+ const el = page.locator("array-selective-element");
+
+ await expect(el.locator(".item-text").first()).toHaveText("item-1");
+ await expect(el.locator(".item-text").nth(1)).toHaveText("item-2");
+ });
+
+ test("should update item text in observed array", async ({ page }) => {
+ const el = page.locator("array-selective-element");
+ await el.locator("button:has-text('Update Item Text')").click();
+
+ await expect(el.locator(".item-text").first()).toHaveText("updated-item-1");
+ });
+
+ test("should add items to observed array", async ({ page }) => {
+ const el = page.locator("array-selective-element");
+
+ await expect(el.locator(".item-row")).toHaveCount(2);
+
+ await el.locator("button:has-text('Add Item')").click();
+
+ await expect(el.locator(".item-row")).toHaveCount(3);
+ await expect(el.locator(".item-text").nth(2)).toHaveText("item-3");
+ });
+ });
+});
diff --git a/packages/fast-html/test/fixtures/observer-map-properties/state.json b/packages/fast-html/test/fixtures/observer-map-properties/state.json
new file mode 100644
index 00000000000..dc9e72829c2
--- /dev/null
+++ b/packages/fast-html/test/fixtures/observer-map-properties/state.json
@@ -0,0 +1,29 @@
+{
+ "user": {
+ "name": "Alice",
+ "age": 28,
+ "history": {
+ "joined": "2020-01-01",
+ "visits": 100
+ },
+ "location": {
+ "city": "New York",
+ "country": "USA"
+ }
+ },
+ "settings": {
+ "theme": "dark",
+ "language": "en"
+ },
+ "analytics": {
+ "charts": {
+ "activeChart": "line",
+ "cachedData": "heavy-data"
+ },
+ "summary": "good"
+ },
+ "items": [
+ { "text": "item-1", "meta": { "count": 1 } },
+ { "text": "item-2", "meta": { "count": 2 } }
+ ]
+}
diff --git a/packages/fast-html/test/fixtures/observer-map-properties/templates.html b/packages/fast-html/test/fixtures/observer-map-properties/templates.html
new file mode 100644
index 00000000000..7437ecf8063
--- /dev/null
+++ b/packages/fast-html/test/fixtures/observer-map-properties/templates.html
@@ -0,0 +1,55 @@
+
+
+
+
+
+ {{user.name}}
+ {{settings.theme}}
+
+
+
+
+
+
+ {{user.name}}
+ {{settings.theme}}
+
+
+
+
+
+
+
+
+
+
+
+
From 770432d6089941e72d07ec67dca12dd72fcbd57f Mon Sep 17 00:00:00 2001
From: Jane Chu <7559015+janechu@users.noreply.github.com>
Date: Tue, 21 Apr 2026 08:45:18 -0700
Subject: [PATCH 07/11] docs: add DESIGN.md for fast-test-harness package
(#7464)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
# Pull Request
## 📖 Description
Adds a contributor-oriented `DESIGN.md` architecture document for the `@microsoft/fast-test-harness` package. This document describes the internal architecture of the test harness, covering:
- High-level overview of CSR and SSR rendering modes
- Module map and package structure
- Fixture system (`CSRFixture`, `SSRFixture`, fixture options)
- Custom Playwright assertions (`toHaveCustomState`)
- Express + Vite server architecture and request flows
- Consumer-owned SSR contract (required test directory files)
- SSR rendering utilities and DSD template processing
- Asset resolution helpers
- Shared Playwright and Vite configuration
## 👩💻 Reviewer Notes
This is a documentation-only change. The `DESIGN.md` follows the same structure and conventions as the existing `DESIGN.md` files in `packages/fast-build`, `packages/fast-element`, `packages/fast-html`, and `crates/microsoft-fast-build`.
## 📑 Test Plan
Documentation-only change — no code changes. All existing tests continue to pass.
## ✅ Checklist
### General
- [ ] I have included a change request file using `$ npm run change`
- [ ] I have added tests for my changes.
- [ ] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/main/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/main/CODE_OF_CONDUCT.md#our-standards) for this project.
---
packages/fast-test-harness/DESIGN.md | 341 +++++++++++++++++++++++++++
1 file changed, 341 insertions(+)
create mode 100644 packages/fast-test-harness/DESIGN.md
diff --git a/packages/fast-test-harness/DESIGN.md b/packages/fast-test-harness/DESIGN.md
new file mode 100644
index 00000000000..1828daa97f3
--- /dev/null
+++ b/packages/fast-test-harness/DESIGN.md
@@ -0,0 +1,341 @@
+# Design — @microsoft/fast-test-harness
+
+This document describes the internal architecture of the `@microsoft/fast-test-harness` package — a Playwright testing harness for FAST Element web components with CSR and SSR support.
+
+---
+
+## Table of Contents
+
+1. [High-Level Overview](#high-level-overview)
+2. [Module Map](#module-map)
+3. [Fixture System](#fixture-system)
+ - [FixtureOptions](#fixtureoptions)
+ - [CSRFixture](#csrfixture)
+ - [SSRFixture](#ssrfixture)
+4. [Custom Assertions](#custom-assertions)
+5. [Server](#server)
+ - [CSR Request Flow](#csr-request-flow)
+ - [SSR Request Flow](#ssr-request-flow)
+ - [Caching and Deduplication](#caching-and-deduplication)
+6. [SSR Rendering Utilities](#ssr-rendering-utilities)
+ - [renderFixture](#renderfixture)
+ - [renderTemplate](#rendertemplate)
+ - [processDsdTemplate](#processdstemplate)
+ - [injectChildTemplates](#injectchildtemplates)
+ - [renderPreloadLinks](#renderpreloadlinks)
+7. [Asset Resolution](#asset-resolution)
+8. [Configuration Files](#configuration-files)
+ - [Playwright Configuration](#playwright-configuration)
+ - [Vite Configuration](#vite-configuration)
+9. [Exports](#exports)
+
+---
+
+## High-Level Overview
+
+`@microsoft/fast-test-harness` provides a turnkey Playwright testing setup for FAST web components. It extends Playwright's `test` and `expect` with a `fastPage` fixture that manages page setup, template injection, and element stability checks. The harness supports two rendering modes:
+
+- **CSR (Client-Side Rendering)** — navigates to a Vite-served `index.html`, then injects component HTML into the page body via `page.evaluate`.
+- **SSR (Server-Side Rendering)** — posts template configuration to a `/generate-fixture` endpoint, which uses Vite's SSR module loading to render a complete HTML page with Declarative Shadow DOM, then navigates to the generated page.
+
+The mode is selected per test via `test.use({ ssr: true })` or globally via the `PLAYWRIGHT_TEST_SSR=true` environment variable.
+
+```
+test("renders element", async ({ fastPage }) => {
+ await fastPage.setTemplate({ attributes: { label: "Hello" } });
+ await expect(fastPage.element).toBeVisible();
+});
+ │
+ ├── CSR path ──────────────────────────────────────────┐
+ │ page.goto("/") │
+ │ page.evaluate() → inject HTML into │
+ │ waitForCustomElement() + waitForStability() │
+ │ │
+ └── SSR path ──────────────────────────────────────────┐
+ POST /generate-fixture { tagName, attributes, … } │
+ server: vite.ssrLoadModule("entry-server.js") │
+ server: render(queryObj) → { template, fixture } │
+ server: inject into ssr.html → write to temp/ │
+ page.goto("/ssr-.html") │
+ waitForStability() │
+```
+
+---
+
+## Module Map
+
+| File | Role |
+|------|------|
+| `src/index.ts` | Package barrel — re-exports fixtures, assertions, and SSR utilities |
+| `src/fixtures/index.ts` | Extends Playwright's `test` with `fastPage` fixture and `expect` with custom assertions |
+| `src/fixtures/csr-fixture.ts` | `CSRFixture` class — client-side rendering fixture |
+| `src/fixtures/ssr-fixture.ts` | `SSRFixture` class — server-side rendering fixture (extends `CSRFixture`) |
+| `src/fixtures/assertions.ts` | Custom Playwright assertion `toHaveCustomState` |
+| `src/ssr/render.ts` | SSR rendering helpers: `renderFixture`, `renderTemplate`, `renderPreloadLinks` |
+| `src/ssr/assets.ts` | Asset resolution helpers: `readAsset`, `resolveAssetUrl` |
+| `src/ssr/entry-client.ts` | SSR hydration entry point — defines `` for the browser |
+| `server.mjs` | Express + Vite dev server — serves CSR pages and handles SSR fixture generation |
+| `start.mjs` | CLI entry point (`fast-test-harness` bin) — calls `startServer()` |
+| `playwright.config.ts` | Shared Playwright configuration (browsers, web server, test matching) |
+| `vite.config.mjs` | Shared Vite configuration (port, resolve conditions, build settings) |
+| `public/styles.css` | Base CSS reset served as a Vite public asset |
+
+---
+
+## Fixture System
+
+### FixtureOptions
+
+The `test.extend` call in `src/fixtures/index.ts` adds four configurable options to every test:
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `tagName` | `string` | `""` | Custom element tag name used to build the default template and locate the element |
+| `innerHTML` | `string` | `""` | Default inner HTML inserted into the element |
+| `waitFor` | `string[]` | `[]` | Additional custom element tag names to wait for before the test runs |
+| `ssr` | `boolean` | `false` (or `true` if `PLAYWRIGHT_TEST_SSR=true`) | Selects SSR mode |
+
+These are configured per test suite with `test.use()`:
+
+```ts
+test.use({ tagName: "my-button", innerHTML: "Click me" });
+```
+
+The `fastPage` fixture factory reads these options and instantiates either `CSRFixture` or `SSRFixture`. For CSR, it also navigates to `/`, emulates reduced motion, and waits for custom element definitions before handing control to the test.
+
+### CSRFixture
+
+`CSRFixture` is the base class for interacting with a component on a Playwright page.
+
+| Method | Description |
+|--------|-------------|
+| `goto(url)` | Navigates to a URL (defaults to `"/"`) |
+| `setTemplate(templateOrOptions?)` | Injects HTML into ``. Accepts a raw HTML string, an options object (`{ attributes, innerHTML }`), or no argument (uses defaults from `tagName`/`innerHTML`). Waits for stability after injection. |
+| `updateTemplate(locator, options)` | Modifies attributes and/or innerHTML of an already-rendered element in place. Boolean `true` sets the attribute, `false` removes it, strings set the value. |
+| `waitForCustomElement(...tagNames)` | Blocks until all specified elements are defined in `customElements` |
+| `applyTokens(tokens)` | Sets CSS custom properties on `` for design token theming |
+| `addStyleTag(options)` | Delegates to `page.addStyleTag()` |
+
+**Template generation** (`defaultTemplate`): When `setTemplate` receives an options object (or no argument), it builds an HTML string from the `tagName`, serialized attributes, and `innerHTML`. Boolean `true` attributes render as bare attributes (`disabled`), string values render as `key="value"`.
+
+**Stability waiting** (`waitForStability`): After injecting HTML, the fixture waits for (1) all matching elements to be attached, (2) custom element definitions to be registered, and (3) the `` to reach a "stable" state via Playwright's `waitForElementState("stable")`.
+
+### SSRFixture
+
+`SSRFixture` extends `CSRFixture` and overrides `setTemplate` and `addStyleTag` to work with server-side rendering.
+
+| Override | Description |
+|----------|-------------|
+| `addStyleTag` | Buffers style options into `pendingStyles` until `setTemplate` is called. Only `{ content }` options are preserved — the content strings are serialized into the SSR generation request. Style options using `path` or `url` are not included in the SSR output. After `setTemplate`, calls pass through to the page directly. |
+| `setTemplate` | Builds a request body from the template options, posts it to `/generate-fixture`, navigates to the returned URL, and waits for stability. |
+
+**SSR request body construction**: The `setTemplate` override constructs a JSON body with these fields:
+
+| Field | Source |
+|-------|--------|
+| `testId` | Derived from `testInfo.titlePath` — sanitized to `[a-z0-9_-]` |
+| `testTitle` | Formatted from the test title path |
+| `tagName` | From fixture options (when not using raw HTML) |
+| `innerHTML` | From the template options or fixture default |
+| `attributes` | JSON-stringified attribute map |
+| `html` | Raw HTML string (when `templateOrOptions` is a string) |
+| `styles` | JSON-stringified array of CSS content strings from buffered `addStyleTag` calls |
+
+All string values are whitespace-collapsed before sending.
+
+**Test title formatting** (`formatTestTitle`): Converts sanitized test IDs back into human-readable titles. If the ID matches the pattern `-`, it splits sections by `-` and words by `_`, capitalizing each word, joining sections with ` › `, and appending the source file path in parentheses (e.g., `Section One › Section Two (path/to/file.ts)`). IDs that don't match the pattern are split on `_` and capitalized.
+
+---
+
+## Custom Assertions
+
+The `toHaveCustomState` assertion checks whether an element matches the CSS `:state()` pseudo-class, which tests `ElementInternals` custom states:
+
+```ts
+await expect(element).toHaveCustomState("checked");
+```
+
+The assertion evaluates `el.matches(`:state(${state})`)` in the browser via `locator.evaluate` and returns a matcher result compatible with Playwright's `expect.extend` API. It supports `.not` negation.
+
+> **Note:** This is a one-shot evaluation, not a polling/auto-retrying Playwright matcher. The `:state()` check runs once and returns the result immediately. If the state may be set asynchronously, wait for the expected condition before asserting.
+
+---
+
+## Server
+
+The server (`server.mjs`) is an Express application with Vite running in middleware mode. It handles both CSR page serving and SSR fixture generation.
+
+### Consumer-Owned SSR Contract
+
+The harness does **not** contain the SSR entry files itself — they live in the consuming project's test directory. By default, `startServer` looks for files under `/test/`:
+
+| File | Owner | Purpose |
+|------|-------|---------|
+| `test/index.html` | Consumer | CSR entry page — loads the component registration script |
+| `test/ssr.html` | Consumer | SSR template with comment placeholders (``, ``, etc.) |
+| `test/src/entry-server.ts` | Consumer | Exports a `render(queryObj)` function that returns `{ template, fixture, preloadLinks }` |
+| `test/src/entry-client.ts` | Consumer | Registers components for DSD hydration in the browser |
+| `test/vite.config.ts` | Consumer | Vite configuration (can import the shared one from this package) |
+
+The `startServer(cwd, root, configFile)` function accepts overrides for each path:
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `cwd` | `process.cwd()` | Static file serving root |
+| `root` | `/test` | Vite root (contains `index.html`, `ssr.html`) |
+| `configFile` | `/vite.config.ts` | Vite config path |
+
+### Startup
+
+`startServer(cwd, root, configFile)` initializes:
+
+1. A `temp/` directory under `root` for writing SSR fixture files (cleaned on startup)
+2. A Vite dev server in middleware mode, configured to ignore the temp directory
+3. Express middleware stack: Vite middleware → static file serving from `cwd` → route handlers
+
+The server listens on port `5273` by default (configurable via `PORT` environment variable).
+
+### CSR Request Flow
+
+The catch-all `*all` handler serves the Vite-transformed `index.html` for navigation requests (those with `Accept: text/html`). The transformed HTML is cached after the first request. Non-HTML requests (module imports, assets) fall through to Vite's middleware.
+
+```
+Browser GET /
+ → catch-all handler
+ → fs.readFile("index.html")
+ → vite.transformIndexHtml(url, html)
+ → cache and respond with 200
+```
+
+### SSR Request Flow
+
+The `/generate-fixture` POST endpoint handles SSR fixture generation:
+
+```
+Browser POST /generate-fixture { testId, tagName, attributes, … }
+ → validate testId (required, alphanumeric + hyphens/underscores only)
+ → parse attributes and styles from JSON strings
+ → check pendingGenerations deduplication map
+ → read ssr.html template
+ → vite.transformIndexHtml() for module injection
+ → vite.ssrLoadModule("/src/entry-server.js")
+ → call render(body) → { template, fixture, preloadLinks }
+ → replace placeholders in ssr.html:
+ → test title
+ → f-template HTML
+ → rendered element HTML
+ → preload links + inline styles
+ → cache in fixtureCache Map
+ → write to temp/ssr-.html (for debugging)
+ → respond with { url: "/ssr-.html" }
+```
+
+A dedicated `GET /ssr-:id.html` handler serves cached fixtures directly from memory, bypassing the filesystem.
+
+### Caching and Deduplication
+
+| Cache | Purpose |
+|-------|---------|
+| `cachedIndexHtml` | Caches the Vite-transformed `index.html` for CSR — avoids re-reading and re-transforming on every navigation |
+| `fixtureCache` | Maps SSR fixture URLs to their rendered HTML — serves fixtures from memory without filesystem reads |
+| `pendingGenerations` | Deduplicates concurrent SSR generation requests for the same `testId` — if a generation is already in progress, subsequent requests await the same promise |
+
+---
+
+## SSR Rendering Utilities
+
+These functions in `src/ssr/render.ts` are used by consumer `entry-server.ts` modules to build SSR output.
+
+### renderFixture
+
+`renderFixture(queryObj, dsdTemplate?, styles?, templateData?, childTemplates?)` assembles the fixture element HTML.
+
+- If `queryObj.html` is present, uses it as the raw fixture HTML.
+- Otherwise, builds the element from `queryObj.tagName`, `queryObj.attributes` (parsed from JSON), and `queryObj.innerHTML`.
+- When a `dsdTemplate` is provided, it is processed through `processDsdTemplate` to resolve `{{placeholder}}` bindings from the element's attributes and `templateData`.
+- The processed DSD is injected inside the opening tag before the innerHTML.
+- If `childTemplates` is provided, DSD templates are injected into nested custom elements via `injectChildTemplates`.
+
+### renderTemplate
+
+`renderTemplate(rawTemplate, styles)` replaces `{{styles}}` in an f-template HTML string with a `` tag. If no `{{styles}}` placeholder is found and a styles URL is provided, it inserts the link tag after the opening `` tag.
+
+### processDsdTemplate
+
+`processDsdTemplate(dsd, templateValues)` resolves `{{varName}}` placeholders in a DSD template string. It uses a character-scanning approach (not regex) to avoid O(n²) backtracking on untrusted input.
+
+The function handles two contexts:
+
+| Context | Behavior |
+|---------|----------|
+| **Attribute binding** (`attr="{{varName}}"` or `?attr="{{varName}}"`) | Scans backwards from `{{` to find the attribute name and optional `?` boolean prefix. If the value is `undefined`, the entire attribute is removed. For boolean attributes (`?`), a truthy value emits the bare attribute name; falsy removes it. |
+| **Text content** (`{{varName}}` in element body) | Replaces with the stringified value, or empty string if `undefined`. |
+
+Attribute names are also normalized by stripping hyphens (e.g., `my-attr` also checks `myattr`) to support camelCase state properties bound to hyphenated HTML attributes.
+
+### injectChildTemplates
+
+`injectChildTemplates(html, childTemplates)` injects DSD templates into nested custom elements found in an HTML string. It uses a regex with a lookahead (`(?=[\s>/])`) to avoid partial matches on hyphenated names (e.g., `my-radio` does not match `my-radio-group`). Each child element's own attributes are extracted and passed to `processDsdTemplate`.
+
+### renderPreloadLinks
+
+`renderPreloadLinks(styles, tokensThemeUrl?)` generates `` tags: a `stylesheet` link for the theme URL (if provided) and `preload` links for each style URL.
+
+---
+
+## Asset Resolution
+
+The `src/ssr/assets.ts` module provides two helpers for locating files in SSR `entry-server.ts` modules:
+
+| Function | Purpose |
+|----------|---------|
+| `readAsset(specifier)` | Reads a file as a UTF-8 string. Accepts bare package specifiers (resolved via `import.meta.resolve` through `package.json` exports maps) or filesystem paths (resolved relative to `process.cwd()`). |
+| `resolveAssetUrl(specifier, root?)` | Resolves a specifier to a server-relative URL path (starting with `/`) for use in `` tags. The path is made relative to `root` (defaults to `process.cwd()`). |
+
+Both delegate to `resolveSpecifier`, which distinguishes bare specifiers from filesystem paths by checking whether the specifier starts with `.` or `/`.
+
+---
+
+## Configuration Files
+
+### Playwright Configuration
+
+`playwright.config.ts` provides a shared Playwright configuration for consumers:
+
+| Setting | Value |
+|---------|-------|
+| `retries` | `3` |
+| `fullyParallel` | `true` |
+| `reducedMotion` | `"reduce"` |
+| `testMatch` | `src/**/*.pw.spec.ts` |
+| `reporter` | `"list"` |
+| `webServer.command` | `node start.mjs` |
+| `webServer.port` | `5273` |
+| `projects` | Chromium, Firefox, WebKit (Safari with `deviceScaleFactor: 1`) |
+
+### Vite Configuration
+
+`vite.config.mjs` provides a shared Vite configuration:
+
+| Setting | Value |
+|---------|-------|
+| `clearScreen` | `false` |
+| `resolve.conditions` | `["test"]` — enables the `test` condition in `package.json` exports maps, allowing packages to expose source files (`.ts`) directly to Vite instead of compiled output |
+| `server.port` | `5273` (from `PORT` env var) |
+| `server.strictPort` | `true` |
+| `build.minify` | `false` |
+| `build.sourcemap` | `true` |
+
+---
+
+## Exports
+
+| Specifier | Contents |
+|-----------|----------|
+| `@microsoft/fast-test-harness` | `test`, `expect`, `CSRFixture`, `SSRFixture`, `readAsset`, `resolveAssetUrl`, `renderFixture`, `renderTemplate` |
+| `@microsoft/fast-test-harness/server.mjs` | `startServer`, `app` |
+| `@microsoft/fast-test-harness/ssr/render.js` | `renderFixture`, `renderTemplate`, `renderPreloadLinks` |
+| `@microsoft/fast-test-harness/ssr/assets.js` | `readAsset`, `resolveAssetUrl` |
+| `@microsoft/fast-test-harness/playwright.config.ts` | Shared Playwright configuration |
+| `@microsoft/fast-test-harness/vite.config.mjs` | Shared Vite configuration |
+| `@microsoft/fast-test-harness/public/*` | Static assets (base CSS reset) |
From 3fee9d1b8eb4a6380c828c4cc7e9e2d338ffb91d Mon Sep 17 00:00:00 2001
From: Jane Chu <7559015+janechu@users.noreply.github.com>
Date: Tue, 21 Apr 2026 10:02:57 -0700
Subject: [PATCH 08/11] chore: update the copilot instructions and skills for
better agent understanding of the project (#7468)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
# Pull Request
## 📖 Description
This change updates skills and instructions for AI to better understand the project and update it when making changes.
## ✅ Checklist
### General
- [ ] I have included a change request file using `$ npm run change`
- [ ] I have added tests for my changes.
- [x] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/main/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/main/CODE_OF_CONDUCT.md#our-standards) for this project.
---
.github/copilot-instructions.md | 12 +++++++++---
.github/skills/shipping/SKILL.md | 4 +---
.github/workflows/ci-validate-platforms.yml | 4 ++--
.github/workflows/ci-validate-pr.yml | 4 ++--
4 files changed, 14 insertions(+), 10 deletions(-)
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
index 8c826e19b20..97282b0ecf5 100644
--- a/.github/copilot-instructions.md
+++ b/.github/copilot-instructions.md
@@ -16,19 +16,22 @@ FAST (`@microsoft/fast`) is a Microsoft open-source monorepo for building W3C-st
## Packages
+Each package includes a DESIGN.md file, read that to gain a general understanding of the code for that package.
+
| Package | Status | Purpose |
|---|---|---|
| `@microsoft/fast-element` | Stable (v2) | Core Web Component library |
| `@microsoft/fast-html` | Alpha | Declarative HTML parser |
| `@microsoft/fast-router` | Alpha | Web Component router |
| `@microsoft/fast-build` | Prerelease | Declarative HTML server side renderer |
+| `@microsoft/fast-test-harness` | Prerelease | Testing utilities for FASTElement components |
-### Other packages
+### Sites
| Package | Status | Purpose |
|---|---|---|
| `sites/website` | Private (not published as a package) | Documentation website source |
-| `sites/benchmarks` | Private (not published as a package) | Benchmarking utilities |
+| `sites/benchmarks` | Private (not published as a package) | Benchmarking site |
### Example projects
@@ -91,7 +94,8 @@ packages//
```
- Source files use **kebab-case**: `element-controller.ts`, `update-queue.ts`.
-- Test files use `*.pw.spec.ts` suffix, co-located next to the source they test.
+- Playwright test files use `*.pw.spec.ts` suffix, co-located next to the source they test.
+- Node test files use `*.spec.ts` suffix.
## Code Style
@@ -150,3 +154,5 @@ Before finishing any change, run these commands from the monorepo root and confi
- [ ] `npm run test` — all tests pass
- [ ] `npm run biome:check` — Biome linting and formatting pass
- [ ] `npm run checkchange` — beachball change files exist for any `packages/*` changes
+
+Read the [shipping skill](./skills/shipping/SKILL.md) and ensure you have updated everything outlined in that file.
diff --git a/.github/skills/shipping/SKILL.md b/.github/skills/shipping/SKILL.md
index 13a0d0262ec..a5b59ef85db 100644
--- a/.github/skills/shipping/SKILL.md
+++ b/.github/skills/shipping/SKILL.md
@@ -180,9 +180,7 @@ If the breaking change is significant or requires multiple PRs, open a [discussi
# Documentation
-Keep the website documentation in `sites/website/src/docs/` updated when making changes that affect public APIs, behavior, or usage patterns. The documentation is organized by version:
-
-- `sites/website/src/docs/2.x/` — Current version documentation (getting started, guides, advanced topics, API reference).
+After any changes ensure that the documentation is up to date, this includes the files DESIGN.md and README.md files for any packages/crates that have been modified. If your changes update or add to the public API, update the sites/website/src/docs/ files. Only update the latest version, these are denoted by major versions in their folder names inside the docs folder, 1.x, 2.x, etc., find the latest version of the docs and modify them if necessary.
When adding or modifying exported APIs, run the website prebuild script to regenerate API documentation from the api-extractor output:
diff --git a/.github/workflows/ci-validate-platforms.yml b/.github/workflows/ci-validate-platforms.yml
index bc35f42893b..68615481900 100644
--- a/.github/workflows/ci-validate-platforms.yml
+++ b/.github/workflows/ci-validate-platforms.yml
@@ -74,11 +74,11 @@ jobs:
run: cargo install wasm-pack
- name: Build workspaces
- run: npx lage build ${{ github.event_name == 'pull_request' && '--since origin/main' || '' }}
+ run: npx lage build ${{ github.event_name == 'pull_request' && '--since origin/main' || '' }} --allow-no-target-runs
- name: Install playwright dependencies and browsers
run: |
npx playwright install --with-deps
- name: Run tests in all Packages
- run: npx lage test:node test:playwright ${{ github.event_name == 'pull_request' && '--since origin/main' || '' }}
+ run: npx lage test:node test:playwright ${{ github.event_name == 'pull_request' && '--since origin/main' || '' }} --allow-no-target-runs
diff --git a/.github/workflows/ci-validate-pr.yml b/.github/workflows/ci-validate-pr.yml
index 4c693ab7448..3e12f8927f9 100644
--- a/.github/workflows/ci-validate-pr.yml
+++ b/.github/workflows/ci-validate-pr.yml
@@ -58,14 +58,14 @@ jobs:
run: cargo install wasm-pack
- name: Build workspaces
- run: npx lage build ${{ github.event_name == 'pull_request' && format('--since origin/{0}', github.event.pull_request.base.ref) || '' }}
+ run: npx lage build ${{ github.event_name == 'pull_request' && format('--since origin/{0}', github.event.pull_request.base.ref) || '' }} --allow-no-target-runs
- name: Install playwright dependencies and browsers
run: |
npx playwright install --with-deps
- name: Testing unit tests
- run: npx lage test:node test:chromium ${{ github.event_name == 'pull_request' && format('--since origin/{0}', github.event.pull_request.base.ref) || '' }}
+ run: npx lage test:node test:chromium ${{ github.event_name == 'pull_request' && format('--since origin/{0}', github.event.pull_request.base.ref) || '' }} --allow-no-target-runs
- name: Testing final validation
run: npm run test:validation
From 350b535b81ff53925d9d74841dcaeefe29543cc5 Mon Sep 17 00:00:00 2001
From: Microsoft FAST Builds
Date: Wed, 22 Apr 2026 00:29:57 +0000
Subject: [PATCH 09/11] applying package updates
---
...-2751da26-46f3-4c7d-ae10-4437c26b800b.json | 7 ------
...-30f1b1bf-454c-4952-a54c-7a0a5131b741.json | 7 ------
package-lock.json | 4 ++--
packages/fast-html/CHANGELOG.json | 23 +++++++++++++++++++
packages/fast-html/CHANGELOG.md | 10 +++++++-
packages/fast-html/package.json | 2 +-
packages/fast-test-harness/package.json | 2 +-
7 files changed, 36 insertions(+), 19 deletions(-)
delete mode 100644 change/@microsoft-fast-html-2751da26-46f3-4c7d-ae10-4437c26b800b.json
delete mode 100644 change/@microsoft-fast-html-30f1b1bf-454c-4952-a54c-7a0a5131b741.json
diff --git a/change/@microsoft-fast-html-2751da26-46f3-4c7d-ae10-4437c26b800b.json b/change/@microsoft-fast-html-2751da26-46f3-4c7d-ae10-4437c26b800b.json
deleted file mode 100644
index fc4bcbc9cf0..00000000000
--- a/change/@microsoft-fast-html-2751da26-46f3-4c7d-ae10-4437c26b800b.json
+++ /dev/null
@@ -1,7 +0,0 @@
-{
- "type": "prerelease",
- "comment": "feat: add properties path tree to ObserverMapConfig in fast-html",
- "packageName": "@microsoft/fast-html",
- "email": "7559015+janechu@users.noreply.github.com",
- "dependentChangeType": "none"
-}
diff --git a/change/@microsoft-fast-html-30f1b1bf-454c-4952-a54c-7a0a5131b741.json b/change/@microsoft-fast-html-30f1b1bf-454c-4952-a54c-7a0a5131b741.json
deleted file mode 100644
index 6861e2da194..00000000000
--- a/change/@microsoft-fast-html-30f1b1bf-454c-4952-a54c-7a0a5131b741.json
+++ /dev/null
@@ -1,7 +0,0 @@
-{
- "type": "none",
- "comment": "chore: remove @microsoft/fast-ssr",
- "packageName": "@microsoft/fast-html",
- "email": "7559015+janechu@users.noreply.github.com",
- "dependentChangeType": "none"
-}
diff --git a/package-lock.json b/package-lock.json
index da10e83a26d..491d8e15647 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -8598,7 +8598,7 @@
},
"packages/fast-html": {
"name": "@microsoft/fast-html",
- "version": "1.0.0-alpha.49",
+ "version": "1.0.0-alpha.50",
"license": "MIT",
"devDependencies": {
"@microsoft/fast-build": "^0.4.0",
@@ -8642,7 +8642,7 @@
},
"peerDependencies": {
"@microsoft/fast-build": ">=0.4.0 <1.0.0",
- "@microsoft/fast-html": ">=1.0.0-alpha.49 <1.0.0",
+ "@microsoft/fast-html": ">=1.0.0-alpha.50 <1.0.0",
"@playwright/test": ">=1.40.0",
"vite": ">=7.0.0"
},
diff --git a/packages/fast-html/CHANGELOG.json b/packages/fast-html/CHANGELOG.json
index d692f446219..01463b79363 100644
--- a/packages/fast-html/CHANGELOG.json
+++ b/packages/fast-html/CHANGELOG.json
@@ -1,6 +1,29 @@
{
"name": "@microsoft/fast-html",
"entries": [
+ {
+ "date": "Wed, 22 Apr 2026 00:29:57 GMT",
+ "version": "1.0.0-alpha.50",
+ "tag": "@microsoft/fast-html_v1.0.0-alpha.50",
+ "comments": {
+ "prerelease": [
+ {
+ "author": "7559015+janechu@users.noreply.github.com",
+ "package": "@microsoft/fast-html",
+ "commit": "0eb81e0d25fc8d42a032cdba9d6b3d7eac1b5dd2",
+ "comment": "feat: add properties path tree to ObserverMapConfig in fast-html"
+ }
+ ],
+ "none": [
+ {
+ "author": "7559015+janechu@users.noreply.github.com",
+ "package": "@microsoft/fast-html",
+ "commit": "f28432a100e1ee2e2bcd0c6dcd6e61953f777854",
+ "comment": "chore: remove @microsoft/fast-ssr"
+ }
+ ]
+ }
+ },
{
"date": "Tue, 21 Apr 2026 00:05:17 GMT",
"version": "1.0.0-alpha.49",
diff --git a/packages/fast-html/CHANGELOG.md b/packages/fast-html/CHANGELOG.md
index 220569449ff..686f6fd54b6 100644
--- a/packages/fast-html/CHANGELOG.md
+++ b/packages/fast-html/CHANGELOG.md
@@ -1,9 +1,17 @@
# Change Log - @microsoft/fast-html
-
+
+## 1.0.0-alpha.50
+
+Wed, 22 Apr 2026 00:29:57 GMT
+
+### Changes
+
+- feat: add properties path tree to ObserverMapConfig in fast-html (7559015+janechu@users.noreply.github.com)
+
## 1.0.0-alpha.49
Fri, 17 Apr 2026 00:26:37 GMT
diff --git a/packages/fast-html/package.json b/packages/fast-html/package.json
index e6bf7594474..c00dc6e6a42 100644
--- a/packages/fast-html/package.json
+++ b/packages/fast-html/package.json
@@ -1,6 +1,6 @@
{
"name": "@microsoft/fast-html",
- "version": "1.0.0-alpha.49",
+ "version": "1.0.0-alpha.50",
"type": "module",
"author": {
"name": "Microsoft",
diff --git a/packages/fast-test-harness/package.json b/packages/fast-test-harness/package.json
index d324b18249a..35d02859dc9 100644
--- a/packages/fast-test-harness/package.json
+++ b/packages/fast-test-harness/package.json
@@ -53,7 +53,7 @@
},
"peerDependencies": {
"@microsoft/fast-build": ">=0.4.0 <1.0.0",
- "@microsoft/fast-html": ">=1.0.0-alpha.49 <1.0.0",
+ "@microsoft/fast-html": ">=1.0.0-alpha.50 <1.0.0",
"@playwright/test": ">=1.40.0",
"vite": ">=7.0.0"
},
From 9f575eb973e92bdf8412d9b6df4ff2dc1e8672e4 Mon Sep 17 00:00:00 2001
From: Jane Chu <7559015+janechu@users.noreply.github.com>
Date: Tue, 21 Apr 2026 19:27:53 -0700
Subject: [PATCH 10/11] feat: replace rollup-plugin-filesize with esbuild
export size reporting (#7473)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
# Pull Request
## 📖 Description
Replace `rollup-plugin-filesize` with an esbuild-based bundle size measurement script. The new script (`packages/fast-element/scripts/measure-sizes.js`) measures minified, gzip, and brotli sizes for the core bundle and 13 individually tree-shaken exports (FASTElement, Updates, Observable, observable, attr, children, css, ref, slotted, volatile, when, html, repeat). Results are saved to `SIZES.md` and surfaced on the documentation site as a new Package Sizes page under Resources.
### 🎫 Issues
* Resolves https://github.com/microsoft/fast/issues/7249
## 👩💻 Reviewer Notes
The `generate-docs.cjs` prebuild script copies `SIZES.md` from the fast-element package and wraps it with 11ty frontmatter to create the docs page. The introduction page now links to the Package Sizes page instead of hardcoding size numbers.
## 📑 Test Plan
All existing tests pass. Build produces `SIZES.md` with correct size data and the website builds the new package-sizes page successfully.
## ✅ Checklist
### General
- [x] I have included a change request file using `$ npm run change`
- [ ] I have added tests for my changes.
- [x] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/main/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/main/CODE_OF_CONDUCT.md#our-standards) for this project.
## ⏭ Next Steps
* Investigate reducing size due to the use of `requestIdleCallback` (per issue #7249)
* Consider adding type exports to the size tracking (per issue #7249, under consideration)
---
...-5636cb6f-65c6-4c40-b964-d6c4b4b054f6.json | 7 +
package-lock.json | 1652 +----------------
package.json | 1 -
packages/fast-element/DESIGN.md | 6 +
packages/fast-element/README.md | 6 +-
packages/fast-element/SIZES.md | 20 +
packages/fast-element/package.json | 3 +-
packages/fast-element/rollup.config.js | 5 -
.../fast-element/scripts/measure-sizes.js | 110 ++
sites/website/package.json | 2 +-
sites/website/scripts/generate-docs.cjs | 49 +-
sites/website/src/docs/2.x/introduction.md | 2 +-
.../src/docs/2.x/resources/export-sizes.md | 35 +
13 files changed, 250 insertions(+), 1648 deletions(-)
create mode 100644 change/@microsoft-fast-element-5636cb6f-65c6-4c40-b964-d6c4b4b054f6.json
create mode 100644 packages/fast-element/SIZES.md
create mode 100644 packages/fast-element/scripts/measure-sizes.js
create mode 100644 sites/website/src/docs/2.x/resources/export-sizes.md
diff --git a/change/@microsoft-fast-element-5636cb6f-65c6-4c40-b964-d6c4b4b054f6.json b/change/@microsoft-fast-element-5636cb6f-65c6-4c40-b964-d6c4b4b054f6.json
new file mode 100644
index 00000000000..f468ccd0591
--- /dev/null
+++ b/change/@microsoft-fast-element-5636cb6f-65c6-4c40-b964-d6c4b4b054f6.json
@@ -0,0 +1,7 @@
+{
+ "type": "none",
+ "comment": "chore: replace rollup-plugin-filesize with esbuild bundle size reporting",
+ "packageName": "@microsoft/fast-element",
+ "email": "7559015+janechu@users.noreply.github.com",
+ "dependentChangeType": "none"
+}
diff --git a/package-lock.json b/package-lock.json
index 491d8e15647..71afa348775 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -31,7 +31,6 @@
"lage": "2.15.8",
"lefthook": "2.1.4",
"rollup": "4.59.0",
- "rollup-plugin-filesize": "10.0.0",
"typescript": "5.3.3",
"vite": "7.3.2",
"yargs": "17.7.2"
@@ -645,16 +644,6 @@
"node": ">=6.9.0"
}
},
- "node_modules/@babel/runtime": {
- "version": "7.29.2",
- "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.29.2.tgz",
- "integrity": "sha512-JiDShH45zKHWyGe4ZNVRrCjBz8Nh9TMmZG1kh4QTK8hCBTWBi8Da+i7s1fJw7/lYpM4ccepSNfqzZ/QvABBi5g==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=6.9.0"
- }
- },
"node_modules/@biomejs/biome": {
"version": "2.4.8",
"resolved": "https://registry.npmjs.org/@biomejs/biome/-/biome-2.4.8.tgz",
@@ -1324,16 +1313,6 @@
"node": ">=18"
}
},
- "node_modules/@gar/promise-retry": {
- "version": "1.0.3",
- "resolved": "https://registry.npmjs.org/@gar/promise-retry/-/promise-retry-1.0.3.tgz",
- "integrity": "sha512-GmzA9ckNokPypTg10pgpeHNQe7ph+iIKKmhKu3Ob9ANkswreCx7R3cKmY781K8QK3AqVL3xVh9A42JvIAbkkSA==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
"node_modules/@genesiscommunitysuccess/cep-fast-plugin": {
"version": "5.0.3",
"resolved": "https://registry.npmjs.org/@genesiscommunitysuccess/cep-fast-plugin/-/cep-fast-plugin-5.0.3.tgz",
@@ -1428,19 +1407,6 @@
"node": ">=12"
}
},
- "node_modules/@isaacs/fs-minipass": {
- "version": "4.0.1",
- "resolved": "https://registry.npmjs.org/@isaacs/fs-minipass/-/fs-minipass-4.0.1.tgz",
- "integrity": "sha512-wgm9Ehl2jpeqP3zw/7mo3kRHFp5MEDhqAdwy1fTGkHAwnkGOVsgpvQhL8B5n1qlb01jV3n/bI0ZfZp5lWA1k4w==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "minipass": "^7.0.4"
- },
- "engines": {
- "node": ">=18.0.0"
- }
- },
"node_modules/@jridgewell/gen-mapping": {
"version": "0.3.13",
"resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz",
@@ -1741,269 +1707,6 @@
"node": ">= 8"
}
},
- "node_modules/@npmcli/agent": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/@npmcli/agent/-/agent-4.0.0.tgz",
- "integrity": "sha512-kAQTcEN9E8ERLVg5AsGwLNoFb+oEG6engbqAU2P43gD4JEIkNGMHdVQ096FsOAAYpZPB0RSt0zgInKIAS1l5QA==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "agent-base": "^7.1.0",
- "http-proxy-agent": "^7.0.0",
- "https-proxy-agent": "^7.0.1",
- "lru-cache": "^11.2.1",
- "socks-proxy-agent": "^8.0.3"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@npmcli/agent/node_modules/lru-cache": {
- "version": "11.3.5",
- "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.3.5.tgz",
- "integrity": "sha512-NxVFwLAnrd9i7KUBxC4DrUhmgjzOs+1Qm50D3oF1/oL+r1NpZ4gA7xvG0/zJ8evR7zIKn4vLf7qTNduWFtCrRw==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "engines": {
- "node": "20 || >=22"
- }
- },
- "node_modules/@npmcli/fs": {
- "version": "5.0.0",
- "resolved": "https://registry.npmjs.org/@npmcli/fs/-/fs-5.0.0.tgz",
- "integrity": "sha512-7OsC1gNORBEawOa5+j2pXN9vsicaIOH5cPXxoR6fJOmH6/EXpJB2CajXOu1fPRFun2m1lktEFX11+P89hqO/og==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "semver": "^7.3.5"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@npmcli/git": {
- "version": "7.0.2",
- "resolved": "https://registry.npmjs.org/@npmcli/git/-/git-7.0.2.tgz",
- "integrity": "sha512-oeolHDjExNAJAnlYP2qzNjMX/Xi9bmu78C9dIGr4xjobrSKbuMYCph8lTzn4vnW3NjIqVmw/f8BCfouqyJXlRg==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "@gar/promise-retry": "^1.0.0",
- "@npmcli/promise-spawn": "^9.0.0",
- "ini": "^6.0.0",
- "lru-cache": "^11.2.1",
- "npm-pick-manifest": "^11.0.1",
- "proc-log": "^6.0.0",
- "semver": "^7.3.5",
- "which": "^6.0.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@npmcli/git/node_modules/isexe": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/isexe/-/isexe-4.0.0.tgz",
- "integrity": "sha512-FFUtZMpoZ8RqHS3XeXEmHWLA4thH+ZxCv2lOiPIn1Xc7CxrqhWzNSDzD+/chS/zbYezmiwWLdQC09JdQKmthOw==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "engines": {
- "node": ">=20"
- }
- },
- "node_modules/@npmcli/git/node_modules/lru-cache": {
- "version": "11.3.5",
- "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.3.5.tgz",
- "integrity": "sha512-NxVFwLAnrd9i7KUBxC4DrUhmgjzOs+1Qm50D3oF1/oL+r1NpZ4gA7xvG0/zJ8evR7zIKn4vLf7qTNduWFtCrRw==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "engines": {
- "node": "20 || >=22"
- }
- },
- "node_modules/@npmcli/git/node_modules/which": {
- "version": "6.0.1",
- "resolved": "https://registry.npmjs.org/which/-/which-6.0.1.tgz",
- "integrity": "sha512-oGLe46MIrCRqX7ytPUf66EAYvdeMIZYn3WaocqqKZAxrBpkqHfL/qvTyJ/bTk5+AqHCjXmrv3CEWgy368zhRUg==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "isexe": "^4.0.0"
- },
- "bin": {
- "node-which": "bin/which.js"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@npmcli/installed-package-contents": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/@npmcli/installed-package-contents/-/installed-package-contents-4.0.0.tgz",
- "integrity": "sha512-yNyAdkBxB72gtZ4GrwXCM0ZUedo9nIbOMKfGjt6Cu6DXf0p8y1PViZAKDC8q8kv/fufx0WTjRBdSlyrvnP7hmA==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "npm-bundled": "^5.0.0",
- "npm-normalize-package-bin": "^5.0.0"
- },
- "bin": {
- "installed-package-contents": "bin/index.js"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@npmcli/node-gyp": {
- "version": "5.0.0",
- "resolved": "https://registry.npmjs.org/@npmcli/node-gyp/-/node-gyp-5.0.0.tgz",
- "integrity": "sha512-uuG5HZFXLfyFKqg8QypsmgLQW7smiRjVc45bqD/ofZZcR/uxEjgQU8qDPv0s9TEeMUiAAU/GC5bR6++UdTirIQ==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@npmcli/package-json": {
- "version": "7.0.5",
- "resolved": "https://registry.npmjs.org/@npmcli/package-json/-/package-json-7.0.5.tgz",
- "integrity": "sha512-iVuTlG3ORq2iaVa1IWUxAO/jIp77tUKBhoMjuzYW2kL4MLN1bi/ofqkZ7D7OOwh8coAx1/S2ge0rMdGv8sLSOQ==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "@npmcli/git": "^7.0.0",
- "glob": "^13.0.0",
- "hosted-git-info": "^9.0.0",
- "json-parse-even-better-errors": "^5.0.0",
- "proc-log": "^6.0.0",
- "semver": "^7.5.3",
- "spdx-expression-parse": "^4.0.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@npmcli/package-json/node_modules/glob": {
- "version": "13.0.6",
- "resolved": "https://registry.npmjs.org/glob/-/glob-13.0.6.tgz",
- "integrity": "sha512-Wjlyrolmm8uDpm/ogGyXZXb1Z+Ca2B8NbJwqBVg0axK9GbBeoS7yGV6vjXnYdGm6X53iehEuxxbyiKp8QmN4Vw==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "dependencies": {
- "minimatch": "^10.2.2",
- "minipass": "^7.1.3",
- "path-scurry": "^2.0.2"
- },
- "engines": {
- "node": "18 || 20 || >=22"
- },
- "funding": {
- "url": "https://github.com/sponsors/isaacs"
- }
- },
- "node_modules/@npmcli/package-json/node_modules/json-parse-even-better-errors": {
- "version": "5.0.0",
- "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-5.0.0.tgz",
- "integrity": "sha512-ZF1nxZ28VhQouRWhUcVlUIN3qwSgPuswK05s/HIaoetAoE/9tngVmCHjSxmSQPav1nd+lPtTL0YZ/2AFdR/iYQ==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@npmcli/package-json/node_modules/lru-cache": {
- "version": "11.3.5",
- "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.3.5.tgz",
- "integrity": "sha512-NxVFwLAnrd9i7KUBxC4DrUhmgjzOs+1Qm50D3oF1/oL+r1NpZ4gA7xvG0/zJ8evR7zIKn4vLf7qTNduWFtCrRw==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "engines": {
- "node": "20 || >=22"
- }
- },
- "node_modules/@npmcli/package-json/node_modules/path-scurry": {
- "version": "2.0.2",
- "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-2.0.2.tgz",
- "integrity": "sha512-3O/iVVsJAPsOnpwWIeD+d6z/7PmqApyQePUtCndjatj/9I5LylHvt5qluFaBT3I5h3r1ejfR056c+FCv+NnNXg==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "dependencies": {
- "lru-cache": "^11.0.0",
- "minipass": "^7.1.2"
- },
- "engines": {
- "node": "18 || 20 || >=22"
- },
- "funding": {
- "url": "https://github.com/sponsors/isaacs"
- }
- },
- "node_modules/@npmcli/promise-spawn": {
- "version": "9.0.1",
- "resolved": "https://registry.npmjs.org/@npmcli/promise-spawn/-/promise-spawn-9.0.1.tgz",
- "integrity": "sha512-OLUaoqBuyxeTqUvjA3FZFiXUfYC1alp3Sa99gW3EUDz3tZ3CbXDdcZ7qWKBzicrJleIgucoWamWH1saAmH/l2Q==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "which": "^6.0.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@npmcli/promise-spawn/node_modules/isexe": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/isexe/-/isexe-4.0.0.tgz",
- "integrity": "sha512-FFUtZMpoZ8RqHS3XeXEmHWLA4thH+ZxCv2lOiPIn1Xc7CxrqhWzNSDzD+/chS/zbYezmiwWLdQC09JdQKmthOw==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "engines": {
- "node": ">=20"
- }
- },
- "node_modules/@npmcli/promise-spawn/node_modules/which": {
- "version": "6.0.1",
- "resolved": "https://registry.npmjs.org/which/-/which-6.0.1.tgz",
- "integrity": "sha512-oGLe46MIrCRqX7ytPUf66EAYvdeMIZYn3WaocqqKZAxrBpkqHfL/qvTyJ/bTk5+AqHCjXmrv3CEWgy368zhRUg==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "isexe": "^4.0.0"
- },
- "bin": {
- "node-which": "bin/which.js"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@npmcli/redact": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/@npmcli/redact/-/redact-4.0.0.tgz",
- "integrity": "sha512-gOBg5YHMfZy+TfHArfVogwgfBeQnKbbGo3pSUyK/gSI0AVu+pEiDVcKlQb0D8Mg1LNRZILZ6XG8I5dJ4KuAd9Q==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@npmcli/run-script": {
- "version": "10.0.4",
- "resolved": "https://registry.npmjs.org/@npmcli/run-script/-/run-script-10.0.4.tgz",
- "integrity": "sha512-mGUWr1uMnf0le2TwfOZY4SFxZGXGfm4Jtay/nwAa2FLNAKXUoUwaGwBMNH36UHPtinWfTSJ3nqFQr0091CxVGg==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "@npmcli/node-gyp": "^5.0.0",
- "@npmcli/package-json": "^7.0.0",
- "@npmcli/promise-spawn": "^9.0.0",
- "node-gyp": "^12.1.0",
- "proc-log": "^6.0.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
"node_modules/@pkgjs/parseargs": {
"version": "0.11.0",
"resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz",
@@ -2536,86 +2239,6 @@
"string-argv": "~0.3.1"
}
},
- "node_modules/@sigstore/bundle": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/@sigstore/bundle/-/bundle-4.0.0.tgz",
- "integrity": "sha512-NwCl5Y0V6Di0NexvkTqdoVfmjTaQwoLM236r89KEojGmq/jMls8S+zb7yOwAPdXvbwfKDlP+lmXgAL4vKSQT+A==",
- "dev": true,
- "license": "Apache-2.0",
- "dependencies": {
- "@sigstore/protobuf-specs": "^0.5.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@sigstore/core": {
- "version": "3.2.0",
- "resolved": "https://registry.npmjs.org/@sigstore/core/-/core-3.2.0.tgz",
- "integrity": "sha512-kxHrDQ9YgfrWUSXU0cjsQGv8JykOFZQ9ErNKbFPWzk3Hgpwu8x2hHrQ9IdA8yl+j9RTLTC3sAF3Tdq1IQCP4oA==",
- "dev": true,
- "license": "Apache-2.0",
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@sigstore/protobuf-specs": {
- "version": "0.5.1",
- "resolved": "https://registry.npmjs.org/@sigstore/protobuf-specs/-/protobuf-specs-0.5.1.tgz",
- "integrity": "sha512-/ScWUhhoFasJsSRGTVBwId1loQjjnjAfE4djL6ZhrXRpNCmPTnUKF5Jokd58ILseOMjzET3UrMOtJPS9sYeI0g==",
- "dev": true,
- "license": "Apache-2.0",
- "engines": {
- "node": "^18.17.0 || >=20.5.0"
- }
- },
- "node_modules/@sigstore/sign": {
- "version": "4.1.1",
- "resolved": "https://registry.npmjs.org/@sigstore/sign/-/sign-4.1.1.tgz",
- "integrity": "sha512-Hf4xglukg0XXQ2RiD5vSoLjdPe8OBUPA8XeVjUObheuDcWdYWrnH/BNmxZCzkAy68MzmNCxXLeurJvs6hcP2OQ==",
- "dev": true,
- "license": "Apache-2.0",
- "dependencies": {
- "@gar/promise-retry": "^1.0.2",
- "@sigstore/bundle": "^4.0.0",
- "@sigstore/core": "^3.2.0",
- "@sigstore/protobuf-specs": "^0.5.0",
- "make-fetch-happen": "^15.0.4",
- "proc-log": "^6.1.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@sigstore/tuf": {
- "version": "4.0.2",
- "resolved": "https://registry.npmjs.org/@sigstore/tuf/-/tuf-4.0.2.tgz",
- "integrity": "sha512-TCAzTy0xzdP79EnxSjq9KQ3eaR7+FmudLC6eRKknVKZbV7ZNlGLClAAQb/HMNJ5n2OBNk2GT1tEmU0xuPr+SLQ==",
- "dev": true,
- "license": "Apache-2.0",
- "dependencies": {
- "@sigstore/protobuf-specs": "^0.5.0",
- "tuf-js": "^4.1.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/@sigstore/verify": {
- "version": "3.1.0",
- "resolved": "https://registry.npmjs.org/@sigstore/verify/-/verify-3.1.0.tgz",
- "integrity": "sha512-mNe0Iigql08YupSOGv197YdHpPPr+EzDZmfCgMc7RPNaZTw5aLN01nBl6CHJOh3BGtnMIj83EeN4butBchc8Ag==",
- "dev": true,
- "license": "Apache-2.0",
- "dependencies": {
- "@sigstore/bundle": "^4.0.0",
- "@sigstore/core": "^3.1.0",
- "@sigstore/protobuf-specs": "^0.5.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
"node_modules/@sindresorhus/slugify": {
"version": "2.2.1",
"resolved": "https://registry.npmjs.org/@sindresorhus/slugify/-/slugify-2.2.1.tgz",
@@ -2647,30 +2270,6 @@
"url": "https://github.com/sponsors/sindresorhus"
}
},
- "node_modules/@tufjs/canonical-json": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/@tufjs/canonical-json/-/canonical-json-2.0.0.tgz",
- "integrity": "sha512-yVtV8zsdo8qFHe+/3kw81dSLyF7D576A5cCFCi4X7B39tWT7SekaEFUnvnWJHz+9qO7qJTah1JbrDjWKqFtdWA==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": "^16.14.0 || >=18.0.0"
- }
- },
- "node_modules/@tufjs/models": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/@tufjs/models/-/models-4.1.0.tgz",
- "integrity": "sha512-Y8cK9aggNRsqJVaKUlEYs4s7CvQ1b1ta2DVPyAimb0I2qhzjNk+A+mxvll/klL0RlfuIUei8BF7YWiua4kQqww==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "@tufjs/canonical-json": "2.0.0",
- "minimatch": "^10.1.1"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
"node_modules/@types/argparse": {
"version": "1.0.38",
"resolved": "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz",
@@ -2821,16 +2420,6 @@
"integrity": "sha512-RYTOHHdWipFUliRFMCS4X2Yn2X8M87V/OpSqWzKKOGhzqyUxzyVmhHDH9sAvG+ZuQf/TAOFsLCpMw09I1ufUnA==",
"license": "MIT"
},
- "node_modules/abbrev": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-4.0.0.tgz",
- "integrity": "sha512-a1wflyaL0tHtJSmLSOVybYhy22vRih4eduhhrkcjgrWGnRfrZtovJ2FRjxuTtkkj47O/baf0R86QU5OuYpz8fA==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
"node_modules/accepts": {
"version": "1.3.8",
"resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz",
@@ -2869,16 +2458,6 @@
"node": ">=0.4.0"
}
},
- "node_modules/agent-base": {
- "version": "7.1.4",
- "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.4.tgz",
- "integrity": "sha512-MnA+YT8fwfJPgBx3m60MNqakm30XOkyIoH1y6huTQvC0PwZG7ki8NacLBcrPbNoo8vEZy7Jpuk7+jMO+CUovTQ==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">= 14"
- }
- },
"node_modules/ajv": {
"version": "8.18.0",
"resolved": "https://registry.npmjs.org/ajv/-/ajv-8.18.0.tgz",
@@ -2926,83 +2505,28 @@
}
}
},
- "node_modules/ansi-align": {
- "version": "3.0.1",
- "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz",
- "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==",
+ "node_modules/ansi-regex": {
+ "version": "6.2.2",
+ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz",
+ "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==",
"dev": true,
- "license": "ISC",
- "dependencies": {
- "string-width": "^4.1.0"
+ "license": "MIT",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-regex?sponsor=1"
}
},
- "node_modules/ansi-align/node_modules/ansi-regex": {
- "version": "5.0.1",
- "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
- "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
+ "node_modules/ansi-styles": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+ "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
"dev": true,
"license": "MIT",
- "engines": {
- "node": ">=8"
- }
- },
- "node_modules/ansi-align/node_modules/emoji-regex": {
- "version": "8.0.0",
- "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
- "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==",
- "dev": true,
- "license": "MIT"
- },
- "node_modules/ansi-align/node_modules/string-width": {
- "version": "4.2.3",
- "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
- "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "emoji-regex": "^8.0.0",
- "is-fullwidth-code-point": "^3.0.0",
- "strip-ansi": "^6.0.1"
- },
- "engines": {
- "node": ">=8"
- }
- },
- "node_modules/ansi-align/node_modules/strip-ansi": {
- "version": "6.0.1",
- "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
- "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "ansi-regex": "^5.0.1"
- },
- "engines": {
- "node": ">=8"
- }
- },
- "node_modules/ansi-regex": {
- "version": "6.2.2",
- "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz",
- "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=12"
- },
- "funding": {
- "url": "https://github.com/chalk/ansi-regex?sponsor=1"
- }
- },
- "node_modules/ansi-styles": {
- "version": "4.3.0",
- "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
- "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "color-convert": "^2.0.1"
- },
+ "dependencies": {
+ "color-convert": "^2.0.1"
+ },
"engines": {
"node": ">=8"
},
@@ -3226,92 +2750,6 @@
"dev": true,
"license": "ISC"
},
- "node_modules/boxen": {
- "version": "5.1.2",
- "resolved": "https://registry.npmjs.org/boxen/-/boxen-5.1.2.tgz",
- "integrity": "sha512-9gYgQKXx+1nP8mP7CzFyaUARhg7D3n1dF/FnErWmu9l6JvGpNUN278h0aSb+QjoiKSWG+iZ3uHrcqk0qrY9RQQ==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "ansi-align": "^3.0.0",
- "camelcase": "^6.2.0",
- "chalk": "^4.1.0",
- "cli-boxes": "^2.2.1",
- "string-width": "^4.2.2",
- "type-fest": "^0.20.2",
- "widest-line": "^3.1.0",
- "wrap-ansi": "^7.0.0"
- },
- "engines": {
- "node": ">=10"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
- "node_modules/boxen/node_modules/ansi-regex": {
- "version": "5.0.1",
- "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
- "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=8"
- }
- },
- "node_modules/boxen/node_modules/emoji-regex": {
- "version": "8.0.0",
- "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
- "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==",
- "dev": true,
- "license": "MIT"
- },
- "node_modules/boxen/node_modules/string-width": {
- "version": "4.2.3",
- "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
- "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "emoji-regex": "^8.0.0",
- "is-fullwidth-code-point": "^3.0.0",
- "strip-ansi": "^6.0.1"
- },
- "engines": {
- "node": ">=8"
- }
- },
- "node_modules/boxen/node_modules/strip-ansi": {
- "version": "6.0.1",
- "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
- "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "ansi-regex": "^5.0.1"
- },
- "engines": {
- "node": ">=8"
- }
- },
- "node_modules/boxen/node_modules/wrap-ansi": {
- "version": "7.0.0",
- "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
- "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "ansi-styles": "^4.0.0",
- "string-width": "^4.1.0",
- "strip-ansi": "^6.0.0"
- },
- "engines": {
- "node": ">=10"
- },
- "funding": {
- "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
- }
- },
"node_modules/brace-expansion": {
"version": "5.0.5",
"resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.5.tgz",
@@ -3337,19 +2775,6 @@
"node": ">=8"
}
},
- "node_modules/brotli-size": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/brotli-size/-/brotli-size-4.0.0.tgz",
- "integrity": "sha512-uA9fOtlTRC0iqKfzff1W34DXUA3GyVqbUaeo3Rw3d4gd1eavKVCETXrn3NzO74W+UVkG3UHu8WxUi+XvKI/huA==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "duplexer": "0.1.1"
- },
- "engines": {
- "node": ">= 10.16.0"
- }
- },
"node_modules/buffer-from": {
"version": "1.1.2",
"resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz",
@@ -3366,73 +2791,6 @@
"node": ">= 0.8"
}
},
- "node_modules/cacache": {
- "version": "20.0.4",
- "resolved": "https://registry.npmjs.org/cacache/-/cacache-20.0.4.tgz",
- "integrity": "sha512-M3Lab8NPYlZU2exsL3bMVvMrMqgwCnMWfdZbK28bn3pK6APT/Te/I8hjRPNu1uwORY9a1eEQoifXbKPQMfMTOA==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "@npmcli/fs": "^5.0.0",
- "fs-minipass": "^3.0.0",
- "glob": "^13.0.0",
- "lru-cache": "^11.1.0",
- "minipass": "^7.0.3",
- "minipass-collect": "^2.0.1",
- "minipass-flush": "^1.0.5",
- "minipass-pipeline": "^1.2.4",
- "p-map": "^7.0.2",
- "ssri": "^13.0.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/cacache/node_modules/glob": {
- "version": "13.0.6",
- "resolved": "https://registry.npmjs.org/glob/-/glob-13.0.6.tgz",
- "integrity": "sha512-Wjlyrolmm8uDpm/ogGyXZXb1Z+Ca2B8NbJwqBVg0axK9GbBeoS7yGV6vjXnYdGm6X53iehEuxxbyiKp8QmN4Vw==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "dependencies": {
- "minimatch": "^10.2.2",
- "minipass": "^7.1.3",
- "path-scurry": "^2.0.2"
- },
- "engines": {
- "node": "18 || 20 || >=22"
- },
- "funding": {
- "url": "https://github.com/sponsors/isaacs"
- }
- },
- "node_modules/cacache/node_modules/lru-cache": {
- "version": "11.3.5",
- "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.3.5.tgz",
- "integrity": "sha512-NxVFwLAnrd9i7KUBxC4DrUhmgjzOs+1Qm50D3oF1/oL+r1NpZ4gA7xvG0/zJ8evR7zIKn4vLf7qTNduWFtCrRw==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "engines": {
- "node": "20 || >=22"
- }
- },
- "node_modules/cacache/node_modules/path-scurry": {
- "version": "2.0.2",
- "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-2.0.2.tgz",
- "integrity": "sha512-3O/iVVsJAPsOnpwWIeD+d6z/7PmqApyQePUtCndjatj/9I5LylHvt5qluFaBT3I5h3r1ejfR056c+FCv+NnNXg==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "dependencies": {
- "lru-cache": "^11.0.0",
- "minipass": "^7.1.2"
- },
- "engines": {
- "node": "18 || 20 || >=22"
- },
- "funding": {
- "url": "https://github.com/sponsors/isaacs"
- }
- },
"node_modules/call-bind-apply-helpers": {
"version": "1.0.2",
"resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz",
@@ -3472,19 +2830,6 @@
"node": ">=6"
}
},
- "node_modules/camelcase": {
- "version": "6.3.0",
- "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz",
- "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=10"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
"node_modules/chalk": {
"version": "4.1.2",
"resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
@@ -3539,29 +2884,6 @@
"fsevents": "~2.3.2"
}
},
- "node_modules/chownr": {
- "version": "3.0.0",
- "resolved": "https://registry.npmjs.org/chownr/-/chownr-3.0.0.tgz",
- "integrity": "sha512-+IxzY9BZOQd/XuYPRmrvEVjF/nqj5kgT4kEq7VofrDoM1MxoRjEWkrCC3EtLi59TVawxTAn+orJwFQcrqEN1+g==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "engines": {
- "node": ">=18"
- }
- },
- "node_modules/cli-boxes": {
- "version": "2.2.1",
- "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-2.2.1.tgz",
- "integrity": "sha512-y4coMcylgSCdVinjiDBuR8PCC2bLjyGTwEmPb9NHR/QaNU6EUOXcTY/s6VjGMD6ENSEaeQYHCY0GNGS5jfMwPw==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=6"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
"node_modules/cliui": {
"version": "8.0.1",
"resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz",
@@ -3660,16 +2982,6 @@
"dev": true,
"license": "MIT"
},
- "node_modules/colors": {
- "version": "1.4.0",
- "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz",
- "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=0.1.90"
- }
- },
"node_modules/command-line-args": {
"version": "5.1.2",
"resolved": "https://registry.npmjs.org/command-line-args/-/command-line-args-5.1.2.tgz",
@@ -4024,12 +3336,6 @@
"node": ">= 0.4"
}
},
- "node_modules/duplexer": {
- "version": "0.1.1",
- "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.1.tgz",
- "integrity": "sha512-sxNZ+ljy+RA1maXoUReeqBBpBC6RLKmg5ewzV+x+mSETmWNoKdZN6vcQjpFROemza23hGFskJtFNoUWUaQ+R4Q==",
- "dev": true
- },
"node_modules/eastasianwidth": {
"version": "0.2.0",
"resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz",
@@ -4081,13 +3387,6 @@
"node": ">=6"
}
},
- "node_modules/err-code": {
- "version": "2.0.3",
- "resolved": "https://registry.npmjs.org/err-code/-/err-code-2.0.3.tgz",
- "integrity": "sha512-2bmlRpNKBxT/CRmPOlyISQpNj+qSeYvcym/uT0Jx2bMOlKLtSy1ZmLuVxSEKKyor/N5yhvp/ZiG1oE3DEYMSFA==",
- "dev": true,
- "license": "MIT"
- },
"node_modules/errno": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/errno/-/errno-1.0.0.tgz",
@@ -4297,13 +3596,6 @@
"url": "https://github.com/sindresorhus/execa?sponsor=1"
}
},
- "node_modules/exponential-backoff": {
- "version": "3.1.3",
- "resolved": "https://registry.npmjs.org/exponential-backoff/-/exponential-backoff-3.1.3.tgz",
- "integrity": "sha512-ZgEeZXj30q+I0EN+CbSSpIyPaJ5HVQD18Z1m+u1FXbAeT94mr1zw50q4q6jiiC447Nl/YTcIYSAftiGqetwXCA==",
- "dev": true,
- "license": "Apache-2.0"
- },
"node_modules/express": {
"version": "4.22.1",
"resolved": "https://registry.npmjs.org/express/-/express-4.22.1.tgz",
@@ -4429,16 +3721,6 @@
}
}
},
- "node_modules/filesize": {
- "version": "6.4.0",
- "resolved": "https://registry.npmjs.org/filesize/-/filesize-6.4.0.tgz",
- "integrity": "sha512-mjFIpOHC4jbfcTfoh4rkWpI31mF7viw9ikj/JyLoKzqlwG/YsefKfvYlYhdYdg/9mtK2z1AzgN/0LvVQ3zdlSQ==",
- "dev": true,
- "license": "BSD-3-Clause",
- "engines": {
- "node": ">= 0.4.0"
- }
- },
"node_modules/fill-range": {
"version": "7.1.1",
"resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
@@ -4555,19 +3837,6 @@
"node": ">=14.14"
}
},
- "node_modules/fs-minipass": {
- "version": "3.0.3",
- "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-3.0.3.tgz",
- "integrity": "sha512-XUBA9XClHbnJWSfBzjkm6RvPsyg3sryZt06BEQoXcF7EK/xpGaQYJgQKDJSUH5SGZ76Y7pFx1QBnXz09rU5Fbw==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "minipass": "^7.0.3"
- },
- "engines": {
- "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
- }
- },
"node_modules/fsevents": {
"version": "2.3.3",
"resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz",
@@ -4921,29 +4190,6 @@
"js-yaml": "bin/js-yaml.js"
}
},
- "node_modules/gzip-size": {
- "version": "6.0.0",
- "resolved": "https://registry.npmjs.org/gzip-size/-/gzip-size-6.0.0.tgz",
- "integrity": "sha512-ax7ZYomf6jqPTQ4+XCpUGyXKHk5WweS+e05MBO4/y3WJ5RkmPXNKvX+bx1behVILVwr6JSQvZAku021CHPXG3Q==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "duplexer": "^0.1.2"
- },
- "engines": {
- "node": ">=10"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
- "node_modules/gzip-size/node_modules/duplexer": {
- "version": "0.1.2",
- "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz",
- "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==",
- "dev": true,
- "license": "MIT"
- },
"node_modules/has-flag": {
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
@@ -4987,29 +4233,6 @@
"he": "bin/he"
}
},
- "node_modules/hosted-git-info": {
- "version": "9.0.2",
- "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-9.0.2.tgz",
- "integrity": "sha512-M422h7o/BR3rmCQ8UHi7cyyMqKltdP9Uo+J2fXK+RSAY+wTcKOIRyhTuKv4qn+DJf3g+PL890AzId5KZpX+CBg==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "lru-cache": "^11.1.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/hosted-git-info/node_modules/lru-cache": {
- "version": "11.3.5",
- "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.3.5.tgz",
- "integrity": "sha512-NxVFwLAnrd9i7KUBxC4DrUhmgjzOs+1Qm50D3oF1/oL+r1NpZ4gA7xvG0/zJ8evR7zIKn4vLf7qTNduWFtCrRw==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "engines": {
- "node": "20 || >=22"
- }
- },
"node_modules/htmlparser2": {
"version": "7.2.0",
"resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-7.2.0.tgz",
@@ -5093,13 +4316,6 @@
"url": "https://github.com/fb55/entities?sponsor=1"
}
},
- "node_modules/http-cache-semantics": {
- "version": "4.2.0",
- "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz",
- "integrity": "sha512-dTxcvPXqPvXBQpq5dUr6mEMJX4oIEFv6bwom3FDwKRDsuIjjJGANqhBuoAn9c1RQJIdAKav33ED65E2ys+87QQ==",
- "dev": true,
- "license": "BSD-2-Clause"
- },
"node_modules/http-equiv-refresh": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/http-equiv-refresh/-/http-equiv-refresh-2.0.1.tgz",
@@ -5129,84 +4345,6 @@
"url": "https://opencollective.com/express"
}
},
- "node_modules/http-proxy-agent": {
- "version": "7.0.2",
- "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-7.0.2.tgz",
- "integrity": "sha512-T1gkAiYYDWYx3V5Bmyu7HcfcvL7mUrTWiM6yOfa3PIphViJ/gFPbvidQ+veqSOHci/PxBcDabeUNCzpOODJZig==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "agent-base": "^7.1.0",
- "debug": "^4.3.4"
- },
- "engines": {
- "node": ">= 14"
- }
- },
- "node_modules/http-proxy-agent/node_modules/debug": {
- "version": "4.4.3",
- "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz",
- "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "ms": "^2.1.3"
- },
- "engines": {
- "node": ">=6.0"
- },
- "peerDependenciesMeta": {
- "supports-color": {
- "optional": true
- }
- }
- },
- "node_modules/http-proxy-agent/node_modules/ms": {
- "version": "2.1.3",
- "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
- "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
- "dev": true,
- "license": "MIT"
- },
- "node_modules/https-proxy-agent": {
- "version": "7.0.6",
- "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz",
- "integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "agent-base": "^7.1.2",
- "debug": "4"
- },
- "engines": {
- "node": ">= 14"
- }
- },
- "node_modules/https-proxy-agent/node_modules/debug": {
- "version": "4.4.3",
- "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz",
- "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "ms": "^2.1.3"
- },
- "engines": {
- "node": ">=6.0"
- },
- "peerDependenciesMeta": {
- "supports-color": {
- "optional": true
- }
- }
- },
- "node_modules/https-proxy-agent/node_modules/ms": {
- "version": "2.1.3",
- "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
- "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
- "dev": true,
- "license": "MIT"
- },
"node_modules/human-signals": {
"version": "2.1.0",
"resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz",
@@ -5240,19 +4378,6 @@
"node": ">= 4"
}
},
- "node_modules/ignore-walk": {
- "version": "8.0.0",
- "resolved": "https://registry.npmjs.org/ignore-walk/-/ignore-walk-8.0.0.tgz",
- "integrity": "sha512-FCeMZT4NiRQGh+YkeKMtWrOmBgWjHjMJ26WQWrRQyoyzqevdaGSakUaJW5xQYmjLlUVk2qUnCjYVBax9EKKg8A==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "minimatch": "^10.0.3"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
"node_modules/import-fresh": {
"version": "3.3.1",
"resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz",
@@ -5285,26 +4410,6 @@
"integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==",
"license": "ISC"
},
- "node_modules/ini": {
- "version": "6.0.0",
- "resolved": "https://registry.npmjs.org/ini/-/ini-6.0.0.tgz",
- "integrity": "sha512-IBTdIkzZNOpqm7q3dRqJvMaldXjDHWkEDfrwGEQTs5eaQMWV+djAhR+wahyNNMAa+qpbDUhBMVt4ZKNwpPm7xQ==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/ip-address": {
- "version": "10.1.0",
- "resolved": "https://registry.npmjs.org/ip-address/-/ip-address-10.1.0.tgz",
- "integrity": "sha512-XXADHxXmvT9+CRxhXg56LJovE+bmWnEWB78LB83VZTprKTmaC5QfruXocxzTZ2Kl0DNwKuBdlIhjL8LeY8Sf8Q==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">= 12"
- }
- },
"node_modules/ipaddr.js": {
"version": "1.9.1",
"resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz",
@@ -5555,16 +4660,6 @@
"graceful-fs": "^4.1.6"
}
},
- "node_modules/jsonparse": {
- "version": "1.3.1",
- "resolved": "https://registry.npmjs.org/jsonparse/-/jsonparse-1.3.1.tgz",
- "integrity": "sha512-POQXvpdL69+CluYsillJ7SUhKvytYjW9vG/GKpnf+xP8UWgYEM/RaMzHHofbALDiKbbP1W8UEYmgGl39WkPZsg==",
- "dev": true,
- "engines": [
- "node >= 0.2.0"
- ],
- "license": "MIT"
- },
"node_modules/junk": {
"version": "3.1.0",
"resolved": "https://registry.npmjs.org/junk/-/junk-3.1.0.tgz",
@@ -5856,40 +4951,6 @@
"node": ">=12"
}
},
- "node_modules/make-fetch-happen": {
- "version": "15.0.5",
- "resolved": "https://registry.npmjs.org/make-fetch-happen/-/make-fetch-happen-15.0.5.tgz",
- "integrity": "sha512-uCbIa8jWWmQZt4dSnEStkVC6gdakiinAm4PiGsywIkguF0eWMdcjDz0ECYhUolFU3pFLOev9VNPCEygydXnddg==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "@gar/promise-retry": "^1.0.0",
- "@npmcli/agent": "^4.0.0",
- "@npmcli/redact": "^4.0.0",
- "cacache": "^20.0.1",
- "http-cache-semantics": "^4.1.1",
- "minipass": "^7.0.2",
- "minipass-fetch": "^5.0.0",
- "minipass-flush": "^1.0.5",
- "minipass-pipeline": "^1.2.4",
- "negotiator": "^1.0.0",
- "proc-log": "^6.0.0",
- "ssri": "^13.0.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/make-fetch-happen/node_modules/negotiator": {
- "version": "1.0.0",
- "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-1.0.0.tgz",
- "integrity": "sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">= 0.6"
- }
- },
"node_modules/markdown-it": {
"version": "14.1.1",
"resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.1.tgz",
@@ -6101,147 +5162,6 @@
"node": ">=16 || 14 >=14.17"
}
},
- "node_modules/minipass-collect": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/minipass-collect/-/minipass-collect-2.0.1.tgz",
- "integrity": "sha512-D7V8PO9oaz7PWGLbCACuI1qEOsq7UKfLotx/C0Aet43fCUB/wfQ7DYeq2oR/svFJGYDHPr38SHATeaj/ZoKHKw==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "minipass": "^7.0.3"
- },
- "engines": {
- "node": ">=16 || 14 >=14.17"
- }
- },
- "node_modules/minipass-fetch": {
- "version": "5.0.2",
- "resolved": "https://registry.npmjs.org/minipass-fetch/-/minipass-fetch-5.0.2.tgz",
- "integrity": "sha512-2d0q2a8eCi2IRg/IGubCNRJoYbA1+YPXAzQVRFmB45gdGZafyivnZ5YSEfo3JikbjGxOdntGFvBQGqaSMXlAFQ==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "minipass": "^7.0.3",
- "minipass-sized": "^2.0.0",
- "minizlib": "^3.0.1"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- },
- "optionalDependencies": {
- "iconv-lite": "^0.7.2"
- }
- },
- "node_modules/minipass-fetch/node_modules/iconv-lite": {
- "version": "0.7.2",
- "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.7.2.tgz",
- "integrity": "sha512-im9DjEDQ55s9fL4EYzOAv0yMqmMBSZp6G0VvFyTMPKWxiSBHUj9NW/qqLmXUwXrrM7AvqSlTCfvqRb0cM8yYqw==",
- "dev": true,
- "license": "MIT",
- "optional": true,
- "dependencies": {
- "safer-buffer": ">= 2.1.2 < 3.0.0"
- },
- "engines": {
- "node": ">=0.10.0"
- },
- "funding": {
- "type": "opencollective",
- "url": "https://opencollective.com/express"
- }
- },
- "node_modules/minipass-flush": {
- "version": "1.0.7",
- "resolved": "https://registry.npmjs.org/minipass-flush/-/minipass-flush-1.0.7.tgz",
- "integrity": "sha512-TbqTz9cUwWyHS2Dy89P3ocAGUGxKjjLuR9z8w4WUTGAVgEj17/4nhgo2Du56i0Fm3Pm30g4iA8Lcqctc76jCzA==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "dependencies": {
- "minipass": "^3.0.0"
- },
- "engines": {
- "node": ">= 8"
- }
- },
- "node_modules/minipass-flush/node_modules/minipass": {
- "version": "3.3.6",
- "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz",
- "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "yallist": "^4.0.0"
- },
- "engines": {
- "node": ">=8"
- }
- },
- "node_modules/minipass-flush/node_modules/yallist": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
- "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==",
- "dev": true,
- "license": "ISC"
- },
- "node_modules/minipass-pipeline": {
- "version": "1.2.4",
- "resolved": "https://registry.npmjs.org/minipass-pipeline/-/minipass-pipeline-1.2.4.tgz",
- "integrity": "sha512-xuIq7cIOt09RPRJ19gdi4b+RiNvDFYe5JH+ggNvBqGqpQXcru3PcRmOZuHBKWK1Txf9+cQ+HMVN4d6z46LZP7A==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "minipass": "^3.0.0"
- },
- "engines": {
- "node": ">=8"
- }
- },
- "node_modules/minipass-pipeline/node_modules/minipass": {
- "version": "3.3.6",
- "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz",
- "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "yallist": "^4.0.0"
- },
- "engines": {
- "node": ">=8"
- }
- },
- "node_modules/minipass-pipeline/node_modules/yallist": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
- "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==",
- "dev": true,
- "license": "ISC"
- },
- "node_modules/minipass-sized": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/minipass-sized/-/minipass-sized-2.0.0.tgz",
- "integrity": "sha512-zSsHhto5BcUVM2m1LurnXY6M//cGhVaegT71OfOXoprxT6o780GZd792ea6FfrQkuU4usHZIUczAQMRUE2plzA==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "minipass": "^7.1.2"
- },
- "engines": {
- "node": ">=8"
- }
- },
- "node_modules/minizlib": {
- "version": "3.1.0",
- "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-3.1.0.tgz",
- "integrity": "sha512-KZxYo1BUkWD2TVFLr0MQoM8vUUigWD3LlD83a/75BqC+4qE0Hb1Vo5v1FgcfaNXvfXzr+5EhQ6ing/CaBijTlw==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "minipass": "^7.1.2"
- },
- "engines": {
- "node": ">= 18"
- }
- },
"node_modules/moo": {
"version": "0.5.2",
"resolved": "https://registry.npmjs.org/moo/-/moo-0.5.2.tgz",
@@ -6288,57 +5208,6 @@
"node": ">= 0.6"
}
},
- "node_modules/node-gyp": {
- "version": "12.2.0",
- "resolved": "https://registry.npmjs.org/node-gyp/-/node-gyp-12.2.0.tgz",
- "integrity": "sha512-q23WdzrQv48KozXlr0U1v9dwO/k59NHeSzn6loGcasyf0UnSrtzs8kRxM+mfwJSf0DkX0s43hcqgnSO4/VNthQ==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "env-paths": "^2.2.0",
- "exponential-backoff": "^3.1.1",
- "graceful-fs": "^4.2.6",
- "make-fetch-happen": "^15.0.0",
- "nopt": "^9.0.0",
- "proc-log": "^6.0.0",
- "semver": "^7.3.5",
- "tar": "^7.5.4",
- "tinyglobby": "^0.2.12",
- "which": "^6.0.0"
- },
- "bin": {
- "node-gyp": "bin/node-gyp.js"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/node-gyp/node_modules/isexe": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/isexe/-/isexe-4.0.0.tgz",
- "integrity": "sha512-FFUtZMpoZ8RqHS3XeXEmHWLA4thH+ZxCv2lOiPIn1Xc7CxrqhWzNSDzD+/chS/zbYezmiwWLdQC09JdQKmthOw==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "engines": {
- "node": ">=20"
- }
- },
- "node_modules/node-gyp/node_modules/which": {
- "version": "6.0.1",
- "resolved": "https://registry.npmjs.org/which/-/which-6.0.1.tgz",
- "integrity": "sha512-oGLe46MIrCRqX7ytPUf66EAYvdeMIZYn3WaocqqKZAxrBpkqHfL/qvTyJ/bTk5+AqHCjXmrv3CEWgy368zhRUg==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "isexe": "^4.0.0"
- },
- "bin": {
- "node-which": "bin/which.js"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
"node_modules/node-html-parser": {
"version": "6.1.13",
"resolved": "https://registry.npmjs.org/node-html-parser/-/node-html-parser-6.1.13.tgz",
@@ -6361,22 +5230,6 @@
"esm-import-transformer": "^3.0.3"
}
},
- "node_modules/nopt": {
- "version": "9.0.0",
- "resolved": "https://registry.npmjs.org/nopt/-/nopt-9.0.0.tgz",
- "integrity": "sha512-Zhq3a+yFKrYwSBluL4H9XP3m3y5uvQkB/09CwDruCiRmR/UJYnn9W4R48ry0uGC70aeTPKLynBtscP9efFFcPw==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "abbrev": "^4.0.0"
- },
- "bin": {
- "nopt": "bin/nopt.js"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
"node_modules/normalize-path": {
"version": "3.0.0",
"resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz",
@@ -6386,108 +5239,6 @@
"node": ">=0.10.0"
}
},
- "node_modules/npm-bundled": {
- "version": "5.0.0",
- "resolved": "https://registry.npmjs.org/npm-bundled/-/npm-bundled-5.0.0.tgz",
- "integrity": "sha512-JLSpbzh6UUXIEoqPsYBvVNVmyrjVZ1fzEFbqxKkTJQkWBO3xFzFT+KDnSKQWwOQNbuWRwt5LSD6HOTLGIWzfrw==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "npm-normalize-package-bin": "^5.0.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/npm-install-checks": {
- "version": "8.0.0",
- "resolved": "https://registry.npmjs.org/npm-install-checks/-/npm-install-checks-8.0.0.tgz",
- "integrity": "sha512-ScAUdMpyzkbpxoNekQ3tNRdFI8SJ86wgKZSQZdUxT+bj0wVFpsEMWnkXP0twVe1gJyNF5apBWDJhhIbgrIViRA==",
- "dev": true,
- "license": "BSD-2-Clause",
- "dependencies": {
- "semver": "^7.1.1"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/npm-normalize-package-bin": {
- "version": "5.0.0",
- "resolved": "https://registry.npmjs.org/npm-normalize-package-bin/-/npm-normalize-package-bin-5.0.0.tgz",
- "integrity": "sha512-CJi3OS4JLsNMmr2u07OJlhcrPxCeOeP/4xq67aWNai6TNWWbTrlNDgl8NcFKVlcBKp18GPj+EzbNIgrBfZhsag==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/npm-package-arg": {
- "version": "13.0.2",
- "resolved": "https://registry.npmjs.org/npm-package-arg/-/npm-package-arg-13.0.2.tgz",
- "integrity": "sha512-IciCE3SY3uE84Ld8WZU23gAPPV9rIYod4F+rc+vJ7h7cwAJt9Vk6TVsK60ry7Uj3SRS3bqRRIGuTp9YVlk6WNA==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "hosted-git-info": "^9.0.0",
- "proc-log": "^6.0.0",
- "semver": "^7.3.5",
- "validate-npm-package-name": "^7.0.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/npm-packlist": {
- "version": "10.0.4",
- "resolved": "https://registry.npmjs.org/npm-packlist/-/npm-packlist-10.0.4.tgz",
- "integrity": "sha512-uMW73iajD8hiH4ZBxEV3HC+eTnppIqwakjOYuvgddnalIw2lJguKviK1pcUJDlIWm1wSJkchpDZDSVVsZEYRng==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "ignore-walk": "^8.0.0",
- "proc-log": "^6.0.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/npm-pick-manifest": {
- "version": "11.0.3",
- "resolved": "https://registry.npmjs.org/npm-pick-manifest/-/npm-pick-manifest-11.0.3.tgz",
- "integrity": "sha512-buzyCfeoGY/PxKqmBqn1IUJrZnUi1VVJTdSSRPGI60tJdUhUoSQFhs0zycJokDdOznQentgrpf8LayEHyyYlqQ==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "npm-install-checks": "^8.0.0",
- "npm-normalize-package-bin": "^5.0.0",
- "npm-package-arg": "^13.0.0",
- "semver": "^7.3.5"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/npm-registry-fetch": {
- "version": "19.1.1",
- "resolved": "https://registry.npmjs.org/npm-registry-fetch/-/npm-registry-fetch-19.1.1.tgz",
- "integrity": "sha512-TakBap6OM1w0H73VZVDf44iFXsOS3h+L4wVMXmbWOQroZgFhMch0juN6XSzBNlD965yIKvWg2dfu7NSiaYLxtw==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "@npmcli/redact": "^4.0.0",
- "jsonparse": "^1.3.1",
- "make-fetch-happen": "^15.0.0",
- "minipass": "^7.0.2",
- "minipass-fetch": "^5.0.0",
- "minizlib": "^3.0.1",
- "npm-package-arg": "^13.0.0",
- "proc-log": "^6.0.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
"node_modules/npm-run-path": {
"version": "4.0.1",
"resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz",
@@ -6611,19 +5362,6 @@
"url": "https://github.com/sponsors/sindresorhus"
}
},
- "node_modules/p-map": {
- "version": "7.0.4",
- "resolved": "https://registry.npmjs.org/p-map/-/p-map-7.0.4.tgz",
- "integrity": "sha512-tkAQEw8ysMzmkhgw8k+1U/iPhWNhykKnSk4Rd5zLoPJCuJaGRPo6YposrZgaxHKzDHdDWWZvE/Sk7hsL2X/CpQ==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=18"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
"node_modules/package-json-from-dist": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz",
@@ -6631,38 +5369,6 @@
"dev": true,
"license": "BlueOak-1.0.0"
},
- "node_modules/pacote": {
- "version": "21.3.0",
- "resolved": "https://registry.npmjs.org/pacote/-/pacote-21.3.0.tgz",
- "integrity": "sha512-8szw+HT7q/WsJjdpkkIUudWge9sUAI3LBDPJdBRh2HD8IrE3lAY+90nScTK+Ln95kRlcz/BOLEoY14qM0DIcvw==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "@npmcli/git": "^7.0.0",
- "@npmcli/installed-package-contents": "^4.0.0",
- "@npmcli/package-json": "^7.0.0",
- "@npmcli/promise-spawn": "^9.0.0",
- "@npmcli/run-script": "^10.0.0",
- "cacache": "^20.0.0",
- "fs-minipass": "^3.0.0",
- "minipass": "^7.0.2",
- "npm-package-arg": "^13.0.0",
- "npm-packlist": "^10.0.1",
- "npm-pick-manifest": "^11.0.1",
- "npm-registry-fetch": "^19.0.0",
- "proc-log": "^6.0.0",
- "promise-retry": "^2.0.1",
- "sigstore": "^4.0.0",
- "ssri": "^13.0.0",
- "tar": "^7.4.3"
- },
- "bin": {
- "pacote": "bin/index.js"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
"node_modules/parent-module": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz",
@@ -6941,30 +5647,6 @@
"node": ">=6"
}
},
- "node_modules/proc-log": {
- "version": "6.1.0",
- "resolved": "https://registry.npmjs.org/proc-log/-/proc-log-6.1.0.tgz",
- "integrity": "sha512-iG+GYldRf2BQ0UDUAd6JQ/RwzaQy6mXmsk/IzlYyal4A4SNFw54MeH4/tLkF4I5WoWG9SQwuqWzS99jaFQHBuQ==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/promise-retry": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/promise-retry/-/promise-retry-2.0.1.tgz",
- "integrity": "sha512-y+WKFlBR8BGXnsNlIHFGPZmyDf3DFMoLhaflAnyZgV6rG6xu+JwesTo2Q9R6XwYmtmwAFCkAk3e35jEdoeh/3g==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "err-code": "^2.0.2",
- "retry": "^0.12.0"
- },
- "engines": {
- "node": ">=10"
- }
- },
"node_modules/prompts": {
"version": "2.4.2",
"resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz",
@@ -7182,16 +5864,6 @@
"node": ">=8"
}
},
- "node_modules/retry": {
- "version": "0.12.0",
- "resolved": "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz",
- "integrity": "sha512-9LkiTwjUh6rT555DtE9rTX+BKByPfrMzEAtnlEtdEwr3Nkffwiihqe2bWADg+OQRjt9gl6ICdmB/ZFDCGAtSow==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">= 4"
- }
- },
"node_modules/reusify": {
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz",
@@ -7247,26 +5919,6 @@
"fsevents": "~2.3.2"
}
},
- "node_modules/rollup-plugin-filesize": {
- "version": "10.0.0",
- "resolved": "https://registry.npmjs.org/rollup-plugin-filesize/-/rollup-plugin-filesize-10.0.0.tgz",
- "integrity": "sha512-JAYYhzCcmGjmCzo3LEHSDE3RAPHKIeBdpqRhiyZSv5o/3wFhktUOzYAWg/uUKyEu5dEaVaql6UOmaqHx1qKrZA==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "@babel/runtime": "^7.13.8",
- "boxen": "^5.0.0",
- "brotli-size": "4.0.0",
- "colors": "1.4.0",
- "filesize": "^6.1.0",
- "gzip-size": "^6.0.0",
- "pacote": "^15.1.1",
- "terser": "^5.6.0"
- },
- "engines": {
- "node": ">=16.0.0"
- }
- },
"node_modules/run-parallel": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
@@ -7559,24 +6211,6 @@
"dev": true,
"license": "ISC"
},
- "node_modules/sigstore": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/sigstore/-/sigstore-4.1.0.tgz",
- "integrity": "sha512-/fUgUhYghuLzVT/gaJoeVehLCgZiUxPCPMcyVNY0lIf/cTCz58K/WTI7PefDarXxp9nUKpEwg1yyz3eSBMTtgA==",
- "dev": true,
- "license": "Apache-2.0",
- "dependencies": {
- "@sigstore/bundle": "^4.0.0",
- "@sigstore/core": "^3.1.0",
- "@sigstore/protobuf-specs": "^0.5.0",
- "@sigstore/sign": "^4.1.0",
- "@sigstore/tuf": "^4.0.1",
- "@sigstore/verify": "^3.1.0"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
"node_modules/sisteransi": {
"version": "1.0.5",
"resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz",
@@ -7602,17 +6236,6 @@
"node": ">=8.0.0"
}
},
- "node_modules/smart-buffer": {
- "version": "4.2.0",
- "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-4.2.0.tgz",
- "integrity": "sha512-94hK0Hh8rPqQl2xXc3HsaBoOXKV20MToPkcXvwbISWLEs+64sBq5kFgn2kJDHb1Pry9yrP0dxrCI9RRci7RXKg==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">= 6.0.0",
- "npm": ">= 3.0.0"
- }
- },
"node_modules/smob": {
"version": "1.6.1",
"resolved": "https://registry.npmjs.org/smob/-/smob-1.6.1.tgz",
@@ -7623,61 +6246,6 @@
"node": ">=20.0.0"
}
},
- "node_modules/socks": {
- "version": "2.8.7",
- "resolved": "https://registry.npmjs.org/socks/-/socks-2.8.7.tgz",
- "integrity": "sha512-HLpt+uLy/pxB+bum/9DzAgiKS8CX1EvbWxI4zlmgGCExImLdiad2iCwXT5Z4c9c3Eq8rP2318mPW2c+QbtjK8A==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "ip-address": "^10.0.1",
- "smart-buffer": "^4.2.0"
- },
- "engines": {
- "node": ">= 10.0.0",
- "npm": ">= 3.0.0"
- }
- },
- "node_modules/socks-proxy-agent": {
- "version": "8.0.5",
- "resolved": "https://registry.npmjs.org/socks-proxy-agent/-/socks-proxy-agent-8.0.5.tgz",
- "integrity": "sha512-HehCEsotFqbPW9sJ8WVYB6UbmIMv7kUUORIF2Nncq4VQvBfNBLibW9YZR5dlYCSUhwcD628pRllm7n+E+YTzJw==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "agent-base": "^7.1.2",
- "debug": "^4.3.4",
- "socks": "^2.8.3"
- },
- "engines": {
- "node": ">= 14"
- }
- },
- "node_modules/socks-proxy-agent/node_modules/debug": {
- "version": "4.4.3",
- "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz",
- "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "ms": "^2.1.3"
- },
- "engines": {
- "node": ">=6.0"
- },
- "peerDependenciesMeta": {
- "supports-color": {
- "optional": true
- }
- }
- },
- "node_modules/socks-proxy-agent/node_modules/ms": {
- "version": "2.1.3",
- "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
- "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
- "dev": true,
- "license": "MIT"
- },
"node_modules/source-map": {
"version": "0.6.1",
"resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
@@ -7708,50 +6276,12 @@
"source-map": "^0.6.0"
}
},
- "node_modules/spdx-exceptions": {
- "version": "2.5.0",
- "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.5.0.tgz",
- "integrity": "sha512-PiU42r+xO4UbUS1buo3LPJkjlO7430Xn5SVAhdpzzsPHsjbYVflnnFdATgabnLude+Cqu25p6N+g2lw/PFsa4w==",
- "dev": true,
- "license": "CC-BY-3.0"
- },
- "node_modules/spdx-expression-parse": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-4.0.0.tgz",
- "integrity": "sha512-Clya5JIij/7C6bRR22+tnGXbc4VKlibKSVj2iHvVeX5iMW7s1SIQlqu699JkODJJIhh/pUu8L0/VLh8xflD+LQ==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "spdx-exceptions": "^2.1.0",
- "spdx-license-ids": "^3.0.0"
- }
- },
- "node_modules/spdx-license-ids": {
- "version": "3.0.23",
- "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.23.tgz",
- "integrity": "sha512-CWLcCCH7VLu13TgOH+r8p1O/Znwhqv/dbb6lqWy67G+pT1kHmeD/+V36AVb/vq8QMIQwVShJ6Ssl5FPh0fuSdw==",
- "dev": true,
- "license": "CC0-1.0"
- },
"node_modules/sprintf-js": {
"version": "1.0.3",
"resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz",
"integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==",
"license": "BSD-3-Clause"
},
- "node_modules/ssri": {
- "version": "13.0.1",
- "resolved": "https://registry.npmjs.org/ssri/-/ssri-13.0.1.tgz",
- "integrity": "sha512-QUiRf1+u9wPTL/76GTYlKttDEBWV1ga9ZXW8BG6kfdeyyM8LGPix9gROyg9V2+P0xNyF3X2Go526xKFdMZrHSQ==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "minipass": "^7.0.3"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
"node_modules/statuses": {
"version": "2.0.2",
"resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.2.tgz",
@@ -7933,23 +6463,6 @@
"url": "https://github.com/sponsors/ljharb"
}
},
- "node_modules/tar": {
- "version": "7.5.13",
- "resolved": "https://registry.npmjs.org/tar/-/tar-7.5.13.tgz",
- "integrity": "sha512-tOG/7GyXpFevhXVh8jOPJrmtRpOTsYqUIkVdVooZYJS/z8WhfQUX8RJILmeuJNinGAMSu1veBr4asSHFt5/hng==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "dependencies": {
- "@isaacs/fs-minipass": "^4.0.0",
- "chownr": "^3.0.0",
- "minipass": "^7.1.2",
- "minizlib": "^3.1.0",
- "yallist": "^5.0.0"
- },
- "engines": {
- "node": ">=18"
- }
- },
"node_modules/terser": {
"version": "5.46.1",
"resolved": "https://registry.npmjs.org/terser/-/terser-5.46.1.tgz",
@@ -8029,59 +6542,6 @@
"integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==",
"license": "0BSD"
},
- "node_modules/tuf-js": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/tuf-js/-/tuf-js-4.1.0.tgz",
- "integrity": "sha512-50QV99kCKH5P/Vs4E2Gzp7BopNV+KzTXqWeaxrfu5IQJBOULRsTIS9seSsOVT8ZnGXzCyx55nYWAi4qJzpZKEQ==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "@tufjs/models": "4.1.0",
- "debug": "^4.4.3",
- "make-fetch-happen": "^15.0.1"
- },
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
- "node_modules/tuf-js/node_modules/debug": {
- "version": "4.4.3",
- "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz",
- "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "ms": "^2.1.3"
- },
- "engines": {
- "node": ">=6.0"
- },
- "peerDependenciesMeta": {
- "supports-color": {
- "optional": true
- }
- }
- },
- "node_modules/tuf-js/node_modules/ms": {
- "version": "2.1.3",
- "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
- "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
- "dev": true,
- "license": "MIT"
- },
- "node_modules/type-fest": {
- "version": "0.20.2",
- "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz",
- "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==",
- "dev": true,
- "license": "(MIT OR CC0-1.0)",
- "engines": {
- "node": ">=10"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
"node_modules/type-is": {
"version": "1.6.18",
"resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz",
@@ -8174,16 +6634,6 @@
"node": ">= 0.4.0"
}
},
- "node_modules/validate-npm-package-name": {
- "version": "7.0.2",
- "resolved": "https://registry.npmjs.org/validate-npm-package-name/-/validate-npm-package-name-7.0.2.tgz",
- "integrity": "sha512-hVDIBwsRruT73PbK7uP5ebUt+ezEtCmzZz3F59BSr2F6OVFnJ/6h8liuvdLrQ88Xmnk6/+xGGuq+pG9WwTuy3A==",
- "dev": true,
- "license": "ISC",
- "engines": {
- "node": "^20.17.0 || >=22.9.0"
- }
- },
"node_modules/vary": {
"version": "1.1.2",
"resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz",
@@ -8283,64 +6733,6 @@
"node": ">= 8"
}
},
- "node_modules/widest-line": {
- "version": "3.1.0",
- "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-3.1.0.tgz",
- "integrity": "sha512-NsmoXalsWVDMGupxZ5R08ka9flZjjiLvHVAWYOKtiKM8ujtZWr9cRffak+uSE48+Ob8ObalXpwyeUiyDD6QFgg==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "string-width": "^4.0.0"
- },
- "engines": {
- "node": ">=8"
- }
- },
- "node_modules/widest-line/node_modules/ansi-regex": {
- "version": "5.0.1",
- "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
- "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=8"
- }
- },
- "node_modules/widest-line/node_modules/emoji-regex": {
- "version": "8.0.0",
- "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
- "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==",
- "dev": true,
- "license": "MIT"
- },
- "node_modules/widest-line/node_modules/string-width": {
- "version": "4.2.3",
- "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
- "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "emoji-regex": "^8.0.0",
- "is-fullwidth-code-point": "^3.0.0",
- "strip-ansi": "^6.0.1"
- },
- "engines": {
- "node": ">=8"
- }
- },
- "node_modules/widest-line/node_modules/strip-ansi": {
- "version": "6.0.1",
- "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
- "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "ansi-regex": "^5.0.1"
- },
- "engines": {
- "node": ">=8"
- }
- },
"node_modules/workspace-tools": {
"version": "0.40.4",
"resolved": "https://registry.npmjs.org/workspace-tools/-/workspace-tools-0.40.4.tgz",
@@ -8483,16 +6875,6 @@
"node": ">=10"
}
},
- "node_modules/yallist": {
- "version": "5.0.0",
- "resolved": "https://registry.npmjs.org/yallist/-/yallist-5.0.0.tgz",
- "integrity": "sha512-YgvUTfwqyc7UXVMrB+SImsVYSmTS8X/tSrtdNZMImM+n7+QTriRXyXim0mBrTXNeqzVF0KWGgHPeiyViFFrNDw==",
- "dev": true,
- "license": "BlueOak-1.0.0",
- "engines": {
- "node": ">=18"
- }
- },
"node_modules/yargs": {
"version": "17.7.2",
"resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz",
diff --git a/package.json b/package.json
index c8c7e0bd438..4da620d6163 100644
--- a/package.json
+++ b/package.json
@@ -66,7 +66,6 @@
"lage": "2.15.8",
"lefthook": "2.1.4",
"rollup": "4.59.0",
- "rollup-plugin-filesize": "10.0.0",
"typescript": "5.3.3",
"vite": "7.3.2",
"yargs": "17.7.2"
diff --git a/packages/fast-element/DESIGN.md b/packages/fast-element/DESIGN.md
index e8195564d72..195629123c0 100644
--- a/packages/fast-element/DESIGN.md
+++ b/packages/fast-element/DESIGN.md
@@ -508,3 +508,9 @@ src/
| [ARCHITECTURE_UPDATES.md](./ARCHITECTURE_UPDATES.md) | Updates queue, attribute and observable change batching |
| [src/templating/TEMPLATE-BINDINGS.md](./src/templating/TEMPLATE-BINDINGS.md) | Full template binding pipeline: authoring → compilation → binding → DOM updates |
| [docs/fast-element-2-changes.md](./docs/fast-element-2-changes.md) | Breaking changes from v1 to v2 |
+
+---
+
+## Bundle Size Reporting
+
+The build generates a `SIZES.md` file that records minified, gzip, and brotli sizes for the CDN rollup bundle and each individually tree-shaken export. Sizes are measured using `esbuild` for per-export bundles and from the Rollup minified output for the CDN rollup bundle. Compression sizes use Node.js `node:zlib`. The documentation site copies this file into the resources section during its prebuild step.
diff --git a/packages/fast-element/README.md b/packages/fast-element/README.md
index 9f41e02094b..e2247d21e5f 100644
--- a/packages/fast-element/README.md
+++ b/packages/fast-element/README.md
@@ -51,4 +51,8 @@ For simplicity, examples throughout the documentation will assume the library ha
:::tip
Looking for a quick guide on building components? Check out [our Cheat Sheet](../resources/cheat-sheet.md#building-components).
-:::
\ No newline at end of file
+:::
+
+## Export Sizes
+
+Bundle sizes for each tree-shakeable export are tracked in [`SIZES.md`](./SIZES.md) and regenerated on every build. See the [Export Sizes](https://www.fast.design/docs/2.x/resources/export-sizes/) documentation page for the latest numbers.
\ No newline at end of file
diff --git a/packages/fast-element/SIZES.md b/packages/fast-element/SIZES.md
new file mode 100644
index 00000000000..84b6e32715f
--- /dev/null
+++ b/packages/fast-element/SIZES.md
@@ -0,0 +1,20 @@
+# Export Sizes
+
+Bundle sizes for `@microsoft/fast-element` exports.
+
+| Export | Minified | Gzip | Brotli |
+|--------|----------|------|--------|
+| CDN Rollup Bundle | 67.59 KB | 20.00 KB | 17.93 KB |
+| FASTElement | 28.10 KB | 8.75 KB | 7.87 KB |
+| Updates | 3.61 KB | 1.48 KB | 1.26 KB |
+| Observable | 8.12 KB | 2.99 KB | 2.66 KB |
+| observable | 8.16 KB | 3.00 KB | 2.68 KB |
+| attr | 3.55 KB | 1.42 KB | 1.19 KB |
+| children | 6.15 KB | 2.34 KB | 2.07 KB |
+| css | 11.32 KB | 4.07 KB | 3.66 KB |
+| ref | 5.12 KB | 2.02 KB | 1.76 KB |
+| slotted | 5.94 KB | 2.28 KB | 2.00 KB |
+| volatile | 8.22 KB | 3.02 KB | 2.69 KB |
+| when | 2.33 KB | 956 B | 771 B |
+| html | 28.16 KB | 9.27 KB | 8.33 KB |
+| repeat | 31.91 KB | 10.17 KB | 9.15 KB |
diff --git a/packages/fast-element/package.json b/packages/fast-element/package.json
index a7f4b9874ef..3ac862c6cfa 100644
--- a/packages/fast-element/package.json
+++ b/packages/fast-element/package.json
@@ -106,8 +106,9 @@
"doc:ci": "api-extractor run",
"doc:exports": "node ./scripts/run-api-extractor.js",
"doc:exports:ci": "node ./scripts/run-api-extractor.js ci",
- "build": "npm run build:tsc && npm run build:rollup && npm run doc && npm run doc:exports",
+ "build": "npm run build:tsc && npm run build:rollup && npm run build:sizes && npm run doc && npm run doc:exports",
"build:rollup": "rollup -c",
+ "build:sizes": "node scripts/measure-sizes.js",
"build:tsc": "tsc -p ./tsconfig.json",
"dev": "tsc -p ./tsconfig.json -w",
"prepublishOnly": "npm run clean && npm run build",
diff --git a/packages/fast-element/rollup.config.js b/packages/fast-element/rollup.config.js
index 8998cf2304c..f41a5a1a9b9 100644
--- a/packages/fast-element/rollup.config.js
+++ b/packages/fast-element/rollup.config.js
@@ -1,4 +1,3 @@
-import filesize from "rollup-plugin-filesize";
import terser from "@rollup/plugin-terser";
import typescript from "@rollup/plugin-typescript";
@@ -11,10 +10,6 @@ const plugins = [
},
exclude: ["**/*.bench.*", "**/*.spec.*"],
}),
- filesize({
- showMinifiedSize: false,
- showBrotliSize: true,
- }),
];
export default [
diff --git a/packages/fast-element/scripts/measure-sizes.js b/packages/fast-element/scripts/measure-sizes.js
new file mode 100644
index 00000000000..df0147675cd
--- /dev/null
+++ b/packages/fast-element/scripts/measure-sizes.js
@@ -0,0 +1,110 @@
+import { readFileSync, writeFileSync } from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { brotliCompressSync, gzipSync } from "node:zlib";
+import { build } from "esbuild";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const packageRoot = path.resolve(__dirname, "..");
+
+const namedExports = [
+ "FASTElement",
+ "Updates",
+ "Observable",
+ "observable",
+ "attr",
+ "children",
+ "css",
+ "ref",
+ "slotted",
+ "volatile",
+ "when",
+ "html",
+ "repeat",
+];
+
+function formatBytes(bytes) {
+ if (bytes < 1024) return `${bytes} B`;
+ return `${(bytes / 1024).toFixed(2)} KB`;
+}
+
+function measureBuffer(buffer) {
+ const gzip = gzipSync(buffer);
+ const brotli = brotliCompressSync(buffer);
+ return {
+ minified: buffer.length,
+ gzip: gzip.length,
+ brotli: brotli.length,
+ };
+}
+
+async function measureExport(exportName) {
+ const contents = `import { ${exportName} } from "@microsoft/fast-element";\nexport { ${exportName} };\n`;
+
+ const result = await build({
+ stdin: {
+ contents,
+ resolveDir: packageRoot,
+ loader: "ts",
+ },
+ bundle: true,
+ minify: true,
+ format: "esm",
+ write: false,
+ treeShaking: true,
+ });
+
+ const code = Buffer.from(result.outputFiles[0].contents);
+ return measureBuffer(code);
+}
+
+async function measureCore() {
+ const coreBundle = path.resolve(packageRoot, "dist/fast-element.min.js");
+ const buffer = readFileSync(coreBundle);
+ return measureBuffer(buffer);
+}
+
+async function main() {
+ const results = [];
+
+ // Measure CDN rollup bundle
+ const core = await measureCore();
+ results.push({ name: "CDN Rollup Bundle", ...core });
+
+ // Measure each named export in parallel
+ const exportResults = await Promise.all(
+ namedExports.map(async name => {
+ const sizes = await measureExport(name);
+ return { name, ...sizes };
+ }),
+ );
+ results.push(...exportResults);
+
+ // Generate markdown table
+ const lines = [
+ "# Export Sizes",
+ "",
+ "Bundle sizes for `@microsoft/fast-element` exports.",
+ "",
+ "| Export | Minified | Gzip | Brotli |",
+ "|--------|----------|------|--------|",
+ ];
+
+ for (const { name, minified, gzip, brotli } of results) {
+ lines.push(
+ `| ${name} | ${formatBytes(minified)} | ${formatBytes(gzip)} | ${formatBytes(brotli)} |`,
+ );
+ }
+
+ lines.push("");
+
+ const outputPath = path.resolve(packageRoot, "SIZES.md");
+ writeFileSync(outputPath, lines.join("\n"));
+ console.log(`Bundle sizes written to ${outputPath}`);
+}
+
+main().catch(err => {
+ console.error(err);
+ process.exit(1);
+});
diff --git a/sites/website/package.json b/sites/website/package.json
index 7017e163e35..9e1b31454b1 100644
--- a/sites/website/package.json
+++ b/sites/website/package.json
@@ -5,7 +5,7 @@
"type": "module",
"scripts": {
"clean": "clean build tmp",
- "prebuild": "npm run clean && node scripts/generate-docs.cjs",
+ "prebuild": "npm run clean && node scripts/generate-docs.cjs 2",
"build": "npm run prebuild && npx @11ty/eleventy --output=build --input=src",
"start": "npm run prebuild && npx @11ty/eleventy --output=build --input=src --serve",
"help": "npx @11ty/eleventy --help"
diff --git a/sites/website/scripts/generate-docs.cjs b/sites/website/scripts/generate-docs.cjs
index 35d3b6a4a1b..fdd68ebdb4e 100644
--- a/sites/website/scripts/generate-docs.cjs
+++ b/sites/website/scripts/generate-docs.cjs
@@ -7,8 +7,10 @@ const { getPackageJsonDir } = require("@microsoft/fast-build/get-package-json.js
// sites/website
const projectRoot = path.resolve(__dirname, "../");
const tempAPIDir = path.resolve(projectRoot, "tmp");
-const markdownAPIDir = path.resolve(projectRoot, "src/docs/2.x/api");
-const currentVersion = "2x";
+const majorVersion = process.argv[2] || "2";
+const currentVersion = `${majorVersion}x`;
+const versionDir = `${majorVersion}.x`;
+const markdownAPIDir = path.resolve(projectRoot, `src/docs/${versionDir}/api`);
const packages = [
{
@@ -253,8 +255,49 @@ async function buildAPIMarkdown() {
}
}
+async function buildSizesPage() {
+ const sizesSource = path.resolve(
+ getPackageJsonDir("@microsoft/fast-element"),
+ "SIZES.md",
+ );
+
+ if (!fs.existsSync(sizesSource)) {
+ console.warn("SIZES.md not found, skipping export sizes page.");
+ return;
+ }
+
+ const sizesContent = fs.readFileSync(sizesSource, "utf-8");
+ // Strip the heading from SIZES.md since we add our own via frontmatter
+ const body = sizesContent.replace(/^# .*\n*/m, "");
+
+ const frontmatter = [
+ "---",
+ "id: export-sizes",
+ "title: Export Sizes",
+ `layout: ${currentVersion}`,
+ "eleventyNavigation:",
+ ` key: export-sizes${currentVersion}`,
+ ` parent: resources${currentVersion}`,
+ " title: Export Sizes",
+ "navigationOptions:",
+ ` activeKey: export-sizes${currentVersion}`,
+ "description: Bundle sizes for @microsoft/fast-element exports.",
+ "keywords:",
+ " - export size",
+ " - bundle size",
+ "---",
+ "",
+ "# Export Sizes",
+ "",
+ ].join("\n");
+
+ const dest = path.resolve(projectRoot, `src/docs/${versionDir}/resources/export-sizes.md`);
+ await safeWrite(dest, frontmatter + body);
+ console.log("Export sizes page generated.");
+}
+
async function main() {
- await Promise.all([buildAPIMarkdown()]);
+ await Promise.all([buildAPIMarkdown(), buildSizesPage()]);
}
main();
diff --git a/sites/website/src/docs/2.x/introduction.md b/sites/website/src/docs/2.x/introduction.md
index 59e9eb06d2c..6469cec7833 100644
--- a/sites/website/src/docs/2.x/introduction.md
+++ b/sites/website/src/docs/2.x/introduction.md
@@ -33,6 +33,6 @@ FAST is a collection of technologies built on Web Components and modern Web Stan
- Style composition
- Elements refs, template directives, and much more.
-The entire `@microsoft/fast-element` library, without tree-shaking, is around 10kb minified and GZipped. It was designed for tree-shaking from the beginning, so any feature you don't use when building a component will be removed during build, allowing for highly efficient optimized payloads as small as 4.5k.
+`@microsoft/fast-element` was designed for tree-shaking from the beginning, so any feature you don't use when building a component will be removed during build, allowing for highly efficient optimized payloads. See the [Export Sizes](/docs/2.x/resources/export-sizes/) page for detailed per-export bundle sizes.
One of FAST's driving principles is "strive to adopt open, web standards-based approaches as much as possible." To that end, FAST is built directly on the W3C Web Component standards mentioned above, and does not create its own component model. This allows components built with FAST to function the same as built-in, native HTML elements. You do not need a framework to use FAST components, but you can use them in combination with any framework or library of your choice.
\ No newline at end of file
diff --git a/sites/website/src/docs/2.x/resources/export-sizes.md b/sites/website/src/docs/2.x/resources/export-sizes.md
new file mode 100644
index 00000000000..c655cdaec5b
--- /dev/null
+++ b/sites/website/src/docs/2.x/resources/export-sizes.md
@@ -0,0 +1,35 @@
+---
+id: export-sizes
+title: Export Sizes
+layout: 2x
+eleventyNavigation:
+ key: export-sizes2x
+ parent: resources2x
+ title: Export Sizes
+navigationOptions:
+ activeKey: export-sizes2x
+description: Bundle sizes for @microsoft/fast-element exports.
+keywords:
+ - export size
+ - bundle size
+---
+
+# Export Sizes
+Bundle sizes for `@microsoft/fast-element` exports.
+
+| Export | Minified | Gzip | Brotli |
+|--------|----------|------|--------|
+| CDN Rollup Bundle | 67.59 KB | 20.00 KB | 17.93 KB |
+| FASTElement | 28.10 KB | 8.75 KB | 7.87 KB |
+| Updates | 3.61 KB | 1.48 KB | 1.26 KB |
+| Observable | 8.12 KB | 2.99 KB | 2.66 KB |
+| observable | 8.16 KB | 3.00 KB | 2.68 KB |
+| attr | 3.55 KB | 1.42 KB | 1.19 KB |
+| children | 6.15 KB | 2.34 KB | 2.07 KB |
+| css | 11.32 KB | 4.07 KB | 3.66 KB |
+| ref | 5.12 KB | 2.02 KB | 1.76 KB |
+| slotted | 5.94 KB | 2.28 KB | 2.00 KB |
+| volatile | 8.22 KB | 3.02 KB | 2.69 KB |
+| when | 2.33 KB | 956 B | 771 B |
+| html | 28.16 KB | 9.27 KB | 8.33 KB |
+| repeat | 31.91 KB | 10.17 KB | 9.15 KB |
From 97fa0376f605875433ebd978d8238966f4d494bb Mon Sep 17 00:00:00 2001
From: Jane Chu <7559015+janechu@users.noreply.github.com>
Date: Wed, 22 Apr 2026 11:05:27 -0700
Subject: [PATCH 11/11] chore: fix github pages pipeline to use Node 22 (#7476)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
# Pull Request
## 📖 Description
The GitHub pages deploy pipeline uses NodeJS version 20 which fails on scripts that use globSync, this change updates to version 22 with separate actions to pin the version.
## ✅ Checklist
### General
- [ ] I have included a change request file using `$ npm run change`
- [ ] I have added tests for my changes.
- [x] I have tested my changes.
- [ ] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/main/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/main/CODE_OF_CONDUCT.md#our-standards) for this project.
## ⏭ Next Steps
- Deploy GitHub pages
---
.github/workflows/cd-gh-pages.yml | 10 ++++------
1 file changed, 4 insertions(+), 6 deletions(-)
diff --git a/.github/workflows/cd-gh-pages.yml b/.github/workflows/cd-gh-pages.yml
index 7803cb74c27..8ad05f43742 100644
--- a/.github/workflows/cd-gh-pages.yml
+++ b/.github/workflows/cd-gh-pages.yml
@@ -13,18 +13,16 @@ permissions:
jobs:
build:
runs-on: ubuntu-latest
- strategy:
- matrix:
- node: [22.x]
steps:
- uses: actions/checkout@v4
- - name: Use Node.js ${{ matrix.node-version }}
- uses: actions/setup-node@v4
with:
- node-version: ${{ matrix.node-version }}
fetch-depth: 0
+ - uses: actions/setup-node@v6
+ with:
+ node-version: 22
+
- name: Set Git User
run: |
git config --global user.name "${{ env.GITHUB_SERVICE_USER }}"
`, etc) are never instantiated as JavaScript objects and you cannot gain references to these elements declared in a template. The parts of a template containing these elements are emitted as-is to the SSR string result (with any bindings evaluated). It is for this reason [certain directives are no-ops](#directive-support-matrix). Additionally, components are rendered using only their template. Imperative code that adds elements or DOM content to a component will be invisible to the template renderer and will not be yielded in the final string result. - -## Community Alignment -`@microsoft/fast-ssr` internally implements the `ElementRenderer` interface proposed [here](https://github.com/webcomponents-cg/community-protocols/issues/7#issuecomment-825151215) and implemented in [`@lit-labs/ssr`](https://github.com/lit/lit/tree/main/packages/labs/ssr). The `ElementRenderer` interface allows Custom Elements created by different component authoring libraries to be rendered side-by-side, maximizing the portability and interoperability of Web Components. For more on how to do that, see the section on [configuring the RenderInfo object](#configuring-the-renderinfo-object). - -## Installation -Install `@microsoft/fast-ssr` and `@microsoft/fast-element` using your package manager of choice: - -```shell -npm install --save @microsoft/fast-ssr @microsoft/fast-element -``` -## Usage -### Installing the DOM Shim -`@microsoft/fast-ssr` requires a minimal DOM implementation to function. Install the shim by importing it. Doing so will ensure availability of certain DOM globals like `HTMLElement`, `Document`, etc. - -```js -import "@microsoft/fast-ssr/install-dom-shim.js"; -``` - -Alternatively, a full DOM implementation such as [`jsdom`](https://github.com/jsdom/jsdom) or [`happy-dom`](https://github.com/capricorn86/happy-dom) can be used. - -#### Augmenting the DOM Shim -To augment the properties installed by the DOM shim, import the Window factory and installer directly, and provide an object to `createWindow()` with the properties that should be added or overwritten. - -```ts -import { - createWindow, - installWindowOnGlobal, -} from '@microsoft/fast-ssr/dom-shim'; - -installWindowOnGlobal(createWindow({ isSSR: true })); -``` - -### Construct the Renderer -Import the renderer factory and construct a `TemplateRenderer`. -```js -import fastSSR from "@microsoft/fast-ssr"; - -const { templateRenderer } = fastSSR(); -``` - -### Define Custom Elements -Ensure that the custom elements used in the template you are rendering are defined in the `customElements` registry. This example defines a component directly, but you can also import any components being used: -```js -import { attr, customElement, html, FASTElement } from "@microsoft/fast-element"; - -@customElement({name: "my-element", template: html`
${x => x.message}
`}) -class MyElement extends FASTElement { - @attr - public message = "Hello World"; -} -``` - -### Rendering -With the `TemplateRenderer` created and a custom element defined, the `TemplateRenderer` can now render a template with that element. The result will be an `iterableIterator${x => x.message}
-`, templateRenderer.createRenderInfo(), { message: "hello world" }); -``` - -#### Rendering Templates with Directives -The `TemplateRenderer` can render templates with directives such as `when` and `repeat`. Some directives are no-ops, see the [directive support matrix](#directive-support-matrix) for details. - -```ts -import { when, repeat } from "@microsoft/fast-element"; - -const result = templateRenderer.render(html` - ${when(x => x.shouldRender, html` -Colors of a pixel
- ${repeat(x => x.data, html`Hello world
`}); -definition.define(); - - -const { templateRenderer, ElementRenderer } = fastSSR(); -ElementRenderer.disable("my-element"); -// or -// ElementRenderer.disable(MyElement); -// or -// ElementRenderer.disable(definition); - -// Does not render template contents of the custom element -templateRenderer.render(html`Async content success
`)}` - }) - class MyElement extends FASTElement { - @observable - renderContent: boolean = false; - connectedCallback(): void { - super.connectedCallback(); - this.dispatchEvent(new PendingTaskEvent(new Promise((resolve) => { - window.setTimeout(() => { - this.renderContent = true; - resolve(); - }, 20); - }))); - } - } - - const template = html`<${html.partial(name)}>`; - const { templateRenderer } = fastSSR({renderMode: "async"}); - - strictEqual(await consolidateAsync(templateRenderer.render(template)), `<${name}>Async content success
`) - }); - test("should support nested async rendering scenarios", async () => { - const name = uniqueElementName(); - @customElement({ - name, - template: html`attr value: ${x => x.value}
` - }) - class MyElement extends FASTElement { - @attr - value: string = ""; - - connectedCallback(): void { - this.asyncConnectedCallback(); - } - - async asyncConnectedCallback() { - this.dispatchEvent(new PendingTaskEvent(new Promise((resolve) => { - window.setTimeout(() => { - super.connectedCallback(); - resolve(); - }, 20); - }))); - } - } - - - const { templateRenderer } = fastSSR({renderMode: "async"}); - const template = `<${name} value="hello-world">`; - strictEqual(await consolidateAsync(templateRenderer.render(template)), `<${name} value="hello-world">attr value: hello-world
`) - }) - }); - - test("should match FAST elements that extend base-classes created from `FASTElement.from()`", () => { - const BaseClass = FASTElement.from(HTMLElement); - class MyElement extends BaseClass {} - - const name = uniqueElementName(); - FASTElement.define(MyElement, name); - - const { ElementRenderer } = fastSSR(); - - strictEqual(ElementRenderer.matchesClass(MyElement, name, new Map()), true) - }) - - describe("with hydration markup enabled", () => { - test("should emit the 'needs-hydration' attribute from `renderAttributes()`", () => { - const { ElementRenderer, templateRenderer } = fastSSR({ emitHydratableMarkup: true}); - const name = uniqueElementName(); - - FASTElement.define(name); - const renderer = new ElementRenderer(name, templateRenderer.createRenderInfo()); - - ok(consolidate(renderer.renderAttributes()).split(" ").includes("needs-hydration")); - }); - }) -}); diff --git a/packages/fast-ssr/src/element-renderer/element-renderer.ts b/packages/fast-ssr/src/element-renderer/element-renderer.ts deleted file mode 100644 index d8946a34406..00000000000 --- a/packages/fast-ssr/src/element-renderer/element-renderer.ts +++ /dev/null @@ -1,163 +0,0 @@ -/** - * This file was ported from {@link https://github.com/lit/lit/tree/main/packages/labs/ssr}. - * Please see {@link ../ACKNOWLEDGEMENTS.md} - */ -import { DOM, observable } from "@microsoft/fast-element"; -import { RenderInfo } from "../render-info.js"; -import { escapeHtml } from "../escape-html.js"; -import { HTMLElement as ShimHTMLElement } from "../dom-shim.js"; -import { shouldBubble } from "../event-utilities.js"; -import { AttributesMap, ElementRenderer } from "./interfaces.js"; - -/** - * @beta - */ -export abstract class DefaultElementRenderer - implements Omit
-
-
-
-
-
-
-
-
-
-
-
-
-
- Fake hydrate
-
-
-
-
-
- Heading
-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Maurisscelerisque varius ornare. Etiam convallis sollicitudin - scelerisque.Maecenas in velit vehicula, aliquet orci et, - consequat purus. Donec egetsodales lectus, vel sollicitudin - ligula. Suspendisse volutpat auctor diam,vel mattis lorem - venenatis in. -
-
-
-
-
-
- Fake hydrate
-
-
-
-
-
- Heading
-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Maurisscelerisque varius ornare. Etiam convallis sollicitudin - scelerisque.Maecenas in velit vehicula, aliquet orci et, - consequat purus. Donec egetsodales lectus, vel sollicitudin - ligula. Suspendisse volutpat auctor diam,vel mattis lorem - venenatis in. -
-- - - - - diff --git a/packages/fast-ssr/src/fast-command-buffer/index.ts b/packages/fast-ssr/src/fast-command-buffer/index.ts deleted file mode 100644 index a44beeb69f1..00000000000 --- a/packages/fast-ssr/src/fast-command-buffer/index.ts +++ /dev/null @@ -1,149 +0,0 @@ -const FASTCommandBufferAttributeName: string = "data-fast-buffer-events"; - -interface CommandCache { - originalNode: HTMLElement; - event: Event; - attachedNode: HTMLElement | null; -} - -/** - * Component for recording user events on SSR rendered FAST components which have not yet hydrated and replaying those - * events when they have. - * During SSR an instance of the
-
-
-
-
-
-
- Heading
-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Maurisscelerisque varius ornare. Etiam convallis sollicitudin - scelerisque.Maecenas in velit vehicula, aliquet orci et, consequat - purus. Donec egetsodales lectus, vel sollicitudin ligula. - Suspendisse volutpat auctor diam,vel mattis lorem venenatis in. -
-
-
-
-
-
-
-
- Heading
-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Maurisscelerisque varius ornare. Etiam convallis sollicitudin - scelerisque.Maecenas in velit vehicula, aliquet orci et, consequat - purus. Donec egetsodales lectus, vel sollicitudin ligula. - Suspendisse volutpat auctor diam,vel mattis lorem venenatis in. -
-
-
-
-
-
-
-
- Heading
-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Maurisscelerisque varius ornare. Etiam convallis sollicitudin - scelerisque.Maecenas in velit vehicula, aliquet orci et, consequat - purus. Donec egetsodales lectus, vel sollicitudin ligula. - Suspendisse volutpat auctor diam,vel mattis lorem venenatis in. -
-
-
-
-
-
-
-
- Heading
-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Maurisscelerisque varius ornare. Etiam convallis sollicitudin - scelerisque.Maecenas in velit vehicula, aliquet orci et, consequat - purus. Donec egetsodales lectus, vel sollicitudin ligula. - Suspendisse volutpat auctor diam,vel mattis lorem venenatis in. -
-
-
-
-
-
-
-
- Heading
-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Maurisscelerisque varius ornare. Etiam convallis sollicitudin - scelerisque.Maecenas in velit vehicula, aliquet orci et, consequat - purus. Donec egetsodales lectus, vel sollicitudin ligula. - Suspendisse volutpat auctor diam,vel mattis lorem venenatis in. -
-
-
-
-
-
-
-
- Heading
-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Maurisscelerisque varius ornare. Etiam convallis sollicitudin - scelerisque.Maecenas in velit vehicula, aliquet orci et, consequat - purus. Donec egetsodales lectus, vel sollicitudin ligula. - Suspendisse volutpat auctor diam,vel mattis lorem venenatis in. -
-
-
-
-
-
-
-
- Heading
-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Maurisscelerisque varius ornare. Etiam convallis sollicitudin - scelerisque.Maecenas in velit vehicula, aliquet orci et, consequat - purus. Donec egetsodales lectus, vel sollicitudin ligula. - Suspendisse volutpat auctor diam,vel mattis lorem venenatis in. -
-
-
-
-
-
-
-
- Heading
-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Maurisscelerisque varius ornare. Etiam convallis sollicitudin - scelerisque.Maecenas in velit vehicula, aliquet orci et, consequat - purus. Donec egetsodales lectus, vel sollicitudin ligula. - Suspendisse volutpat auctor diam,vel mattis lorem venenatis in. -
-
-
-
-
-
-
-
- Heading
-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Maurisscelerisque varius ornare. Etiam convallis sollicitudin - scelerisque.Maecenas in velit vehicula, aliquet orci et, consequat - purus. Donec egetsodales lectus, vel sollicitudin ligula. - Suspendisse volutpat auctor diam,vel mattis lorem venenatis in. -
-
-
-
-
-
-
-
- Heading
-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Maurisscelerisque varius ornare. Etiam convallis sollicitudin - scelerisque.Maecenas in velit vehicula, aliquet orci et, consequat - purus. Donec egetsodales lectus, vel sollicitudin ligula. - Suspendisse volutpat auctor diam,vel mattis lorem venenatis in. -
-Hello world
`); - const code = codes[0] as TextOp; - deepStrictEqual(codes.length, 1); - strictEqual(code.type, OpType.text); - strictEqual(code.value, "Hello world
"); - }); - test("should emit doctype, html, head, and body elements as part of text op", () => { - const codes = parseTemplateToOpCodes(html``); - const code = codes[0] as TextOp; - strictEqual(code.type, OpType.text); - strictEqual(code.value, ""); - }) - test("should emit a viewBehaviorFactory op from a binding", () => { - const input = html`${() => "hello world"}`; - const codes = parseTemplateToOpCodes(input); - strictEqual(codes.length, 1); - const code = codes[0] as ViewBehaviorFactoryOp; - strictEqual(code.type, OpType.viewBehaviorFactory); - strictEqual(code.factory, firstFactory(input.factories)); - strictEqual(code.index, 0); - }); - test("should emit a directive op from a content binding", () => { - const input = html`Hello ${() => "World"}.`; - - const codes = parseTemplateToOpCodes(input); - const code = codes[1] as ViewBehaviorFactoryOp; - strictEqual(codes.length, 3); - strictEqual(code.type, OpType.viewBehaviorFactory); - }); - test("should sandwich viewBehaviorFactory ops between text ops when binding native element content", () => { - const input = html`${() => "hello world"}
`; - const codes = parseTemplateToOpCodes(input); - strictEqual(codes[0].type, OpType.text); - strictEqual(codes[1].type, OpType.viewBehaviorFactory); - strictEqual(codes[2].type, OpType.text); - }); - test("should emit custom element codes for undefined custom elements", () => { - const codes = parseTemplateToOpCodes(html``);
- strictEqual(codes[1].type, OpType.templateElementOpen);
- strictEqual(codes[2].type, OpType.templateElementClose);
- strictEqual(codes[3].type, OpType.text);
- strictEqual((codes[3] as TextOp).value, `
`);
- })
-});
-describe("parseStringToOpCodes", () => {
- test("should increment binding index for each static host binding for a custom element template", () => {
- // Ensure alignment w/ client-side host binding indexing
- const template = html`
- ${() => "binding three"}
- ` - const codes = parseStringToOpCodes(template.html as string, template.factories, true); - const bindingCode = codes.find(code => code.type === OpType.viewBehaviorFactory) as ViewBehaviorFactoryOp; - - notStrictEqual(bindingCode, undefined); - strictEqual(bindingCode.index, 2); - }) -}) diff --git a/packages/fast-ssr/src/template-parser/template-parser.ts b/packages/fast-ssr/src/template-parser/template-parser.ts deleted file mode 100644 index 7f05bb4395e..00000000000 --- a/packages/fast-ssr/src/template-parser/template-parser.ts +++ /dev/null @@ -1,438 +0,0 @@ -/** - * This file was heavily inspired by {@link https://github.com/lit/lit/tree/main/packages/labs/ssr}, with adjustments to render parse FAST elements. - * Please see {@link ../ACKNOWLEDGEMENTS.md} - */ -import { - Aspected, - Compiler, - HTMLDirective, - Parser, - ViewBehaviorFactory, - ViewTemplate, -} from "@microsoft/fast-element"; -import { parse, parseFragment } from "parse5"; -import { - Attribute, - DefaultTreeCommentNode, - DefaultTreeElement, - DefaultTreeNode, - DefaultTreeParentNode, - DefaultTreeTextNode, -} from "parse5/index.js"; -import { TemplateCacheControllerImpl } from "../template-cache/controller.js"; -import { AttributeBindingOp, OpCodes, OpType } from "./op-codes.js"; - -interface Visitor { - visit?: (node: DefaultTreeNode) => void; - leave?: (node: DefaultTreeNode) => void; -} - -declare module "parse5/index.js" { - interface DefaultTreeElement { - isCustomElement?: boolean; - } -} - -/** - * Traverses a tree of nodes depth-first, invoking callbacks from visitor for each node as it goes. - * @param node - the node to traverse - * @param visitor - callbacks to be invoked during node traversal - */ -function traverse(node: DefaultTreeNode | DefaultTreeParentNode, visitor: Visitor) { - // Templates parsed with `parse()` are parsed as full documents and will contain - // html, body tags whether the template contains them or not. Skip over visiting and - // leaving these elements if there is no source-code location, because that indicates - // they are not in the template string. - const shouldVisit = !!(node as DefaultTreeElement).sourceCodeLocation; - if (visitor.visit && shouldVisit) { - visitor.visit(node); - } - - if ("childNodes" in node) { - const { childNodes } = node; - for (const child of childNodes) { - traverse(child, visitor); - } - } - - if (node.nodeName === "template") { - traverse((node as any).content, visitor); - } - - if (visitor.leave && shouldVisit) { - visitor.leave(node); - } -} - -/** - * Test if a node is a comment node. - * @param node - the node to test - */ -function isCommentNode(node: DefaultTreeNode): node is DefaultTreeCommentNode { - return node.nodeName === "#comment"; -} - -/** - * Test if a node is a text node. - * @param node - the node to test - */ -function isTextNode(node: DefaultTreeNode): node is DefaultTreeTextNode { - return node.nodeName === "#text"; -} - -/** - * Test if a node is an element node - * @param node - the node to test - */ -function isElementNode(node: DefaultTreeNode): node is DefaultTreeElement { - return (node as DefaultTreeElement).tagName !== undefined; -} - -function isDefaultTreeParentNode(node: any): node is DefaultTreeParentNode { - return Array.isArray(node.childNodes); -} - -function firstElementChild(node: DefaultTreeParentNode): DefaultTreeElement | null { - return ( - (node.childNodes.find(child => isElementNode(child)) as - | DefaultTreeElement - | undefined) || null - ); -} -/** - * https://html.spec.whatwg.org/dev/custom-elements.html#custom-elements-core-concepts - * @internal - */ -export const customElementNameExcludeList = [ - "annotation-xml", - "color-profile", - "font-face", - "font-face-src", - "font-face-uri", - "font-face-format", - "font-face-name", - "missing-glyph", -]; - -export const templateCacheController = TemplateCacheControllerImpl.create(OpCodes); - -/** - * Parses a template into a set of operation instructions - * @param template - The template to parse - */ -export function parseTemplateToOpCodes(template: ViewTemplate): OpCodes { - const cached = !templateCacheController.disabled && OpCodes.get(template); - - if (!!cached) { - return cached; - } - - const { html } = template; - - if (typeof html !== "string") { - throw new Error( - "@microsoft/fast-ssr only supports rendering a ViewTemplate with a string source." - ); - } - - /** - * Typescript thinks that `html` is a string | HTMLTemplateElement inside the functions defined - * below, so store in a new var that is just a string type - */ - const templateString = html; - - const codes = parseStringToOpCodes(templateString, template.factories); - !templateCacheController.disabled && OpCodes.set(template, codes); - return codes as OpCodes; -} - -export function parseStringToOpCodes( - /** - * The string to parse - */ - templateString: string, - factories: RecordHello world
`) - - strictEqual(consolidate(result), `Hello world
`); - }); - test("should render a template as a child element", () => { - const { templateRenderer } = fastSSR(); - const result = templateRenderer.render(html``) - - strictEqual(consolidate(result), ``); - }); - }); - - describe("rendering declarative shadow DOM", () => { - test("should emit static shadow DOM template for a defined custom element", () => { - const { templateRenderer } = fastSSR(); - const result = templateRenderer.render(html`Hello world
"; - @customElement({ - name, - shadowOptions: null, - template: html`${template}` - }) - class MyElement extends FASTElement {} - - const { templateRenderer } = fastSSR(); - const result = templateRenderer.render(html`<${html.partial(name)}>`); - const validationResult = validateRendererOutput(result, [ - `<${name}`, - ">", - (x) => !!HydrationMarkup.parseElementBoundaryStartMarker(x), - template, - (x) => !!HydrationMarkup.parseElementBoundaryEndMarker(x), - `` - ]); - - deepStrictEqual(validationResult, true); - }); - - test("should render styles as the first child elements in the element's light DOM", () => { - const name = uniqueElementName(); - const template = "With styles
"; - @customElement({ - name, - shadowOptions: null, - template: html`${template}`, - styles: css`:host {color: red;}` - }) - class MyElement extends FASTElement {} - - const { templateRenderer } = fastSSR(); - const result = templateRenderer.render(html`<${html.partial(name)}>`); - - const validationResult = validateRendererOutput(result, [ - `<${name}`, - ">", - (x) => !!HydrationMarkup.parseElementBoundaryStartMarker(x), - "", - template, - (x) => !!HydrationMarkup.parseElementBoundaryEndMarker(x), - `` - ]); - - deepStrictEqual(validationResult, true); - }); - test("should render child elements into the element's light DOM", () => { - const name = uniqueElementName(); - @customElement({ - name, - shadowOptions: null - }) - class MyElement extends FASTElement {} - - const { templateRenderer } = fastSSR(); - const result = templateRenderer.render(html`<${html.partial(name)}>Hello world
`); - - strictEqual(consolidate(result), `<${name}>Hello world
`); - }); - }); - - test("should emit a single element template", () => { - const { templateRenderer } = fastSSR(); - const result = templateRenderer.render(html`Hello world
`) - - strictEqual(consolidate(result), "Hello world
") - }); - - test("should emit un-registered custom elements without any shadow DOM", () => { - const { templateRenderer } = fastSSR(); - const result = templateRenderer.render(html`Hello world
`}) - definition.define() - - for (const key of [name, definition, MyElement]) { - const { ElementRenderer, templateRenderer } = fastSSR(); - strictEqual(consolidate(templateRenderer.render(html`<${html.partial(name)}>`)), `<${name}>Hello world
`); - ElementRenderer.disable(key); - strictEqual(consolidate(templateRenderer.render(html`<${html.partial(name)}>`)), `<${name}>`); - } - }); - - describe("with deferHydration enabled", () => { - test("should emit elements that have been disabled with defer-hydration attribute", () => { - const name = uniqueElementName(); - @customElement({ - name, - shadowOptions: null, - template: html`Hello world
` - }) - class MyElement extends FASTElement {} - - const { templateRenderer, ElementRenderer } = fastSSR({ deferHydration: true }); - ElementRenderer.disable(name); - const result = templateRenderer.render(html`<${html.partial(name)}>Hello world
`) - - strictEqual(consolidate(result), `<${name} defer-hydration>Hello world
`); - }); - - test("should emit undefined custom elements with the defer-hydration attribute", () => { - const name = uniqueElementName(); - const { templateRenderer } = fastSSR({ deferHydration: true }); - const result = consolidate(templateRenderer.render(`<${name}>`)); - - strictEqual(result, `<${name} defer-hydration>`); - }); - - test("should emit elements that have been disabled with defer-hydration attribute based on deferHydration function return value", () => { - const noDeferName = uniqueElementName(); - const deferName = uniqueElementName(); - class MyElement extends FASTElement {} - MyElement.compose({name: deferName, template: html``}).define() - MyElement.compose({name: noDeferName, template: html``}).define() - const { templateRenderer, ElementRenderer } = fastSSR({ deferHydration: (name) => name === deferName }); - ElementRenderer.disable(deferName); - ElementRenderer.disable(noDeferName); - const result = consolidate(templateRenderer.render(`<${noDeferName}><${deferName}>`)); - strictEqual(result, `<${noDeferName}><${deferName} defer-hydration>`); - }); - - test("should emit undefined custom elements with defer-hydration attribute based on deferHydration function return value", () => { - const noDeferName = uniqueElementName(); - const deferName = uniqueElementName(); - const { templateRenderer } = fastSSR({ deferHydration: (name) => name === deferName }); - const result = consolidate(templateRenderer.render(`<${noDeferName}><${deferName}>`)); - strictEqual(result, `<${noDeferName}><${deferName} defer-hydration>`); - }); - }) - - /** - * Bindings - */ - test("should provide the source object to any bindings", () => { - const source = {}; - let calledWith: any; - const { templateRenderer } = fastSSR(); - consolidate(templateRenderer.render(html`${(x) => {calledWith = x}}`, templateRenderer.createRenderInfo(), source)); - - strictEqual(source, calledWith); - }); - - test("should provide the defaultExecutionContext object to a binding", () => { - let calledWith: any; - const { templateRenderer } = fastSSR(); - consolidate(templateRenderer.render(html`${(x, c) => {calledWith = c}}`)); - - strictEqual(calledWith, ExecutionContext.default); - }); - - - test("should not emit string content from a binding that returns a null value", () => { - const { templateRenderer } = fastSSR(); - const result = consolidate(templateRenderer.render(html`${(x) => null}`)); - - strictEqual(result, ""); - }); - - test("should not emit string content from a binding that returns an undefined value", () => { - const { templateRenderer } = fastSSR(); - const result = consolidate(templateRenderer.render(html`${(x) => undefined}`)); - - strictEqual(result, ""); - }); - - test("should emit a native element with an attribute when the attr binding returns a string", () => { - const { templateRenderer } = fastSSR(); - const result = consolidate(templateRenderer.render(html``)); - - strictEqual(result, ``); - }); - - test("should emit a custom element with an attribute binding when the attr binding returns a string", () => { - const { templateRenderer } = fastSSR(); - const result = templateRenderer.render(html`Hello ${html`world`}
`)) - strictEqual(result, `Hello world
`); - }); - - describe("binding the the classList", () => { - test("should emit class attribute to native elements", () => { - const { templateRenderer } = fastSSR(); - - const result = consolidate(templateRenderer.render(html`"foo bar"}>Hello world
`)) - strictEqual(result, ``); - }); - test("should emit class attribute to custom elements", () => { - const { templateRenderer } = fastSSR(); - - const result = consolidate(templateRenderer.render(html`Hello world
`)}`) - - strictEqual(consolidate(result), "Hello world
") - }); - test("should emit nothing when a 'when' directive's binding evaluates false ", () => { - const { templateRenderer } = fastSSR(); - const result = templateRenderer.render(html`${when(x => false, html`Hello world
`)}`) - - strictEqual(consolidate(result), ""); - }); - }); - - describe("with a 'repeat' directive", () => { - test("should provide parent and parentContext to execution context of bindings in child template", () => { - - const { templateRenderer } = fastSSR(); - const source = { - data: ["foo", "bar", "bat"] - }; - const ctx = ExecutionContext.default; - consolidate(templateRenderer.render(html- Hello
- World
- Hello
- World
${() => "hello world"}
`; - FASTElement.define({name, template}); - const { templateRenderer } = fastSSR({emitHydratableMarkup: true}); - const result = consolidate(templateRenderer.render(`<${name}>`)); - const codes = (template.create() as unknown as SSRView).codes; - strictEqual(result, `<${name} needs-hydration>${hydrationMarker.contentBindingStart(0, codes.id)}hello world${hydrationMarker.contentBindingEnd(0, codes.id)}
`) - }); - test("should emit a marker attribute to an element with a attribute binding ", () => { - const name = uniqueElementName(); - FASTElement.define({name, template: html``}); - const { templateRenderer } = fastSSR({emitHydratableMarkup: true}); - const result = consolidate(templateRenderer.render(`<${name}>`)); - - strictEqual(result, `<${name} needs-hydration>`) - }); - test("should emit a marker attribute to an element with a boolean attribute binding ", () => { - const name = uniqueElementName(); - FASTElement.define({name, template: html``}); - const { templateRenderer } = fastSSR({emitHydratableMarkup: true}); - const result = consolidate(templateRenderer.render(`<${name}>`)); - - strictEqual(result, `<${name} needs-hydration>`) - }); - test("should emit a marker attribute to an element with a property binding", () => { - const name = uniqueElementName(); - FASTElement.define({name, template: html``}); - const { templateRenderer } = fastSSR({emitHydratableMarkup: true}); - const result = consolidate(templateRenderer.render(`<${name}>`)); - - strictEqual(result, `<${name} needs-hydration>`) - }); - test("should emit a marker attribute to an element with an event binding", () => { - const name = uniqueElementName(); - FASTElement.define({name, template: html``}); - const { templateRenderer } = fastSSR({emitHydratableMarkup: true}); - const result = consolidate(templateRenderer.render(`<${name}>`)); - - strictEqual(result, `<${name} needs-hydration>`) - }); - test("should emit a all binding ids to the marker attribute to an element with multiple attribute bindings", () => { - const name = uniqueElementName(); - FASTElement.define({name, template: html`false}>
`}); - const { templateRenderer } = fastSSR({emitHydratableMarkup: true}); - const result = consolidate(templateRenderer.render(`<${name}>`)); - - strictEqual(result, `<${name} needs-hydration>`) - }); - test("should restart marker indexes inside the template after host bindings", () => { - const name = uniqueElementName(); - FASTElement.define({ - name, - template: html``, - }); - const { templateRenderer } = fastSSR({ emitHydratableMarkup: true }); - const result = consolidate(templateRenderer.render(`<${name}>`)); - - strictEqual(result, - `<${name} needs-hydration>` - ); - }); - test("should restart marker indexes after multiple host bindings of different types", () => { - // Test various permutations of host binding types to ensure order doesn't matter - const hostBindings = { - event: `@click="\${() => void 0}"`, - boolean: `?disabled="\${() => true}"`, - property: `:title="\${() => 'tooltip'}"`, - attribute: `attr="\${() => 'value'}"`, - }; - - const permutations = [ - ["event", "boolean", "property", "attribute"], - ["attribute", "property", "boolean", "event"], - ["boolean", "event", "attribute", "property"], - ["property", "attribute", "event", "boolean"], - ] as const; - - for (const order of permutations) { - const name = uniqueElementName(); - const hostBindingString = order.map(key => hostBindings[key]).join(" "); - const templateString = ``; - - FASTElement.define({ - name, - template: new Function("html", `return html\`${templateString}\``)(html), - }); - const { templateRenderer } = fastSSR({ emitHydratableMarkup: true }); - const result = consolidate(templateRenderer.render(`<${name}>`)); - - // Verify content binding is at index 0 regardless of host binding order - // Attribute order on host may vary, so check for key parts - ok(result.includes(`<${name}`)); - ok(result.includes(`disabled`)); - ok(result.includes(`attr="value"`)); - ok(result.includes(`needs-hydration`)); - ok(result.includes(``)); - ok(result.includes(``)); - } - }); - test("should restart marker indexes after host bindings with static attributes", () => { - const name = uniqueElementName(); - FASTElement.define({ - name, - template: html``, - }); - const { templateRenderer } = fastSSR({ emitHydratableMarkup: true }); - const result = consolidate(templateRenderer.render(`<${name}>`)); - - strictEqual(result, - `<${name} id="static-id" needs-hydration>` - ); - }); - test("should restart marker indexes after multiple host events", () => { - const name = uniqueElementName(); - FASTElement.define({ - name, - template: html``, - }); - const { templateRenderer } = fastSSR({ emitHydratableMarkup: true }); - const result = consolidate(templateRenderer.render(`<${name}>`)); - - strictEqual(result, - `<${name} needs-hydration>` - ); - }); - test("should restart marker indexes with host bindings and multiple content bindings", () => { - const name = uniqueElementName(); - FASTElement.define({ - name, - template: html``, - }); - const { templateRenderer } = fastSSR({ emitHydratableMarkup: true }); - const result = consolidate(templateRenderer.render(`<${name}>`)); - - strictEqual(result, - `<${name} needs-hydration>` - ); - }); - test("should restart marker indexes with host bindings and content text bindings", () => { - const name = uniqueElementName(); - const template = html`${() => "text"}`; - FASTElement.define({ - name, - template, - }); - const { templateRenderer } = fastSSR({ emitHydratableMarkup: true }); - const result = consolidate(templateRenderer.render(`<${name}>`)); - const codes = (template.create() as unknown as SSRView).codes; - - strictEqual(result, - `<${name} needs-hydration>${hydrationMarker.contentBindingStart(0, codes.id)}text${hydrationMarker.contentBindingEnd(0, codes.id)}` - ); - }); - test("should only emit markers for custom element templates", () => { - const { templateRenderer } = fastSSR({emitHydratableMarkup: true}); - const result = consolidate(templateRenderer.render(html`${x => "hello world"}
`)); - strictEqual(result, "hello world
"); - }) - }); - - describe("Disconnecting elements", () => { - test("should disconnect an element if there are no other elements in the customElementInstanceStack", () => { - let disconnected = false; - const name = uniqueElementName(); - (class extends FASTElement { - disconnectedCallback(): void { - disconnected = true; - } - }).define(name); - - const { templateRenderer } = fastSSR(); - consolidate(templateRenderer.render(`<${name}>`)); - - strictEqual(disconnected, true); - }); - - test("should not disconnect an element if there are other elements in the customElementInstanceStack", () => { - let disconnected = false; - const name = uniqueElementName(); - (class extends FASTElement { - disconnectedCallback(): void { - disconnected = true; - } - }).define(name); - - const { templateRenderer } = fastSSR(); - const renderInfo = templateRenderer.createRenderInfo(); - renderInfo.customElementInstanceStack.push(new FallbackRenderer("tag-name")); - consolidate(templateRenderer.render(`<${name}>`, renderInfo)); - - strictEqual(disconnected, false); - }); - test("should remove behaviors during disconnection", () => { - let removed = false; - const behavior: HostBehavior = { - removedCallback() { - removed = true; - } - } - - const name = uniqueElementName(); - (class extends FASTElement { - connectedCallback(): void { - super.connectedCallback(); - this.$fastController.addBehavior(behavior); - } - }).define(name); - - const { templateRenderer } = fastSSR(); - const renderInfo = templateRenderer.createRenderInfo(); - consolidate(templateRenderer.render(`<${name}>`, renderInfo)); - - strictEqual(removed, true); - }); - }); - - describe("with tryRecoverFromErrors", () => { - test("should not emit shadow-dom for a component that throws during connectedCallback", () => { - const name = uniqueElementName(); - (class extends FASTElement { - connectedCallback(): void { - super.connectedCallback(); - throw new Error(); - } - } ).define({name}); - const { templateRenderer } = fastSSR({tryRecoverFromError: true}); - - let result: string = ""; - const template = `<${name}>`; - doesNotThrow(() => { - result = consolidate(templateRenderer.render(template)); - }); - strictEqual(result, template) - }); - - test("should emit the defer-hydration attribute to the element when configured for a component that throws during connectedCallback", () => { - const name = uniqueElementName(); - (class extends FASTElement { - connectedCallback(): void { - super.connectedCallback(); - throw new Error(); - } - } ).define({name}); - const { templateRenderer } = fastSSR({tryRecoverFromError: true, deferHydration: true}); - - let result: string = ""; - const template = `<${name}>`; - doesNotThrow(() => { - result = consolidate(templateRenderer.render(template)); - }); - strictEqual(result, `<${name} defer-hydration>`); - }); - test("should not emit the needs-hydration attribute to the element when configured for a component that throws during connectedCallback", () => { - const name = uniqueElementName(); - (class extends FASTElement { - connectedCallback(): void { - super.connectedCallback(); - throw new Error(); - } - } ).define({name}); - const { templateRenderer } = fastSSR({tryRecoverFromError: true, emitHydratableMarkup: true}); - - let result: string = ""; - const template = `<${name}>`; - doesNotThrow(() => { - result = consolidate(templateRenderer.render(template)); - }); - strictEqual(result, template); - }); - test("should not emit shadow-dom for a component that throws during async process in connectedCallback", async () => { - const name = uniqueElementName(); - (class extends FASTElement { - connectedCallback(): void { - async function throwErr(): PromiseHello world
`}); - const { templateRenderer } = fastSSR({tryRecoverFromError: true}); - - const result = consolidate(templateRenderer.render(`<${name} contextual-attribute="value">`)) - strictEqual(result, `<${name} contextual-attribute="value">`); - }); - test("should invoke a provided handler with the thrown error when a recoverable error is caught in the connectedCallback", () => { - const name = uniqueElementName(); - (class extends FASTElement { - connectedCallback(): void { - super.connectedCallback(); - throw new Error(); - } - } ).define(name); - let err: any; - const handler = (reason: unknown) => { - err = reason; - } - const { templateRenderer } = fastSSR({tryRecoverFromError: handler}); - - consolidate(templateRenderer.render(`<${name} contextual-attribute="value">`)) - strictEqual(err instanceof Error, true); - }); - test("should invoke a provided handler with the thrown error when a recoverable error is caught from a PendingTaskEvent", async () => { - const name = uniqueElementName(); - (class extends FASTElement { - connectedCallback(): void { - async function throwErr(): Promise
+ Alice
+ 28
+ 2020-01-01
+ 100
+ New York
+
+
+ dark
+
+
+ line
+ heavy-data
+ good
+
+
+
+
+
+
+
+
+
+ item-1
+ 1
+
+
+
+ item-2
+ 2
+
+
+
+
+ {{user.name}}
+ {{user.age}}
+ {{user.history.joined}}
+ {{user.history.visits}}
+ {{user.location.city}}
+
+
+ {{settings.theme}}
+
+
+ {{analytics.charts.activeChart}}
+ {{analytics.charts.cachedData}}
+ {{analytics.summary}}
+
+
+
+
+
+
+
+
+
+
+
+ {{item.text}}
+ {{item.meta.count}}
+
+
+ {{user.name}}
+ {{user.age}}
+ {{user.history.joined}}
+ {{user.history.visits}}
+ {{user.location.city}}
+
+
+ {{settings.theme}}
+
+
+ {{analytics.charts.activeChart}}
+ {{analytics.charts.cachedData}}
+ {{analytics.summary}}
+
+
+
+
+
+
+
+
+
+
+
+ {{item.text}}
+ {{item.meta.count}}
+
+