@nowarajs/elysia-cache 1.3.2 → 1.3.4

package/dist/cache.d.ts

@@ -1,183 +1,17 @@
 import type { KvStore } from '@nowarajs/kv-store/types';
-import { Elysia } from 'elysia';
+import { Elysia, type DefinitionBase, type MetadataBase, type SingletonBase } from 'elysia';
 import type { CacheOptions } from './types/cache-options';
-export declare const cache: (store?: KvStore) => Elysia<"", {
-    decorator: {};
-    store: {};
-    derive: {};
-    resolve: {};
-}, {
-    typebox: {};
-    error: {};
-}, {
-    schema: {};
-    standaloneSchema: {};
+/**
+ * Response caching plugin for Elysia applications.
+ *
+ * Caches responses per route with configurable TTL. Adds standard cache headers
+ * (`Cache-Control`, `ETag`, `Last-Modified`, `Expires`, `X-Cache`).
+ *
+ * @param store - KV store for caching. Defaults to in-memory.
+ * @returns Elysia plugin with `isCached` macro
+ */
+export declare const cache: (store?: KvStore) => Elysia<"", SingletonBase, DefinitionBase, MetadataBase & {
     macro: Partial<{
         readonly isCached: CacheOptions;
     }>;
-    macroFn: {
-        readonly isCached: ({ ttl, prefix }: CacheOptions) => {
-            readonly afterHandle: ({ set, responseValue, request }: {
-                body: unknown;
-                query: Record<string, string>;
-                params: {};
-                headers: Record<string, string | undefined>;
-                cookie: Record<string, import("elysia").Cookie<unknown>>;
-                server: import("elysia/universal/server").Server | null;
-                redirect: import("elysia").redirect;
-                set: {
-                    headers: import("elysia").HTTPHeaders;
-                    status?: number | keyof import("elysia").StatusMap;
-                    redirect?: string;
-                    cookie?: Record<string, import("elysia/cookies").ElysiaCookie>;
-                };
-                path: string;
-                route: string;
-                request: Request;
-                store: {};
-                status: <const Code extends number | keyof import("elysia").StatusMap, const T = Code extends 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 300 | 301 | 302 | 303 | 304 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 420 | 421 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511 ? {
-                    readonly 100: "Continue";
-                    readonly 101: "Switching Protocols";
-                    readonly 102: "Processing";
-                    readonly 103: "Early Hints";
-                    readonly 200: "OK";
-                    readonly 201: "Created";
-                    readonly 202: "Accepted";
-                    readonly 203: "Non-Authoritative Information";
-                    readonly 204: "No Content";
-                    readonly 205: "Reset Content";
-                    readonly 206: "Partial Content";
-                    readonly 207: "Multi-Status";
-                    readonly 208: "Already Reported";
-                    readonly 300: "Multiple Choices";
-                    readonly 301: "Moved Permanently";
-                    readonly 302: "Found";
-                    readonly 303: "See Other";
-                    readonly 304: "Not Modified";
-                    readonly 307: "Temporary Redirect";
-                    readonly 308: "Permanent Redirect";
-                    readonly 400: "Bad Request";
-                    readonly 401: "Unauthorized";
-                    readonly 402: "Payment Required";
-                    readonly 403: "Forbidden";
-                    readonly 404: "Not Found";
-                    readonly 405: "Method Not Allowed";
-                    readonly 406: "Not Acceptable";
-                    readonly 407: "Proxy Authentication Required";
-                    readonly 408: "Request Timeout";
-                    readonly 409: "Conflict";
-                    readonly 410: "Gone";
-                    readonly 411: "Length Required";
-                    readonly 412: "Precondition Failed";
-                    readonly 413: "Payload Too Large";
-                    readonly 414: "URI Too Long";
-                    readonly 415: "Unsupported Media Type";
-                    readonly 416: "Range Not Satisfiable";
-                    readonly 417: "Expectation Failed";
-                    readonly 418: "I'm a teapot";
-                    readonly 420: "Enhance Your Calm";
-                    readonly 421: "Misdirected Request";
-                    readonly 422: "Unprocessable Content";
-                    readonly 423: "Locked";
-                    readonly 424: "Failed Dependency";
-                    readonly 425: "Too Early";
-                    readonly 426: "Upgrade Required";
-                    readonly 428: "Precondition Required";
-                    readonly 429: "Too Many Requests";
-                    readonly 431: "Request Header Fields Too Large";
-                    readonly 451: "Unavailable For Legal Reasons";
-                    readonly 500: "Internal Server Error";
-                    readonly 501: "Not Implemented";
-                    readonly 502: "Bad Gateway";
-                    readonly 503: "Service Unavailable";
-                    readonly 504: "Gateway Timeout";
-                    readonly 505: "HTTP Version Not Supported";
-                    readonly 506: "Variant Also Negotiates";
-                    readonly 507: "Insufficient Storage";
-                    readonly 508: "Loop Detected";
-                    readonly 510: "Not Extended";
-                    readonly 511: "Network Authentication Required";
-                }[Code] : Code>(code: Code, response?: T) => import("elysia").ElysiaCustomStatusResponse<Code, T, Code extends "Continue" | "Switching Protocols" | "Processing" | "Early Hints" | "OK" | "Created" | "Accepted" | "Non-Authoritative Information" | "No Content" | "Reset Content" | "Partial Content" | "Multi-Status" | "Already Reported" | "Multiple Choices" | "Moved Permanently" | "Found" | "See Other" | "Not Modified" | "Temporary Redirect" | "Permanent Redirect" | "Bad Request" | "Unauthorized" | "Payment Required" | "Forbidden" | "Not Found" | "Method Not Allowed" | "Not Acceptable" | "Proxy Authentication Required" | "Request Timeout" | "Conflict" | "Gone" | "Length Required" | "Precondition Failed" | "Payload Too Large" | "URI Too Long" | "Unsupported Media Type" | "Range Not Satisfiable" | "Expectation Failed" | "I'm a teapot" | "Enhance Your Calm" | "Misdirected Request" | "Unprocessable Content" | "Locked" | "Failed Dependency" | "Too Early" | "Upgrade Required" | "Precondition Required" | "Too Many Requests" | "Request Header Fields Too Large" | "Unavailable For Legal Reasons" | "Internal Server Error" | "Not Implemented" | "Bad Gateway" | "Service Unavailable" | "Gateway Timeout" | "HTTP Version Not Supported" | "Variant Also Negotiates" | "Insufficient Storage" | "Loop Detected" | "Not Extended" | "Network Authentication Required" ? {
-                    readonly Continue: 100;
-                    readonly "Switching Protocols": 101;
-                    readonly Processing: 102;
-                    readonly "Early Hints": 103;
-                    readonly OK: 200;
-                    readonly Created: 201;
-                    readonly Accepted: 202;
-                    readonly "Non-Authoritative Information": 203;
-                    readonly "No Content": 204;
-                    readonly "Reset Content": 205;
-                    readonly "Partial Content": 206;
-                    readonly "Multi-Status": 207;
-                    readonly "Already Reported": 208;
-                    readonly "Multiple Choices": 300;
-                    readonly "Moved Permanently": 301;
-                    readonly Found: 302;
-                    readonly "See Other": 303;
-                    readonly "Not Modified": 304;
-                    readonly "Temporary Redirect": 307;
-                    readonly "Permanent Redirect": 308;
-                    readonly "Bad Request": 400;
-                    readonly Unauthorized: 401;
-                    readonly "Payment Required": 402;
-                    readonly Forbidden: 403;
-                    readonly "Not Found": 404;
-                    readonly "Method Not Allowed": 405;
-                    readonly "Not Acceptable": 406;
-                    readonly "Proxy Authentication Required": 407;
-                    readonly "Request Timeout": 408;
-                    readonly Conflict: 409;
-                    readonly Gone: 410;
-                    readonly "Length Required": 411;
-                    readonly "Precondition Failed": 412;
-                    readonly "Payload Too Large": 413;
-                    readonly "URI Too Long": 414;
-                    readonly "Unsupported Media Type": 415;
-                    readonly "Range Not Satisfiable": 416;
-                    readonly "Expectation Failed": 417;
-                    readonly "I'm a teapot": 418;
-                    readonly "Enhance Your Calm": 420;
-                    readonly "Misdirected Request": 421;
-                    readonly "Unprocessable Content": 422;
-                    readonly Locked: 423;
-                    readonly "Failed Dependency": 424;
-                    readonly "Too Early": 425;
-                    readonly "Upgrade Required": 426;
-                    readonly "Precondition Required": 428;
-                    readonly "Too Many Requests": 429;
-                    readonly "Request Header Fields Too Large": 431;
-                    readonly "Unavailable For Legal Reasons": 451;
-                    readonly "Internal Server Error": 500;
-                    readonly "Not Implemented": 501;
-                    readonly "Bad Gateway": 502;
-                    readonly "Service Unavailable": 503;
-                    readonly "Gateway Timeout": 504;
-                    readonly "HTTP Version Not Supported": 505;
-                    readonly "Variant Also Negotiates": 506;
-                    readonly "Insufficient Storage": 507;
-                    readonly "Loop Detected": 508;
-                    readonly "Not Extended": 510;
-                    readonly "Network Authentication Required": 511;
-                }[Code] : Code>;
-            } & {
-                responseValue: unknown;
-                response: unknown;
-            }) => Promise<void>;
-        };
-    };
-    parser: {};
-    response: {};
-}, {}, {
-    derive: {};
-    resolve: {};
-    schema: {};
-    standaloneSchema: {};
-    response: {};
-}, {
-    derive: {};
-    resolve: {};
-    schema: {};
-    standaloneSchema: {};
-    response: {};
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nowarajs/elysia-cache",
-	"version": "1.3.2",
+	"version": "1.3.4",
 	"author": "NowaraJS",
 	"description": "A template to create a bun package.",
 	"type": "module",

package/AGENTS.md

@@ -1,44 +0,0 @@
----
-name: Development_Workflow_and_Code_Standards
-description: Guidelines for development workflow and code standards
-applyTo: '**'
----
-
-## TypeScript and Project Conventions
-1. Use underscore prefix for private or non-exported elements (e.g., _privateMethod)
-2. Always specify visibility modifiers (private, protected, public), plus readonly, override, etc. when applicable
-3. Naming conventions: camelCase for variables/functions/methods; PascalCase for classes/interfaces/types; SCREAMING_CASE for constants
-4. Explicit typing: Always specify types for variables, parameters, and return values; never use any; prefer unknown if type cannot be determined; prefer interface over type alias for extendable objects
-5. Documentation: Use TSDoc style; explain purpose, parameters, return values, and behavior; only document code when requested; for @throws, use format "@throws ({@link Type}) – description"; for object/interface properties, write comment above each property instead of @param
-6. Control structures: Omit curly braces for single-statement bodies
-7. Path Aliases: Use $ for internal imports; do not import barrel files except as entry points
-8. Export Pattern: Each directory has index.ts re-exporting public items; types exported in types/index.ts
-9. Function style: Class methods use standard method syntax; helpers/callbacks/HOFs prefer arrow functions unless function syntax is required
-
-## Contribution Principles
-1. Follow TypeScript best practices and idiomatic patterns
-2. Maintain existing code structure and modular organization
-3. Keep developer experience in mind
-4. Keep pull requests focused and well-documented (with TsDoc if asked)
-5. Commit different types of changes separately; avoid mixing tests and features in one commit
-
-## Commit Message Convention (Conventional Commits + Emoji)
-Format: <type>(<emoji>): [summary up to 72 chars]
-(blank line, then context or description)
-
-<type> is lowercase
-summary is surrounded by brackets `[summary]`
-
-Types:
-feat(🚀) – New features
-fix(🔧) – Bug fixes
-perf(⚡) – Performance improvements
-refactor(🧹) – Refactoring
-build(📦) – Build tools / dependency changes
-types(🌊) – Type definitions
-chore(🦉) – Maintenance, non-code/test changes
-examples(🏀) – Example updates
-docs(📖) – Documentation changes
-test(🧪) – Test code updates
-style(🎨) – Style/formatting only
-ci(🤖) – CI/CD configuration