create-cloudflare 0.0.0-e2a6fa40 → 0.0.0-e37c1b86

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 (106) hide show
  1. package/README.md +1 -52
  2. package/dist/cli.js +76893 -58628
  3. package/package.json +25 -13
  4. package/templates/angular/c3.ts +99 -0
  5. package/{dist/angular/templates/src/main.server.ts → templates/angular/templates/server.ts} +14 -15
  6. package/templates/angular/templates/tools/alter-polyfills.mjs +27 -0
  7. package/templates/angular/templates/tools/copy-files.mjs +9 -0
  8. package/templates/astro/c3.ts +50 -0
  9. package/templates/common/c3.ts +16 -0
  10. package/templates/common/js/__dot__gitignore +172 -0
  11. package/templates/common/js/package.json +1 -0
  12. package/templates/common/js/wrangler.toml +1 -1
  13. package/templates/common/ts/__dot__gitignore +172 -0
  14. package/templates/common/ts/package.json +1 -1
  15. package/templates/common/ts/wrangler.toml +1 -1
  16. package/templates/docusaurus/c3.ts +27 -0
  17. package/templates/gatsby/c3.ts +46 -0
  18. package/templates/hello-world/c3.ts +16 -0
  19. package/templates/hello-world/js/__dot__gitignore +172 -0
  20. package/templates/hello-world/js/package.json +1 -0
  21. package/templates/hello-world/js/wrangler.toml +1 -1
  22. package/templates/hello-world/ts/__dot__gitignore +172 -0
  23. package/templates/hello-world/ts/package.json +1 -1
  24. package/templates/hello-world/ts/wrangler.toml +1 -1
  25. package/templates/hello-world-durable-object/c3.ts +16 -0
  26. package/templates/hello-world-durable-object/js/.editorconfig +13 -0
  27. package/templates/hello-world-durable-object/js/.prettierrc +6 -0
  28. package/templates/hello-world-durable-object/js/__dot__gitignore +172 -0
  29. package/templates/hello-world-durable-object/js/package.json +13 -0
  30. package/templates/hello-world-durable-object/js/src/index.js +65 -0
  31. package/templates/hello-world-durable-object/js/wrangler.toml +51 -0
  32. package/templates/hello-world-durable-object/ts/.editorconfig +13 -0
  33. package/templates/hello-world-durable-object/ts/.prettierrc +6 -0
  34. package/templates/hello-world-durable-object/ts/__dot__gitignore +172 -0
  35. package/templates/hello-world-durable-object/ts/package.json +15 -0
  36. package/templates/hello-world-durable-object/ts/src/index.ts +78 -0
  37. package/templates/hello-world-durable-object/ts/tsconfig.json +101 -0
  38. package/templates/hello-world-durable-object/ts/wrangler.toml +51 -0
  39. package/templates/hono/c3.ts +25 -0
  40. package/templates/next/README.md +58 -0
  41. package/templates/next/app/js/app/api/hello/route.js +21 -0
  42. package/templates/next/app/js/app/not-found.js +58 -0
  43. package/templates/next/app/ts/app/api/hello/route.ts +22 -0
  44. package/templates/next/app/ts/app/not-found.tsx +58 -0
  45. package/templates/next/c3.ts +226 -0
  46. package/templates/next/env.d.ts +7 -0
  47. package/templates/next/pages/js/pages/api/hello.js +23 -0
  48. package/templates/next/pages/ts/pages/api/hello.ts +24 -0
  49. package/templates/next/wrangler.toml +57 -0
  50. package/templates/nuxt/c3.ts +100 -0
  51. package/templates/nuxt/templates/wrangler.toml +50 -0
  52. package/templates/openapi/c3.ts +9 -0
  53. package/templates/openapi/ts/README.md +25 -0
  54. package/templates/openapi/ts/__dot__gitignore +171 -0
  55. package/templates/{chatgptPlugin → openapi}/ts/package.json +5 -3
  56. package/templates/openapi/ts/src/endpoints/taskCreate.ts +48 -0
  57. package/templates/openapi/ts/src/endpoints/taskDelete.ts +55 -0
  58. package/templates/openapi/ts/src/endpoints/taskFetch.ts +74 -0
  59. package/templates/openapi/ts/src/endpoints/taskList.ts +66 -0
  60. package/templates/openapi/ts/src/index.ts +29 -0
  61. package/templates/openapi/ts/src/types.ts +9 -0
  62. package/templates/openapi/ts/tsconfig.json +32 -0
  63. package/templates/pre-existing/c3.ts +83 -0
  64. package/templates/pre-existing/js/.editorconfig +13 -0
  65. package/templates/pre-existing/js/.prettierrc +6 -0
  66. package/templates/pre-existing/js/__dot__gitignore +172 -0
  67. package/templates/pre-existing/js/package.json +13 -0
  68. package/templates/pre-existing/js/wrangler.toml +3 -0
  69. package/templates/queues/c3.ts +26 -0
  70. package/templates/queues/js/__dot__gitignore +172 -0
  71. package/templates/queues/js/package.json +1 -0
  72. package/templates/queues/ts/__dot__gitignore +172 -0
  73. package/templates/queues/ts/package.json +1 -1
  74. package/templates/qwik/c3.ts +145 -0
  75. package/templates/qwik/snippets/getPlatformProxy.ts +6 -0
  76. package/templates/qwik/templates/worker-configuration.d.ts +3 -0
  77. package/templates/qwik/templates/wrangler.toml +50 -0
  78. package/templates/react/c3.ts +29 -0
  79. package/templates/remix/c3.ts +33 -0
  80. package/templates/scheduled/c3.ts +16 -0
  81. package/templates/scheduled/js/__dot__gitignore +172 -0
  82. package/templates/scheduled/js/package.json +1 -0
  83. package/templates/scheduled/js/wrangler.toml +1 -1
  84. package/templates/scheduled/ts/__dot__gitignore +172 -0
  85. package/templates/scheduled/ts/package.json +1 -1
  86. package/templates/scheduled/ts/wrangler.toml +1 -1
  87. package/templates/solid/c3.ts +39 -0
  88. package/templates/solid/js/vite.config.js +12 -0
  89. package/templates/solid/ts/vite.config.ts +12 -0
  90. package/templates/svelte/c3.ts +129 -0
  91. package/templates/svelte/js/src/hooks.server.js +25 -0
  92. package/templates/svelte/js/wrangler.toml +50 -0
  93. package/templates/svelte/ts/src/hooks.server.ts +24 -0
  94. package/templates/svelte/ts/wrangler.toml +50 -0
  95. package/templates/vue/c3.ts +27 -0
  96. package/dist/angular/templates/tools/bundle.mjs +0 -77
  97. package/dist/angular/templates/tools/copy-client-files.mjs +0 -4
  98. package/dist/angular/templates/tools/copy-worker-files.mjs +0 -10
  99. package/dist/angular/templates/tsconfig.server.json +0 -5
  100. package/templates/chatgptPlugin/ts/.assets/example.png +0 -0
  101. package/templates/chatgptPlugin/ts/README.md +0 -25
  102. package/templates/chatgptPlugin/ts/src/index.ts +0 -33
  103. package/templates/chatgptPlugin/ts/src/search.ts +0 -63
  104. /package/{dist → templates}/angular/templates/src/_routes.json +0 -0
  105. /package/{dist → templates}/angular/templates/tools/paths.mjs +0 -0
  106. /package/templates/{chatgptPlugin → openapi}/ts/wrangler.toml +0 -0
@@ -0,0 +1,13 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "version": "0.0.0",
4
+ "private": true,
5
+ "scripts": {
6
+ "deploy": "wrangler deploy",
7
+ "dev": "wrangler dev",
8
+ "start": "wrangler dev"
9
+ },
10
+ "devDependencies": {
11
+ "wrangler": "^3.0.0"
12
+ }
13
+ }
@@ -0,0 +1,65 @@
1
+ /**
2
+ * Welcome to Cloudflare Workers! This is your first Durable Objects application.
3
+ *
4
+ * - Run `npm run dev` in your terminal to start a development server
5
+ * - Open a browser tab at http://localhost:8787/ to see your Durable Object in action
6
+ * - Run `npm run deploy` to publish your application
7
+ *
8
+ * Learn more at https://developers.cloudflare.com/durable-objects
9
+ */
10
+
11
+ /**
12
+ * Env provides a mechanism to reference bindings declared in wrangler.toml within JavaScript
13
+ *
14
+ * @typedef {Object} Env
15
+ * @property {DurableObjectNamespace} MY_DURABLE_OBJECT - The Durable Object namespace binding
16
+ */
17
+
18
+ /** A Durable Object's behavior is defined in an exported Javascript class */
19
+ export class MyDurableObject {
20
+ /**
21
+ * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
22
+ * `DurableObjectStub::get` for a given identifier
23
+ *
24
+ * @param {DurableObjectState} state - The interface for interacting with Durable Object state
25
+ * @param {Env} env - The interface to reference bindings declared in wrangler.toml
26
+ */
27
+ constructor(state, env) {}
28
+
29
+ /**
30
+ * The Durable Object fetch handler will be invoked when a Durable Object instance receives a
31
+ * request from a Worker via an associated stub
32
+ *
33
+ * @param {Request} request - The request submitted to a Durable Object instance from a Worker
34
+ * @returns {Promise<Response>} The response to be sent back to the Worker
35
+ */
36
+ async fetch(request) {
37
+ return new Response('Hello World');
38
+ }
39
+ }
40
+
41
+ export default {
42
+ /**
43
+ * This is the standard fetch handler for a Cloudflare Worker
44
+ *
45
+ * @param {Request} request - The request submitted to the Worker from the client
46
+ * @param {Env} env - The interface to reference bindings declared in wrangler.toml
47
+ * @param {ExecutionContext} ctx - The execution context of the Worker
48
+ * @returns {Promise<Response>} The response to be sent back to the client
49
+ */
50
+ async fetch(request, env, ctx) {
51
+ // We will create a `DurableObjectId` using the pathname from the Worker request
52
+ // This id refers to a unique instance of our 'MyDurableObject' class above
53
+ let id = env.MY_DURABLE_OBJECT.idFromName(new URL(request.url).pathname);
54
+
55
+ // This stub creates a communication channel with the Durable Object instance
56
+ // The Durable Object constructor will be invoked upon the first call for a given id
57
+ let stub = env.MY_DURABLE_OBJECT.get(id);
58
+
59
+ // We call `fetch()` on the stub to send a request to the Durable Object instance
60
+ // The Durable Object instance will invoke its fetch handler to handle the request
61
+ let response = await stub.fetch(request);
62
+
63
+ return response;
64
+ },
65
+ };
@@ -0,0 +1,51 @@
1
+ name = "<TBD>"
2
+ main = "src/index.js"
3
+ compatibility_date = "<TBD>"
4
+
5
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
6
+ # Note: Use secrets to store sensitive data.
7
+ # Docs: https://developers.cloudflare.com/workers/platform/environment-variables
8
+ # [vars]
9
+ # MY_VARIABLE = "production_value"
10
+
11
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
12
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/kv
13
+ # [[kv_namespaces]]
14
+ # binding = "MY_KV_NAMESPACE"
15
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
16
+
17
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
18
+ # Docs: https://developers.cloudflare.com/r2/api/workers/workers-api-usage/
19
+ # [[r2_buckets]]
20
+ # binding = "MY_BUCKET"
21
+ # bucket_name = "my-bucket"
22
+
23
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
24
+ # Docs: https://developers.cloudflare.com/queues/get-started
25
+ # [[queues.producers]]
26
+ # binding = "MY_QUEUE"
27
+ # queue = "my-queue"
28
+
29
+ # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
30
+ # Docs: https://developers.cloudflare.com/queues/get-started
31
+ # [[queues.consumers]]
32
+ # queue = "my-queue"
33
+
34
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
35
+ # Docs: https://developers.cloudflare.com/workers/platform/services
36
+ # [[services]]
37
+ # binding = "MY_SERVICE"
38
+ # service = "my-service"
39
+
40
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
41
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
42
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
43
+ [[durable_objects.bindings]]
44
+ name = "MY_DURABLE_OBJECT"
45
+ class_name = "MyDurableObject"
46
+
47
+ # Durable Object migrations.
48
+ # Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
49
+ [[migrations]]
50
+ tag = "v1"
51
+ new_classes = ["MyDurableObject"]
@@ -0,0 +1,13 @@
1
+ # http://editorconfig.org
2
+ root = true
3
+
4
+ [*]
5
+ indent_style = tab
6
+ tab_width = 2
7
+ end_of_line = lf
8
+ charset = utf-8
9
+ trim_trailing_whitespace = true
10
+ insert_final_newline = true
11
+
12
+ [*.yml]
13
+ indent_style = space
@@ -0,0 +1,6 @@
1
+ {
2
+ "printWidth": 140,
3
+ "singleQuote": true,
4
+ "semi": true,
5
+ "useTabs": true
6
+ }
@@ -0,0 +1,172 @@
1
+ # Logs
2
+
3
+ logs
4
+ _.log
5
+ npm-debug.log_
6
+ yarn-debug.log*
7
+ yarn-error.log*
8
+ lerna-debug.log*
9
+ .pnpm-debug.log*
10
+
11
+ # Diagnostic reports (https://nodejs.org/api/report.html)
12
+
13
+ report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
14
+
15
+ # Runtime data
16
+
17
+ pids
18
+ _.pid
19
+ _.seed
20
+ \*.pid.lock
21
+
22
+ # Directory for instrumented libs generated by jscoverage/JSCover
23
+
24
+ lib-cov
25
+
26
+ # Coverage directory used by tools like istanbul
27
+
28
+ coverage
29
+ \*.lcov
30
+
31
+ # nyc test coverage
32
+
33
+ .nyc_output
34
+
35
+ # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
36
+
37
+ .grunt
38
+
39
+ # Bower dependency directory (https://bower.io/)
40
+
41
+ bower_components
42
+
43
+ # node-waf configuration
44
+
45
+ .lock-wscript
46
+
47
+ # Compiled binary addons (https://nodejs.org/api/addons.html)
48
+
49
+ build/Release
50
+
51
+ # Dependency directories
52
+
53
+ node_modules/
54
+ jspm_packages/
55
+
56
+ # Snowpack dependency directory (https://snowpack.dev/)
57
+
58
+ web_modules/
59
+
60
+ # TypeScript cache
61
+
62
+ \*.tsbuildinfo
63
+
64
+ # Optional npm cache directory
65
+
66
+ .npm
67
+
68
+ # Optional eslint cache
69
+
70
+ .eslintcache
71
+
72
+ # Optional stylelint cache
73
+
74
+ .stylelintcache
75
+
76
+ # Microbundle cache
77
+
78
+ .rpt2_cache/
79
+ .rts2_cache_cjs/
80
+ .rts2_cache_es/
81
+ .rts2_cache_umd/
82
+
83
+ # Optional REPL history
84
+
85
+ .node_repl_history
86
+
87
+ # Output of 'npm pack'
88
+
89
+ \*.tgz
90
+
91
+ # Yarn Integrity file
92
+
93
+ .yarn-integrity
94
+
95
+ # dotenv environment variable files
96
+
97
+ .env
98
+ .env.development.local
99
+ .env.test.local
100
+ .env.production.local
101
+ .env.local
102
+
103
+ # parcel-bundler cache (https://parceljs.org/)
104
+
105
+ .cache
106
+ .parcel-cache
107
+
108
+ # Next.js build output
109
+
110
+ .next
111
+ out
112
+
113
+ # Nuxt.js build / generate output
114
+
115
+ .nuxt
116
+ dist
117
+
118
+ # Gatsby files
119
+
120
+ .cache/
121
+
122
+ # Comment in the public line in if your project uses Gatsby and not Next.js
123
+
124
+ # https://nextjs.org/blog/next-9-1#public-directory-support
125
+
126
+ # public
127
+
128
+ # vuepress build output
129
+
130
+ .vuepress/dist
131
+
132
+ # vuepress v2.x temp and cache directory
133
+
134
+ .temp
135
+ .cache
136
+
137
+ # Docusaurus cache and generated files
138
+
139
+ .docusaurus
140
+
141
+ # Serverless directories
142
+
143
+ .serverless/
144
+
145
+ # FuseBox cache
146
+
147
+ .fusebox/
148
+
149
+ # DynamoDB Local files
150
+
151
+ .dynamodb/
152
+
153
+ # TernJS port file
154
+
155
+ .tern-port
156
+
157
+ # Stores VSCode versions used for testing VSCode extensions
158
+
159
+ .vscode-test
160
+
161
+ # yarn v2
162
+
163
+ .yarn/cache
164
+ .yarn/unplugged
165
+ .yarn/build-state.yml
166
+ .yarn/install-state.gz
167
+ .pnp.\*
168
+
169
+ # wrangler project
170
+
171
+ .dev.vars
172
+ .wrangler/
@@ -0,0 +1,15 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "version": "0.0.0",
4
+ "private": true,
5
+ "scripts": {
6
+ "deploy": "wrangler deploy",
7
+ "dev": "wrangler dev",
8
+ "start": "wrangler dev"
9
+ },
10
+ "devDependencies": {
11
+ "@cloudflare/workers-types": "^4.20231218.0",
12
+ "typescript": "^5.0.4",
13
+ "wrangler": "^3.0.0"
14
+ }
15
+ }
@@ -0,0 +1,78 @@
1
+ /**
2
+ * Welcome to Cloudflare Workers! This is your first Durable Objects application.
3
+ *
4
+ * - Run `npm run dev` in your terminal to start a development server
5
+ * - Open a browser tab at http://localhost:8787/ to see your Durable Object in action
6
+ * - Run `npm run deploy` to publish your application
7
+ *
8
+ * Learn more at https://developers.cloudflare.com/durable-objects
9
+ */
10
+
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
+ /** A Durable Object's behavior is defined in an exported Javascript class */
32
+ export class MyDurableObject {
33
+ /**
34
+ * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
35
+ * `DurableObjectStub::get` for a given identifier
36
+ *
37
+ * @param state - The interface for interacting with Durable Object state
38
+ * @param env - The interface to reference bindings declared in wrangler.toml
39
+ */
40
+ constructor(state: DurableObjectState, env: Env) {}
41
+
42
+ /**
43
+ * The Durable Object fetch handler will be invoked when a Durable Object instance receives a
44
+ * request from a Worker via an associated stub
45
+ *
46
+ * @param request - The request submitted to a Durable Object instance from a Worker
47
+ * @returns The response to be sent back to the Worker
48
+ */
49
+ async fetch(request: Request): Promise<Response> {
50
+ return new Response('Hello World');
51
+ }
52
+ }
53
+
54
+ export default {
55
+ /**
56
+ * This is the standard fetch handler for a Cloudflare Worker
57
+ *
58
+ * @param request - The request submitted to the Worker from the client
59
+ * @param env - The interface to reference bindings declared in wrangler.toml
60
+ * @param ctx - The execution context of the Worker
61
+ * @returns The response to be sent back to the client
62
+ */
63
+ async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
64
+ // We will create a `DurableObjectId` using the pathname from the Worker request
65
+ // This id refers to a unique instance of our 'MyDurableObject' class above
66
+ let id: DurableObjectId = env.MY_DURABLE_OBJECT.idFromName(new URL(request.url).pathname);
67
+
68
+ // This stub creates a communication channel with the Durable Object instance
69
+ // The Durable Object constructor will be invoked upon the first call for a given id
70
+ let stub: DurableObjectStub = env.MY_DURABLE_OBJECT.get(id);
71
+
72
+ // We call `fetch()` on the stub to send a request to the Durable Object instance
73
+ // The Durable Object instance will invoke its fetch handler to handle the request
74
+ let response = await stub.fetch(request);
75
+
76
+ return response;
77
+ },
78
+ };
@@ -0,0 +1,101 @@
1
+ {
2
+ "compilerOptions": {
3
+ /* Visit https://aka.ms/tsconfig.json to read more about this file */
4
+
5
+ /* Projects */
6
+ // "incremental": true, /* Enable incremental compilation */
7
+ // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8
+ // "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
9
+ // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
10
+ // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11
+ // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12
+
13
+ /* Language and Environment */
14
+ "target": "es2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
15
+ "lib": ["es2021"] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
16
+ "jsx": "react" /* Specify what JSX code is generated. */,
17
+ // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
18
+ // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19
+ // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
20
+ // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21
+ // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
22
+ // "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
23
+ // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
24
+ // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
25
+
26
+ /* Modules */
27
+ "module": "es2022" /* Specify what module code is generated. */,
28
+ // "rootDir": "./", /* Specify the root folder within your source files. */
29
+ "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
30
+ // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
31
+ // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
32
+ // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
33
+ // "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
34
+ "types": ["@cloudflare/workers-types"] /* Specify type package names to be included without being referenced in a source file. */,
35
+ // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
36
+ "resolveJsonModule": true /* Enable importing .json files */,
37
+ // "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
38
+
39
+ /* JavaScript Support */
40
+ "allowJs": true /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */,
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. */
100
+ }
101
+ }
@@ -0,0 +1,51 @@
1
+ name = "<TBD>"
2
+ main = "src/index.ts"
3
+ compatibility_date = "<TBD>"
4
+
5
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
6
+ # Note: Use secrets to store sensitive data.
7
+ # Docs: https://developers.cloudflare.com/workers/platform/environment-variables
8
+ # [vars]
9
+ # MY_VARIABLE = "production_value"
10
+
11
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
12
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/kv
13
+ # [[kv_namespaces]]
14
+ # binding = "MY_KV_NAMESPACE"
15
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
16
+
17
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
18
+ # Docs: https://developers.cloudflare.com/r2/api/workers/workers-api-usage/
19
+ # [[r2_buckets]]
20
+ # binding = "MY_BUCKET"
21
+ # bucket_name = "my-bucket"
22
+
23
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
24
+ # Docs: https://developers.cloudflare.com/queues/get-started
25
+ # [[queues.producers]]
26
+ # binding = "MY_QUEUE"
27
+ # queue = "my-queue"
28
+
29
+ # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
30
+ # Docs: https://developers.cloudflare.com/queues/get-started
31
+ # [[queues.consumers]]
32
+ # queue = "my-queue"
33
+
34
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
35
+ # Docs: https://developers.cloudflare.com/workers/platform/services
36
+ # [[services]]
37
+ # binding = "MY_SERVICE"
38
+ # service = "my-service"
39
+
40
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
41
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
42
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
43
+ [[durable_objects.bindings]]
44
+ name = "MY_DURABLE_OBJECT"
45
+ class_name = "MyDurableObject"
46
+
47
+ # Durable Object migrations.
48
+ # Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
49
+ [[migrations]]
50
+ tag = "v1"
51
+ new_classes = ["MyDurableObject"]
@@ -0,0 +1,25 @@
1
+ import { logRaw } from "@cloudflare/cli";
2
+ import { runFrameworkGenerator } from "helpers/command";
3
+ import type { TemplateConfig } from "../../src/templates";
4
+ import type { C3Context } from "types";
5
+
6
+ const generate = async (ctx: C3Context) => {
7
+ await runFrameworkGenerator(ctx, [
8
+ ctx.project.name,
9
+ "--template",
10
+ "cloudflare-workers",
11
+ ]);
12
+
13
+ logRaw(""); // newline
14
+ };
15
+
16
+ const config: TemplateConfig = {
17
+ configVersion: 1,
18
+ id: "hono",
19
+ displayName: "Hono",
20
+ platform: "workers",
21
+ generate,
22
+ devScript: "dev",
23
+ deployScript: "deploy",
24
+ };
25
+ export default config;
@@ -0,0 +1,58 @@
1
+ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`c3`](https://developers.cloudflare.com/pages/get-started/c3).
2
+
3
+ ## Getting Started
4
+
5
+ First, run the development server:
6
+
7
+ ```bash
8
+ npm run dev
9
+ # or
10
+ yarn dev
11
+ # or
12
+ pnpm dev
13
+ # or
14
+ bun dev
15
+ ```
16
+
17
+ Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18
+
19
+ ## Cloudflare integration
20
+
21
+ Besides the `dev` script mentioned above `c3` has added a few extra scripts that allow you to integrate the application with the [Cloudflare Pages](https://pages.cloudflare.com/) environment, these are:
22
+ - `pages:build` to build the application for Pages using the [`@cloudflare/next-on-pages`](https://github.com/cloudflare/next-on-pages) CLI
23
+ - `preview` to locally preview your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
24
+ - `deploy` to deploy your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
25
+
26
+ > __Note:__ while the `dev` script is optimal for local development you should preview your Pages application as well (periodically or before deployments) in order to make sure that it can properly work in the Pages environment (for more details see the [`@cloudflare/next-on-pages` recommended workflow](https://github.com/cloudflare/next-on-pages/blob/05b6256/internal-packages/next-dev/README.md#recommended-workflow))
27
+
28
+ ### Bindings
29
+
30
+ Cloudflare [Bindings](https://developers.cloudflare.com/pages/functions/bindings/) are what allows you to interact with resources available in the Cloudflare Platform.
31
+
32
+ You can use bindings during development, when previewing locally your application and of course in the deployed application:
33
+
34
+ - To use bindings in dev mode you need to define them in the `next.config.js` file under `setupDevBindings`, this mode uses the `next-dev` `@cloudflare/next-on-pages` submodule. For more details see its [documentation](https://github.com/cloudflare/next-on-pages/blob/05b6256/internal-packages/next-dev/README.md).
35
+
36
+ - To use bindings in the preview mode you need to add them to the `pages:preview` script accordingly to the `wrangler pages dev` command. For more details see its [documentation](https://developers.cloudflare.com/workers/wrangler/commands/#dev-1) or the [Pages Bindings documentation](https://developers.cloudflare.com/pages/functions/bindings/).
37
+
38
+ - To use bindings in the deployed application you will need to configure them in the Cloudflare [dashboard](https://dash.cloudflare.com/). For more details see the [Pages Bindings documentation](https://developers.cloudflare.com/pages/functions/bindings/).
39
+
40
+ #### KV Example
41
+
42
+ `c3` has added for you an example showing how you can use a KV binding.
43
+
44
+ In order to enable the example:
45
+ - Search for javascript/typescript lines containing the following comment:
46
+ ```ts
47
+ // KV Example:
48
+ ```
49
+ and uncomment the commented lines below it.
50
+ - Do the same in the `wrangler.toml` file, where
51
+ the comment is:
52
+ ```
53
+ # KV Example:
54
+ ```
55
+
56
+ After doing this you can run the `dev` or `preview` script and visit the `/api/hello` route to see the example in action.
57
+
58
+ Finally, if you also want to see the example work in the deployed application make sure to add a `MY_KV` binding to your Pages application in its [dashboard kv bindings settings section](https://dash.cloudflare.com/?to=/:account/pages/view/:pages-project/settings/functions#kv_namespace_bindings_section). After having configured it make sure to re-deploy your application.