From cfbcccb5c54e943434bf1dfec63d0f0b99383554 Mon Sep 17 00:00:00 2001 From: jorenbroekema Date: Mon, 9 Nov 2020 14:04:05 +0100 Subject: [PATCH] fix: use lion/core types wherever possible --- .changeset/fair-suns-melt.md | 28 +++++++++++++++++++ packages/calendar/test/lion-calendar.test.js | 2 +- .../test/lion-checkbox-group.test.js | 2 +- .../collapsible/test/lion-collapsible.test.js | 2 +- packages/core/src/DelegateMixin.js | 2 +- packages/core/src/DisabledMixin.js | 2 +- .../core/src/DisabledWithTabIndexMixin.js | 2 +- packages/dialog/test/lion-dialog.test.js | 2 +- packages/form/test/lion-form.test.js | 2 +- .../renderLitAsNode/src/renderLitAsNode.js | 2 +- .../sb-action-logger/src/SbActionLogger.js | 2 +- .../test/sb-action-logger.test.js | 2 +- packages/icon/src/IconManager.js | 4 +-- packages/icon/test/lion-icon.test.js | 2 +- .../input-date/test/lion-input-date.test.js | 2 +- .../test/lion-input-datepicker.test.js | 2 +- .../input-email/test/lion-input-email.test.js | 2 +- .../input-iban/test/lion-input-iban.test.js | 2 +- packages/input-range/src/LionInputRange.js | 2 +- .../input-range/test/lion-input-range.test.js | 2 +- .../input-stepper/src/LionInputStepper.js | 9 +++--- .../test/lion-input-stepper.test.js | 2 +- .../listbox/test-suites/ListboxMixin.suite.js | 2 +- packages/pagination/src/LionPagination.js | 2 +- .../pagination/test/lion-pagination.test.js | 2 +- .../radio-group/test/lion-radio-group.test.js | 2 +- packages/steps/test/lion-steps.test.js | 2 +- .../switch/test/lion-switch-button.test.js | 2 +- packages/switch/test/lion-switch.test.js | 2 +- packages/textarea/test/lion-textarea.test.js | 2 +- 30 files changed, 62 insertions(+), 33 deletions(-) create mode 100644 .changeset/fair-suns-melt.md diff --git a/.changeset/fair-suns-melt.md b/.changeset/fair-suns-melt.md new file mode 100644 index 000000000..510484f8b --- /dev/null +++ b/.changeset/fair-suns-melt.md @@ -0,0 +1,28 @@ +--- +'@lion/accordion': patch +'@lion/calendar': patch +'@lion/checkbox-group': patch +'@lion/collapsible': patch +'@lion/core': patch +'@lion/dialog': patch +'@lion/form': patch +'@lion/form-core': patch +'@lion/helpers': patch +'@lion/icon': patch +'@lion/input-amount': patch +'@lion/input-date': patch +'@lion/input-datepicker': patch +'@lion/input-email': patch +'@lion/input-iban': patch +'@lion/input-range': patch +'@lion/input-stepper': patch +'@lion/listbox': patch +'@lion/pagination': patch +'providence-analytics': patch +'@lion/radio-group': patch +'@lion/steps': patch +'@lion/switch': patch +'@lion/textarea': patch +--- + +Fix type imports to reuse lion where possible, in case Lit updates with new types that may break us. diff --git a/packages/calendar/test/lion-calendar.test.js b/packages/calendar/test/lion-calendar.test.js index fdde99409..5ebaa268a 100644 --- a/packages/calendar/test/lion-calendar.test.js +++ b/packages/calendar/test/lion-calendar.test.js @@ -10,7 +10,7 @@ import { CalendarObject, DayObject } from '../test-helpers.js'; /** * @typedef {import('../src/LionCalendar').LionCalendar} LionCalendar - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult) => Promise} */ (_fixture); diff --git a/packages/checkbox-group/test/lion-checkbox-group.test.js b/packages/checkbox-group/test/lion-checkbox-group.test.js index dddbe47d7..932f1ad04 100644 --- a/packages/checkbox-group/test/lion-checkbox-group.test.js +++ b/packages/checkbox-group/test/lion-checkbox-group.test.js @@ -5,7 +5,7 @@ import '../lion-checkbox.js'; /** * @typedef {import('../src/LionCheckboxGroup').LionCheckboxGroup} LionCheckboxGroup - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult) => Promise} */ (_fixture); diff --git a/packages/collapsible/test/lion-collapsible.test.js b/packages/collapsible/test/lion-collapsible.test.js index 497d6550b..0883dd45f 100644 --- a/packages/collapsible/test/lion-collapsible.test.js +++ b/packages/collapsible/test/lion-collapsible.test.js @@ -5,7 +5,7 @@ import '../lion-collapsible.js'; /** * @typedef {import('../src/LionCollapsible').LionCollapsible} LionCollapsible - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult) => Promise} */ (_fixture); diff --git a/packages/core/src/DelegateMixin.js b/packages/core/src/DelegateMixin.js index cbe124d5f..a8f248f13 100644 --- a/packages/core/src/DelegateMixin.js +++ b/packages/core/src/DelegateMixin.js @@ -14,7 +14,7 @@ import { dedupeMixin } from '@open-wc/dedupe-mixin'; /** * @type {DelegateMixin} - * @param {import('@open-wc/dedupe-mixin').Constructor} superclass + * @param {import('@open-wc/dedupe-mixin').Constructor} superclass */ const DelegateMixinImplementation = superclass => // eslint-disable-next-line diff --git a/packages/core/src/DisabledMixin.js b/packages/core/src/DisabledMixin.js index 5511fac19..cfd4f5846 100644 --- a/packages/core/src/DisabledMixin.js +++ b/packages/core/src/DisabledMixin.js @@ -6,7 +6,7 @@ import { dedupeMixin } from '@open-wc/dedupe-mixin'; /** * @type {DisabledMixin} - * @param {import('@open-wc/dedupe-mixin').Constructor} superclass + * @param {import('@open-wc/dedupe-mixin').Constructor} superclass */ const DisabledMixinImplementation = superclass => // eslint-disable-next-line no-shadow diff --git a/packages/core/src/DisabledWithTabIndexMixin.js b/packages/core/src/DisabledWithTabIndexMixin.js index 06fc249d3..04cf21462 100644 --- a/packages/core/src/DisabledWithTabIndexMixin.js +++ b/packages/core/src/DisabledWithTabIndexMixin.js @@ -7,7 +7,7 @@ import { DisabledMixin } from './DisabledMixin.js'; /** * @type {DisabledWithTabIndexMixin} - * @param {import('@open-wc/dedupe-mixin').Constructor} superclass + * @param {import('@open-wc/dedupe-mixin').Constructor} superclass */ const DisabledWithTabIndexMixinImplementation = superclass => // eslint-disable-next-line no-shadow diff --git a/packages/dialog/test/lion-dialog.test.js b/packages/dialog/test/lion-dialog.test.js index d4f4b3351..cfdc5d336 100644 --- a/packages/dialog/test/lion-dialog.test.js +++ b/packages/dialog/test/lion-dialog.test.js @@ -5,7 +5,7 @@ import '../lion-dialog.js'; /** * @typedef {import('../src/LionDialog').LionDialog} LionDialog - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult) => Promise} */ (_fixture); diff --git a/packages/form/test/lion-form.test.js b/packages/form/test/lion-form.test.js index 1b20915d0..f54d6388b 100644 --- a/packages/form/test/lion-form.test.js +++ b/packages/form/test/lion-form.test.js @@ -18,7 +18,7 @@ import '../lion-form.js'; /** * @typedef {import('../src/LionForm').LionForm} LionForm - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult) => Promise} */ (_fixture); diff --git a/packages/helpers/renderLitAsNode/src/renderLitAsNode.js b/packages/helpers/renderLitAsNode/src/renderLitAsNode.js index 955a0cba0..ca8a1b204 100644 --- a/packages/helpers/renderLitAsNode/src/renderLitAsNode.js +++ b/packages/helpers/renderLitAsNode/src/renderLitAsNode.js @@ -4,7 +4,7 @@ import { render } from '@lion/core'; * Helper to render a lit TemplateResult as an offline-created DOM node * Make sure that the top-most element in the template has no siblings, * as they won't be taken into account. We only return firstElementChild. - * @param {import('lit-html').TemplateResult} litHtmlTemplate + * @param {import('@lion/core').TemplateResult} litHtmlTemplate */ export const renderLitAsNode = litHtmlTemplate => { const offlineRenderContainer = document.createElement('div'); diff --git a/packages/helpers/sb-action-logger/src/SbActionLogger.js b/packages/helpers/sb-action-logger/src/SbActionLogger.js index bafd1ec99..ae7c0cd93 100644 --- a/packages/helpers/sb-action-logger/src/SbActionLogger.js +++ b/packages/helpers/sb-action-logger/src/SbActionLogger.js @@ -1,6 +1,6 @@ import { css, html, LitElement, render } from '@lion/core'; -/** @typedef {import('lit-html').TemplateResult} TemplateResult */ +/** @typedef {import('@lion/core').TemplateResult} TemplateResult */ export class SbActionLogger extends LitElement { static get properties() { diff --git a/packages/helpers/sb-action-logger/test/sb-action-logger.test.js b/packages/helpers/sb-action-logger/test/sb-action-logger.test.js index 2ccbdf9b3..70942e987 100644 --- a/packages/helpers/sb-action-logger/test/sb-action-logger.test.js +++ b/packages/helpers/sb-action-logger/test/sb-action-logger.test.js @@ -3,7 +3,7 @@ import '../../sb-action-logger.js'; /** * @typedef {import('../src/SbActionLogger').SbActionLogger} SbActionLogger - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult|string) => Promise} */ (_fixture); diff --git a/packages/icon/src/IconManager.js b/packages/icon/src/IconManager.js index 8a495e6fb..f19f3a18c 100644 --- a/packages/icon/src/IconManager.js +++ b/packages/icon/src/IconManager.js @@ -1,6 +1,6 @@ /** - * @typedef {import('lit-html').TemplateResult} TemplateResult - * @typedef {import('lit-html').nothing} nothing + * @typedef {import('@lion/core').TemplateResult} TemplateResult + * @typedef {import('@lion/core').nothing} nothing */ export class IconManager { diff --git a/packages/icon/test/lion-icon.test.js b/packages/icon/test/lion-icon.test.js index 2c77ac274..d081b311f 100644 --- a/packages/icon/test/lion-icon.test.js +++ b/packages/icon/test/lion-icon.test.js @@ -8,7 +8,7 @@ import heartSvg from './heart.svg.js'; /** * @typedef {(strings: TemplateStringsArray, ... expr: string[]) => string} TaggedTemplateLiteral * @typedef {import('../src/LionIcon').LionIcon} LionIcon - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult|string) => Promise} */ (_fixture); diff --git a/packages/input-date/test/lion-input-date.test.js b/packages/input-date/test/lion-input-date.test.js index 681a99641..1e2b41f3f 100644 --- a/packages/input-date/test/lion-input-date.test.js +++ b/packages/input-date/test/lion-input-date.test.js @@ -7,7 +7,7 @@ import '../lion-input-date.js'; /** * @typedef {import('../src/LionInputDate').LionInputDate} LionInputDate - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult) => Promise} */ (_fixture); diff --git a/packages/input-datepicker/test/lion-input-datepicker.test.js b/packages/input-datepicker/test/lion-input-datepicker.test.js index 3019d7183..aa014523e 100644 --- a/packages/input-datepicker/test/lion-input-datepicker.test.js +++ b/packages/input-datepicker/test/lion-input-datepicker.test.js @@ -10,7 +10,7 @@ import { LionInputDatepicker } from '../src/LionInputDatepicker.js'; import { DatepickerInputObject } from '../test-helpers.js'; /** - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult) => Promise} */ (_fixture); diff --git a/packages/input-email/test/lion-input-email.test.js b/packages/input-email/test/lion-input-email.test.js index da21b7c7f..f7e98e5fc 100644 --- a/packages/input-email/test/lion-input-email.test.js +++ b/packages/input-email/test/lion-input-email.test.js @@ -4,7 +4,7 @@ import '../lion-input-email.js'; /** * @typedef {import('../src/LionInputEmail').LionInputEmail} LionInputEmail - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult|string) => Promise} */ (_fixture); diff --git a/packages/input-iban/test/lion-input-iban.test.js b/packages/input-iban/test/lion-input-iban.test.js index 18c5ea134..3c7228ed5 100644 --- a/packages/input-iban/test/lion-input-iban.test.js +++ b/packages/input-iban/test/lion-input-iban.test.js @@ -9,7 +9,7 @@ import '../lion-input-iban.js'; /** * @typedef {import('../src/LionInputIban').LionInputIban} LionInputIban - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult|string) => Promise} */ (_fixture); diff --git a/packages/input-range/src/LionInputRange.js b/packages/input-range/src/LionInputRange.js index 016b87efe..159651b15 100644 --- a/packages/input-range/src/LionInputRange.js +++ b/packages/input-range/src/LionInputRange.js @@ -4,7 +4,7 @@ import { LionInput } from '@lion/input'; import { formatNumber, LocalizeMixin } from '@lion/localize'; /** - * @typedef {import('lit-element').CSSResult} CSSResult + * @typedef {import('@lion/core').CSSResult} CSSResult */ /** diff --git a/packages/input-range/test/lion-input-range.test.js b/packages/input-range/test/lion-input-range.test.js index df013db0c..b966d20d0 100644 --- a/packages/input-range/test/lion-input-range.test.js +++ b/packages/input-range/test/lion-input-range.test.js @@ -4,7 +4,7 @@ import '../lion-input-range.js'; /** * @typedef {import('../src/LionInputRange').LionInputRange} LionInputRange - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult|string) => Promise} */ (_fixture); diff --git a/packages/input-stepper/src/LionInputStepper.js b/packages/input-stepper/src/LionInputStepper.js index 6edded79d..dff05ccb1 100644 --- a/packages/input-stepper/src/LionInputStepper.js +++ b/packages/input-stepper/src/LionInputStepper.js @@ -7,6 +7,7 @@ import { IsNumber, MinNumber, MaxNumber } from '@lion/form-core'; * * @customElement lion-input-stepper */ +// @ts-expect-error false positive, lit-element already merges properties for you export class LionInputStepper extends LionInput { static get styles() { return [ @@ -256,7 +257,7 @@ export class LionInputStepper extends LionInput { /** * Get the decrementor button sign template - * @returns {String|import('lit-element').TemplateResult} + * @returns {String|import('@lion/core').TemplateResult} */ // eslint-disable-next-line class-methods-use-this _decrementorSignTemplate() { @@ -265,7 +266,7 @@ export class LionInputStepper extends LionInput { /** * Get the incrementor button sign template - * @returns {String|import('lit-element').TemplateResult} + * @returns {String|import('@lion/core').TemplateResult} */ // eslint-disable-next-line class-methods-use-this _incrementorSignTemplate() { @@ -274,7 +275,7 @@ export class LionInputStepper extends LionInput { /** * Get the increment button template - * @returns {import('lit-element').TemplateResult} + * @returns {import('@lion/core').TemplateResult} */ _decrementorTemplate() { return html` @@ -292,7 +293,7 @@ export class LionInputStepper extends LionInput { /** * Get the decrement button template - * @returns {import('lit-element').TemplateResult} + * @returns {import('@lion/core').TemplateResult} */ _incrementorTemplate() { return html` diff --git a/packages/input-stepper/test/lion-input-stepper.test.js b/packages/input-stepper/test/lion-input-stepper.test.js index f50596975..cebb4b64b 100644 --- a/packages/input-stepper/test/lion-input-stepper.test.js +++ b/packages/input-stepper/test/lion-input-stepper.test.js @@ -3,7 +3,7 @@ import '../lion-input-stepper.js'; /** * @typedef {import('../src/LionInputStepper').LionInputStepper} LionInputStepper - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult|string) => Promise} */ (_fixture); diff --git a/packages/listbox/test-suites/ListboxMixin.suite.js b/packages/listbox/test-suites/ListboxMixin.suite.js index 7da50a908..aedee3726 100644 --- a/packages/listbox/test-suites/ListboxMixin.suite.js +++ b/packages/listbox/test-suites/ListboxMixin.suite.js @@ -11,7 +11,7 @@ import '../lion-listbox.js'; * @typedef {import('../src/LionListbox').LionListbox} LionListbox * @typedef {import('../src/LionOption').LionOption} LionOption * @typedef {import('@lion/select-rich').LionSelectInvoker} LionSelectInvoker - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult) => Promise} */ (_fixture); diff --git a/packages/pagination/src/LionPagination.js b/packages/pagination/src/LionPagination.js index e6668b92a..b108021bd 100644 --- a/packages/pagination/src/LionPagination.js +++ b/packages/pagination/src/LionPagination.js @@ -2,7 +2,7 @@ import { LitElement, html, css } from '@lion/core'; import { LocalizeMixin } from '@lion/localize'; /** - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ /** diff --git a/packages/pagination/test/lion-pagination.test.js b/packages/pagination/test/lion-pagination.test.js index c04a38d45..f12633f24 100644 --- a/packages/pagination/test/lion-pagination.test.js +++ b/packages/pagination/test/lion-pagination.test.js @@ -5,7 +5,7 @@ import '../lion-pagination.js'; /** * @typedef {import('../src/LionPagination').LionPagination} LionPagination - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult) => Promise} */ (_fixture); diff --git a/packages/radio-group/test/lion-radio-group.test.js b/packages/radio-group/test/lion-radio-group.test.js index edeb85b11..fc76526a8 100644 --- a/packages/radio-group/test/lion-radio-group.test.js +++ b/packages/radio-group/test/lion-radio-group.test.js @@ -6,7 +6,7 @@ import '../lion-radio.js'; /** * @typedef {import('../src/LionRadioGroup').LionRadioGroup} LionRadioGroup * @typedef {import('../src/LionRadio').LionRadio} LionRadio - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult) => Promise} */ (_fixture); diff --git a/packages/steps/test/lion-steps.test.js b/packages/steps/test/lion-steps.test.js index 4d36064c3..8ae303587 100644 --- a/packages/steps/test/lion-steps.test.js +++ b/packages/steps/test/lion-steps.test.js @@ -6,7 +6,7 @@ import '../lion-steps.js'; /** * @typedef {import('../src/LionSteps').LionSteps} LionSteps * @typedef {import('../src/LionStep').LionStep} LionStep - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult * @typedef {{[key: string]: ?}} UnknownData */ diff --git a/packages/switch/test/lion-switch-button.test.js b/packages/switch/test/lion-switch-button.test.js index 0f44fe584..ef0d9bc41 100644 --- a/packages/switch/test/lion-switch-button.test.js +++ b/packages/switch/test/lion-switch-button.test.js @@ -4,7 +4,7 @@ import '../lion-switch-button.js'; /** * @typedef {import('../src/LionSwitchButton').LionSwitchButton} LionSwitchButton - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult) => Promise} */ (_fixture); diff --git a/packages/switch/test/lion-switch.test.js b/packages/switch/test/lion-switch.test.js index 7ac80a9c5..d1c958302 100644 --- a/packages/switch/test/lion-switch.test.js +++ b/packages/switch/test/lion-switch.test.js @@ -4,7 +4,7 @@ import '../lion-switch.js'; /** * @typedef {import('../src/LionSwitch').LionSwitch} LionSwitch - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult) => Promise} */ (_fixture); diff --git a/packages/textarea/test/lion-textarea.test.js b/packages/textarea/test/lion-textarea.test.js index 615a5ba4d..505e774b2 100644 --- a/packages/textarea/test/lion-textarea.test.js +++ b/packages/textarea/test/lion-textarea.test.js @@ -4,7 +4,7 @@ import '../lion-textarea.js'; /** * @typedef {import('../src/LionTextarea').LionTextarea} LionTextarea - * @typedef {import('lit-html').TemplateResult} TemplateResult + * @typedef {import('@lion/core').TemplateResult} TemplateResult */ const fixture = /** @type {(arg: TemplateResult|string) => Promise} */ (_fixture);