fix: move types to runtime entrypoint

nuxt-modules · Mar 31, 2021 · 4cbac01 · 4cbac01
1 parent c10a060
commit 4cbac01
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 42 deletions.
diff --git a/src/components/sanity-content.ts b/src/components/sanity-content.ts
@@ -2,7 +2,7 @@ import defu from 'defu'
 import type { CreateElement, VNode, VNodeData, VueConstructor } from 'vue'
 
 // eslint-disable-next-line
-import type { SanityConfiguration } from '../module'
+import type { SanityConfiguration } from '..'
 import { extendVue } from './vue'
 
 interface MarkDefs {

diff --git a/src/components/sanity-image.ts b/src/components/sanity-image.ts
@@ -1,7 +1,7 @@
 import { extendVue } from './vue'
 
 // eslint-disable-next-line
-import type { SanityConfiguration } from '../module'
+import type { SanityConfiguration } from '..'
 
 const baseURL = 'https://cdn.sanity.io/images'
 

diff --git a/src/index.ts b/src/index.ts
@@ -1,2 +1,44 @@
+import type { SanityClient } from '@sanity/client'
+
+import type { SanityModuleOptions, CONFIG_KEY } from './module'
+
+import type { createClient } from './client'
+
+const HELPER_KEY: `$${typeof CONFIG_KEY}` = '$sanity'
+
 export * from './client'
 export * from './helpers'
+
+interface Client {
+  client: SanityClient
+  config: Pick<SanityModuleOptions, 'useCdn' | 'projectId' | 'dataset' | 'withCredentials' | 'token'>
+  fetch: ReturnType<typeof createClient>['fetch']
+  setToken: (token: string) => void
+}
+
+type SanityHelper = Record<string, Client> & Client
+
+declare module '@nuxt/types' {
+  interface NuxtOptions {
+    [CONFIG_KEY]: SanityModuleOptions
+  } // Nuxt 2.14+
+  interface Configuration {
+    [CONFIG_KEY]: SanityModuleOptions
+  } // Nuxt 2.9 - 2.13
+  interface NuxtAppOptions {
+    [HELPER_KEY]: SanityHelper
+  }
+}
+
+declare module 'vue/types/vue' {
+  interface Vue {
+    [HELPER_KEY]: SanityHelper
+  }
+}
+
+declare module 'vuex/types/index' {
+  // eslint-disable-next-line
+  interface Store<S> {
+    [HELPER_KEY]: SanityHelper
+  }
+}
diff --git a/src/module.ts b/src/module.ts
@@ -5,13 +5,10 @@ import { readJSONSync } from 'fs-extra'
 import { join, resolve } from 'upath'
 
 import type { Module } from '@nuxt/types'
-import type { SanityClient } from '@sanity/client'
 
 import { name, version } from '../package.json'
 
-import type { SanityConfiguration, createClient } from '.'
-
-export type { SanityConfiguration }
+import type { SanityConfiguration } from '.'
 
 export interface SanityModuleOptions extends Partial<SanityConfiguration> {
   /**
@@ -52,8 +49,7 @@ const DEFAULTS: SanityModuleOptions = {
   additionalClients: {},
 }
 
-const CONFIG_KEY = 'sanity'
-const HELPER_KEY = '$sanity'
+export const CONFIG_KEY = 'sanity' as const
 
 function validateConfig ({ projectId, dataset }: SanityModuleOptions) {
   if (!projectId) {
@@ -152,38 +148,4 @@ const sanityModule: Module<SanityModuleOptions> = function sanityModule (moduleO
 
 ;(sanityModule as any).meta = { name, version }
 
-interface Client {
-  client: SanityClient
-  config: Pick<SanityModuleOptions, 'useCdn' | 'projectId' | 'dataset' | 'withCredentials' | 'token'>
-  fetch: ReturnType<typeof createClient>['fetch']
-  setToken: (token: string) => void
-}
-
-type SanityHelper = Record<string, Client> & Client
-
-declare module '@nuxt/types' {
-  interface NuxtOptions {
-    [CONFIG_KEY]: SanityModuleOptions
-  } // Nuxt 2.14+
-  interface Configuration {
-    [CONFIG_KEY]: SanityModuleOptions
-  } // Nuxt 2.9 - 2.13
-  interface NuxtAppOptions {
-    [HELPER_KEY]: SanityHelper
-  }
-}
-
-declare module 'vue/types/vue' {
-  interface Vue {
-    [HELPER_KEY]: SanityHelper
-  }
-}
-
-declare module 'vuex/types/index' {
-  // eslint-disable-next-line
-  interface Store<S> {
-    [HELPER_KEY]: SanityHelper
-  }
-}
-
 export default sanityModule