From 847f75b725026a230b35be4d4e555c94f61c30c0 Mon Sep 17 00:00:00 2001 From: dswbx Date: Wed, 3 Sep 2025 17:00:24 +0200 Subject: [PATCH] docs: update cloudflare imports --- app/src/adapter/cloudflare/vite.ts | 4 ++-- .../cloudflare/image-optimization.plugin.ts | 6 +++--- app/src/plugins/index.ts | 1 + .../integration/(runtimes)/cloudflare.mdx | 4 ++-- examples/cloudflare-worker/config.ts | 14 -------------- examples/cloudflare-worker/wrangler.json | 2 +- 6 files changed, 9 insertions(+), 22 deletions(-) diff --git a/app/src/adapter/cloudflare/vite.ts b/app/src/adapter/cloudflare/vite.ts index c8c073e..22862b1 100644 --- a/app/src/adapter/cloudflare/vite.ts +++ b/app/src/adapter/cloudflare/vite.ts @@ -12,7 +12,7 @@ export function devFsVitePlugin({ }: { verbose?: boolean; configFile?: string; -}): Plugin { +} = {}): any { let isDev = false; let projectRoot = ""; @@ -115,7 +115,7 @@ if (typeof globalThis !== 'undefined') { return polyfill + code; } }, - }; + } satisfies Plugin; } // Write function that uses the dev-fs polyfill injected by our Vite plugin diff --git a/app/src/plugins/cloudflare/image-optimization.plugin.ts b/app/src/plugins/cloudflare/image-optimization.plugin.ts index cd6742f..0f330bd 100644 --- a/app/src/plugins/cloudflare/image-optimization.plugin.ts +++ b/app/src/plugins/cloudflare/image-optimization.plugin.ts @@ -16,7 +16,7 @@ const schema = s.partialObject({ metadata: s.string({ enum: ["copyright", "keep", "none"] }), quality: s.number({ minimum: 1, maximum: 100 }), }); -type ImageOptimizationSchema = s.Static; +export type CloudflareImageOptimizationSchema = s.Static; export type CloudflareImageOptimizationOptions = { /** @@ -38,12 +38,12 @@ export type CloudflareImageOptimizationOptions = { * The default options to use * @default {} */ - defaultOptions?: ImageOptimizationSchema; + defaultOptions?: CloudflareImageOptimizationSchema; /** * The fixed options to use * @default {} */ - fixedOptions?: ImageOptimizationSchema; + fixedOptions?: CloudflareImageOptimizationSchema; /** * The cache control to use * @default public, max-age=31536000, immutable diff --git a/app/src/plugins/index.ts b/app/src/plugins/index.ts index ee7a31a..eab3bf6 100644 --- a/app/src/plugins/index.ts +++ b/app/src/plugins/index.ts @@ -1,5 +1,6 @@ export { cloudflareImageOptimization, + type CloudflareImageOptimizationSchema, type CloudflareImageOptimizationOptions, } from "./cloudflare/image-optimization.plugin"; export { showRoutes, type ShowRoutesOptions } from "./dev/show-routes.plugin"; diff --git a/docs/content/docs/(documentation)/integration/(runtimes)/cloudflare.mdx b/docs/content/docs/(documentation)/integration/(runtimes)/cloudflare.mdx index 9ad826b..6ca9f25 100644 --- a/docs/content/docs/(documentation)/integration/(runtimes)/cloudflare.mdx +++ b/docs/content/docs/(documentation)/integration/(runtimes)/cloudflare.mdx @@ -163,7 +163,7 @@ The [Cloudflare Vite Plugin](https://developers.cloudflare.com/workers/vite-plug To fix this, bknd exports a Vite plugin that provides filesystem access during development. You can use it by adding the following to your `vite.config.ts` file: ```ts -import { devFsVitePlugin } from "bknd/adapter/cloudflare/vite"; +import { devFsVitePlugin } from "bknd/adapter/cloudflare"; export default defineConfig({ plugins: [devFsVitePlugin()], // [!code highlight] @@ -173,7 +173,7 @@ export default defineConfig({ Now to use this polyfill, you can use the `devFsWrite` function to write files to the filesystem. ```ts -import { devFsWrite } from "bknd/adapter/cloudflare/vite"; // [!code highlight] +import { devFsWrite } from "bknd/adapter/cloudflare"; // [!code highlight] import { syncTypes } from "bknd/plugins"; export default { diff --git a/examples/cloudflare-worker/config.ts b/examples/cloudflare-worker/config.ts index 0309982..4207e27 100644 --- a/examples/cloudflare-worker/config.ts +++ b/examples/cloudflare-worker/config.ts @@ -1,21 +1,7 @@ import type { CloudflareBkndConfig } from "bknd/adapter/cloudflare"; -import { syncTypes } from "bknd/plugins"; -import { writeFile } from "node:fs/promises"; - -const isDev = import.meta.env && !import.meta.env.PROD; export default { d1: { session: true, }, - options: { - plugins: [ - syncTypes({ - enabled: isDev, - write: async (et) => { - await writeFile("bknd-types.d.ts", et.toString()); - }, - }), - ], - }, } satisfies CloudflareBkndConfig; diff --git a/examples/cloudflare-worker/wrangler.json b/examples/cloudflare-worker/wrangler.json index 013a2dd..fd92cd8 100644 --- a/examples/cloudflare-worker/wrangler.json +++ b/examples/cloudflare-worker/wrangler.json @@ -2,7 +2,7 @@ "$schema": "node_modules/wrangler/config-schema.json", "name": "bknd-cf-worker-example", "main": "src/index.ts", - "compatibility_date": "2025-02-04", + "compatibility_date": "2025-08-03", "compatibility_flags": ["nodejs_compat"], "workers_dev": true, "minify": true,