create-cloudflare 0.0.0-ee91efcc → 0.0.0-ee98fd444
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 +53242 -37817
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +39 -28
- 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.toml +85 -0
- package/templates/angular/c3.ts +114 -0
- package/templates/angular/templates/src/server.ts +15 -0
- package/templates/angular/templates/tools/copy-files.mjs +15 -0
- package/templates/astro/c3.ts +113 -0
- package/templates/astro/snippets/runtimeDeclaration.ts +5 -0
- package/templates/astro/templates/wrangler.toml +86 -0
- package/templates/common/c3.ts +19 -0
- package/templates/common/js/.editorconfig +0 -1
- package/templates/common/js/package.json +1 -1
- package/templates/common/js/wrangler.toml +84 -22
- 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.toml +84 -22
- package/templates/docusaurus/c3.ts +28 -0
- package/templates/gatsby/c3.ts +49 -0
- package/templates/hello-world/c3.ts +20 -0
- 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.toml +85 -22
- package/templates/hello-world/py/__dot__gitignore +68 -0
- package/templates/hello-world/py/package.json +13 -0
- package/templates/hello-world/py/src/entry.py +4 -0
- package/templates/hello-world/py/wrangler.toml +114 -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.toml +85 -22
- package/templates/hello-world-durable-object/c3.ts +18 -0
- package/templates/hello-world-durable-object/js/.editorconfig +12 -0
- package/templates/hello-world-durable-object/js/.prettierrc +6 -0
- package/templates/hello-world-durable-object/js/__dot__gitignore +172 -0
- package/templates/hello-world-durable-object/js/package.json +13 -0
- package/templates/hello-world-durable-object/js/src/index.js +69 -0
- package/templates/hello-world-durable-object/js/wrangler.toml +113 -0
- package/templates/hello-world-durable-object/ts/.editorconfig +12 -0
- package/templates/hello-world-durable-object/ts/.prettierrc +6 -0
- package/templates/hello-world-durable-object/ts/__dot__gitignore +172 -0
- package/templates/hello-world-durable-object/ts/package.json +15 -0
- package/templates/hello-world-durable-object/ts/src/index.ts +65 -0
- package/templates/hello-world-durable-object/ts/tsconfig.json +42 -0
- package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +5 -0
- package/templates/hello-world-durable-object/ts/wrangler.toml +113 -0
- package/templates/hono/c3.ts +69 -0
- package/templates/hono/snippets/appDeclaration.ts +1 -0
- package/templates/hono/templates/worker-configuration.d.ts +4 -0
- package/templates/hono/templates/wrangler.toml +113 -0
- package/templates/next/README.md +68 -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 +22 -0
- package/templates/next/app/ts/app/not-found.tsx +58 -0
- package/templates/next/c3.ts +238 -0
- 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.toml +86 -0
- package/templates/nuxt/c3.ts +134 -0
- package/templates/nuxt/templates/env.d.ts +14 -0
- package/templates/nuxt/templates/worker-configuration.d.ts +4 -0
- package/templates/nuxt/templates/wrangler.toml +86 -0
- package/templates/openapi/c3.ts +10 -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 +16 -22
- package/templates/openapi/ts/src/types.ts +9 -8
- package/templates/openapi/ts/worker-configuration.d.ts +4 -0
- package/templates/openapi/ts/wrangler.toml +110 -0
- package/templates/pre-existing/c3.ts +102 -0
- package/templates/pre-existing/js/.editorconfig +12 -0
- package/templates/pre-existing/js/.prettierrc +6 -0
- package/templates/pre-existing/js/__dot__gitignore +172 -0
- package/templates/pre-existing/js/package.json +13 -0
- package/templates/pre-existing/js/wrangler.toml +4 -0
- package/templates/queues/c3.ts +28 -0
- package/templates/queues/js/.editorconfig +0 -1
- package/templates/queues/js/package.json +1 -1
- package/templates/queues/js/wrangler.toml +101 -2
- 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.toml +101 -2
- package/templates/qwik/c3.ts +147 -0
- package/templates/qwik/snippets/getPlatformProxy.ts +6 -0
- package/templates/qwik/templates/worker-configuration.d.ts +4 -0
- package/templates/qwik/templates/wrangler.toml +86 -0
- package/templates/react/c3.ts +61 -0
- package/templates/remix/c3.ts +67 -0
- package/templates/remix/templates/worker-configuration.d.ts +4 -0
- package/templates/remix/templates/wrangler.toml +85 -0
- package/templates/scheduled/c3.ts +18 -0
- package/templates/scheduled/js/.editorconfig +0 -1
- package/templates/scheduled/js/package.json +3 -3
- package/templates/scheduled/js/src/index.js +8 -1
- package/templates/scheduled/js/wrangler.toml +110 -0
- package/templates/scheduled/ts/.editorconfig +0 -1
- package/templates/scheduled/ts/package.json +5 -4
- package/templates/scheduled/ts/src/index.ts +6 -23
- package/templates/scheduled/ts/tsconfig.json +36 -95
- package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
- package/templates/scheduled/ts/wrangler.toml +110 -0
- package/templates/solid/c3.ts +87 -0
- package/templates/solid/templates/wrangler.toml +84 -0
- package/templates/svelte/c3.ts +158 -0
- package/templates/svelte/templates/wrangler.toml +85 -0
- package/templates/vue/c3.ts +29 -0
- package/templates-experimental/angular/c3.ts +112 -0
- package/templates-experimental/angular/templates/src/server.ts +15 -0
- package/templates-experimental/angular/templates/wrangler.toml +11 -0
- package/templates-experimental/astro/c3.ts +114 -0
- package/templates-experimental/astro/snippets/runtimeDeclaration.ts +5 -0
- package/templates-experimental/astro/templates/public/.assetsignore +4 -0
- package/templates-experimental/astro/templates/wrangler.toml +12 -0
- package/templates-experimental/docusaurus/c3.ts +32 -0
- package/templates-experimental/docusaurus/templates/wrangler.toml +10 -0
- package/templates-experimental/gatsby/c3.ts +53 -0
- package/templates-experimental/gatsby/templates/wrangler.toml +10 -0
- package/templates-experimental/hello-world-assets-only/c3.ts +15 -0
- package/templates-experimental/hello-world-assets-only/templates/package.json +13 -0
- package/templates-experimental/hello-world-assets-only/templates/public/index.html +11 -0
- package/templates-experimental/hello-world-assets-only/templates/wrangler.toml +10 -0
- package/templates-experimental/hello-world-durable-object-with-assets/c3.ts +23 -0
- package/templates-experimental/hello-world-durable-object-with-assets/js/.editorconfig +12 -0
- package/templates-experimental/hello-world-durable-object-with-assets/js/.prettierrc +6 -0
- package/{templates/chatgptPlugin/ts → templates-experimental/hello-world-durable-object-with-assets/js}/__dot__gitignore +1 -0
- package/templates-experimental/hello-world-durable-object-with-assets/js/package.json +13 -0
- package/templates-experimental/hello-world-durable-object-with-assets/js/public/index.html +19 -0
- package/templates-experimental/hello-world-durable-object-with-assets/js/src/index.js +69 -0
- package/templates-experimental/hello-world-durable-object-with-assets/js/wrangler.toml +24 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/.editorconfig +12 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/.prettierrc +6 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/__dot__gitignore +172 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/package.json +15 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/public/index.html +19 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/src/index.ts +66 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/tsconfig.json +42 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/worker-configuration.d.ts +5 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/wrangler.toml +24 -0
- package/templates-experimental/hello-world-with-assets/c3.ts +22 -0
- package/templates-experimental/hello-world-with-assets/js/.editorconfig +12 -0
- package/templates-experimental/hello-world-with-assets/js/.prettierrc +6 -0
- package/templates-experimental/hello-world-with-assets/js/__dot__gitignore +172 -0
- package/templates-experimental/hello-world-with-assets/js/package.json +16 -0
- package/templates-experimental/hello-world-with-assets/js/public/index.html +31 -0
- package/templates-experimental/hello-world-with-assets/js/src/index.js +23 -0
- package/templates-experimental/hello-world-with-assets/js/test/index.spec.js +41 -0
- package/templates-experimental/hello-world-with-assets/js/vitest.config.js +11 -0
- package/templates-experimental/hello-world-with-assets/js/wrangler.toml +12 -0
- package/templates-experimental/hello-world-with-assets/py/__dot__gitignore +68 -0
- package/templates-experimental/hello-world-with-assets/py/package.json +13 -0
- package/templates-experimental/hello-world-with-assets/py/public/index.html +31 -0
- package/templates-experimental/hello-world-with-assets/py/src/entry.py +9 -0
- package/templates-experimental/hello-world-with-assets/py/wrangler.toml +12 -0
- package/templates-experimental/hello-world-with-assets/ts/.editorconfig +12 -0
- package/templates-experimental/hello-world-with-assets/ts/.prettierrc +6 -0
- package/templates-experimental/hello-world-with-assets/ts/__dot__gitignore +172 -0
- package/templates-experimental/hello-world-with-assets/ts/package.json +18 -0
- package/templates-experimental/hello-world-with-assets/ts/public/index.html +31 -0
- package/templates-experimental/hello-world-with-assets/ts/src/index.ts +26 -0
- package/templates-experimental/hello-world-with-assets/ts/test/index.spec.ts +41 -0
- package/templates-experimental/hello-world-with-assets/ts/test/tsconfig.json +8 -0
- package/templates-experimental/hello-world-with-assets/ts/tsconfig.json +44 -0
- package/templates-experimental/hello-world-with-assets/ts/vitest.config.mts +11 -0
- package/templates-experimental/hello-world-with-assets/ts/worker-configuration.d.ts +4 -0
- package/templates-experimental/hello-world-with-assets/ts/wrangler.toml +12 -0
- package/templates-experimental/hono/c3.ts +43 -0
- package/templates-experimental/hono/templates/public/index.html +19 -0
- package/templates-experimental/hono/templates/src/index.ts +9 -0
- package/templates-experimental/hono/templates/worker-configuration.d.ts +4 -0
- package/templates-experimental/hono/templates/wrangler.toml +5 -0
- package/templates-experimental/next/c3.ts +52 -0
- package/templates-experimental/next/templates/__dot__gitignore +42 -0
- package/templates-experimental/next/templates/env.d.ts +5 -0
- package/templates-experimental/next/templates/wrangler.toml +12 -0
- package/templates-experimental/nuxt/c3.ts +135 -0
- package/templates-experimental/nuxt/templates/env.d.ts +14 -0
- package/templates-experimental/nuxt/templates/worker-configuration.d.ts +4 -0
- package/templates-experimental/nuxt/templates/wrangler.toml +11 -0
- package/templates-experimental/qwik/c3.ts +153 -0
- package/templates-experimental/qwik/snippets/getPlatformProxy.ts +6 -0
- package/templates-experimental/qwik/templates/public/.assetsignore +4 -0
- package/templates-experimental/qwik/templates/worker-configuration.d.ts +4 -0
- package/templates-experimental/qwik/templates/wrangler.toml +12 -0
- package/templates-experimental/remix/c3.ts +52 -0
- package/templates-experimental/remix/templates/public/.assetsignore +0 -0
- package/templates-experimental/remix/templates/worker-configuration.d.ts +4 -0
- package/templates-experimental/remix/templates/wrangler.toml +11 -0
- package/templates-experimental/solid/c3.ts +94 -0
- package/templates-experimental/solid/templates/wrangler.toml +12 -0
- package/templates-experimental/svelte/c3.ts +129 -0
- package/templates-experimental/svelte/templates/static/.assetsignore +4 -0
- package/templates-experimental/svelte/templates/wrangler.toml +11 -0
- package/templates-experimental/vue/c3.ts +33 -0
- package/templates-experimental/vue/templates/wrangler.toml +10 -0
- package/dist/angular/templates/server.ts +0 -34
- package/dist/angular/templates/tools/alter-polyfills.mjs +0 -27
- package/dist/angular/templates/tools/copy-files.mjs +0 -9
- package/dist/angular/templates/tools/paths.mjs +0 -9
- package/templates/chatgptPlugin/ts/.assets/example.png +0 -0
- package/templates/chatgptPlugin/ts/README.md +0 -25
- package/templates/chatgptPlugin/ts/package.json +0 -16
- package/templates/chatgptPlugin/ts/src/index.ts +0 -33
- package/templates/chatgptPlugin/ts/src/search.ts +0 -59
- package/templates/chatgptPlugin/ts/wrangler.toml +0 -3
- /package/{dist → templates}/angular/templates/src/_routes.json +0 -0
|
@@ -0,0 +1,33 @@
|
|
|
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
|
+
frameworkCli: "create-vue",
|
|
16
|
+
platform: "workers",
|
|
17
|
+
displayName: "Vue",
|
|
18
|
+
copyFiles: {
|
|
19
|
+
path: "./templates",
|
|
20
|
+
},
|
|
21
|
+
path: "templates-experimental/vue",
|
|
22
|
+
generate,
|
|
23
|
+
transformPackageJson: async () => ({
|
|
24
|
+
scripts: {
|
|
25
|
+
deploy: `${npm} run build && wrangler deploy`,
|
|
26
|
+
preview: `${npm} run build && wrangler dev`,
|
|
27
|
+
},
|
|
28
|
+
}),
|
|
29
|
+
devScript: "dev",
|
|
30
|
+
deployScript: "deploy",
|
|
31
|
+
previewScript: "preview",
|
|
32
|
+
};
|
|
33
|
+
export default config;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
#:schema node_modules/wrangler/config-schema.json
|
|
2
|
+
name = "<TBD>"
|
|
3
|
+
compatibility_date = "<TBD>"
|
|
4
|
+
assets = { directory = "./dist" }
|
|
5
|
+
|
|
6
|
+
# Workers Logs
|
|
7
|
+
# Docs: https://developers.cloudflare.com/workers/observability/logs/workers-logs/
|
|
8
|
+
# Configuration: https://developers.cloudflare.com/workers/observability/logs/workers-logs/#enable-workers-logs
|
|
9
|
+
[observability]
|
|
10
|
+
enabled = true
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
import { renderApplication } from "@angular/platform-server";
|
|
2
|
-
import bootstrap from "./src/main.server";
|
|
3
|
-
|
|
4
|
-
interface Env {
|
|
5
|
-
ASSETS: { fetch: typeof fetch };
|
|
6
|
-
}
|
|
7
|
-
|
|
8
|
-
// We attach the Cloudflare `fetch()` handler to the global scope
|
|
9
|
-
// so that we can export it when we process the Angular output.
|
|
10
|
-
// See tools/bundle.mjs
|
|
11
|
-
async function workerFetchHandler(request: Request, env: Env) {
|
|
12
|
-
const url = new URL(request.url);
|
|
13
|
-
console.log("render SSR", url.href);
|
|
14
|
-
|
|
15
|
-
// Get the root `index.html` content.
|
|
16
|
-
const indexUrl = new URL("/", url);
|
|
17
|
-
const indexResponse = await env.ASSETS.fetch(new Request(indexUrl));
|
|
18
|
-
const document = await indexResponse.text();
|
|
19
|
-
|
|
20
|
-
const content = await renderApplication(bootstrap, {
|
|
21
|
-
document,
|
|
22
|
-
url: url.pathname,
|
|
23
|
-
});
|
|
24
|
-
|
|
25
|
-
// console.log("rendered SSR", content);
|
|
26
|
-
return new Response(content, indexResponse);
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
export default {
|
|
30
|
-
fetch: (request: Request, env: Env) =>
|
|
31
|
-
(globalThis as any)["__zone_symbol__Promise"].resolve(
|
|
32
|
-
workerFetchHandler(request, env)
|
|
33
|
-
),
|
|
34
|
-
};
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
import { EOL } from "node:os";
|
|
2
|
-
import fs from "node:fs";
|
|
3
|
-
import { join } from "node:path";
|
|
4
|
-
import { worker } from "./paths.mjs";
|
|
5
|
-
|
|
6
|
-
/**
|
|
7
|
-
* Split by lines and comment the banner
|
|
8
|
-
* ```
|
|
9
|
-
* import { createRequire } from 'node:module';
|
|
10
|
-
* globalThis['require'] ??= createRequire(import.meta.url);
|
|
11
|
-
* ```
|
|
12
|
-
*/
|
|
13
|
-
const serverPolyfillsFile = join(worker, "polyfills.server.mjs");
|
|
14
|
-
const serverPolyfillsData = fs
|
|
15
|
-
.readFileSync(serverPolyfillsFile, "utf8")
|
|
16
|
-
.split(/\r?\n/);
|
|
17
|
-
|
|
18
|
-
for (let index = 0; index < 2; index++) {
|
|
19
|
-
if (serverPolyfillsData[index].includes("createRequire")) {
|
|
20
|
-
serverPolyfillsData[index] = "// " + serverPolyfillsData[index];
|
|
21
|
-
}
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
// Add needed polyfills
|
|
25
|
-
serverPolyfillsData.unshift(`globalThis['process'] = {};`);
|
|
26
|
-
|
|
27
|
-
fs.writeFileSync(serverPolyfillsFile, serverPolyfillsData.join(EOL));
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
// Copy the files over so that they can be uploaded by the pages publish command.
|
|
2
|
-
import fs from "node:fs";
|
|
3
|
-
import { join } from "node:path";
|
|
4
|
-
import { client, cloudflare, worker, ssr } from "./paths.mjs";
|
|
5
|
-
|
|
6
|
-
fs.cpSync(client, cloudflare, { recursive: true });
|
|
7
|
-
fs.cpSync(ssr, worker, { recursive: true });
|
|
8
|
-
|
|
9
|
-
fs.renameSync(join(worker, "server.mjs"), join(worker, "index.js"));
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import path from "node:path";
|
|
2
|
-
import { fileURLToPath } from "node:url";
|
|
3
|
-
|
|
4
|
-
const dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
5
|
-
export const root = path.resolve(dirname, "..");
|
|
6
|
-
export const client = path.resolve(root, "dist/browser");
|
|
7
|
-
export const ssr = path.resolve(root, "dist/server");
|
|
8
|
-
export const cloudflare = path.resolve(root, "dist/cloudflare");
|
|
9
|
-
export const worker = path.resolve(cloudflare, "_worker.js");
|
|
Binary file
|
|
@@ -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
|
-

|
|
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,16 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "cloudflare-workers-chatgpt-plugin-example",
|
|
3
|
-
"version": "0.0.1",
|
|
4
|
-
"private": true,
|
|
5
|
-
"scripts": {
|
|
6
|
-
"deploy": "wrangler deploy",
|
|
7
|
-
"dev": "wrangler dev",
|
|
8
|
-
"start": "wrangler dev"
|
|
9
|
-
},
|
|
10
|
-
"dependencies": {
|
|
11
|
-
"@cloudflare/itty-router-openapi": "^1.0.1"
|
|
12
|
-
},
|
|
13
|
-
"devDependencies": {
|
|
14
|
-
"wrangler": "^3.0.0"
|
|
15
|
-
}
|
|
16
|
-
}
|
|
@@ -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
|
-
}
|
|
File without changes
|