@ereo/deploy-cloudflare 0.1.6

package/README.md

@@ -0,0 +1,187 @@
+# @ereo/deploy-cloudflare
+
+Cloudflare deployment adapter for the EreoJS framework. Generates build configuration and wrangler.toml files for deploying to Cloudflare Workers.
+
+## Installation
+
+```bash
+bun add @ereo/deploy-cloudflare
+```
+
+## Quick Start
+
+```typescript
+import { defineConfig } from '@ereo/core';
+import { cloudflare } from '@ereo/deploy-cloudflare';
+
+export default defineConfig({
+  ...cloudflare(),
+});
+```
+
+This sets the build target to `'cloudflare'` in your EreoJS configuration.
+
+## API Reference
+
+### `cloudflare(config?)`
+
+Generates EreoJS configuration for Cloudflare deployment.
+
+**Parameters:**
+- `config` (optional): `CloudflareConfig` object
+
+**Returns:** `Partial<FrameworkConfig>` - Always returns:
+```typescript
+{
+  build: {
+    target: 'cloudflare'
+  }
+}
+```
+
+**Note:** The current implementation returns the same output regardless of configuration options passed. Configuration properties are accepted for future compatibility but are not yet utilized.
+
+```typescript
+import { cloudflare } from '@ereo/deploy-cloudflare';
+
+const config = cloudflare();
+// Returns: { build: { target: 'cloudflare' } }
+```
+
+### `generateWranglerToml(config)`
+
+Generates a wrangler.toml configuration string.
+
+**Parameters:**
+- `config`: `CloudflareConfig` object
+
+**Returns:** `string` - wrangler.toml content
+
+**Supported Options:**
+- `routes`: Array of route patterns (e.g., `['example.com/*']`)
+- `kvNamespaces`: Array of KV namespace binding names
+
+**Example:**
+
+```typescript
+import { generateWranglerToml } from '@ereo/deploy-cloudflare';
+
+const toml = generateWranglerToml({
+  routes: ['api.example.com/*'],
+  kvNamespaces: ['CACHE', 'SESSIONS'],
+});
+
+await Bun.write('wrangler.toml', toml);
+```
+
+**Output:**
+
+```toml
+name = "ereo-app"
+compatibility_date = "2024-01-01"
+main = "dist/server.js"
+
+routes = ["api.example.com/*"]
+
+[[kv_namespaces]]
+binding = "CACHE"
+id = "your-namespace-id"
+
+[[kv_namespaces]]
+binding = "SESSIONS"
+id = "your-namespace-id"
+```
+
+**Important:** You must manually replace `"your-namespace-id"` with your actual Cloudflare KV namespace IDs.
+
+### `CloudflareConfig` Interface
+
+```typescript
+interface CloudflareConfig {
+  /** Deployment target: 'pages' or 'workers' (not currently used) */
+  target?: 'pages' | 'workers';
+
+  /** Cloudflare account ID (not currently used) */
+  accountId?: string;
+
+  /** Custom domain routes - included in wrangler.toml output */
+  routes?: string[];
+
+  /** KV namespace bindings - included in wrangler.toml output */
+  kvNamespaces?: string[];
+
+  /** Durable Object bindings (not currently used) */
+  durableObjects?: string[];
+}
+```
+
+### Default Export
+
+The package default export is the `cloudflare` function:
+
+```typescript
+import cloudflare from '@ereo/deploy-cloudflare';
+// Equivalent to: import { cloudflare } from '@ereo/deploy-cloudflare';
+```
+
+## Deployment Workflow
+
+### 1. Configure EreoJS
+
+```typescript
+// ereo.config.ts
+import { defineConfig } from '@ereo/core';
+import { cloudflare } from '@ereo/deploy-cloudflare';
+
+export default defineConfig({
+  ...cloudflare(),
+});
+```
+
+### 2. Generate wrangler.toml
+
+```typescript
+// scripts/generate-wrangler.ts
+import { generateWranglerToml } from '@ereo/deploy-cloudflare';
+
+const toml = generateWranglerToml({
+  routes: ['myapp.example.com/*'],
+  kvNamespaces: ['CACHE'],
+});
+
+await Bun.write('wrangler.toml', toml);
+console.log('Generated wrangler.toml - remember to update KV namespace IDs!');
+```
+
+### 3. Deploy with Wrangler
+
+```bash
+# Build the application
+bun run build
+
+# Deploy to Cloudflare
+wrangler deploy
+```
+
+## Current Limitations
+
+This package provides minimal configuration scaffolding. The following features are defined in the interface but not yet implemented:
+
+- `target` option does not differentiate between Pages and Workers
+- `accountId` is not used in any output
+- `durableObjects` bindings are not generated in wrangler.toml
+- KV namespace IDs must be manually configured (placeholder values are generated)
+
+For full Cloudflare configuration, manually edit the generated wrangler.toml or create one from scratch following [Cloudflare's documentation](https://developers.cloudflare.com/workers/wrangler/configuration/).
+
+## Documentation
+
+For full documentation, visit [https://ereo.dev/docs/deploy-cloudflare](https://ereo.dev/docs/deploy-cloudflare)
+
+## Part of EreoJS
+
+This package is part of the [EreoJS monorepo](https://github.com/anthropics/ereo-js).
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @ereo/deploy-cloudflare - Cloudflare deployment adapter
+ */
+import type { FrameworkConfig } from '@ereo/core';
+/** Cloudflare deployment configuration */
+export interface CloudflareConfig {
+    /** Deployment target: 'pages' or 'workers' */
+    target?: 'pages' | 'workers';
+    /** Account ID */
+    accountId?: string;
+    /** Custom domains */
+    routes?: string[];
+    /** KV namespace bindings */
+    kvNamespaces?: string[];
+    /** Durable Object bindings */
+    durableObjects?: string[];
+}
+/** Generate Cloudflare configuration */
+export declare function cloudflare(config?: CloudflareConfig): Partial<FrameworkConfig>;
+/** Generate wrangler.toml configuration */
+export declare function generateWranglerToml(config: CloudflareConfig): string;
+export default cloudflare;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD,0CAA0C;AAC1C,MAAM,WAAW,gBAAgB;IAC/B,8CAA8C;IAC9C,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qBAAqB;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,4BAA4B;IAC5B,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,8BAA8B;IAC9B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED,wCAAwC;AACxC,wBAAgB,UAAU,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC,CAMlF;AAED,2CAA2C;AAC3C,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAmBrE;AAED,eAAe,UAAU,CAAC"}

package/dist/index.js

@@ -0,0 +1,35 @@
+// @bun
+// src/index.ts
+function cloudflare(config = {}) {
+  return {
+    build: {
+      target: "cloudflare"
+    }
+  };
+}
+function generateWranglerToml(config) {
+  const bindings = [];
+  if (config.kvNamespaces) {
+    for (const ns of config.kvNamespaces) {
+      bindings.push(`[[kv_namespaces]]
+binding = "${ns}"
+id = "your-namespace-id"`);
+    }
+  }
+  return `name = "ereo-app"
+compatibility_date = "2024-01-01"
+main = "dist/server.js"
+
+${config.routes ? `routes = ${JSON.stringify(config.routes)}` : ""}
+
+${bindings.join(`
+
+`)}
+`;
+}
+var src_default = cloudflare;
+export {
+  generateWranglerToml,
+  src_default as default,
+  cloudflare
+};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@ereo/deploy-cloudflare",
+  "version": "0.1.6",
+  "license": "MIT",
+  "author": "Ereo Team",
+  "homepage": "https://ereo.dev",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ereojs/ereo.git",
+    "directory": "packages/deploy-cloudflare"
+  },
+  "bugs": {
+    "url": "https://github.com/ereojs/ereo/issues"
+  },
+  "description": "Cloudflare Pages/Workers deployment adapter for EreoJS framework",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "bun build ./src/index.ts --outdir ./dist --target bun --external @ereo/core && bun run build:types",
+    "build:types": "tsc --emitDeclarationOnly --outDir dist",
+    "dev": "bun build ./src/index.ts --outdir ./dist --target bun --watch",
+    "test": "bun test",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@ereo/core": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.1.0",
+    "typescript": "^5.4.0"
+  }
+}