@vercel/functions 3.1.4 → 3.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vercel/functions
 
+## 3.2.0
+
+### Minor Changes
+
+- Add new API for invalidateBySrcImage and dangerouslyDeleteBySrcImage ([#14111](https://github.com/vercel/vercel/pull/14111))
+
 ## 3.1.4
 
 ### Patch Changes

package/docs/interfaces/index.PurgeApi.md

@@ -8,11 +8,44 @@ Vercel Cache Purge APIs.
 
 ### Properties
 
+- [dangerouslyDeleteBySrcImage](index.PurgeApi.md#dangerouslydeletebysrcimage)
 - [dangerouslyDeleteByTag](index.PurgeApi.md#dangerouslydeletebytag)
+- [invalidateBySrcImage](index.PurgeApi.md#invalidatebysrcimage)
 - [invalidateByTag](index.PurgeApi.md#invalidatebytag)
 
 ## Properties
 
+### dangerouslyDeleteBySrcImage
+
+• **dangerouslyDeleteBySrcImage**: (`src`: `string` \| `string`[], `options?`: [`DangerouslyDeleteOptions`](index.DangerouslyDeleteOptions.md)) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+#### Type declaration
+
+▸ (`src`, `options?`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+Given a source image, delete all of its transformed images after a specified revalidation deadline.
+If accessed prior to the revalidation deadline, the stale transformed image will be served and a background task will be triggered. After the revalidation deadline is reached, the transformed image will be deleted.
+The default revalidation deadline is 0 and the content will be deleted immediately.
+
+##### Parameters
+
+| Name       | Type                                                            | Description                                                        |
+| :--------- | :-------------------------------------------------------------- | :----------------------------------------------------------------- |
+| `src`      | `string` \| `string`[]                                          | The source image to delete.                                        |
+| `options?` | [`DangerouslyDeleteOptions`](index.DangerouslyDeleteOptions.md) | The options for the delete that specify the revalidation deadline. |
+
+##### Returns
+
+[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+A promise that resolves when the delete is complete.
+
+#### Defined in
+
+[packages/functions/src/purge/types.ts:54](https://github.com/vercel/vercel/blob/main/packages/functions/src/purge/types.ts#L54)
+
+---
+
 ### dangerouslyDeleteByTag
 
 • **dangerouslyDeleteByTag**: (`tag`: `string` \| `string`[], `options?`: [`DangerouslyDeleteOptions`](index.DangerouslyDeleteOptions.md)) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
@@ -44,6 +77,35 @@ A promise that resolves when the delete is complete.
 
 ---
 
+### invalidateBySrcImage
+
+• **invalidateBySrcImage**: (`src`: `string` \| `string`[]) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+#### Type declaration
+
+▸ (`src`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+Given a source image, invalidate all of its transformed images by marking them as stale.
+On the next access, the stale transformed image will be served and a background task will transform the source image.
+
+##### Parameters
+
+| Name  | Type                   | Description                     |
+| :---- | :--------------------- | :------------------------------ |
+| `src` | `string` \| `string`[] | The source image to invalidate. |
+
+##### Returns
+
+[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+A promise that resolves when the invalidate is complete.
+
+#### Defined in
+
+[packages/functions/src/purge/types.ts:43](https://github.com/vercel/vercel/blob/main/packages/functions/src/purge/types.ts#L43)
+
+---
+
 ### invalidateByTag
 
 • **invalidateByTag**: (`tag`: `string` \| `string`[]) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>

package/docs/modules/index.md

@@ -13,11 +13,13 @@
 ### Functions
 
 - [attachDatabasePool](index.md#attachdatabasepool)
+- [dangerouslyDeleteBySrcImage](index.md#dangerouslydeletebysrcimage)
 - [dangerouslyDeleteByTag](index.md#dangerouslydeletebytag)
 - [experimental_attachDatabasePool](index.md#experimental_attachdatabasepool)
 - [geolocation](index.md#geolocation)
 - [getCache](index.md#getcache)
 - [getEnv](index.md#getenv)
+- [invalidateBySrcImage](index.md#invalidatebysrcimage)
 - [invalidateByTag](index.md#invalidatebytag)
 - [ipAddress](index.md#ipaddress)
 - [next](index.md#next)
@@ -60,6 +62,27 @@ attachDatabasePool(pgPool);
 
 ---
 
+### dangerouslyDeleteBySrcImage
+
+▸ **dangerouslyDeleteBySrcImage**(`src`, `options?`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+#### Parameters
+
+| Name       | Type                                                                          |
+| :--------- | :---------------------------------------------------------------------------- |
+| `src`      | `string` \| `string`[]                                                        |
+| `options?` | [`DangerouslyDeleteOptions`](../interfaces/index.DangerouslyDeleteOptions.md) |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+#### Defined in
+
+[packages/functions/src/purge/index.ts:28](https://github.com/vercel/vercel/blob/main/packages/functions/src/purge/index.ts#L28)
+
+---
+
 ### dangerouslyDeleteByTag
 
 ▸ **dangerouslyDeleteByTag**(`tag`, `options?`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
@@ -77,7 +100,7 @@ attachDatabasePool(pgPool);
 
 #### Defined in
 
-[packages/functions/src/purge/index.ts:13](https://github.com/vercel/vercel/blob/main/packages/functions/src/purge/index.ts#L13)
+[packages/functions/src/purge/index.ts:12](https://github.com/vercel/vercel/blob/main/packages/functions/src/purge/index.ts#L12)
 
 ---
 
@@ -238,6 +261,26 @@ https://vercel.com/docs/projects/environment-variables/system-environment-variab
 
 ---
 
+### invalidateBySrcImage
+
+▸ **invalidateBySrcImage**(`src`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+#### Parameters
+
+| Name  | Type                   |
+| :---- | :--------------------- |
+| `src` | `string` \| `string`[] |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
+
+#### Defined in
+
+[packages/functions/src/purge/index.ts:23](https://github.com/vercel/vercel/blob/main/packages/functions/src/purge/index.ts#L23)
+
+---
+
 ### invalidateByTag
 
 ▸ **invalidateByTag**(`tag`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
@@ -254,7 +297,7 @@ https://vercel.com/docs/projects/environment-variables/system-environment-variab
 
 #### Defined in
 
-[packages/functions/src/purge/index.ts:5](https://github.com/vercel/vercel/blob/main/packages/functions/src/purge/index.ts#L5)
+[packages/functions/src/purge/index.ts:4](https://github.com/vercel/vercel/blob/main/packages/functions/src/purge/index.ts#L4)
 
 ---
 

package/index.d.ts

@@ -6,5 +6,5 @@ export { rewrite, next } from './middleware';
 export { getCache } from './cache';
 export { attachDatabasePool, experimental_attachDatabasePool, } from './db-connections';
 export type { RuntimeCache } from './cache/types';
-export { invalidateByTag, dangerouslyDeleteByTag } from './purge';
+export { invalidateByTag, dangerouslyDeleteByTag, invalidateBySrcImage, dangerouslyDeleteBySrcImage, } from './purge';
 export type { PurgeApi, DangerouslyDeleteOptions } from './purge/types';

package/index.js

@@ -19,11 +19,13 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   attachDatabasePool: () => import_db_connections.attachDatabasePool,
+  dangerouslyDeleteBySrcImage: () => import_purge.dangerouslyDeleteBySrcImage,
   dangerouslyDeleteByTag: () => import_purge.dangerouslyDeleteByTag,
   experimental_attachDatabasePool: () => import_db_connections.experimental_attachDatabasePool,
   geolocation: () => import_headers.geolocation,
   getCache: () => import_cache.getCache,
   getEnv: () => import_get_env.getEnv,
+  invalidateBySrcImage: () => import_purge.invalidateBySrcImage,
   invalidateByTag: () => import_purge.invalidateByTag,
   ipAddress: () => import_headers.ipAddress,
   next: () => import_middleware.next,
@@ -41,11 +43,13 @@ var import_purge = require("./purge");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   attachDatabasePool,
+  dangerouslyDeleteBySrcImage,
   dangerouslyDeleteByTag,
   experimental_attachDatabasePool,
   geolocation,
   getCache,
   getEnv,
+  invalidateBySrcImage,
   invalidateByTag,
   ipAddress,
   next,

package/package.json

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

package/purge/index.d.ts

@@ -1,4 +1,5 @@
 import { DangerouslyDeleteOptions } from './types';
-export * from './types';
 export declare const invalidateByTag: (tag: string | string[]) => Promise<void>;
 export declare const dangerouslyDeleteByTag: (tag: string | string[], options?: DangerouslyDeleteOptions) => Promise<void>;
+export declare const invalidateBySrcImage: (src: string | string[]) => Promise<void>;
+export declare const dangerouslyDeleteBySrcImage: (src: string | string[], options?: DangerouslyDeleteOptions) => Promise<void>;

package/purge/index.js

@@ -15,16 +15,16 @@ 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 purge_exports = {};
 __export(purge_exports, {
+  dangerouslyDeleteBySrcImage: () => dangerouslyDeleteBySrcImage,
   dangerouslyDeleteByTag: () => dangerouslyDeleteByTag,
+  invalidateBySrcImage: () => invalidateBySrcImage,
   invalidateByTag: () => invalidateByTag
 });
 module.exports = __toCommonJS(purge_exports);
 var import_get_context = require("../get-context");
-__reExport(purge_exports, require("./types"), module.exports);
 const invalidateByTag = (tag) => {
   const api = (0, import_get_context.getContext)().purge;
   if (api) {
@@ -39,9 +39,18 @@ const dangerouslyDeleteByTag = (tag, options) => {
   }
   return Promise.resolve();
 };
+const invalidateBySrcImage = (src) => {
+  const api = (0, import_get_context.getContext)().purge;
+  return api ? api.invalidateBySrcImage(src) : Promise.resolve();
+};
+const dangerouslyDeleteBySrcImage = (src, options) => {
+  const api = (0, import_get_context.getContext)().purge;
+  return api ? api.dangerouslyDeleteBySrcImage(src, options) : Promise.resolve();
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  dangerouslyDeleteBySrcImage,
   dangerouslyDeleteByTag,
-  invalidateByTag,
-  ...require("./types")
+  invalidateBySrcImage,
+  invalidateByTag
 });

package/purge/types.d.ts

@@ -27,4 +27,22 @@ export interface PurgeApi {
      * @returns A promise that resolves when the delete is complete.
      */
     dangerouslyDeleteByTag: (tag: string | string[], options?: DangerouslyDeleteOptions) => Promise<void>;
+    /**
+     * Given a source image, invalidate all of its transformed images by marking them as stale.
+     * On the next access, the stale transformed image will be served and a background task will transform the source image.
+     *
+     * @param src The source image to invalidate.
+     * @returns A promise that resolves when the invalidate is complete.
+     */
+    invalidateBySrcImage: (src: string | string[]) => Promise<void>;
+    /**
+     * Given a source image, delete all of its transformed images after a specified revalidation deadline.
+     * If accessed prior to the revalidation deadline, the stale transformed image will be served and a background task will be triggered. After the revalidation deadline is reached, the transformed image will be deleted.
+     * The default revalidation deadline is 0 and the content will be deleted immediately.
+     *
+     * @param src The source image to delete.
+     * @param options The options for the delete that specify the revalidation deadline.
+     * @returns A promise that resolves when the delete is complete.
+     */
+    dangerouslyDeleteBySrcImage: (src: string | string[], options?: DangerouslyDeleteOptions) => Promise<void>;
 }