feat: allow fallbackToApi to be set to server-only or client-only

Author: antfu

playground/nuxt.config.ts

@@ -23,6 +23,7 @@ export default defineNuxtConfig({
       },
     ],
     serverBundle: 'remote',
+    fallbackToApi: 'server-only',
     // serverBundle: {
     //   externalizeIconsJson: true,
     // },

src/runtime/plugin.ts

@@ -20,7 +20,7 @@ export default defineNuxtPlugin({
       const baseURL = config.app?.baseURL?.replace(/\/$/, '') ?? ''
 
       resources.push(baseURL + (options.localApiEndpoint || '/api/_nuxt_icon'))
-      if (options.fallbackToApi) {
+      if (options.fallbackToApi === true || options.fallbackToApi === 'client-only') {
         resources.push(options.iconifyApiEndpoint!)
       }
     }

src/runtime/server/api.ts

@@ -47,7 +47,7 @@ export default defineCachedEventHandler(async (event: H3Event) => {
     }
   }
 
-  if (options.fallbackToApi) {
+  if (options.fallbackToApi === true || options.fallbackToApi === 'server-only') {
     consola.debug(`[Icon] fetching ${(icons || []).map(i => '`' + collectionName + ':' + i + '`').join(',')} from iconify api`)
     if (apiUrl.host !== new URL(apiEndPoint).host) {
       return createError({ status: 400, message: 'Invalid icon request' })

src/schema-types.ts

@@ -99,7 +99,7 @@ export interface NuxtIconRuntimeOptions {
    *
    * @enum server,iconify
    */
-  provider: string | undefined
+  provider: 'server' | 'iconify' | undefined
 
   /**
    * Iconify API Endpoint URL
@@ -116,8 +116,10 @@ export interface NuxtIconRuntimeOptions {
    * Fallback to Iconify API if server provider fails to found the collection.
    *
    * @default true
+   *
+   * @enum true,false,server-only,client-only
    */
-  fallbackToApi: boolean
+  fallbackToApi: boolean | 'server-only' | 'client-only'
 
   /**
    * Local API Endpoint Path

src/schema.ts

@@ -109,6 +109,7 @@ export const schema = {
       ].join('\n'),
       enum: ['server', 'iconify'],
       tags: ['@studioIcon material-symbols:cloud'],
+      type: '"server" | "iconify" | undefined',
     },
   },
   iconifyApiEndpoint: {
@@ -125,6 +126,8 @@ export const schema = {
       title: 'Fallback to Iconify API',
       description: 'Fallback to Iconify API if server provider fails to found the collection.',
       tags: ['@studioIcon material-symbols:public'],
+      enum: [true, false, 'server-only', 'client-only'],
+      type: 'boolean | "server-only" | "client-only"',
     },
   },
   localApiEndpoint: {
@@ -149,6 +152,7 @@ export const schema = {
       title: 'Customize callback',
       description: 'Customize icon content (replace stroke-width, colors, etc...).',
       tags: ['@studioIcon material-symbols:edit'],
+      type: 'IconifyIconCustomizeCallback',
     },
   },
 } satisfies SchemaDefinition