Merge pull request #199 from nuxt-modules/feat/195-global-module-config

adding ability to pass in global module configurations
nuxt-modules · Mar 24, 2024 · 7874007 · 7874007
2 parents 19f0bee + 81c6690
commit 7874007
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 8 deletions.
diff --git a/src/module.ts b/src/module.ts
@@ -13,7 +13,8 @@ export type ModuleOptions = {
   uploadPreset?: string;
   apiKey?: string;
   analytics?: boolean;
-  config?: CloudinaryConfigurationOptions;
+  cloud?: ConfigOptions["cloud"];
+  url?: ConfigOptions["url"];
 };
 
 export default defineNuxtModule<ModuleOptions>({
@@ -36,7 +37,8 @@ export default defineNuxtModule<ModuleOptions>({
           process.env.CLOUDINARY_UPLOAD_PRESET || options.uploadPreset,
         apiKey: process.env.CLOUDINARY_API_KEY || options.apiKey,
         analytics: options.analytics,
-        config: options.config,
+        cloud: options.cloud,
+        url: options.url,
       }
     );
 

diff --git a/src/runtime/composables/useCldImageUrl.ts b/src/runtime/composables/useCldImageUrl.ts
@@ -6,8 +6,16 @@ import pkg from '../../../package.json'
 export const useCldImageUrl = (props: ConstructUrlProps) => {
   if (!props.options.src) console.error("`[@nuxtjs/cloudinary]`: Property `src` is missing")
 
-  const cldCloudName = props.config?.cloud?.cloudName || useRuntimeConfig().public.cloudinary.cloudName
-  const config = props.config || useRuntimeConfig().public.cloudinary.config
+  const moduleConfig = useRuntimeConfig().public.cloudinary;
+
+  // There are a few ways to pass in the Cloud Name
+  // - Component/composable config prop
+  // - Top level module config
+  // - Top level module config cloud property
+  // While the top level module config is redundant, retaining it for convenience as most
+  // users won't need to pass in more advanced settings via the `cloud` property
+
+  const cldCloudName = props.config?.cloud?.cloudName || moduleConfig.cloud?.cloudName || moduleConfig?.cloudName;
 
   if (!cldCloudName) console.warn('`[@nuxtjs/cloudinary]` Environment variable `CLOUDINARY_CLOUD_NAME` or property `cloudinary.cloudName` missing')
 
@@ -17,15 +25,17 @@ export const useCldImageUrl = (props: ConstructUrlProps) => {
       ...props.options
     },
     config: {
-      ...config,
+      url: moduleConfig.url,
       cloud: {
-        cloudName: cldCloudName
-      }
+        cloudName: cldCloudName,
+        ...moduleConfig.cloud
+      },
+      ...props.config,
     },
     analytics: false
   }
 
-  if (useRuntimeConfig().public.cloudinary.analytics) {
+  if (moduleConfig.analytics) {
     cldOptions = {
       ...cldOptions,
       analytics: Object.assign({