create-cloudflare 0.0.0-9c15b6ea2 → 0.0.0-9c30aecaa

package/templates/hello-world-workflows/ts/src/index.ts

@@ -0,0 +1,111 @@
+import {
+	WorkflowEntrypoint,
+	WorkflowEvent,
+	WorkflowStep,
+} from "cloudflare:workers";
+
+/**
+ * Welcome to Cloudflare Workers! This is your first Workflows application.
+ *
+ * - Run `npm run dev` in your terminal to start a development server
+ * - Open a browser tab at http://localhost:8787/ to see your Workflow in action
+ * - Run `npm run deploy` to publish your application
+ *
+ * Learn more at https://developers.cloudflare.com/workflows
+ */
+ 
+// User-defined params passed to your Workflow
+type Params = {
+	email: string;
+	metadata: Record<string, string>;
+};
+
+export class MyWorkflow extends WorkflowEntrypoint<Env, Params> {
+	async run(event: WorkflowEvent<Params>, step: WorkflowStep) {
+		// Can access bindings on `this.env`
+		// Can access params on `event.payload`
+
+		const files = await step.do("my first step", async () => {
+			// Fetch a list of files from $SOME_SERVICE
+			return {
+				inputParams: event,
+				files: [
+					"doc_7392_rev3.pdf",
+					"report_x29_final.pdf",
+					"memo_2024_05_12.pdf",
+					"file_089_update.pdf",
+					"proj_alpha_v2.pdf",
+					"data_analysis_q2.pdf",
+					"notes_meeting_52.pdf",
+					"summary_fy24_draft.pdf",
+				],
+			};
+		});
+
+		// You can optionally have a Workflow wait for additional data,
+		// human approval or an external webhook or HTTP request, before progressing.
+		// You can submit data via HTTP POST to /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/events/{eventName}
+		const waitForApproval = await step.waitForEvent("request-approval", {
+			type: "approval", // define an optional key to switch on
+			timeout: "1 minute", // keep it short for the example!
+		});
+
+		const apiResponse = await step.do("some other step", async () => {
+			let resp = await fetch("https://api.cloudflare.com/client/v4/ips");
+			return await resp.json<any>();
+		});
+
+		await step.sleep("wait on something", "1 minute");
+
+		await step.do(
+			"make a call to write that could maybe, just might, fail",
+			// Define a retry strategy
+			{
+				retries: {
+					limit: 5,
+					delay: "5 second",
+					backoff: "exponential",
+				},
+				timeout: "15 minutes",
+			},
+			async () => {
+				// Do stuff here, with access to the state from our previous steps
+				if (Math.random() > 0.5) {
+					throw new Error("API call to $STORAGE_SYSTEM failed");
+				}
+			},
+		);
+	}
+}
+export default {
+	async fetch(req: Request, env: Env): Promise<Response> {
+		let url = new URL(req.url);
+
+		if (url.pathname.startsWith("/favicon")) {
+			return Response.json({}, { status: 404 });
+		}
+
+		// Get the status of an existing instance, if provided
+		// GET /?instanceId=<id here>
+		let id = url.searchParams.get("instanceId");
+		if (id) {
+			let instance = await env.MY_WORKFLOW.get(id);
+			return Response.json({
+				status: await instance.status(),
+			});
+		}
+
+		// Spawn a new instance and return the ID and status
+		let instance = await env.MY_WORKFLOW.create();
+		// You can also set the ID to match an ID in your own system
+		// and pass an optional payload to the Workflow
+		// let instance = await env.MY_WORKFLOW.create({
+		// 	id: 'id-from-your-system',
+		// 	params: { payload: 'to send' },
+		// });
+		return Response.json({
+			id: instance.id,
+			details: await instance.status(),
+		});
+	},
+};

package/templates/hello-world-workflows/ts/tsconfig.json

@@ -0,0 +1,40 @@
+{
+	"compilerOptions": {
+		/* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+		/* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+		"target": "es2021",
+		/* Specify a set of bundled library declaration files that describe the target runtime environment. */
+		"lib": ["es2021"],
+		/* Specify what JSX code is generated. */
+		"jsx": "react-jsx",
+
+		/* Specify what module code is generated. */
+		"module": "es2022",
+		/* Specify how TypeScript looks up a file from a given module specifier. */
+		"moduleResolution": "node",
+		/* Enable importing .json files */
+		"resolveJsonModule": true,
+
+		/* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+		"allowJs": true,
+		/* Enable error reporting in type-checked JavaScript files. */
+		"checkJs": false,
+
+		/* Disable emitting files from a compilation. */
+		"noEmit": true,
+
+		/* Ensure that each file can be safely transpiled without relying on other imports. */
+		"isolatedModules": true,
+		/* Allow 'import x from y' when a module doesn't have a default export. */
+		"allowSyntheticDefaultImports": true,
+		/* Ensure that casing is correct in imports. */
+		"forceConsistentCasingInFileNames": true,
+
+		/* Enable all strict type-checking options. */
+		"strict": true,
+
+		/* Skip type checking all .d.ts files. */
+		"skipLibCheck": true
+	}
+}

package/templates/hello-world-workflows/ts/wrangler.jsonc

@@ -0,0 +1,17 @@
+{
+	"name": "<TBD>",
+	"main": "src/index.ts",
+	"compatibility_date": "<TBD>",
+
+	"observability": {
+		"enabled": true,
+		"head_sampling_rate": 1,
+	},
+	"workflows": [
+		{
+			"name": "<TBD>",
+			"binding": "MY_WORKFLOW",
+			"class_name": "MyWorkflow",
+		},
+	],
+}

package/templates/hono/pages/c3.ts

@@ -19,6 +19,8 @@ const generate = async (ctx: C3Context) => {
 	logRaw(""); // newline
 };
 
+const envInterfaceName = "CloudflareBindings";
+
 const config: TemplateConfig = {
 	configVersion: 1,
 	id: "hono",
@@ -33,12 +35,13 @@ const config: TemplateConfig = {
 	generate,
 	transformPackageJson: async () => ({
 		scripts: {
-			"cf-typegen": "wrangler types --env-interface CloudflareBindings",
+			"cf-typegen": `wrangler types --env-interface ${envInterfaceName}`,
 			preview: "vite build && wrangler pages dev",
 		},
 	}),
 	devScript: "dev",
 	deployScript: "deploy",
 	previewScript: "preview",
+	envInterfaceName,
 };
 export default config;

package/templates/hono/workers/c3.ts

@@ -19,6 +19,7 @@ const generate = async (ctx: C3Context) => {
 	logRaw(""); // newline
 };
 
+const envInterfaceName = "CloudflareBindings";
 const config: TemplateConfig = {
 	configVersion: 1,
 	id: "hono",
@@ -32,11 +33,12 @@ const config: TemplateConfig = {
 	generate,
 	transformPackageJson: async () => ({
 		scripts: {
-			"cf-typegen": "wrangler types --env-interface CloudflareBindings",
+			"cf-typegen": `wrangler types --env-interface ${envInterfaceName}`,
 		},
 	}),
 	devScript: "dev",
 	deployScript: "deploy",
 	previewScript: "dev",
+	envInterfaceName,
 };
 export default config;

package/templates/next/pages/c3.ts

@@ -75,14 +75,6 @@ const configure = async (ctx: C3Context) => {
 
 	const usesTs = usesTypescript(ctx);
 
-	if (usesTs) {
-		copyFile(
-			join(getTemplatePath(ctx), "env.d.ts"),
-			join(projectPath, "env.d.ts"),
-		);
-		updateStatus("Created an env.d.ts file");
-	}
-
 	const installEslintPlugin = await shouldInstallNextOnPagesEslintPlugin(ctx);
 
 	if (installEslintPlugin) {
@@ -145,7 +137,6 @@ export const writeEslintrc = async (ctx: C3Context): Promise<void> => {
 const addDevDependencies = async (installEslintPlugin: boolean) => {
 	const packages = [
 		"@cloudflare/next-on-pages@1",
-		"@cloudflare/workers-types",
 		"vercel",
 		...(installEslintPlugin ? ["eslint-plugin-next-on-pages"] : []),
 	];
@@ -156,6 +147,9 @@ const addDevDependencies = async (installEslintPlugin: boolean) => {
 	});
 };
 
+const envInterfaceName = "CloudflareEnv";
+const typesPath = "./env.d.ts";
+
 export default {
 	configVersion: 1,
 	id: "next",
@@ -213,7 +207,7 @@ export default {
 				preview: `${pagesBuildRunCommand} && wrangler pages dev`,
 				deploy: `${pagesBuildRunCommand} && wrangler pages deploy`,
 				...(usesTypescript(ctx) && {
-					"cf-typegen": `wrangler types --env-interface CloudflareEnv env.d.ts`,
+					"cf-typegen": `wrangler types --env-interface ${envInterfaceName} ${typesPath}`,
 				}),
 			},
 		};
@@ -222,4 +216,6 @@ export default {
 	previewScript: "preview",
 	deployScript: "deploy",
 	compatibilityFlags: ["nodejs_compat"],
+	typesPath,
+	envInterfaceName,
 } as TemplateConfig;

package/templates/next/workers/c3.ts

@@ -11,7 +11,7 @@ const generate = async (ctx: C3Context) => {
 };
 
 const configure = async (ctx: C3Context) => {
-	await installPackages(["@opennextjs/cloudflare@~1.0.0-beta.0 || ^1.0.0"], {
+	await installPackages(["@opennextjs/cloudflare@^1.0.2"], {
 		startText: "Adding the Cloudflare adapter",
 		doneText: `${brandColor(`installed`)} @opennextjs/cloudflare)}`,
 	});
@@ -42,13 +42,14 @@ const updateNextConfig = (usesTs: boolean) => {
 	s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
 };
 
+const envInterfaceName = "CloudflareEnv";
+const typesPath = "./cloudflare-env.d.ts";
 export default {
 	configVersion: 1,
 	id: "next",
 	frameworkCli: "create-next-app",
-	frameworkCliPinnedVersion: "~15.3.0",
 	platform: "workers",
-	displayName: "Next.js (using Node.js compat + Workers Assets)",
+	displayName: "Next.js",
 	path: "templates/next/workers",
 	copyFiles: {
 		path: "./templates",
@@ -59,11 +60,12 @@ export default {
 		scripts: {
 			deploy: `opennextjs-cloudflare build && opennextjs-cloudflare deploy`,
 			preview: `opennextjs-cloudflare build && opennextjs-cloudflare preview`,
-			"cf-typegen": `wrangler types --env-interface CloudflareEnv cloudflare-env.d.ts`,
+			"cf-typegen": `wrangler types --env-interface ${envInterfaceName} ${typesPath}`,
 		},
 	}),
 	devScript: "dev",
 	previewScript: "preview",
 	deployScript: "deploy",
-	compatibilityFlags: ["nodejs_compat"],
+	typesPath,
+	envInterfaceName,
 } as TemplateConfig;

package/templates/next/workers/templates/public/_headers

@@ -0,0 +1,3 @@
+# https://developers.cloudflare.com/workers/static-assets/headers
+/_next/static/*
+  Cache-Control: public,max-age=31536000,immutable

package/templates/nuxt/pages/c3.ts

@@ -3,8 +3,7 @@ import { brandColor, dim } from "@cloudflare/cli/colors";
 import { spinner } from "@cloudflare/cli/interactive";
 import { runFrameworkGenerator } from "frameworks/index";
 import { mergeObjectProperties, transformFile } from "helpers/codemod";
-import { getLatestTypesEntrypoint } from "helpers/compatDate";
-import { readFile, writeFile } from "helpers/files";
+import { writeFile } from "helpers/files";
 import { detectPackageManager } from "helpers/packageManagers";
 import { installPackages } from "helpers/packages";
 import * as recast from "recast";
@@ -30,7 +29,7 @@ const generate = async (ctx: C3Context) => {
 	logRaw(""); // newline
 };
 
-const configure = async (ctx: C3Context) => {
+const configure = async () => {
 	const packages = ["nitro-cloudflare-dev"];
 
 	// When using pnpm, explicitly add h3 package so the H3Event type declaration can be updated.
@@ -45,29 +44,6 @@ const configure = async (ctx: C3Context) => {
 		doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
 	});
 	updateNuxtConfig();
-
-	updateEnvTypes(ctx);
-};
-
-const updateEnvTypes = (ctx: C3Context) => {
-	const filepath = "env.d.ts";
-
-	const s = spinner();
-	s.start(`Updating ${filepath}`);
-
-	let file = readFile(filepath);
-
-	let typesEntrypoint = `@cloudflare/workers-types`;
-	const latestEntrypoint = getLatestTypesEntrypoint(ctx);
-	if (latestEntrypoint) {
-		typesEntrypoint += `/${latestEntrypoint}`;
-	}
-
-	// Replace placeholder with actual types entrypoint
-	file = file.replace("WORKERS_TYPES_ENTRYPOINT", typesEntrypoint);
-	writeFile("env.d.ts", file);
-
-	s.stop(`${brandColor(`updated`)} ${dim(`\`${filepath}\``)}`);
 };
 
 const updateNuxtConfig = () => {

package/templates/nuxt/pages/templates/env.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="WORKERS_TYPES_ENTRYPOINT" />
+/// <reference types="./worker-configuration.d.ts" />
 
 declare module "h3" {
   interface H3EventContext {

package/templates/nuxt/workers/c3.ts

@@ -3,8 +3,7 @@ import { brandColor, dim } from "@cloudflare/cli/colors";
 import { spinner } from "@cloudflare/cli/interactive";
 import { runFrameworkGenerator } from "frameworks/index";
 import { mergeObjectProperties, transformFile } from "helpers/codemod";
-import { getLatestTypesEntrypoint } from "helpers/compatDate";
-import { readFile, writeFile } from "helpers/files";
+import { writeFile } from "helpers/files";
 import { detectPackageManager } from "helpers/packageManagers";
 import { installPackages } from "helpers/packages";
 import * as recast from "recast";
@@ -30,7 +29,7 @@ const generate = async (ctx: C3Context) => {
 	logRaw(""); // newline
 };
 
-const configure = async (ctx: C3Context) => {
+const configure = async () => {
 	const packages = ["nitro-cloudflare-dev", "nitropack"];
 
 	// When using pnpm, explicitly add h3 package so the H3Event type declaration can be updated.
@@ -45,29 +44,6 @@ const configure = async (ctx: C3Context) => {
 		doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
 	});
 	updateNuxtConfig();
-
-	updateEnvTypes(ctx);
-};
-
-const updateEnvTypes = (ctx: C3Context) => {
-	const filepath = "env.d.ts";
-
-	const s = spinner();
-	s.start(`Updating ${filepath}`);
-
-	let file = readFile(filepath);
-
-	let typesEntrypoint = `@cloudflare/workers-types`;
-	const latestEntrypoint = getLatestTypesEntrypoint(ctx);
-	if (latestEntrypoint) {
-		typesEntrypoint += `/${latestEntrypoint}`;
-	}
-
-	// Replace placeholder with actual types entrypoint
-	file = file.replace("WORKERS_TYPES_ENTRYPOINT", typesEntrypoint);
-	writeFile("env.d.ts", file);
-
-	s.stop(`${brandColor(`updated`)} ${dim(`\`${filepath}\``)}`);
 };
 
 const updateNuxtConfig = () => {

package/templates/nuxt/workers/templates/env.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="WORKERS_TYPES_ENTRYPOINT" />
+/// <reference types="./worker-configuration.d.ts" />
 
 declare module "h3" {
   interface H3EventContext {

package/templates/openapi/ts/tsconfig.json

@@ -22,7 +22,6 @@
 		"types": [
 			"@types/node",
 			"@types/service-worker-mock",
-			"@cloudflare/workers-types"
 		]
 	},
 	"exclude": ["node_modules", "dist", "tests"],

package/templates/queues/ts/tsconfig.json

@@ -13,8 +13,6 @@
 		"module": "es2022",
     /* Specify how TypeScript looks up a file from a given module specifier. */
 		"moduleResolution": "node",
-    /* Specify type package names to be included without being referenced in a source file. */
-		"types": ["@cloudflare/workers-types"],
     /* Enable importing .json files */
 		"resolveJsonModule": true,
 

package/templates/qwik/pages/c3.ts

@@ -146,5 +146,6 @@ const config: TemplateConfig = {
 	devScript: "dev",
 	deployScript: "deploy",
 	previewScript: "preview",
+	workersTypes: "installed",
 };
 export default config;

package/templates/qwik/workers/c3.ts

@@ -148,5 +148,6 @@ const config: TemplateConfig = {
 	devScript: "dev",
 	deployScript: "deploy",
 	previewScript: "preview",
+	workersTypes: "installed",
 };
 export default config;

package/templates/qwik/workers/templates/wrangler.jsonc

@@ -3,7 +3,8 @@
   "main": "./dist/_worker.js",
   "compatibility_date": "<TBD>",
   "compatibility_flags": [
-    "nodejs_compat"
+    "nodejs_compat",
+    "global_fetch_strictly_public"
   ],
   "assets": {
     "binding": "ASSET",

package/templates/react/pages/c3.ts

@@ -49,11 +49,13 @@ const config: TemplateConfig = {
 	platform: "pages",
 	hidden: true,
 	path: "templates/react/pages",
+	copyFiles: { path: "./templates" },
 	generate,
 	transformPackageJson: async () => ({
 		scripts: {
-			deploy: `${npm} run build && wrangler pages deploy ./dist`,
-			preview: `${npm} run build && wrangler pages dev ./dist`,
+			deploy: `${npm} run build && wrangler pages deploy`,
+			preview: `${npm} run build && wrangler pages dev`,
+			"cf-typegen": `wrangler types`,
 		},
 	}),
 	devScript: "dev",

package/templates/react/pages/templates/wrangler.jsonc

@@ -0,0 +1,5 @@
+{
+	"name": "<TBD>",
+	"compatibility_date": "<TBD>",
+	"pages_build_output_dir": "./dist"
+  }

package/templates/react/workers/ts/tsconfig.worker.json

@@ -2,7 +2,7 @@
   "extends": "./tsconfig.node.json",
   "compilerOptions": {
     "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.worker.tsbuildinfo",
-    "types": ["@cloudflare/workers-types/2023-07-01", "vite/client"]
+    "types": ["./worker-configuration.d.ts", "vite/client"],
   },
   "include": ["./worker-configuration.d.ts", "./worker"]
 }

package/templates/react-router/c3.ts

@@ -19,24 +19,12 @@ const generate = async (ctx: C3Context) => {
 	logRaw(""); // newline
 };
 
-// TODO: Uncomment this once @react-router/dev updates its peer dependency to Wrangler v4
-// const configure = async () => {
-// 	await installPackages(["wrangler@latest"], {
-// 		dev: true,
-// 		startText: "Updating the Wrangler version",
-// 		doneText: `${brandColor(`updated`)} ${dim("wrangler@latest")}`,
-// 	});
-// };
-
 const config: TemplateConfig = {
 	configVersion: 1,
 	id: "react-router",
 	platform: "workers",
 	frameworkCli: "create-react-router",
 	displayName: "React Router (formerly Remix)",
-	copyFiles: {
-		path: "./templates",
-	},
 	generate,
 	// configure,
 	transformPackageJson: async () => ({

package/templates/remix/pages/c3.ts

@@ -65,5 +65,6 @@ const config: TemplateConfig = {
 	devScript: "dev",
 	deployScript: "deploy",
 	previewScript: "preview",
+	workersTypes: "installed",
 };
 export default config;

package/templates/remix/pages/templates/worker-configuration.d.ts

@@ -1,4 +1,4 @@
 // Generated by Wrangler
-// After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
+// After adding bindings to `wrangler.toml`, regenerate this interface via `npm run cf-typegen`
 interface Env {
 }

package/templates/remix/workers/c3.ts

@@ -48,5 +48,6 @@ const config: TemplateConfig = {
 	devScript: "dev",
 	deployScript: "deploy",
 	previewScript: "preview",
+	workersTypes: "installed",
 };
 export default config;

package/templates/scheduled/ts/tsconfig.json

@@ -13,8 +13,6 @@
 		"module": "es2022",
     /* Specify how TypeScript looks up a file from a given module specifier. */
 		"moduleResolution": "node",
-    /* Specify type package names to be included without being referenced in a source file. */
-		"types": ["@cloudflare/workers-types"],
     /* Enable importing .json files */
 		"resolveJsonModule": true,
 

package/templates/solid/c3.ts

@@ -77,6 +77,7 @@ const config: TemplateConfig = {
 		scripts: {
 			preview: `${npm} run build && npx wrangler pages dev`,
 			deploy: `${npm} run build && wrangler pages deploy`,
+			"cf-typegen": `wrangler types`,
 		},
 	}),
 	compatibilityFlags: ["nodejs_compat"],

package/templates/svelte/pages/c3.ts

@@ -1,5 +1,4 @@
 import { existsSync } from "node:fs";
-import { platform } from "node:os";
 import { logRaw, updateStatus } from "@cloudflare/cli";
 import { blue, brandColor, dim } from "@cloudflare/cli/colors";
 import { runFrameworkGenerator } from "frameworks/index";
@@ -124,6 +123,7 @@ const updateTypeDefinitions = (ctx: C3Context) => {
 	});
 };
 
+const typesPath = "src/worker-configuration.d.ts";
 const config: TemplateConfig = {
 	configVersion: 1,
 	id: "svelte",
@@ -144,10 +144,9 @@ const config: TemplateConfig = {
 		};
 
 		if (usesTypescript(ctx)) {
-			const mv = platform() === "win32" ? "move" : "mv";
 			scripts = {
 				...scripts,
-				"cf-typegen": `wrangler types && ${mv} worker-configuration.d.ts src/`,
+				"cf-typegen": `wrangler types ${typesPath}`,
 			};
 		}
 
@@ -156,5 +155,6 @@ const config: TemplateConfig = {
 	devScript: "dev",
 	deployScript: "deploy",
 	previewScript: "preview",
+	typesPath,
 };
 export default config;

package/templates/svelte/workers/c3.ts

@@ -1,4 +1,3 @@
-import { platform } from "node:os";
 import { logRaw, updateStatus } from "@cloudflare/cli";
 import { blue, brandColor, dim } from "@cloudflare/cli/colors";
 import { runFrameworkGenerator } from "frameworks/index";
@@ -94,6 +93,7 @@ const updateTypeDefinitions = (ctx: C3Context) => {
 	});
 };
 
+const typesPath = "./src/worker-configuration.d.ts";
 const config: TemplateConfig = {
 	configVersion: 1,
 	id: "svelte",
@@ -113,10 +113,9 @@ const config: TemplateConfig = {
 		};
 
 		if (usesTypescript(ctx)) {
-			const mv = platform() === "win32" ? "move" : "mv";
 			scripts = {
 				...scripts,
-				"cf-typegen": `wrangler types && ${mv} worker-configuration.d.ts src/`,
+				"cf-typegen": `wrangler types ${typesPath}`,
 			};
 		}
 
@@ -125,5 +124,6 @@ const config: TemplateConfig = {
 	devScript: "dev",
 	deployScript: "deploy",
 	previewScript: "preview",
+	typesPath,
 };
 export default config;

package/templates/vue/pages/c3.ts

@@ -16,12 +16,14 @@ const config: TemplateConfig = {
 	displayName: "Vue",
 	platform: "pages",
 	hidden: true,
-	path: "templates/pages/vue",
+	path: "templates/vue/pages",
+	copyFiles: { path: "./templates" },
 	generate,
 	transformPackageJson: async () => ({
 		scripts: {
-			deploy: `${npm} run build && wrangler pages deploy ./dist`,
-			preview: `${npm} run build && wrangler pages dev ./dist`,
+			deploy: `${npm} run build && wrangler pages deploy`,
+			preview: `${npm} run build && wrangler pages dev`,
+			"cf-typegen": `wrangler types`,
 		},
 	}),
 	devScript: "dev",

package/templates/vue/pages/templates/wrangler.jsonc

@@ -0,0 +1,5 @@
+{
+	"name": "<TBD>",
+	"compatibility_date": "<TBD>",
+	"pages_build_output_dir": "./dist"
+  }