@vercel/config 0.0.16 → 0.0.17

package/README.md

@@ -13,7 +13,8 @@ npm install @vercel/config
 Create a `vercel.ts` file in your project root:
 
 ```typescript
-import { createRouter, VercelConfig } from '@vercel/config/v1';
+import { createRouter } from '@vercel/config';
+import type { VercelConfig } from '@vercel/config';
 
 const router = createRouter();
 
@@ -21,15 +22,11 @@ export const config: VercelConfig = {
   buildCommand: 'npm run build',
   framework: 'nextjs',
   
-  routes: [
-    // Headers
-    router.cacheControl('/static/(.*)', {
-      public: true,
-      maxAge: '1 week',
-      immutable: true
-    }),
+  rewrites: [
+    // Simple rewrite
+    router.rewrite('/api/(.*)', 'https://backend.api.example.com/$1'),
     
-    // Rewrites with transforms
+    // Rewrite with transforms
     router.rewrite('/users/:userId', 'https://api.example.com/users/$1', 
       ({ userId, env }) => ({
         requestHeaders: {
@@ -37,12 +34,21 @@ export const config: VercelConfig = {
           'authorization': `Bearer ${env.API_TOKEN}`
         }
       })
-    ),
-    
-    // Simple redirects
+    )
+  ],
+  
+  redirects: [
     router.redirect('/old-docs', '/docs', { permanent: true })
   ],
 
+  headers: [
+    router.cacheControl('/static/(.*)', {
+      public: true,
+      maxAge: '1 week',
+      immutable: true
+    })
+  ],
+
   crons: [
     { path: '/api/cleanup', schedule: '0 0 * * *' }
   ]
@@ -53,7 +59,6 @@ export const config: VercelConfig = {
 
 - **Type-safe configuration** - Full TypeScript support with IDE autocomplete
 - **Readable syntax** - Helper methods like `router.redirect()`, `router.rewrite()`, `router.header()`
-- **Static validation** - Catch configuration errors at development time
 - **Transforms** - Modify request/response headers and query parameters on the fly
 - **Conditions** - Advanced routing with `has` and `missing` conditions
 - **CLI tools** - `compile` and `validate` commands for development
@@ -84,39 +89,11 @@ npx @vercel/config validate
 npx @vercel/config generate
 ```
 
-## Validation
-
-Static fields are validated to ensure they only contain literal values (strings, booleans, objects with primitives):
-
-```typescript
-// ✅ Valid - static string
-export const buildCommand = 'npm run build';
-
-// ❌ Invalid - computed value
-export const buildCommand = process.env.BUILD_CMD;
-
-// ✅ Valid - static object
-export const git = {
-  deploymentEnabled: {
-    'main': true,
-    'dev': false
-  }
-};
-```
-
-Static fields that are validated:
-- `buildCommand`, `devCommand`, `installCommand`
-- `framework`, `nodeVersion`, `outputDirectory`
-- `github.enabled`, `github.autoAlias`, `github.autoJobCancelation`
-- `git.deploymentEnabled`
-- `relatedProjects`
-
 ## Important Notes
 
-- **One config file only**: You cannot have both `vercel.ts` and `vercel.json`. The build will fail if both exist.
-
-
-- **Versioned API**: Use `@vercel/config/v1` for imports to enable future versioning.
+- **One config file only**: You cannot have both `vercel.ts` and `vercel.json`.
+- **Transforms compile to routes**: When you add transforms to rewrites/redirects (like `requestHeaders`), they're compiled to the lower-level `routes` primitive internally.
+- **Automatic compilation**: The Vercel CLI compiles `vercel.ts` automatically.
 
 ## Learn More
 

package/dist/types.d.ts

@@ -206,3 +206,7 @@ export interface VercelConfig {
      */
     nodeVersion?: string;
 }
+/**
+ * Runtime placeholder for VercelConfig to allow named imports.
+ */
+export declare const VercelConfig: {};

package/dist/types.js

@@ -4,3 +4,8 @@
  * https://openapi.vercel.sh/vercel.json
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.VercelConfig = void 0;
+/**
+ * Runtime placeholder for VercelConfig to allow named imports.
+ */
+exports.VercelConfig = {};

package/dist/v1/index.d.ts

@@ -1,9 +1,5 @@
-/**
- * @vercel/config/v1 - Main API entry point
- *
- * Usage:
- *   import { createRouter, VercelConfig } from '@vercel/config/v1';
- */
 export { createRouter, Router } from "../router";
 export * from "../router";
-export type { VercelConfig, Redirect, Rewrite, HeaderRule, Condition, RouteType } from "../types";
+export { VercelConfig } from "../types";
+export type { Redirect, Rewrite, HeaderRule, Condition, RouteType } from "../types";
+export { validateStaticString, validateStaticBoolean, validateStaticObject, validateStaticStringArray, validateStaticFields } from "../utils/validation";

package/dist/v1/index.js

@@ -1,10 +1,4 @@
 "use strict";
-/**
- * @vercel/config/v1 - Main API entry point
- *
- * Usage:
- *   import { createRouter, VercelConfig } from '@vercel/config/v1';
- */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -20,8 +14,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Router = exports.createRouter = void 0;
+exports.validateStaticFields = exports.validateStaticStringArray = exports.validateStaticObject = exports.validateStaticBoolean = exports.validateStaticString = exports.VercelConfig = exports.Router = exports.createRouter = void 0;
 var router_1 = require("../router");
 Object.defineProperty(exports, "createRouter", { enumerable: true, get: function () { return router_1.createRouter; } });
 Object.defineProperty(exports, "Router", { enumerable: true, get: function () { return router_1.Router; } });
 __exportStar(require("../router"), exports);
+var types_1 = require("../types");
+Object.defineProperty(exports, "VercelConfig", { enumerable: true, get: function () { return types_1.VercelConfig; } });
+var validation_1 = require("../utils/validation");
+Object.defineProperty(exports, "validateStaticString", { enumerable: true, get: function () { return validation_1.validateStaticString; } });
+Object.defineProperty(exports, "validateStaticBoolean", { enumerable: true, get: function () { return validation_1.validateStaticBoolean; } });
+Object.defineProperty(exports, "validateStaticObject", { enumerable: true, get: function () { return validation_1.validateStaticObject; } });
+Object.defineProperty(exports, "validateStaticStringArray", { enumerable: true, get: function () { return validation_1.validateStaticStringArray; } });
+Object.defineProperty(exports, "validateStaticFields", { enumerable: true, get: function () { return validation_1.validateStaticFields; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/config",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "description": "A TypeScript SDK for programmatically generating Vercel configuration files",
   "bugs": {
     "url": "https://github.com/vercel/router-sdk/issues"
@@ -11,22 +11,18 @@
   },
   "author": "Vercel",
   "license": "MIT",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": "./dist/index.js",
-    "./v1": "./dist/v1/index.js"
-  },
+  "main": "dist/v1/index.js",
+  "types": "dist/v1/index.d.ts",
   "typesVersions": {
     "*": {
-      ".": [
-        "dist/index.d.ts"
-      ],
       "v1": [
         "dist/v1/index.d.ts"
       ]
     }
   },
+  "exports": {
+    "./v1": "./dist/v1/index.js"
+  },
   "bin": {
     "@vercel/config": "./dist/cli.js"
   },

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-export { createRouter, Router } from "./router";
-export * from "./router";
-export type { VercelConfig, Redirect, Rewrite, HeaderRule, Condition, RouteType } from "./types";
-export { validateStaticString, validateStaticBoolean, validateStaticObject, validateStaticStringArray, validateStaticFields } from "./utils/validation";

package/dist/index.js

@@ -1,27 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateStaticFields = exports.validateStaticStringArray = exports.validateStaticObject = exports.validateStaticBoolean = exports.validateStaticString = exports.Router = exports.createRouter = void 0;
-var router_1 = require("./router");
-Object.defineProperty(exports, "createRouter", { enumerable: true, get: function () { return router_1.createRouter; } });
-Object.defineProperty(exports, "Router", { enumerable: true, get: function () { return router_1.Router; } });
-__exportStar(require("./router"), exports);
-var validation_1 = require("./utils/validation");
-Object.defineProperty(exports, "validateStaticString", { enumerable: true, get: function () { return validation_1.validateStaticString; } });
-Object.defineProperty(exports, "validateStaticBoolean", { enumerable: true, get: function () { return validation_1.validateStaticBoolean; } });
-Object.defineProperty(exports, "validateStaticObject", { enumerable: true, get: function () { return validation_1.validateStaticObject; } });
-Object.defineProperty(exports, "validateStaticStringArray", { enumerable: true, get: function () { return validation_1.validateStaticStringArray; } });
-Object.defineProperty(exports, "validateStaticFields", { enumerable: true, get: function () { return validation_1.validateStaticFields; } });