feat: add support for defining compatibility date & flags (#264)

Author: atinux

playground/nuxt.config.ts

@@ -19,6 +19,7 @@ export default defineNuxtConfig({
     blob: true,
     cache: true,
     bindings: {
+      compatibilityFlags: ['nodejs_compat_v2'],
       // Used for /api/hyperdrive
       hyperdrive: {
         POSTGRES: '8bb2913857b84c939cd908740fa5a5d5'

playground/server/api/crypto.ts

@@ -0,0 +1,12 @@
+export default eventHandler(async () => {
+  // Available in nodejs_compat_v2
+  const crypto = globalThis['process']?.getBuiltinModule?.('crypto')
+  const hash = await new Promise((resolve, reject) => {
+    crypto.scrypt('hello-world', crypto.randomUUID(), 64, (err, hash) => {
+      if (err) return reject(err)
+      resolve(hash.toString('hex'))
+    })
+  })
+
+  return { hash: `scrypt:${hash}` }
+})

src/features.ts

@@ -28,6 +28,8 @@ export interface HubConfig {
   kv?: boolean
 
   bindings?: {
+    compatibilityDate?: string
+    compatibilityFlags?: string[]
     hyperdrive?: {
       [key: string]: string
     }

src/types/module.ts

@@ -85,6 +85,17 @@ export interface ModuleOptions {
    * @default {}
    */
   bindings?: {
+    /**
+     * The compatibility date for the project.
+     * @see https://developers.cloudflare.com/workers/configuration/compatibility-dates/
+     */
+    compatibilityDate?: string
+    /**
+     * Extra compatibility flags for the project.
+     * Note that NuxtHub will always add the 'nodejs_compat' flag if not specified.
+     * @see https://developers.cloudflare.com/workers/configuration/compatibility-dates/#compatibility-flags
+     */
+    compatibilityFlags?: string[]
     /**
      * The hyperdrive bindings for the project, used only when deployed on Cloudflare.
      * @see https://hub.nuxt.com/docs/features/hyperdrive