@estiva-app/ui 0.21.0 → 0.22.0

package/dist/registry/find.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../src/registry/find.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAEvD,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,aAAa,CAAA;IACpB,4EAA4E;IAC5E,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;IACb,uDAAuD;IACvD,KAAK,EAAE,MAAM,EAAE,CAAA;IACf;;;;;OAKG;IACH,KAAK,EAAE,MAAM,EAAE,CAAA;CAChB;AAoDD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAS,EAAE,GAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,OAAO,EAAE,CAiEnH;AAED,yGAAyG;AACzG,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,GAAG,MAAM,GAAG,IAAI,CAGhF;AAED,gGAAgG;AAChG,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAiC7F"}

package/dist/registry/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * `@estiva-app/ui/registry` — the component catalogue (UIG-12, seam S2).
+ *
+ * The one copy, here, as every gate piece is (docs/GATES.md §23): the skill
+ * (UIG-20), the copy detector (UIG-25) and the merged search (UIG-19) read
+ * this, and no repo keeps a parser of its own.
+ *
+ * The data itself is `registry.json` at the package's root, committed and
+ * shipped. Read it with `estiva-ui find`, or import these to read it yourself.
+ */
+export { buildRegistry, readIndexExports, serializeRegistry, type BuildOptions } from './build';
+export { docsLink, findInRegistry, formatFindings, type Finding } from './find';
+export { SCHEMA_VERSION, validateRegistry, type EntryBehaviour, type EntryKind, type EntryStatus, type EntryVariant, type PurposeSource, type Registry, type RegistryEntry, type RegistryExclusion, } from './schema';
+//# sourceMappingURL=index.d.ts.map

package/dist/registry/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/registry/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,KAAK,YAAY,EAAE,MAAM,SAAS,CAAA;AAC/F,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,OAAO,EAAE,MAAM,QAAQ,CAAA;AAC/E,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,KAAK,cAAc,EACnB,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,aAAa,EAClB,KAAK,iBAAiB,GACvB,MAAM,UAAU,CAAA"}

package/dist/registry/index.js

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+import {
+  docsLink,
+  findInRegistry,
+  formatFindings
+} from "./chunk-IJNCYVH4.js";
+import {
+  buildRegistry,
+  readIndexExports,
+  serializeRegistry
+} from "./chunk-QDYGB3QN.js";
+import {
+  SCHEMA_VERSION,
+  validateRegistry
+} from "./chunk-MRSBS5OP.js";
+export {
+  SCHEMA_VERSION,
+  buildRegistry,
+  docsLink,
+  findInRegistry,
+  formatFindings,
+  readIndexExports,
+  serializeRegistry,
+  validateRegistry
+};
+//# sourceMappingURL=index.js.map

package/dist/registry/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/dist/registry/schema.d.ts

@@ -0,0 +1,147 @@
+/**
+ * The catalogue's shape (UIG-12, seam S2 in docs/GATES.md §16).
+ *
+ * A **data source read by machines first** and rendered second — not a
+ * documentation generator. The skill (UIG-20), the copy detector (UIG-25) and
+ * the merged search (UIG-19) all read this and nothing else, so the field
+ * names are the contract and `schemaVersion` is what makes a change to them
+ * detectable.
+ *
+ * Names are plain and ours. Open-sourcing is far off; when it comes, a
+ * renaming pass is one version bump, and guessing at a public vocabulary now
+ * would cost every reader between here and there.
+ */
+/**
+ * Raise this whenever a field is added, removed or given a new meaning. A
+ * reader that knows version N and is handed N+1 must be able to say so rather
+ * than silently read a field that moved.
+ */
+export declare const SCHEMA_VERSION = 1;
+/** What a name is, which decides how a reader offers it. */
+export type EntryKind = 
+/** Draws something. Used in JSX. */
+'component'
+/** A React hook: `use…`, callable only inside a component. */
+ | 'hook'
+/** A function or a constant. Neither of the above. */
+ | 'helper';
+/** Where an entry's one-line purpose was read from. */
+export type PurposeSource = 
+/** The `.mdx` page's opening paragraph — the name has a page of its own. */
+'page'
+/** The doc comment above the export — the name is documented on a sibling's page. */
+ | 'comment';
+export type EntryStatus = 'stable' | 'migrating' | 'deprecated';
+/** A prop that takes one of a known set of words, and the set. */
+export interface EntryVariant {
+    prop: string;
+    values: string[];
+}
+/**
+ * One prop a component declares itself.
+ *
+ * **Itself**, not what it inherits: a component that extends
+ * `ComponentPropsWithRef<'div'>` would otherwise drag in every DOM attribute,
+ * which is noise in a catalogue whose whole point is a short answer.
+ */
+export interface EntryProp {
+    name: string;
+    /**
+     * What it takes, in a word a person reads: `true/false`, `number`, `text`,
+     * `anything`, `a handler`, the words themselves for a set (`left | right`),
+     * or the type as written where none of those fit.
+     */
+    takes: string;
+    required: boolean;
+    /** The first sentence of the prop's own comment, where it has one. */
+    note: string | null;
+}
+/** A behaviour this component owns, from UIG-8's enumeration. */
+export interface EntryBehaviour {
+    /** `OwnedBehaviour.id` — `portal`, `walking`, `scroll`… */
+    id: string;
+    /** What a person notices it doing, in words. */
+    behaviour: string;
+}
+export interface RegistryEntry {
+    /** The exported name, exactly as `index.ts` exports it. */
+    name: string;
+    /** Which library it came from. One repo per registry until UIG-13 merges them. */
+    repo: string;
+    kind: EntryKind;
+    /** What a caller actually types. */
+    importPath: string;
+    /** The file the name is declared in, relative to the repo. Several names share one file. */
+    sourceFile: string;
+    /** One line: what it is for. Never empty — the build fails instead. */
+    purpose: string;
+    purposeFrom: PurposeSource;
+    /**
+     * Every prop it declares itself — what it can do. This is the field a reader
+     * asks "does it already do X?" of, before writing X by hand.
+     */
+    props: EntryProp[];
+    /**
+     * The subset of `props` that takes one of a known set of words, structured.
+     * Kept beside `props` because it is what a search ranks well on, and what a
+     * caller most often needs named back at them.
+     */
+    variants: EntryVariant[];
+    /** What it owns, so a caller never rebuilds it (UIG-8). Empty for most. */
+    ownsBehaviours: EntryBehaviour[];
+    status: EntryStatus;
+    /**
+     * Which migration stage plans to change it.
+     *
+     * Always `null` here. The migration's plan lives in `K:/Estiva/migration
+     * docs`, which is not in this repo and is not in CI — and a copy kept here by
+     * hand is the drifting list this whole project exists to remove. The field
+     * stays in the schema because a later ticket may have a source a build can
+     * read; until then a reader gets an honest `null` rather than a stale number.
+     */
+    migrationStage: number | null;
+    /** The `.mdx` page's Storybook id, or `null` where the name has no page of its own. */
+    docsId: string | null;
+    /** A story that shows it, by Storybook id. `null` where nothing renders it alone. */
+    storyId: string | null;
+    /** The `.mdx` path, relative to the repo, or `null`. */
+    docPage: string | null;
+}
+/** A name that is exported and deliberately not an entry. Empty today; the count still has to reconcile. */
+export interface RegistryExclusion {
+    name: string;
+    reason: string;
+}
+export interface Registry {
+    schemaVersion: number;
+    builtFrom: {
+        repo: string;
+        /** The npm package the entries are imported from. */
+        package: string;
+        packageVersion: string;
+        /** Value exports counted in `index.ts`. `entries + excluded` must equal it. */
+        exports: number;
+        /** Type-only exports, which are not entries. Recorded so the count reconciles. */
+        typeExports: number;
+    };
+    /**
+     * How to turn an id into a link. There is no Storybook on the internet yet
+     * (UIG-19), so an absolute URL committed here would resolve nowhere: the
+     * reader joins its own base to these.
+     */
+    storybook: {
+        docsPath: string;
+        storyPath: string;
+        devUrl: string;
+    };
+    entries: RegistryEntry[];
+    excluded: RegistryExclusion[];
+}
+/**
+ * Check a registry against this schema. Returns every problem, not the first:
+ * a build that reports one missing purpose per run costs one run per entry.
+ *
+ * An empty list is the only pass. CI runs this on the committed file.
+ */
+export declare function validateRegistry(value: unknown): string[];
+//# sourceMappingURL=schema.d.ts.map

package/dist/registry/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/registry/schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH;;;;GAIG;AACH,eAAO,MAAM,cAAc,IAAI,CAAA;AAE/B,4DAA4D;AAC5D,MAAM,MAAM,SAAS;AACnB,oCAAoC;AAClC,WAAW;AACb,8DAA8D;GAC5D,MAAM;AACR,sDAAsD;GACpD,QAAQ,CAAA;AAEZ,uDAAuD;AACvD,MAAM,MAAM,aAAa;AACvB,4EAA4E;AAC1E,MAAM;AACR,qFAAqF;GACnF,SAAS,CAAA;AAEb,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,YAAY,CAAA;AAE/D,kEAAkE;AAClE,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,OAAO,CAAA;IACjB,sEAAsE;IACtE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CACpB;AAED,iEAAiE;AACjE,MAAM,WAAW,cAAc;IAC7B,2DAA2D;IAC3D,EAAE,EAAE,MAAM,CAAA;IACV,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAA;IACZ,kFAAkF;IAClF,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,SAAS,CAAA;IACf,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAA;IAClB,4FAA4F;IAC5F,UAAU,EAAE,MAAM,CAAA;IAClB,uEAAuE;IACvE,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,aAAa,CAAA;IAC1B;;;OAGG;IACH,KAAK,EAAE,SAAS,EAAE,CAAA;IAClB;;;;OAIG;IACH,QAAQ,EAAE,YAAY,EAAE,CAAA;IACxB,2EAA2E;IAC3E,cAAc,EAAE,cAAc,EAAE,CAAA;IAChC,MAAM,EAAE,WAAW,CAAA;IACnB;;;;;;;;OAQG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,uFAAuF;IACvF,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,qFAAqF;IACrF,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,wDAAwD;IACxD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;CACvB;AAED,4GAA4G;AAC5G,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,QAAQ;IACvB,aAAa,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,qDAAqD;QACrD,OAAO,EAAE,MAAM,CAAA;QACf,cAAc,EAAE,MAAM,CAAA;QACtB,+EAA+E;QAC/E,OAAO,EAAE,MAAM,CAAA;QACf,kFAAkF;QAClF,WAAW,EAAE,MAAM,CAAA;KACpB,CAAA;IACD;;;;OAIG;IACH,SAAS,EAAE;QACT,QAAQ,EAAE,MAAM,CAAA;QAChB,SAAS,EAAE,MAAM,CAAA;QACjB,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,OAAO,EAAE,aAAa,EAAE,CAAA;IACxB,QAAQ,EAAE,iBAAiB,EAAE,CAAA;CAC9B;AASD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,EAAE,CAwGzD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@estiva-app/ui",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "description": "Estiva's design tokens (the contract) and a small set of primitives (a convenience) for every Estiva app.",
   "type": "module",
   "license": "MIT",
@@ -8,6 +8,7 @@
     "dist",
     "src",
     "stories",
+    "registry.json",
     "tailwind-preset.js",
     "tokens.css",
     "base.css",
@@ -27,6 +28,11 @@
       "types": "./dist/gates/index.d.ts",
       "default": "./dist/gates/index.js"
     },
+    "./registry": {
+      "types": "./dist/registry/index.d.ts",
+      "default": "./dist/registry/index.js"
+    },
+    "./registry.json": "./registry.json",
     "./tailwind-preset": "./tailwind-preset.js",
     "./tokens.css": "./tokens.css",
     "./package.json": "./package.json",
@@ -34,7 +40,8 @@
   },
   "bin": {
     "create-estiva-app": "dist/gates/create-app.js",
-    "estiva-gates": "dist/gates/cli.js"
+    "estiva-gates": "dist/gates/cli.js",
+    "estiva-ui": "dist/registry/cli.js"
   },
   "scripts": {
     "build": "node build.mjs && tsc -p tsconfig.build.json",
@@ -54,6 +61,12 @@
     "gates:status": "node dist/gates/cli.js status",
     "pregates:compare": "node build.mjs",
     "gates:compare": "node scripts/gates-compare.mjs",
+    "preregistry": "node build.mjs",
+    "registry": "node dist/registry/cli.js build",
+    "preregistry:check": "node build.mjs",
+    "registry:check": "node dist/registry/cli.js check",
+    "preui:find": "node build.mjs",
+    "ui:find": "node dist/registry/cli.js find",
     "prepublishOnly": "npm run build"
   },
   "peerDependencies": {