@sisense/sdk-data 1.11.0 → 1.12.0

package/dist/cjs/dimensional-model/filters/utils/types.d.ts

@@ -0,0 +1,200 @@
+declare type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
+}[Keys];
+export declare type JaqlContext = Record<string, Partial<FilterJaqlInternal>>;
+export declare type Id = string;
+export declare type Datasource = {
+    address: Id;
+    database: string;
+    id: string;
+    title: string;
+    live?: boolean;
+    fullname: string;
+    lastBuildTime?: string;
+    revisionId?: string;
+};
+export declare enum GeneralFilterType {
+    INCLUDE_ALL = "INCLUDE_ALL",
+    ADVANCED = "ADVANCED",
+    INVALID = "INVALID",
+    CONDITION = "CONDITION",
+    SPECIFIC_ITEMS = "SPECIFIC_ITEMS"
+}
+export declare enum DateTimeFilterType {
+    PERIOD = "PERIOD",
+    DATE_RANGE = "DATE_RANGE"
+}
+export declare enum NumericFilterType {
+    NUMERIC_RANGE = "NUMERIC_RANGE"
+}
+export declare type FilterType = GeneralFilterType | DateTimeFilterType | NumericFilterType;
+export interface BaseFilterJaql {
+    filterType?: FilterType;
+    custom?: boolean;
+    isAdvanced?: boolean;
+    rankingMessage?: string;
+    isBetween?: boolean;
+    isEmpty?: boolean;
+}
+export interface IncludeAllFilterJaql extends BaseFilterJaql {
+    all: boolean;
+}
+export declare type PeriodFilterDetails = {
+    count: number;
+    offset: number;
+    anchor?: string;
+};
+export interface PeriodFilterJaqlOptions extends BaseFilterJaql {
+    last: PeriodFilterDetails;
+    next: PeriodFilterDetails;
+    multiSelection?: boolean;
+    isNotCurrentPeriod?: boolean;
+}
+export declare type PeriodFilterJaql = RequireOnlyOne<PeriodFilterJaqlOptions, 'last' | 'next'>;
+export interface RangeFilterJaql extends BaseFilterJaql {
+    from?: string | number;
+    to?: string | number;
+    multiSelection?: boolean;
+}
+export declare type RankingFilterJaql = {
+    agg: string;
+    column: string;
+    datatype: string;
+    dim: string;
+    level?: string;
+    merged?: boolean;
+    table: string;
+};
+export declare type FilterMultiSelectJaql = {
+    explicit?: boolean;
+    multiSelection: boolean;
+    members: string[];
+    isCondition?: boolean;
+};
+export declare type FilterMultipleConditionJaql = {
+    or: ConditionFilterJaql[];
+    and: ConditionFilterJaql[];
+};
+export declare type ConditionFilterJaqlOptions = BaseFilterJaql & {
+    top: number;
+    bottom: number;
+    exclude: {
+        members?: string[];
+        from?: number;
+        to?: number;
+    };
+    startsWith: string;
+    doesntStartWith: string;
+    endsWith: string;
+    doesntEndWith: string;
+    doesntContain: string;
+    equals: number | string;
+    doesntEqual: number | string;
+    to: number;
+    toNotEqual: number;
+    from: number;
+    fromNotEqual: number;
+    contains: string;
+    by?: RankingFilterJaql;
+    rankingMessage?: string;
+} & Partial<FilterMultiSelectJaql> & Partial<PeriodFilterJaql> & Partial<RangeFilterJaql> & Partial<FilterMultipleConditionJaql>;
+export declare type ConditionFilterJaql = RequireOnlyOne<ConditionFilterJaqlOptions, 'top' | 'bottom' | 'exclude' | 'last' | 'next' | 'contains' | 'equals' | 'doesntEqual' | 'to' | 'toNotEqual' | 'from' | 'fromNotEqual' | 'startsWith' | 'doesntStartWith' | 'endsWith' | 'doesntEndWith' | 'doesntContain' | 'or' | 'and'>;
+export declare type InvalidTypeFilterJaql = BaseFilterJaql;
+export declare type SpecificItemsFilterJaql = BaseFilterJaql & FilterMultiSelectJaql;
+export declare type AnyTypeFilterJaql = IncludeAllFilterJaql | PeriodFilterJaql | RangeFilterJaql | ConditionFilterJaql | InvalidTypeFilterJaql | SpecificItemsFilterJaql;
+export declare enum DatetimeLevel {
+    YEARS = "years",
+    QUARTERS = "quarters",
+    MONTHS = "months",
+    WEEKS = "weeks",
+    DAYS = "days",
+    HOURS = "hours",
+    MINUTES = "minutes"
+}
+export declare type FilterJaqlInternal = {
+    title: string;
+    column: string;
+    datasource?: Datasource;
+    datatype: string;
+    dim: string;
+    dimension?: string;
+    fiscal?: string;
+    firstday?: string;
+    merged?: boolean;
+    table?: string;
+    filter?: AnyTypeFilterJaql;
+    level?: DatetimeLevel;
+    locale?: string;
+    bucket?: string;
+    collapsed?: boolean;
+    isDashboardFilter?: boolean;
+    formula?: string;
+    context?: JaqlContext;
+    agg?: string;
+};
+export declare enum FilterModalType {
+    DATE_TIME = "datetime",
+    NUMERIC = "numeric",
+    TEXT = "text"
+}
+export declare type BackgroundFilterExtraProps = {
+    level?: DatetimeLevel;
+    turnedOff?: boolean;
+};
+export declare type BackgroundFilter = {
+    filter?: AnyTypeFilterJaql & BackgroundFilterExtraProps;
+};
+export declare type FilterJaqlWrapperWithType = {
+    filter: AnyTypeFilterJaql & BackgroundFilter;
+    level?: DatetimeLevel;
+    agg?: string;
+};
+export declare const nonSupportedMinutesBuckets: string[];
+export declare const FILTER_TYPES: {
+    NUMERIC_RANGE: NumericFilterType.NUMERIC_RANGE;
+    PERIOD: DateTimeFilterType.PERIOD;
+    DATE_RANGE: DateTimeFilterType.DATE_RANGE;
+    INCLUDE_ALL: GeneralFilterType.INCLUDE_ALL;
+    ADVANCED: GeneralFilterType.ADVANCED;
+    INVALID: GeneralFilterType.INVALID;
+    CONDITION: GeneralFilterType.CONDITION;
+    SPECIFIC_ITEMS: GeneralFilterType.SPECIFIC_ITEMS;
+};
+export declare type FilterJaqlByTypeMap = {
+    [FILTER_TYPES.INCLUDE_ALL]: IncludeAllFilterJaql;
+    [FILTER_TYPES.PERIOD]: PeriodFilterJaql;
+    [FILTER_TYPES.DATE_RANGE]: RangeFilterJaql;
+    [FILTER_TYPES.NUMERIC_RANGE]: RangeFilterJaql;
+    [FILTER_TYPES.CONDITION]: ConditionFilterJaql;
+    [FILTER_TYPES.SPECIFIC_ITEMS]: SpecificItemsFilterJaql;
+};
+export declare const DEFAULT_FILTER_JAQL_BY_TYPE_MAP: FilterJaqlByTypeMap;
+export declare const DEFAULT_FILTER_JAQL_WRAPPER: FilterJaqlWrapperWithType;
+export declare enum ConditionFilterType {
+    IS = "members",
+    IS_NOT = "exclude",
+    IS_WITHIN = "isWithin",
+    TOP = "top",
+    BOTTOM = "bottom",
+    AFTER = "after",
+    BEFORE = "before",
+    STARTS_WITH = "startsWith",
+    DOESNT_START_WITH = "doesntStartWith",
+    ENDS_WITH = "endsWith",
+    DOESNT_END_WITH = "doesntEndWith",
+    CONTAINS = "contains",
+    DOESNT_CONTAIN = "doesntContain",
+    EQUALS = "equals",
+    DOESNT_EQUAL = "doesntEqual",
+    IS_EMPTY = "isEmpty",
+    IS_NOT_EMPTY = "isNotEmpty",
+    GREATER_THAN = "fromNotEqual",
+    GREATER_THAN_OR_EQUAL = "from",
+    LESS_THAN = "toNotEqual",
+    LESS_THAN_OR_EQUAL = "to",
+    BETWEEN = "between",
+    IS_NOT_BETWEEN = "isNotBetween",
+    MULTIPLE_CONDITION = "multipleCondition",
+    NONE = "none"
+}
+export {};

package/dist/cjs/dimensional-model/filters/utils/types.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConditionFilterType = exports.DEFAULT_FILTER_JAQL_WRAPPER = exports.DEFAULT_FILTER_JAQL_BY_TYPE_MAP = exports.FILTER_TYPES = exports.nonSupportedMinutesBuckets = exports.FilterModalType = exports.DatetimeLevel = exports.NumericFilterType = exports.DateTimeFilterType = exports.GeneralFilterType = void 0;
+var GeneralFilterType;
+(function (GeneralFilterType) {
+    GeneralFilterType["INCLUDE_ALL"] = "INCLUDE_ALL";
+    GeneralFilterType["ADVANCED"] = "ADVANCED";
+    GeneralFilterType["INVALID"] = "INVALID";
+    GeneralFilterType["CONDITION"] = "CONDITION";
+    GeneralFilterType["SPECIFIC_ITEMS"] = "SPECIFIC_ITEMS";
+})(GeneralFilterType = exports.GeneralFilterType || (exports.GeneralFilterType = {}));
+var DateTimeFilterType;
+(function (DateTimeFilterType) {
+    DateTimeFilterType["PERIOD"] = "PERIOD";
+    DateTimeFilterType["DATE_RANGE"] = "DATE_RANGE";
+})(DateTimeFilterType = exports.DateTimeFilterType || (exports.DateTimeFilterType = {}));
+var NumericFilterType;
+(function (NumericFilterType) {
+    NumericFilterType["NUMERIC_RANGE"] = "NUMERIC_RANGE";
+})(NumericFilterType = exports.NumericFilterType || (exports.NumericFilterType = {}));
+var DatetimeLevel;
+(function (DatetimeLevel) {
+    DatetimeLevel["YEARS"] = "years";
+    DatetimeLevel["QUARTERS"] = "quarters";
+    DatetimeLevel["MONTHS"] = "months";
+    DatetimeLevel["WEEKS"] = "weeks";
+    DatetimeLevel["DAYS"] = "days";
+    DatetimeLevel["HOURS"] = "hours";
+    DatetimeLevel["MINUTES"] = "minutes";
+})(DatetimeLevel = exports.DatetimeLevel || (exports.DatetimeLevel = {}));
+var FilterModalType;
+(function (FilterModalType) {
+    FilterModalType["DATE_TIME"] = "datetime";
+    FilterModalType["NUMERIC"] = "numeric";
+    FilterModalType["TEXT"] = "text";
+})(FilterModalType = exports.FilterModalType || (exports.FilterModalType = {}));
+exports.nonSupportedMinutesBuckets = ['1', '30'];
+exports.FILTER_TYPES = Object.assign(Object.assign(Object.assign({}, GeneralFilterType), DateTimeFilterType), NumericFilterType);
+exports.DEFAULT_FILTER_JAQL_BY_TYPE_MAP = {
+    [exports.FILTER_TYPES.INCLUDE_ALL]: {
+        all: true,
+        filterType: exports.FILTER_TYPES.INCLUDE_ALL,
+    },
+    [exports.FILTER_TYPES.PERIOD]: {
+        last: { count: 1, offset: 1 },
+        isNotCurrentPeriod: true,
+        filterType: exports.FILTER_TYPES.PERIOD,
+    },
+    [exports.FILTER_TYPES.DATE_RANGE]: {
+        filterType: exports.FILTER_TYPES.DATE_RANGE,
+    },
+    [exports.FILTER_TYPES.NUMERIC_RANGE]: {
+        filterType: exports.FILTER_TYPES.NUMERIC_RANGE,
+    },
+    [exports.FILTER_TYPES.CONDITION]: {
+        explicit: false,
+        multiSelection: true,
+        exclude: { members: [] },
+        filterType: exports.FILTER_TYPES.CONDITION,
+    },
+    [exports.FILTER_TYPES.SPECIFIC_ITEMS]: {
+        explicit: true,
+        multiSelection: true,
+        members: [],
+        filterType: exports.FILTER_TYPES.SPECIFIC_ITEMS,
+    },
+};
+exports.DEFAULT_FILTER_JAQL_WRAPPER = {
+    filter: exports.DEFAULT_FILTER_JAQL_BY_TYPE_MAP.INCLUDE_ALL,
+    level: DatetimeLevel.YEARS,
+};
+var ConditionFilterType;
+(function (ConditionFilterType) {
+    ConditionFilterType["IS"] = "members";
+    ConditionFilterType["IS_NOT"] = "exclude";
+    ConditionFilterType["IS_WITHIN"] = "isWithin";
+    ConditionFilterType["TOP"] = "top";
+    ConditionFilterType["BOTTOM"] = "bottom";
+    ConditionFilterType["AFTER"] = "after";
+    ConditionFilterType["BEFORE"] = "before";
+    ConditionFilterType["STARTS_WITH"] = "startsWith";
+    ConditionFilterType["DOESNT_START_WITH"] = "doesntStartWith";
+    ConditionFilterType["ENDS_WITH"] = "endsWith";
+    ConditionFilterType["DOESNT_END_WITH"] = "doesntEndWith";
+    ConditionFilterType["CONTAINS"] = "contains";
+    ConditionFilterType["DOESNT_CONTAIN"] = "doesntContain";
+    ConditionFilterType["EQUALS"] = "equals";
+    ConditionFilterType["DOESNT_EQUAL"] = "doesntEqual";
+    ConditionFilterType["IS_EMPTY"] = "isEmpty";
+    ConditionFilterType["IS_NOT_EMPTY"] = "isNotEmpty";
+    ConditionFilterType["GREATER_THAN"] = "fromNotEqual";
+    ConditionFilterType["GREATER_THAN_OR_EQUAL"] = "from";
+    ConditionFilterType["LESS_THAN"] = "toNotEqual";
+    ConditionFilterType["LESS_THAN_OR_EQUAL"] = "to";
+    ConditionFilterType["BETWEEN"] = "between";
+    ConditionFilterType["IS_NOT_BETWEEN"] = "isNotBetween";
+    ConditionFilterType["MULTIPLE_CONDITION"] = "multipleCondition";
+    ConditionFilterType["NONE"] = "none";
+})(ConditionFilterType = exports.ConditionFilterType || (exports.ConditionFilterType = {}));