EspoCRM – Open Source CRM Application
PHP calendarcontactscrmcrm-platformcrm-systemcustomer-portalcustomer-supportcustomizabledocumentsemail-marketingkanbanleadsopen-sourcephpplatformsales-automationsingle-page-applicationsupport
TS ref
Yuriia09bb91fbdc6
diff --git a/client/src/collection.ts b/client/src/collection.tsindex d771ea97bc..b2cbd35428 100644--- a/client/src/collection.ts+++ b/client/src/collection.ts@@ -82,7 +82,7 @@ export interface WhereItem {/*** Search data.*/-export interface Data {+export interface SearchData {primaryFilter?: string | null;boolFilterList?: string[];textFilter?: string;@@ -90,12 +90,12 @@ export interface Data {q?: string;}-/**- * @property model A class.- */-export interface Options {+export interface CollectionOptions {+ /**+ * A model.+ */model?: typeof Model;- defs: import('model').Defs;+ defs: import('model').ModelDefs;maxSize?: number;entityType?: string | null;urlRoot?: string;@@ -199,7 +199,7 @@ export default class Collection<TModel extends Model = Model> {/*** Model definitions.*/- protected defs: import('model').Defs | null+ protected defs: import('model').ModelDefs | null/*** A model type.@@ -209,7 +209,7 @@ export default class Collection<TModel extends Model = Model> {/*** Search data.*/- data: Data & Record<string, any>+ data: SearchData & Record<string, any>/*** Models. Do not write, do not mutate.@@ -226,7 +226,7 @@ export default class Collection<TModel extends Model = Model> {* @param {{* entityType?: string,* model?: Model.prototype,- * defs?: import('model').Defs,+ * defs?: import('model').ModelDefs,* order?: 'asc'|'desc'|boolean|null,* orderBy?: string|null,* urlRoot?: string,@@ -236,7 +236,7 @@ export default class Collection<TModel extends Model = Model> {*/constructor(models: TModel[] | Record<string, any>[] | null,- options: Options,+ options: CollectionOptions,) {options = {...options};diff --git a/client/src/model.ts b/client/src/model.tsindex 7455487fcb..a79406ee88 100644--- a/client/src/model.ts+++ b/client/src/model.ts@@ -64,7 +64,7 @@ export interface SetRelateItem {/*** Definitions.*/-export interface Defs {+export interface ModelDefs {fields?: Record<string, FieldDefs & Record<string, any>>;links?: Record<string, Record<string, any>>;}@@ -76,12 +76,12 @@ interface FieldDefs {type: string;}-export interface Options {+export interface ModelOptions {collection?: Collection;entityType?: string;urlRoot?: string;url?: string;- defs?: Defs;+ defs?: ModelDefs;user?: User;}@@ -153,11 +153,11 @@ export default class Model<T extends Record<string, unknown> = Record<string, an* Definitions.* @internal*/- public defs: Defs+ public defs: ModelDefsconstructor(attributes?: Partial<T> | Model<T>,- options?: Options,+ options?: ModelOptions,) {options = options || {};@@ -798,7 +798,7 @@ export default class Model<T extends Record<string, unknown> = Record<string, an** @param defs Definitions.*/- setDefs(defs: Defs): void {+ setDefs(defs: ModelDefs): void {this.defs = defs || {};if (!this.defs.fields) {diff --git a/client/src/views/fields/array.ts b/client/src/views/fields/array.tsindex ac5a993fb8..1125e10bac 100644--- a/client/src/views/fields/array.ts+++ b/client/src/views/fields/array.ts@@ -28,7 +28,7 @@/** @module views/fields/array */-import BaseFieldView, {Options as BaseOptions, Params as BaseParams, ViewSchema} from 'views/fields/base';+import BaseFieldView, {BaseOptions as BaseOptions, BaseParams as BaseParams, BaseViewSchema} from 'views/fields/base';import RegExpPattern from 'helpers/reg-exp-pattern';import MultiSelect from 'ui/multi-select';import ModalView, {ModalOptions} from 'views/modal';@@ -45,7 +45,7 @@ type StyleMap = Record<string, 'warning' | 'danger' | 'success' | 'info' | 'prim/*** Parameters.*/-export interface Params extends BaseParams {+export interface ArrayParams extends BaseParams {/*** A translation string. E.g. `Global.scopeNames`.*/@@ -125,7 +125,7 @@ export interface Params extends BaseParams {/*** Options.*/-export interface Options extends BaseOptions {+export interface ArrayOptions extends BaseOptions {/*** Option translations.*/@@ -140,9 +140,9 @@ export interface Options extends BaseOptions {* An array field.*/class ArrayFieldView<- S extends ViewSchema = ViewSchema,- P extends Params = Params,- O extends Options = Options,+ S extends BaseViewSchema = BaseViewSchema,+ P extends ArrayParams = ArrayParams,+ O extends ArrayOptions = ArrayOptions,> extends BaseFieldView<S, O, P> {readonly type = 'array'diff --git a/client/src/views/fields/base.ts b/client/src/views/fields/base.tsindex f75f942af0..27bfe5adf6 100644--- a/client/src/views/fields/base.ts+++ b/client/src/views/fields/base.ts@@ -40,7 +40,7 @@ const $ = JQuery;/*** Options.*/-export interface Options {+export interface BaseOptions {/*** A field name.*/@@ -87,12 +87,15 @@ export interface Options {* @property inlineEditDisabled Disable inline edit.* @property readOnly Is read-only.*/-export interface Params {+export interface BaseParams {inlineEditDisabled?: boolean;readOnly?: boolean;}-export interface ViewSchema {+/**+ * @internal+ */+export interface BaseViewSchema {model: Model;}@@ -104,9 +107,9 @@ type Mode = 'list' | 'listLink' | 'detail' | 'edit' | 'search';* @todo Document events.*/export default class BaseFieldView<- S extends ViewSchema = ViewSchema,- O extends Options = Options,- P extends Params = Params,+ S extends BaseViewSchema = BaseViewSchema,+ O extends BaseOptions = BaseOptions,+ P extends BaseParams = BaseParams,> extends View<{model: S['model']}> {options: O & {params: P}diff --git a/client/src/views/fields/bool.ts b/client/src/views/fields/bool.tsindex 7fe50ec90b..5d7066f10f 100644--- a/client/src/views/fields/bool.ts+++ b/client/src/views/fields/bool.ts@@ -30,21 +30,21 @@import BaseFieldView from 'views/fields/base';import Select from 'ui/select';-import {Options as BaseOptions} from 'views/fields/base';-import {Params as BaseParams} from 'views/fields/base';-import {ViewSchema} from 'views/fields/base';+import {BaseOptions as BaseOptions} from 'views/fields/base';+import {BaseParams as BaseParams} from 'views/fields/base';+import {BaseViewSchema} from 'views/fields/base';-export interface Params extends BaseParams {}+export interface BoolParams extends BaseParams {}-export interface Options extends BaseOptions {}+export interface BoolOptions extends BaseOptions {}/*** A boolean field (checkbox).*/export default class BoolFieldView<- S extends ViewSchema = ViewSchema,- O extends Options = Options,- P extends Params = Params,+ S extends BaseViewSchema = BaseViewSchema,+ O extends BoolOptions = BoolOptions,+ P extends BoolParams = BoolParams,> extends BaseFieldView<S, O, P> {readonly type = 'bool'diff --git a/client/src/views/fields/date.ts b/client/src/views/fields/date.tsindex ca75126ea4..3d9cc9e1d1 100644--- a/client/src/views/fields/date.ts+++ b/client/src/views/fields/date.ts@@ -28,14 +28,14 @@/** @module views/fields/date */-import BaseFieldView, {Options as BaseOptions, Params as BaseParams, ViewSchema} from 'views/fields/base';+import BaseFieldView, {BaseOptions as BaseOptions, BaseParams as BaseParams, BaseViewSchema} from 'views/fields/base';import moment from 'moment';import Datepicker from 'ui/datepicker';import JQuery from 'jquery'const $ = JQuery;-export interface Params extends BaseParams {+export interface DateParams extends BaseParams {/*** Required.*/@@ -58,7 +58,7 @@ export interface Params extends BaseParams {afterOrEqual?: boolean;}-export interface Options extends BaseOptions {+export interface DateOptions extends BaseOptions {/*** A label text of other field. Used in before/after validations.*/@@ -69,9 +69,9 @@ export interface Options extends BaseOptions {* A date field.*/class DateFieldView<- S extends ViewSchema = ViewSchema,- O extends Options = Options,- P extends Params = Params,+ S extends BaseViewSchema = BaseViewSchema,+ O extends DateOptions = DateOptions,+ P extends DateParams = DateParams,> extends BaseFieldView<S, O, P> {readonly type: string = 'date'diff --git a/client/src/views/fields/datetime-optional.ts b/client/src/views/fields/datetime-optional.tsindex 86a86a91aa..706da49e77 100644--- a/client/src/views/fields/datetime-optional.ts+++ b/client/src/views/fields/datetime-optional.ts@@ -30,7 +30,7 @@import DatetimeFieldView from 'views/fields/datetime';import moment from 'moment';-import {Options as BaseOptions, ViewSchema} from 'views/fields/base';+import {BaseOptions as BaseOptions, BaseViewSchema} from 'views/fields/base';interface Params {/**@@ -70,7 +70,7 @@ interface Options extends BaseOptions {* A date-time or date.*/class DatetimeOptionalFieldView<- S extends ViewSchema = ViewSchema,+ S extends BaseViewSchema = BaseViewSchema,O extends Options = Options,P extends Params = Params,> extends DatetimeFieldView<S, O, P> {diff --git a/client/src/views/fields/datetime.ts b/client/src/views/fields/datetime.tsindex 7402f9a254..6d39b091e3 100644--- a/client/src/views/fields/datetime.ts+++ b/client/src/views/fields/datetime.ts@@ -30,12 +30,12 @@import DateFieldView from 'views/fields/date';import moment from 'moment';-import {Options as BaseOptions, ViewSchema} from 'views/fields/base';+import {BaseOptions as BaseOptions, BaseViewSchema} from 'views/fields/base';import JQuery from 'jquery'const $ = JQuery;-export interface Params {+export interface DatetimeParams {/*** Required.*/@@ -66,7 +66,7 @@ export interface Params {afterOrEqual?: boolean;}-export interface Options extends BaseOptions {+export interface DatetimeOptions extends BaseOptions {/*** A label text of other field. Used in before/after validations.*/@@ -77,9 +77,9 @@ export interface Options extends BaseOptions {* A date-time field.*/class DatetimeFieldView<- S extends ViewSchema = ViewSchema,- O extends Options = Options,- P extends Params = Params,+ S extends BaseViewSchema = BaseViewSchema,+ O extends DatetimeOptions = DatetimeOptions,+ P extends DatetimeParams = DatetimeParams,> extends DateFieldView<S, O, P> {readonly type: string = 'datetime'diff --git a/client/src/views/fields/enum.ts b/client/src/views/fields/enum.tsindex aa13fdaaf7..98a00e0e4b 100644--- a/client/src/views/fields/enum.ts+++ b/client/src/views/fields/enum.ts@@ -28,7 +28,7 @@/** @module views/fields/enumeration */-import BaseFieldView, {Options as BaseOptions, Params as BaseParams, ViewSchema} from 'views/fields/base';+import BaseFieldView, {BaseOptions as BaseOptions, BaseParams as BaseParams, BaseViewSchema} from 'views/fields/base';import MultiSelect from 'ui/multi-select';import Select from 'ui/select'import _ from 'underscore';@@ -44,7 +44,7 @@ type StyleMap = Record<string, 'warning' | 'danger' | 'success' | 'info' | 'prim/*** Parameters.*/-export interface Params extends BaseParams {+export interface EnumParams extends BaseParams {/*** Select options.*/@@ -90,7 +90,7 @@ export interface Params extends BaseParams {/*** Options.*/-export interface Options extends BaseOptions {+export interface EnumOptions extends BaseOptions {/*** Handles an option item to override the label or add a style.* @since 10.0.0@@ -110,9 +110,9 @@ export interface Options extends BaseOptions {* An enum field (select-box).*/class EnumFieldView<- S extends ViewSchema = ViewSchema,- P extends Params = Params,- O extends Options = Options,+ S extends BaseViewSchema = BaseViewSchema,+ P extends EnumParams = EnumParams,+ O extends EnumOptions = EnumOptions,> extends BaseFieldView<S, O, P> {readonly type = 'enum'diff --git a/client/src/views/fields/varchar.ts b/client/src/views/fields/varchar.tsindex 986d8c013d..8c6e7413c4 100644--- a/client/src/views/fields/varchar.ts+++ b/client/src/views/fields/varchar.ts@@ -28,14 +28,14 @@/** @module views/fields/varchar */-import BaseFieldView, {Options as BaseOptions, Params as BaseParams, ViewSchema} from 'views/fields/base';+import BaseFieldView, {BaseOptions as BaseOptions, BaseParams as BaseParams, BaseViewSchema} from 'views/fields/base';import RegExpPattern from 'helpers/reg-exp-pattern';import Autocomplete from 'ui/autocomplete';import MultiSelect from 'ui/multi-select';import Ajax from 'ajax';import Ui from 'ui';-export interface Params extends BaseParams {+export interface VarcharParams extends BaseParams {/*** Max length.*/@@ -66,7 +66,7 @@ export interface Params extends BaseParams {copyToClipboard?: boolean;}-export interface Options extends BaseOptions {+export interface VarcharOptions extends BaseOptions {/*** Custom autocomplete options.*/@@ -79,9 +79,9 @@ type AutocompleteReturn = Promise<import('ui/autocomplete').AutocompleteItem & R* A varchar field.*/class VarcharFieldView<- S extends ViewSchema = ViewSchema,- P extends Params = Params,- O extends Options = Options,+ S extends BaseViewSchema = BaseViewSchema,+ P extends VarcharParams = VarcharParams,+ O extends VarcharOptions = VarcharOptions,> extends BaseFieldView<S, O, P> {readonly type = 'varchar'diff --git a/client/src/views/modals/select-records.js b/client/src/views/modals/select-records.jsindex 80b2e2da44..deed3fdbc5 100644--- a/client/src/views/modals/select-records.js+++ b/client/src/views/modals/select-records.js@@ -101,7 +101,7 @@ class SelectRecordsModalView extends ModalView {* @property {function(): Promise<Record>} [createAttributesProvider] Create-attributes provider.* @property {Record} [createAttributes] Create-attributes.* @property {function(import('model').default[])} [onSelect] On record select. As of 9.0.0.- * @property {function({where: Record[], searchParams: import('collection').Data})} [onMassSelect]+ * @property {function({where: Record[], searchParams: import('collection').SearchData})} [onMassSelect]* On record select. As of 9.1.0.* @property {function()} [onCreate] On create click. As of 9.0.5.* @property {boolean} [searchPanelDisabled] Disable the search panel.