import get from 'lodash/get'; import isEqual from 'lodash/isEqual'; import { ALL_OF_KEY, DEPENDENCIES_KEY, ID_KEY, ITEMS_KEY, PROPERTIES_KEY, REF_KEY } from '../constants'; import isObject from '../isObject'; import { FormContextType, IdSchema, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types'; import retrieveSchema from './retrieveSchema'; import getSchemaType from '../getSchemaType'; /** An internal helper that generates an `IdSchema` object for the `schema`, recursively with protection against * infinite recursion * * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary * @param schema - The schema for which the `IdSchema` is desired * @param idPrefix - The prefix to use for the id * @param idSeparator - The separator to use for the path segments in the id * @param [id] - The base id for the schema * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s * @param [formData] - The current formData, if any, to assist retrieving a schema * @param [_recurseList=[]] - The list of retrieved schemas currently being recursed, used to prevent infinite recursion * @returns - The `IdSchema` object for the `schema` */ function toIdSchemaInternal( validator: ValidatorType, schema: S, idPrefix: string, idSeparator: string, id?: string | null, rootSchema?: S, formData?: T, _recurseList: S[] = [] ): IdSchema { if (REF_KEY in schema || DEPENDENCIES_KEY in schema || ALL_OF_KEY in schema) { const _schema = retrieveSchema(validator, schema, rootSchema, formData); const sameSchemaIndex = _recurseList.findIndex((item) => isEqual(item, _schema)); if (sameSchemaIndex === -1) { return toIdSchemaInternal( validator, _schema, idPrefix, idSeparator, id, rootSchema, formData, _recurseList.concat(_schema) ); } } if (ITEMS_KEY in schema && !get(schema, [ITEMS_KEY, REF_KEY])) { return toIdSchemaInternal( validator, get(schema, ITEMS_KEY) as S, idPrefix, idSeparator, id, rootSchema, formData, _recurseList ); } const $id = id || idPrefix; const idSchema: IdSchema = { $id } as IdSchema; if (getSchemaType(schema) === 'object' && PROPERTIES_KEY in schema) { for (const name in schema.properties) { const field = get(schema, [PROPERTIES_KEY, name]); const fieldId = idSchema[ID_KEY] + idSeparator + name; idSchema[name] = toIdSchemaInternal( validator, isObject(field) ? field : {}, idPrefix, idSeparator, fieldId, rootSchema, // It's possible that formData is not an object -- this can happen if an // array item has just been added, but not populated with data yet get(formData, [name]), _recurseList ); } } return idSchema as IdSchema; } /** Generates an `IdSchema` object for the `schema`, recursively * * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary * @param schema - The schema for which the `IdSchema` is desired * @param [id] - The base id for the schema * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s * @param [formData] - The current formData, if any, to assist retrieving a schema * @param [idPrefix='root'] - The prefix to use for the id * @param [idSeparator='_'] - The separator to use for the path segments in the id * @returns - The `IdSchema` object for the `schema` */ export default function toIdSchema( validator: ValidatorType, schema: S, id?: string | null, rootSchema?: S, formData?: T, idPrefix = 'root', idSeparator = '_' ): IdSchema { return toIdSchemaInternal(validator, schema, idPrefix, idSeparator, id, rootSchema, formData); }