@tekki-forge/core 0.1.0

package/README.md

@@ -0,0 +1,5 @@
+# @tekki-forge/core
+
+Forge schema DSL: defineApp, entity and field builders.
+
+Part of [Tekki Forge](https://www.npmjs.com/package/tekki-forge), which turns a `forge.config.ts` into a production-ready full-stack app. Apps created with `forge new` install this package for you; see the [tekki-forge](https://www.npmjs.com/package/tekki-forge) package for the documentation.

package/dist/app.d.ts

@@ -0,0 +1,308 @@
+import type { AnyField } from "./fields.js";
+import type { DashboardWidget } from "./dashboard.js";
+import type { PluginDefinition } from "./plugin.js";
+/**
+ * A permission rule lists who may perform an operation. Tokens:
+ *  - a role name, e.g. "admin", "manager", "member"
+ *  - "owner"          the user referenced by the entity's owner relation
+ *  - "team"           members of the record's team (entities with features: { teams: true })
+ *  - "authenticated"  any signed-in user
+ *  - "public"         anyone, including anonymous visitors
+ *  - "policy:<name>"  a named policy implemented in the API extension file
+ */
+export type PermissionToken = string;
+export type PermissionRule = readonly PermissionToken[];
+export interface EntityPermissions {
+    create?: PermissionRule;
+    read?: PermissionRule;
+    update?: PermissionRule;
+    delete?: PermissionRule;
+}
+export interface EntityFeatures {
+    /** createdAt / updatedAt columns. Default: true. */
+    timestamps?: boolean;
+    /** Keep deleted rows with a deletedAt marker and expose a restore endpoint. */
+    softDelete?: boolean;
+    /** Record every create/update/delete in the audit log. */
+    audit?: boolean;
+    /** Scope rows to the active organization. Default: true when multi-tenancy is enabled. */
+    tenant?: boolean;
+    /** CSV export endpoint and button. Default: true. */
+    export?: boolean;
+    /** Bulk delete endpoint and selection UI. Default: true. */
+    bulkDelete?: boolean;
+    /**
+     * Records belong to a team of the organization: adds a `team` relation (built-in Team model) and
+     * enables the "team" permission token (members of the record's team). Requires multiTenant.
+     */
+    teams?: boolean;
+    /**
+     * Comments with @mentions on each record, shown with the audit history in the record page's Activity panel.
+     * Anyone who can read a record can comment on it. Default: false.
+     */
+    comments?: boolean;
+}
+export interface ActionDefinition {
+    readonly __forge: "action";
+    label?: string;
+    /** Confirmation prompt shown before running the action. */
+    confirm?: string;
+    /** Who may run it. Default: the entity's update rule. */
+    permission?: PermissionRule;
+    /** Visual emphasis in the UI. */
+    variant?: "default" | "danger";
+}
+export declare function action(definition?: Omit<ActionDefinition, "__forge">): ActionDefinition;
+export interface EntityListOptions {
+    columns?: readonly string[];
+    /** e.g. "-createdAt" or "name" */
+    defaultSort?: string;
+    pageSize?: number;
+}
+export interface WorkflowTransition {
+    /** State(s) the transition starts from; "*" for any. */
+    from: string | readonly string[];
+    to: string;
+    label?: string;
+    /** Who may run it. Default: the entity's update rule. */
+    permission?: PermissionRule;
+    confirm?: string;
+    variant?: "default" | "danger";
+}
+export interface WorkflowDefinition {
+    /** An enumeration field holding the state. It can then only change through transitions. */
+    field: string;
+    /** State of new records. Default: the field's default, else its first value. */
+    initial?: string;
+    transitions: Record<string, WorkflowTransition>;
+}
+export interface EntityViews {
+    /** Kanban board grouped by an enum field (drag cards between columns). */
+    board?: {
+        groupBy: string;
+        title?: string;
+        fields?: readonly string[];
+    };
+    /** Month calendar placed by a date/datetime field. */
+    calendar?: {
+        date: string;
+        end?: string;
+        title?: string;
+    };
+    /** Map of records by a location field. */
+    map?: {
+        location: string;
+        title?: string;
+    };
+}
+export interface EntityDefinition {
+    readonly __forge: "entity";
+    label?: string;
+    pluralLabel?: string;
+    /** Database table name. Default: snake_case plural of the entity name. */
+    table?: string;
+    /** URL segment. Default: kebab-case plural of the entity name. */
+    path?: string;
+    /**
+     * Name the stored data is keyed on: the Prisma model (and so its enum types and many-to-many link
+     * tables) and the entity name recorded in uploaded files, the audit log and notifications.
+     * Default: the entity name. Renaming an entity in the schema editor sets it to the previous name
+     * (with `table` and `path`), so the rename changes no database object and no stored row.
+     * Changing it yourself renames those database objects — review the migration.
+     */
+    storageName?: string;
+    /** Field used as the human-readable label of a record. */
+    display?: string;
+    /** lucide icon name used in navigation. */
+    icon?: string;
+    /** Show in the sidebar. Default true. */
+    nav?: boolean;
+    description?: string;
+    fields: Record<string, AnyField>;
+    permissions?: EntityPermissions;
+    features?: EntityFeatures;
+    actions?: Record<string, ActionDefinition>;
+    list?: EntityListOptions;
+    workflow?: WorkflowDefinition;
+    views?: EntityViews;
+}
+export declare function entity(definition: Omit<EntityDefinition, "__forge">): EntityDefinition;
+export type SocialProvider = "google" | "microsoft" | "github" | "apple" | "gitlab" | "discord";
+export interface AuthConfig {
+    emailPassword?: boolean;
+    /** Allow self-service sign-up. Default: true. */
+    registration?: boolean;
+    social?: readonly SocialProvider[];
+    emailVerification?: boolean;
+    passwordReset?: boolean;
+    twoFactor?: boolean;
+    passkeys?: boolean;
+}
+export interface MultiTenantConfig {
+    enabled: boolean;
+    model?: "organization";
+}
+export type UIStyle = "simple" | "shadow" | "neumorphism" | "glassmorphism" | "skeuomorphism" | "material" | "brutalist" | "editorial" | "aurora" | "terminal" | "clay";
+/** 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";
+/** 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 interface ThemeConfig {
+    /**
+     * Start from a curated look: midnight, sandstone, ocean, forest, sunset, graphite, candy, paper, phosphor.
+     * Any other key set here overrides the preset's value.
+     */
+    preset?: ThemePreset;
+    /**
+     * Visual language of the whole UI:
+     *  - simple         flat surfaces, hairline borders
+     *  - shadow         borderless cards floating on soft layered shadows
+     *  - neumorphism    extruded surfaces the same colour as the page
+     *  - glassmorphism  frosted translucent panels over a colourful backdrop
+     *  - skeuomorphism  tactile gradients, bevels and highlights
+     *  - material       Material Design 3 tonal surfaces and elevation
+     *  - brutalist      thick borders, hard offset shadows, bold type
+     *  - editorial      paper tones, serif headings, hairlines, generous whitespace
+     *  - aurora         soft animated gradient backdrop from your colours, glassy cards
+     *  - terminal       dark-first, monospace, phosphor accents
+     *  - clay           claymorphism: puffy rounded surfaces with inner highlights
+     */
+    style?: UIStyle;
+    colors?: {
+        /** Main brand colour: primary buttons, links, focus rings, active navigation. Hex, e.g. "#4f46e5". */
+        primary?: string;
+        /** Secondary highlight: badges, charts, the glass backdrop, selected states. */
+        accent?: string;
+        /** Destructive actions. */
+        danger?: string;
+    };
+    mode?: "light" | "dark" | "system";
+    /** Corner roundness. */
+    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.
+     */
+    font?: ThemeFont;
+    /** Navigation: a sidebar (default), a top bar, or a compact icon rail (tooltips on hover/focus, expandable with its toggle). */
+    layout?: "sidebar" | "topbar" | "compact";
+    /** Spacing of tables, forms and cards. Default: comfortable. */
+    density?: "comfortable" | "compact";
+    /** Logo shown in the navigation, on sign-in pages and as the favicon: an https:// URL or a file in apps/web/public ("/logo.svg"). */
+    logo?: string;
+    /** Short line shown on the sign-in pages' brand panel. */
+    tagline?: string;
+}
+export interface NotificationRule {
+    /**
+     * Event that triggers it: "<Entity>.<created|updated|deleted|restored|transitioned|action>",
+     * optionally narrowed to a transition or action: "Invoice.transitioned:send".
+     */
+    on: string;
+    /**
+     * Who is notified: "owner", the name of a User relation on the entity ("assignee", "members"),
+     * or "role:<role>" (members of the organization with that role). The person who caused the event is never notified.
+     */
+    to: string | readonly string[];
+    /** Text with {placeholders}: any field of the record, {actor}, {entity}. */
+    title: string;
+    body?: string;
+    /** Where the notification leads. Default: the record's page. */
+    link?: string;
+    /** Also send an email (templated, queued when the jobs plugin is present). */
+    email?: boolean;
+    /** Only for updates that changed this field. */
+    when?: {
+        changed?: string;
+    };
+}
+export interface AppDefinition {
+    name: string;
+    description?: string;
+    database?: {
+        provider?: "postgresql";
+    };
+    auth?: AuthConfig;
+    multiTenant?: boolean | MultiTenantConfig;
+    /**
+     * Roles used by permission rules. "admin" always exists. When multi-tenancy is on,
+     * organization member roles (owner → admin, admin, member) are merged in.
+     */
+    roles?: readonly string[];
+    api?: {
+        prefix?: string;
+        docs?: boolean;
+    };
+    /** Client SDKs to generate. Default: TypeScript only (packages/sdk). */
+    sdk?: SdkConfig;
+    admin?: {
+        enabled?: boolean;
+    };
+    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[];
+    };
+    /** In-app (and optional email) notifications triggered by record events. */
+    notifications?: readonly NotificationRule[];
+    /**
+     * Scheduled database backups (`forge backup` runs them by hand). With the jobs plugin the worker runs
+     * them on `schedule` (cron, UTC); otherwise run `forge backup` from cron or CI.
+     */
+    backups?: BackupsConfig;
+    /** Languages of the admin UI. Translations of your labels live in locales/<locale>.json. */
+    i18n?: I18nConfig;
+    entities: Record<string, EntityDefinition>;
+    /**
+     * A public landing page at `/` for signed-out visitors (signed-in users still get the dashboard).
+     * `true` builds one from the app's name, description, tagline and entities; an object overrides any part.
+     */
+    landing?: boolean | LandingConfig;
+}
+export interface LandingFeature {
+    title: string;
+    description: string;
+    /** Icon name: zap, shield, chart, sparkles, lock, globe, clock, bell, search, heart, rocket, users, calendar… */
+    icon?: string;
+}
+export interface LandingConfig {
+    /** Default true when the block is present. */
+    enabled?: boolean;
+    /** Main heading. Default: the theme tagline, else the app name. */
+    headline?: string;
+    /** Default: the app description. */
+    subheadline?: string;
+    /** Up to 12 cards. Default: one per entity in the navigation (first 6). */
+    features?: readonly LandingFeature[];
+    /** Main button. Default: "Get started" → /sign-up (or "Sign in" when registration is off). */
+    cta?: {
+        label: string;
+        href: string;
+    };
+}
+export interface BackupsConfig {
+    /** Cron pattern, e.g. "0 3 * * *" (every day at 03:00 UTC). */
+    schedule?: string;
+    /** Number of backups to keep (older ones are deleted after each backup). Default 14. */
+    keep?: number;
+}
+export type SdkLanguage = "typescript" | "python" | "dart";
+export interface SdkConfig {
+    /**
+     * Languages to generate a typed API client for: "typescript" (packages/sdk), "python" (packages/sdk-python,
+     * httpx, sync + async) and "dart" (packages/sdk-dart, package:http, works in Flutter). Default: ["typescript"].
+     */
+    languages?: readonly SdkLanguage[];
+}
+export interface I18nConfig {
+    /** Language your labels are written in. Default "en". */
+    defaultLocale?: string;
+    /** Every language users can pick, e.g. ["en", "fr"]. The default locale is always included. */
+    locales?: readonly string[];
+}
+export interface AppConfig extends AppDefinition {
+    readonly __forge: "app";
+}
+export declare function defineApp(definition: AppDefinition): AppConfig;

package/dist/app.js

@@ -0,0 +1,10 @@
+export function action(definition = {}) {
+    return { __forge: "action", ...definition };
+}
+export function entity(definition) {
+    return { __forge: "entity", ...definition };
+}
+export function defineApp(definition) {
+    return { __forge: "app", ...definition };
+}
+//# sourceMappingURL=app.js.map

package/dist/app.js.map

@@ -0,0 +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"}

package/dist/dashboard.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Dashboard widgets declared in forge.config.ts. Filters use the same syntax as list query parameters
+ * ({ stage: "won", "amount.gte": 1000, owner: "$me" }) plus relative dates: "$today", "$today-30d", "$now", "$startOfMonth".
+ */
+export type WidgetFilter = Record<string, string | number | boolean | readonly (string | number)[]>;
+export type Aggregate = "count" | "sum" | "avg" | "min" | "max";
+interface WidgetBase {
+    title: string;
+    entity: string;
+    where?: WidgetFilter;
+    /** Columns in a 3-column grid. Default 1 (charts: 2, lists: 2). */
+    span?: 1 | 2 | 3;
+}
+export interface MetricWidget extends WidgetBase {
+    readonly type: "metric";
+    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…).
+     */
+    compare?: "week" | "month" | "quarter" | "year" | 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". */
+    trend?: "up-is-good" | "down-is-good";
+}
+export interface ChartWidget extends WidgetBase {
+    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";
+    };
+    aggregate?: Aggregate;
+    field?: string;
+    /** Max categories shown (the rest are grouped as "Other"). Default 8. */
+    limit?: number;
+}
+export interface ListWidget extends WidgetBase {
+    readonly type: "list";
+    /** e.g. "-createdAt" */
+    sort?: string;
+    limit?: number;
+    columns?: readonly string[];
+}
+export type DashboardWidget = MetricWidget | ChartWidget | ListWidget;
+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;
+export {};

package/dist/dashboard.js

@@ -0,0 +1,4 @@
+export const metric = (w) => ({ type: "metric", ...w });
+export const chart = (w) => ({ type: "chart", ...w });
+export const list = (w) => ({ type: "list", ...w });
+//# sourceMappingURL=dashboard.js.map

package/dist/dashboard.js.map

@@ -0,0 +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"}

package/dist/fields.d.ts

@@ -0,0 +1,130 @@
+/**
+ * Field builders. Each builder returns a plain, serializable description of a
+ * field; the compiler turns these into the normalized IR consumed by generators.
+ */
+export type FieldKind = "string" | "text" | "richtext" | "integer" | "decimal" | "money" | "percentage" | "boolean" | "date" | "datetime" | "enum" | "email" | "url" | "phone" | "color" | "json" | "location" | "file" | "image" | "computed" | "relation";
+export interface BaseFieldOptions {
+    label?: string;
+    description?: string;
+    required?: boolean;
+    unique?: boolean;
+    /** Add a database index on this column. */
+    index?: boolean;
+    default?: unknown;
+    /** Included in the `search` query parameter (text-like fields only). */
+    searchable?: boolean;
+    /** Exposed as a list filter. */
+    filterable?: boolean;
+    /** Allowed in the `sort` query parameter. Defaults to true for scalar fields. */
+    sortable?: boolean;
+    /** Shown as a column in list views. */
+    list?: boolean;
+    /** Never returned by the API nor rendered in the UI. */
+    hidden?: boolean;
+    /** Returned by the API but never writable through it. */
+    readonly?: boolean;
+    placeholder?: string;
+    /** Override the UI widget, e.g. "textarea". */
+    widget?: string;
+    /**
+     * Field-level access on top of the entity's permissions. Tokens as in entity permissions
+     * (roles, "owner", "authenticated", "policy:<name>"). Unreadable fields are removed from API
+     * responses, exports and search; unwritable fields are rejected on create/update.
+     */
+    permissions?: {
+        read?: readonly string[];
+        write?: readonly string[];
+    };
+}
+export interface StringFieldOptions extends BaseFieldOptions {
+    default?: string;
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+}
+export interface NumberFieldOptions extends BaseFieldOptions {
+    default?: number;
+    min?: number;
+    max?: number;
+}
+export interface DecimalFieldOptions extends NumberFieldOptions {
+    precision?: number;
+    scale?: number;
+}
+export interface MoneyFieldOptions extends DecimalFieldOptions {
+    /** ISO 4217 currency code, e.g. "USD", "EUR", "XOF". */
+    currency?: string;
+}
+export interface BooleanFieldOptions extends BaseFieldOptions {
+    default?: boolean;
+}
+export interface DateFieldOptions extends BaseFieldOptions {
+    /** `"now"` sets the current date/time on create. */
+    default?: "now" | string;
+}
+export interface EnumFieldOptions<V extends string = string> extends BaseFieldOptions {
+    values: readonly V[] | Record<V, string>;
+    default?: V;
+}
+export type RelationType = "many-to-one" | "many-to-many";
+export interface RelationFieldOptions extends BaseFieldOptions {
+    /** Target entity name, e.g. "Customer" or the built-in "User". */
+    entity: string;
+    type?: RelationType;
+    /** Marks this relation as the record owner used by `"owner"` permission rules. */
+    owner?: boolean;
+    onDelete?: "cascade" | "restrict" | "setNull";
+    /** Name of the inverse (one-to-many) collection on the target entity. */
+    inverse?: string;
+}
+export interface FileFieldOptions extends BaseFieldOptions {
+    /** Allowed types: MIME types ("application/pdf", "image/*") or extensions (".docx"). */
+    accept?: readonly string[];
+    /** Max size, e.g. "10MB", "500KB" or bytes. Default 10MB (image: 5MB). */
+    maxSize?: string | number;
+}
+export type ComputedType = "integer" | "decimal" | "money" | "percentage" | "string" | "boolean" | "date" | "datetime";
+export interface ComputedFieldOptions extends Omit<BaseFieldOptions, "required" | "unique" | "default" | "readonly"> {
+    /** Result type — decides storage, formatting and sorting. */
+    type: ComputedType;
+    /**
+     * Safe expression over this entity's fields, e.g. "quantity * unitPrice", "round(total * 0.18, 2)",
+     * "concat(firstName, ' ', lastName)" or an aggregate over a one-to-many relation: "sum(lines.amount)".
+     * The value is stored and recomputed on every write (so it can be sorted and filtered).
+     */
+    expression: string;
+    currency?: string;
+    precision?: number;
+    scale?: number;
+}
+export interface FieldDefinition<K extends FieldKind = FieldKind, O extends BaseFieldOptions = BaseFieldOptions> {
+    readonly __forge: "field";
+    readonly kind: K;
+    readonly options: O;
+}
+export declare const string: (o?: StringFieldOptions) => FieldDefinition<"string", StringFieldOptions>;
+export declare const text: (o?: StringFieldOptions) => FieldDefinition<"text", StringFieldOptions>;
+export declare const richtext: (o?: StringFieldOptions) => FieldDefinition<"richtext", StringFieldOptions>;
+export declare const email: (o?: StringFieldOptions) => FieldDefinition<"email", StringFieldOptions>;
+export declare const url: (o?: StringFieldOptions) => FieldDefinition<"url", StringFieldOptions>;
+export declare const phone: (o?: StringFieldOptions) => FieldDefinition<"phone", StringFieldOptions>;
+export declare const color: (o?: StringFieldOptions) => FieldDefinition<"color", StringFieldOptions>;
+export declare const integer: (o?: NumberFieldOptions) => FieldDefinition<"integer", NumberFieldOptions>;
+export declare const decimal: (o?: DecimalFieldOptions) => FieldDefinition<"decimal", DecimalFieldOptions>;
+export declare const money: (o?: MoneyFieldOptions) => FieldDefinition<"money", MoneyFieldOptions>;
+export declare const percentage: (o?: NumberFieldOptions) => FieldDefinition<"percentage", NumberFieldOptions>;
+export declare const boolean: (o?: BooleanFieldOptions) => FieldDefinition<"boolean", BooleanFieldOptions>;
+export declare const date: (o?: DateFieldOptions) => FieldDefinition<"date", DateFieldOptions>;
+export declare const datetime: (o?: DateFieldOptions) => FieldDefinition<"datetime", DateFieldOptions>;
+export declare const json: (o?: BaseFieldOptions) => FieldDefinition<"json", BaseFieldOptions>;
+export declare const enumeration: <V extends string>(o: EnumFieldOptions<V>) => FieldDefinition<"enum", EnumFieldOptions<V>>;
+export declare const relation: (o: RelationFieldOptions) => FieldDefinition<"relation", RelationFieldOptions>;
+/** Latitude/longitude pair, e.g. for the map view. */
+export declare const location: (o?: BaseFieldOptions) => FieldDefinition<"location", BaseFieldOptions>;
+/** A file stored in the app's object storage (requires the storage plugin). */
+export declare const file: (o?: FileFieldOptions) => FieldDefinition<"file", FileFieldOptions>;
+/** An image (PNG, JPEG, GIF, WebP, AVIF) stored in object storage (requires the storage plugin). */
+export declare const image: (o?: FileFieldOptions) => FieldDefinition<"image", FileFieldOptions>;
+/** A read-only value derived from other fields, stored and kept up to date by Forge. */
+export declare const computed: (o: ComputedFieldOptions) => FieldDefinition<"computed", ComputedFieldOptions>;
+export type AnyField = FieldDefinition<FieldKind, any>;

package/dist/fields.js

@@ -0,0 +1,33 @@
+/**
+ * Field builders. Each builder returns a plain, serializable description of a
+ * field; the compiler turns these into the normalized IR consumed by generators.
+ */
+function field(kind, options) {
+    return { __forge: "field", kind, options };
+}
+export const string = (o = {}) => field("string", o);
+export const text = (o = {}) => field("text", o);
+export const richtext = (o = {}) => field("richtext", o);
+export const email = (o = {}) => field("email", o);
+export const url = (o = {}) => field("url", o);
+export const phone = (o = {}) => field("phone", o);
+export const color = (o = {}) => field("color", o);
+export const integer = (o = {}) => field("integer", o);
+export const decimal = (o = {}) => field("decimal", o);
+export const money = (o = {}) => field("money", o);
+export const percentage = (o = {}) => field("percentage", o);
+export const boolean = (o = {}) => field("boolean", o);
+export const date = (o = {}) => field("date", o);
+export const datetime = (o = {}) => field("datetime", o);
+export const json = (o = {}) => field("json", o);
+export const enumeration = (o) => field("enum", o);
+export const relation = (o) => field("relation", o);
+/** Latitude/longitude pair, e.g. for the map view. */
+export const location = (o = {}) => field("location", o);
+/** A file stored in the app's object storage (requires the storage plugin). */
+export const file = (o = {}) => field("file", o);
+/** An image (PNG, JPEG, GIF, WebP, AVIF) stored in object storage (requires the storage plugin). */
+export const image = (o = {}) => field("image", o);
+/** A read-only value derived from other fields, stored and kept up to date by Forge. */
+export const computed = (o) => field("computed", o);
+//# sourceMappingURL=fields.js.map

package/dist/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","sourceRoot":"","sources":["../src/fields.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAuIH,SAAS,KAAK,CAAkD,IAAO,EAAE,OAAU;IACjF,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAC7C,CAAC;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,IAAwB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;AACzE,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,IAAwB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AACrE,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,IAAwB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;AAC7E,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,IAAwB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AACvE,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,IAAwB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;AACnE,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,IAAwB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AACvE,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,IAAwB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AACvE,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAwB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;AAC3E,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAyB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;AAC5E,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,IAAuB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AACtE,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAwB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;AACjF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAyB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;AAC5E,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,IAAsB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AACnE,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,IAAsB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;AAC3E,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,IAAsB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AACnE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAmB,CAAsB,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAC1F,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAuB,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;AAC1E,sDAAsD;AACtD,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,IAAsB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;AAC3E,+EAA+E;AAC/E,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,IAAsB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AACnE,oGAAoG;AACpG,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,IAAsB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AACrE,wFAAwF;AACxF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAuB,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./fields.js";
+export * from "./app.js";
+export * from "./plugin.js";
+export * from "./dashboard.js";

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from "./fields.js";
+export * from "./app.js";
+export * from "./plugin.js";
+export * from "./dashboard.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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"}

package/dist/plugin.d.ts

@@ -0,0 +1,64 @@
+import type { EntityDefinition } from "./app.js";
+/** A container added to docker-compose.yml by a plugin (Compose service syntax). */
+export interface PluginDockerService {
+    image: string;
+    command?: string | string[];
+    environment?: Record<string, string>;
+    ports?: string[];
+    volumes?: string[];
+    healthcheck?: {
+        test: string[];
+        interval?: string;
+        timeout?: string;
+        retries?: number;
+    };
+}
+export interface PluginEnvVar {
+    name: string;
+    description: string;
+    /** Value written to .env for local development. */
+    default?: string;
+    /** Value inside docker-compose (service names instead of localhost). */
+    docker?: string;
+    required?: boolean;
+    secret?: boolean;
+}
+/**
+ * What a plugin contributes. Plugin packages export a factory returning this from their root
+ * (kept tiny so forge.config.ts loads fast); runtime code lives in the package's ./api, ./worker and ./web exports.
+ */
+export interface PluginDefinition {
+    readonly __forge: "plugin";
+    /** Unique name, e.g. "storage". */
+    name: string;
+    /** npm package providing the runtime, e.g. "@tekki-forge/plugin-storage". */
+    package: string;
+    version?: string;
+    /** JSON-serializable options, passed to the runtime. */
+    options?: Record<string, unknown>;
+    /** Other plugins this one needs, e.g. webhooks → ["jobs"]. */
+    requires?: readonly string[];
+    /** Entities added to the schema. */
+    entities?: Record<string, EntityDefinition>;
+    /** URL segments under /api the plugin serves (so no entity can use them). */
+    reservedPaths?: readonly string[];
+    /** Which runtime entry points the package exports. */
+    runtime?: {
+        api?: boolean;
+        worker?: boolean;
+        web?: boolean;
+    };
+    env?: readonly PluginEnvVar[];
+    docker?: {
+        services?: Record<string, PluginDockerService>;
+        volumes?: readonly string[];
+    };
+    /** Navigation entries in the admin UI. `admin: true` shows them to admins only. */
+    nav?: readonly {
+        label: string;
+        path: string;
+        icon?: string;
+        admin?: boolean;
+    }[];
+}
+export declare function definePlugin(definition: Omit<PluginDefinition, "__forge">): PluginDefinition;

package/dist/plugin.js

@@ -0,0 +1,4 @@
+export function definePlugin(definition) {
+    return { __forge: "plugin", ...definition };
+}
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAkDA,MAAM,UAAU,YAAY,CAAC,UAA6C;IACxE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,UAAU,EAAE,CAAC;AAC9C,CAAC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@tekki-forge/core",
+  "version": "0.1.0",
+  "description": "Forge schema DSL: defineApp, entity and field builders",
+  "keywords": [
+    "code-generator",
+    "forge",
+    "full-stack",
+    "tekki-forge"
+  ],
+  "author": "Mahy KANE",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {},
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}