@rokkit/core 1.0.0-next.100 → 1.0.0-next.102

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Jerry Thomas
+Copyright (c) 2025 Jerry Thomas
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/colors/index.d.ts

@@ -0,0 +1,333 @@
+export const shades: number[];
+export const defaultPalette: string[];
+export const syntaxColors: {
+    "one-dark": {
+        dark: {
+            "--tab-size": string;
+            "--code-fill": string;
+            "--code-normal": string;
+            "--code-string": string;
+            "--code-number": string;
+            "--code-atrule": string;
+            "--code-keyword": string;
+            "--code-comment": string;
+            "--code-property": string;
+            "--code-selector": string;
+            "--code-operator": string;
+            "--code-function": string;
+            "--code-gutter-marker": string;
+            "--code-gutter-subtle": string;
+            "--code-cursor": string;
+            "--code-cursor-block": string;
+            "--code-linenumbers": string;
+        };
+        light: {
+            "--tab-size": string;
+            "--code-fill": string;
+            "--code-normal": string;
+            "--code-string": string;
+            "--code-number": string;
+            "--code-atrule": string;
+            "--code-keyword": string;
+            "--code-comment": string;
+            "--code-property": string;
+            "--code-selector": string;
+            "--code-operator": string;
+            "--code-function": string;
+            "--code-gutter-marker": string;
+            "--code-gutter-subtle": string;
+            "--code-cursor": string;
+            "--code-cursor-block": string;
+            "--code-linenumbers": string;
+        };
+    };
+};
+export const defaultColors: {
+    amber: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    blue: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    cyan: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    emerald: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    fuscia: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    gray: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    green: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    indigo: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    lime: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    orange: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    pink: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    purple: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    red: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    rose: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    sky: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    slate: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    stone: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    teal: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    violet: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    yellow: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    zinc: {
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    shark: {
+        DEFAULT: string;
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+};

package/dist/constants.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Generate a state icon mapping from a list of icon names
+ *
+ * @param {string[]} icons
+ * @returns {import('./types').StateIcons}
+ */
+export function stateIconsFromNames(icons: string[]): import("./types").StateIcons;
+/**
+ * @type {import('./types).FieldMapping} Fields
+ */
+export const defaultFields: any;
+export const defaultIcons: string[];
+export namespace defaultOptions {
+    let id: string;
+    let label: string;
+    let value: string;
+    let checked: string;
+}
+export namespace defaultKeyMap {
+    let ArrowRight: string;
+    let ArrowLeft: string;
+    let ArrowDown: string;
+    let ArrowUp: string;
+    let Enter: string;
+    let Escape: string;
+}
+export namespace defaultThemeMapping {
+    let neutral: string;
+    let primary: string;
+    let secondary: string;
+    let accent: string;
+    let success: string;
+    let warning: string;
+    let danger: string;
+    let error: string;
+    let info: string;
+}
+export const defaultStateIcons: any;
+export { defaultColors, syntaxColors, shades, defaultPalette } from "./colors/index.js";

package/dist/field-mapper.d.ts

@@ -0,0 +1,20 @@
+export class FieldMapper {
+    constructor(fields?: any, using?: {});
+    _fields: {};
+    _using: {};
+    set fields(fields: {});
+    get fields(): {};
+    set using(using: {});
+    get using(): {};
+    getComponent(value: any): import("svelte").SvelteComponent<Record<string, any>, any, any>;
+    getIcon(value: any): string;
+    getValue(node: any): any;
+    getText(node: any): string;
+    getAttribute(node: any, attr: any): any;
+    getFormattedText(node: any, formatter: any): Function;
+    hasChildren(item: any): boolean;
+    isExpanded(item: any): boolean;
+    isNested(items: any): boolean;
+    hasImage(item: any): any;
+    hasIcon(item: any): any;
+}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./types.js";
+export * from "./constants.js";
+export * from "./utils.js";
+export * from "./nested.js";
+export * from "./string.js";
+export { FieldMapper } from "./field-mapper.js";

package/dist/key-event-map.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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/mapping.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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;

package/dist/nested.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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/string.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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): 0 | 1 | -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;