@vercel/config 0.0.13 → 0.0.16

package/dist/types.d.ts

@@ -0,0 +1,208 @@
+/**
+ * Vercel configuration type that mirrors the vercel.json schema
+ * https://openapi.vercel.sh/vercel.json
+ */
+export type Framework = 'blitzjs' | 'nextjs' | 'gatsby' | 'remix' | 'react-router' | 'astro' | 'hexo' | 'eleventy' | 'docusaurus-2' | 'docusaurus' | 'preact' | 'solidstart-1' | 'solidstart' | 'dojo' | 'ember' | 'vue' | 'scully' | 'ionic-angular' | 'angular' | 'polymer' | 'svelte' | 'sveltekit' | 'sveltekit-1' | 'ionic-react' | 'create-react-app' | 'gridsome' | 'umijs' | 'sapper' | 'saber' | 'stencil' | 'nuxtjs' | 'redwoodjs' | 'hugo' | 'jekyll' | 'brunch' | 'middleman' | 'zola' | 'hydrogen' | 'vite' | 'tanstack-start' | 'vitepress' | 'vuepress' | 'parcel' | 'fastapi' | 'flask' | 'fasthtml' | 'sanity-v3' | 'sanity' | 'storybook' | 'nitro' | 'hono' | 'express' | 'h3' | 'nestjs' | 'elysia' | 'fastify' | 'xmcp' | null;
+export interface CronJob {
+    schedule: string;
+    path: string;
+}
+export interface FunctionConfig {
+    excludeFiles?: string;
+    includeFiles?: string;
+    maxDuration?: number;
+    memory?: number;
+    runtime?: string;
+    supportsCancellation?: boolean;
+    experimentalTriggers?: Array<{
+        type: 'queue/v1beta';
+        topic: string;
+        consumer: string;
+        maxDeliveries?: number;
+        retryAfterSeconds?: number;
+        initialDelaySeconds?: number;
+    }>;
+}
+export interface GitDeploymentConfig {
+    [branch: string]: boolean;
+}
+export interface GitConfig {
+    deploymentEnabled?: boolean | GitDeploymentConfig;
+}
+export interface GithubConfig {
+    enabled?: boolean;
+    autoAlias?: boolean;
+    autoJobCancelation?: boolean;
+}
+/**
+ * HTTP header key/value pair
+ */
+export interface Header {
+    key: string;
+    value: string;
+}
+/**
+ * Condition for matching in redirects, rewrites, and headers
+ */
+export interface Condition {
+    type: 'header' | 'cookie' | 'host' | 'query' | 'path';
+    key?: string;
+    value?: string | number;
+    inc?: string[];
+    pre?: string;
+    eq?: string | number;
+    neq?: string;
+    gt?: number;
+    gte?: number;
+    lt?: number;
+    lte?: number;
+}
+/**
+ * Redirect matching vercel.json schema
+ * Returned by router.redirect()
+ */
+export interface Redirect {
+    source: string;
+    destination: string;
+    permanent?: boolean;
+    statusCode?: number;
+    has?: Condition[];
+    missing?: Condition[];
+}
+/**
+ * Rewrite matching vercel.json schema
+ * Returned by router.rewrite()
+ */
+export interface Rewrite {
+    source: string;
+    destination: string;
+    has?: Condition[];
+    missing?: Condition[];
+}
+/**
+ * Header rule matching vercel.json schema
+ * Returned by router.header() and router.cacheControl()
+ */
+export interface HeaderRule {
+    source: string;
+    headers: Header[];
+    has?: Condition[];
+    missing?: Condition[];
+}
+/**
+ * Union type for all router helper outputs
+ * Can be simple schema objects (Redirect, Rewrite, HeaderRule) or Routes with transforms
+ * Note: Route type is defined in router.ts (uses src/dest instead of source/destination)
+ */
+export type RouteType = Redirect | Rewrite | HeaderRule | any;
+export interface WildcardDomain {
+    domain: string;
+    value: string;
+}
+export interface VercelConfig {
+    /**
+     * Aliases that will get assigned when the deployment is `READY` and the target is `production`.
+     */
+    alias?: string | string[];
+    /**
+     * When set to `true`, all HTML files and Serverless Functions will have their extension removed.
+     */
+    cleanUrls?: boolean;
+    /**
+     * An array of cron jobs that should be created for production Deployments.
+     */
+    crons?: CronJob[];
+    /**
+     * An object containing the deployment's environment variables.
+     */
+    env?: Record<string, string>;
+    /**
+     * An array of the passive regions the deployment's Serverless Functions should be deployed to.
+     */
+    passiveRegions?: string[];
+    /**
+     * Same as passiveRegions. An array of passive regions for failover.
+     */
+    functionFailoverRegions?: string[];
+    /**
+     * An object describing custom options for Serverless Functions.
+     */
+    functions?: Record<string, FunctionConfig>;
+    /**
+     * Git-related configuration.
+     */
+    git?: GitConfig;
+    /**
+     * GitHub-related configuration.
+     */
+    github?: GithubConfig;
+    /**
+     * HTTP headers configuration.
+     * Can use router.header() and router.cacheControl() helpers.
+     */
+    headers?: RouteType[];
+    /**
+     * HTTP redirects configuration.
+     * Can use router.redirect() helper.
+     */
+    redirects?: RouteType[];
+    /**
+     * HTTP rewrites configuration.
+     * Can use router.rewrite() helper.
+     */
+    rewrites?: RouteType[];
+    /**
+     * Routes configuration using the lower-level routes primitive.
+     * Use this if you need transforms or want everything in one place.
+     * Cannot be mixed with headers, redirects, or rewrites.
+     */
+    routes?: RouteType[];
+    /**
+     * Wildcard domain configuration.
+     */
+    wildcard?: WildcardDomain[];
+    /**
+     * The build command for this project. When `null`, automatically detected.
+     */
+    buildCommand?: string | null;
+    /**
+     * The ignore command for this project.
+     */
+    ignoreCommand?: string | null;
+    /**
+     * The dev command for this project. When `null`, automatically detected.
+     */
+    devCommand?: string | null;
+    /**
+     * The framework being used. When `null`, no framework is selected.
+     */
+    framework?: Framework;
+    /**
+     * The install command for this project. When `null`, automatically detected.
+     */
+    installCommand?: string | null;
+    /**
+     * The output directory of the project. When `null`, automatically detected.
+     */
+    outputDirectory?: string | null;
+    /**
+     * When `false`, visiting a path that ends with a forward slash will redirect to the path without the trailing slash.
+     */
+    trailingSlash?: boolean;
+    /**
+     * An array of projectIds to associate with the current project.
+     */
+    relatedProjects?: string[];
+    /**
+     * Enables Fluid compute for the project.
+     */
+    fluid?: boolean;
+    /**
+     * Enables Bun for the project and specifies the version to use.
+     */
+    bunVersion?: string;
+    /**
+     * Node.js version for this project.
+     */
+    nodeVersion?: string;
+}

package/dist/types.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Vercel configuration type that mirrors the vercel.json schema
+ * https://openapi.vercel.sh/vercel.json
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/validation.d.ts

@@ -41,3 +41,30 @@ export declare function countCaptureGroups(pattern: string): number;
  * that don't exist in the source pattern.
  */
 export declare function validateCaptureGroupReferences(source: string, destination: string): void;
+/**
+ * Validates that a value is a static string literal (not computed, not a function call, etc.)
+ * Used for static fields that must be extracted before build execution.
+ */
+export declare function validateStaticString(value: any, fieldName: string): void;
+/**
+ * Validates that a value is a static boolean literal
+ */
+export declare function validateStaticBoolean(value: any, fieldName: string): void;
+/**
+ * Validates that a value is a static object with primitive values
+ * Used for git.deploymentEnabled and similar objects that need to be static
+ */
+export declare function validateStaticObject(value: any, fieldName: string): void;
+/**
+ * Validates that a value is a static array of strings
+ */
+export declare function validateStaticStringArray(value: any, fieldName: string): void;
+/**
+ * Validates static fields in VercelConfig that must be extracted before build execution.
+ * These fields include:
+ * - buildCommand, devCommand, installCommand, framework, nodeVersion, outputDirectory
+ * - github.enabled, github.autoAlias, github.autoJobCancelation
+ * - git.deploymentEnabled
+ * - relatedProjects
+ */
+export declare function validateStaticFields(config: Record<string, any>): void;

package/dist/utils/validation.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateCaptureGroupReferences = exports.countCaptureGroups = exports.createCronExpression = exports.parseCronExpression = exports.validateRegexPattern = void 0;
+exports.validateStaticFields = exports.validateStaticStringArray = exports.validateStaticObject = exports.validateStaticBoolean = exports.validateStaticString = exports.validateCaptureGroupReferences = exports.countCaptureGroups = exports.createCronExpression = exports.parseCronExpression = exports.validateRegexPattern = void 0;
 const zod_1 = require("zod");
 /**
  * Validates and type-checks regex patterns for Vercel's path-to-regexp syntax.
@@ -122,3 +122,98 @@ function validateCaptureGroupReferences(source, destination) {
     }
 }
 exports.validateCaptureGroupReferences = validateCaptureGroupReferences;
+/**
+ * Validates that a value is a static string literal (not computed, not a function call, etc.)
+ * Used for static fields that must be extracted before build execution.
+ */
+function validateStaticString(value, fieldName) {
+    if (typeof value !== 'string') {
+        throw new Error(`Field "${fieldName}" must be a static string literal. ` +
+            `Got ${typeof value}. Function calls, variables, and expressions are not allowed.`);
+    }
+}
+exports.validateStaticString = validateStaticString;
+/**
+ * Validates that a value is a static boolean literal
+ */
+function validateStaticBoolean(value, fieldName) {
+    if (typeof value !== 'boolean') {
+        throw new Error(`Field "${fieldName}" must be a static boolean literal. ` +
+            `Got ${typeof value}. Only true or false are allowed.`);
+    }
+}
+exports.validateStaticBoolean = validateStaticBoolean;
+/**
+ * Validates that a value is a static object with primitive values
+ * Used for git.deploymentEnabled and similar objects that need to be static
+ */
+function validateStaticObject(value, fieldName) {
+    if (typeof value !== 'object' || value === null) {
+        throw new Error(`Field "${fieldName}" must be a static object with primitive values. ` +
+            `Got ${typeof value}.`);
+    }
+    for (const [key, val] of Object.entries(value)) {
+        if (typeof val !== 'boolean' && typeof val !== 'string' && typeof val !== 'number') {
+            throw new Error(`Field "${fieldName}.${key}" must contain only static primitive values (string, number, boolean). ` +
+                `Got ${typeof val}.`);
+        }
+    }
+}
+exports.validateStaticObject = validateStaticObject;
+/**
+ * Validates that a value is a static array of strings
+ */
+function validateStaticStringArray(value, fieldName) {
+    if (!Array.isArray(value)) {
+        throw new Error(`Field "${fieldName}" must be a static array of strings. ` +
+            `Got ${typeof value}.`);
+    }
+    for (let i = 0; i < value.length; i++) {
+        if (typeof value[i] !== 'string') {
+            throw new Error(`Field "${fieldName}[${i}]" must be a static string. ` +
+                `Got ${typeof value[i]}.`);
+        }
+    }
+}
+exports.validateStaticStringArray = validateStaticStringArray;
+/**
+ * Validates static fields in VercelConfig that must be extracted before build execution.
+ * These fields include:
+ * - buildCommand, devCommand, installCommand, framework, nodeVersion, outputDirectory
+ * - github.enabled, github.autoAlias, github.autoJobCancelation
+ * - git.deploymentEnabled
+ * - relatedProjects
+ */
+function validateStaticFields(config) {
+    // Validate string fields
+    const stringFields = ['buildCommand', 'devCommand', 'installCommand', 'framework', 'nodeVersion', 'outputDirectory'];
+    for (const field of stringFields) {
+        if (config[field] !== undefined && config[field] !== null) {
+            validateStaticString(config[field], field);
+        }
+    }
+    // Validate relatedProjects (array of strings)
+    if (config.relatedProjects !== undefined) {
+        validateStaticStringArray(config.relatedProjects, 'relatedProjects');
+    }
+    // Validate git.deploymentEnabled (boolean or object with branch booleans)
+    if (config.git !== undefined && config.git.deploymentEnabled !== undefined) {
+        const deploymentEnabled = config.git.deploymentEnabled;
+        if (typeof deploymentEnabled === 'boolean') {
+            validateStaticBoolean(deploymentEnabled, 'git.deploymentEnabled');
+        }
+        else {
+            validateStaticObject(deploymentEnabled, 'git.deploymentEnabled');
+        }
+    }
+    // Validate github fields (booleans)
+    const githubBooleanFields = ['enabled', 'autoAlias', 'autoJobCancelation'];
+    if (config.github !== undefined) {
+        for (const field of githubBooleanFields) {
+            if (config.github[field] !== undefined) {
+                validateStaticBoolean(config.github[field], `github.${field}`);
+            }
+        }
+    }
+}
+exports.validateStaticFields = validateStaticFields;

package/dist/v1/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @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";

package/dist/v1/index.js

@@ -0,0 +1,27 @@
+"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);
+    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.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);

package/package.json

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