kss-modern 0.0.1

package/README.md

@@ -0,0 +1,15 @@
+# styleguide-rewrite
+
+To install dependencies:
+
+```bash
+bun install
+```
+
+To run:
+
+```bash
+bun run index.ts
+```
+
+This project was created using `bun init` in bun v1.1.34. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.

package/dist/node/lib/index.d.mts

@@ -0,0 +1,86 @@
+interface ColorObject {
+    name?: string;
+    color: string;
+    description?: string;
+}
+interface IconObject {
+    name: string;
+    svg: string;
+}
+interface in2Section {
+    id: string;
+    sectionLevel: 'first' | 'second' | 'third';
+    header: string;
+    description: string;
+    hasMarkdownDescription: boolean;
+    markup: string;
+    modifiers: {
+        value: string;
+        description: string;
+    }[];
+    colors?: ColorObject[];
+    icons?: IconObject[];
+    figma?: string;
+    wrapper?: string;
+    htmlclass?: string;
+    bodyclass?: string;
+    sourceFileName: string;
+    previewFileName: string;
+    fullpageFileName: string;
+}
+
+declare global {
+    var isWatchMode: boolean;
+    var styleguideConfiguration: StyleguideConfiguration;
+}
+interface StyleguideConfiguration {
+    mode: 'development' | 'production';
+    outDir: string;
+    contentDir: `${string}/`;
+    projectTitle: string;
+    deactivateDarkMode?: boolean;
+    launchInEditor?: boolean | {
+        rootDir: string;
+    };
+    theme: string | {
+        light: string;
+        dark: string;
+    };
+    html: {
+        lang: string;
+        assets: {
+            css: {
+                type?: 'regular' | 'overwriteStyleguide';
+                src: string;
+            }[];
+            js: {
+                type?: 'regular' | 'overwriteStyleguide';
+                src: string;
+                additionalAttributes?: Record<string, string>;
+            }[];
+        };
+    };
+    plugins?: {
+        ogImage?: (section: in2Section) => string;
+    };
+}
+interface StyleguideBuildOutput {
+    errors?: {
+        overwrittenSectionsIds?: string[];
+    };
+}
+/**
+ * Builds the styleguide
+ * @param config - The configuration for the styleguide
+ */
+declare function buildStyleguide(config: StyleguideConfiguration): Promise<StyleguideBuildOutput>;
+/**
+ * Builds the styleguide and watches for changes
+ * @param config - The configuration for the styleguide
+ * @param onChange - Optional callback function to call when the styleguide is changed
+ * @param onError - Optional callback function to call when an error occurs while building the styleguide
+ */
+declare function watchStyleguide(config: StyleguideConfiguration, onChange?: () => void, onError?: (errorData: StyleguideBuildOutput['errors']) => void): Promise<void>;
+
+export { buildStyleguide, watchStyleguide };
+export type { StyleguideConfiguration };

package/dist/node/lib/index.d.ts

@@ -0,0 +1,86 @@
+interface ColorObject {
+    name?: string;
+    color: string;
+    description?: string;
+}
+interface IconObject {
+    name: string;
+    svg: string;
+}
+interface in2Section {
+    id: string;
+    sectionLevel: 'first' | 'second' | 'third';
+    header: string;
+    description: string;
+    hasMarkdownDescription: boolean;
+    markup: string;
+    modifiers: {
+        value: string;
+        description: string;
+    }[];
+    colors?: ColorObject[];
+    icons?: IconObject[];
+    figma?: string;
+    wrapper?: string;
+    htmlclass?: string;
+    bodyclass?: string;
+    sourceFileName: string;
+    previewFileName: string;
+    fullpageFileName: string;
+}
+
+declare global {
+    var isWatchMode: boolean;
+    var styleguideConfiguration: StyleguideConfiguration;
+}
+interface StyleguideConfiguration {
+    mode: 'development' | 'production';
+    outDir: string;
+    contentDir: `${string}/`;
+    projectTitle: string;
+    deactivateDarkMode?: boolean;
+    launchInEditor?: boolean | {
+        rootDir: string;
+    };
+    theme: string | {
+        light: string;
+        dark: string;
+    };
+    html: {
+        lang: string;
+        assets: {
+            css: {
+                type?: 'regular' | 'overwriteStyleguide';
+                src: string;
+            }[];
+            js: {
+                type?: 'regular' | 'overwriteStyleguide';
+                src: string;
+                additionalAttributes?: Record<string, string>;
+            }[];
+        };
+    };
+    plugins?: {
+        ogImage?: (section: in2Section) => string;
+    };
+}
+interface StyleguideBuildOutput {
+    errors?: {
+        overwrittenSectionsIds?: string[];
+    };
+}
+/**
+ * Builds the styleguide
+ * @param config - The configuration for the styleguide
+ */
+declare function buildStyleguide(config: StyleguideConfiguration): Promise<StyleguideBuildOutput>;
+/**
+ * Builds the styleguide and watches for changes
+ * @param config - The configuration for the styleguide
+ * @param onChange - Optional callback function to call when the styleguide is changed
+ * @param onError - Optional callback function to call when an error occurs while building the styleguide
+ */
+declare function watchStyleguide(config: StyleguideConfiguration, onChange?: () => void, onError?: (errorData: StyleguideBuildOutput['errors']) => void): Promise<void>;
+
+export { buildStyleguide, watchStyleguide };
+export type { StyleguideConfiguration };