@netlify/cache 1.3.0 → 1.5.0

package/dist/bootstrap/main.cjs

@@ -43,7 +43,21 @@ __export(main_exports, {
 });
 module.exports = __toCommonJS(main_exports);
 
+// 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";
@@ -155,7 +169,7 @@ var NetlifyCache = class {
     }
     const context = __privateGet(this, _getContext).call(this);
     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 +180,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();

package/dist/bootstrap/main.js

@@ -1,13 +1,42 @@
-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/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:"]);
@@ -114,7 +143,7 @@ var NetlifyCache = class {
     }
     const context = __privateGet(this, _getContext).call(this);
     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 +154,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();

package/dist/main.cjs

@@ -20,6 +20,11 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/main.ts
 var main_exports = {};
 __export(main_exports, {
+  DAY: () => DAY,
+  HOUR: () => HOUR,
+  MINUTE: () => MINUTE,
+  WEEK: () => WEEK,
+  YEAR: () => YEAR,
   fetchWithCache: () => fetchWithCache,
   getCacheStatus: () => getCacheStatus,
   setCacheHeaders: () => setCacheHeaders
@@ -290,8 +295,20 @@ var fetchWithCache = async (request, optionsOrCacheSettings, cacheOptionsParam)
   }
   return fresh;
 };
+
+// src/constants.ts
+var MINUTE = 60;
+var HOUR = 60 * MINUTE;
+var DAY = 24 * HOUR;
+var WEEK = 7 * DAY;
+var YEAR = 365 * DAY;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  DAY,
+  HOUR,
+  MINUTE,
+  WEEK,
+  YEAR,
   fetchWithCache,
   getCacheStatus,
   setCacheHeaders

package/dist/main.d.cts

@@ -153,4 +153,25 @@ type FetchWithCache = {
  */
 declare const fetchWithCache: FetchWithCache;
 
-export { fetchWithCache, getCacheStatus, setCacheHeaders };
+/**
+ * Number of seconds in one minute.
+ */
+declare const MINUTE = 60;
+/**
+ * Number of seconds in one hour.
+ */
+declare const HOUR: number;
+/**
+ * Number of seconds in one day.
+ */
+declare const DAY: number;
+/**
+ * Number of seconds in one week.
+ */
+declare const WEEK: number;
+/**
+ * Number of seconds in one year.
+ */
+declare const YEAR: number;
+
+export { DAY, HOUR, MINUTE, WEEK, YEAR, fetchWithCache, getCacheStatus, setCacheHeaders };

package/dist/main.d.ts

@@ -153,4 +153,25 @@ type FetchWithCache = {
  */
 declare const fetchWithCache: FetchWithCache;
 
-export { fetchWithCache, getCacheStatus, setCacheHeaders };
+/**
+ * Number of seconds in one minute.
+ */
+declare const MINUTE = 60;
+/**
+ * Number of seconds in one hour.
+ */
+declare const HOUR: number;
+/**
+ * Number of seconds in one day.
+ */
+declare const DAY: number;
+/**
+ * Number of seconds in one week.
+ */
+declare const WEEK: number;
+/**
+ * Number of seconds in one year.
+ */
+declare const YEAR: number;
+
+export { DAY, HOUR, MINUTE, WEEK, YEAR, fetchWithCache, getCacheStatus, setCacheHeaders };

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];
@@ -263,7 +262,19 @@ var fetchWithCache = async (request, optionsOrCacheSettings, cacheOptionsParam)
   }
   return fresh;
 };
+
+// src/constants.ts
+var MINUTE = 60;
+var HOUR = 60 * MINUTE;
+var DAY = 24 * HOUR;
+var WEEK = 7 * DAY;
+var YEAR = 365 * DAY;
 export {
+  DAY,
+  HOUR,
+  MINUTE,
+  WEEK,
+  YEAR,
   fetchWithCache,
   getCacheStatus,
   setCacheHeaders

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/cache",
-  "version": "1.3.0",
+  "version": "1.5.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
-};