create-cloudflare 0.0.0-e5cdd7fa → 0.0.0-e5dbedd78
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.
- package/README.md +1 -1
- package/dist/cli.js +66474 -63680
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +39 -27
- package/templates/analog/c3.ts +135 -0
- package/templates/analog/snippets/devBindingsModule.ts +7 -0
- package/templates/analog/templates/env.d.ts +13 -0
- package/templates/analog/templates/src/dev-bindings.ts +18 -0
- package/templates/analog/templates/worker-configuration.d.ts +4 -0
- package/templates/analog/templates/wrangler.jsonc +5 -0
- package/templates/angular/c3.ts +5 -95
- package/templates/angular/pages/c3.ts +134 -0
- package/templates/angular/pages/templates/src/server.ts +15 -0
- package/templates/angular/pages/templates/tools/copy-files.mjs +15 -0
- package/templates/angular/workers/c3.ts +130 -0
- package/templates/angular/workers/templates/src/server.ts +15 -0
- package/templates/angular/workers/templates/wrangler.jsonc +12 -0
- package/templates/astro/c3.ts +5 -46
- package/templates/astro/pages/c3.ts +98 -0
- package/templates/astro/pages/templates/js/wrangler.jsonc +8 -0
- package/templates/astro/pages/templates/ts/src/env.d.ts +5 -0
- package/templates/astro/pages/templates/ts/worker-configuration.d.ts +4 -0
- package/templates/astro/pages/templates/ts/wrangler.jsonc +8 -0
- package/templates/astro/workers/c3.ts +98 -0
- package/templates/astro/workers/templates/js/public/.assetsignore +2 -0
- package/templates/astro/workers/templates/js/wrangler.jsonc +15 -0
- package/templates/astro/workers/templates/ts/public/.assetsignore +2 -0
- package/templates/astro/workers/templates/ts/src/env.d.ts +5 -0
- package/templates/astro/workers/templates/ts/worker-configuration.d.ts +4 -0
- package/templates/astro/workers/templates/ts/wrangler.jsonc +15 -0
- package/templates/common/c3.ts +10 -5
- package/templates/common/js/.editorconfig +0 -1
- package/templates/common/js/package.json +1 -1
- package/templates/common/js/wrangler.jsonc +8 -0
- package/templates/common/ts/.editorconfig +0 -1
- package/templates/common/ts/package.json +4 -3
- package/templates/common/ts/src/ab-test.ts +2 -2
- package/templates/common/ts/src/index.ts +5 -2
- package/templates/common/ts/src/proxy.ts +2 -2
- package/templates/common/ts/src/redirect.ts +2 -2
- package/templates/common/ts/tsconfig.json +37 -95
- package/templates/common/ts/worker-configuration.d.ts +2 -14
- package/templates/common/ts/wrangler.jsonc +8 -0
- package/templates/docusaurus/c3.ts +5 -23
- package/templates/docusaurus/pages/c3.ts +30 -0
- package/templates/docusaurus/workers/c3.ts +33 -0
- package/templates/docusaurus/workers/templates/wrangler.jsonc +10 -0
- package/templates/gatsby/c3.ts +5 -42
- package/templates/gatsby/pages/c3.ts +50 -0
- package/templates/gatsby/workers/c3.ts +53 -0
- package/templates/gatsby/workers/templates/wrangler.jsonc +10 -0
- package/templates/hello-world/c3.ts +30 -7
- package/templates/hello-world/js/.editorconfig +0 -1
- package/templates/hello-world/js/package.json +5 -2
- package/templates/hello-world/js/test/index.spec.js +20 -0
- package/templates/hello-world/js/vitest.config.js +11 -0
- package/templates/hello-world/js/wrangler.jsonc +8 -0
- package/templates/hello-world/py/.python-version +1 -0
- package/templates/hello-world/py/README.md +23 -0
- package/templates/hello-world/py/__dot__gitignore +68 -0
- package/templates/hello-world/py/package.json +13 -0
- package/templates/hello-world/py/pyproject.toml +9 -0
- package/templates/hello-world/py/src/entry.py +4 -0
- package/templates/hello-world/py/uv.lock +22 -0
- package/templates/hello-world/py/wrangler.jsonc +9 -0
- package/templates/hello-world/ts/.editorconfig +0 -1
- package/templates/hello-world/ts/package.json +7 -3
- package/templates/hello-world/ts/src/index.ts +5 -19
- package/templates/hello-world/ts/test/index.spec.ts +25 -0
- package/templates/hello-world/ts/test/tsconfig.json +8 -0
- package/templates/hello-world/ts/tsconfig.json +39 -96
- package/templates/hello-world/ts/vitest.config.mts +11 -0
- package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
- package/templates/hello-world/ts/wrangler.jsonc +8 -0
- package/templates/hello-world-assets-only/c3.ts +16 -0
- package/templates/hello-world-assets-only/templates/package.json +13 -0
- package/templates/hello-world-assets-only/templates/public/index.html +11 -0
- package/templates/hello-world-assets-only/templates/wrangler.jsonc +10 -0
- package/templates/hello-world-durable-object/c3.ts +10 -6
- package/templates/hello-world-durable-object/js/.editorconfig +0 -1
- package/templates/hello-world-durable-object/js/package.json +1 -1
- package/templates/hello-world-durable-object/js/src/index.js +28 -23
- package/templates/hello-world-durable-object/js/wrangler.jsonc +24 -0
- package/templates/hello-world-durable-object/ts/.editorconfig +0 -1
- package/templates/hello-world-durable-object/ts/package.json +4 -4
- package/templates/hello-world-durable-object/ts/src/index.ts +32 -44
- package/templates/hello-world-durable-object/ts/tsconfig.json +36 -95
- package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +5 -0
- package/templates/hello-world-durable-object/ts/wrangler.jsonc +24 -0
- package/templates/hello-world-durable-object-with-assets/c3.ts +23 -0
- package/templates/hello-world-durable-object-with-assets/js/.editorconfig +12 -0
- package/templates/hello-world-durable-object-with-assets/js/.prettierrc +6 -0
- package/templates/hello-world-durable-object-with-assets/js/__dot__gitignore +172 -0
- package/templates/hello-world-durable-object-with-assets/js/package.json +13 -0
- package/templates/hello-world-durable-object-with-assets/js/public/index.html +19 -0
- package/templates/hello-world-durable-object-with-assets/js/src/index.js +69 -0
- package/templates/hello-world-durable-object-with-assets/js/wrangler.jsonc +28 -0
- package/templates/hello-world-durable-object-with-assets/ts/.editorconfig +12 -0
- package/templates/hello-world-durable-object-with-assets/ts/.prettierrc +6 -0
- package/templates/hello-world-durable-object-with-assets/ts/__dot__gitignore +172 -0
- package/templates/hello-world-durable-object-with-assets/ts/package.json +15 -0
- package/templates/hello-world-durable-object-with-assets/ts/public/index.html +19 -0
- package/templates/hello-world-durable-object-with-assets/ts/src/index.ts +66 -0
- package/templates/hello-world-durable-object-with-assets/ts/tsconfig.json +42 -0
- package/templates/hello-world-durable-object-with-assets/ts/worker-configuration.d.ts +5 -0
- package/templates/hello-world-durable-object-with-assets/ts/wrangler.jsonc +28 -0
- package/templates/hello-world-with-assets/c3.ts +21 -0
- package/templates/hello-world-with-assets/js/.editorconfig +12 -0
- package/templates/hello-world-with-assets/js/.prettierrc +6 -0
- package/templates/hello-world-with-assets/js/__dot__gitignore +172 -0
- package/templates/hello-world-with-assets/js/package.json +16 -0
- package/templates/hello-world-with-assets/js/public/index.html +31 -0
- package/templates/hello-world-with-assets/js/src/index.js +23 -0
- package/templates/hello-world-with-assets/js/test/index.spec.js +41 -0
- package/templates/hello-world-with-assets/js/vitest.config.js +11 -0
- package/templates/hello-world-with-assets/js/wrangler.jsonc +15 -0
- package/templates/hello-world-with-assets/py/__dot__gitignore +68 -0
- package/templates/hello-world-with-assets/py/package.json +13 -0
- package/templates/hello-world-with-assets/py/public/index.html +31 -0
- package/templates/hello-world-with-assets/py/src/entry.py +9 -0
- package/templates/hello-world-with-assets/py/wrangler.jsonc +15 -0
- package/templates/hello-world-with-assets/ts/.editorconfig +12 -0
- package/templates/hello-world-with-assets/ts/.prettierrc +6 -0
- package/templates/hello-world-with-assets/ts/__dot__gitignore +172 -0
- package/templates/hello-world-with-assets/ts/package.json +18 -0
- package/templates/hello-world-with-assets/ts/public/index.html +31 -0
- package/templates/hello-world-with-assets/ts/src/index.ts +26 -0
- package/templates/hello-world-with-assets/ts/test/index.spec.ts +41 -0
- package/templates/hello-world-with-assets/ts/test/tsconfig.json +8 -0
- package/templates/hello-world-with-assets/ts/tsconfig.json +44 -0
- package/templates/hello-world-with-assets/ts/vitest.config.mts +11 -0
- package/templates/hello-world-with-assets/ts/worker-configuration.d.ts +4 -0
- package/templates/hello-world-with-assets/ts/wrangler.jsonc +15 -0
- package/templates/hono/c3.ts +5 -21
- package/templates/hono/pages/c3.ts +42 -0
- package/templates/hono/pages/templates/src/index.tsx +12 -0
- package/templates/hono/pages/templates/worker-configuration.d.ts +4 -0
- package/templates/hono/pages/templates/wrangler.jsonc +9 -0
- package/templates/hono/workers/c3.ts +42 -0
- package/templates/hono/workers/templates/public/index.html +19 -0
- package/templates/hono/workers/templates/src/index.ts +9 -0
- package/templates/hono/workers/templates/worker-configuration.d.ts +4 -0
- package/templates/hono/workers/templates/wrangler.jsonc +9 -0
- package/templates/next/README.md +67 -0
- package/templates/next/app/js/app/api/hello/route.js +21 -0
- package/templates/next/app/js/app/not-found.js +58 -0
- package/templates/next/app/ts/app/api/hello/route.ts +21 -0
- package/templates/next/app/ts/app/not-found.tsx +58 -0
- package/templates/next/c3.ts +96 -86
- package/templates/next/env.d.ts +5 -0
- package/templates/next/pages/js/pages/api/hello.js +23 -0
- package/templates/next/pages/ts/pages/api/hello.ts +24 -0
- package/templates/next/wrangler.jsonc +8 -0
- package/templates/nuxt/c3.ts +5 -55
- package/templates/nuxt/pages/c3.ts +145 -0
- package/templates/nuxt/pages/templates/env.d.ts +14 -0
- package/templates/nuxt/pages/templates/worker-configuration.d.ts +4 -0
- package/templates/nuxt/pages/templates/wrangler.jsonc +5 -0
- package/templates/nuxt/workers/c3.ts +145 -0
- package/templates/nuxt/workers/templates/env.d.ts +14 -0
- package/templates/nuxt/workers/templates/worker-configuration.d.ts +4 -0
- package/templates/nuxt/workers/templates/wrangler.jsonc +12 -0
- package/templates/openapi/c3.ts +1 -0
- package/templates/openapi/ts/README.md +3 -3
- package/templates/openapi/ts/package.json +7 -4
- package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
- package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
- package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
- package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
- package/templates/openapi/ts/src/index.ts +14 -20
- package/templates/openapi/ts/src/types.ts +9 -8
- package/templates/openapi/ts/worker-configuration.d.ts +4 -0
- package/templates/openapi/ts/wrangler.jsonc +8 -0
- package/templates/pre-existing/c3.ts +37 -18
- package/templates/pre-existing/js/.editorconfig +0 -1
- package/templates/pre-existing/js/package.json +1 -1
- package/templates/queues/c3.ts +9 -5
- package/templates/queues/js/.editorconfig +0 -1
- package/templates/queues/js/package.json +1 -1
- package/templates/queues/js/wrangler.jsonc +21 -0
- package/templates/queues/ts/.editorconfig +0 -1
- package/templates/queues/ts/package.json +4 -3
- package/templates/queues/ts/src/index.ts +6 -8
- package/templates/queues/ts/tsconfig.json +36 -95
- package/templates/queues/ts/worker-configuration.d.ts +5 -0
- package/templates/queues/ts/wrangler.jsonc +21 -0
- package/templates/qwik/c3.ts +5 -88
- package/templates/qwik/pages/c3.ts +149 -0
- package/templates/qwik/pages/snippets/getPlatformProxy.ts +6 -0
- package/templates/qwik/pages/templates/worker-configuration.d.ts +4 -0
- package/templates/qwik/pages/templates/wrangler.jsonc +8 -0
- package/templates/qwik/workers/c3.ts +154 -0
- package/templates/qwik/workers/snippets/getPlatformProxy.ts +6 -0
- package/templates/qwik/workers/templates/public/.assetsignore +4 -0
- package/templates/qwik/workers/templates/worker-configuration.d.ts +4 -0
- package/templates/qwik/workers/templates/wrangler.jsonc +15 -0
- package/templates/react/c3.ts +5 -25
- package/templates/react/pages/c3.ts +62 -0
- package/templates/react/workers/c3.ts +183 -0
- package/templates/react/workers/js/api/index.js +13 -0
- package/templates/react/workers/js/src/App.css +45 -0
- package/templates/react/workers/js/src/App.jsx +58 -0
- package/templates/react/workers/js/src/assets/Cloudflare_Logo.svg +53 -0
- package/templates/react/workers/js/wrangler.jsonc +9 -0
- package/templates/react/workers/ts/api/index.ts +13 -0
- package/templates/react/workers/ts/src/App.css +45 -0
- package/templates/react/workers/ts/src/App.tsx +58 -0
- package/templates/react/workers/ts/src/assets/Cloudflare_Logo.svg +51 -0
- package/templates/react/workers/ts/tsconfig.worker.json +8 -0
- package/templates/react/workers/ts/worker-configuration.d.ts +5 -0
- package/templates/react/workers/ts/wrangler.jsonc +9 -0
- package/templates/remix/c3.ts +5 -29
- package/templates/remix/pages/c3.ts +68 -0
- package/templates/remix/pages/templates/worker-configuration.d.ts +4 -0
- package/templates/remix/pages/templates/wrangler.jsonc +5 -0
- package/templates/remix/workers/c3.ts +52 -0
- package/templates/remix/workers/templates/public/.assetsignore +0 -0
- package/templates/remix/workers/templates/worker-configuration.d.ts +4 -0
- package/templates/remix/workers/templates/wrangler.toml +11 -0
- package/templates/scheduled/c3.ts +9 -5
- package/templates/scheduled/js/.editorconfig +0 -1
- package/templates/scheduled/js/package.json +3 -3
- package/templates/scheduled/js/src/index.js +9 -2
- package/templates/scheduled/js/wrangler.jsonc +13 -0
- package/templates/scheduled/ts/.editorconfig +0 -1
- package/templates/scheduled/ts/package.json +5 -4
- package/templates/scheduled/ts/src/index.ts +8 -25
- package/templates/scheduled/ts/tsconfig.json +36 -95
- package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
- package/templates/scheduled/ts/wrangler.jsonc +13 -0
- package/templates/solid/c3.ts +62 -12
- package/templates/solid/templates/wrangler.jsonc +8 -0
- package/templates/svelte/c3.ts +6 -74
- package/templates/svelte/pages/c3.ts +159 -0
- package/templates/svelte/pages/templates/wrangler.jsonc +5 -0
- package/templates/svelte/workers/c3.ts +129 -0
- package/templates/svelte/workers/templates/static/.assetsignore +2 -0
- package/templates/svelte/workers/templates/wrangler.jsonc +12 -0
- package/templates/vue/c3.ts +5 -23
- package/templates/vue/pages/c3.ts +30 -0
- package/templates/vue/workers/c3.ts +98 -0
- package/templates/vue/workers/js/server/index.js +13 -0
- package/templates/vue/workers/js/src/App.vue +107 -0
- package/templates/vue/workers/js/src/components/HelloWorld.vue +47 -0
- package/templates/vue/workers/js/vite.config.js +21 -0
- package/templates/vue/workers/js/wrangler.jsonc +12 -0
- package/templates/vue/workers/ts/server/index.ts +13 -0
- package/templates/vue/workers/ts/src/App.vue +107 -0
- package/templates/vue/workers/ts/src/components/HelloWorld.vue +44 -0
- package/templates/vue/workers/ts/tsconfig.worker.json +8 -0
- package/templates/vue/workers/ts/vite.config.ts +21 -0
- package/templates/vue/workers/ts/worker-configuration.d.ts +6 -0
- package/templates/vue/workers/ts/wrangler.jsonc +12 -0
- package/templates-experimental/next/c3.ts +75 -0
- package/templates-experimental/next/templates/.dev.vars +2 -0
- package/templates-experimental/next/templates/__dot__gitignore +39 -0
- package/templates-experimental/next/templates/cloudflare-env.d.ts +5 -0
- package/templates-experimental/next/templates/open-next.config.ts +6 -0
- package/templates-experimental/next/templates/wrangler.jsonc +12 -0
- package/templates-experimental/solid/c3.ts +94 -0
- package/templates-experimental/solid/templates/wrangler.jsonc +15 -0
- package/templates/angular/templates/server.ts +0 -34
- package/templates/angular/templates/tools/alter-polyfills.mjs +0 -27
- package/templates/angular/templates/tools/copy-files.mjs +0 -9
- package/templates/angular/templates/tools/paths.mjs +0 -9
- package/templates/common/js/wrangler.toml +0 -51
- package/templates/common/ts/wrangler.toml +0 -51
- package/templates/hello-world/js/wrangler.toml +0 -51
- package/templates/hello-world/ts/wrangler.toml +0 -51
- package/templates/hello-world-durable-object/js/wrangler.toml +0 -51
- package/templates/hello-world-durable-object/ts/wrangler.toml +0 -51
- package/templates/next/templates.ts +0 -281
- package/templates/openapi/ts/wrangler.toml +0 -3
- package/templates/pre-existing/js/wrangler.toml +0 -3
- package/templates/queues/js/wrangler.toml +0 -19
- package/templates/queues/ts/wrangler.toml +0 -19
- package/templates/scheduled/js/wrangler.toml +0 -9
- package/templates/scheduled/ts/wrangler.toml +0 -9
- package/templates/solid/js/vite.config.js +0 -12
- package/templates/solid/ts/vite.config.ts +0 -12
- package/templates/svelte/templates.ts +0 -13
- /package/templates/angular/{templates → pages/templates}/src/_routes.json +0 -0
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { TemplateConfig } from "../../src/templates";
|
|
2
|
+
|
|
3
|
+
const config: TemplateConfig = {
|
|
4
|
+
configVersion: 1,
|
|
5
|
+
id: "hello-world-assets-only",
|
|
6
|
+
path: "templates/hello-world-assets-only",
|
|
7
|
+
displayName: "Assets only",
|
|
8
|
+
description:
|
|
9
|
+
"For static sites (including SPAs) or when using your own backend",
|
|
10
|
+
platform: "workers",
|
|
11
|
+
copyFiles: {
|
|
12
|
+
path: "./templates",
|
|
13
|
+
},
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
export default config;
|
|
@@ -1,14 +1,18 @@
|
|
|
1
1
|
export default {
|
|
2
2
|
configVersion: 1,
|
|
3
3
|
id: "hello-world-durable-object",
|
|
4
|
-
displayName:
|
|
4
|
+
displayName: "Worker + Durable Objects",
|
|
5
|
+
description:
|
|
6
|
+
"For multiplayer apps using WebSockets, or when you need synchronization",
|
|
5
7
|
platform: "workers",
|
|
6
8
|
copyFiles: {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
variants: {
|
|
10
|
+
js: {
|
|
11
|
+
path: "./js",
|
|
12
|
+
},
|
|
13
|
+
ts: {
|
|
14
|
+
path: "./ts",
|
|
15
|
+
},
|
|
12
16
|
},
|
|
13
17
|
},
|
|
14
18
|
};
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { DurableObject } from "cloudflare:workers";
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* Welcome to Cloudflare Workers! This is your first Durable Objects application.
|
|
3
5
|
*
|
|
@@ -9,32 +11,34 @@
|
|
|
9
11
|
*/
|
|
10
12
|
|
|
11
13
|
/**
|
|
12
|
-
* Env provides a mechanism to reference bindings declared in wrangler.
|
|
14
|
+
* Env provides a mechanism to reference bindings declared in wrangler.jsonc within JavaScript
|
|
13
15
|
*
|
|
14
16
|
* @typedef {Object} Env
|
|
15
17
|
* @property {DurableObjectNamespace} MY_DURABLE_OBJECT - The Durable Object namespace binding
|
|
16
18
|
*/
|
|
17
19
|
|
|
18
20
|
/** A Durable Object's behavior is defined in an exported Javascript class */
|
|
19
|
-
export class MyDurableObject {
|
|
21
|
+
export class MyDurableObject extends DurableObject {
|
|
20
22
|
/**
|
|
21
23
|
* The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
|
|
22
|
-
* `DurableObjectStub::get` for a given identifier
|
|
24
|
+
* `DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
|
|
23
25
|
*
|
|
24
|
-
* @param {DurableObjectState}
|
|
25
|
-
* @param {Env} env - The interface to reference bindings declared in wrangler.
|
|
26
|
+
* @param {DurableObjectState} ctx - The interface for interacting with Durable Object state
|
|
27
|
+
* @param {Env} env - The interface to reference bindings declared in wrangler.jsonc
|
|
26
28
|
*/
|
|
27
|
-
constructor(
|
|
29
|
+
constructor(ctx, env) {
|
|
30
|
+
super(ctx, env);
|
|
31
|
+
}
|
|
28
32
|
|
|
29
33
|
/**
|
|
30
|
-
* The Durable Object
|
|
31
|
-
*
|
|
34
|
+
* The Durable Object exposes an RPC method sayHello which will be invoked when when a Durable
|
|
35
|
+
* Object instance receives a request from a Worker via the same method invocation on the stub
|
|
32
36
|
*
|
|
33
|
-
* @param {
|
|
34
|
-
* @returns {Promise<
|
|
37
|
+
* @param {string} name - The name provided to a Durable Object instance from a Worker
|
|
38
|
+
* @returns {Promise<string>} The greeting to be sent back to the Worker
|
|
35
39
|
*/
|
|
36
|
-
async
|
|
37
|
-
return
|
|
40
|
+
async sayHello(name) {
|
|
41
|
+
return `Hello, ${name}!`;
|
|
38
42
|
}
|
|
39
43
|
}
|
|
40
44
|
|
|
@@ -43,23 +47,24 @@ export default {
|
|
|
43
47
|
* This is the standard fetch handler for a Cloudflare Worker
|
|
44
48
|
*
|
|
45
49
|
* @param {Request} request - The request submitted to the Worker from the client
|
|
46
|
-
* @param {Env} env - The interface to reference bindings declared in wrangler.
|
|
50
|
+
* @param {Env} env - The interface to reference bindings declared in wrangler.jsonc
|
|
47
51
|
* @param {ExecutionContext} ctx - The execution context of the Worker
|
|
48
52
|
* @returns {Promise<Response>} The response to be sent back to the client
|
|
49
53
|
*/
|
|
50
54
|
async fetch(request, env, ctx) {
|
|
51
|
-
//
|
|
52
|
-
//
|
|
53
|
-
|
|
55
|
+
// Create a `DurableObjectId` for an instance of the `MyDurableObject`
|
|
56
|
+
// class named "foo". Requests from all Workers to the instance named
|
|
57
|
+
// "foo" will go to a single globally unique Durable Object instance.
|
|
58
|
+
const id = env.MY_DURABLE_OBJECT.idFromName("foo");
|
|
54
59
|
|
|
55
|
-
//
|
|
56
|
-
//
|
|
57
|
-
|
|
60
|
+
// Create a stub to open a communication channel with the Durable
|
|
61
|
+
// Object instance.
|
|
62
|
+
const stub = env.MY_DURABLE_OBJECT.get(id);
|
|
58
63
|
|
|
59
|
-
//
|
|
60
|
-
//
|
|
61
|
-
|
|
64
|
+
// Call the `sayHello()` RPC method on the stub to invoke the method on
|
|
65
|
+
// the remote Durable Object instance
|
|
66
|
+
const greeting = await stub.sayHello("world");
|
|
62
67
|
|
|
63
|
-
return
|
|
68
|
+
return new Response(greeting);
|
|
64
69
|
},
|
|
65
70
|
};
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "<TBD>",
|
|
3
|
+
"main": "src/index.js",
|
|
4
|
+
"compatibility_date": "<TBD>",
|
|
5
|
+
"migrations": [
|
|
6
|
+
{
|
|
7
|
+
"new_sqlite_classes": [
|
|
8
|
+
"MyDurableObject"
|
|
9
|
+
],
|
|
10
|
+
"tag": "v1"
|
|
11
|
+
}
|
|
12
|
+
],
|
|
13
|
+
"durable_objects": {
|
|
14
|
+
"bindings": [
|
|
15
|
+
{
|
|
16
|
+
"class_name": "MyDurableObject",
|
|
17
|
+
"name": "MY_DURABLE_OBJECT"
|
|
18
|
+
}
|
|
19
|
+
]
|
|
20
|
+
},
|
|
21
|
+
"observability": {
|
|
22
|
+
"enabled": true
|
|
23
|
+
}
|
|
24
|
+
}
|
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
"scripts": {
|
|
6
6
|
"deploy": "wrangler deploy",
|
|
7
7
|
"dev": "wrangler dev",
|
|
8
|
-
"start": "wrangler dev"
|
|
8
|
+
"start": "wrangler dev",
|
|
9
|
+
"cf-typegen": "wrangler types"
|
|
9
10
|
},
|
|
10
11
|
"devDependencies": {
|
|
11
|
-
"
|
|
12
|
-
"
|
|
13
|
-
"wrangler": "^3.0.0"
|
|
12
|
+
"typescript": "^5.5.2",
|
|
13
|
+
"wrangler": "^3.101.0"
|
|
14
14
|
}
|
|
15
15
|
}
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { DurableObject } from "cloudflare:workers";
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* Welcome to Cloudflare Workers! This is your first Durable Objects application.
|
|
3
5
|
*
|
|
@@ -5,49 +7,34 @@
|
|
|
5
7
|
* - Open a browser tab at http://localhost:8787/ to see your Durable Object in action
|
|
6
8
|
* - Run `npm run deploy` to publish your application
|
|
7
9
|
*
|
|
10
|
+
* Bind resources to your worker in `wrangler.jsonc`. After adding bindings, a type definition for the
|
|
11
|
+
* `Env` object can be regenerated with `npm run cf-typegen`.
|
|
12
|
+
*
|
|
8
13
|
* Learn more at https://developers.cloudflare.com/durable-objects
|
|
9
14
|
*/
|
|
10
15
|
|
|
11
|
-
/**
|
|
12
|
-
* Associate bindings declared in wrangler.toml with the TypeScript type system
|
|
13
|
-
*/
|
|
14
|
-
export interface Env {
|
|
15
|
-
// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
|
|
16
|
-
// MY_KV_NAMESPACE: KVNamespace;
|
|
17
|
-
//
|
|
18
|
-
// Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
|
|
19
|
-
MY_DURABLE_OBJECT: DurableObjectNamespace;
|
|
20
|
-
//
|
|
21
|
-
// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
|
|
22
|
-
// MY_BUCKET: R2Bucket;
|
|
23
|
-
//
|
|
24
|
-
// Example binding to a Service. Learn more at https://developers.cloudflare.com/workers/runtime-apis/service-bindings/
|
|
25
|
-
// MY_SERVICE: Fetcher;
|
|
26
|
-
//
|
|
27
|
-
// Example binding to a Queue. Learn more at https://developers.cloudflare.com/queues/javascript-apis/
|
|
28
|
-
// MY_QUEUE: Queue;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
16
|
/** A Durable Object's behavior is defined in an exported Javascript class */
|
|
32
|
-
export class MyDurableObject {
|
|
17
|
+
export class MyDurableObject extends DurableObject<Env> {
|
|
33
18
|
/**
|
|
34
19
|
* The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
|
|
35
|
-
* `DurableObjectStub::get` for a given identifier
|
|
20
|
+
* `DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
|
|
36
21
|
*
|
|
37
|
-
* @param
|
|
38
|
-
* @param env - The interface to reference bindings declared in wrangler.
|
|
22
|
+
* @param ctx - The interface for interacting with Durable Object state
|
|
23
|
+
* @param env - The interface to reference bindings declared in wrangler.jsonc
|
|
39
24
|
*/
|
|
40
|
-
constructor(
|
|
25
|
+
constructor(ctx: DurableObjectState, env: Env) {
|
|
26
|
+
super(ctx, env);
|
|
27
|
+
}
|
|
41
28
|
|
|
42
29
|
/**
|
|
43
|
-
* The Durable Object
|
|
44
|
-
*
|
|
30
|
+
* The Durable Object exposes an RPC method sayHello which will be invoked when when a Durable
|
|
31
|
+
* Object instance receives a request from a Worker via the same method invocation on the stub
|
|
45
32
|
*
|
|
46
|
-
* @param
|
|
47
|
-
* @returns The
|
|
33
|
+
* @param name - The name provided to a Durable Object instance from a Worker
|
|
34
|
+
* @returns The greeting to be sent back to the Worker
|
|
48
35
|
*/
|
|
49
|
-
async
|
|
50
|
-
return
|
|
36
|
+
async sayHello(name: string): Promise<string> {
|
|
37
|
+
return `Hello, ${name}!`;
|
|
51
38
|
}
|
|
52
39
|
}
|
|
53
40
|
|
|
@@ -56,23 +43,24 @@ export default {
|
|
|
56
43
|
* This is the standard fetch handler for a Cloudflare Worker
|
|
57
44
|
*
|
|
58
45
|
* @param request - The request submitted to the Worker from the client
|
|
59
|
-
* @param env - The interface to reference bindings declared in wrangler.
|
|
46
|
+
* @param env - The interface to reference bindings declared in wrangler.jsonc
|
|
60
47
|
* @param ctx - The execution context of the Worker
|
|
61
48
|
* @returns The response to be sent back to the client
|
|
62
49
|
*/
|
|
63
|
-
async fetch(request
|
|
64
|
-
//
|
|
65
|
-
//
|
|
66
|
-
|
|
50
|
+
async fetch(request, env, ctx): Promise<Response> {
|
|
51
|
+
// Create a `DurableObjectId` for an instance of the `MyDurableObject`
|
|
52
|
+
// class named "foo". Requests from all Workers to the instance named
|
|
53
|
+
// "foo" will go to a single globally unique Durable Object instance.
|
|
54
|
+
const id: DurableObjectId = env.MY_DURABLE_OBJECT.idFromName("foo");
|
|
67
55
|
|
|
68
|
-
//
|
|
69
|
-
//
|
|
70
|
-
|
|
56
|
+
// Create a stub to open a communication channel with the Durable
|
|
57
|
+
// Object instance.
|
|
58
|
+
const stub = env.MY_DURABLE_OBJECT.get(id);
|
|
71
59
|
|
|
72
|
-
//
|
|
73
|
-
//
|
|
74
|
-
|
|
60
|
+
// Call the `sayHello()` RPC method on the stub to invoke the method on
|
|
61
|
+
// the remote Durable Object instance
|
|
62
|
+
const greeting = await stub.sayHello("world");
|
|
75
63
|
|
|
76
|
-
return
|
|
64
|
+
return new Response(greeting);
|
|
77
65
|
},
|
|
78
|
-
}
|
|
66
|
+
} satisfies ExportedHandler<Env>;
|
|
@@ -2,100 +2,41 @@
|
|
|
2
2
|
"compilerOptions": {
|
|
3
3
|
/* Visit https://aka.ms/tsconfig.json to read more about this file */
|
|
4
4
|
|
|
5
|
-
/*
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
"
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
/*
|
|
27
|
-
"
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
"
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
/*
|
|
40
|
-
"
|
|
41
|
-
"checkJs": false /* Enable error reporting in type-checked JavaScript files. */,
|
|
42
|
-
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
|
|
43
|
-
|
|
44
|
-
/* Emit */
|
|
45
|
-
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
|
|
46
|
-
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
|
|
47
|
-
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
|
|
48
|
-
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
|
|
49
|
-
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
|
|
50
|
-
// "outDir": "./", /* Specify an output folder for all emitted files. */
|
|
51
|
-
// "removeComments": true, /* Disable emitting comments. */
|
|
52
|
-
"noEmit": true /* Disable emitting files from a compilation. */,
|
|
53
|
-
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
|
|
54
|
-
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
|
|
55
|
-
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
|
|
56
|
-
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
|
|
57
|
-
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
|
58
|
-
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
|
|
59
|
-
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
|
|
60
|
-
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
|
|
61
|
-
// "newLine": "crlf", /* Set the newline character for emitting files. */
|
|
62
|
-
// "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
|
|
63
|
-
// "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
|
|
64
|
-
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
|
|
65
|
-
// "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
|
|
66
|
-
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
|
|
67
|
-
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
|
|
68
|
-
|
|
69
|
-
/* Interop Constraints */
|
|
70
|
-
"isolatedModules": true /* Ensure that each file can be safely transpiled without relying on other imports. */,
|
|
71
|
-
"allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */,
|
|
72
|
-
// "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
|
|
73
|
-
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
|
|
74
|
-
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
|
|
75
|
-
|
|
76
|
-
/* Type Checking */
|
|
77
|
-
"strict": true /* Enable all strict type-checking options. */,
|
|
78
|
-
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
|
|
79
|
-
// "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
|
|
80
|
-
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
|
|
81
|
-
// "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
|
|
82
|
-
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
|
|
83
|
-
// "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
|
|
84
|
-
// "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
|
|
85
|
-
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
|
|
86
|
-
// "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
|
|
87
|
-
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
|
|
88
|
-
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
|
|
89
|
-
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
|
|
90
|
-
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
|
|
91
|
-
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
|
|
92
|
-
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
|
|
93
|
-
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
|
|
94
|
-
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
|
|
95
|
-
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
|
|
96
|
-
|
|
97
|
-
/* Completeness */
|
|
98
|
-
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
|
|
99
|
-
"skipLibCheck": true /* Skip type checking all .d.ts files. */
|
|
5
|
+
/* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
|
|
6
|
+
"target": "es2021",
|
|
7
|
+
/* Specify a set of bundled library declaration files that describe the target runtime environment. */
|
|
8
|
+
"lib": ["es2021"],
|
|
9
|
+
/* Specify what JSX code is generated. */
|
|
10
|
+
"jsx": "react-jsx",
|
|
11
|
+
|
|
12
|
+
/* Specify what module code is generated. */
|
|
13
|
+
"module": "es2022",
|
|
14
|
+
/* Specify how TypeScript looks up a file from a given module specifier. */
|
|
15
|
+
"moduleResolution": "node",
|
|
16
|
+
/* Specify type package names to be included without being referenced in a source file. */
|
|
17
|
+
"types": ["@cloudflare/workers-types"],
|
|
18
|
+
/* Enable importing .json files */
|
|
19
|
+
"resolveJsonModule": true,
|
|
20
|
+
|
|
21
|
+
/* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
|
|
22
|
+
"allowJs": true,
|
|
23
|
+
/* Enable error reporting in type-checked JavaScript files. */
|
|
24
|
+
"checkJs": false,
|
|
25
|
+
|
|
26
|
+
/* Disable emitting files from a compilation. */
|
|
27
|
+
"noEmit": true,
|
|
28
|
+
|
|
29
|
+
/* Ensure that each file can be safely transpiled without relying on other imports. */
|
|
30
|
+
"isolatedModules": true,
|
|
31
|
+
/* Allow 'import x from y' when a module doesn't have a default export. */
|
|
32
|
+
"allowSyntheticDefaultImports": true,
|
|
33
|
+
/* Ensure that casing is correct in imports. */
|
|
34
|
+
"forceConsistentCasingInFileNames": true,
|
|
35
|
+
|
|
36
|
+
/* Enable all strict type-checking options. */
|
|
37
|
+
"strict": true,
|
|
38
|
+
|
|
39
|
+
/* Skip type checking all .d.ts files. */
|
|
40
|
+
"skipLibCheck": true
|
|
100
41
|
}
|
|
101
42
|
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "<TBD>",
|
|
3
|
+
"main": "src/index.ts",
|
|
4
|
+
"compatibility_date": "<TBD>",
|
|
5
|
+
"migrations": [
|
|
6
|
+
{
|
|
7
|
+
"new_sqlite_classes": [
|
|
8
|
+
"MyDurableObject"
|
|
9
|
+
],
|
|
10
|
+
"tag": "v1"
|
|
11
|
+
}
|
|
12
|
+
],
|
|
13
|
+
"durable_objects": {
|
|
14
|
+
"bindings": [
|
|
15
|
+
{
|
|
16
|
+
"class_name": "MyDurableObject",
|
|
17
|
+
"name": "MY_DURABLE_OBJECT"
|
|
18
|
+
}
|
|
19
|
+
]
|
|
20
|
+
},
|
|
21
|
+
"observability": {
|
|
22
|
+
"enabled": true
|
|
23
|
+
}
|
|
24
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { TemplateConfig } from "../../src/templates";
|
|
2
|
+
|
|
3
|
+
const config: TemplateConfig = {
|
|
4
|
+
configVersion: 1,
|
|
5
|
+
id: "hello-world-durable-object-with-assets",
|
|
6
|
+
path: "templates/hello-world-durable-object-with-assets",
|
|
7
|
+
displayName: "Worker + Durable Objects + Assets",
|
|
8
|
+
description:
|
|
9
|
+
"For full-stack applications requiring static assets, an API, and real-time coordination",
|
|
10
|
+
platform: "workers",
|
|
11
|
+
copyFiles: {
|
|
12
|
+
variants: {
|
|
13
|
+
js: {
|
|
14
|
+
path: "./js",
|
|
15
|
+
},
|
|
16
|
+
ts: {
|
|
17
|
+
path: "./ts",
|
|
18
|
+
},
|
|
19
|
+
},
|
|
20
|
+
},
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
export default config;
|