@mrjasonroy/cache-components-cache-handler 16.0.0-alpha.0

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,gFAAgF;AAChF,2DAA2D;AAC3D,gFAAgF;AAEhF,OAAO,EACL,gBAAgB,EAEhB,sBAAsB,GACvB,MAAM,yBAAyB,CAAC;AACjC,WAAW;AACX,OAAO,EACL,wBAAwB,EACxB,kBAAkB,GAEnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,iBAAiB,GAElB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrE,UAAU;AACV,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EACL,iBAAiB,EACjB,6BAA6B,GAE9B,MAAM,0BAA0B,CAAC;AAWlC,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEjD,gFAAgF;AAChF,kDAAkD;AAClD,gFAAgF;AAEhF,OAAO,EACL,4BAA4B,GAE7B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,2BAA2B,GAG5B,MAAM,uBAAuB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,163 @@
+/**
+ * Next.js 16 Cache Handler Types
+ * Based on: https://nextjs.org/docs/app/api-reference/config/next-config-js/cacheHandler
+ */
+/**
+ * Prefix for implicit tags generated by Next.js (system-generated tags for ISR)
+ */
+export declare const IMPLICIT_TAG_PREFIX = "_N_T_";
+/**
+ * Cache entry value types supported by Next.js
+ */
+export type CacheValue = {
+    kind: "ROUTE";
+    html: string;
+    pageData: Record<string, unknown>;
+    status?: number;
+    headers?: Record<string, string | string[]>;
+} | {
+    kind: "PAGE";
+    html: string;
+    pageData: Record<string, unknown>;
+    status?: number;
+    headers?: Record<string, string[]>;
+} | {
+    kind: "FETCH";
+    data: {
+        headers: Record<string, string>;
+        body: string;
+        status: number;
+        url: string;
+    };
+    revalidate: number | false;
+} | {
+    kind: "IMAGE";
+    etag: string;
+    buffer: Buffer;
+    extension: string;
+    isMiss?: boolean;
+    isStale?: boolean;
+};
+/**
+ * Lifespan parameters for cache entries
+ * All time values are in SECONDS (not milliseconds)
+ */
+export interface LifespanParameters {
+    /**
+     * Timestamp when entry was last modified (seconds since epoch)
+     */
+    lastModifiedAt: number;
+    /**
+     * Timestamp when entry becomes stale (seconds since epoch)
+     */
+    staleAt: number;
+    /**
+     * Timestamp when entry expires (seconds since epoch)
+     */
+    expireAt: number;
+    /**
+     * Age in seconds until entry becomes stale
+     */
+    staleAge: number;
+    /**
+     * Age in seconds until entry expires
+     */
+    expireAge: number;
+    /**
+     * Original revalidate value from Next.js
+     */
+    revalidate: number | false | undefined;
+}
+/**
+ * Internal cache handler value with metadata
+ * This is what handlers store internally
+ */
+export interface CacheHandlerValue {
+    /**
+     * Timestamp of last modification (milliseconds since epoch)
+     */
+    lastModified: number;
+    /**
+     * Lifespan/TTL parameters (null means no expiration)
+     */
+    lifespan: LifespanParameters | null;
+    /**
+     * Tags for cache invalidation (both explicit and implicit)
+     */
+    tags: readonly string[];
+    /**
+     * The actual cache value
+     */
+    value: CacheValue;
+}
+/**
+ * Context provided when setting cache entries
+ */
+export interface CacheHandlerContext {
+    /**
+     * Tags for cache invalidation
+     */
+    tags?: string[];
+    /**
+     * Revalidation period in seconds, or false to disable
+     */
+    revalidate?: number | false;
+    /**
+     * Soft tags (for Next.js internal use)
+     */
+    softTags?: string[];
+}
+/**
+ * Metadata passed to get() method
+ */
+export interface CacheHandlerGetMeta {
+    /**
+     * Implicit tags (system-generated) for this request
+     */
+    implicitTags: string[];
+}
+/**
+ * Cache handler interface that must be implemented
+ */
+export interface CacheHandler {
+    /**
+     * Handler name (for debugging/logging)
+     */
+    name: string;
+    /**
+     * Get a cache entry by key
+     */
+    get(key: string, meta?: CacheHandlerGetMeta): Promise<CacheValue | null>;
+    /**
+     * Set a cache entry
+     */
+    set(key: string, value: CacheValue, context?: CacheHandlerContext): Promise<void>;
+    /**
+     * Revalidate cache entries by tag
+     * @param tag - Cache tag to revalidate
+     * @param profile - Optional revalidation profile ("max" or custom profile name) or object with expire time
+     */
+    revalidateTag(tag: string, profile?: string | {
+        expire?: number;
+    }): Promise<void>;
+    /**
+     * Delete a cache entry by key (optional)
+     */
+    delete?(key: string): Promise<void>;
+}
+/**
+ * Cache handler constructor parameters
+ */
+export interface CacheHandlerOptions {
+    /**
+     * Next.js configuration
+     */
+    _appDir?: string;
+    _pagesDir?: string;
+    _requestHeaders?: Record<string, string>;
+    flushToDisk?: boolean;
+    experimental?: {
+        ppr?: boolean;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,eAAO,MAAM,mBAAmB,UAAU,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB;IACE,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;CAC7C,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;CACpC,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF,UAAU,EAAE,MAAM,GAAG,KAAK,CAAC;CAC5B,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEN;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAEzE;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElF;;;;OAIG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElF;;OAEG;IACH,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE;QACb,GAAG,CAAC,EAAE,OAAO,CAAC;KACf,CAAC;CACH"}

package/dist/types.js

@@ -0,0 +1,9 @@
+/**
+ * Next.js 16 Cache Handler Types
+ * Based on: https://nextjs.org/docs/app/api-reference/config/next-config-js/cacheHandler
+ */
+/**
+ * Prefix for implicit tags generated by Next.js (system-generated tags for ISR)
+ */
+export const IMPLICIT_TAG_PREFIX = "_N_T_";
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,OAAO,CAAC"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@mrjasonroy/cache-components-cache-handler",
+  "version": "16.0.0-alpha.0",
+  "description": "Cache handler for Next.js 16+ with support for 'use cache' directive and Cache Components",
+  "author": "Jason Roy",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist .turbo node_modules"
+  },
+  "keywords": [
+    "nextjs",
+    "next",
+    "cache",
+    "cache-handler",
+    "use-cache",
+    "isr",
+    "revalidation",
+    "redis",
+    "elasticache",
+    "valkey"
+  ],
+  "peerDependencies": {
+    "next": "~16.0.0"
+  },
+  "peerDependenciesMeta": {
+    "ioredis": {
+      "optional": true
+    }
+  },
+  "optionalDependencies": {
+    "ioredis": "^5.4.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.2",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mrjasonroy/cache-components-cache-handler",
+    "directory": "packages/cache-handler"
+  },
+  "homepage": "https://github.com/mrjasonroy/cache-components-cache-handler#readme",
+  "bugs": {
+    "url": "https://github.com/mrjasonroy/cache-components-cache-handler/issues"
+  }
+}