@kerfjs/ui 5.0.0-beta.18 → 5.0.0-beta.22

package/analyzer/report.schema.json

@@ -0,0 +1,66 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/brianwestphal/kerf/main/ui/analyzer/report.schema.json",
+  "title": "Kerf UI static analysis report",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "tool",
+    "root",
+    "files",
+    "profile",
+    "diagnostics",
+    "summary"
+  ],
+  "properties": {
+    "schemaVersion": { "const": 1 },
+    "tool": {
+      "type": "object",
+      "required": ["name", "version"],
+      "properties": {
+        "name": { "type": "string" },
+        "version": { "type": "integer" }
+      },
+      "additionalProperties": false
+    },
+    "root": { "type": "string" },
+    "files": { "type": "array", "items": { "type": "string" } },
+    "profile": { "type": "object" },
+    "diagnostics": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["ruleId", "severity", "message", "location"],
+        "properties": {
+          "ruleId": { "pattern": "^KUI-L[0-9]{3}$" },
+          "severity": { "enum": ["error", "review"] },
+          "message": { "type": "string" },
+          "location": {
+            "type": "object",
+            "required": ["file", "line", "column"],
+            "properties": {
+              "file": { "type": "string" },
+              "line": { "type": "integer", "minimum": 1 },
+              "column": { "type": "integer", "minimum": 1 }
+            },
+            "additionalProperties": false
+          },
+          "evidence": {},
+          "chain": {}
+        },
+        "additionalProperties": false
+      }
+    },
+    "summary": {
+      "type": "object",
+      "required": ["errors", "review", "suppressed"],
+      "properties": {
+        "errors": { "type": "integer", "minimum": 0 },
+        "review": { "type": "integer", "minimum": 0 },
+        "suppressed": { "type": "integer", "minimum": 0 }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

package/dist/browser/pane.js

@@ -0,0 +1,3 @@
+import '../styles/foundation.css';
+import '../styles/pane.css';
+export * from '../pane.js';

package/dist/browser/sunken-panel.js

@@ -0,0 +1,3 @@
+import '../styles/foundation.css';
+import '../styles/sunken-panel.css';
+export * from '../sunken-panel.js';

package/dist/catalog-resources.d.ts

@@ -0,0 +1,34 @@
+import { CatalogResource } from './catalog.js';
+import 'kerfjs';
+
+/**
+ * Standard resource labels for a Kerf catalog detail footer. Keep these labels
+ * stable across catalogs so people and AI-generated integrations see the same
+ * choices in the same vocabulary.
+ */
+type CatalogResourceKind = 'demoSource' | 'componentSource' | 'designTemplate' | 'guidance' | 'integrationGuidance';
+type CatalogGuidanceKind = 'guidance' | 'integrationGuidance';
+interface CatalogResourceTarget {
+    href: string;
+    /** Optional monospace detail, normally the repository-relative source path. */
+    detail?: string;
+}
+interface CatalogResourcesInput {
+    /** Required source for the runnable demonstration. */
+    demoSource: CatalogResourceTarget;
+    /** Source for the production component; omit for recipes and integrations. */
+    componentSource?: CatalogResourceTarget;
+    /** Optional design-tool template associated with the component. */
+    designTemplate?: CatalogResourceTarget;
+    /** Required UI or integration guidance. */
+    guidance: CatalogResourceTarget;
+    /** Use `integrationGuidance` when the component implementation is upstream. */
+    guidanceKind?: CatalogGuidanceKind;
+}
+/**
+ * Build the standard catalog resource group in its canonical order: demo,
+ * component, optional design template, then guidance.
+ */
+declare function catalogResources(input: CatalogResourcesInput): CatalogResource[];
+
+export { type CatalogGuidanceKind, type CatalogResourceKind, type CatalogResourceTarget, type CatalogResourcesInput, catalogResources };

package/dist/catalog-resources.js

@@ -0,0 +1,22 @@
+// src/catalog-resources.ts
+function catalogResources(input) {
+  const resources = [
+    { label: "Demo source", ...input.demoSource }
+  ];
+  if (input.componentSource)
+    resources.push({
+      label: "Component source",
+      ...input.componentSource
+    });
+  if (input.designTemplate)
+    resources.push({ label: "Design template", ...input.designTemplate });
+  resources.push({
+    label: input.guidanceKind === "integrationGuidance" ? "Integration guidance" : "Guidance",
+    ...input.guidance
+  });
+  return resources;
+}
+
+export { catalogResources };
+
+//# sourceMappingURL=catalog-resources.js.map

package/dist/catalog-resources.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/catalog-resources.ts"],"names":[],"mappings":";AAuCO,SAAS,iBACd,KAAA,EACmB;AACnB,EAAA,MAAM,SAAA,GAA+B;AAAA,IACnC,EAAE,KAAA,EAAO,aAAA,EAAe,GAAG,MAAM,UAAA;AAAW,GAC9C;AACA,EAAA,IAAI,KAAA,CAAM,eAAA;AACR,IAAA,SAAA,CAAU,IAAA,CAAK;AAAA,MACb,KAAA,EAAO,kBAAA;AAAA,MACP,GAAG,KAAA,CAAM;AAAA,KACV,CAAA;AACH,EAAA,IAAI,KAAA,CAAM,cAAA;AACR,IAAA,SAAA,CAAU,KAAK,EAAE,KAAA,EAAO,mBAAmB,GAAG,KAAA,CAAM,gBAAgB,CAAA;AACtE,EAAA,SAAA,CAAU,IAAA,CAAK;AAAA,IACb,KAAA,EACE,KAAA,CAAM,YAAA,KAAiB,qBAAA,GACnB,sBAAA,GACA,UAAA;AAAA,IACN,GAAG,KAAA,CAAM;AAAA,GACV,CAAA;AACD,EAAA,OAAO,SAAA;AACT","file":"catalog-resources.js","sourcesContent":["import type { CatalogResource } from './catalog.js';\n\n/**\n * Standard resource labels for a Kerf catalog detail footer. Keep these labels\n * stable across catalogs so people and AI-generated integrations see the same\n * choices in the same vocabulary.\n */\nexport type CatalogResourceKind =\n  | 'demoSource'\n  | 'componentSource'\n  | 'designTemplate'\n  | 'guidance'\n  | 'integrationGuidance';\n\nexport type CatalogGuidanceKind = 'guidance' | 'integrationGuidance';\n\nexport interface CatalogResourceTarget {\n  href: string;\n  /** Optional monospace detail, normally the repository-relative source path. */\n  detail?: string;\n}\n\nexport interface CatalogResourcesInput {\n  /** Required source for the runnable demonstration. */\n  demoSource: CatalogResourceTarget;\n  /** Source for the production component; omit for recipes and integrations. */\n  componentSource?: CatalogResourceTarget;\n  /** Optional design-tool template associated with the component. */\n  designTemplate?: CatalogResourceTarget;\n  /** Required UI or integration guidance. */\n  guidance: CatalogResourceTarget;\n  /** Use `integrationGuidance` when the component implementation is upstream. */\n  guidanceKind?: CatalogGuidanceKind;\n}\n\n/**\n * Build the standard catalog resource group in its canonical order: demo,\n * component, optional design template, then guidance.\n */\nexport function catalogResources(\n  input: CatalogResourcesInput,\n): CatalogResource[] {\n  const resources: CatalogResource[] = [\n    { label: 'Demo source', ...input.demoSource },\n  ];\n  if (input.componentSource)\n    resources.push({\n      label: 'Component source',\n      ...input.componentSource,\n    });\n  if (input.designTemplate)\n    resources.push({ label: 'Design template', ...input.designTemplate });\n  resources.push({\n    label:\n      input.guidanceKind === 'integrationGuidance'\n        ? 'Integration guidance'\n        : 'Guidance',\n    ...input.guidance,\n  });\n  return resources;\n}\n"]}

package/dist/catalog.d.ts

@@ -97,6 +97,16 @@ declare function Catalog({ brand, sections, active, content, collapsed, theme, h
  * - `'none'` — a content-item / composition that owns its geometry and already aligns; no inset (default).
  */
 type CatalogExampleAlign = 'glyph' | 'inline-control' | 'none';
+type CatalogExampleRootAttributes = Readonly<Record<`data-${string}`, string | undefined> & {
+    'data-catalog-example'?: never;
+    'data-catalog-example-stack'?: never;
+    'data-align'?: never;
+}>;
+type CatalogExampleStackRootAttributes = Readonly<Record<`data-${string}`, string | undefined> & {
+    'data-catalog-example'?: never;
+    'data-catalog-example-stack'?: never;
+    'data-align'?: never;
+}>;
 interface CatalogExampleProps {
     /** The example's label, shown as a `ListHeader` above the specimen. Omit for a bare specimen. */
     label?: string;
@@ -104,6 +114,8 @@ interface CatalogExampleProps {
     note?: SafeHtml | string;
     /** Alignment inset for the specimen — see {@link CatalogExampleAlign}. Default `'none'`. */
     align?: CatalogExampleAlign;
+    /** Safe authoring `data-*` metadata for the rendered section. Helper-owned structural attributes remain protected. */
+    rootAttributes?: CatalogExampleRootAttributes;
     className?: string;
     children?: SafeHtml | readonly SafeHtml[];
 }
@@ -115,14 +127,20 @@ interface CatalogExampleProps {
  * `--kui-catalog-example-align` custom property so a debug overlay can exclude it
  * from a specimen's measured margin.
  */
-declare function CatalogExample({ label, note, align, className, children, }: CatalogExampleProps): SafeHtml;
+declare function CatalogExample({ label, note, align, rootAttributes, className, children, }: CatalogExampleProps): SafeHtml;
 interface CatalogExampleStackProps {
     /** Accessible label for the stack region. */
     label?: string;
+    /** Safe authoring `data-*` metadata for the rendered stack. Helper-owned structural attributes remain protected. */
+    rootAttributes?: CatalogExampleStackRootAttributes;
     className?: string;
     children?: SafeHtml | readonly SafeHtml[];
 }
-/** A vertically-stacked group of {@link CatalogExample}s with the catalog's example rhythm. */
-declare function CatalogExampleStack({ label, className, children, }: CatalogExampleStackProps): SafeHtml;
+/**
+ * A vertically-stacked group of {@link CatalogExample}s with the catalog's
+ * example rhythm. The semantic `section` becomes a named `region` when `label`
+ * is supplied; an unlabeled stack remains an ordinary grouping.
+ */
+declare function CatalogExampleStack({ label, rootAttributes, className, children, }: CatalogExampleStackProps): SafeHtml;
 
 export { Catalog, type CatalogBrand, type CatalogEntry, CatalogExample, type CatalogExampleAlign, type CatalogExampleProps, CatalogExampleStack, type CatalogExampleStackProps, type CatalogProps, type CatalogRelated, type CatalogResource, type CatalogSecondaryGroup, type CatalogSection };