@rokkit/data 1.0.0-next.118 → 1.0.0-next.120

package/dist/parser.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Constructs a regular expression pattern for matching search filter strings.
+ * The pattern captures "column", "operator", and "value" groups for filter expressions.
+ * Supported operators include common comparison and wildcard operators.
+ *
+ * Examples of valid expressions this regex can match:
+ * - "username:john_doe"
+ * - "age>30"
+ * - "status!=active"
+ * - "title~\"Product Manager\""
+ * - "completed!~*yes"
+ *
+ * The "column" group matches one or more word characters.
+ * The "operator" group matches one among the specified comparison or wildcard operators:
+ * :, >, <, >=, <=, =<, =>, =, !=, ~, ~*, !~, !~*.
+ * The "value" group matches either a double-quoted string or a single unquoted word
+ * that doesn't include whitespace or any of the operator characters.
+ *
+ * @returns {RegExp} - The regular expression pattern to identify search filter elements.
+ */
+export function getRegex(): RegExp;
+/**
+ * Parses a search string and extracts filters based on a predefined regular expression pattern.
+ * Each filter captures column, operator, and value components. Any remaining text that
+ * does not fit the pattern is considered a general search term.
+ *
+ * @param {string} string - The search string to parse for filters.
+ * @returns {Object[]} - An array of filter objects each containing the column, operator, and value,
+ *                       plus an additional object for general search if there is remaining text.
+ */
+export function parseFilters(string: string): Object[];

package/dist/renamer.d.ts

@@ -0,0 +1,37 @@
+/**
+ * A generator function that produces a function to rename keys.
+ *
+ * @param {OptionsToRenameKeys} options - Options to rename keys
+ * @returns {Object}                    - A renamer object.
+ *
+ * Example:
+ *
+ * renamer({ prefix: 'a', keys: ['a', 'b'] }).get()
+ * renamer({ prefix: 'a', separator: '-' }).get()
+ * renamer().setPrefix('a')
+ *          .setSeparator('-')
+ *          .setKeys(['a', 'b'])
+ *          .get()
+ * renamer().setPrefix('a').get()
+ * renamer().setSuffix('b').get()
+ * renamer().setKeys(['a', 'b']).get()
+ */
+export function renamer(options?: OptionsToRenameKeys): Object;
+export type OptionsToRenameKeys = {
+    /**
+     * - The prefix to add to the key.
+     */
+    prefix?: string | undefined;
+    /**
+     * - The suffix to add to the key.
+     */
+    suffix?: string | undefined;
+    /**
+     * - The separator to use between the key and the prefix or suffix.
+     */
+    separator?: string | undefined;
+    /**
+     * - The keys to rename.
+     */
+    keys?: any[] | undefined;
+};

package/dist/rollup.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Sets initial values for summaries.
+ *
+ * @param {Array} summaries - An array of summary objects.
+ * @returns {Object} An object with keys for each summary initialized to empty arrays.
+ */
+export function initialValues(summaries: any[]): Object;
+/**
+ * Adds data to summary aggregation arrays.
+ *
+ * @param {Object} group - The group object to add data to.
+ * @param {Object} row - The data row being processed.
+ * @param {Array} summaries - An array of summary objects.
+ */
+export function addToSummaries(group: Object, row: Object, summaries: any[]): void;
+/**
+ * Groups data by specified keys.
+ *
+ * @param {Array} data - An array of data points.
+ * @param {Array} groupByKeys - Keys to group the data by.
+ * @param {Array} summaries - An array of summary objects to define aggregation operations.
+ * @returns {Object} Grouped data object with aggregation placeholders.
+ */
+export function groupDataByKeys(data: any[], groupByKeys: any[], summaries: any[]): Object;
+/**
+ * Fills grouped data with aligned data if specified in configuration.
+ *
+ * @param {Object} groupedData - The grouped data object.
+ * @param {Object} config - Configuration object containing alignment settings.
+ * @returns {Array} Aligned data array.
+ */
+export function fillAlignedData(groupedData: Object, config: Object, fillRowsFunc: any): any[];
+/**
+ * Performs aggregation operations on grouped data.
+ *
+ * @param {Array} dataArray - An array of grouped data with aggregation arrays.
+ * @param {Array} summaries - An array of summary objects with reducer functions.
+ * @returns {Array} Aggregated data array with computed summary values.
+ */
+export function aggregateData(dataArray: any[], summaries: any[]): any[];
+/**
+ * Creates a generator that produces missing rows in a dataset based on specified columns.
+ * The function determines all unique combinations of the specified columns in config.align_by
+ * and returns a generator function to create the missing combinations, potentially with default
+ * values for other columns.
+ * @param {Array<Object>} data - The array of objects representing the dataset.
+ * @param {Object} config - The configuration object.
+ *
+ * @returns {Function} A generator function that when called, produces the missing rows.
+ */
+export function getAlignGenerator(data: Array<Object>, config: Object): Function;

package/dist/sites/learn/src/hooks.d.ts

@@ -0,0 +1 @@
+export const reroute: any;

package/dist/sites/learn/src/hooks.server.d.ts

@@ -0,0 +1,2 @@
+/** @type {import('@sveltejs/kit').Handle} */
+export const handle: import("@sveltejs/kit").Handle;

package/dist/sites/learn/src/lib/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Finds an item in the menu based on the URL.
+ * @param {Array<any>} menu
+ * @param {*} url
+ * @returns {any}
+ */
+export function findItemInMenu(menu: Array<any>, url: any): any;

package/dist/sites/learn/src/lib/media.d.ts

@@ -0,0 +1,13 @@
+export function watchMedia(breakpoints?: {
+    small: string;
+    medium: string;
+    large: string;
+    extraLarge: string;
+    short: string;
+    landscape: string;
+    tiny: string;
+    dark: string;
+    noanimations: string;
+}): Record<string, MediaQuery>;
+export const media: Record<string, MediaQuery>;
+import { MediaQuery } from 'svelte/reactivity';

package/dist/sites/learn/src/lib/paraglide/messages/en.d.ts

@@ -0,0 +1,3 @@
+export function hello_world(params: {
+    name: NonNullable<unknown>;
+}): string;

package/dist/sites/learn/src/lib/paraglide/messages/fr.d.ts

@@ -0,0 +1,3 @@
+export function hello_world(params: {
+    name: NonNullable<unknown>;
+}): string;

package/dist/sites/learn/src/lib/paraglide/messages/hi.d.ts

@@ -0,0 +1,3 @@
+export function hello_world(params: {
+    name: NonNullable<unknown>;
+}): string;

package/dist/sites/learn/src/lib/paraglide/messages.d.ts

@@ -0,0 +1,5 @@
+export function hello_world(params: {
+    name: NonNullable<unknown>;
+}, options?: {
+    languageTag?: "en" | "hi" | "fr";
+}): string;

package/dist/sites/learn/src/lib/paraglide/runtime.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Check if something is an available language tag.
+ *
+ * @example
+ * 	if (isAvailableLanguageTag(params.locale)) {
+ * 		setLanguageTag(params.locale)
+ * 	} else {
+ * 		setLanguageTag("en")
+ * 	}
+ *
+ * @param {any} thing
+ * @returns {thing is AvailableLanguageTag}
+ */
+export function isAvailableLanguageTag(thing: any): thing is AvailableLanguageTag;
+/**
+ * The project's source language tag.
+ *
+ * @example
+ *   if (newlySelectedLanguageTag === sourceLanguageTag){
+ *     // do nothing as the source language tag is the default language
+ *     return
+ *   }
+ */
+export const sourceLanguageTag: "en";
+/**
+ * The project's available language tags.
+ *
+ * @example
+ *   if (availableLanguageTags.includes(userSelectedLanguageTag) === false){
+ *     throw new Error("Language tag not available")
+ *   }
+ */
+export const availableLanguageTags: readonly ["en", "hi", "fr"];
+/**
+ * Get the current language tag.
+ *
+ * @example
+ *   if (languageTag() === "de"){
+ *     console.log("Germany 🇩🇪")
+ *   } else if (languageTag() === "nl"){
+ *     console.log("Netherlands 🇳🇱")
+ *   }
+ *
+ * @type {() => AvailableLanguageTag}
+ */
+export let languageTag: () => AvailableLanguageTag;
+export function setLanguageTag(tag: AvailableLanguageTag | (() => AvailableLanguageTag)): void;
+export function onSetLanguageTag(fn: (languageTag: AvailableLanguageTag) => void): void;
+/**
+ * A language tag that is available in the project.
+ */
+export type AvailableLanguageTag = (typeof availableLanguageTags)[number];

package/dist/sites/learn/src/lib/stories/02-elements/01-list/03-mapping/src/data.d.ts

@@ -0,0 +1,5 @@
+export const data: {
+    name: string;
+    photo: string;
+    artist: string;
+}[];

package/dist/sites/learn/src/lib/stories/02-elements/01-list/04-mixed/src/data.d.ts

@@ -0,0 +1,13 @@
+export const items: ({
+    name: string;
+    photo: string;
+    artist: string;
+    description: string;
+    type: string;
+} | {
+    name: string;
+    photo: string;
+    artist: string;
+    description: string;
+    type?: undefined;
+})[];

package/dist/sites/learn/src/lib/stories/02-elements/02-tabs/04-fields/src/data.d.ts

@@ -0,0 +1,5 @@
+export const options: {
+    name: string;
+    photo: string;
+    artist: string;
+}[];

package/dist/sites/learn/src/lib/stories/02-elements/02-tabs/05-using/src/data.d.ts

@@ -0,0 +1,6 @@
+export const options: {
+    name: string;
+    photo: string;
+    artist: string;
+    target: string;
+}[];

package/dist/sites/learn/src/lib/stories/02-elements/03-accordion/01-intro/src/data.d.ts

@@ -0,0 +1,4 @@
+export const data: {
+    text: string;
+    children: string[];
+}[];

package/dist/sites/learn/src/lib/stories/02-elements/03-accordion/02-fields/src/data.d.ts

@@ -0,0 +1,9 @@
+export const items: {
+    name: string;
+    values: {
+        name: string;
+        photo: string;
+        source: string;
+        target: string;
+    }[];
+}[];

package/dist/sites/learn/src/lib/stories/02-elements/03-accordion/03-using/src/data.d.ts

@@ -0,0 +1,19 @@
+export const data: ({
+    name: string;
+    isOpen: boolean;
+    values: {
+        name: string;
+        photo: string;
+        source: string;
+        target: string;
+    }[];
+} | {
+    name: string;
+    values: {
+        name: string;
+        photo: string;
+        source: string;
+        target: string;
+    }[];
+    isOpen?: undefined;
+})[];

package/dist/sites/learn/src/lib/stories/02-elements/03-accordion/04-mixed/src/data.d.ts

@@ -0,0 +1,30 @@
+export const data: ({
+    name: string;
+    _open: boolean;
+    values: ({
+        name: string;
+        photo: string;
+        description: string;
+        type: string;
+    } | {
+        name: string;
+        photo: string;
+        description: string;
+        type?: undefined;
+    })[];
+} | {
+    name: string;
+    values: {
+        name: string;
+        photo: string;
+        description: string;
+    }[];
+    _open?: undefined;
+} | {
+    name: string;
+    values: {
+        name: string;
+        photo: string;
+    }[];
+    _open?: undefined;
+})[];

package/dist/sites/learn/src/lib/stories/02-elements/03-accordion/props.d.ts

@@ -0,0 +1,15 @@
+export const props: ({
+    name: string;
+    type: string;
+    purpose: string;
+    required: boolean;
+    example: string;
+    default?: undefined;
+} | {
+    name: string;
+    type: string;
+    purpose: string;
+    required: boolean;
+    default: string;
+    example?: undefined;
+})[];

package/dist/sites/learn/src/lib/stories/02-elements/04-tree/01-intro/src/data.d.ts

@@ -0,0 +1,12 @@
+export const data: {
+    text: string;
+    children: ({
+        text: string;
+        children: {
+            text: string;
+        }[];
+    } | {
+        text: string;
+        children?: undefined;
+    })[];
+}[];

package/dist/sites/learn/src/lib/stories/02-elements/06-select/02-fields/src/data.d.ts

@@ -0,0 +1,5 @@
+export const options: {
+    name: string;
+    photo: string;
+    artist: string;
+}[];

package/dist/sites/learn/src/lib/stories/02-elements/07-multi-select/02-fields/src/data.d.ts

@@ -0,0 +1,5 @@
+export const options: {
+    name: string;
+    photo: string;
+    artist: string;
+}[];

package/dist/sites/learn/src/lib/stories/02-elements/08-drop-down/02-fields/src/data.d.ts

@@ -0,0 +1,5 @@
+export const options: {
+    name: string;
+    photo: string;
+    artist: string;
+}[];

package/dist/sites/learn/src/lib/stories/05-templates/01-form/02-schema/src/schema.d.ts

@@ -0,0 +1,22 @@
+export namespace schema {
+    let type: string;
+    namespace properties {
+        namespace name {
+            let type_1: string;
+            export { type_1 as type };
+            export let required: boolean;
+        }
+        namespace email {
+            let type_2: string;
+            export { type_2 as type };
+            let required_1: boolean;
+            export { required_1 as required };
+        }
+        namespace age {
+            let type_3: string;
+            export { type_3 as type };
+            export let min: number;
+            export let max: number;
+        }
+    }
+}

package/dist/sites/learn/src/lib/stories/05-templates/01-form/03-layout/src/layout.d.ts

@@ -0,0 +1,19 @@
+export namespace layout {
+    let type: string;
+    let elements: ({
+        title: string;
+        type: string;
+        elements: {
+            label: string;
+            scope: string;
+        }[];
+        label?: undefined;
+        scope?: undefined;
+    } | {
+        label: string;
+        scope: string;
+        title?: undefined;
+        type?: undefined;
+        elements?: undefined;
+    })[];
+}

package/dist/sites/learn/src/lib/stories/05-templates/01-form/03-layout/src/schema.d.ts

@@ -0,0 +1,36 @@
+export namespace schema {
+    let type: string;
+    namespace properties {
+        namespace first_name {
+            let type_1: string;
+            export { type_1 as type };
+            export let required: boolean;
+        }
+        namespace last_name {
+            let type_2: string;
+            export { type_2 as type };
+            let required_1: boolean;
+            export { required_1 as required };
+        }
+        namespace gender {
+            let type_3: string;
+            export { type_3 as type };
+            let required_2: boolean;
+            export { required_2 as required };
+            export let options: {
+                id: string;
+                value: string;
+            }[];
+            export namespace fields {
+                let value: string;
+                let text: string;
+            }
+        }
+        namespace age {
+            let type_4: string;
+            export { type_4 as type };
+            export let min: number;
+            export let max: number;
+        }
+    }
+}

package/dist/sites/learn/src/lib/stories/05-templates/01-form/05-validation/src/schema.d.ts

@@ -0,0 +1,34 @@
+export const schema: ({
+    key: string;
+    label: string;
+    type: string;
+    description: string;
+    props: {
+        type: string;
+        items?: undefined;
+        rows?: undefined;
+        maxLength?: undefined;
+    };
+} | {
+    key: string;
+    label: string;
+    type: string;
+    description: string;
+    props: {
+        items: string[];
+        type?: undefined;
+        rows?: undefined;
+        maxLength?: undefined;
+    };
+} | {
+    key: string;
+    label: string;
+    type: string;
+    description: string;
+    props: {
+        type: string;
+        rows: number;
+        maxLength: number;
+        items?: undefined;
+    };
+})[];

package/dist/sites/learn/src/lib/stories/05-templates/02-editor/01-introduction/src/data.d.ts

@@ -0,0 +1,39 @@
+export namespace data {
+    namespace tenant {
+        let name: string;
+        let industry: string;
+        let domain: null;
+    }
+    namespace services {
+        namespace identity {
+            let provider: string;
+            let url: string;
+        }
+        namespace storage {
+            let provider_1: string;
+            export { provider_1 as provider };
+            let url_1: string;
+            export { url_1 as url };
+        }
+    }
+    namespace modules {
+        namespace inventory {
+            let minimum_stock: number;
+            let restock_threshold: number;
+            let max_age: number;
+        }
+        namespace perishable {
+            let minimum_stock_1: number;
+            export { minimum_stock_1 as minimum_stock };
+            let restock_threshold_1: number;
+            export { restock_threshold_1 as restock_threshold };
+            let max_age_1: number;
+            export { max_age_1 as max_age };
+        }
+    }
+    namespace instance {
+        let type: string;
+        let language: string;
+        let time_zone: string;
+    }
+}