@apia/query 5.0.0 → 5.0.1

package/dist/ListFunctionalityController.js

@@ -0,0 +1,54 @@
+import { Url } from '@apia/util';
+import { ApiaApi } from '@apia/api2';
+import { makeAutoObservable } from 'mobx';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, key + "" , value);
+  return value;
+};
+class ListFunctionalityController {
+  constructor(env) {
+    this.env = env;
+    __publicField(this, "state", {
+      fncId: -1,
+      isFavorite: false,
+      isMaximized: false
+    });
+    makeAutoObservable(this);
+    this.initializeFavoriteAction();
+  }
+  async initializeFavoriteAction() {
+    const id = new Url(window.location.href).getParameter("favFncId") || new Url(
+      window.frameElement?.attributes.getNamedItem("src")?.value || ""
+    ).getParameter("favFncId");
+    this.state.fncId = id || id == 0 ? Number.parseInt(String(id)) : 0;
+    if (this.state.fncId !== null) {
+      const res = await ApiaApi.post(
+        { ...this.env.context },
+        {
+          action: "loadFavoriteState",
+          favFncId: this.state.fncId
+        }
+      );
+      if (res?.data) {
+        this.state.isFavorite = res.data.isFavorite;
+      }
+    }
+  }
+  async toggleFavoriteFunctionality() {
+    if (this.state.fncId !== null) {
+      const res = await ApiaApi.post(
+        { ...this.env.context },
+        { action: "toggleFavorite", favFncId: this.state.fncId }
+      );
+      if (res?.data) {
+        this.state.isFavorite = res.data.isFavorite;
+      }
+    }
+  }
+}
+
+export { ListFunctionalityController };
+//# sourceMappingURL=ListFunctionalityController.js.map

package/dist/ListFunctionalityController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListFunctionalityController.js","sources":["../src/ListFunctionalityController.ts"],"sourcesContent":["import { Url } from '@apia/util';\r\nimport { ListFunctionalityState } from './ListController';\r\nimport { ApiaApi } from '@apia/api2';\r\nimport { TQueryEnvironment } from './types';\r\nimport { makeAutoObservable } from 'mobx';\r\n\r\nexport class ListFunctionalityController {\r\n  public readonly state: ListFunctionalityState = {\r\n    fncId: -1,\r\n    isFavorite: false,\r\n    isMaximized: false,\r\n  };\r\n\r\n  constructor(protected env: TQueryEnvironment) {\r\n    makeAutoObservable(this);\r\n\r\n    this.initializeFavoriteAction();\r\n  }\r\n\r\n  protected async initializeFavoriteAction() {\r\n    const id =\r\n      new Url(window.location.href).getParameter('favFncId') ||\r\n      new Url(\r\n        window.frameElement?.attributes.getNamedItem('src')?.value || '',\r\n      ).getParameter('favFncId');\r\n\r\n    this.state.fncId = id || (id as any) == 0 ? Number.parseInt(String(id)) : 0;\r\n    //id || (id as any) == 0 ? Number.parseInt(String(id)) : null;\r\n\r\n    if (this.state.fncId !== null) {\r\n      const res = await ApiaApi.post<{\r\n        isFavorite: boolean;\r\n      }>(\r\n        { ...this.env.context },\r\n        {\r\n          action: 'loadFavoriteState',\r\n          favFncId: this.state.fncId,\r\n        },\r\n      );\r\n\r\n      if (res?.data) {\r\n        this.state.isFavorite = res.data.isFavorite;\r\n      }\r\n    }\r\n  }\r\n\r\n  public async toggleFavoriteFunctionality() {\r\n    if (this.state.fncId !== null) {\r\n      const res = await ApiaApi.post<{\r\n        isFavorite: boolean;\r\n      }>(\r\n        { ...this.env.context },\r\n        { action: 'toggleFavorite', favFncId: this.state.fncId },\r\n      );\r\n\r\n      if (res?.data) {\r\n        this.state.isFavorite = res.data.isFavorite;\r\n      }\r\n    }\r\n  }\r\n}\r\n"],"names":[],"mappings":";;;;;;;;;;AAMO,MAAM,2BAAA,CAA4B;AAAA,EAOvC,YAAsB,GAAA,EAAwB;AAAxB,IAAA,IAAA,CAAA,GAAA,GAAA,GAAA;AANtB,IAAA,aAAA,CAAA,IAAA,EAAgB,OAAA,EAAgC;AAAA,MAC9C,KAAA,EAAO,EAAA;AAAA,MACP,UAAA,EAAY,KAAA;AAAA,MACZ,WAAA,EAAa;AAAA,KACf,CAAA;AAGE,IAAA,kBAAA,CAAmB,IAAI,CAAA;AAEvB,IAAA,IAAA,CAAK,wBAAA,EAAyB;AAAA;AAChC,EAEA,MAAgB,wBAAA,GAA2B;AACzC,IAAA,MAAM,EAAA,GACJ,IAAI,GAAA,CAAI,MAAA,CAAO,QAAA,CAAS,IAAI,CAAA,CAAE,YAAA,CAAa,UAAU,CAAA,IACrD,IAAI,GAAA;AAAA,MACF,OAAO,YAAA,EAAc,UAAA,CAAW,YAAA,CAAa,KAAK,GAAG,KAAA,IAAS;AAAA,KAChE,CAAE,aAAa,UAAU,CAAA;AAE3B,IAAA,IAAA,CAAK,KAAA,CAAM,KAAA,GAAQ,EAAA,IAAO,EAAA,IAAc,CAAA,GAAI,OAAO,QAAA,CAAS,MAAA,CAAO,EAAE,CAAC,CAAA,GAAI,CAAA;AAG1E,IAAA,IAAI,IAAA,CAAK,KAAA,CAAM,KAAA,KAAU,IAAA,EAAM;AAC7B,MAAA,MAAM,GAAA,GAAM,MAAM,OAAA,CAAQ,IAAA;AAAA,QAGxB,EAAE,GAAG,IAAA,CAAK,GAAA,CAAI,OAAA,EAAQ;AAAA,QACtB;AAAA,UACE,MAAA,EAAQ,mBAAA;AAAA,UACR,QAAA,EAAU,KAAK,KAAA,CAAM;AAAA;AACvB,OACF;AAEA,MAAA,IAAI,KAAK,IAAA,EAAM;AACb,QAAA,IAAA,CAAK,KAAA,CAAM,UAAA,GAAa,GAAA,CAAI,IAAA,CAAK,UAAA;AAAA;AACnC;AACF;AACF,EAEA,MAAa,2BAAA,GAA8B;AACzC,IAAA,IAAI,IAAA,CAAK,KAAA,CAAM,KAAA,KAAU,IAAA,EAAM;AAC7B,MAAA,MAAM,GAAA,GAAM,MAAM,OAAA,CAAQ,IAAA;AAAA,QAGxB,EAAE,GAAG,IAAA,CAAK,GAAA,CAAI,OAAA,EAAQ;AAAA,QACtB,EAAE,MAAA,EAAQ,gBAAA,EAAkB,QAAA,EAAU,IAAA,CAAK,MAAM,KAAA;AAAM,OACzD;AAEA,MAAA,IAAI,KAAK,IAAA,EAAM;AACb,QAAA,IAAA,CAAK,KAAA,CAAM,UAAA,GAAa,GAAA,CAAI,IAAA,CAAK,UAAA;AAAA;AACnC;AACF;AAEJ;;;;"}

package/dist/ModalListController.d.ts

@@ -0,0 +1,14 @@
+import { ListController, TListControllerConfiguration } from './ListController.js';
+import { TQueryEnvironment } from './types.js';
+
+declare class ModalListController extends ListController {
+    private tabId;
+    constructor(env: TQueryEnvironment, configuration: TListControllerConfiguration);
+    protected getPageMethodParameters(defaultParams: Record<string, unknown>): Record<string, unknown>;
+    protected getRefreshMethodParameters(defaultParams: Record<string, unknown>): Record<string, unknown>;
+    protected initializeFavoriteAction(): Promise<void>;
+    toggleFavoriteFunctionality(): Promise<void>;
+}
+
+export { ModalListController };
+//# sourceMappingURL=ModalListController.d.ts.map

package/dist/ModalListController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModalListController.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/ModalListController.js

@@ -0,0 +1,29 @@
+import { ListController } from './ListController.js';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, key + "" , value);
+  return value;
+};
+class ModalListController extends ListController {
+  constructor(env, configuration) {
+    super(env, configuration);
+    __publicField(this, "tabId", Date.now());
+  }
+  getPageMethodParameters(defaultParams) {
+    return { ...defaultParams, tabId: this.tabId };
+  }
+  getRefreshMethodParameters(defaultParams) {
+    return { ...defaultParams, tabId: this.tabId };
+  }
+  initializeFavoriteAction() {
+    return Promise.resolve();
+  }
+  toggleFavoriteFunctionality() {
+    return Promise.resolve();
+  }
+}
+
+export { ModalListController };
+//# sourceMappingURL=ModalListController.js.map

package/dist/ModalListController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModalListController.js","sources":["../src/ModalListController.ts"],"sourcesContent":["import { ListController, TListControllerConfiguration } from './ListController';\r\nimport { TQueryEnvironment } from './types';\r\n\r\nexport class ModalListController extends ListController {\r\n  private tabId = Date.now();\r\n\r\n  public constructor(\r\n    env: TQueryEnvironment,\r\n    configuration: TListControllerConfiguration,\r\n  ) {\r\n    super(env, configuration);\r\n  }\r\n\r\n  protected getPageMethodParameters(\r\n    defaultParams: Record<string, unknown>,\r\n  ): Record<string, unknown> {\r\n    return { ...defaultParams, tabId: this.tabId };\r\n  }\r\n\r\n  protected getRefreshMethodParameters(\r\n    defaultParams: Record<string, unknown>,\r\n  ): Record<string, unknown> {\r\n    return { ...defaultParams, tabId: this.tabId };\r\n  }\r\n\r\n  protected initializeFavoriteAction(): Promise<void> {\r\n    return Promise.resolve();\r\n  }\r\n\r\n  public toggleFavoriteFunctionality(): Promise<void> {\r\n    return Promise.resolve();\r\n  }\r\n}\r\n"],"names":[],"mappings":";;;;;;;;AAGO,MAAM,4BAA4B,cAAA,CAAe;AAAA,EAG/C,WAAA,CACL,KACA,aAAA,EACA;AACA,IAAA,KAAA,CAAM,KAAK,aAAa,CAAA;AAN1B,IAAA,aAAA,CAAA,IAAA,EAAQ,OAAA,EAAQ,KAAK,GAAA,EAAI,CAAA;AAAA;AAOzB,EAEU,wBACR,aAAA,EACyB;AACzB,IAAA,OAAO,EAAE,GAAG,aAAA,EAAe,KAAA,EAAO,KAAK,KAAA,EAAM;AAAA;AAC/C,EAEU,2BACR,aAAA,EACyB;AACzB,IAAA,OAAO,EAAE,GAAG,aAAA,EAAe,KAAA,EAAO,KAAK,KAAA,EAAM;AAAA;AAC/C,EAEU,wBAAA,GAA0C;AAClD,IAAA,OAAO,QAAQ,OAAA,EAAQ;AAAA;AACzB,EAEO,2BAAA,GAA6C;AAClD,IAAA,OAAO,QAAQ,OAAA,EAAQ;AAAA;AAE3B;;;;"}

package/dist/QueriesFunctionalityController.d.ts

@@ -0,0 +1,262 @@
+import { ListFunctionalityController } from './ListFunctionalityController.js';
+import { TApiaChartColumn, TPivotTableData, ColumnSort, Pivot, TQuerySort, PivotTableUIProps } from '@apia/charts';
+import { TQueryEnvironment } from './types.js';
+import { EventEmitter } from '@apia/util';
+import { TTab, TabsController, TabsControllerProps } from '@apia/components';
+
+type PivotTableConfig = {
+    renderer: string;
+    columnSort: string;
+    aggregator: string;
+    mainPivot: boolean;
+    description: string;
+    title: string;
+    rowSort: string;
+    columns: {
+        column: {
+            showAs: 'row' | 'column' | 'none';
+            title: string;
+            AggColumnOrder?: number;
+            isAnAggColumn: boolean;
+        }[];
+    };
+    rows: {
+        row: {
+            cell: (string | number | {
+                content: string;
+                isHTML: boolean;
+            })[];
+        } | {
+            cell: (string | number | {
+                content: string;
+                isHTML: boolean;
+            })[];
+        }[];
+    };
+};
+type Renderer = 'Table' | 'Table Heatmap' | 'Table Col Heatmap' | 'Table Row Heatmap' | 'Exportable TSV' | 'Grouped Column Chart' | 'Stacked Column Chart' | 'Grouped Bar Chart' | 'Stacked Bar Chart' | 'Line Chart' | 'Dot Chart' | 'Area Chart' | 'Scatter Chart' | 'Multiple Pie Chart';
+type Aggregator = 'Count' | 'Count Unique Values' | 'List Unique Values' | 'Sum' | 'Integer Sum' | 'Average' | 'Median' | 'Sample Variance' | 'Sample Standard Deviation' | 'Minimum' | 'Maximum' | 'First' | 'Last' | 'Sum over Sum' | 'Sum as Fraction of Total' | 'Sum as Fraction of Rows' | 'Sum as Fraction of Columns' | 'Count as Fraction of Total' | 'Count as Fraction of Rows' | 'Count as Fraction of Columns';
+type TChartData = {
+    title: string;
+    type: 'bar' | 'line' | 'scatter' | 'bubble' | 'pie' | 'doughnut' | 'polarArea' | 'radar' | 'waterfall';
+    datasets: {
+        backgroundColor: string | string[];
+        borderColor: string | string[];
+        borderWidth: number;
+        label: string;
+        data: number[] | [number, number][];
+    }[];
+    indexAxis: 'x' | 'y';
+    labels: string[];
+    showValues: string;
+    showLegend: string;
+    showXAxisValues: string | undefined;
+    showYAxisValues: string | undefined;
+    showTable: string | undefined;
+    xAxisTitle: string;
+    yAxisTitle: string;
+};
+type TApiaChartDefinition = {
+    chartType?: 'barH3D' | 'barV3D' | 'barH2D' | 'barV2D' | 'linear' | 'waterfall' | 'pie2D' | 'pie3D';
+    aspectRatio?: number;
+    axisXTitle?: string;
+    axisYTitle?: string;
+    hideSelector?: boolean;
+    /**
+     * The colors of the waterfall chart are defined by the bars with positive
+     * values and the bars with negative values. So in order to mantain cohesion
+     * in the color schema of the chart, this prop establishes the required colors
+     * for the chart
+     */
+    waterfallColors?: {
+        positive: string;
+        negative: string;
+        total: string;
+        stepConnector: string;
+    };
+    /**
+     * Name of the schema of colors shown in the chart. Pie charts must always include a schema
+     */
+    colorSchema?: string;
+    /**
+     * Main data to be parsed and shown in the chart.
+     * Depending on the ```chartType``` and the amount of ```column``` objects,
+     * the data can be considered differently.
+     *
+     * Examples:
+     * ```
+     * const columnsWithSingleColumnObject = columns: {
+     *   column: {
+     *     color: 'red',
+     *     coordinate: [
+     *       { xValue: '1', yValue: '1' },
+     *       ...,
+     *     ],
+     *     name: 'col1',
+     *   }
+     * };
+     * ```
+     * ```
+     * const columnsWithMultipleColumnObject = columns: {
+     *   column: [
+     *     {
+     *      color: 'red',
+     *      coordinate: [
+     *        { xValue: '1', yValue: '1' },
+     *        ...,
+     *      ],
+     *      name: 'col1',
+     *    },
+     *    ...,
+     *  ]
+     * };
+     *```
+     *
+     *
+     * ***Horizontal and Vertical bars***:
+     *
+     * ```1 column object```:
+     *
+     * Each ```coordinate``` is considered an individual separate 'column bar',
+     * and the ```colorSchema``` is separated between each ```coordinate``` made
+     * 'column bar'.
+     *
+     *
+     * ```Multiple column objects```:
+     *
+     * Each ```column``` object should have the same amount of coordinates and
+     * the coordinates in the same index of the array should have the same
+     * ```xValue```
+     *
+     * Each ```coordinate``` is considered an individual separate 'column bar',
+     * but the coordinates of each column are re-accommodated based on their
+     * ```xValue``` in order to make groups of columns with the same value on the
+     * X axis.
+     *
+     * In this case there will be 6 groups of columns (based on the length of the
+     * coordinate array), each group containing 3 'column bars' (based on the
+     * amount of column objects) and the ```colorSchema``` will be distributed
+     * inside each group, meaning each column having one single color.
+     *
+     *
+     * ***Linear***:
+     *
+     * ```N column objects```:
+  
+     *
+     * Each ```column``` object is considered a line path, the coordinates being
+     * the nodes of said line.
+     *
+     * ***Pie charts***:
+     *
+     * ```N column objects```:
+     *
+     * Each ```column``` object is considered a unique Pie chart, the coordinates
+     * being the slices of said pie.
+     *
+     * ***Waterfall***:
+     *
+     * ```N column objects```:
+     *
+     * Each ```column``` object is considered a unique Waterfall chart, the coordinates
+     * being bars with the ```yValue``` determining if it goes up or down. Only this
+     * type of chart admits negative values on its coordinates.
+     *
+     */
+    dataSets: {
+        data: TApiaChartColumn | TApiaChartColumn[];
+    };
+    margin?: {
+        top: number;
+        left: number;
+        bottom: number;
+        right: number;
+    } | number;
+    pnl_id?: string;
+    showAxisXTitle?: boolean;
+    showAxisYTitle?: boolean;
+    showGrid?: boolean;
+    showLegend?: boolean;
+    showValues?: boolean;
+    /**
+     * Specific for waterfall charts to show the total sum of the values of the
+     * chart at the end while each column shows its value. Otherwise the values
+     * shown on each bar will represent the current sum of values
+     */
+    showTotal?: boolean;
+    title: string;
+    ratio: {
+        height: number;
+        width: number;
+        maxWidth: number;
+    };
+};
+declare class AsideTabs extends TabsController {
+    id: string;
+    props: Omit<TabsControllerProps<TTab>, 'id' | 'initialState'>;
+    protected onTabChange: (newTab: string) => unknown;
+    constructor(id: string, props: Omit<TabsControllerProps<TTab>, 'id' | 'initialState'>, onTabChange: (newTab: string) => unknown);
+    openTab(tabId: string, _closeOthers?: boolean): void;
+}
+declare class QueriesFunctionalityController extends ListFunctionalityController {
+    protected env: TQueryEnvironment;
+    tabs?: TTab[] | undefined;
+    asideTabsController: AsideTabs;
+    queryState: {
+        currentChart?: (TChartData & {
+            chartId: string | number;
+        }) | (TChartData[] & {
+            chartId: string | number;
+        });
+        currentPivot?: TPivotTableData & {
+            pivotId: string;
+        };
+        defaultChart?: string;
+        defaultPivot?: string;
+        isLoading: boolean;
+    };
+    protected emitter: EventEmitter<{
+        changeTab: string;
+    }>;
+    constructor(env: TQueryEnvironment, tabs?: TTab[] | undefined);
+    loadChart(chartId: string): Promise<TChartData>;
+    loadMainChart(): Promise<void>;
+    private static convertChartDefinitionToChartData;
+    loadPivot(props: {
+        pivotId: string;
+        offline: boolean;
+        rowId?: string;
+    }): Promise<false | {
+        load: {
+            pivots: {
+                title: string;
+                description: string;
+                mainPivot: boolean;
+                columnSort: ColumnSort;
+                rowSort: ColumnSort;
+                renderer: Renderer;
+                aggregator: Aggregator;
+                columns: {
+                    title: string;
+                    showAs: "none" | "column" | "row";
+                    AggColumnOrder: number | undefined;
+                    isAnAggColumn: boolean;
+                }[];
+                rows: {
+                    cell: string[];
+                }[];
+            }[];
+        };
+    }>;
+    loadMainPivot(): Promise<void>;
+    private static stripHtml;
+    handleCloseChart(): void;
+    handleClosePivot(): void;
+    openAndReadFile(pivot: Pivot, accept?: string): void;
+    convertColumnSortToTQuerySort(sort: ColumnSort): TQuerySort;
+    parsePivotProps(pivot: Pivot): Omit<PivotTableUIProps, "onChange">;
+    pivotRefresh(): Promise<void>;
+}
+
+export { type PivotTableConfig, QueriesFunctionalityController, type TApiaChartDefinition, type TChartData };
+//# sourceMappingURL=QueriesFunctionalityController.d.ts.map

package/dist/QueriesFunctionalityController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueriesFunctionalityController.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}