fix: require zod input type from getFreshValue

when using schema validation

Author: Xiphe

src/cachified.spec.ts

@@ -294,7 +294,8 @@ describe('cachified', () => {
       cache,
       key: 'test-2',
       checkValue: z.string(),
-      getFreshValue() {
+      /* manually setting unknown here leaves the type-checking to zod during runtime */
+      getFreshValue(): unknown {
         /* pretend API returns an unexpected value */
         return 1;
       },
@@ -326,19 +327,19 @@ describe('cachified', () => {
       cachified({
         cache,
         key: 'test',
-        checkValue: z.string().transform((s) => s.toUpperCase()),
+        checkValue: z.string().transform((s) => parseInt(s, 10)),
         getFreshValue() {
-          return 'one';
+          return '123';
         },
       });
 
-    expect(await getValue()).toBe('ONE');
+    expect(await getValue()).toBe(123);
 
     /* Stores original value in cache */
-    expect(cache.get('test')?.value).toBe('one');
+    expect(cache.get('test')?.value).toBe('123');
 
     /* Gets transformed value from cache */
-    expect(await getValue()).toBe('ONE');
+    expect(await getValue()).toBe(123);
   });
 
   it('supports migrating cached values', async () => {

src/cachified.ts

@@ -14,8 +14,8 @@ import { shouldRefresh } from './shouldRefresh';
 // Keys are unique per cache but may be used by multiple caches
 const pendingValuesByCache = new WeakMap<Cache, Map<string, any>>();
 
-export async function cachified<Value>(
-  options: CachifiedOptionsWithSchema<Value>,
+export async function cachified<Value, InternalValue>(
+  options: CachifiedOptionsWithSchema<Value, InternalValue>,
 ): Promise<Value>;
 export async function cachified<Value>(
   options: CachifiedOptions<Value>,

src/common.ts

@@ -55,7 +55,8 @@ export type CheckValue<Value> = (
   value: unknown,
   migrate: (value: Value, updateCache?: boolean) => MigratedValue<Value>,
 ) => ValueCheckResult<Value> | Promise<ValueCheckResult<Value>>;
-export interface Schema<Value> {
+export interface Schema<Value, InputValue> {
+  _input: InputValue;
   parseAsync(value: unknown): Promise<Value>;
 }
 
@@ -126,7 +127,7 @@ export interface CachifiedOptions<Value> {
    *
    * @type {function(): boolean | undefined | string | MigratedValue} Optional, default makes no value check
    */
-  checkValue?: CheckValue<Value> | Schema<Value>;
+  checkValue?: CheckValue<Value> | Schema<Value, unknown>;
   /**
    * Set true to not even try reading the currently cached value
    *
@@ -163,12 +164,12 @@ export interface CachifiedOptions<Value> {
 }
 /* When using a schema validator, a strongly typed getFreshValue is not required
    and sometimes even sub-optimal */
-export type CachifiedOptionsWithSchema<Value> = Omit<
+export type CachifiedOptionsWithSchema<Value, InternalValue> = Omit<
   CachifiedOptions<Value>,
   'checkValue' | 'getFreshValue'
 > & {
-  checkValue: Schema<Value>;
-  getFreshValue: GetFreshValue<unknown>;
+  checkValue: Schema<Value, InternalValue>;
+  getFreshValue: GetFreshValue<InternalValue>;
 };
 
 export interface Context<Value>