@vercel/functions 3.2.0 → 3.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vercel/functions
 
+## 3.3.0
+
+### Minor Changes
+
+- Introduce Vercel AddCacheTag API: addCacheTag ([#14096](https://github.com/vercel/vercel/pull/14096))
+
 ## 3.2.0
 
 ### Minor Changes

package/addcachetag/index.d.ts

@@ -0,0 +1 @@
+export declare const addCacheTag: (tag: string | string[]) => Promise<void>;

package/addcachetag/index.js

@@ -0,0 +1,35 @@
+"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 addcachetag_exports = {};
+__export(addcachetag_exports, {
+  addCacheTag: () => addCacheTag
+});
+module.exports = __toCommonJS(addcachetag_exports);
+var import_get_context = require("../get-context");
+const addCacheTag = (tag) => {
+  const api = (0, import_get_context.getContext)().addCacheTag;
+  if (api) {
+    return api.addCacheTag(tag);
+  }
+  return Promise.resolve();
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  addCacheTag
+});

package/addcachetag/types.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Vercel AddCacheTag API.
+ */
+export interface AddCacheTagApi {
+    /**
+     * Add one or more tags to the cache content
+     *
+     * @param tag One or more tags to add to the cache content.
+     * @returns A promise that resolves when the tag is added.
+     */
+    addCacheTag: (tag: string | string[]) => Promise<void>;
+}

package/addcachetag/types.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/docs/interfaces/index.AddCacheTagApi.md

@@ -0,0 +1,39 @@
+# Interface: AddCacheTagApi
+
+[index](../modules/index.md).AddCacheTagApi
+
+Vercel AddCacheTag API.
+
+## Table of contents
+
+### Properties
+
+- [addCacheTag](index.AddCacheTagApi.md#addcachetag)
+
+## Properties
+
+### addCacheTag
+
+• **addCacheTag**: (`tag`: `string` \| `string`[]) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+#### Type declaration
+
+▸ (`tag`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+Add one or more tags to the cache content
+
+##### Parameters
+
+| Name  | Type                   | Description                                   |
+| :---- | :--------------------- | :-------------------------------------------- |
+| `tag` | `string` \| `string`[] | One or more tags to add to the cache content. |
+
+##### Returns
+
+[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+A promise that resolves when the tag is added.
+
+#### Defined in
+
+[packages/functions/src/addcachetag/types.ts:11](https://github.com/vercel/vercel/blob/main/packages/functions/src/addcachetag/types.ts#L11)

package/docs/modules/index.md

@@ -4,6 +4,7 @@
 
 ### Interfaces
 
+- [AddCacheTagApi](../interfaces/index.AddCacheTagApi.md)
 - [DangerouslyDeleteOptions](../interfaces/index.DangerouslyDeleteOptions.md)
 - [Geo](../interfaces/index.Geo.md)
 - [PurgeApi](../interfaces/index.PurgeApi.md)
@@ -12,6 +13,7 @@
 
 ### Functions
 
+- [addCacheTag](index.md#addcachetag)
 - [attachDatabasePool](index.md#attachdatabasepool)
 - [dangerouslyDeleteBySrcImage](index.md#dangerouslydeletebysrcimage)
 - [dangerouslyDeleteByTag](index.md#dangerouslydeletebytag)
@@ -28,6 +30,26 @@
 
 ## Functions
 
+### addCacheTag
+
+▸ **addCacheTag**(`tag`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+#### Parameters
+
+| Name  | Type                   |
+| :---- | :--------------------- |
+| `tag` | `string` \| `string`[] |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+#### Defined in
+
+[packages/functions/src/addcachetag/index.ts:3](https://github.com/vercel/vercel/blob/main/packages/functions/src/addcachetag/index.ts#L3)
+
+---
+
 ### attachDatabasePool
 
 ▸ **attachDatabasePool**(`dbPool`): `void`

package/get-context.d.ts

@@ -1,9 +1,11 @@
 import { RuntimeCache } from './cache/types';
 import { PurgeApi } from './purge/types';
+import { AddCacheTagApi } from './addcachetag/types';
 type Context = {
     waitUntil?: (promise: Promise<unknown>) => void;
     cache?: RuntimeCache;
     purge?: PurgeApi;
+    addCacheTag?: AddCacheTagApi;
     headers?: Record<string, string>;
 };
 export declare const SYMBOL_FOR_REQ_CONTEXT: unique symbol;

package/index.d.ts

@@ -8,3 +8,5 @@ export { attachDatabasePool, experimental_attachDatabasePool, } from './db-conne
 export type { RuntimeCache } from './cache/types';
 export { invalidateByTag, dangerouslyDeleteByTag, invalidateBySrcImage, dangerouslyDeleteBySrcImage, } from './purge';
 export type { PurgeApi, DangerouslyDeleteOptions } from './purge/types';
+export { addCacheTag } from './addcachetag';
+export type { AddCacheTagApi } from './addcachetag/types';

package/index.js

@@ -18,6 +18,7 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var src_exports = {};
 __export(src_exports, {
+  addCacheTag: () => import_addcachetag.addCacheTag,
   attachDatabasePool: () => import_db_connections.attachDatabasePool,
   dangerouslyDeleteBySrcImage: () => import_purge.dangerouslyDeleteBySrcImage,
   dangerouslyDeleteByTag: () => import_purge.dangerouslyDeleteByTag,
@@ -40,8 +41,10 @@ var import_middleware = require("./middleware");
 var import_cache = require("./cache");
 var import_db_connections = require("./db-connections");
 var import_purge = require("./purge");
+var import_addcachetag = require("./addcachetag");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  addCacheTag,
   attachDatabasePool,
   dangerouslyDeleteBySrcImage,
   dangerouslyDeleteByTag,

package/package.json

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