@vercel/functions 3.7.7 → 3.9.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @vercel/functions
 
+## 3.9.0
+
+### Minor Changes
+
+- 0b0a4a8: Add a `metric()` helper for reporting custom metrics from Vercel Functions.
+
+## 3.8.0
+
+### Minor Changes
+
+- 8fb6c4f: Adds getDeadline
+
 ## 3.7.7
 
 ### Patch Changes

package/deadline.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Returns the shared invocation deadline for the
+ * current function invocation, as a Date object.
+ */
+export declare function getDeadline(): Date | undefined;

package/deadline.js

@@ -0,0 +1,39 @@
+"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 deadline_exports = {};
+__export(deadline_exports, {
+  getDeadline: () => getDeadline
+});
+module.exports = __toCommonJS(deadline_exports);
+var import_get_context = require("./get-context");
+function getDeadline() {
+  const deadline = (0, import_get_context.getContext)().deadline;
+  if (deadline === void 0) {
+    return void 0;
+  }
+  const date = new Date(deadline);
+  if (isNaN(date.getTime())) {
+    return void 0;
+  }
+  return date;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getDeadline
+});

package/docs/index/README.md

@@ -33,10 +33,12 @@
 - [experimental_upgradeWebSocket](functions/experimental_upgradeWebSocket.md)
 - [geolocation](functions/geolocation.md)
 - [getCache](functions/getCache.md)
+- [getDeadline](functions/getDeadline.md)
 - [getEnv](functions/getEnv.md)
 - [invalidateBySrcImage](functions/invalidateBySrcImage.md)
 - [invalidateByTag](functions/invalidateByTag.md)
 - [ipAddress](functions/ipAddress.md)
+- [metric](functions/metric.md)
 - [next](functions/next.md)
 - [rewrite](functions/rewrite.md)
 - [waitUntil](functions/waitUntil.md)

package/docs/index/functions/getDeadline.md

@@ -0,0 +1,16 @@
+[**@vercel/functions**](../../README.md)
+
+***
+
+# Function: getDeadline()
+
+> **getDeadline**(): [`Date`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date) \| `undefined`
+
+Defined in: [packages/functions/src/deadline.ts:7](https://github.com/vercel/vercel/blob/main/packages/functions/src/deadline.ts#L7)
+
+Returns the shared invocation deadline for the
+current function invocation, as a Date object.
+
+## Returns
+
+[`Date`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date) \| `undefined`

package/docs/index/functions/metric.md

@@ -0,0 +1,45 @@
+[**@vercel/functions**](../../README.md)
+
+***
+
+# Function: metric()
+
+> **metric**(`name`, `value`, `tags?`): `void`
+
+Defined in: [packages/functions/src/metric.ts:28](https://github.com/vercel/vercel/blob/main/packages/functions/src/metric.ts#L28)
+
+Reports a custom metric for the current Vercel Function invocation.
+
+## Parameters
+
+### name
+
+`string`
+
+The name of the metric.
+
+### value
+
+`number`
+
+The numeric value of the metric.
+
+### tags?
+
+[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>
+
+Optional tags to attach to the metric.
+
+## Returns
+
+`void`
+
+## Example
+
+```js
+import { metric } from '@vercel/functions';
+
+metric('tinybird.query_ms', 100, {
+  query: 'getUser',
+});
+```

package/get-context.d.ts

@@ -5,6 +5,7 @@ import { PurgeApi } from './purge/types';
 import { AddCacheTagApi } from './addcachetag/types';
 type Context = {
     waitUntil?: (promise: Promise<unknown>) => void;
+    deadline?: string;
     cache?: RuntimeCache;
     purge?: PurgeApi;
     addCacheTag?: AddCacheTagApi;

package/index.d.ts

@@ -1,7 +1,9 @@
 export type { Request, Geo } from './headers';
 export { geolocation, ipAddress } from './headers';
 export { getEnv } from './get-env';
+export { getDeadline } from './deadline';
 export { waitUntil } from './wait-until';
+export { metric } from './metric';
 export { rewrite, next } from './middleware';
 export { getCache } from './cache';
 export { attachDatabasePool, experimental_attachDatabasePool, } from './db-connections';

package/index.js

@@ -26,10 +26,12 @@ __export(src_exports, {
   experimental_upgradeWebSocket: () => import_websocket.experimental_upgradeWebSocket,
   geolocation: () => import_headers.geolocation,
   getCache: () => import_cache.getCache,
+  getDeadline: () => import_deadline.getDeadline,
   getEnv: () => import_get_env.getEnv,
   invalidateBySrcImage: () => import_purge.invalidateBySrcImage,
   invalidateByTag: () => import_purge.invalidateByTag,
   ipAddress: () => import_headers.ipAddress,
+  metric: () => import_metric.metric,
   next: () => import_middleware.next,
   rewrite: () => import_middleware.rewrite,
   waitUntil: () => import_wait_until.waitUntil
@@ -37,7 +39,9 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 var import_headers = require("./headers");
 var import_get_env = require("./get-env");
+var import_deadline = require("./deadline");
 var import_wait_until = require("./wait-until");
+var import_metric = require("./metric");
 var import_middleware = require("./middleware");
 var import_cache = require("./cache");
 var import_db_connections = require("./db-connections");
@@ -54,10 +58,12 @@ var import_websocket = require("./websocket");
   experimental_upgradeWebSocket,
   geolocation,
   getCache,
+  getDeadline,
   getEnv,
   invalidateBySrcImage,
   invalidateByTag,
   ipAddress,
+  metric,
   next,
   rewrite,
   waitUntil

package/metric.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Reports a custom metric for the current Vercel Function invocation.
+ *
+ * @param name The name of the metric.
+ * @param value The numeric value of the metric.
+ * @param tags Optional tags to attach to the metric.
+ *
+ * @example
+ *
+ * ```js
+ * import { metric } from '@vercel/functions';
+ *
+ * metric('tinybird.query_ms', 100, {
+ *   query: 'getUser',
+ * });
+ * ```
+ */
+export declare function metric(name: string, value: number, tags?: Record<string, string>): void;

package/metric.js

@@ -0,0 +1,32 @@
+"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 metric_exports = {};
+__export(metric_exports, {
+  metric: () => metric
+});
+module.exports = __toCommonJS(metric_exports);
+const RUSTY_RUNTIME_IPC_SYMBOL = Symbol.for("@vercel/rusty-runtime-ipc");
+function metric(name, value, tags) {
+  const ipc = globalThis[RUSTY_RUNTIME_IPC_SYMBOL];
+  ipc?.sendMetric?.(name, value, tags);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  metric
+});

package/package.json

@@ -30,7 +30,7 @@
       "require": "./middleware.js"
     }
   },
-  "version": "3.7.7",
+  "version": "3.9.0",
   "repository": {
     "directory": "packages/functions",
     "type": "git",