@remoteoss/json-schema-form 0.11.11-dev.20250220174843 → 1.0.0-beta.0

package/.nvmrc

@@ -0,0 +1 @@
+22.13.1

package/.vscode/settings.json

@@ -0,0 +1,51 @@
+{
+  // Disable the default formatter, use eslint instead
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+
+  // Auto fix
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "never"
+  },
+
+  // Silent the stylistic rules in you IDE, but still auto fix them
+  "eslint.rules.customizations": [
+    { "rule": "style/*", "severity": "off", "fixable": true },
+    { "rule": "format/*", "severity": "off", "fixable": true },
+    { "rule": "*-indent", "severity": "off", "fixable": true },
+    { "rule": "*-spacing", "severity": "off", "fixable": true },
+    { "rule": "*-spaces", "severity": "off", "fixable": true },
+    { "rule": "*-order", "severity": "off", "fixable": true },
+    { "rule": "*-dangle", "severity": "off", "fixable": true },
+    { "rule": "*-newline", "severity": "off", "fixable": true },
+    { "rule": "*quotes", "severity": "off", "fixable": true },
+    { "rule": "*semi", "severity": "off", "fixable": true }
+  ],
+
+  // Enable eslint for all supported languages
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "vue",
+    "html",
+    "markdown",
+    "json",
+    "json5",
+    "jsonc",
+    "yaml",
+    "toml",
+    "xml",
+    "gql",
+    "graphql",
+    "astro",
+    "svelte",
+    "css",
+    "less",
+    "scss",
+    "pcss",
+    "postcss"
+  ]
+}

package/README.md

@@ -1,36 +1,41 @@
-<p align="center">
-<img src=".github/media/jsf_logo_dark.png"  width="600" alt="json-schema-form">
-</p>
+# Next
 
-<p align="center">
-  <code>json-schema-form</code> is a headless UI form library powered by <a href="https://json-schema.org/">JSON Schemas</a>. 
-<br/>
-  It transforms JSON schemas into Javascript to be consumed by your UI libraries.
-</p>
+The current version (0.x) has some critical validation bugs
+([examples](https://github.com/remoteoss/json-schema-form/pull/107)).
+To fix them, we need to re-write the library internals.
+This `next/` folder is where the rewriting is happening
+(now in TypeScript, yey!).
 
----
+We expect the main `createHeadlessForm()` API to remain the same,
+avoiding any major breaking change.
+This is under active development, more info soon!
 
-### Why JSON Schemas for forms?
+## Development
 
-JSON Schemas are the SSoT (Single Source of Truth) that allows you to share form's _structure_ and _validations_ between frontend and backend, regardless of the language used.
+Ensure that you isolate your workspace to the "next" folder only.
+This means:
 
-## Installation
+1. In your editor, open only the "next" folder.
+1. In your terminal, run commands when you are in the "next" folder only.
 
-Available on [NPM](https://www.npmjs.com/package/@remoteoss/json-schema-form).
+Otherwise, your editor may fail to set up linting and type checking,
+while your terminal may fail to resolve paths.
 
-```bash
-npm install @remoteoss/json-schema-form
-# or
-
-yarn install @remoteoss/json-schema-form
-```
+The limitation of this approach is that
+your editor will fail to recognise our git repository here.
+This also means you should turn off the editor's suggestion
+to open git repository at root.
 
-## Documentation
+## Node.js Version
 
-Check the 📚 **[JSF website](https://json-schema-form.vercel.app/)** for documentation and demos.
+This project requires Node.js LTS v22.13.1.
+We recommend using the exact version specified in `.nvmrc`:
 
-## Contributing
+Navigate to the "next" folder and run:
 
-Read [CONTRIBUTING](CONTRIBUTING.md) to get started.
+```bash
+nvm use
+```
 
-_Backed by [Remote.com](https://remote.com/)_
+Without the correct Node.js version,
+tests and other development tasks will likely fail.

package/babel.config.mjs

@@ -0,0 +1,14 @@
+/**
+ * @type {import('@babel/core').TransformOptions}
+ */
+const options = {
+  presets: [
+    ['@babel/preset-env', { targets: { node: 'current' } }],
+    // Type checking is already done in our build,
+    // so we can use a lightweight preset.
+    // - https://jestjs.io/docs/getting-started#using-typescript
+    '@babel/preset-typescript',
+  ],
+}
+
+export default options

package/eslint.config.mjs

@@ -0,0 +1,3 @@
+import antfu from '@antfu/eslint-config'
+
+export default antfu({})

package/jest.config.mjs

@@ -0,0 +1,52 @@
+/**
+ * This next version of JSON Schema Form ("V2")
+ * must be tested against 2 sets ("root") of tests.
+ * Note that "rootDir" is the path to this next version.
+ *
+ * @type {import('jest').Config['roots']}
+ */
+const roots = [
+  // 1. The existing tests from the previous version ("V1")
+  '<rootDir>/../src/tests',
+  // 2. The new tests for this version
+  '<rootDir>/test',
+]
+
+/**
+ * Module aliases to use the same test with different source versions.
+ * To learn more, see "roots" above.
+ *
+ * This is only needed to use V1 tests for V2 source.
+ * as V2 tests are used to test V2 source only.
+ *
+ * @type {import('jest').Config['moduleNameMapper']}
+ */
+const moduleNameMapper = {
+  // We use kebab-case in V2
+  '^@/createHeadlessForm$': '<rootDir>/src/form',
+  '^@/utils$': '<rootDir>/src/utils',
+  // Avoid catch all aliases such as "^@/(.*)$".
+  // Aliases should be added as needed.
+  // If there are many, we will have a compat barrel file.
+}
+
+/**
+ * Some tests are invalid for V2 testing.
+ * For example:
+ * - Buggy behaviours in V1 that are already fixed (and tested) in V2
+ * - Deprecated or removed APIs
+ *
+ * @type {import('jest').Config['testPathIgnorePatterns']}
+ */
+const testPathIgnorePatterns = [
+  // Nothing yet
+]
+
+/** @type {import('jest').Config} */
+const config = {
+  roots,
+  moduleNameMapper,
+  testPathIgnorePatterns,
+}
+
+export default config

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@remoteoss/json-schema-form",
-  "version": "0.11.11-dev.20250220174843",
-  "description": "Headless UI form powered by JSON Schemas",
+  "version": "1.0.0-beta.0",
+  "packageManager": "pnpm@9.15.2",
+  "description": "WIP V2 – Headless UI form powered by JSON Schemas",
   "author": "Remote.com <engineering@remote.com> (https://remote.com/)",
   "license": "MIT",
   "homepage": "https://json-schema-form.vercel.app/",
@@ -9,80 +10,35 @@
     "type": "git",
     "url": "https://github.com/remoteoss/json-schema-form.git"
   },
-  "main": "dist/index.cjs",
-  "module": "dist/index.js",
-  "typings": "./json-schema-form.d.ts",
-  "files": [
-    "dist",
-    "src/tests",
-    "json-schema-form.schema.json",
-    "json-schema-form.d.ts",
-    "README.md",
-    "CHANGELOG.md",
-    "LICENSE.md"
+  "keywords": [
+    "JSON",
+    "schema",
+    "json-schema",
+    "form"
   ],
+  "main": "index.js",
+  "engines": {
+    "node": ">=18.14.0"
+  },
   "scripts": {
-    "build": "node scripts/build.js",
+    "build": "tsup",
     "test": "jest",
     "test:watch": "jest --watchAll",
-    "lint": "eslint \"src/**/*.{js,ts}\"",
-    "format": "npm run format:prettier && npm run format:eslint",
-    "prepare": "husky install",
-    "format:eslint": "eslint --fix \"src/**/*.{js,ts}\"",
-    "format:prettier": "prettier --write \"src/**/*.{js,ts}\"",
-    "prettier:check": "prettier --check \"src/**/*.{js,ts}\"",
-    "check:pr-version": "node scripts/pr_dev_version",
-    "check:pr-next-version": "node scripts/pr_next_dev_version",
-    "release:local": "node scripts/release_local",
-    "release:dev:patch": "node scripts/release_dev patch",
-    "release:dev:minor": "node scripts/release_dev minor",
-    "release:main:patch": "node scripts/release_main patch",
-    "release:main:minor": "node scripts/release_main minor",
-    "release:v1:dev": "node scripts/release_v1 dev",
-    "release:v1:beta": "node scripts/release_v1 beta",
-    "version_as_main": "node scripts/version_as_main.js",
-    "psrepublishOnly": "if [[ ! $PWD =~ scripts$ ]]; then npm run publish:nopublish; fi",
-    "psublish:nopublish": "echo 'Use `npm release:*` script instead && exit 1"
-  },
-  "lint-staged": {
-    "*.{js,jsx}": [
-      "npm run format"
-    ]
-  },
-  "dependencies": {
-    "json-logic-js": "^2.0.2",
-    "lodash": "^4.17.21",
-    "randexp": "^0.5.3",
-    "yup": "^0.30.0"
+    "test:file": "jest --runTestsByPath",
+    "lint": "eslint --max-warnings 0 .",
+    "release:dev": "cd .. && npm run release:v1:dev",
+    "release:beta": "cd .. && npm run release:v1:beta"
   },
   "devDependencies": {
-    "@babel/core": "^7.21.5",
-    "@babel/eslint-parser": "^7.25.9",
-    "@babel/preset-env": "^7.21.5",
-    "babel-jest": "^29.5.0",
-    "babel-plugin-module-resolver": "^5.0.2",
-    "child-process-promise": "^2.2.1",
-    "esbuild": "^0.17.15",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.6.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-sort-keys": "^2.3.5",
-    "eslint-plugin-unused-imports": "^1.1.5",
-    "fs-extra": "^11.1.1",
-    "generate-changelog": "^1.8.0",
-    "husky": "^8.0.3",
-    "jest": "^29.5.0",
-    "jest-environment-jsdom": "^29.5.0",
-    "lint-staged": "^13.2.2",
-    "semver": "^7.5.1"
-  },
-  "keywords": [
-    "json schemas",
-    "form"
-  ],
-  "engines": {
-    "node": ">=18.14.0"
+    "@antfu/eslint-config": "^3.14.0",
+    "@babel/core": "^7.23.7",
+    "@babel/preset-env": "^7.23.7",
+    "@babel/preset-typescript": "^7.26.0",
+    "@jest/globals": "^29.7.0",
+    "babel-jest": "^29.7.0",
+    "eslint": "^9.18.0",
+    "jest": "^29.7.0",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.3"
   }
 }

package/src/form.ts

@@ -0,0 +1,3 @@
+export function createHeadlessForm(): never {
+  throw new Error('Not implemented')
+}

package/src/index.ts

@@ -0,0 +1 @@
+export { createHeadlessForm } from './form'

package/src/utils.ts

@@ -0,0 +1,24 @@
+type DiskSizeUnit = 'Bytes' | 'KB' | 'MB'
+
+/**
+ * @todo: Remove this.
+ *
+ * This utility only exists as an example of using V1 tests for V2 source.
+ * It should not be tested, or even part of JSON Schema Form.
+ */
+export function convertDiskSizeFromTo(
+  from: DiskSizeUnit,
+  to: DiskSizeUnit,
+): (value: number) => number {
+  const multipliers: Record<DiskSizeUnit, number> = {
+    Bytes: 1,
+    KB: 1024,
+    MB: 1024 * 1024,
+  }
+
+  return (value: number): number => {
+    const fromMultiplier = multipliers[from]
+    const toMultiplier = multipliers[to]
+    return (value * fromMultiplier) / toMultiplier
+  }
+}

package/test/form.test.ts

@@ -0,0 +1,11 @@
+import { describe, expect, it } from '@jest/globals'
+import { createHeadlessForm } from '../src'
+
+/**
+ * Example test suite for V2
+ */
+describe('createHeadlessForm', () => {
+  it('should be a function', () => {
+    expect(createHeadlessForm).toBeInstanceOf(Function)
+  })
+})

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true
+  },
+  "include": [
+    "src"
+  ]
+}

package/tsup.config.json

@@ -0,0 +1,10 @@
+{
+  "clean": true,
+  "dts": true,
+  "entry": ["src/index.ts"],
+  "format": ["esm"],
+  "sourcemap": true,
+  "minify": true,
+  "target": "es2020",
+  "outDir": "dist"
+}