feat: add core module config

Author: davidstackio

src/module.ts

@@ -1,15 +1,62 @@
 import { addPlugin, createResolver, defineNuxtModule } from '@nuxt/kit'
 
-// Module options TypeScript interface definition
-export interface ModuleOptions {}
+// Types
+import type { ModuleOptions } from './types'
 
 export default defineNuxtModule<ModuleOptions>({
   meta: {
     name: 'nuxtify-core',
     configKey: 'nuxtifyCore',
+    compatibility: {
+      nuxt: '>=3.16.0',
+      bridge: false,
+    },
+  },
+  defaults: {
+    // Brand
+    brand: {
+      name: 'nuxtify-core',
+      domain: '',
+      tagline: '',
+      logo: {
+        lightUrl: '',
+        darkUrl: '',
+        width: 200,
+        mobileWidth: 150,
+      },
+    },
+
+    // Policies
+    policies: {
+      privacyUrl: '/privacy',
+      termsUrl: '/terms',
+    },
+
+    // Announcement
+    announcement: {
+      show: false,
+      message: '',
+      buttonText: '',
+      buttonUrl: '',
+    },
+
+    // Credits
+    credits: {
+      creator: {
+        name: '',
+        domain: '',
+      },
+      prependText: '',
+      appendText: '',
+      showPoweredBy: true,
+    },
+
+    // Email
+    email: {
+      general: '',
+      support: '',
+    },
   },
-  // Default configuration options of the Nuxt module
-  defaults: {},
   setup(_options, _nuxt) {
     const resolver = createResolver(import.meta.url)
 

src/types.ts

@@ -0,0 +1,97 @@
+interface BrandOptions {
+  /**
+   * The name of the brand.
+   *
+   * @default "nuxtify-core"
+   */
+  name?: string
+  /**
+   * The domain of the brand.
+   *
+   * @default ""
+   */
+  domain?: string
+  /**
+   * The tagline of the brand.
+   *
+   * @default ""
+   */
+  tagline?: string
+  /**
+   * The logo of the brand.
+   */
+  logo?: {
+    /**
+     * The URL of the light logo. Recommended 5:1 aspect ratio (e.g. 400 x 80 px).
+     *
+     * @default ""
+     */
+    lightUrl?: string
+    /**
+     * The URL of the dark logo. Recommended 5:1 aspect ratio (e.g. 400 x 80 px).
+     *
+     * @default ""
+     */
+    darkUrl?: string
+    /**
+     * The width of the logo.
+     *
+     * @default 200
+     */
+    width?: number
+    /**
+     * The width of the logo on mobile.
+     *
+     * @default 150
+     */
+    mobileWidth?: number
+  }
+}
+
+interface PoliciesOptions {
+  privacyUrl: string
+  termsUrl: string
+}
+
+export interface ModuleOptions {
+  /**
+   * Brand options
+   */
+  brand?: BrandOptions
+
+  /**
+   * Policies options
+   */
+  policies?: PoliciesOptions
+
+  /**
+   * Announcement banner options
+   */
+  announcement?: {
+    show?: boolean
+    message?: string
+    buttonText?: string
+    buttonUrl?: string
+  }
+
+  /**
+   * Credits options
+   */
+  credits?: {
+    creator?: {
+      name?: string
+      domain?: string
+    }
+    prependText?: string
+    appendText?: string
+    showPoweredBy?: boolean
+  }
+
+  /**
+   * Email options
+   */
+  email?: {
+    general?: string
+    support?: string
+  }
+}