@creatio/base 0.812.0 → 0.814.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/esm2020/lib/internal/enums/index.mjs +2 -1
  3. package/esm2020/lib/internal/enums/platform-apis.enum.mjs +11 -0
  4. package/esm2020/lib/public/enums/data-schema-type.enum.mjs +2 -1
  5. package/esm2020/lib/public/esq/data-model/columns/base-query-column.mjs +7 -1
  6. package/esm2020/lib/public/esq/data-model/enums/admin-unit-role-sources.enum.mjs +36 -0
  7. package/esm2020/lib/public/esq/data-model/enums/index.mjs +2 -2
  8. package/esm2020/lib/public/esq/data-model/expressions/arithmetic/arithmetic-expression.mjs +7 -1
  9. package/esm2020/lib/public/esq/data-model/expressions/base-expression.mjs +1 -1
  10. package/esm2020/lib/public/esq/data-model/expressions/columns/column-expression.mjs +11 -1
  11. package/esm2020/lib/public/esq/data-model/expressions/functions/argument-function-expression.mjs +7 -1
  12. package/esm2020/lib/public/esq/data-model/expressions/functions/macros-function-expression.mjs +7 -1
  13. package/esm2020/lib/public/esq/data-model/expressions/mocks/expression.mock.mjs +7 -1
  14. package/esm2020/lib/public/esq/data-model/expressions/parameters/parameter-expression.mjs +7 -1
  15. package/esm2020/lib/public/esq/data-model/expressions/sub-queries/sub-query-expression.mjs +31 -8
  16. package/esm2020/lib/public/esq/data-model/filters/base-filter.mjs +1 -1
  17. package/esm2020/lib/public/esq/data-model/filters/between-filter.mjs +11 -1
  18. package/esm2020/lib/public/esq/data-model/filters/compare-filter.mjs +7 -1
  19. package/esm2020/lib/public/esq/data-model/filters/exists-filter.mjs +7 -1
  20. package/esm2020/lib/public/esq/data-model/filters/filter-group.mjs +32 -1
  21. package/esm2020/lib/public/esq/data-model/filters/in-filter.mjs +10 -1
  22. package/esm2020/lib/public/esq/data-model/filters/mocks/filter.mock.mjs +7 -1
  23. package/esm2020/lib/public/esq/data-model/filters/single-filter.mjs +7 -1
  24. package/esm2020/lib/public/esq/data-model/index.mjs +2 -1
  25. package/esm2020/lib/public/esq/data-model/queries/base-filterable-query.mjs +19 -1
  26. package/esm2020/lib/public/esq/data-model/queries/entity-schema-query.mjs +19 -3
  27. package/esm2020/lib/public/esq/data-model/used-column.mjs +2 -0
  28. package/esm2020/lib/public/models/index.mjs +3 -1
  29. package/esm2020/lib/public/models/item-creation-config.mjs +2 -0
  30. package/esm2020/lib/public/models/request/index.mjs +2 -1
  31. package/esm2020/lib/public/models/request/request-registration-config.model.mjs +2 -0
  32. package/esm2020/lib/public/models/view-model-collection.mjs +2 -0
  33. package/esm2020/lib/public/services/index.mjs +2 -1
  34. package/esm2020/lib/public/services/mask-service/base-mask.service.mjs +2 -0
  35. package/esm2020/lib/public/services/mask-service/index.mjs +3 -0
  36. package/esm2020/lib/public/services/mask-service/schema-view-mask.request.mjs +24 -0
  37. package/esm2020/lib/public/services/model/data-source-aggregation-config.mjs +1 -1
  38. package/esm2020/lib/public/services/model/data-source-parameter.mjs +2 -1
  39. package/fesm2015/creatio-base.mjs +461 -209
  40. package/fesm2015/creatio-base.mjs.map +1 -1
  41. package/fesm2020/creatio-base.mjs +462 -216
  42. package/fesm2020/creatio-base.mjs.map +1 -1
  43. package/index.d.ts +189 -1
  44. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -2,8 +2,45 @@ declare interface BaseDataSourceFunctionConfig {
2
2
  type: ɵFunctionStringType;
3
3
  }
4
4
 
5
+ export declare enum eAdminUnitRoleSources {
6
+ /**
7
+ * Empty value.
8
+ */
9
+ None = 0,
10
+ /**
11
+ * Self.
12
+ */
13
+ Self = 1,
14
+ /**
15
+ * Explicit entry into role.
16
+ */
17
+ ExplicitEntry = 2,
18
+ /**
19
+ * Delegated role.
20
+ */
21
+ Delegated = 4,
22
+ /**
23
+ * Gets functional role from organizational role.
24
+ */
25
+ FuncRoleFromOrgRole = 8,
26
+ /**
27
+ * Gets role up hierarchy from role.
28
+ */
29
+ UpHierarchy = 16,
30
+ /**
31
+ * Gets role as a manager.
32
+ */
33
+ AsManager = 32,
34
+ /**
35
+ * Gets all roles.
36
+ */
37
+ All = 63
38
+ }
39
+
5
40
  /* Excluded from this release type: LookupMode */
6
41
 
42
+ /* Excluded from this release type: UsedColumn */
43
+
7
44
  /**
8
45
  * @public
9
46
  * @description Represents abstract class.
@@ -107,6 +144,7 @@ export declare abstract class ɵArgumentFunctionExpression extends ɵFunctionExp
107
144
  protected constructor(config: ɵArgumentFunctionExpressionConfig<ɵArgumentFunctionExpression>);
108
145
  abstract clone(): ɵArgumentFunctionExpression;
109
146
  toJson(): ɵJsonObject;
147
+ /* Excluded from this release type: _getUsedColumns */
110
148
  }
111
149
 
112
150
  export declare type ɵArgumentFunctionExpressionConfig<TExpression extends ɵArgumentFunctionExpression> = ɵFunctionExpressionConfig<TExpression> & Pick<ɵArgumentFunctionExpression, 'functionArgument'>;
@@ -129,6 +167,7 @@ export declare class ɵArithmeticExpression extends ɵBaseExpression {
129
167
  */
130
168
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser?: TExpressionParser): ɵArithmeticExpression;
131
169
  clone(): ɵArithmeticExpression;
170
+ /* Excluded from this release type: _getUsedColumns */
132
171
  }
133
172
 
134
173
  export declare type ɵArithmeticExpressionConfig = ɵExpressionConfig<ɵArithmeticExpression> & Pick<ɵArithmeticExpression, 'arithmeticOperation' | 'leftArithmeticOperand' | 'rightArithmeticOperand'>;
@@ -234,6 +273,7 @@ export declare abstract class ɵBaseExpression implements ɵSerializable {
234
273
  * @public
235
274
  */
236
275
  toJson(): ɵJsonObject;
276
+ /* Excluded from this release type: _getUsedColumns */
237
277
  }
238
278
 
239
279
  /**
@@ -264,6 +304,7 @@ export declare abstract class ɵBaseFilter implements ɵSerializable {
264
304
  * @public
265
305
  */
266
306
  toJson(): ɵJsonObject;
307
+ /* Excluded from this release type: _getUsedColumns */
267
308
  }
268
309
 
269
310
  /**
@@ -274,6 +315,7 @@ export declare abstract class ɵBaseFilterableQuery extends ɵBaseQuery {
274
315
  protected constructor(operationType: ɵQueryOperationType, rootSchemaName: string);
275
316
  clearFilters(): void;
276
317
  getMetadata(): Record<string, unknown>;
318
+ /* Excluded from this release type: _getUsedColumns */
277
319
  }
278
320
 
279
321
  /**
@@ -284,6 +326,35 @@ export declare class ɵBaseFilterParser {
284
326
  static fromJson(dto: ɵJsonObject): unknown;
285
327
  }
286
328
 
329
+ /**
330
+ * @public
331
+ * @description Provides implementation of service to work with mask.
332
+ */
333
+ export declare interface ɵBaseMaskService {
334
+ /**
335
+ * @description Shows mask.
336
+ * @param taskName Name of task.
337
+ * @param context View model context.
338
+ */
339
+ showMask(taskName: string, context: ɵViewModelContext): Promise<void>;
340
+ /**
341
+ * @description Hides mask.
342
+ * @param taskName Name of task.
343
+ * @param context View model context.
344
+ */
345
+ hideMask(taskName: string, context: ɵViewModelContext): Promise<void>;
346
+ /**
347
+ * @description Shows mask for the whole available space on the screen.
348
+ * @param taskName Name of task.
349
+ */
350
+ showFullScreenMask(taskName: string): Promise<void>;
351
+ /**
352
+ * @description Hides full screen mask.
353
+ * @param taskName Name of task.
354
+ */
355
+ hideFullScreenMask(taskName: string): Promise<void>;
356
+ }
357
+
287
358
  export declare interface ɵBaseModel<TLoadOptions extends ɵDataSourceLoadOptions> {
288
359
  getSchema(): Promise<ɵDataSchema>;
289
360
  load(config?: {
@@ -338,6 +409,7 @@ export declare abstract class ɵBaseQueryColumn<TExpression extends ɵBaseExpres
338
409
  * @returns Self.
339
410
  */
340
411
  withCaption(caption: string): this;
412
+ /* Excluded from this release type: _getUsedColumns */
341
413
  }
342
414
 
343
415
  /**
@@ -395,6 +467,7 @@ export declare class ɵBetweenFilter extends ɵSingleFilter {
395
467
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser: TExpressionParser): ɵBetweenFilter;
396
468
  clone(): ɵBetweenFilter;
397
469
  toJson(): ɵJsonObject;
470
+ /* Excluded from this release type: _getUsedColumns */
398
471
  }
399
472
 
400
473
  /**
@@ -415,6 +488,7 @@ export declare class ɵColumnExpression extends ɵBaseExpression {
415
488
  */
416
489
  static fromJson(dto: ɵJsonObject): ɵColumnExpression;
417
490
  clone(): ɵColumnExpression;
491
+ /* Excluded from this release type: _getUsedColumns */
418
492
  }
419
493
 
420
494
  export declare type ɵColumnExpressionConfig = ɵExpressionConfig<ɵColumnExpression> & Pick<ɵColumnExpression, 'columnPath'>;
@@ -431,6 +505,7 @@ export declare class ɵCompareFilter extends ɵSingleFilter {
431
505
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser: TExpressionParser): ɵCompareFilter;
432
506
  clone(): ɵCompareFilter;
433
507
  toJson(): ɵJsonObject;
508
+ /* Excluded from this release type: _getUsedColumns */
434
509
  }
435
510
 
436
511
  export declare enum ɵComparisonType {
@@ -629,7 +704,8 @@ export declare interface ɵDataSchemaAttributeValidatorConfig {
629
704
  */
630
705
  export declare enum ɵDataSchemaType {
631
706
  Entity = "Entity",
632
- ClientUnit = "ClientUnit"
707
+ ClientUnit = "ClientUnit",
708
+ Intent = "Intent"
633
709
  }
634
710
 
635
711
  /**
@@ -978,6 +1054,10 @@ export declare class ɵEntitySchemaQuery extends ɵBaseFilterableQuery {
978
1054
  };
979
1055
  useLocalization: boolean;
980
1056
  useRecordDeactivation: boolean;
1057
+ /**
1058
+ * Bit mask that indicates which role sources will be considered when checking record rights.
1059
+ */
1060
+ adminUnitRoleSources?: eAdminUnitRoleSources;
981
1061
  constructor(rootSchemaName: string);
982
1062
  private _internalAddColumn;
983
1063
  private _getIsPageable;
@@ -1075,6 +1155,7 @@ export declare class ɵEntitySchemaQuery extends ɵBaseFilterableQuery {
1075
1155
  * @returns [WindowFunctionColumn] Column instance.
1076
1156
  */
1077
1157
  addWindowFunctionColumn(columnPath: string, aggregationType: ɵAggregationType, columnAlias: string, aggregationEvalType?: ɵAggregationEvalType): ɵWindowFunctionColumn;
1158
+ /* Excluded from this release type: _getUsedColumns */
1078
1159
  }
1079
1160
 
1080
1161
  export declare class ɵExistsFilter extends ɵSingleFilter {
@@ -1090,6 +1171,7 @@ export declare class ɵExistsFilter extends ɵSingleFilter {
1090
1171
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser: TExpressionParser): ɵExistsFilter;
1091
1172
  clone(): ɵExistsFilter;
1092
1173
  toJson(): ɵJsonObject;
1174
+ /* Excluded from this release type: _getUsedColumns */
1093
1175
  }
1094
1176
 
1095
1177
  export declare const ɵEXPRESSION_TYPE_MOCK: ɵExpressionType;
@@ -1103,6 +1185,7 @@ export declare class ɵExpressionMock extends ɵBaseExpression {
1103
1185
  constructor(config?: ɵExpressionConfig<ɵExpressionMock>);
1104
1186
  get plainObject(): object;
1105
1187
  clone(): ɵExpressionMock;
1188
+ /* Excluded from this release type: _getUsedColumns */
1106
1189
  }
1107
1190
 
1108
1191
  /**
@@ -1148,6 +1231,11 @@ export declare class ɵFilterGroup extends ɵBaseFilter {
1148
1231
  * @public
1149
1232
  */
1150
1233
  static fromJson<T extends typeof ɵBaseFilterParser>(dto: ɵJsonObject, filterParser: T): ɵFilterGroup;
1234
+ /**
1235
+ * Converts instance to json object.
1236
+ * @public
1237
+ */
1238
+ toJson(): ɵJsonObject;
1151
1239
  private _createParameterValueExpressions;
1152
1240
  /**
1153
1241
  * Returns filter item by index.
@@ -1196,6 +1284,7 @@ export declare class ɵFilterGroup extends ɵBaseFilter {
1196
1284
  addNotExistsFilter(columnPath: string, subFilters?: ɵFilterGroup, filterKey?: string): void;
1197
1285
  add(filter: ɵBaseFilter, filterKey?: string): void;
1198
1286
  clone(): ɵFilterGroup;
1287
+ /* Excluded from this release type: _getUsedColumns */
1199
1288
  }
1200
1289
 
1201
1290
  export declare class ɵFilterMock extends ɵBaseFilter {
@@ -1204,6 +1293,7 @@ export declare class ɵFilterMock extends ɵBaseFilter {
1204
1293
  constructor(filterType?: ɵFilterType);
1205
1294
  get plainObject(): object;
1206
1295
  clone(): ɵFilterMock;
1296
+ /* Excluded from this release type: _getUsedColumns */
1207
1297
  }
1208
1298
 
1209
1299
  /**
@@ -1295,6 +1385,7 @@ export declare class ɵInFilter extends ɵSingleFilter {
1295
1385
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser: TExpressionParser): ɵInFilter;
1296
1386
  clone(): ɵInFilter;
1297
1387
  toJson(): ɵJsonObject;
1388
+ /* Excluded from this release type: _getUsedColumns */
1298
1389
  }
1299
1390
 
1300
1391
  /**
@@ -1338,6 +1429,28 @@ export declare class ɵIsNullFilter extends ɵSingleFilter {
1338
1429
  clone(): ɵIsNullFilter;
1339
1430
  }
1340
1431
 
1432
+ /**
1433
+ * @public
1434
+ * @description Config to create item in collection.
1435
+ * @property {number} index - Index of item in collection.
1436
+ * @property {Record<string, unknown>} initialAttributeValues - Initial attribute values.
1437
+ * @property {ɵJsonObject} initialModelValues - Initial values of the model.
1438
+ */
1439
+ export declare interface ɵItemCreationConfig {
1440
+ /**
1441
+ * @description Index of item in collection.
1442
+ */
1443
+ index?: number;
1444
+ /**
1445
+ * @description Initial attribute values.
1446
+ */
1447
+ initialAttributeValues?: Record<string, unknown>;
1448
+ /**
1449
+ * @description Initial values of the model.
1450
+ */
1451
+ initialModelValues?: ɵJsonObject;
1452
+ }
1453
+
1341
1454
  export declare class ɵItemNotFoundException extends Error {
1342
1455
  constructor(key: string);
1343
1456
  }
@@ -1459,6 +1572,7 @@ export declare class ɵMacrosFunctionExpression extends ɵFunctionExpression {
1459
1572
  */
1460
1573
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser?: TFilterParser, expressionParser?: TExpressionParser): ɵMacrosFunctionExpression;
1461
1574
  clone(): ɵMacrosFunctionExpression;
1575
+ /* Excluded from this release type: _getUsedColumns */
1462
1576
  }
1463
1577
 
1464
1578
  export declare type ɵMacrosFunctionExpressionConfig = ɵFunctionExpressionConfig<ɵMacrosFunctionExpression> & Pick<ɵMacrosFunctionExpression, 'macrosType'>;
@@ -1538,6 +1652,7 @@ export declare enum ɵModelInPageAction {
1538
1652
  */
1539
1653
  export declare enum ɵModelParameterType {
1540
1654
  PrimaryColumnValue = "primaryColumnValue",
1655
+ ColumnValue = "columnValue",
1541
1656
  Filter = "filter",
1542
1657
  PrimaryDisplayValueFilter = "primaryDisplayValueFilter",
1543
1658
  Empty = "empty",
@@ -1577,6 +1692,7 @@ export declare class ɵParameterExpression extends ɵBaseExpression {
1577
1692
  private _convertStringToBlobArray;
1578
1693
  private _getParameterValueMetadata;
1579
1694
  clone(): ɵParameterExpression;
1695
+ /* Excluded from this release type: _getUsedColumns */
1580
1696
  }
1581
1697
 
1582
1698
  export declare type ɵParameterExpressionConfig = ɵExpressionConfig<ɵParameterExpression> & Pick<ɵParameterExpression, 'value'>;
@@ -1590,6 +1706,16 @@ export declare const ɵparserMock: {
1590
1706
  clone: () => undefined;
1591
1707
  };
1592
1708
 
1709
+ /**
1710
+ * Available platform APIs
1711
+ */
1712
+ export declare enum ɵPlatformAPIs {
1713
+ /**
1714
+ * Selection metadata API.
1715
+ */
1716
+ Selection = "selection"
1717
+ }
1718
+
1593
1719
  /**
1594
1720
  * @public
1595
1721
  */
@@ -1704,12 +1830,60 @@ export declare interface ɵRequestHandler<TRequest = ɵBaseRequest, TResult = un
1704
1830
  setNext(next: ɵRequestHandler): void;
1705
1831
  }
1706
1832
 
1833
+ /**
1834
+ * @public
1835
+ * @description Config for register request.
1836
+ * @property {string} type - The type of request.
1837
+ * @property {string[]} scopes - Scopes of request.
1838
+ * @property {string} title - Title of request.
1839
+ * @property {string} propertiesPanelComponentTypeName - Type of properties panel
1840
+ * @property {number} position - Position of the request
1841
+ * @property {ɵPlatformAPIs} compatibleAPIs - Compatible platform APIs
1842
+ */
1843
+ export declare interface ɵRequestRegistrationConfig {
1844
+ /**
1845
+ * @description The type of request.
1846
+ * @example
1847
+ * 'crt.RequestType'
1848
+ */
1849
+ readonly type: string;
1850
+ /**
1851
+ * @description Scopes of request
1852
+ */
1853
+ readonly scopes?: string[];
1854
+ /* Excluded from this release type: title */
1855
+ /* Excluded from this release type: propertiesPanelComponentTypeName */
1856
+ /* Excluded from this release type: position */
1857
+ /* Excluded from this release type: compatibleAPIs */
1858
+ }
1859
+
1707
1860
  /**
1708
1861
  * @public
1709
1862
  * @description Function that takes a injection token, and returns dependency instance.
1710
1863
  */
1711
1864
  export declare type ɵResolveDependencyFn = (token: unknown) => unknown;
1712
1865
 
1866
+ /**
1867
+ * @public
1868
+ * @description Request to show mask.
1869
+ */
1870
+ export declare class ɵSchemaViewMaskRequest extends ɵBaseRequest {
1871
+ readonly action: ɵSchemaViewMaskRequestAction;
1872
+ readonly taskName: string;
1873
+ readonly $context: ɵViewModelContext;
1874
+ readonly type = "crt.SchemaViewMaskRequest";
1875
+ constructor(action: ɵSchemaViewMaskRequestAction, taskName: string, $context: ɵViewModelContext);
1876
+ }
1877
+
1878
+ /**
1879
+ * @public
1880
+ * @description Actions of mask request.
1881
+ */
1882
+ export declare enum ɵSchemaViewMaskRequestAction {
1883
+ AddTask = "addTask",
1884
+ RemoveTask = "removeTask"
1885
+ }
1886
+
1713
1887
  /**
1714
1888
  * @public
1715
1889
  */
@@ -1727,6 +1901,7 @@ export declare abstract class ɵSingleFilter extends ɵBaseFilter {
1727
1901
  readonly leftExpression: ɵBaseExpression;
1728
1902
  protected constructor(filterType: ɵFilterType, comparisonType: ɵComparisonType, leftExpression: ɵBaseExpression);
1729
1903
  toJson(): ɵJsonObject;
1904
+ /* Excluded from this release type: _getUsedColumns */
1730
1905
  }
1731
1906
 
1732
1907
  /**
@@ -1763,6 +1938,7 @@ export declare class ɵSubQueryExpression extends ɵBaseExpression {
1763
1938
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser>(dto: ɵJsonObject, filterParser: TFilterParser): ɵSubQueryExpression;
1764
1939
  clone(): ɵSubQueryExpression;
1765
1940
  toJson(): ɵJsonObject;
1941
+ /* Excluded from this release type: _getUsedColumns */
1766
1942
  }
1767
1943
 
1768
1944
  export declare type ɵSubQueryExpressionConfig = ɵExpressionConfig<ɵSubQueryExpression> & Pick<ɵSubQueryExpression, 'columnPath'>;
@@ -1816,6 +1992,18 @@ export declare class ɵValidationUtilities {
1816
1992
  }): void;
1817
1993
  }
1818
1994
 
1995
+ /**
1996
+ * @public
1997
+ * @description Interface describes the collection of view models.
1998
+ */
1999
+ export declare interface ɵViewModelCollection<T extends ɵViewModelContext> {
2000
+ /**
2001
+ * @description Abstract async method to create item in collection.
2002
+ * @param {ɵItemCreationConfig} config - {@link ɵItemCreationConfig}
2003
+ */
2004
+ createItem(config?: ɵItemCreationConfig): Promise<T>;
2005
+ }
2006
+
1819
2007
  /**
1820
2008
  * @public
1821
2009
  * @description Interface describes view model context.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@creatio/base",
3
- "version": "0.812.0",
3
+ "version": "0.814.0",
4
4
  "license": "SEE LICENSE IN LICENSE.md",
5
5
  "description": "Internal API to create customizations and integrations for Creatio platform.",
6
6
  "keywords": [