diff --git a/.changeset/mean-bottles-give.md b/.changeset/mean-bottles-give.md new file mode 100644 index 000000000..8e8ab4f93 --- /dev/null +++ b/.changeset/mean-bottles-give.md @@ -0,0 +1,5 @@ +--- +'@lion/form-core': patch +--- + +Added some type fixes/adjustments. diff --git a/packages/form-core/src/validate/Validator.js b/packages/form-core/src/validate/Validator.js index 739ef6d1d..3a68a2ba9 100644 --- a/packages/form-core/src/validate/Validator.js +++ b/packages/form-core/src/validate/Validator.js @@ -1,3 +1,13 @@ +/** + * @typedef {object} MessageData + * @property {*} [MessageData.modelValue] + * @property {string} [MessageData.fieldName] + * @property {HTMLElement} [MessageData.formControl] + * @property {string} [MessageData.type] + * @property {Object.} [MessageData.config] + * @property {string} [MessageData.name] + */ + export class Validator { /** * @@ -65,12 +75,7 @@ export class Validator { /** * @overridable - * @param {object} [data] - * @param {*} [data.modelValue] - * @param {string} [data.fieldName] - * @param {HTMLElement} [data.formControl] - * @param {*} [data.params] - * @param {string|undefined} [data.type] + * @param {MessageData} [data] * @returns {Promise} */ async _getMessage(data) { @@ -96,13 +101,7 @@ export class Validator { /** * @overridable - * @param {object} [data] - * @param {*} [data.modelValue] - * @param {string} [data.fieldName] - * @param {*} [data.params] - * @param {string} [data.type] - * @param {Object.} [data.config] - * @param {string} [data.name] + * @param {MessageData} [data] * @returns {Promise} */ // eslint-disable-next-line no-unused-vars diff --git a/packages/form-core/test-suites/ValidateMixinFeedbackPart.suite.js b/packages/form-core/test-suites/ValidateMixinFeedbackPart.suite.js index 4dc4de55b..a634a98ed 100644 --- a/packages/form-core/test-suites/ValidateMixinFeedbackPart.suite.js +++ b/packages/form-core/test-suites/ValidateMixinFeedbackPart.suite.js @@ -244,7 +244,7 @@ export function runValidateMixinFeedbackPart() { let name = ''; if (this.feedbackData && this.feedbackData.length > 0) { const ctor = /** @type {typeof Validator} */ (this.feedbackData[0]?.validator - .constructor); + ?.constructor); name = ctor.validatorName; } return html`Custom for ${name}`; @@ -467,7 +467,7 @@ export function runValidateMixinFeedbackPart() { // ignore fieldName Promise as it will always be unique const compare = spy.args[0][0]; - delete compare?.config.fieldName; + delete compare?.config?.fieldName; expect(compare).to.eql({ config: {}, params: 4,