@xyd-js/plugin-docs 0.1.0-build.160

package/src/presets/openapi/index.ts

@@ -0,0 +1,66 @@
+import {Settings} from "@xyd-js/core";
+import {deferencedOpenAPI, oapSchemaToReferences, getXDocs} from "@xyd-js/openapi";
+import type {Reference} from "@xyd-js/uniform";
+
+import {Preset} from "../../types"
+import {UniformPreset} from "../uniform"
+
+export interface openapiPresetOptions {
+    urlPrefix?: string
+    root?: string
+    disableFSWrite?: boolean
+}
+
+function preset(
+    settings: Settings,
+    options: openapiPresetOptions
+) {
+    return OpenAPIUniformPreset.new(settings, options)
+}
+
+export const openapiPreset = preset satisfies Preset<unknown>
+
+class OpenAPIUniformPreset extends UniformPreset {
+    private constructor(
+        settings: Settings,
+        options: {
+            disableFSWrite?: boolean
+        }
+    ) {
+        super(
+            "openapi",
+            settings.api?.openapi || "",
+            settings?.navigation?.sidebar || [],
+            options.disableFSWrite
+        )
+        this.uniformRefResolver = this.uniformRefResolver.bind(this)
+    }
+
+    static new(
+        settings: Settings,
+        options: openapiPresetOptions
+    ) {
+        return new OpenAPIUniformPreset(settings, {
+            disableFSWrite: options.disableFSWrite
+        })
+            .urlPrefix(options.urlPrefix || "")
+            .newUniformPreset()(settings, "openapi")
+    }
+
+    protected override async uniformRefResolver(filePath: string): Promise<Reference[]> {
+        if (!filePath) {
+            return []
+        }
+
+        const schema = await deferencedOpenAPI(filePath)
+        if (schema) {
+            const xdocs = getXDocs(schema)
+            if (xdocs?.route) {
+                this.fileRouting(filePath, xdocs.route)
+            }
+        }
+
+        return oapSchemaToReferences(schema)
+    }
+}
+

package/src/presets/sources/index.ts

@@ -0,0 +1,74 @@
+import path from "path";
+import fs from "fs/promises";
+
+import type {Reference} from "@xyd-js/uniform";
+import {Settings} from "@xyd-js/core";
+import {sourcesToUniformV2} from "@xyd-js/sources/ts"
+
+import {Preset} from "../../types"
+import {UniformPreset} from "../uniform"
+
+export interface sourcesPresetsOptions {
+    urlPrefix?: string
+    root?: string
+    disableFSWrite?: boolean    
+}
+
+function preset(
+    settings: Settings,
+    options: sourcesPresetsOptions
+) {
+    return SourceUniformPreset.new(settings, options)
+}
+
+export const sourcesPreset = preset satisfies Preset<unknown>
+
+class SourceUniformPreset extends UniformPreset {
+    private constructor(
+        settings: Settings,
+        options: {
+            disableFSWrite?: boolean
+        }
+    ) {
+        super(
+            "sources",
+            settings.api?.sources || "",
+            settings?.navigation?.sidebar || [],
+            options.disableFSWrite
+        )
+    }
+
+    static new(
+        settings: Settings,
+        options: sourcesPresetsOptions
+    ) {
+        return new SourceUniformPreset(settings, {
+            disableFSWrite: options.disableFSWrite
+        })
+            .urlPrefix(options.urlPrefix || "")
+            .sourceTheme(true)
+            .newUniformPreset()(settings, "sources")
+    }
+
+    // TODO: options to specify only specific packages?
+    protected override async uniformRefResolver(filePath: string): Promise<Reference[]> {
+        if (!filePath) {
+            return []
+        }
+
+        const packages = await fs.readdir(filePath)
+
+        const ref = await sourcesToUniformV2(
+            filePath,
+            packages.map(p => path.join(filePath, p))
+        )
+
+        if (!ref || !ref.references) {
+            console.error("Failed to generate documentation.", filePath)
+            return []
+        }
+
+        return ref.references
+    }
+}
+