@reformer/renderer-json 8.0.0 → 9.0.0-beta.2

package/README.md

@@ -0,0 +1,87 @@
+# @reformer/renderer-json
+
+Render [`@reformer/core`](https://www.npmjs.com/package/@reformer/core) forms from a **JSON schema**.
+Field bindings, components and data sources are expressed as string operators
+(`$model(...)`, `$component(...)`, `$dataSource(...)`), so an entire form can be described as data and
+rendered through a component registry — no per-field React code.
+
+## Documentation
+
+Full documentation is available at [https://alexandrbukhtatyy.github.io/ReFormer/](https://alexandrbukhtatyy.github.io/ReFormer/)
+
+## Features
+
+- Describe forms declaratively as JSON (`JsonFormSchema`)
+- String operators bind schema leaves to a reactive `FormModel` and to registered components
+- Component registry (`defineRegistry`) maps operator names to your React components
+- Optional schema validation against a meta-schema (ajv, loaded dynamically — dev only)
+- TypeScript support, tree-shakable exports
+
+## Installation
+
+```bash
+npm install @reformer/renderer-json @reformer/core @reformer/renderer-react
+```
+
+`@reformer/ui-kit` is an optional peer — use it (or your own components) to populate the registry.
+
+## Quick Start
+
+```tsx
+import { useMemo } from 'react';
+import { createModel } from '@reformer/core';
+import { Input, Box, FormField } from '@reformer/ui-kit';
+import {
+  JsonFormRenderer,
+  JsonRendererProvider,
+  defineRegistry,
+  FIELD_WRAPPER,
+  type JsonFormSchema,
+} from '@reformer/renderer-json';
+
+// Bindings are string operators: '$model(...)', '$component(...)', '$dataSource(...)'.
+const schema: JsonFormSchema = {
+  version: '1.0',
+  root: {
+    component: '$component(Box)',
+    children: [
+      {
+        value: '$model(email)',
+        component: '$component(Input)',
+        componentProps: { label: 'Email' },
+      },
+    ],
+  },
+};
+
+type MyForm = { email: string };
+
+export function MyFormPage() {
+  // M1: the model is the source of truth; schema leaves bind to its signals.
+  const model = useMemo(() => createModel<MyForm>({ email: '' }), []);
+  const registry = useMemo(
+    () =>
+      defineRegistry((reg) => {
+        reg.component('Input', Input);
+        reg.component('Box', Box);
+        reg.component(FIELD_WRAPPER, FormField); // system field wrapper
+      }),
+    []
+  );
+
+  // The model is provided through the provider (settings.model), not as a renderer prop.
+  return (
+    <JsonRendererProvider settings={{ registry, model }}>
+      <JsonFormRenderer<MyForm> schema={schema} validate={import.meta.env.DEV} />
+    </JsonRendererProvider>
+  );
+}
+```
+
+`JsonFormRenderer` accepts only `{ schema, renderBehavior?, onSchemaReady?, validate? }`. The
+`FormModel` is supplied via `JsonRendererProvider` settings (`model`); schema leaves are bound to its
+signals by the built-in converter.
+
+## License
+
+MIT

package/dist/converter/json-to-render-schema.test.d.ts

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

package/dist/index-DrpWfdbU.js

@@ -0,0 +1,51 @@
+const s = /^\$(model|component|dataSource|fn|locale)\((.+)\)$/;
+function o(e) {
+  if (typeof e != "string") return null;
+  const t = s.exec(e);
+  return t ? { op: t[1], arg: t[2] } : null;
+}
+const $ = (e) => o(e)?.op === "model", g = (e) => o(e)?.op === "component", b = (e) => o(e)?.op === "dataSource", S = (e) => o(e)?.op === "fn", O = (e) => o(e)?.op === "locale", p = "http://json-schema.org/draft-07/schema#", c = "https://reformer.dev/schemas/form-schema.schema.json", m = "ReFormer JSON form schema (M1, string-operator DSL)", d = "Base meta-schema: validates node structure + operator string syntax ($model/$component/$dataSource). Component-name enum is tightened per-app via buildFormSchemaMetaSchema; $dataSource names and $model paths are checked outside this schema.", l = "object", f = ["root"], u = !1, h = { $schema: { type: "string" }, version: { type: "string" }, root: { $ref: "#/definitions/node" } }, y = { modelOp: { type: "string", pattern: "^\\$model\\(.+\\)$", description: 'Model binding: "$model(path)" — path resolved at runtime (not validated here).' }, componentOp: { type: "string", pattern: "^\\$component\\(.+\\)$", description: 'Registry component: "$component(Name)". Name is tightened to a registry enum by buildFormSchemaMetaSchema.' }, node: { $comment: "Discriminated by which operator key is present (array→value→component), mirroring the isArrayNode/isFieldNode/isContainerNode runtime guards. Using oneOf here made ajv (allErrors) report failures against all three branches for any single mistake, burying the real cause; if/then/else surfaces only the relevant branch's errors.", if: { type: "object", required: ["array"] }, then: { $ref: "#/definitions/arrayNode" }, else: { if: { type: "object", required: ["value"] }, then: { $ref: "#/definitions/fieldNode" }, else: { $ref: "#/definitions/containerNode" } } }, fieldNode: { type: "object", required: ["value"], additionalProperties: !1, properties: { selector: { type: "string" }, value: { $ref: "#/definitions/modelOp" }, component: { $ref: "#/definitions/componentOp" }, componentProps: { type: "object" }, wrapper: { $ref: "#/definitions/node" } } }, arrayNode: { type: "object", required: ["array", "item"], additionalProperties: !1, properties: { selector: { type: "string" }, array: { $ref: "#/definitions/modelOp" }, item: { type: "object", required: ["$template"], additionalProperties: !1, properties: { $template: { $ref: "#/definitions/node" } } }, initialValue: { type: "object" }, componentProps: { type: "object" } } }, containerNode: { type: "object", required: ["component"], additionalProperties: !1, properties: { selector: { type: "string" }, component: { $ref: "#/definitions/componentOp" }, componentProps: { type: "object" }, children: { type: "array", items: { $ref: "#/definitions/node" } } } } }, a = {
+  $schema: p,
+  $id: c,
+  title: m,
+  description: d,
+  type: l,
+  required: f,
+  additionalProperties: u,
+  properties: h,
+  definitions: y
+}, N = a;
+function j(e) {
+  return e.names().filter((t) => e.get(t)?.type === "component");
+}
+function v(e) {
+  return e.names().filter((t) => e.get(t)?.type === "dataSource");
+}
+function P(e) {
+  return e.names().filter((t) => e.get(t)?.type === "fn");
+}
+function q(e) {
+  return e.getLocale?.()?.keys;
+}
+function F(e) {
+  const t = JSON.parse(JSON.stringify(a)), n = e?.componentNames;
+  if (n && n.length > 0) {
+    const r = t.definitions.componentOp;
+    delete r.pattern, r.enum = n.map((i) => `$component(${i})`);
+  }
+  return t;
+}
+export {
+  g as a,
+  b,
+  S as c,
+  O as d,
+  F as e,
+  N as f,
+  j as g,
+  v as h,
+  $ as i,
+  P as j,
+  q as k,
+  o as p
+};

package/dist/index.d.ts

@@ -11,12 +11,19 @@ export { SchemaErrorPanel } from './components/schema-error-panel';
 export type { SchemaErrorPanelProps } from './components/schema-error-panel';
 export type { JsonFormSchema, JsonNode, JsonFieldNode, JsonArrayNode, JsonContainerNode, } from './types/json-schema';
 export { isFieldNode, isArrayNode, isContainerNode } from './types/json-schema';
-export { parseOperator, isModelOp, isComponentOp, isDataSourceOp } from './operators';
-export type { ModelOp, ComponentOp, DataSourceOp, JsonOperator, ParsedOperator } from './operators';
+export { parseOperator, isModelOp, isComponentOp, isDataSourceOp, isFnOp, isLocaleOp, } from './operators';
+export type { ModelOp, ComponentOp, DataSourceOp, FnOp, LocaleOp, JsonOperator, ParsedOperator, } from './operators';
 export { defineRegistry } from './registry/component-registry';
-export { FIELD_WRAPPER } from './registry/constants';
+export { FIELD_WRAPPER, LOCALE_SERVICE } from './registry/constants';
 export type { ComponentRegistry, ComponentMetadata, RegistryBuilder } from './registry/types';
+export { createLocaleResolver, createLocaleService, defaultLocaleResolver, } from './locale/locale-service';
+export type { LocaleResolver, LocaleService, LocaleParams } from './locale/locale-service';
+export { LocaleProvider, useLocale } from './locale/locale-context';
+export type { LocaleProviderProps } from './locale/locale-context';
+export { I18n } from './locale/i18n';
+export type { I18nProps } from './locale/i18n';
+export { useSignalValues, unwrapSignalValues } from './locale/use-signal-value';
 export { JsonRendererProvider, useJsonRendererSettings } from './context/json-renderer-context';
 export type { JsonRendererSettings, JsonRendererProviderProps, } from './context/json-renderer-context';
 export { createRenderSchemaFromJsonM1, convertJsonToM1Tree, } from './converter/json-to-render-schema';
-export { formSchemaMetaSchema, buildFormSchemaMetaSchema, getComponentNames, getDataSourceNames, } from './schema';
+export { formSchemaMetaSchema, buildFormSchemaMetaSchema, getComponentNames, getDataSourceNames, getFnNames, getLocaleKeys, } from './schema';