@creatio/base 0.834.0 → 0.1000.1

package/index.d.ts

@@ -49,6 +49,17 @@ export declare enum eAdminUnitRoleSources {
     All = 63
 }
 
+/**
+ * @public
+ * @description Origin of a filter group — where the group came from. A group can originate from a predefined
+ * filter (preset); the discriminated `kind` leaves room for other origins without a breaking change. Persisted
+ * as a client-side round-trip marker so a stored filter can be re-rendered as its source.
+ */
+export declare interface FilterGroupOrigin {
+    readonly type: ɵFilterGroupOriginType.Predefined;
+    readonly predefinedFilterId: ɵGuid;
+}
+
 /**
  * @generativeApi
  * @description Combined type for all ESQ filters. If you plan to create a new filter, please add it to this type.
@@ -84,6 +95,10 @@ export declare type IFilterGroup = ɵBaseFilter & {
      * @description Root entity schema name or table name.
      */
     rootSchemaName?: string;
+    /**
+     * @description Origin of this filter group (e.g. the predefined filter / preset it was created from), if any.
+     */
+    filterGroupOrigin?: FilterGroupOrigin;
 };
 
 /**
@@ -974,7 +989,7 @@ export declare type ɵColumnExpressionConfig = ɵExpressionConfig<ɵColumnExpres
  * by which the comparison is made, rightExpression describes the value to which the column is compared.
  * @extends {ɵSingleFilter}
  */
-export declare class ɵCompareFilter extends ɵSingleFilter {
+export declare class ɵCompareFilter<LeftExpression extends ɵBaseExpression = ɵBaseExpression> extends ɵSingleFilter<LeftExpression> {
     /**
      * @description Type of filter.
      * @default 1
@@ -987,7 +1002,7 @@ export declare class ɵCompareFilter extends ɵSingleFilter {
      * @description Filter expression. Right expression is used to compare values of column from the left expression
      */
     rightExpression: ɵBaseExpression;
-    constructor(comparisonType: ɵComparisonType, leftExpression: ɵBaseExpression, rightExpression: ɵBaseExpression);
+    constructor(comparisonType: ɵComparisonType, leftExpression: LeftExpression, rightExpression: ɵBaseExpression);
     /**
      * Parses filter from json.
      * @public
@@ -2503,6 +2518,10 @@ export declare class ɵFilterGroup extends ɵBaseFilter implements IFilterGroup
      * @description Root schema name.
      */
     rootSchemaName?: string;
+    /**
+     * @description Origin of this filter group (e.g. the predefined filter / preset it was created from), if any.
+     */
+    filterGroupOrigin?: FilterGroupOrigin;
     constructor(logicalOperation?: ɵLogicalOperatorType, rootSchemaName?: string);
     /**
      * @public
@@ -2607,6 +2626,18 @@ export declare class ɵFilterGroup extends ɵBaseFilter implements IFilterGroup
     /* Excluded from this release type: _getUsedColumns */
 }
 
+/**
+ * @public
+ * @description The origin kind of a filter group — where the group was created from.
+ */
+export declare enum ɵFilterGroupOriginType {
+    /**
+     * @public
+     * @description The group was created from a predefined filter (preset).
+     */
+    Predefined = "Predefined"
+}
+
 export declare class ɵFilterMock extends ɵBaseFilter {
     /* Excluded from this release type: _instanceOfKey */
     /* Excluded from this release type: _instanceOfKeys */
@@ -2651,6 +2682,9 @@ export declare class ɵFilterResolver {
  * - 4 In, Checks if a value is in a specified set of values.
  * - 5 Exists, Checks if a value exists.
  * - 6 FilterGroup, A group of filters combined with logical operators (AND, OR).
+ * - 7 Segment, Segment-membership filter — EXISTS / NOT EXISTS against the per-segment
+ *   data table addressed by SegmentFilterOptions.segmentId. Documented in
+ *   `crt-data-segmentation-engine/architecture/artifacts/insegment-filter-api.md`.
  */
 export declare enum ɵFilterType {
     /**
@@ -2689,7 +2723,15 @@ export declare enum ɵFilterType {
      * @public
      * @description A group of filters combined with logical operators (AND, OR).
      */
-    FilterGroup = 6
+    FilterGroup = 6,
+    /**
+     * @public
+     * @description Segment-membership filter. Carries a nested SegmentFilterOptions payload;
+     * the backend resolves segmentId via the SysDataSegment lookup and emits an EXISTS / NOT
+     * EXISTS subquery against the segment's per-segment data table. Use comparisonType
+     * Exists (15) for "in segment" and Not_exists (16) for "not in segment".
+     */
+    Segment = 7
 }
 
 /**
@@ -3733,6 +3775,252 @@ export declare enum ɵSchemaViewMaskRequestAction {
     RemoveTask = "removeTask"
 }
 
+/**
+ * @public
+ * @description Segment-membership filter. Tests whether the outer row's primary key is
+ * present in (or absent from, with `Not_exists`) the per-segment data table named by
+ * `SegmentFilterOptions.segmentId`.
+ *
+ * Wire form (DataService `SelectQuery` filters):
+ * ```jsonc
+ * {
+ *   "filterType": 7, // FilterType.Segment
+ *   "comparisonType": 15, // 15 = Exists (IN), 16 = Not_exists (NOT IN)
+ *   "isEnabled": true,
+ *   "segmentFilterOptions": {
+ *     "segmentId": "<SysDataSegment.Id>"
+ *   }
+ * }
+ * ```
+ *
+ * Extends `BaseFilter` directly — segment filters have no `leftExpression`, so they don't
+ * share `SingleFilter`'s contract. Structurally a sibling of `FilterGroup` in that respect.
+ *
+ * @extends {BaseFilter}
+ */
+export declare class ɵSegmentFilter extends ɵBaseFilter {
+    /* Excluded from this release type: _segmentFilterOptions */
+    /* Excluded from this release type: _comparisonType */
+    /* Excluded from this release type: _instanceOfKey */
+    /* Excluded from this release type: _instanceOfKeys */
+    /**
+     * @description Type of filter.
+     * @default 7
+     */
+    readonly filterType = ɵFilterType.Segment;
+    constructor(segmentFilterOptions: ɵSegmentFilterOptions, comparisonType?: ɵSegmentFilterComparisonType);
+    /**
+     * @public
+     * @description Segment selection + membership-mode + temporal bounds. The nested
+     * object is the wire-level payload — backend reads it as
+     * `Terrasoft.Core.Entities.SegmentFilterOptions`. Read-only from outside; mutate
+     * via {@link ɵSegmentFilter.patchOptions}.
+     */
+    get segmentFilterOptions(): ɵSegmentFilterOptions;
+    /**
+     * @public
+     * @description Comparison semantics. `Exists` = "row is in segment", `Not_exists` =
+     * "row is not in segment". Any other value would be rejected by the backend with
+     * `NotSupportedException`. Defaults to `ComparisonType.Exists` so the common
+     * "is in segment" case requires no explicit argument. Read-only from outside; mutate
+     * via {@link ɵSegmentFilter.updateComparisonType}.
+     */
+    get comparisonType(): ɵSegmentFilterComparisonType;
+    private _serializeOptions;
+    /**
+     * Parses a segment filter from its wire-level DTO. The parameter is the typed
+     * `SegmentFilterDto` directly — the resolver dispatch passes the raw `JsonObject`
+     * at runtime, but TypeScript sees the base-class signature (`dto: JsonObject`) for
+     * the call site, so this narrower parameter is structurally compatible without a
+     * cast at either end.
+     *
+     * @public
+     */
+    static fromJson({ comparisonType, uId, segmentFilterOptions }: ɵSegmentFilterDto): ɵSegmentFilter;
+    /**
+     * @public
+     * @description Patches the nested segment options with the provided partial. Existing
+     * fields not present in the patch are kept; new fields override the old ones. Use this
+     * from the UI when picking a segment, switching membership mode, or shifting temporal
+     * bounds — direct assignment to `segmentFilterOptions` is intentionally funneled
+     * through this method so all mutations live on the filter's public API.
+     * @param options - Partial set of fields to merge over the current options.
+     */
+    patchOptions(options: Partial<ɵSegmentFilterOptions>): void;
+    /**
+     * @public
+     * @description Switches whether the filter participates in the query. Mirrors the
+     * `isEnabled` property carried by every `BaseFilter`, exposed as a method so
+     * all-value writes on a `SegmentFilter` go through its public surface.
+     * @param enabled - `true` to include the filter in the resulting query, `false`
+     * to keep it on the rendered list but exclude it from execution.
+     */
+    toggle(enabled: boolean): void;
+    /**
+     * @public
+     * @description Replaces the comparison semantics — `Exists` ("row is in segment") or
+     * `Not_exists` ("row is not in segment"). Use this from the UI when the user flips
+     * the "in / not in" selector; direct assignment to `comparisonType` is intentionally
+     * funneled through this method so all mutations live on the filter's public API.
+     * @param comparisonType - The new comparison semantics to apply.
+     */
+    updateComparisonType(comparisonType: ɵSegmentFilterComparisonType): void;
+    /**
+     * @public
+     * @description Assigns the filter's unique identifier. Mirrors `BaseFilter.uId`,
+     * exposed as a method so all writes on a `SegmentFilter` go through its public
+     * surface — used at parse time by `fromJson` to attach the wire-level `uId` to a
+     * freshly constructed instance.
+     * @param uId - The identifier to set, or `undefined` to clear it.
+     */
+    updateId(uId: string | undefined): void;
+    /**
+     * @public
+     * @description Clones the filter. The constructor defensively copies the options object, so
+     * the clone owns an independent copy and the two instances never share mutable state. The
+     * remaining own state is copied field by field, matching the explicit clone style of the
+     * sibling filters.
+     */
+    clone(): ɵSegmentFilter;
+    /** {@inheritDoc ɵSerializable.toJson} */
+    toJson(): ɵSegmentFilterDto;
+    /* Excluded from this release type: _getUsedColumns */
+}
+
+/**
+ * @public
+ * @description Comparison kinds the backend accepts on a `FilterType.Segment` filter. Any
+ * other value would be rejected by `EntitySchemaQuery.CreateSegmentFilter` with
+ * `NotSupportedException`. `Exists` means "row is a member of the segment" (IN), while
+ * `Not_exists` means "row is not a member" (NOT IN).
+ */
+export declare type ɵSegmentFilterComparisonType = ɵComparisonType.Exists | ɵComparisonType.Not_exists;
+
+/**
+ * @public
+ * @description Wire-level shape of a serialized `SegmentFilter`. Mirrors the documented
+ * Segmentation API JSON contract (insegment-filter-api.md §5).
+ *
+ * Extends `JsonObject` so `toJson` can return it where a generic JSON object is expected by
+ * serializers / parsers, and so `fromJson` can read fields via dot notation without runtime
+ * type guards or `as` casts. Every field is optional because the parser must tolerate
+ * partially filled wire payloads (e.g. preset templates with no `segmentId` yet).
+ */
+export declare interface ɵSegmentFilterDto extends ɵJsonObject {
+    /**
+     * @description Filter-type discriminator. Always `FilterType.Segment` (7) when present.
+     */
+    filterType?: ɵFilterType.Segment;
+    /**
+     * @description Comparison semantics. See {@link ɵSegmentFilterComparisonType}.
+     */
+    comparisonType?: ɵSegmentFilterComparisonType;
+    /**
+     * @description Whether the filter participates in the query. Defaults to `true` when
+     * absent (resolved by the outer `BaseFilter`).
+     */
+    isEnabled?: boolean;
+    /**
+     * @description Truncates `DateTime`-typed parameters to a date-only value when applied.
+     * Inert for segment filters (no date parameters) but kept on the wire for shape parity
+     * with sibling filter DTOs.
+     */
+    trimDateTimeParameterToDate?: boolean;
+    /**
+     * @description Filter unique identifier. Consumed by `fromJson` when present on an inbound
+     * payload so the UI can correlate rendered controls with the source filter. It is not
+     * emitted by `toJson` (matching the sibling filter DTOs), so it does not round-trip
+     * through serialization.
+     */
+    uId?: string;
+    /**
+     * @description Nested segment-membership options. See {@link ɵSegmentFilterOptionsDto}.
+     */
+    segmentFilterOptions?: ɵSegmentFilterOptionsDto;
+}
+
+/**
+ * @public
+ * @description Options that parameterise a segment-membership filter. Mirrors the wire
+ * `SegmentFilterOptions` payload defined in the Segmentation API
+ * (`crt-data-segmentation-engine/architecture/artifacts/insegment-filter-api.md` §5).
+ *
+ * `segmentId` is required. `includeRemovedMembers` toggles the active-only `RemovedOn IS NULL`
+ * subquery predicate. `addedOn*` / `removedOn*` are inclusive ISO-8601 date bounds on the
+ * membership row's `AddedOn` / `RemovedOn` timestamps; `removedOn*` requires
+ * `includeRemovedMembers: true` (the backend throws ArgumentException otherwise).
+ */
+export declare interface ɵSegmentFilterOptions {
+    /**
+     * @description Identifier of the `SysDataSegment` record whose per-segment data table is
+     * probed by the membership subquery. Required.
+     */
+    segmentId: string;
+    /**
+     * @description When `true`, the subquery omits the `RemovedOn IS NULL` predicate so
+     * historical (removed) memberships also satisfy the filter. Required for any non-null
+     * `removedOn*` bound. Defaults to `false` (active members only).
+     */
+    includeRemovedMembers?: boolean;
+    /**
+     * @description When `true`, the server bypasses the `RequireActiveSegmentUserStatus`
+     * gate, so the filter is valid for any operator user status (Active / Paused /
+     * Disabled). The system (lifecycle) status gate — `RequireReadySegmentStatus` — still
+     * applies, so segments that have never been actualised remain rejected. Defaults to
+     * `false` (Active-only).
+     */
+    ignoreUserStatus?: boolean;
+    /**
+     * @description Inclusive ISO-8601 lower bound on the membership row's `AddedOn`
+     * timestamp.
+     */
+    addedOnFrom?: string;
+    /**
+     * @description Inclusive ISO-8601 upper bound on the membership row's `AddedOn`
+     * timestamp.
+     */
+    addedOnTo?: string;
+    /**
+     * @description Inclusive ISO-8601 lower bound on the membership row's `RemovedOn`
+     * timestamp. Requires `includeRemovedMembers: true`.
+     */
+    removedOnFrom?: string;
+    /**
+     * @description Inclusive ISO-8601 upper bound on the membership row's `RemovedOn`
+     * timestamp. Requires `includeRemovedMembers: true`.
+     */
+    removedOnTo?: string;
+}
+
+/**
+ * @public
+ * @description Wire-level shape of the nested `segmentFilterOptions` object in a serialized
+ * `SegmentFilter`. Every field is optional, so the DTO can represent both fully filled
+ * payloads and unfilled preset templates (where the UI hasn't picked a segment yet).
+ *
+ * Extends `JsonObject` so the type interoperates with the resolver / parser dispatch
+ * contracts while still exposing each documented field with its narrow type.
+ */
+export declare interface ɵSegmentFilterOptionsDto extends ɵJsonObject {
+    /**
+     * @description Identifier of the `SysDataSegment` record. Optional on the wire so
+     * unfilled preset templates can omit it.
+     */
+    segmentId?: string;
+    /** {@inheritDoc ɵSegmentFilterOptions.includeRemovedMembers} */
+    includeRemovedMembers?: boolean;
+    /** {@inheritDoc ɵSegmentFilterOptions.ignoreUserStatus} */
+    ignoreUserStatus?: boolean;
+    /** {@inheritDoc ɵSegmentFilterOptions.addedOnFrom} */
+    addedOnFrom?: string;
+    /** {@inheritDoc ɵSegmentFilterOptions.addedOnTo} */
+    addedOnTo?: string;
+    /** {@inheritDoc ɵSegmentFilterOptions.removedOnFrom} */
+    removedOnFrom?: string;
+    /** {@inheritDoc ɵSegmentFilterOptions.removedOnTo} */
+    removedOnTo?: string;
+}
+
 /**
  * @public
  * @description The query class for localized data fetching.
@@ -3758,7 +4046,7 @@ export declare interface ɵSerializable {
  * @description Basic filter class with one condition.
  * @extends {ɵBaseFilter}
  */
-export declare abstract class ɵSingleFilter extends ɵBaseFilter {
+export declare abstract class ɵSingleFilter<LeftExpression extends ɵBaseExpression = ɵBaseExpression> extends ɵBaseFilter {
     /* Excluded from this release type: _instanceOfKey */
     /* Excluded from this release type: _instanceOfKeys */
     /**
@@ -3771,7 +4059,7 @@ export declare abstract class ɵSingleFilter extends ɵBaseFilter {
     /**
      * @description expression that contains the value to be compared with the right expressions.
      */
-    readonly leftExpression: ɵBaseExpression;
+    readonly leftExpression: LeftExpression;
     /**
      * @description name of the entity schema, connected to the root schema of the filter.
      * Used, when one of the expressions uses a column from another schema.
@@ -3782,7 +4070,7 @@ export declare abstract class ɵSingleFilter extends ɵBaseFilter {
      * @default 10
      */
     dataValueType?: ɵDataValueType;
-    protected constructor(filterType: ɵFilterType, comparisonType: ɵComparisonType, leftExpression: ɵBaseExpression);
+    protected constructor(filterType: ɵFilterType, comparisonType: ɵComparisonType, leftExpression: LeftExpression);
     /** {@inheritDoc ɵSerializable.toJson} */
     toJson(): ɵJsonObject;
     /* Excluded from this release type: _getUsedColumns */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@creatio/base",
-  "version": "0.834.0",
+  "version": "0.1000.1",
   "license": "SEE LICENSE IN LICENSE.md",
   "description": "Internal API to create customizations and integrations for Creatio platform.",
   "keywords": [
@@ -17,27 +17,16 @@
     "tslib": "^2.3.0"
   },
   "sideEffects": false,
-  "overrides": [
-    {
-      "files": [
-        "*.ts"
-      ],
-      "parserOptions": {
-        "project": [
-          "libs/devkit/base/tsconfig.*?.json"
-        ]
-      }
-    }
-  ],
   "module": "fesm2022/creatio-base.mjs",
-  "typings": "index.d.ts",
+  "typings": "types/creatio-base.d.ts",
   "exports": {
     "./package.json": {
       "default": "./package.json"
     },
     ".": {
-      "types": "./index.d.ts",
+      "types": "./types/creatio-base.d.ts",
       "default": "./fesm2022/creatio-base.mjs"
     }
-  }
+  },
+  "type": "module"
 }