@xyd-js/plugin-docs 0.1.0-xyd.3 → 0.1.0-xyd.44

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+import { Plugin as Plugin$1 } from 'vite';
+import { RouteConfigEntry } from '@react-router/dev/routes';
+import { Settings } from '@xyd-js/core';
+
+interface PluginOutput {
+    vitePlugins: Plugin$1[];
+    settings: Settings;
+    routes: RouteConfigEntry[];
+    basePath: string;
+    pagePathMapping: {
+        [page: string]: string;
+    };
+}
+type Plugin = () => Promise<PluginOutput | null>;
+
+/**
+ * Reads `xyd` settings from the current working directory.
+ *
+ * This function searches for a file named 'xyd' with one of the supported extensions
+ * (tsx, jsx, js, ts, json) in the current working directory. If found, it loads the
+ * settings from that file.
+ *
+ * For React-based settings files (tsx, jsx, js, ts), it uses Vite's SSR module loading
+ * to evaluate the file and extract the default export. For JSON files, it simply
+ * parses the JSON content.
+ *
+ * @returns A Promise that resolves to:
+ *   - The Settings object if a valid settings file was found and loaded
+ *   - A string if the settings file contains a string value
+ *   - null if no settings file was found or an error occurred
+ *
+ * @throws May throw errors if file reading or parsing fails
+ */
+declare function readSettings(): Promise<Settings | null>;
+
+interface PluginDocsOptions {
+    disableAPIGeneration?: boolean;
+    disableFSWrite?: boolean;
+}
+declare function pluginDocs(options?: PluginDocsOptions): Promise<PluginOutput | null>;
+
+export { type Plugin, type PluginDocsOptions, type PluginOutput, pluginDocs, readSettings };