@webiny/app-admin 0.0.0-unstable.a4f3e4ea8b → 0.0.0-unstable.a85ef555b2

package/features/formModel/jsonSchema/buildFieldsFromJsonSchema.js

@@ -0,0 +1,154 @@
+import { z } from "zod";
+import { getJsonSchemaKind } from "./getJsonSchemaKind.js";
+import { normalizeJsonSchema } from "./normalizeJsonSchema.js";
+const KINDS_WITHOUT_REQUIRED = [
+    "boolean",
+    "object"
+];
+const isJsonText = (value)=>{
+    if ("" === value.trim()) return true;
+    try {
+        JSON.parse(value);
+        return true;
+    } catch  {
+        return false;
+    }
+};
+const createNumberSchema = (schema)=>{
+    const { minimum, maximum, exclusiveMinimum, exclusiveMaximum } = schema;
+    const hasMinimum = "number" == typeof minimum;
+    const hasMaximum = "number" == typeof maximum;
+    let numberSchema = z.number();
+    let constrained = false;
+    if ("integer" === schema.type) {
+        numberSchema = numberSchema.int("Enter a whole number.");
+        constrained = true;
+    }
+    if (hasMinimum && hasMaximum) {
+        const message = `Enter a number from ${minimum} to ${maximum}.`;
+        numberSchema = numberSchema.min(minimum, message).max(maximum, message);
+        constrained = true;
+    } else if (hasMinimum) {
+        numberSchema = numberSchema.min(minimum, `Enter a number of at least ${minimum}.`);
+        constrained = true;
+    } else if (hasMaximum) {
+        numberSchema = numberSchema.max(maximum, `Enter a number of at most ${maximum}.`);
+        constrained = true;
+    }
+    if ("number" == typeof exclusiveMinimum) {
+        numberSchema = numberSchema.gt(exclusiveMinimum);
+        constrained = true;
+    }
+    if ("number" == typeof exclusiveMaximum) {
+        numberSchema = numberSchema.lt(exclusiveMaximum);
+        constrained = true;
+    }
+    return constrained ? numberSchema : null;
+};
+const createEnumBuilder = (params)=>{
+    const { schema, registry } = params;
+    const values = schema.enum ?? [];
+    if ("string" === schema.type) {
+        const stringOptions = values.map((value)=>({
+                label: String(value),
+                value: String(value)
+            }));
+        return registry.text().options(stringOptions);
+    }
+    const numberOptions = values.map((value)=>({
+            label: String(value),
+            value: Number(value)
+        }));
+    return registry.number().options(numberOptions);
+};
+const createStringBuilder = (params)=>{
+    const { schema, registry, options } = params;
+    const builder = registry.text();
+    const hint = schema.ui;
+    if ("textarea" === hint) return builder.renderer("textarea");
+    if ("string" == typeof hint) {
+        const renderer = options.uiRenderers[hint];
+        if ("string" == typeof renderer) return builder.renderer(renderer);
+    }
+    return builder;
+};
+const createNumberBuilder = (params)=>{
+    const builder = params.registry.number();
+    const numberSchema = createNumberSchema(params.schema);
+    if (numberSchema) builder.schema(numberSchema);
+    return builder;
+};
+const createJsonBuilder = (params)=>{
+    const builder = params.registry.text();
+    builder.renderer("codeEditor", {
+        language: "json"
+    });
+    builder.schema(z.string().refine(isJsonText, "Enter valid JSON."));
+    return builder;
+};
+const createObjectBuilder = (params, isList)=>{
+    const { schema, registry, options } = params;
+    const itemSchema = isList ? normalizeJsonSchema(schema.items) : schema;
+    const builder = registry.object();
+    if (isList) builder.list();
+    return builder.fields((inner)=>buildFieldsFromJsonSchema(itemSchema, inner, options));
+};
+const createBuilder = (kind, params)=>{
+    switch(kind){
+        case "string":
+            return createStringBuilder(params);
+        case "enum":
+            return createEnumBuilder(params);
+        case "number":
+            return createNumberBuilder(params);
+        case "boolean":
+            return params.registry.boolean();
+        case "object":
+            return createObjectBuilder(params, false);
+        case "stringList":
+            return params.registry.text().list().renderer("tags");
+        case "objectList":
+            return createObjectBuilder(params, true);
+        default:
+            return createJsonBuilder(params);
+    }
+};
+const getDefaultValue = (kind, schema)=>{
+    if (void 0 === schema.default || "object" === kind || "objectList" === kind) return;
+    if ("json" === kind) return JSON.stringify(schema.default, null, 2);
+    return schema.default;
+};
+const createField = (params)=>{
+    const { name, schema, isRequired } = params;
+    const kind = getJsonSchemaKind(schema);
+    const label = "string" == typeof schema.title && "" !== schema.title ? schema.title : name;
+    const builder = createBuilder(kind, params);
+    builder.label(label);
+    if ("string" == typeof schema.description && "" !== schema.description) builder.help(schema.description);
+    const defaultValue = getDefaultValue(kind, schema);
+    if (void 0 !== defaultValue) builder.defaultValue(defaultValue);
+    const canBeRequired = !KINDS_WITHOUT_REQUIRED.includes(kind);
+    if (isRequired && void 0 === schema.default && canBeRequired) builder.required(`${label} is required.`);
+    return builder;
+};
+const buildFieldsFromJsonSchema = (schema, registry, options)=>{
+    const fields = {};
+    if ("object" !== getJsonSchemaKind(schema)) return fields;
+    const requiredNames = Array.isArray(schema.required) ? schema.required : [];
+    const properties = schema.properties ?? {};
+    for (const [name, property] of Object.entries(properties)){
+        const propertySchema = normalizeJsonSchema(property);
+        const isRequired = requiredNames.includes(name);
+        fields[name] = createField({
+            name,
+            schema: propertySchema,
+            isRequired,
+            registry,
+            options
+        });
+    }
+    return fields;
+};
+export { buildFieldsFromJsonSchema };
+
+//# sourceMappingURL=buildFieldsFromJsonSchema.js.map

package/features/formModel/jsonSchema/buildFieldsFromJsonSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"features/formModel/jsonSchema/buildFieldsFromJsonSchema.js","sources":["../../../../src/features/formModel/jsonSchema/buildFieldsFromJsonSchema.ts"],"sourcesContent":["import { z } from \"zod\";\nimport type { IFieldBuilder } from \"../abstractions.js\";\nimport type { IFieldBuilderRegistry } from \"../abstractions.js\";\nimport type { JsonSchema } from \"./JsonSchema.js\";\nimport type { JsonSchemaFieldOptions } from \"./JsonSchemaFieldOptions.js\";\nimport type { JsonSchemaKind } from \"./getJsonSchemaKind.js\";\nimport { getJsonSchemaKind } from \"./getJsonSchemaKind.js\";\nimport { normalizeJsonSchema } from \"./normalizeJsonSchema.js\";\n\ninterface PropertyParams {\n    name: string;\n    schema: JsonSchema;\n    isRequired: boolean;\n    registry: IFieldBuilderRegistry;\n    options: JsonSchemaFieldOptions;\n}\n\n// A switch always has a value and a nested object is required through its own properties.\nconst KINDS_WITHOUT_REQUIRED: JsonSchemaKind[] = [\"boolean\", \"object\"];\n\n// Blank text means \"not set\" (`formDataToJsonSchemaValue` leaves it out), so it is valid here.\nconst isJsonText = (value: string): boolean => {\n    if (value.trim() === \"\") {\n        return true;\n    }\n    try {\n        JSON.parse(value);\n        return true;\n    } catch {\n        return false;\n    }\n};\n\nconst createNumberSchema = (schema: JsonSchema): z.ZodTypeAny | null => {\n    const { minimum, maximum, exclusiveMinimum, exclusiveMaximum } = schema;\n    const hasMinimum = typeof minimum === \"number\";\n    const hasMaximum = typeof maximum === \"number\";\n    let numberSchema = z.number();\n    let constrained = false;\n\n    if (schema.type === \"integer\") {\n        numberSchema = numberSchema.int(\"Enter a whole number.\");\n        constrained = true;\n    }\n    if (hasMinimum && hasMaximum) {\n        const message = `Enter a number from ${minimum} to ${maximum}.`;\n        numberSchema = numberSchema.min(minimum, message).max(maximum, message);\n        constrained = true;\n    } else if (hasMinimum) {\n        numberSchema = numberSchema.min(minimum, `Enter a number of at least ${minimum}.`);\n        constrained = true;\n    } else if (hasMaximum) {\n        numberSchema = numberSchema.max(maximum, `Enter a number of at most ${maximum}.`);\n        constrained = true;\n    }\n    if (typeof exclusiveMinimum === \"number\") {\n        numberSchema = numberSchema.gt(exclusiveMinimum);\n        constrained = true;\n    }\n    if (typeof exclusiveMaximum === \"number\") {\n        numberSchema = numberSchema.lt(exclusiveMaximum);\n        constrained = true;\n    }\n    return constrained ? numberSchema : null;\n};\n\nconst createEnumBuilder = (params: PropertyParams): IFieldBuilder => {\n    const { schema, registry } = params;\n    const values = schema.enum ?? [];\n    if (schema.type === \"string\") {\n        const stringOptions = values.map(value => ({ label: String(value), value: String(value) }));\n        return registry.text().options(stringOptions);\n    }\n    const numberOptions = values.map(value => ({ label: String(value), value: Number(value) }));\n    return registry.number().options(numberOptions);\n};\n\nconst createStringBuilder = (params: PropertyParams): IFieldBuilder => {\n    const { schema, registry, options } = params;\n    const builder = registry.text();\n    const hint = schema.ui;\n    if (hint === \"textarea\") {\n        return builder.renderer(\"textarea\");\n    }\n    if (typeof hint === \"string\") {\n        const renderer = options.uiRenderers[hint];\n        if (typeof renderer === \"string\") {\n            return builder.renderer(renderer);\n        }\n    }\n    return builder;\n};\n\nconst createNumberBuilder = (params: PropertyParams): IFieldBuilder => {\n    const builder = params.registry.number();\n    const numberSchema = createNumberSchema(params.schema);\n    if (numberSchema) {\n        builder.schema(numberSchema);\n    }\n    return builder;\n};\n\nconst createJsonBuilder = (params: PropertyParams): IFieldBuilder => {\n    const builder = params.registry.text();\n    builder.renderer(\"codeEditor\", { language: \"json\" });\n    builder.schema(z.string().refine(isJsonText, \"Enter valid JSON.\"));\n    return builder;\n};\n\nconst createObjectBuilder = (params: PropertyParams, isList: boolean): IFieldBuilder => {\n    const { schema, registry, options } = params;\n    const itemSchema = isList ? normalizeJsonSchema(schema.items) : schema;\n    const builder = registry.object();\n    if (isList) {\n        builder.list();\n    }\n    return builder.fields(inner => buildFieldsFromJsonSchema(itemSchema, inner, options));\n};\n\nconst createBuilder = (kind: JsonSchemaKind, params: PropertyParams): IFieldBuilder => {\n    switch (kind) {\n        case \"string\":\n            return createStringBuilder(params);\n        case \"enum\":\n            return createEnumBuilder(params);\n        case \"number\":\n            return createNumberBuilder(params);\n        case \"boolean\":\n            return params.registry.boolean();\n        case \"object\":\n            return createObjectBuilder(params, false);\n        case \"stringList\":\n            return params.registry.text().list().renderer(\"tags\");\n        case \"objectList\":\n            return createObjectBuilder(params, true);\n        default:\n            return createJsonBuilder(params);\n    }\n};\n\n// Object kinds take their defaults through `jsonSchemaValueToFormData`, not the builder.\nconst getDefaultValue = (kind: JsonSchemaKind, schema: JsonSchema): unknown => {\n    if (schema.default === undefined || kind === \"object\" || kind === \"objectList\") {\n        return undefined;\n    }\n    if (kind === \"json\") {\n        return JSON.stringify(schema.default, null, 2);\n    }\n    return schema.default;\n};\n\nconst createField = (params: PropertyParams): IFieldBuilder => {\n    const { name, schema, isRequired } = params;\n    const kind = getJsonSchemaKind(schema);\n    const label = typeof schema.title === \"string\" && schema.title !== \"\" ? schema.title : name;\n    const builder = createBuilder(kind, params);\n\n    builder.label(label);\n    if (typeof schema.description === \"string\" && schema.description !== \"\") {\n        builder.help(schema.description);\n    }\n\n    const defaultValue = getDefaultValue(kind, schema);\n    if (defaultValue !== undefined) {\n        builder.defaultValue(defaultValue);\n    }\n\n    const canBeRequired = !KINDS_WITHOUT_REQUIRED.includes(kind);\n    if (isRequired && schema.default === undefined && canBeRequired) {\n        builder.required(`${label} is required.`);\n    }\n    return builder;\n};\n\n/*\n * Builds the FormModel fields of a JSON schema's properties (R271). A schema that is not an object\n * has no fields. The `required` list of an object marks its properties required, except a\n * property with a `default`, a switch and a nested object (its own properties are required).\n */\nexport const buildFieldsFromJsonSchema = (\n    schema: JsonSchema,\n    registry: IFieldBuilderRegistry,\n    options: JsonSchemaFieldOptions\n): Record<string, IFieldBuilder> => {\n    const fields: Record<string, IFieldBuilder> = {};\n    if (getJsonSchemaKind(schema) !== \"object\") {\n        return fields;\n    }\n\n    const requiredNames = Array.isArray(schema.required) ? schema.required : [];\n    const properties = schema.properties ?? {};\n\n    for (const [name, property] of Object.entries(properties)) {\n        const propertySchema = normalizeJsonSchema(property);\n        const isRequired = requiredNames.includes(name);\n        fields[name] = createField({ name, schema: propertySchema, isRequired, registry, options });\n    }\n\n    return fields;\n};\n"],"names":["KINDS_WITHOUT_REQUIRED","isJsonText","value","JSON","createNumberSchema","schema","minimum","maximum","exclusiveMinimum","exclusiveMaximum","hasMinimum","hasMaximum","numberSchema","z","constrained","message","createEnumBuilder","params","registry","values","stringOptions","String","numberOptions","Number","createStringBuilder","options","builder","hint","renderer","createNumberBuilder","createJsonBuilder","createObjectBuilder","isList","itemSchema","normalizeJsonSchema","inner","buildFieldsFromJsonSchema","createBuilder","kind","getDefaultValue","undefined","createField","name","isRequired","getJsonSchemaKind","label","defaultValue","canBeRequired","fields","requiredNames","Array","properties","property","Object","propertySchema"],"mappings":";;;AAkBA,MAAMA,yBAA2C;IAAC;IAAW;CAAS;AAGtE,MAAMC,aAAa,CAACC;IAChB,IAAIA,AAAiB,OAAjBA,MAAM,IAAI,IACV,OAAO;IAEX,IAAI;QACAC,KAAK,KAAK,CAACD;QACX,OAAO;IACX,EAAE,OAAM;QACJ,OAAO;IACX;AACJ;AAEA,MAAME,qBAAqB,CAACC;IACxB,MAAM,EAAEC,OAAO,EAAEC,OAAO,EAAEC,gBAAgB,EAAEC,gBAAgB,EAAE,GAAGJ;IACjE,MAAMK,aAAa,AAAmB,YAAnB,OAAOJ;IAC1B,MAAMK,aAAa,AAAmB,YAAnB,OAAOJ;IAC1B,IAAIK,eAAeC,EAAE,MAAM;IAC3B,IAAIC,cAAc;IAElB,IAAIT,AAAgB,cAAhBA,OAAO,IAAI,EAAgB;QAC3BO,eAAeA,aAAa,GAAG,CAAC;QAChCE,cAAc;IAClB;IACA,IAAIJ,cAAcC,YAAY;QAC1B,MAAMI,UAAU,CAAC,oBAAoB,EAAET,QAAQ,IAAI,EAAEC,QAAQ,CAAC,CAAC;QAC/DK,eAAeA,aAAa,GAAG,CAACN,SAASS,SAAS,GAAG,CAACR,SAASQ;QAC/DD,cAAc;IAClB,OAAO,IAAIJ,YAAY;QACnBE,eAAeA,aAAa,GAAG,CAACN,SAAS,CAAC,2BAA2B,EAAEA,QAAQ,CAAC,CAAC;QACjFQ,cAAc;IAClB,OAAO,IAAIH,YAAY;QACnBC,eAAeA,aAAa,GAAG,CAACL,SAAS,CAAC,0BAA0B,EAAEA,QAAQ,CAAC,CAAC;QAChFO,cAAc;IAClB;IACA,IAAI,AAA4B,YAA5B,OAAON,kBAA+B;QACtCI,eAAeA,aAAa,EAAE,CAACJ;QAC/BM,cAAc;IAClB;IACA,IAAI,AAA4B,YAA5B,OAAOL,kBAA+B;QACtCG,eAAeA,aAAa,EAAE,CAACH;QAC/BK,cAAc;IAClB;IACA,OAAOA,cAAcF,eAAe;AACxC;AAEA,MAAMI,oBAAoB,CAACC;IACvB,MAAM,EAAEZ,MAAM,EAAEa,QAAQ,EAAE,GAAGD;IAC7B,MAAME,SAASd,OAAO,IAAI,IAAI,EAAE;IAChC,IAAIA,AAAgB,aAAhBA,OAAO,IAAI,EAAe;QAC1B,MAAMe,gBAAgBD,OAAO,GAAG,CAACjB,CAAAA,QAAU;gBAAE,OAAOmB,OAAOnB;gBAAQ,OAAOmB,OAAOnB;YAAO;QACxF,OAAOgB,SAAS,IAAI,GAAG,OAAO,CAACE;IACnC;IACA,MAAME,gBAAgBH,OAAO,GAAG,CAACjB,CAAAA,QAAU;YAAE,OAAOmB,OAAOnB;YAAQ,OAAOqB,OAAOrB;QAAO;IACxF,OAAOgB,SAAS,MAAM,GAAG,OAAO,CAACI;AACrC;AAEA,MAAME,sBAAsB,CAACP;IACzB,MAAM,EAAEZ,MAAM,EAAEa,QAAQ,EAAEO,OAAO,EAAE,GAAGR;IACtC,MAAMS,UAAUR,SAAS,IAAI;IAC7B,MAAMS,OAAOtB,OAAO,EAAE;IACtB,IAAIsB,AAAS,eAATA,MACA,OAAOD,QAAQ,QAAQ,CAAC;IAE5B,IAAI,AAAgB,YAAhB,OAAOC,MAAmB;QAC1B,MAAMC,WAAWH,QAAQ,WAAW,CAACE,KAAK;QAC1C,IAAI,AAAoB,YAApB,OAAOC,UACP,OAAOF,QAAQ,QAAQ,CAACE;IAEhC;IACA,OAAOF;AACX;AAEA,MAAMG,sBAAsB,CAACZ;IACzB,MAAMS,UAAUT,OAAO,QAAQ,CAAC,MAAM;IACtC,MAAML,eAAeR,mBAAmBa,OAAO,MAAM;IACrD,IAAIL,cACAc,QAAQ,MAAM,CAACd;IAEnB,OAAOc;AACX;AAEA,MAAMI,oBAAoB,CAACb;IACvB,MAAMS,UAAUT,OAAO,QAAQ,CAAC,IAAI;IACpCS,QAAQ,QAAQ,CAAC,cAAc;QAAE,UAAU;IAAO;IAClDA,QAAQ,MAAM,CAACb,EAAE,MAAM,GAAG,MAAM,CAACZ,YAAY;IAC7C,OAAOyB;AACX;AAEA,MAAMK,sBAAsB,CAACd,QAAwBe;IACjD,MAAM,EAAE3B,MAAM,EAAEa,QAAQ,EAAEO,OAAO,EAAE,GAAGR;IACtC,MAAMgB,aAAaD,SAASE,oBAAoB7B,OAAO,KAAK,IAAIA;IAChE,MAAMqB,UAAUR,SAAS,MAAM;IAC/B,IAAIc,QACAN,QAAQ,IAAI;IAEhB,OAAOA,QAAQ,MAAM,CAACS,CAAAA,QAASC,0BAA0BH,YAAYE,OAAOV;AAChF;AAEA,MAAMY,gBAAgB,CAACC,MAAsBrB;IACzC,OAAQqB;QACJ,KAAK;YACD,OAAOd,oBAAoBP;QAC/B,KAAK;YACD,OAAOD,kBAAkBC;QAC7B,KAAK;YACD,OAAOY,oBAAoBZ;QAC/B,KAAK;YACD,OAAOA,OAAO,QAAQ,CAAC,OAAO;QAClC,KAAK;YACD,OAAOc,oBAAoBd,QAAQ;QACvC,KAAK;YACD,OAAOA,OAAO,QAAQ,CAAC,IAAI,GAAG,IAAI,GAAG,QAAQ,CAAC;QAClD,KAAK;YACD,OAAOc,oBAAoBd,QAAQ;QACvC;YACI,OAAOa,kBAAkBb;IACjC;AACJ;AAGA,MAAMsB,kBAAkB,CAACD,MAAsBjC;IAC3C,IAAIA,AAAmBmC,WAAnBnC,OAAO,OAAO,IAAkBiC,AAAS,aAATA,QAAqBA,AAAS,iBAATA,MACrD;IAEJ,IAAIA,AAAS,WAATA,MACA,OAAOnC,KAAK,SAAS,CAACE,OAAO,OAAO,EAAE,MAAM;IAEhD,OAAOA,OAAO,OAAO;AACzB;AAEA,MAAMoC,cAAc,CAACxB;IACjB,MAAM,EAAEyB,IAAI,EAAErC,MAAM,EAAEsC,UAAU,EAAE,GAAG1B;IACrC,MAAMqB,OAAOM,kBAAkBvC;IAC/B,MAAMwC,QAAQ,AAAwB,YAAxB,OAAOxC,OAAO,KAAK,IAAiBA,AAAiB,OAAjBA,OAAO,KAAK,GAAUA,OAAO,KAAK,GAAGqC;IACvF,MAAMhB,UAAUW,cAAcC,MAAMrB;IAEpCS,QAAQ,KAAK,CAACmB;IACd,IAAI,AAA8B,YAA9B,OAAOxC,OAAO,WAAW,IAAiBA,AAAuB,OAAvBA,OAAO,WAAW,EAC5DqB,QAAQ,IAAI,CAACrB,OAAO,WAAW;IAGnC,MAAMyC,eAAeP,gBAAgBD,MAAMjC;IAC3C,IAAIyC,AAAiBN,WAAjBM,cACApB,QAAQ,YAAY,CAACoB;IAGzB,MAAMC,gBAAgB,CAAC/C,uBAAuB,QAAQ,CAACsC;IACvD,IAAIK,cAActC,AAAmBmC,WAAnBnC,OAAO,OAAO,IAAkB0C,eAC9CrB,QAAQ,QAAQ,CAAC,GAAGmB,MAAM,aAAa,CAAC;IAE5C,OAAOnB;AACX;AAOO,MAAMU,4BAA4B,CACrC/B,QACAa,UACAO;IAEA,MAAMuB,SAAwC,CAAC;IAC/C,IAAIJ,AAA8B,aAA9BA,kBAAkBvC,SAClB,OAAO2C;IAGX,MAAMC,gBAAgBC,MAAM,OAAO,CAAC7C,OAAO,QAAQ,IAAIA,OAAO,QAAQ,GAAG,EAAE;IAC3E,MAAM8C,aAAa9C,OAAO,UAAU,IAAI,CAAC;IAEzC,KAAK,MAAM,CAACqC,MAAMU,SAAS,IAAIC,OAAO,OAAO,CAACF,YAAa;QACvD,MAAMG,iBAAiBpB,oBAAoBkB;QAC3C,MAAMT,aAAaM,cAAc,QAAQ,CAACP;QAC1CM,MAAM,CAACN,KAAK,GAAGD,YAAY;YAAEC;YAAM,QAAQY;YAAgBX;YAAYzB;YAAUO;QAAQ;IAC7F;IAEA,OAAOuB;AACX"}

package/features/formModel/jsonSchema/buildFieldsFromJsonSchema.test.d.ts

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