@fjell/core 4.4.49 → 4.4.51

package/src/key/KUtils.ts

@@ -1,484 +0,0 @@
-/* eslint-disable no-undefined */
-import {
-  ComKey,
-  LocKey,
-  LocKeyArray,
-  PriKey
-} from "../keys";
-
-import LibLogger from "../logger";
-
-const logger = LibLogger.get('KUtils');
-
-// Normalize a key value to string for consistent comparison and hashing
-const normalizeKeyValue = (value: string | number): string => {
-  return String(value);
-};
-
-// Normalized hash function for Dictionary that converts pk/lk values to strings
-export const createNormalizedHashFunction = <T>() => {
-  return (key: T): string => {
-    if (typeof key === 'object' && key !== null) {
-      // Create a normalized version of the key with string values
-      const normalizedKey = JSON.parse(JSON.stringify(key));
-
-      // Normalize pk values
-      if ('pk' in normalizedKey && (normalizedKey.pk !== undefined && normalizedKey.pk !== null)) {
-        normalizedKey.pk = normalizeKeyValue(normalizedKey.pk);
-      }
-
-      // Normalize lk values
-      if ('lk' in normalizedKey && (normalizedKey.lk !== undefined && normalizedKey.lk !== null)) {
-        normalizedKey.lk = normalizeKeyValue(normalizedKey.lk);
-      }
-
-      // Normalize loc array lk values
-      if ('loc' in normalizedKey && Array.isArray(normalizedKey.loc)) {
-        normalizedKey.loc = normalizedKey.loc.map((locItem: any) => {
-          if (locItem && 'lk' in locItem && (locItem.lk !== undefined && locItem.lk !== null)) {
-            return { ...locItem, lk: normalizeKeyValue(locItem.lk) };
-          }
-          return locItem;
-        });
-      }
-
-      return JSON.stringify(normalizedKey);
-    }
-    return JSON.stringify(key);
-  };
-};
-
-// Normalized comparison functions
-export const isPriKeyEqualNormalized = <
-  S extends string,
->(a: PriKey<S>, b: PriKey<S>): boolean => {
-  logger.trace('isPriKeyEqualNormalized', { a, b });
-  return a && b &&
-    normalizeKeyValue(a.pk) === normalizeKeyValue(b.pk) &&
-    a.kt === b.kt;
-};
-
-export const isLocKeyEqualNormalized = <
-  L1 extends string,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(a: LocKey<L1 | L2 | L3 | L4 | L5>, b: LocKey<L1 | L2 | L3 | L4 | L5>): boolean => {
-  logger.trace('isLocKeyEqualNormalized', { a, b });
-  return a && b &&
-    normalizeKeyValue(a.lk) === normalizeKeyValue(b.lk) &&
-    a.kt === b.kt;
-};
-
-export const isComKeyEqualNormalized = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(a: ComKey<S, L1, L2, L3, L4, L5>, b: ComKey<S, L1, L2, L3, L4, L5>): boolean => {
-  logger.trace('isComKeyEqualNormalized', { a, b });
-  if (a && b && isPriKeyEqualNormalized({ kt: a.kt, pk: a.pk } as PriKey<S>, { kt: b.kt, pk: b.pk } as PriKey<S>)) {
-    if (a.loc.length === b.loc.length) {
-      for (let i = 0; i < a.loc.length; i++) {
-        if (!isLocKeyEqualNormalized<L1, L2, L3, L4, L5>(a.loc[i], b.loc[i])) {
-          return false;
-        }
-      }
-      return true;
-    } else {
-      return false;
-    }
-  } else {
-    return false;
-  }
-};
-
-export const isItemKeyEqualNormalized = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(a: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>, b: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>): boolean => {
-  logger.trace('isItemKeyEqualNormalized', { a, b });
-  if (isComKey(a) && isComKey(b)) {
-    return isComKeyEqualNormalized(a as ComKey<S, L1, L2, L3, L4, L5>, b as ComKey<S, L1, L2, L3, L4, L5>);
-  } else if (isPriKey(a) && isPriKey(b)) {
-    if (isComKey(a) || isComKey(b)) {
-      return false;
-    } else {
-      return isPriKeyEqualNormalized(a as PriKey<S>, b as PriKey<S>);
-    }
-  } else {
-    return false;
-  }
-};
-
-// Original comparison functions (kept for backward compatibility)
-export const isItemKeyEqual = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(a: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>, b: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>): boolean => {
-  logger.trace('isKeyEqual', { a, b });
-  if (isComKey(a) && isComKey(b)) {
-    return isComKeyEqual(a as ComKey<S, L1, L2, L3, L4, L5>, b as ComKey<S, L1, L2, L3, L4, L5>);
-  } else if (isPriKey(a) && isPriKey(b)) {
-    if (isComKey(a) || isComKey(b)) {
-      return false;
-    } else {
-      return isPriKeyEqual(a as PriKey<S>, b as PriKey<S>);
-    }
-  } else {
-    return false;
-  }
-};
-
-export const isPriKeyEqual = <
-  S extends string,
->(a: PriKey<S>, b: PriKey<S>): boolean => {
-  logger.trace('isPriKeyEqual', { a, b });
-  return a && b && a.pk === b.pk && a.kt === b.kt;
-}
-
-export const isLocKeyEqual = <
-  L1 extends string,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(a: LocKey<L1 | L2 | L3 | L4 | L5>, b: LocKey<L1 | L2 | L3 | L4 | L5>): boolean => {
-  logger.trace('isLocKeyEqual', { a, b });
-  return a && b && a.lk === b.lk && a.kt === b.kt;
-}
-
-export const isComKeyEqual = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(a: ComKey<S, L1, L2, L3, L4, L5>, b: ComKey<S, L1, L2, L3, L4, L5>): boolean => {
-  logger.trace('isComKeyEqual', { a, b });
-  if (a && b && isPriKeyEqual({ kt: a.kt, pk: a.pk } as PriKey<S>, { kt: b.kt, pk: b.pk } as PriKey<S>)) {
-    if (a.loc.length === b.loc.length) {
-      for (let i = 0; i < a.loc.length; i++) {
-        if (!isLocKeyEqual<L1, L2, L3, L4, L5>(a.loc[i], b.loc[i])) {
-          return false;
-        }
-      }
-      return true;
-    } else {
-      return false;
-    }
-  } else {
-    return false;
-  }
-}
-
-export const isItemKey = (key: any): boolean => {
-  logger.trace('isItemKey', { key });
-  return key !== undefined && (isComKey(key) || isPriKey(key));
-}
-
-export const isComKey = (key: any): boolean => {
-  logger.trace('isComKey', { key });
-  return key !== undefined &&
-    (key.pk !== undefined && key.kt !== undefined) && (key.loc !== undefined && Array.isArray(key.loc));
-}
-
-export const isPriKey = (key: any): boolean => {
-  logger.trace('isPriKey', { key });
-  return key !== undefined &&
-    (key.pk !== undefined && key.kt !== undefined) && (key.loc === undefined);
-}
-
-export const isLocKey = (key: any): boolean => {
-  logger.trace('isLocKey', { key });
-  return key !== undefined && (key.lk !== undefined && key.kt !== undefined);
-}
-
-export const generateKeyArray = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never,
->(key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S> | LocKeyArray<L1, L2, L3, L4, L5> | []):
-  Array<PriKey<S> | LocKey<L1 | L2 | L3 | L4 | L5>> => {
-  logger.trace('generateKeyArray', { key });
-  const keys: Array<PriKey<S> | LocKey<L1 | L2 | L3 | L4 | L5>> = [];
-
-  if (isComKey(key) || isPriKey(key)) {
-    // console.log('it is an item key');
-    if (isComKey(key)) {
-      //  console.log('it is a composite key');
-      const comKey = key as ComKey<S, L1, L2, L3, L4, L5>;
-      keys.push({ pk: comKey.pk, kt: comKey.kt });
-      for (let i = 0; i < comKey.loc.length; i++) {
-        keys.push(comKey.loc[i]);
-      }
-    } else {
-      keys.push(key as PriKey<S>);
-    }
-  } else {
-    // console.log('is is an array, length: ' + key.length);
-    const locKeys = key as LocKey<L1 | L2 | L3 | L4 | L5>[];
-    for (let i = 0; i < locKeys.length; i++) {
-      // console.log('Pushing a key');
-      keys.push(locKeys[i]);
-    }
-  }
-  return keys;
-}
-
-// TODO: Exactly the same as in ContainedItemLib
-export const constructPriKey = <S extends string>(
-  pk: string | number | PriKey<S>,
-  kt: S,
-) => {
-  logger.trace('constructPriKey', { pk, kt });
-  let pri: PriKey<S>;
-  if (typeof pk === 'string' || typeof pk === 'number') {
-    pri = { kt: kt as S, pk: pk };
-  } else {
-    pri = pk;
-  }
-  return pri;
-}
-
-// TODO: Exactly the same as in ContainedItemLib
-export const cPK = constructPriKey;
-
-export const toKeyTypeArray = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>):
-  string[] => {
-  logger.trace('toKeyTypeArray', { ik });
-  if (isComKey(ik)) {
-    const ck = ik as ComKey<S, L1, L2, L3, L4, L5>;
-    return [ck.kt, ...ck.loc.map((l: LocKey<L1 | L2 | L3 | L4 | L5>) => l.kt)];
-  } else {
-    return [(ik as PriKey<S>).kt];
-  }
-}
-
-/**
- * Extracts key type arrays from any key type (PriKey, ComKey, or LocKeyArray)
- * This is useful for cache invalidation and registry lookups
- */
-export const extractKeyTypeArray = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S> | LocKeyArray<L1, L2, L3, L4, L5>):
-  string[] => {
-  logger.trace('extractKeyTypeArray', { key });
-
-  if (isComKey(key)) {
-    const ck = key as ComKey<S, L1, L2, L3, L4, L5>;
-    return [ck.kt, ...ck.loc.map((l: LocKey<L1 | L2 | L3 | L4 | L5>) => l.kt)];
-  } else if (isPriKey(key)) {
-    return [(key as PriKey<S>).kt];
-  } else if (Array.isArray(key)) {
-    // This is a LocKeyArray
-    return key.map(locKey => locKey.kt);
-  } else {
-    logger.warning('extractKeyTypeArray: Unknown key type', { key });
-    return [];
-  }
-}
-
-export const abbrevIK = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>): string => {
-  logger.trace('abbrevIK', { ik });
-  if (ik) {
-    if (isComKey(ik)) {
-      const ck = ik as ComKey<S, L1, L2, L3, L4, L5>;
-      return `${ck.kt}:${ck.pk}:${ck.loc.map((l: LocKey<L1 | L2 | L3 | L4 | L5>) => `${l.kt}:${l.lk}`).join(',')}`;
-    } else {
-      return `${(ik as PriKey<S>).kt}:${(ik as PriKey<S>).pk}`;
-    }
-  } else {
-    return 'null IK';
-  }
-}
-
-export const abbrevLKA = <
-  L1 extends string,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(keyArray: Array<LocKey<L1 | L2 | L3 | L4 | L5>> | null): string => {
-  logger.trace('abbrevLKA', { keyArray });
-  if (keyArray === undefined || keyArray === null) {
-    return 'null LKA';
-  } else {
-    return keyArray.map(key => {
-      if (key) {
-        return `${key.kt}:${key.lk}`;
-      } else {
-        return key;
-      }
-    }).join(',');
-  }
-}
-
-export const primaryType = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>): string => {
-  logger.trace('primaryType', { ik });
-  if (isComKey(ik)) {
-    return (ik as ComKey<S, L1, L2, L3, L4, L5>).kt;
-  } else {
-    return (ik as PriKey<S>).kt;
-  }
-}
-
-/**
-   *
-   * @param ik ItemKey to be used as a basis for a location
-   * @returns
-   */
-export const itemKeyToLocKeyArray =
-  <
-    S extends string,
-    L1 extends string = never,
-    L2 extends string = never,
-    L3 extends string = never,
-    L4 extends string = never,
-    L5 extends string = never
-  >(ik: PriKey<S> | ComKey<S, L1, L2, L3, L4, L5>): LocKeyArray<S, L1, L2, L3, L4> => {
-    logger.trace('itemKeyToLocKeyArray', { ik: abbrevIK(ik) });
-    let lka: Array<LocKey<L1 | L2 | L3 | L4 | L5>> = [];
-    if (isComKey(ik)) {
-      const ck = ik as ComKey<S, L1, L2, L3, L4, L5>;
-      // For composite keys, return only the parent location keys (ck.loc)
-      // Location arrays are ordered child-to-parent per KTA hierarchy: ['child', 'parent', 'grandparent']
-      // This is used for aggregation queries where we want to find sibling items at the same location
-      lka = [...ck.loc];
-    } else {
-      const pk = ik as PriKey<S>;
-      lka = [{ kt: pk.kt, lk: pk.pk } as unknown as LocKey<L1 | L2 | L3 | L4 | L5>];
-    }
-    logger.trace('itemKeyToLocKeyArray Results', { ik: abbrevIK(ik), lka: abbrevLKA(lka) });
-    return lka as LocKeyArray<S, L1, L2, L3, L4>;
-  }
-
-export const ikToLKA = itemKeyToLocKeyArray;
-
-/**
-   * Sometimes you need to take a location key array and convert it to the item key that points to the containing item.
-   * @param lka A location key array
-   * @returns An item key corresponding to the containing item this location refers to.
-   */
-export const locKeyArrayToItemKey =
-  <
-    L1 extends string,
-    L2 extends string = never,
-    L3 extends string = never,
-    L4 extends string = never,
-    L5 extends string = never
-  >(lka: LocKeyArray<L1, L2, L3, L4, L5>):
-    PriKey<L1> | ComKey<L1, L2, L3, L4, L5> => {
-    logger.trace('locKeyArrayToItemKey', { lka: abbrevLKA(lka as Array<LocKey<L1 | L2 | L3 | L4 | L5>>) });
-
-    if (lka && lka.length === 1) {
-      const priKey = cPK(lka[0].lk, lka[0].kt);
-      return priKey as PriKey<L1>;
-    } else if (lka && lka.length > 1 && lka[0] !== undefined) {
-      const locs = lka.slice(1);
-      const priKey = cPK(lka[0].lk, lka[0].kt);
-      const comKey = { kt: priKey.kt, pk: priKey.pk, loc: locs as unknown as LocKeyArray<L2, L3, L4, L5> };
-      return comKey as ComKey<L1, L2, L3, L4, L5>;
-    } else {
-      throw new Error('locKeyArrayToItemKey: lka is undefined or empty');
-    }
-  }
-
-// TODO: This is annoying that we have to check for '' and 'null'
-export const isValidPriKey = <S extends string>(key: PriKey<S>): boolean => {
-  const valid = (key !== undefined && key !== null)
-    && (key.pk !== undefined && key.pk !== null && key.pk !== '' && key.pk !== 'null')
-    && (key.kt !== undefined && key.kt !== null && key.kt !== '' && key.kt !== 'null');
-  return valid;
-}
-
-// TODO: This is annoying that we have to check for '' and 'null'
-export const isValidLocKey = <
-  L1 extends string,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(key: LocKey<L1 | L2 | L3 | L4 | L5>): boolean => {
-  const valid = (key !== undefined && key !== null)
-    && (key.lk !== undefined && key.lk !== null && key.lk !== '' && key.lk !== 'null')
-    && (key.kt !== undefined && key.kt !== null && key.kt !== '' && key.kt !== 'null');
-  return valid;
-}
-
-export const isValidLocKeyArray = <
-  L1 extends string,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(keyArray: Array<LocKey<L1 | L2 | L3 | L4 | L5>>): boolean => {
-  return (keyArray !== undefined && keyArray !== null) && keyArray.every(isValidLocKey);
-}
-
-export const isValidComKey = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(key: ComKey<S, L1, L2, L3, L4, L5>): boolean => {
-  return (key !== undefined
-    && key !== null) && isValidPriKey(key) && isValidLocKeyArray(key.loc as Array<LocKey<L1 | L2 | L3 | L4 | L5>>);
-}
-
-export const isValidItemKey = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>): boolean => {
-  return (isComKey(key) &&
-    isValidComKey(key as ComKey<S, L1, L2, L3, L4, L5>)) || (isPriKey(key) && isValidPriKey(key as PriKey<S>));
-}
-
-export const lkaToIK = locKeyArrayToItemKey;

package/src/keys.ts

@@ -1,95 +0,0 @@
-
-export type UUID = `${string}-${string}-${string}-${string}-${string}`;
-
-export interface ComKey<
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
-> {
-  readonly kt: S,
-  readonly pk: UUID | string | number,
-  readonly loc: LocKeyArray<L1, L2, L3, L4, L5>
-};
-
-export interface PriKey<
-  S extends string,
-> {
-  readonly kt: S,
-  readonly pk: UUID | string | number,
-};
-
-export interface LocKey<
-  L extends string
-> {
-  readonly kt: L,
-  readonly lk: UUID | string | number
-};
-export type LocKeyArray<
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
-> =
-  ([L5] extends [never] ?
-    ([L4] extends [never] ?
-      ([L3] extends [never] ?
-        ([L2] extends [never] ?
-          ([L1] extends [never] ?
-            [] | never :
-            [LocKey<L1>]) :
-          [LocKey<L1>, LocKey<L2>]) :
-        [LocKey<L1>, LocKey<L2>, LocKey<L3>]) :
-      [LocKey<L1>, LocKey<L2>, LocKey<L3>, LocKey<L4>]) :
-    [LocKey<L1>, LocKey<L2>, LocKey<L3>, LocKey<L4>, LocKey<L5>]);
-
-export type ItemTypeArray<
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never,
-> =
-([L5] extends [never] ?
-  ([L4] extends [never] ?
-    ([L3] extends [never] ?
-      ([L2] extends [never] ?
-        ([L1] extends [never] ?
-          [S] :
-          [S, L1]) :
-        [S, L1, L2]) :
-      [S, L1, L2, L3]) :
-    [S, L1, L2, L3, L4]) :
-  [S, L1, L2, L3, L4, L5]);
-
-export type AllItemTypeArrays<
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never,
-> = readonly [S] |
-  readonly [S, L1] |
-  readonly [S, L1, L2] |
-  readonly [S, L1, L2, L3] |
-  readonly [S, L1, L2, L3, L4] |
-  readonly [S, L1, L2, L3, L4, L5];
-
-export type AllLocTypeArrays<
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never,
-> = readonly [] |
-  readonly [L1] |
-  readonly [L1, L2] |
-  readonly [L1, L2, L3] |
-  readonly [L1, L2, L3, L4] |
-  readonly [L1, L2, L3, L4, L5];
-

package/src/logger.ts

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

package/src/operations/OperationContext.ts

@@ -1,12 +0,0 @@
-import { ComKey, LocKeyArray, PriKey } from '../keys';
-import type { ErrorInfo } from '../errors/ActionError';
-
-export interface OperationContext {
-  itemType: string;
-  operationType: ErrorInfo['operation']['type'];
-  operationName: string;
-  params: Record<string, any>;
-  key?: PriKey<any> | ComKey<any, any, any, any, any, any>;
-  locations?: LocKeyArray<any, any, any, any, any>;
-}
-