Skip to content

EspoCRM – Open Source CRM Application

TS migration

Yurii40ee0a6d7e80
diff --git a/client/src/views/fields/base.ts b/client/src/views/fields/base.ts
index da250cf7a6..139b1a6b01 100644
--- a/client/src/views/fields/base.ts
+++ b/client/src/views/fields/base.ts
@@ -105,8 +105,8 @@ type Mode = 'list' | 'listLink' | 'detail' | 'edit' | 'search';
*/
export default class BaseFieldView<
S extends ViewSchema = ViewSchema,
- P extends Params = Params,
O extends Options = Options,
+ P extends Params = Params,
> extends View<{model: S['model']}> {
options: O & {params: P}
diff --git a/client/src/views/fields/bool.ts b/client/src/views/fields/bool.ts
index 8c1dd393b5..b2ee5b477f 100644
--- a/client/src/views/fields/bool.ts
+++ b/client/src/views/fields/bool.ts
@@ -44,7 +44,8 @@ interface Options extends BaseOptions {}
export default class BoolFieldView<
S extends ViewSchema = ViewSchema,
O extends Options = Options,
-> extends BaseFieldView<S, Params, O> {
+ P extends Params = Params,
+> extends BaseFieldView<S, O, P> {
readonly type = 'bool'
diff --git a/client/src/views/fields/date.ts b/client/src/views/fields/date.ts
index 4236bd35d8..d01988f42e 100644
--- a/client/src/views/fields/date.ts
+++ b/client/src/views/fields/date.ts
@@ -71,9 +71,10 @@ interface Options extends BaseOptions {
class DateFieldView<
S extends ViewSchema = ViewSchema,
O extends Options = Options,
-> extends BaseFieldView<S, Params, O> {
+ P extends Params = Params,
+> extends BaseFieldView<S, O, P> {
- readonly type = 'date'
+ readonly type: string = 'date'
protected listTemplate = 'fields/date/list'
protected listLinkTemplate = 'fields/date/list-link'
@@ -321,7 +322,7 @@ class DateFieldView<
return this.getDateTime().toDisplayDate(date);
}
- afterRender() {
+ protected afterRender() {
if (this.isEditMode() || this.isSearchMode()) {
this.mainInputElement = this.element?.querySelector(`[data-name="${this.name}"]`);
@@ -436,10 +437,7 @@ class DateFieldView<
return data;
}
- /**
- * @inheritDoc
- */
- fetchSearch() {
+ fetchSearch(): Record<string, any> | null {
const type = this.fetchSearchType();
if (this.searchWithRangeTypeList.includes(type)) {
@@ -606,10 +604,9 @@ class DateFieldView<
}
/**
- * @protected
* @since 9.2.0
*/
- onAfterChange() {
+ protected onAfterChange() {
const after = this.params.after as string;
const from = this.model.attributes[after] as string | undefined;
diff --git a/client/src/views/fields/datetime.js b/client/src/views/fields/datetime.ts
similarity index 78%
rename from client/src/views/fields/datetime.js
rename to client/src/views/fields/datetime.ts
index fcd979ffba..b87b4c3166 100644
--- a/client/src/views/fields/datetime.js
+++ b/client/src/views/fields/datetime.ts
@@ -30,61 +30,70 @@
import DateFieldView from 'views/fields/date';
import moment from 'moment';
+import {Options as BaseOptions, ViewSchema} from 'views/fields/base';
+import JQuery from 'jquery'
-/**
- * A date-time field.
- *
- * @extends DateFieldView<module:views/fields/datetime~params>
- */
-class DatetimeFieldView extends DateFieldView {
+const $ = JQuery;
+interface Params {
/**
- * @typedef {Object} module:views/fields/datetime~options
- * @property {
- * module:views/fields/varchar~params &
- * module:views/fields/base~params &
- * Record
- * } [params] Parameters.
- * @property {string} [otherFieldLabelText] A label text of other field. Used in before/after validations.
+ * Required.
*/
-
+ required?: boolean;
+ /**
+ * Use numeric format.
+ */
+ useNumericFormat?: boolean;
+ /**
+ * Display seconds.
+ */
+ hasSeconds?: boolean;
+ /**
+ * A minutes step.
+ */
+ minuteStep?: number;
+ /**
+ * Validate to be after another date field.
+ */
+ after?: string;
+ /**
+ * Validate to be before another date field.
+ */
+ before?: string;
/**
- * @typedef {Object} module:views/fields/datetime~params
- * @property {boolean} [required] Required.
- * @property {boolean} [useNumericFormat] Use numeric format.
- * @property {boolean} [hasSeconds] Display seconds.
- * @property {number} [minuteStep] A minute step.
- * @property {string} [after] Validate to be after another date field.
- * @property {string} [before] Validate to be before another date field.
- * @property {boolean} [afterOrEqual] Allow an equal date for 'after' validation.
+ * Allow an equal date for 'after' validation.
*/
+ afterOrEqual?: boolean;
+}
+interface Options extends BaseOptions {
/**
- * @param {
- * module:views/fields/datetime~options &
- * module:views/fields/base~options
- * } options Options.
+ * A label text of other field. Used in before/after validations.
*/
- constructor(options) {
- super(options);
- }
+ otherFieldLabelText?: string;
+}
+
+/**
+ * A date-time field.
+ */
+class DatetimeFieldView<
+ S extends ViewSchema = ViewSchema,
+ O extends Options = Options,
+ P extends Params = Params,
+> extends DateFieldView<S, O, P> {
- type = 'datetime'
+ readonly type: string = 'datetime'
- editTemplate = 'fields/datetime/edit'
+ protected editTemplate = 'fields/datetime/edit'
- /**
- * @inheritDoc
- * @type {Array<(function (): boolean)|string>}
- */
- validations = [
+ protected validations = [
'required',
'datetime',
'after',
'before',
]
- searchTypeList = [
+ protected searchTypeList = [
'lastSevenDays',
'ever',
'isEmpty',
@@ -108,7 +117,7 @@ class DatetimeFieldView extends DateFieldView {
'between',
]
- timeFormatMap = {
+ readonly timeFormatMap: Record<string, string> = {
'HH:mm': 'H:i',
'hh:mm A': 'h:i A',
'hh:mm a': 'h:i a',
@@ -116,7 +125,15 @@ class DatetimeFieldView extends DateFieldView {
'hh:mma': 'h:ia',
}
- data() {
+ private $date: JQuery | null = null
+ private $time: JQuery | null = null
+
+ /**
+ * A none option value,
+ */
+ protected noneOption: string | null = null
+
+ protected data() {
const data = super.data();
data.date = data.time = '';
@@ -133,7 +150,7 @@ class DatetimeFieldView extends DateFieldView {
return data;
}
- getDateStringValue() {
+ protected getDateStringValue(): string | -1 | null {
if (this.mode === this.MODE_DETAIL && !this.model.has(this.name)) {
return -1;
}
@@ -169,6 +186,7 @@ class DatetimeFieldView extends DateFieldView {
}
const d = this.getDateTime().toMoment(value);
+ // @ts-ignore
const now = moment().tz(this.getDateTime().timeZone || 'UTC');
const dt = now.clone().startOf('day');
@@ -202,11 +220,12 @@ class DatetimeFieldView extends DateFieldView {
return this.getDateTime().toDisplay(value);
}
- initTimepicker() {
+ protected initTimepicker() {
const $time = this.$time;
const modalBodyElement = this.element.closest('.modal-body');
+ // @ts-ignore
$time.timepicker({
step: this.params.minuteStep || 30,
scrollDefaultNow: true,
@@ -215,46 +234,48 @@ class DatetimeFieldView extends DateFieldView {
});
$time
- .parent()
+ ?.parent()
.find('button.time-picker-btn')
.on('click', () => {
+ // @ts-ignore
$time.timepicker('show');
});
}
- setDefaultTime() {
+ protected setDefaultTime() {
const dtString = moment('2014-01-01 00:00').format(this.getDateTime().getDateTimeFormat()) || '';
const pair = this.splitDatetime(dtString);
if (pair.length === 2) {
- this.$time.val(pair[1]);
+ this.$time?.val(pair[1]);
}
}
- splitDatetime(value) {
+ protected splitDatetime(value: string): [string, string] {
const m = moment(value, this.getDateTime().getDateTimeFormat());
const dateValue = m.format(this.getDateTime().getDateFormat());
- const timeValue = value.substr(dateValue.length + 1);
+ const timeValue = value.substring(dateValue.length + 1);
return [dateValue, timeValue];
}
- setup() {
+ protected setup() {
super.setup();
this.on('remove', () => this.destroyTimepicker());
this.on('mode-changed', () => this.destroyTimepicker());
}
- destroyTimepicker() {
+ protected destroyTimepicker() {
if (this.$time && this.$time[0]) {
+ // @ts-ignore
this.$time.timepicker('remove');
}
}
- afterRender() {
+ protected afterRender() {
super.afterRender();
if (this.mode !== this.MODE_EDIT) {
@@ -266,8 +287,8 @@ class DatetimeFieldView extends DateFieldView {
this.initTimepicker();
- this.$element.on('change.datetime', () => {
- if (this.$element.val() && !$time.val()) {
+ this.$element?.on('change.datetime', () => {
+ if (this.$element?.val() && !$time.val()) {
this.setDefaultTime();
this.trigger('change');
}
@@ -285,7 +306,7 @@ class DatetimeFieldView extends DateFieldView {
return;
}
- if (this.noneOption && $time.val() === '' && this.$date.val() !== '') {
+ if (this.noneOption && $time.val() === '' && this.$date?.val() !== '') {
$time.val(this.noneOption);
return;
@@ -308,11 +329,7 @@ class DatetimeFieldView extends DateFieldView {
});
}
- /**
- * @param {string} string
- * @return {string|-1|null}
- */
- parse(string) {
+ protected parse(string: string): string| -1| null {
if (!string) {
return null;
}
@@ -321,10 +338,10 @@ class DatetimeFieldView extends DateFieldView {
}
fetch() {
- const data = {};
+ const data = {} as Record<string, any>;
- const date = this.$date.val();
- const time = this.$time.val();
+ const date = this.$date?.val();
+ const time = this.$time?.val();
let value = null;
@@ -347,10 +364,11 @@ class DatetimeFieldView extends DateFieldView {
return true;
}
+
+ return false;
}
- /** @inheritDoc */
- fetchSearch() {
+ fetchSearch(): Record<string, any> | null {
const data = super.fetchSearch();
if (data) {
@@ -365,7 +383,7 @@ class DatetimeFieldView extends DateFieldView {
* Not implemented. For datetimeOptions too.
* When implementing, keep in mind the duration field.
*/
- onAfterChange() {}
+ protected onAfterChange() {}
}
export default DatetimeFieldView;
diff --git a/client/src/views/fields/varchar.ts b/client/src/views/fields/varchar.ts
index e3ae418d7e..778cde26a2 100644
--- a/client/src/views/fields/varchar.ts
+++ b/client/src/views/fields/varchar.ts
@@ -80,8 +80,9 @@ type AutocompleteReturn = Promise<import('ui/autocomplete').AutocompleteItem & R
*/
class VarcharFieldView<
S extends ViewSchema = ViewSchema,
+ P extends Params = Params,
O extends Options = Options,
-> extends BaseFieldView<S, Params, O> {
+> extends BaseFieldView<S, O, P> {
readonly type = 'varchar'