chore: Add basic docs to pickXKey and buildCompleteYupSchema

Author: sandrina-p

src/internals/helpers.js

@@ -10,10 +10,12 @@ import isEmpty from 'lodash/isEmpty';
 import isFunction from 'lodash/isFunction';
 
 /**
- * Returns the object from the JSON-schema node using the key.
- *
+ * Shorthand to lookup for keys with `x-jsf-*` preffix.
  * @param {Object} node - JSON-schema node
- * @param {String} key - JSON-schema key name
+ * @param {"presentation"|"errorMessage"} key - JSON-schema key name
+ * @example
+ *  pickKey(properties, 'presentation')
+ *  is the same as properties["x-jsf-presentation"]
  * @returns {Object}
  */
 export function pickXKey(node, key) {

src/yupSchema.js

@@ -8,6 +8,7 @@ import { convertDiskSizeFromTo } from './utils';
 
 /**
  * @typedef {import('./createHeadlessForm').FieldParameters} FieldParameters
+ * @typedef {import('../createHeadlessForm').JsfConfig} JsfConfig
  */
 
 export const DEFAULT_DATE_FORMAT = 'yyyy-MM-dd';
@@ -297,6 +298,14 @@ function getSchema(fields = [], config) {
   return newSchema;
 }
 
+/**
+ * Returns the Yup schema structure of given fields.
+ * These fields must be the same from
+ * const { fields } = createHeadlessForm()
+ * @param {Fields[]} fields - List of fields
+ * @param {JsfConfig} config - Config
+ * @returns
+ */
 export function buildCompleteYupSchema(fields, config) {
   return object().shape(getSchema(fields, config), getNoSortEdges(fields));
 }