@vercel/functions 1.1.0 → 1.3.0

package/dist/get-env.d.ts

@@ -0,0 +1,133 @@
+export declare const getEnv: (env?: {
+    [key: string]: string | undefined;
+}) => {
+    /**
+     * An indicator to show that System Environment Variables have been exposed to your project's Deployments.
+     * @example "1"
+     */
+    VERCEL: string | undefined;
+    /**
+     * An indicator that the code is running in a Continuous Integration environment.
+     * @example "1"
+     */
+    CI: string | undefined;
+    /**
+     * The Environment that the app is deployed and running on.
+     * @example "production"
+     */
+    VERCEL_ENV: string | undefined;
+    /**
+     * The domain name of the generated deployment URL. The value does not include the protocol scheme https://.
+     * NOTE: This Variable cannot be used in conjunction with Standard Deployment Protection.
+     * @example "*.vercel.app"
+     */
+    VERCEL_URL: string | undefined;
+    /**
+     * The domain name of the generated Git branch URL. The value does not include the protocol scheme https://.
+     * @example "*-git-*.vercel.app"
+     */
+    VERCEL_BRANCH_URL: string | undefined;
+    /**
+     * A production domain name of the project. This is useful to reliably generate links that point to production such as OG-image URLs.
+     * The value does not include the protocol scheme https://.
+     * @example "myproject.vercel.app"
+     */
+    VERCEL_PROJECT_PRODUCTION_URL: string | undefined;
+    /**
+     * The ID of the Region where the app is running.
+     *
+     * Possible values:
+     * - arn1 (Stockholm, Sweden)
+     * - bom1 (Mumbai, India)
+     * - cdg1 (Paris, France)
+     * - cle1 (Cleveland, USA)
+     * - cpt1 (Cape Town, South Africa)
+     * - dub1 (Dublin, Ireland)
+     * - fra1 (Frankfurt, Germany)
+     * - gru1 (São Paulo, Brazil)
+     * - hkg1 (Hong Kong)
+     * - hnd1 (Tokyo, Japan)
+     * - iad1 (Washington, D.C., USA)
+     * - icn1 (Seoul, South Korea)
+     * - kix1 (Osaka, Japan)
+     * - lhr1 (London, United Kingdom)
+     * - pdx1 (Portland, USA)
+     * - sfo1 (San Francisco, USA)
+     * - sin1 (Singapore)
+     * - syd1 (Sydney, Australia)
+     * - dev1 (Development Region)
+     *
+     * @example "iad1"
+     */
+    VERCEL_REGION: string | undefined;
+    /**
+     * The unique identifier for the deployment, which can be used to implement Skew Protection.
+     * @example "dpl_7Gw5ZMBpQA8h9GF832KGp7nwbuh3"
+     */
+    VERCEL_DEPLOYMENT_ID: string | undefined;
+    /**
+     * When Skew Protection is enabled in Project Settings, this value is set to 1.
+     * @example "1"
+     */
+    VERCEL_SKEW_PROTECTION_ENABLED: string | undefined;
+    /**
+     * The Protection Bypass for Automation value, if the secret has been generated in the project's Deployment Protection settings.
+     */
+    VERCEL_AUTOMATION_BYPASS_SECRET: string | undefined;
+    /**
+     * The Git Provider the deployment is triggered from.
+     * @example "github"
+     */
+    VERCEL_GIT_PROVIDER: string | undefined;
+    /**
+     * The origin repository the deployment is triggered from.
+     * @example "my-site"
+     */
+    VERCEL_GIT_REPO_SLUG: string | undefined;
+    /**
+     * The account that owns the repository the deployment is triggered from.
+     * @example "acme"
+     */
+    VERCEL_GIT_REPO_OWNER: string | undefined;
+    /**
+     * The ID of the repository the deployment is triggered from.
+     * @example "117716146"
+     */
+    VERCEL_GIT_REPO_ID: string | undefined;
+    /**
+     * The git branch of the commit the deployment was triggered by.
+     * @example "improve-about-page"
+     */
+    VERCEL_GIT_COMMIT_REF: string | undefined;
+    /**
+     * The git SHA of the commit the deployment was triggered by.
+     * @example "fa1eade47b73733d6312d5abfad33ce9e4068081"
+     */
+    VERCEL_GIT_COMMIT_SHA: string | undefined;
+    /**
+     * The message attached to the commit the deployment was triggered by.
+     * @example "Update about page"
+     */
+    VERCEL_GIT_COMMIT_MESSAGE: string | undefined;
+    /**
+     * The username attached to the author of the commit that the project was deployed by.
+     * @example "johndoe"
+     */
+    VERCEL_GIT_COMMIT_AUTHOR_LOGIN: string | undefined;
+    /**
+     * The name attached to the author of the commit that the project was deployed by.
+     * @example "John Doe"
+     */
+    VERCEL_GIT_COMMIT_AUTHOR_NAME: string | undefined;
+    /**
+     * The git SHA of the last successful deployment for the project and branch.
+     * NOTE: This Variable is only exposed when an Ignored Build Step is provided.
+     * @example "fa1eade47b73733d6312d5abfad33ce9e4068080"
+     */
+    VERCEL_GIT_PREVIOUS_SHA: string | undefined;
+    /**
+     * The pull request id the deployment was triggered by. If a deployment is created on a branch before a pull request is made, this value will be an empty string.
+     * @example "23"
+     */
+    VERCEL_GIT_PULL_REQUEST_ID: string | undefined;
+};

package/dist/get-env.js

@@ -0,0 +1,162 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var get_env_exports = {};
+__export(get_env_exports, {
+  getEnv: () => getEnv
+});
+module.exports = __toCommonJS(get_env_exports);
+const getEnv = (env = process.env) => ({
+  /**
+   * An indicator to show that System Environment Variables have been exposed to your project's Deployments.
+   * @example "1"
+   */
+  VERCEL: get(env, "VERCEL"),
+  /**
+   * An indicator that the code is running in a Continuous Integration environment.
+   * @example "1"
+   */
+  CI: get(env, "CI"),
+  /**
+   * The Environment that the app is deployed and running on.
+   * @example "production"
+   */
+  VERCEL_ENV: get(env, "VERCEL_ENV"),
+  /**
+   * The domain name of the generated deployment URL. The value does not include the protocol scheme https://.
+   * NOTE: This Variable cannot be used in conjunction with Standard Deployment Protection.
+   * @example "*.vercel.app"
+   */
+  VERCEL_URL: get(env, "VERCEL_URL"),
+  /**
+   * The domain name of the generated Git branch URL. The value does not include the protocol scheme https://.
+   * @example "*-git-*.vercel.app"
+   */
+  VERCEL_BRANCH_URL: get(env, "VERCEL_BRANCH_URL"),
+  /**
+   * A production domain name of the project. This is useful to reliably generate links that point to production such as OG-image URLs.
+   * The value does not include the protocol scheme https://.
+   * @example "myproject.vercel.app"
+   */
+  VERCEL_PROJECT_PRODUCTION_URL: get(env, "VERCEL_PROJECT_PRODUCTION_URL"),
+  /**
+   * The ID of the Region where the app is running.
+   *
+   * Possible values:
+   * - arn1 (Stockholm, Sweden)
+   * - bom1 (Mumbai, India)
+   * - cdg1 (Paris, France)
+   * - cle1 (Cleveland, USA)
+   * - cpt1 (Cape Town, South Africa)
+   * - dub1 (Dublin, Ireland)
+   * - fra1 (Frankfurt, Germany)
+   * - gru1 (São Paulo, Brazil)
+   * - hkg1 (Hong Kong)
+   * - hnd1 (Tokyo, Japan)
+   * - iad1 (Washington, D.C., USA)
+   * - icn1 (Seoul, South Korea)
+   * - kix1 (Osaka, Japan)
+   * - lhr1 (London, United Kingdom)
+   * - pdx1 (Portland, USA)
+   * - sfo1 (San Francisco, USA)
+   * - sin1 (Singapore)
+   * - syd1 (Sydney, Australia)
+   * - dev1 (Development Region)
+   *
+   * @example "iad1"
+   */
+  VERCEL_REGION: get(env, "VERCEL_REGION"),
+  /**
+   * The unique identifier for the deployment, which can be used to implement Skew Protection.
+   * @example "dpl_7Gw5ZMBpQA8h9GF832KGp7nwbuh3"
+   */
+  VERCEL_DEPLOYMENT_ID: get(env, "VERCEL_DEPLOYMENT_ID"),
+  /**
+   * When Skew Protection is enabled in Project Settings, this value is set to 1.
+   * @example "1"
+   */
+  VERCEL_SKEW_PROTECTION_ENABLED: get(env, "VERCEL_SKEW_PROTECTION_ENABLED"),
+  /**
+   * The Protection Bypass for Automation value, if the secret has been generated in the project's Deployment Protection settings.
+   */
+  VERCEL_AUTOMATION_BYPASS_SECRET: get(env, "VERCEL_AUTOMATION_BYPASS_SECRET"),
+  /**
+   * The Git Provider the deployment is triggered from.
+   * @example "github"
+   */
+  VERCEL_GIT_PROVIDER: get(env, "VERCEL_GIT_PROVIDER"),
+  /**
+   * The origin repository the deployment is triggered from.
+   * @example "my-site"
+   */
+  VERCEL_GIT_REPO_SLUG: get(env, "VERCEL_GIT_REPO_SLUG"),
+  /**
+   * The account that owns the repository the deployment is triggered from.
+   * @example "acme"
+   */
+  VERCEL_GIT_REPO_OWNER: get(env, "VERCEL_GIT_REPO_OWNER"),
+  /**
+   * The ID of the repository the deployment is triggered from.
+   * @example "117716146"
+   */
+  VERCEL_GIT_REPO_ID: get(env, "VERCEL_GIT_REPO_ID"),
+  /**
+   * The git branch of the commit the deployment was triggered by.
+   * @example "improve-about-page"
+   */
+  VERCEL_GIT_COMMIT_REF: get(env, "VERCEL_GIT_COMMIT_REF"),
+  /**
+   * The git SHA of the commit the deployment was triggered by.
+   * @example "fa1eade47b73733d6312d5abfad33ce9e4068081"
+   */
+  VERCEL_GIT_COMMIT_SHA: get(env, "VERCEL_GIT_COMMIT_SHA"),
+  /**
+   * The message attached to the commit the deployment was triggered by.
+   * @example "Update about page"
+   */
+  VERCEL_GIT_COMMIT_MESSAGE: get(env, "VERCEL_GIT_COMMIT_MESSAGE"),
+  /**
+   * The username attached to the author of the commit that the project was deployed by.
+   * @example "johndoe"
+   */
+  VERCEL_GIT_COMMIT_AUTHOR_LOGIN: get(env, "VERCEL_GIT_COMMIT_AUTHOR_LOGIN"),
+  /**
+   * The name attached to the author of the commit that the project was deployed by.
+   * @example "John Doe"
+   */
+  VERCEL_GIT_COMMIT_AUTHOR_NAME: get(env, "VERCEL_GIT_COMMIT_AUTHOR_NAME"),
+  /**
+   * The git SHA of the last successful deployment for the project and branch.
+   * NOTE: This Variable is only exposed when an Ignored Build Step is provided.
+   * @example "fa1eade47b73733d6312d5abfad33ce9e4068080"
+   */
+  VERCEL_GIT_PREVIOUS_SHA: get(env, "VERCEL_GIT_PREVIOUS_SHA"),
+  /**
+   * The pull request id the deployment was triggered by. If a deployment is created on a branch before a pull request is made, this value will be an empty string.
+   * @example "23"
+   */
+  VERCEL_GIT_PULL_REQUEST_ID: get(env, "VERCEL_GIT_PULL_REQUEST_ID")
+});
+const get = (env, key) => {
+  const value = env[key];
+  return value === "" ? void 0 : value;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getEnv
+});

package/dist/headers.d.ts

@@ -0,0 +1,83 @@
+/**
+ * City of the original client IP as calculated by Vercel Proxy.
+ */
+export declare const CITY_HEADER_NAME = "x-vercel-ip-city";
+/**
+ * Country of the original client IP as calculated by Vercel Proxy.
+ */
+export declare const COUNTRY_HEADER_NAME = "x-vercel-ip-country";
+/**
+ * Client IP as calculated by Vercel Proxy.
+ */
+export declare const IP_HEADER_NAME = "x-real-ip";
+/**
+ * Latitude of the original client IP as calculated by Vercel Proxy.
+ */
+export declare const LATITUDE_HEADER_NAME = "x-vercel-ip-latitude";
+/**
+ * Longitude of the original client IP as calculated by Vercel Proxy.
+ */
+export declare const LONGITUDE_HEADER_NAME = "x-vercel-ip-longitude";
+/**
+ * Country region of the original client IP calculated by Vercel Proxy.
+ *
+ * See [docs](https://vercel.com/docs/concepts/edge-network/headers#x-vercel-ip-country-region).
+ */
+export declare const REGION_HEADER_NAME = "x-vercel-ip-country-region";
+/**
+ * The request ID for each request generated by Vercel Proxy.
+ */
+export declare const REQUEST_ID_HEADER_NAME = "x-vercel-id";
+/**
+ * Unicode characters for emoji flags start at this number, and run up to 127469.
+ */
+export declare const EMOJI_FLAG_UNICODE_STARTING_POSITION = 127397;
+/**
+ * We define a new type so this function can be reused with
+ * the global `Request`, `node-fetch` and other types.
+ */
+interface Request {
+    headers: {
+        get(name: string): string | null;
+    };
+}
+/**
+ * The location information of a given request.
+ */
+export interface Geo {
+    /** The city that the request originated from. */
+    city?: string;
+    /** The country that the request originated from. */
+    country?: string;
+    /** The flag emoji for the country the request originated from. */
+    flag?: string;
+    /** The [Vercel Edge Network region](https://vercel.com/docs/concepts/edge-network/regions) that received the request. */
+    region?: string;
+    /** The region part of the ISO 3166-2 code of the client IP.
+     * See [docs](https://vercel.com/docs/concepts/edge-network/headers#x-vercel-ip-country-region).
+     */
+    countryRegion?: string;
+    /** The latitude of the client. */
+    latitude?: string;
+    /** The longitude of the client. */
+    longitude?: string;
+}
+/**
+ * Returns the IP address of the request from the headers.
+ *
+ * @see {@link IP_HEADER_NAME}
+ * @param request The incoming request object which provides the IP
+ */
+export declare function ipAddress(request: Request): string | undefined;
+/**
+ * Returns the location information for the incoming request.
+ *
+ * @see {@link CITY_HEADER_NAME}
+ * @see {@link COUNTRY_HEADER_NAME}
+ * @see {@link REGION_HEADER_NAME}
+ * @see {@link LATITUDE_HEADER_NAME}
+ * @see {@link LONGITUDE_HEADER_NAME}
+ * @param request The incoming request object which provides the geolocation data
+ */
+export declare function geolocation(request: Request): Geo;
+export {};

package/dist/headers.js

@@ -0,0 +1,84 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var headers_exports = {};
+__export(headers_exports, {
+  CITY_HEADER_NAME: () => CITY_HEADER_NAME,
+  COUNTRY_HEADER_NAME: () => COUNTRY_HEADER_NAME,
+  EMOJI_FLAG_UNICODE_STARTING_POSITION: () => EMOJI_FLAG_UNICODE_STARTING_POSITION,
+  IP_HEADER_NAME: () => IP_HEADER_NAME,
+  LATITUDE_HEADER_NAME: () => LATITUDE_HEADER_NAME,
+  LONGITUDE_HEADER_NAME: () => LONGITUDE_HEADER_NAME,
+  REGION_HEADER_NAME: () => REGION_HEADER_NAME,
+  REQUEST_ID_HEADER_NAME: () => REQUEST_ID_HEADER_NAME,
+  geolocation: () => geolocation,
+  ipAddress: () => ipAddress
+});
+module.exports = __toCommonJS(headers_exports);
+const CITY_HEADER_NAME = "x-vercel-ip-city";
+const COUNTRY_HEADER_NAME = "x-vercel-ip-country";
+const IP_HEADER_NAME = "x-real-ip";
+const LATITUDE_HEADER_NAME = "x-vercel-ip-latitude";
+const LONGITUDE_HEADER_NAME = "x-vercel-ip-longitude";
+const REGION_HEADER_NAME = "x-vercel-ip-country-region";
+const REQUEST_ID_HEADER_NAME = "x-vercel-id";
+const EMOJI_FLAG_UNICODE_STARTING_POSITION = 127397;
+function getHeader(request, key) {
+  return request.headers.get(key) ?? void 0;
+}
+function getFlag(countryCode) {
+  const regex = new RegExp("^[A-Z]{2}$").test(countryCode);
+  if (!countryCode || !regex)
+    return void 0;
+  return String.fromCodePoint(
+    ...countryCode.split("").map((char) => EMOJI_FLAG_UNICODE_STARTING_POSITION + char.charCodeAt(0))
+  );
+}
+function ipAddress(request) {
+  return getHeader(request, IP_HEADER_NAME);
+}
+function getRegionFromRequestId(requestId) {
+  if (!requestId) {
+    return "dev1";
+  }
+  return requestId.split(":")[0];
+}
+function geolocation(request) {
+  return {
+    city: getHeader(request, CITY_HEADER_NAME),
+    country: getHeader(request, COUNTRY_HEADER_NAME),
+    flag: getFlag(getHeader(request, COUNTRY_HEADER_NAME)),
+    countryRegion: getHeader(request, REGION_HEADER_NAME),
+    region: getRegionFromRequestId(getHeader(request, REQUEST_ID_HEADER_NAME)),
+    latitude: getHeader(request, LATITUDE_HEADER_NAME),
+    longitude: getHeader(request, LONGITUDE_HEADER_NAME)
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CITY_HEADER_NAME,
+  COUNTRY_HEADER_NAME,
+  EMOJI_FLAG_UNICODE_STARTING_POSITION,
+  IP_HEADER_NAME,
+  LATITUDE_HEADER_NAME,
+  LONGITUDE_HEADER_NAME,
+  REGION_HEADER_NAME,
+  REQUEST_ID_HEADER_NAME,
+  geolocation,
+  ipAddress
+});

package/dist/index.d.ts

@@ -1 +1,3 @@
-export * from './wait-until';
+export { geolocation, ipAddress } from './headers';
+export { getEnv } from './get-env';
+export { waitUntil } from './wait-until';

package/dist/index.js

@@ -3,6 +3,10 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
     for (let key of __getOwnPropNames(from))
@@ -11,12 +15,22 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var src_exports = {};
+__export(src_exports, {
+  geolocation: () => import_headers.geolocation,
+  getEnv: () => import_get_env.getEnv,
+  ipAddress: () => import_headers.ipAddress,
+  waitUntil: () => import_wait_until.waitUntil
+});
 module.exports = __toCommonJS(src_exports);
-__reExport(src_exports, require("./wait-until"), module.exports);
+var import_headers = require("./headers");
+var import_get_env = require("./get-env");
+var import_wait_until = require("./wait-until");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ...require("./wait-until")
+  geolocation,
+  getEnv,
+  ipAddress,
+  waitUntil
 });

package/package.json

@@ -9,7 +9,7 @@
     "dist"
   ],
   "types": "./dist/index.d.ts",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "repository": {
     "directory": "packages/functions",
     "type": "git",
@@ -19,8 +19,11 @@
     "url": "https://github.com/vercel/vercel/issues"
   },
   "devDependencies": {
-    "typescript": "4.9.5",
     "tinyspawn": "1.3.1",
+    "typedoc": "0.24.6",
+    "typedoc-plugin-markdown": "3.15.2",
+    "typedoc-plugin-mdn-links": "3.0.3",
+    "typescript": "4.9.5",
     "vitest": "1.3.1"
   },
   "engines": {
@@ -31,7 +34,9 @@
     "access": "public"
   },
   "scripts": {
+    "pretest": "pnpm run build",
     "test": "vitest",
-    "build": "node ../../utils/build.mjs"
+    "build": "node ../../utils/build.mjs",
+    "build:docs": "typedoc && prettier --write docs/**/*.md docs/*.md"
   }
 }