@spytecgps/nova-orm 1.4.241 → 1.4.242

package/dist/cache/LruQueryResultCache.d.ts

@@ -6,7 +6,15 @@ export interface LruQueryResultCacheConfig {
 }
 export declare class LruQueryResultCache implements QueryResultCache {
     private readonly cache;
+    private readonly maxSize;
     constructor(config?: LruQueryResultCacheConfig);
+    /**
+     * Emit `nova.cache.lru.size` and `nova.cache.lru.max` as observable gauges so
+     * dashboards can tell "is the LRU full?" directly instead of inferring from
+     * hit-rate decay. Filter by `ServiceName` to disambiguate when multiple
+     * DataSources share a process.
+     */
+    private registerSizeGauges;
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     synchronize(): Promise<void>;

package/dist/cache/LruQueryResultCache.js

@@ -1 +1 @@
-"use strict";var e=require("lru-cache");exports.LruQueryResultCache=class LruQueryResultCache{cache;constructor(c={}){this.cache=new e.LRUCache({max:c.max??1e3,ttl:c.maxTtlMs})}async connect(){}async disconnect(){this.cache.clear()}async synchronize(){}async getFromCache(e){const c=this.keyFor(e);if(c)return this.cache.get(c)}async storeInCache(e){const c=this.keyFor(e);if(!c)return;const t={...e,time:e.time??Date.now()};this.cache.set(c,t)}isExpired(e){const c=e.time??0;return Date.now()-c>=e.duration}async remove(e){for(const c of e)this.cache.delete(c)}async clear(){this.cache.clear()}keyFor(e){return e.identifier??e.query}};
+"use strict";var e=require("@opentelemetry/api"),c=require("lru-cache");exports.LruQueryResultCache=class LruQueryResultCache{cache;maxSize;constructor(e={}){this.maxSize=e.max??1e3,this.cache=new c.LRUCache({max:this.maxSize,ttl:e.maxTtlMs}),this.registerSizeGauges()}registerSizeGauges(){const c=e.metrics.getMeter("@spytecgps/nova-orm");c.createObservableGauge("nova.cache.lru.size",{description:"Current entry count in the in-process LRU query result cache"}).addCallback((e=>{e.observe(this.cache.size)})),c.createObservableGauge("nova.cache.lru.max",{description:"Configured max entry count for the in-process LRU query result cache"}).addCallback((e=>{e.observe(this.maxSize)}))}async connect(){}async disconnect(){this.cache.clear()}async synchronize(){}async getFromCache(e){const c=this.keyFor(e);if(c)return this.cache.get(c)}async storeInCache(e){const c=this.keyFor(e);if(!c)return;const t={...e,time:e.time??Date.now()};this.cache.set(c,t)}isExpired(e){const c=e.time??0;return Date.now()-c>=e.duration}async remove(e){for(const c of e)this.cache.delete(c)}async clear(){this.cache.clear()}keyFor(e){return e.identifier??e.query}};

package/dist/cache/buildCacheFromEnv.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Build the TypeORM `cache:` config object from REDIS_* env vars so consumers
+ * don't have to embed mode-switching logic in every service. SSM-driven
+ * `/${stage}/cache/<name>/redis/{host,port,tls,mode}` keys map 1:1 to the env
+ * vars and this helper returns the right TypeORM shape.
+ *
+ * Returns undefined if REDIS_HOST is absent, so it's safe to spread into a
+ * DataSource config that may or may not have a cache configured.
+ *
+ * Supported modes:
+ *   - "standalone" (default): uses TypeORM's built-in RedisQueryResultCache
+ *     with the `ioredis` client type. One node, no cluster topology.
+ *   - "cluster": custom client passed through TypeORM's `client` field; uses
+ *     `ioredis` Cluster mode with the ElastiCache-cluster-mode safety
+ *     defaults baked in (enableOfflineQueue:false, checkServerIdentity bypass
+ *     for TLS — see project_elasticache_cluster_ioredis_tls).
+ */
+export type CacheMode = 'standalone' | 'cluster';
+export interface CacheFromEnvOptions {
+    /** Env var name for host. Default: REDIS_HOST. Override to support multiple caches in one process. */
+    hostEnv?: string;
+    portEnv?: string;
+    tlsEnv?: string;
+    modeEnv?: string;
+}
+export interface BuiltCacheConfig {
+    type?: 'ioredis';
+    options?: Record<string, unknown>;
+    client?: unknown;
+    ignoreErrors?: boolean;
+}
+export declare function buildCacheFromEnv(options?: CacheFromEnvOptions): BuiltCacheConfig | undefined;

package/dist/cache/buildCacheFromEnv.js

@@ -0,0 +1 @@
+"use strict";let e;exports.buildCacheFromEnv=function(r={}){const t=r.hostEnv??"REDIS_HOST",n=r.portEnv??"REDIS_PORT",o=r.tlsEnv??"REDIS_TLS",s=r.modeEnv??"REDIS_MODE",i=process.env[t];if(!i)return;const u=Number(process.env[n]??"6379"),c="true"===process.env[o];if("cluster"===(process.env[s]??"standalone")){const r=function(){if(void 0!==e)return e;try{e=require("ioredis")}catch{e=null}return e}();if(!r)throw new Error("buildCacheFromEnv: REDIS_MODE=cluster requires `ioredis` to be installed");return{client:new r.Cluster([{host:i,port:u}],{redisOptions:c?{tls:{checkServerIdentity:()=>{}}}:{},enableOfflineQueue:!1}),ignoreErrors:!0}}return{type:"ioredis",options:{host:i,port:u,tls:c?{}:void 0},ignoreErrors:!0}};

package/dist/cache/index.d.ts

@@ -1,3 +1,4 @@
 export { attachIoredisErrorHandler, RedisQueryResultCacheLike } from './attachIoredisErrorHandler';
+export { buildCacheFromEnv, BuiltCacheConfig, CacheFromEnvOptions, CacheMode, } from './buildCacheFromEnv';
 export { CacheKind, InstrumentedQueryResultCache, InstrumentedQueryResultCacheOptions, } from './InstrumentedQueryResultCache';
 export { LruQueryResultCache, LruQueryResultCacheConfig } from './LruQueryResultCache';

package/dist/cache/index.js

@@ -1 +1 @@
-"use strict";var e=require("./attachIoredisErrorHandler.js"),r=require("./InstrumentedQueryResultCache.js"),t=require("./LruQueryResultCache.js");exports.attachIoredisErrorHandler=e.attachIoredisErrorHandler,exports.InstrumentedQueryResultCache=r.InstrumentedQueryResultCache,exports.LruQueryResultCache=t.LruQueryResultCache;
+"use strict";var e=require("./attachIoredisErrorHandler.js"),r=require("./buildCacheFromEnv.js"),u=require("./InstrumentedQueryResultCache.js"),t=require("./LruQueryResultCache.js");exports.attachIoredisErrorHandler=e.attachIoredisErrorHandler,exports.buildCacheFromEnv=r.buildCacheFromEnv,exports.InstrumentedQueryResultCache=u.InstrumentedQueryResultCache,exports.LruQueryResultCache=t.LruQueryResultCache;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spytecgps/nova-orm",
-  "version": "1.4.241",
+  "version": "1.4.242",
   "description": "ORM with PlanetScale",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/schema.sql

@@ -1,6 +1,6 @@
--- nova-orm-schema-checksum: 6c149c8020575fbb21298a8ec3655fcd
+-- nova-orm-schema-checksum: bdf84e9724e3cf6c308f89f1c1871778
 -- Nova ORM Schema Dump
--- Generated at: 2026-05-24T13:19:09.208Z
+-- Generated at: 2026-05-24T15:55:45.644Z
 
 SET FOREIGN_KEY_CHECKS = 0;