create-cloudflare 0.0.0-e6ddf8a7 → 0.0.0-e7982641

package/templates/svelte/c3.ts

@@ -0,0 +1,129 @@
+import { platform } from "node:os";
+import { logRaw, updateStatus } from "@cloudflare/cli";
+import { blue, brandColor, dim } from "@cloudflare/cli/colors";
+import { transformFile } from "helpers/codemod";
+import { installPackages, runFrameworkGenerator } from "helpers/command";
+import { usesTypescript } from "helpers/files";
+import { detectPackageManager } from "helpers/packages";
+import * as recast from "recast";
+import type { TemplateConfig } from "../../src/templates";
+import type { C3Context, PackageJson } 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)}`,
+	});
+
+	updateSvelteConfig();
+	updateTypeDefinitions(ctx);
+};
+
+const updateSvelteConfig = () => {
+	// All we need to do is change the import statement in svelte.config.js
+	updateStatus(`Changing adapter in ${blue("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;
+		},
+	});
+};
+
+const updateTypeDefinitions = (ctx: C3Context) => {
+	if (!usesTypescript(ctx)) {
+		return;
+	}
+
+	updateStatus(`Updating global type definitions in ${blue("app.d.ts")}`);
+
+	const b = recast.types.builders;
+
+	transformFile("src/app.d.ts", {
+		visitTSModuleDeclaration(n) {
+			if (n.value.id.name === "App" && n.node.body) {
+				const moduleBlock = n.node
+					.body as recast.types.namedTypes.TSModuleBlock;
+
+				const platformInterface = b.tsInterfaceDeclaration(
+					b.identifier("Platform"),
+					b.tsInterfaceBody([
+						b.tsPropertySignature(
+							b.identifier("env"),
+							b.tsTypeAnnotation(b.tsTypeReference(b.identifier("Env")))
+						),
+						b.tsPropertySignature(
+							b.identifier("cf"),
+							b.tsTypeAnnotation(
+								b.tsTypeReference(b.identifier("CfProperties"))
+							)
+						),
+						b.tsPropertySignature(
+							b.identifier("ctx"),
+							b.tsTypeAnnotation(
+								b.tsTypeReference(b.identifier("ExecutionContext"))
+							)
+						),
+					])
+				);
+
+				moduleBlock.body.unshift(platformInterface);
+			}
+
+			this.traverse(n);
+		},
+	});
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "svelte",
+	displayName: "Svelte",
+	platform: "pages",
+	copyFiles: {
+		variants: {
+			js: { path: "./js" },
+			ts: { path: "./ts" },
+		},
+	},
+	generate,
+	configure,
+	transformPackageJson: async (original: PackageJson, ctx: C3Context) => {
+		let scripts: Record<string, string> = {
+			preview: `${npm} run build && wrangler pages dev .svelte-kit/cloudflare`,
+			deploy: `${npm} run build && wrangler pages deploy .svelte-kit/cloudflare`,
+		};
+
+		if (usesTypescript(ctx)) {
+			const mv = platform() === "win32" ? "move" : "mv";
+			scripts = {
+				...scripts,
+				"build-cf-types": `wrangler types && ${mv} worker-configuration.d.ts src/`,
+			};
+		}
+
+		return { scripts };
+	},
+	devScript: "dev",
+	deployScript: "deploy",
+	previewScript: "preview",
+};
+export default config;

package/templates/svelte/js/src/hooks.server.js

@@ -0,0 +1,25 @@
+import { dev } from '$app/environment';
+
+/*
+  When developing, this hook will add proxy objects to the `platform` object which
+  will emulate any bindings defined in `wrangler.toml`.
+*/
+
+let platform;
+
+if (dev) {
+	const { getPlatformProxy } = await import('wrangler');
+	platform = await getPlatformProxy();
+}
+
+export const handle = async ({ event, resolve }) => {
+	if (platform) {
+		event.platform = {
+			...event.platform,
+			...platform
+		};
+	}
+
+	return resolve(event);
+};
+

package/templates/svelte/js/wrangler.toml

@@ -0,0 +1,50 @@
+name = "<TBD>"
+compatibility_date = "<TBD>"
+
+# Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
+# Note: Use secrets to store sensitive data.
+# Docs: https://developers.cloudflare.com/workers/platform/environment-variables
+# [vars]
+# MY_VARIABLE = "production_value"
+
+# Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
+# Docs: https://developers.cloudflare.com/workers/runtime-apis/kv
+# [[kv_namespaces]]
+# binding = "MY_KV_NAMESPACE"
+# id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+
+# Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
+# Docs: https://developers.cloudflare.com/r2/api/workers/workers-api-usage/
+# [[r2_buckets]]
+# binding = "MY_BUCKET"
+# bucket_name = "my-bucket"
+
+# 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]]
+# 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]]
+# queue = "my-queue"
+
+# Bind another Worker service. Use this binding to call another Worker without network overhead.
+# Docs: https://developers.cloudflare.com/workers/platform/services
+# [[services]]
+# binding = "MY_SERVICE"
+# service = "my-service"
+
+# Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
+# Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
+# Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
+# [[durable_objects.bindings]]
+# name = "MY_DURABLE_OBJECT"
+# class_name = "MyDurableObject"
+
+# Durable Object migrations.
+# Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
+# [[migrations]]
+# tag = "v1"
+# new_classes = ["MyDurableObject"]

package/templates/svelte/ts/src/hooks.server.ts

@@ -0,0 +1,24 @@
+import { dev } from '$app/environment';
+
+/*
+  When developing, this hook will add proxy objects to the `platform` object which
+  will emulate any bindings defined in `wrangler.toml`.
+*/
+
+let platform: App.Platform;
+
+if (dev) {
+	const { getPlatformProxy } = await import('wrangler');
+	platform = await getPlatformProxy();
+}
+
+export const handle = async ({ event, resolve }) => {
+	if (platform) {
+		event.platform = {
+			...event.platform,
+			...platform
+		};
+	}
+
+	return resolve(event);
+};

package/templates/svelte/ts/wrangler.toml

@@ -0,0 +1,50 @@
+name = "<TBD>"
+compatibility_date = "<TBD>"
+
+# Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
+# Note: Use secrets to store sensitive data.
+# Docs: https://developers.cloudflare.com/workers/platform/environment-variables
+# [vars]
+# MY_VARIABLE = "production_value"
+
+# Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
+# Docs: https://developers.cloudflare.com/workers/runtime-apis/kv
+# [[kv_namespaces]]
+# binding = "MY_KV_NAMESPACE"
+# id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+
+# Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
+# Docs: https://developers.cloudflare.com/r2/api/workers/workers-api-usage/
+# [[r2_buckets]]
+# binding = "MY_BUCKET"
+# bucket_name = "my-bucket"
+
+# 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]]
+# 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]]
+# queue = "my-queue"
+
+# Bind another Worker service. Use this binding to call another Worker without network overhead.
+# Docs: https://developers.cloudflare.com/workers/platform/services
+# [[services]]
+# binding = "MY_SERVICE"
+# service = "my-service"
+
+# Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
+# Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
+# Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
+# [[durable_objects.bindings]]
+# name = "MY_DURABLE_OBJECT"
+# class_name = "MyDurableObject"
+
+# Durable Object migrations.
+# Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
+# [[migrations]]
+# tag = "v1"
+# new_classes = ["MyDurableObject"]

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>"