create-cloudflare 0.0.0-e33bb44a → 0.0.0-e4aff81a

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,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/__dot__gitignore

@@ -0,0 +1,172 @@
+# 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
+.wrangler/

package/templates/queues/js/package.json

@@ -4,11 +4,10 @@
 	"private": true,
 	"scripts": {
 		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
 		"start": "wrangler dev"
 	},
 	"devDependencies": {
-		"@cloudflare/workers-types": "^4.20230419.0",
-		"typescript": "^5.0.4",
 		"wrangler": "^3.0.0"
 	}
 }

package/templates/queues/js/wrangler.toml

@@ -1,16 +1,16 @@
 name = "<TBD>"
-main = "src/worker.js"
+main = "src/index.js"
 compatibility_date = "<TBD>"
 
 # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
 # Docs: https://developers.cloudflare.com/queues/get-started
-# [[queues.producers]]
+[[queues.producers]]
 binding = "MY_QUEUE"
 queue = "my-queue"
 
 # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
 # Docs: https://developers.cloudflare.com/queues/get-started
-# [[queues.consumers]]
+[[queues.consumers]]
 queue = "my-queue"
 # Optional: Configure batching and retries: https://developers.cloudflare.com/queues/learning/batching-retries/
 # max_batch_size = 10