create-cloudflare 0.0.0-4ce7a5de → 0.0.0-4d9d9e6c8

package/templates/analog/templates/wrangler.jsonc

@@ -0,0 +1,5 @@
+{
+  "name": "<TBD>",
+  "compatibility_date": "<TBD>",
+  "pages_build_output_dir": "./dist/analog/public"
+}

package/templates/angular/c3.ts

@@ -1,100 +1,9 @@
-import { resolve } from "node:path";
-import { logRaw } from "@cloudflare/cli";
-import { brandColor, dim } from "@cloudflare/cli/colors";
-import { spinner } from "@cloudflare/cli/interactive";
-import { runFrameworkGenerator } from "frameworks/index";
-import { compatDateFlag } from "helpers/compatDate";
-import { readFile, readJSON, writeFile } from "helpers/files";
-import { detectPackageManager } from "helpers/packageManagers";
-import { installPackages } from "helpers/packages";
-import type { TemplateConfig } from "../../src/templates";
-import type { C3Context } from "types";
+import pages from "./pages/c3";
+import workers from "./workers/c3";
+import type { MultiPlatformTemplateConfig } from "../../src/templates";
 
-const { npm } = detectPackageManager();
-
-const generate = async (ctx: C3Context) => {
-	await runFrameworkGenerator(ctx, [ctx.project.name, "--ssr"]);
-	logRaw("");
-};
-
-const configure = async (ctx: C3Context) => {
-	updateAngularJson(ctx);
-	await updateAppCode();
-	await installCFWorker();
-};
-
-async function installCFWorker() {
-	await installPackages(
-		["@cloudflare/workers-types", "@miniflare/tre@next", "wrangler@beta"],
-		{
-			dev: true,
-			startText: "Installing adapter dependencies",
-			doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
-		}
-	);
-}
-async function updateAppCode() {
-	const s = spinner();
-	s.start(`Updating application code`);
-
-	// Update an app config file to:
-	// - add the `provideHttpClient(withFetch())` call to enable `fetch` usage in `HttpClient`
-	const appConfigPath = "src/app/app.config.ts";
-	const appConfig = readFile(resolve(appConfigPath));
-	const newAppConfig =
-		"import { provideHttpClient, withFetch } from '@angular/common/http';\n" +
-		appConfig.replace(
-			"providers: [",
-			"providers: [provideHttpClient(withFetch()), "
-		);
-	writeFile(resolve(appConfigPath), newAppConfig);
-	s.stop(`${brandColor(`updated`)} ${dim(appConfigPath)}`);
-
-	// Remove unwanted dependencies
-	s.start(`Updating package.json`);
-	const packageJsonPath = resolve("package.json");
-	const packageManifest = readJSON(packageJsonPath);
-
-	delete packageManifest["dependencies"]["@angular/ssr"];
-	delete packageManifest["dependencies"]["express"];
-
-	writeFile(packageJsonPath, JSON.stringify(packageManifest, null, 2));
-	s.stop(`${brandColor(`updated`)} ${dim(`\`package.json\``)}`);
-}
-
-function updateAngularJson(ctx: C3Context) {
-	const s = spinner();
-	s.start(`Updating angular.json config`);
-	const angularJson = readJSON(resolve("angular.json"));
-	// Update builder
-	const architectSection = angularJson.projects[ctx.project.name].architect;
-	architectSection.build.options.outputPath = "dist";
-	architectSection.build.options.assets.push("src/_routes.json");
-
-	writeFile(resolve("angular.json"), JSON.stringify(angularJson, null, 2));
-	s.stop(`${brandColor(`updated`)} ${dim(`\`angular.json\``)}`);
-}
-
-const config: TemplateConfig = {
-	configVersion: 1,
-	id: "angular",
+const config: MultiPlatformTemplateConfig = {
 	displayName: "Angular",
-	platform: "pages",
-	copyFiles: {
-		path: "./templates",
-	},
-	devScript: "start",
-	deployScript: "deploy",
-	generate,
-	configure,
-	transformPackageJson: async () => ({
-		scripts: {
-			start: `${npm} run build && wrangler pages dev dist/cloudflare ${await compatDateFlag()} --experimental-local`,
-			build: `ng build && ${npm} run process`,
-			process:
-				"node ./tools/copy-files.mjs && node ./tools/alter-polyfills.mjs",
-			deploy: `${npm} run build && wrangler pages deploy dist/cloudflare`,
-		},
-	}),
+	platformVariants: { pages, workers },
 };
 export default config;

package/templates/angular/pages/c3.ts

@@ -0,0 +1,134 @@
+import { resolve } from "node:path";
+import { logRaw } from "@cloudflare/cli";
+import { brandColor, dim } from "@cloudflare/cli/colors";
+import { spinner } from "@cloudflare/cli/interactive";
+import { runFrameworkGenerator } from "frameworks/index";
+import { compatDateFlag } from "helpers/compatDate";
+import { readFile, readJSON, writeFile } from "helpers/files";
+import { detectPackageManager } from "helpers/packageManagers";
+import { installPackages } from "helpers/packages";
+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,
+		"--ssr",
+		"--server-routing" /** Dev Preview API */,
+	]);
+	logRaw("");
+};
+
+const configure = async (ctx: C3Context) => {
+	updateAngularJson(ctx);
+	await updateAppCode();
+	await installCFWorker();
+};
+
+async function installCFWorker() {
+	await installPackages(["xhr2"], {
+		dev: true,
+		startText: "Installing additional dependencies",
+		doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
+	});
+}
+async function updateAppCode() {
+	const s = spinner();
+	s.start(`Updating application code`);
+
+	// Update an app config file to:
+	// - add the `provideHttpClient(withFetch())` call to enable `fetch` usage in `HttpClient`
+	const appConfigPath = "src/app/app.config.ts";
+	const appConfig = readFile(resolve(appConfigPath));
+	const newAppConfig =
+		"import { provideHttpClient, withFetch } from '@angular/common/http';\n" +
+		appConfig.replace(
+			"providers: [",
+			"providers: [provideHttpClient(withFetch()), ",
+		);
+	writeFile(resolve(appConfigPath), newAppConfig);
+	s.stop(`${brandColor(`updated`)} ${dim(appConfigPath)}`);
+
+	// Update an app server routes file to:
+	const appServerRoutesPath = "src/app/app.routes.server.ts";
+	const appRoutes = readFile(resolve(appServerRoutesPath));
+	const newAppRoutes = appRoutes.replace(
+		"RenderMode.Prerender",
+		"RenderMode.Server",
+	);
+	writeFile(resolve(appServerRoutesPath), newAppRoutes);
+	s.stop(`${brandColor(`updated`)} ${dim(appServerRoutesPath)}`);
+
+	// Remove unwanted dependencies
+	s.start(`Updating package.json`);
+	const packageJsonPath = resolve("package.json");
+	const packageManifest = readJSON(packageJsonPath) as PackageJson;
+
+	delete packageManifest["dependencies"]?.["express"];
+	delete packageManifest["devDependencies"]?.["@types/express"];
+
+	writeFile(packageJsonPath, JSON.stringify(packageManifest, null, 2));
+	s.stop(`${brandColor(`updated`)} ${dim(`\`package.json\``)}`);
+}
+
+function updateAngularJson(ctx: C3Context) {
+	const s = spinner();
+	s.start(`Updating angular.json config`);
+	const angularJson = readJSON("angular.json") as AngularJson;
+
+	// Update builder
+	const architectSection = angularJson.projects[ctx.project.name].architect;
+	architectSection.build.options.outputPath = "dist";
+	architectSection.build.options.outputMode = "server";
+	architectSection.build.options.ssr.experimentalPlatform = "neutral";
+	architectSection.build.options.assets.push("src/_routes.json");
+
+	writeFile(resolve("angular.json"), JSON.stringify(angularJson, null, 2));
+	s.stop(`${brandColor(`updated`)} ${dim(`\`angular.json\``)}`);
+}
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "angular",
+	frameworkCli: "@angular/create",
+	displayName: "Angular",
+	platform: "pages",
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates/angular/pages",
+	devScript: "start",
+	deployScript: "deploy",
+	previewScript: "start",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			start: `${npm} run build && wrangler pages dev dist/cloudflare ${await compatDateFlag()}`,
+			build: `ng build && ${npm} run process`,
+			process: "node ./tools/copy-files.mjs",
+			deploy: `${npm} run build && wrangler pages deploy dist/cloudflare`,
+		},
+	}),
+};
+export default config;
+
+type AngularJson = {
+	projects: Record<
+		string,
+		{
+			architect: {
+				build: {
+					options: {
+						outputPath: string;
+						outputMode: string;
+						ssr: Record<string, unknown>;
+						assets: string[];
+					};
+				};
+			};
+		}
+	>;
+};

package/templates/angular/pages/templates/src/server.ts

@@ -0,0 +1,15 @@
+import { AngularAppEngine, createRequestHandler } from '@angular/ssr';
+
+const angularApp = new AngularAppEngine();
+
+/**
+ * This is a request handler used by the Angular CLI (dev-server and during build).
+ */
+export const reqHandler = createRequestHandler(async (req) => {
+	const res = await angularApp.handle(req);
+
+	return res ?? new Response('Page not found.', { status: 404 });
+});
+
+
+export default { fetch: reqHandler };

package/templates/angular/pages/templates/tools/copy-files.mjs

@@ -0,0 +1,15 @@
+// Copy the files over so that they can be uploaded by the pages publish command.
+import fs from "node:fs";
+import { join, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const root = resolve(fileURLToPath(import.meta.url), "../../");
+const client = resolve(root, "dist/browser");
+const ssr = resolve(root, "dist/server");
+const cloudflare = resolve(root, "dist/cloudflare");
+const worker = resolve(cloudflare, "_worker.js");
+
+fs.cpSync(client, cloudflare, { recursive: true });
+fs.cpSync(ssr, worker, { recursive: true });
+
+fs.renameSync(join(worker, "server.mjs"), join(worker, "index.js"));

package/templates/angular/workers/c3.ts

@@ -0,0 +1,130 @@
+import { resolve } from "node:path";
+import { logRaw } from "@cloudflare/cli";
+import { brandColor, dim } from "@cloudflare/cli/colors";
+import { spinner } from "@cloudflare/cli/interactive";
+import { runFrameworkGenerator } from "frameworks/index";
+import { readFile, readJSON, writeFile } from "helpers/files";
+import { detectPackageManager } from "helpers/packageManagers";
+import { installPackages } from "helpers/packages";
+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,
+		"--ssr",
+		"--server-routing" /** Dev Preview API */,
+	]);
+	logRaw("");
+};
+
+const configure = async (ctx: C3Context) => {
+	updateAngularJson(ctx);
+	await updateAppCode();
+	await installCFWorker();
+};
+
+async function installCFWorker() {
+	await installPackages(["xhr2"], {
+		dev: true,
+		startText: "Installing additional dependencies",
+		doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
+	});
+}
+async function updateAppCode() {
+	const s = spinner();
+	s.start(`Updating application code`);
+
+	// Update an app config file to:
+	// - add the `provideHttpClient(withFetch())` call to enable `fetch` usage in `HttpClient`
+	const appConfigPath = "src/app/app.config.ts";
+	const appConfig = readFile(resolve(appConfigPath));
+	const newAppConfig =
+		"import { provideHttpClient, withFetch } from '@angular/common/http';\n" +
+		appConfig.replace(
+			"providers: [",
+			"providers: [provideHttpClient(withFetch()), ",
+		);
+	writeFile(resolve(appConfigPath), newAppConfig);
+	s.stop(`${brandColor(`updated`)} ${dim(appConfigPath)}`);
+
+	// Update an app server routes file to:
+	const appServerRoutesPath = "src/app/app.routes.server.ts";
+	const appRoutes = readFile(resolve(appServerRoutesPath));
+	const newAppRoutes = appRoutes.replace(
+		"RenderMode.Prerender",
+		"RenderMode.Server",
+	);
+	writeFile(resolve(appServerRoutesPath), newAppRoutes);
+	s.stop(`${brandColor(`updated`)} ${dim(appServerRoutesPath)}`);
+
+	// Remove unwanted dependencies
+	s.start(`Updating package.json`);
+	const packageJsonPath = resolve("package.json");
+	const packageManifest = readJSON(packageJsonPath) as PackageJson;
+
+	delete packageManifest["dependencies"]?.["express"];
+	delete packageManifest["devDependencies"]?.["@types/express"];
+
+	writeFile(packageJsonPath, JSON.stringify(packageManifest, null, 2));
+	s.stop(`${brandColor(`updated`)} ${dim(`\`package.json\``)}`);
+}
+
+function updateAngularJson(ctx: C3Context) {
+	const s = spinner();
+	s.start(`Updating angular.json config`);
+	const angularJson = readJSON(resolve("angular.json")) as AngularJson;
+	// Update builder
+	const architectSection = angularJson.projects[ctx.project.name].architect;
+	architectSection.build.options.outputPath = "dist";
+	architectSection.build.options.outputMode = "server";
+	architectSection.build.options.ssr.experimentalPlatform = "neutral";
+
+	writeFile(resolve("angular.json"), JSON.stringify(angularJson, null, 2));
+	s.stop(`${brandColor(`updated`)} ${dim(`\`angular.json\``)}`);
+}
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "angular",
+	frameworkCli: "@angular/create",
+	displayName: "Angular",
+	platform: "workers",
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates/angular/workers",
+	devScript: "start",
+	deployScript: "deploy",
+	previewScript: "start",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			start: `${npm} run build && wrangler dev`,
+			build: `ng build`,
+			deploy: `${npm} run build && wrangler deploy`,
+		},
+	}),
+};
+export default config;
+
+type AngularJson = {
+	projects: Record<
+		string,
+		{
+			architect: {
+				build: {
+					options: {
+						outputPath: string;
+						outputMode: string;
+						ssr: Record<string, unknown>;
+						assets: string[];
+					};
+				};
+			};
+		}
+	>;
+};

package/templates/angular/workers/templates/src/server.ts

@@ -0,0 +1,15 @@
+import { AngularAppEngine, createRequestHandler } from '@angular/ssr';
+
+const angularApp = new AngularAppEngine();
+
+/**
+ * This is a request handler used by the Angular CLI (dev-server and during build).
+ */
+export const reqHandler = createRequestHandler(async (req) => {
+	const res = await angularApp.handle(req);
+
+	return res ?? new Response('Page not found.', { status: 404 });
+});
+
+
+export default { fetch: reqHandler };

package/templates/angular/workers/templates/wrangler.jsonc

@@ -0,0 +1,12 @@
+{
+  "name": "<TBD>",
+  "main": "./dist/server/server.mjs",
+  "compatibility_date": "<TBD>",
+  "assets": {
+    "binding": "ASSETS",
+    "directory": "./dist/browser"
+  },
+  "observability": {
+    "enabled": true
+  }
+}

package/templates/astro/c3.ts

@@ -1,7 +1,7 @@
 import { logRaw, updateStatus } from "@cloudflare/cli";
 import { blue, brandColor, dim } from "@cloudflare/cli/colors";
 import { runFrameworkGenerator } from "frameworks/index";
-import { loadTemplateSnippets, transformFile } from "helpers/codemod";
+import { transformFile } from "helpers/codemod";
 import { runCommand } from "helpers/command";
 import { usesTypescript } from "helpers/files";
 import { detectPackageManager } from "helpers/packageManagers";
@@ -17,17 +17,16 @@ const generate = async (ctx: C3Context) => {
 	logRaw(""); // newline
 };
 
-const configure = async (ctx: C3Context) => {
+const configure = async () => {
 	await runCommand([npx, "astro", "add", "cloudflare", "-y"], {
 		silent: true,
 		startText: "Installing adapter",
 		doneText: `${brandColor("installed")} ${dim(
-			`via \`${npx} astro add cloudflare\``
+			`via \`${npx} astro add cloudflare\``,
 		)}`,
 	});
 
 	updateAstroConfig();
-	updateEnvDeclaration(ctx);
 };
 
 const updateAstroConfig = () => {
@@ -46,10 +45,10 @@ const updateAstroConfig = () => {
 			n.node.arguments = [
 				b.objectExpression([
 					b.objectProperty(
-						b.identifier("runtime"),
+						b.identifier("platformProxy"),
 						b.objectExpression([
-							b.objectProperty(b.identifier("mode"), b.stringLiteral("local")),
-						])
+							b.objectProperty(b.identifier("enabled"), b.booleanLiteral(true)),
+						]),
 					),
 				]),
 			];
@@ -59,42 +58,28 @@ const updateAstroConfig = () => {
 	});
 };
 
-const updateEnvDeclaration = (ctx: C3Context) => {
-	if (!usesTypescript(ctx)) {
-		return;
-	}
-
-	const filePath = "src/env.d.ts";
-
-	updateStatus(`Adding type declarations in ${blue(filePath)}`);
-
-	transformFile(filePath, {
-		visitProgram: function (n) {
-			const snippets = loadTemplateSnippets(ctx);
-			const patch = snippets.runtimeDeclarationTs;
-			const b = recast.types.builders;
-
-			// Preserve comments with the new body
-			const comments = n.get("comments").value;
-			n.node.comments = comments.map((c: recast.types.namedTypes.CommentLine) =>
-				b.commentLine(c.value)
-			);
-
-			// Add the patch
-			n.get("body").push(...patch);
-
-			return false;
-		},
-	});
-};
-
 const config: TemplateConfig = {
 	configVersion: 1,
 	id: "astro",
+	frameworkCli: "create-astro",
 	platform: "pages",
 	displayName: "Astro",
 	copyFiles: {
-		path: "./templates",
+		async selectVariant(ctx) {
+			// Note: this `selectVariant` function should not be needed
+			//       this is just a quick workaround until
+			//       https://github.com/cloudflare/workers-sdk/issues/7495
+			//       is resolved
+			return usesTypescript(ctx) ? "ts" : "js";
+		},
+		variants: {
+			js: {
+				path: "./templates/js",
+			},
+			ts: {
+				path: "./templates/ts",
+			},
+		},
 	},
 	devScript: "dev",
 	deployScript: "deploy",
@@ -103,9 +88,9 @@ const config: TemplateConfig = {
 	configure,
 	transformPackageJson: async (pkgJson: PackageJson, ctx: C3Context) => ({
 		scripts: {
-			deploy: `astro build && wrangler pages deploy ./dist`,
-			preview: `astro build && wrangler pages dev ./dist`,
-			...(usesTypescript(ctx) && { "build-cf-types": `wrangler types` }),
+			deploy: `astro build && wrangler pages deploy`,
+			preview: `astro build && wrangler pages dev`,
+			...(usesTypescript(ctx) && { "cf-typegen": `wrangler types` }),
 		},
 	}),
 };

package/templates/astro/templates/js/wrangler.jsonc

@@ -0,0 +1,8 @@
+{
+  "name": "<TBD>",
+  "compatibility_date": "<TBD>",
+  "compatibility_flags": [
+    "nodejs_compat"
+  ],
+  "pages_build_output_dir": "./dist"
+}

package/templates/astro/templates/ts/src/env.d.ts

@@ -0,0 +1,5 @@
+type Runtime = import("@astrojs/cloudflare").Runtime<Env>;
+
+declare namespace App {
+	interface Locals extends Runtime {}
+}

package/templates/astro/templates/ts/worker-configuration.d.ts

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

package/templates/astro/templates/ts/wrangler.jsonc

@@ -0,0 +1,8 @@
+{
+  "name": "<TBD>",
+  "compatibility_date": "<TBD>",
+  "compatibility_flags": [
+    "nodejs_compat"
+  ],
+  "pages_build_output_dir": "./dist"
+}

package/templates/common/c3.ts

@@ -2,7 +2,10 @@ export default {
 	configVersion: 1,
 	id: "common",
 	displayName: "Example router & proxy Worker",
+	description:
+		"Create a Worker to route and forward requests to other services",
 	platform: "workers",
+	hidden: true,
 	copyFiles: {
 		variants: {
 			js: {

package/templates/common/js/package.json

@@ -9,6 +9,6 @@
 	},
 	"devDependencies": {
 		"itty-router": "^3.0.12",
-		"wrangler": "^3.0.0"
+		"wrangler": "^3.101.0"
 	}
 }

package/templates/common/js/wrangler.jsonc

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

package/templates/common/ts/package.json

@@ -5,11 +5,12 @@
 	"scripts": {
 		"deploy": "wrangler deploy",
 		"dev": "wrangler dev",
-		"start": "wrangler dev"
+		"start": "wrangler dev",
+		"cf-typegen": "wrangler types"
 	},
 	"devDependencies": {
 		"itty-router": "^3.0.12",
-		"typescript": "^5.0.4",
-		"wrangler": "^3.0.0"
+		"typescript": "^5.5.2",
+		"wrangler": "^3.101.0"
 	}
 }

package/templates/common/ts/src/ab-test.ts

@@ -6,7 +6,7 @@ const EXPERIMENTS = [
 ];
 
 export default {
-	async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
+	async fetch(request, env, ctx): Promise<Response> {
 		const fingerprint = [request.headers.get('cf-connecting-ip'), request.cf?.postalCode]; // add any values you want considered as a fingerprint
 		const activeExperiments = await getActiveExperiments(fingerprint, EXPERIMENTS);
 
@@ -22,7 +22,7 @@ export default {
 
 		return rewriter.transform(res);
 	},
-};
+} satisfies ExportedHandler<Env>;
 
 // Get active experiments by hashing a fingerprint
 async function getActiveExperiments(fingerprint: unknown, experiments: Array<{ name: string; threshold: number }>) {

package/templates/common/ts/src/index.ts

@@ -5,6 +5,9 @@
  * - Open a browser tab at http://localhost:8787/ to see your worker in action
  * - Run `npm run deploy` to publish your worker
  *
+ * Bind resources to your Worker in `wrangler.jsonc`. After adding bindings, a type definition for the
+ * `Env` object can be regenerated with `npm run cf-typegen`.
+ *
  * Learn more at https://developers.cloudflare.com/workers/
  */
 
@@ -16,7 +19,7 @@ import apiRouter from './router';
 export default {
 	// The fetch handler is invoked when this worker receives a HTTP(S) request
 	// and should return a Response (optionally wrapped in a Promise)
-	async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
+	async fetch(request, env, ctx): Promise<Response> {
 		// You'll find it helpful to parse the request.url string into a URL object. Learn more at https://developer.mozilla.org/en-US/docs/Web/API/URL
 		const url = new URL(request.url);
 
@@ -43,4 +46,4 @@ export default {
 			{ headers: { 'Content-Type': 'text/html' } }
 		);
 	},
-};
+} satisfies ExportedHandler<Env>;