✨ feat: Support config file using a virtual module (#170)

Author: enZane

packages/drupal-vite/config.d.ts

@@ -0,0 +1,9 @@
+declare module "drupal-vite/user" {
+  import type { Exchange } from "@urql/core";
+
+  const config: {
+    exchanges?: Exchange[];
+  }
+
+  export default config;
+}

packages/drupal-vite/package.json

@@ -1,7 +1,7 @@
 {
   "name": "drupal-vite",
   "author": "Octahedroid <[email protected]>",
-  "version": "0.0.3",
+  "version": "0.4.0",
   "license": "MIT",
   "description": "Vite plugin for Drupal integration",
   "module": "build/index.js",
@@ -15,12 +15,18 @@
     },
     "./client": {
       "types": "./build/client.d.ts"
+    },
+    "./config": {
+      "types": "./build/config.d.ts"
     }
   },
   "typesVersions": {
     "*": {
       "client": [
         "./build/client.d.ts"
+      ],
+      "config": [
+        "./build/config.d.ts"
       ]
     }
   },
@@ -34,13 +40,13 @@
   "scripts": {
     "build": "bun build ./src/index.ts --outdir ./build --format esm --target node --external wrangler",
     "build:types": "tsc --emitDeclarationOnly --declaration --outDir build",
-    "copy:dts": "cp client.d.ts build/client.d.ts",
+    "copy:dts": "cp client.d.ts build/client.d.ts && cp config.d.ts build/config.d.ts",
     "build:all": "bun run build && bun run build:types && bun run copy:dts",
     "prepublishOnly": "bun run build:all",
     "yalc:publish": "bun run build:all && yalc publish"
   },
   "devDependencies": {
-    "vite": "^6.3.5"
+    "vite": "^7.1.3"
   },
   "peerDependencies": {
     "typescript": "^5",
@@ -50,7 +56,8 @@
   "dependencies": {
     "@types/fs-extra": "^11.0.4",
     "drupal-auth-client": "^1.0.2",
-    "fs-extra": "^11.3.0"
+    "fs-extra": "^11.3.0",
+    "jiti": "^2.5.1"
   },
   "keywords": [
     "vite-plugin",

packages/drupal-vite/src/index.ts

@@ -1,77 +1,16 @@
 import { type Plugin } from "vite";
 import { resolveValue } from "./utils";
 import type { DrupalPluginOptions } from "./types";
+import { resolve } from "path";
+import { existsSync } from "fs";
 
 export type { DrupalDecoupledConfig } from "./types";
 
 const VIRTUAL_MODULE_ID = "drupal-vite/client";
+const VIRTUAL_CONFIG_MODULE_ID = "drupal-vite/config";
 
 /**
  * Creates a Vite plugin for Drupal integration
- *
- * @description
- * This plugin provides seamless integration between Vite and Drupal by:
- * - Setting up authentication with Drupal using OAuth
- * - Configuring a GraphQL client for Drupal queries
- * - Managing environment variables and configuration
- * - Exposing helper functions for auth and GraphQL operations
- *
- * @example
- * ```ts
- * // vite.config.ts
- * import { defineConfig } from 'vite';
- * import { drupal } from 'drupal-vite';
- *
- * export default defineConfig({
- *   plugins: [
- *     drupal()
- *   ]
- * });
- * ```
- *
- * @example
- * ```ts
- * // vite.config.ts with direct configuration
- * import { defineConfig } from 'vite';
- * import { drupal } from 'drupal-vite';
- *
- * export default defineConfig({
- *   plugins: [
- *     drupal({
- *       drupalUrl: 'https://your-drupal-site.com',
- *       simple_oauth: {
- *         clientID: 'your-client-id',
- *         clientSecret: 'your-client-secret'
- *       },
- *       graphql: {
- *         endpoint: '/graphql'
- *       }
- *     })
- *   ]
- * });
- * ```
- *
- * @example
- * ```ts
- * // vite.config.ts with environment variable references
- * import { defineConfig } from 'vite';
- * import { drupal } from 'drupal-vite';
- *
- * export default defineConfig({
- *   plugins: [
- *     drupal({
- *       drupalUrl: 'DRUPAL_URL', // Will use process.env.DRUPAL_URL
- *       simple_oauth: {
- *         clientID: 'DRUPAL_CLIENT_ID', // Will use process.env.DRUPAL_CLIENT_ID
- *         clientSecret: 'DRUPAL_CLIENT_SECRET' // Will use process.env.DRUPAL_CLIENT_SECRET
- *       }
- *     })
- *   ]
- * });
- * ```
- *
- * @param {DrupalPluginOptions} options - Configuration options for the plugin
- * @returns {Plugin} A Vite plugin instance
  */
 export function drupal(options?: DrupalPluginOptions): Plugin {
   const { simple_oauth, graphql, drupalUrl } = options || {};
@@ -80,13 +19,16 @@ export function drupal(options?: DrupalPluginOptions): Plugin {
   const { endpoint = "/graphql" } = graphql || {};
 
   const resolvedVirtualModuleId = `\0${VIRTUAL_MODULE_ID}`;
+  const resolvedVirtualConfigModuleId = `\0${VIRTUAL_CONFIG_MODULE_ID}`;
+
   let resolvedClientID: string | undefined;
   let resolvedClientSecret: string | undefined;
   let resolvedDrupalUrl: string | undefined;
 
   return {
     name: "vite-plugin-drupal-init",
-    async configResolved(resolvedConfig) {
+
+    async configResolved() {
       const defaultClientId = "DRUPAL_CLIENT_ID";
       const defaultClientSecret = "DRUPAL_CLIENT_SECRET";
       const defaultDrupalUrl = "DRUPAL_URL";
@@ -102,20 +44,30 @@ export function drupal(options?: DrupalPluginOptions): Plugin {
         console.error(`[drupal-vite] Client ID is not configured.`);
       }
       if (!resolvedClientSecret) {
-        console.error(`[drupal-vite] Client Secret is not configured. `);
+        console.error(`[drupal-vite] Client Secret is not configured.`);
       }
       if (!resolvedDrupalUrl) {
-        console.error(`[drupal-vite] Drupal URL is not configured. '.`);
+        console.error(`[drupal-vite] Drupal URL is not configured.`);
       }
     },
+
     resolveId(id) {
+      if (
+        id === VIRTUAL_CONFIG_MODULE_ID ||
+        id === resolvedVirtualConfigModuleId ||
+        id.endsWith(VIRTUAL_CONFIG_MODULE_ID)
+      ) {
+        return resolvedVirtualConfigModuleId;
+      }
+
       if (
         id === VIRTUAL_MODULE_ID ||
         id === resolvedVirtualModuleId ||
         id.endsWith(VIRTUAL_MODULE_ID)
       ) {
         return resolvedVirtualModuleId;
       }
+
       return null;
     },
 
@@ -129,11 +81,22 @@ export function drupal(options?: DrupalPluginOptions): Plugin {
       const sanitizedDrupalUrl = resolvedDrupalUrl.replace(/\/$/, "");
       const fullGraphqlEndpoint = `${sanitizedDrupalUrl}${endpoint}`;
 
-      if (id === resolvedVirtualModuleId || id.includes(VIRTUAL_MODULE_ID)) {
-        const module = `
+      // ---- user config virtual module
+      if (id === resolvedVirtualConfigModuleId) {
+        const configPath = resolve(process.cwd(), "drupal-decoupled.config.ts");
+        if (existsSync(configPath)) {
+          return `import userConfig from ${JSON.stringify(configPath)};
+                  export default userConfig;`;
+        }
+        return `export default {};`;
+      }
+
+      // ---- client virtual module
+      if (id === resolvedVirtualModuleId) {
+        return `
 import { drupalAuthClient } from "drupal-auth-client";
 import { Client, fetchExchange } from "@urql/core";
-import customConfig from "./drupal-decoupled.config.ts"
+import { default as config } from "${resolvedVirtualConfigModuleId}";
 
 export async function getDrupalAuth() {
   return await drupalAuthClient("${sanitizedDrupalUrl}", {
@@ -146,16 +109,14 @@ export async function getDrupalClient() {
   const auth = await getDrupalAuth();
   return new Client({
     url: "${fullGraphqlEndpoint}",
-    exchanges: customConfig.exchanges ?? [fetchExchange],
+    exchanges: config.exchanges ? config.exchanges : [fetchExchange],
     fetchOptions: {
       headers: {
         Authorization: \`\${auth.token_type} \${auth.access_token}\`,
       },
     },
   });
 }`;
-
-        return module;
       }
       return null;
     },

packages/drupal-vite/tsconfig.json

@@ -30,6 +30,6 @@
     "noUnusedParameters": false,
     "noPropertyAccessFromIndexSignature": false
   },
-  "include": ["src/**/*", "client.d.ts"],
+  "include": ["src/**/*", "client.d.ts", "config.d.ts"],
   "exclude": ["node_modules", "build"]
 }