@declarion/react 0.1.0

package/dist-lib/types/schema.d.ts

@@ -0,0 +1,380 @@
+export type LocalizedString = Record<string, string>;
+export declare function loc(ls: LocalizedString | undefined, lang?: string): string;
+export declare function fieldDisplayName(field: EntityField, fieldName: string, entities?: Record<string, Entity>): string;
+export interface RefDisplay {
+    field: string;
+}
+export interface RefConfig {
+    entity: string;
+    field?: string;
+    display?: RefDisplay;
+    fields?: string[];
+}
+export interface UnitConfig {
+    storage: string;
+    display?: string;
+}
+export interface EntityField {
+    type: string;
+    required?: boolean;
+    primary?: boolean;
+    auto?: boolean;
+    timezone?: string;
+    precision?: number;
+    scale?: number;
+    unit?: UnitConfig;
+    default?: unknown;
+    display?: {
+        name: LocalizedString;
+        width?: number;
+        widget?: string;
+        is_listable?: boolean;
+        is_filterable?: boolean;
+        ref_display_field?: string;
+        span?: number | "full";
+    };
+    values?: Array<{
+        code: string;
+        name: LocalizedString;
+        description?: LocalizedString;
+        color?: string;
+    }>;
+    enum?: string;
+    ref?: RefConfig;
+    structure?: string;
+    array?: boolean;
+}
+export interface StructureDef {
+    name: LocalizedString;
+    description?: LocalizedString;
+    fields: Record<string, EntityField>;
+    field_order: string[];
+}
+export type ChildDisplayMode = "table" | "timeline" | "list" | "cards";
+export interface TimelineConfig {
+    type_field?: string;
+    time_field?: string;
+    summary_field?: string;
+    content_field?: string;
+    author_field?: string;
+    scroll?: boolean;
+    auto_scroll?: "none" | "bottom" | "top";
+}
+export interface CardsConfig {
+    columns_count?: number;
+    header_field?: string;
+    badge_field?: string;
+}
+export interface ChildQuickAdd {
+    fields: string[];
+    defaults?: Record<string, unknown>;
+    placeholder?: LocalizedString;
+}
+export interface ChildDisplay {
+    name: LocalizedString;
+    icon?: string;
+    mode?: ChildDisplayMode;
+    columns?: string[];
+    sort?: string;
+    limit?: number;
+    timeline?: TimelineConfig;
+    cards?: CardsConfig;
+    editable?: boolean;
+    searchable?: boolean;
+    filters?: string[];
+    position_field?: string;
+}
+export interface ChildRelation {
+    entity: string;
+    foreign_key: string | string[];
+    display?: ChildDisplay;
+    quick_add?: ChildQuickAdd;
+}
+export interface StatusDef {
+    code: string;
+    name: LocalizedString;
+    description?: LocalizedString;
+    color?: string;
+    is_final?: boolean;
+}
+export interface StatusGroupDef {
+    name: LocalizedString;
+    description?: LocalizedString;
+    is_main?: boolean;
+    initial: string;
+    statuses: StatusDef[];
+    transitions?: Record<string, string[]>;
+}
+export interface PropertyDef {
+    name: LocalizedString;
+    description?: LocalizedString;
+    type: string;
+    display?: EntityField["display"];
+    values?: EntityField["values"];
+    enum?: string;
+    ref?: RefConfig;
+    structure?: string;
+    readonly?: boolean;
+}
+export declare function propertyToField(prop: PropertyDef): EntityField;
+export interface EnumDef {
+    name: LocalizedString;
+    description?: LocalizedString;
+    values: Array<{
+        code: string;
+        name: LocalizedString;
+        description?: LocalizedString;
+        color?: string;
+    }>;
+}
+export interface ParameterDef {
+    name: LocalizedString;
+    description?: LocalizedString;
+    type: string;
+    default?: unknown;
+    is_public?: boolean;
+    category?: string;
+}
+export interface AssociationDisplay {
+    name?: LocalizedString;
+    icon?: string;
+}
+export interface AssociationDef {
+    target: string;
+    display?: AssociationDisplay;
+    source: string;
+    code: string;
+}
+export interface Entity {
+    table: string;
+    primary_key?: string[];
+    virtual?: boolean;
+    readonly?: boolean;
+    default_timezone?: string;
+    display: {
+        name: LocalizedString;
+        name_plural: LocalizedString;
+        description?: LocalizedString;
+        icon: string;
+        display_field?: string;
+    };
+    fields: Record<string, EntityField>;
+    field_order: string[];
+    soft_delete?: string;
+    tenant_key?: string;
+    children?: ChildRelation[];
+    status_groups?: Record<string, StatusGroupDef>;
+    properties?: Record<string, PropertyDef>;
+    search_fields?: string[];
+    actions?: Record<string, Action>;
+    handlers?: Record<string, HandlerDef>;
+    associations?: Record<string, AssociationDef>;
+}
+export declare function getPrimaryKeyFields(entity: Entity): string[];
+export type PkValues = Record<string, string>;
+export declare function extractPkValues(entity: Entity, record: Record<string, unknown>): PkValues;
+export declare function pkValuesToId(pkValues: PkValues): string;
+export declare function isCompositePk(entity: Entity): boolean;
+export type SizeValue = string;
+export interface SectionNode {
+    name: LocalizedString;
+    items: LayoutNode[];
+    collapsed?: boolean;
+    columns?: number;
+}
+export interface RowConfig {
+    items: LayoutNode[];
+    gap?: number;
+    resizable?: boolean;
+    stack_below?: number | "never";
+    width?: SizeValue;
+    height?: SizeValue;
+}
+export interface ColumnConfig {
+    items: LayoutNode[];
+    gap?: number;
+    width?: SizeValue;
+    height?: SizeValue;
+}
+export interface TabsConfig {
+    items: LayoutNode[];
+}
+export interface LayoutNode {
+    row?: RowConfig;
+    column?: ColumnConfig;
+    tabs?: TabsConfig;
+    section?: SectionNode;
+    children?: string;
+    associated?: string;
+    properties?: true | string[];
+    statuses?: true | string[];
+    fields?: string[];
+    width?: SizeValue;
+    height?: SizeValue;
+    min_width?: string;
+    max_width?: string;
+    label?: LocalizedString;
+    icon?: string;
+    mode?: ChildDisplayMode;
+    columns?: string[];
+    sort?: string;
+    limit?: number;
+    quick_add?: ChildQuickAdd;
+    timeline?: TimelineConfig;
+    cards?: CardsConfig;
+    editable?: boolean;
+    searchable?: boolean;
+    filters?: string[];
+    position_field?: string;
+}
+export interface Screen {
+    type: "list" | "detail" | "custom" | "record_list";
+    entity?: string;
+    route: string;
+    component?: string;
+    display?: {
+        name: LocalizedString;
+        icon: string;
+    };
+    columns?: string[];
+    default_columns?: string[];
+    filters?: string[];
+    default_filters?: string[];
+    search_fields?: string[];
+    sort_default?: string;
+    actions?: string[];
+    row_actions?: string[];
+    items?: LayoutNode[];
+    sidebar?: LayoutNode[];
+    sidebar_width?: string;
+    self?: boolean;
+    list_width?: string;
+    list_resizable?: boolean;
+    fixed_filters?: Record<string, unknown>;
+    views?: ViewDefinition[];
+}
+/** System view (preset) defined in screen YAML. Read-only. */
+export interface ViewDefinition {
+    code: string;
+    name: LocalizedString;
+    icon?: string;
+    filters?: Array<{
+        field: string;
+        op: string;
+        value?: unknown;
+    }>;
+    columns?: string[];
+    sort?: string;
+}
+export interface NavNode {
+    screen?: string;
+    name?: LocalizedString;
+    icon?: string;
+    items?: NavNode[];
+}
+export interface HandlerParamDisplay {
+    name?: LocalizedString;
+    description?: LocalizedString;
+    widget?: string;
+}
+export interface HandlerParam {
+    type?: string;
+    required?: boolean;
+    default?: unknown;
+    hidden?: boolean;
+    enum?: string;
+    values?: Array<{
+        code: string;
+        name: LocalizedString;
+        description?: LocalizedString;
+        color?: string;
+    }>;
+    ref?: string;
+    display?: HandlerParamDisplay;
+}
+export interface ActionCondition {
+    status?: string[];
+    field?: string;
+    op?: string;
+    value?: unknown;
+}
+export interface Action {
+    handler?: string;
+    type?: string;
+    association?: string;
+    scope?: string;
+    batch_mode?: string;
+    entity?: string;
+    display: {
+        name: LocalizedString;
+        icon: string;
+    };
+    visibility?: string[];
+    confirmation?: LocalizedString;
+    conditions?: ActionCondition[];
+    resolved_params?: Record<string, HandlerParam>;
+    resolved_param_order?: string[];
+}
+export interface LanguageDef {
+    code: string;
+    name: LocalizedString;
+}
+export interface HandlerDef {
+    code: string;
+    type: string;
+    entity?: string;
+    display?: {
+        name?: LocalizedString;
+        icon?: string;
+    };
+    params?: Record<string, HandlerParam>;
+    param_order?: string[];
+    success_event?: string;
+}
+export interface Branding {
+    app_name?: string;
+    app_logo?: string;
+    app_initial?: string;
+    accent_color?: string;
+}
+export interface ThemeDef {
+    extends?: string;
+    background?: string;
+    foreground?: string;
+    card?: string;
+    card_foreground?: string;
+    popover?: string;
+    popover_foreground?: string;
+    primary?: string;
+    primary_foreground?: string;
+    secondary?: string;
+    secondary_foreground?: string;
+    muted?: string;
+    muted_foreground?: string;
+    accent?: string;
+    accent_foreground?: string;
+    destructive?: string;
+    destructive_foreground?: string;
+    border?: string;
+    input?: string;
+    ring?: string;
+    sidebar?: string;
+    sidebar_foreground?: string;
+    sidebar_border?: string;
+    sidebar_accent?: string;
+    sidebar_muted?: string;
+    radius?: string;
+}
+export interface Schema {
+    languages: LanguageDef[];
+    structures: Record<string, StructureDef>;
+    entities: Record<string, Entity>;
+    screens: Record<string, Screen>;
+    navigation: NavNode[];
+    actions: Record<string, Action>;
+    handlers?: Record<string, HandlerDef>;
+    enums: Record<string, EnumDef>;
+    parameters: Record<string, ParameterDef>;
+    branding?: Branding;
+    themes?: Record<string, ThemeDef>;
+}

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@declarion/react",
+  "version": "0.1.0",
+  "private": false,
+  "license": "MIT",
+  "description": "React SDK for Declarion, the schema-driven business apps platform.",
+  "homepage": "https://declarion.io",
+  "type": "module",
+  "main": "./dist-lib/index.js",
+  "module": "./dist-lib/index.js",
+  "types": "./dist-lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist-lib/index.d.ts",
+      "import": "./dist-lib/index.js",
+      "default": "./dist-lib/index.js"
+    },
+    "./styles.css": "./dist-lib/declarion-react.css"
+  },
+  "files": [
+    "dist-lib",
+    "LICENSE",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "dependencies": {
+    "@dnd-kit/core": "^6.3.1",
+    "@dnd-kit/sortable": "^10.0.0",
+    "@dnd-kit/utilities": "^3.2.2",
+    "@radix-ui/react-alert-dialog": "^1.1.0",
+    "@radix-ui/react-dialog": "^1.1.0",
+    "@radix-ui/react-dropdown-menu": "^2.1.0",
+    "@radix-ui/react-label": "^2.1.0",
+    "@radix-ui/react-select": "^2.1.0",
+    "@radix-ui/react-separator": "^1.1.0",
+    "@radix-ui/react-slot": "^1.1.0",
+    "@tanstack/react-query": "^5.62.0",
+    "@tanstack/react-table": "^8.20.0",
+    "@tanstack/react-virtual": "^3.11.0",
+    "class-variance-authority": "^0.7.0",
+    "clsx": "^2.1.0",
+    "lucide-react": "^0.468.0",
+    "react-markdown": "^10.1.0",
+    "react-router-dom": "^6.28.0",
+    "recharts": "^2.15.0",
+    "remark-breaks": "^4.0.0",
+    "sonner": "^1.7.0",
+    "tailwind-merge": "^2.6.0",
+    "vanilla-jsoneditor": "^3.11.0",
+    "zustand": "^5.0.0"
+  },
+  "devDependencies": {
+    "@tailwindcss/typography": "^0.5.19",
+    "@tailwindcss/vite": "^4.0.0",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "@vitejs/plugin-react": "^4.3.0",
+    "jsdom": "^29.0.1",
+    "msw": "^2.12.14",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "tailwindcss": "^4.0.0",
+    "typescript": "^5.7.0",
+    "vite": "^6.0.0",
+    "vitest": "^4.1.0"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc --noEmit && vite build",
+    "build:lib": "vite build --config vite.lib.config.ts && tsc -p tsconfig.lib.json",
+    "lint": "tsc --noEmit",
+    "test": "vitest run",
+    "preview": "vite preview"
+  }
+}