@tekki-forge/core 0.1.0 → 0.3.0

package/dist/app.d.ts

@@ -1,6 +1,8 @@
 import type { AnyField } from "./fields.js";
-import type { DashboardWidget } from "./dashboard.js";
+import type { DashboardConfig } from "./dashboard.js";
+import type { EntityIcon } from "./icons.js";
 import type { PluginDefinition } from "./plugin.js";
+import type { SiteConfig } from "./site.js";
 /**
  * A permission rule lists who may perform an operation. Tokens:
  *  - a role name, e.g. "admin", "manager", "member"
@@ -113,8 +115,8 @@ export interface EntityDefinition {
     storageName?: string;
     /** Field used as the human-readable label of a record. */
     display?: string;
-    /** lucide icon name used in navigation. */
-    icon?: string;
+    /** Icon in navigation: one of ENTITY_ICONS, e.g. "receipt", "users", "truck", "ticket", "building". */
+    icon?: EntityIcon;
     /** Show in the sidebar. Default true. */
     nav?: boolean;
     description?: string;
@@ -142,14 +144,15 @@ export interface MultiTenantConfig {
     enabled: boolean;
     model?: "organization";
 }
-export type UIStyle = "simple" | "shadow" | "neumorphism" | "glassmorphism" | "skeuomorphism" | "material" | "brutalist" | "editorial" | "aurora" | "terminal" | "clay";
+export type UIStyle = "simple" | "shadow" | "neumorphism" | "glassmorphism" | "skeuomorphism" | "material" | "brutalist" | "editorial" | "aurora" | "terminal" | "clay" | "corporate" | "soft" | "luxury" | "retro" | "neon" | "swiss" | "nature" | "cyber" | "minimal" | "playful";
 /** Curated looks (style + colours + font + corners + mode + layout). Explicit theme keys override them. */
-export type ThemePreset = "midnight" | "sandstone" | "ocean" | "forest" | "sunset" | "graphite" | "candy" | "paper" | "phosphor";
+export type ThemePreset = "midnight" | "sandstone" | "ocean" | "forest" | "sunset" | "graphite" | "candy" | "paper" | "phosphor" | "boardroom" | "sakura" | "noir" | "arcade" | "ember" | "atelier" | "matcha" | "circuit" | "lagoon" | "orchid" | "harbor" | "blueprint";
 /** Typeface pairing (headings + body), loaded from Google Fonts at runtime; "system" loads nothing. */
-export type ThemeFont = "inter" | "geist" | "plex" | "grotesk" | "serif" | "rounded" | "mono" | "system";
+export type ThemeFont = "inter" | "geist" | "plex" | "grotesk" | "serif" | "rounded" | "mono" | "system" | "elegant" | "pixel" | "tech" | "playful";
 export interface ThemeConfig {
     /**
-     * Start from a curated look: midnight, sandstone, ocean, forest, sunset, graphite, candy, paper, phosphor.
+     * Start from a curated look: midnight, sandstone, ocean, forest, sunset, graphite, candy, paper, phosphor,
+     * boardroom, sakura, noir, arcade, ember, atelier, matcha, circuit, lagoon, orchid, harbor, blueprint.
      * Any other key set here overrides the preset's value.
      */
     preset?: ThemePreset;
@@ -166,6 +169,16 @@ export interface ThemeConfig {
      *  - aurora         soft animated gradient backdrop from your colours, glassy cards
      *  - terminal       dark-first, monospace, phosphor accents
      *  - clay           claymorphism: puffy rounded surfaces with inner highlights
+     *  - corporate      sober and dense, enterprise blue-grey, crisp tables
+     *  - soft           pastel, rounded and airy, gentle shadows
+     *  - luxury         deep tones, gold accents, serif display, thin rules (dark by default)
+     *  - retro          80s/90s desktop: bevelled windows, pixel headings, readable body
+     *  - neon           dark, glowing accents and crisp borders (glow off for reduced motion / forced colours)
+     *  - swiss          strict grid, big type, red accent, no shadows
+     *  - nature         earthy tones, organic shapes, paper texture
+     *  - cyber          angled corners, HUD accents, dark-first
+     *  - minimal        almost no chrome: whitespace and hairlines
+     *  - playful        bold colours, hand-drawn edges, bouncy hover
      */
     style?: UIStyle;
     colors?: {
@@ -181,7 +194,8 @@ export interface ThemeConfig {
     radius?: "none" | "small" | "medium" | "large" | "full";
     /**
      * Typeface pairing: inter, geist, plex (IBM Plex), grotesk (Space Grotesk headings), serif (Fraunces headings),
-     * rounded (Nunito), mono (JetBrains Mono), system (no web font). Default: the style's own, else system.
+     * rounded (Nunito), mono (JetBrains Mono), elegant (Cormorant Garamond headings), pixel (Silkscreen headings),
+     * tech (Chakra Petch headings), playful (Fredoka + Nunito), system (no web font). Default: the style's own, else system.
      */
     font?: ThemeFont;
     /** Navigation: a sidebar (default), a top bar, or a compact icon rail (tooltips on hover/focus, expandable with its toggle). */
@@ -192,6 +206,20 @@ export interface ThemeConfig {
     logo?: string;
     /** Short line shown on the sign-in pages' brand panel. */
     tagline?: string;
+    /** Page background made from the theme colours (CSS only, static under reduced motion). Default: plain (the style's own). */
+    background?: "plain" | "gradient" | "mesh" | "dots" | "grid" | "noise";
+    /** Card treatment. Default: the style's own. */
+    cards?: "flat" | "bordered" | "elevated" | "glass";
+    /** Button shape and fill. Default: the style's own. */
+    buttons?: "solid" | "soft" | "outline" | "pill";
+    /** Page and card transitions: none, subtle (default) or lively. Always none under prefers-reduced-motion. */
+    motion?: "none" | "subtle" | "lively";
+    /** Sidebar surface: light (the regular surface), dark, or brand (the primary colour). Default: the style's own. */
+    sidebar?: "light" | "dark" | "brand";
+    /** Navigation icons: outline (default) or duotone (tinted fill). */
+    iconStyle?: "outline" | "duotone";
+    /** Colours of charts, exposed as --forge-chart-1 … --forge-chart-8: theme (default), vivid, pastel or mono. */
+    chartPalette?: "theme" | "vivid" | "pastel" | "mono";
 }
 export interface NotificationRule {
     /**
@@ -235,16 +263,12 @@ export interface AppDefinition {
     };
     /** Client SDKs to generate. Default: TypeScript only (packages/sdk). */
     sdk?: SdkConfig;
-    admin?: {
-        enabled?: boolean;
-    };
+    admin?: AdminConfig;
     theme?: ThemeConfig;
     /** Plugins such as storage(), jobs(), webhooks(), payments(). */
     plugins?: readonly PluginDefinition[];
-    /** Widgets on the home page (metric, chart, list). Default: a count per entity. */
-    dashboard?: {
-        widgets: readonly DashboardWidget[];
-    };
+    /** Widgets on the home page (metric, chart, list), optionally in tabs. Default: a count per entity. */
+    dashboard?: DashboardConfig;
     /** In-app (and optional email) notifications triggered by record events. */
     notifications?: readonly NotificationRule[];
     /**
@@ -260,6 +284,26 @@ export interface AppDefinition {
      * `true` builds one from the app's name, description, tagline and entities; an object overrides any part.
      */
     landing?: boolean | LandingConfig;
+    /**
+     * Feature flags with their default value, e.g. `{ newEditor: false }`. Global admins switch them at
+     * runtime in Administration → System settings; read them with `useFeatureFlag("newEditor")` in the UI
+     * and `ctx.use<FeatureFlags>("featureFlags")?.enabled("newEditor")` in extensions.
+     */
+    featureFlags?: Record<string, boolean>;
+    /**
+     * A public website: pages made of sections (hero, features, pricing, FAQ, blog…), a header menu and a footer.
+     * Seeded into the database and editable in the admin (Content); signed-out visitors of `/` see the home page.
+     */
+    site?: SiteConfig;
+}
+export interface AdminConfig {
+    /** The administration area (/admin) and its API. Default: true. */
+    enabled?: boolean;
+    /**
+     * Built-in support inbox: a "Help & support" form in the app (tickets with a message thread) answered
+     * by global admins in Administration → Support. Default: true.
+     */
+    support?: boolean;
 }
 export interface LandingFeature {
     title: string;

package/dist/app.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AA2DA,MAAM,UAAU,MAAM,CAAC,aAAgD,EAAE;IACvE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,UAAU,EAAE,CAAC;AAC9C,CAAC;AAqED,MAAM,UAAU,MAAM,CAAC,UAA6C;IAClE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,UAAU,EAAE,CAAC;AAC9C,CAAC;AAiMD,MAAM,UAAU,SAAS,CAAC,UAAyB;IACjD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,UAAU,EAAE,CAAC;AAC3C,CAAC"}
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AA6DA,MAAM,UAAU,MAAM,CAAC,aAAgD,EAAE;IACvE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,UAAU,EAAE,CAAC;AAC9C,CAAC;AAqED,MAAM,UAAU,MAAM,CAAC,UAA6C;IAClE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,UAAU,EAAE,CAAC;AAC9C,CAAC;AA+QD,MAAM,UAAU,SAAS,CAAC,UAAyB;IACjD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,UAAU,EAAE,CAAC;AAC3C,CAAC"}

package/dist/dashboard.d.ts

@@ -4,41 +4,124 @@
  */
 export type WidgetFilter = Record<string, string | number | boolean | readonly (string | number)[]>;
 export type Aggregate = "count" | "sum" | "avg" | "min" | "max";
+/** Date buckets of a chart axis. */
+export type DateBucket = "day" | "week" | "month" | "year";
+/** Calendar periods (weeks start on Monday). */
+export type Period = "week" | "month" | "quarter" | "year";
+/**
+ * How numbers are written. Default: like the field (money keeps its currency, percentage fields show "%").
+ * "compact" = 12.5K, "currency" = money (the field's currency, else `currency`), "percent" = a fraction as % (0.25 → 25%).
+ */
+export type NumberFormat = "number" | "compact" | "currency" | "percent";
+export type ChartKind = "bar" | "line" | "area" | "donut" | "pie" | "stackedBar" | "funnel" | "heatmap" | "table";
 interface WidgetBase {
     title: string;
     entity: string;
     where?: WidgetFilter;
     /** Columns in a 3-column grid. Default 1 (charts: 2, lists: 2). */
     span?: 1 | 2 | 3;
+    /**
+     * Roles that see this widget, e.g. ["admin"] for revenue only the owner should see. Default: everyone who
+     * can read the entity. (The numbers always respect the viewer's permissions on top of this.)
+     */
+    visibleTo?: readonly string[];
 }
-export interface MetricWidget extends WidgetBase {
+/** One side of a ratio metric. */
+export interface MetricSource {
+    entity: string;
+    where?: WidgetFilter;
+    aggregate?: Aggregate;
+    field?: string;
+    /** Date or datetime field that places records in a period (`period`, `compare`). Default "createdAt". */
+    dateField?: string;
+}
+export interface MetricWidget extends Omit<WidgetBase, "entity"> {
     readonly type: "metric";
+    /** Required, except for ratio metrics (each side names its own entity). */
+    entity?: string;
     aggregate?: Aggregate;
     /** Numeric field for sum/avg/min/max. */
     field?: string;
     /**
      * Show the change versus the previous period ("+12% vs previous month") with a sparkline of the last 12 periods.
      * Periods are rolling windows ending now (month = the last month, compared with the month before).
-     * Default "month" when the entity has a date to compare on, false when `where` already uses relative dates ($today, $startOfMonth…).
+     * Default "month" when the entity has a date to compare on, false when `where` already uses relative dates ($today, $startOfMonth…) or `period` is set.
      */
-    compare?: "week" | "month" | "quarter" | "year" | false;
+    compare?: Period | false;
     /** Date or datetime field that places records in a period. Default "createdAt". */
     dateField?: string;
-    /** Which direction is good news (colours the change). Default "up-is-good". */
+    /** Which direction is good news (colours the change and the goal). Default "up-is-good". */
     trend?: "up-is-good" | "down-is-good";
+    /**
+     * Count only the current calendar period (this week/month/quarter/year, in the dashboard's timezone), the whole
+     * period: records dated later in it (upcoming bookings, due dates) count too. Without `period` the value is all-time.
+     */
+    period?: Period;
+    /** A target: shows progress towards it (e.g. 50000 with period "month" = "50K this month"). */
+    goal?: number;
+    /**
+     * A ratio of two aggregates, e.g. a conversion rate: { numerator: { entity: "Deal", where: { stage: "won" } }, denominator: { entity: "Lead" } }.
+     * Both sides use the viewer's permissions; the widget is hidden from viewers who can't read either side. Shown as a percentage by default.
+     */
+    ratio?: {
+        numerator: MetricSource;
+        denominator: MetricSource;
+    };
+    format?: NumberFormat;
+    /** ISO currency code for `format: "currency"` when the field is not money. */
+    currency?: string;
 }
-export interface ChartWidget extends WidgetBase {
+/** One line/bar series of a multi-series chart; each series can come from another entity. */
+export interface ChartSeries {
+    entity: string;
+    /** Legend label. Default: the entity's plural label. */
+    label?: string;
+    where?: WidgetFilter;
+    aggregate?: Aggregate;
+    field?: string;
+    /** Date axis (`groupBy: { by }`): the date field that places this series' records. Default: the chart's groupBy field, else "createdAt". */
+    dateField?: string;
+    /** Category axis (`groupBy: "stage"`): the field this series groups by. Default: the chart's groupBy. */
+    groupBy?: string;
+    /** Value axis. Default: left, or right when the unit differs from the first series (count vs money). */
+    axis?: "left" | "right";
+}
+export interface ChartWidget extends Omit<WidgetBase, "entity"> {
     readonly type: "chart";
-    chart: "bar" | "line" | "donut";
-    /** Enum, boolean or many-to-one relation field — or a date field bucketed by day/week/month/year. */
-    groupBy: string | {
-        field: string;
-        by: "day" | "week" | "month" | "year";
+    chart: ChartKind;
+    /** Required unless `series` is set. */
+    entity?: string;
+    /**
+     * Enum, boolean or many-to-one relation field — or a date field bucketed by day/week/month/year.
+     * Heatmaps: `{ field, by: "hour" }` (day of week × hour of day) or `{ field, by: "day" }` (one cell per day, a column per week).
+     * Multi-series date axis: `{ by: "month" }` (each series names its `dateField`).
+     */
+    groupBy?: string | {
+        field?: string;
+        by: DateBucket | "hour";
     };
+    /** A second enum, boolean or many-to-one field: one series per value (stackedBar, or grouped bar/line/area/table). */
+    stackBy?: string;
+    /** Several series (possibly from several entities) on a shared date axis or a shared category axis. */
+    series?: readonly ChartSeries[];
     aggregate?: Aggregate;
     field?: string;
     /** Max categories shown (the rest are grouped as "Other"). Default 8. */
     limit?: number;
+    /** Funnel: the enum values to show, in order. Default: every value, in declaration order. */
+    stages?: readonly string[];
+    /** Funnel: count records at a stage or any later one ("reached this stage"). Default false. */
+    cumulative?: boolean;
+    /** Plot height: sm 160px, md 220px (default), lg 320px. */
+    height?: "sm" | "md" | "lg";
+    /** Series/segment colours in order: hex ("#2563eb") or theme tokens ("primary", "accent", "success", "info", "danger", "chart-1"…"chart-8"). Default: the theme's chart palette. */
+    colors?: readonly string[];
+    /** Show the legend. Default: when there are several series (and for donut/pie). */
+    legend?: boolean;
+    /** Stack the series of a bar/area chart. Default: true for stackedBar, false otherwise. */
+    stacked?: boolean;
+    format?: NumberFormat;
+    currency?: string;
 }
 export interface ListWidget extends WidgetBase {
     readonly type: "list";
@@ -48,6 +131,19 @@ export interface ListWidget extends WidgetBase {
     columns?: readonly string[];
 }
 export type DashboardWidget = MetricWidget | ChartWidget | ListWidget;
+/** A dashboard tab; `visibleTo` gives roles their own dashboards. */
+export interface DashboardTab {
+    title: string;
+    widgets: readonly DashboardWidget[];
+    visibleTo?: readonly string[];
+}
+export interface DashboardConfig {
+    /** The widgets (one page). Use `tabs` instead for several pages. */
+    widgets?: readonly DashboardWidget[];
+    tabs?: readonly DashboardTab[];
+    /** IANA timezone for date buckets, heatmaps and goal periods (e.g. "Europe/Paris"). Default "UTC". */
+    timezone?: string;
+}
 export declare const metric: (w: Omit<MetricWidget, "type">) => MetricWidget;
 export declare const chart: (w: Omit<ChartWidget, "type">) => ChartWidget;
 export declare const list: (w: Omit<ListWidget, "type">) => ListWidget;

package/dist/dashboard.js.map

@@ -1 +1 @@
-{"version":3,"file":"dashboard.js","sourceRoot":"","sources":["../src/dashboard.ts"],"names":[],"mappings":"AAqDA,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAA6B,EAAgB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;AAClG,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAA4B,EAAe,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;AAC9F,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CAA2B,EAAc,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC"}
+{"version":3,"file":"dashboard.js","sourceRoot":"","sources":["../src/dashboard.ts"],"names":[],"mappings":"AAsJA,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAA6B,EAAgB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;AAClG,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAA4B,EAAe,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;AAC9F,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CAA2B,EAAc,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC"}

package/dist/icons.d.ts

@@ -0,0 +1,3 @@
+/** Icons an entity can use in navigation (`icon: "receipt"`); the admin renders them with lucide. */
+export declare const ENTITY_ICONS: readonly ["folder", "users", "user", "briefcase", "building", "file-text", "box", "tag", "layers", "star", "calendar", "credit-card", "mail", "map-pin", "package", "shopping-cart", "ticket", "check-square", "receipt", "wallet", "banknote", "dollar-sign", "chart", "trending-up", "target", "phone", "message-square", "headphones", "life-buoy", "clipboard", "list-todo", "kanban", "flag", "bug", "wrench", "hammer", "truck", "warehouse", "store", "factory", "home", "bed", "car", "plane", "map", "globe", "graduation-cap", "book", "library", "stethoscope", "heart-pulse", "pill", "utensils", "coffee", "shirt", "gift", "camera", "image", "video", "music", "newspaper", "megaphone", "award", "trophy", "shield", "key", "lock", "server", "database", "cpu", "code", "git-branch", "rocket", "zap", "leaf", "sprout", "paw", "dumbbell", "clock", "timer", "bell", "inbox", "archive", "file", "paperclip", "contact", "id-card", "handshake", "scale", "landmark", "calculator", "percent", "boxes", "barcode", "scan", "settings", "sliders", "puzzle", "lightbulb"];
+export type EntityIcon = (typeof ENTITY_ICONS)[number];

package/dist/icons.js

@@ -0,0 +1,3 @@
+/** Icons an entity can use in navigation (`icon: "receipt"`); the admin renders them with lucide. */
+export const ENTITY_ICONS = ["folder", "users", "user", "briefcase", "building", "file-text", "box", "tag", "layers", "star", "calendar", "credit-card", "mail", "map-pin", "package", "shopping-cart", "ticket", "check-square", "receipt", "wallet", "banknote", "dollar-sign", "chart", "trending-up", "target", "phone", "message-square", "headphones", "life-buoy", "clipboard", "list-todo", "kanban", "flag", "bug", "wrench", "hammer", "truck", "warehouse", "store", "factory", "home", "bed", "car", "plane", "map", "globe", "graduation-cap", "book", "library", "stethoscope", "heart-pulse", "pill", "utensils", "coffee", "shirt", "gift", "camera", "image", "video", "music", "newspaper", "megaphone", "award", "trophy", "shield", "key", "lock", "server", "database", "cpu", "code", "git-branch", "rocket", "zap", "leaf", "sprout", "paw", "dumbbell", "clock", "timer", "bell", "inbox", "archive", "file", "paperclip", "contact", "id-card", "handshake", "scale", "landmark", "calculator", "percent", "boxes", "barcode", "scan", "settings", "sliders", "puzzle", "lightbulb"];
+//# sourceMappingURL=icons.js.map

package/dist/icons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"icons.js","sourceRoot":"","sources":["../src/icons.ts"],"names":[],"mappings":"AAAA,qGAAqG;AACrG,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,CAAU,CAAC"}

package/dist/index.d.ts

@@ -2,3 +2,5 @@ export * from "./fields.js";
 export * from "./app.js";
 export * from "./plugin.js";
 export * from "./dashboard.js";
+export * from "./icons.js";
+export * from "./site.js";

package/dist/index.js

@@ -2,4 +2,6 @@ export * from "./fields.js";
 export * from "./app.js";
 export * from "./plugin.js";
 export * from "./dashboard.js";
+export * from "./icons.js";
+export * from "./site.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

package/dist/site.d.ts

@@ -0,0 +1,350 @@
+/**
+ * The public website (`site` in forge.config.ts): pages made of sections from a built-in library, a header menu,
+ * a footer and a blog. Pages are seeded into the database and stay editable in the admin (Content).
+ */
+/** A same-site path ("/pricing", "/sign-up", "#plans"), an http(s) URL, mailto: or tel:. */
+export type Href = string;
+/** An image: an http(s) URL, a file in apps/web/public ("/hero.png") or an upload ("/api/files/<id>", storage plugin). */
+export type ImageUrl = string;
+export interface SiteLink {
+    label: string;
+    href: Href;
+}
+/** Heading shown above most sections. */
+export interface SectionHeading {
+    /** Small line above the title. */
+    eyebrow?: string;
+    title?: string;
+    subtitle?: string;
+}
+export type PostKind = "post" | "guide" | "webinar" | "case-study";
+export type DataFilter = Record<string, string | number | boolean | readonly (string | number)[]>;
+export interface HeroProps {
+    eyebrow?: string;
+    title: string;
+    subtitle?: string;
+    primary?: SiteLink;
+    secondary?: SiteLink;
+    /** Shown by the "split" variant (and behind the "minimal" one when set). */
+    image?: ImageUrl;
+    imageAlt?: string;
+}
+export interface FeatureItem {
+    title: string;
+    description?: string;
+    /** zap, shield, chart, sparkles, lock, globe, clock, bell, search, heart, rocket, users, calendar… */
+    icon?: string;
+    /** Shown by the "alternating" and "bento" variants. */
+    image?: ImageUrl;
+    imageAlt?: string;
+    href?: Href;
+}
+export interface FeaturesProps extends SectionHeading {
+    items: readonly FeatureItem[];
+}
+export interface LogosProps extends SectionHeading {
+    items: readonly {
+        name: string;
+        image?: ImageUrl;
+        href?: Href;
+    }[];
+}
+export interface TestimonialsProps extends SectionHeading {
+    items: readonly {
+        quote: string;
+        author: string;
+        role?: string;
+        avatar?: ImageUrl;
+    }[];
+}
+/**
+ * A number: static (`value: "99.9%"`) or live — `entity` (+ `aggregate`, `field`, `where`), computed like a
+ * dashboard metric. Live numbers need an entity whose read rule includes "public" (and no organization scope).
+ */
+export interface StatItem {
+    label: string;
+    value?: string;
+    entity?: string;
+    aggregate?: "count" | "sum" | "avg" | "min" | "max";
+    field?: string;
+    where?: DataFilter;
+    prefix?: string;
+    suffix?: string;
+}
+export interface StatsProps extends SectionHeading {
+    items: readonly StatItem[];
+}
+export interface StepsProps extends SectionHeading {
+    items: readonly {
+        title: string;
+        description?: string;
+    }[];
+}
+export interface PricingPlan {
+    name: string;
+    price: string;
+    /** e.g. "/ month" */
+    period?: string;
+    description?: string;
+    features?: readonly string[];
+    cta?: SiteLink;
+    /** Emphasized card ("Most popular"). */
+    highlighted?: boolean;
+}
+export interface PricingProps extends SectionHeading {
+    /** "payments": the plans of the payments plugin (name, price, description, features). Default: "static" when `plans` is set. */
+    source?: "static" | "payments";
+    plans?: readonly PricingPlan[];
+}
+export interface FaqProps extends SectionHeading {
+    /** Answers are markdown. */
+    items: readonly {
+        question: string;
+        answer: string;
+    }[];
+}
+export interface CtaProps {
+    title: string;
+    subtitle?: string;
+    primary?: SiteLink;
+    secondary?: SiteLink;
+}
+export interface ComparisonProps extends SectionHeading {
+    /** Column headings, e.g. ["Acme", "Spreadsheets", "Others"]. */
+    columns: readonly string[];
+    /** One value per column: true/false shows a check or a dash, text is shown as is. */
+    rows: readonly {
+        feature: string;
+        values: readonly (string | boolean)[];
+    }[];
+}
+export interface IntegrationsProps extends SectionHeading {
+    items: readonly {
+        name: string;
+        description?: string;
+        image?: ImageUrl;
+        href?: Href;
+    }[];
+}
+export interface TeamProps extends SectionHeading {
+    items: readonly {
+        name: string;
+        role?: string;
+        bio?: string;
+        avatar?: ImageUrl;
+        href?: Href;
+    }[];
+}
+export interface GalleryProps extends SectionHeading {
+    items: readonly {
+        image: ImageUrl;
+        alt: string;
+        caption?: string;
+    }[];
+}
+/** A form whose messages are stored (built-in ContactMessage model) and notified to admins. */
+export interface ContactProps extends SectionHeading {
+    /** Shown beside the form by the "split" variant. */
+    email?: string;
+    phone?: string;
+    address?: string;
+    /** Ask for a company name too. */
+    company?: boolean;
+    buttonLabel?: string;
+    successMessage?: string;
+}
+/** Email capture stored in the built-in NewsletterSubscriber model. */
+export interface NewsletterProps extends SectionHeading {
+    buttonLabel?: string;
+    successMessage?: string;
+}
+export interface RichTextProps {
+    /** Markdown (sanitized: no raw HTML). */
+    body: string;
+}
+export interface ImageTextProps {
+    eyebrow?: string;
+    title?: string;
+    /** Markdown. */
+    body?: string;
+    image: ImageUrl;
+    imageAlt?: string;
+    cta?: SiteLink;
+}
+export interface VideoProps extends SectionHeading {
+    /** A YouTube or Vimeo link, or a video file (.mp4/.webm). */
+    url: string;
+    caption?: string;
+}
+export interface EmbedProps extends SectionHeading {
+    /** https URL whose host is allowed (YouTube, Vimeo, Google Maps/Docs/Forms, Calendly, Typeform, Loom, Figma… or site.embedHosts). */
+    url: string;
+    /** Accessible name of the frame. */
+    frameTitle: string;
+    /** Height in pixels (200–1200). Default 480. */
+    height?: number;
+}
+export interface BlogListProps extends SectionHeading {
+    /** Which posts: "post" (blog), "guide", "webinar" or "case-study". Default "post". */
+    kind?: PostKind;
+    /** Default 6. */
+    limit?: number;
+    tag?: string;
+}
+export interface SpacerProps {
+}
+export interface DividerProps {
+}
+/** Records of an entity whose read rule includes "public" (e.g. a product catalog or a job board). */
+export interface EntityListProps extends SectionHeading {
+    entity: string;
+    /** Fields shown (default: the display field and the first list columns). */
+    fields?: readonly string[];
+    /** List-query filter, e.g. { status: "open" }. */
+    filter?: DataFilter;
+    /** e.g. "-createdAt" */
+    sort?: string;
+    /** Default 12, at most 48. */
+    limit?: number;
+}
+export interface SectionPropsByType {
+    hero: HeroProps;
+    features: FeaturesProps;
+    logos: LogosProps;
+    testimonials: TestimonialsProps;
+    stats: StatsProps;
+    steps: StepsProps;
+    pricing: PricingProps;
+    faq: FaqProps;
+    cta: CtaProps;
+    comparison: ComparisonProps;
+    integrations: IntegrationsProps;
+    team: TeamProps;
+    gallery: GalleryProps;
+    contact: ContactProps;
+    newsletter: NewsletterProps;
+    richText: RichTextProps;
+    imageText: ImageTextProps;
+    video: VideoProps;
+    embed: EmbedProps;
+    blogList: BlogListProps;
+    spacer: SpacerProps;
+    divider: DividerProps;
+    entityList: EntityListProps;
+    entityGrid: EntityListProps;
+}
+export interface SectionVariantsByType {
+    hero: "centered" | "split" | "brand" | "minimal";
+    features: "grid" | "alternating" | "bento";
+    logos: "strip" | "grid";
+    testimonials: "cards" | "single";
+    stats: "row" | "cards";
+    steps: "numbered" | "timeline";
+    pricing: "cards" | "compact";
+    faq: "accordion" | "columns";
+    cta: "banner" | "split" | "minimal";
+    comparison: "table" | "cards";
+    integrations: "grid" | "list";
+    team: "cards" | "compact";
+    gallery: "grid" | "masonry";
+    contact: "form" | "split";
+    newsletter: "inline" | "card";
+    richText: "default" | "narrow";
+    imageText: "left" | "right";
+    video: "default" | "wide";
+    embed: "default" | "wide";
+    blogList: "grid" | "list" | "featured";
+    spacer: "small" | "medium" | "large";
+    divider: "line" | "dots";
+    entityList: "table" | "list";
+    entityGrid: "cards" | "compact";
+}
+export type SectionType = keyof SectionPropsByType;
+export interface SectionOptions<T extends SectionType> {
+    variant?: SectionVariantsByType[T];
+    /** Stable key (letters, digits, dashes) so admin edits survive reordering in the config. Default: the type (+ "-2", "-3"…). */
+    id?: string;
+    /** Kept but not shown. */
+    hidden?: boolean;
+}
+export interface SectionDefinition {
+    readonly __forge: "section";
+    type: string;
+    variant?: string;
+    id?: string;
+    hidden?: boolean;
+    props: Record<string, unknown>;
+}
+/**
+ * A section of a page: `section("hero", { variant: "split", title: "…", image: "/hero.png" })`.
+ * Props are typed per section type; see SectionPropsByType.
+ */
+export declare function section<T extends SectionType>(type: T, props?: SectionPropsByType[T] & SectionOptions<T>): SectionDefinition;
+/** Ready-made pages with sensible sections and placeholder copy from the app's name, description and entities. */
+export type PageTemplate = "home" | "features" | "how-it-works" | "integrations" | "product-tour" | "use-cases" | "industries" | "pricing" | "customers" | "blog" | "guides" | "webinars" | "docs" | "about" | "team" | "careers" | "contact" | "security" | "privacy" | "compliance" | "login" | "signup" | "blank";
+export interface PageSeo {
+    /** Default: the page title. */
+    title?: string;
+    description?: string;
+    /** Open Graph image. */
+    image?: ImageUrl;
+}
+export interface PageDefinition {
+    readonly __forge: "page";
+    /** Fills the title, path, SEO and sections you leave out. */
+    template?: PageTemplate;
+    title?: string;
+    /** "/", "/pricing", "/product/features" (lowercase, at most 3 segments). */
+    path?: string;
+    seo?: PageSeo;
+    sections?: readonly SectionDefinition[];
+    /** "draft" pages are only visible to site editors. Default "published". */
+    status?: "published" | "draft";
+    /**
+     * Place in the automatic header menu: `false` hides it, `{ group: "Resources" }` puts it in a dropdown,
+     * `{ label }` renames the entry, `{ footerOnly: true }` lists it only in the footer (legal pages).
+     * Default: grouped by the first path segment ("/product/x" → "Product").
+     */
+    nav?: false | {
+        group?: string;
+        label?: string;
+        footerOnly?: boolean;
+    };
+    /** Make the page a link to another address (the login and signup templates point at /sign-in and /sign-up). */
+    redirect?: Href;
+}
+export declare function page(definition?: Omit<PageDefinition, "__forge">): PageDefinition;
+/** A header menu entry: a link (`href` or `page`, a key of site.pages) or a dropdown group (`items`). */
+export interface SiteNavItem {
+    label?: string;
+    href?: Href;
+    page?: string;
+    description?: string;
+    items?: readonly SiteNavItem[];
+}
+export interface SiteFooter {
+    columns?: readonly {
+        title: string;
+        links: readonly SiteNavItem[];
+    }[];
+    /** Line under the columns, e.g. "Made in Dakar". */
+    note?: string;
+    /** Social profile links shown as icons. */
+    social?: readonly {
+        network: "x" | "github" | "linkedin" | "youtube" | "instagram" | "facebook" | "mastodon" | "discord";
+        href: string;
+    }[];
+}
+export interface SiteConfig {
+    pages: Record<string, PageDefinition>;
+    /** Header menu. Default: built from the pages (groups by first path segment or `nav.group`). */
+    nav?: readonly SiteNavItem[];
+    /** Footer columns. Default: the menu's groups and pages. */
+    footer?: SiteFooter;
+    /** Base path of each post kind (detail pages are `<path>/<slug>`, feed `<path>/rss.xml`). Default: the page listing that kind. */
+    blog?: Partial<Record<PostKind, string>>;
+    /** Extra hosts the `embed` section may show (besides YouTube, Vimeo, Google, Calendly, Typeform, Loom, Figma…). */
+    embedHosts?: readonly string[];
+    /** Roles (global user roles) that may edit the site in the admin. Default ["admin"]. */
+    editors?: readonly string[];
+}

package/dist/site.js

@@ -0,0 +1,16 @@
+/**
+ * The public website (`site` in forge.config.ts): pages made of sections from a built-in library, a header menu,
+ * a footer and a blog. Pages are seeded into the database and stay editable in the admin (Content).
+ */
+/**
+ * A section of a page: `section("hero", { variant: "split", title: "…", image: "/hero.png" })`.
+ * Props are typed per section type; see SectionPropsByType.
+ */
+export function section(type, props) {
+    const { variant, id, hidden, ...rest } = (props ?? {});
+    return { __forge: "section", type, ...(variant !== undefined ? { variant } : {}), ...(id !== undefined ? { id } : {}), ...(hidden !== undefined ? { hidden } : {}), props: rest };
+}
+export function page(definition = {}) {
+    return { __forge: "page", ...definition };
+}
+//# sourceMappingURL=site.js.map

package/dist/site.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.js","sourceRoot":"","sources":["../src/site.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAkRH;;;GAGG;AACH,MAAM,UAAU,OAAO,CAAwB,IAAO,EAAE,KAAiD;IACvG,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,CAAC,KAAK,IAAI,EAAE,CAAkF,CAAC;IACxI,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACpL,CAAC;AAyDD,MAAM,UAAU,IAAI,CAAC,aAA8C,EAAE;IACnE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,CAAC;AAC5C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tekki-forge/core",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Forge schema DSL: defineApp, entity and field builders",
   "keywords": [
     "code-generator",