create-cloudflare 0.0.0-e2a6fa40 → 0.0.0-e2f5756c2

package/templates/openapi/c3.ts

@@ -0,0 +1,10 @@
+export default {
+	configVersion: 1,
+	id: "openapi",
+	displayName: "API starter (OpenAPI compliant)",
+	description: "Get started building a basic API on Workers",
+	platform: "workers",
+	copyFiles: {
+		path: "./ts",
+	},
+};

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 [chanfana](https://github.com/cloudflare/chanfana) and [Hono](https://github.com/honojs/hono).
+
+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 [chanfana documentation](https://chanfana.pages.dev/) and [Hono documentation](https://hono.dev/docs).
+
+## Development
+
+1. Run `wrangler dev` to start a local instance of the API.
+2. Open `http://localhost:8787/` 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/__dot__gitignore

@@ -0,0 +1,171 @@
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+\*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+\*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+\*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+\*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.cache
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+.cache/
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+.cache
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.\*
+
+# wrangler project
+
+.dev.vars

package/templates/openapi/ts/package.json

@@ -0,0 +1,21 @@
+{
+	"name": "cloudflare-workers-openapi",
+	"version": "0.0.1",
+	"private": true,
+	"scripts": {
+		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
+		"start": "wrangler dev",
+		"cf-typegen": "wrangler types"
+	},
+	"dependencies": {
+		"chanfana": "^2.0.2",
+		"zod": "^3.23.8",
+		"hono": "^4.4.7"
+	},
+	"devDependencies": {
+		"@types/node": "20.8.3",
+		"@types/service-worker-mock": "^2.0.1",
+		"wrangler": "^3.101.0"
+	}
+}

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

@@ -0,0 +1,58 @@
+import { Bool, OpenAPIRoute } from "chanfana";
+import { z } from "zod";
+import { Task } from "../types";
+
+export class TaskCreate extends OpenAPIRoute {
+	schema = {
+		tags: ["Tasks"],
+		summary: "Create a new Task",
+		request: {
+			body: {
+				content: {
+					"application/json": {
+						schema: Task,
+					},
+				},
+			},
+		},
+		responses: {
+			"200": {
+				description: "Returns the created task",
+				content: {
+					"application/json": {
+						schema: z.object({
+							series: z.object({
+								success: Bool(),
+								result: z.object({
+									task: Task,
+								}),
+							}),
+						}),
+					},
+				},
+			},
+		},
+	};
+
+	async handle(c) {
+		// Get validated data
+		const data = await this.getValidatedData<typeof this.schema>();
+
+		// 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,56 @@
+import { Bool, OpenAPIRoute, Str } from "chanfana";
+import { z } from "zod";
+import { Task } from "../types";
+
+export class TaskDelete extends OpenAPIRoute {
+	schema = {
+		tags: ["Tasks"],
+		summary: "Delete a Task",
+		request: {
+			params: z.object({
+				taskSlug: Str({ description: "Task slug" }),
+			}),
+		},
+		responses: {
+			"200": {
+				description: "Returns if the task was deleted successfully",
+				content: {
+					"application/json": {
+						schema: z.object({
+							series: z.object({
+								success: Bool(),
+								result: z.object({
+									task: Task,
+								}),
+							}),
+						}),
+					},
+				},
+			},
+		},
+	};
+
+	async handle(c) {
+		// Get validated data
+		const data = await this.getValidatedData<typeof this.schema>();
+
+		// 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,81 @@
+import { Bool, OpenAPIRoute, Str } from "chanfana";
+import { z } from "zod";
+import { Task } from "../types";
+
+export class TaskFetch extends OpenAPIRoute {
+	schema = {
+		tags: ["Tasks"],
+		summary: "Get a single Task by slug",
+		request: {
+			params: z.object({
+				taskSlug: Str({ description: "Task slug" }),
+			}),
+		},
+		responses: {
+			"200": {
+				description: "Returns a single task if found",
+				content: {
+					"application/json": {
+						schema: z.object({
+							series: z.object({
+								success: Bool(),
+								result: z.object({
+									task: Task,
+								}),
+							}),
+						}),
+					},
+				},
+			},
+			"404": {
+				description: "Task not found",
+				content: {
+					"application/json": {
+						schema: z.object({
+							series: z.object({
+								success: Bool(),
+								error: Str(),
+							}),
+						}),
+					},
+				},
+			},
+		},
+	};
+
+	async handle(c) {
+		// Get validated data
+		const data = await this.getValidatedData<typeof this.schema>();
+
+		// 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,69 @@
+import { Bool, Num, OpenAPIRoute } from "chanfana";
+import { z } from "zod";
+import { Task } from "../types";
+
+export class TaskList extends OpenAPIRoute {
+	schema = {
+		tags: ["Tasks"],
+		summary: "List Tasks",
+		request: {
+			query: z.object({
+				page: Num({
+					description: "Page number",
+					default: 0,
+				}),
+				isCompleted: Bool({
+					description: "Filter by completed flag",
+					required: false,
+				}),
+			}),
+		},
+		responses: {
+			"200": {
+				description: "Returns a list of tasks",
+				content: {
+					"application/json": {
+						schema: z.object({
+							series: z.object({
+								success: Bool(),
+								result: z.object({
+									tasks: Task.array(),
+								}),
+							}),
+						}),
+					},
+				},
+			},
+		},
+	};
+
+	async handle(c) {
+		// Get validated data
+		const data = await this.getValidatedData<typeof this.schema>();
+
+		// 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,23 @@
+import { fromHono } from "chanfana";
+import { Hono } from "hono";
+import { TaskCreate } from "./endpoints/taskCreate";
+import { TaskDelete } from "./endpoints/taskDelete";
+import { TaskFetch } from "./endpoints/taskFetch";
+import { TaskList } from "./endpoints/taskList";
+
+// Start a Hono app
+const app = new Hono();
+
+// Setup OpenAPI registry
+const openapi = fromHono(app, {
+	docs_url: "/",
+});
+
+// Register OpenAPI endpoints
+openapi.get("/api/tasks", TaskList);
+openapi.post("/api/tasks", TaskCreate);
+openapi.get("/api/tasks/:taskSlug", TaskFetch);
+openapi.delete("/api/tasks/:taskSlug", TaskDelete);
+
+// Export the Hono app
+export default app;

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

@@ -0,0 +1,10 @@
+import { DateTime, Str } from "chanfana";
+import { z } from "zod";
+
+export const Task = z.object({
+	name: Str({ example: "lorem" }),
+	slug: Str(),
+	description: Str({ required: false }),
+	completed: z.boolean().default(false),
+	due_date: 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/worker-configuration.d.ts

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

package/templates/openapi/ts/wrangler.json

@@ -0,0 +1,8 @@
+{
+  "name": "<TBD>",
+  "main": "src/index.ts",
+  "compatibility_date": "<TBD>",
+  "observability": {
+    "enabled": true
+  }
+}

package/templates/pre-existing/c3.ts

@@ -0,0 +1,102 @@
+import { cp, mkdtemp } from "fs/promises";
+import { tmpdir } from "os";
+import { join } from "path";
+import { brandColor, dim } from "@cloudflare/cli/colors";
+import { processArgument } from "helpers/args";
+import { runCommand } from "helpers/command";
+import { detectPackageManager } from "helpers/packageManagers";
+import { chooseAccount, wranglerLogin } from "../../src/wrangler/accounts";
+import type { C3Context } from "types";
+
+export async function copyExistingWorkerFiles(ctx: C3Context) {
+	const { dlx } = detectPackageManager();
+
+	if (ctx.args.existingScript === undefined) {
+		ctx.args.existingScript = await processArgument(
+			ctx.args,
+			"existingScript",
+			{
+				type: "text",
+				question:
+					"Please specify the name of the existing worker in this account?",
+				label: "worker",
+				defaultValue: ctx.project.name,
+			},
+		);
+	}
+
+	// `wrangler init --from-dash` bails if you opt-out of creating a package.json
+	// so run it (with -y) in a tempdir and copy the src files after
+	const tempdir = await mkdtemp(join(tmpdir(), "c3-wrangler-init--from-dash-"));
+	await runCommand(
+		[
+			...dlx,
+			"wrangler@3",
+			"init",
+			"--from-dash",
+			ctx.args.existingScript,
+			"-y",
+			"--no-delegate-c3",
+		],
+		{
+			silent: true,
+			cwd: tempdir, // use a tempdir because we don't want all the files
+			env: { CLOUDFLARE_ACCOUNT_ID: ctx.account?.id },
+			startText: "Downloading existing worker files",
+			doneText: `${brandColor("downloaded")} ${dim(
+				`existing "${ctx.args.existingScript}" worker files`,
+			)}`,
+		},
+	);
+
+	// copy src/* files from the downloaded Worker
+	await cp(
+		join(tempdir, ctx.args.existingScript, "src"),
+		join(ctx.project.path, "src"),
+		{ recursive: true },
+	);
+
+	// copy wrangler.toml from the downloaded Worker
+	await cp(
+		join(tempdir, ctx.args.existingScript, "wrangler.toml"),
+		join(ctx.project.path, "wrangler.toml"),
+	);
+}
+
+export default {
+	configVersion: 1,
+	id: "pre-existing",
+	displayName: "Pre-existing Worker (from Dashboard)",
+	platform: "workers",
+	hidden: true,
+	copyFiles: {
+		path: "./js",
+	},
+	configure: buildConfigure({
+		login: wranglerLogin,
+		chooseAccount,
+		copyFiles: copyExistingWorkerFiles,
+	}),
+};
+
+export interface ConfigureParams {
+	login: (ctx: C3Context) => Promise<boolean>;
+	chooseAccount: (ctx: C3Context) => Promise<void>;
+	copyFiles: (ctx: C3Context) => Promise<void>;
+}
+
+export function buildConfigure(params: ConfigureParams) {
+	return async function configure(ctx: C3Context) {
+		const loginSuccess = await params.login(ctx);
+
+		if (!loginSuccess) {
+			throw new Error("Failed to login to Cloudflare");
+		}
+
+		await params.chooseAccount(ctx);
+		await params.copyFiles(ctx);
+
+		// Force no-deploy since the Worker is already deployed
+		ctx.args.deploy = false;
+	};
+}

package/templates/pre-existing/js/.editorconfig

@@ -0,0 +1,12 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.yml]
+indent_style = space

package/templates/pre-existing/js/.prettierrc

@@ -0,0 +1,6 @@
+{
+	"printWidth": 140,
+	"singleQuote": true,
+	"semi": true,
+	"useTabs": true
+}