feat: Add explicit types for resource schemas and a getSchema helper function to the useResourceSchemas composable.

Author: clifordpereira

src/runtime/composables/useResourceSchemas.ts

@@ -1,7 +1,29 @@
 import { useAsyncData, useRequestHeaders } from '#imports'
+import type { Ref } from 'vue'
 
-export const useResourceSchemas = async () => {
-  const { data: schemas, status, error, refresh } = await useAsyncData('resource-schemas', () => $fetch<Record<string, { resource: string, fields: { name: string, type: string, required?: boolean, selectOptions?: string[] }[] }>>('/api/_schema', {
+export interface ResourceField {
+  name: string
+  type: string
+  required?: boolean
+  selectOptions?: string[]
+}
+
+export interface ResourceSchema {
+  resource: string
+  fields: ResourceField[]
+}
+
+export type ResourceSchemas = Record<string, ResourceSchema>
+
+export const useResourceSchemas = async (): Promise<{
+  schemas: Ref<ResourceSchemas | null | undefined>
+  getSchema: (resource: string) => ResourceSchema | undefined
+  status: Ref<'idle' | 'pending' | 'success' | 'error'>
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  error: Ref<any>
+  refresh: () => Promise<void>
+}> => {
+  const { data: schemas, status, error, refresh } = await useAsyncData<ResourceSchemas>('resource-schemas', () => $fetch('/api/_schema', {
     headers: useRequestHeaders(['cookie']),
   }))
 
@@ -15,6 +37,6 @@ export const useResourceSchemas = async () => {
     getSchema,
     status,
     error,
-    refresh,
+    refresh: refresh as unknown as () => Promise<void>,
   }
 }