next-cache-toolbar 0.2.1 → 0.3.1

package/readme.md

@@ -2,13 +2,12 @@
 
 A toolbar that helps to identify [data cache](https://nextjs.org/docs/app/building-your-application/caching#data-cache) entries
 
-![Example](./assets/example_image.png)
+![Example app](./assets/app.jpg)
 
-## Preview cached body
+![Example toolbar open](./assets/app-toolbar-open.jpg)
 
-![Example](./assets/body_preview.png)
-
-## Use
+![Example body open](./assets/app-body-open.jpg)
+## How to use it?
 
 `next-cache-toolbar` requires to use [app router](https://nextjs.org/docs/app/building-your-application/caching#data-cache)
 
@@ -44,3 +43,31 @@ export default function Layout({ children }) {
   );
 }
 ```
+
+## How does `data cache` work?
+
+There are two cases when `data cache` is used:
+ - wrapping any function with `unstable_cache`
+ - adding `next` options to `fetch` call
+
+Both cases will store returned data inside `.next/cache/fetch-cache` folder in format 
+
+```json
+{
+  "kind": "FETCH",
+  "revalidate": 30,
+  "tags": [],
+  "data": {
+    "body": "...",
+    "headers": {},
+    "status": 200,
+    "url": "..."
+  }
+}
+```
+
+There is one caveat, when using `unstable_cache` stored data will do not have any headers while body will be in plain JSON.
+But when using `fetch` with `next` options all headers from response will be present and `body` will be encoded using base64.
+Nevertheless both of these approaches stores all data as well as `revalidate` time and `tags`.
+
+

package/dist/cjs/getCacheEntries-server-DMz68ZTt.js

@@ -1,72 +0,0 @@
-'use server';
-var zod = require('zod');
-var node_fs = require('node:fs');
-
-const stringToJSONSchema = zod.z.string().transform((str, ctx)=>{
-    try {
-        return JSON.parse(str);
-    } catch (e) {
-        ctx.addIssue({
-            code: "custom",
-            message: "Encoded body is not in JSON format",
-            path: [
-                "data",
-                "body"
-            ]
-        });
-        return zod.z.NEVER;
-    }
-});
-const nextCacheFileSchema = zod.z.object({
-    data: zod.z.object({
-        body: zod.z.string(),
-        headers: zod.z.record(zod.z.string(), zod.z.string()),
-        status: zod.z.number(),
-        url: zod.z.string()
-    }),
-    kind: zod.z.union([
-        zod.z.literal("FETCH"),
-        zod.z.unknown()
-    ]),
-    revalidate: zod.z.number().optional(),
-    tags: zod.z.array(zod.z.string()).optional().default([])
-}).transform((cacheEntry)=>{
-    const body = stringToJSONSchema.parse(atob(cacheEntry.data.body));
-    return {
-        ...cacheEntry,
-        data: {
-            ...cacheEntry.data,
-            body
-        }
-    };
-});
-
-const cachePath = ".next/cache/fetch-cache";
-const getCacheFiles = async ()=>{
-    if (!node_fs.existsSync(cachePath)) {
-        return;
-    }
-    const files = await node_fs.promises.readdir(cachePath);
-    const cacheFiles = new Map();
-    for (const file of files){
-        // ignore tags-manifest file
-        if (file.match(/manifest/)) {
-            continue;
-        }
-        try {
-            const fileContent = await node_fs.promises.readFile(`${cachePath}/${file}`);
-            const cacheEntry = nextCacheFileSchema.parse(JSON.parse(fileContent.toString()));
-            cacheFiles.set(file, cacheEntry);
-        } catch (error) {
-            if (error instanceof zod.ZodError) {
-                const issues = error.issues;
-                console.error(`File ${file} do not match the schema`, issues);
-                continue;
-            }
-            console.error(`Error parsing ${file}`);
-        }
-    }
-    return Array.from(cacheFiles.entries());
-};
-
-exports.getCacheFiles = getCacheFiles;

package/dist/es/getCacheEntries-server-BkR7kA29.js

@@ -1,72 +0,0 @@
-'use server';
-import { z, ZodError } from 'zod';
-import { existsSync, promises } from 'node:fs';
-
-const stringToJSONSchema = z.string().transform((str, ctx)=>{
-    try {
-        return JSON.parse(str);
-    } catch (e) {
-        ctx.addIssue({
-            code: "custom",
-            message: "Encoded body is not in JSON format",
-            path: [
-                "data",
-                "body"
-            ]
-        });
-        return z.NEVER;
-    }
-});
-const nextCacheFileSchema = z.object({
-    data: z.object({
-        body: z.string(),
-        headers: z.record(z.string(), z.string()),
-        status: z.number(),
-        url: z.string()
-    }),
-    kind: z.union([
-        z.literal("FETCH"),
-        z.unknown()
-    ]),
-    revalidate: z.number().optional(),
-    tags: z.array(z.string()).optional().default([])
-}).transform((cacheEntry)=>{
-    const body = stringToJSONSchema.parse(atob(cacheEntry.data.body));
-    return {
-        ...cacheEntry,
-        data: {
-            ...cacheEntry.data,
-            body
-        }
-    };
-});
-
-const cachePath = ".next/cache/fetch-cache";
-const getCacheFiles = async ()=>{
-    if (!existsSync(cachePath)) {
-        return;
-    }
-    const files = await promises.readdir(cachePath);
-    const cacheFiles = new Map();
-    for (const file of files){
-        // ignore tags-manifest file
-        if (file.match(/manifest/)) {
-            continue;
-        }
-        try {
-            const fileContent = await promises.readFile(`${cachePath}/${file}`);
-            const cacheEntry = nextCacheFileSchema.parse(JSON.parse(fileContent.toString()));
-            cacheFiles.set(file, cacheEntry);
-        } catch (error) {
-            if (error instanceof ZodError) {
-                const issues = error.issues;
-                console.error(`File ${file} do not match the schema`, issues);
-                continue;
-            }
-            console.error(`Error parsing ${file}`);
-        }
-    }
-    return Array.from(cacheFiles.entries());
-};
-
-export { getCacheFiles as g };