@finos/legend-application-repl 0.0.59 → 1.0.0

package/src/stores/dataCube/core/DataCubeQueryEngine.ts

@@ -1,327 +0,0 @@
-/**
- * Copyright (c) 2020-present, Goldman Sachs
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { TailwindCSSPalette } from '@finos/legend-art';
-import { PRIMITIVE_TYPE, type V1_AppliedFunction } from '@finos/legend-graph';
-import { IllegalStateError } from '@finos/legend-shared';
-
-export enum DataCubeFunction {
-  // relation
-  EXTEND = 'meta::pure::functions::relation::extend',
-  FILTER = 'meta::pure::functions::relation::filter',
-  GROUP_BY = 'meta::pure::functions::relation::groupBy',
-  LIMIT = 'meta::pure::functions::relation::limit',
-  PIVOT = 'meta::pure::functions::relation::pivot',
-  // RENAME = 'meta::pure::functions::relation::rename',
-  SELECT = 'meta::pure::functions::relation::select',
-  SLICE = 'meta::pure::functions::relation::slice',
-  SORT = 'meta::pure::functions::relation::sort',
-
-  // generic
-  CAST = 'meta::pure::functions::lang::cast',
-  FROM = 'meta::pure::mapping::from',
-
-  // sort
-  ASC = 'meta::pure::functions::relation::ascending',
-  DESC = 'meta::pure::functions::relation::descending',
-
-  // filter
-  AND = 'meta::pure::functions::boolean::and',
-  OR = 'meta::pure::functions::boolean::or',
-  NOT = 'meta::pure::functions::boolean::not',
-  TO_LOWERCASE = 'meta::pure::functions::string::toLower',
-
-  CONTAINS = 'meta::pure::functions::string::contains',
-  ENDS_WITH = 'meta::pure::functions::string::endsWith',
-  EQUAL = 'meta::pure::functions::boolean::equal',
-  GREATER_THAN = 'meta::pure::functions::boolean::greaterThan',
-  GREATER_THAN_OR_EQUAL = 'meta::pure::functions::boolean::greaterThanEqual',
-  IN = 'meta::pure::functions::collection::in',
-  IS_EMPTY = 'meta::pure::functions::collection::isEmpty',
-  LESS_THAN = 'meta::pure::functions::boolean::lessThan',
-  LESS_THAN_OR_EQUAL = 'meta::pure::functions::boolean::lessThanEqual',
-  STARTS_WITH = 'meta::pure::functions::string::startsWith',
-
-  // aggregate
-  AVERAGE = 'meta::pure::functions::math::average',
-  COUNT = 'meta::pure::functions::collection::count',
-  DISTINCT = 'meta::pure::functions::collection::distinct',
-  FIRST = 'meta::pure::functions::collection::first',
-  JOIN_STRINGS = 'meta::pure::functions::string::joinStrings',
-  LAST = 'meta::pure::functions::collection::last',
-  MAX = 'meta::pure::functions::collection::max',
-  MIN = 'meta::pure::functions::collection::min',
-  SUM = 'meta::pure::functions::math::sum',
-  STANDARD_DEVIATION_POPULATION = 'meta::pure::functions::math::stdDevPopulation',
-  STANDARD_DEVIATION_SAMPLE = 'meta::pure::functions::math::stdDevSample',
-  UNIQUE_VALUE_ONLY = 'meta::pure::functions::collection::uniqueValueOnly',
-  VARIANCE_POPULATION = 'meta::pure::functions::math::variancePopulation',
-  VARIANCE_SAMPLE = 'meta::pure::functions::math::varianceSample',
-  // PERCENTILE = 'meta::pure::functions::math::percentile',
-}
-
-export type DataCubeQueryFunctionMap = {
-  leafExtend?: V1_AppliedFunction | undefined;
-  filter?: V1_AppliedFunction | undefined;
-  pivotSort?: V1_AppliedFunction | undefined;
-  pivot?: V1_AppliedFunction | undefined;
-  pivotCast?: V1_AppliedFunction | undefined;
-  groupBy?: V1_AppliedFunction | undefined;
-  groupExtend?: V1_AppliedFunction | undefined;
-  select?: V1_AppliedFunction | undefined;
-  sort?: V1_AppliedFunction | undefined;
-  limit?: V1_AppliedFunction | undefined;
-};
-
-export enum DataCubeNumberScale {
-  BASIS_POINT = 'Basis Points (bp)',
-  PERCENT = 'Percent (%)',
-  THOUSANDS = 'Thousands (k)',
-  MILLIONS = 'Millions (m)',
-  BILLIONS = 'Billions (b)',
-  TRILLIONS = 'Trillions (t)',
-  AUTO = 'Auto (k/m/b/t)',
-}
-
-export enum DataCubeSelectionStat {
-  COUNT = 'Count',
-  SUM = 'Sum',
-  MIN = 'Min',
-  MAX = 'Max',
-  AVERAGE = 'Average',
-}
-
-export enum DataCubeFont {
-  // sans-serif
-  ARIAL = 'Arial',
-  ROBOTO = 'Roboto',
-  ROBOTO_CONDENSED = 'Roboto Condensed',
-
-  // serif
-  TIMES_NEW_ROMAN = 'Times New Roman',
-  GEORGIA = 'Georgia',
-  ROBOTO_SERIF = 'Roboto Serif',
-
-  // monospace
-  JERBRAINS_MONO = 'Jetbrains Mono',
-  ROBOTO_MONO = 'Roboto Mono',
-  UBUNTU_MONO = 'Ubuntu Mono',
-}
-
-export enum DataCubeFontTextAlignment {
-  CENTER = 'center',
-  LEFT = 'left',
-  RIGHT = 'right',
-}
-
-export enum DataCubeFontCase {
-  LOWERCASE = 'lowercase',
-  UPPERCASE = 'uppercase',
-  CAPITALIZE = 'capitalize',
-}
-
-export enum DataCubeFontFormatUnderlineVariant {
-  SOLID = 'solid',
-  DASHED = 'dashed',
-  DOTTED = 'dotted',
-  DOUBLE = 'double',
-  WAVY = 'wavy',
-}
-
-export enum DataCubeColumnKind {
-  MEASURE = 'Measure',
-  DIMENSION = 'Dimension',
-}
-
-export enum DataCubeOperationAdvancedValueType {
-  COLUMN = 'COLUMN',
-  // PARAMETER
-}
-
-export type DataCubeOperationValue = {
-  value: unknown;
-  type: string;
-};
-
-export enum DataCubeAggregateOperator {
-  SUM = 'sum',
-  AVERAGE = 'avg',
-  COUNT = 'count',
-  MIN = 'min',
-  MAX = 'max',
-  UNIQUE = 'uniq',
-  FIRST = 'first',
-  LAST = 'last',
-  // MEDIAN = 'median',
-  VARIANCE_POPULATION = 'var',
-  VARIANCE_SAMPLE = 'var_sample',
-  STANDARD_DEVIATION_POPULATION = 'std',
-  STANDARD_DEVIATION_SAMPLE = 'std_sample',
-  // STANDARD_ERROR = 'stderr',
-  // NULL = 'null',
-  // ssq
-  // countvalid
-  // countnull
-  // uniqunstrict
-  // minmagnitude
-  // maxmagnitude
-  // commonprefix
-  // commonprefixunstrict
-  JOIN_STRINGS = 'strjoin',
-  // strjoinuniq
-  // splitjoin
-  // daterange
-  // wavg
-  // wstderr
-  // wsum
-  // custom
-}
-
-export enum DataCubeQueryFilterOperator {
-  LESS_THAN = '<', // DONE
-  LESS_THAN_OR_EQUAL = '<=', // DONE
-  EQUAL = '=', // DONE
-  NOT_EQUAL = '!=', // DONE
-  GREATER_THAN = '>', // DONE
-  GREATER_THAN_OR_EQUAL = '>=', // DONE
-  IN = 'in',
-  NOT_IN = 'not in',
-  IS_NULL = 'is null', // DONE
-  IS_NOT_NULL = 'is not null', // DONE
-  // string ONLY
-  EQUAL_CASE_INSENSITIVE = '= (case-insensitive)', // DONE
-  NOT_EQUAL_CASE_INSENSITIVE = '!= (case-insensitive)', // DONE
-  IN_CASE_INSENSITIVE = 'in (case-insensitive)',
-  NOT_IN_CASE_INSENSITIVE = 'not in (case-insensitive)',
-  CONTAIN = 'contains', // DONE
-  CONTAIN_CASE_INSENSITIVE = 'contains (case-insensitive)', // DONE
-  NOT_CONTAIN = 'does not contain', // DONE
-  START_WITH = 'starts with', // DONE
-  START_WITH_CASE_INSENSITIVE = 'starts with (case-insensitive)', // DONE
-  NOT_START_WITH = 'does not start with', // DONE
-  END_WITH = 'ends with', // DONE
-  END_WITH_CASE_INSENSITIVE = 'ends with (case-insensitive)', // DONE
-  NOT_END_WITH = 'does not end with', // DONE
-  // column
-  LESS_THAN_COLUMN = '< value in column', // DONE
-  LESS_THAN_OR_EQUAL_COLUMN = '<= value in column', // DONE
-  EQUAL_COLUMN = '= value in column', // DONE
-  EQUAL_CASE_INSENSITIVE_COLUMN = '= (case-insensitive) value in column', // DONE
-  NOT_EQUAL_COLUMN = '!= value in column', // DONE
-  NOT_EQUAL_CASE_INSENSITIVE_COLUMN = '!= (case-insensitive) value in column', // DONE
-  GREATER_THAN_COLUMN = '> value in column', // DONE
-  GREATER_THAN_OR_EQUAL_COLUMN = '>= value in column', // DONE
-  // TODO?: having, having in aggregate, between
-}
-
-export enum DataCubeQueryFilterGroupOperator {
-  AND = 'and',
-  OR = 'or',
-}
-
-export enum DataCubeQuerySortOperator {
-  ASCENDING = 'ascending',
-  DESCENDING = 'descending',
-}
-
-export enum DataCubeColumnPinPlacement {
-  LEFT = 'Left',
-  RIGHT = 'Right',
-}
-
-// TODO: support more classifications of this column, it can also be aggregation with map/reduce or
-// OLAP window aggregation, or custom groupings, etc.
-export enum DataCubeExtendedColumnType {
-  SIMPLE = 'simple',
-}
-
-export enum DataCubeColumnDataType {
-  NUMBER = 'Numeric',
-  TEXT = 'Text',
-  DATE = 'Date',
-  TIME = 'Time',
-}
-
-export function getDataType(type: string): DataCubeColumnDataType {
-  switch (type) {
-    case PRIMITIVE_TYPE.NUMBER:
-    case PRIMITIVE_TYPE.INTEGER:
-    case PRIMITIVE_TYPE.DECIMAL:
-    case PRIMITIVE_TYPE.FLOAT:
-      return DataCubeColumnDataType.NUMBER;
-    case PRIMITIVE_TYPE.DATE:
-    case PRIMITIVE_TYPE.STRICTDATE:
-      return DataCubeColumnDataType.DATE;
-    case PRIMITIVE_TYPE.DATETIME:
-      return DataCubeColumnDataType.TIME;
-    case PRIMITIVE_TYPE.STRING:
-    default:
-      return DataCubeColumnDataType.TEXT;
-  }
-}
-
-export function ofDataType(
-  type: string,
-  dataTypes: DataCubeColumnDataType[],
-): boolean {
-  return dataTypes.includes(getDataType(type));
-}
-
-export const PIVOT_COLUMN_NAME_VALUE_SEPARATOR = '__|__';
-export function isPivotResultColumnName(columnName: string) {
-  return columnName.includes(PIVOT_COLUMN_NAME_VALUE_SEPARATOR);
-}
-export function getPivotResultColumnBaseColumnName(columnName: string) {
-  if (!isPivotResultColumnName(columnName)) {
-    throw new IllegalStateError(
-      `Column '${columnName}' is not a pivot result column`,
-    );
-  }
-  return columnName.substring(
-    columnName.lastIndexOf(PIVOT_COLUMN_NAME_VALUE_SEPARATOR) +
-      PIVOT_COLUMN_NAME_VALUE_SEPARATOR.length,
-  );
-}
-
-export const DEFAULT_LAMBDA_VARIABLE_NAME = 'x';
-
-export const DEFAULT_REPORT_NAME = 'New Report';
-export const DEFAULT_ROW_BUFFER = 20;
-
-export const DEFAULT_URL_LABEL_QUERY_PARAM = 'dataCube.linkLabel';
-export const DEFAULT_MISSING_VALUE_DISPLAY_TEXT = '';
-
-export const DEFAULT_GRID_LINE_COLOR = TailwindCSSPalette.neutral[200];
-export const DEFAULT_ROW_HIGHLIGHT_BACKGROUND_COLOR = '#d7e0eb';
-
-export const DEFAULT_COLUMN_WIDTH = 300;
-export const DEFAULT_COLUMN_MIN_WIDTH = 50;
-export const DEFAULT_COLUMN_MAX_WIDTH = undefined;
-
-export const DEFAULT_FONT_FAMILY = DataCubeFont.ROBOTO;
-export const DEFAULT_FONT_SIZE = 11;
-export const DEFAULT_FONT_BOLD = false;
-export const DEFAULT_FONT_ITALIC = false;
-export const DEFAULT_FONT_CASE = undefined;
-export const DEFAULT_FONT_UNDERLINED = undefined;
-export const DEFAULT_FONT_STRIKETHROUGH = false;
-export const DEFAULT_TEXT_ALIGN = DataCubeFontTextAlignment.LEFT;
-export const DEFAULT_FOREGROUND_COLOR = TailwindCSSPalette.black;
-export const DEFAULT_BACKGROUND_COLOR = TailwindCSSPalette.transparent;
-export const DEFAULT_ROW_BACKGROUND_COLOR = TailwindCSSPalette.white;
-export const DEFAULT_NEGATIVE_FOREGROUND_COLOR = TailwindCSSPalette.red[500];
-export const DEFAULT_ZERO_FOREGROUND_COLOR = TailwindCSSPalette.neutral[400];
-export const DEFAULT_ERROR_FOREGROUND_COLOR = TailwindCSSPalette.blue[600];

package/src/stores/dataCube/core/DataCubeQuerySnapshot.ts

@@ -1,188 +0,0 @@
-/**
- * Copyright (c) 2020-present, Goldman Sachs
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import type { V1_Lambda, V1_ValueSpecification } from '@finos/legend-graph';
-import type { DataCubeConfiguration } from './DataCubeConfiguration.js';
-import {
-  IllegalStateError,
-  hashObject,
-  pruneObject,
-  uuid,
-  type PlainObject,
-  type Writable,
-} from '@finos/legend-shared';
-import type { DataCubeOperationValue } from './DataCubeQueryEngine.js';
-
-export type DataCubeQuerySnapshotFilterCondition =
-  DataCubeQuerySnapshotColumn & {
-    value: DataCubeOperationValue | undefined;
-    operation: string;
-    not?: boolean | undefined;
-  };
-
-export type DataCubeQuerySnapshotFilter = {
-  groupOperator: string;
-  conditions: (
-    | DataCubeQuerySnapshotFilterCondition
-    | DataCubeQuerySnapshotFilter
-  )[];
-  not?: boolean | undefined;
-};
-
-export type DataCubeQuerySnapshotColumn = {
-  name: string;
-  type: string;
-};
-
-export type DataCubeQuerySnapshotExtendedColumn =
-  DataCubeQuerySnapshotColumn & {
-    _type: string;
-  };
-
-export type DataCubeQuerySnapshotSimpleExtendedColumn =
-  DataCubeQuerySnapshotExtendedColumn & {
-    lambda: PlainObject<V1_Lambda>;
-  };
-
-export type DataCubeQuerySnapshotSortColumn = DataCubeQuerySnapshotColumn & {
-  operation: string;
-};
-
-export type DataCubeQuerySnapshotGroupBy = {
-  columns: DataCubeQuerySnapshotColumn[];
-};
-
-export type DataCubeQuerySnapshotPivot = {
-  columns: DataCubeQuerySnapshotColumn[];
-  castColumns: DataCubeQuerySnapshotColumn[];
-};
-
-export type DataCubeQuerySnapshotData = {
-  name: string;
-  runtime: string;
-  mapping: string | undefined;
-  sourceQuery: PlainObject<V1_ValueSpecification>;
-  configuration: PlainObject<DataCubeConfiguration>;
-  sourceColumns: DataCubeQuerySnapshotColumn[];
-  leafExtendedColumns: DataCubeQuerySnapshotExtendedColumn[];
-  filter?: DataCubeQuerySnapshotFilter | undefined;
-  selectColumns: DataCubeQuerySnapshotColumn[];
-  groupBy?: DataCubeQuerySnapshotGroupBy | undefined;
-  pivot?: DataCubeQuerySnapshotPivot | undefined;
-  groupExtendedColumns: DataCubeQuerySnapshotExtendedColumn[];
-  sortColumns: DataCubeQuerySnapshotSortColumn[];
-  limit: number | undefined;
-};
-
-export class DataCubeQuerySnapshot {
-  readonly uuid = uuid();
-  timestamp = Date.now();
-  readonly data: DataCubeQuerySnapshotData;
-
-  private _finalized = false;
-  private _hashCode?: string | undefined;
-
-  private constructor(
-    name: string,
-    runtime: string,
-    mapping: string | undefined,
-    sourceQuery: PlainObject<V1_ValueSpecification>,
-    configuration: PlainObject<DataCubeConfiguration>,
-  ) {
-    this.data = {
-      name,
-      runtime,
-      mapping,
-      sourceQuery,
-      configuration,
-      sourceColumns: [],
-      leafExtendedColumns: [],
-      selectColumns: [],
-      filter: undefined,
-      groupBy: undefined,
-      pivot: undefined,
-      groupExtendedColumns: [],
-      sortColumns: [],
-      limit: undefined,
-    };
-  }
-
-  static create(
-    name: string,
-    runtime: string,
-    mapping: string | undefined,
-    sourceQuery: PlainObject<V1_ValueSpecification>,
-    configuration: PlainObject<DataCubeConfiguration>,
-  ) {
-    return new DataCubeQuerySnapshot(
-      name,
-      runtime,
-      mapping,
-      sourceQuery,
-      configuration,
-    );
-  }
-
-  clone() {
-    const clone = new DataCubeQuerySnapshot('', '', '', {}, {});
-    (clone.data as Writable<DataCubeQuerySnapshotData>) = JSON.parse(
-      JSON.stringify(this.data),
-    ) as DataCubeQuerySnapshotData;
-    return clone;
-  }
-
-  isFinalized() {
-    return this._finalized;
-  }
-
-  finalize() {
-    if (this._finalized) {
-      return this;
-    }
-    /**
-     * NOTE: if this becomes a performance bottleneck, we can consider
-     * more granular hashing strategy
-     *
-     * Here, we are just hashing the raw object, but we must ensure
-     * to properly prune the snapshot data object before hashing
-     * else there would be mismatch
-     */
-    this._hashCode = hashObject(pruneObject(this.data));
-    this._finalized = true;
-    return this;
-  }
-
-  get hashCode() {
-    if (!this._finalized || !this._hashCode) {
-      throw new IllegalStateError('Snapshot is not finalized');
-    }
-    return this._hashCode;
-  }
-}
-
-export function _findCol<T extends DataCubeQuerySnapshotColumn>(
-  cols: T[] | undefined,
-  name: string,
-): T | undefined {
-  return cols?.find((c) => c.name === name);
-}
-
-export function _toCol(col: {
-  name: string;
-  type: string;
-}): DataCubeQuerySnapshotColumn {
-  return { name: col.name, type: col.type };
-}