@remoteoss/json-schema-form 1.0.0-beta.2 → 1.0.0-dev.20250124133204

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/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,6 +1,6 @@
 {
   "name": "@remoteoss/json-schema-form",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-dev.20250124133204",
   "packageManager": "pnpm@9.15.2",
   "description": "WIP V2 – Headless UI form powered by JSON Schemas",
   "author": "Remote.com <engineering@remote.com> (https://remote.com/)",
@@ -16,12 +16,7 @@
     "json-schema",
     "form"
   ],
-  "main": "dist/index.mjs",
-  "module": "dist/index.mjs",
-  "files": [
-    "README.md",
-    "dist"
-  ],
+  "main": "index.js",
   "engines": {
     "node": ">=18.14.0"
   },

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"
+}

package/dist/index.d.mts

@@ -1,3 +0,0 @@
-declare function createHeadlessForm(): never;
-
-export { createHeadlessForm };

package/dist/index.mjs

@@ -1,2 +0,0 @@
-function e(){throw new Error("Not implemented")}export{e as createHeadlessForm};
-//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/form.ts"],"sourcesContent":["export function createHeadlessForm(): never {\n  throw new Error('Not implemented')\n}\n"],"mappings":"AAAO,SAASA,GAA4B,CAC1C,MAAM,IAAI,MAAM,iBAAiB,CACnC","names":["createHeadlessForm"]}