Skip to content

Commit

Permalink
fix(editor): Fix design system typecheck errors (no-changelog) (#9447)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexgrozav committed May 21, 2024
1 parent d21ad15 commit eef5479
Show file tree
Hide file tree
Showing 20 changed files with 161 additions and 65 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { computed, ref } from 'vue';
import { uid } from '../../utils';
import { ElColorPicker } from 'element-plus';
import N8nInput from '../N8nInput';
import type { ElementPlusSizePropType } from '@/types';
export type ColorPickerProps = {
disabled?: boolean;
Expand All @@ -19,18 +20,20 @@ export type ColorPickerProps = {
defineOptions({ name: 'N8nColorPicker' });
const props = withDefaults(defineProps<ColorPickerProps>(), {
disabled: false,
size: 'medium',
size: 'default',
showAlpha: false,
colorFormat: 'hex',
popperClass: '',
predefine: undefined,
modelValue: undefined,
showInput: true,
name: uid('color-picker'),
});
const color = ref(props.modelValue);
const colorPickerProps = computed(() => {
const { showInput, ...rest } = props;
const { showInput, modelValue, size, ...rest } = props;
return rest;
});
Expand All @@ -40,6 +43,8 @@ const emit = defineEmits<{
(event: 'active-change', value: string): void;
}>();
const resolvedSize = computed(() => props.size as ElementPlusSizePropType);
const onChange = (value: string) => {
emit('change', value);
};
Expand All @@ -61,7 +66,7 @@ const onColorSelect = (value: string) => {
<span :class="['n8n-color-picker', $style.component]">
<ElColorPicker
v-bind="colorPickerProps"
size="default"
:size="resolvedSize"
@change="onChange"
@active-change="onActiveChange"
@update:model-value="onColorSelect"
Expand All @@ -70,7 +75,7 @@ const onColorSelect = (value: string) => {
v-if="showInput"
:class="$style.input"
:disabled="props.disabled"
:size="props.size"
:size="size"
:model-value="color"
:name="name"
type="text"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ exports[`components > N8nColorPicker > should render with input 1`] = `
<!--teleport end-->
<div
class="el-input el-input--medium n8n-input input input"
class="el-input el-input--default n8n-input input input"
data-v-dab78bb8=""
>
<!-- input -->
Expand All @@ -79,7 +79,6 @@ exports[`components > N8nColorPicker > should render with input 1`] = `
<input
autocomplete="off"
class="el-input__inner"
maxlength="Infinity"
name="color-picker"
placeholder=""
rows="2"
Expand Down
36 changes: 25 additions & 11 deletions packages/design-system/src/components/N8nFormInput/FormInput.vue
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<template>
<N8nCheckbox
v-if="type === 'checkbox'"
v-bind="$props"
ref="inputRef"
:label="label"
:disabled="disabled"
:label-size="labelSize as CheckboxLabelSizePropType"
:model-value="modelValue as CheckboxModelValuePropType"
@update:model-value="onUpdateModelValue"
@focus="onFocus"
/>
Expand All @@ -17,7 +20,7 @@
{{ tooltipText }}
</template>
<ElSwitch
:model-value="modelValue"
:model-value="modelValue as SwitchModelValuePropType"
:active-color="activeColor"
:inactive-color="inactiveColor"
@update:model-value="onUpdateModelValue"
Expand Down Expand Up @@ -59,9 +62,9 @@
v-else
ref="inputRef"
:name="name"
:type="type"
:type="type as InputTypePropType"
:placeholder="placeholder"
:model-value="modelValue"
:model-value="modelValue as InputModelValuePropType"
:maxlength="maxlength"
:autocomplete="autocomplete"
:disabled="disabled"
Expand Down Expand Up @@ -99,7 +102,18 @@ import N8nCheckbox from '../N8nCheckbox';
import { ElSwitch } from 'element-plus';
import { getValidationError, VALIDATORS } from './validators';
import type { Rule, RuleGroup, IValidator, Validatable, FormState } from '../../types';
import type {
Rule,
RuleGroup,
IValidator,
Validatable,
InputModelValuePropType,
InputTypePropType,
SwitchModelValuePropType,
CheckboxModelValuePropType,
CheckboxLabelSizePropType,
InputAutocompletePropType,
} from '../../types';
import { t } from '../../locale';
Expand All @@ -120,10 +134,10 @@ export interface Props {
validators?: { [key: string]: IValidator | RuleGroup };
maxlength?: number;
options?: Array<{ value: string | number; label: string; disabled?: boolean }>;
autocomplete?: string;
autocomplete?: InputAutocompletePropType;
name?: string;
focusInitially?: boolean;
labelSize?: 'small' | 'medium';
labelSize?: 'small' | 'medium' | 'large';
disabled?: boolean;
activeLabel?: string;
activeColor?: string;
Expand Down Expand Up @@ -206,7 +220,7 @@ function onBlur() {
$emit('blur');
}
function onUpdateModelValue(value: FormState) {
function onUpdateModelValue(value: Validatable) {
state.isTyping = true;
$emit('update:modelValue', value);
}
Expand All @@ -225,9 +239,9 @@ const validationError = computed<string | null>(() => {
const error = getInputValidationError();
if (error) {
if (error.messageKey) {
return t(error.messageKey, error.options);
} else {
if ('messageKey' in error) {
return t(error.messageKey, error.options as object);
} else if ('message' in error) {
return error.message;
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export const requiredValidator: IValidator<{}> = {
};

export const minLengthValidator: IValidator<{ minimum: number }> = {
validate: (value: Validatable, config: { minimum: number }) => {
validate: (value: Validatable, config) => {
if (typeof value === 'string' && value.length < config.minimum) {
return {
messageKey: 'formInput.validator.minCharactersRequired',
Expand Down Expand Up @@ -76,7 +76,7 @@ export const emailValidator: IValidator<{}> = {
};

export const containsUpperCaseValidator: IValidator<{ minimum: number }> = {
validate: (value: Validatable, config: { minimum: number }) => {
validate: (value: Validatable, config) => {
if (typeof value !== 'string') {
return false;
}
Expand All @@ -94,7 +94,7 @@ export const containsUpperCaseValidator: IValidator<{ minimum: number }> = {
};

export const matchRegex: IValidator<{ regex: RegExp; message: string }> = {
validate: (value: Validatable, config: { regex: RegExp; message: string }) => {
validate: (value: Validatable, config) => {
if (!config.regex.test(`${value as string}`)) {
return {
message: config.message,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ export default defineComponent({
default: true,
},
tagSize: {
type: String,
type: String as PropType<'small' | 'medium'>,
default: 'small',
validator: (value: string): boolean => ['small', 'medium'].includes(value),
},
Expand Down
20 changes: 16 additions & 4 deletions packages/design-system/src/components/N8nInput/Input.vue
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
<template>
<ElInput
ref="innerInput"
:size="computedSize"
:model-value="modelValue"
:type="type"
:size="resolvedSize"
:class="['n8n-input', ...classes]"
:autocomplete="autocomplete"
:name="name"
v-bind="{ ...$props, ...$attrs }"
:placeholder="placeholder"
:disabled="disabled"
:readonly="readonly"
:clearable="clearable"
:rows="rows"
:title="title"
v-bind="$attrs"
>
<template v-if="$slots.prepend" #prepend>
<slot name="prepend" />
Expand All @@ -27,6 +35,7 @@ import { computed, ref } from 'vue';
import { ElInput } from 'element-plus';
import { uid } from '../../utils';
import type { InputSize, InputType } from '@/types/input';
import type { ElementPlusSizePropType, InputAutocompletePropType } from '@/types';
interface InputProps {
modelValue?: string | number;
Expand All @@ -40,12 +49,13 @@ interface InputProps {
maxlength?: number;
title?: string;
name?: string;
autocomplete?: 'off' | 'autocomplete';
autocomplete?: InputAutocompletePropType;
}
defineOptions({ name: 'N8nInput' });
const props = withDefaults(defineProps<InputProps>(), {
modelValue: '',
type: 'text',
size: 'large',
placeholder: '',
disabled: false,
Expand All @@ -58,7 +68,9 @@ const props = withDefaults(defineProps<InputProps>(), {
autocomplete: 'off',
});
const computedSize = computed(() => (props.size === 'xlarge' ? undefined : props.size));
const resolvedSize = computed(
() => (props.size === 'xlarge' ? undefined : props.size) as ElementPlusSizePropType,
);
const classes = computed(() => {
const applied: string[] = [];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ exports[`N8nInput > should render correctly 1`] = `
<!--v-if-->
<div class="el-input__wrapper">
<!-- prefix slot -->
<!--v-if--><input class="el-input__inner" name="input" rows="2" maxlength="Infinity" title="" type="text" autocomplete="off" tabindex="0" placeholder=""><!-- suffix slot -->
<!--v-if--><input class="el-input__inner" name="input" rows="2" title="" type="text" autocomplete="off" tabindex="0" placeholder=""><!-- suffix slot -->
<!--v-if-->
</div><!-- append slot -->
<!--v-if-->
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<script setup lang="ts">
import type { InputSize } from '@/types';
import type { ElementPlusSizePropType, InputSize } from '@/types';
import { ElInputNumber } from 'element-plus';
import { computed } from 'vue';
type InputNumberProps = {
size?: InputSize;
Expand All @@ -10,9 +11,24 @@ type InputNumberProps = {
precision?: number;
};
defineProps<InputNumberProps>();
const props = withDefaults(defineProps<InputNumberProps>(), {
size: undefined,
step: 1,
precision: 0,
min: -Infinity,
max: Infinity,
});
const resolvedSize = computed(() => props.size as ElementPlusSizePropType);
</script>

<template>
<ElInputNumber v-bind="{ ...$props, ...$attrs }" />
<ElInputNumber
:size="resolvedSize"
:min="min"
:max="max"
:step="step"
:precision="precision"
v-bind="$attrs"
/>
</template>
4 changes: 3 additions & 1 deletion packages/design-system/src/components/N8nLink/Link.vue
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import type { TextSize } from '@/types/text';
const THEME = ['primary', 'danger', 'text', 'secondary'] as const;
interface LinkProps {
to?: RouteLocationRaw;
to?: RouteLocationRaw | string;
size?: TextSize;
newWindow?: boolean;
bold?: boolean;
Expand All @@ -27,6 +27,8 @@ interface LinkProps {
defineOptions({ name: 'N8nLink' });
withDefaults(defineProps<LinkProps>(), {
to: undefined,
size: undefined,
bold: false,
underline: false,
theme: 'primary',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<template #content>{{ nodeTypeName }}</template>
<div v-if="type !== 'unknown'" :class="$style.icon">
<img v-if="type === 'file'" :src="src" :class="$style.nodeIconImage" />
<FontAwesomeIcon v-else :icon="name" :class="$style.iconFa" :style="fontStyleData" />
<FontAwesomeIcon v-else :icon="`${name}`" :class="$style.iconFa" :style="fontStyleData" />
</div>
<div v-else :class="$style.nodeIconPlaceholder">
{{ nodeTypeName ? nodeTypeName.charAt(0) : '?' }}
Expand All @@ -22,7 +22,7 @@
<template v-else>
<div v-if="type !== 'unknown'" :class="$style.icon">
<img v-if="type === 'file'" :src="src" :class="$style.nodeIconImage" />
<FontAwesomeIcon v-else :icon="name" :style="fontStyleData" />
<FontAwesomeIcon v-else :icon="`${name}`" :style="fontStyleData" />
<div v-if="badge" :class="$style.badge" :style="badgeStyleData">
<n8n-node-icon :type="badge.type" :src="badge.src" :size="badgeSize"></n8n-node-icon>
</div>
Expand Down
11 changes: 8 additions & 3 deletions packages/design-system/src/components/N8nRoute/Route.vue
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
<template>
<router-link v-if="useRouterLink" :to="to" v-bind="$attrs">
<router-link v-if="useRouterLink && to" :to="to" v-bind="$attrs">
<slot></slot>
</router-link>
<a v-else :href="to" :target="openNewWindow ? '_blank' : '_self'" v-bind="$attrs">
<a
v-else
:href="to ? `${to}` : undefined"
:target="openNewWindow ? '_blank' : '_self'"
v-bind="$attrs"
>
<slot></slot>
</a>
</template>
Expand All @@ -12,7 +17,7 @@ import { computed } from 'vue';
import { type RouteLocationRaw } from 'vue-router';
interface RouteProps {
to?: RouteLocationRaw;
to?: RouteLocationRaw | string;
newWindow?: boolean;
}
Expand Down
16 changes: 10 additions & 6 deletions packages/design-system/src/components/N8nSelect/Select.vue
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import { ElSelect } from 'element-plus';
import { type PropType, defineComponent } from 'vue';
import type { SelectSize } from '@/types';
import { isEventBindingElementAttribute } from '../../utils';
type InnerSelectRef = InstanceType<typeof ElSelect>;
Expand Down Expand Up @@ -86,13 +87,16 @@ export default defineComponent({
},
computed: {
listeners() {
return Object.entries(this.$attrs).reduce<Record<string, () => {}>>((acc, [key, value]) => {
if (/^on[A-Z]/.test(key)) {
acc[key] = value;
}
return Object.entries(this.$attrs).reduce<Record<string, (...args: unknown[]) => {}>>(
(acc, [key, value]) => {
if (isEventBindingElementAttribute(value, key)) {
acc[key] = value;
}
return acc;
}, {});
return acc;
},
{},
);
},
computedSize(): InnerSelectRef['$props']['size'] {
if (this.size === 'medium') {
Expand Down
Loading

0 comments on commit eef5479

Please sign in to comment.