nuxt-directus-sdk 4.0.5 → 5.0.0-beta.1

package/dist/module.mjs

@@ -1,11 +1,12 @@
-import { useLogger, defineNuxtModule, createResolver, addServerHandler, installModule, addPlugin, addRouteMiddleware, addImportsDir, addComponentsDir, addImportsSources, addTypeTemplate } from '@nuxt/kit';
+import { useLogger, defineNuxtModule, createResolver, addServerHandler, addPlugin, addRouteMiddleware, addImportsDir, addComponentsDir, addImportsSources, addTypeTemplate, hasNuxtModule, installModule } from '@nuxt/kit';
+import { colors } from 'consola/utils';
 import { defu } from 'defu';
 import { joinURL } from 'ufo';
 import { generateTypes } from '../dist/runtime/types/index.js';
 import { useUrl } from '../dist/runtime/utils/index.js';
 
 const name = "nuxt-directus-sdk";
-const version = "4.0.5";
+const version = "5.0.0-beta.1";
 
 const configKey = "directus";
 const logger = useLogger("nuxt-directus-sdk");
@@ -25,6 +26,7 @@ const module = defineNuxtModule({
     adminToken: import.meta.env.DIRECTUS_ADMIN_TOKEN ?? "",
     devtools: true,
     visualEditor: true,
+    image: true,
     types: {
       enabled: true,
       prefix: ""
@@ -38,7 +40,7 @@ const module = defineNuxtModule({
       readMeFields: [],
       redirect: {
         home: "/",
-        login: "/account/login",
+        login: "/auth/login",
         logout: "/"
       }
     }
@@ -49,26 +51,24 @@ const module = defineNuxtModule({
       return;
     }
     const resolver = createResolver(import.meta.url);
+    async function registerModule(name2, key, moduleOptions) {
+      if (!hasNuxtModule(name2)) {
+        await installModule(name2, defu(nuxtApp.options[key], moduleOptions));
+      } else {
+        nuxtApp.options[key] = defu(nuxtApp.options[key], moduleOptions);
+      }
+    }
     const devProxyConfig = typeof options.devProxy === "boolean" ? { enabled: options.devProxy } : { ...options.devProxy };
+    const directusUrl = options.url;
     const devProxyEnabled = devProxyConfig.enabled ?? nuxtApp.options.dev;
     const devProxyPath = devProxyConfig.path ?? "/directus";
-    const directusUrl = options.url;
-    logger.info(`Nuxt Directus SDK Version: ${version}`);
+    const wsProxyPath = devProxyConfig.wsPath ?? `${devProxyPath}-ws`;
+    const wsTarget = joinURL(directusUrl, "websocket");
+    const loggerMessage = [];
     if (devProxyEnabled && nuxtApp.options.dev) {
-      const devPort = nuxtApp.options.devServer?.port ?? 3e3;
-      const devHost = nuxtApp.options.devServer?.host ?? "localhost";
-      const baseUrl = `http://${devHost}:${devPort}`;
-      const proxyUrl = `${baseUrl}${devProxyPath}/`;
-      const wsProxyPath = `${devProxyPath}-ws`;
-      const wsTarget = joinURL(directusUrl, "websocket");
-      logger.info(`\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501`);
-      logger.info(`\u{1F504} Directus Development Proxy Enabled`);
-      logger.info(`   Proxy path: ${devProxyPath}`);
-      logger.info(`   Forwarding to: ${directusUrl}`);
-      logger.info(`   Local URL: ${proxyUrl}`);
-      logger.info(`   WebSocket proxy path: ${wsProxyPath}`);
-      logger.info(`   WebSocket target: ${wsTarget}`);
-      logger.info(`\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501`);
+      loggerMessage.push(`\u{1F310} Development mode:`);
+      loggerMessage.push(`URL${colors.dim(` ${devProxyPath}`)} proxies ${colors.underline(colors.green(`${directusUrl}`))}`);
+      loggerMessage.push(`WS URL${colors.dim(` ${wsProxyPath}`)} proxies ${colors.underline(colors.green(`${wsTarget}`))}`);
       nuxtApp.options.nitro = nuxtApp.options.nitro || {};
       nuxtApp.options.nitro.devProxy = nuxtApp.options.nitro.devProxy || {};
       nuxtApp.options.nitro.devProxy[wsProxyPath] = {
@@ -121,21 +121,35 @@ const module = defineNuxtModule({
         route: `${devProxyPath}/**`,
         handler: resolver.resolve("./runtime/server/routes/directus")
       });
-      options.url = proxyUrl;
-      options.wsProxyUrl = joinURL(baseUrl, wsProxyPath);
+      options.devProxy = {
+        enabled: true,
+        path: devProxyPath,
+        wsPath: wsProxyPath
+      };
     } else if (!nuxtApp.options.dev) {
-      logger.info(`\u{1F310} Production mode: Connecting directly to ${directusUrl}`);
+      loggerMessage.push(`\u{1F310} Production mode:`, ` SDK connects directly to ${colors.dim(`${directusUrl}`)}`);
+      options.devProxy = false;
     }
     options.directusUrl = directusUrl;
     nuxtApp.options.runtimeConfig[configKey] = options;
     nuxtApp.options.runtimeConfig.public = nuxtApp.options.runtimeConfig.public || {};
     nuxtApp.options.runtimeConfig.public[configKey] = defu(nuxtApp.options.runtimeConfig.public[configKey], options);
     delete nuxtApp.options.runtimeConfig.public[configKey].adminToken;
-    await installModule("@nuxt/image", {
-      directus: {
-        baseURL: useUrl(options.url, "assets")
-      }
-    });
+    const imageConfig = typeof options.image === "boolean" ? { enabled: options.image } : options.image;
+    const imageEnabled = imageConfig?.enabled ?? true;
+    if (imageEnabled) {
+      const { setDefaultProvider, modifiers } = imageConfig || {};
+      const imageBaseUrl = devProxyEnabled ? `${devProxyPath}/assets` : useUrl(options.url, "assets");
+      await registerModule("@nuxt/image", "image", {
+        // Set default provider if requested
+        ...setDefaultProvider && { provider: "directus" },
+        // Configure Directus provider
+        directus: {
+          baseURL: imageBaseUrl,
+          modifiers
+        }
+      });
+    }
     addPlugin(resolver.resolve("./runtime/plugin"));
     addRouteMiddleware({
       name: "auth",
@@ -227,9 +241,9 @@ const module = defineNuxtModule({
         ]
       });
     });
+    loggerMessage.push(``);
     if (options.devtools) {
-      const adminUrl = useUrl(directusUrl, "admin");
-      logger.info(`Directus Admin URL: ${adminUrl}`);
+      loggerMessage.push(`Directus Admin added to Nuxt DevTools`);
       nuxtApp.hook("devtools:customTabs", (iframeTabs) => {
         iframeTabs.push({
           name: "directus",
@@ -237,40 +251,41 @@ const module = defineNuxtModule({
           icon: "simple-icons:directus",
           view: {
             type: "iframe",
-            src: adminUrl
+            src: useUrl(directusUrl, "admin")
           }
         });
       });
     } else {
-      logger.info("Set devtools to true to view the Directus admin panel from inside Nuxt Devtools");
+      loggerMessage.push(`${colors.dim(`  Directus Admin was not added to Nuxt DevTools`)}`);
     }
-    if (options.types?.enabled) {
+    const typesEnabled = typeof options.types === "boolean" && options.types || options.types && options.types.enabled === true;
+    const typesPrefix = typeof options.types === "object" ? options.types.prefix ?? "" : "";
+    if (typesEnabled) {
       if (!options.adminToken) {
-        logger.warn("Directus types generation is disabled, set the admin token in the config or .env file as DIRECTUS_ADMIN_TOKEN");
+        loggerMessage.push(``, `${colors.bgRedBright(`${colors.red("\u2691 ERROR:")} Unable to generate Types`)}`, `  Fix: Set adminToken in config or DIRECTUS_ADMIN_TOKEN in .env`);
       } else {
         try {
           let cachedTypes = null;
-          const typesPath = addTypeTemplate({
+          addTypeTemplate({
             filename: `types/${configKey}.d.ts`,
             async getContents() {
               if (!cachedTypes) {
                 cachedTypes = await generateTypes({
-                  url: useUrl(directusUrl),
+                  url: directusUrl,
                   token: options.adminToken,
-                  prefix: options.types?.prefix ?? ""
+                  prefix: typesPrefix
                 });
               }
               return cachedTypes;
             }
-          }, { nitro: true, nuxt: true }).dst;
-          nuxtApp.hook("prepare:types", (options2) => {
-            options2.references.push({ path: typesPath });
-          });
+          }, { nitro: true, nuxt: true });
+          loggerMessage.push(`${colors.dim(`  Directus Types saved successfully to #build/types/${configKey}.d.ts`)}`);
         } catch (error) {
           logger.error(error.message);
         }
       }
     }
+    logger.box({ message: loggerMessage.join("\n"), title: `${colors.magenta(`Nuxt Directus SDK Version: ${colors.magentaBright(`${version}`)}`)}`, style: { padding: 3, borderColor: "magenta", borderStyle: "double-single-rounded" } });
   }
 });