@netlify/cache 1.4.0 → 1.6.0

package/dist/bootstrap/main.cjs

@@ -39,11 +39,34 @@ var __privateSet = (obj, member, value, setter) => {
 var main_exports = {};
 __export(main_exports, {
   NetlifyCache: () => NetlifyCache,
-  NetlifyCacheStorage: () => NetlifyCacheStorage
+  NetlifyCacheStorage: () => NetlifyCacheStorage,
+  Operation: () => Operation
 });
 module.exports = __toCommonJS(main_exports);
 
+// src/bootstrap/environment.ts
+var Operation = /* @__PURE__ */ ((Operation2) => {
+  Operation2["Delete"] = "delete";
+  Operation2["Read"] = "read";
+  Operation2["Write"] = "write";
+  return Operation2;
+})(Operation || {});
+
+// src/bootstrap/errors.ts
+var ERROR_CODES = {
+  invalid_vary: "Responses must not use unsupported directives of the `Netlify-Vary` header (https://ntl.fyi/cache_api_invalid_vary).",
+  no_cache: "Responses must not set cache control headers with the `private`, `no-cache` or `no-store` directives (https://ntl.fyi/cache_api_no_cache).",
+  low_ttl: "Responses must have a cache control header with a `max-age` or `s-maxage` directive (https://ntl.fyi/cache_api_low_ttl).",
+  no_directive: "Responses must have a cache control header with caching directives (https://ntl.fyi/cache_api_no_directive).",
+  no_ttl: "Responses must have a cache control header with a `max-age` or `s-maxage` directive (https://ntl.fyi/cache_api_no_ttl).",
+  no_status: "Responses must specify a status code (https://ntl.fyi/cache_api_no_status).",
+  invalid_directive: "Responses must have a cache control header with caching directives (https://ntl.fyi/cache_api_invalid_directive).",
+  status: "Responses must have a status code between 200 and 299 (https://ntl.fyi/cache_api_status)."
+};
+var GENERIC_ERROR = "The server has returned an unexpected error (https://ntl.fyi/cache_api_error).";
+
 // src/headers.ts
+var ErrorDetail = "netlify-programmable-error";
 var ResourceHeaders = "netlify-programmable-headers";
 var ResourceStatus = "netlify-programmable-status";
 var ResourceStore = "netlify-programmable-store";
@@ -104,12 +127,14 @@ var NetlifyCache = class {
   }
   // eslint-disable-next-line class-methods-use-this, require-await, @typescript-eslint/no-unused-vars
   async delete(request) {
-    const context = __privateGet(this, _getContext).call(this);
-    const resourceURL = extractAndValidateURL(request);
-    await fetch(`${context.url}/${toCacheKey(resourceURL)}`, {
-      headers: this[getInternalHeaders](context),
-      method: "DELETE"
-    });
+    const context = __privateGet(this, _getContext).call(this, { operation: "delete" /* Delete */ });
+    if (context) {
+      const resourceURL = extractAndValidateURL(request);
+      await fetch(`${context.url}/${toCacheKey(resourceURL)}`, {
+        headers: this[getInternalHeaders](context),
+        method: "DELETE"
+      });
+    }
     return true;
   }
   // eslint-disable-next-line class-methods-use-this, require-await, @typescript-eslint/no-unused-vars
@@ -118,7 +143,10 @@ var NetlifyCache = class {
   }
   async match(request) {
     try {
-      const context = __privateGet(this, _getContext).call(this);
+      const context = __privateGet(this, _getContext).call(this, { operation: "read" /* Read */ });
+      if (!context) {
+        return;
+      }
       const resourceURL = extractAndValidateURL(request);
       const cacheURL = `${context.url}/${toCacheKey(resourceURL)}`;
       const response = await fetch(cacheURL, {
@@ -153,9 +181,12 @@ var NetlifyCache = class {
     if (response.headers.get("vary")?.includes("*")) {
       throw new TypeError("Cannot cache response with 'Vary: *' header.");
     }
-    const context = __privateGet(this, _getContext).call(this);
+    const context = __privateGet(this, _getContext).call(this, { operation: "write" /* Write */ });
+    if (!context) {
+      return;
+    }
     const resourceURL = extractAndValidateURL(request);
-    await fetch(`${context.url}/${toCacheKey(resourceURL)}`, {
+    const cacheResponse = await fetch(`${context.url}/${toCacheKey(resourceURL)}`, {
       body: response.body,
       headers: {
         ...this[getInternalHeaders](context),
@@ -166,6 +197,11 @@ var NetlifyCache = class {
       duplex: "half",
       method: "POST"
     });
+    if (!cacheResponse.ok) {
+      const errorDetail = cacheResponse.headers.get(ErrorDetail) ?? "";
+      const errorMessage = ERROR_CODES[errorDetail] || GENERIC_ERROR;
+      console.warn(`Failed to write to the cache: ${errorMessage}`);
+    }
   }
 };
 _base64Encode = new WeakMap();
@@ -240,5 +276,6 @@ _stores = new WeakMap();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   NetlifyCache,
-  NetlifyCacheStorage
+  NetlifyCacheStorage,
+  Operation
 });

package/dist/bootstrap/main.d.cts

@@ -1,5 +1,5 @@
-import { E as EnvironmentOptions } from '../cache-854474ad.js';
-export { B as Base64Encoder, N as NetlifyCache, R as RequestContextFactory } from '../cache-854474ad.js';
+import { E as EnvironmentOptions } from '../cache-dc160ee0.js';
+export { B as Base64Encoder, N as NetlifyCache, O as Operation, R as RequestContextFactory } from '../cache-dc160ee0.js';
 
 declare class NetlifyCacheStorage {
     #private;

package/dist/bootstrap/main.d.ts

@@ -1,5 +1,5 @@
-import { E as EnvironmentOptions } from '../cache-854474ad.js';
-export { B as Base64Encoder, N as NetlifyCache, R as RequestContextFactory } from '../cache-854474ad.js';
+import { E as EnvironmentOptions } from '../cache-dc160ee0.js';
+export { B as Base64Encoder, N as NetlifyCache, O as Operation, R as RequestContextFactory } from '../cache-dc160ee0.js';
 
 declare class NetlifyCacheStorage {
     #private;

package/dist/bootstrap/main.js

@@ -1,13 +1,50 @@
-import {
-  NetlifyForwardedHost,
-  ResourceHeaders,
-  ResourceStatus,
-  ResourceStore,
-  UserAgent,
-  __privateAdd,
-  __privateGet,
-  __privateSet
-} from "../chunk-I5FZDZ6V.js";
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateSet = (obj, member, value, setter) => {
+  __accessCheck(obj, member, "write to private field");
+  setter ? setter.call(obj, value) : member.set(obj, value);
+  return value;
+};
+
+// src/bootstrap/environment.ts
+var Operation = /* @__PURE__ */ ((Operation2) => {
+  Operation2["Delete"] = "delete";
+  Operation2["Read"] = "read";
+  Operation2["Write"] = "write";
+  return Operation2;
+})(Operation || {});
+
+// src/bootstrap/errors.ts
+var ERROR_CODES = {
+  invalid_vary: "Responses must not use unsupported directives of the `Netlify-Vary` header (https://ntl.fyi/cache_api_invalid_vary).",
+  no_cache: "Responses must not set cache control headers with the `private`, `no-cache` or `no-store` directives (https://ntl.fyi/cache_api_no_cache).",
+  low_ttl: "Responses must have a cache control header with a `max-age` or `s-maxage` directive (https://ntl.fyi/cache_api_low_ttl).",
+  no_directive: "Responses must have a cache control header with caching directives (https://ntl.fyi/cache_api_no_directive).",
+  no_ttl: "Responses must have a cache control header with a `max-age` or `s-maxage` directive (https://ntl.fyi/cache_api_no_ttl).",
+  no_status: "Responses must specify a status code (https://ntl.fyi/cache_api_no_status).",
+  invalid_directive: "Responses must have a cache control header with caching directives (https://ntl.fyi/cache_api_invalid_directive).",
+  status: "Responses must have a status code between 200 and 299 (https://ntl.fyi/cache_api_status)."
+};
+var GENERIC_ERROR = "The server has returned an unexpected error (https://ntl.fyi/cache_api_error).";
+
+// src/headers.ts
+var ErrorDetail = "netlify-programmable-error";
+var ResourceHeaders = "netlify-programmable-headers";
+var ResourceStatus = "netlify-programmable-status";
+var ResourceStore = "netlify-programmable-store";
+var NetlifyForwardedHost = "netlify-forwarded-host";
+var UserAgent = "user-agent";
 
 // src/bootstrap/cache.ts
 var allowedProtocols = /* @__PURE__ */ new Set(["http:", "https:"]);
@@ -63,12 +100,14 @@ var NetlifyCache = class {
   }
   // eslint-disable-next-line class-methods-use-this, require-await, @typescript-eslint/no-unused-vars
   async delete(request) {
-    const context = __privateGet(this, _getContext).call(this);
-    const resourceURL = extractAndValidateURL(request);
-    await fetch(`${context.url}/${toCacheKey(resourceURL)}`, {
-      headers: this[getInternalHeaders](context),
-      method: "DELETE"
-    });
+    const context = __privateGet(this, _getContext).call(this, { operation: "delete" /* Delete */ });
+    if (context) {
+      const resourceURL = extractAndValidateURL(request);
+      await fetch(`${context.url}/${toCacheKey(resourceURL)}`, {
+        headers: this[getInternalHeaders](context),
+        method: "DELETE"
+      });
+    }
     return true;
   }
   // eslint-disable-next-line class-methods-use-this, require-await, @typescript-eslint/no-unused-vars
@@ -77,7 +116,10 @@ var NetlifyCache = class {
   }
   async match(request) {
     try {
-      const context = __privateGet(this, _getContext).call(this);
+      const context = __privateGet(this, _getContext).call(this, { operation: "read" /* Read */ });
+      if (!context) {
+        return;
+      }
       const resourceURL = extractAndValidateURL(request);
       const cacheURL = `${context.url}/${toCacheKey(resourceURL)}`;
       const response = await fetch(cacheURL, {
@@ -112,9 +154,12 @@ var NetlifyCache = class {
     if (response.headers.get("vary")?.includes("*")) {
       throw new TypeError("Cannot cache response with 'Vary: *' header.");
     }
-    const context = __privateGet(this, _getContext).call(this);
+    const context = __privateGet(this, _getContext).call(this, { operation: "write" /* Write */ });
+    if (!context) {
+      return;
+    }
     const resourceURL = extractAndValidateURL(request);
-    await fetch(`${context.url}/${toCacheKey(resourceURL)}`, {
+    const cacheResponse = await fetch(`${context.url}/${toCacheKey(resourceURL)}`, {
       body: response.body,
       headers: {
         ...this[getInternalHeaders](context),
@@ -125,6 +170,11 @@ var NetlifyCache = class {
       duplex: "half",
       method: "POST"
     });
+    if (!cacheResponse.ok) {
+      const errorDetail = cacheResponse.headers.get(ErrorDetail) ?? "";
+      const errorMessage = ERROR_CODES[errorDetail] || GENERIC_ERROR;
+      console.warn(`Failed to write to the cache: ${errorMessage}`);
+    }
   }
 };
 _base64Encode = new WeakMap();
@@ -198,5 +248,6 @@ _environmentOptions = new WeakMap();
 _stores = new WeakMap();
 export {
   NetlifyCache,
-  NetlifyCacheStorage
+  NetlifyCacheStorage,
+  Operation
 };

package/dist/{cache-854474ad.d.ts → cache-dc160ee0.d.ts}

@@ -4,7 +4,14 @@ interface EnvironmentOptions {
     getContext: RequestContextFactory;
     userAgent?: string;
 }
-type RequestContextFactory = () => RequestContext;
+declare const enum Operation {
+    Delete = "delete",
+    Read = "read",
+    Write = "write"
+}
+type RequestContextFactory = (options: {
+    operation: Operation;
+}) => RequestContext | null;
 interface RequestContext {
     host: string;
     token: string;
@@ -30,4 +37,4 @@ declare class NetlifyCache implements Cache {
     put(request: RequestInfo | URL | string, response: Response): Promise<void>;
 }
 
-export { Base64Encoder as B, EnvironmentOptions as E, NetlifyCache as N, RequestContextFactory as R };
+export { Base64Encoder as B, EnvironmentOptions as E, NetlifyCache as N, Operation as O, RequestContextFactory as R };

package/dist/main.d.cts

@@ -1,4 +1,4 @@
-import { N as NetlifyCache } from './cache-854474ad.js';
+import { N as NetlifyCache } from './cache-dc160ee0.js';
 
 interface CacheSettings {
     /**

package/dist/main.d.ts

@@ -1,4 +1,4 @@
-import { N as NetlifyCache } from './cache-854474ad.js';
+import { N as NetlifyCache } from './cache-dc160ee0.js';
 
 interface CacheSettings {
     /**

package/dist/main.js

@@ -1,10 +1,9 @@
-import {
-  CacheStatus,
-  NetlifyCacheId,
-  NetlifyCacheTag,
-  NetlifyCdnCacheControl,
-  NetlifyVary
-} from "./chunk-I5FZDZ6V.js";
+// src/headers.ts
+var CacheStatus = "cache-status";
+var NetlifyCacheId = "netlify-cache-id";
+var NetlifyCacheTag = "netlify-cache-tag";
+var NetlifyCdnCacheControl = "netlify-cdn-cache-control";
+var NetlifyVary = "netlify-vary";
 
 // src/cache-headers/validation.ts
 var ensureArray = (value) => Array.isArray(value) ? value : [value];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/cache",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "TypeScript utilities for interacting with the Netlify cache",
   "type": "module",
   "engines": {

package/dist/chunk-I5FZDZ6V.js

@@ -1,46 +0,0 @@
-var __accessCheck = (obj, member, msg) => {
-  if (!member.has(obj))
-    throw TypeError("Cannot " + msg);
-};
-var __privateGet = (obj, member, getter) => {
-  __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd = (obj, member, value) => {
-  if (member.has(obj))
-    throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
-var __privateSet = (obj, member, value, setter) => {
-  __accessCheck(obj, member, "write to private field");
-  setter ? setter.call(obj, value) : member.set(obj, value);
-  return value;
-};
-
-// src/headers.ts
-var CacheStatus = "cache-status";
-var NetlifyCacheId = "netlify-cache-id";
-var NetlifyCacheTag = "netlify-cache-tag";
-var NetlifyCdnCacheControl = "netlify-cdn-cache-control";
-var NetlifyVary = "netlify-vary";
-var ResourceHeaders = "netlify-programmable-headers";
-var ResourceStatus = "netlify-programmable-status";
-var ResourceStore = "netlify-programmable-store";
-var NetlifyForwardedHost = "netlify-forwarded-host";
-var UserAgent = "user-agent";
-
-export {
-  __privateGet,
-  __privateAdd,
-  __privateSet,
-  CacheStatus,
-  NetlifyCacheId,
-  NetlifyCacheTag,
-  NetlifyCdnCacheControl,
-  NetlifyVary,
-  ResourceHeaders,
-  ResourceStatus,
-  ResourceStore,
-  NetlifyForwardedHost,
-  UserAgent
-};