create-cloudflare 0.0.0-e2a6fa40 → 0.0.0-e3990bbf

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-e2a6fa40";
+var version = "0.0.0-e3990bbf";
 var devDependencies = {
   "@babel/parser": "^7.21.3",
   "@babel/types": "^7.21.4",
@@ -61023,7 +61023,7 @@ function secondsSince(start) {
 }
 
 // ../wrangler/package.json
-var version2 = "3.7.0";
+var version2 = "3.8.0";
 
 // src/common.ts
 var { name, npm: npm11 } = detectPackageManager();
@@ -61627,6 +61627,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,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-cloudflare",
-  "version": "0.0.0-e2a6fa40",
+  "version": "0.0.0-e3990bbf",
   "description": "A CLI for creating and deploying new applications to Cloudflare.",
   "keywords": [
     "cloudflare",
@@ -62,7 +62,7 @@
     "@clack/core": "^0.3.2",
     "@types/semver": "^7.5.1",
     "@cloudflare/workers-tsconfig": "0.0.0",
-    "wrangler": "3.7.0"
+    "wrangler": "3.8.0"
   },
   "engines": {
     "node": ">=16.13.0"

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

@@ -7,7 +7,7 @@
 		"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/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,18 @@
+{
+	"name": "cloudflare-workers-openapi",
+	"version": "0.0.1",
+	"private": true,
+	"scripts": {
+		"deploy": "wrangler deploy",
+		"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>"