@visualbravo/zenstack-cache 1.0.0 → 1.0.2

package/README.md

@@ -10,11 +10,14 @@
     <a href="https://www.npmjs.com/package/@visualbravo/zenstack-cache?activeTab=versions">
       <img alt="NPM Version" src="https://img.shields.io/npm/v/%40visualbravo%2Fzenstack-cache/latest">
     </a>
+    <a href="https://www.npmjs.com/package/@visualbravo/zenstack-cache">
+      <img alt="NPM Downloads" src="https://img.shields.io/npm/dm/%40visualbravo%2Fzenstack-cache">
+    </a>
     <a href="https://github.com/visualbravo/zenstack-cache/actions/workflows/build-and-test.yaml?query=branch%3Adev++">
       <img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/visualbravo/zenstack-cache/build-and-test.yaml">
     </a>
-    <a href="https://discord.gg/Ykhr738dUe">
-      <img alt="Join the ZenStack server" src="https://img.shields.io/discord/1035538056146595961">
+    <a href="https://discord.gg/2PaRSu7X">
+      <img alt="Join the ZenStack Cache channel" src="https://img.shields.io/discord/1035538056146595961">
     </a>
     <a href="https://github.com/visualbravo/zenstack-cache/blob/76a2de03245c26841b04525dd8b424a8799d654c/LICENSE">
       <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-green">
@@ -131,6 +134,21 @@ const revalidatedPublishedPosts = await client.$cache.revalidation as Post[]
 > [!NOTE]
 > The total TTL of a cache entry is equal to its `ttl` + `swr`. The `ttl` window comes first, followed by the `swr` window. You can combine the two options to best suit the needs of your application.
 
+## Caching Forever
+
+You can cache results forever by specifying neither `ttl` nor `swr`. Such results will always be considered fresh.
+
+```typescript
+client.post.findMany({
+  cache: {
+    tags: [`user:${userId}`],
+  },
+})
+```
+
+> [!WARNING]
+> Your server may eventually run out of memory if you're not careful about invalidating entries that never expire.
+
 ## License
 
 MIT

package/dist/plugin.cjs

@@ -49,18 +49,13 @@ function defineCachePlugin(pluginOptions) {
 						status = "hit";
 						return entry.result;
 					} else if (require_utils.entryIsStale(entry)) {
-						revalidation = proceed(args).then(async (result$1) => {
-							try {
-								await cache.set(key, {
-									createdAt: Date.now(),
-									options,
-									result: result$1
-								});
-								return result$1;
-							} catch (err) {
-								console.error(`Failed to cache query result: ${err}`);
-								return null;
-							}
+						revalidation = proceed(args).then((result$1) => {
+							cache.set(key, {
+								createdAt: Date.now(),
+								options,
+								result: result$1
+							}).catch((err) => console.error(`Failed to cache query result: ${err}`));
+							return result$1;
 						});
 						status = "stale";
 						return entry.result;

package/dist/plugin.mjs

@@ -47,18 +47,13 @@ function defineCachePlugin(pluginOptions) {
 						status = "hit";
 						return entry.result;
 					} else if (entryIsStale(entry)) {
-						revalidation = proceed(args).then(async (result$1) => {
-							try {
-								await cache.set(key, {
-									createdAt: Date.now(),
-									options,
-									result: result$1
-								});
-								return result$1;
-							} catch (err) {
-								console.error(`Failed to cache query result: ${err}`);
-								return null;
-							}
+						revalidation = proceed(args).then((result$1) => {
+							cache.set(key, {
+								createdAt: Date.now(),
+								options,
+								result: result$1
+							}).catch((err) => console.error(`Failed to cache query result: ${err}`));
+							return result$1;
 						});
 						status = "stale";
 						return entry.result;

package/dist/schemas.cjs

@@ -4,8 +4,8 @@ zod = require_rolldown_runtime.__toESM(zod);
 
 //#region src/schemas.ts
 const cacheOptionsSchema = zod.default.strictObject({
-	ttl: zod.default.number().min(1).optional(),
-	swr: zod.default.number().min(1).optional(),
+	ttl: zod.default.int().positive().optional(),
+	swr: zod.default.int().positive().optional(),
 	tags: zod.default.string().array().optional()
 });
 const cacheEnvelopeSchema = zod.default.object({ cache: cacheOptionsSchema.optional() });

package/dist/schemas.d.cts

@@ -2,14 +2,14 @@ import z from "zod";
 
 //#region src/schemas.d.ts
 declare const cacheOptionsSchema: z.ZodObject<{
-  ttl: z.ZodOptional<z.ZodNumber>;
-  swr: z.ZodOptional<z.ZodNumber>;
+  ttl: z.ZodOptional<z.ZodInt>;
+  swr: z.ZodOptional<z.ZodInt>;
   tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
 }, z.core.$strict>;
 declare const cacheEnvelopeSchema: z.ZodObject<{
   cache: z.ZodOptional<z.ZodObject<{
-    ttl: z.ZodOptional<z.ZodNumber>;
-    swr: z.ZodOptional<z.ZodNumber>;
+    ttl: z.ZodOptional<z.ZodInt>;
+    swr: z.ZodOptional<z.ZodInt>;
     tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
   }, z.core.$strict>>;
 }, z.core.$strip>;

package/dist/schemas.d.mts

@@ -2,14 +2,14 @@ import z from "zod";
 
 //#region src/schemas.d.ts
 declare const cacheOptionsSchema: z.ZodObject<{
-  ttl: z.ZodOptional<z.ZodNumber>;
-  swr: z.ZodOptional<z.ZodNumber>;
+  ttl: z.ZodOptional<z.ZodInt>;
+  swr: z.ZodOptional<z.ZodInt>;
   tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
 }, z.core.$strict>;
 declare const cacheEnvelopeSchema: z.ZodObject<{
   cache: z.ZodOptional<z.ZodObject<{
-    ttl: z.ZodOptional<z.ZodNumber>;
-    swr: z.ZodOptional<z.ZodNumber>;
+    ttl: z.ZodOptional<z.ZodInt>;
+    swr: z.ZodOptional<z.ZodInt>;
     tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
   }, z.core.$strict>>;
 }, z.core.$strip>;

package/dist/schemas.mjs

@@ -2,8 +2,8 @@ import z from "zod";
 
 //#region src/schemas.ts
 const cacheOptionsSchema = z.strictObject({
-	ttl: z.number().min(1).optional(),
-	swr: z.number().min(1).optional(),
+	ttl: z.int().positive().optional(),
+	swr: z.int().positive().optional(),
 	tags: z.string().array().optional()
 });
 const cacheEnvelopeSchema = z.object({ cache: cacheOptionsSchema.optional() });

package/package.json

@@ -1,12 +1,20 @@
 {
   "name": "@visualbravo/zenstack-cache",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "license": "MIT",
   "repository": "github:visualbravo/zenstack-cache",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.cts",
+  "keywords": [
+    "zenstack",
+    "cache",
+    "caching",
+    "prisma",
+    "accelerate",
+    "orm"
+  ],
   "exports": {
     ".": {
       "@zenstack-cache/source": "./src/index.ts",