@xyd-js/plugin-orama 0.1.0-build.157

package/src/index.ts

@@ -0,0 +1,103 @@
+import type {Plugin as VitePlugin, ResolvedConfig} from 'vite'
+
+import type {Settings} from '@xyd-js/core'
+import type {Plugin} from '@xyd-js/plugins'
+import {mapSettingsToDocSections, type DocSectionSchema} from '@xyd-js/content/md'
+
+import {DEFAULT_SUGGESTIONS} from './const'
+import type {OramaPluginOptions, OramaCloudConfig, OramaSectionSchema} from './types'
+import Search from './Search'
+
+export default function OramaPlugin(
+    pluginOptions: OramaPluginOptions = {}
+): Plugin {
+    return function (settings: Settings) {
+        return {
+            name: "plugin-orama",
+            vite: [
+                vitePlugin(
+                    settings,
+                    pluginOptions,
+                )
+            ],
+            components: [
+                {
+                    component: Search,
+                    name: "Search",
+                    dist: "@xyd-js/plugin-orama/Search" // TODO: better in the future
+                }
+            ]
+        }
+    }
+}
+
+function vitePlugin(
+    settings: Settings,
+    pluginOptions: OramaPluginOptions = {}
+): VitePlugin {
+    const virtualModuleId = 'virtual:xyd-plugin-orama-data'
+    const resolvedVirtualModuleId = `\0${virtualModuleId}`
+
+    let resolveConfig: ResolvedConfig | null = null
+
+    return {
+        name: 'xyd-plugin-orama',
+        enforce: 'pre',
+
+        async configResolved(config: ResolvedConfig) {
+            if (resolveConfig) {
+                return
+            }
+
+            resolveConfig = config
+        },
+
+        async resolveId(id) {
+            if (id === virtualModuleId) {
+                return resolvedVirtualModuleId
+            }
+        },
+
+        async load(this, id: string) {
+            if (id !== resolvedVirtualModuleId) {
+                return
+            }
+
+            let cloudConfig: OramaCloudConfig | null = null
+            if (pluginOptions.endpoint && pluginOptions.apiKey) {
+                cloudConfig = {
+                    endpoint: pluginOptions.endpoint,
+                    apiKey: pluginOptions.apiKey
+                }
+            }
+
+            const sections = (await mapSettingsToDocSections(settings)).map(mapDocSectionsToOrama)
+
+            return `
+                const docs = ${JSON.stringify(sections)};
+                const cloudConfig = ${JSON.stringify(cloudConfig)};
+                const suggestions = ${JSON.stringify(pluginOptions.suggestions || DEFAULT_SUGGESTIONS)};
+
+                export default { docs, cloudConfig, suggestions };
+            `
+        }
+    }
+}
+
+function mapDocSectionsToOrama(doc: DocSectionSchema): OramaSectionSchema {
+    return {
+        category: '', // TODO: finish
+
+        path: doc.pageUrl,
+
+        title: doc.headingTitle,
+
+        description: doc.content,
+
+        content: doc.content,
+
+        // section: doc.content,
+        // version: string
+    }
+}
+

package/src/types.ts

@@ -0,0 +1,25 @@
+export interface OramaCloudConfig {
+    endpoint: string
+
+    apiKey: string
+}
+
+export interface OramaPluginOptions {
+    endpoint?: string
+
+    apiKey?: string
+
+    suggestions?: string[]
+}
+
+export interface OramaSectionSchema {
+    category: string
+
+    path: string
+
+    title: string
+
+    description: string
+
+    content: string
+}

package/src/virtual.d.ts

@@ -0,0 +1,6 @@
+declare module 'virtual:xyd-plugin-orama-data' {
+    import {OramaPluginData} from "./types";
+
+    const data: OramaPluginData;
+    export default data;
+}

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "esnext",
+    "esModuleInterop": true,
+    "moduleResolution": "bundler",
+    "target": "esnext",
+    "baseUrl": ".",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": false,
+    "noEmit": true,
+    "incremental": false,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "plugins": [],
+    "strictNullChecks": true
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx"],
+  "exclude": ["node_modules"]
+}

package/tsup.config.ts

@@ -0,0 +1,33 @@
+import {copyFile} from 'node:fs/promises';
+import {join} from 'node:path';
+
+import {defineConfig, Options} from 'tsup';
+
+const config: Options = {
+    entry: {
+        index: 'src/index.ts'
+    },
+    dts: {
+        entry: {
+            index: 'src/index.ts'
+        },
+        resolve: true, // Resolve external types
+    },
+    format: ['esm'],
+    platform: 'node',
+    shims: false,
+    splitting: false,
+    sourcemap: true,
+    clean: true,
+    external: [
+        'virtual:xyd-plugin-orama-data'
+    ],
+    onSuccess: async () => {
+        await copyFile(
+            join(process.cwd(), 'src', 'Search.tsx'),
+            join(process.cwd(), 'dist', 'Search.tsx')
+        );
+    }
+}
+
+export default defineConfig(config);