@warpgogol/werkstatt-shared 0.14.1 → 0.15.0

package/src/share/remediation/remediation-catalog.ts

@@ -1,196 +0,0 @@
-/*
-<MODULE_CONTRACT>
-<purpose>
-  Canonical remediation catalog mapping ruleId to structured remediation patterns.
-  Consumed by diagnosticsResult() for auto-population and by remediation.hint.validate
-  for coverage checking (RFC-1027).
-</purpose>
-<non-goals>
-  <item>Does not own the Diagnostic schema — that lives in werkstatt-engine schemas.</item>
-  <item>Does not aggregate remediation hints into KernelExecutionReport — that is the engine's job.</item>
-</non-goals>
-</MODULE_CONTRACT>
-<CHANGE_SUMMARY>
-  <item>RFC-1027: Create REMEDIATION_CATALOG with 30+ patterns for the most common ruleIds.</item>
-</CHANGE_SUMMARY>
-*/
-
-export interface RemediationPattern {
-  ruleId: string;
-  action: string;
-  template?: string;
-  docRef?: string;
-  targetFiles?: string[];
-}
-
-const REMEDIATION_ENTRIES: RemediationPattern[] = [
-  {
-    ruleId: "SEO-RUNTIME.CANONICAL-MISMATCH",
-    action: "Ensure the canonical URL in the rendered HTML matches the production domain without language prefix for the default locale.",
-    docRef: "docs/authoring/site-composition.md",
-    targetFiles: ["src/layouts/**/*.astro"],
-  },
-  {
-    ruleId: "WORKSPACE.SURFACE.VALIDATE",
-    action: "Fix surface validation errors by checking the surface block declarations against the schema.",
-    docRef: "docs/authoring/site-composition.md",
-  },
-  {
-    ruleId: "TEST.SIGNAL.POLICY.VALIDATE",
-    action: "Align test signal declarations with the policy schema — check signal name, severity, and evidence path.",
-    docRef: "docs/agents/domain.md",
-  },
-  {
-    ruleId: "PUBLIC.ICONS.VALIDATE",
-    action: "Replace invalid icon references with valid SurfaceLabels entries or remove the icon field.",
-    docRef: "docs/authoring/site-composition.md",
-  },
-  {
-    ruleId: "PARITY-SECTION-COUNT",
-    action: "Add or remove sections so the locale overlay matches the base locale section count.",
-    docRef: "docs/authoring/preventive-measures-parity-and-templates.md",
-  },
-  {
-    ruleId: "GEN-FILES-01",
-    action: "Regenerate generated files by running the owning kernel command, then commit the updated output.",
-    docRef: "docs/authoring/generated-files-and-templates.md",
-  },
-  {
-    ruleId: "DEPS-GEN-01",
-    action: "Run pnpm exec werkstatt run deps.peer.check to regenerate the peer dependency manifest.",
-    docRef: "docs/authoring/generated-files-and-templates.md",
-  },
-  {
-    ruleId: "AGC-01",
-    action: "Fix the agent gate configuration — ensure the gate metadata matches the declared gate catalog.",
-    docRef: "docs/agents/domain.md",
-  },
-  {
-    ruleId: "WORKPIECE-IMPORTS-01",
-    action: "Resolve the broken import in the workpiece — check the module path and ensure the package is installed.",
-  },
-  {
-    ruleId: "SNAP-01",
-    action: "Regenerate the behavior snapshot by running pnpm exec werkstatt run behavior.snapshot.generate.",
-  },
-  {
-    ruleId: "CREG-04",
-    action: "Fix the content regression — review the content diff and update the review.yaml before closing the mission.",
-    docRef: "docs/authoring/site-composition.md",
-  },
-  {
-    ruleId: "CREG-03",
-    action: "Fix the content regression — ensure all locale overlays are consistent with the base content.",
-    docRef: "docs/authoring/preventive-measures-parity-and-templates.md",
-  },
-  {
-    ruleId: "CREG-01",
-    action: "Fix the content regression — the base content was changed without a review.yaml. Run content.regression.review.generate.",
-    docRef: "docs/authoring/site-composition.md",
-  },
-  {
-    ruleId: "BRK-04",
-    action: "Fix the bordbuch entry — ensure the hash chain is intact and the entry is properly signed.",
-  },
-  {
-    ruleId: "PROPS-01",
-    action: "Fix the content props schema violation — check the frontmatter against the schema declaration.",
-  },
-  {
-    ruleId: "MAINTENANCE.DEBT.BASELINE.VALIDATE",
-    action: "Regenerate the maintenance debt baseline by running pnpm exec werkstatt run maintenance.debt.baseline.generate.",
-  },
-  {
-    ruleId: "HDR-04",
-    action: "Fix the header configuration — ensure the header block matches the surface schema.",
-    docRef: "docs/authoring/site-composition.md",
-  },
-  {
-    ruleId: "HDR-02",
-    action: "Fix the header navigation — ensure all nav items have valid href and label.",
-    docRef: "docs/authoring/site-composition.md",
-  },
-  {
-    ruleId: "HDR-01",
-    action: "Fix the header structure — ensure the header block is declared in the surface composition.",
-    docRef: "docs/authoring/site-composition.md",
-  },
-  {
-    ruleId: "GEN-EDIT-01",
-    action: "Do not hand-edit generated files. Modify the source template and regenerate.",
-    docRef: "docs/authoring/generated-files-and-templates.md",
-  },
-  {
-    ruleId: "DEPS-PEER-01",
-    action: "Add the missing peer dependency to the package.json or remove the import that requires it.",
-  },
-  {
-    ruleId: "CW-EVID-01",
-    action: "Fix the changelog evidence — ensure the evidence file exists and is referenced correctly.",
-  },
-  {
-    ruleId: "CMD-MAN-03",
-    action: "Regenerate the command manifest by running pnpm exec werkstatt run command.manifest.generate.",
-  },
-  {
-    ruleId: "CI-LOCAL-05",
-    action: "Fix the CI configuration — ensure the local CI workflow matches the pipeline definitions.",
-  },
-  {
-    ruleId: "AGS-05",
-    action: "Fix the agent gate search configuration — ensure the search manifest is generated and accessible.",
-    docRef: "docs/agents/domain.md",
-  },
-  {
-    ruleId: "AGS-02",
-    action: "Fix the agent gate search schema — ensure the search chunk text is within the max length.",
-    docRef: "docs/agents/domain.md",
-  },
-  {
-    ruleId: "AGO-01",
-    action: "Fix the agent gate output — ensure the gate output matches the declared schema.",
-    docRef: "docs/agents/domain.md",
-  },
-  {
-    ruleId: "AGK-03",
-    action: "Fix the agent gate key — ensure the gate key is unique and matches the declared catalog.",
-    docRef: "docs/agents/domain.md",
-  },
-  {
-    ruleId: "WS-WRITE-02",
-    action: "Fix the workspace write — ensure the write intent is declared and the path is within the workspace root.",
-  },
-  {
-    ruleId: "SUPPRESS-VAL-04",
-    action: "Fix the suppression validation — ensure the suppression rule matches the declared schema.",
-    docRef: "docs/authoring/guide-suppression-matching.md",
-  },
-  {
-    ruleId: "ENV-CONTRACT-02",
-    action: "Fix the environment contract — ensure the env variable is declared in .env.example and matches the contract.",
-  },
-  {
-    ruleId: "ENV-CONTRACT-04",
-    action: "Fix the environment contract — ensure the env variable type matches the declared schema.",
-  },
-  {
-    ruleId: "ENV-CONTRACT-05",
-    action: "Fix the environment contract — ensure the env variable is documented in the .env.example file.",
-  },
-  {
-    ruleId: "DEPLOY-SCRIPTS-03",
-    action: "Fix the deploy script — ensure the script is executable and matches the deployment pipeline.",
-  },
-  {
-    ruleId: "FLEET-05",
-    action: "Fix the fleet configuration — ensure the fleet entry matches the declared schema.",
-  },
-];
-
-export const REMEDIATION_CATALOG: ReadonlyMap<string, RemediationPattern> = new Map(
-  REMEDIATION_ENTRIES.map((entry) => [entry.ruleId, entry]),
-);
-
-export function lookupRemediation(ruleId: string): RemediationPattern | undefined {
-  return REMEDIATION_CATALOG.get(ruleId);
-}

package/src/share/scripts/index.ts

@@ -1,26 +0,0 @@
-/* 
-<MODULE_CONTRACT> 
-<purpose>Serves as a central export point for various script modules utilized in dynamic loading contexts.</purpose> 
- 
- 
-<non-goals> 
-<item>Do not define new modules or components.</item> 
-<item>Do not manage application state or business logic.</item> 
-</non-goals> 
-</MODULE_CONTRACT> 
- 
-<CHANGE_SUMMARY>
-  <item>Added Compass scaffolding to clarify module roles and prevent scope creep.</item>
-</CHANGE_SUMMARY> 
-*/
-
-// scheduler.ts is loaded dynamically by orchestrator.ts and lordicon.ts
-export * from "./lordicon.ts";
-export * from "./external-links.ts";
-export * from "./external-link-qr.ts";
-export * from "./lenis.ts";
-export * from "./orchestrator.ts";
-// gsap-counter.ts (RFC-0040) is loaded dynamically by orchestrator.ts
-// inline-number-animation.ts (RFC-0041) is loaded dynamically by orchestrator.ts
-// gsap-reveal.ts / gsap-parallax.ts / gsap-stagger.ts (RFC-0106) are loaded
-// dynamically by orchestrator.ts via the reveal / parallax / stagger opt-ins.

package/src/share/scripts/tests/orchestrator.test.ts

@@ -1,8 +0,0 @@
-import { describe, it, expect } from "vitest";
-import { runStandardLayoutOrchestration } from "../orchestrator.ts";
-
-describe("runStandardLayoutOrchestration", () => {
-  it("is an async function", () => {
-    expect(typeof runStandardLayoutOrchestration).toBe("function");
-  });
-});

package/src/share/semantic/jsonld/shared.ts

@@ -1,31 +0,0 @@
-/*
-<MODULE_CONTRACT>
-<purpose>Maintains packages/share/src/semantic/jsonld/shared.ts as an authored share authored module so agents can evolve it without rediscovering local boundaries.</purpose>
-<non-goals>
-  <item>Do not modify node structure.</item>
-</non-goals>
-</MODULE_CONTRACT>
-<CHANGE_SUMMARY>
-  <item>Added graph deduplication utility keyed by @id.</item>
-</CHANGE_SUMMARY>
-*/
-
-import type { JsonLdNode } from "./types.ts";
-
-export function dedupeGraph(nodes: JsonLdNode[]): JsonLdNode[] {
-  const seenIds = new Set<string>();
-
-  return nodes.filter((node) => {
-    const nodeId = typeof node["@id"] === "string" ? node["@id"] : null;
-    if (!nodeId) {
-      return true;
-    }
-
-    if (seenIds.has(nodeId)) {
-      return false;
-    }
-
-    seenIds.add(nodeId);
-    return true;
-  });
-}

package/src/share/semantic/jsonld/types.ts

@@ -1,19 +0,0 @@
-// test-adjacency: exempt — pure type definitions
-/*
-<MODULE_CONTRACT>
-<purpose>Maintains packages/share/src/semantic/jsonld/types.ts as an authored share authored module so agents can evolve it without rediscovering local boundaries.</purpose>
-<non-goals>
-  <item>Do not implement JSON-LD processing logic.</item>
-</non-goals>
-</MODULE_CONTRACT>
-<CHANGE_SUMMARY>
-  <item>Moved from app semantic/jsonld/types to packages/share.</item>
-</CHANGE_SUMMARY>
-*/
-
-export type JsonLdNode = Record<string, unknown>;
-
-export type JsonLdDocument = {
-  "@context": "https://schema.org";
-  "@graph": JsonLdNode[];
-};

package/src/share/semantic/jsonld/website.ts

@@ -1,27 +0,0 @@
-/*
-<MODULE_CONTRACT>
-<purpose>Maintains packages/share/src/semantic/jsonld/website.ts as an authored share authored module so agents can evolve it without rediscovering local boundaries.</purpose>
-<non-goals>
-  <item>Do not parse raw content.</item>
-</non-goals>
-</MODULE_CONTRACT>
-<CHANGE_SUMMARY>
-  <item>Added WebSite JSON-LD generation.</item>
-</CHANGE_SUMMARY>
-*/
-
-import type { JsonLdContext } from "./context.ts";
-import type { JsonLdNode } from "./types.ts";
-
-export function buildWebSiteNode(context: JsonLdContext): JsonLdNode {
-  const { page, ids } = context;
-
-  return {
-    "@type": "WebSite",
-    "@id": ids.website,
-    url: page.organization.url,
-    name: page.organization.name,
-    inLanguage: page.lang,
-    publisher: { "@id": ids.organization },
-  };
-}

package/src/share/string-utils.ts

@@ -1,19 +0,0 @@
-/*
-<MODULE_CONTRACT>
-<purpose>Maintains packages/share/src/string-utils.ts as an authored share authored module so agents can evolve it without rediscovering local boundaries.</purpose>
-<non-goals>
-  <item>Do not introduce app-specific runtime composition or deployment behavior into this reusable package source file.</item>
-</non-goals>
-</MODULE_CONTRACT>
-<CHANGE_SUMMARY>
-  <item>Dedup: centralise the kebab-case helper previously duplicated in site-kernel and site-kernel-checks.</item>
-</CHANGE_SUMMARY>
-*/
-
-/** Lowercase, dash-only kebab-case. Strips leading/trailing hyphens. */
-export function toKebabCase(value: string): string {
-  return value
-    .toLowerCase()
-    .replace(/[^a-z0-9]+/g, "-")
-    .replace(/^-+|-+$/g, "");
-}

package/src/share/types/axiom-study.d.ts

@@ -1,22 +0,0 @@
-declare module "@syrokomskyi/axiom-study" {
-  export interface Finding {
-    findingId: string;
-    semanticFingerprint: { algorithm: "sha256"; digest: string; size: number; mediaType: string };
-    methodologyId: string;
-    ruleId: string;
-    affectedSubjectId: string;
-    title: string;
-    severity: "info" | "low" | "medium" | "high" | "critical";
-    evidence: Array<{
-      evidenceRef: {
-        artifactId: string;
-        rootDigest: { algorithm: "sha256"; digest: string; size: number; mediaType: string };
-        schema: string;
-      };
-      selector: string;
-      evidenceClass: string;
-    }>;
-    uncertainty: unknown[];
-    extension: Record<string, unknown>;
-  }
-}

package/src/share/types/hls-js-light.d.ts

@@ -1,16 +0,0 @@
-/*
-<MODULE_CONTRACT>
-<purpose>Type shim for the official `hls.js/light` export used by the lazy feature-video runtime.</purpose>
-<non-goals>
-  <item>Do not change runtime resolution; this file only fills the missing package declaration.</item>
-</non-goals>
-</MODULE_CONTRACT>
-<CHANGE_SUMMARY>
-  <item>Use the hls.js light runtime without losing TypeScript strictness.</item>
-</CHANGE_SUMMARY>
-*/
-
-declare module "hls.js/light" {
-  export { default } from "hls.js";
-  export * from "hls.js";
-}

package/src/share/types/qrcode-browser.d.ts

@@ -1,18 +0,0 @@
-/*
-<MODULE_CONTRACT>
-<purpose>Type shim for the qrcode browser entry point (qrcode/lib/browser.js).
-The qrcode package only ships types for its main entry, but the browser entry
-exports the same toCanvas function. This shim re-exports all types from qrcode
-so the client-side QR code script gets full type safety.</purpose>
-<non-goals>
-  <item>Do not change runtime resolution; this file only fills the missing package declaration.</item>
-</non-goals>
-</MODULE_CONTRACT>
-<CHANGE_SUMMARY>
-  <item>Add type declaration for qrcode/lib/browser.js deep import used by external-link-qr.ts.</item>
-</CHANGE_SUMMARY>
-*/
-
-declare module "qrcode/lib/browser.js" {
-  export * from "qrcode";
-}

package/src/share/utility-registry.yaml

@@ -1,50 +0,0 @@
-utilities:
-  - id: slug
-    canonicalPath: packages/werkstatt-shared/src/share/slug/
-    forbiddenImports:
-      - "@sindresorhus/slugify"
-      - cyrillic-to-translit-js
-      - github-slugger
-    functionNames:
-      - slugify
-      - toSlug
-      - makeSlug
-      - createSlug
-      - slugUrl
-      - slugId
-    patterns:
-      - id: nkfd-diacritic-strip
-        regex: "\\.normalize\\(.{0,5}NFKD.{0,5}\\)\\.replace"
-        description: NFKD normalize + diacritic strip + non-alphanumeric replace (legacy custom slugify pattern)
-    allowlist:
-      - path: packages/werkstatt-shared/src/share/slug/
-        reason: Canonical slug module — owns all slug generation logic (RFC-0915, DNA-88)
-      - path: packages/werkstatt-shared/src/share/semantic/extract.ts
-        reason: CHANGE_SUMMARY comment references slugify removal — no function definition remains
-      - path: packages/werkstatt-site/src/checks/tests/utility-provenance.test.ts
-        reason: Test file intentionally contains forbidden patterns to validate the provenance validator (RFC-0916)
-      - path: packages/werkstatt-site/src/checks/utility-provenance.ts
-        reason: Validator implementation references forbidden imports/function names in string literals for detection logic (RFC-0916)
-  - id: template-filter
-    canonicalPath: packages/werkstatt-shared/src/share/routes/
-    forbiddenImports: []
-    functionNames:
-      - hasPlaceholderRoutes
-    patterns: []
-    allowlist:
-      - path: packages/werkstatt-shared/src/share/routes/
-        reason: Canonical placeholder route filter — owns all template detection logic (RFC-0917)
-  - id: remediation-catalog
-    canonicalPath: packages/werkstatt-shared/src/share/remediation/
-    forbiddenImports: []
-    functionNames:
-      - lookupRemediation
-      - REMEDIATION_CATALOG
-    patterns: []
-    allowlist:
-      - path: packages/werkstatt-shared/src/share/remediation/
-        reason: Canonical remediation catalog — owns all ruleId-to-remediation-pattern mappings (RFC-1027)
-      - path: packages/werkstatt-shared/src/checks/result-helpers.ts
-        reason: Consumes lookupRemediation to auto-populate Diagnostic.remediation (RFC-1027)
-      - path: packages/werkstatt-engine/src/remediation/
-        reason: Engine remediation module reads REMEDIATION_CATALOG for catalog.generate and hint.validate (RFC-1027)

package/src/share/vitest.config.ts

@@ -1,8 +0,0 @@
-import { defineConfig } from "vitest/config";
-
-export default defineConfig({
-  test: {
-    environment: "node",
-    include: ["src/**/*.test.ts"],
-  },
-});