create-cloudflare 0.0.0-e33bb44a → 0.0.0-e34d19867

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

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

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

@@ -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-durable-object/js/.prettierrc

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

package/templates/hello-world-durable-object/js/__dot__gitignore

@@ -0,0 +1,172 @@
+# 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
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+\*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+\*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+\*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.cache
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+.cache/
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+.cache
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.\*
+
+# wrangler project
+
+.dev.vars
+.wrangler/

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

@@ -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/js/src/index.js

@@ -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/js/wrangler.jsonc

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

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

package/templates/hello-world-durable-object/py/README.md

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

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

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

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

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

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

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

@@ -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-durable-object/ts/.prettierrc

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