@remoteoss/json-schema-form 0.11.11-dev.20250220174843 → 1.0.0-beta.0

package/json-schema-form.d.ts

@@ -1,175 +0,0 @@
-/**
- * Shorthand to lookup for keys with `x-jsf-*` preffix.
- */
-export function pickXKey(node: Object, key: 'presentation' | 'errorMessage'): Object | undefined;
-type ValidationTypes =
-  | 'type'
-  | 'minimum'
-  | 'maximum'
-  | 'minLength'
-  | 'maxLength'
-  | 'pattern'
-  | 'maxFileSize'
-  | 'accept'
-  | 'required';
-
-type JSFConfig = {
-  /**
-   * Initial json values to prefill the form fields.
-   * This influences the initial visibility of conditional fields.
-   */
-  initialValues?: Record<string, unknown>;
-  /**
-   * It inforces all json properties (fields) to have x-jsf-presentation.inputType.
-    @default true 
-  */
-  strictInputType?: boolean;
-  /**
-   * Customize the output of a given named Field.
-   * Useful if you want to enhance the UI/UX of a particular field.
-   * @example
-   * { has_pet: { "optionsDirection": "horizontal" } }
-   */
-  customProperties?: {
-    description?: (description: string, field: $TSFixMe) => string | string;
-    [key: string]: unknown;
-  };
-  /**
-   * Customize the config for each inputType
-   */
-  inputTypes?: {
-    /**
-     * Customize the error error message of this input type.
-     * @example
-     * { required: "This number is required." }
-     */
-    errorMessage?: Partial<Record<ValidationTypes, string>>;
-  };
-};
-type Fields = Record<string, unknown>[]; //TODO: Type the field based on the given JSON Schema properties.
-
-type $TSFixMe = any;
-
-/**
- * Returns the Yup schema structure of given fields.
- * These fields must be the same from
- * const { fields } = createHeadlessForm()
- */
-export function buildCompleteYupSchema(fields: Fields, config: JSFConfig): $TSFixMe; //TODO: We need to update Yup to 1.0 which supports TS.
-
-type HeadlessFormOutput = {
-  /**
-   * List of Fields. Each Field corresponds to a form input from the json schema.
-   * @example
-   * [
-      {
-        name: "has_pet",
-        label: "Has Pet",
-        options: [
-          { label: "Yes", value: "yes" },
-          { label: "No", value: "no" }
-        ],
-        required: true,
-        inputType: "radio",
-        jsonType: "string",
-        description: "Do you have a pet?",
-        errorMessage: {},
-        isVisible: true
-      },
-      {
-        type: "text",
-        label: "Pet's name",
-        description: "What's your pet's name?",
-        required: false,
-        inputType: "text",
-        jsonType: "string",
-        isVisible: false
-      }
-   * ]
-   */
-  fields: Fields;
-  /**
-   * Validates given values and returns the respective errors.
-   * @example
-   * const { formErrors } = handleValidation({ has_pet: "yes" });
-   * console.log(formErrors) // { pet_name: "Required field." }
-   */
-  handleValidation: (values: Record<string, unknown>) => {
-    yupError: $TSFixMe;
-    formErrors: $TSFixMe;
-  };
-  isError: boolean;
-  error?: Error;
-};
-
-type JSONSchemaObjectType = Record<string, unknown>;
-type FieldName = string;
-type FieldAttrs = Record<string, unknown>;
-
-type ModifyConfig = {
-  /**
-   * An object with the fields to be modified with the returned attributes.
-   */
-  fields?: Record<FieldName, FieldAttrs | ((fieldAttrs: FieldAttrs) => FieldAttrs)>;
-  /**
-   * A callback function that runs through all fields, to modify them with the returned attributes.
-   */
-  allFields?: (fieldName: FieldName, fieldAttrs: FieldAttrs) => FieldAttrs;
-  /**
-   * An object of new fields to be created with the new attributes.
-   */
-  create?: Record<FieldName, FieldAttrs>;
-  /**
-   * An array of the fields to keep, removing the remaining fields.
-   */
-  pick?: FieldName[];
-  /**
-   * An array of fieldNames with the new order. Can be an object or callback function
-   * */
-  orderRoot?: FieldName[] | ((originalOrder: FieldName[]) => FieldName[]);
-  /**
-   * Mutes any logs or warnings from the library.
-   */
-  muteLogging?: boolean;
-};
-
-type WarningType =
-  | 'FIELD_TO_CHANGE_NOT_FOUND'
-  | 'ORDER_MISSING_FIELDS'
-  | 'FIELD_TO_CREATE_EXISTS'
-  | 'PICK_MISSED_FIELD';
-
-type Warning = {
-  message: string;
-  type: WarningType;
-  meta?: Record<string, unknown>;
-};
-
-type ModifyOutput = {
-  schema: JSONSchemaObjectType;
-  warnings: Warning[];
-};
-
-/**
- * Generates the Headless form based on the provided JSON schema
- */
-export function createHeadlessForm(
-  /** A JSON Schema of type object */
-  jsonSchema: JSONSchemaObjectType,
-  customConfig?: JSFConfig
-): HeadlessFormOutput;
-
-/**
- * Returns a new JSON Schema modified based a given configuration.
- * This does not mutate the original JSON Schema.
- */
-export function modify(
-  /**
-   * The original JSON schema as base to the modifications.
-   */
-  originalSchema: JSONSchemaObjectType,
-  /**
-   * The configuration object to create a new JSON Schema based on the originalSchema.
-   */
-  config?: ModifyConfig
-): ModifyOutput;

package/json-schema-form.schema.json

@@ -1,188 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "JSON json-schema-form-Schema",
-  "definitions": {
-    "schemaArray": {
-      "allOf": [
-        {
-          "$ref": "http://json-schema.org/draft-07/schema#/definitions/schemaArray"
-        },
-        {
-          "items": { "$ref": "#" }
-        }
-      ]
-    }
-  },
-  "allOf": [{ "$ref": "http://json-schema.org/draft-07/schema#" }],
-  "properties": {
-    "additionalItems": { "$ref": "#" },
-    "additionalProperties": { "$ref": "#" },
-    "dependencies": {
-      "additionalProperties": {
-        "anyOf": [{ "$ref": "#" }, { "type": "array" }]
-      }
-    },
-    "items": {
-      "anyOf": [{ "$ref": "#" }, { "$ref": "#/definitions/schemaArray" }]
-    },
-    "definitions": {
-      "additionalProperties": { "$ref": "#" }
-    },
-    "patternProperties": {
-      "additionalProperties": { "$ref": "#" }
-    },
-    "properties": {
-      "additionalProperties": { "$ref": "#" }
-    },
-    "if": { "$ref": "#" },
-    "then": { "$ref": "#" },
-    "else": { "$ref": "#" },
-    "allOf": { "$ref": "#/definitions/schemaArray" },
-    "anyOf": { "$ref": "#/definitions/schemaArray" },
-    "oneOf": { "$ref": "#/definitions/schemaArray" },
-    "not": { "$ref": "#" },
-    "contains": { "$ref": "#" },
-    "propertyNames": { "$ref": "#" },
-    "x-jsf-order": {
-      "description": "This keyword defines the order of fields for a given form or fieldset. It's placed at the schema root and inside of each fieldset.",
-      "$ref": "http://json-schema.org/draft-07/schema#/definitions/stringArray"
-    },
-    "x-jsf-errorMessage": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "type": {
-          "type": "string",
-          "description": "Message shown when the value is not of the correct type."
-        },
-        "required": {
-          "type": "string",
-          "description": "Message shown when the value is required and not provided."
-        },
-        "minimum": {
-          "type": "string",
-          "description": "Message shown when the value is less than the minimum value."
-        },
-        "minLength": {
-          "type": "string",
-          "description": "Message shown when the value is less than the minimum length."
-        },
-        "maximum": {
-          "type": "string",
-          "description": "Message shown when the value is greater than the maximum value."
-        },
-        "maxLength": {
-          "type": "string",
-          "description": "Message shown when the value is greater than the maximum length."
-        },
-        "pattern": {
-          "type": "string",
-          "description": "Message shown when the value is not the correct format and does not match the pattern property."
-        },
-        "maxFileSize": {
-          "type": "string",
-          "description": "Message shown when the file size is greater than the maximum file size."
-        },
-        "accept": {
-          "type": "string",
-          "description": "Message shown when the file type is not accepted."
-        }
-      }
-    },
-    "x-jsf-presentation": {
-      "type": "object",
-      "description": "Presentation overrides for the schema",
-      "properties": {
-        "inputType": {
-          "description": "Input type for the generated UI field",
-          "type": "string",
-          "anyOf": [
-            {
-              "const": "text",
-              "description": "Similar to the native HTML input with text type."
-            },
-            {
-              "const": "select",
-              "description": "Similar to the native HTML select element."
-            },
-            {
-              "const": "radio",
-              "description": "Similar to a native HTML input with radio type."
-            },
-            {
-              "const": "number",
-              "description": "Similar to the native HTML input with number type."
-            },
-            {
-              "const": "date",
-              "description": "Expects a value with format YYY-MM-DD."
-            },
-            {
-              "const": "checkbox",
-              "description": "Similar to the native HTML input with checkbox type."
-            },
-            {
-              "const": "email",
-              "description": "Similar to the native HTML input with email type."
-            },
-            {
-              "const": "file",
-              "description": "Similar to the native HTML input with file type."
-            },
-            {
-              "const": "fieldset",
-              "description": "Groups multiple Fields inside. Its expected value is a nested object."
-            },
-            {
-              "const": "group-array",
-              "description": "A list of inputs that can be repeated. Its expected value is an array."
-            },
-            {
-              "type": "string",
-              "description": "Any arbitrary custom inputType you might want to represent your UI Field."
-            }
-          ]
-        },
-        "accept": {
-          "description": "For `inputType: \"file\"`. The accepted file types, as a comma separated string.",
-          "type": "string"
-        },
-        "description": {
-          "description": "Field description with HTML. If you don't need HTML, please use the native description keyword.",
-          "type": "string"
-        },
-        "statement": {
-          "description": "Special message about the field. Useful in cases where this message is based on the field value.",
-          "type": "object",
-          "properties": {
-            "title": {
-              "type": "string"
-            },
-            "description": {
-              "description": "The sentence itself. Might include HTML.",
-              "type": "string"
-            },
-            "severity": {
-              "description": "Defines the type of message.",
-              "anyOf": [
-                { "type": "string", "const": "info" },
-                { "type": "string", "const": "warning" },
-                { "type": "string", "const": "error" },
-                { "type": "string", "const": "success" },
-                {}
-              ]
-            }
-          }
-        },
-        "maxFileSize": {
-          "description": "For `inputType: \"file\"`. The maximum file size in KB. It's used to enhanced Yup validation.",
-          "type": "number"
-        },
-        "addFieldText": {
-          "description": "Used in `group-array` fields. The button text to add a new field.",
-          "type": "string"
-        }
-      }
-    }
-  }
-}

package/src/tests/checkIfConditionMatches.test.js

@@ -1,65 +0,0 @@
-import { checkIfConditionMatchesProperties } from '@/internals/checkIfConditionMatches';
-
-describe('checkIfConditionMatchesProperties()', () => {
-  it('True if is always going to be true', () => {
-    expect(checkIfConditionMatchesProperties({ if: true })).toBe(true);
-  });
-
-  it('False if is always going to be false', () => {
-    expect(checkIfConditionMatchesProperties({ if: false })).toBe(false);
-  });
-
-  it('Empty if is always going to be true', () => {
-    expect(checkIfConditionMatchesProperties({ if: { properties: {} } })).toBe(true);
-  });
-
-  it('Basic if check passes with correct value', () => {
-    expect(
-      checkIfConditionMatchesProperties(
-        { if: { properties: { a: { const: 'hello' } } } },
-        {
-          a: 'hello',
-        }
-      )
-    ).toBe(true);
-  });
-
-  it('Basic if check fails with incorrect value', () => {
-    expect(
-      checkIfConditionMatchesProperties(
-        { if: { properties: { a: { const: 'hello' } } } },
-        {
-          a: 'goodbye',
-        }
-      )
-    ).toBe(false);
-  });
-
-  it('Nested properties check passes with correct value', () => {
-    expect(
-      checkIfConditionMatchesProperties(
-        {
-          if: { properties: { parent: { properties: { child: { const: 'hello from child' } } } } },
-        },
-        {
-          parent: { child: 'hello from child' },
-        },
-        [{ name: 'parent', fields: [] }]
-      )
-    ).toBe(true);
-  });
-
-  it('Nested properties check passes with correct value', () => {
-    expect(
-      checkIfConditionMatchesProperties(
-        {
-          if: { properties: { parent: { properties: { child: { const: 'hello from child' } } } } },
-        },
-        {
-          parent: { child: 'goodbye from child' },
-        },
-        [{ name: 'parent', fields: [] }]
-      )
-    ).toBe(false);
-  });
-});