Merge pull request #2 from BJTheCod3r/chore/type-fixes

chore: type fixes

Author: BJTheCod3r

README.md

@@ -34,6 +34,7 @@ export default defineNuxtConfig({
     documentIdParam: 'document_id',
     backLink: '/',
     backLinkText: 'Back to dashboard',
+    showBackLink: true,
     buttonColor: '#4f46e5',
     buttonHoverColor: '#4338ca',
     showDocument: true,
@@ -112,6 +113,7 @@ All response fields are treated as strings except the validity flag. If a status
 | `logo`                                                                                     | Logo URL displayed at the top of the page                                                | `/logo.png`              |
 | `verificationEndpoint`                                                                     | API endpoint that validates a document                                                   | **required**             |
 | `backLink` / `backLinkText`                                                                | Destination + label for the back button                                                  | `'/'` / `'Back to Home'` |
+| `showBackLink`                                                                             | Toggle visibility of the back button                                                     | `true`                   |
 | `buttonColor` / `buttonHoverColor`                                                         | Primary button colours                                                                   | `#4f46e5` / `#4338ca`    |
 | `fields`                                                                                   | Array describing the detail rows (label, key, type, optional resolver)                   | Built-in defaults        |
 | `showDocument`                                                                             | Toggle document image section (hides it entirely when `false`)                           | `true`                   |
@@ -153,6 +155,8 @@ Only fields that resolve to a non-empty value are rendered. `type: 'status'` als
 
 When `showDocument` is `false`, the asset block is skipped altogether even if the API responds with a URL. Use `showDocumentTitle` to hide the heading while keeping the preview itself, or override `displayTitle` to customise the heading copy. Set `displayType` to `'image'` or `'pdf'` when you know the asset format; otherwise the component falls back to inferring it from the URL (still supporting PDF detection). The `displayField` can point to an image or a PDF; PDFs render inside the viewer with a fallback link.
 
+Turn off the footer back button entirely by setting `showBackLink: false`.
+
 ```ts
 documentVerification: {
   // ...

playground/nuxt.config.ts

@@ -1,11 +1,14 @@
 // https://nuxt.com/docs/api/configuration/nuxt-config
+import { defineNuxtConfig } from 'nuxt/config'
+
 export default defineNuxtConfig({
   modules: ['../nuxt'],
   documentVerification: {
     logo: '/document-icon.png',
     verificationEndpoint: '/api/verify-document',
     backLink: '/',
     backLinkText: 'Back to Home',
+    showBackLink: false,
     buttonColor: '#4f46e5',
     buttonHoverColor: '#4338ca',
     fields: [

playground/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "types": ["nuxt"]
+  },
+  "include": ["../src/types/**/*.d.ts", "./**/*"]
+}

src/types/runtime-config.ts …nd/types/nuxt-document-verification.d.tssrc/types/runtime-config.ts renamed to playground/types/nuxt-document-verification.d.ts src/types/runtime-config.ts renamed to playground/types/nuxt-document-verification.d.ts

@@ -1,9 +1,10 @@
-import type { DocumentVerificationConfig } from '../runtime/composables/types'
+import type { DocumentVerificationConfig } from '../../src/runtime/composables/types'
 
-declare module '@nuxt/schema' {
+declare module 'nuxt/schema' {
   interface NuxtConfig {
     documentVerification?: DocumentVerificationConfig
   }
+
   interface PublicRuntimeConfig {
     documentVerification: DocumentVerificationConfig
   }

src/module.ts

@@ -1,5 +1,3 @@
-import './types/runtime-config'
-
 import { defineNuxtModule, createResolver, addComponent, addImportsDir, addPlugin } from '@nuxt/kit'
 import type { DocumentVerificationConfig } from './runtime/composables/types'
 import { BASE_FIELD_DEFINITIONS } from './runtime/composables/constants'
@@ -17,6 +15,7 @@ export default defineNuxtModule<DocumentVerificationConfig>({
     verificationEndpoint: '/api/verify-document',
     backLink: '/',
     backLinkText: 'Back to Home',
+    showBackLink: true,
     buttonColor: '#4f46e5',
     buttonHoverColor: '#4338ca',
     fields: BASE_FIELD_DEFINITIONS,

src/runtime/components/DocumentFooter.vue

@@ -1,5 +1,5 @@
 <template>
-  <div class="dv-footer">
+  <div v-if="showBackLink" class="dv-footer">
     <a :href="backLink" class="dv-footer__link">{{ backLinkText }}</a>
   </div>
 </template>
@@ -15,5 +15,9 @@ defineProps({
     type: String,
     required: true,
   },
+  showBackLink: {
+    type: Boolean,
+    default: true,
+  },
 })
 </script>

src/runtime/components/DocumentVerification.vue

@@ -30,7 +30,12 @@
       />
     </div>
 
-    <DocumentFooter :back-link="config.backLink" :back-link-text="config.backLinkText" />
+    <DocumentFooter
+      v-if="config.showBackLink !== false"
+      :back-link="config.backLink"
+      :back-link-text="config.backLinkText"
+      :show-back-link="config.showBackLink"
+    />
   </div>
 </template>
 

src/runtime/composables/types.ts

@@ -53,6 +53,7 @@ export interface DocumentVerificationConfig {
   verificationEndpoint: string
   backLink: string
   backLinkText: string
+  showBackLink?: boolean
   buttonColor: string
   buttonHoverColor: string
   fields?: FieldDefinition[]

src/runtime/composables/useDocumentVerification.ts

@@ -32,6 +32,7 @@ export const useDocumentVerification = () => {
   const cfg = $documentVerification as DocumentVerificationConfig
   const route = useRoute()
   const documentIdParam = cfg.documentIdParam || DEFAULT_DOCUMENT_ID_PARAM
+  const showBackLink = cfg.showBackLink ?? true
   const showDocument = cfg.showDocument ?? true
   const displayTitle = cfg.displayTitle ?? 'Document Preview'
   const showDocumentTitle = cfg.showDocumentTitle ?? true
@@ -40,6 +41,7 @@ export const useDocumentVerification = () => {
   const resolvedConfig: DocumentVerificationConfig = {
     ...cfg,
     documentIdParam,
+    showBackLink,
     showDocument,
     showDocumentTitle,
     displayTitle,

src/runtime/plugins/document-verification.ts

@@ -17,6 +17,7 @@ export default defineNuxtPlugin<{ documentVerification: DocumentVerificationConf
     }
 
     const documentIdParam = moduleConfig.documentIdParam ?? DEFAULT_DOCUMENT_ID_PARAM
+    const showBackLink = moduleConfig.showBackLink ?? true
     const showDocument = moduleConfig.showDocument ?? true
     const displayTitle = moduleConfig.displayTitle ?? 'Document Preview'
     const showDocumentTitle = moduleConfig.showDocumentTitle ?? true
@@ -26,6 +27,7 @@ export default defineNuxtPlugin<{ documentVerification: DocumentVerificationConf
     const normalizedConfig: DocumentVerificationConfig = {
       ...moduleConfig,
       documentIdParam,
+      showBackLink,
       showDocument,
       displayTitle,
       showDocumentTitle,