npm - @webstir-io/webstir-frontend - Versions diffs - 0.1.40 → 0.1.41 - Mend

@webstir-io/webstir-frontend 0.1.40 → 0.1.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (138) hide show

package/README.md +124 -60
package/dist/assets/imageOptimizer.js +10 -15
package/dist/assets/precompression.js +1 -1
package/dist/builders/contentBuilder.js +102 -90
package/dist/builders/cssBuilder.js +25 -19
package/dist/builders/htmlBuilder.js +57 -42
package/dist/builders/index.js +1 -1
package/dist/builders/jsBuilder.js +219 -76
package/dist/builders/staticAssetsBuilder.js +27 -9
package/dist/builders/types.d.ts +1 -0
package/dist/cli.d.ts +1 -1
package/dist/cli.js +6 -30
package/dist/config/manifest.js +7 -6
package/dist/config/paths.js +2 -2
package/dist/config/schema.d.ts +8 -0
package/dist/config/schema.js +7 -6
package/dist/config/setup.js +1 -1
package/dist/config/workspace.js +11 -9
package/dist/core/constants.d.ts +1 -1
package/dist/core/constants.js +5 -5
package/dist/core/diagnostics.js +1 -1
package/dist/core/pages.js +4 -4
package/dist/hooks.js +3 -3
package/dist/html/criticalCss.js +6 -3
package/dist/html/htmlSecurity.d.ts +6 -1
package/dist/html/htmlSecurity.js +28 -14
package/dist/html/lazyLoad.js +1 -1
package/dist/html/pageScaffold.js +1 -1
package/dist/html/resourceHints.js +5 -2
package/dist/index.d.ts +2 -0
package/dist/index.js +2 -0
package/dist/inspect.d.ts +2 -0
package/dist/inspect.js +110 -0
package/dist/modes/ssg/metadata.js +4 -4
package/dist/modes/ssg/routing.js +2 -5
package/dist/modes/ssg/seo.js +5 -5
package/dist/modes/ssg/views.js +17 -11
package/dist/operations.js +18 -10
package/dist/pipeline.d.ts +1 -0
package/dist/pipeline.js +6 -1
package/dist/provider.js +28 -24
package/dist/runtime/boundary.d.ts +28 -0
package/dist/runtime/boundary.js +247 -0
package/dist/runtime/index.d.ts +1 -0
package/dist/runtime/index.js +1 -0
package/dist/types.d.ts +52 -0
package/dist/utils/fs.d.ts +11 -10
package/dist/utils/fs.js +48 -20
package/dist/utils/glob.d.ts +8 -0
package/dist/utils/glob.js +21 -0
package/dist/utils/hash.js +1 -2
package/dist/utils/pagePaths.js +2 -2
package/package.json +19 -14
package/scripts/publish.sh +2 -94
package/scripts/update-contract.sh +12 -10
package/src/assets/assetManifest.ts +39 -29
package/src/assets/imageOptimizer.ts +91 -82
package/src/assets/precompression.ts +22 -16
package/src/builders/contentBuilder.ts +1224 -1149
package/src/builders/cssBuilder.ts +466 -417
package/src/builders/htmlBuilder.ts +511 -448
package/src/builders/index.ts +7 -7
package/src/builders/jsBuilder.ts +538 -280
package/src/builders/staticAssetsBuilder.ts +166 -135
package/src/builders/types.ts +7 -6
package/src/cli.ts +66 -90
package/src/config/manifest.ts +16 -14
package/src/config/paths.ts +5 -5
package/src/config/schema.ts +38 -37
package/src/config/setup.ts +7 -7
package/src/config/workspace.ts +118 -116
package/src/config/workspaceManifest.ts +14 -14
package/src/core/constants.ts +62 -62
package/src/core/diagnostics.ts +26 -26
package/src/core/pages.ts +19 -19
package/src/hooks.ts +128 -118
package/src/html/criticalCss.ts +84 -77
package/src/html/htmlSecurity.ts +107 -66
package/src/html/lazyLoad.ts +22 -19
package/src/html/pageScaffold.ts +37 -28
package/src/html/resourceHints.ts +83 -74
package/src/index.ts +2 -0
package/src/inspect.ts +158 -0
package/src/modes/ssg/metadata.ts +53 -51
package/src/modes/ssg/routing.ts +177 -177
package/src/modes/ssg/seo.ts +208 -200
package/src/modes/ssg/validation.ts +31 -25
package/src/modes/ssg/views.ts +257 -238
package/src/operations.ts +105 -95
package/src/pipeline.ts +81 -69
package/src/provider.ts +184 -176
package/src/runtime/boundary.ts +325 -0
package/src/runtime/index.ts +1 -0
package/src/types.ts +107 -48
package/src/utils/changedFile.ts +22 -22
package/src/utils/fs.ts +73 -26
package/src/utils/glob.ts +38 -0
package/src/utils/hash.ts +2 -4
package/src/utils/pagePaths.ts +35 -23
package/src/utils/pathMatch.ts +26 -23
package/tests/add-page-defaults.test.js +44 -39
package/tests/bundlerParity.test.js +252 -0
package/tests/cli.contract.test.js +13 -0
package/tests/content-pages.test.js +108 -13
package/tests/css-app-imports.test.js +22 -11
package/tests/css-page-imports.test.js +26 -13
package/tests/diagnostics.test.js +39 -36
package/tests/features.test.js +48 -43
package/tests/hooks.test.js +58 -42
package/tests/htmlSecurity.test.js +66 -0
package/tests/inspect.test.js +148 -0
package/tests/provider.integration.test.js +71 -20
package/tests/runtime.test.js +493 -0
package/tests/ssg-defaults.test.js +284 -177
package/tests/ssg-guardrails.test.js +51 -51
package/tsconfig.json +3 -10
package/dist/watch/frontendFiles.d.ts +0 -3
package/dist/watch/frontendFiles.js +0 -25
package/dist/watch/hotUpdateTracker.d.ts +0 -51
package/dist/watch/hotUpdateTracker.js +0 -205
package/dist/watch/pipelineHelpers.d.ts +0 -26
package/dist/watch/pipelineHelpers.js +0 -177
package/dist/watch/types.d.ts +0 -27
package/dist/watch/types.js +0 -1
package/dist/watch/watchCoordinator.d.ts +0 -36
package/dist/watch/watchCoordinator.js +0 -551
package/dist/watch/watchDaemon.d.ts +0 -17
package/dist/watch/watchDaemon.js +0 -127
package/dist/watch/watchReporter.d.ts +0 -21
package/dist/watch/watchReporter.js +0 -64
package/scripts/smoke.mjs +0 -35
package/src/watch/frontendFiles.ts +0 -32
package/src/watch/hotUpdateTracker.ts +0 -285
package/src/watch/pipelineHelpers.ts +0 -242
package/src/watch/types.ts +0 -23
package/src/watch/watchCoordinator.ts +0 -666
package/src/watch/watchDaemon.ts +0 -144
package/src/watch/watchReporter.ts +0 -98

package/tests/htmlSecurity.test.js ADDED Viewed

@@ -0,0 +1,66 @@
+import test from 'node:test';
+import assert from 'node:assert/strict';
+import { load } from 'cheerio';
+import { addSubresourceIntegrity } from '../dist/html/htmlSecurity.js';
+test('addSubresourceIntegrity skips external fetches by default', async () => {
+  const document = load(`
+        <html>
+            <head>
+                <script src="https://cdn.example.com/app.js"></script>
+                <link rel="stylesheet" href="https://cdn.example.com/app.css" />
+            </head>
+        </html>
+    `);
+  let calls = 0;
+  const result = await addSubresourceIntegrity(document, {
+    fetcher: async () => {
+      calls += 1;
+      throw new Error('fetch should not be called when external fetch is disabled');
+    },
+  });
+  assert.equal(calls, 0);
+  assert.deepEqual(result.failures, []);
+  assert.deepEqual(result.skippedExternalResources, [
+    'https://cdn.example.com/app.js',
+    'https://cdn.example.com/app.css',
+  ]);
+  assert.equal(document('script').attr('integrity'), undefined);
+  assert.equal(document('link').attr('integrity'), undefined);
+});
+test('addSubresourceIntegrity can opt in to fetching external resources', async () => {
+  const document = load(`
+        <html>
+            <head>
+                <script src="https://cdn.example.com/app.js"></script>
+                <link rel="stylesheet" href="https://cdn.example.com/app.css" />
+            </head>
+        </html>
+    `);
+  let calls = 0;
+  const result = await addSubresourceIntegrity(document, {
+    allowExternalFetch: true,
+    fetcher: async () => {
+      calls += 1;
+      return {
+        ok: true,
+        async arrayBuffer() {
+          return Buffer.from('console.log("webstir");');
+        },
+      };
+    },
+  });
+  assert.equal(calls, 2);
+  assert.deepEqual(result.failures, []);
+  assert.deepEqual(result.skippedExternalResources, []);
+  assert.match(String(document('script').attr('integrity')), /^sha384-/);
+  assert.match(String(document('link').attr('integrity')), /^sha384-/);
+  assert.equal(document('script').attr('crossorigin'), 'anonymous');
+  assert.equal(document('link').attr('crossorigin'), 'anonymous');
+});

package/tests/inspect.test.js ADDED Viewed

@@ -0,0 +1,148 @@
+import test from 'node:test';
+import assert from 'node:assert/strict';
+import fs from 'node:fs/promises';
+import fssync from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { inspectFrontendWorkspace } from '../dist/index.js';
+async function createWorkspace({ frontendConfig, pkg, withFrontend = true } = {}) {
+  const root = await fs.mkdtemp(path.join(os.tmpdir(), 'webstir-frontend-inspect-'));
+  const frontendRoot = path.join(root, 'src', 'frontend');
+  if (withFrontend) {
+    await fs.mkdir(frontendRoot, { recursive: true });
+  }
+  await fs.writeFile(
+    path.join(root, 'package.json'),
+    JSON.stringify(
+      pkg ?? {
+        name: 'inspect-workspace',
+        version: '1.0.0',
+      },
+      null,
+      2,
+    ),
+    'utf8',
+  );
+  if (frontendConfig !== undefined) {
+    await fs.writeFile(
+      path.join(frontendRoot, 'frontend.config.json'),
+      JSON.stringify(frontendConfig, null, 2),
+      'utf8',
+    );
+  }
+  return {
+    root,
+    cleanup: () => fs.rm(root, { recursive: true, force: true }),
+  };
+}
+test('inspectFrontendWorkspace resolves shallow workspace facts without building', async (t) => {
+  const workspace = await createWorkspace({
+    pkg: {
+      name: 'inspect-workspace',
+      version: '1.0.0',
+      webstir: {
+        enable: {
+          clientNav: true,
+          contentNav: true,
+          unknownFlag: true,
+        },
+      },
+    },
+    frontendConfig: {
+      paths: {
+        contentRoot: 'docs/content',
+      },
+    },
+  });
+  t.after(workspace.cleanup);
+  const appRoot = path.join(workspace.root, 'src', 'frontend', 'app');
+  const pageRoot = path.join(workspace.root, 'src', 'frontend', 'pages', 'home');
+  const contentRoot = path.join(workspace.root, 'docs', 'content');
+  await fs.mkdir(appRoot, { recursive: true });
+  await fs.mkdir(pageRoot, { recursive: true });
+  await fs.mkdir(contentRoot, { recursive: true });
+  await fs.writeFile(path.join(appRoot, 'app.html'), '<!doctype html><html></html>', 'utf8');
+  await fs.writeFile(path.join(appRoot, 'app.css'), 'body{}', 'utf8');
+  await fs.writeFile(path.join(appRoot, 'app.ts'), 'export {};\n', 'utf8');
+  await fs.writeFile(path.join(pageRoot, 'index.html'), '<head></head><main></main>', 'utf8');
+  await fs.writeFile(path.join(pageRoot, 'index.css'), 'main{}', 'utf8');
+  await fs.writeFile(path.join(pageRoot, 'index.ts'), 'export {};\n', 'utf8');
+  await fs.writeFile(path.join(contentRoot, '_sidebar.json'), '{}', 'utf8');
+  const result = await inspectFrontendWorkspace(workspace.root);
+  assert.equal(result.config.paths.src.content, contentRoot);
+  assert.equal(result.packageJson.exists, true);
+  assert.deepEqual(result.packageJson.enable.raw, {
+    clientNav: true,
+    contentNav: true,
+    unknownFlag: true,
+  });
+  assert.deepEqual(result.packageJson.enable.known, {
+    spa: false,
+    clientNav: true,
+    backend: false,
+    search: false,
+    contentNav: true,
+  });
+  assert.equal(result.appShell.exists, true);
+  assert.equal(result.appShell.templateExists, true);
+  assert.equal(result.appShell.stylesheetExists, true);
+  assert.equal(result.appShell.scriptExists, true);
+  assert.deepEqual(
+    result.pages.map((page) => ({
+      name: page.name,
+      htmlExists: page.htmlExists,
+      stylesheetExists: page.stylesheetExists,
+      scriptExists: page.scriptExists,
+    })),
+    [
+      {
+        name: 'home',
+        htmlExists: true,
+        stylesheetExists: true,
+        scriptExists: true,
+      },
+    ],
+  );
+  assert.equal(result.content.exists, true);
+  assert.equal(result.content.sidebarOverrideExists, true);
+  assert.equal(fssync.existsSync(path.join(workspace.root, 'build')), false);
+  assert.equal(fssync.existsSync(path.join(workspace.root, '.webstir')), false);
+});
+test('inspectFrontendWorkspace reports absent frontend facts cleanly', async (t) => {
+  const workspace = await createWorkspace();
+  t.after(workspace.cleanup);
+  const result = await inspectFrontendWorkspace(workspace.root);
+  assert.equal(result.packageJson.exists, true);
+  assert.equal(result.packageJson.enable.raw, undefined);
+  assert.deepEqual(result.packageJson.enable.known, {
+    spa: false,
+    clientNav: false,
+    backend: false,
+    search: false,
+    contentNav: false,
+  });
+  assert.equal(result.appShell.exists, false);
+  assert.equal(result.pages.length, 0);
+  assert.equal(result.content.exists, false);
+  assert.equal(result.content.sidebarOverrideExists, false);
+});

package/tests/provider.integration.test.js CHANGED Viewed

@@ -11,7 +11,10 @@ async function loadProviderOrSkip(t) {
     return mod.frontendProvider;
   } catch (err) {
     // Likely due to optional native deps like sharp; skip gracefully.
-    console.warn('[frontend-tests] Skipping provider integration: optional dependency unavailable:', err?.message ?? err);
+    console.warn(
+      '[frontend-tests] Skipping provider integration: optional dependency unavailable:',
+      err?.message ?? err,
+    );
     t?.diagnostic?.('skip: missing optional dependency');
     return null;
   }
@@ -25,8 +28,16 @@ async function createWorkspace() {
   await fs.mkdir(pageDir, { recursive: true });
   // Minimal app template and page fragment
-  await fs.writeFile(path.join(appDir, 'app.html'), '<!DOCTYPE html><html><head><title>App</title></head><body><main></main></body></html>', 'utf8');
-  await fs.writeFile(path.join(pageDir, 'index.html'), '<head></head><main><section>Home</section></main>', 'utf8');
+  await fs.writeFile(
+    path.join(appDir, 'app.html'),
+    '<!DOCTYPE html><html><head><title>App</title></head><body><main></main></body></html>',
+    'utf8',
+  );
+  await fs.writeFile(
+    path.join(pageDir, 'index.html'),
+    '<head></head><main><section>Home</section></main>',
+    'utf8',
+  );
   await fs.writeFile(path.join(pageDir, 'index.ts'), 'console.log("home");', 'utf8');
   return root;
@@ -47,16 +58,28 @@ async function createWorkspaceWithClientNav() {
     webstir: {
       mode: 'ssg',
       enable: {
-        clientNav: true
-      }
-    }
+        clientNav: true,
+      },
+    },
   };
   await fs.writeFile(path.join(root, 'package.json'), JSON.stringify(pkg, null, 2), 'utf8');
-  await fs.writeFile(path.join(appDir, 'app.html'), '<!DOCTYPE html><html><head><title>App</title></head><body><main></main></body></html>', 'utf8');
-  await fs.writeFile(path.join(appDir, 'app.ts'), 'import "./scripts/features/client-nav.js";', 'utf8');
+  await fs.writeFile(
+    path.join(appDir, 'app.html'),
+    '<!DOCTYPE html><html><head><title>App</title></head><body><main></main></body></html>',
+    'utf8',
+  );
+  await fs.writeFile(
+    path.join(appDir, 'app.ts'),
+    'import "./scripts/features/client-nav.js";',
+    'utf8',
+  );
   await fs.writeFile(path.join(featureDir, 'client-nav.ts'), 'export {};', 'utf8');
-  await fs.writeFile(path.join(pageDir, 'index.html'), '<head></head><main><section>Home</section></main>', 'utf8');
+  await fs.writeFile(
+    path.join(pageDir, 'index.html'),
+    '<head></head><main><section>Home</section></main>',
+    'utf8',
+  );
   return root;
 }
@@ -85,8 +108,16 @@ test('frontend provider publish produces dist assets and preserves entry in mani
   const workspace = await createWorkspace();
   // Run build first so manifest has entries from build/frontend
-  await frontendProvider.build({ workspaceRoot: workspace, env: { WEBSTIR_MODULE_MODE: 'build' }, incremental: false });
-  const publishResult = await frontendProvider.build({ workspaceRoot: workspace, env: { WEBSTIR_MODULE_MODE: 'publish' }, incremental: false });
+  await frontendProvider.build({
+    workspaceRoot: workspace,
+    env: { WEBSTIR_MODULE_MODE: 'build' },
+    incremental: false,
+  });
+  const publishResult = await frontendProvider.build({
+    workspaceRoot: workspace,
+    env: { WEBSTIR_MODULE_MODE: 'publish' },
+    incremental: false,
+  });
   // Dist should contain a hashed JS file
   const distPageDir = path.join(workspace, 'dist', 'frontend', 'pages', 'home');
@@ -102,13 +133,28 @@ test('enable.clientNav uses feature module (no legacy helper injection)', async
   if (!frontendProvider) return; // skip
   const workspace = await createWorkspaceWithClientNav();
-  await frontendProvider.build({ workspaceRoot: workspace, env: { WEBSTIR_MODULE_MODE: 'build' }, incremental: false });
-  await frontendProvider.build({ workspaceRoot: workspace, env: { WEBSTIR_MODULE_MODE: 'publish' }, incremental: false });
+  await frontendProvider.build({
+    workspaceRoot: workspace,
+    env: { WEBSTIR_MODULE_MODE: 'build' },
+    incremental: false,
+  });
+  await frontendProvider.build({
+    workspaceRoot: workspace,
+    env: { WEBSTIR_MODULE_MODE: 'publish' },
+    incremental: false,
+  });
   const distClientNav = path.join(workspace, 'dist', 'frontend', 'clientNav.js');
-  assert.equal(fssync.existsSync(distClientNav), false, 'did not expect dist/frontend/clientNav.js');
+  assert.equal(
+    fssync.existsSync(distClientNav),
+    false,
+    'did not expect dist/frontend/clientNav.js',
+  );
-  const distHtml = await fs.readFile(path.join(workspace, 'dist', 'frontend', 'index.html'), 'utf8');
+  const distHtml = await fs.readFile(
+    path.join(workspace, 'dist', 'frontend', 'index.html'),
+    'utf8',
+  );
   assert.ok(!distHtml.includes('clientNav.js'), 'did not expect client-nav script injected');
   assert.ok(!distHtml.includes('index.js'), 'should not inject page index.js when none exists');
 });
@@ -124,14 +170,19 @@ test('enable.clientNav without feature module fails fast', async (t) => {
     webstir: {
       mode: 'ssg',
       enable: {
-        clientNav: true
-      }
-    }
+        clientNav: true,
+      },
+    },
   };
   await fs.writeFile(path.join(workspace, 'package.json'), JSON.stringify(pkg, null, 2), 'utf8');
   await assert.rejects(
-    () => frontendProvider.build({ workspaceRoot: workspace, env: { WEBSTIR_MODULE_MODE: 'build' }, incremental: false }),
-    /Enabled feature module\(s\) missing: client-nav/
+    () =>
+      frontendProvider.build({
+        workspaceRoot: workspace,
+        env: { WEBSTIR_MODULE_MODE: 'build' },
+        incremental: false,
+      }),
+    /Enabled feature module\(s\) missing: client-nav/,
   );
 });