@makehq/forman-schema 1.3.3 → 1.4.0

package/dist/index.cjs

@@ -90,6 +90,7 @@ var FORMAN_TYPE_MAP = {
   udt: "number",
   array: "array",
   collection: "object",
+  dynamicCollection: "object",
   text: "string",
   number: "number",
   boolean: "boolean",
@@ -154,6 +155,7 @@ function toJSONSchemaInternal(field, context = createDefaultContext()) {
   };
   switch (normalizedField.type) {
     case "collection":
+    case "dynamicCollection":
       return handleCollectionType(normalizedField, result, context);
     case "array":
       return handleArrayType(normalizedField, result, context);
@@ -245,6 +247,7 @@ function handleArrayType(field, result, context) {
 function handleSelectType(field, result, context) {
   const optionsOrGroups = isObject(field.options) ? field.options.store : field.options;
   const nested = isObject(field.options) ? isObject(field.options.nested) ? field.options.nested.store : field.options.nested : void 0;
+  const nestedContainsStrings = Array.isArray(nested) && nested.some((item) => typeof item === "string");
   const domain = isObject(field.options) ? isObject(field.options.nested) && field.options.nested.domain ? field.options.nested.domain : void 0 : void 0;
   if (typeof optionsOrGroups === "string") {
     Object.defineProperty(result, "x-fetch", {
@@ -266,12 +269,33 @@ function handleSelectType(field, result, context) {
     })) {
       result.oneOf = (options || []).map((option) => {
         const localNested = (isObject(option.nested) ? option.nested.store : option.nested) || nested;
+        const localNestedContainsStrings = Array.isArray(localNested) && localNested.some((item) => typeof item === "string");
         const localDomain = (isObject(option.nested) && option.nested.domain ? option.nested.domain : domain) || context.domain;
         if (localNested) {
           context.addConditionalFields(
             field.name,
             option.value,
-            typeof localNested === "string" ? appendQueryString(localNested, localDomain, [...context.tail, field.name]) : toJSONSchemaInternal(
+            typeof localNested === "string" ? appendQueryString(localNested, localDomain, [...context.tail, field.name]) : localNestedContainsStrings ? {
+              type: "object",
+              allOf: localNested.map(
+                (item) => typeof item === "string" ? {
+                  $ref: appendQueryString(item, localDomain, [
+                    ...context.tail,
+                    field.name
+                  ])
+                } : toJSONSchemaInternal(
+                  {
+                    type: "collection",
+                    spec: [item]
+                  },
+                  {
+                    ...context,
+                    domain: localDomain,
+                    tail: [...context.tail, field.name]
+                  }
+                )
+              )
+            } : toJSONSchemaInternal(
               { type: "collection", spec: localNested },
               {
                 ...context,
@@ -291,7 +315,7 @@ function handleSelectType(field, result, context) {
     }
   }
   if (nested && domain && domain !== context.domain) {
-    if (typeof nested === "string") {
+    if (typeof nested === "string" || nestedContainsStrings) {
       throw new SchemaConversionError("Dynamic nested fields with domain change are not supported.");
     }
     let root = context.roots[domain];
@@ -310,7 +334,19 @@ function handleSelectType(field, result, context) {
       configurable: true,
       enumerable: true,
       writable: true,
-      value: typeof nested === "string" ? { $ref: appendQueryString(nested, context.domain, [...context.tail, field.name]) } : toJSONSchemaInternal(
+      value: typeof nested === "string" ? { $ref: appendQueryString(nested, context.domain, [...context.tail, field.name]) } : nestedContainsStrings ? {
+        type: "object",
+        allOf: nested.map(
+          (item) => typeof item === "string" ? { $ref: appendQueryString(item, context.domain, [...context.tail, field.name]) } : toJSONSchemaInternal(
+            { type: "collection", spec: [item] },
+            {
+              ...context,
+              domain: domain || context.domain,
+              tail: [...context.tail, field.name]
+            }
+          )
+        )
+      } : toJSONSchemaInternal(
         { type: "collection", spec: nested },
         {
           ...context,
@@ -727,21 +763,32 @@ async function handleNestedFields(nested, value, field, context) {
     tail: field.name ? [...context.tail, { name: field.name, value }] : context.tail
   };
   if (typeof store === "string") {
-    try {
-      store = await context.resolveRemote(store, context);
-    } catch (error) {
-      return {
-        valid: false,
-        errors: [
-          ...errors,
-          {
-            domain: context.domain,
-            path: context.path.join("."),
-            message: `Failed to resolve remote resource ${store}: ${error}`
-          }
-        ]
-      };
+    store = [store];
+  }
+  if (Array.isArray(store) && store.some((item) => typeof item === "string")) {
+    const resolvedStore = [];
+    for (const item of store) {
+      if (typeof item === "string") {
+        try {
+          resolvedStore.push(...await context.resolveRemote(item, context));
+        } catch (error) {
+          return {
+            valid: false,
+            errors: [
+              ...errors,
+              {
+                domain: context.domain,
+                path: context.path.join("."),
+                message: `Failed to resolve remote resource ${item}: ${error}`
+              }
+            ]
+          };
+        }
+      } else {
+        resolvedStore.push(item);
+      }
     }
+    store = resolvedStore;
   }
   if (store && domain && domain !== context.domain) {
     if (!context.roots[domain]) {
@@ -845,12 +892,19 @@ var JSON_PRIMITIVE_TYPE_MAP = {
 function toFormanSchema(field) {
   switch (field.type) {
     case "object":
-      const spec = field.properties ? Object.entries(field.properties).filter(([name, property]) => !!property).map(([name, property]) => {
+      if (!field.properties || !Object.entries(field.properties).length) {
+        return {
+          type: "dynamicCollection",
+          label: noEmpty(field.title),
+          help: noEmpty(field.description)
+        };
+      }
+      const spec = Object.entries(field.properties).filter(([name, property]) => !!property).map(([name, property]) => {
         const subField = toFormanSchema(property);
         subField.name = name;
         subField.required = field.required?.includes(name) || false;
         return subField;
-      }) : [];
+      });
       return {
         type: "collection",
         label: noEmpty(field.title),

package/dist/index.d.cts

@@ -138,7 +138,7 @@ type FormanSchemaExtendedOptions = {
 /**
  * Nested fields
  */
-type FormanSchemaNested = FormanSchemaField[] | string | FormanSchemaExtendedNested;
+type FormanSchemaNested = (FormanSchemaField | string)[] | string | FormanSchemaExtendedNested;
 /**
  * Extended nested fields
  */

package/dist/index.d.ts

@@ -138,7 +138,7 @@ type FormanSchemaExtendedOptions = {
 /**
  * Nested fields
  */
-type FormanSchemaNested = FormanSchemaField[] | string | FormanSchemaExtendedNested;
+type FormanSchemaNested = (FormanSchemaField | string)[] | string | FormanSchemaExtendedNested;
 /**
  * Extended nested fields
  */

package/dist/index.js

@@ -61,6 +61,7 @@ var FORMAN_TYPE_MAP = {
   udt: "number",
   array: "array",
   collection: "object",
+  dynamicCollection: "object",
   text: "string",
   number: "number",
   boolean: "boolean",
@@ -125,6 +126,7 @@ function toJSONSchemaInternal(field, context = createDefaultContext()) {
   };
   switch (normalizedField.type) {
     case "collection":
+    case "dynamicCollection":
       return handleCollectionType(normalizedField, result, context);
     case "array":
       return handleArrayType(normalizedField, result, context);
@@ -216,6 +218,7 @@ function handleArrayType(field, result, context) {
 function handleSelectType(field, result, context) {
   const optionsOrGroups = isObject(field.options) ? field.options.store : field.options;
   const nested = isObject(field.options) ? isObject(field.options.nested) ? field.options.nested.store : field.options.nested : void 0;
+  const nestedContainsStrings = Array.isArray(nested) && nested.some((item) => typeof item === "string");
   const domain = isObject(field.options) ? isObject(field.options.nested) && field.options.nested.domain ? field.options.nested.domain : void 0 : void 0;
   if (typeof optionsOrGroups === "string") {
     Object.defineProperty(result, "x-fetch", {
@@ -237,12 +240,33 @@ function handleSelectType(field, result, context) {
     })) {
       result.oneOf = (options || []).map((option) => {
         const localNested = (isObject(option.nested) ? option.nested.store : option.nested) || nested;
+        const localNestedContainsStrings = Array.isArray(localNested) && localNested.some((item) => typeof item === "string");
         const localDomain = (isObject(option.nested) && option.nested.domain ? option.nested.domain : domain) || context.domain;
         if (localNested) {
           context.addConditionalFields(
             field.name,
             option.value,
-            typeof localNested === "string" ? appendQueryString(localNested, localDomain, [...context.tail, field.name]) : toJSONSchemaInternal(
+            typeof localNested === "string" ? appendQueryString(localNested, localDomain, [...context.tail, field.name]) : localNestedContainsStrings ? {
+              type: "object",
+              allOf: localNested.map(
+                (item) => typeof item === "string" ? {
+                  $ref: appendQueryString(item, localDomain, [
+                    ...context.tail,
+                    field.name
+                  ])
+                } : toJSONSchemaInternal(
+                  {
+                    type: "collection",
+                    spec: [item]
+                  },
+                  {
+                    ...context,
+                    domain: localDomain,
+                    tail: [...context.tail, field.name]
+                  }
+                )
+              )
+            } : toJSONSchemaInternal(
               { type: "collection", spec: localNested },
               {
                 ...context,
@@ -262,7 +286,7 @@ function handleSelectType(field, result, context) {
     }
   }
   if (nested && domain && domain !== context.domain) {
-    if (typeof nested === "string") {
+    if (typeof nested === "string" || nestedContainsStrings) {
       throw new SchemaConversionError("Dynamic nested fields with domain change are not supported.");
     }
     let root = context.roots[domain];
@@ -281,7 +305,19 @@ function handleSelectType(field, result, context) {
       configurable: true,
       enumerable: true,
       writable: true,
-      value: typeof nested === "string" ? { $ref: appendQueryString(nested, context.domain, [...context.tail, field.name]) } : toJSONSchemaInternal(
+      value: typeof nested === "string" ? { $ref: appendQueryString(nested, context.domain, [...context.tail, field.name]) } : nestedContainsStrings ? {
+        type: "object",
+        allOf: nested.map(
+          (item) => typeof item === "string" ? { $ref: appendQueryString(item, context.domain, [...context.tail, field.name]) } : toJSONSchemaInternal(
+            { type: "collection", spec: [item] },
+            {
+              ...context,
+              domain: domain || context.domain,
+              tail: [...context.tail, field.name]
+            }
+          )
+        )
+      } : toJSONSchemaInternal(
         { type: "collection", spec: nested },
         {
           ...context,
@@ -698,21 +734,32 @@ async function handleNestedFields(nested, value, field, context) {
     tail: field.name ? [...context.tail, { name: field.name, value }] : context.tail
   };
   if (typeof store === "string") {
-    try {
-      store = await context.resolveRemote(store, context);
-    } catch (error) {
-      return {
-        valid: false,
-        errors: [
-          ...errors,
-          {
-            domain: context.domain,
-            path: context.path.join("."),
-            message: `Failed to resolve remote resource ${store}: ${error}`
-          }
-        ]
-      };
+    store = [store];
+  }
+  if (Array.isArray(store) && store.some((item) => typeof item === "string")) {
+    const resolvedStore = [];
+    for (const item of store) {
+      if (typeof item === "string") {
+        try {
+          resolvedStore.push(...await context.resolveRemote(item, context));
+        } catch (error) {
+          return {
+            valid: false,
+            errors: [
+              ...errors,
+              {
+                domain: context.domain,
+                path: context.path.join("."),
+                message: `Failed to resolve remote resource ${item}: ${error}`
+              }
+            ]
+          };
+        }
+      } else {
+        resolvedStore.push(item);
+      }
     }
+    store = resolvedStore;
   }
   if (store && domain && domain !== context.domain) {
     if (!context.roots[domain]) {
@@ -816,12 +863,19 @@ var JSON_PRIMITIVE_TYPE_MAP = {
 function toFormanSchema(field) {
   switch (field.type) {
     case "object":
-      const spec = field.properties ? Object.entries(field.properties).filter(([name, property]) => !!property).map(([name, property]) => {
+      if (!field.properties || !Object.entries(field.properties).length) {
+        return {
+          type: "dynamicCollection",
+          label: noEmpty(field.title),
+          help: noEmpty(field.description)
+        };
+      }
+      const spec = Object.entries(field.properties).filter(([name, property]) => !!property).map(([name, property]) => {
         const subField = toFormanSchema(property);
         subField.name = name;
         subField.required = field.required?.includes(name) || false;
         return subField;
-      }) : [];
+      });
       return {
         type: "collection",
         label: noEmpty(field.title),

package/package.json

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