@aryanbansal-launch/edge-utils 0.1.3 → 0.1.5

package/bin/launch-init.js

@@ -0,0 +1,137 @@
+#!/usr/bin/env node
+
+import fs from 'fs';
+import path from 'path';
+
+const functionsDir = path.join(process.cwd(), 'functions');
+const edgeFile = path.join(functionsDir, '[proxy].edge.js');
+
+// Simple ANSI colors for better terminal output
+const colors = {
+  reset: '\x1b[0m',
+  bright: '\x1b[1m',
+  green: '\x1b[32m',
+  yellow: '\x1b[33m',
+  cyan: '\x1b[36m',
+  blue: '\x1b[34m'
+};
+
+const template = `
+import {
+  jsonResponse,
+  passThrough,
+  redirectIfMatch,
+  protectWithBasicAuth,
+  ipAccessControl,
+  blockAICrawlers,
+  getGeoHeaders,
+  handleNextJS_RSC
+} from "@aryanbansal-launch/edge-utils";
+
+/**
+ * Default Edge Handler for Contentstack Launch
+ * This file was automatically generated by @aryanbansal-launch/edge-utils
+ */
+export default async function handler(request, context) {
+  // 1. ⚛️ Fix Next.js RSC issues for specific paths
+  const rscResponse = await handleNextJS_RSC(request, {
+    affectedPaths: ["/my-rsc-page", "/another-page"]
+  });
+  if (rscResponse) return rscResponse;
+
+  // 2. 🛡️ Block AI bots immediately
+  const botResponse = blockAICrawlers(request);
+  if (botResponse) return botResponse;
+
+  // 3. 🧱 IP Whitelisting
+  const ipResponse = ipAccessControl(request, { allow: ["203.0.113.10"] });
+  if (ipResponse) return ipResponse;
+
+  // 4. 🔐 Domain-specific Basic Auth
+  const authResponse = await protectWithBasicAuth(request, {
+    hostnameIncludes: "staging.myapp.com",
+    username: "admin",
+    password: "securepassword123"
+  });
+  if (authResponse && authResponse.status === 401) return authResponse;
+
+  // 5. 🔀 SEO-friendly Redirects
+  const redirectResponse = redirectIfMatch(request, {
+    path: "/legacy-url",
+    to: "/modern-url",
+    status: 301
+  });
+  if (redirectResponse) return redirectResponse;
+
+  // 6. 📍 Geo-Location Access
+  const geo = getGeoHeaders(request);
+  if (geo.country === "US") {
+    console.log(\`User from \${geo.city}, \${geo.region}\`);
+  }
+
+  // 7. 📤 Custom JSON Responses
+  if (new URL(request.url).pathname === "/api/health") {
+    return jsonResponse({ status: "healthy", region: geo.region });
+  }
+
+  // 8. 🚀 Pass through to origin
+  return passThrough(request);
+}
+`.trim();
+
+async function init() {
+  console.log(`\n${colors.bright}${colors.cyan}🚀 Edge Utilities: Contentstack Launch Setup${colors.reset}\n`);
+
+  let actionsTaken = 0;
+
+  // 1. Root level check: Look for package.json
+  const packageJsonPath = path.join(process.cwd(), 'package.json');
+  if (!fs.existsSync(packageJsonPath)) {
+    console.log(`${colors.red}❌ Error: Root directory not detected.${colors.reset}`);
+    console.log(`${colors.yellow}Contentstack Launch requires the 'functions' folder to be at your project root${colors.reset}`);
+    console.log(`${colors.yellow}(the same directory as your package.json).${colors.reset}\n`);
+    console.log(`Please ${colors.bright}cd${colors.reset} into your project root and try again.`);
+    process.exit(1);
+  }
+
+  try {
+    // 2. Folder existence check
+    if (!fs.existsSync(functionsDir)) {
+      fs.mkdirSync(functionsDir, { recursive: true });
+      console.log(`${colors.green}✨ New:${colors.reset} Created /functions directory`);
+      actionsTaken++;
+    } else {
+      console.log(`${colors.blue}ℹ️  Existing:${colors.reset} /functions directory already found`);
+    }
+
+    // 3. File existence check (don't overwrite user's work)
+    if (!fs.existsSync(edgeFile)) {
+      fs.writeFileSync(edgeFile, template + '\n');
+      console.log(`${colors.green}✨ New:${colors.reset} Created /functions/[proxy].edge.js`);
+      actionsTaken++;
+    } else {
+      console.log(`${colors.blue}ℹ️  Existing:${colors.reset} /functions/[proxy].edge.js already found`);
+    }
+
+    // Final Summary Messages based on the state
+    if (actionsTaken === 0) {
+      console.log(`\n${colors.bright}${colors.blue}🏁 Everything is already set up!${colors.reset}`);
+      console.log(`No changes were made to your existing files.`);
+    } else {
+      console.log(`\n${colors.bright}${colors.green}🎉 Setup Complete!${colors.reset}`);
+      console.log(`Successfully prepared your edge environment.`);
+    }
+
+    console.log(`\n${colors.bright}Next Steps:${colors.reset}`);
+    console.log(`1. Open ${colors.cyan}functions/[proxy].edge.js${colors.reset}`);
+    console.log(`2. Customize your redirects, auth, and RSC paths`);
+    console.log(`3. Deploy your project to Contentstack Launch\n`);
+    
+    console.log(`${colors.blue}Documentation:${colors.reset} https://github.com/AryanBansal-launch/launch-edge-utils#readme\n`);
+  } catch (error) {
+    console.error(`\n${colors.red}❌ Error during setup:${colors.reset}`, error.message);
+    process.exit(1);
+  }
+}
+
+init();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aryanbansal-launch/edge-utils",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "license": "MIT",
   "type": "module",
   "repository": {
@@ -12,11 +12,15 @@
     "url": "https://github.com/AryanBansal-launch/launch-edge-utils/issues"
   },
   "main": "dist/index.js",
+  "bin": {
+    "launch-init": "./bin/launch-init.js"
+  },
   "exports": {
     ".": "./dist/index.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "bin"
   ],
   "scripts": {
     "build": "tsc"

package/readme.md

@@ -1,10 +1,9 @@
-# 🚀 Edge Utils
+# 🚀 Edge Utils for Contentstack Launch
 
 [![npm version](https://img.shields.io/npm/v/@launch/edge-utils.svg)](https://www.npmjs.com/package/@launch/edge-utils)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Platform Support](https://img.shields.io/badge/Platform-Edge-blueviolet.svg)](#platform-support)
 
-A lightweight, developer-friendly toolkit for **Edge Computing**. Speed up your development on platforms like Cloudflare Workers, Vercel Edge, and Contentstack Launch with production-ready utilities for security, authentication, and routing.
+A lightweight, high-performance toolkit specifically designed for **Contentstack Launch Edge Functions**. Speed up your development with production-ready utilities for security, authentication, routing, and Next.js compatibility—all optimized to run at the edge.
 
 ---
 
@@ -13,25 +12,35 @@ A lightweight, developer-friendly toolkit for **Edge Computing**. Speed up your
 - 🛡️ **Security First**: Block AI crawlers and manage IP access with ease.
 - 🔐 **Edge Auth**: Implement Basic Auth directly at the edge for specific hostnames.
 - 📍 **Geo-Aware**: Easily extract location data from request headers.
-- ⚛️ **Next.js Ready**: Built-in fixes for RSC header issues on edge proxies.
+- ⚛️ **Next.js Ready**: Built-in fixes for RSC header issues on Launch proxies.
 - 🔀 **Smart Routing**: Declarative redirects based on path and method.
 - ⚡ **Zero Dependencies**: Lightweight and optimized for edge runtime limits.
 
 ---
 
-## 📦 Installation
+## ⚡ Quick Start (Recommended)
 
+Set up your entire edge environment in seconds with our automated CLI tool.
+
+### 1. Install
 ```bash
-npm install @launch/edge-utils
+npm install @aryanbansal-launch/edge-utils
 ```
 
+### 2. Initialize
+Run this command from your **project root**:
+```bash
+npx launch-init
+```
+This will automatically create the `functions/` directory and a boilerplate `[proxy].edge.js` handler for you.
+
 ---
 
 ## 🛠️ Usage Example
 
-Transform your edge handler into a powerful middleware chain:
+Once initialized, your `functions/[proxy].edge.js` will look like a powerful middleware chain:
 
-```typescript
+```javascript
 import {
   jsonResponse,
   passThrough,
@@ -41,12 +50,12 @@ import {
   blockAICrawlers,
   getGeoHeaders,
   handleNextJS_RSC
-} from "@launch/edge-utils";
+} from "@aryanbansal-launch/edge-utils";
 
-export default async function handler(request: Request) {
+export default async function handler(request, context) {
   // 1. ⚛️ Fix Next.js RSC issues for specific paths
   const rscResponse = await handleNextJS_RSC(request, {
-    affectedPaths: ["/my-rsc-page", "/another-page"]
+    affectedPaths: ["/shop", "/about"]
   });
   if (rscResponse) return rscResponse;
 
@@ -54,11 +63,11 @@ export default async function handler(request: Request) {
   const botResponse = blockAICrawlers(request);
   if (botResponse) return botResponse;
 
-  // 2. 🧱 IP Whitelisting
+  // 3. 🧱 IP Whitelisting
   const ipResponse = ipAccessControl(request, { allow: ["203.0.113.10"] });
   if (ipResponse) return ipResponse;
 
-  // 3. 🔐 Domain-specific Basic Auth
+  // 4. 🔐 Domain-specific Basic Auth (e.g., for staging)
   const authResponse = await protectWithBasicAuth(request, {
     hostnameIncludes: "staging.myapp.com",
     username: "admin",
@@ -66,7 +75,7 @@ export default async function handler(request: Request) {
   });
   if (authResponse && authResponse.status === 401) return authResponse;
 
-  // 4. 🔀 SEO-friendly Redirects
+  // 5. 🔀 SEO-friendly Redirects
   const redirectResponse = redirectIfMatch(request, {
     path: "/legacy-url",
     to: "/modern-url",
@@ -74,16 +83,9 @@ export default async function handler(request: Request) {
   });
   if (redirectResponse) return redirectResponse;
 
-  // 5. 📍 Geo-Location Access
+  // 6. 📍 Geo-Location Access
   const geo = getGeoHeaders(request);
-  if (geo.country === "US") {
-    console.log(`User from ${geo.city}, ${geo.region}`);
-  }
-
-  // 6. 📤 Custom JSON Responses
-  if (new URL(request.url).pathname === "/api/health") {
-    return jsonResponse({ status: "healthy", region: geo.region });
-  }
+  console.log(`Request from ${geo.city}, ${geo.country}`);
 
   // 7. 🚀 Pass through to origin
   return passThrough(request);
@@ -95,78 +97,23 @@ export default async function handler(request: Request) {
 ## 📖 API Reference
 
 ### 🛡️ Security
-
-#### `blockAICrawlers`
-Blocks common AI crawlers (GPTBot, ClaudeBot, etc.) to protect your content from scraping.
-- **Parameters**: `request: Request`, `bots?: string[]` (optional list to override defaults)
-- **Returns**: `Response` (403) or `null`.
-
-#### `ipAccessControl`
-Simple firewall for your edge function.
-- **Options**:
-  - `allow`: Array of IPs allowed to access.
-  - `deny`: Array of IPs to block.
-- **Returns**: `Response` (403) or `null`.
+- **`blockAICrawlers(request, bots?)`**: Blocks common AI crawlers.
+- **`ipAccessControl(request, { allow?, deny? })`**: Simple IP-based firewall.
 
 ### 🔐 Authentication
-
-#### `protectWithBasicAuth`
-Prompt for credentials based on the hostname.
-- **Options**:
-  - `hostnameIncludes`: Match substring in hostname (e.g., ".dev").
-  - `username`: Required username.
-  - `password`: Required password.
-  - `realm`: Optional realm name for the auth prompt.
-- **Returns**: `Promise<Response>` or `null`.
+- **`protectWithBasicAuth(request, options)`**: Prompt for credentials based on hostname.
 
 ### 🔀 Redirection
-
-#### `redirectIfMatch`
-Perform redirects directly at the edge to reduce latency.
-- **Options**:
-  - `path`: The path to match.
-  - `method`: HTTP method to match (optional, defaults to any).
-  - `to`: Target path or URL.
-  - `status`: HTTP status code (default: 301).
-- **Returns**: `Response` (Redirect) or `null`.
+- **`redirectIfMatch(request, options)`**: Perform SEO-friendly redirects at the edge.
 
 ### 📍 Geo Location
-
-#### `getGeoHeaders`
-Extracts geo-information provided by edge platform headers.
-- **Returns**: Object with `country`, `region`, `city`, `latitude`, `longitude`.
+- **`getGeoHeaders(request)`**: Returns an object with `country`, `region`, `city`, `latitude`, `longitude`.
 
 ### ⚛️ Next.js
-
-#### `handleNextJS_RSC`
-Handles Next.js React Server Component (RSC) header issues on Contentstack Launch. It detects requests to "affected paths" that have the `rsc` header but lack the `_rsc` query parameter, and strips the header to prevent proxy/caching issues.
-- **Options**:
-  - `affectedPaths`: Array of pathnames (e.g., `['/shop', '/about']`) where this fix should apply.
-- **Returns**: `Promise<Response>` (the re-fetched request without RSC header) or `null`.
+- **`handleNextJS_RSC(request, { affectedPaths })`**: Resolves RSC header issues on Contentstack Launch.
 
 ---
 
 ## 🌐 Platform Support
 
-Optimized for:
-- [Contentstack Launch](https://www.contentstack.com/docs/developers/launch)
-- [Vercel Edge Functions](https://vercel.com/docs/concepts/functions/edge-functions)
-- [Cloudflare Workers](https://workers.cloudflare.com/)
-
----
-
-## 🤝 Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
-1. Fork the Project
-2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
-3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
-4. Push to the Branch (`git push origin feature/AmazingFeature`)
-5. Open a Pull Request
-
----
-
-## 📄 License
-
-Distributed under the MIT License. See `LICENSE` for more information.
+This library is exclusively optimized for **[Contentstack Launch](https://www.contentstack.com/docs/developers/launch)**.