create-cloudflare 0.0.0-e37c1b86 → 0.0.0-e39a45ffa
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/cli.js +69576 -67931
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +39 -28
- package/templates/analog/c3.ts +111 -0
- package/templates/analog/snippets/devBindingsModule.ts +7 -0
- package/templates/analog/templates/env.d.ts +13 -0
- package/templates/analog/templates/src/dev-bindings.ts +18 -0
- package/templates/analog/templates/wrangler.jsonc +5 -0
- package/templates/angular/c3.ts +5 -95
- package/templates/angular/pages/c3.ts +135 -0
- package/templates/angular/pages/templates/src/server.ts +15 -0
- package/templates/angular/pages/templates/tools/copy-files.mjs +15 -0
- package/templates/angular/pages/templates/wrangler.jsonc +5 -0
- package/templates/angular/workers/c3.ts +131 -0
- package/templates/angular/workers/templates/src/server.ts +15 -0
- package/templates/angular/workers/templates/wrangler.jsonc +12 -0
- package/templates/astro/c3.ts +5 -46
- package/templates/astro/pages/c3.ts +99 -0
- package/templates/astro/pages/templates/js/wrangler.jsonc +8 -0
- package/templates/astro/pages/templates/ts/src/env.d.ts +5 -0
- package/templates/astro/pages/templates/ts/worker-configuration.d.ts +4 -0
- package/templates/astro/pages/templates/ts/wrangler.jsonc +8 -0
- package/templates/astro/workers/c3.ts +98 -0
- package/templates/astro/workers/templates/js/public/.assetsignore +2 -0
- package/templates/astro/workers/templates/js/wrangler.jsonc +16 -0
- package/templates/astro/workers/templates/ts/public/.assetsignore +2 -0
- package/templates/astro/workers/templates/ts/src/env.d.ts +5 -0
- package/templates/astro/workers/templates/ts/wrangler.jsonc +16 -0
- package/templates/common/c3.ts +8 -1
- package/templates/common/js/.editorconfig +0 -1
- package/templates/common/js/package.json +1 -1
- package/templates/common/js/wrangler.jsonc +8 -0
- package/templates/common/ts/.editorconfig +0 -1
- package/templates/common/ts/package.json +4 -3
- package/templates/common/ts/src/ab-test.ts +2 -2
- package/templates/common/ts/src/index.ts +5 -2
- package/templates/common/ts/src/proxy.ts +2 -2
- package/templates/common/ts/src/redirect.ts +2 -2
- package/templates/common/ts/tsconfig.json +34 -95
- package/templates/common/ts/wrangler.jsonc +8 -0
- package/templates/docusaurus/c3.ts +5 -23
- package/templates/docusaurus/pages/c3.ts +32 -0
- package/templates/docusaurus/workers/c3.ts +34 -0
- package/templates/docusaurus/workers/templates/wrangler.jsonc +10 -0
- package/templates/gatsby/c3.ts +5 -42
- package/templates/gatsby/pages/c3.ts +52 -0
- package/templates/gatsby/workers/c3.ts +54 -0
- package/templates/gatsby/workers/templates/wrangler.jsonc +10 -0
- package/templates/hello-world/c3.ts +23 -2
- package/templates/hello-world/js/.editorconfig +0 -1
- package/templates/hello-world/js/package.json +5 -2
- package/templates/hello-world/js/test/index.spec.js +20 -0
- package/templates/hello-world/js/vitest.config.js +11 -0
- package/templates/hello-world/js/wrangler.jsonc +8 -0
- package/templates/hello-world/py/.python-version +1 -0
- package/templates/hello-world/py/README.md +23 -0
- package/templates/hello-world/py/__dot__gitignore +68 -0
- package/templates/hello-world/py/package.json +13 -0
- package/templates/hello-world/py/pyproject.toml +9 -0
- package/templates/hello-world/py/src/entry.py +5 -0
- package/templates/hello-world/py/uv.lock +22 -0
- package/templates/hello-world/py/wrangler.jsonc +9 -0
- package/templates/hello-world/ts/.editorconfig +0 -1
- package/templates/hello-world/ts/package.json +7 -3
- package/templates/hello-world/ts/src/index.ts +5 -19
- package/templates/hello-world/ts/test/env.d.ts +3 -0
- package/templates/hello-world/ts/test/index.spec.ts +24 -0
- package/templates/hello-world/ts/test/tsconfig.json +8 -0
- package/templates/hello-world/ts/tsconfig.json +37 -96
- package/templates/hello-world/ts/vitest.config.mts +11 -0
- package/templates/hello-world/ts/wrangler.jsonc +8 -0
- package/templates/hello-world-assets-only/c3.ts +16 -0
- package/templates/hello-world-assets-only/templates/package.json +13 -0
- package/templates/hello-world-assets-only/templates/public/index.html +12 -0
- package/templates/hello-world-assets-only/templates/wrangler.jsonc +11 -0
- package/templates/hello-world-durable-object/c3.ts +10 -2
- package/templates/hello-world-durable-object/js/.editorconfig +0 -1
- package/templates/hello-world-durable-object/js/package.json +1 -1
- package/templates/hello-world-durable-object/js/src/index.js +28 -23
- package/templates/hello-world-durable-object/js/wrangler.jsonc +24 -0
- package/templates/hello-world-durable-object/py/.python-version +1 -0
- package/templates/hello-world-durable-object/py/README.md +23 -0
- package/templates/hello-world-durable-object/py/__dot__gitignore +68 -0
- package/templates/hello-world-durable-object/py/package.json +13 -0
- package/templates/hello-world-durable-object/py/pyproject.toml +9 -0
- package/templates/hello-world-durable-object/py/src/entry.py +66 -0
- package/templates/hello-world-durable-object/py/uv.lock +22 -0
- package/templates/hello-world-durable-object/py/wrangler.jsonc +27 -0
- package/templates/hello-world-durable-object/ts/.editorconfig +0 -1
- package/templates/hello-world-durable-object/ts/package.json +4 -4
- package/templates/hello-world-durable-object/ts/src/index.ts +32 -44
- package/templates/hello-world-durable-object/ts/tsconfig.json +34 -95
- package/templates/hello-world-durable-object/ts/wrangler.jsonc +24 -0
- package/templates/hello-world-durable-object-with-assets/c3.ts +26 -0
- package/templates/hello-world-durable-object-with-assets/js/.editorconfig +12 -0
- package/templates/hello-world-durable-object-with-assets/js/.prettierrc +6 -0
- package/templates/hello-world-durable-object-with-assets/js/__dot__gitignore +172 -0
- package/templates/hello-world-durable-object-with-assets/js/package.json +13 -0
- package/templates/hello-world-durable-object-with-assets/js/public/index.html +20 -0
- package/templates/hello-world-durable-object-with-assets/js/src/index.js +70 -0
- package/templates/hello-world-durable-object-with-assets/js/wrangler.jsonc +28 -0
- package/templates/hello-world-durable-object-with-assets/py/.python-version +1 -0
- package/templates/hello-world-durable-object-with-assets/py/README.md +23 -0
- package/templates/hello-world-durable-object-with-assets/py/__dot__gitignore +68 -0
- package/templates/hello-world-durable-object-with-assets/py/package.json +13 -0
- package/templates/hello-world-durable-object-with-assets/py/public/index.html +20 -0
- package/templates/hello-world-durable-object-with-assets/py/pyproject.toml +9 -0
- package/templates/hello-world-durable-object-with-assets/py/src/entry.py +66 -0
- package/templates/hello-world-durable-object-with-assets/py/uv.lock +22 -0
- package/templates/hello-world-durable-object-with-assets/py/wrangler.jsonc +31 -0
- package/templates/hello-world-durable-object-with-assets/ts/.editorconfig +12 -0
- package/templates/hello-world-durable-object-with-assets/ts/.prettierrc +6 -0
- package/templates/hello-world-durable-object-with-assets/ts/__dot__gitignore +172 -0
- package/templates/hello-world-durable-object-with-assets/ts/package.json +15 -0
- package/templates/hello-world-durable-object-with-assets/ts/public/index.html +20 -0
- package/templates/hello-world-durable-object-with-assets/ts/src/index.ts +67 -0
- package/templates/hello-world-durable-object-with-assets/ts/tsconfig.json +40 -0
- package/templates/hello-world-durable-object-with-assets/ts/wrangler.jsonc +28 -0
- package/templates/hello-world-with-assets/c3.ts +25 -0
- package/templates/hello-world-with-assets/js/.editorconfig +12 -0
- package/templates/hello-world-with-assets/js/.prettierrc +6 -0
- package/templates/hello-world-with-assets/js/__dot__gitignore +172 -0
- package/templates/hello-world-with-assets/js/package.json +16 -0
- package/templates/hello-world-with-assets/js/public/index.html +32 -0
- package/templates/hello-world-with-assets/js/src/index.js +23 -0
- package/templates/hello-world-with-assets/js/test/index.spec.js +41 -0
- package/templates/hello-world-with-assets/js/vitest.config.js +11 -0
- package/templates/hello-world-with-assets/js/wrangler.jsonc +16 -0
- package/templates/hello-world-with-assets/py/.python-version +1 -0
- package/templates/hello-world-with-assets/py/README.md +23 -0
- package/templates/hello-world-with-assets/py/__dot__gitignore +68 -0
- package/templates/hello-world-with-assets/py/package.json +13 -0
- package/templates/hello-world-with-assets/py/public/index.html +32 -0
- package/templates/hello-world-with-assets/py/pyproject.toml +9 -0
- package/templates/hello-world-with-assets/py/src/entry.py +11 -0
- package/templates/hello-world-with-assets/py/uv.lock +22 -0
- package/templates/hello-world-with-assets/py/wrangler.jsonc +15 -0
- package/templates/hello-world-with-assets/ts/.editorconfig +12 -0
- package/templates/hello-world-with-assets/ts/.prettierrc +6 -0
- package/templates/hello-world-with-assets/ts/__dot__gitignore +172 -0
- package/templates/hello-world-with-assets/ts/package.json +18 -0
- package/templates/hello-world-with-assets/ts/public/index.html +32 -0
- package/templates/hello-world-with-assets/ts/src/index.ts +26 -0
- package/templates/hello-world-with-assets/ts/test/env.d.ts +3 -0
- package/templates/hello-world-with-assets/ts/test/index.spec.ts +41 -0
- package/templates/hello-world-with-assets/ts/test/tsconfig.json +8 -0
- package/templates/hello-world-with-assets/ts/tsconfig.json +42 -0
- package/templates/hello-world-with-assets/ts/vitest.config.mts +11 -0
- package/templates/hello-world-with-assets/ts/wrangler.jsonc +15 -0
- package/templates/hono/c3.ts +5 -21
- package/templates/hono/pages/c3.ts +47 -0
- package/templates/hono/pages/templates/src/index.tsx +12 -0
- package/templates/hono/pages/templates/wrangler.jsonc +8 -0
- package/templates/hono/workers/c3.ts +44 -0
- package/templates/hono/workers/templates/public/index.html +19 -0
- package/templates/hono/workers/templates/src/index.ts +9 -0
- package/templates/hono/workers/templates/wrangler.jsonc +9 -0
- package/templates/next/c3.ts +7 -224
- package/templates/next/{README.md → pages/README.md} +15 -6
- package/templates/next/{app → pages/app}/js/app/api/hello/route.js +5 -5
- package/templates/next/{app → pages/app}/ts/app/api/hello/route.ts +5 -6
- package/templates/next/pages/c3.ts +221 -0
- package/templates/next/pages/{js → pages/js}/pages/api/hello.js +1 -1
- package/templates/next/pages/{ts → pages/ts}/pages/api/hello.ts +1 -1
- package/templates/next/pages/wrangler.jsonc +8 -0
- package/templates/next/workers/c3.ts +71 -0
- package/templates/next/workers/templates/.dev.vars +2 -0
- package/templates/next/workers/templates/__dot__gitignore +39 -0
- package/templates/next/workers/templates/open-next.config.ts +9 -0
- package/templates/next/workers/templates/wrangler.jsonc +13 -0
- package/templates/nuxt/c3.ts +5 -96
- package/templates/nuxt/pages/c3.ts +123 -0
- package/templates/nuxt/pages/templates/env.d.ts +14 -0
- package/templates/nuxt/pages/templates/wrangler.jsonc +5 -0
- package/templates/nuxt/workers/c3.ts +122 -0
- package/templates/nuxt/workers/templates/env.d.ts +14 -0
- package/templates/nuxt/workers/templates/wrangler.jsonc +12 -0
- package/templates/openapi/c3.ts +6 -1
- package/templates/openapi/ts/README.md +3 -3
- package/templates/openapi/ts/__dot__gitignore +1 -0
- package/templates/openapi/ts/package.json +9 -5
- package/templates/openapi/ts/src/endpoints/taskCreate.ts +27 -17
- package/templates/openapi/ts/src/endpoints/taskDelete.ts +21 -20
- package/templates/openapi/ts/src/endpoints/taskFetch.ts +31 -24
- package/templates/openapi/ts/src/endpoints/taskList.ts +28 -25
- package/templates/openapi/ts/src/index.ts +16 -19
- package/templates/openapi/ts/src/types.ts +12 -8
- package/templates/openapi/ts/tsconfig.json +18 -21
- package/templates/openapi/ts/wrangler.jsonc +8 -0
- package/templates/pre-existing/c3.ts +43 -20
- package/templates/pre-existing/js/.editorconfig +0 -1
- package/templates/pre-existing/js/package.json +1 -1
- package/templates/queues/c3.ts +7 -1
- package/templates/queues/js/.editorconfig +0 -1
- package/templates/queues/js/package.json +1 -1
- package/templates/queues/js/wrangler.jsonc +21 -0
- package/templates/queues/ts/.editorconfig +0 -1
- package/templates/queues/ts/package.json +4 -3
- package/templates/queues/ts/src/index.ts +6 -8
- package/templates/queues/ts/tsconfig.json +34 -95
- package/templates/queues/ts/wrangler.jsonc +21 -0
- package/templates/qwik/c3.ts +5 -141
- package/templates/qwik/pages/c3.ts +151 -0
- package/templates/qwik/pages/templates/worker-configuration.d.ts +4 -0
- package/templates/qwik/pages/templates/wrangler.jsonc +8 -0
- package/templates/qwik/workers/c3.ts +153 -0
- package/templates/qwik/workers/snippets/getPlatformProxy.ts +6 -0
- package/templates/qwik/workers/templates/public/.assetsignore +4 -0
- package/templates/qwik/workers/templates/worker-configuration.d.ts +4 -0
- package/templates/qwik/workers/templates/wrangler.jsonc +16 -0
- package/templates/react/c3.ts +5 -25
- package/templates/react/pages/c3.ts +65 -0
- package/templates/react/pages/templates/wrangler.jsonc +5 -0
- package/templates/react/workers/c3.ts +183 -0
- package/templates/react/workers/js/src/App.css +45 -0
- package/templates/react/workers/js/src/App.jsx +58 -0
- package/templates/react/workers/js/src/assets/Cloudflare_Logo.svg +53 -0
- package/templates/react/workers/js/worker/index.js +13 -0
- package/templates/react/workers/js/wrangler.jsonc +9 -0
- package/templates/react/workers/ts/src/App.css +45 -0
- package/templates/react/workers/ts/src/App.tsx +58 -0
- package/templates/react/workers/ts/src/assets/Cloudflare_Logo.svg +51 -0
- package/templates/react/workers/ts/tsconfig.worker.json +8 -0
- package/templates/react/workers/ts/worker/index.ts +12 -0
- package/templates/react/workers/ts/wrangler.jsonc +9 -0
- package/templates/react-router/c3.ts +41 -0
- package/templates/remix/c3.ts +6 -29
- package/templates/remix/pages/c3.ts +70 -0
- package/templates/remix/pages/templates/worker-configuration.d.ts +4 -0
- package/templates/remix/pages/templates/wrangler.jsonc +5 -0
- package/templates/remix/workers/c3.ts +53 -0
- package/templates/remix/workers/templates/public/.assetsignore +0 -0
- package/templates/remix/workers/templates/worker-configuration.d.ts +4 -0
- package/templates/remix/workers/templates/wrangler.toml +11 -0
- package/templates/scheduled/c3.ts +7 -1
- package/templates/scheduled/js/.editorconfig +0 -1
- package/templates/scheduled/js/package.json +3 -3
- package/templates/scheduled/js/src/index.js +9 -2
- package/templates/scheduled/js/wrangler.jsonc +13 -0
- package/templates/scheduled/ts/.editorconfig +0 -1
- package/templates/scheduled/ts/package.json +5 -4
- package/templates/scheduled/ts/src/index.ts +15 -25
- package/templates/scheduled/ts/tsconfig.json +34 -95
- package/templates/scheduled/ts/wrangler.jsonc +13 -0
- package/templates/solid/c3.ts +63 -14
- package/templates/solid/templates/wrangler.jsonc +8 -0
- package/templates/svelte/c3.ts +6 -126
- package/templates/svelte/pages/c3.ts +160 -0
- package/templates/svelte/pages/templates/wrangler.jsonc +5 -0
- package/templates/svelte/workers/c3.ts +129 -0
- package/templates/svelte/workers/templates/static/.assetsignore +2 -0
- package/templates/svelte/workers/templates/wrangler.jsonc +12 -0
- package/templates/vue/c3.ts +5 -23
- package/templates/vue/pages/c3.ts +33 -0
- package/templates/vue/pages/templates/wrangler.jsonc +5 -0
- package/templates/vue/workers/c3.ts +98 -0
- package/templates/vue/workers/js/server/index.js +13 -0
- package/templates/vue/workers/js/src/App.vue +107 -0
- package/templates/vue/workers/js/src/components/HelloWorld.vue +47 -0
- package/templates/vue/workers/js/vite.config.js +21 -0
- package/templates/vue/workers/js/wrangler.jsonc +11 -0
- package/templates/vue/workers/ts/server/index.ts +12 -0
- package/templates/vue/workers/ts/src/App.vue +107 -0
- package/templates/vue/workers/ts/src/components/HelloWorld.vue +44 -0
- package/templates/vue/workers/ts/tsconfig.worker.json +8 -0
- package/templates/vue/workers/ts/vite.config.ts +21 -0
- package/templates/vue/workers/ts/wrangler.jsonc +11 -0
- package/templates-experimental/solid/c3.ts +94 -0
- package/templates-experimental/solid/templates/wrangler.jsonc +15 -0
- package/templates/angular/templates/server.ts +0 -34
- package/templates/angular/templates/tools/alter-polyfills.mjs +0 -27
- package/templates/angular/templates/tools/copy-files.mjs +0 -9
- package/templates/angular/templates/tools/paths.mjs +0 -9
- package/templates/common/js/wrangler.toml +0 -51
- package/templates/common/ts/worker-configuration.d.ts +0 -16
- package/templates/common/ts/wrangler.toml +0 -51
- package/templates/hello-world/js/wrangler.toml +0 -51
- package/templates/hello-world/ts/wrangler.toml +0 -51
- package/templates/hello-world-durable-object/js/wrangler.toml +0 -51
- package/templates/hello-world-durable-object/ts/wrangler.toml +0 -51
- package/templates/next/env.d.ts +0 -7
- package/templates/next/wrangler.toml +0 -57
- package/templates/nuxt/templates/wrangler.toml +0 -50
- package/templates/openapi/ts/wrangler.toml +0 -3
- package/templates/pre-existing/js/wrangler.toml +0 -3
- package/templates/queues/js/wrangler.toml +0 -19
- package/templates/queues/ts/wrangler.toml +0 -19
- package/templates/qwik/templates/worker-configuration.d.ts +0 -3
- package/templates/qwik/templates/wrangler.toml +0 -50
- package/templates/scheduled/js/wrangler.toml +0 -9
- package/templates/scheduled/ts/wrangler.toml +0 -9
- package/templates/solid/js/vite.config.js +0 -12
- package/templates/solid/ts/vite.config.ts +0 -12
- package/templates/svelte/js/src/hooks.server.js +0 -25
- package/templates/svelte/js/wrangler.toml +0 -50
- package/templates/svelte/ts/src/hooks.server.ts +0 -24
- package/templates/svelte/ts/wrangler.toml +0 -50
- /package/templates/angular/{templates → pages/templates}/src/_routes.json +0 -0
- /package/templates/next/{app → pages/app}/js/app/not-found.js +0 -0
- /package/templates/next/{app → pages/app}/ts/app/not-found.tsx +0 -0
- /package/templates/qwik/{snippets → pages/snippets}/getPlatformProxy.ts +0 -0
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { defineCloudflareConfig } from "@opennextjs/cloudflare";
|
|
2
|
+
|
|
3
|
+
export default defineCloudflareConfig({
|
|
4
|
+
// Uncomment to enable R2 cache,
|
|
5
|
+
// It should be imported as:
|
|
6
|
+
// `import r2IncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/r2-incremental-cache";`
|
|
7
|
+
// See https://opennext.js.org/cloudflare/caching for more details
|
|
8
|
+
// incrementalCache: r2IncrementalCache,
|
|
9
|
+
});
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "<app-name>",
|
|
3
|
+
"main": ".open-next/worker.js",
|
|
4
|
+
"compatibility_date": "2025-03-01",
|
|
5
|
+
"compatibility_flags": [
|
|
6
|
+
"nodejs_compat",
|
|
7
|
+
"global_fetch_strictly_public"
|
|
8
|
+
],
|
|
9
|
+
"assets": {
|
|
10
|
+
"binding": "ASSETS",
|
|
11
|
+
"directory": ".open-next/assets"
|
|
12
|
+
}
|
|
13
|
+
}
|
package/templates/nuxt/c3.ts
CHANGED
|
@@ -1,100 +1,9 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
3
|
-
import {
|
|
4
|
-
import { transformFile } from "helpers/codemod";
|
|
5
|
-
import { installPackages, runFrameworkGenerator } from "helpers/command";
|
|
6
|
-
import { writeFile } from "helpers/files";
|
|
7
|
-
import { detectPackageManager } from "helpers/packages";
|
|
8
|
-
import * as recast from "recast";
|
|
9
|
-
import type { TemplateConfig } from "../../src/templates";
|
|
10
|
-
import type { C3Context } from "types";
|
|
1
|
+
import pages from "./pages/c3";
|
|
2
|
+
import workers from "./workers/c3";
|
|
3
|
+
import type { MultiPlatformTemplateConfig } from "../../src/templates";
|
|
11
4
|
|
|
12
|
-
const
|
|
13
|
-
|
|
14
|
-
const generate = async (ctx: C3Context) => {
|
|
15
|
-
const gitFlag = ctx.args.git ? `--gitInit` : `--no-gitInit`;
|
|
16
|
-
|
|
17
|
-
await runFrameworkGenerator(ctx, [
|
|
18
|
-
"init",
|
|
19
|
-
ctx.project.name,
|
|
20
|
-
"--packageManager",
|
|
21
|
-
npm,
|
|
22
|
-
gitFlag,
|
|
23
|
-
]);
|
|
24
|
-
|
|
25
|
-
writeFile("./.node-version", "17");
|
|
26
|
-
|
|
27
|
-
logRaw(""); // newline
|
|
28
|
-
};
|
|
29
|
-
|
|
30
|
-
const configure = async () => {
|
|
31
|
-
await installPackages(["nitro-cloudflare-dev"], {
|
|
32
|
-
dev: true,
|
|
33
|
-
startText: "Installing nitro module `nitro-cloudflare-dev`",
|
|
34
|
-
doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
|
|
35
|
-
});
|
|
36
|
-
updateNuxtConfig();
|
|
37
|
-
};
|
|
38
|
-
|
|
39
|
-
const updateNuxtConfig = () => {
|
|
40
|
-
const s = spinner();
|
|
41
|
-
|
|
42
|
-
const configFile = "nuxt.config.ts";
|
|
43
|
-
s.start(`Updating \`${configFile}\``);
|
|
44
|
-
|
|
45
|
-
const b = recast.types.builders;
|
|
46
|
-
|
|
47
|
-
const presetDef = b.objectProperty(
|
|
48
|
-
b.identifier("nitro"),
|
|
49
|
-
b.objectExpression([
|
|
50
|
-
b.objectProperty(
|
|
51
|
-
b.identifier("preset"),
|
|
52
|
-
b.stringLiteral("cloudflare-pages")
|
|
53
|
-
),
|
|
54
|
-
])
|
|
55
|
-
);
|
|
56
|
-
|
|
57
|
-
const moduleDef = b.objectProperty(
|
|
58
|
-
b.identifier("modules"),
|
|
59
|
-
b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")])
|
|
60
|
-
);
|
|
61
|
-
|
|
62
|
-
transformFile(configFile, {
|
|
63
|
-
visitCallExpression: function (n) {
|
|
64
|
-
const callee = n.node.callee as recast.types.namedTypes.Identifier;
|
|
65
|
-
if (callee.name === "defineNuxtConfig") {
|
|
66
|
-
const obj = n.node
|
|
67
|
-
.arguments[0] as recast.types.namedTypes.ObjectExpression;
|
|
68
|
-
|
|
69
|
-
obj.properties.push(presetDef);
|
|
70
|
-
obj.properties.push(moduleDef);
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
return this.traverse(n);
|
|
74
|
-
},
|
|
75
|
-
});
|
|
76
|
-
|
|
77
|
-
s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
|
|
78
|
-
};
|
|
79
|
-
|
|
80
|
-
const config: TemplateConfig = {
|
|
81
|
-
configVersion: 1,
|
|
82
|
-
id: "nuxt",
|
|
83
|
-
platform: "pages",
|
|
84
|
-
copyFiles: {
|
|
85
|
-
path: "./templates",
|
|
86
|
-
},
|
|
5
|
+
const config: MultiPlatformTemplateConfig = {
|
|
87
6
|
displayName: "Nuxt",
|
|
88
|
-
|
|
89
|
-
deployScript: "deploy",
|
|
90
|
-
generate,
|
|
91
|
-
configure,
|
|
92
|
-
transformPackageJson: async () => ({
|
|
93
|
-
scripts: {
|
|
94
|
-
deploy: `${npm} run build && wrangler pages deploy ./dist`,
|
|
95
|
-
preview: `${npm} run build && wrangler pages dev ./dist`,
|
|
96
|
-
"build-cf-types": `wrangler types`,
|
|
97
|
-
},
|
|
98
|
-
}),
|
|
7
|
+
platformVariants: { pages, workers },
|
|
99
8
|
};
|
|
100
9
|
export default config;
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { logRaw } from "@cloudflare/cli";
|
|
2
|
+
import { brandColor, dim } from "@cloudflare/cli/colors";
|
|
3
|
+
import { spinner } from "@cloudflare/cli/interactive";
|
|
4
|
+
import { runFrameworkGenerator } from "frameworks/index";
|
|
5
|
+
import { mergeObjectProperties, transformFile } from "helpers/codemod";
|
|
6
|
+
import { writeFile } from "helpers/files";
|
|
7
|
+
import { detectPackageManager } from "helpers/packageManagers";
|
|
8
|
+
import { installPackages } from "helpers/packages";
|
|
9
|
+
import * as recast from "recast";
|
|
10
|
+
import type { TemplateConfig } from "../../../src/templates";
|
|
11
|
+
import type { C3Context } from "types";
|
|
12
|
+
|
|
13
|
+
const { npm, name: pm } = detectPackageManager();
|
|
14
|
+
|
|
15
|
+
const generate = async (ctx: C3Context) => {
|
|
16
|
+
const gitFlag = ctx.args.git ? `--gitInit` : `--no-gitInit`;
|
|
17
|
+
|
|
18
|
+
await runFrameworkGenerator(ctx, [
|
|
19
|
+
"init",
|
|
20
|
+
ctx.project.name,
|
|
21
|
+
"--packageManager",
|
|
22
|
+
npm,
|
|
23
|
+
"--no-install",
|
|
24
|
+
gitFlag,
|
|
25
|
+
]);
|
|
26
|
+
|
|
27
|
+
writeFile("./.node-version", "18");
|
|
28
|
+
|
|
29
|
+
logRaw(""); // newline
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
const configure = async () => {
|
|
33
|
+
const packages = ["nitro-cloudflare-dev"];
|
|
34
|
+
|
|
35
|
+
// When using pnpm, explicitly add h3 package so the H3Event type declaration can be updated.
|
|
36
|
+
// Package managers other than pnpm will hoist the dependency, as will pnpm with `--shamefully-hoist`
|
|
37
|
+
if (pm === "pnpm") {
|
|
38
|
+
packages.push("h3");
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
await installPackages(packages, {
|
|
42
|
+
dev: true,
|
|
43
|
+
startText: "Installing nitro module `nitro-cloudflare-dev`",
|
|
44
|
+
doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
|
|
45
|
+
});
|
|
46
|
+
updateNuxtConfig();
|
|
47
|
+
};
|
|
48
|
+
|
|
49
|
+
const updateNuxtConfig = () => {
|
|
50
|
+
const s = spinner();
|
|
51
|
+
|
|
52
|
+
const configFile = "nuxt.config.ts";
|
|
53
|
+
s.start(`Updating \`${configFile}\``);
|
|
54
|
+
|
|
55
|
+
const b = recast.types.builders;
|
|
56
|
+
|
|
57
|
+
const presetDef = b.objectProperty(
|
|
58
|
+
b.identifier("nitro"),
|
|
59
|
+
b.objectExpression([
|
|
60
|
+
b.objectProperty(
|
|
61
|
+
b.identifier("preset"),
|
|
62
|
+
b.stringLiteral("cloudflare-pages"),
|
|
63
|
+
),
|
|
64
|
+
b.objectProperty(
|
|
65
|
+
b.identifier("cloudflare"),
|
|
66
|
+
b.objectExpression([
|
|
67
|
+
b.objectProperty(
|
|
68
|
+
b.identifier("deployConfig"),
|
|
69
|
+
b.booleanLiteral(true),
|
|
70
|
+
),
|
|
71
|
+
b.objectProperty(b.identifier("nodeCompat"), b.booleanLiteral(true)),
|
|
72
|
+
]),
|
|
73
|
+
),
|
|
74
|
+
]),
|
|
75
|
+
);
|
|
76
|
+
|
|
77
|
+
const moduleDef = b.objectProperty(
|
|
78
|
+
b.identifier("modules"),
|
|
79
|
+
b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")]),
|
|
80
|
+
);
|
|
81
|
+
|
|
82
|
+
transformFile(configFile, {
|
|
83
|
+
visitCallExpression: function (n) {
|
|
84
|
+
const callee = n.node.callee as recast.types.namedTypes.Identifier;
|
|
85
|
+
if (callee.name === "defineNuxtConfig") {
|
|
86
|
+
mergeObjectProperties(
|
|
87
|
+
n.node.arguments[0] as recast.types.namedTypes.ObjectExpression,
|
|
88
|
+
[presetDef, moduleDef],
|
|
89
|
+
);
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
return this.traverse(n);
|
|
93
|
+
},
|
|
94
|
+
});
|
|
95
|
+
|
|
96
|
+
s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
|
|
97
|
+
};
|
|
98
|
+
|
|
99
|
+
const config: TemplateConfig = {
|
|
100
|
+
configVersion: 1,
|
|
101
|
+
id: "nuxt",
|
|
102
|
+
frameworkCli: "nuxi",
|
|
103
|
+
platform: "pages",
|
|
104
|
+
hidden: true,
|
|
105
|
+
displayName: "Nuxt",
|
|
106
|
+
copyFiles: {
|
|
107
|
+
path: "./templates",
|
|
108
|
+
},
|
|
109
|
+
path: "templates/nuxt/pages",
|
|
110
|
+
generate,
|
|
111
|
+
configure,
|
|
112
|
+
transformPackageJson: async () => ({
|
|
113
|
+
scripts: {
|
|
114
|
+
deploy: `${npm} run build && wrangler pages deploy`,
|
|
115
|
+
preview: `${npm} run build && wrangler pages dev`,
|
|
116
|
+
"cf-typegen": `wrangler types`,
|
|
117
|
+
},
|
|
118
|
+
}),
|
|
119
|
+
devScript: "dev",
|
|
120
|
+
deployScript: "deploy",
|
|
121
|
+
previewScript: "preview",
|
|
122
|
+
};
|
|
123
|
+
export default config;
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
import { logRaw } from "@cloudflare/cli";
|
|
2
|
+
import { brandColor, dim } from "@cloudflare/cli/colors";
|
|
3
|
+
import { spinner } from "@cloudflare/cli/interactive";
|
|
4
|
+
import { runFrameworkGenerator } from "frameworks/index";
|
|
5
|
+
import { mergeObjectProperties, transformFile } from "helpers/codemod";
|
|
6
|
+
import { writeFile } from "helpers/files";
|
|
7
|
+
import { detectPackageManager } from "helpers/packageManagers";
|
|
8
|
+
import { installPackages } from "helpers/packages";
|
|
9
|
+
import * as recast from "recast";
|
|
10
|
+
import type { TemplateConfig } from "../../../src/templates";
|
|
11
|
+
import type { C3Context } from "types";
|
|
12
|
+
|
|
13
|
+
const { npm, name: pm } = detectPackageManager();
|
|
14
|
+
|
|
15
|
+
const generate = async (ctx: C3Context) => {
|
|
16
|
+
const gitFlag = ctx.args.git ? `--gitInit` : `--no-gitInit`;
|
|
17
|
+
|
|
18
|
+
await runFrameworkGenerator(ctx, [
|
|
19
|
+
"init",
|
|
20
|
+
ctx.project.name,
|
|
21
|
+
"--packageManager",
|
|
22
|
+
npm,
|
|
23
|
+
"--no-install",
|
|
24
|
+
gitFlag,
|
|
25
|
+
]);
|
|
26
|
+
|
|
27
|
+
writeFile("./.node-version", "18");
|
|
28
|
+
|
|
29
|
+
logRaw(""); // newline
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
const configure = async () => {
|
|
33
|
+
const packages = ["nitro-cloudflare-dev", "nitropack"];
|
|
34
|
+
|
|
35
|
+
// When using pnpm, explicitly add h3 package so the H3Event type declaration can be updated.
|
|
36
|
+
// Package managers other than pnpm will hoist the dependency, as will pnpm with `--shamefully-hoist`
|
|
37
|
+
if (pm === "pnpm") {
|
|
38
|
+
packages.push("h3");
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
await installPackages(packages, {
|
|
42
|
+
dev: true,
|
|
43
|
+
startText: "Installing nitro module `nitro-cloudflare-dev`",
|
|
44
|
+
doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
|
|
45
|
+
});
|
|
46
|
+
updateNuxtConfig();
|
|
47
|
+
};
|
|
48
|
+
|
|
49
|
+
const updateNuxtConfig = () => {
|
|
50
|
+
const s = spinner();
|
|
51
|
+
|
|
52
|
+
const configFile = "nuxt.config.ts";
|
|
53
|
+
s.start(`Updating \`${configFile}\``);
|
|
54
|
+
|
|
55
|
+
const b = recast.types.builders;
|
|
56
|
+
|
|
57
|
+
const presetDef = b.objectProperty(
|
|
58
|
+
b.identifier("nitro"),
|
|
59
|
+
b.objectExpression([
|
|
60
|
+
b.objectProperty(
|
|
61
|
+
b.identifier("preset"),
|
|
62
|
+
b.stringLiteral("cloudflare_module"),
|
|
63
|
+
),
|
|
64
|
+
b.objectProperty(
|
|
65
|
+
b.identifier("cloudflare"),
|
|
66
|
+
b.objectExpression([
|
|
67
|
+
b.objectProperty(
|
|
68
|
+
b.identifier("deployConfig"),
|
|
69
|
+
b.booleanLiteral(true),
|
|
70
|
+
),
|
|
71
|
+
b.objectProperty(b.identifier("nodeCompat"), b.booleanLiteral(true)),
|
|
72
|
+
]),
|
|
73
|
+
),
|
|
74
|
+
]),
|
|
75
|
+
);
|
|
76
|
+
|
|
77
|
+
const moduleDef = b.objectProperty(
|
|
78
|
+
b.identifier("modules"),
|
|
79
|
+
b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")]),
|
|
80
|
+
);
|
|
81
|
+
|
|
82
|
+
transformFile(configFile, {
|
|
83
|
+
visitCallExpression: function (n) {
|
|
84
|
+
const callee = n.node.callee as recast.types.namedTypes.Identifier;
|
|
85
|
+
if (callee.name === "defineNuxtConfig") {
|
|
86
|
+
mergeObjectProperties(
|
|
87
|
+
n.node.arguments[0] as recast.types.namedTypes.ObjectExpression,
|
|
88
|
+
[presetDef, moduleDef],
|
|
89
|
+
);
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
return this.traverse(n);
|
|
93
|
+
},
|
|
94
|
+
});
|
|
95
|
+
|
|
96
|
+
s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
|
|
97
|
+
};
|
|
98
|
+
|
|
99
|
+
const config: TemplateConfig = {
|
|
100
|
+
configVersion: 1,
|
|
101
|
+
id: "nuxt",
|
|
102
|
+
frameworkCli: "nuxi",
|
|
103
|
+
platform: "workers",
|
|
104
|
+
displayName: "Nuxt",
|
|
105
|
+
copyFiles: {
|
|
106
|
+
path: "./templates",
|
|
107
|
+
},
|
|
108
|
+
path: "templates/nuxt/workers",
|
|
109
|
+
generate,
|
|
110
|
+
configure,
|
|
111
|
+
transformPackageJson: async () => ({
|
|
112
|
+
scripts: {
|
|
113
|
+
deploy: `${npm} run build && wrangler deploy`,
|
|
114
|
+
preview: `${npm} run build && wrangler dev`,
|
|
115
|
+
"cf-typegen": `wrangler types`,
|
|
116
|
+
},
|
|
117
|
+
}),
|
|
118
|
+
devScript: "dev",
|
|
119
|
+
deployScript: "deploy",
|
|
120
|
+
previewScript: "preview",
|
|
121
|
+
};
|
|
122
|
+
export default config;
|
package/templates/openapi/c3.ts
CHANGED
|
@@ -1,9 +1,14 @@
|
|
|
1
|
-
|
|
1
|
+
import type { TemplateConfig } from "../../src/templates";
|
|
2
|
+
|
|
3
|
+
const config: TemplateConfig = {
|
|
2
4
|
configVersion: 1,
|
|
3
5
|
id: "openapi",
|
|
4
6
|
displayName: "API starter (OpenAPI compliant)",
|
|
7
|
+
description: "Get started building a basic API on Workers",
|
|
5
8
|
platform: "workers",
|
|
6
9
|
copyFiles: {
|
|
7
10
|
path: "./ts",
|
|
8
11
|
},
|
|
9
12
|
};
|
|
13
|
+
|
|
14
|
+
export default config;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Cloudflare Workers OpenAPI 3.1
|
|
2
2
|
|
|
3
|
-
This is a Cloudflare Worker with OpenAPI 3.1 using [
|
|
3
|
+
This is a Cloudflare Worker with OpenAPI 3.1 using [chanfana](https://github.com/cloudflare/chanfana) and [Hono](https://github.com/honojs/hono).
|
|
4
4
|
|
|
5
5
|
This is an example project made to be used as a quick start into building OpenAPI compliant Workers that generates the
|
|
6
6
|
`openapi.json` schema automatically from code and validates the incoming request to the defined parameters or request body.
|
|
@@ -16,10 +16,10 @@ This is an example project made to be used as a quick start into building OpenAP
|
|
|
16
16
|
|
|
17
17
|
1. Your main router is defined in `src/index.ts`.
|
|
18
18
|
2. Each endpoint has its own file in `src/endpoints/`.
|
|
19
|
-
3. For more information read the [
|
|
19
|
+
3. For more information read the [chanfana documentation](https://chanfana.pages.dev/) and [Hono documentation](https://hono.dev/docs).
|
|
20
20
|
|
|
21
21
|
## Development
|
|
22
22
|
|
|
23
23
|
1. Run `wrangler dev` to start a local instance of the API.
|
|
24
|
-
2. Open `http://localhost:
|
|
24
|
+
2. Open `http://localhost:8787/` in your browser to see the Swagger interface where you can try the endpoints.
|
|
25
25
|
3. Changes made in the `src/` folder will automatically trigger the server to reload, you only need to refresh the Swagger interface.
|
|
@@ -5,14 +5,18 @@
|
|
|
5
5
|
"scripts": {
|
|
6
6
|
"deploy": "wrangler deploy",
|
|
7
7
|
"dev": "wrangler dev",
|
|
8
|
-
"start": "wrangler dev"
|
|
8
|
+
"start": "wrangler dev",
|
|
9
|
+
"cf-typegen": "wrangler types"
|
|
9
10
|
},
|
|
10
11
|
"dependencies": {
|
|
11
|
-
"
|
|
12
|
+
"chanfana": "^2.6.3",
|
|
13
|
+
"hono": "^4.6.20",
|
|
14
|
+
"zod": "^3.24.1"
|
|
12
15
|
},
|
|
13
16
|
"devDependencies": {
|
|
14
|
-
"@types
|
|
15
|
-
"@types/
|
|
16
|
-
"
|
|
17
|
+
"@cloudflare/workers-types": "^4.20250129.0",
|
|
18
|
+
"@types/node": "22.13.0",
|
|
19
|
+
"@types/service-worker-mock": "^2.0.4",
|
|
20
|
+
"wrangler": "^3.107.2"
|
|
17
21
|
}
|
|
18
22
|
}
|
|
@@ -1,33 +1,43 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
} from "@cloudflare/itty-router-openapi";
|
|
5
|
-
import { Task } from "../types";
|
|
1
|
+
import { Bool, OpenAPIRoute } from "chanfana";
|
|
2
|
+
import { z } from "zod";
|
|
3
|
+
import { type AppContext, Task } from "../types";
|
|
6
4
|
|
|
7
5
|
export class TaskCreate extends OpenAPIRoute {
|
|
8
|
-
|
|
6
|
+
schema = {
|
|
9
7
|
tags: ["Tasks"],
|
|
10
8
|
summary: "Create a new Task",
|
|
11
|
-
|
|
9
|
+
request: {
|
|
10
|
+
body: {
|
|
11
|
+
content: {
|
|
12
|
+
"application/json": {
|
|
13
|
+
schema: Task,
|
|
14
|
+
},
|
|
15
|
+
},
|
|
16
|
+
},
|
|
17
|
+
},
|
|
12
18
|
responses: {
|
|
13
19
|
"200": {
|
|
14
20
|
description: "Returns the created task",
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
21
|
+
content: {
|
|
22
|
+
"application/json": {
|
|
23
|
+
schema: z.object({
|
|
24
|
+
series: z.object({
|
|
25
|
+
success: Bool(),
|
|
26
|
+
result: z.object({
|
|
27
|
+
task: Task,
|
|
28
|
+
}),
|
|
29
|
+
}),
|
|
30
|
+
}),
|
|
19
31
|
},
|
|
20
32
|
},
|
|
21
33
|
},
|
|
22
34
|
},
|
|
23
35
|
};
|
|
24
36
|
|
|
25
|
-
async handle(
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
data: Record<string, any>
|
|
30
|
-
) {
|
|
37
|
+
async handle(c: AppContext) {
|
|
38
|
+
// Get validated data
|
|
39
|
+
const data = await this.getValidatedData<typeof this.schema>();
|
|
40
|
+
|
|
31
41
|
// Retrieve the validated request body
|
|
32
42
|
const taskToCreate = data.body;
|
|
33
43
|
|
|
@@ -1,38 +1,39 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
Path,
|
|
5
|
-
} from "@cloudflare/itty-router-openapi";
|
|
6
|
-
import { Task } from "../types";
|
|
1
|
+
import { Bool, OpenAPIRoute, Str } from "chanfana";
|
|
2
|
+
import { z } from "zod";
|
|
3
|
+
import { type AppContext, Task } from "../types";
|
|
7
4
|
|
|
8
5
|
export class TaskDelete extends OpenAPIRoute {
|
|
9
|
-
|
|
6
|
+
schema = {
|
|
10
7
|
tags: ["Tasks"],
|
|
11
8
|
summary: "Delete a Task",
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
description: "Task slug",
|
|
9
|
+
request: {
|
|
10
|
+
params: z.object({
|
|
11
|
+
taskSlug: Str({ description: "Task slug" }),
|
|
15
12
|
}),
|
|
16
13
|
},
|
|
17
14
|
responses: {
|
|
18
15
|
"200": {
|
|
19
16
|
description: "Returns if the task was deleted successfully",
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
17
|
+
content: {
|
|
18
|
+
"application/json": {
|
|
19
|
+
schema: z.object({
|
|
20
|
+
series: z.object({
|
|
21
|
+
success: Bool(),
|
|
22
|
+
result: z.object({
|
|
23
|
+
task: Task,
|
|
24
|
+
}),
|
|
25
|
+
}),
|
|
26
|
+
}),
|
|
24
27
|
},
|
|
25
28
|
},
|
|
26
29
|
},
|
|
27
30
|
},
|
|
28
31
|
};
|
|
29
32
|
|
|
30
|
-
async handle(
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
data: Record<string, any>
|
|
35
|
-
) {
|
|
33
|
+
async handle(c: AppContext) {
|
|
34
|
+
// Get validated data
|
|
35
|
+
const data = await this.getValidatedData<typeof this.schema>();
|
|
36
|
+
|
|
36
37
|
// Retrieve the validated slug
|
|
37
38
|
const { taskSlug } = data.params;
|
|
38
39
|
|