npm - create-cloudflare - Versions diffs - 0.0.0-e3136f935 → 0.0.0-e34d19867 - Mend

create-cloudflare 0.0.0-e3136f935 → 0.0.0-e34d19867

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (327) hide show

package/templates/hello-world-durable-object-with-assets/js/package.json ADDED Viewed

@@ -0,0 +1,13 @@
+{
+	"name": "<TBD>",
+	"version": "0.0.0",
+	"private": true,
+	"scripts": {
+		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
+		"start": "wrangler dev"
+	},
+	"devDependencies": {
+		"wrangler": "^3.101.0"
+	}
+}

package/{templates-experimental/hello-world-with-assets/ts → templates/hello-world-durable-object-with-assets/js}/public/index.html RENAMED Viewed

@@ -1,4 +1,4 @@
-<!doctype html>
+<!DOCTYPE html>
 <html lang="en">
 	<head>
 		<meta charset="UTF-8" />
@@ -8,7 +8,7 @@
 	<body>
 		<h1 id="heading"></h1>
 		<script>
-			fetch('/api')
+			fetch('/message')
 				.then((resp) => resp.text())
 				.then((text) => {
 					const h1 = document.getElementById('heading');

package/templates/hello-world-durable-object-with-assets/js/src/index.js ADDED Viewed

@@ -0,0 +1,70 @@
+import { DurableObject } from "cloudflare:workers";
+/**
+ * Welcome to Cloudflare Workers! This is your first Durable Objects application.
+ *
+ * - Run `npm run dev` in your terminal to start a development server
+ * - Open a browser tab at http://localhost:8787/ to see your Durable Object in action
+ * - Run `npm run deploy` to publish your application
+ *
+ * Learn more at https://developers.cloudflare.com/durable-objects
+ */
+/**
+ * Env provides a mechanism to reference bindings declared in wrangler.jsonc within JavaScript
+ *
+ * @typedef {Object} Env
+ * @property {DurableObjectNamespace} MY_DURABLE_OBJECT - The Durable Object namespace binding
+ */
+/** A Durable Object's behavior is defined in an exported Javascript class */
+export class MyDurableObject extends DurableObject {
+	/**
+	 * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
+	 * 	`DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
+	 *
+	 * @param {DurableObjectState} ctx - The interface for interacting with Durable Object state
+	 * @param {Env} env - The interface to reference bindings declared in wrangler.jsonc
+	 */
+	constructor(ctx, env) {
+		super(ctx, env);
+	}
+	/**
+	 * The Durable Object exposes an RPC method sayHello which will be invoked when when a Durable
+	 *  Object instance receives a request from a Worker via the same method invocation on the stub
+	 *
+	 * @param {string} name - The name provided to a Durable Object instance from a Worker
+	 * @returns {Promise<string>} The greeting to be sent back to the Worker
+	 */
+	async sayHello(name) {
+		return `Hello, ${name}!`;
+	}
+}
+export default {
+	/**
+	 * This is the standard fetch handler for a Cloudflare Worker
+	 *
+	 * @param {Request} request - The request submitted to the Worker from the client
+	 * @param {Env} env - The interface to reference bindings declared in wrangler.jsonc
+	 * @param {ExecutionContext} ctx - The execution context of the Worker
+	 * @returns {Promise<Response>} The response to be sent back to the client
+	 */
+	async fetch(request, env, ctx) {
+		// Create a `DurableObjectId` for an instance of the `MyDurableObject`
+		// class named "foo". Requests from all Workers to the instance named
+		// "foo" will go to a single globally unique Durable Object instance.
+		const id = env.MY_DURABLE_OBJECT.idFromName("foo");
+		// Create a stub to open a communication channel with the Durable
+		// Object instance.
+		const stub = env.MY_DURABLE_OBJECT.get(id);
+		// Call the `sayHello()` RPC method on the stub to invoke the method on
+		// the remote Durable Object instance
+		const greeting = await stub.sayHello("world");
+		return new Response(greeting);
+	}
+};

package/templates/hello-world-durable-object-with-assets/js/wrangler.jsonc ADDED Viewed

@@ -0,0 +1,28 @@
+{
+  "name": "<TBD>",
+  "main": "src/index.js",
+  "compatibility_date": "<TBD>",
+  "assets": {
+    "binding": "ASSETS",
+    "directory": "./public"
+  },
+  "durable_objects": {
+    "bindings": [
+      {
+        "class_name": "MyDurableObject",
+        "name": "MY_DURABLE_OBJECT"
+      }
+    ]
+  },
+  "migrations": [
+    {
+      "new_sqlite_classes": [
+        "MyDurableObject"
+      ],
+      "tag": "v1"
+    }
+  ],
+  "observability": {
+    "enabled": true
+  }
+}

package/templates/hello-world-durable-object-with-assets/py/.python-version ADDED Viewed

	@@ -0,0 +1 @@
1	+ 3.12

package/templates/hello-world-durable-object-with-assets/py/README.md ADDED Viewed

@@ -0,0 +1,23 @@
+## Usage
+You can run the Worker defined by your new project by executing `wrangler dev` in this
+directory. This will start up an HTTP server and will allow you to iterate on your
+Worker without having to restart `wrangler`.
+### Types and autocomplete
+This project also includes a pyproject.toml and uv.lock file with some requirements which
+set up autocomplete and type hints for this Python Workers project.
+To get these installed you'll need `uv`, which you can install by following
+https://docs.astral.sh/uv/getting-started/installation/.
+Once `uv` is installed, you can run the following:
+```
+uv venv
+uv sync
+```
+Then point your editor's Python plugin at the `.venv` directory. You should then have working
+autocomplete and type information in your editor.

package/templates/hello-world-durable-object-with-assets/py/package.json ADDED Viewed

@@ -0,0 +1,13 @@
+{
+	"name": "<TBD>",
+	"version": "0.0.0",
+	"private": true,
+	"scripts": {
+		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
+		"start": "wrangler dev"
+	},
+	"devDependencies": {
+		"wrangler": "^3.101.0"
+	}
+}

package/{templates-experimental/hello-world-with-assets → templates/hello-world-durable-object-with-assets}/py/public/index.html RENAMED Viewed

@@ -1,4 +1,4 @@
-<!doctype html>
+<!DOCTYPE html>
 <html lang="en">
 	<head>
 		<meta charset="UTF-8" />
@@ -8,10 +8,10 @@
 	<body>
 		<h1 id="heading"></h1>
 		<script>
-			fetch("/api")
+			fetch('/message')
 				.then((resp) => resp.text())
 				.then((text) => {
-					const h1 = document.getElementById("heading");
+					const h1 = document.getElementById('heading');
 					h1.textContent = text;
 				});
 		</script>

package/templates/hello-world-durable-object-with-assets/py/pyproject.toml ADDED Viewed

@@ -0,0 +1,9 @@
+[project]
+name = "<TBD>"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "webtypy>=0.1.7",
+]

package/templates/hello-world-durable-object-with-assets/py/src/entry.py ADDED Viewed

@@ -0,0 +1,66 @@
+from workers import DurableObject, Response
+"""
+ * Welcome to Cloudflare Workers! This is your first Durable Objects application.
+ *
+ * - Run `npm run dev` in your terminal to start a development server
+ * - Open a browser tab at http://localhost:8787/ to see your Durable Object in action
+ * - Run `npm run deploy` to publish your application
+ *
+ * Learn more at https://developers.cloudflare.com/durable-objects
+"""
+"""
+ * Env provides a mechanism to reference bindings declared in wrangler.jsonc within Python
+ *
+ * @typedef {Object} Env
+ * @property {DurableObjectNamespace} MY_DURABLE_OBJECT - The Durable Object namespace binding
+"""
+# A Durable Object's behavior is defined in an exported Python class
+class MyDurableObject(DurableObject):
+    """
+     * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
+     * `DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
+     *
+     * @param {DurableObjectState} ctx - The interface for interacting with Durable Object state
+     * @param {Env} env - The interface to reference bindings declared in wrangler.jsonc
+    """
+    def __init__(self, ctx, env):
+        super().__init__(ctx, env)
+    """
+     * The Durable Object exposes an RPC method `say_hello` which will be invoked when when a Durable
+     *  Object instance receives a request from a Worker via the same method invocation on the stub
+     *
+     * @param {string} name - The name provided to a Durable Object instance from a Worker
+     * @returns {Promise<string>} The greeting to be sent back to the Worker
+    """
+    async def say_hello(self, name):
+        return f"Hello, {name}!"
+"""
+* This is the standard fetch handler for a Cloudflare Worker
+*
+* @param {Request} request - The request submitted to the Worker from the client
+* @param {Env} env - The interface to reference bindings declared in wrangler.jsonc
+* @param {ExecutionContext} ctx - The execution context of the Worker
+* @returns {Promise<Response>} The response to be sent back to the client
+"""
+async def on_fetch(request, env, ctx):
+    # Create a `DurableObjectId` for an instance of the `MyDurableObject`
+    # class named "foo". Requests from all Workers to the instance named
+    # "foo" will go to a single globally unique Durable Object instance.
+    id = env.MY_DURABLE_OBJECT.idFromName("foo")
+    # Create a stub to open a communication channel with the Durable
+    # Object instance.
+    stub = env.MY_DURABLE_OBJECT.get(id)
+    # Call the `say_hello()` RPC method on the stub to invoke the method on
+    # the remote Durable Object instance
+    greeting = await stub.say_hello("world")
+    return Response(greeting)

package/templates/hello-world-durable-object-with-assets/py/uv.lock ADDED Viewed

@@ -0,0 +1,22 @@
+version = 1
+requires-python = ">=3.12"
+[[package]]
+name = "<TBD>"
+version = "0.1.0"
+source = { virtual = "." }
+dependencies = [
+    { name = "webtypy" },
+]
+[package.metadata]
+requires-dist = [{ name = "webtypy", specifier = ">=0.1.7" }]
+[[package]]
+name = "webtypy"
+version = "0.1.7"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/5e/89/c7a0311fdc73809fc2415be97767f085ff3e00c86546430034dc8465fee7/webtypy-0.1.7.tar.gz", hash = "sha256:1b7212719a949c802f3d60fac5f0d952eb503a92121409cf1ad9847d7c76a336", size = 104505 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/61/91/c731bdaa605279e00b28bfd2bf0ae67f48061d16890fb1c026924bfbd242/webtypy-0.1.7-py3-none-any.whl", hash = "sha256:f35e6d73a4e08783e23adfac271a11cda3a2bd1105499db70e4819244efed0ae", size = 103519 },
+]

package/templates/hello-world-durable-object-with-assets/py/wrangler.jsonc ADDED Viewed

@@ -0,0 +1,31 @@
+{
+  "name": "<TBD>",
+  "main": "src/entry.py",
+  "compatibility_date": "<TBD>",
+  "compatibility_flags": [
+    "python_workers"
+  ],
+  "assets": {
+    "binding": "ASSETS",
+    "directory": "./public"
+  },
+  "migrations": [
+    {
+      "new_sqlite_classes": [
+        "MyDurableObject"
+      ],
+      "tag": "v1"
+    }
+  ],
+  "durable_objects": {
+    "bindings": [
+      {
+        "class_name": "MyDurableObject",
+        "name": "MY_DURABLE_OBJECT"
+      }
+    ]
+  },
+  "observability": {
+    "enabled": true
+  }
+}

package/templates/hello-world-durable-object-with-assets/ts/package.json ADDED Viewed

@@ -0,0 +1,15 @@
+{
+	"name": "<TBD>",
+	"version": "0.0.0",
+	"private": true,
+	"scripts": {
+		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
+		"start": "wrangler dev",
+		"cf-typegen": "wrangler types"
+	},
+	"devDependencies": {
+		"typescript": "^5.5.2",
+		"wrangler": "^3.101.0"
+	}
+}

package/templates/hello-world-durable-object-with-assets/ts/public/index.html ADDED Viewed

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<title>Hello, World!</title>
+	</head>
+	<body>
+		<h1 id="heading"></h1>
+		<script>
+			fetch('/message')
+				.then((resp) => resp.text())
+				.then((text) => {
+					const h1 = document.getElementById('heading');
+					h1.textContent = text;
+				});
+		</script>
+	</body>
+</html>

package/templates/hello-world-durable-object-with-assets/ts/src/index.ts ADDED Viewed

@@ -0,0 +1,67 @@
+import { DurableObject } from "cloudflare:workers";
+/**
+ * Welcome to Cloudflare Workers! This is your first Durable Objects application.
+ *
+ * - Run `npm run dev` in your terminal to start a development server
+ * - Open a browser tab at http://localhost:8787/ to see your Durable Object in action
+ * - Run `npm run deploy` to publish your application
+ *
+ * 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/durable-objects
+ */
+/** A Durable Object's behavior is defined in an exported Javascript class */
+export class MyDurableObject extends DurableObject {
+	/**
+	 * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
+	 * 	`DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
+	 *
+	 * @param ctx - The interface for interacting with Durable Object state
+	 * @param env - The interface to reference bindings declared in wrangler.jsonc
+	 */
+	constructor(ctx: DurableObjectState, env: Env) {
+		super(ctx, env);
+	}
+	/**
+	 * The Durable Object exposes an RPC method sayHello which will be invoked when when a Durable
+	 *  Object instance receives a request from a Worker via the same method invocation on the stub
+	 *
+	 * @param name - The name provided to a Durable Object instance from a Worker
+	 * @returns The greeting to be sent back to the Worker
+	 */
+	async sayHello(name: string): Promise<string> {
+		return `Hello, ${name}!`;
+	}
+}
+export default {
+	/**
+	 * This is the standard fetch handler for a Cloudflare Worker
+	 *
+	 * @param request - The request submitted to the Worker from the client
+	 * @param env - The interface to reference bindings declared in wrangler.jsonc
+	 * @param ctx - The execution context of the Worker
+	 * @returns The response to be sent back to the client
+	 */
+	async fetch(request, env, ctx): Promise<Response> {
+		// Create a `DurableObjectId` for an instance of the `MyDurableObject`
+		// class named "foo". Requests from all Workers to the instance named
+		// "foo" will go to a single globally unique Durable Object instance.
+		const id: DurableObjectId = env.MY_DURABLE_OBJECT.idFromName("foo");
+		// Create a stub to open a communication channel with the Durable
+		// Object instance.
+		const stub = env.MY_DURABLE_OBJECT.get(id);
+		// Call the `sayHello()` RPC method on the stub to invoke the method on
+		// the remote Durable Object instance
+		const greeting = await stub.sayHello("world");
+		return new Response(greeting);
+	},
+} satisfies ExportedHandler<Env>;

package/templates/hello-world-durable-object-with-assets/ts/tsconfig.json ADDED Viewed

@@ -0,0 +1,40 @@
+{
+	"compilerOptions": {
+		/* Visit https://aka.ms/tsconfig.json to read more about this file */
+    /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+		"target": "es2021",
+    /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+		"lib": ["es2021"],
+    /* Specify what JSX code is generated. */
+		"jsx": "react-jsx",
+    /* Specify what module code is generated. */
+		"module": "es2022",
+    /* Specify how TypeScript looks up a file from a given module specifier. */
+		"moduleResolution": "node",
+    /* Enable importing .json files */
+		"resolveJsonModule": true,
+    /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+		"allowJs": true,
+    /* Enable error reporting in type-checked JavaScript files. */
+		"checkJs": false,
+    /* Disable emitting files from a compilation. */
+		"noEmit": true,
+    /* Ensure that each file can be safely transpiled without relying on other imports. */
+		"isolatedModules": true,
+    /* Allow 'import x from y' when a module doesn't have a default export. */
+		"allowSyntheticDefaultImports": true,
+    /* Ensure that casing is correct in imports. */
+		"forceConsistentCasingInFileNames": true,
+    /* Enable all strict type-checking options. */
+		"strict": true,
+    /* Skip type checking all .d.ts files. */
+		"skipLibCheck": true
+	}
+}

package/templates/hello-world-durable-object-with-assets/ts/wrangler.jsonc ADDED Viewed

@@ -0,0 +1,28 @@
+{
+  "name": "<TBD>",
+  "main": "src/index.ts",
+  "compatibility_date": "<TBD>",
+  "migrations": [
+    {
+      "new_sqlite_classes": [
+        "MyDurableObject"
+      ],
+      "tag": "v1"
+    }
+  ],
+  "assets": {
+    "binding": "ASSETS",
+    "directory": "./public"
+  },
+  "durable_objects": {
+    "bindings": [
+      {
+        "class_name": "MyDurableObject",
+        "name": "MY_DURABLE_OBJECT"
+      }
+    ]
+  },
+  "observability": {
+    "enabled": true
+  }
+}

package/templates/hello-world-with-assets/c3.ts ADDED Viewed

@@ -0,0 +1,25 @@
+import type { TemplateConfig } from "../../src/templates";
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "hello-world-with-assets",
+	path: "templates/hello-world-with-assets",
+	displayName: "SSR / full-stack app",
+	description:
+		"For sites with a backend API, or server-side rendering (SSR). Uses Static Assets with a Worker.",
+	platform: "workers",
+	copyFiles: {
+		variants: {
+			js: {
+				path: "./js",
+			},
+			ts: {
+				path: "./ts",
+			},
+			python: {
+				path: "./py",
+			},
+		},
+	},
+};
+export default config;

package/templates/hello-world-with-assets/js/.editorconfig ADDED Viewed

@@ -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/hello-world-with-assets/js/.prettierrc ADDED Viewed

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