All files / shared/src/types/middleware cache.ts

100% Statements 21/21
100% Branches 2/2
100% Functions 0/0
100% Lines 21/21

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 761x   1x 1x 1x 1x     1x 1x 1x 1x       1x 1x 1x 1x 1x 1x 1x                                 1x 1x 1x 1x 1x                                                                  
import { z } from 'zod';
 
export enum CacheMode {
  DISABLED = 'disabled',
  SIMPLE = 'simple',
  SEMANTIC = 'semantic',
}
 
export const CacheSettings = z.object({
  mode: z.enum(CacheMode),
  max_age: z.number().default(604800).optional(),
});
 
export type CacheSettings = z.infer<typeof CacheSettings>;
 
export enum CacheStatus {
  HIT = 'HIT',
  SEMANTIC_HIT = 'SEMANTIC_HIT',
  MISS = 'MISS',
  SEMANTIC_MISS = 'SEMANTIC_MISS',
  REFRESH = 'REFRESH',
  DISABLED = 'DISABLED',
}
 
export interface FinalCacheSettings {
  mode: CacheMode;
  maxAge: number;
  status: CacheStatus;
}
 
export interface CacheHandlerResult {
  response?: Response;
  status: CacheStatus;
  createdAt: Date;
  executionTime: number;
  key?: string;
}
 
export const CachedValue = z.object({
  key: z.string(),
  value: z.string(),
  expires_at: z.string(),
});
 
export type CachedValue = z.infer<typeof CachedValue>;
 
export interface CacheQueryParams {
  key: string;
  expires_at: string;
}
 
// Key and value are only present if status is HIT
export type GetFromCacheResult =
  | {
      status: CacheStatus.HIT;
      key: string;
      value: string;
    }
  | {
      status: CacheStatus.SEMANTIC_HIT;
      key: string;
      value: string;
    }
  | {
      status: CacheStatus.MISS;
    }
  | {
      status: CacheStatus.SEMANTIC_MISS;
    }
  | {
      status: CacheStatus.DISABLED;
    }
  | {
      status: CacheStatus.REFRESH;
    };