Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chientrm/wrangler-proxy
Wrangler Proxy exposes Workers API to outside and integrate to your favorite frameworks. Compatible with DrizzleORM.
https://github.com/chientrm/wrangler-proxy
bindings cloudflare cloudflare-kv cloudflare-r2 d1 drizzle-orm fullstack kv r2 service svelte sveltekit workers wrangler
Last synced: 3 days ago
JSON representation
Wrangler Proxy exposes Workers API to outside and integrate to your favorite frameworks. Compatible with DrizzleORM.
- Host: GitHub
- URL: https://github.com/chientrm/wrangler-proxy
- Owner: chientrm
- License: mit
- Created: 2023-06-27T15:45:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-29T01:07:11.000Z (10 months ago)
- Last Synced: 2024-10-08T14:07:54.384Z (about 1 month ago)
- Topics: bindings, cloudflare, cloudflare-kv, cloudflare-r2, d1, drizzle-orm, fullstack, kv, r2, service, svelte, sveltekit, workers, wrangler
- Language: TypeScript
- Homepage:
- Size: 137 KB
- Stars: 31
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# wrangler-proxy
[](https://www.npmjs.com/package/wrangler-proxy)
[](https://github.com/chientrm/wrangler-proxy)
Wrangler Proxy exposes Workers API to outside and integrate to your favorite frameworks. Compatible with DrizzleORM.
## Quick links
- [Get Started](#get-started)
- [Install](#install)
- [Setup `wrangler.toml`](#example-wranglertoml)
- [Setup proxy for dev](#start-proxy-for-dev)
- [Remote mode](#remote-mode)
- [Local mode](#local-mode)
- [Setup SvelteKit project](#example-sveltekit-project)
- [Using wrangler-proxy to expose workers API](#using-wrangler-proxy-to-expose-workers-api)
- [Features](#features)
- [D1](#d1)
- [PreparedStatement](#preparedstatement)
- [Service Bindings](#service-bindings)
- [app.d.ts](#appdts)
- [hooks.server.ts](#hooksserverts)
- [Example Usage](#example-usage)
- [KV](#kv)
- [R2](#r2)
- [waitUntil](#waituntil)
- [Queues](#queues-😔)
- [Hyperdrive](#hyperdrive-😔)
- [Workers AI](#workers-ai-😔)
- [AI Gateway](#ai-gateway-😔)
- [Stream](#stream-😔)
- [Images](#images-😔)
- [Contributing](#contributing)
- [Buy Me A Coffee](https://www.buymeacoffee.com/chientrm)
- [Donating via PayPal](https://www.paypal.me/chientrm)
## Get Started
### Install
```
npm i -D wrangler-proxy
```
### Example `wrangler.toml`
```toml
name = "worker"
compatibility_date = "2023-07-02"
[[d1_databases]]
binding = "D1"
database_name = "D1"
database_id = ""
[[kv_namespaces]]
binding = "KV"
id = ""
preview_id = ""
[[services]]
binding = "WORKER"
service = ""
environment = "production"
```
### Start proxy for dev
#### Remote mode
```
wrangler dev node_modules/wrangler-proxy/dist/worker.js --remote
```
#### Local mode
```
wrangler dev node_modules/wrangler-proxy/dist/worker.js
```
### Example SvelteKit project
```ts
// file: app.d.ts
declare global {
namespace App {
interface Locals {
D1: D1Database;
}
interface Platform {
env?: {
D1: D1Database;
};
}
}
}
export {};
```
```ts
// file: src/hooks.server.ts
import { connectD1 } from 'wrangler-proxy';
export const handle = ({ event, resolve }) => {
event.locals.D1 = event.platform?.env?.D1 ?? connectD1('D1');
// or connectD1('D1', { hostname: 'custom-host-name' });
// default hostname is `http://127.0.0.1:8787`
return resolve(event);
};
```
## Using `wrangler-proxy` to expose workers API
Init worker
```
npm create cloudflare@2 - .
```
```ts
// file: src/index.ts
import { createWorker } from 'wrangler-proxy';
export default createWorker();
```
## Features
- 😔 Need funding
- 🤷 Not fully tested
- ✅ Complete
### D1
```ts
import { connectD1 } from 'wrangler-proxy';
```
| Function | Status |
| ----------- | ------ |
| `prepare()` | ✅ |
| `batch()` | ✅ |
| `dump()` | 😔 |
| `exec()` | ✅ |
#### PreparedStatement
| Function | Status |
| --------- | ------ |
| `first()` | ✅ |
| `run()` | ✅ |
| `all()` | ✅ |
| `raw()` | ✅ |
| `bind()` | ✅ |
### Service Bindings
```ts
import { connectServiceBinding } from 'wrangler-proxy';
```
| Function | Status |
| ----------- | ------ |
| `fetch()` | ✅ |
| `connect()` | 😔 |
#### app.d.ts
```ts
// app.d.ts
declare global {
namespace App {
interface Locals {
SB: Fetcher;
}
interface Platform {
env?: {
SB: Fetcher;
};
}
}
}
```
#### hooks.server.ts
```ts
/// hooks.server.ts
import { connectServiceBinding } from 'wrangler-proxy';
export const handle = async ({ resolve, event }) => {
event.locals.SB = event.platform?.env?.SB ?? connectServiceBinding('SB');
return resolve(event);
};
```
#### Example usage
```ts
event.locals.SB.fetch('http://whatever.fake/send');
```
`http://whatever.fake` is required as a dummy hostname. Without a dummy hostname the `fetch` will fail.
### KV
```ts
import { connectKV } from 'wrangler-proxy';
```
| Function | Status |
| ------------------- | ------ |
| `put()` | 🤷 |
| `get()` | ✅ |
| `getWithMetadata()` | 🤷 |
| `delete()` | ✅ |
| `list()` | 🤷 |
### R2
```ts
import { connectR2 } from 'wrangler-proxy';
```
| Function | Status |
| ------------------------- | ------ |
| `head()` | 😔 |
| `get()` | ✅ |
| `put()` | ✅ |
| `createMultipartUpload()` | 😔 |
| `resumeMultipartUpload()` | 😔 |
| `delete()` | ✅ |
| `list()` | 😔 |
### `waitUntil`
```ts
// file: app.d.ts
namespace App {
interface Platform {
context: {
waitUntil(promise: Promise): void;
};
}
}
```
```ts
// file: +page.server.ts
import { waitUntil } from 'wrangler-proxy';
export const actions = {
default: ({ locals, platform }) => {
waitUntil((async () => {})(), platform?.context);
return { message: 'success' };
},
};
```
### Queues 😔
### Hyperdrive 😔
### Workers AI 😔
### AI Gateway 😔
### Stream 😔
### Images 😔
## Contributing
If you find this project helpful, consider supporting it by
or
[Donating via PayPal](https://www.paypal.me/chientrm)
Your donation will help us implement your requested features faster.