fix: module build

Author: sandros94

Diff for: package.json

@@ -14,6 +14,12 @@
     "name": "Sandro Circi",
     "email": "[email protected]"
   },
+  "build": {
+    "externals": [
+      "defu",
+      "ufo"
+    ]
+  },
   "exports": {
     ".": {
       "types": "./dist/types.d.ts",

Diff for: src/runtime/composables/surreal-db.ts

@@ -1,8 +1,9 @@
+import type { AsyncDataOptions, AsyncData, NuxtError } from 'nuxt/app'
+import type { FetchError } from 'ofetch'
 import { joinURL } from 'ufo'
 import { hash } from 'ohash'
 
-import type { Overrides } from '../types'
-import type { AsyncDataOptions } from '#app'
+import type { Overrides, PickFrom, KeysOf } from '../types'
 import type { MaybeRefOrGetter } from '#imports'
 import { computed, createError, toValue, useAsyncData, useNuxtApp, useSurrealFetch } from '#imports'
 
@@ -26,7 +27,7 @@ export function useSurrealDB(overrides?: Overrides) {
       method: 'GET',
       key: undefined,
     },
-  ) {
+  ): Promise<AsyncData<PickFrom<T, KeysOf<T>> | null, NuxtError<unknown> | null>> {
     const _record = toValue(record)
     const {
       key,
@@ -77,7 +78,7 @@ export function useSurrealDB(overrides?: Overrides) {
   // TODO: POST /signup Signs-up as a scope user to a specific scope
   // TODO: POST /signin Signs-in as a root, namespace, database, or scope user
 
-  async function sql<T = any>(sql: string, ovr?: Overrides) {
+  async function sql<T = any>(sql: string, ovr?: Overrides): Promise<AsyncData<PickFrom<T, KeysOf<T>> | null, FetchError<any> | null>> {
     return useSurrealFetch<T>('sql', {
       ...(ovr || overrides),
       method: 'POST',
@@ -93,7 +94,7 @@ export function useSurrealDB(overrides?: Overrides) {
     })
   }
 
-  async function version(ovr?: Overrides) {
+  async function version(ovr?: Overrides): Promise<AsyncData<any, FetchError<any> | null>> {
     return useSurrealFetch('version', {
       ...$surrealFetchOptionsOverride(ovr || overrides),
     })

Diff for: src/runtime/composables/surreal-fetch.ts

@@ -1,13 +1,14 @@
-import type { UseFetchOptions } from 'nuxt/app'
+import { useFetch, useNuxtApp, useRuntimeConfig } from 'nuxt/app'
+import type { AsyncData, UseFetchOptions } from 'nuxt/app'
 import { type MaybeRefOrGetter, ref } from 'vue'
+import type { FetchError } from 'ofetch'
 
-import type { DatabasePreset, Overrides } from '../types'
-import { useFetch, useNuxtApp, useRuntimeConfig } from '#app'
+import type { DatabasePreset, Overrides, PickFrom, KeysOf } from '../types'
 
 export function useSurrealFetch<T = any>(
   endpoint: MaybeRefOrGetter<string>,
   options: UseFetchOptions<T> & Overrides = {},
-) {
+): AsyncData<PickFrom<T, KeysOf<T>> | null, FetchError<any> | null> {
   const {
     database,
     token,

Diff for: src/runtime/plugin.ts

@@ -1,3 +1,5 @@
+// The following nitropack import is from https://github.com/nuxt/module-builder/issues/141#issuecomment-2078248248
+import type {} from 'nitropack'
 import type { FetchOptions, ResponseType } from 'ofetch'
 
 import type { DatabasePreset, Overrides } from './types'

Diff for: src/runtime/types/index.d.ts

@@ -25,3 +25,21 @@ type ErrorResponse = {
 
 export type Response<T> = Array<(OKResponse<T> | ErrorResponse)>
 export type Res<T> = Response<T>
+
+export type PickFrom<T, K extends Array<string>> = T extends Array<any>
+  ? T
+  : T extends Record<string, any>
+    ? keyof T extends K[number]
+      ? T // Exact same keys as the target, skip Pick
+      : K[number] extends never
+        ? T
+        : Pick<T, K[number]>
+    : T
+
+export type KeysOf<T> = Array<
+  T extends T // Include all keys of union types, not just common keys
+    ? keyof T extends string
+      ? keyof T
+      : never
+    : never
+>