@rokkit/core 1.0.0-next.121 → 1.0.0-next.122

package/dist/packages/core/src/field-mapper.d.ts

@@ -1,63 +0,0 @@
-export class FieldMapper {
-    constructor(fields?: any);
-    hasIcon: ((obj: unknown) => obj is {
-        [x: string]: unknown;
-    }) | undefined;
-    hasImage: ((obj: unknown) => obj is {
-        [x: string]: unknown;
-    }) | undefined;
-    hasText: ((obj: unknown) => obj is {
-        [x: string]: unknown;
-    }) | undefined;
-    hasValue: ((obj: unknown) => obj is {
-        [x: string]: unknown;
-    }) | undefined;
-    hasLabel: ((obj: unknown) => obj is {
-        [x: string]: unknown;
-    }) | undefined;
-    hasComponent: ((obj: unknown) => obj is {
-        [x: string]: unknown;
-    }) | undefined;
-    hasCurrency: ((obj: unknown) => obj is {
-        [x: string]: unknown;
-    }) | undefined;
-    withPrefix: ((x: any) => string) | undefined;
-    excludeFlags: (<U extends Partial<Record<any, any>>>(obj: any extends keyof U ? U : never) => any extends keyof U ? Omit<U, any> : never) | undefined;
-    getChildMapper(): null;
-    /**
-     * @private
-     */
-    private prop;
-    /**
-     * Gets a mapped attribute from the original item
-     *
-     * @param {string} fieldName - Name of the field to get
-     * @returns {any|null} - The attribute value or null if not found
-     */
-    get(fieldName: string, value: any, defaultValue?: null): any | null;
-    set fields(fields: any);
-    get fields(): any;
-    getIcon(value: any): string | null;
-    getValue(value: any): any;
-    getFormattedText(value: any, formatter: any): any;
-    hasChildren(item: any): item is never;
-    isNested(items: any): boolean;
-    getChildren(item: any): never[];
-    /**
-     * Finds children by an index path
-     *
-     * @param {Array<Object>} items
-     * @param {Array<number>} path
-     * @returns {Array<Object>}
-     */
-    getChildrenByPath(items: Array<Object>, path?: Array<number>): Array<Object>;
-    /**
-     * Finds an item by an index path
-     *
-     * @param {Array<Object>} items
-     * @param {Array<number>} path
-     * @returns {Object|null}
-     */
-    getItemByPath(items: Array<Object>, path?: Array<number>): Object | null;
-    #private;
-}

package/dist/packages/core/src/index.d.ts

@@ -1,13 +0,0 @@
-export * from "./types.js";
-export * from "./constants.js";
-export * from "./utils.js";
-export * from "./nested.js";
-export * from "./string.js";
-export * from "./theme.js";
-export { FieldMapper } from "./field-mapper.js";
-export { createEmitter } from "./events.js";
-export { getLineTypes } from "./connector.js";
-export { generateTicks } from "./ticks.js";
-export { getItemAtIndex, getIndexForItem } from "./mapped-items.js";
-export { weekdays, getCalendarDays } from "./calendar.js";
-export { getValue, getNestedFields, hasChildren, isExpanded } from "./mapping.js";

package/dist/packages/core/src/key-event-map.d.ts

@@ -1,18 +0,0 @@
-/**
- * Class to manage key event mappings.
- */
-export class KeyEventMap {
-    mapping: {};
-    /**
-     * Add a new key mapping.
-     * @param {string}               eventName - The event name.
-     * @param {Array<string>|RegExp} keys      - The keys to match.
-     */
-    add(eventName: string, keys: Array<string> | RegExp): void;
-    /**
-     * Get the event name for a given key.
-     * @param {string} key - The key to match.
-     * @returns {string|null} - The event name or null if no match is found.
-     */
-    getEventForKey(key: string): string | null;
-}

package/dist/packages/core/src/mapped-items.d.ts

@@ -1,14 +0,0 @@
-/**
- * Get an item at a specific index
- * @param {Array<any>} items
- * @param {any} index
- * @returns
- */
-export function getItemAtIndex(items: Array<any>, index: any): any;
-/**
- *  Get the index for an item in an array
- * @param {Array<any} items
- * @param {any} item
- * @returns
- */
-export function getIndexForItem(items: Array<any>, item: any): number;

package/dist/packages/core/src/mapping.d.ts

@@ -1,75 +0,0 @@
-/**
- * Get the component to be used to render the item.
- * If the component is null or undefined, it will return the default component.
- *
- * @param {object|string}                     value
- * @param {import('./types.js').FieldMapping} fields
- * @param {import('./types.js').ComponentMap} using
- */
-export function getComponent(value: object | string, fields: import("./types.js").FieldMapping, using: import("./types.js").ComponentMap): import("svelte").SvelteComponent<Record<string, any>, any, any>;
-/**
- * Get the icon for the item. If the icon is an object, it will use the state to determine which icon to use.
- *
- * @param {object|string}                     value
- * @param {import('./types.js').FieldMapping} fields
- * @returns {string}
- */
-export function getIcon(value: object | string, fields?: import("./types.js").FieldMapping): string;
-/**
- * Get the value for the item. If the value is an object,
- * it will use the field mapping to determine which attribute to get.
- *
- * @param {*}                              node
- * @param {import('./types').FieldMapping} fields
- * @returns {*}
- */
-export function getValue(node: any, fields?: import("./types").FieldMapping): any;
-/**
- * Get the text for the item. If the text is an object,
- * it will use the field mapping to determine which attribute to get.
- *
- * @param {*}                              node
- * @param {import('./types').FieldMapping} fields
- * @returns {string}
- */
-export function getText(node: any, fields?: import("./types").FieldMapping): string;
-/**
- * Gets the attribute from the node
- * @param {*}      node
- * @param {string} attr
- * @returns {*}
- */
-export function getAttribute(node: any, attr: string): any;
-/**
- * Get the formatted text for the item. If the text is an object, use the field mapping to determine
- * which attribute to get currency. Use the formatter or identity function to format the text.
- *
- * @param {*}                              node
- * @param {import('./types').FieldMapping} fields
- * @param {Function}                       formatter
- * @returns {Function}
- */
-export function getFormattedText(node: any, fields?: import("./types").FieldMapping, formatter?: Function): Function;
-/**
- * Check if the current item is a parent
- *
- * @param {*}                              item
- * @param {import('./types').FieldMapping} fields
- * @returns {boolean}
- */
-export function hasChildren(item: any, fields: import("./types").FieldMapping): boolean;
-/**
- * Check if the current item is a parent and is expanded
- *
- * @param {*}                              item
- * @param {import('./types').FieldMapping} fields
- * @returns {boolean}
- */
-export function isExpanded(item: any, fields: import("./types").FieldMapping): boolean;
-/**
- * Fetches the fieldmapping for a child node
- *
- * @param {import('./types').FieldMapping} fields
- * @returns {import('./types').FieldMapping}
- */
-export function getNestedFields(fields: import("./types").FieldMapping): import("./types").FieldMapping;

package/dist/packages/core/src/nested.d.ts

@@ -1,18 +0,0 @@
-/**
- * Flattens a nested list of items
- *
- * @param {Array}                         items
- * @param {import('./types).FieldMapping} fields
- * @param {number}                        level
- * @returns {Array}
- */
-export function flattenNestedList(items: any[], fields?: any, level?: number): any[];
-/**
- * Matches a path slug to a value in the menu
- *
- * @param {string}                         slug
- * @param {Array}                          data
- * @param {import('./types').FieldMapping} fields
- * @returns {any}
- */
-export function findValueFromPath(slug: string, data: any[], fields: import("./types").FieldMapping): any;

package/dist/packages/core/src/string.d.ts

@@ -1,59 +0,0 @@
-/**
- * Capitalizes the first letter of input string
- *
- * @param {String} str
- * @returns {String}
- */
-export function toInitCapCase(text: any): string;
-/**
- * Convert a hyphen separated string to PascalCase
- *
- * @param {String} text
- * @returns
- */
-export function toPascalCase(text: string): string;
-/**
- * Convert a PascalCase string to snake case with separator as hyphen
- *
- * @param {string} text
- * @returns {string}
- */
-export function toHyphenCase(text: string): string;
-/**
- * Simple comparison for two strings
- *
- * @param {String} a
- * @param {String} b
- * @returns
- */
-export function compareStrings(a: string, b: string): 1 | 0 | -1;
-/**
- * Sort by splitting hyphen separated strings while keeping strings with same number of parts together
- *
- * @param {String} a hyphen separates string
- * @param {String} b hyphen separates string
- * @param {string} separator - separator to split the string
- * @returns {Number} -1, 0, 1 based on comparison
- */
-export function sortByParts(a: string, b: string, separator?: string): number;
-/**
- * Generates a unique id from current timestamp
- *
- * @returns {String} timestamp based unique id
- */
-export function uniqueId(prefix?: string, separator?: string): string;
-/**
- * Removes undefined and null values from the input object.
- *
- * @param {Object} obj
- * @returns {Object}
- */
-export function compact(obj: Object): Object;
-/**
- * Converts an input number into it's hexadecimal representation, with optional left padded zeroes based on the `size`
- *
- * @param {number} value
- * @param {number} size
- * @returns
- */
-export function toHexString(value: number, size?: number): string;

package/dist/packages/core/src/theme.d.ts

@@ -1,52 +0,0 @@
-/**
- * Generate shades for a color using css varuable
- *
- * @param {string} name
- * @param {string} modifier
- * @returns
- */
-export function shadesOf(name: string, modifier?: string): {
-    DEFAULT: any;
-    base: any;
-    inset: any;
-    subtle: any;
-    muted: any;
-    raised: any;
-    elevated: any;
-    floating: any;
-    contrast: any;
-    overlay: any;
-};
-/**
- * Generate shades for a color using css varuable
- *
- * @param {string} name
- * @param {string} modifier
- * @returns {object}
- */
-export function stateColors(name: string, modifier?: string): object;
-/**
- *
- * @param {string} modifier
- * @returns
- */
-export function themeColors(modifier?: string): {};
-/**
- * Generates contrast colors for light and dark modes based on a given palette. Each color variant in the
- * palette is mapped to either a light or dark contrast color depending on the shade's value.
- *
- * @param {string} [light='#ffffff'] - The default light color used when the shade is >= 500 in light mode or <= 500 in dark mode.
- * @param {string} [dark='#000000'] - The default dark color used when the shade is < 500 in light mode or > 500 in dark mode.
- * @param {Array<string>} [palette=defaultPalette] - An array of color variant names to generate contrast colors for.
- * @returns {Array<Object>} An array containing contrast color rules organized by light and dark modes for each variant in the palette.
- */
-export function contrastColors(light?: string, dark?: string, palette?: Array<string>): Array<Object>;
-/**
- * Constructs and returns the light and dark theme variants based on provided color mapping and color definitions.
- *
- * @param {string} name                          - The base name for the theme, defaults to 'rokkit' if not provided.
- * @param {Object} [mapping=defaultThemeMapping] - An object mapping variant names to color property names.
- * @param {Object} [colors=defaultColors]        - The object containing default color definitions.
- * @returns {Array<Array>} An array containing two arrays, one for the light theme variant and another for the dark theme.
- */
-export function themeRules(name?: string, mapping?: Object, colors?: Object): Array<any[]>;

package/dist/packages/core/src/ticks.d.ts

@@ -1,10 +0,0 @@
-/**
- * Generates an array of tick marks for a range of values.
- *
- * @param {number} lowerBound                            - The lower bound of the range.
- * @param {number} upperBound                            - The upper bound of the range.
- * @param {number} [minorTickStep=upperBound-lowerBound] - The step size for minor ticks.
- * @param {number} [majorTickStep=1]                     - The step size for major ticks.
- * @returns {import('./types').TickMark[]>} An array of tick mark objects.
- */
-export function generateTicks(lowerBound: number, upperBound: number, minorTickStep?: number, majorTickStep?: number): import("./types").TickMark[];

package/dist/packages/core/src/types.d.ts

@@ -1,245 +0,0 @@
-declare const _default: {};
-export default _default;
-export type LineType = "child" | "last" | "sibling" | "empty" | "icon";
-/**
- * An object where keys are event names and values are event handler functions.
- */
-export type EventHandlers = {
-    [x: string]: Function;
-};
-/**
- * Component map to be used to render the item.
- */
-export type ComponentMap = {
-    [x: string]: import("svelte").SvelteComponent<Record<string, any>, any, any>;
-};
-/**
- * Options for the sort order of the column.
- */
-export type SortOptions = "ascending" | "descending" | "none";
-export type SelectionState = "checked" | "unchecked" | "indeterminate";
-/**
- * Options for the horizontal alignment of the column content.
- */
-export type HorizontalAlignOptions = "left" | "middle" | "right";
-/**
- * Options for the action type of the column.
- */
-export type ActionTypes = "select" | "edit" | "delete";
-/**
- * Structure to map custom fields for rendering. This is used to identofy the attributes for various purposes.
- */
-export type FieldMapping = {
-    /**
-     * Unique id for the item
-     */
-    id?: string | undefined;
-    /**
-     * the text to render
-     */
-    text?: string | undefined;
-    /**
-     * the value associated with the item
-     */
-    value?: string | undefined;
-    /**
-     * a URL
-     */
-    url?: string | undefined;
-    /**
-     * icon to render
-     */
-    icon?: string | undefined;
-    /**
-     * the image to render
-     */
-    image?: string | undefined;
-    /**
-     * children of the item
-     */
-    children?: string | undefined;
-    /**
-     * summary of the item
-     */
-    summary?: string | undefined;
-    /**
-     * notes for the item
-     */
-    notes?: string | undefined;
-    /**
-     * additional properties
-     */
-    props?: string | undefined;
-    /**
-     * item is open or closed
-     */
-    isOpen?: string | undefined;
-    /**
-     * level of item
-     */
-    level?: string | undefined;
-    /**
-     * item is a parent
-     */
-    parent?: string | undefined;
-    /**
-     * {string} [isDeleted='_deleted'] item is deleted
-     */
-    currency?: string | undefined;
-    /**
-     * Field mapping to be used on children in the next level
-     */
-    fields?: FieldMapping | 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").
-     */
-    dataType: string;
-    /**
-     * - Additional attributes for the column.
-     */
-    fields?: 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 virtual (true/false).
-     */
-    virtual?: boolean | undefined;
-    /**
-     * - Indicates if the column is sortable (true/false).
-     */
-    sortable?: boolean | undefined;
-    /**
-     * - The sort order of the column.
-     */
-    sortOrder?: SortOptions | undefined;
-    /**
-     * - The alignment of the column content.
-     */
-    align?: HorizontalAlignOptions | undefined;
-    /**
-     * - Action attribute for action columns.
-     */
-    action?: ActionTypes | undefined;
-};
-/**
- * Track the state of a row in the table.
- */
-export type RowState = {
-    /**
-     * - The index of the node in the flat list.
-     */
-    index: 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;
-    /**
-     * - The index of the parent node in the flat list.
-     */
-    parentIndex?: number | undefined;
-    /**
-     * - Indicates whether the node is selected (true/false/indeterminate).
-     */
-    selected?: SelectionState | undefined;
-    /**
-     * - The indices of the children in the flat list.
-     */
-    childred: Array<number>;
-};
-/**
- * Track the state of all rows in the table.
- */
-export type RowStateMap = {
-    /**
-     * - Flat list of hierarchy nodes.
-     */
-    rows: RowState[];
-};
-/**
- * Shade mapping for color variables
- */
-export type ShadeMapping = {
-    /**
-     * - the variable name to be used
-     */
-    key: string;
-    /**
-     * - the value to be used
-     */
-    value: string;
-    /**
-     * - light or dark mode
-     */
-    mode: string;
-};
-export type TickMark = {
-    /**
-     * - The value of the tick mark.
-     */
-    value: number;
-    /**
-     * - The label for the tick mark.
-     */
-    label: string;
-    /**
-     * - Indicates if the tick mark is a major tick.
-     */
-    major: boolean;
-};
-export type CalendarDay = {
-    /**
-     * - The day of the month.
-     */
-    day: number;
-    /**
-     * - indicates the offset for positioning
-     */
-    offset: number;
-    /**
-     * - Datevalue for the day.
-     */
-    date: date;
-    /**
-     * - formatted text for the day.
-     */
-    text: string;
-    /**
-     * - Indicates if the day is a holiday.
-     */
-    holiday: boolean;
-    /**
-     * - Indicates if the day is on the weekend.
-     */
-    weekend: boolean;
-};

package/dist/packages/core/src/utils.d.ts

@@ -1,70 +0,0 @@
-/**
- * Finds the closest ancestor of the given element that has the given attribute.
- *
- * @param {HTMLElement} element
- * @param {string} attribute
- * @returns {HTMLElement|null}
- */
-export function getClosestAncestorWithAttribute(element: HTMLElement, attribute: string): HTMLElement | null;
-/**
- * A function that performs no operations.
- */
-export function noop(): void;
-/**
- * Generates a random id
- *
- * @returns {string} A random id
- */
-export function id(): string;
-/**
- * Check if a value is a json object
- *
- * @param {*} val
- * @returns {boolean}
- */
-export function isObject(val: any): boolean;
-/**
- * Converts the value to a string. If the value is an object, it will convert it to a JSON string.
- *
- * @param {*} value
- * @returns {string}
- */
-export function toString(value: any): string;
-/**
- * Generates icon shortcuts for a collection of icons
- *
- * @param {string[]} icons
- * @param {string} collection
- * @param {string} variants
- * @returns {Object}
- */
-export function iconShortcuts(icons: string[], collection: string, variants: string): Object;
-/**
- * Scales the path by the size
- *
- * @param {number} size
- * @param {string|number} x
- * @returns {string|number}
- */
-export function scaledPath(size: number, x: string | number): string | number;
-/**
- * Gets a key string from path
- * @param {string[]} path
- * @returns {string}
- */
-export function getKeyFromPath(path: string[]): string;
-/**
- * Gets a path array from key string
- * @param {string} key
- * @returns {string[]}
- */
-export function getPathFromKey(key: string): string[];
-/**
- * Get snippet function from an object
- * @param {Object} obj
- * @param {string} key
- * @param {null|Function} defaultSnippet
- * @returns {Function|undefined}
- */
-export function getSnippet(obj: Object, key: string, defaultSnippet?: null | Function): Function | undefined;
-export function importIcons(icons: Object): Object;

package/dist/packages/data/src/aggregators.d.ts

@@ -1,2 +0,0 @@
-export function counter(values: any[]): number;
-export function violin(values: number[]): Object;

package/dist/packages/data/src/constants.d.ts

@@ -1,46 +0,0 @@
-export const pickAllowedConfig: <U extends Partial<Record<"children" | "actual_flag", any>>>(obj: "children" | "actual_flag" extends keyof U ? U : never) => "children" | "actual_flag" extends keyof U ? Pick<U, keyof U & ("children" | "actual_flag")> : never;
-/** @type {import('./types').DataFrameConfig */
-export const defaultConfig: import("./types").DataFrameConfig;
-export namespace defaultPathOptions {
-    let path: null;
-    let separator: string;
-    let currencySuffix: string;
-}
-export namespace defaultViewOptions {
-    let expanded: boolean;
-    let actions: never[];
-    let language: string;
-    let scanMode: string;
-}
-export namespace defaultActionOrder {
-    export let select: number;
-    export let edit: number;
-    let _delete: number;
-    export { _delete as delete };
-}
-/**
- * Returns the default properties for a column
- * @param {string} key - the key to use for the column
- * @returns {Object} the default properties for a column
- */
-export const filterOperations: {
-    '=': (value: any, pattern: any) => boolean;
-    '<': (value: any, pattern: any) => boolean;
-    '>': (value: any, pattern: any) => boolean;
-    '<=': (value: any, pattern: any) => boolean;
-    '>=': (value: any, pattern: any) => boolean;
-    '~*': (value: any, pattern: any) => any;
-    '~': (value: any, pattern: any) => any;
-    '!=': (value: any, pattern: any) => boolean;
-    '!~*': (value: any, pattern: any) => boolean;
-    '!~': (value: any, pattern: any) => boolean;
-};
-export namespace typeConverters {
-    export function string(value: any): string;
-    export function number(value: any): number;
-    export function boolean(value: any): boolean;
-    export function date(value: any): Date;
-    export { identity as mixed };
-}
-export function includeAll(): boolean;
-import { identity } from 'ramda';