feat: add support for cross-domain nested fieldsets and new type editor (#21)

Author: patriksimek

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@makehq/forman-schema",
-    "version": "1.6.0",
+    "version": "1.7.0",
     "description": "Forman Schema Tools",
     "license": "MIT",
     "author": "Make",

package.json

@@ -48,15 +48,15 @@ export interface DomainRoot {
      * @param nested The nested fields to add
      * @param tail The tail of parameters in nested selects, required to resolve RPC payloads
      */
-    addFields: (nested: FormanSchemaField[], tail?: string[]) => void;
+    addFields: (nested: (FormanSchemaField | string)[], tail?: string[]) => void;
 }
 
 /**
  * Buffer of fields to be added to a domain before the root has been identified
  */
 export type FormanDomainBuffer = {
     /** Field to add */
-    field: FormanSchemaField;
+    field: FormanSchemaField | string;
     /** Tail of parameters in nested selects, required to resolve RPC payloads */
     tail?: string[];
 };
@@ -92,6 +92,7 @@ const FORMAN_TYPE_MAP: Readonly<Record<string, JSONSchema7['type']>> = {
     collection: 'object',
     dynamicCollection: 'object',
     text: 'string',
+    editor: 'string',
     number: 'number',
     boolean: 'boolean',
     date: 'string',
@@ -228,7 +229,15 @@ function handleCollectionType(field: FormanSchemaField, result: JSONSchema7, con
         required: [],
     });
 
-    function addField(subField: FormanSchemaField, tail?: string[]) {
+    function addField(subField: FormanSchemaField | string, tail?: string[]) {
+        if (typeof subField === 'string') {
+            const value = { $ref: appendQueryString(subField, context.domain, tail || context.tail) };
+
+            result.allOf ||= [];
+            result.allOf.push(value);
+            return;
+        }
+
         if (isVisualType(subField.type)) {
             return;
         }
@@ -275,7 +284,7 @@ function handleCollectionType(field: FormanSchemaField, result: JSONSchema7, con
         const buffer = context.roots[domainRoot]?.buffer;
 
         context.roots[domainRoot] = {
-            addFields: (nested: FormanSchemaField[], tail?: string[]) => {
+            addFields: (nested: (FormanSchemaField | string)[], tail?: string[]) => {
                 nested.forEach(subField => addField(subField, tail));
             },
         };
@@ -483,22 +492,20 @@ function handleSelectType(field: FormanSchemaField, result: JSONSchema7, context
     }
 
     if (nested && domain && domain !== context.domain) {
-        if (typeof nested === 'string' || nestedContainsStrings) {
-            throw new SchemaConversionError('Dynamic nested fields with domain change are not supported.');
-        }
+        const normalizedNested = typeof nested === 'string' ? [nested] : nested;
 
         let root = context.roots[domain];
         if (!root) {
             const buffer: FormanDomainBuffer[] = [];
             root = context.roots[domain] = {
                 buffer,
-                addFields: (nested: FormanSchemaField[], tail?: string[]) => {
+                addFields: (nested: (FormanSchemaField | string)[], tail?: string[]) => {
                     buffer.push(...nested.map(field => ({ field, tail })));
                 },
             };
         }
 
-        root.addFields(nested as FormanSchemaField[], [...context.tail, field.name!]);
+        root.addFields(normalizedNested, [...context.tail, field.name!]);
     } else if (nested) {
         Object.defineProperty(result, 'x-nested', {
             configurable: true,

src/forman.ts

@@ -196,7 +196,7 @@ export type FormanSchemaNested = (FormanSchemaField | string)[] | string | Forma
  */
 export type FormanSchemaExtendedNested = {
     /** Store for the nested fields */
-    store: FormanSchemaField[] | string;
+    store: (FormanSchemaField | string)[] | string;
     /** Domain for the nested fields */
     domain?: string;
 };