@fjell/core 4.4.3 → 4.4.5

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fjell/core",
   "description": "Core Items for Fjell",
-  "version": "4.4.3",
+  "version": "4.4.5",
   "license": "Apache-2.0",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -14,30 +14,30 @@
   },
   "type": "module",
   "dependencies": {
-    "@fjell/logging": "^4.4.2",
+    "@fjell/logging": "^4.4.4",
     "deepmerge": "^4.3.1",
     "flatted": "^3.3.3",
     "luxon": "^3.6.1"
   },
   "devDependencies": {
     "@eslint/eslintrc": "^3.3.1",
-    "@eslint/js": "^9.29.0",
-    "@swc/core": "^1.12.1",
-    "@tsconfig/recommended": "^1.0.9",
+    "@eslint/js": "^9.30.0",
+    "@swc/core": "^1.12.7",
+    "@tsconfig/recommended": "^1.0.10",
     "@types/luxon": "^3.6.2",
-    "@typescript-eslint/eslint-plugin": "^8.34.1",
-    "@typescript-eslint/parser": "^8.34.1",
-    "@vitest/coverage-v8": "3.1.4",
-    "concurrently": "^9.1.2",
+    "@typescript-eslint/eslint-plugin": "^8.35.0",
+    "@typescript-eslint/parser": "^8.35.0",
+    "@vitest/coverage-v8": "3.2.4",
+    "concurrently": "^9.2.0",
     "copyfiles": "^2.4.1",
-    "eslint": "^9.29.0",
+    "eslint": "^9.30.0",
     "rimraf": "^6.0.1",
     "tsc-alias": "^1.8.16",
     "typescript": "^5.8.3",
-    "vite": "^6.3.5",
+    "vite": "^7.0.0",
     "vite-plugin-dts": "^4.5.4",
     "vite-plugin-node": "^5.0.1",
-    "vitest": "3.1.4"
+    "vitest": "3.2.4"
   },
   "repository": {
     "type": "git",

package/src/item/IUtils.ts

@@ -1,3 +1,5 @@
+/* eslint-disable indent */
+/* eslint-disable max-len */
 import { Item } from "@/items";
 import { isComKey, isPriKey, toKeyTypeArray } from "@/key/KUtils";
 import { AllItemTypeArrays, ComKey, PriKey } from "@/keys";
@@ -6,42 +8,48 @@ import LibLogger from '@/logger';
 
 const logger = LibLogger.get('IUtils');
 
-export const validatePK = <
+const validatePKForItem = <
   S extends string,
   L1 extends string = never,
   L2 extends string = never,
   L3 extends string = never,
   L4 extends string = never,
-  L5 extends string = never
->(input: Item<S, L1, L2, L3, L4, L5> | Item<S, L1, L2, L3, L4, L5>[], pkType: S):
-  Item<S, L1, L2, L3, L4, L5> | Item<S, L1, L2, L3, L4, L5>[] => {
+  L5 extends string = never,
+>(item: Item<S, L1, L2, L3, L4, L5>, pkType: S): Item<S, L1, L2, L3, L4, L5> => {
+  if (!item) {
+    logger.error('Validating PK, Item is undefined', { item });
+    throw new Error('Validating PK, Item is undefined');
+  }
+  if (!item.key) {
+    logger.error('Validating PK, Item does not have a key', { item });
+    throw new Error('Validating PK, Item does not have a key');
+  }
 
+  const keyTypeArray = toKeyTypeArray(item.key as ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>);
+  if (keyTypeArray[0] !== pkType) {
+    logger.error('Key Type Array Mismatch', { keyTypeArray, pkType });
+    throw new Error(`Item does not have the correct primary key type. Expected ${pkType}, got ${keyTypeArray[0]}`);
+  }
+  return item;
+};
+
+export const validatePK = <
+  S extends string,
+  L1 extends string = never,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never,
+>(
+  input: Item<S, L1, L2, L3, L4, L5> | Item<S, L1, L2, L3, L4, L5>[],
+  pkType: S,
+): Item<S, L1, L2, L3, L4, L5> | Item<S, L1, L2, L3, L4, L5>[] => {
   logger.trace('Checking Return Type', { input });
 
   if (Array.isArray(input)) {
-    const itemArray = input as Item<S, L1, L2, L3, L4, L5>[];
-    return itemArray.map((item) => validatePK(item, pkType)) as Item<S, L1, L2, L3, L4, L5>[];
-  } else {
-    const item = input as Item<S, L1, L2, L3, L4, L5>;
-    if( item ) {
-      if (item.key) {
-        const keyTypeArray = toKeyTypeArray(item.key as ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>);
-        const match: boolean = keyTypeArray[0] === pkType;
-        if (!match) {
-          logger.error('Key Type Array Mismatch', { keyTypeArray, pkType });
-          throw new Error('Item does not have the correct primary key type');
-        } else {
-          return item;
-        }
-      } else {
-        logger.error('Validating PK, Item does not have a key', { item });
-        throw new Error('Validating PK, Item does not have a key');
-      }
-    } else {
-      logger.error('Validating PK, Item is undefined', { item });
-      throw new Error('Validating PK, Item is undefined');
-    }
+    return input.map((item) => validatePKForItem(item, pkType));
   }
+  return validatePKForItem(input, pkType);
 };
 
 export const validateKeys = <
@@ -50,30 +58,30 @@ export const validateKeys = <
   L2 extends string = never,
   L3 extends string = never,
   L4 extends string = never,
-  L5 extends string = never
->(item: Item<S, L1, L2, L3, L4, L5>, keyTypes: AllItemTypeArrays<S, L1, L2, L3, L4, L5>):
-  Item<S, L1, L2, L3, L4, L5> => {
+  L5 extends string = never,
+>(
+  item: Item<S, L1, L2, L3, L4, L5>,
+  keyTypes: AllItemTypeArrays<S, L1, L2, L3, L4, L5>,
+): Item<S, L1, L2, L3, L4, L5> => {
   logger.trace('Checking Return Type', { item });
-  if( item ) {
-    if (item.key) {
-      const keyTypeArray = toKeyTypeArray(item.key as ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>);
-      if (keyTypeArray.length !== keyTypes.length) {
-        throw new Error('Item does not have the correct number of keys');
-      } else {
-        const match: boolean = JSON.stringify(keyTypeArray) === JSON.stringify(keyTypes);
-        if (!match) {
-          logger.error('Key Type Array Mismatch', { keyTypeArray, thisKeyTypes: keyTypes });
-          throw new Error('Item does not have the correct key types');
-        } else {
-          return item;
-        }
-      }
-    } else {
-      throw new Error('validating keys, item does not have a key: ' + JSON.stringify(item));
-    }
-  } else {
+  if (!item) {
     throw new Error('validating keys, item is undefined');
   }
+  if (!item.key) {
+    throw new Error('validating keys, item does not have a key: ' + JSON.stringify(item));
+  }
+
+  const keyTypeArray = toKeyTypeArray(item.key as ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>);
+  if (keyTypeArray.length !== keyTypes.length) {
+    throw new Error(`Item does not have the correct number of keys. Expected ${keyTypes.length}, but got ${keyTypeArray.length}`);
+  }
+
+  const match: boolean = JSON.stringify(keyTypeArray) === JSON.stringify(keyTypes);
+  if (!match) {
+    logger.error('Key Type Array Mismatch', { keyTypeArray, thisKeyTypes: keyTypes });
+    throw new Error(`Item does not have the correct key types. Expected [${keyTypes.join(', ')}], but got [${keyTypeArray.join(', ')}]`);
+  }
+  return item;
 };
 
 export const isPriItem = <
@@ -82,10 +90,12 @@ export const isPriItem = <
   L2 extends string = never,
   L3 extends string = never,
   L4 extends string = never,
-  L5 extends string = never
->(item: Item<S, L1, L2, L3, L4, L5>): item is Item<S, L1, L2, L3, L4, L5> => {
-  return (item && item.key) ? isPriKey(item.key as PriKey<S>) : false;
-}
+  L5 extends string = never,
+>(
+  item: Item<S, L1, L2, L3, L4, L5>,
+): item is Item<S> & { key: PriKey<S> } => {
+  return !!(item && item.key && isPriKey(item.key));
+};
 
 export const isComItem = <
   S extends string,
@@ -93,7 +103,9 @@ export const isComItem = <
   L2 extends string = never,
   L3 extends string = never,
   L4 extends string = never,
-  L5 extends string = never
->(item: Item<S, L1, L2, L3, L4, L5>): item is Item<S, L1, L2, L3, L4, L5> => {
-  return (item && item.key) ? isComKey(item.key as ComKey<S, L1, L2, L3, L4, L5>) : false;
-}
+  L5 extends string = never,
+>(
+  item: Item<S, L1, L2, L3, L4, L5>,
+): item is Item<S, L1, L2, L3, L4, L5> & { key: ComKey<S, L1, L2, L3, L4, L5> } => {
+  return !!(item && item.key && isComKey(item.key));
+};

package/src/items.ts

@@ -16,8 +16,6 @@ export type Identified<S extends string,
     key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>;
   };
 
-export type Propertied = { [key: string]: any };
-
 /**
  * This is a generic item event, and it's designed to make sure we have the ability to define not just
  * the required fields, but also the optional fields.
@@ -48,29 +46,6 @@ export interface Deletable extends Partial<Evented> {
 
 export type ManagedEvents = Timestamped & Deletable;
 
-export type ItemProperties<
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never> =
-  Omit<Item<S, L1, L2, L3, L4, L5>, 'events' | 'key'> & {
-    events?: Evented;
-  };
-
-export type TypesProperties<
-  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> =
-  Omit<V, 'events' | 'key'> & {
-    events?: Evented;
-  };
-
 export type References = Record<
   string,
   ComKey<string, string | never, string | never, string | never, string | never, string | never> |
@@ -94,9 +69,43 @@ export interface Item<S extends string = never,
   L2 extends string = never,
   L3 extends string = never,
   L4 extends string = never,
-  L5 extends string = never> extends Identified<S, L1, L2, L3, L4, L5>, Propertied {
+  L5 extends string = never> extends Identified<S, L1, L2, L3, L4, L5> {
   events: ManagedEvents & Evented;
   // TODO: This is a bit of a hack to get around the fact that we don't want to pass all these generics
   aggs?: ReferenceItems;
   refs?: References;
+  [key: string]: any
 }
+
+/**
+ * Interface for properties that can be added to items
+ */
+export interface Propertied {
+  name: string;
+  value: number;
+}
+
+/**
+ * Type for item properties without the key - equivalent to Partial<Item> without the key
+ */
+export type ItemProperties<
+  S extends string = never,
+  L1 extends string = never,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never
+> = Partial<Omit<Item<S, L1, L2, L3, L4, L5>, 'key'>>;
+
+/**
+ * Type for item properties without the key - equivalent to Partial<Item> without the key
+ * This is an alias for ItemProperties for backward compatibility
+ */
+export type TypesProperties<
+  S extends string = never,
+  L1 extends string = never,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never
+> = Partial<Omit<Item<S, L1, L2, L3, L4, L5>, 'key'>>;

package/src/key/KUtils.ts

@@ -23,7 +23,7 @@ export const isItemKeyEqual = <
   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)) {
+    if (isComKey(a) || isComKey(b)) {
       return false;
     } else {
       return isPriKeyEqual(a as PriKey<S>, b as PriKey<S>);
@@ -163,7 +163,7 @@ export const toKeyTypeArray = <
   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)];
+    return [ck.kt, ...ck.loc.map((l: LocKey<L1 | L2 | L3 | L4 | L5>) => l.kt)];
   } else {
     return [(ik as PriKey<S>).kt];
   }
@@ -178,10 +178,10 @@ export const abbrevIK = <
   L5 extends string = never
 >(ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>): string => {
   logger.trace('abbrevIK', { ik });
-  if(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(',')}`;
+      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}`;
     }
@@ -228,10 +228,10 @@ export const primaryType = <
 }
 
 /**
- *
- * @param ik ItemKey to be used as a basis for a location
- * @returns
- */
+   *
+   * @param ik ItemKey to be used as a basis for a location
+   * @returns
+   */
 export const itemKeyToLocKeyArray =
   <
     S extends string,
@@ -257,10 +257,10 @@ export const itemKeyToLocKeyArray =
 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.
- */
+   * 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,
@@ -272,7 +272,7 @@ export const locKeyArrayToItemKey =
     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) {
+    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) {

package/vitest.config.ts

@@ -1,5 +1,5 @@
 import { defineConfig } from 'vitest/config';
-import path from 'path';
+import * as path from 'path';
 
 export default defineConfig({
   resolve: {