@rizom/site-rizom-ai 0.2.0-alpha.238 → 0.2.0-alpha.243

package/dist/index.d.ts

@@ -0,0 +1,454 @@
+import { JSX, ReactNode } from "react";
+import { z } from "zod/v4";
+//#region ../../packages/site/src/index.d.ts
+/** Permission levels for editable site content templates. */
+type UserPermissionLevel = "admin" | "trusted" | "public";
+type JsonPrimitive = null | boolean | number | string;
+type JsonValue = JsonPrimitive | JsonValue[] | JsonObject;
+/** A JSON document with an object at its root. */
+interface JsonObject {
+  [key: string]: JsonValue;
+}
+/** Runtime script declaration attached to a content section/template. */
+interface RuntimeScript {
+  src: string;
+  defer?: boolean;
+  module?: boolean;
+}
+/** Bivariant component type for author-supplied layout components. */
+type ComponentType<P = unknown> = {
+  bivarianceHack(props: P): JSX.Element;
+}["bivarianceHack"];
+/** Navigation slot types exposed to authored routes and generated entity routes. */
+type NavigationSlot = "primary" | "secondary";
+/** Display and behavior metadata for an entity type. */
+interface EntityDisplayEntry {
+  label: string;
+  pluralName?: string | undefined;
+  /** Layout name for this entity type's generated routes (defaults to "default"). */
+  layout?: string | undefined;
+  /** Enable pagination for list pages. */
+  paginate?: boolean | undefined;
+  /** Items per page (default: 10). */
+  pageSize?: number | undefined;
+  navigation?: {
+    show?: boolean | undefined;
+    slot?: NavigationSlot | undefined;
+    priority?: number | undefined;
+  } | undefined;
+}
+interface SectionDefinitionInput {
+  id: string;
+  template: string;
+  content?: unknown;
+  dataQuery?: {
+    entityType?: string | undefined;
+    template?: string | undefined;
+    query?: Record<string, unknown> | undefined;
+    [key: string]: unknown;
+  } | undefined;
+  order?: number | undefined;
+}
+interface NavigationMetadataInput {
+  show?: boolean | undefined;
+  label?: string | undefined;
+  slot?: NavigationSlot | undefined;
+  priority?: number | undefined;
+}
+interface RouteDefinitionInput {
+  id: string;
+  path: string;
+  title?: string | undefined;
+  /** Bare display label without any page suffix. */
+  pageLabel?: string | undefined;
+  description?: string | undefined;
+  sections?: SectionDefinitionInput[] | undefined;
+  layout?: string | undefined;
+  fullscreen?: boolean | undefined;
+  pluginId?: string | undefined;
+  sourceEntityType?: string | undefined;
+  external?: boolean | undefined;
+  navigation?: NavigationMetadataInput | undefined;
+}
+interface SiteContentStringFieldDefinition {
+  type: "string";
+  label: string;
+  optional?: boolean;
+}
+interface SiteContentNumberFieldDefinition {
+  type: "number";
+  label: string;
+  optional?: boolean;
+}
+interface SiteContentEnumFieldDefinition {
+  type: "enum";
+  label: string;
+  options: [string, ...string[]] | readonly [string, ...string[]];
+  optional?: boolean;
+}
+interface SiteContentObjectFieldDefinition {
+  type: "object";
+  label: string;
+  fields: Record<string, SiteContentFieldDefinition>;
+  optional?: boolean;
+}
+interface SiteContentArrayFieldDefinition {
+  type: "array";
+  label: string;
+  items: SiteContentStringFieldDefinition | SiteContentNumberFieldDefinition | SiteContentEnumFieldDefinition | SiteContentObjectFieldDefinition;
+  minItems?: number;
+  length?: number;
+  optional?: boolean;
+}
+type SiteContentFieldDefinition = SiteContentStringFieldDefinition | SiteContentNumberFieldDefinition | SiteContentEnumFieldDefinition | SiteContentObjectFieldDefinition | SiteContentArrayFieldDefinition;
+interface SiteContentSectionDefinition {
+  description: string;
+  title: string;
+  layout: ComponentType<unknown>;
+  fields: Record<string, SiteContentFieldDefinition>;
+  requiredPermission?: UserPermissionLevel;
+  fullscreen?: boolean;
+  runtimeScripts?: RuntimeScript[];
+}
+interface SiteContentDefinition {
+  namespace: string;
+  sections: Record<string, SiteContentSectionDefinition>;
+}
+/** Author-facing metadata for a schema-first content section. */
+interface SectionMeta {
+  title: string;
+  description: string;
+  requiredPermission?: UserPermissionLevel | undefined;
+  fullscreen?: boolean | undefined;
+}
+/**
+ * A schema-first content section. Its component props are inferred from the
+ * same schema used by runtime validation, markdown formatting, and editing.
+ */
+interface SiteSectionDefinition<S extends z.ZodType = z.ZodType> extends SectionMeta {
+  schema: S;
+  component: ComponentType<z.output<S>>;
+}
+interface SiteSectionGroup {
+  namespace: string;
+  sections: Record<string, SiteSectionDefinition>;
+}
+interface SiteMetadataCTA {
+  heading: string;
+  buttonText: string;
+  buttonLink: string;
+}
+interface SiteMetadataSection {
+  blurb?: string | undefined;
+}
+interface SiteMetadata {
+  represents?: "brain" | "anchor" | undefined;
+  title: string;
+  description: string;
+  url?: string | undefined;
+  copyright?: string | undefined;
+  logo?: boolean | undefined;
+  themeMode?: "light" | "dark" | undefined;
+  analyticsScript?: string | undefined;
+  cta?: SiteMetadataCTA | undefined;
+  sections?: Record<string, SiteMetadataSection> | undefined;
+}
+interface NavigationItem {
+  label: string;
+  href: string;
+  priority: number;
+}
+interface SiteLayoutInfo extends SiteMetadata {
+  copyright: string;
+  navigation: {
+    primary: NavigationItem[];
+    secondary: NavigationItem[];
+  };
+  socialLinks?: Array<{
+    platform: "github" | "instagram" | "linkedin" | "email" | "website";
+    url: string;
+    label?: string | undefined;
+  }> | undefined;
+}
+/** Props supplied by the site builder to every authored layout. */
+interface SiteLayoutProps {
+  sections: ReactNode[];
+  title: string;
+  description: string;
+  path: string;
+  siteInfo: SiteLayoutInfo;
+}
+/** Initial section content keyed by section-group namespace and section id. */
+interface SiteContent {
+  [namespace: string]: Record<string, JsonObject>;
+}
+/** Declarative site-package shape authored by public site packages. */
+interface SiteDefinition {
+  /** Layout components keyed by name — a `default` layout is required. */
+  layouts: Record<string, ComponentType<SiteLayoutProps>>;
+  /** Hand-written route definitions (home, about, etc.). */
+  routes: RouteDefinitionInput[];
+  /** Optional initial content validated by the corresponding section schema. */
+  content?: SiteContent | undefined;
+  /** Optional schema-first section groups. */
+  sections?: SiteSectionGroup | SiteSectionGroup[] | undefined;
+  /** Optional additive CSS owned by the site package. */
+  themeOverride?: string | undefined;
+  /** Global head scripts to inject into every rendered page. */
+  headScripts?: string[] | undefined;
+  /** Display metadata per entity type. */
+  entityDisplay: Record<string, EntityDisplayEntry>;
+  /** Static assets to write into the site output directory at build time. */
+  staticAssets?: Record<string, string> | undefined;
+}
+type SiteDefinitionOverrides = Partial<SiteDefinition>;
+//#endregion
+//#region src/rizom/contracts.d.ts
+interface RizomLink {
+  href: string;
+  label: string;
+  /** Open in a new tab with rel="noopener noreferrer". */
+  external?: boolean;
+}
+type RizomBrandSuffix = "ai" | "foundation" | "work";
+interface RizomSideNavItem {
+  href: string;
+  label: string;
+}
+interface RizomFooterTagline {
+  prefix?: string;
+  link: RizomLink;
+  suffix?: string;
+}
+type RizomLayoutProps = SiteLayoutProps;
+interface RizomPluginCapabilities {
+  tools: [];
+  resources: [];
+}
+interface RizomMessageBus {
+  subscribe(channel: string, handler: () => Promise<{
+    success: boolean;
+  }>): unknown;
+  send(message: {
+    type: string;
+    sender: string;
+    payload: Record<string, unknown>;
+  }): Promise<unknown>;
+}
+interface RizomLogger {
+  info(message: string): void;
+}
+interface DataSourceRegistry {
+  register(dataSource: unknown): void;
+}
+interface RizomSiteShell {
+  getMessageBus(): RizomMessageBus;
+  getLogger(): RizomLogger;
+  registerTemplates(templates: Record<string, unknown>, namespace?: string): void;
+  getDataSourceRegistry(): DataSourceRegistry;
+}
+interface SiteCompositionPlugin {
+  readonly id: string;
+  readonly version: string;
+  readonly type: "core" | "entity" | "service" | "interface";
+  readonly packageName: string;
+  readonly description?: string | undefined;
+  readonly dependencies?: string[] | undefined;
+  register?(shell: RizomSiteShell, context?: unknown): Promise<RizomPluginCapabilities>;
+  ready?(): Promise<void>;
+  shutdown?(): Promise<void>;
+  requiresDaemonStartup?(): boolean;
+}
+interface SitePackage<TPluginConfig = Record<string, unknown>, TPlugin extends SiteCompositionPlugin = SiteCompositionPlugin> {
+  layouts: Record<string, unknown>;
+  routes: RouteDefinitionInput[];
+  plugin?: ((config?: TPluginConfig) => TPlugin) | undefined;
+  content?: SiteContent | undefined;
+  sections?: SiteSectionGroup | SiteSectionGroup[] | undefined;
+  themeOverride?: string | undefined;
+  headScripts?: string[] | undefined;
+  entityDisplay: Record<string, EntityDisplayEntry>;
+  staticAssets?: Record<string, string> | undefined;
+}
+//#endregion
+//#region src/rizom/ui/frame.d.ts
+interface RizomFrameProps {
+  children?: ReactNode;
+}
+/**
+ * Shared Rizom page frame.
+ *
+ * Owns only the centered page container. Wrapper sites own their actual
+ * chrome/layout composition.
+ */
+declare const RizomFrame: ({ children }: RizomFrameProps) => JSX.Element;
+//#endregion
+//#region src/rizom/ui/Header.d.ts
+interface HeaderProps {
+  brandSuffix: RizomBrandSuffix;
+  navLinks: RizomLink[];
+  primaryCta: RizomLink;
+}
+declare const Header: ({ brandSuffix, navLinks, primaryCta }: HeaderProps) => JSX.Element;
+//#endregion
+//#region src/rizom/ui/Footer.d.ts
+interface FooterProps {
+  brandSuffix: RizomBrandSuffix;
+  metaLabel: string;
+  tagline?: RizomFooterTagline;
+  links: RizomLink[];
+  className?: string;
+}
+declare const Footer: ({ brandSuffix, metaLabel, tagline, links, className }: FooterProps) => JSX.Element;
+//#endregion
+//#region src/rizom/ui/SideNav.d.ts
+interface SideNavProps {
+  items: RizomSideNavItem[];
+}
+declare const SideNav: ({ items }: SideNavProps) => JSX.Element;
+//#endregion
+//#region src/rizom/ui/Section.d.ts
+interface SectionProps {
+  id?: string;
+  className?: string;
+  children?: ReactNode;
+}
+declare const GUTTER = "px-6 md:px-10 xl:px-20";
+declare const Section: ({ id, className, children }: SectionProps) => JSX.Element;
+//#endregion
+//#region src/rizom/ui/Button.d.ts
+type ButtonVariant = "primary" | "primary-strong" | "secondary";
+type ButtonSize = "md" | "lg";
+interface ButtonProps {
+  href: string;
+  variant?: ButtonVariant;
+  size?: ButtonSize;
+  block?: boolean;
+  className?: string;
+  children?: ReactNode;
+}
+declare const Button: ({ href, variant, size, block, className, children }: ButtonProps) => JSX.Element;
+//#endregion
+//#region src/rizom/ui/Badge.d.ts
+interface BadgeProps {
+  children?: ReactNode;
+  className?: string;
+}
+declare const Badge: ({ children, className }: BadgeProps) => JSX.Element;
+//#endregion
+//#region src/rizom/ui/Divider.d.ts
+interface DividerProps {
+  className?: string;
+}
+declare const Divider: ({ className }: DividerProps) => JSX.Element;
+//#endregion
+//#region src/rizom/ui/highlighted-text.d.ts
+/**
+ * Render a content string with two lightweight markup conventions:
+ *
+ * - `\n` in the string produces a `<br />` (for multi-line headlines)
+ * - Any `*...*` run is wrapped in a `<span>` carrying `highlightClass`
+ *
+ * Authors write the phrase as one natural string in markdown content;
+ * the renderer does the structural split. Highlight styling is passed
+ * per-brand (rizom.ai uses accent+midline, rizom.work uses
+ * italic+accent) so each brand owns its own emphasis treatment while
+ * the parsing/structure is shared.
+ */
+declare function renderHighlightedText(text: string, highlightClass: string): JSX.Element;
+//#endregion
+//#region src/rizom/ui/site-info-links.d.ts
+declare function socialLinksToRizomLinks(siteInfo: Pick<SiteLayoutInfo, "socialLinks">, allowedPlatforms?: string[]): RizomLink[];
+//#endregion
+//#region src/rizom/ui/Wordmark.d.ts
+interface WordmarkProps {
+  /** Brand name before the dot. Defaults to `"rizom"`. */
+  name?: string;
+  /** Suffix after the dot. Any string (e.g. `"ai"`, `"io"`, `"foundation"`). */
+  brandSuffix: RizomBrandSuffix | string;
+  className?: string;
+  dotClassName?: string;
+  suffixClassName?: string;
+}
+declare const Wordmark: ({ name, brandSuffix, className, dotClassName, suffixClassName }: WordmarkProps) => JSX.Element;
+//#endregion
+//#region src/rizom/ui/Ecosystem.d.ts
+interface EcosystemCard {
+  suffix: RizomBrandSuffix;
+  title: string;
+  body: string;
+  linkLabel: string;
+  linkHref: string;
+}
+interface EcosystemContent {
+  eyebrow: string;
+  headline: string;
+  cards: EcosystemCard[];
+}
+declare const Ecosystem: ({ eyebrow, headline, cards }: EcosystemContent) => JSX.Element;
+//#endregion
+//#region src/rizom/runtime/default-layout.d.ts
+declare const DefaultRizomLayout: ({ sections }: RizomLayoutProps) => JSX.Element;
+//#endregion
+//#region src/rizom/runtime/base-site.d.ts
+declare const rizomBaseSite: SiteDefinition;
+//#endregion
+//#region src/rizom/create-site.d.ts
+interface RizomRuntimeHooks {
+  contentNamespace: string;
+  templates?: Record<string, unknown>;
+  dataSources?: unknown[];
+}
+interface CreateRizomSiteOptions {
+  packageName: string;
+  layout: unknown;
+  routes: RouteDefinitionInput[];
+  content?: SiteContent;
+  /**
+   * Schema-first section groups (authored via `@rizom/site`'
+   * `defineSection`/`sectionGroup`). Registered as content templates at brain
+   * boot exactly like `content`, so the Studio + directory-sync + resolver treat
+   * them identically — but the section shape is derived from one zod schema.
+   */
+  sections?: SiteSectionGroup | SiteSectionGroup[];
+  themeOverride?: string;
+  /**
+   * Presentation config for entity-backed list/detail routes (labels, plural
+   * names, navigation). Merged onto the base site's empty map. Sites that
+   * surface plugin lists — e.g. `post`→"Essay", `deck`→"Talk" — set it here.
+   */
+  entityDisplay?: Record<string, EntityDisplayEntry>;
+  /** Advanced runtime hooks for in-repo sites that need custom template/data-source wiring. */
+  runtime?: RizomRuntimeHooks;
+}
+declare function createRizomSite(options: CreateRizomSiteOptions): SitePackage;
+//#endregion
+//#region src/site.d.ts
+declare const rizomAiSite: SitePackage;
+//#endregion
+//#region src/routes.d.ts
+/**
+ * The consolidated Rizom site routes. The home page composes the rev-5 section
+ * set from the "home" content namespace; the layout owns navigation (the
+ * two-tier faces strip), so routes stay out of the entity nav.
+ */
+declare const aiRoutes: RouteDefinitionInput[];
+//#endregion
+//#region src/home.d.ts
+/**
+ * The umbrella home page's authored sections. The namespace ("home") matches
+ * the route id, so each stores as site-content/home/<section>.md and resolves
+ * as "home:<section>". Two sections live elsewhere: the hero is the live
+ * agent proximity map (agent-discovery:proximity-map) and the proof/ask is
+ * the knowledge map (topics:knowledge-map) — both authored via overlay
+ * markdown merged over their live datasource payloads.
+ */
+declare const homeSections: SiteSectionGroup;
+//#endregion
+//#region src/work.d.ts
+declare const workSections: SiteSectionGroup;
+//#endregion
+//#region src/foundation.d.ts
+declare const foundationSections: SiteSectionGroup;
+//#endregion
+export { Badge, type BadgeProps, Button, type ButtonProps, type ButtonSize, type ButtonVariant, type CreateRizomSiteOptions, DefaultRizomLayout, Divider, type DividerProps, Ecosystem, type EcosystemCard, type EcosystemContent, type EntityDisplayEntry, Footer, GUTTER, Header, type RizomBrandSuffix, type RizomFooterTagline, RizomFrame, type RizomFrameProps, type RizomLayoutProps, type RizomLink, type RizomSideNavItem, type RouteDefinitionInput, Section, type SectionDefinitionInput, type SectionProps, SideNav, type SiteContentArrayFieldDefinition, type SiteContentDefinition, type SiteContentEnumFieldDefinition, type SiteContentFieldDefinition, type SiteContentNumberFieldDefinition, type SiteContentObjectFieldDefinition, type SiteContentSectionDefinition, type SiteContentStringFieldDefinition, type SiteDefinition, type SiteDefinitionOverrides, type SiteLayoutInfo, type SitePackage, Wordmark, type WordmarkProps, aiRoutes, createRizomSite, rizomAiSite as default, rizomAiSite, foundationSections, homeSections, renderHighlightedText, rizomBaseSite, socialLinksToRizomLinks, workSections };