@fjell/cache 4.6.4 → 4.6.7

package/src/Cache.ts

@@ -1,428 +0,0 @@
-import {
-  AllItemTypeArrays,
-  ComKey,
-  isItemKeyEqual,
-  isValidItemKey,
-  Item,
-  ItemQuery,
-  LocKeyArray,
-  PriKey,
-  validatePK
-} from "@fjell/core";
-import { CacheMap } from "./CacheMap";
-import LibLogger from "./logger";
-
-import { ClientApi } from "@fjell/client-api";
-import { NotFoundError } from "@fjell/http-api";
-
-const logger = LibLogger.get('Cache');
-
-export interface Cache<
-  V extends Item<S, L1, L2, L3, L4, L5>,
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
-> {
-
-  all: (
-    query?: ItemQuery,
-    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
-  ) =>
-    Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V[]]>,
-
-  one: (
-    query?: ItemQuery,
-    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
-  ) => Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V | null]>
-
-  action: (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-    action: string,
-    body?: any,
-  ) => Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]>
-
-  allAction: (
-    action: string,
-    body?: any,
-    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
-  ) => Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V[]]>
-
-  allFacet: (
-    facet: string,
-    params?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
-    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
-  ) => Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, any]>;
-
-  create: (
-    item: Partial<Item<S, L1, L2, L3, L4, L5>>,
-    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
-  ) => Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]>;
-
-  get: (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-  ) => Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V | null]>;
-
-  retrieve: (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-  ) => Promise<[CacheMap<V, S, L1, L2, L3, L4, L5> | null, V | null]>;
-
-  remove: (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-  ) => Promise<CacheMap<V, S, L1, L2, L3, L4, L5>>;
-
-  update: (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-    item: Partial<Item<S, L1, L2, L3, L4, L5>>,
-  ) => Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]>;
-
-  facet: (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-    facet: string,
-    params?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
-  ) => Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, any]>;
-
-  find: (
-    finder: string,
-    params?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
-    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
-  ) => Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V[]]>;
-
-  findOne: (
-    finder: string,
-    params?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
-    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
-  ) => Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]>;
-
-  set: (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-    item: Item<S, L1, L2, L3, L4, L5>
-  ) => Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]>;
-
-  reset: () => Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>]>;
-
-  pkTypes: AllItemTypeArrays<S, L1, L2, L3, L4, L5>;
-
-  cacheMap: CacheMap<V, S, L1, L2, L3, L4, L5>;
-}
-
-export const createCache = async <
-  V extends Item<S, L1, L2, L3, L4, L5>,
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(
-  api: ClientApi<V, S, L1, L2, L3, L4, L5>,
-  pkType: S,
-  parentCache?: Cache<Item<L1, L2, L3, L4, L5>, L1, L2, L3, L4, L5>
-): Promise<Cache<V, S, L1, L2, L3, L4, L5>> => {
-
-  let pkTypes: AllItemTypeArrays<S, L1, L2, L3, L4, L5> = [pkType];
-  if (parentCache) {
-    pkTypes = pkTypes.concat(parentCache.pkTypes as any) as unknown as AllItemTypeArrays<S, L1, L2, L3, L4, L5>;
-  }
-
-  let cacheMap: CacheMap<V, S, L1, L2, L3, L4, L5> =
-    new CacheMap<V, S, L1, L2, L3, L4, L5>(pkTypes as AllItemTypeArrays<S, L1, L2, L3, L4, L5>);
-
-  const all = async (
-    query: ItemQuery = {},
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
-  ):
-    Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V[]]> => {
-    logger.default('all', { query, locations });
-    let ret: V[] = [];
-    try {
-      ret = await api.all(query, locations);
-      ret.forEach((v) => {
-        cacheMap.set(v.key, v);
-      });
-    } catch (e: unknown) {
-      if (e instanceof NotFoundError) {
-      } else {
-        throw e;
-      }
-
-    }
-    return [cacheMap, validatePK(ret, pkType) as V[]];
-  }
-
-  const one = async (
-    query: ItemQuery = {},
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
-  ):
-    Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V | null]> => {
-    logger.default('one', { query, locations });
-
-    let retItem: V | null = null;
-    try {
-      retItem = await api.one(query, locations);
-      if (retItem) {
-        cacheMap.set(retItem.key, retItem);
-      }
-    } catch (e: unknown) {
-      if (e instanceof NotFoundError) {
-      } else {
-        throw e;
-      }
-
-    }
-    return [
-      cacheMap,
-      retItem ?
-        validatePK(retItem, pkType) as V :
-        null
-    ];
-  }
-
-  const action = async (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-    action: string,
-    body: any = {},
-  ): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]> => {
-    logger.default('action', { key, action, body });
-
-    // TODO: This is validating the key, but it doesn't have knowledge of the pkType
-    // This should be looking at the parentCaches and calculating an array of pkTypes
-    if (!isValidItemKey(key)) {
-      logger.error('Key for Action is not a valid ItemKey: %j', key);
-      throw new Error('Key for Action is not a valid ItemKey');
-    }
-
-    const updated = await api.action(key, action, body);
-    cacheMap.set(updated.key, updated);
-    return [cacheMap, validatePK(updated, pkType) as V];
-  }
-
-  const allAction = async (
-    action: string,
-    body: any = {},
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
-  ): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V[]]> => {
-    logger.default('allAction', { action, body, locations });
-    let ret: V[] = [];
-    try {
-      ret = await api.allAction(action, body, locations);
-      ret.forEach((v) => {
-        cacheMap.set(v.key, v);
-      });
-    } catch (e: unknown) {
-      // istanbul ignore next
-      if (e instanceof NotFoundError) {
-      } else {
-        throw e;
-      }
-
-    }
-    return [cacheMap, validatePK(ret, pkType) as V[]];
-  }
-
-  const allFacet = async (
-    facet: string,
-    params: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>> = {},
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
-  ): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, any]> => {
-    logger.default('allFacet', { facet, params, locations });
-    const ret = await api.allFacet(facet, params, locations);
-    return [cacheMap, ret];
-  }
-
-  const create = async (
-    v: Partial<Item<S, L1, L2, L3, L4, L5>>,
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
-  ): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]> => {
-    logger.default('create', { v, locations });
-    const created = await api.create(v, locations);
-    cacheMap.set(created.key, created);
-    return [cacheMap, validatePK(created, pkType) as V];
-  }
-
-  const get = async (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-  ): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V | null]> => {
-    logger.default('get', { key });
-    // TODO: This is validating the key, but it doesn't have knowledge of the pkType
-    // This should be looking at the parentCaches and calculating an array of pkTypes
-    if (!isValidItemKey(key)) {
-      logger.error('Key for Get is not a valid ItemKey: %j', key);
-      throw new Error('Key for Get is not a valid ItemKey');
-    }
-    let ret: V | null;
-    try {
-      ret = await api.get(key);
-      if (ret) {
-        cacheMap.set(ret.key, ret);
-      }
-    } catch (e: any) {
-      logger.error("Error getting item for key", { key, message: e.message, stack: e.stack });
-      throw e;
-    }
-    return [
-      cacheMap,
-      ret ?
-        validatePK(ret, pkType) as V :
-        null
-    ];
-  }
-
-  const retrieve = async (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-  ): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5> | null, V | null]> => {
-    logger.default('retrieve', { key });
-    if (!isValidItemKey(key)) {
-      logger.error('Key for Retrieve is not a valid ItemKey: %j', key);
-      throw new Error('Key for Retrieve is not a valid ItemKey');
-    }
-    const containsItemKey = cacheMap.includesKey(key);
-
-    let retrieved: V | null;
-    if (containsItemKey) {
-      logger.default('Looking for Object in Cache', key);
-      retrieved = cacheMap.get(key);
-    } else {
-      logger.default('Object Not Found in Cache, Retrieving from Server API', { key });
-      [, retrieved] = await get(key);
-    }
-    const retValue: [CacheMap<V, S, L1, L2, L3, L4, L5> | null, V | null] = [
-      containsItemKey ? null : cacheMap,
-      retrieved ?
-        validatePK(retrieved, pkType) as V :
-        null
-    ];
-    // logger.debug('Returning from retrieve', { retValue });
-    return retValue;
-  }
-
-  const remove = async (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-  ): Promise<CacheMap<V, S, L1, L2, L3, L4, L5>> => {
-    logger.default('remove', { key });
-    // TODO: This is validating the key, but it doesn't have knowledge of the pkType
-    // This should be looking at the parentCaches and calculating an array of pkTypes
-    if (!isValidItemKey(key)) {
-      logger.error('Key for Remove is not a valid ItemKey: %j', key);
-      throw new Error('Key for Remove is not a valid ItemKey');
-    }
-    try {
-      await api.remove(key);
-      cacheMap.delete(key);
-    } catch (e) {
-      logger.error("Error deleting item", { error: e });
-      throw e;
-    }
-    return cacheMap;
-  }
-
-  const update = async (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-    v: Partial<Item<S, L1, L2, L3, L4, L5>>,
-  ): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]> => {
-    logger.default('update', { key, v });
-
-    // TODO: This is validating the key, but it doesn't have knowledge of the pkType
-    // This should be looking at the parentCaches and calculating an array of pkTypes
-    if (!isValidItemKey(key)) {
-      logger.error('Key for Update is not a valid ItemKey: %j', key);
-      throw new Error('Key for Update is not a valid ItemKey');
-    }
-
-    try {
-      const updated = await api.update(key, v);
-      cacheMap.set(updated.key, updated);
-      return [cacheMap, validatePK(updated, pkType) as V];
-    } catch (e) {
-      logger.error("Error updating chat", { error: e });
-      throw e;
-    }
-  }
-
-  // Facets are a pass-thru for caches
-  const facet = async (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-    facet: string,
-    params: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>> = {},
-  ): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, any]> => {
-    logger.default('facet', { key, facet });
-    const ret = await api.facet(key, facet, params);
-    return [cacheMap, ret];
-  }
-
-  const find = async (
-    finder: string,
-    params: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>> = {},
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
-  ): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V[]]> => {
-    logger.default('find', { finder, params, locations });
-    const ret: V[] = await api.find(finder, params, locations);
-    ret.forEach((v) => {
-      cacheMap.set(v.key, v);
-    });
-    return [cacheMap, validatePK(ret, pkType) as V[]];
-  }
-
-  const findOne = async (
-    finder: string,
-    finderParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>> = {},
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
-  ): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]> => {
-    logger.default('findOne', { finder, finderParams, locations });
-    const ret = await api.findOne(finder, finderParams, locations);
-    cacheMap.set(ret.key, ret);
-    return [cacheMap, validatePK(ret, pkType) as V];
-  }
-
-  const reset = async (): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>]> => {
-    cacheMap = new CacheMap<V, S, L1, L2, L3, L4, L5>(pkTypes);
-    return [cacheMap];
-  }
-
-  const set = async (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-    v: Item<S, L1, L2, L3, L4, L5>
-  ): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]> => {
-    logger.default('set', { key, v });
-
-    // TODO: This is validating the key, but it doesn't have knowledge of the pkType
-    // This should be looking at the parentCaches and calculating an array of pkTypes
-    if (!isValidItemKey(key)) {
-      logger.error('Key for Update is not a valid ItemKey: %j', key);
-      throw new Error('Key for Update is not a valid ItemKey');
-    }
-
-    // TODO: This could be merged with the isValidItemKey check, later.
-    validatePK(v, pkType);
-
-    if (!isItemKeyEqual(key, v.key)) {
-      logger.error('Key does not match item key: %j != %j', key, v.key);
-      throw new Error('Key does not match item key');
-    }
-
-    cacheMap.set(key, v as V);
-    return [cacheMap, validatePK(v, pkType) as V];
-  }
-
-  return {
-    all,
-    one,
-    action,
-    allAction,
-    allFacet,
-    create,
-    get,
-    retrieve,
-    remove,
-    update,
-    facet,
-    find,
-    findOne,
-    reset,
-    set,
-    pkTypes,
-    cacheMap
-  }
-}

package/src/CacheMap.ts

@@ -1,132 +0,0 @@
-import {
-  AllItemTypeArrays,
-  ComKey,
-  Dictionary,
-  isComKey,
-  isQueryMatch,
-  Item,
-  ItemQuery,
-  LocKeyArray,
-  PriKey
-} from "@fjell/core";
-import LibLogger from "./logger";
-
-const logger = LibLogger.get("CacheMap");
-
-// const isObj = (x: any) => typeof x === "object" && x !== null;
-
-// const intersection = (a: object, b: object): object => {
-//   const result: { [key: string]: any } = {}
-
-//   if (([a, b]).every(isObj)) {
-//     Object.keys(a).forEach((key) => {
-//       // @ts-ignore
-//       const value = a[key]
-//       // @ts-ignore
-//       const other = b[key]
-
-//       if (isObj(value)) {
-//         result[key] = intersection(value, other)
-//       } else if (value === other) {
-//         result[key] = value
-//       }
-//     })
-//   }
-
-//   return result
-// }
-
-// const removeEmptyObjects = (obj: object): object => {
-//   const result: { [key: string]: any } = {}
-
-//   Object.keys(obj).forEach((key) => {
-//     // @ts-ignore
-//     const value = obj[key];
-
-//     if (isObj(value)) {
-//       const nested = removeEmptyObjects(value);
-
-//       if (Object.keys(nested).length > 0) {
-//         result[key] = nested
-//       }
-//     } else if (value !== null) {
-//       result[key] = value
-//     }
-//   });
-
-//   return result;
-// }
-
-export class CacheMap<
-  V extends Item<S, L1, L2, L3, L4, L5>,
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
-> extends Dictionary<ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>, V> {
-
-  private types: AllItemTypeArrays<S, L1, L2, L3, L4, L5>;
-
-  public constructor(
-    types: AllItemTypeArrays<S, L1, L2, L3, L4, L5>,
-    map?: { [key: string]: V },
-  ) {
-    super(map);
-    this.types = types;
-  }
-
-  public get(
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-  ): V | null {
-    return super.get(key) as V | null;
-  }
-
-  public allIn(
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | []
-  ): V[] {
-    if (locations.length === 0) {
-      logger.debug('Returning all items, LocKeys is empty');
-      return this.values();
-    } else {
-      const locKeys: LocKeyArray<L1, L2, L3, L4, L5> | [] = locations;
-      logger.debug('allIn', { locKeys, keys: this.keys().length });
-      return this.keys()
-        .filter((key) => key && isComKey(key))
-        .filter((key) => {
-          const ComKey = key as ComKey<S, L1, L2, L3, L4, L5>;
-          logger.debug('Comparing Location Keys', {
-            locKeys,
-            ComKey,
-          });
-          return JSON.stringify(locKeys) === JSON.stringify(ComKey.loc);
-        })
-        .map((key) => this.get(key) as V);
-    }
-  }
-
-  // TODO: Can we do case insensitive matching?
-  public contains(query: ItemQuery, locations: LocKeyArray<L1, L2, L3, L4, L5> | []): boolean {
-    logger.debug('contains', { query, locations });
-    const items = this.allIn(locations);
-
-    return items.some((item) => isQueryMatch(item, query));
-  }
-
-  public queryIn(
-    query: ItemQuery,
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
-  ): V[] {
-    logger.debug('queryIn', { query, locations });
-    const items = this.allIn(locations);
-
-    return items.filter((item) => isQueryMatch(item, query));
-  }
-
-  public clone(): CacheMap<V, S, L1, L2, L3, L4, L5> {
-    const clone = new CacheMap<V, S, L1, L2, L3, L4, L5>(this.types, this.map);
-    return clone;
-  }
-
-};

package/src/CacheRegistry.ts

@@ -1,66 +0,0 @@
-import { Item } from "@fjell/core";
-import { Cache } from "./Cache";
-import LibLogger from './logger';
-
-const logger = LibLogger.get('CacheRegistry');
-
-export class CacheRegistry {
-
-  private static instance: CacheRegistry;
-
-  public constructor() {
-    logger.debug('CacheRegistry instance created');
-  }
-
-  // TODO: My use of Generics has Boxed me into a corner where I can't reference AbstractCache without the types
-  private cacheMap: { [kt: string]: any } = {};
-
-  public registerCache = async <
-    S extends string,
-    L1 extends string = never,
-    L2 extends string = never,
-    L3 extends string = never,
-    L4 extends string = never,
-    L5 extends string = never
-  >(cache: Cache<Item<S, L1, L2, L3, L4, L5>, S, L1, L2, L3, L4, L5>): Promise<void> => {
-    try {
-      logger.debug('Attempting to register cache with pkTypes:', cache.pkTypes);
-      const key = JSON.stringify(cache.pkTypes);
-      if (this.cacheMap[key]) {
-        logger.debug(`Cache with pkTypes ${key} already exists, will be overwritten`);
-      }
-      this.cacheMap[key] = cache;
-      logger.debug('Cache registered successfully with key:', key);
-    } catch (error) {
-      logger.error('Failed to register cache:', error);
-      throw error;
-    }
-  };
-
-  public getCache = (kts: string[]): any => {
-    logger.debug('Attempting to get cache for key types:', kts);
-    
-    const key = JSON.stringify(kts);
-    logger.debug('Looking up cache with key:', key);
-    
-    const cache = this.cacheMap[key];
-    if (!cache) {
-      logger.warning(`No cache found for key types: ${key}`);
-    }
-    return cache;
-  };
-
-  public printRegisteredCaches = (): void => {
-    logger.debug('Printing all registered caches:');
-    const cacheCount = Object.keys(this.cacheMap).length;
-    logger.debug(`Total number of registered caches: ${cacheCount}`);
-    
-    if (cacheCount === 0) {
-      logger.debug('No caches are currently registered');
-    }
-    
-    Object.entries(this.cacheMap).forEach(([keyTypes]) => {
-      logger.debug(`Cache with key types: ${keyTypes}`);
-    });
-  };
-}

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from './Aggregator';
-export * from './Cache';
-export * from './CacheMap';
-export * from './CacheRegistry';

package/src/logger.ts

@@ -1,5 +0,0 @@
-import Logging from '@fjell/logging';
-
-const LibLogger = Logging.getLogger('@fjell/cache');
-
-export default LibLogger;