@studiocms/cfetch 0.1.1 → 0.1.3

package/README.md

@@ -60,7 +60,7 @@ export default defineConfig({
 
 ### Usage
 
-You can import the cachedFetch function anywhere you would use a normal `fetch` call. `cfetch` adapts the same default options as fetch,
+You can import the `cFetch` function anywhere and use it as you would use a normal `fetch` call. `cFetch` adapts the same default options as `fetch`:
 
 ```astro
 ---
@@ -69,30 +69,32 @@ import { cFetch } from 'c:fetch';
 const response = await cFetch(
     'https://example.com', // string | URL | Request
     { /* Normal fetch init optional options here, method, mode, etc. */ },
-    { lifetime: "1h" } // Optional, allows changing the default lifetime of the cache
-    );
+    { lifetime: "1h" }, // Optional, allows changing the default lifetime of the cache
+    'json', // Optional, allows changing the type of response object to be cached. 'json' (default) or 'text'
+);
 
 const html = await response.text();
 ---
 ```
 
-If you are also wanting the other available metadata (such as `lastChecked` value which is the last time the cache was updated) then you can add the following prop to cached fetch, changing the shape of the data output to the following:
+If you need to access the other available metadata (such as the `lastChecked` value which provides the last time the cache was updated), you can pass `true` as the fourth parameter, which will change the returned object to the following:
 
 ```astro
 ---
 import { cFetch } from 'c:fetch';
 
-const { lastCheck, data: response } = await cFetch(
-    'https://example.com', // string | URL | Request
-    { /* Normal fetch init optional options here, method, mode, etc. */ },
-    { lifetime: "1h" }, // Optional, allows changing the default lifetime of the cache
-    true
-    );
+const { lastCheck, data } = await cFetch(
+    'https://example.com',
+    { /* ... */ },
+    { lifetime: "1h" },
+    'json',
+    true // Changes the the output to include the lastCheck value
+);
 
-const html = await response.text();
+const html = await data.text();
 ---
 ```
 
 ## Licensing
 
-[MIT Licensed](https://github.com/withstudiocms/cfetch/blob/main/LICENSE).
+[MIT Licensed](https://github.com/withstudiocms/cfetch/blob/main/LICENSE).

package/dist/cache.d.ts

@@ -62,6 +62,8 @@ declare module 'c:fetch' {
 	 * @param input - The input to the fetch function, typically a URL or Request object.
 	 * @param init - An optional configuration object for the fetch request.
 	 * @param cacheConfig - Partial configuration for the cache behavior. Defaults to `defaultConfig`.
+	 * @param  type - Optional parameter specifying the expected response body format.
+	 *              Can be either 'json' or 'text'. Determines how the response body is processed.
 	 * @param metadata - A boolean indicating whether to return the full cached object (including metadata)
 	 *               or just the data. Defaults to `false`.
 	 * @returns The fetched or cached data. If `full` is `true`, returns an object containing
@@ -71,12 +73,14 @@ declare module 'c:fetch' {
 	export function cFetch(
 		input: Input,
 		init?: Init,
-		cacheConfig?: Partial<CacheConfig>
+		cacheConfig?: Partial<CacheConfig>,
+		type?: 'json' | 'text'
 	): Promise<Response>;
 	export function cFetch(
 		input: Input,
 		init?: Init,
 		cacheConfig?: Partial<CacheConfig>,
+		type?: 'json' | 'text',
 		metadata?: boolean
 	): Promise<CacheDataValue>;
 }

package/dist/wrappers.d.ts

@@ -3,6 +3,9 @@ export type { CacheConfig };
 /**
  * Exported for tests
  */
-export declare const cachedData: Map<string, CacheDataValue>;
-export declare function cFetch(input: Input, init?: Init, cacheConfig?: Partial<CacheConfig>): Promise<Response>;
-export declare function cFetch(input: Input, init?: Init, cacheConfig?: Partial<CacheConfig>, metadata?: boolean): Promise<CacheDataValue>;
+export declare const cachedData: Map<string, {
+    lastCheck: Date;
+    data: any;
+}>;
+export declare function cFetch(input: Input, init?: Init, cacheConfig?: Partial<CacheConfig>, type?: 'json' | 'text'): Promise<Response>;
+export declare function cFetch(input: Input, init?: Init, cacheConfig?: Partial<CacheConfig>, type?: 'json' | 'text', metadata?: boolean): Promise<CacheDataValue>;

package/dist/wrappers.js

@@ -6,32 +6,40 @@ const defaultConfig = await import("virtual:cfetch/config").then((mod) => {
   return _config;
 });
 const cachedData = /* @__PURE__ */ new Map();
-async function cFetch(input, init = void 0, cacheConfig = defaultConfig, metadata = false) {
+async function cFetch(input, init = {}, cacheConfig = defaultConfig, type = "json", metadata = false) {
   if (init?.method && init.method !== "GET") {
     console.warn(
       "Warning: cFetch is designed for GET requests. Using it with other methods will not cache the response."
     );
-    const newResponse = fetch(input, init);
-    return metadata ? { lastCheck: /* @__PURE__ */ new Date(), data: newResponse } : newResponse;
+    const response = await fetch(input, init);
+    const data = type === "json" ? await response.clone().json() : await response.clone().text();
+    const result = new Response(type === "json" ? JSON.stringify(data) : data, response);
+    return metadata ? { lastCheck: /* @__PURE__ */ new Date(), data: result } : result;
   }
-  const { lifetime } = {
-    ...defaultConfig,
-    ...cacheConfig
-  };
-  const storedData = cachedData.get(input.toString());
+  const { lifetime } = { ...defaultConfig, ...cacheConfig };
+  const key = input.toString();
+  const storedData = cachedData.get(key);
   if (!storedData || isOlderThan(storedData.lastCheck, lifetime)) {
-    const newResponse = await fetch(input, init);
-    if (!newResponse.ok) {
+    const response = await fetch(input, init);
+    if (!response.ok) {
       if (!storedData) {
         throw new Error("Failed to retrieve cached data, and failed to fetch new data");
       }
-      return metadata ? storedData : storedData.data;
+      const fallback = new Response(
+        type === "json" ? JSON.stringify(storedData.data) : storedData.data
+      );
+      return metadata ? { ...storedData, data: fallback } : fallback;
     }
-    const newCachedData = { lastCheck: /* @__PURE__ */ new Date(), data: newResponse };
-    cachedData.set(input.toString(), newCachedData);
-    return metadata ? newCachedData : newResponse;
+    const data = type === "json" ? await response.clone().json() : await response.clone().text();
+    const newCachedData = { lastCheck: /* @__PURE__ */ new Date(), data };
+    cachedData.set(key, newCachedData);
+    const result = new Response(type === "json" ? JSON.stringify(data) : data, response);
+    return metadata ? { ...newCachedData, data: result } : result;
   }
-  return metadata ? storedData : storedData.data;
+  const cachedResponse = new Response(
+    type === "json" ? JSON.stringify(storedData.data) : storedData.data
+  );
+  return metadata ? { ...storedData, data: cachedResponse } : cachedResponse;
 }
 export {
   cFetch,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studiocms/cfetch",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Astro integration that allows you to have a cached fetch function in your Astro SSR project.",
   "license": "MIT",
   "homepage": "https://studiocms.dev",