@creatio/base 0.811.0 → 0.812.0

package/index.d.ts

@@ -164,6 +164,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 */
@@ -178,7 +229,11 @@ export declare abstract class ɵBaseExpression implements ɵSerializable {
     static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser?: TExpressionParser): ɵBaseExpression;
     protected serializeItem(item: ɵSerializable): ɵJsonObject;
     abstract clone(): ɵBaseExpression;
-    /* Excluded from this release type: toJson */
+    /**
+     * Converts instance to json object.
+     * @public
+     */
+    toJson(): ɵJsonObject;
 }
 
 /**
@@ -204,7 +259,11 @@ export declare abstract class ɵBaseFilter implements ɵSerializable {
     static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser: TExpressionParser): ɵBaseFilter;
     protected serializeItem(item: ɵSerializable): ɵJsonObject;
     abstract clone(): ɵBaseFilter;
-    /* Excluded from this release type: toJson */
+    /**
+     * Converts instance to json object.
+     * @public
+     */
+    toJson(): ɵJsonObject;
 }
 
 /**
@@ -338,6 +397,12 @@ export declare class ɵBetweenFilter extends ɵSingleFilter {
     toJson(): ɵJsonObject;
 }
 
+/**
+ * @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 */
@@ -855,6 +920,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
@@ -1059,12 +1141,14 @@ 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;
+    private _createParameterValueExpressions;
     /**
      * Returns filter item by index.
      * @param index Item index.
@@ -1087,6 +1171,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.
@@ -1361,12 +1451,13 @@ 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;
 }
 
@@ -1379,6 +1470,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
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@creatio/base",
-  "version": "0.811.0",
+  "version": "0.812.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"