@rokkit/data 1.0.0-next.119 → 1.0.0-next.121

package/dist/types.d.ts

@@ -0,0 +1,346 @@
+declare const _default: {};
+export default _default;
+export type FieldMapping = import("@rokkit/core").FieldMapping;
+export type SortOptions = import("@rokkit/core").SortOptions;
+export type HorizontalAlignOptions = import("@rokkit/core").HorizontalAlignOptions;
+export type ActionTypes = import("@rokkit/core").ActionTypes;
+export type SelectionState = import("@rokkit/core").SelectionState;
+export type ColumnSorter = {
+    name: string;
+    sorter: Function;
+};
+export type SortableColumn = string | [string, boolean] | ColumnSorter;
+export type ColumnAggregator = {
+    name: string;
+    aggregator: Function;
+    suffix: string;
+};
+/**
+ * Options for joining two data sets
+ */
+export type OptionsToRenameKeys = {
+    /**
+     * - Prefix to be added to each attribute
+     */
+    prefix?: string | undefined;
+    /**
+     * - Suffix to be added to each attribute
+     */
+    suffix?: string | undefined;
+    /**
+     * - Separator to be used when adding prefix or suffix. defaults to _
+     */
+    separator?: string | undefined;
+};
+/**
+ * Column metadata for the table.
+ */
+export type ColumnMetadata = {
+    /**
+     * - The name of the column.
+     */
+    name: string;
+    /**
+     * - The data type of the column (e.g., "string", "number", "date").
+     */
+    type: string;
+    /**
+     * - The field mapping for the column.
+     */
+    field?: import("@rokkit/core").FieldMapping | undefined;
+    /**
+     * - The number of digits for numeric values (defaults to 0).
+     */
+    digits?: number | undefined;
+    /**
+     * - A function to format the column value.
+     */
+    formatter: Function;
+    /**
+     * - Indicates if the column is sortable (true/false).
+     */
+    sortable?: boolean | undefined;
+    /**
+     * - The sort order of the column.
+     */
+    sortOrder?: import("@rokkit/core").SortOptions | undefined;
+    /**
+     * - The alignment of the column content.
+     */
+    align?: import("@rokkit/core").HorizontalAlignOptions | undefined;
+    /**
+     * - Action attribute for action columns.
+     */
+    action?: import("@rokkit/core").ActionTypes | undefined;
+};
+export type Metadata = Array<ColumnMetadata>;
+export type ColumnIndexMap = {
+    [x: string]: number;
+};
+/**
+ * Track the state of a row in the table.
+ */
+export type TreeTableNode = {
+    /**
+     * - Reference to actual row in the data.
+     */
+    row: number;
+    /**
+     * - The depth of the node in the hierarchy.
+     */
+    depth: number;
+    /**
+     * - The value of the hierarchy node.
+     */
+    value?: string | undefined;
+    /**
+     * - Indicates whether the node is visible (true/false).
+     */
+    isHidden?: boolean | undefined;
+    /**
+     * - Indicates if this node is a parent (true/false).
+     */
+    isParent?: boolean | undefined;
+    /**
+     * - Indicates whether the node is expanded (true/false).
+     */
+    isExpanded?: boolean | undefined;
+    /**
+     * - Reference to the parent node in the flat list.
+     */
+    parent?: number | undefined;
+    /**
+     * - Indicates whether the node is selected (true/false/indeterminate).
+     */
+    selected?: import("@rokkit/core").SelectionState | undefined;
+    /**
+     * - Reference to the children nodes in the flat list.
+     */
+    children: Array<any>;
+};
+/**
+ * Track the state of all rows in the table.
+ */
+export type TreeTable = {
+    /**
+     * - Flat list of hierarchy nodes.
+     */
+    rows: TreeTableNode[];
+};
+export type OverrideConfig = {
+    /**
+     * - the field used for identifying filler rows in the data
+     */
+    actual_flag: string;
+    /**
+     * - the field used for collecting children of a node in rollup
+     */
+    children: string;
+};
+export type ReducerConfig = {
+    /**
+     * - The target field to hold the reduced value
+     */
+    field: string;
+    /**
+     * - The function to use for reducing the data
+     */
+    using: Function;
+};
+export type SummaryConfig = {
+    /**
+     * - A function used to collect the data for the summary
+     */
+    mapper: Function;
+    /**
+     * - Array of reducer configurations
+     */
+    reducers: Array<ReducerConfig>;
+    /**
+     * - Array of column metadata for the summary
+     */
+    metadata?: Metadata | undefined;
+};
+export type DataFrameConfig = {
+    /**
+     * =[]         - The columns to group by.
+     */
+    group_by: Array<string>;
+    /**
+     * =[]         - The columns to be aligned during rollup.
+     */
+    align_by: Array<string>;
+    /**
+     * =[] - Array of summary configurations.
+     */
+    summaries: Array<SummaryConfig>;
+    /**
+     * ={}                   - Template row to be used for filling in missing rows.
+     */
+    template: any;
+};
+export type SortBy = Function;
+/**
+ * DataFrame-like object with data manipulation methods.
+ */
+export type DataFrame = {
+    /**
+     * - Array of objects representing the rows of data.
+     */
+    data: Array<Object>;
+    /**
+     * - Array of column metadata for the data.
+     */
+    metadata: Metadata;
+    /**
+     * - Configuration options for the DataFrame.
+     */
+    config: DataFrameConfig;
+    /**
+     * - A map of column names to their index in the metadata.
+     */
+    columns: ColumnIndexMap;
+    /**
+     * - Method to override the configuration of the DataFrame.
+     */
+    override: (arg0: OverrideConfig) => DataFrame;
+    /**
+     * - Method to group the DataFrame by specified columns.
+     */
+    groupBy: (...args: string[]) => DataFrame;
+    /**
+     * - Sets the filter function for the DataFrame
+     */
+    where: (arg0: (arg0: any) => any) => DataFrame;
+    /**
+     * - Method to align the DataFrame.
+     */
+    align: () => DataFrame;
+    /**
+     * - set the template to be used for filling in missing rows.
+     */
+    using: () => DataFrame;
+    /**
+     * - add a summarizer to be used during rollup
+     */
+    summarize: () => DataFrame;
+    /**
+     * - Method to sort the DataFrame by specified columns.
+     */
+    sortBy: (...args: SortableColumn[]) => DataFrame;
+    /**
+     * - perform join with another DataFrame returning a new DataFrmae. Defaults to innerJoin, other join types can be specified.
+     */
+    join: () => DataFrame;
+    /**
+     * - perform an ineer join with another DataFrame and return a new DataFrame.
+     */
+    innerJoin: () => DataFrame;
+    /**
+     * - perform a left join with another DataFrame and return a new DataFrame.
+     */
+    leftJoin: () => DataFrame;
+    /**
+     * - perform a right join with another DataFrame returning a new DataFrame.
+     */
+    rightJoin: () => DataFrame;
+    /**
+     * - perform a full join with another DataFrame returning a new DataFrame.
+     */
+    fullJoin: () => DataFrame;
+    /**
+     * - perform a nested join with another DataFrame returning a new DataFrame.
+     */
+    nestedJoin: () => DataFrame;
+    /**
+     * - Method to rename the columns of the DataFrame.
+     */
+    rename: () => DataFrame;
+    /**
+     * - Method to drop the columns of the DataFrame.
+     */
+    drop: () => DataFrame;
+    /**
+     * - Method to delete the rows of the DataFrame.
+     */
+    delete: () => DataFrame;
+    /**
+     * - Method to update the rows of the DataFrame.
+     */
+    update: () => DataFrame;
+    /**
+     * - Method to combine the rows of the DataFrame with another DataFrame.
+     */
+    union: () => DataFrame;
+    /**
+     * - Method to remove the rows of the DataFrame which are present in another DataFrame.
+     */
+    minus: () => DataFrame;
+    /**
+     * - Method to keep the rows of the DataFrame which are present in another DataFrame.
+     */
+    intersect: () => DataFrame;
+    /**
+     * - Method to rollup the DataFrame.
+     */
+    rollup: () => DataFrame;
+    /**
+     * - Method to select the columns of the DataFrame.
+     */
+    select: () => Arrat<Object>;
+};
+export type JoinType = inner | outer | full | nested;
+/**
+ * Options for joining two data sets
+ */
+export type JoinOptions = {
+    /**
+     * - Flag indicating inner join
+     */
+    inner?: boolean | undefined;
+    /**
+     * {string} [prefix]                - prefix to be used for renaming keys in the second data set.
+     */
+    type?: JoinType;
+    /**
+     * - suffix to be used for renaming keys in the second data set.
+     */
+    suffix?: string | undefined;
+    /**
+     * - separator to be used for renaming keys in the second data set.
+     */
+    separator?: string | undefined;
+};
+/**
+ * DataView
+ */
+export type DataView = {
+    /**
+     * - The state of the rows in the table.
+     */
+    hierarchy: TreeTable;
+    /**
+     * - The metadata for the columns in the table.
+     */
+    columns: Metadata;
+    /**
+     * - Sort the DataView by the specified columns.
+     */
+    sortBy: Function;
+    /**
+     * - Clear the sorting of the DataView.
+     */
+    clearSort: Function;
+    /**
+     * - Filter the DataView by the specified columns.
+     */
+    filter: Function;
+    /**
+     * - toggle expand or collapse the DataView by the specified columns.
+     */
+    toggle: Function;
+    /**
+     * - select the DataView by the specified columns.
+     */
+    select: Function;
+};

package/dist/utils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Derive the type of a value
+ * @param {any} value
+ * @returns {string}
+ */
+export function typeOf(value: any): string;

package/dist/view.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Sorts a hierarchy based on a group of sorters.
+ *
+ * @param {Array<Object>} hierarchy - The hierarchy to sort.
+ * @param {Array<Array<string, boolean>>} sortGroup - The group of sorters to apply.
+ */
+export function groupSort(hierarchy: Array<Object>, sortGroup: Array<Array<string, boolean>>): void;
+/**
+ * Determines the selected state of a group of children in the hierarchy.
+ * If all children are checked, returns 'checked'.
+ * If all children are unchecked, returns 'unchecked'.
+ * Otherwise, returns 'indeterminate'.
+ *
+ * @param {Array<Object>} children - The array of child objects with a 'selected' property.
+ * @returns {string} The determined selected state: 'checked', 'unchecked', or 'indeterminate'.
+ */
+export function determineSelectedState(children: Array<Object>): string;
+/**
+ * Toggles the selection state of a node in the hierarchy.
+ * Depending on whether the node to toggle is a parent or child,
+ * it will either select or deselect all children, or update the parent's selection state based on its children's states.
+ *
+ * @param {import('./types').Hierarchy} item - The node to toggle.
+ *
+ */
+export function toggleSelection(item: import("./types").Hierarchy): void;
+/**
+ * Creates a view object for managing data presentation with metadata and hierarchy structures,
+ * as well as providing methods for sorting, selection, and toggling of data expansion.
+ *
+ * @param {Array<Object>} data    - The source data array to be presented by the view.
+ * @param {Object}        options - The configuration options used for deriving metadata and hierarchy from the data.
+ * @returns {import('svelte/store').Writable} An object representing the view, providing methods to manipulate and query the presentation state.
+ */
+export function dataview(data: Array<Object>, options: Object): import("svelte/store").Writable<any>;

package/package.json

@@ -1,12 +1,9 @@
 {
   "name": "@rokkit/data",
-  "version": "1.0.0-next.119",
+  "version": "1.0.0-next.121",
   "description": "Contains generic data manipulation functions that can be used in various components.",
   "author": "Jerry Thomas <me@jerrythomas.name>",
   "license": "MIT",
-  "main": "index.js",
-  "module": "src/index.js",
-  "types": "dist/index.d.ts",
   "type": "module",
   "publishConfig": {
     "access": "public"
@@ -18,7 +15,9 @@
   },
   "files": [
     "src/**/*.js",
-    "src/**/*.svelte"
+    "dist/**/*.d.ts",
+    "README.md",
+    "package.json"
   ],
   "exports": {
     "./src": "./src",
@@ -31,7 +30,7 @@
   },
   "dependencies": {
     "@lukeed/uuid": "^2.0.1",
-    "@rokkit/core": "1.0.0-next.118",
+    "@rokkit/core": "1.0.0-next.120",
     "d3-array": "^3.2.4",
     "d3-collection": "^1.0.7",
     "ramda": "^0.30.1",