create-cloudflare 0.0.0-e9c2b04a → 0.0.0-e9f8a2fa

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 (131) hide show
  1. package/dist/cli.js +44926 -28282
  2. package/dist/tsconfig.tsbuildinfo +1 -0
  3. package/package.json +19 -16
  4. package/templates/analog/c3.ts +134 -0
  5. package/templates/analog/snippets/devBindingsModule.ts +7 -0
  6. package/templates/analog/templates/env.d.ts +13 -0
  7. package/templates/analog/templates/src/dev-bindings.ts +18 -0
  8. package/templates/analog/templates/worker-configuration.d.ts +4 -0
  9. package/templates/analog/templates/wrangler.toml +85 -0
  10. package/templates/angular/c3.ts +100 -0
  11. package/{dist → templates}/angular/templates/tools/copy-files.mjs +1 -1
  12. package/templates/astro/c3.ts +112 -0
  13. package/templates/astro/snippets/runtimeDeclaration.ts +5 -0
  14. package/templates/astro/templates/wrangler.toml +85 -0
  15. package/templates/common/c3.ts +16 -0
  16. package/templates/common/js/.editorconfig +0 -1
  17. package/templates/common/js/wrangler.toml +78 -22
  18. package/templates/common/ts/.editorconfig +0 -1
  19. package/templates/common/ts/package.json +2 -1
  20. package/templates/common/ts/src/index.ts +3 -0
  21. package/templates/common/ts/worker-configuration.d.ts +2 -14
  22. package/templates/common/ts/wrangler.toml +78 -22
  23. package/templates/docusaurus/c3.ts +26 -0
  24. package/templates/gatsby/c3.ts +48 -0
  25. package/templates/hello-world/c3.ts +16 -0
  26. package/templates/hello-world/js/.editorconfig +0 -1
  27. package/templates/hello-world/js/package.json +5 -2
  28. package/templates/hello-world/js/test/index.spec.js +20 -0
  29. package/templates/hello-world/js/vitest.config.js +11 -0
  30. package/templates/hello-world/js/wrangler.toml +79 -22
  31. package/templates/hello-world/ts/.editorconfig +0 -1
  32. package/templates/hello-world/ts/package.json +6 -2
  33. package/templates/hello-world/ts/src/index.ts +3 -17
  34. package/templates/hello-world/ts/test/index.spec.ts +25 -0
  35. package/templates/hello-world/ts/test/tsconfig.json +11 -0
  36. package/templates/hello-world/ts/tsconfig.json +3 -2
  37. package/templates/hello-world/ts/vitest.config.ts +11 -0
  38. package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
  39. package/templates/hello-world/ts/wrangler.toml +79 -22
  40. package/templates/hello-world-durable-object/c3.ts +16 -0
  41. package/templates/hello-world-durable-object/js/.editorconfig +12 -0
  42. package/templates/hello-world-durable-object/js/.prettierrc +6 -0
  43. package/templates/{chatgptPlugin/ts → hello-world-durable-object/js}/__dot__gitignore +1 -0
  44. package/templates/{chatgptPlugin/ts → hello-world-durable-object/js}/package.json +2 -5
  45. package/templates/hello-world-durable-object/js/src/index.js +69 -0
  46. package/templates/hello-world-durable-object/js/wrangler.toml +107 -0
  47. package/templates/hello-world-durable-object/ts/.editorconfig +12 -0
  48. package/templates/hello-world-durable-object/ts/.prettierrc +6 -0
  49. package/templates/hello-world-durable-object/ts/__dot__gitignore +172 -0
  50. package/templates/hello-world-durable-object/ts/package.json +15 -0
  51. package/templates/hello-world-durable-object/ts/src/index.ts +86 -0
  52. package/templates/hello-world-durable-object/ts/tsconfig.json +101 -0
  53. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +6 -0
  54. package/templates/hello-world-durable-object/ts/wrangler.toml +107 -0
  55. package/templates/hello-world-python/c3.ts +9 -0
  56. package/templates/hello-world-python/py/__dot__gitignore +68 -0
  57. package/templates/hello-world-python/py/package.json +13 -0
  58. package/templates/hello-world-python/py/src/entry.py +4 -0
  59. package/templates/hello-world-python/py/wrangler.toml +108 -0
  60. package/templates/hono/c3.ts +78 -0
  61. package/templates/hono/snippets/appDeclaration.ts +1 -0
  62. package/templates/hono/snippets/bindingsType.ts +3 -0
  63. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  64. package/templates/hono/templates/wrangler.toml +107 -0
  65. package/templates/next/README.md +68 -0
  66. package/templates/next/app/js/app/api/hello/route.js +21 -0
  67. package/templates/next/app/js/app/not-found.js +58 -0
  68. package/templates/next/app/ts/app/api/hello/route.ts +22 -0
  69. package/templates/next/app/ts/app/not-found.tsx +58 -0
  70. package/templates/next/c3.ts +238 -0
  71. package/templates/next/env.d.ts +5 -0
  72. package/templates/next/pages/js/pages/api/hello.js +23 -0
  73. package/templates/next/pages/ts/pages/api/hello.ts +24 -0
  74. package/templates/next/wrangler.toml +86 -0
  75. package/templates/nuxt/c3.ts +134 -0
  76. package/templates/nuxt/templates/env.d.ts +14 -0
  77. package/templates/nuxt/templates/worker-configuration.d.ts +4 -0
  78. package/templates/nuxt/templates/wrangler.toml +85 -0
  79. package/templates/openapi/c3.ts +9 -0
  80. package/templates/openapi/ts/package.json +2 -1
  81. package/templates/openapi/ts/src/endpoints/taskList.ts +1 -1
  82. package/templates/openapi/ts/src/index.ts +2 -2
  83. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  84. package/templates/openapi/ts/wrangler.toml +104 -0
  85. package/templates/pre-existing/c3.ts +83 -0
  86. package/templates/pre-existing/js/.editorconfig +12 -0
  87. package/templates/pre-existing/js/.prettierrc +6 -0
  88. package/templates/pre-existing/js/__dot__gitignore +172 -0
  89. package/templates/pre-existing/js/package.json +13 -0
  90. package/templates/pre-existing/js/wrangler.toml +4 -0
  91. package/templates/queues/c3.ts +26 -0
  92. package/templates/queues/js/.editorconfig +0 -1
  93. package/templates/queues/js/wrangler.toml +95 -2
  94. package/templates/queues/ts/.editorconfig +0 -1
  95. package/templates/queues/ts/package.json +2 -1
  96. package/templates/queues/ts/src/index.ts +3 -5
  97. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  98. package/templates/queues/ts/wrangler.toml +95 -2
  99. package/templates/qwik/c3.ts +146 -0
  100. package/templates/qwik/snippets/getPlatformProxy.ts +6 -0
  101. package/templates/qwik/templates/worker-configuration.d.ts +4 -0
  102. package/templates/qwik/templates/wrangler.toml +85 -0
  103. package/templates/react/c3.ts +31 -0
  104. package/templates/remix/c3.ts +66 -0
  105. package/templates/remix/templates/worker-configuration.d.ts +4 -0
  106. package/templates/remix/templates/wrangler.toml +85 -0
  107. package/templates/scheduled/c3.ts +16 -0
  108. package/templates/scheduled/js/.editorconfig +0 -1
  109. package/templates/scheduled/js/package.json +2 -2
  110. package/templates/scheduled/js/src/index.js +8 -1
  111. package/templates/scheduled/js/wrangler.toml +104 -0
  112. package/templates/scheduled/ts/.editorconfig +0 -1
  113. package/templates/scheduled/ts/package.json +3 -2
  114. package/templates/scheduled/ts/src/index.ts +4 -21
  115. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  116. package/templates/scheduled/ts/wrangler.toml +104 -0
  117. package/templates/solid/c3.ts +84 -0
  118. package/templates/solid/templates/wrangler.toml +84 -0
  119. package/templates/svelte/c3.ts +130 -0
  120. package/templates/svelte/js/wrangler.toml +85 -0
  121. package/templates/svelte/ts/wrangler.toml +85 -0
  122. package/templates/vue/c3.ts +28 -0
  123. package/templates/chatgptPlugin/ts/.assets/example.png +0 -0
  124. package/templates/chatgptPlugin/ts/README.md +0 -25
  125. package/templates/chatgptPlugin/ts/src/index.ts +0 -33
  126. package/templates/chatgptPlugin/ts/src/search.ts +0 -59
  127. package/templates/chatgptPlugin/ts/wrangler.toml +0 -3
  128. package/{dist → templates}/angular/templates/server.ts +0 -0
  129. package/{dist → templates}/angular/templates/src/_routes.json +0 -0
  130. package/{dist → templates}/angular/templates/tools/alter-polyfills.mjs +1 -1
  131. /package/{dist → templates}/angular/templates/tools/paths.mjs +0 -0
@@ -0,0 +1,130 @@
1
+ import { platform } from "node:os";
2
+ import { logRaw, updateStatus } from "@cloudflare/cli";
3
+ import { blue, brandColor, dim } from "@cloudflare/cli/colors";
4
+ import { runFrameworkGenerator } from "frameworks/index";
5
+ import { transformFile } from "helpers/codemod";
6
+ import { usesTypescript } from "helpers/files";
7
+ import { detectPackageManager } from "helpers/packageManagers";
8
+ import { installPackages } from "helpers/packages";
9
+ import * as recast from "recast";
10
+ import type { TemplateConfig } from "../../src/templates";
11
+ import type { C3Context, PackageJson } from "types";
12
+
13
+ const { npm } = detectPackageManager();
14
+
15
+ const generate = async (ctx: C3Context) => {
16
+ await runFrameworkGenerator(ctx, [ctx.project.name]);
17
+
18
+ logRaw("");
19
+ };
20
+
21
+ const configure = async (ctx: C3Context) => {
22
+ // Install the adapter
23
+ const pkg = `@sveltejs/adapter-cloudflare`;
24
+ await installPackages([pkg], {
25
+ dev: true,
26
+ startText: "Adding the Cloudflare Pages adapter",
27
+ doneText: `${brandColor(`installed`)} ${dim(pkg)}`,
28
+ });
29
+
30
+ updateSvelteConfig();
31
+ updateTypeDefinitions(ctx);
32
+ };
33
+
34
+ const updateSvelteConfig = () => {
35
+ // All we need to do is change the import statement in svelte.config.js
36
+ updateStatus(`Changing adapter in ${blue("svelte.config.js")}`);
37
+
38
+ transformFile("svelte.config.js", {
39
+ visitImportDeclaration: function (n) {
40
+ // importSource is the `x` in `import y from "x"`
41
+ const importSource = n.value.source;
42
+ if (importSource.value === "@sveltejs/adapter-auto") {
43
+ importSource.value = "@sveltejs/adapter-cloudflare";
44
+ }
45
+
46
+ // stop traversing this node
47
+ return false;
48
+ },
49
+ });
50
+ };
51
+
52
+ const updateTypeDefinitions = (ctx: C3Context) => {
53
+ if (!usesTypescript(ctx)) {
54
+ return;
55
+ }
56
+
57
+ updateStatus(`Updating global type definitions in ${blue("app.d.ts")}`);
58
+
59
+ const b = recast.types.builders;
60
+
61
+ transformFile("src/app.d.ts", {
62
+ visitTSModuleDeclaration(n) {
63
+ if (n.value.id.name === "App" && n.node.body) {
64
+ const moduleBlock = n.node
65
+ .body as recast.types.namedTypes.TSModuleBlock;
66
+
67
+ const platformInterface = b.tsInterfaceDeclaration(
68
+ b.identifier("Platform"),
69
+ b.tsInterfaceBody([
70
+ b.tsPropertySignature(
71
+ b.identifier("env"),
72
+ b.tsTypeAnnotation(b.tsTypeReference(b.identifier("Env"))),
73
+ ),
74
+ b.tsPropertySignature(
75
+ b.identifier("cf"),
76
+ b.tsTypeAnnotation(
77
+ b.tsTypeReference(b.identifier("CfProperties")),
78
+ ),
79
+ ),
80
+ b.tsPropertySignature(
81
+ b.identifier("ctx"),
82
+ b.tsTypeAnnotation(
83
+ b.tsTypeReference(b.identifier("ExecutionContext")),
84
+ ),
85
+ ),
86
+ ]),
87
+ );
88
+
89
+ moduleBlock.body.unshift(platformInterface);
90
+ }
91
+
92
+ this.traverse(n);
93
+ },
94
+ });
95
+ };
96
+
97
+ const config: TemplateConfig = {
98
+ configVersion: 1,
99
+ id: "svelte",
100
+ displayName: "Svelte",
101
+ platform: "pages",
102
+ copyFiles: {
103
+ variants: {
104
+ js: { path: "./js" },
105
+ ts: { path: "./ts" },
106
+ },
107
+ },
108
+ generate,
109
+ configure,
110
+ transformPackageJson: async (original: PackageJson, ctx: C3Context) => {
111
+ let scripts: Record<string, string> = {
112
+ preview: `${npm} run build && wrangler pages dev`,
113
+ deploy: `${npm} run build && wrangler pages deploy`,
114
+ };
115
+
116
+ if (usesTypescript(ctx)) {
117
+ const mv = platform() === "win32" ? "move" : "mv";
118
+ scripts = {
119
+ ...scripts,
120
+ "cf-typegen": `wrangler types && ${mv} worker-configuration.d.ts src/`,
121
+ };
122
+ }
123
+
124
+ return { scripts };
125
+ },
126
+ devScript: "dev",
127
+ deployScript: "deploy",
128
+ previewScript: "preview",
129
+ };
130
+ export default config;
@@ -0,0 +1,85 @@
1
+ #:schema node_modules/wrangler/config-schema.json
2
+ name = "<TBD>"
3
+ compatibility_date = "<TBD>"
4
+ pages_build_output_dir = ".svelte-kit/cloudflare"
5
+
6
+ # Automatically place your workloads in an optimal location to minimize latency.
7
+ # If you are running back-end logic in a Pages Function, running it closer to your back-end infrastructure
8
+ # rather than the end user may result in better performance.
9
+ # Docs: https://developers.cloudflare.com/pages/functions/smart-placement/#smart-placement
10
+ # [placement]
11
+ # mode = "smart"
12
+
13
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
14
+ # Docs:
15
+ # - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
16
+ # Note: Use secrets to store sensitive data.
17
+ # - https://developers.cloudflare.com/pages/functions/bindings/#secrets
18
+ # [vars]
19
+ # MY_VARIABLE = "production_value"
20
+
21
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
22
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#workers-ai
23
+ # [ai]
24
+ # binding = "AI"
25
+
26
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
27
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#d1-databases
28
+ # [[d1_databases]]
29
+ # binding = "MY_DB"
30
+ # database_name = "my-database"
31
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
32
+
33
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
34
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
35
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
36
+ # [[durable_objects.bindings]]
37
+ # name = "MY_DURABLE_OBJECT"
38
+ # class_name = "MyDurableObject"
39
+ # script_name = 'my-durable-object'
40
+
41
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
42
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#kv-namespaces
43
+ # [[kv_namespaces]]
44
+ # binding = "MY_KV_NAMESPACE"
45
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
46
+
47
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
48
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#queue-producers
49
+ # [[queues.producers]]
50
+ # binding = "MY_QUEUE"
51
+ # queue = "my-queue"
52
+
53
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
54
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#r2-buckets
55
+ # [[r2_buckets]]
56
+ # binding = "MY_BUCKET"
57
+ # bucket_name = "my-bucket"
58
+
59
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
60
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
61
+ # [[services]]
62
+ # binding = "MY_SERVICE"
63
+ # service = "my-service"
64
+
65
+ # To use different bindings for preview and production environments, follow the examples below.
66
+ # When using environment-specific overrides for bindings, ALL bindings must be specified on a per-environment basis.
67
+ # Docs: https://developers.cloudflare.com/pages/functions/wrangler-configuration#environment-specific-overrides
68
+
69
+ ######## PREVIEW environment config ########
70
+
71
+ # [env.preview.vars]
72
+ # API_KEY = "xyz789"
73
+
74
+ # [[env.preview.kv_namespaces]]
75
+ # binding = "MY_KV_NAMESPACE"
76
+ # id = "<PREVIEW_NAMESPACE_ID>"
77
+
78
+ ######## PRODUCTION environment config ########
79
+
80
+ # [env.production.vars]
81
+ # API_KEY = "abc123"
82
+
83
+ # [[env.production.kv_namespaces]]
84
+ # binding = "MY_KV_NAMESPACE"
85
+ # id = "<PRODUCTION_NAMESPACE_ID>"
@@ -0,0 +1,85 @@
1
+ #:schema node_modules/wrangler/config-schema.json
2
+ name = "<TBD>"
3
+ compatibility_date = "<TBD>"
4
+ pages_build_output_dir = ".svelte-kit/cloudflare"
5
+
6
+ # Automatically place your workloads in an optimal location to minimize latency.
7
+ # If you are running back-end logic in a Pages Function, running it closer to your back-end infrastructure
8
+ # rather than the end user may result in better performance.
9
+ # Docs: https://developers.cloudflare.com/pages/functions/smart-placement/#smart-placement
10
+ # [placement]
11
+ # mode = "smart"
12
+
13
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
14
+ # Docs:
15
+ # - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
16
+ # Note: Use secrets to store sensitive data.
17
+ # - https://developers.cloudflare.com/pages/functions/bindings/#secrets
18
+ # [vars]
19
+ # MY_VARIABLE = "production_value"
20
+
21
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
22
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#workers-ai
23
+ # [ai]
24
+ # binding = "AI"
25
+
26
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
27
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#d1-databases
28
+ # [[d1_databases]]
29
+ # binding = "MY_DB"
30
+ # database_name = "my-database"
31
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
32
+
33
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
34
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
35
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
36
+ # [[durable_objects.bindings]]
37
+ # name = "MY_DURABLE_OBJECT"
38
+ # class_name = "MyDurableObject"
39
+ # script_name = 'my-durable-object'
40
+
41
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
42
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#kv-namespaces
43
+ # [[kv_namespaces]]
44
+ # binding = "MY_KV_NAMESPACE"
45
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
46
+
47
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
48
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#queue-producers
49
+ # [[queues.producers]]
50
+ # binding = "MY_QUEUE"
51
+ # queue = "my-queue"
52
+
53
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
54
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#r2-buckets
55
+ # [[r2_buckets]]
56
+ # binding = "MY_BUCKET"
57
+ # bucket_name = "my-bucket"
58
+
59
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
60
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
61
+ # [[services]]
62
+ # binding = "MY_SERVICE"
63
+ # service = "my-service"
64
+
65
+ # To use different bindings for preview and production environments, follow the examples below.
66
+ # When using environment-specific overrides for bindings, ALL bindings must be specified on a per-environment basis.
67
+ # Docs: https://developers.cloudflare.com/pages/functions/wrangler-configuration#environment-specific-overrides
68
+
69
+ ######## PREVIEW environment config ########
70
+
71
+ # [env.preview.vars]
72
+ # API_KEY = "xyz789"
73
+
74
+ # [[env.preview.kv_namespaces]]
75
+ # binding = "MY_KV_NAMESPACE"
76
+ # id = "<PREVIEW_NAMESPACE_ID>"
77
+
78
+ ######## PRODUCTION environment config ########
79
+
80
+ # [env.production.vars]
81
+ # API_KEY = "abc123"
82
+
83
+ # [[env.production.kv_namespaces]]
84
+ # binding = "MY_KV_NAMESPACE"
85
+ # id = "<PRODUCTION_NAMESPACE_ID>"
@@ -0,0 +1,28 @@
1
+ import { runFrameworkGenerator } from "frameworks/index";
2
+ import { detectPackageManager } from "helpers/packageManagers";
3
+ import type { TemplateConfig } from "../../src/templates";
4
+ import type { C3Context } from "types";
5
+
6
+ const { npm } = detectPackageManager();
7
+
8
+ const generate = async (ctx: C3Context) => {
9
+ await runFrameworkGenerator(ctx, [ctx.project.name]);
10
+ };
11
+
12
+ const config: TemplateConfig = {
13
+ configVersion: 1,
14
+ id: "vue",
15
+ displayName: "Vue",
16
+ platform: "pages",
17
+ generate,
18
+ transformPackageJson: async () => ({
19
+ scripts: {
20
+ deploy: `${npm} run build && wrangler pages deploy ./dist`,
21
+ preview: `${npm} run build && wrangler pages dev ./dist`,
22
+ },
23
+ }),
24
+ devScript: "dev",
25
+ deployScript: "deploy",
26
+ previewScript: "preview",
27
+ };
28
+ export default config;
@@ -1,25 +0,0 @@
1
- # Example ChatGPT Plugin for Cloudflare Workers
2
-
3
- This is an example plugin showing how to build [ChatGPT plugins](https://platform.openai.com/docs/plugins/introduction) using [Cloudflare Workers](https://workers.dev). Using this example, you can deploy a plugin to Cloudflare Workers in just a few minutes.
4
-
5
- The sample plugin allows ChatGPT users to search for repositories using GitHub's search API. The plugin is implemented in TypeScript and uses the [OpenAPI](https://www.openapis.org/) specification to define the plugin's API.
6
-
7
- ![Example conversation in ChatGPT showing the plugin in use](./.assets/example.png)
8
-
9
- ## Get started
10
-
11
- 0. Sign up for [Cloudflare Workers](https://workers.dev). The free tier is more than enough for most use cases.
12
- 1. Install [wrangler](https://developers.cloudflare.com/workers/cli-wrangler/install-update), the Cloudflare Workers CLI
13
- 2. Clone this project and install dependencies with `npm install`
14
- 3. Run `wrangler login` to login to your Cloudflare account in wrangler
15
- 4. Run `wrangler deploy` to publish the plugin to Cloudflare Workers
16
-
17
- ## Usage
18
-
19
- 1. You can configure the `.well-known/ai-plugin.json` route in `index.ts`.
20
- 2. You can set up any new routes and the associated OpenAPI schema by defining new routes. See `search.ts` for an example.
21
- 3. For more information read the [itty-router-openapi official documentation](https://cloudflare.github.io/itty-router-openapi/).
22
-
23
- ## Deploying to OpenAI's API
24
-
25
- Follow the instructions [in the ChatGPT documentation](https://platform.openai.com/docs/plugins/introduction/plugin-flow) to deploy your plugin and begin using it in ChatGPT.
@@ -1,33 +0,0 @@
1
- import { OpenAPIRouter } from "@cloudflare/itty-router-openapi";
2
- import { GetSearch } from "./search";
3
-
4
- export const router = OpenAPIRouter({
5
- schema: {
6
- info: {
7
- title: "GitHub Repositories Search API",
8
- description:
9
- "A plugin that allows the user to search for GitHub repositories using ChatGPT",
10
- version: "v0.0.1",
11
- },
12
- },
13
- docs_url: "/",
14
- aiPlugin: {
15
- name_for_human: "GitHub Repositories Search",
16
- name_for_model: "github_repositories_search",
17
- description_for_human: "GitHub Repositories Search plugin for ChatGPT.",
18
- description_for_model:
19
- "GitHub Repositories Search plugin for ChatGPT. You can search for GitHub repositories using this plugin.",
20
- contact_email: "support@example.com",
21
- legal_info_url: "http://www.example.com/legal",
22
- logo_url: "https://workers.cloudflare.com/resources/logo/logo.svg",
23
- },
24
- });
25
-
26
- router.get("/search", GetSearch);
27
-
28
- // 404 for everything else
29
- router.all("*", () => new Response("Not Found.", { status: 404 }));
30
-
31
- export default {
32
- fetch: router.handle,
33
- };
@@ -1,59 +0,0 @@
1
- import { OpenAPIRoute, Query } from "@cloudflare/itty-router-openapi";
2
-
3
- export class GetSearch extends OpenAPIRoute {
4
- static schema = {
5
- tags: ["Search"],
6
- summary: "Search repositories by a query parameter",
7
- parameters: {
8
- q: Query(String, {
9
- description: "The query to search for",
10
- default: "cloudflare workers",
11
- }),
12
- },
13
- responses: {
14
- "200": {
15
- description: "Successfully response",
16
- schema: {
17
- repos: [
18
- {
19
- name: "itty-router-openapi",
20
- description:
21
- "OpenAPI 3 schema generator and validator for Cloudflare Workers",
22
- stars: "80",
23
- url: "https://github.com/cloudflare/itty-router-openapi",
24
- },
25
- ],
26
- },
27
- },
28
- },
29
- };
30
-
31
- async handle(request: Request, env, ctx, data: Record<string, any>) {
32
- const url = `https://api.github.com/search/repositories?q=${data.query.q}`;
33
-
34
- const resp = await fetch(url, {
35
- headers: {
36
- Accept: "application/vnd.github.v3+json",
37
- "User-Agent": "RepoAI - Cloudflare Workers ChatGPT Plugin Example",
38
- },
39
- });
40
-
41
- if (!resp.ok) {
42
- return new Response(await resp.text(), { status: 400 });
43
- }
44
-
45
- const json = await resp.json();
46
-
47
- // @ts-ignore
48
- const repos = json.items.map((item: any) => ({
49
- name: item.name,
50
- description: item.description,
51
- stars: item.stargazers_count,
52
- url: item.html_url,
53
- }));
54
-
55
- return {
56
- repos: repos,
57
- };
58
- }
59
- }
@@ -1,3 +0,0 @@
1
- name = "<TBD>"
2
- main = "src/index.ts"
3
- compatibility_date = "<TBD>"
File without changes
@@ -1,5 +1,5 @@
1
- import { EOL } from "node:os";
2
1
  import fs from "node:fs";
2
+ import { EOL } from "node:os";
3
3
  import { join } from "node:path";
4
4
  import { worker } from "./paths.mjs";
5
5