@rizom/site-rizom 0.2.0-alpha.150 → 0.2.0-alpha.151

package/dist/index.d.ts

@@ -1,9 +1,193 @@
-import { ComponentChildren, JSX } from 'preact';
-import { RizomBrandSuffix as RizomBrandSuffix$1, RizomLink, RizomFooterTagline, RizomSideNavItem, SiteLayoutInfo, RizomLayoutProps, SiteDefinition, RouteDefinitionInput, SiteContentDefinition } from '@rizom/site';
-export { EntityDisplayEntry, RizomBrandSuffix, RizomFooterTagline, RizomLayoutProps, RizomLink, RizomSideNavItem, RouteDefinitionInput, SectionDefinitionInput, SiteContentArrayFieldDefinition, SiteContentDefinition, SiteContentEnumFieldDefinition, SiteContentFieldDefinition, SiteContentNumberFieldDefinition, SiteContentObjectFieldDefinition, SiteContentSectionDefinition, SiteContentStringFieldDefinition, SiteDefinition, SiteDefinitionOverrides, SiteLayoutInfo } from '@rizom/site';
-
+import { ComponentChildren, JSX } from "preact";
+//#region ../../packages/site/src/index.d.ts
+/** Permission levels for editable site content templates. */
+type UserPermissionLevel = "anchor" | "trusted" | "public";
+/** 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>;
+}
+interface SiteMetadataCTA {
+  heading: string;
+  buttonText: string;
+  buttonLink: string;
+}
+interface SiteMetadataSection {
+  blurb?: string | undefined;
+}
+interface SiteMetadata {
+  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;
+}
+/** Declarative site-package shape authored by public site packages. */
+interface SiteDefinition {
+  /** Layout components keyed by name — at minimum "default" is required. */
+  layouts: Record<string, unknown>;
+  /** Hand-written route definitions (home, about, etc.). */
+  routes: RouteDefinitionInput[];
+  /** Optional content definitions owned by this package. */
+  content?: SiteContentDefinition | SiteContentDefinition[];
+  /** Optional additive CSS owned by the site package. */
+  themeOverride?: string;
+  /** Global head scripts to inject into every rendered page. */
+  headScripts?: string[];
+  /** 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>;
+}
+type SiteDefinitionOverrides = Partial<SiteDefinition>;
+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;
+}
+interface RizomLayoutProps {
+  sections: ComponentChildren[];
+  title: string;
+  description: string;
+  path: string;
+  siteInfo: SiteLayoutInfo;
+}
+//#endregion
+//#region src/ui/frame.d.ts
 interface RizomFrameProps {
-    children?: ComponentChildren;
+  children?: ComponentChildren;
 }
 /**
  * Shared Rizom page frame.
@@ -12,59 +196,67 @@ interface RizomFrameProps {
  * container. Wrapper sites own their actual chrome/layout composition.
  */
 declare const RizomFrame: ({ children }: RizomFrameProps) => JSX.Element;
-
+//#endregion
+//#region src/ui/Header.d.ts
 interface HeaderProps {
-    brandSuffix: RizomBrandSuffix$1;
-    navLinks: RizomLink[];
-    primaryCta: RizomLink;
+  brandSuffix: RizomBrandSuffix;
+  navLinks: RizomLink[];
+  primaryCta: RizomLink;
 }
-declare const Header: ({ brandSuffix, navLinks, primaryCta, }: HeaderProps) => JSX.Element;
-
+declare const Header: ({ brandSuffix, navLinks, primaryCta }: HeaderProps) => JSX.Element;
+//#endregion
+//#region src/ui/Footer.d.ts
 interface FooterProps {
-    brandSuffix: RizomBrandSuffix$1;
-    metaLabel: string;
-    tagline?: RizomFooterTagline;
-    links: RizomLink[];
-    className?: string;
-}
-declare const Footer: ({ brandSuffix, metaLabel, tagline, links, className, }: FooterProps) => JSX.Element;
-
+  brandSuffix: RizomBrandSuffix;
+  metaLabel: string;
+  tagline?: RizomFooterTagline;
+  links: RizomLink[];
+  className?: string;
+}
+declare const Footer: ({ brandSuffix, metaLabel, tagline, links, className }: FooterProps) => JSX.Element;
+//#endregion
+//#region src/ui/SideNav.d.ts
 interface SideNavProps {
-    items: RizomSideNavItem[];
+  items: RizomSideNavItem[];
 }
 declare const SideNav: ({ items }: SideNavProps) => JSX.Element;
-
+//#endregion
+//#region src/ui/Section.d.ts
 interface SectionProps {
-    id?: string;
-    className?: string;
-    children?: ComponentChildren;
+  id?: string;
+  className?: string;
+  children?: ComponentChildren;
 }
 declare const GUTTER = "px-6 md:px-10 xl:px-20";
-declare const Section: ({ id, className, children, }: SectionProps) => JSX.Element;
-
+declare const Section: ({ id, className, children }: SectionProps) => JSX.Element;
+//#endregion
+//#region src/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?: ComponentChildren;
-}
-declare const Button: ({ href, variant, size, block, className, children, }: ButtonProps) => JSX.Element;
-
+  href: string;
+  variant?: ButtonVariant;
+  size?: ButtonSize;
+  block?: boolean;
+  className?: string;
+  children?: ComponentChildren;
+}
+declare const Button: ({ href, variant, size, block, className, children }: ButtonProps) => JSX.Element;
+//#endregion
+//#region src/ui/Badge.d.ts
 interface BadgeProps {
-    children?: ComponentChildren;
-    className?: string;
+  children?: ComponentChildren;
+  className?: string;
 }
 declare const Badge: ({ children, className }: BadgeProps) => JSX.Element;
-
+//#endregion
+//#region src/ui/Divider.d.ts
 interface DividerProps {
-    className?: string;
+  className?: string;
 }
 declare const Divider: ({ className }: DividerProps) => JSX.Element;
-
+//#endregion
+//#region src/ui/highlighted-text.d.ts
 /**
  * Render a content string with two lightweight markup conventions:
  *
@@ -78,58 +270,65 @@ declare const Divider: ({ className }: DividerProps) => JSX.Element;
  * the parsing/structure is shared.
  */
 declare function renderHighlightedText(text: string, highlightClass: string): JSX.Element;
-
+//#endregion
+//#region src/ui/site-info-links.d.ts
 declare function socialLinksToRizomLinks(siteInfo: Pick<SiteLayoutInfo, "socialLinks">, allowedPlatforms?: string[]): RizomLink[];
-
-declare const DefaultRizomLayout: ({ sections, }: RizomLayoutProps) => JSX.Element;
-
+//#endregion
+//#region src/runtime/default-layout.d.ts
+declare const DefaultRizomLayout: ({ sections }: RizomLayoutProps) => JSX.Element;
+//#endregion
+//#region src/runtime/base-site.d.ts
 declare const rizomBaseSite: SiteDefinition;
-
+//#endregion
+//#region src/contracts.d.ts
 type RizomThemeProfile = "product" | "editorial" | "studio";
-
+//#endregion
+//#region src/create-site.d.ts
 interface RizomRuntimeHooks {
-    contentNamespace: string;
-    templates?: Record<string, unknown>;
-    dataSources?: unknown[];
+  contentNamespace: string;
+  templates?: Record<string, unknown>;
+  dataSources?: unknown[];
 }
 interface CreateRizomSiteOptions {
-    packageName: string;
-    themeProfile: RizomThemeProfile;
-    layout: unknown;
-    routes: RouteDefinitionInput[];
-    content?: SiteContentDefinition | SiteContentDefinition[];
-    themeOverride?: string;
-    /** Advanced runtime hooks for in-repo sites that need custom template/data-source wiring. */
-    runtime?: RizomRuntimeHooks;
+  packageName: string;
+  themeProfile: RizomThemeProfile;
+  layout: unknown;
+  routes: RouteDefinitionInput[];
+  content?: SiteContentDefinition | SiteContentDefinition[];
+  themeOverride?: string;
+  /** Advanced runtime hooks for in-repo sites that need custom template/data-source wiring. */
+  runtime?: RizomRuntimeHooks;
 }
 declare function createRizomSite(options: CreateRizomSiteOptions): SiteDefinition;
-
-type RizomBrandSuffix = "ai" | "foundation" | "work";
-
+//#endregion
+//#region ../../shared/rizom-ui/src/types.d.ts
+type RizomBrandSuffix$1 = "ai" | "foundation" | "work";
+//#endregion
+//#region ../../shared/rizom-ui/src/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;
-
+  /** Brand name before the dot. Defaults to `"rizom"`. */
+  name?: string;
+  /** Suffix after the dot. Any string (e.g. `"ai"`, `"io"`, `"foundation"`). */
+  brandSuffix: RizomBrandSuffix$1 | string;
+  className?: string;
+  dotClassName?: string;
+  suffixClassName?: string;
+}
+declare const Wordmark: ({ name, brandSuffix, className, dotClassName, suffixClassName }: WordmarkProps) => JSX.Element;
+//#endregion
+//#region ../../shared/rizom-ui/src/Ecosystem.d.ts
 interface EcosystemCard {
-    suffix: RizomBrandSuffix;
-    title: string;
-    body: string;
-    linkLabel: string;
-    linkHref: string;
+  suffix: RizomBrandSuffix$1;
+  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;
-
-export { Badge, Button, DefaultRizomLayout, Divider, Ecosystem, Footer, GUTTER, Header, RizomFrame, Section, SideNav, Wordmark, createRizomSite, rizomBaseSite as default, renderHighlightedText, rizomBaseSite, socialLinksToRizomLinks };
-export type { BadgeProps, ButtonProps, ButtonSize, ButtonVariant, CreateRizomSiteOptions, DividerProps, EcosystemCard, EcosystemContent, RizomFrameProps, RizomThemeProfile, SectionProps, WordmarkProps };
+  eyebrow: string;
+  headline: string;
+  cards: EcosystemCard[];
+}
+declare const Ecosystem: ({ eyebrow, headline, cards }: EcosystemContent) => JSX.Element;
+//#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 RizomThemeProfile, 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, Wordmark, type WordmarkProps, createRizomSite, rizomBaseSite as default, rizomBaseSite, renderHighlightedText, socialLinksToRizomLinks };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rizom/site-rizom",
-  "version": "0.2.0-alpha.150",
+  "version": "0.2.0-alpha.151",
   "description": "Shared Rizom site core — structural base for rizom.ai, rizom.foundation, and rizom.work",
   "type": "module",
   "exports": {
@@ -26,7 +26,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@rizom/site": "0.2.0-alpha.150",
+    "@rizom/site": "0.2.0-alpha.151",
     "clsx": "^2.1.0",
     "preact": "^10.27.2",
     "tailwind-merge": "^3.6.0"