feat: vectorize

Author: RihanArfan

playground/nuxt.config.ts

@@ -14,7 +14,8 @@ export default defineNuxtConfig({
     database: true,
     kv: true,
     blob: true,
-    cache: true
+    cache: true,
+    vectorize: true
     // projectUrl: ({ branch }) => branch === 'main' ? 'https://playground.nuxt.dev' : `https://${encodeHost(branch).replace(/\//g, '-')}.playground-to39.pages.dev`
   },
   ui: {

src/features.ts

@@ -26,6 +26,7 @@ export interface HubConfig {
   cache?: boolean
   database?: boolean
   kv?: boolean
+  vectorize?: boolean
 
   remoteManifest?: {
     version: string
@@ -101,6 +102,12 @@ export function setupKV(_nuxt: Nuxt) {
   addServerImportsDir(resolve('./runtime/kv/server/utils'))
 }
 
+export function setupVectorize(_nuxt: Nuxt) {
+  // Add Server scanning
+  addServerScanDir(resolve('./runtime/vectorize/server'))
+  addServerImportsDir(resolve('./runtime/vectorize/server/utils'))
+}
+
 export function setupOpenAPI(nuxt: Nuxt) {
   // Fallback to custom placeholder when openAPI is disabled
   nuxt.options.alias['#hub/openapi'] = nuxt.options.nitro?.experimental?.openAPI === true

src/module.ts

@@ -7,7 +7,7 @@ import { findWorkspaceDir } from 'pkg-types'
 import { parseArgs } from 'citty'
 import { version } from '../package.json'
 import { generateWrangler } from './utils/wrangler'
-import { setupAi, setupCache, setupAnalytics, setupBlob, setupOpenAPI, setupDatabase, setupKV, setupBase, setupRemote } from './features'
+import { setupAi, setupCache, setupAnalytics, setupBlob, setupOpenAPI, setupDatabase, setupKV, setupVectorize, setupBase, setupRemote } from './features'
 import type { ModuleOptions } from './types/module'
 import { addBuildHooks } from './utils/build'
 
@@ -50,6 +50,7 @@ export default defineNuxtModule<ModuleOptions>({
       cache: false,
       database: false,
       kv: false,
+      vectorize: false,
       // Other options
       version,
       env: process.env.NUXT_HUB_ENV || 'production',
@@ -83,6 +84,7 @@ export default defineNuxtModule<ModuleOptions>({
     hub.cache && setupCache(nuxt)
     hub.database && setupDatabase(nuxt)
     hub.kv && setupKV(nuxt)
+    hub.vectorize && setupVectorize(nuxt)
 
     // nuxt prepare, stop here
     if (nuxt.options._prepare) {
@@ -134,7 +136,7 @@ export default defineNuxtModule<ModuleOptions>({
         await writeFile(gitignorePath, `${gitignore ? gitignore + '\n' : gitignore}.data`, 'utf-8')
       }
 
-      const needWrangler = Boolean(hub.ai || hub.analytics || hub.blob || hub.database || hub.kv)
+      const needWrangler = Boolean(hub.ai || hub.analytics || hub.blob || hub.database || hub.kv || hub.vectorize)
       if (needWrangler) {
         // Generate the wrangler.toml file
         const wranglerPath = join(hubDir, './wrangler.toml')

src/runtime/utils/features.ts

@@ -22,6 +22,9 @@ const featureMessages = {
   kv: [
     'NuxtHub KV is not enabled, set `hub.kv = true` in your `nuxt.config.ts`',
     'Read more at `https://hub.nuxt.com/docs/storage/kv`'
+  ].join('\n'),
+  vectorize: [
+    'NuxtHub Vectorize is not enabled, set `hub.vectorize = true` in your `nuxt.config.ts`'
   ].join('\n')
 }
 

src/runtime/vectorize/server/utils/vectorize.ts

@@ -0,0 +1,34 @@
+import { createError } from 'h3'
+import type { VectorizeIndex } from '@nuxthub/core'
+import { requireNuxtHubFeature } from '../../../utils/features'
+
+let _vectorize: VectorizeIndex
+
+/**
+ * Access the Vectorize database.
+ *
+ * @example ```ts
+ * const vectorize = hubVectorize()
+ * let vectorsToInsert = [
+ *   {id: "123", values: [32.4, 6.5, 11.2, 10.3, 87.9]},
+ *   {id: "456", values: [2.5, 7.8, 9.1, 76.9, 8.5]},
+ * ]
+ * let inserted = await vectorize.insert(vectorsToInsert)
+ * ```
+ *
+ * @see https://developers.cloudflare.com/vectorize/reference/client-api/
+ */
+export function hubVectorize(): VectorizeIndex {
+  requireNuxtHubFeature('vectorize')
+
+  if (_vectorize) {
+    return _vectorize
+  }
+  // @ts-expect-error globalThis.__env__ is not defined
+  const binding = process.env.VECTORIZE || globalThis.__env__?.VECTORIZE || globalThis.VECTORIZE
+  if (binding) {
+    _vectorize = binding as VectorizeIndex
+    return _vectorize
+  }
+  throw createError('Missing Cloudflare DB binding (Vectorize)')
+}

src/types/index.ts

@@ -2,3 +2,4 @@ export * from './blob'
 export * from './database'
 export * from './kv'
 export * from './module'
+export * from './vectorize'

src/types/module.ts

@@ -49,6 +49,12 @@ export interface ModuleOptions {
    * @default process.env.NUXT_HUB_REMOTE or --remote option when running `nuxt dev`
    * @see https://hub.nuxt.com/docs/getting-started/remote-storage
    */
+  /**
+   * Set `true` to enable the database for the project.
+   *
+   * @default false
+   */
+  vectorize?: boolean
   remote?: boolean | 'production' | 'preview'
   /**
    * The URL of the NuxtHub Admin

src/types/vectorize.ts

@@ -0,0 +1 @@
+export type { VectorizeIndex } from '@cloudflare/workers-types/experimental'

src/utils/build.ts

@@ -101,7 +101,8 @@ export function addBuildHooks(nuxt: Nuxt, hub: HubConfig) {
         blob: hub.blob,
         cache: hub.cache,
         database: hub.database,
-        kv: hub.kv
+        kv: hub.kv,
+        vectorize: hub.vectorize
       }
       await writeFile(join(nitro.options.output.publicDir, 'hub.config.json'), JSON.stringify(hubConfig, null, 2), 'utf-8')
     })

src/utils/wrangler.ts

@@ -1,6 +1,6 @@
 import { stringifyTOML } from 'confbox'
 
-export function generateWrangler(hub: { kv: boolean, database: boolean, blob: boolean, analytics: boolean, ai: boolean, accountId?: string }) {
+export function generateWrangler(hub: { kv: boolean, database: boolean, blob: boolean, analytics: boolean, ai: boolean, accountId?: string, vectorize: boolean }) {
   const wrangler: { [key: string]: any } = {}
 
   if (hub.accountId) {
@@ -42,5 +42,12 @@ export function generateWrangler(hub: { kv: boolean, database: boolean, blob: bo
     }]
   }
 
+  if (hub.vectorize) {
+    wrangler['vectorize'] = [{
+      binding: 'VECTORIZE',
+      index_name: 'default',
+    }]
+  }
+
   return stringifyTOML(wrangler)
 }