@givolt/i3-composer-agent 2.3.2 → 2.3.3

package/skills/i3-ui-prototype/scripts/template-inventory.cjs

@@ -0,0 +1,78 @@
+'use strict';
+const fs = require('node:fs'), path = require('node:path'), crypto = require('node:crypto'), assert = require('node:assert/strict');
+const digest = value => crypto.createHash('sha256').update(value).digest('hex');
+const ignored = new Set(['template-inventory.json', 'capabilities.generated.json']);
+function files(directory, prefix = '') {
+  return fs.readdirSync(path.join(directory, prefix), { withFileTypes: true }).sort((a,b) => a.name.localeCompare(b.name, 'en')).flatMap(entry => {
+    const name = prefix ? `${prefix}/${entry.name}` : entry.name;
+    assert.ok(!entry.isSymbolicLink(), `Refusing template symlink: ${name}`);
+    if (['.git', 'node_modules'].includes(entry.name) || ignored.has(name)) return [];
+    return entry.isDirectory() ? files(directory, name) : [name];
+  });
+}
+function attributes(text) {
+  const value = {};
+  for (const match of text.matchAll(/([^\s=<>/'"`]+)(?:\s*=\s*(?:"([^"]*)"|'([^']*)'|([^\s>]+)))?/g)) {
+    assert.ok(!Object.hasOwn(value, match[1]), `Duplicate HTML attribute: ${match[1]}`);
+    value[match[1]] = match[2] ?? match[3] ?? match[4] ?? '';
+  }
+  return value;
+}
+function scan(directory) {
+  directory = fs.realpathSync(directory);
+  const sourceFiles = files(directory), hashes = Object.fromEntries(sourceFiles.map(file => [file, digest(fs.readFileSync(path.join(directory, file)))]));
+  const html = fs.readFileSync(path.join(directory, 'index.html'), 'utf8');
+  const policy = JSON.parse(fs.readFileSync(path.join(directory, 'component-inventory.json'), 'utf8'));
+  return scanResources(hashes, html, policy);
+}
+function scanResources(hashes, html, policy) {
+  const routesMatch = html.match(/id="prototype-offline-routes">([\s\S]*?)<\/script>/);
+  assert.ok(routesMatch, 'Template inventory requires explicit offline routes');
+  const routes = JSON.parse(routesMatch[1]);
+  assert.equal(policy.schemaVersion, 1, 'Unsupported component inventory classification');
+  const fragments = [], components = {}, unknownComponents = new Set(); let eventCount = 0;
+  for (const match of html.matchAll(/^<template data-source="([^"]+)">\n([\s\S]*?)^<\/template>/gm)) {
+    const file = match[1], content = match[2], nodes = [];
+    assert.ok(!fragments.some(fragment => fragment.file === file), `Duplicate HTML fragment: ${file}`);
+    const cleaned = content.replace(/<!--[\s\S]*?-->/g, text => ' '.repeat(text.length));
+    for (const token of cleaned.matchAll(/<([a-zA-Z][\w:.-]*)(\s(?:[^"'<>]|"[^"]*"|'[^']*')*)?\s*\/?\s*>/g)) {
+      const attrs = attributes(token[2] || ''), node = { id: `${file}#${nodes.length + 1}`, tag: token[1], attributes: attrs };
+      nodes.push(node);
+      eventCount += Object.keys(attrs).filter(key => key.startsWith('data-on-')).length;
+      const component = attrs['data-component'];
+      if (!component) continue;
+      const classification = policy.components?.[component];
+      if (!classification) unknownComponents.add(component);
+      else {
+        assert.ok(['framework', 'business-reference', 'icon', 'router', 'dynamic'].includes(classification.kind), `Unknown classification: ${component}`);
+        assert.ok(Array.isArray(classification.capabilities), `Missing semantic classification: ${component}`);
+        if (classification.source) assert.ok(fragments.some(item => item.file === classification.source) || html.includes(`<template data-source="${classification.source}">`), `Missing component source: ${component}`);
+      }
+      components[component] ||= { classification: classification || null, occurrences: [] };
+      components[component].occurrences.push(node.id);
+    }
+    fragments.push({ file, digest: digest(content), nodes });
+  }
+  assert.ok(fragments.length, 'Template inventory requires editable fragments');
+  assert.equal(unknownComponents.size, 0, `Unclassified template components: ${[...unknownComponents].join(', ')}`);
+  const pages = [...new Set(routes.map(route => route.component).filter(Boolean))].map(component => {
+    const fragment = 'reference/' + component.replace(/^\.\//, '').replace(/\.js$/, '.html');
+    assert.ok(fragments.some(item => item.file === fragment), `Route has no editable HTML: ${component}`);
+    return { component, fragment, routes: routes.filter(route => route.component === component).map(route => route.path) };
+  });
+  return { schemaVersion: 1, files: hashes, routes, pages, fragments, components, eventCount, unknownComponents: [] };
+}
+function verify(directory, inventory) {
+  assert.deepEqual(scan(directory), inventory, 'Template inventory changed; review every source/component/interaction difference and regenerate the inventory');
+  return { status: 'passed', files: Object.keys(inventory.files).length, routes: inventory.routes.length, pages: inventory.pages.length, fragments: inventory.fragments.length, components: Object.keys(inventory.components).length, events: inventory.eventCount };
+}
+function verifySnapshot(snapshot) {
+  const resources = new Map(snapshot.files.map(file => [file.path, Buffer.from(file.content, 'base64')]));
+  assert.equal(resources.size, snapshot.files.length, 'Duplicate template snapshot resource');
+  const hashes = Object.fromEntries([...resources].filter(([file]) => !ignored.has(file)).map(([file, content]) => [file, digest(content)]));
+  const expected = JSON.parse(resources.get('template-inventory.json').toString('utf8'));
+  const actual = scanResources(hashes, resources.get('index.html').toString('utf8'), JSON.parse(resources.get('component-inventory.json').toString('utf8')));
+  assert.deepEqual(actual, expected, 'Template snapshot inventory differs from actual sources/components/events');
+  return actual;
+}
+module.exports = { scan, verify, verifySnapshot };