npm - create-cloudflare - Versions diffs - 0.0.0-e37c1b86 → 0.0.0-e39a45ffa - Mend

create-cloudflare 0.0.0-e37c1b86 → 0.0.0-e39a45ffa

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 (302) hide show

package/templates/hello-world/ts/vitest.config.mts ADDED Viewed

@@ -0,0 +1,11 @@
+import { defineWorkersConfig } from '@cloudflare/vitest-pool-workers/config';
+export default defineWorkersConfig({
+	test: {
+		poolOptions: {
+			workers: {
+				wrangler: { configPath: './wrangler.jsonc' },
+			},
+		},
+	},
+});

package/templates/hello-world/ts/wrangler.jsonc ADDED Viewed

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

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

@@ -0,0 +1,16 @@
+import type { TemplateConfig } from "../../src/templates";
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "hello-world-assets-only",
+	path: "templates/hello-world-assets-only",
+	displayName: "Static site",
+	description:
+		"For static sites or when using your own backend. Uses Workers Static Assets.",
+	platform: "workers",
+	copyFiles: {
+		path: "./templates",
+	},
+};
+export default config;

package/templates/hello-world-assets-only/templates/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.78.5"
+	}
+}

package/templates/hello-world-assets-only/templates/public/index.html ADDED Viewed

@@ -0,0 +1,12 @@
+<!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">Hello, World!</h1>
+		<p>This page comes from a static asset stored at `public/index.html` as configured in `wrangler.jsonc`.</p>
+	</body>
+</html>

package/templates/hello-world-assets-only/templates/wrangler.jsonc ADDED Viewed

@@ -0,0 +1,11 @@
+{
+  "name": "<TBD>",
+  "compatibility_date": "<TBD>",
+  "assets": {
+    // The path to the directory containing the `index.html` file to be served at `/`
+    "directory": "./public"
+  },
+  "observability": {
+    "enabled": true
+  }
+}

package/templates/hello-world-durable-object/c3.ts CHANGED Viewed

@@ -1,7 +1,11 @@
-export default {
+import type { TemplateConfig } from "../../src/templates";
+const config: TemplateConfig = {
 	configVersion: 1,
 	id: "hello-world-durable-object",
-	displayName: '"Hello World" Durable Object',
+	displayName: "Worker + Durable Objects",
+	description:
+		"For multiplayer apps using WebSockets, or when you need synchronization",
 	platform: "workers",
 	copyFiles: {
 		variants: {
@@ -11,6 +15,10 @@ export default {
 			ts: {
 				path: "./ts",
 			},
+			python: {
+				path: "./py",
+			},
 		},
 	},
 };
+export default config;

package/templates/hello-world-durable-object/js/.editorconfig CHANGED Viewed

@@ -3,7 +3,6 @@ root = true
 [*]
 indent_style = tab
-tab_width = 2
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true

package/templates/hello-world-durable-object/js/package.json CHANGED Viewed

@@ -8,6 +8,6 @@
 		"start": "wrangler dev"
 	},
 	"devDependencies": {
-		"wrangler": "^3.0.0"
+		"wrangler": "^3.101.0"
 	}
 }

package/templates/hello-world-durable-object/js/src/index.js CHANGED Viewed

@@ -1,3 +1,5 @@
+import { DurableObject } from "cloudflare:workers";
 /**
  * Welcome to Cloudflare Workers! This is your first Durable Objects application.
  *
@@ -9,32 +11,34 @@
  */
 /**
- * Env provides a mechanism to reference bindings declared in wrangler.toml within JavaScript
+ * 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 {
+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
+	 * 	`DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
 	 *
-	 * @param {DurableObjectState} state - The interface for interacting with Durable Object state
-	 * @param {Env} env - The interface to reference bindings declared in wrangler.toml
+	 * @param {DurableObjectState} ctx - The interface for interacting with Durable Object state
+	 * @param {Env} env - The interface to reference bindings declared in wrangler.jsonc
 	 */
-	constructor(state, env) {}
+	constructor(ctx, env) {
+		super(ctx, env);
+	}
 	/**
-	 * The Durable Object fetch handler will be invoked when a Durable Object instance receives a
-	 * 	request from a Worker via an associated stub
+	 * 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 {Request} request - The request submitted to a Durable Object instance from a Worker
-	 * @returns {Promise<Response>} The response to be sent back to the Worker
+	 * @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 fetch(request) {
-		return new Response('Hello World');
+	async sayHello(name) {
+		return `Hello, ${name}!`;
 	}
 }
@@ -43,23 +47,24 @@ 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.toml
+	 * @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) {
-		// We will create a `DurableObjectId` using the pathname from the Worker request
-		// This id refers to a unique instance of our 'MyDurableObject' class above
-		let id = env.MY_DURABLE_OBJECT.idFromName(new URL(request.url).pathname);
+		// 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");
-		// This stub creates a communication channel with the Durable Object instance
-		// The Durable Object constructor will be invoked upon the first call for a given id
-		let stub = env.MY_DURABLE_OBJECT.get(id);
+		// Create a stub to open a communication channel with the Durable
+		// Object instance.
+		const stub = env.MY_DURABLE_OBJECT.get(id);
-		// We call `fetch()` on the stub to send a request to the Durable Object instance
-		// The Durable Object instance will invoke its fetch handler to handle the request
-		let response = await stub.fetch(request);
+		// 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 response;
+		return new Response(greeting);
 	},
 };

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

@@ -0,0 +1,24 @@
+{
+  "name": "<TBD>",
+  "main": "src/index.js",
+  "compatibility_date": "<TBD>",
+  "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/py/.python-version ADDED Viewed

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

package/templates/hello-world-durable-object/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/py/__dot__gitignore ADDED Viewed

@@ -0,0 +1,68 @@
+# 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
+# Dependency directories
+node_modules/
+jspm_packages/
+# TypeScript cache
+\*.tsbuildinfo
+# Optional npm cache directory
+.npm
+# Optional eslint cache
+.eslintcache
+# Optional stylelint cache
+.stylelintcache
+# Optional REPL history
+.node_repl_history
+# Output of 'npm pack'
+\*.tgz
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+# public
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+# wrangler project
+.dev.vars
+.wrangler/

package/templates/hello-world-durable-object/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/hello-world-durable-object/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/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/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/py/wrangler.jsonc ADDED Viewed

@@ -0,0 +1,27 @@
+{
+  "name": "<TBD>",
+  "main": "src/entry.py",
+  "compatibility_date": "<TBD>",
+  "compatibility_flags": [
+    "python_workers"
+  ],
+  "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/ts/.editorconfig CHANGED Viewed

@@ -3,7 +3,6 @@ root = true
 [*]
 indent_style = tab
-tab_width = 2
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true

package/templates/hello-world-durable-object/ts/package.json CHANGED Viewed

@@ -5,11 +5,11 @@
 	"scripts": {
 		"deploy": "wrangler deploy",
 		"dev": "wrangler dev",
-		"start": "wrangler dev"
+		"start": "wrangler dev",
+		"cf-typegen": "wrangler types"
 	},
 	"devDependencies": {
-		"@cloudflare/workers-types": "^4.20231218.0",
-		"typescript": "^5.0.4",
-		"wrangler": "^3.0.0"
+		"typescript": "^5.5.2",
+		"wrangler": "^3.101.0"
 	}
 }

package/templates/hello-world-durable-object/ts/src/index.ts CHANGED Viewed

@@ -1,3 +1,5 @@
+import { DurableObject } from "cloudflare:workers";
 /**
  * Welcome to Cloudflare Workers! This is your first Durable Objects application.
  *
@@ -5,49 +7,34 @@
  * - 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
  */
-/**
- * Associate bindings declared in wrangler.toml with the TypeScript type system
- */
-export interface Env {
-	// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
-	// MY_KV_NAMESPACE: KVNamespace;
-	//
-	// Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
-	MY_DURABLE_OBJECT: DurableObjectNamespace;
-	//
-	// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
-	// MY_BUCKET: R2Bucket;
-	//
-	// Example binding to a Service. Learn more at https://developers.cloudflare.com/workers/runtime-apis/service-bindings/
-	// MY_SERVICE: Fetcher;
-	//
-	// Example binding to a Queue. Learn more at https://developers.cloudflare.com/queues/javascript-apis/
-	// MY_QUEUE: Queue;
-}
 /** A Durable Object's behavior is defined in an exported Javascript class */
-export class MyDurableObject {
+export class MyDurableObject extends DurableObject<Env> {
 	/**
 	 * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
-	 * 	`DurableObjectStub::get` for a given identifier
+	 * 	`DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
 	 *
-	 * @param state - The interface for interacting with Durable Object state
-	 * @param env - The interface to reference bindings declared in wrangler.toml
+	 * @param ctx - The interface for interacting with Durable Object state
+	 * @param env - The interface to reference bindings declared in wrangler.jsonc
 	 */
-	constructor(state: DurableObjectState, env: Env) {}
+	constructor(ctx: DurableObjectState, env: Env) {
+		super(ctx, env);
+	}
 	/**
-	 * The Durable Object fetch handler will be invoked when a Durable Object instance receives a
-	 * 	request from a Worker via an associated stub
+	 * 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 request - The request submitted to a Durable Object instance from a Worker
-	 * @returns The response to be sent back to the Worker
+	 * @param name - The name provided to a Durable Object instance from a Worker
+	 * @returns The greeting to be sent back to the Worker
 	 */
-	async fetch(request: Request): Promise<Response> {
-		return new Response('Hello World');
+	async sayHello(name: string): Promise<string> {
+		return `Hello, ${name}!`;
 	}
 }
@@ -56,23 +43,24 @@ 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.toml
+	 * @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: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
-		// We will create a `DurableObjectId` using the pathname from the Worker request
-		// This id refers to a unique instance of our 'MyDurableObject' class above
-		let id: DurableObjectId = env.MY_DURABLE_OBJECT.idFromName(new URL(request.url).pathname);
+	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");
-		// This stub creates a communication channel with the Durable Object instance
-		// The Durable Object constructor will be invoked upon the first call for a given id
-		let stub: DurableObjectStub = env.MY_DURABLE_OBJECT.get(id);
+		// Create a stub to open a communication channel with the Durable
+		// Object instance.
+		const stub = env.MY_DURABLE_OBJECT.get(id);
-		// We call `fetch()` on the stub to send a request to the Durable Object instance
-		// The Durable Object instance will invoke its fetch handler to handle the request
-		let response = await stub.fetch(request);
+		// 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 response;
+		return new Response(greeting);
 	},
-};
+} satisfies ExportedHandler<Env>;