Merge pull request #93 from elek-io/add-field-definition-forms

Add all field definition forms for field types but dynamic

Author: Nils-Kolvenbach

.changeset/curvy-zod-aligns.md

@@ -0,0 +1,5 @@
+---
+'@elek-io/client': patch
+---
+
+Adopt @elek-io/core 0.20.0 and align on a single zod 4.4.3. Core now declares zod as a peer dependency and re-exports z, so the app supplies the shared zod copy. This dedupes zod to one physical version and clears the zodResolver type errors.

.changeset/fair-forms-regroup.md

@@ -0,0 +1,5 @@
+---
+'@elek-io/client': patch
+---
+
+Render field-definition groups and finish adapting the dynamic form system to @elek-io/core 0.20.0. Groups in a Collection's fieldDefinitions are shown as labeled fieldsets in the Entry form and Collection editor, field definitions are flattened where grouping is irrelevant, and a Project's commit history now comes from a dedicated projects.history query instead of the Project read. Form typing was reworked to infer react-hook-form types from the generated Zod schemas.

.gitattributes

@@ -0,0 +1,5 @@
+# Check out all text files with LF line endings on every platform.
+# Prettier enforces LF, and without this the default autocrlf setting on
+# Windows (including the GitHub Windows runners) converts files to CRLF at
+# checkout, failing the lint and format checks there.
+* text=auto eol=lf

.github/workflows/cd.yml

@@ -4,37 +4,35 @@ on:
   push:
     branches:
       - main
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+permissions:
+  contents: write # Required for pushing commits via changesets action
+  pull-requests: write # Required for creating release PRs via changesets action
 
 jobs:
-  release:
-    name: Preparing new release on ${{ matrix.platform }} with Node.js ${{ matrix.node-version }}
-    timeout-minutes: 20
-    strategy:
-      matrix:
-        # @see https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#standard-github-hosted-runners-for-public-repositories
-        # macos-13 = intel
-        # macos-14+ = M1 (arm)
-        platform: [ubuntu-24.04, macos-13, macos-15, windows-2025]
-        node-version: [22]
-    runs-on: ${{ matrix.platform }}
+  changesets:
+    name: Create or update release pull request
+    timeout-minutes: 15
+    runs-on: ubuntu-24.04
+    outputs:
+      hasChangesets: ${{ steps.changesets.outputs.hasChangesets }}
     steps:
       - name: Check out code
         uses: actions/checkout@v4
         with:
           fetch-depth: 1
       - name: Install pnpm
         uses: pnpm/action-setup@v4
-        with:
-          version: 10
-      - name: Setup Node.js ${{ matrix.node-version }} environment
+      - name: Setup Node.js environment
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version-file: '.node-version'
           cache: 'pnpm'
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
-      - name: Run linter
-        run: pnpm run lint
+      - name: Run lint, check types and formatting
+        run: pnpm run lint && pnpm run check-types && pnpm run check-format
       - name: Create or update pull request
         id: changesets
         uses: changesets/action@v1
@@ -43,8 +41,34 @@ jobs:
           commit: Release new version
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Publish
-        if: steps.changesets.outputs.hasChangesets == 'false'
-        run: pnpm run build
+
+  release:
+    name: Releasing on ${{ matrix.platform }}
+    needs: changesets
+    # Only build once the release pull request has been merged
+    if: needs.changesets.outputs.hasChangesets == 'false'
+    timeout-minutes: 20
+    strategy:
+      fail-fast: false
+      matrix:
+        # Mirrors the platforms and Node.js version @elek-io/core tests on
+        platform: [ubuntu-24.04, macos-15-intel, macos-15, windows-2025]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.node-version'
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+      - name: Build and upload to a draft GitHub Release
+        run: pnpm run build --publish always
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci.yml

@@ -5,16 +5,13 @@ on:
 
 jobs:
   test:
-    name: Testing on ${{ matrix.platform }} with Node.js ${{ matrix.node-version }}
+    name: Testing on ${{ matrix.platform }}
     timeout-minutes: 20
     strategy:
       fail-fast: false
       matrix:
-        # @see https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#standard-github-hosted-runners-for-public-repositories
-        # macos-13 = intel
-        # macos-14+ = M1 (arm)
-        platform: [ubuntu-24.04, macos-13, macos-15, windows-2025]
-        node-version: [22]
+        # Mirrors the platforms and Node.js version @elek-io/core tests on
+        platform: [ubuntu-24.04, macos-15-intel, macos-15, windows-2025]
     runs-on: ${{ matrix.platform }}
     steps:
       - name: Check out code
@@ -23,19 +20,15 @@ jobs:
           fetch-depth: 1
       - name: Install pnpm
         uses: pnpm/action-setup@v4
-        with:
-          version: 10
-      - name: Setup Node.js ${{ matrix.node-version }} environment
+      - name: Setup Node.js environment
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version-file: '.node-version'
           cache: 'pnpm'
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
-      - name: Run linter
-        run: pnpm run lint
-      # - name: Run typecheck
-      #   run: pnpm run check-types
+      - name: Run lint, check types and formatting
+        run: pnpm run lint && pnpm run check-types && pnpm run check-format
       # - name: Identify misconfigurations and security anti-patterns
       #   uses: doyensec/electronegativity-action@v2
       # - name: Upload report

.node-version

@@ -0,0 +1 @@
+24

AGENTS.md

@@ -0,0 +1,43 @@
+# AGENTS.md
+
+Guidance for AI agents and contributors working on `@elek-io/client`.
+
+`@elek-io/core` handles file IO and git version control for elek.io Projects, a headless, git-backed CMS. It is published as a TypeScript library with Node, Browser, Astro and CLI entry points.
+
+`@elek-io/client` uses `@elek-io/core` and provides a UI on top of that business logic, packaged with Electron as a cross-platform desktop application.
+
+## Documentation
+
+Documentation is split by what you are working on:
+
+- [`contributing/`](./contributing/) - contributor and design docs for the client: the Electron process architecture, the IPC security model, TanStack Query data loading, and the dynamic form system. Start at [`contributing/README.md`](./contributing/README.md). The client ships as a packaged desktop app, not an npm package, so these docs are never shipped and may link anywhere.
+- **Core's behavior** is documented inside the `@elek-io/core` package itself. After `pnpm install`, read it under [`node_modules/@elek-io/core/docs/`](./node_modules/@elek-io/core/docs/index.md) (content export, the local API, API client generation, fields, storage layout, and more). This is the reference for anything the client delegates to Core.
+- To **contribute to Core** itself, use the [`@elek-io/core` repository](https://github.com/elek-io/core). Core's own contributor docs are not part of its published package, so they live only there.
+
+Two rules follow:
+
+- **Read before you change.** Before working on an area, read its doc first so you change behavior on purpose, not by guesswork. For client behavior that is the matching doc in `contributing/`; for behavior that comes from Core, read Core's docs in the package.
+- **Write after you change.** When you change client behavior a user or contributor should know about, update the matching doc in `contributing/` in the same change. Changes to Core itself do not belong in this repo - make them in the separate [`@elek-io/core`](https://github.com/elek-io/core) repository and document them there.
+
+## Commands
+
+- `pnpm install` - install dependencies (use pnpm, not npm)
+- `pnpm dev` - start the app in development with HMR (electron-vite)
+- `pnpm start` - preview the built app (electron-vite preview)
+- `pnpm build` - clean, build and package for the current platform (electron-vite then electron-builder)
+- `pnpm build:unpack` - build without packaging, faster for local testing
+- `pnpm build:win` / `pnpm build:mac` / `pnpm build:linux` - package for a specific platform
+- `pnpm check-types` - type-check both processes with tsc, no emit (`check-types:node` and `check-types:web` cover one process each)
+- `pnpm lint` - run eslint
+- `pnpm format` - format with prettier
+
+## Conventions
+
+- Prefer a library's built-in feature over hand-rolled code.
+- Avoid type casts. Shape the types so a cast is not needed.
+- Keep comments short and put deeper detail in the docs. Avoid em-dashes and semicolons, use simple sentences for readability.
+
+## Testing notes
+
+- The client has no automated test runner configured yet, so there are no existing tests to follow. Until one is set up, verify a change by running the app with `pnpm dev` telling the user to exercise the affected flows, and make sure `pnpm check-types` and `pnpm lint` pass before considering it done.
+- All Core file and git operations run in the main process and are reached from the renderer only through `window.ipc`. Exercise them through the running app, not in isolation.

CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

README.md

@@ -2,9 +2,7 @@
 
 > A modern, offline-first content management system (CMS) and digital asset manager (DAM).
 
-[![Version](https://img.shields.io/badge/version-0.3.2-blue.svg)](https://github.com/elek-io/client/releases)
 [![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey.svg)](https://github.com/elek-io/client)
-[![License](https://img.shields.io/badge/license-todo-red.svg)](LICENSE)
 
 > [!IMPORTANT]  
 > elek.io Client is under active development and not yet ready for production usage! Feel free to check it out and make suggestions.
@@ -21,7 +19,7 @@ elek.io Client solves these problems by being an offline-first desktop applicati
 - **Cross-Platform**: Desktop apps for Windows, macOS, and Linux
 - **Version Control**: Every Project is a Git repository with full version history
 - **Easy backups & collaboration (optional)**: Synchronize to any Git hosting service (GitHub, GitLab, Bitbucket etc.) to work together with others and have a backup if needed
-- **Multi-Language**: Built-in support for 25 languages
+- **Multi-Language**: Built-in support for 24 languages
 - **Structured Content**: Define custom content types (Collections) with field definitions
 - **Developer-Friendly**: Local read-only OpenAPI REST API with optional typesafe TS/JS API Client generation and JSON file exports for programmatic access to your content e.g. to use with static site generators
 
@@ -33,11 +31,11 @@ Download the latest version for your platform:
 
 - **Windows**: [Download installer](https://github.com/elek-io/client/releases)
 - **macOS**: [Download DMG](https://github.com/elek-io/client/releases)
-- **Linux**: Download [AppImage](https://github.com/elek-io/client/releases) / [Snap](https://snapcraft.io/) / [DEB](https://github.com/elek-io/client/releases)
+- **Linux**: Download [AppImage](https://github.com/elek-io/client/releases) / [Snap](https://github.com/elek-io/client/releases) / [DEB](https://github.com/elek-io/client/releases)
 
 ### System Requirements
 
-Altough elek.io Client might run on older hard and software than listed below, the following is the recommended minimum:
+Although elek.io Client might run on older hard and software than listed below, the following is the recommended minimum:
 
 - **Windows**: Windows 10 or later
 - **macOS**: macOS 13.7.6 (Ventura) or later
@@ -47,4 +45,4 @@ Altough elek.io Client might run on older hard and software than listed below, t
 
 ## For Developers
 
-For insight on how elek.io Client works, please refer to the [documentation folder](documentation/overview.md).
+For insight on how elek.io Client works, please refer to the [contributing folder](contributing/README.md).

documentation/README.md contributing/README.mddocumentation/README.md renamed to contributing/README.md

@@ -3,7 +3,7 @@
 Welcome to the elek.io Client developer documentation. This guide will help you understand the codebase architecture and development patterns.
 
 > [!NOTE]
-> If your main interest is using Projects content inside your own applications, you can skip to the [Consuming Content Locally](./consuming-content-locally.md) section.
+> This folder documents how to **contribute to** elek.io Client. If instead you want to consume your Projects' content inside your own applications, see the [@elek-io/core documentation](https://github.com/elek-io/core). Core ships its full guides (content export, local API, API client generation) both in its repository and in the package's `docs` folder.
 
 ## Prerequisites
 
@@ -18,9 +18,16 @@ Welcome to the elek.io Client developer documentation. This guide will help you
 
 Then proceed to the specific topics based on your interests or contribution goals:
 
+- **[Routing](./renderer/routing.md)** - File-based routing, layout routes, hash history, and why data is fetched in components rather than route guards
 - **[Loading and Updating Data](./renderer/loading-and-updating-data.md)** - TanStack Query patterns for data fetching and mutations
-- **[Dynamic Form Generation](./renderer/dynamic-form-field-generation.md)** - How user-defined forms work with field definitions
+- **[Dynamic Form Field Generation](./renderer/dynamic-form-field-generation.md)** - How user-defined forms work with field definitions
+- **[Markdown Editor](./renderer/markdown-editor.md)** - The Milkdown based mdast editor for markdown fields: the tree bridge, feature gating, and reference nodes
 - **[Breadcrumb Navigation](./renderer/breadcrumb-navigation.md)** - Route-based breadcrumb system for hierarchical navigation
+- **[Theming and Styling](./renderer/theming-and-styling.md)** - shadcn/ui components, Tailwind v4 CSS configuration, and dark mode
+- **[Internationalization](./renderer/internationalization.md)** - translations, datetime locales, and multi-language form state
+- **[Releasing](./releasing.md)** - versioning with changesets and how CD publishes draft GitHub Releases
+
+For a running list of things Core supports but the client cannot use yet, see **[Not Yet Implemented](./not-yet-implemented.md)**. Add to it whenever you find such a gap.
 
 ## Contributing
 
@@ -29,7 +36,6 @@ When updating these docs:
 - Keep code examples up-to-date with actual implementation
 - Include file references with line numbers where relevant
 - Add practical examples for complex concepts
-- Update the "Last Updated" date at the bottom of each document
 
 ## Additional Resources
 
@@ -38,7 +44,3 @@ When updating these docs:
 - [React Hook Form Documentation](https://react-hook-form.com/get-started)
 - [shadcn/ui Documentation](https://ui.shadcn.com/docs)
 - [@elek-io/core Repository](https://github.com/elek-io/core)
-
----
-
-**Last Updated:** 2025-12-04