@aryanbansal-launch/edge-utils 0.1.6 → 0.1.8

package/bin/launch-config.js

@@ -0,0 +1,123 @@
+#!/usr/bin/env node
+
+import fs from 'fs';
+import path from 'path';
+import readline from 'readline';
+
+const colors = {
+  reset: '\x1b[0m',
+  bright: '\x1b[1m',
+  green: '\x1b[32m',
+  yellow: '\x1b[33m',
+  cyan: '\x1b[36m',
+  blue: '\x1b[34m',
+  red: '\x1b[31m'
+};
+
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout
+});
+
+const question = (query) => 
+  new Promise((resolve) => rl.question(query, resolve));
+
+async function run() {
+  console.log(`\n${colors.bright}${colors.cyan}🚀 Launch Configuration Generator${colors.reset}\n`);
+
+  const packageJsonPath = path.join(process.cwd(), 'package.json');
+  if (!fs.existsSync(packageJsonPath)) {
+    console.log(`${colors.red}❌ Error: Root directory not detected.${colors.reset}`);
+    process.exit(1);
+  }
+
+  const launchJsonPath = path.join(process.cwd(), 'launch.json');
+  let config = {
+    redirects: [],
+    rewrites: [],
+    cache: {
+      cachePriming: {
+        urls: []
+      }
+    }
+  };
+
+  if (fs.existsSync(launchJsonPath)) {
+    console.log(`${colors.yellow}ℹ️  Existing launch.json found. We will merge your changes.${colors.reset}\n`);
+    try {
+      const existingConfig = JSON.parse(fs.readFileSync(launchJsonPath, 'utf-8'));
+      
+      // Preserve everything, but ensure our managed fields are initialized as arrays/objects
+      config = {
+        ...existingConfig,
+        redirects: existingConfig.redirects || [],
+        rewrites: existingConfig.rewrites || [],
+        cache: {
+          ...(existingConfig.cache || {}),
+          cachePriming: {
+            ...(existingConfig.cache?.cachePriming || {}),
+            urls: existingConfig.cache?.cachePriming?.urls || []
+          }
+        }
+      };
+    } catch (e) {
+      console.log(`${colors.red}⚠️  Error parsing existing launch.json. Starting with a fresh config.${colors.reset}\n`);
+    }
+  }
+
+  // 1. Redirects
+  while (true) {
+    const addRedirect = await question(`Do you want to add a Redirect?${config.redirects.length > 0 ? ' another?' : ''} (y/n): `);
+    if (addRedirect.toLowerCase() !== 'y') break;
+    
+    const source = await question('   Source path (e.g., /source): ');
+    const destination = await question('   Destination path (e.g., /destination): ');
+    const code = await question('   Status code (default 308): ');
+    config.redirects.push({
+      source,
+      destination,
+      statusCode: parseInt(code) || 308
+    });
+    console.log(`${colors.green}   ✔ Redirect added.${colors.reset}`);
+  }
+
+  // 2. Rewrites
+  while (true) {
+    const addRewrite = await question(`Do you want to add a Rewrite?${config.rewrites.length > 0 ? ' another?' : ''} (y/n): `);
+    if (addRewrite.toLowerCase() !== 'y') break;
+
+    const source = await question('   Source path (e.g., /api/*): ');
+    const destination = await question('   Destination URL: ');
+    config.rewrites.push({ source, destination });
+    console.log(`${colors.green}   ✔ Rewrite added.${colors.reset}`);
+  }
+
+  // 3. Cache Priming
+  const addPrime = await question('Do you want to add Cache Priming URLs? (y/n): ');
+  if (addPrime.toLowerCase() === 'y') {
+    console.log(`${colors.cyan}Note: Only relative paths are supported. No Regex/Wildcards.${colors.reset}`);
+    const urls = await question('Enter URLs separated by commas (e.g., /home,/about,/shop): ');
+    const urlList = urls.split(',').map(u => u.trim()).filter(u => u);
+    config.cache.cachePriming.urls = [...new Set([...(config.cache.cachePriming.urls || []), ...urlList])];
+  }
+
+  // Clean up empty fields before writing
+  if (config.redirects && config.redirects.length === 0) delete config.redirects;
+  if (config.rewrites && config.rewrites.length === 0) delete config.rewrites;
+  
+  if (config.cache) {
+    if (config.cache.cachePriming && config.cache.cachePriming.urls && config.cache.cachePriming.urls.length === 0) {
+      delete config.cache.cachePriming;
+    }
+    if (Object.keys(config.cache).length === 0) {
+      delete config.cache;
+    }
+  }
+
+  fs.writeFileSync(launchJsonPath, JSON.stringify(config, null, 2));
+  console.log(`\n${colors.green}✅ Successfully updated launch.json!${colors.reset}\n`);
+  
+  rl.close();
+}
+
+run();

package/dist/index.js

@@ -6,4 +6,5 @@ export * from "./security/ip-access.js";
 export * from "./security/block-bots.js";
 export * from "./security/block-default-domains.js";
 export * from "./geo/geo-headers.js";
+export * from "./launch/config.js";
 export * from "./nextjs/rsc.js";

package/dist/launch/config.js

@@ -0,0 +1,11 @@
+export function generateLaunchConfig(options) {
+    return {
+        redirects: options.redirects || [],
+        rewrites: options.rewrites || [],
+        cache: {
+            cachePriming: {
+                urls: options.cache?.cachePriming?.urls || []
+            }
+        }
+    };
+}

package/dist/security/block-default-domains.js

@@ -1,7 +1,3 @@
-/**
- * Blocks access to the site when accessed via default Contentstack Launch domains.
- * This is useful for ensuring users only access the site via your custom domain.
- */
 export function blockDefaultDomains(request, options = {}) {
     const domain = options.domainToBlock || 'contentstackapps.com';
     const url = new URL(request.url);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aryanbansal-launch/edge-utils",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "license": "MIT",
   "type": "module",
   "repository": {
@@ -13,7 +13,8 @@
   },
   "main": "dist/index.js",
   "bin": {
-    "launch-init": "./bin/launch-init.js"
+    "launch-init": "./bin/launch-init.js",
+    "launch-config": "./bin/launch-config.js"
   },
   "exports": {
     ".": "./dist/index.js"

package/readme.md

@@ -1,6 +1,6 @@
 # 🚀 Edge Utils for Contentstack Launch
 
-[![npm version](https://img.shields.io/npm/v/@launch/edge-utils.svg)](https://www.npmjs.com/package/@aryanbansal-launch/edge-utils)
+[![npm version](https://img.shields.io/npm/v/@aryanbansal-launch/edge-utils.svg)](https://www.npmjs.com/package/@aryanbansal-launch/edge-utils)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 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,6 +13,7 @@ A lightweight, high-performance toolkit specifically designed for **Contentstack
 - 🔐 **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 Launch proxies.
+- 🚀 **Cache Priming**: Easily manage cache warming URLs via CLI.
 - 🔀 **Smart Routing**: Declarative redirects based on path and method.
 - ⚡ **Zero Dependencies**: Lightweight and optimized for edge runtime limits.
 
@@ -34,6 +35,12 @@ npx launch-init
 ```
 This will automatically create the `functions/` directory and a boilerplate `[proxy].edge.js` handler for you.
 
+### 3. Configure (Optional)
+Manage your `launch.json` ([Redirects](https://www.contentstack.com/docs/developers/launch/edge-url-redirects), [Rewrites](https://www.contentstack.com/docs/developers/launch/edge-url-rewrites), and [Cache Priming](https://www.contentstack.com/docs/developers/launch/cache-priming)) interactively:
+```bash
+npx launch-config
+```
+
 ---
 
 ## 🛠️ Usage Example
@@ -64,15 +71,15 @@ export default async function handler(request, context) {
   });
   if (rscResponse) return rscResponse;
 
-  // 2. 🛡️ Block AI bots immediately
+  // 3. 🤖 Block AI bots immediately
   const botResponse = blockAICrawlers(request);
   if (botResponse) return botResponse;
 
-  // 3. 🧱 IP Whitelisting
+  // 4. 🧱 IP Whitelisting
   const ipResponse = ipAccessControl(request, { allow: ["203.0.113.10"] });
   if (ipResponse) return ipResponse;
 
-  // 4. 🔐 Domain-specific Basic Auth (e.g., for staging)
+  // 5. 🔐 Domain-specific Basic Auth (e.g., for staging)
   const authResponse = await protectWithBasicAuth(request, {
     hostnameIncludes: "staging.myapp.com",
     username: "admin",
@@ -80,7 +87,7 @@ export default async function handler(request, context) {
   });
   if (authResponse && authResponse.status === 401) return authResponse;
 
-  // 5. 🔀 SEO-friendly Redirects
+  // 6. 🔀 SEO-friendly Redirects
   const redirectResponse = redirectIfMatch(request, {
     path: "/legacy-url",
     to: "/modern-url",
@@ -88,11 +95,11 @@ export default async function handler(request, context) {
   });
   if (redirectResponse) return redirectResponse;
 
-  // 6. 📍 Geo-Location Access
+  // 7. 📍 Geo-Location Access
   const geo = getGeoHeaders(request);
   console.log(`Request from ${geo.city}, ${geo.country}`);
 
-  // 7. 🚀 Pass through to origin
+  // 8. 🚀 Pass through to origin
   return passThrough(request);
 }
 ```
@@ -102,9 +109,9 @@ export default async function handler(request, context) {
 ## 📖 API Reference
 
 ### 🛡️ Security
-- **`blockAICrawlers(request, bots?)`**: Blocks common AI crawlers.
-- **`blockDefaultDomains(request, { domainToBlock? })`**: Blocks access via default Contentstack Launch domains (e.g., `contentstackapps.com`).
-- **`ipAccessControl(request, { allow?, deny? })`**: Simple IP-based firewall.
+- **`blockAICrawlers(request, bots?)`**: Detects and blocks known AI crawlers (GPTBot, ClaudeBot, etc.) based on the User-Agent.
+- **`blockDefaultDomains(request, { domainToBlock? })`**: Prevents users from accessing your site via the default `*.contentstackapps.com` domains, forcing them to use your custom domain.
+- **`ipAccessControl(request, { allow?, deny? })`**: A simple firewall to whitelist or blacklist specific IP addresses at the edge.
 
 ### 🔐 Authentication
 - **`protectWithBasicAuth(request, options)`**: Prompt for credentials based on hostname.
@@ -123,3 +130,9 @@ export default async function handler(request, context) {
 ## 🌐 Platform Support
 
 This library is exclusively optimized for **[Contentstack Launch](https://www.contentstack.com/docs/developers/launch)**.
+
+---
+
+## 📄 License
+
+Distributed under the MIT License. See `LICENSE` for more information.