create-cloudflare 2.47.2 → 2.48.0

package/dist/cli.js

@@ -74560,7 +74560,7 @@ var Yargs = YargsFactory(esm_default);
 var yargs_default = Yargs;
 
 // package.json
-var version = "2.47.2";
+var version = "2.48.0";
 
 // src/metrics.ts
 var import_node_async_hooks = require("node:async_hooks");
@@ -75335,20 +75335,20 @@ var package_default = {
     "so that we can use dependabot to update these dependencies automatically."
   ],
   dependencies: {
-    "create-astro": "4.11.4",
+    "create-astro": "4.12.1",
     "create-analog": "1.8.1",
     "@angular/create": "19.2.12",
-    "create-docusaurus": "3.7.0",
+    "create-docusaurus": "3.8.0",
     "create-hono": "0.19.1",
-    "create-next-app": "15.3.2",
-    "create-qwik": "1.13.0",
+    "create-next-app": "15.3.3",
+    "create-qwik": "1.14.1",
     "create-vite": "6.5.0",
     "create-remix": "2.16.6",
-    "create-react-router": "7.6.0",
+    "create-react-router": "7.6.1",
     "create-solid": "0.6.2",
     "create-vue": "3.16.4",
     gatsby: "5.14.3",
-    sv: "0.8.6",
+    sv: "0.8.7",
     nuxi: "3.25.1"
   }
 };
@@ -76271,10 +76271,29 @@ var config19 = {
 };
 var c3_default19 = config19;
 
+// templates/hello-world-workflows/c3.ts
+var c3_default20 = {
+  configVersion: 1,
+  id: "hello-world-workflows",
+  displayName: "Workflow",
+  description: "For multi-step applications that automatically retry, persist state, and run for minutes, hours, days or weeks",
+  platform: "workers",
+  copyFiles: {
+    variants: {
+      js: {
+        path: "./js"
+      },
+      ts: {
+        path: "./ts"
+      }
+    }
+  }
+};
+
 // templates/hello-world/c3.ts
 var import_promises2 = require("node:fs/promises");
 var import_node_path5 = require("node:path");
-var c3_default20 = {
+var c3_default21 = {
   configVersion: 1,
   id: "hello-world",
   displayName: "Worker only",
@@ -76344,7 +76363,7 @@ var config20 = {
   previewScript: "preview",
   envInterfaceName
 };
-var c3_default21 = config20;
+var c3_default22 = config20;
 
 // templates/hono/workers/c3.ts
 var generate12 = async (ctx) => {
@@ -76381,14 +76400,14 @@ var config21 = {
   previewScript: "dev",
   envInterfaceName: envInterfaceName2
 };
-var c3_default22 = config21;
+var c3_default23 = config21;
 
 // templates/hono/c3.ts
 var config22 = {
   displayName: "Hono",
-  platformVariants: { pages: c3_default21, workers: c3_default22 }
+  platformVariants: { pages: c3_default22, workers: c3_default23 }
 };
-var c3_default23 = config22;
+var c3_default24 = config22;
 
 // templates/next/pages/c3.ts
 var import_path10 = require("path");
@@ -76487,7 +76506,7 @@ var addDevDependencies = async (installEslintPlugin) => {
 };
 var envInterfaceName3 = "CloudflareEnv";
 var typesPath = "./env.d.ts";
-var c3_default24 = {
+var c3_default25 = {
   configVersion: 1,
   id: "next",
   frameworkCli: "create-next-app",
@@ -76580,7 +76599,7 @@ var updateNextConfig2 = (usesTs) => {
 };
 var envInterfaceName4 = "CloudflareEnv";
 var typesPath2 = "./cloudflare-env.d.ts";
-var c3_default25 = {
+var c3_default26 = {
   configVersion: 1,
   id: "next",
   frameworkCli: "create-next-app",
@@ -76609,9 +76628,9 @@ var c3_default25 = {
 // templates/next/c3.ts
 var config23 = {
   displayName: "Next.js",
-  platformVariants: { pages: c3_default24, workers: c3_default25 }
+  platformVariants: { pages: c3_default25, workers: c3_default26 }
 };
-var c3_default26 = config23;
+var c3_default27 = config23;
 
 // templates/nuxt/pages/c3.ts
 var recast6 = __toESM(require_main3());
@@ -76707,7 +76726,7 @@ var config24 = {
   deployScript: "deploy",
   previewScript: "preview"
 };
-var c3_default27 = config24;
+var c3_default28 = config24;
 
 // templates/nuxt/workers/c3.ts
 var recast7 = __toESM(require_main3());
@@ -76802,14 +76821,14 @@ var config25 = {
   deployScript: "deploy",
   previewScript: "preview"
 };
-var c3_default28 = config25;
+var c3_default29 = config25;
 
 // templates/nuxt/c3.ts
 var config26 = {
   displayName: "Nuxt",
-  platformVariants: { pages: c3_default27, workers: c3_default28 }
+  platformVariants: { pages: c3_default28, workers: c3_default29 }
 };
-var c3_default29 = config26;
+var c3_default30 = config26;
 
 // templates/openapi/c3.ts
 var config27 = {
@@ -76822,7 +76841,7 @@ var config27 = {
     path: "./ts"
   }
 };
-var c3_default30 = config27;
+var c3_default31 = config27;
 
 // templates/pre-existing/c3.ts
 var import_promises3 = require("fs/promises");
@@ -76988,7 +77007,7 @@ var config28 = {
     copyFiles: copyExistingWorkerFiles
   })
 };
-var c3_default31 = config28;
+var c3_default32 = config28;
 function buildConfigure(params) {
   return async function configure21(ctx) {
     const loginSuccess = await params.login(ctx);
@@ -77029,7 +77048,7 @@ var config29 = {
     ]
   }
 };
-var c3_default32 = config29;
+var c3_default33 = config29;
 
 // templates/qwik/pages/c3.ts
 var recast8 = __toESM(require_main3());
@@ -77139,7 +77158,7 @@ var config30 = {
   previewScript: "preview",
   workersTypes: "installed"
 };
-var c3_default33 = config30;
+var c3_default34 = config30;
 
 // templates/qwik/workers/c3.ts
 var recast9 = __toESM(require_main3());
@@ -77249,14 +77268,14 @@ var config31 = {
   previewScript: "preview",
   workersTypes: "installed"
 };
-var c3_default34 = config31;
+var c3_default35 = config31;
 
 // templates/qwik/c3.ts
 var config32 = {
   displayName: "Qwik",
-  platformVariants: { pages: c3_default33, workers: c3_default34 }
+  platformVariants: { pages: c3_default34, workers: c3_default35 }
 };
-var c3_default35 = config32;
+var c3_default36 = config32;
 
 // templates/react-router/c3.ts
 var { npm: npm14 } = detectPackageManager();
@@ -77290,7 +77309,7 @@ var config33 = {
   deployScript: "deploy",
   previewScript: "preview"
 };
-var c3_default36 = config33;
+var c3_default37 = config33;
 
 // templates/react/pages/c3.ts
 var { npm: npm15 } = detectPackageManager();
@@ -77345,7 +77364,7 @@ var config34 = {
   deployScript: "deploy",
   previewScript: "preview"
 };
-var c3_default37 = config34;
+var c3_default38 = config34;
 
 // templates/react/workers/c3.ts
 var import_assert2 = __toESM(require("assert"));
@@ -77483,14 +77502,14 @@ var config35 = {
   deployScript: "deploy",
   previewScript: "preview"
 };
-var c3_default38 = config35;
+var c3_default39 = config35;
 
 // templates/react/c3.ts
 var config36 = {
   displayName: "React",
-  platformVariants: { pages: c3_default37, workers: c3_default38 }
+  platformVariants: { pages: c3_default38, workers: c3_default39 }
 };
-var c3_default39 = config36;
+var c3_default40 = config36;
 
 // templates/remix/pages/c3.ts
 var { npm: npm17 } = detectPackageManager();
@@ -77542,7 +77561,7 @@ var config37 = {
   previewScript: "preview",
   workersTypes: "installed"
 };
-var c3_default40 = config37;
+var c3_default41 = config37;
 
 // templates/remix/workers/c3.ts
 var { npm: npm18 } = detectPackageManager();
@@ -77585,15 +77604,15 @@ var config38 = {
   previewScript: "preview",
   workersTypes: "installed"
 };
-var c3_default41 = config38;
+var c3_default42 = config38;
 
 // templates/remix/c3.ts
 var config39 = {
   displayName: "Remix",
-  platformVariants: { pages: c3_default40, workers: c3_default41 },
+  platformVariants: { pages: c3_default41, workers: c3_default42 },
   hidden: true
 };
-var c3_default42 = config39;
+var c3_default43 = config39;
 
 // templates/scheduled/c3.ts
 var config40 = {
@@ -77613,7 +77632,7 @@ var config40 = {
     }
   }
 };
-var c3_default43 = config40;
+var c3_default44 = config40;
 
 // templates/solid/c3.ts
 var recast11 = __toESM(require_main3());
@@ -77683,7 +77702,7 @@ var config41 = {
   deployScript: "deploy",
   previewScript: "preview"
 };
-var c3_default44 = config41;
+var c3_default45 = config41;
 
 // templates/svelte/pages/c3.ts
 var import_node_fs3 = require("node:fs");
@@ -77807,7 +77826,7 @@ var config42 = {
   previewScript: "preview",
   typesPath: typesPath3
 };
-var c3_default45 = config42;
+var c3_default46 = config42;
 
 // templates/svelte/workers/c3.ts
 var recast13 = __toESM(require_main3());
@@ -77906,14 +77925,14 @@ var config43 = {
   previewScript: "preview",
   typesPath: typesPath4
 };
-var c3_default46 = config43;
+var c3_default47 = config43;
 
 // templates/svelte/c3.ts
 var config44 = {
   displayName: "SvelteKit",
-  platformVariants: { pages: c3_default45, workers: c3_default46 }
+  platformVariants: { pages: c3_default46, workers: c3_default47 }
 };
-var c3_default47 = config44;
+var c3_default48 = config44;
 
 // templates/vue/pages/c3.ts
 var { npm: npm22 } = detectPackageManager();
@@ -77941,7 +77960,7 @@ var config45 = {
   deployScript: "deploy",
   previewScript: "preview"
 };
-var c3_default48 = config45;
+var c3_default49 = config45;
 
 // templates/vue/workers/c3.ts
 var { npm: npm23 } = detectPackageManager();
@@ -78016,20 +78035,20 @@ var config46 = {
   deployScript: "deploy",
   previewScript: "preview"
 };
-var c3_default49 = config46;
+var c3_default50 = config46;
 
 // templates/vue/c3.ts
 var config47 = {
   displayName: "Vue",
-  platformVariants: { pages: c3_default48, workers: c3_default49 }
+  platformVariants: { pages: c3_default49, workers: c3_default50 }
 };
-var c3_default50 = config47;
+var c3_default51 = config47;
 
 // src/git.ts
 var import_node_assert = __toESM(require("node:assert"));
 
 // ../wrangler/package.json
-var version2 = "4.16.0";
+var version2 = "4.19.0";
 
 // src/git.ts
 var offerGit = async (ctx) => {
@@ -78299,16 +78318,16 @@ function getFrameworkMap({ experimental = false }) {
       astro: c3_default8,
       docusaurus: c3_default12,
       gatsby: c3_default15,
-      hono: c3_default23,
-      next: c3_default26,
-      nuxt: c3_default29,
-      qwik: c3_default35,
-      react: c3_default39,
-      "react-router": c3_default36,
-      remix: c3_default42,
-      solid: c3_default44,
-      svelte: c3_default47,
-      vue: c3_default50
+      hono: c3_default24,
+      next: c3_default27,
+      nuxt: c3_default30,
+      qwik: c3_default36,
+      react: c3_default40,
+      "react-router": c3_default37,
+      remix: c3_default43,
+      solid: c3_default45,
+      svelte: c3_default48,
+      vue: c3_default51
     };
   }
 }
@@ -78320,10 +78339,10 @@ function getOtherTemplateMap({
   } else {
     return {
       common: c3_default9,
-      scheduled: c3_default43,
-      queues: c3_default32,
-      openapi: c3_default30,
-      "pre-existing": c3_default31
+      scheduled: c3_default44,
+      queues: c3_default33,
+      openapi: c3_default31,
+      "pre-existing": c3_default32
     };
   }
 }
@@ -78334,16 +78353,17 @@ function getHelloWorldTemplateMap({
     return {};
   } else {
     return {
-      "hello-world": c3_default20,
+      "hello-world": c3_default21,
       "hello-world-assets-only": c3_default16,
       "hello-world-with-assets": c3_default19,
       "hello-world-durable-object": c3_default18,
       "hello-world-durable-object-with-assets": c3_default17,
+      "hello-world-workflows": c3_default20,
       common: c3_default9,
-      scheduled: c3_default43,
-      queues: c3_default32,
-      openapi: c3_default30,
-      "pre-existing": c3_default31
+      scheduled: c3_default44,
+      queues: c3_default33,
+      openapi: c3_default31,
+      "pre-existing": c3_default32
     };
   }
 }
@@ -78363,6 +78383,7 @@ var deriveCorrelatedArgs = (args) => {
   switch (args.type) {
     case "hello-world":
     case "hello-world-durable-object":
+    case "hello-world-workflows":
       args.category ??= "hello-world";
       break;
     case "hello-world-python":

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-cloudflare",
-  "version": "2.47.2",
+  "version": "2.48.0",
   "description": "A CLI for creating and deploying new applications to Cloudflare.",
   "keywords": [
     "cloudflare",
@@ -30,7 +30,7 @@
     "@babel/parser": "^7.21.3",
     "@babel/types": "^7.21.4",
     "@clack/prompts": "^0.6.3",
-    "@cloudflare/workers-types": "^4.20250508.0",
+    "@cloudflare/workers-types": "^4.20250525.0",
     "@iarna/toml": "^3.0.0",
     "@types/command-exists": "^1.2.0",
     "@types/cross-spawn": "^6.0.2",
@@ -73,9 +73,9 @@
     "@cloudflare/cli": "1.1.1",
     "@cloudflare/eslint-config-worker": "1.1.0",
     "@cloudflare/mock-npm-registry": "0.0.0",
-    "@cloudflare/vite-plugin": "1.2.3",
+    "@cloudflare/vite-plugin": "1.4.0",
     "@cloudflare/workers-tsconfig": "0.0.0",
-    "wrangler": "4.16.0"
+    "wrangler": "4.19.0"
   },
   "engines": {
     "node": ">=18.14.1"

package/templates/hello-world-assets-only/templates/public/index.html

@@ -7,5 +7,6 @@
 	</head>
 	<body>
 		<h1 id="heading">Hello, World!</h1>
+		<p>This page comes from a static asset stored at `public/index.html` as configured in `wrangler.jsonc`.</p>
 	</body>
 </html>

package/templates/hello-world-assets-only/templates/wrangler.jsonc

@@ -2,6 +2,7 @@
   "name": "<TBD>",
   "compatibility_date": "<TBD>",
   "assets": {
+    // The path to the directory containing the `index.html` file to be served at `/`
     "directory": "./public"
   },
   "observability": {

package/templates/hello-world-durable-object-with-assets/js/public/index.html

@@ -4,6 +4,7 @@
 		<meta charset="UTF-8" />
 		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
 		<title>Hello, World!</title>
+		<p>This page comes from a static asset stored at `public/index.html` as configured in `wrangler.jsonc`.</p>
 	</head>
 	<body>
 		<h1 id="heading"></h1>

package/templates/hello-world-durable-object-with-assets/js/wrangler.jsonc

@@ -3,7 +3,7 @@
   "main": "src/index.js",
   "compatibility_date": "<TBD>",
   "assets": {
-    "binding": "ASSETS",
+    // The path to the directory containing the `index.html` file to be served at `/`
     "directory": "./public"
   },
   "durable_objects": {

package/templates/hello-world-durable-object-with-assets/py/public/index.html

@@ -7,6 +7,7 @@
 	</head>
 	<body>
 		<h1 id="heading"></h1>
+		<p>This page comes from a static asset stored at `public/index.html` as configured in `wrangler.jsonc`.</p>
 		<script>
 			fetch('/message')
 				.then((resp) => resp.text())

package/templates/hello-world-durable-object-with-assets/py/wrangler.jsonc

@@ -6,7 +6,7 @@
     "python_workers"
   ],
   "assets": {
-    "binding": "ASSETS",
+    // The path to the directory containing the `index.html` file to be served at `/`
     "directory": "./public"
   },
   "migrations": [

package/templates/hello-world-durable-object-with-assets/ts/public/index.html

@@ -7,6 +7,7 @@
 	</head>
 	<body>
 		<h1 id="heading"></h1>
+		<p>This page comes from a static asset stored at `public/index.html` as configured in `wrangler.jsonc`.</p>
 		<script>
 			fetch('/message')
 				.then((resp) => resp.text())

package/templates/hello-world-durable-object-with-assets/ts/wrangler.jsonc

@@ -11,7 +11,7 @@
     }
   ],
   "assets": {
-    "binding": "ASSETS",
+    // The path to the directory containing the `index.html` file to be served at `/`
     "directory": "./public"
   },
   "durable_objects": {

package/templates/hello-world-with-assets/js/public/index.html

@@ -7,6 +7,7 @@
 	</head>
 	<body>
 		<h1 id="heading"></h1>
+		<p>This page comes from a static asset stored at `public/index.html` as configured in `wrangler.jsonc`.</p>
 		<button id="button" type="button">Fetch a random UUID</button>
 		<output id="random" for="button"></output>
 		<script>

package/templates/hello-world-with-assets/js/wrangler.jsonc

@@ -7,7 +7,7 @@
     "global_fetch_strictly_public"
   ],
   "assets": {
-    "binding": "ASSETS",
+    // The path to the directory containing the `index.html` file to be served at `/`
     "directory": "./public"
   },
   "observability": {

package/templates/hello-world-with-assets/py/public/index.html

@@ -7,6 +7,7 @@
 	</head>
 	<body>
 		<h1 id="heading"></h1>
+		<p>This page comes from a static asset stored at `public/index.html` as configured in `wrangler.jsonc`.</p>
 		<button id="button" type="button">Fetch a random UUID</button>
 		<output id="random" for="button"></output>
 		<script>

package/templates/hello-world-with-assets/py/wrangler.jsonc

@@ -6,7 +6,7 @@
     "python_workers"
   ],
   "assets": {
-    "binding": "ASSETS",
+    // The path to the directory containing the `index.html` file to be served at `/`
     "directory": "./public"
   },
   "observability": {

package/templates/hello-world-with-assets/ts/public/index.html

@@ -7,6 +7,7 @@
 	</head>
 	<body>
 		<h1 id="heading"></h1>
+		<p>This page comes from a static asset stored at `public/index.html` as configured in `wrangler.jsonc`.</p>
 		<button id="button" type="button">Fetch a random UUID</button>
 		<output id="random" for="button"></output>
 		<script>

package/templates/hello-world-with-assets/ts/wrangler.jsonc

@@ -3,11 +3,10 @@
   "main": "src/index.ts",
   "compatibility_date": "<TBD>",
   "compatibility_flags": [
-    "nodejs_compat",
     "global_fetch_strictly_public"
   ],
   "assets": {
-    "binding": "ASSETS",
+    // The path to the directory containing the `index.html` file to be served at `/`
     "directory": "./public"
   },
   "observability": {

package/templates/hello-world-workflows/c3.ts

@@ -0,0 +1,20 @@
+import type { TemplateConfig } from "../../src/templates";
+
+export default {
+	configVersion: 1,
+	id: "hello-world-workflows",
+	displayName: "Workflow",
+	description:
+		"For multi-step applications that automatically retry, persist state, and run for minutes, hours, days or weeks",
+	platform: "workers",
+	copyFiles: {
+		variants: {
+			js: {
+				path: "./js",
+			},
+			ts: {
+				path: "./ts",
+			},
+		},
+	},
+} satisfies TemplateConfig;

package/templates/hello-world-workflows/js/package.json

@@ -0,0 +1,13 @@
+{
+	"name": "<TBD>",
+	"version": "0.0.0",
+	"private": true,
+	"scripts": {
+		"deploy": "wrangler deploy",
+		"start": "wrangler dev",
+		"dev": "wrangler dev"
+	},
+	"devDependencies": {
+		"wrangler": "^4.6.0"
+	}
+}

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

@@ -0,0 +1,129 @@
+import { WorkflowEntrypoint } 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
+ */
+ 
+/**
+ * @typedef {Object} Env
+ * @property {Workflow} MY_WORKFLOW
+ */
+
+/**
+ * @typedef {Object} Params
+ * @property {string} email
+ * @property {Record<string, string>} metadata
+ */
+
+export class MyWorkflow extends WorkflowEntrypoint {
+	/**
+	 * @param {Env} env
+	 */
+	constructor(env) {
+		this.env = env;
+	}
+
+	/**
+	 * @param {WorkflowEvent<Params>} event
+	 * @param {WorkflowStep} step
+	 */
+	async run(event, step) {
+		// 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();
+		});
+
+		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
+			/** @type {Object} */ ({
+				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 {
+	/**
+	 * @param {Request} req
+	 * @param {Env} env
+	 * @returns {Promise<Response>}
+	 */
+	async fetch(req, env) {
+		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/js/wrangler.jsonc

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

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

@@ -0,0 +1,15 @@
+{
+	"name": "<TBD>",
+	"version": "0.0.0",
+	"private": true,
+	"scripts": {
+		"deploy": "wrangler deploy",
+		"start": "wrangler dev",
+		"dev": "wrangler dev",
+		"cf-typegen": "wrangler types"
+	},
+	"devDependencies": {
+		"typescript": "^5.0.4",
+		"wrangler": "^4.6.0"
+	}
+}

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",
+		},
+	],
+}