@happyvertical/smrt-types 0.51.32 → 0.51.33

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,YAAY,EACV,YAAY,EACZ,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,eAAe,CAAC;AAGvB,YAAY,EACV,wBAAwB,EACxB,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AAGzB,YAAY,EACV,kBAAkB,EAClB,oBAAoB,EACpB,wBAAwB,EACxB,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,EACf,uBAAuB,EACvB,kBAAkB,EAClB,mBAAmB,EACnB,aAAa,EACb,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,eAAe,EACf,eAAe,EACf,aAAa,EACb,sBAAsB,EACtB,cAAc,GACf,MAAM,iBAAiB,CAAC;AACzB,YAAY,EACV,2BAA2B,EAC3B,wBAAwB,EACxB,uBAAuB,EACvB,2BAA2B,EAC3B,4BAA4B,EAC5B,2BAA2B,EAC3B,2BAA2B,EAC3B,0BAA0B,EAC1B,qBAAqB,EACrB,2BAA2B,EAC3B,2BAA2B,EAC3B,+BAA+B,EAC/B,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EACjB,4BAA4B,EAC5B,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EACtB,uBAAuB,EACvB,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,6BAA6B,EAC7B,yBAAyB,EACzB,sBAAsB,EACtB,mBAAmB,EACnB,wBAAwB,EACxB,kBAAkB,EAClB,2BAA2B,EAC3B,2BAA2B,EAC3B,yBAAyB,EACzB,yBAAyB,GAC1B,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACV,UAAU,EACV,IAAI,EACJ,gBAAgB,EAChB,MAAM,EACN,IAAI,GACL,MAAM,eAAe,CAAC;AACvB,YAAY,EACV,2BAA2B,EAC3B,qCAAqC,EACrC,qBAAqB,EACrB,oBAAoB,EACpB,+BAA+B,EAC/B,8BAA8B,EAC9B,uBAAuB,EACvB,8BAA8B,EAC9B,wBAAwB,EACxB,qBAAqB,EACrB,uBAAuB,EACvB,2BAA2B,EAC3B,sBAAsB,EACtB,0BAA0B,EAC1B,qBAAqB,EACrB,yBAAyB,EACzB,8BAA8B,GAC/B,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACV,mBAAmB,EACnB,iBAAiB,EACjB,yBAAyB,EACzB,YAAY,EACZ,cAAc,GACf,MAAM,aAAa,CAAC;AACrB,YAAY,EACV,mBAAmB,EACnB,iBAAiB,EACjB,eAAe,EACf,uBAAuB,EACvB,uBAAuB,GACxB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAGtE,OAAO,EACL,mBAAmB,EACnB,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,sBAAsB,EACtB,YAAY,EACZ,UAAU,GACX,MAAM,WAAW,CAAC"}

package/dist/knowledge.d.ts

@@ -0,0 +1,279 @@
+import type { CapabilityClassification } from './capability.js';
+/** Kind of generated surface a knowledge entry describes (REST/CLI/MCP/AI). */
+export type DomainKnowledgeSurfaceKind = 'api' | 'cli' | 'mcp' | 'ai';
+/** A single generated surface (one api/cli/mcp/ai operation) exposed by an object. */
+export interface DomainKnowledgeSurface {
+    kind: DomainKnowledgeSurfaceKind;
+    name: string;
+    operation: string;
+    path?: string;
+    method?: string;
+    description?: string;
+    objectName?: string;
+}
+/**
+ * A public method a generated surface deliberately does NOT expose, and why.
+ *
+ * Silence is the failure mode this closes: before #2686 a method that produced
+ * no route simply did not appear, leaving an author to guess whether they had
+ * mistyped a name, hit an `exclude`, or written a signature no HTTP caller can
+ * satisfy. `reason` is human-readable prose; `code` is the stable key to react
+ * to programmatically.
+ */
+export interface DomainKnowledgeWithheldSurface {
+    kind: DomainKnowledgeSurfaceKind;
+    /** The method name that was withheld. */
+    operation: string;
+    /**
+     * Stable rejection key — `not-wireable`, `excluded`, `not-included`,
+     * `withheld`, `lifecycle-method`, `no-receiver`, `api-disabled`.
+     */
+    code: string;
+    /** Human-readable explanation, e.g. why a parameter cannot cross a wire. */
+    reason: string;
+    objectName?: string;
+}
+/** Per-object configuration controlling domain-knowledge generation and exposure. */
+export interface DomainKnowledgeConfig {
+    enabled?: boolean;
+    api?: {
+        /**
+         * Generate HTTP knowledge routes. Disabled by default; prefer CLI/MCP for
+         * agent workflows unless this is a guarded dev/admin endpoint.
+         */
+        enabled?: boolean;
+        basePath?: string;
+        includeDocs?: boolean;
+        includePrompts?: boolean;
+        /**
+         * Require dev mode or admin locals for HTTP knowledge access. Setting this
+         * to false makes the route public and should only be used when sanitized
+         * anonymous schema/surface metadata is acceptable.
+         */
+        requireAdmin?: boolean;
+    };
+    includeDocs?: boolean;
+    includePrompts?: boolean;
+    tags?: string[];
+    summary?: string;
+    risks?: string[];
+}
+/** Validation constraints retained in the curated agent-facing field shape. */
+export interface DomainKnowledgeFieldConstraints {
+    min?: number;
+    max?: number;
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+}
+/** A field retained in the curated agent-facing object shape. */
+export interface DomainKnowledgeField {
+    name: string;
+    type: string;
+    required?: boolean;
+    related?: string;
+    columnType?: string;
+    default?: unknown;
+    constraints?: DomainKnowledgeFieldConstraints;
+    readonly?: boolean;
+    transient?: boolean;
+}
+/** Additive structured signature; `methods: string[]` remains the compatibility surface. */
+export interface DomainKnowledgeMethodSignature {
+    name: string;
+    async?: boolean;
+    static?: boolean;
+    params?: string[];
+    returns?: string;
+}
+/** Normalized tenancy facts from `@smrt({ tenantScoped })`. */
+export interface DomainKnowledgeTenant {
+    scoped: boolean;
+    mode?: 'required' | 'optional';
+    field?: string;
+}
+/** One object's entry in the domain-knowledge manifest (fields, relationships, surfaces). */
+export interface DomainKnowledgeObject {
+    name: string;
+    qualifiedName?: string;
+    collection: string;
+    tableName?: string;
+    packageName?: string;
+    extends?: string;
+    visibility?: string;
+    fields: DomainKnowledgeField[];
+    relationships: DomainKnowledgeField[];
+    methods: string[];
+    methodSignatures?: DomainKnowledgeMethodSignature[];
+    tenant?: DomainKnowledgeTenant;
+    tableStrategy?: 'cti' | 'sti';
+    conflictColumns?: string[];
+    surfaces: DomainKnowledgeSurface[];
+    /**
+     * Public methods a generated surface withheld, with the reason for each.
+     * Omitted entirely when nothing was withheld, so an artifact for a fully
+     * exposed object is unchanged (#2686).
+     */
+    withheldSurfaces?: DomainKnowledgeWithheldSurface[];
+    relationshipFeatures: string[];
+    tags: string[];
+    summary?: string;
+    risks: string[];
+}
+/**
+ * A sibling module doc linked from a package's `AGENTS.md` (#2108).
+ *
+ * Oversized package docs are split by module into `packages/<pkg>/agents/<module>.md`
+ * rather than nested `AGENTS.md` files, because instruction chains are additive.
+ * The link in `AGENTS.md` is the registration: the knowledge tooling resolves it
+ * so the moved prose — which is curated and not regenerable from the manifest —
+ * stays reachable from agent context.
+ */
+export interface DomainKnowledgeModuleDoc {
+    /** Path relative to the package root, e.g. `agents/commissions.md`. */
+    path: string;
+    /** Module name derived from the file's basename, e.g. `commissions`. */
+    module: string;
+    content: string;
+}
+/**
+ * A declared view intent (#2588) as emitted into the knowledge artifact (#2591).
+ *
+ * `id` is the entry's identity everywhere: in this artifact, in a playbook step
+ * (`{ kind: 'intent', id }`), and in `smrt doctor`'s surface report. It is
+ * declared, never derived from a namespace, a generated tool name, or a route,
+ * so it survives every rename those could undergo.
+ */
+export interface DomainKnowledgeViewIntent {
+    id: string;
+    description: string;
+    /** Resolved through the #2587 fail-closed rule at declaration time. */
+    capability: CapabilityClassification;
+    /** The browser registry this intent compiles into, and what it addresses. */
+    target: Record<string, unknown>;
+    hasInputSchema: boolean;
+    /**
+     * Always exactly `['browser']`. An intent moves mounted browser state; a
+     * server-side agent reaches one only through the #2446 command/ack bridge,
+     * which the referencing playbook declares. Typed as the literal tuple so a
+     * consumer cannot read the contract as wider than it is.
+     */
+    planes: ['browser'];
+    /** Declaring module, relative to the package root, in POSIX form. */
+    sourceFile: string;
+}
+/** One step of an emitted playbook. Steps never nest another playbook. */
+export type DomainKnowledgePlaybookStep = {
+    kind: 'operation';
+    model: string;
+    action: string;
+} | {
+    kind: 'intent';
+    id: string;
+};
+/** A registered playbook (#2589) as emitted into the knowledge artifact (#2591). */
+export interface DomainKnowledgePlaybook {
+    key: string;
+    title: string;
+    description: string;
+    steps: DomainKnowledgePlaybookStep[];
+    planes: Array<'browser' | 'server'>;
+    /** False when `planes` was derived from the step kinds rather than declared. */
+    planesDeclared: boolean;
+    onStepFailure: 'abort' | 'continue';
+    enabled: boolean;
+    /** Declaring module, relative to the package root, in POSIX form. */
+    sourceFile: string;
+}
+/**
+ * A declaration the scanner recognized but could not emit.
+ *
+ * Recorded rather than dropped: the whole point of emitting the agent surface
+ * is that "what can an agent do here" has one answer, and an invisible
+ * declaration would quietly make that answer wrong. Every message names
+ * `useWebMcpTool`, the escape hatch for a genuinely computed tool set.
+ */
+export interface DomainKnowledgeAgentSurfaceDiagnostic {
+    code: string;
+    helper: 'defineIntent' | 'definePlaybook';
+    message: string;
+    /** Declaring module, relative to the package root, in POSIX form. */
+    sourceFile: string;
+    line?: number;
+    column?: number;
+}
+/**
+ * The package's declared agent-addressable surface beyond its generated model
+ * tools (#2591).
+ *
+ * Omitted entirely when a package declares no intents, playbooks, or
+ * diagnostics, so an artifact for a package with none stays byte-identical to
+ * what it emitted before this field existed.
+ */
+export interface DomainKnowledgeAgentSurface {
+    intents: DomainKnowledgeViewIntent[];
+    playbooks: DomainKnowledgePlaybook[];
+    diagnostics: DomainKnowledgeAgentSurfaceDiagnostic[];
+}
+/** The package-level domain-knowledge artifact (`smrt-knowledge.json`) — the agent/developer contract. */
+export interface DomainKnowledgeManifest {
+    schemaVersion: 1;
+    /** True when generation removed sensitive fields before projecting objects. */
+    sensitiveFieldsExcluded?: true;
+    generatedAt: string;
+    packageName?: string;
+    packageVersion?: string;
+    sourceManifestPath?: string;
+    agentDocPath?: string;
+    sourceHashes: Record<string, string>;
+    exports: string[];
+    dependencies: Record<string, string>;
+    smrtDependencies: string[];
+    sdkDependencies: string[];
+    tags: string[];
+    summary?: string;
+    risks: string[];
+    objects: DomainKnowledgeObject[];
+    surfaces: DomainKnowledgeSurface[];
+    prompts: Array<{
+        filePath: string;
+        key?: string;
+    }>;
+    relationshipsV2: {
+        foreignKeyFields: number;
+        crossPackageRefFields: number;
+        junctionCollections: number;
+        hierarchicalObjects: number;
+        polymorphicAssociations: number;
+        uuidColumns: number;
+    };
+    agentDoc?: string;
+    /** Sibling module docs linked from `AGENTS.md`; omitted when the package links none. */
+    moduleDocs?: DomainKnowledgeModuleDoc[];
+    /**
+     * Declared view intents and playbooks (#2591). Omitted when the package
+     * declares none, so this field is additive to schema version 1.
+     *
+     * This is deliberately a knowledge-artifact field and not a runtime-manifest
+     * field: `manifest.json` stays runtime-focused, and the agent-addressable
+     * surface is an agent/developer contract.
+     */
+    agentSurface?: DomainKnowledgeAgentSurface;
+}
+/** Result of a domain-knowledge freshness check (stale references, error/warning counts). */
+export interface DomainKnowledgeFreshnessResult {
+    ok: boolean;
+    checkedAt: string;
+    artifactPath?: string;
+    issueCount: number;
+    errorCount: number;
+    warningCount: number;
+    issues: Array<{
+        severity: 'error' | 'warning';
+        code: string;
+        message: string;
+        file?: string;
+        packageName?: string;
+    }>;
+}
+//# sourceMappingURL=knowledge.d.ts.map

package/dist/knowledge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowledge.d.ts","sourceRoot":"","sources":["../src/knowledge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAEhE,+EAA+E;AAC/E,MAAM,MAAM,0BAA0B,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,IAAI,CAAC;AAEtE,sFAAsF;AACtF,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,0BAA0B,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,0BAA0B,CAAC;IACjC,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,4EAA4E;IAC5E,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,qFAAqF;AACrF,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,GAAG,CAAC,EAAE;QACJ;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB;;;;WAIG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;IACF,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,+EAA+E;AAC/E,MAAM,WAAW,+BAA+B;IAC9C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,iEAAiE;AACjE,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,+BAA+B,CAAC;IAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,4FAA4F;AAC5F,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,+DAA+D;AAC/D,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,6FAA6F;AAC7F,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,oBAAoB,EAAE,CAAC;IAC/B,aAAa,EAAE,oBAAoB,EAAE,CAAC;IACtC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,gBAAgB,CAAC,EAAE,8BAA8B,EAAE,CAAC;IACpD,MAAM,CAAC,EAAE,qBAAqB,CAAC;IAC/B,aAAa,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,QAAQ,EAAE,sBAAsB,EAAE,CAAC;IACnC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,8BAA8B,EAAE,CAAC;IACpD,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,wBAAwB;IACvC,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,wEAAwE;IACxE,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,uEAAuE;IACvE,UAAU,EAAE,wBAAwB,CAAC;IACrC,6EAA6E;IAC7E,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,cAAc,EAAE,OAAO,CAAC;IACxB;;;;;OAKG;IACH,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC;IACpB,qEAAqE;IACrE,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,0EAA0E;AAC1E,MAAM,MAAM,2BAA2B,GACnC;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACpD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnC,oFAAoF;AACpF,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,2BAA2B,EAAE,CAAC;IACrC,MAAM,EAAE,KAAK,CAAC,SAAS,GAAG,QAAQ,CAAC,CAAC;IACpC,gFAAgF;IAChF,cAAc,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,OAAO,GAAG,UAAU,CAAC;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,qEAAqE;IACrE,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qCAAqC;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,cAAc,GAAG,gBAAgB,CAAC;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,qEAAqE;IACrE,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACrC,SAAS,EAAE,uBAAuB,EAAE,CAAC;IACrC,WAAW,EAAE,qCAAqC,EAAE,CAAC;CACtD;AAED,0GAA0G;AAC1G,MAAM,WAAW,uBAAuB;IACtC,aAAa,EAAE,CAAC,CAAC;IACjB,+EAA+E;IAC/E,uBAAuB,CAAC,EAAE,IAAI,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjC,QAAQ,EAAE,sBAAsB,EAAE,CAAC;IACnC,OAAO,EAAE,KAAK,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,CAAC,CAAC;IACH,eAAe,EAAE;QACf,gBAAgB,EAAE,MAAM,CAAC;QACzB,qBAAqB,EAAE,MAAM,CAAC;QAC9B,mBAAmB,EAAE,MAAM,CAAC;QAC5B,mBAAmB,EAAE,MAAM,CAAC;QAC5B,uBAAuB,EAAE,MAAM,CAAC;QAChC,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wFAAwF;IACxF,UAAU,CAAC,EAAE,wBAAwB,EAAE,CAAC;IACxC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,2BAA2B,CAAC;CAC5C;AAED,6FAA6F;AAC7F,MAAM,WAAW,8BAA8B;IAC7C,EAAE,EAAE,OAAO,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,KAAK,CAAC;QACZ,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;QAC9B,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC,CAAC;CACJ"}

package/dist/module.d.ts

@@ -0,0 +1,207 @@
+/**
+ * Module type definitions for SMRT Framework
+ *
+ * These types allow SMRT modules to declare their capabilities,
+ * including models, collections, and optional Svelte UI components.
+ *
+ * @example Module with UI components
+ * ```typescript
+ * // In core module: packages/commerce/src/ui.ts
+ * import type { SmrtModuleMeta, ModuleUISlot } from '@happyvertical/smrt-types';
+ *
+ * export const COMMERCE_UI_SLOTS: Record<string, ModuleUISlot> = {
+ *   'invoice-card': { id: 'invoice-card', label: 'Invoice Card', category: 'display' },
+ * };
+ *
+ * export const COMMERCE_MODULE_META: SmrtModuleMeta = {
+ *   name: '@happyvertical/smrt-commerce',
+ *   displayName: 'Commerce',
+ *   uiSlots: COMMERCE_UI_SLOTS,
+ * };
+ *
+ * // In svelte subpath: packages/commerce/src/svelte/index.ts
+ * import { ModuleUIRegistry } from '@happyvertical/smrt-ui/registry';
+ * import { COMMERCE_MODULE_META } from '../ui.js';
+ * import InvoiceCard from './components/InvoiceCard.svelte';
+ *
+ * ModuleUIRegistry.registerModule(COMMERCE_MODULE_META);
+ * ModuleUIRegistry.register('@happyvertical/smrt-commerce', 'invoice-card', InvoiceCard);
+ * ```
+ */
+/**
+ * UI slot definition for a SMRT module.
+ *
+ * Modules declare the slots they support in their `SmrtModuleMeta`. Svelte UI
+ * packages then implement those slots by registering components against the
+ * same `id` via `ModuleUIRegistryInterface.register()`.
+ *
+ * @example
+ * ```typescript
+ * const slot: ModuleUISlot = {
+ *   id: 'invoice-card',
+ *   label: 'Invoice Card',
+ *   description: 'Compact card view for a single invoice',
+ *   category: 'display',
+ *   order: 10,
+ * };
+ * ```
+ *
+ * @see {@link SmrtModuleMeta} for how slots are declared on a module
+ * @see {@link ModuleUIRegistryInterface} for registering component implementations
+ */
+export interface ModuleUISlot {
+    /** Unique identifier (e.g., 'invoice-card', 'customer-form') */
+    id: string;
+    /** Human-readable label */
+    label: string;
+    /** Description of the component's purpose */
+    description?: string;
+    /** Icon identifier (lucide icon names) */
+    icon?: string;
+    /** Display order (lower first) */
+    order?: number;
+    /** Component category for grouping */
+    category?: 'display' | 'form' | 'admin' | 'list' | 'detail' | 'action' | 'dashboard' | 'navigation';
+    /** Required props interface name (for documentation) */
+    propsInterface?: string;
+}
+/**
+ * Metadata declaration for a SMRT module.
+ *
+ * Each module exports a `SmrtModuleMeta` constant describing its package
+ * identity, the UI slots it declares, and the model/collection classes it
+ * provides. The UI registry uses this to resolve component lookups at runtime.
+ *
+ * @example
+ * ```typescript
+ * export const COMMERCE_MODULE_META: SmrtModuleMeta = {
+ *   name: '@happyvertical/smrt-commerce',
+ *   displayName: 'Commerce',
+ *   description: 'Invoicing, contracts, and fulfillment',
+ *   models: ['Customer', 'Invoice', 'Contract'],
+ *   uiSlots: {
+ *     'invoice-card': { id: 'invoice-card', label: 'Invoice Card', category: 'display' },
+ *   },
+ * };
+ * ```
+ *
+ * @see {@link ModuleUISlot} for the shape of each declared slot
+ * @see {@link ModuleUIRegistryInterface} for registering and retrieving module components
+ */
+export interface SmrtModuleMeta {
+    /** Package name (e.g., '@happyvertical/smrt-commerce') */
+    name: string;
+    /** Human-readable display name */
+    displayName: string;
+    /** Module description */
+    description?: string;
+    /** Module version */
+    version?: string;
+    /** UI slots this module declares */
+    uiSlots?: Record<string, ModuleUISlot>;
+    /** Model classes this module provides */
+    models?: string[];
+    /** Collection classes this module provides */
+    collections?: string[];
+    /** Peer dependencies for UI (e.g., ['@happyvertical/smrt-profiles']) */
+    uiDependencies?: string[];
+}
+/**
+ * Generic component type for SMRT module UI slots.
+ *
+ * Intentionally opaque — defined as a loose function signature rather than
+ * `import('svelte').ComponentType` to avoid pulling Svelte (and its DOM types)
+ * into server-side Node.js builds. The actual Svelte component constructor
+ * is assignable to this type at runtime.
+ *
+ * @typeParam Props - The props interface the component accepts; defaults to `unknown`.
+ *
+ * @example
+ * ```typescript
+ * import InvoiceCard from './InvoiceCard.svelte';
+ * // InvoiceCard is assignable to ModuleComponentType<InvoiceCardProps>
+ * registry.register('@happyvertical/smrt-commerce', 'invoice-card', InvoiceCard);
+ * ```
+ *
+ * @see {@link ModuleUIBaseProps} for the base props all slot components receive
+ * @see {@link ModuleUIRegistryInterface} for storing and retrieving components
+ */
+export type ModuleComponentType<Props = unknown> = (...args: any[]) => any;
+/**
+ * Base props contract for all SMRT module UI slot components.
+ *
+ * Every component registered against a `ModuleUISlot` should accept at least
+ * these props. Individual slot components may extend this interface with
+ * slot-specific required props.
+ *
+ * @typeParam TData   - Shape of the primary data object(s) the component renders.
+ * @typeParam TConfig - Shape of the optional configuration/settings object.
+ *
+ * @example
+ * ```typescript
+ * interface InvoiceCardProps extends ModuleUIBaseProps<Invoice> {
+ *   showLineItems?: boolean;
+ * }
+ * ```
+ *
+ * @see {@link ModuleComponentType} for the component type that accepts these props
+ * @see {@link ModuleUISlot} for the slot declaration that names the `propsInterface`
+ */
+export interface ModuleUIBaseProps<TData = unknown, TConfig = unknown> {
+    /** Primary data object(s) the component operates on */
+    data?: TData;
+    /** Configuration/settings */
+    config?: TConfig;
+    /** Callback for data changes */
+    onChange?: (data: TData) => void | Promise<void>;
+    /** Callback for saving */
+    onSave?: (data: TData) => Promise<void>;
+    /** Whether component is read-only */
+    readonly?: boolean;
+    /** CSS class for styling */
+    class?: string;
+    /** Loading state */
+    loading?: boolean;
+}
+/**
+ * Registry interface for mapping SMRT module slots to Svelte components.
+ *
+ * Implemented by `ModuleUIRegistry` in `@happyvertical/smrt-ui`. Consumers
+ * call `register()` once per slot at Svelte package initialisation time and
+ * `get()` when rendering to retrieve the correct component.
+ *
+ * @example
+ * ```typescript
+ * // Registration (in packages/commerce/src/svelte/index.ts)
+ * ModuleUIRegistry.registerModule(COMMERCE_MODULE_META);
+ * ModuleUIRegistry.register('@happyvertical/smrt-commerce', 'invoice-card', InvoiceCard);
+ *
+ * // Retrieval (in a host Svelte app)
+ * const InvoiceCard = ModuleUIRegistry.get('@happyvertical/smrt-commerce', 'invoice-card');
+ * ```
+ *
+ * @see {@link SmrtModuleMeta} for the module metadata structure passed to `registerModule()`
+ * @see {@link ModuleUISlot} for the slot identifiers used as `slotId`
+ * @see {@link ModuleComponentType} for the component type stored in the registry
+ */
+export interface ModuleUIRegistryInterface {
+    /** Register a component for a module's slot */
+    register<TProps extends ModuleUIBaseProps>(moduleName: string, slotId: string, component: ModuleComponentType<TProps>): void;
+    /** Get a component for a module's slot */
+    get<TProps extends ModuleUIBaseProps>(moduleName: string, slotId: string): ModuleComponentType<TProps> | undefined;
+    /** Check if component is registered */
+    has(moduleName: string, slotId: string): boolean;
+    /** Get all registered slot IDs for a module */
+    getSlots(moduleName: string): string[];
+    /** Get all registered module names */
+    getModules(): string[];
+    /** Get module metadata */
+    getModuleMeta(moduleName: string): SmrtModuleMeta | undefined;
+    /** Register module metadata */
+    registerModule(meta: SmrtModuleMeta): void;
+    /** Unregister for testing */
+    unregister(moduleName: string, slotId: string): boolean;
+    /** Clear all for testing */
+    clear(): void;
+}
+//# sourceMappingURL=module.d.ts.map

package/dist/module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../src/module.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,YAAY;IAC3B,gEAAgE;IAChE,EAAE,EAAE,MAAM,CAAC;IACX,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,QAAQ,CAAC,EACL,SAAS,GACT,MAAM,GACN,OAAO,GACP,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,YAAY,CAAC;IACjB,wDAAwD;IACxD,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,cAAc;IAC7B,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qBAAqB;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACvC,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,wEAAwE;IACxE,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,MAAM,MAAM,mBAAmB,CAAC,KAAK,GAAG,OAAO,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAE3E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,iBAAiB,CAAC,KAAK,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO;IACnE,uDAAuD;IACvD,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,6BAA6B;IAC7B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gCAAgC;IAChC,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjD,0BAA0B;IAC1B,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,qCAAqC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oBAAoB;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,yBAAyB;IACxC,+CAA+C;IAC/C,QAAQ,CAAC,MAAM,SAAS,iBAAiB,EACvC,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,mBAAmB,CAAC,MAAM,CAAC,GACrC,IAAI,CAAC;IAER,0CAA0C;IAC1C,GAAG,CAAC,MAAM,SAAS,iBAAiB,EAClC,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GACb,mBAAmB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAE3C,uCAAuC;IACvC,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IAEjD,+CAA+C;IAC/C,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAEvC,sCAAsC;IACtC,UAAU,IAAI,MAAM,EAAE,CAAC;IAEvB,0BAA0B;IAC1B,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAAC;IAE9D,+BAA+B;IAC/B,cAAc,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;IAE3C,6BAA6B;IAC7B,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IAExD,4BAA4B;IAC5B,KAAK,IAAI,IAAI,CAAC;CACf"}

package/dist/routes.d.ts

@@ -0,0 +1,107 @@
+/**
+ * Shared route contract types for SMRT packages.
+ *
+ * Packages can export route modules that describe their page surfaces without
+ * owning the consuming app's physical route tree. Apps stay responsible for
+ * URL shape, auth, tenancy, and layout composition while reusing package-owned
+ * page components and loader helpers.
+ */
+import type { ModuleComponentType } from './module.js';
+/**
+ * Route load function category.
+ *
+ * `page` maps naturally to SvelteKit's `+page.ts`, while `page-server` maps to
+ * `+page.server.ts`.
+ */
+export type SmrtRouteLoadKind = 'page' | 'page-server';
+/**
+ * Navigation metadata for a package route.
+ */
+export interface SmrtRouteNavigationMeta {
+    /** Label shown in app navigation. */
+    label: string;
+    /** Optional route description for menus or docs. */
+    description?: string;
+    /** Optional icon identifier. */
+    icon?: string;
+    /** Display order (lower first). */
+    order?: number;
+    /** Optional grouping key for larger menus. */
+    group?: string;
+}
+/**
+ * Resolved navigation entry for a mounted route.
+ */
+export interface SmrtRouteNavigationItem {
+    /** Stable route identifier. */
+    routeId: string;
+    /** Link href as mounted by the consuming app. */
+    href: string;
+    /** Label shown in the app navigation. */
+    label: string;
+    /** Optional description for menu UI. */
+    description?: string;
+    /** Optional icon identifier. */
+    icon?: string;
+    /** Display order (lower first). */
+    order?: number;
+    /** Optional grouping key for larger menus. */
+    group?: string;
+}
+/**
+ * Package-owned route definition.
+ *
+ * @typeParam TData - Data shape the route component expects.
+ * @typeParam TLoadInput - Input accepted by the optional `load` helper.
+ * @typeParam TProps - Component props shape. Defaults to `{ data?: TData }`.
+ */
+export interface SmrtRouteDefinition<TData = unknown, TLoadInput = unknown, TProps = {
+    data?: TData;
+}> {
+    /** Stable route identifier, namespaced by package. */
+    id: string;
+    /** Human-readable page title. */
+    title: string;
+    /** Optional description for docs and tooling. */
+    description?: string;
+    /** Canonical path the package recommends by default. */
+    defaultPath: string;
+    /** Page component exported by the package. */
+    component: ModuleComponentType<TProps>;
+    /** Optional reusable load helper for app-owned route files. */
+    load?: (input: TLoadInput) => Promise<TData> | TData;
+    /** Which SvelteKit route file the `load` helper belongs in. */
+    loadKind?: SmrtRouteLoadKind;
+    /** Optional navigation metadata. */
+    nav?: SmrtRouteNavigationMeta;
+    /** Optional tags for docs, hosts, or filtering. */
+    tags?: string[];
+}
+/**
+ * Package-owned route module.
+ *
+ * Consumers import one of these from `@happyvertical/smrt-<pkg>/routes`, then
+ * mount the exported components and loaders inside their own app route tree.
+ *
+ */
+export interface SmrtRouteModule {
+    /** Package name, usually `@happyvertical/smrt-<pkg>`. */
+    packageName: string;
+    /** Human-readable module name. */
+    displayName: string;
+    /** Optional module description. */
+    description?: string;
+    /**
+     * Route definitions keyed by package-local name.
+     *
+     * A heterogeneous registry: each entry is a `SmrtRouteDefinition` with its
+     * own `TData`/`TLoadInput`/`TProps`. `TLoadInput` sits in a contravariant
+     * position (`load?: (input: TLoadInput) => …`), so a concrete route
+     * (`SmrtRouteDefinition<Foo, Bar>`) is NOT assignable to
+     * `SmrtRouteDefinition<unknown, unknown, unknown>` — narrowing the params to
+     * `unknown` would reject every real route registration. Like
+     * {@link ModuleComponentType}, this is an irreducible registry `any`.
+     */
+    routes: Record<string, SmrtRouteDefinition<any, any, any>>;
+}
+//# sourceMappingURL=routes.d.ts.map

package/dist/routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,aAAa,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB,CAClC,KAAK,GAAG,OAAO,EACf,UAAU,GAAG,OAAO,EACpB,MAAM,GAAG;IAAE,IAAI,CAAC,EAAE,KAAK,CAAA;CAAE;IAEzB,sDAAsD;IACtD,EAAE,EAAE,MAAM,CAAC;IACX,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,WAAW,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,SAAS,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACvC,+DAA+D;IAC/D,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;IACrD,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,oCAAoC;IACpC,GAAG,CAAC,EAAE,uBAAuB,CAAC;IAC9B,mDAAmD;IACnD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,yDAAyD;IACzD,WAAW,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;;OAUG;IAEH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;CAC5D"}