create-cloudflare 0.0.0-e6ddf8a7 → 0.0.0-e7ccc859

package/templates/queues/c3.ts

@@ -0,0 +1,24 @@
+export default {
+	configVersion: 1,
+	id: "queues",
+	displayName: "Queue consumer & producer Worker",
+	platform: "workers",
+	copyFiles: {
+		js: {
+			path: "./js",
+		},
+		ts: {
+			path: "./ts",
+		},
+	},
+	bindings: {
+		queues: [
+			{
+				boundVariable: "MY_QUEUE",
+				defaultValue: "my-queue",
+				producer: true,
+				consumer: true,
+			},
+		],
+	},
+};

package/templates/queues/ts/package.json

@@ -8,7 +8,6 @@
 		"start": "wrangler dev"
 	},
 	"devDependencies": {
-		"@cloudflare/workers-types": "^4.20230419.0",
 		"typescript": "^5.0.4",
 		"wrangler": "^3.0.0"
 	}

package/templates/qwik/c3.ts

@@ -0,0 +1,92 @@
+import { endSection } from "@cloudflare/cli";
+import { brandColor } from "@cloudflare/cli/colors";
+import { spinner } from "@cloudflare/cli/interactive";
+import { parseTs, transformFile } from "helpers/codemod";
+import { runCommand, runFrameworkGenerator } from "helpers/command";
+import { usesTypescript } from "helpers/files";
+import { detectPackageManager } from "helpers/packages";
+import { quoteShellArgs } from "../../src/common";
+import type { TemplateConfig } from "../../src/templates";
+import type * as recast from "recast";
+import type { C3Context } from "types";
+
+const { npm, npx } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, ["basic", ctx.project.name]);
+};
+
+const configure = async (ctx: C3Context) => {
+	// Add the pages integration
+	const cmd = [npx, "qwik", "add", "cloudflare-pages"];
+	endSection(`Running ${quoteShellArgs(cmd)}`);
+	await runCommand(cmd);
+
+	addBindingsProxy(ctx);
+};
+
+const addBindingsProxy = (ctx: C3Context) => {
+	// Qwik only has a typescript template atm.
+	// This check is an extra precaution
+	if (!usesTypescript(ctx)) {
+		return;
+	}
+
+	const s = spinner();
+	s.start("Updating `vite.config.ts`");
+
+	// Insert the env declaration after the last import (but before the rest of the body)
+	const envDeclaration = `
+let env = {};
+
+if(process.env.NODE_ENV === 'development') {
+  const { getBindingsProxy } = await import('wrangler');
+  const { bindings } = await getBindingsProxy();
+  env = bindings;
+}
+`;
+
+	transformFile("vite.config.ts", {
+		visitProgram: function (n) {
+			const lastImportIndex = n.node.body.findLastIndex(
+				(t) => t.type === "ImportDeclaration"
+			);
+			n.get("body").insertAt(lastImportIndex + 1, envDeclaration);
+
+			return false;
+		},
+	});
+
+	// Populate the `qwikCity` plugin with the platform object containing the `env` defined above.
+	const platformObject = parseTs(`{ platform: { env } }`);
+
+	transformFile("vite.config.ts", {
+		visitCallExpression: function (n) {
+			const callee = n.node.callee as recast.types.namedTypes.Identifier;
+			if (callee.name === "qwikCity") {
+				n.node.arguments = [platformObject];
+			}
+
+			this.traverse(n);
+		},
+	});
+
+	s.stop(`${brandColor("updated")} \`vite.config.ts\``);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "qwik",
+	displayName: "Qwik",
+	platform: "pages",
+	devScript: "dev",
+	deployScript: "deploy",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			deploy: `${npm} run build && wrangler pages deploy ./dist`,
+		},
+	}),
+};
+export default config;

package/templates/react/c3.ts

@@ -0,0 +1,29 @@
+import { logRaw } from "@cloudflare/cli";
+import { runFrameworkGenerator } from "helpers/command";
+import { compatDateFlag } from "helpers/files";
+import { detectPackageManager } from "helpers/packages";
+import type { TemplateConfig } from "../../src/templates";
+import type { C3Context } from "types";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, [ctx.project.name]);
+
+	logRaw("");
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "react",
+	displayName: "React",
+	platform: "pages",
+	generate,
+	transformPackageJson: async () => ({
+		scripts: {
+			"pages:dev": `wrangler pages dev ${await compatDateFlag()} --port 3000 -- ${npm} start`,
+			"pages:deploy": `${npm} run build && wrangler pages deploy ./build`,
+		},
+	}),
+};
+export default config;

package/templates/remix/c3.ts

@@ -0,0 +1,33 @@
+import { logRaw } from "@cloudflare/cli";
+import { runFrameworkGenerator } from "helpers/command.js";
+import { detectPackageManager } from "helpers/packages";
+import type { TemplateConfig } from "../../src/templates";
+import type { C3Context } from "types";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, [
+		ctx.project.name,
+		"--template",
+		"https://github.com/remix-run/remix/tree/main/templates/cloudflare-pages",
+	]);
+
+	logRaw(""); // newline
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "remix",
+	displayName: "Remix",
+	platform: "pages",
+	generate,
+	transformPackageJson: async () => ({
+		scripts: {
+			"pages:deploy": `${npm} run build && wrangler pages deploy ./public`,
+		},
+	}),
+	devScript: "dev",
+	testFlags: ["--typescript", "--no-install", "--no-git-init"],
+};
+export default config;

package/templates/scheduled/c3.ts

@@ -0,0 +1,14 @@
+export default {
+	configVersion: 1,
+	id: "scheduled",
+	displayName: "Scheduled Worker (Cron Trigger)",
+	platform: "workers",
+	copyFiles: {
+		js: {
+			path: "./js",
+		},
+		ts: {
+			path: "./ts",
+		},
+	},
+};

package/templates/scheduled/ts/package.json

@@ -8,7 +8,6 @@
 		"start": "wrangler dev"
 	},
 	"devDependencies": {
-		"@cloudflare/workers-types": "^4.20230419.0",
 		"typescript": "^5.0.4",
 		"wrangler": "^3.0.0"
 	}

package/templates/solid/c3.ts

@@ -0,0 +1,37 @@
+import { logRaw } from "@cloudflare/cli";
+import { runFrameworkGenerator } from "helpers/command";
+import { compatDateFlag } from "helpers/files";
+import { detectPackageManager } from "helpers/packages";
+import type { TemplateConfig } from "../../src/templates";
+import type { C3Context } from "types";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	// Run the create-solid command
+	await runFrameworkGenerator(ctx, [ctx.project.name]);
+
+	logRaw("");
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "solid",
+	displayName: "Solid",
+	platform: "pages",
+	copyFiles: {
+		js: { path: "./js" },
+		ts: { path: "./ts" },
+	},
+	generate,
+	transformPackageJson: async () => ({
+		scripts: {
+			"pages:preview": `${npm} run build && npx wrangler pages dev dist ${await compatDateFlag()} --compatibility-flag nodejs_compat`,
+			"pages:deploy": `${npm} run build && wrangler pages deploy ./dist`,
+		},
+	}),
+	devScript: "dev",
+	previewScript: "pages:preview",
+	compatibilityFlags: ["nodejs_compat"],
+};
+export default config;

package/templates/solid/js/vite.config.js

@@ -0,0 +1,12 @@
+import { defineConfig } from "@solidjs/start/config";
+
+export default defineConfig({
+    start: {
+        server: {
+            preset: "cloudflare-pages",
+            rollupConfig: {
+                external: ["node:async_hooks"]
+            },
+        }
+    }
+});

package/templates/solid/ts/vite.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from "@solidjs/start/config";
+
+export default defineConfig({
+    start: {
+        server: {
+            preset: "cloudflare-pages",
+            rollupConfig: {
+                external: ["node:async_hooks"]
+            },
+        }
+    }
+});

package/templates/svelte/c3.ts

@@ -0,0 +1,77 @@
+import { logRaw, updateStatus } from "@cloudflare/cli";
+import { blue, brandColor, dim } from "@cloudflare/cli/colors";
+import { parseTs, transformFile } from "helpers/codemod";
+import { installPackages, runFrameworkGenerator } from "helpers/command";
+import { compatDateFlag, usesTypescript } from "helpers/files";
+import { detectPackageManager } from "helpers/packages";
+import { platformInterface } from "./templates";
+import type { TemplateConfig } from "../../src/templates";
+import type * as recast from "recast";
+import type { C3Context } from "types";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, [ctx.project.name]);
+
+	logRaw("");
+};
+
+const configure = async (ctx: C3Context) => {
+	// Install the adapter
+	const pkg = `@sveltejs/adapter-cloudflare`;
+	await installPackages([pkg], {
+		dev: true,
+		startText: "Adding the Cloudflare Pages adapter",
+		doneText: `${brandColor(`installed`)} ${dim(pkg)}`,
+	});
+
+	// Change the import statement in svelte.config.js
+	transformFile("svelte.config.js", {
+		visitImportDeclaration: function (n) {
+			// importSource is the `x` in `import y from "x"`
+			const importSource = n.value.source;
+			if (importSource.value === "@sveltejs/adapter-auto") {
+				importSource.value = "@sveltejs/adapter-cloudflare";
+			}
+
+			// stop traversing this node
+			return false;
+		},
+	});
+	updateStatus(`Changing adapter in ${blue("svelte.config.js")}`);
+
+	// If using typescript, add the platform interface to the `App` interface
+	if (usesTypescript(ctx)) {
+		transformFile("src/app.d.ts", {
+			visitTSModuleDeclaration(n) {
+				if (n.value.id.name === "App") {
+					const patchAst = parseTs(platformInterface);
+					const body = n.node.body as recast.types.namedTypes.TSModuleBlock;
+					body.body.push(patchAst.program.body[0]);
+				}
+
+				this.traverse(n);
+			},
+		});
+		updateStatus(`Updating global type definitions in ${blue("app.d.ts")}`);
+	}
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "svelte",
+	displayName: "Svelte",
+	platform: "pages",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			"pages:preview": `${npm} run build && wrangler pages dev ${await compatDateFlag()} .svelte-kit/cloudflare`,
+			"pages:deploy": `${npm} run build && wrangler pages deploy .svelte-kit/cloudflare`,
+		},
+	}),
+	devScript: "dev",
+	previewScript: "pages:preview",
+};
+export default config;

package/templates/svelte/templates.ts

@@ -0,0 +1,13 @@
+export const platformInterface = `
+interface Platform {
+  env: {
+    COUNTER: DurableObjectNamespace;
+  };
+  context: {
+    waitUntil(promise: Promise<any>): void;
+  };
+  caches: CacheStorage & { default: Cache }
+}
+`;
+
+// interface["Platform"] #context #waitUntil:nth(2)

package/templates/vue/c3.ts

@@ -0,0 +1,27 @@
+import { runFrameworkGenerator } from "helpers/command";
+import { compatDateFlag } from "helpers/files";
+import { detectPackageManager } from "helpers/packages";
+import type { TemplateConfig } from "../../src/templates";
+import type { C3Context } from "types";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, [ctx.project.name]);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "vue",
+	displayName: "Vue",
+	platform: "pages",
+	generate,
+	transformPackageJson: async () => ({
+		scripts: {
+			"pages:dev": `wrangler pages dev ${await compatDateFlag()} --proxy 5173 -- ${npm} run dev`,
+			"pages:deploy": `${npm} run build && wrangler pages deploy ./dist`,
+		},
+	}),
+	testFlags: ["--ts"],
+};
+export default config;

package/templates/chatgptPlugin/ts/README.md

@@ -1,25 +0,0 @@
-# Example ChatGPT Plugin for Cloudflare Workers
-
-This is an example plugin showing how to build [ChatGPT plugins](https://platform.openai.com/docs/plugins/introduction) using [Cloudflare Workers](https://workers.dev). Using this example, you can deploy a plugin to Cloudflare Workers in just a few minutes.
-
-The sample plugin allows ChatGPT users to search for repositories using GitHub's search API. The plugin is implemented in TypeScript and uses the [OpenAPI](https://www.openapis.org/) specification to define the plugin's API.
-
-![Example conversation in ChatGPT showing the plugin in use](./.assets/example.png)
-
-## Get started
-
-0. Sign up for [Cloudflare Workers](https://workers.dev). The free tier is more than enough for most use cases.
-1. Install [wrangler](https://developers.cloudflare.com/workers/cli-wrangler/install-update), the Cloudflare Workers CLI
-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 plugin to Cloudflare Workers
-
-## Usage
-
-1. You can configure the `.well-known/ai-plugin.json` route in `index.ts`.
-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
-
-Follow the instructions [in the ChatGPT documentation](https://platform.openai.com/docs/plugins/introduction/plugin-flow) to deploy your plugin and begin using it in ChatGPT.

package/templates/chatgptPlugin/ts/package.json

@@ -1,17 +0,0 @@
-{
-	"name": "cloudflare-workers-chatgpt-plugin-example",
-	"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.20230404.0",
-		"wrangler": "^3.0.0"
-	}
-}

package/templates/chatgptPlugin/ts/src/index.ts

@@ -1,33 +0,0 @@
-import { OpenAPIRouter } from "@cloudflare/itty-router-openapi";
-import { GetSearch } from "./search";
-
-export const router = OpenAPIRouter({
-	schema: {
-		info: {
-			title: "GitHub Repositories Search API",
-			description:
-				"A plugin that allows the user to search for GitHub repositories using ChatGPT",
-			version: "v0.0.1",
-		},
-	},
-	docs_url: "/",
-	aiPlugin: {
-		name_for_human: "GitHub Repositories Search",
-		name_for_model: "github_repositories_search",
-		description_for_human: "GitHub Repositories Search plugin for ChatGPT.",
-		description_for_model:
-			"GitHub Repositories Search plugin for ChatGPT. You can search for GitHub repositories using this plugin.",
-		contact_email: "support@example.com",
-		legal_info_url: "http://www.example.com/legal",
-		logo_url: "https://workers.cloudflare.com/resources/logo/logo.svg",
-	},
-});
-
-router.get("/search", GetSearch);
-
-// 404 for everything else
-router.all("*", () => new Response("Not Found.", { status: 404 }));
-
-export default {
-	fetch: router.handle,
-};

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

@@ -1,59 +0,0 @@
-import { OpenAPIRoute, Query } from "@cloudflare/itty-router-openapi";
-
-export class GetSearch extends OpenAPIRoute {
-	static schema = {
-		tags: ["Search"],
-		summary: "Search repositories by a query parameter",
-		parameters: {
-			q: Query(String, {
-				description: "The query to search for",
-				default: "cloudflare workers",
-			}),
-		},
-		responses: {
-			"200": {
-				description: "Successfully response",
-				schema: {
-					repos: [
-						{
-							name: "itty-router-openapi",
-							description:
-								"OpenAPI 3 schema generator and validator for Cloudflare Workers",
-							stars: "80",
-							url: "https://github.com/cloudflare/itty-router-openapi",
-						},
-					],
-				},
-			},
-		},
-	};
-
-	async handle(request: Request, env, ctx, data: Record<string, any>) {
-		const url = `https://api.github.com/search/repositories?q=${data.query.q}`;
-
-		const resp = await fetch(url, {
-			headers: {
-				Accept: "application/vnd.github.v3+json",
-				"User-Agent": "RepoAI - Cloudflare Workers ChatGPT Plugin Example",
-			},
-		});
-
-		if (!resp.ok) {
-			return new Response(await resp.text(), { status: 400 });
-		}
-
-		const json = await resp.json();
-
-		// @ts-ignore
-		const repos = json.items.map((item: any) => ({
-			name: item.name,
-			description: item.description,
-			stars: item.stargazers_count,
-			url: item.html_url,
-		}));
-
-		return {
-			repos: repos,
-		};
-	}
-}

package/templates/chatgptPlugin/ts/wrangler.toml

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