@creatio/base 0.811.1 → 0.813.0

package/index.d.ts

@@ -4,6 +4,8 @@ declare interface BaseDataSourceFunctionConfig {
 
 /* Excluded from this release type: LookupMode */
 
+/* Excluded from this release type: UsedColumn */
+
 /**
  * @public
  * @description Represents abstract class.
@@ -107,6 +109,7 @@ export declare abstract class ɵArgumentFunctionExpression extends ɵFunctionExp
     protected constructor(config: ɵArgumentFunctionExpressionConfig<ɵArgumentFunctionExpression>);
     abstract clone(): ɵArgumentFunctionExpression;
     toJson(): ɵJsonObject;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 export declare type ɵArgumentFunctionExpressionConfig<TExpression extends ɵArgumentFunctionExpression> = ɵFunctionExpressionConfig<TExpression> & Pick<ɵArgumentFunctionExpression, 'functionArgument'>;
@@ -129,6 +132,7 @@ export declare class ɵArithmeticExpression extends ɵBaseExpression {
      */
     static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser?: TExpressionParser): ɵArithmeticExpression;
     clone(): ɵArithmeticExpression;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 export declare type ɵArithmeticExpressionConfig = ɵExpressionConfig<ɵArithmeticExpression> & Pick<ɵArithmeticExpression, 'arithmeticOperation' | 'leftArithmeticOperand' | 'rightArithmeticOperand'>;
@@ -164,6 +168,57 @@ export declare interface ɵBaseDataSourceParameter {
     relationsConfigs?: ɵDataSourceParameterRelationConfig[];
 }
 
+/**
+ * @public
+ * @description Config for button in dialog.
+ * @property {string} caption - Text witch will be displayed in button
+ * @property {ɵButtonColor} color - Color of button
+ */
+export declare interface ɵBaseDialogButtonConfig {
+    /**
+     * @description Text witch will be displayed in button
+     */
+    caption: string;
+    /**
+     * @description Color of button
+     */
+    color: ɵButtonColor;
+}
+
+/**
+ * @public
+ * @description Dialog configuration object
+ * @property {string} title - Header of dialog
+ * @property {string} message - Message witch will be displayed in dialog
+ * @property {ɵDialogAction[]} actions - List of actions in dialog
+ */
+export declare interface ɵBaseDialogConfig<TActionConfig extends ɵBaseDialogButtonConfig = ɵBaseDialogButtonConfig> {
+    /**
+     * @description Header text in dialog
+     */
+    title?: string;
+    /**
+     * @description Message witch will be displayed in dialog
+     */
+    message: string;
+    /**
+     * @description List of actions in dialog
+     */
+    actions: Array<ɵDialogAction<TActionConfig>>;
+}
+
+/**
+ * @public
+ * @description Service to working with dialog windows.
+ */
+export declare interface ɵBaseDialogService<TConfig extends ɵBaseDialogConfig = ɵBaseDialogConfig> {
+    /**
+     * Opens dialog.
+     * @param {ɵBaseDialogConfig} config Dialog configuration object
+     */
+    open(config: TConfig): Promise<string>;
+}
+
 export declare abstract class ɵBaseExpression implements ɵSerializable {
     /* Excluded from this release type: _instanceOfKey */
     /* Excluded from this release type: _instanceOfKeys */
@@ -183,6 +238,7 @@ export declare abstract class ɵBaseExpression implements ɵSerializable {
      * @public
      */
     toJson(): ɵJsonObject;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 /**
@@ -213,6 +269,7 @@ export declare abstract class ɵBaseFilter implements ɵSerializable {
      * @public
      */
     toJson(): ɵJsonObject;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 /**
@@ -223,6 +280,7 @@ export declare abstract class ɵBaseFilterableQuery extends ɵBaseQuery {
     protected constructor(operationType: ɵQueryOperationType, rootSchemaName: string);
     clearFilters(): void;
     getMetadata(): Record<string, unknown>;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 /**
@@ -233,6 +291,35 @@ export declare class ɵBaseFilterParser {
     static fromJson(dto: ɵJsonObject): unknown;
 }
 
+/**
+ * @public
+ * @description Provides implementation of service to work with mask.
+ */
+export declare interface ɵBaseMaskService {
+    /**
+     * @description Shows mask.
+     * @param taskName Name of task.
+     * @param context View model context.
+     */
+    showMask(taskName: string, context: ɵViewModelContext): Promise<void>;
+    /**
+     * @description Hides mask.
+     * @param taskName Name of task.
+     * @param context View model context.
+     */
+    hideMask(taskName: string, context: ɵViewModelContext): Promise<void>;
+    /**
+     * @description Shows mask for the whole available space on the screen.
+     * @param taskName Name of task.
+     */
+    showFullScreenMask(taskName: string): Promise<void>;
+    /**
+     * @description Hides full screen mask.
+     * @param taskName Name of task.
+     */
+    hideFullScreenMask(taskName: string): Promise<void>;
+}
+
 export declare interface ɵBaseModel<TLoadOptions extends ɵDataSourceLoadOptions> {
     getSchema(): Promise<ɵDataSchema>;
     load(config?: {
@@ -287,6 +374,7 @@ export declare abstract class ɵBaseQueryColumn<TExpression extends ɵBaseExpres
      * @returns Self.
      */
     withCaption(caption: string): this;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 /**
@@ -344,8 +432,15 @@ export declare class ɵBetweenFilter extends ɵSingleFilter {
     static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser: TExpressionParser): ɵBetweenFilter;
     clone(): ɵBetweenFilter;
     toJson(): ɵJsonObject;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
+/**
+ * @public
+ * @description button color theme name
+ */
+export declare type ɵButtonColor = 'primary' | 'accent' | 'warn' | 'default';
+
 export declare class ɵColumnExpression extends ɵBaseExpression {
     /* Excluded from this release type: _instanceOfKey */
     /* Excluded from this release type: _instanceOfKeys */
@@ -358,6 +453,7 @@ export declare class ɵColumnExpression extends ɵBaseExpression {
      */
     static fromJson(dto: ɵJsonObject): ɵColumnExpression;
     clone(): ɵColumnExpression;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 export declare type ɵColumnExpressionConfig = ɵExpressionConfig<ɵColumnExpression> & Pick<ɵColumnExpression, 'columnPath'>;
@@ -374,6 +470,7 @@ export declare class ɵCompareFilter extends ɵSingleFilter {
     static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser: TExpressionParser): ɵCompareFilter;
     clone(): ɵCompareFilter;
     toJson(): ɵJsonObject;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 export declare enum ɵComparisonType {
@@ -863,6 +960,23 @@ export declare class ɵDeleteQuery extends ɵBaseFilterableQuery {
     constructor(rootSchemaName: string);
 }
 
+/**
+ * @public
+ * @description Config for action in dialog.
+ * @property {string} key - Result witch will be returned after choose action
+ * @property {ɵBaseDialogButtonConfig} config - Config for button in dialog
+ */
+export declare interface ɵDialogAction<T extends ɵBaseDialogButtonConfig = ɵBaseDialogButtonConfig> {
+    /**
+     * @description Result witch will be returned after choose action
+     */
+    key: string;
+    /**
+     * @description Config for button in dialog
+     */
+    config: T;
+}
+
 /**
  * Empty Guid constant.
  * @public
@@ -1001,6 +1115,7 @@ export declare class ɵEntitySchemaQuery extends ɵBaseFilterableQuery {
      * @returns [WindowFunctionColumn] Column instance.
      */
     addWindowFunctionColumn(columnPath: string, aggregationType: ɵAggregationType, columnAlias: string, aggregationEvalType?: ɵAggregationEvalType): ɵWindowFunctionColumn;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 export declare class ɵExistsFilter extends ɵSingleFilter {
@@ -1016,6 +1131,7 @@ export declare class ɵExistsFilter extends ɵSingleFilter {
     static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser: TExpressionParser): ɵExistsFilter;
     clone(): ɵExistsFilter;
     toJson(): ɵJsonObject;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 export declare const ɵEXPRESSION_TYPE_MOCK: ɵExpressionType;
@@ -1029,6 +1145,7 @@ export declare class ɵExpressionMock extends ɵBaseExpression {
     constructor(config?: ɵExpressionConfig<ɵExpressionMock>);
     get plainObject(): object;
     clone(): ɵExpressionMock;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 /**
@@ -1067,12 +1184,19 @@ export declare class ɵFilterGroup extends ɵBaseFilter {
         [key: string]: ɵBaseFilter;
     };
     logicalOperation: ɵLogicalOperatorType;
-    constructor(logicalOperation?: ɵLogicalOperatorType);
+    rootSchemaName?: string;
+    constructor(logicalOperation?: ɵLogicalOperatorType, rootSchemaName?: string);
     /**
      * Parses filter group from json.
      * @public
      */
     static fromJson<T extends typeof ɵBaseFilterParser>(dto: ɵJsonObject, filterParser: T): ɵFilterGroup;
+    /**
+     * Converts instance to json object.
+     * @public
+     */
+    toJson(): ɵJsonObject;
+    private _createParameterValueExpressions;
     /**
      * Returns filter item by index.
      * @param index Item index.
@@ -1095,6 +1219,12 @@ export declare class ɵFilterGroup extends ɵBaseFilter {
      * @param filterKey Filter key.
      */
     addSchemaColumnInFilterWithParameters(comparisonType: ɵComparisonType, columnPath: string, parameterValues: ɵEntityColumnValue[], filterKey?: string): void;
+    /**
+     * Creates and adds in filter for primary column.
+     * @param primaryColumnValues Primary column values.
+     * @param filterKey Filter key.
+     */
+    addPrimarySchemaColumnInFilter(primaryColumnValues: ɵEntityColumnValue[], filterKey?: string): void;
     addSchemaColumnIsNullFilter(columnPath: string, filterKey?: string): void;
     /**
      * Creates and adds not null filter.
@@ -1114,6 +1244,7 @@ export declare class ɵFilterGroup extends ɵBaseFilter {
     addNotExistsFilter(columnPath: string, subFilters?: ɵFilterGroup, filterKey?: string): void;
     add(filter: ɵBaseFilter, filterKey?: string): void;
     clone(): ɵFilterGroup;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 export declare class ɵFilterMock extends ɵBaseFilter {
@@ -1122,6 +1253,7 @@ export declare class ɵFilterMock extends ɵBaseFilter {
     constructor(filterType?: ɵFilterType);
     get plainObject(): object;
     clone(): ɵFilterMock;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 /**
@@ -1213,6 +1345,7 @@ export declare class ɵInFilter extends ɵSingleFilter {
     static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser: TExpressionParser): ɵInFilter;
     clone(): ɵInFilter;
     toJson(): ɵJsonObject;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 /**
@@ -1256,6 +1389,28 @@ export declare class ɵIsNullFilter extends ɵSingleFilter {
     clone(): ɵIsNullFilter;
 }
 
+/**
+ * @public
+ * @description Config to create item in collection.
+ * @property {number} index - Index of item in collection.
+ * @property {Record<string, unknown>} initialAttributeValues - Initial attribute values.
+ * @property {ɵJsonObject} initialModelValues - Initial values of the model.
+ */
+export declare interface ɵItemCreationConfig {
+    /**
+     * @description Index of item in collection.
+     */
+    index?: number;
+    /**
+     * @description Initial attribute values.
+     */
+    initialAttributeValues?: Record<string, unknown>;
+    /**
+     * @description Initial values of the model.
+     */
+    initialModelValues?: ɵJsonObject;
+}
+
 export declare class ɵItemNotFoundException extends Error {
     constructor(key: string);
 }
@@ -1369,13 +1524,15 @@ export declare class ɵMacrosFunctionExpression extends ɵFunctionExpression {
     /* Excluded from this release type: _instanceOfKeys */
     readonly functionType: ɵFunctionType;
     readonly macrosType: ɵQueryMacrosType;
+    readonly functionArgument?: ɵBaseExpression;
     constructor(config: ɵMacrosFunctionExpressionConfig);
     /**
      * Parses expression from json.
      * @public
      */
-    static fromJson(dto: ɵJsonObject): ɵMacrosFunctionExpression;
+    static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser?: TFilterParser, expressionParser?: TExpressionParser): ɵMacrosFunctionExpression;
     clone(): ɵMacrosFunctionExpression;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 export declare type ɵMacrosFunctionExpressionConfig = ɵFunctionExpressionConfig<ɵMacrosFunctionExpression> & Pick<ɵMacrosFunctionExpression, 'macrosType'>;
@@ -1387,6 +1544,69 @@ export declare interface ɵMetadataProvider<T> {
     getMetadata(): T;
 }
 
+/**
+ * @public
+ * @description Default value of the model.
+ * @property {string} attributeName - Name of the attribute of the model.
+ * @property {unknown} value - Value of the attribute of the model.
+ */
+export declare interface ɵModelDefaultValue {
+    /**
+     * @description Name of the attribute of the model
+     */
+    attributeName: string;
+    /**
+     * @description Value of the attribute of the model
+     */
+    value: unknown;
+}
+
+/**
+ * @public
+ * @description Initial config of the model.
+ * @property {string} name - Name of the model.
+ * @property {string} recordId - Primary value of the record.
+ * @property {ɵModelInPageAction} action - Type of the action. {@link ɵModelInPageAction}
+ * @property {Array<ɵModelDefaultValue>} defaultValues - Default values of the model. {@link ɵModelDefaultValue}
+ */
+export declare interface ɵModelInitConfig {
+    /**
+     * @description Name of the model in modelConfig that should be initialized.
+     */
+    name?: string;
+    /**
+     * @description Primary value of the record.
+     */
+    recordId?: string;
+    /**
+     * @description Type of the action. {@link ɵModelInPageAction}
+     */
+    action: ɵModelInPageAction;
+    /**
+     * @description Default values of the model. {@link ɵModelDefaultValue}
+     */
+    defaultValues?: Array<ɵModelDefaultValue>;
+}
+
+/**
+ * @public
+ * @description Type of the action of the model.
+ */
+export declare enum ɵModelInPageAction {
+    /**
+     * @description Action for editing existed record.
+     */
+    Edit = "edit",
+    /**
+     * @description Action for adding new record.
+     */
+    Add = "add",
+    /**
+     * @description Action for copying the record.
+     */
+    Copy = "copy"
+}
+
 /**
  * @public
  */
@@ -1431,6 +1651,7 @@ export declare class ɵParameterExpression extends ɵBaseExpression {
     private _convertStringToBlobArray;
     private _getParameterValueMetadata;
     clone(): ɵParameterExpression;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 export declare type ɵParameterExpressionConfig = ɵExpressionConfig<ɵParameterExpression> & Pick<ɵParameterExpression, 'value'>;
@@ -1558,12 +1779,58 @@ export declare interface ɵRequestHandler<TRequest = ɵBaseRequest, TResult = un
     setNext(next: ɵRequestHandler): void;
 }
 
+/**
+ * @public
+ * @description Config for register request.
+ * @property {string} type - The type of request.
+ * @property {string[]} scopes - Scopes of request.
+ * @property {string} title - Title of request.
+ * @property {string} propertiesPanelComponentTypeName - Type of properties panel
+ * @property {number} position - Position of the request
+ */
+export declare interface ɵRequestRegistrationConfig {
+    /**
+     * @description The type of request.
+     * @example
+     * 'crt.RequestType'
+     */
+    readonly type: string;
+    /**
+     * @description Scopes of request
+     */
+    readonly scopes?: string[];
+    /* Excluded from this release type: title */
+    /* Excluded from this release type: propertiesPanelComponentTypeName */
+    /* Excluded from this release type: position */
+}
+
 /**
  * @public
  * @description Function that takes a injection token, and returns dependency instance.
  */
 export declare type ɵResolveDependencyFn = (token: unknown) => unknown;
 
+/**
+ * @public
+ * @description Request to show mask.
+ */
+export declare class ɵSchemaViewMaskRequest extends ɵBaseRequest {
+    readonly action: ɵSchemaViewMaskRequestAction;
+    readonly taskName: string;
+    readonly $context: ɵViewModelContext;
+    readonly type = "crt.SchemaViewMaskRequest";
+    constructor(action: ɵSchemaViewMaskRequestAction, taskName: string, $context: ɵViewModelContext);
+}
+
+/**
+ * @public
+ * @description Actions of mask request.
+ */
+export declare enum ɵSchemaViewMaskRequestAction {
+    AddTask = "addTask",
+    RemoveTask = "removeTask"
+}
+
 /**
  * @public
  */
@@ -1581,6 +1848,7 @@ export declare abstract class ɵSingleFilter extends ɵBaseFilter {
     readonly leftExpression: ɵBaseExpression;
     protected constructor(filterType: ɵFilterType, comparisonType: ɵComparisonType, leftExpression: ɵBaseExpression);
     toJson(): ɵJsonObject;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 /**
@@ -1617,6 +1885,7 @@ export declare class ɵSubQueryExpression extends ɵBaseExpression {
     static fromJson<TFilterParser extends typeof ɵBaseFilterParser>(dto: ɵJsonObject, filterParser: TFilterParser): ɵSubQueryExpression;
     clone(): ɵSubQueryExpression;
     toJson(): ɵJsonObject;
+    /* Excluded from this release type: _getUsedColumns */
 }
 
 export declare type ɵSubQueryExpressionConfig = ɵExpressionConfig<ɵSubQueryExpression> & Pick<ɵSubQueryExpression, 'columnPath'>;
@@ -1670,6 +1939,18 @@ export declare class ɵValidationUtilities {
     }): void;
 }
 
+/**
+ * @public
+ * @description Interface describes the collection of view models.
+ */
+export declare interface ɵViewModelCollection<T extends ɵViewModelContext> {
+    /**
+     * @description Abstract async method to create item in collection.
+     * @param {ɵItemCreationConfig} config - {@link ɵItemCreationConfig}
+     */
+    createItem(config?: ɵItemCreationConfig): Promise<T>;
+}
+
 /**
  * @public
  * @description Interface describes view model context.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@creatio/base",
-  "version": "0.811.1",
+  "version": "0.813.0",
   "license": "SEE LICENSE IN LICENSE.md",
   "description": "Internal API to create customizations and integrations for Creatio platform.",
   "keywords": [
@@ -9,7 +9,7 @@
     "base"
   ],
   "peerDependencies": {
-    "class-transformer": "^0.4.0"
+    "class-transformer": "0.5.1"
   },
   "dependencies": {
     "tslib": "^2.3.0"