@rokkit/core 1.0.0-next.113 → 1.0.0-next.115

package/dist/packages/states/src/vibe.svelte.d.ts

@@ -0,0 +1,622 @@
+export const vibe: Vibe;
+export type ThemeMode = "light" | "dark";
+export type Density = "cozy" | "compact" | "comfortable";
+/**
+ * Vibe - Theme management
+ */
+declare class Vibe {
+    /**
+     * Private constructor to enforce singleton pattern
+     * @param {VibeOptions} [options={}]
+     */
+    constructor(options?: VibeOptions);
+    set mode(value: string);
+    get mode(): string;
+    set style(value: string);
+    get style(): string;
+    set density(value: string);
+    get density(): string;
+    set colorMap(value: typeof defaultThemeMapping);
+    get colorMap(): typeof defaultThemeMapping;
+    set colors(value: {
+        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;
+        };
+    });
+    get colors(): {
+        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;
+        };
+    };
+    set allowedStyles(input: string[]);
+    get allowedStyles(): string[];
+    get palette(): {
+        [x: string]: string;
+    };
+    /**
+     * Load theme from storage
+     * @param {string} key
+     */
+    load(key: string): void;
+    /**
+     * Save current theme to storage
+     * @param {string} key
+     */
+    save(key: string): void;
+    /**
+     * Update theme with new values
+     * @param {Partial<Theme>} value
+     */
+    update(value: Partial<Theme>): void;
+    #private;
+}
+import { defaultThemeMapping } from '@rokkit/core';
+export {};

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

@@ -0,0 +1,6 @@
+export const defaultThemeColors: {};
+export const palettes: {
+    rokkit: any[][];
+    'sea-green': any[][];
+};
+export { defaultStateIcons, defaultIcons } from "@rokkit/core";

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

@@ -0,0 +1,2 @@
+export * from "./constants.js";
+export { iconShortcuts, themeColors, themeRules } from "@rokkit/core";

package/dist/packages/tutorial/src/assimilate.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Filters out menu items that are labs.
+ *
+ * @param {Array} data - The data to filter.
+ * @param {boolean} labs - Whether to include labs in the result.
+ * @returns {Array} - The filtered data.
+ */
+export function filterMenuItems(data: any[], labs?: boolean): any[];
+/**
+ * Finds the tutorial in the flat list of tutorials.
+ *
+ * @param {Array} flat - The flat list of tutorials.
+ * @param {string} route - The route of the tutorial.
+ * @returns {Object} - The tutorial.
+ */
+export function findTutorial(flat: any[], route: string): Object;
+/**
+ * Processes the tutorials and returns the tutorials and routes.
+ *
+ * @param {Record<string,Function<Promise>} modules - The modules to process.
+ * @param {Record<string,Function<Promise>} sources - The sources to process.
+ * @param {Object} options - The options to use.
+ * @returns {Object} - The tutorials and routes.
+ */
+export function assimilateTutorials(modules: Record<string, Function>, sources: Record<string, Function>, options: Object): Object;

package/dist/packages/tutorial/src/collector.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Get metadata for the item based on its file type.
+ * @param {string} rootFolder - The root folder containing the item.
+ * @param {Object} item - The item to get the metadata for.
+ * @returns {Promise<Object>} - A promise that resolves to the metadata object.
+ */
+export function getMetadata(rootFolder: string, item: Object): Promise<Object>;
+/**
+ * Read content of all files in the given folder.
+ * @param {string} folder - The folder to read files from.
+ * @returns {Promise<Object>} - A promise that resolves to an object containing file content keyed by file paths.
+ */
+export function readFolderContent(folder: string): Promise<Object>;
+/**
+ * Get the folder content and its preview file if it exists.
+ * @param {string} baseFolder - The base folder path.
+ * @param {string} folder - The folder to get the content from.
+ * @returns {Promise<Object|null>} - A promise that resolves to an object containing the folder content and preview file, or null if the folder does not exist or is empty.
+ */
+export function getFolder(baseFolder: string, folder: string): Promise<Object | null>;
+/**
+ * Read and add metadata for each item in the data array.
+ * @param {string} rootFolder - The root folder containing the items.
+ * @param {Array} data - The array of items to read metadata for.
+ * @returns {Promise<Array>} - A promise that resolves to an array of items with added metadata.
+ */
+export function enrich(rootFolder: string, data: any[]): Promise<any[]>;
+/**
+ * Convert the array of file objects into a hierarchical data structure.
+ * @param {Array} data - The array of file objects.
+ * @returns {Object} - The hierarchical data object.
+ */
+export function transform(data: any[]): Object;
+/**
+ * Remove invalid entries from the data object.
+ * @param {Object} data - The data object to remove invalid entries from.
+ * @param {Object} options - The options object containing validation criteria.
+ * @returns {Object} - An object containing the cleaned data and any errors found.
+ */
+export function removeInvalidEntries(data: Object, options: Object): Object;
+/**
+ * Collect tutorials based on the provided options.
+ * @param {import('./types').TutorialOptions} options - The options for collecting tutorials.
+ * @returns {Promise<void>} - A promise that resolves when the tutorials have been collected and written to the metadata file.
+ */
+export function collectTutorials(options: import("./types").TutorialOptions): Promise<void>;