I18n

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
+  "changelog": false,
+  "commit": false,
+  "fixed": [],
+  "linked": [["@valbuild/*"]],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": ["example-*"]
+}

.eslintignore

@@ -0,0 +1,6 @@
+examples/next*
+trials
+
+dist
+out
+tsconfig.tsbuildinfo

.eslintrc.js

@@ -0,0 +1,27 @@
+/**
+ * @type {import("eslint").Linter.Config}
+ */
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:react/jsx-runtime",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: "latest",
+    sourceType: "module",
+  },
+  plugins: ["react", "@typescript-eslint"],
+  settings: {
+    react: {
+      version: "detect",
+    },
+  },
+};

.github/workflows/check.yml

@@ -0,0 +1,83 @@
+name: Check
+on: push
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          cache: npm
+      - run: npm ci
+      - run: npm run lint
+  format:
+    name: Check format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          cache: npm
+      - run: npm ci
+      - run: npm run format
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          cache: npm
+      - run: npm ci
+      - run: npm run build
+      - run: npx jest packages/server/src/readValFile.test.ts
+  build-next:
+    name: Build Next.js example
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          cache: npm
+      - run: npm ci
+      - run: npm run build
+        working-directory: examples/next
+  typecheck:
+    name: Typecheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          cache: npm
+      - run: npm ci
+      - run: npm run -ws typecheck
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          cache: npm
+      - run: npm ci
+      - run: npm test

.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          cache: npm
+      - run: npm ci
+      - uses: changesets/action@v1
+        with:
+          publish: npm run release
+          version: npm run version-packages
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -2,3 +2,6 @@ node_modules/
 .next
 dist
 tsconfig.tsbuildinfo
+.envrc
+.tmp
+.DS_Store

.npmignore

@@ -0,0 +1 @@
+tsconfig.tsbuildinfo

.nvmrc

@@ -0,0 +1 @@
+v22.9.0

.prettierignore

@@ -0,0 +1,17 @@
+# next.js
+examples/next*/.next/
+examples/next*/out/
+
+# production
+examples/next*/build
+
+trials
+
+dist
+tsconfig.tsbuildinfo
+
+packages/ui/server/.tmp
+out
+
+.tmp
+examples/next*/.val/*

.prettierrc.json

@@ -0,0 +1 @@
+{}

.vscode/settings.json

@@ -8,5 +8,7 @@
     "**/.DS_Store": true,
     "**/Thumbs.db": true,
     "**/node_modules": true
-  }
-}
+  },
+  "cSpell.words": ["flexsearch", "hotspot", "remirror", "retryable", "stega"],
+  "typescript.preferences.importModuleSpecifier": "relative"
+}

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2025 Fredrik Ekholdt and Blank AS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1 +1,149 @@
-# Val
+<p align="center">
+  <p align="center">
+    <a href="https://val.build">
+<svg width="100" height="100" viewBox="0 0 944 944" fill="none" xmlns="http://www.w3.org/2000/svg">
+<circle cx="472" cy="472" r="472" fill="#1D1C28"/>
+<g filter="url(#filter0_d_14_601)">
+<path d="M181 348C181 345.791 182.791 344 185 344H320C322.209 344 324 345.791 324 348V602C324 604.209 322.209 606 320 606H185C182.791 606 181 604.209 181 602V348Z" fill="#38CD80"/>
+</g>
+<g filter="url(#filter1_i_14_601)">
+<circle cx="252" cy="550" r="24" fill="#1E1F2A"/>
+</g>
+<path d="M659.085 550.374H658.585H654.427C652.095 550.374 650.434 549.729 649.347 548.522C648.25 547.306 647.658 545.431 647.658 542.807V439.857C647.658 437.924 646.091 436.357 644.158 436.357H629.16C627.227 436.357 625.66 437.924 625.66 439.857V455.828C625.66 456.658 624.986 457.332 624.155 457.332C623.593 457.332 623.072 457.015 622.798 456.508C618.502 448.559 612.704 442.661 605.399 438.838C597.962 434.671 589.622 432.592 580.394 432.592C571.897 432.592 563.846 434.128 556.247 437.2C548.643 440.274 541.944 444.796 536.154 450.761L536.153 450.761C530.537 456.552 526.106 463.693 522.854 472.174C519.598 480.668 517.975 490.411 517.975 501.395V505.697C517.975 516.86 519.597 526.693 522.854 535.187C526.105 543.667 530.535 550.895 536.148 556.864L536.153 556.869L536.159 556.875C541.95 562.659 548.647 567.088 556.246 570.161L556.256 570.165C563.856 573.057 572.083 574.5 580.932 574.5C589.456 574.5 597.527 572.325 605.137 567.982C612.625 563.807 618.519 557.469 622.822 548.992C623.085 548.475 623.609 548.147 624.176 548.147H624.546C625.161 548.147 625.66 548.646 625.66 549.261C625.66 555.468 627.583 560.617 631.452 564.665L631.451 564.665L631.46 564.673C635.511 568.72 640.668 570.735 646.889 570.735H658.585H659.085H661.157H661.657H760C761.933 570.735 763.5 569.168 763.5 567.235V553.874C763.5 551.941 761.933 550.374 760 550.374H733.542C732.161 550.374 731.042 549.255 731.042 547.874V385C731.042 383.067 729.475 381.5 727.542 381.5H680.701C678.768 381.5 677.201 383.067 677.201 385V398.361C677.201 400.294 678.768 401.861 680.701 401.861H706.543C707.924 401.861 709.043 402.981 709.043 404.361V547.874C709.043 549.255 707.924 550.374 706.543 550.374H661.657H661.157H659.085ZM600.117 550.146L600.111 550.149C594.977 552.448 589.304 553.601 583.086 553.601C570.468 553.601 560.194 549.435 552.222 541.12C544.436 532.633 540.512 520.847 540.512 505.697V501.395C540.512 494.274 541.581 487.79 543.712 481.936L543.714 481.931C545.849 475.89 548.778 470.842 552.495 466.775C556.398 462.521 560.92 459.246 566.061 456.944C571.195 454.645 576.867 453.492 583.086 453.492C589.117 453.492 594.696 454.731 599.829 457.207L599.838 457.211L599.848 457.215C605.166 459.517 609.681 462.79 613.4 467.035L613.4 467.035L613.408 467.044C617.306 471.292 620.324 476.431 622.458 482.469L622.459 482.474C624.59 488.328 625.66 494.812 625.66 501.933V505.16C625.66 512.46 624.59 519.125 622.458 525.159C620.324 531.022 617.393 536.075 613.669 540.326C609.95 544.571 605.435 547.844 600.117 550.146ZM464.902 570.735C466.39 570.735 467.716 569.794 468.206 568.389L512.685 441.011C513.479 438.736 511.79 436.357 509.38 436.357H491.006C489.496 436.357 488.157 437.325 487.683 438.758L447.951 558.864C447.716 559.575 447.051 560.055 446.303 560.055C445.554 560.055 444.89 559.575 444.655 558.864L404.923 438.758C404.449 437.325 403.109 436.357 401.6 436.357H383.225C380.815 436.357 379.126 438.736 379.921 441.011L424.399 568.389C424.89 569.794 426.215 570.735 427.704 570.735H464.902Z" fill="white" stroke="white"/>
+<defs>
+<filter id="filter0_d_14_601" x="127.464" y="290.464" width="250.072" height="369.072" filterUnits="userSpaceOnUse" color-interpolation-filters="sRGB">
+<feFlood flood-opacity="0" result="BackgroundImageFix"/>
+<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/>
+<feOffset/>
+<feGaussianBlur stdDeviation="26.768"/>
+<feComposite in2="hardAlpha" operator="out"/>
+<feColorMatrix type="matrix" values="0 0 0 0 0.219608 0 0 0 0 0.803922 0 0 0 0 0.501961 0 0 0 0.3 0"/>
+<feBlend mode="normal" in2="BackgroundImageFix" result="effect1_dropShadow_14_601"/>
+<feBlend mode="normal" in="SourceGraphic" in2="effect1_dropShadow_14_601" result="shape"/>
+</filter>
+<filter id="filter1_i_14_601" x="228" y="526" width="48" height="48" filterUnits="userSpaceOnUse" color-interpolation-filters="sRGB">
+<feFlood flood-opacity="0" result="BackgroundImageFix"/>
+<feBlend mode="normal" in="SourceGraphic" in2="BackgroundImageFix" result="shape"/>
+<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/>
+<feOffset/>
+<feGaussianBlur stdDeviation="6"/>
+<feComposite in2="hardAlpha" operator="arithmetic" k2="-1" k3="1"/>
+<feColorMatrix type="matrix" values="0 0 0 0 0.219608 0 0 0 0 0.803922 0 0 0 0 0.501961 0 0 0 0.3 0"/>
+<feBlend mode="normal" in2="shape" result="effect1_innerShadow_14_601"/>
+</filter>
+</defs>
+</svg>
+    </a>
+    <br/>
+  </p>
+</p>
+
+# 🐉 HERE BE DRAGONS 🐉
+
+Val is currently in beta - the API can be considered relatively stable, but expect some features to be broken and the UX to be changing.
+
+Join us on [discord](https://discord.gg/cZzqPvaX8k) to get help or give us feedback.
+
+## Table of contents
+
+- [Installation](./packages/next/README.md#Installation)
+- [Introduction](#content-as-code)
+- [Examples](#examples)
+- [Documentation](#documentation)
+
+## Content as code
+
+Val is a CMS library where **content** is **TypeScript** / **JavaScript** files stored in your git repo.
+
+As a CMS, Val is useful because:
+
+- editors can **change content** without having to ask developers to do it for them (and nobody wants that)
+- a **well-documented** way to **structure content**
+- **image**, **richtext**, ... support is built-in
+- built-in **visual editing** which lets editors click-then-edit content (and therefore **code**!) directly in your app
+  ![Visual editing](https://val.build/docs/images/visual-editing.png)
+- an embedded studio which lets editors navigate the content structure and make updates there
+  ![Studio](https://val.build/docs/images/studio.png)
+
+<details>
+<summary>Definition: editor</summary>
+An editor in this context, is a non-technical person that edits content in your application (technical writer, proof-reader, legal, ...).
+</details>
+
+<br />
+
+But, with the benefits of **hard-coded** content:
+
+- works seamlessly **locally** or with git **branches**
+- content is **type-checked** so you can spend less time on figuring out why something isn't working
+  ![Type check error](https://val.build/docs/images/type-check-error.png)
+- content can be refactored (change names, etc) just as if it was hard-coded (because it is)
+  ![Renaming](https://val.build/docs/images/renaming.gif)
+- works as normal with your **favorite IDE** without any plugins: search for content, references to usages, ...
+  ![References](https://val.build/docs/images/references.gif)
+- **no** need for **code-gen** and extra build steps
+- **fast** since the content is literally hosted with the application
+- content is **always there** and can never fail (since it is not loaded from somewhere)
+- no need to worry about **caching** since content is not fetched from some DB or cloud service
+- no need to manage different **environments** with different versions of content
+- works out of the box with Vercel **preview links**
+- **resolve conflicts** like you normally resolve conflicts: **in git**
+
+Compared to other CMSs, Val has the following advantages:
+
+- **easy** to _grok_: Val is designed to have a minimum of boilerplate and there's **0** query languages to learn
+- Vals abstraction model is based on **JSON** and TypeScript (Record, keyof). What this means is that there is nothing to learn (for you or your future colleagues): no "a collection is..." or a "a document is sort of a..." - just JSON and regular TypeScript types
+- **no signup** required to use it locally
+- **no fees** for content that is in your code: your content is your code, and your code is... yours
+- **minimal** API surface: Val is designed to not "infect" your code base
+- **easy to remove**: since your content is already in your code and Val is designed to have a minimal surface, it's easy to remove if you want to switch
+- eslint rules and [VS Code extension](https://marketplace.visualstudio.com/items?itemName=valbuild.vscode-val-build) for an even **better-than-hard-coded** developer experience
+
+<details>
+<summary>Upcoming feature: <strong>i18n</strong></summary>
+Val will soon have support for i18n. Follow this repository to get notified when this is the case.
+</details>
+
+<details>
+<summary>Upcoming feature: <strong>remote content</strong></summary>
+Having hard-coded content is great for landing pages, product pages and other pages where the amount of content is manageable.
+
+However, checking in the 10 000th blog entry in git might feel wrong (though we would say it is ok).
+
+Therefore, Val will add `remote content` support which enables you to seamlessly move content to the cloud and back again as desired.
+You code will still be the one truth, but the actual content will be hosted on [val.build](https://val.build).
+
+`.remote()` support will also make it possible to have remote images to avoid having to put them in your repository.
+
+There will also be specific support for remote i18n, which will make it possible to split which languages are defined in code, and which are fetched from remote.
+
+More details on `.remote()` will follow later.
+
+</details>
+
+## When to NOT use Val
+
+Val is designed to work well on a single web-app, and currently only supports Next 14+ (more meta-frameworks will supported) and GitHub (more Git providers will follow).
+
+Unless your application fits these requirements, you should have a look elsewhere (at least for now).
+
+In addition, if you have a "content model", i.e. content schemas, that rarely change and you plan on using them in a lot of different applications (web, mobile, etc), Val will most likely not be a great fit.
+
+If that is the case, we recommend having a look at [Sanity](https://sanity.io) instead (we have no affiliation, but if we didn't have Val we would use Sanity).
+
+**NOTE**: Our experience is that, however nice it sounds, it is hard to "nail" the content model down. Usually content (on, for example, your landing page) is derived from what you want to present, not vice-versa. In addition, you should think carefully whether you _really_ want to present the exact same content on all these different surfaces.
+
+<details>
+  <summary>Upcoming feature: <strong>external content</strong></summary>
+Val will support external content, i.e. content from other Val projects, CMSs or DBs some time in the future.
+</details>
+
+## Examples
+
+Examples can found [here](./examples).
+
+## Documentation
+
+Val currently only support Next.js.
+
+To get started using Next.js, checkout the [README](./packages/next/README.md).

babel.config.js

@@ -1,3 +1,5 @@
+/** @type {import("@babel/core").TransformOptions} */
 module.exports = {
   presets: ["@babel/preset-env", "@babel/preset-typescript"],
+  babelrcRoots: [".", "./packages/*"],
 };

examples/next/.eslintrc.json

@@ -1,3 +1,3 @@
 {
-  "extends": "next/core-web-vitals"
+  "extends": ["next/core-web-vitals", "plugin:@valbuild/recommended"]
 }

examples/next/.gitignore

@@ -34,3 +34,6 @@ yarn-error.log*
 # typescript
 *.tsbuildinfo
 next-env.d.ts
+
+# Val
+.val

examples/next/.nvmrc

@@ -0,0 +1 @@
+../../.nvmrc