@studiocms/cfetch 0.3.1 → 0.4.0

package/README.md

@@ -103,6 +103,7 @@ interface CachedResponse<T> {
 
 ```ts
 interface CFetchConfig {
+  forceCache?: true | undefined;
   ttl?: Duration.DurationInput;
   tags?: string[];
   key?: string;
@@ -110,6 +111,9 @@ interface CFetchConfig {
 }
 ```
 
+> [!NOTE]
+> By default only `GET` and `HEAD` requests are cached. You can change that by setting `forceCache` to `true`.
+
 ##### `InvalidateCacheOptions` type
 
 ```ts

package/dist/wrappers.d.mts

@@ -25,6 +25,7 @@ interface CachedResponse<T> {
  * Configuration options for cached fetch requests.
  */
 interface CFetchConfig {
+  forceCache?: true | undefined;
   ttl?: Duration$1.DurationInput;
   tags?: string[];
   key?: string;
@@ -58,6 +59,7 @@ declare const noOpParser: <U>(_: Response) => Promise<U>;
  * @param parser - A function that parses the Response object into type T
  * @param options - Optional RequestInit configuration for the fetch request
  * @param cacheConfig - Optional cache configuration object
+ * @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
  * @param cacheConfig.ttl - Time-to-live duration for the cached entry
  * @param cacheConfig.tags - Tags to associate with the cached entry for invalidation
  * @param cacheConfig.key - Custom cache key (defaults to URL and options hash)
@@ -112,6 +114,7 @@ declare const invalidateCacheEffect: (opts: InvalidateCacheOptions) => Effect.Ef
  * @param url - The URL to fetch data from
  * @param options - Optional fetch configuration options (headers, method, etc.)
  * @param cacheConfig - Optional cache configuration
+ * @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
  * @param cacheConfig.ttl - Time-to-live duration for the cached response
  * @param cacheConfig.tags - Tags to associate with the cached entry for invalidation
  * @param cacheConfig.key - Custom cache key to use instead of the default URL-based key
@@ -133,6 +136,7 @@ declare const cFetchEffectJson: <T>(url: string | URL, options?: RequestInit, ca
  * @param url - The URL to fetch the resource from.
  * @param options - Optional fetch configuration including method, headers, body, etc.
  * @param cacheConfig - Optional cache configuration.
+ * @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
  * @param cacheConfig.ttl - Time-to-live duration for the cached response.
  * @param cacheConfig.tags - Array of tags to associate with the cached entry for invalidation purposes.
  * @param cacheConfig.key - Custom cache key. If not provided, the URL will be used as the key.
@@ -156,6 +160,7 @@ declare const cFetchEffectText: (url: string | URL, options?: RequestInit, cache
  * @param url - The URL of the resource to fetch
  * @param options - Optional fetch request configuration (headers, method, etc.)
  * @param cacheConfig - Optional cache configuration object
+ * @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
  * @param cacheConfig.ttl - Time-to-live duration for the cached response
  * @param cacheConfig.tags - Array of tags to associate with the cached entry
  * @param cacheConfig.key - Custom cache key to use instead of the default
@@ -180,6 +185,7 @@ declare const cFetchEffectBlob: (url: string | URL, options?: RequestInit, cache
  * @param parser - A function that parses the Response object into the desired type T
  * @param options - Optional fetch request configuration (headers, method, body, etc.)
  * @param cacheConfig - Optional cache configuration object
+ * @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
  * @param cacheConfig.ttl - Time-to-live duration for the cached response
  * @param cacheConfig.tags - Array of tags to associate with the cached entry for invalidation purposes
  * @param cacheConfig.key - Custom cache key; if not provided, a key will be generated from the URL and options
@@ -203,6 +209,7 @@ declare const cFetch: <T>(url: string | URL, parser: (response: Response) => Pro
  * @param url - The URL to fetch data from
  * @param options - Optional fetch configuration options (headers, method, body, etc.)
  * @param cacheConfig - Optional cache configuration object
+ * @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
  * @param cacheConfig.ttl - Time-to-live duration for the cached response
  * @param cacheConfig.tags - Array of tags to associate with the cached entry for invalidation purposes
  * @param cacheConfig.key - Custom cache key to use instead of the default
@@ -226,6 +233,7 @@ declare const cFetchJson: <T>(url: string | URL, options?: RequestInit, cacheCon
  * @param url - The URL to fetch
  * @param options - Optional fetch configuration options (headers, method, etc.)
  * @param cacheConfig - Optional cache configuration
+ * @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
  * @param cacheConfig.ttl - Time-to-live duration for the cached response
  * @param cacheConfig.tags - Tags to associate with the cached response for invalidation
  * @param cacheConfig.key - Custom cache key (defaults to URL if not provided)
@@ -248,6 +256,7 @@ declare const cFetchText: (url: string | URL, options?: RequestInit, cacheConfig
  * @param url - The URL to fetch the Blob resource from
  * @param options - Optional fetch request configuration (headers, method, etc.)
  * @param cacheConfig - Optional cache configuration object
+ * @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
  * @param cacheConfig.ttl - Time-to-live duration for the cached response
  * @param cacheConfig.tags - Array of cache tags for cache invalidation
  * @param cacheConfig.key - Custom cache key for storing the response

package/dist/wrappers.mjs

@@ -107,6 +107,7 @@ const fetchAndParse = (url, parser, options) => Effect.gen(function* () {
 * @param parser - A function that parses the Response object into type T
 * @param options - Optional RequestInit configuration for the fetch request
 * @param cacheConfig - Optional cache configuration object
+* @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
 * @param cacheConfig.ttl - Time-to-live duration for the cached entry
 * @param cacheConfig.tags - Tags to associate with the cached entry for invalidation
 * @param cacheConfig.key - Custom cache key (defaults to URL and options hash)
@@ -137,9 +138,9 @@ const fetchAndParse = (url, parser, options) => Effect.gen(function* () {
 */
 const cFetchEffect = (url, parser, options, cacheConfig) => Effect.gen(function* () {
 	const cache = yield* CacheService;
-	const { key, verbose = false, ...cacheOpts } = cacheConfig || {};
+	const { forceCache = false, key, verbose = false, ...cacheOpts } = cacheConfig || {};
 	const method = options?.method?.toUpperCase() || "GET";
-	if (!cacheableMethods.includes(method)) {
+	if (!cacheableMethods.includes(method) && !forceCache) {
 		if (verbose) console.log(`[c:fetch] Bypassing cache for non-cacheable method: ${method}`);
 		return yield* fetchAndParse(url, parser, options);
 	}
@@ -193,6 +194,7 @@ const invalidateCacheEffect = (opts) => Effect.gen(function* () {
 * @param url - The URL to fetch data from
 * @param options - Optional fetch configuration options (headers, method, etc.)
 * @param cacheConfig - Optional cache configuration
+* @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
 * @param cacheConfig.ttl - Time-to-live duration for the cached response
 * @param cacheConfig.tags - Tags to associate with the cached entry for invalidation
 * @param cacheConfig.key - Custom cache key to use instead of the default URL-based key
@@ -214,6 +216,7 @@ const cFetchEffectJson = (url, options, cacheConfig) => cFetchEffect(url, (res)
 * @param url - The URL to fetch the resource from.
 * @param options - Optional fetch configuration including method, headers, body, etc.
 * @param cacheConfig - Optional cache configuration.
+* @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
 * @param cacheConfig.ttl - Time-to-live duration for the cached response.
 * @param cacheConfig.tags - Array of tags to associate with the cached entry for invalidation purposes.
 * @param cacheConfig.key - Custom cache key. If not provided, the URL will be used as the key.
@@ -237,6 +240,7 @@ const cFetchEffectText = (url, options, cacheConfig) => cFetchEffect(url, (res)
 * @param url - The URL of the resource to fetch
 * @param options - Optional fetch request configuration (headers, method, etc.)
 * @param cacheConfig - Optional cache configuration object
+* @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
 * @param cacheConfig.ttl - Time-to-live duration for the cached response
 * @param cacheConfig.tags - Array of tags to associate with the cached entry
 * @param cacheConfig.key - Custom cache key to use instead of the default
@@ -261,6 +265,7 @@ const cFetchEffectBlob = (url, options, cacheConfig) => cFetchEffect(url, (res)
 * @param parser - A function that parses the Response object into the desired type T
 * @param options - Optional fetch request configuration (headers, method, body, etc.)
 * @param cacheConfig - Optional cache configuration object
+* @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
 * @param cacheConfig.ttl - Time-to-live duration for the cached response
 * @param cacheConfig.tags - Array of tags to associate with the cached entry for invalidation purposes
 * @param cacheConfig.key - Custom cache key; if not provided, a key will be generated from the URL and options
@@ -284,6 +289,7 @@ const cFetch = (url, parser, options, cacheConfig) => runEffect(cFetchEffect(url
 * @param url - The URL to fetch data from
 * @param options - Optional fetch configuration options (headers, method, body, etc.)
 * @param cacheConfig - Optional cache configuration object
+* @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
 * @param cacheConfig.ttl - Time-to-live duration for the cached response
 * @param cacheConfig.tags - Array of tags to associate with the cached entry for invalidation purposes
 * @param cacheConfig.key - Custom cache key to use instead of the default
@@ -307,6 +313,7 @@ const cFetchJson = (url, options, cacheConfig) => runEffect(cFetchEffectJson(url
 * @param url - The URL to fetch
 * @param options - Optional fetch configuration options (headers, method, etc.)
 * @param cacheConfig - Optional cache configuration
+* @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
 * @param cacheConfig.ttl - Time-to-live duration for the cached response
 * @param cacheConfig.tags - Tags to associate with the cached response for invalidation
 * @param cacheConfig.key - Custom cache key (defaults to URL if not provided)
@@ -329,6 +336,7 @@ const cFetchText = (url, options, cacheConfig) => runEffect(cFetchEffectText(url
 * @param url - The URL to fetch the Blob resource from
 * @param options - Optional fetch request configuration (headers, method, etc.)
 * @param cacheConfig - Optional cache configuration object
+* @param cacheConfig.forceCache - When set to `true`, forces caching even for non-cacheable HTTP methods (e.g. POST)
 * @param cacheConfig.ttl - Time-to-live duration for the cached response
 * @param cacheConfig.tags - Array of cache tags for cache invalidation
 * @param cacheConfig.key - Custom cache key for storing the response

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studiocms/cfetch",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Astro integration that allows you to have a cached fetch function in your Astro SSR project.",
   "license": "MIT",
   "homepage": "https://studiocms.dev",
@@ -53,7 +53,7 @@
     "@inox-tools/astro-tests": "^0.8.1",
     "@types/node": "^22.0.0",
     "jest-extended": "^7.0.0",
-    "astro": "^5.17.1",
+    "astro": "^5.17.2",
     "effect": "^3.19.16"
   },
   "peerDependencies": {