@aryanbansal-launch/edge-utils 0.1.8 β 0.1.10
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/bin/launch-init.js +1 -1
- package/package.json +2 -2
- package/readme.md +75 -75
package/bin/launch-init.js
CHANGED
|
@@ -85,7 +85,7 @@ export default async function handler(request, context) {
|
|
|
85
85
|
`.trim();
|
|
86
86
|
|
|
87
87
|
async function init() {
|
|
88
|
-
console.log(`\n${colors.bright}${colors.cyan}π
|
|
88
|
+
console.log(`\n${colors.bright}${colors.cyan}π create-launch-edge: Contentstack Launch Initializer${colors.reset}\n`);
|
|
89
89
|
|
|
90
90
|
let actionsTaken = 0;
|
|
91
91
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aryanbansal-launch/edge-utils",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.10",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"repository": {
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
},
|
|
14
14
|
"main": "dist/index.js",
|
|
15
15
|
"bin": {
|
|
16
|
-
"launch-
|
|
16
|
+
"create-launch-edge": "./bin/launch-init.js",
|
|
17
17
|
"launch-config": "./bin/launch-config.js"
|
|
18
18
|
},
|
|
19
19
|
"exports": {
|
package/readme.md
CHANGED
|
@@ -3,133 +3,133 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/@aryanbansal-launch/edge-utils)
|
|
4
4
|
[](https://opensource.org/licenses/MIT)
|
|
5
5
|
|
|
6
|
-
A
|
|
7
|
-
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
## β¨ Features
|
|
11
|
-
|
|
12
|
-
- π‘οΈ **Security First**: Block AI crawlers and manage IP access with ease.
|
|
13
|
-
- π **Edge Auth**: Implement Basic Auth directly at the edge for specific hostnames.
|
|
14
|
-
- π **Geo-Aware**: Easily extract location data from request headers.
|
|
15
|
-
- βοΈ **Next.js Ready**: Built-in fixes for RSC header issues on Launch proxies.
|
|
16
|
-
- π **Cache Priming**: Easily manage cache warming URLs via CLI.
|
|
17
|
-
- π **Smart Routing**: Declarative redirects based on path and method.
|
|
18
|
-
- β‘ **Zero Dependencies**: Lightweight and optimized for edge runtime limits.
|
|
6
|
+
A comprehensive toolkit for [Contentstack Launch](https://www.contentstack.com/docs/developers/launch) (the high-performance frontend hosting service by [Contentstack](https://www.contentstack.com/)). This library provides production-ready utilities to simplify [Edge Functions](https://www.contentstack.com/docs/developers/launch/edge-functions) development, security, and performance optimization.
|
|
19
7
|
|
|
20
8
|
---
|
|
21
9
|
|
|
22
10
|
## β‘ Quick Start (Recommended)
|
|
23
11
|
|
|
24
|
-
|
|
12
|
+
Bootstrap your edge environment in seconds using our automated initializer. Run this command from your **project root**:
|
|
25
13
|
|
|
26
|
-
### 1. Install
|
|
27
14
|
```bash
|
|
15
|
+
# Install the package
|
|
28
16
|
npm install @aryanbansal-launch/edge-utils
|
|
29
|
-
```
|
|
30
17
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
npx launch-init
|
|
18
|
+
# Initialize Edge Functions
|
|
19
|
+
npx create-launch-edge
|
|
35
20
|
```
|
|
36
|
-
This will automatically create the `functions/` directory and a boilerplate `[proxy].edge.js` handler for you.
|
|
37
21
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
22
|
+
This command will automatically create the `functions/` directory and a production-ready `[proxy].edge.js` boilerplate handler.
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## β¨ Features & Deep Dive
|
|
27
|
+
|
|
28
|
+
### π‘οΈ Security & Access Control
|
|
29
|
+
- **[Block AI Crawlers](https://www.contentstack.com/docs/developers/launch/blocking-ai-crawlers)**: Automatically detects and rejects requests from known scrapers (GPTBot, ClaudeBot, etc.) to protect your content and server resources.
|
|
30
|
+
- **[Restricted Default Domains](https://www.contentstack.com/docs/developers/launch/blocking-default-launch-domains-from-google-search)**: By default, Launch provides a `*.contentstackapps.com` domain. This utility forces visitors to your custom domain, which is essential for SEO (preventing duplicate content) and professional branding.
|
|
31
|
+
- **[IP Access Control](https://www.contentstack.com/docs/developers/launch/ip-based-access-control-using-edge-functions)**: Create a lightweight firewall at the edge to whitelist internal teams or block malicious IPs before they hit your application logic.
|
|
32
|
+
- **[Edge Auth](https://www.contentstack.com/docs/developers/launch/password-protection-for-environments)**: Implement [Basic Authentication](https://www.contentstack.com/docs/developers/launch/password-protection-for-environments) directly at the edge to protect staging environments or specific paths. (Note: Hashing is recommended for production environments).
|
|
33
|
+
|
|
34
|
+
### βοΈ Next.js Optimization
|
|
35
|
+
- **[RSC Header Fix](https://www.contentstack.com/docs/developers/launch/handling-nextjs-rsc-issues-on-launch)**: Next.js React Server Components (RSC) use a special `rsc` header. Sometimes, proxies or caches can incorrectly serve RSC data when a full page load is expected. This utility detects these edge cases and strips the header to ensure the correct response type is served.
|
|
36
|
+
|
|
37
|
+
### π Performance & Geo-Awareness
|
|
38
|
+
- **[Geo-Location Access](https://www.contentstack.com/docs/developers/launch/geolocation-headers-in-launch)**: Contentstack Launch injects geography data into request headers. This utility parses those headers into a clean object (`country`, `city`, `region`, etc.), enabling you to personalize content or restrict features based on user location.
|
|
39
|
+
- **[Cache Priming](https://www.contentstack.com/docs/developers/launch/cache-priming)**: Use the `launch-config` CLI to pre-load critical URLs into the edge cache, eliminating "cold start" latency for your first visitors after a deployment.
|
|
40
|
+
|
|
41
|
+
### π Smart Routing
|
|
42
|
+
- **Declarative Redirects**: Handle complex, logic-based redirects at runtime.
|
|
43
|
+
- **Runtime vs Config**:
|
|
44
|
+
- Use **`launch.json`** ([Static Redirects](https://www.contentstack.com/docs/developers/launch/edge-url-redirects)) for high-performance, simple path-to-path mapping.
|
|
45
|
+
- Use **`redirectIfMatch`** (this library) for dynamic redirects that require logic, such as checking cookies, headers, or geo-location before redirecting.
|
|
43
46
|
|
|
44
47
|
---
|
|
45
48
|
|
|
46
|
-
## π οΈ Usage Example
|
|
49
|
+
## π οΈ Detailed Usage Example
|
|
47
50
|
|
|
48
|
-
|
|
51
|
+
Your `functions/[proxy].edge.js` acts as a **middleware chain**. You can layer these utilities to create complex edge logic:
|
|
49
52
|
|
|
50
53
|
```javascript
|
|
51
54
|
import {
|
|
52
|
-
jsonResponse,
|
|
53
|
-
passThrough,
|
|
54
|
-
redirectIfMatch,
|
|
55
|
-
protectWithBasicAuth,
|
|
56
|
-
ipAccessControl,
|
|
57
|
-
blockAICrawlers,
|
|
58
55
|
blockDefaultDomains,
|
|
56
|
+
handleNextJS_RSC,
|
|
57
|
+
blockAICrawlers,
|
|
58
|
+
ipAccessControl,
|
|
59
|
+
protectWithBasicAuth,
|
|
60
|
+
redirectIfMatch,
|
|
59
61
|
getGeoHeaders,
|
|
60
|
-
|
|
62
|
+
passThrough
|
|
61
63
|
} from "@aryanbansal-launch/edge-utils";
|
|
62
64
|
|
|
63
65
|
export default async function handler(request, context) {
|
|
64
|
-
// 1. π‘οΈ
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
66
|
+
// 1. π‘οΈ Force Custom Domain (SEO Best Practice)
|
|
67
|
+
// Blocks access via *.contentstackapps.com
|
|
68
|
+
const domainCheck = blockDefaultDomains(request);
|
|
69
|
+
if (domainCheck) return domainCheck;
|
|
70
|
+
|
|
71
|
+
// 2. βοΈ Fix Next.js RSC Header issues
|
|
72
|
+
// Prevents "JSON-only" responses on page refreshes
|
|
73
|
+
const rscCheck = await handleNextJS_RSC(request, {
|
|
70
74
|
affectedPaths: ["/shop", "/about"]
|
|
71
75
|
});
|
|
72
|
-
if (
|
|
76
|
+
if (rscCheck) return rscCheck;
|
|
73
77
|
|
|
74
|
-
// 3. π€ Block
|
|
75
|
-
const
|
|
76
|
-
if (
|
|
78
|
+
// 3. π€ Block Aggressive Bots
|
|
79
|
+
const botCheck = blockAICrawlers(request);
|
|
80
|
+
if (botCheck) return botCheck;
|
|
77
81
|
|
|
78
|
-
// 4. π§±
|
|
79
|
-
const
|
|
80
|
-
if (
|
|
82
|
+
// 4. 𧱠Firewall
|
|
83
|
+
const ipCheck = ipAccessControl(request, { allow: ["203.0.113.10"] });
|
|
84
|
+
if (ipCheck) return ipCheck;
|
|
81
85
|
|
|
82
|
-
// 5. π
|
|
83
|
-
const
|
|
86
|
+
// 5. π Password Protection
|
|
87
|
+
const auth = await protectWithBasicAuth(request, {
|
|
84
88
|
hostnameIncludes: "staging.myapp.com",
|
|
85
89
|
username: "admin",
|
|
86
90
|
password: "securepassword123"
|
|
87
91
|
});
|
|
88
|
-
if (
|
|
92
|
+
if (auth && auth.status === 401) return auth;
|
|
89
93
|
|
|
90
|
-
// 6. π
|
|
91
|
-
const
|
|
92
|
-
path: "/legacy-
|
|
93
|
-
to: "/
|
|
94
|
+
// 6. π Logic-Based Redirects
|
|
95
|
+
const redirect = redirectIfMatch(request, {
|
|
96
|
+
path: "/legacy-page",
|
|
97
|
+
to: "/new-page",
|
|
94
98
|
status: 301
|
|
95
99
|
});
|
|
96
|
-
if (
|
|
100
|
+
if (redirect) return redirect;
|
|
97
101
|
|
|
98
|
-
// 7. π
|
|
102
|
+
// 7. π Personalization
|
|
99
103
|
const geo = getGeoHeaders(request);
|
|
100
|
-
|
|
104
|
+
if (geo.country === "UK") {
|
|
105
|
+
// Custom logic for UK visitors...
|
|
106
|
+
}
|
|
101
107
|
|
|
102
|
-
// 8. π Pass through to
|
|
108
|
+
// 8. π Pass through to Origin
|
|
103
109
|
return passThrough(request);
|
|
104
110
|
}
|
|
105
111
|
```
|
|
106
112
|
|
|
107
113
|
---
|
|
108
114
|
|
|
109
|
-
##
|
|
110
|
-
|
|
111
|
-
### π‘οΈ Security
|
|
112
|
-
- **`blockAICrawlers(request, bots?)`**: Detects and blocks known AI crawlers (GPTBot, ClaudeBot, etc.) based on the User-Agent.
|
|
113
|
-
- **`blockDefaultDomains(request, { domainToBlock? })`**: Prevents users from accessing your site via the default `*.contentstackapps.com` domains, forcing them to use your custom domain.
|
|
114
|
-
- **`ipAccessControl(request, { allow?, deny? })`**: A simple firewall to whitelist or blacklist specific IP addresses at the edge.
|
|
115
|
-
|
|
116
|
-
### π Authentication
|
|
117
|
-
- **`protectWithBasicAuth(request, options)`**: Prompt for credentials based on hostname.
|
|
115
|
+
## βοΈ Configuration CLI
|
|
118
116
|
|
|
119
|
-
|
|
120
|
-
- **`redirectIfMatch(request, options)`**: Perform SEO-friendly redirects at the edge.
|
|
117
|
+
Manage your `launch.json` file interactively to handle bulk settings:
|
|
121
118
|
|
|
122
|
-
|
|
123
|
-
-
|
|
119
|
+
```bash
|
|
120
|
+
npx launch-config
|
|
121
|
+
```
|
|
124
122
|
|
|
125
|
-
###
|
|
126
|
-
-
|
|
123
|
+
### Supported Settings:
|
|
124
|
+
- **Bulk Redirects**: Add multiple sources and destinations easily.
|
|
125
|
+
- **Rewrites**: Map internal paths to external APIs or micro-services.
|
|
126
|
+
- **Cache Priming**: Add a comma-separated list of URLs to warm up the CDN.
|
|
127
127
|
|
|
128
128
|
---
|
|
129
129
|
|
|
130
130
|
## π Platform Support
|
|
131
131
|
|
|
132
|
-
This library is exclusively optimized for **[Contentstack Launch](https://www.contentstack.com/docs/developers/launch)**.
|
|
132
|
+
This library is exclusively optimized for **[Contentstack Launch](https://www.contentstack.com/docs/developers/launch)**. It assumes an environment where `Request`, `Response`, and standard Edge Global APIs are available.
|
|
133
133
|
|
|
134
134
|
---
|
|
135
135
|
|