create-cloudflare 0.0.0-a986f19f → 0.0.0-a9cb8c60

package/README.md

@@ -46,7 +46,7 @@ To create a new Typescript "Hello World" worker, run:
 npm create cloudflare@latest hello-world -- --type hello-world --ts
 ```
 
-Current template options are: `hello-world`, `common`, or `chatgptPlugin`.
+Current template options are: `hello-world`, `common`, `chatgptPlugin`, or `openapi`.
 
 #### Additional arguments
 

package/dist/cli.js

@@ -57864,7 +57864,7 @@ var Yargs = YargsFactory(esm_default);
 var yargs_default = Yargs;
 
 // package.json
-var version = "0.0.0-a986f19f";
+var version = "0.0.0-a9cb8c60";
 var devDependencies = {
   "@babel/parser": "^7.21.3",
   "@babel/types": "^7.21.4",
@@ -58504,7 +58504,7 @@ async function openInBrowser(url) {
 }
 var C3_DEFAULTS = {
   projectName: new import_haikunator.default().haikunate({ tokenHex: true }),
-  type: "hello-world",
+  type: "webFramework",
   framework: "angular",
   autoUpdate: true,
   deploy: true,
@@ -59871,14 +59871,21 @@ var detectPackageManager = () => {
       case "pnpm":
         name2 = "pnpm";
         version3 = devDependencies["pnpm"].replace("^", "");
+        process.env.npm_config_user_agent = "pnpm";
         break;
       case "yarn":
         name2 = "yarn";
         version3 = devDependencies["yarn"].replace("^", "");
+        process.env.npm_config_user_agent = "yarn";
+        break;
+      case "bun":
+        name2 = "bun";
+        version3 = "1.0.0";
         break;
       case "npm":
         name2 = "npm";
         version3 = "0.0.0";
+        process.env.npm_config_user_agent = "npm";
         break;
     }
   }
@@ -59917,6 +59924,14 @@ var detectPackageManager = () => {
         npx: "yarn",
         dlx: "yarn"
       };
+    case "bun":
+      return {
+        name: name2,
+        version: version3,
+        npm: "bun",
+        npx: "bunx",
+        dlx: "bunx"
+      };
     case "npm":
     default:
       return {
@@ -60047,14 +60062,18 @@ var runFrameworkGenerator = async (ctx, cmd) => {
   await runCommand(cmd);
 };
 var installPackages = async (packages, config14) => {
-  const { npm: npm13 } = detectPackageManager();
+  const { npm: npm14 } = detectPackageManager();
   let saveFlag;
   let cmd;
-  switch (npm13) {
+  switch (npm14) {
     case "yarn":
       cmd = "add";
       saveFlag = config14.dev ? "-D" : "";
       break;
+    case "bun":
+      cmd = "add";
+      saveFlag = config14.dev ? "-d" : "";
+      break;
     case "npm":
     case "pnpm":
     default:
@@ -60062,36 +60081,36 @@ var installPackages = async (packages, config14) => {
       saveFlag = config14.dev ? "--save-dev" : "--save";
       break;
   }
-  await runCommand(`${npm13} ${cmd} ${saveFlag} ${packages.join(" ")}`, {
+  await runCommand(`${npm14} ${cmd} ${saveFlag} ${packages.join(" ")}`, {
     ...config14,
     silent: true
   });
 };
 var npmInstall = async () => {
-  const { npm: npm13 } = detectPackageManager();
-  await runCommand(`${npm13} install`, {
+  const { npm: npm14 } = detectPackageManager();
+  await runCommand(`${npm14} install`, {
     silent: true,
     startText: "Installing dependencies",
-    doneText: `${brandColor("installed")} ${dim(`via \`${npm13} install\``)}`
+    doneText: `${brandColor("installed")} ${dim(`via \`${npm14} install\``)}`
   });
 };
 var resetPackageManager = async (ctx) => {
-  const { npm: npm13 } = detectPackageManager();
-  if (npm13 === "npm")
+  const { npm: npm14 } = detectPackageManager();
+  if (npm14 === "npm")
     return;
   const nodeModulesPath = import_path5.default.join(ctx.project.path, "node_modules");
   (0, import_fs5.rmSync)(nodeModulesPath, { recursive: true });
   const lockfilePath = import_path5.default.join(ctx.project.path, "package-lock.json");
   (0, import_fs5.rmSync)(lockfilePath);
-  await runCommand(`${npm13} install`, {
+  await runCommand(`${npm14} install`, {
     silent: true,
     cwd: ctx.project.path,
     startText: "Installing dependencies",
-    doneText: `${brandColor("installed")} ${dim(`via \`${npm13} install\``)}`
+    doneText: `${brandColor("installed")} ${dim(`via \`${npm14} install\``)}`
   });
 };
 var installWrangler = async () => {
-  const { npm: npm13 } = detectPackageManager();
+  const { npm: npm14 } = detectPackageManager();
   if ((0, import_fs5.existsSync)(import_path5.default.resolve("node_modules", "wrangler"))) {
     return;
   }
@@ -60101,7 +60120,7 @@ var installWrangler = async () => {
       "A command line tool for building Cloudflare Workers"
     )}`,
     doneText: `${brandColor("installed")} ${dim(
-      `via \`${npm13} install wrangler --save-dev\``
+      `via \`${npm14} install wrangler --save-dev\``
     )}`
   });
 };
@@ -60148,8 +60167,8 @@ var listAccounts = async () => {
   return accounts;
 };
 async function getWorkerdCompatibilityDate() {
-  const { npm: npm13 } = detectPackageManager();
-  return runCommand(`${npm13} info workerd dist-tags.latest`, {
+  const { npm: npm14 } = detectPackageManager();
+  return runCommand(`${npm14} info workerd dist-tags.latest`, {
     silent: true,
     captureOutput: true,
     startText: "Retrieving current workerd compatibility date",
@@ -60600,10 +60619,14 @@ var config6 = {
 var next_default = config6;
 
 // src/frameworks/nuxt/index.ts
-var { dlx: dlx7 } = detectPackageManager();
+var { npm: npm5, dlx: dlx7 } = detectPackageManager();
 var generate7 = async (ctx) => {
   const cli = getFrameworkCli(ctx);
-  await runFrameworkGenerator(ctx, `${dlx7} ${cli} init ${ctx.project.name}`);
+  const gitFlag = ctx.args.git ? `--gitInit` : `--no-gitInit`;
+  await runFrameworkGenerator(
+    ctx,
+    `${dlx7} ${cli} init ${ctx.project.name} --packageManager ${npm5} ${gitFlag}`
+  );
   logRaw("");
 };
 var configure4 = async (ctx) => {
@@ -60617,8 +60640,8 @@ var config7 = {
   displayName: "Nuxt",
   packageScripts: {
     build: (cmd) => `NITRO_PRESET=cloudflare-pages ${cmd}`,
-    "pages:dev": `wrangler pages dev ${compatDateFlag()} --proxy 3000 -- npm run dev`,
-    "pages:deploy": "npm run build && wrangler pages deploy ./dist"
+    "pages:dev": `wrangler pages dev ${compatDateFlag()} --proxy 3000 -- ${npm5} run dev`,
+    "pages:deploy": `${npm5} run build && wrangler pages deploy ./dist`
   }
 };
 var nuxt_default = config7;
@@ -60632,19 +60655,19 @@ var package_default = {
     "additionally it also contains a map that maps frameworks to their respective clis"
   ],
   dependencies: {
-    "@angular/cli": "16.2.0",
-    "create-astro": "4.0.1",
+    "@angular/cli": "16.2.2",
+    "create-astro": "4.1.0",
     "create-docusaurus": "2.4.1",
     "create-hono": "0.2.6",
     "create-next-app": "13.4.19",
-    "create-qwik": "1.2.7",
+    "create-qwik": "1.2.12",
     "create-react-app": "5.0.1",
-    "create-remix": "1.19.3",
-    "create-solid": "0.2.26",
-    "create-svelte": "4.2.0",
-    "create-vue": "3.6.4",
-    gatsby: "5.11.0",
-    nuxi: "3.6.5"
+    "create-remix": "2.0.0",
+    "create-solid": "0.3.6",
+    "create-svelte": "5.1.0",
+    "create-vue": "3.7.5",
+    gatsby: "5.12.4",
+    nuxi: "3.9.0"
   },
   frameworkCliMap: {
     angular: "@angular/cli",
@@ -60664,7 +60687,7 @@ var package_default = {
 };
 
 // src/frameworks/qwik/index.ts
-var { npm: npm5, npx: npx4, dlx: dlx8 } = detectPackageManager();
+var { npm: npm6, npx: npx4, dlx: dlx8 } = detectPackageManager();
 var generate8 = async (ctx) => {
   const cli = getFrameworkCli(ctx);
   await runFrameworkGenerator(ctx, `${dlx8} ${cli} basic ${ctx.project.name}`);
@@ -60681,14 +60704,14 @@ var config8 = {
   configure: configure5,
   displayName: "Qwik",
   packageScripts: {
-    "pages:dev": `wrangler pages dev ${compatDateFlag()} -- ${npm5} run dev`,
-    "pages:deploy": `${npm5} run build && wrangler pages deploy ./dist`
+    "pages:dev": `wrangler pages dev ${compatDateFlag()} -- ${npm6} run dev`,
+    "pages:deploy": `${npm6} run build && wrangler pages deploy ./dist`
   }
 };
 var qwik_default = config8;
 
 // src/frameworks/react/index.ts
-var { npm: npm6, dlx: dlx9 } = detectPackageManager();
+var { npm: npm7, dlx: dlx9 } = detectPackageManager();
 var generate9 = async (ctx) => {
   const cli = getFrameworkCli(ctx);
   await runFrameworkGenerator(ctx, `${dlx9} ${cli} ${ctx.project.name}`);
@@ -60702,14 +60725,14 @@ var config9 = {
   configure: configure6,
   displayName: "React",
   packageScripts: {
-    "pages:dev": `wrangler pages dev ${compatDateFlag()} --port 3000 -- ${npm6} start`,
-    "pages:deploy": `${npm6} run build && wrangler pages deploy ./build`
+    "pages:dev": `wrangler pages dev ${compatDateFlag()} --port 3000 -- ${npm7} start`,
+    "pages:deploy": `${npm7} run build && wrangler pages deploy ./build`
   }
 };
 var react_default = config9;
 
 // src/frameworks/remix/index.ts
-var { npm: npm7, dlx: dlx10 } = detectPackageManager();
+var { npm: npm8, dlx: dlx10 } = detectPackageManager();
 var generate10 = async (ctx) => {
   const cli = getFrameworkCli(ctx);
   await runFrameworkGenerator(
@@ -60722,16 +60745,13 @@ var config10 = {
   generate: generate10,
   displayName: "Remix",
   packageScripts: {
-    "pages:deploy": `${npm7} run build && wrangler pages deploy ./public`
+    "pages:deploy": `${npm8} run build && wrangler pages deploy ./public`
   },
   devCommand: "dev",
-  testFlags: ["--typescript", "--no-install"]
+  testFlags: ["--typescript", "--no-install", "--no-git-init"]
 };
 var remix_default = config10;
 
-// src/frameworks/solid/index.ts
-var import_fs8 = require("fs");
-
 // src/frameworks/solid/templates.ts
 var viteConfig = `
 import solid from "solid-start/vite";
@@ -60744,15 +60764,14 @@ export default defineConfig({
 `;
 
 // src/frameworks/solid/index.ts
-var { npm: npm8, dlx: dlx11 } = detectPackageManager();
+var { npm: npm9, dlx: dlx11 } = detectPackageManager();
 var generate11 = async (ctx) => {
-  (0, import_fs8.mkdirSync)(ctx.project.path);
-  process.chdir(ctx.project.path);
   const cli = getFrameworkCli(ctx);
-  await runFrameworkGenerator(ctx, `${dlx11} ${cli}`);
+  await runFrameworkGenerator(ctx, `${dlx11} ${cli} ${ctx.project.name}`);
   logRaw("");
 };
-var configure7 = async () => {
+var configure7 = async (ctx) => {
+  process.chdir(ctx.project.path);
   const pkg = "solid-start-cloudflare-pages";
   await installPackages([pkg], {
     dev: true,
@@ -60762,7 +60781,7 @@ var configure7 = async () => {
   const viteConfigPath = usesTypescript() ? `./vite.config.ts` : `./vite.config.js`;
   writeFile2(viteConfigPath, viteConfig);
   updateStatus(
-    `Adding the Cloudflare Pages adapter to ${blue("vite.config.js")}`
+    `Adding the Cloudflare Pages adapter to ${blue(viteConfigPath)}`
   );
 };
 var config11 = {
@@ -60770,8 +60789,8 @@ var config11 = {
   configure: configure7,
   displayName: "Solid",
   packageScripts: {
-    "pages:dev": `wrangler pages dev ${compatDateFlag()} --proxy 3000 -- ${npm8} run dev`,
-    "pages:deploy": `${npm8} run build && wrangler pages deploy ./dist/public`
+    "pages:dev": `wrangler pages dev ${compatDateFlag()} --proxy 3000 -- ${npm9} run dev`,
+    "pages:deploy": `${npm9} run build && wrangler pages deploy ./dist/public`
   }
 };
 var solid_default = config11;
@@ -60823,7 +60842,7 @@ interface Platform {
 `;
 
 // src/frameworks/svelte/index.ts
-var { npm: npm9, dlx: dlx12 } = detectPackageManager();
+var { npm: npm10, dlx: dlx12 } = detectPackageManager();
 var generate12 = async (ctx) => {
   const cli = getFrameworkCli(ctx);
   await runFrameworkGenerator(ctx, `${dlx12} ${cli} ${ctx.project.name}`);
@@ -60867,14 +60886,14 @@ var config12 = {
   configure: configure8,
   displayName: "Svelte",
   packageScripts: {
-    "pages:dev": `wrangler pages dev ${compatDateFlag()} --proxy 5173 -- ${npm9} run dev`,
-    "pages:deploy": `NODE_VERSION=16 ${npm9} run build && wrangler pages deploy .svelte-kit/cloudflare`
+    "pages:dev": `wrangler pages dev ${compatDateFlag()} --proxy 5173 -- ${npm10} run dev`,
+    "pages:deploy": `${npm10} run build && wrangler pages deploy .svelte-kit/cloudflare`
   }
 };
 var svelte_default = config12;
 
 // src/frameworks/vue/index.ts
-var { npm: npm10, dlx: dlx13 } = detectPackageManager();
+var { npm: npm11, dlx: dlx13 } = detectPackageManager();
 var generate13 = async (ctx) => {
   const cli = getFrameworkCli(ctx);
   await runFrameworkGenerator(ctx, `${dlx13} ${cli} ${ctx.project.name}`);
@@ -60883,8 +60902,8 @@ var config13 = {
   generate: generate13,
   displayName: "Vue",
   packageScripts: {
-    "pages:dev": `wrangler pages dev ${compatDateFlag()} --proxy 5173 -- ${npm10} run dev`,
-    "pages:deploy": `${npm10} run build && wrangler pages deploy ./dist`
+    "pages:dev": `wrangler pages dev ${compatDateFlag()} --proxy 5173 -- ${npm11} run dev`,
+    "pages:deploy": `${npm11} run build && wrangler pages deploy ./dist`
   },
   testFlags: ["--ts"]
 };
@@ -60927,7 +60946,7 @@ var debug = (msg) => {
 };
 
 // src/common.ts
-var import_fs9 = require("fs");
+var import_fs8 = require("fs");
 var import_path7 = require("path");
 var import_process2 = require("process");
 
@@ -61023,14 +61042,14 @@ function secondsSince(start) {
 }
 
 // ../wrangler/package.json
-var version2 = "3.7.0";
+var version2 = "3.10.1";
 
 // src/common.ts
-var { name, npm: npm11 } = detectPackageManager();
+var { name, npm: npm12 } = detectPackageManager();
 var validateProjectDirectory = (relativePath) => {
   const path3 = (0, import_path7.resolve)(relativePath);
-  const existsAlready = (0, import_fs9.existsSync)(path3);
-  const isEmpty = existsAlready && (0, import_fs9.readdirSync)(path3).length === 0;
+  const existsAlready = (0, import_fs8.existsSync)(path3);
+  const isEmpty = existsAlready && (0, import_fs8.readdirSync)(path3).length === 0;
   if (existsAlready && !isEmpty) {
     return `Directory \`${relativePath}\` already exists and is not empty. Please choose a new name.`;
   }
@@ -61043,13 +61062,13 @@ var setupProjectDirectory = (args) => {
   }
   const directory = (0, import_path7.dirname)(path3);
   const pathBasename = (0, import_path7.basename)(path3);
-  (0, import_fs9.mkdirSync)(directory, { recursive: true });
+  (0, import_fs8.mkdirSync)(directory, { recursive: true });
   (0, import_process2.chdir)(directory);
   return { name: pathBasename, path: path3 };
 };
 var offerToDeploy = async (ctx) => {
   startSection(`Deploy with Cloudflare`, `Step 3 of 3`);
-  const label = `deploy via \`${npm11} run ${ctx.framework?.config.deployCommand ?? "deploy"}\``;
+  const label = `deploy via \`${npm12} run ${ctx.framework?.config.deployCommand ?? "deploy"}\``;
   ctx.args.deploy = await processArgument(ctx.args, "deploy", {
     type: "confirm",
     question: "Do you want to deploy your application?",
@@ -61071,7 +61090,7 @@ var runDeploy = async (ctx) => {
     return;
   }
   const baseDeployCmd = [
-    npm11,
+    npm12,
     "run",
     ctx.framework?.config.deployCommand ?? "deploy"
   ];
@@ -61146,11 +61165,11 @@ var printSummary = async (ctx) => {
     [`Navigate to the new directory`, `cd ${ctx.project.name}`],
     [
       `Run the development server`,
-      `${npm11} run ${ctx.framework?.config.devCommand ?? "start"}`
+      `${npm12} run ${ctx.framework?.config.devCommand ?? "start"}`
     ],
     [
       `Deploy your application`,
-      `${npm11} run ${ctx.framework?.config.deployCommand ?? "deploy"}`
+      `${npm12} run ${ctx.framework?.config.deployCommand ?? "deploy"}`
     ],
     [
       `Read the documentation`,
@@ -61172,7 +61191,7 @@ var printSummary = async (ctx) => {
       `${bgGreen(" APPLICATION CREATED ")}`,
       `${dim(`Deploy your application with`)}`,
       `${blue(
-        `${npm11} run ${ctx.framework?.config.deployCommand ?? "deploy"}`
+        `${npm12} run ${ctx.framework?.config.deployCommand ?? "deploy"}`
       )}`
     ].join(" ");
     logRaw(msg);
@@ -61627,6 +61646,13 @@ var templateMap = {
       ts: true
     })
   },
+  openapi: {
+    label: `OpenAPI 3.1`,
+    handler: (args) => runWorkersGenerator({
+      ...args,
+      ts: true
+    })
+  },
   "pre-existing": {
     label: "Pre-existing Worker (from Dashboard)",
     handler: runWorkersGenerator,
@@ -61683,7 +61709,7 @@ var processArgument = async (args, name2, promptConfig) => {
 
 // src/cli.ts
 var import_semver2 = __toESM(require_semver2());
-var { npm: npm12 } = detectPackageManager();
+var { npm: npm13 } = detectPackageManager();
 var main = async (argv) => {
   const args = await parseArgs(argv);
   logRaw("");
@@ -61710,7 +61736,7 @@ var isUpdateAvailable = async () => {
 };
 var runLatest = async () => {
   const args = process.argv.slice(2);
-  await runCommand(`${npm12} create cloudflare@latest ${args.join(" ")}`);
+  await runCommand(`${npm13} create cloudflare@latest ${args.join(" ")}`);
 };
 var runCli = async (args) => {
   printBanner();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-cloudflare",
-  "version": "0.0.0-a986f19f",
+  "version": "0.0.0-a9cb8c60",
   "description": "A CLI for creating and deploying new applications to Cloudflare.",
   "keywords": [
     "cloudflare",
@@ -62,10 +62,10 @@
     "@clack/core": "^0.3.2",
     "@types/semver": "^7.5.1",
     "@cloudflare/workers-tsconfig": "0.0.0",
-    "wrangler": "3.7.0"
+    "wrangler": "3.10.1"
   },
   "engines": {
-    "node": ">=16.13.0"
+    "node": ">=18.14.1"
   },
   "scripts": {
     "build": "node -r esbuild-register scripts/build.ts",
@@ -75,6 +75,7 @@
     "test:e2e:cleanup": "node -r esbuild-register scripts/e2eCleanup.ts",
     "test:e2e:npm": "pnpm run build && TEST_PM=npm vitest run --config ./vitest-e2e.config.ts",
     "test:e2e:pnpm": "pnpm run build && TEST_PM=pnpm vitest run --config ./vitest-e2e.config.ts",
+    "test:e2e:bun": "pnpm run build && TEST_PM=bun vitest run --config ./vitest-e2e.config.ts",
     "test:unit": "vitest run --config ./vitest.config.ts",
     "test:unit:watch": "vitest --config ./vitest.config.ts",
     "watch": "node -r esbuild-register scripts/build.ts --watch"

package/templates/chatgptPlugin/ts/README.md

@@ -17,8 +17,8 @@ The sample plugin allows ChatGPT users to search for repositories using GitHub's
 ## Usage
 
 1. You can configure the `.well-known/ai-plugin.json` route in `index.ts`.
-2. Update the OpenAPI schema in `openapi.ts`.
-3. You can set up any new routes and the associated OpenAPI schema by defining new routes. See `search.ts` for an example.
+2. You can set up any new routes and the associated OpenAPI schema by defining new routes. See `search.ts` for an example.
+3. For more information read the [itty-router-openapi official documentation](https://cloudflare.github.io/itty-router-openapi/).
 
 ## Deploying to OpenAI's API
 

package/templates/chatgptPlugin/ts/package.json

@@ -4,10 +4,11 @@
 	"private": true,
 	"scripts": {
 		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
 		"start": "wrangler dev"
 	},
 	"dependencies": {
-		"@cloudflare/itty-router-openapi": "^0.1.2"
+		"@cloudflare/itty-router-openapi": "^1.0.1"
 	},
 	"devDependencies": {
 		"@cloudflare/workers-types": "^4.20230404.0",

package/templates/chatgptPlugin/ts/src/search.ts

@@ -1,9 +1,4 @@
-import {
-	ApiException,
-	OpenAPIRoute,
-	Query,
-	ValidationError,
-} from "@cloudflare/itty-router-openapi";
+import { OpenAPIRoute, Query } from "@cloudflare/itty-router-openapi";
 
 export class GetSearch extends OpenAPIRoute {
 	static schema = {
@@ -17,6 +12,7 @@ export class GetSearch extends OpenAPIRoute {
 		},
 		responses: {
 			"200": {
+				description: "Successfully response",
 				schema: {
 					repos: [
 						{
@@ -33,7 +29,7 @@ export class GetSearch extends OpenAPIRoute {
 	};
 
 	async handle(request: Request, env, ctx, data: Record<string, any>) {
-		const url = `https://api.github.com/search/repositories?q=${data.q}`;
+		const url = `https://api.github.com/search/repositories?q=${data.query.q}`;
 
 		const resp = await fetch(url, {
 			headers: {

package/templates/common/js/package.json

@@ -4,6 +4,7 @@
 	"private": true,
 	"scripts": {
 		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
 		"start": "wrangler dev"
 	},
 	"devDependencies": {

package/templates/common/ts/package.json

@@ -4,6 +4,7 @@
 	"private": true,
 	"scripts": {
 		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
 		"start": "wrangler dev"
 	},
 	"devDependencies": {

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

@@ -4,6 +4,7 @@
 	"private": true,
 	"scripts": {
 		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
 		"start": "wrangler dev"
 	},
 	"devDependencies": {

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

@@ -4,6 +4,7 @@
 	"private": true,
 	"scripts": {
 		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
 		"start": "wrangler dev"
 	},
 	"devDependencies": {

package/templates/openapi/ts/README.md

@@ -0,0 +1,25 @@
+# Cloudflare Workers OpenAPI 3.1
+
+This is a Cloudflare Worker with OpenAPI 3.1 using [itty-router-openapi](https://github.com/cloudflare/itty-router-openapi).
+
+This is an example project made to be used as a quick start into building OpenAPI compliant Workers that generates the
+`openapi.json` schema automatically from code and validates the incoming request to the defined parameters or request body.
+
+## Get started
+
+1. Sign up for [Cloudflare Workers](https://workers.dev). The free tier is more than enough for most use cases.
+2. Clone this project and install dependencies with `npm install`
+3. Run `wrangler login` to login to your Cloudflare account in wrangler
+4. Run `wrangler deploy` to publish the API to Cloudflare Workers
+
+## Project structure
+
+1. Your main router is defined in `src/index.ts`.
+2. Each endpoint has its own file in `src/endpoints/`.
+3. For more information read the [itty-router-openapi official documentation](https://cloudflare.github.io/itty-router-openapi/).
+
+## Development
+
+1. Run `wrangler dev` to start a local instance of the API.
+2. Open `http://localhost:9000/` in your browser to see the Swagger interface where you can try the endpoints.
+3. Changes made in the `src/` folder will automatically trigger the server to reload, you only need to refresh the Swagger interface.

package/templates/openapi/ts/package.json

@@ -0,0 +1,19 @@
+{
+	"name": "cloudflare-workers-openapi",
+	"version": "0.0.1",
+	"private": true,
+	"scripts": {
+		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
+		"start": "wrangler dev"
+	},
+	"dependencies": {
+		"@cloudflare/itty-router-openapi": "^1.0.1"
+	},
+	"devDependencies": {
+		"@cloudflare/workers-types": "^4.20230821.0",
+		"@types/node": "^20.5.7",
+		"@types/service-worker-mock": "^2.0.1",
+		"wrangler": "^3.0.0"
+	}
+}

package/templates/openapi/ts/src/endpoints/taskCreate.ts

@@ -0,0 +1,48 @@
+import {
+	OpenAPIRoute,
+	OpenAPIRouteSchema,
+} from "@cloudflare/itty-router-openapi";
+import { Task } from "../types";
+
+export class TaskCreate extends OpenAPIRoute {
+	static schema: OpenAPIRouteSchema = {
+		tags: ["Tasks"],
+		summary: "Create a new Task",
+		requestBody: Task,
+		responses: {
+			"200": {
+				description: "Returns the created task",
+				schema: {
+					success: Boolean,
+					result: {
+						task: Task,
+					},
+				},
+			},
+		},
+	};
+
+	async handle(
+		request: Request,
+		env: any,
+		context: any,
+		data: Record<string, any>
+	) {
+		// Retrieve the validated request body
+		const taskToCreate = data.body;
+
+		// Implement your own object insertion here
+
+		// return the new task
+		return {
+			success: true,
+			task: {
+				name: taskToCreate.name,
+				slug: taskToCreate.slug,
+				description: taskToCreate.description,
+				completed: taskToCreate.completed,
+				due_date: taskToCreate.due_date,
+			},
+		};
+	}
+}

package/templates/openapi/ts/src/endpoints/taskDelete.ts

@@ -0,0 +1,55 @@
+import {
+	OpenAPIRoute,
+	OpenAPIRouteSchema,
+	Path,
+} from "@cloudflare/itty-router-openapi";
+import { Task } from "../types";
+
+export class TaskDelete extends OpenAPIRoute {
+	static schema: OpenAPIRouteSchema = {
+		tags: ["Tasks"],
+		summary: "Delete a Task",
+		parameters: {
+			taskSlug: Path(String, {
+				description: "Task slug",
+			}),
+		},
+		responses: {
+			"200": {
+				description: "Returns if the task was deleted successfully",
+				schema: {
+					success: Boolean,
+					result: {
+						task: Task,
+					},
+				},
+			},
+		},
+	};
+
+	async handle(
+		request: Request,
+		env: any,
+		context: any,
+		data: Record<string, any>
+	) {
+		// Retrieve the validated slug
+		const { taskSlug } = data.params;
+
+		// Implement your own object deletion here
+
+		// Return the deleted task for confirmation
+		return {
+			result: {
+				task: {
+					name: "Build something awesome with Cloudflare Workers",
+					slug: taskSlug,
+					description: "Lorem Ipsum",
+					completed: true,
+					due_date: "2022-12-24",
+				},
+			},
+			success: true,
+		};
+	}
+}

package/templates/openapi/ts/src/endpoints/taskFetch.ts

@@ -0,0 +1,74 @@
+import {
+	OpenAPIRoute,
+	OpenAPIRouteSchema,
+	Path,
+} from "@cloudflare/itty-router-openapi";
+import { Task } from "../types";
+
+export class TaskFetch extends OpenAPIRoute {
+	static schema: OpenAPIRouteSchema = {
+		tags: ["Tasks"],
+		summary: "Get a single Task by slug",
+		parameters: {
+			taskSlug: Path(String, {
+				description: "Task slug",
+			}),
+		},
+		responses: {
+			"200": {
+				description: "Returns a single task if found",
+				schema: {
+					success: Boolean,
+					result: {
+						task: Task,
+					},
+				},
+			},
+			"404": {
+				description: "Task not found",
+				schema: {
+					success: Boolean,
+					error: String,
+				},
+			},
+		},
+	};
+
+	async handle(
+		request: Request,
+		env: any,
+		context: any,
+		data: Record<string, any>
+	) {
+		// Retrieve the validated slug
+		const { taskSlug } = data.params;
+
+		// Implement your own object fetch here
+
+		const exists = true;
+
+		// @ts-ignore: check if the object exists
+		if (exists === false) {
+			return Response.json(
+				{
+					success: false,
+					error: "Object not found",
+				},
+				{
+					status: 404,
+				}
+			);
+		}
+
+		return {
+			success: true,
+			task: {
+				name: "my task",
+				slug: taskSlug,
+				description: "this needs to be done",
+				completed: false,
+				due_date: new Date().toISOString().slice(0, 10),
+			},
+		};
+	}
+}

package/templates/openapi/ts/src/endpoints/taskList.ts

@@ -0,0 +1,66 @@
+import { Task } from "../types";
+import {
+	OpenAPIRoute,
+	OpenAPIRouteSchema,
+	Query,
+} from "@cloudflare/itty-router-openapi";
+
+export class TaskList extends OpenAPIRoute {
+	static schema: OpenAPIRouteSchema = {
+		tags: ["Tasks"],
+		summary: "List Tasks",
+		parameters: {
+			page: Query(Number, {
+				description: "Page number",
+				default: 0,
+			}),
+			isCompleted: Query(Boolean, {
+				description: "Filter by completed flag",
+				required: false,
+			}),
+		},
+		responses: {
+			"200": {
+				description: "Returns a list of tasks",
+				schema: {
+					success: Boolean,
+					result: {
+						tasks: [Task],
+					},
+				},
+			},
+		},
+	};
+
+	async handle(
+		request: Request,
+		env: any,
+		context: any,
+		data: Record<string, any>
+	) {
+		// Retrieve the validated parameters
+		const { page, isCompleted } = data.query;
+
+		// Implement your own object list here
+
+		return {
+			success: true,
+			tasks: [
+				{
+					name: "Clean my room",
+					slug: "clean-room",
+					description: null,
+					completed: false,
+					due_date: "2025-01-05",
+				},
+				{
+					name: "Build something awesome with Cloudflare Workers",
+					slug: "cloudflare-workers",
+					description: "Lorem Ipsum",
+					completed: true,
+					due_date: "2022-12-24",
+				},
+			],
+		};
+	}
+}

package/templates/openapi/ts/src/index.ts

@@ -0,0 +1,29 @@
+import { OpenAPIRouter } from "@cloudflare/itty-router-openapi";
+import { TaskList } from "./endpoints/taskList";
+import { TaskCreate } from "./endpoints/taskCreate";
+import { TaskFetch } from "./endpoints/taskFetch";
+import { TaskDelete } from "./endpoints/taskDelete";
+
+export const router = OpenAPIRouter({
+	docs_url: "/",
+});
+
+router.get("/api/tasks/", TaskList);
+router.post("/api/tasks/", TaskCreate);
+router.get("/api/tasks/:taskSlug/", TaskFetch);
+router.delete("/api/tasks/:taskSlug/", TaskDelete);
+
+// 404 for everything else
+router.all("*", () =>
+	Response.json(
+		{
+			success: false,
+			error: "Route not found",
+		},
+		{ status: 404 }
+	)
+);
+
+export default {
+	fetch: router.handle,
+};

package/templates/openapi/ts/src/types.ts

@@ -0,0 +1,9 @@
+import { DateTime, Str } from "@cloudflare/itty-router-openapi";
+
+export const Task = {
+	name: new Str({ example: "lorem" }),
+	slug: String,
+	description: new Str({ required: false }),
+	completed: Boolean,
+	due_date: new DateTime(),
+};

package/templates/openapi/ts/tsconfig.json

@@ -0,0 +1,32 @@
+{
+	"compilerOptions": {
+		"allowJs": true,
+		"allowSyntheticDefaultImports": true,
+		"baseUrl": "src",
+		"declaration": true,
+		"sourceMap": true,
+		"esModuleInterop": true,
+		"inlineSourceMap": false,
+		"lib": ["esnext"],
+		"listEmittedFiles": false,
+		"listFiles": false,
+		"moduleResolution": "node",
+		"noFallthroughCasesInSwitch": true,
+		"pretty": true,
+		"resolveJsonModule": true,
+		"rootDir": ".",
+		"skipLibCheck": true,
+		"strict": false,
+		"traceResolution": false,
+		"outDir": "",
+		"target": "esnext",
+		"module": "esnext",
+		"types": [
+			"@types/node",
+			"@types/service-worker-mock",
+			"@cloudflare/workers-types"
+		]
+	},
+	"exclude": ["node_modules", "dist", "tests"],
+	"include": ["src", "scripts"]
+}

package/templates/openapi/ts/wrangler.toml

@@ -0,0 +1,3 @@
+name = "<TBD>"
+main = "src/index.ts"
+compatibility_date = "<TBD>"

package/templates/queues/js/package.json

@@ -4,6 +4,7 @@
 	"private": true,
 	"scripts": {
 		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
 		"start": "wrangler dev"
 	},
 	"devDependencies": {

package/templates/queues/ts/package.json

@@ -4,6 +4,7 @@
 	"private": true,
 	"scripts": {
 		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
 		"start": "wrangler dev"
 	},
 	"devDependencies": {

package/templates/scheduled/js/package.json

@@ -4,6 +4,7 @@
 	"private": true,
 	"scripts": {
 		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
 		"start": "wrangler dev"
 	},
 	"devDependencies": {

package/templates/scheduled/js/wrangler.toml

@@ -1,5 +1,5 @@
 name = "<TBD>"
-main = "src/index.ts"
+main = "src/index.js"
 compatibility_date = "<TBD>"
 
 # Cron Triggers

package/templates/scheduled/ts/package.json

@@ -4,6 +4,7 @@
 	"private": true,
 	"scripts": {
 		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
 		"start": "wrangler dev"
 	},
 	"devDependencies": {