@vercel/functions 1.1.0 → 1.2.0

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,2 @@
-export * from './wait-until';
+export { geolocation, ipAddress } from './headers';
+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,19 @@ 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,
+  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_wait_until = require("./wait-until");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ...require("./wait-until")
+  geolocation,
+  ipAddress,
+  waitUntil
 });

package/package.json

@@ -9,7 +9,7 @@
     "dist"
   ],
   "types": "./dist/index.d.ts",
-  "version": "1.1.0",
+  "version": "1.2.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"
   }
 }