@fjell/core 4.4.42 → 4.4.44

package/dist/index.js

@@ -413,7 +413,7 @@ var AItemService = class {
 
 // src/item/ItemQuery.ts
 var isCondition = (condition) => {
-  return (typeof condition.column === "string" && (Array.isArray(condition.value) && condition.value.every((item) => typeof item === "string")) || Array.isArray(condition.value) && condition.value.every((item) => typeof item === "number") || typeof condition.value === "string" || typeof condition.value === "number" || typeof condition.value === "boolean" || condition.value instanceof Date) && (condition.operator ? typeof condition.operator === "string" : true);
+  return (typeof condition.column === "string" && (Array.isArray(condition.value) && condition.value.every((item) => typeof item === "string")) || Array.isArray(condition.value) && condition.value.every((item) => typeof item === "number") || typeof condition.value === "string" || typeof condition.value === "number" || typeof condition.value === "boolean" || condition.value instanceof Date || condition.value === null) && (condition.operator ? typeof condition.operator === "string" : true);
 };
 
 // src/item/IQFactory.ts
@@ -477,7 +477,7 @@ var IQFactory = class _IQFactory {
       this.query.refs = {};
     }
     const refName = name || kt;
-    this.query.refs[refName] = cPK(pk, kt);
+    this.query.refs[refName] = { key: cPK(pk, kt) };
     return this;
   }
   condition(column, value, operator = "==") {
@@ -596,7 +596,10 @@ var paramsToQuery = (params) => {
 var isRefQueryMatch = (refKey, queryRef, references) => {
   logger3.trace("doesRefMatch", { queryRef, references });
   logger3.debug("Comparing Ref", { refKey, itemRef: references[refKey], queryRef });
-  return isItemKeyEqual(queryRef, references[refKey]);
+  if (!references[refKey]) {
+    return false;
+  }
+  return isItemKeyEqual(queryRef, references[refKey].key);
 };
 var isCompoundConditionQueryMatch = (queryCondition, item) => {
   if (queryCondition.compoundType === "AND") {
@@ -617,6 +620,17 @@ var isConditionQueryMatch = (queryCondition, item) => {
     return false;
   }
   logger3.debug("Comparing Condition", { propKey, itemProp: item[propKey], queryCondition });
+  if (queryCondition.value === null) {
+    if (queryCondition.operator === "==") {
+      return item[propKey] === null;
+    } else if (queryCondition.operator === "!=") {
+      return item[propKey] !== null;
+    } else {
+      throw new Error(
+        `Operator ${queryCondition.operator} cannot be used with null value. Use '==' for null checks or '!=' for not-null checks.`
+      );
+    }
+  }
   let result = false;
   switch (queryCondition.operator) {
     case "==":
@@ -655,6 +669,9 @@ var isConditionQueryMatch = (queryCondition, item) => {
 var isAggQueryMatch = (aggKey, aggQuery, agg) => {
   const aggItem = agg.item;
   logger3.debug("Comparing Agg", { aggKey, aggItem, aggQuery });
+  if (!aggItem) {
+    return false;
+  }
   return isQueryMatch(aggItem, aggQuery);
 };
 var isEventQueryMatch = (eventKey, eventQuery, item) => {
@@ -684,7 +701,7 @@ var isQueryMatch = (item, query) => {
   if (query.refs && item.refs) {
     for (const key in query.refs) {
       const queryRef = query.refs[key];
-      if (!isRefQueryMatch(key, queryRef, item.refs)) return false;
+      if (!isRefQueryMatch(key, queryRef.key, item.refs)) return false;
     }
   } else if (query.refs && !item.refs) {
     logger3.debug("Query contains refs but item does not have refs", { query, item });
@@ -703,10 +720,20 @@ var isQueryMatch = (item, query) => {
   if (query.aggs && item.aggs) {
     for (const key in query.aggs) {
       const aggQuery = query.aggs[key];
-      if (item.aggs[key] && !isAggQueryMatch(key, aggQuery, item.aggs[key])) return false;
+      if (item.aggs[key]) {
+        let hasMatch = false;
+        for (const aggRecord of item.aggs[key]) {
+          if (isAggQueryMatch(key, aggQuery, aggRecord)) {
+            hasMatch = true;
+            break;
+          }
+        }
+        if (!hasMatch) return false;
+      } else {
+        return false;
+      }
     }
-  }
-  if (query.aggs && !item.aggs) {
+  } else if (query.aggs && !item.aggs) {
     logger3.debug("Query contains aggs but item does not have aggs", { query, item });
     return false;
   }
@@ -747,11 +774,11 @@ var abbrevQuery = (query) => {
   return abbrev.join(" ");
 };
 var abbrevRef = (key, ref) => {
-  if (isPriKey(ref)) {
-    const priKey = ref;
+  if (isPriKey(ref.key)) {
+    const priKey = ref.key;
     return `R(${key},${priKey.kt},${priKey.pk})`;
   } else {
-    const comKey = ref;
+    const comKey = ref.key;
     return `R(${key},${JSON.stringify(comKey)})`;
   }
 };

package/dist/item/IQFactory.d.ts

@@ -9,7 +9,7 @@ export declare class IQFactory {
     limit(limit: number): this;
     offset(offset: number): this;
     pk(kt: string, pk: string, name?: string): this;
-    condition(column: string, value: string[] | string | number[] | number | boolean | Date, operator?: ConditionOperator): this;
+    condition(column: string, value: string[] | string | number[] | number | boolean | Date | null, operator?: ConditionOperator): this;
     static all(): IQFactory;
     static orderBy(field: string, direction?: OrderDirection): IQFactory;
     static agg(name: string, query: ItemQuery): IQFactory;
@@ -17,7 +17,7 @@ export declare class IQFactory {
     static limit(limit: number): IQFactory;
     static offset(offset: number): IQFactory;
     static pk(kt: string, pk: string, name?: string): IQFactory;
-    static condition(column: string, value: string[] | string | number[] | number | boolean | Date, operator?: ConditionOperator): IQFactory;
+    static condition(column: string, value: string[] | string | number[] | number | boolean | Date | null, operator?: ConditionOperator): IQFactory;
     static conditions(conditions: Condition[], compoundType?: CompoundType): IQFactory;
     toQuery(): ItemQuery;
 }

package/dist/item/IQUtils.d.ts

@@ -1,5 +1,4 @@
-import { Item } from "../items";
-import { ComKey, PriKey } from "../keys";
+import { Item, Reference } from "../items";
 import { CompoundCondition, Condition, ItemQuery, QueryParams } from "./ItemQuery";
 /**
  * When we query or search, we're sending a GET request.  This converts everything in ItemQuery into a flat
@@ -29,7 +28,7 @@ export declare const queryToParams: (query: ItemQuery) => QueryParams;
 export declare const paramsToQuery: (params: QueryParams) => ItemQuery;
 export declare const isQueryMatch: <S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never>(item: Item<S, L1, L2, L3, L4, L5>, query: ItemQuery) => boolean;
 export declare const abbrevQuery: (query: ItemQuery | null | undefined) => string;
-export declare const abbrevRef: <S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never>(key: string, ref: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>) => string;
+export declare const abbrevRef: <S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never>(key: string, ref: Reference<S, L1, L2, L3, L4, L5>) => string;
 export declare const abbrevAgg: (key: string, agg: ItemQuery) => string;
 export declare const abbrevCompoundCondition: (compoundCondition: CompoundCondition) => string;
 export declare const abbrevCondition: (condition: Condition | CompoundCondition) => string;

package/dist/item/ItemQuery.d.ts

@@ -10,7 +10,7 @@ export type ConditionOperator = '==' | '!=' | '>' | '>=' | '<' | '<=' | 'in' | '
  */
 export type Condition = {
     column: string;
-    value: string[] | string | number[] | number | boolean | Date;
+    value: string[] | string | number[] | number | boolean | Date | null;
     operator: ConditionOperator;
 };
 /**

package/dist/items.d.ts

@@ -29,16 +29,20 @@ export interface Deletable extends Partial<Evented> {
     deleted: ItemEvent;
 }
 export type ManagedEvents = Timestamped & Deletable;
-export type References = Record<string, ComKey<string, string | never, string | never, string | never, string | never, string | never> | PriKey<string>>;
-export type ReferenceItem<S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never> = {
+export type Reference<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>;
-    item: Item<S, L1, L2, L3, L4, L5>;
+    item?: Item<S, L1, L2, L3, L4, L5>;
+};
+export type ReferenceItem<S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never> = Reference<S, L1, L2, L3, L4, L5>;
+export type References = Record<string, Reference<any, any, any, any, any, any>>;
+export type Aggregation<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>;
+    item?: Item<S, L1, L2, L3, L4, L5>;
 };
-export type ReferenceItems = Record<string, ReferenceItem<string, string | never, string | never, string | never, string | never, string | never>>;
 export interface Item<S extends string = never, L1 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> {
     events: ManagedEvents & Evented;
-    aggs?: ReferenceItems;
-    refs?: References;
+    aggs?: Record<string, Aggregation<any, any, any, any, any, any>[]>;
+    refs?: Record<string, Reference<any, any, any, any, any, any>>;
     [key: string]: any;
 }
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fjell/core",
   "description": "Core Item and Key Framework for Fjell",
-  "version": "4.4.42",
+  "version": "4.4.44",
   "keywords": [
     "core",
     "fjell"

package/src/item/IQFactory.ts

@@ -82,13 +82,13 @@ export class IQFactory {
       this.query.refs = {};
     }
     const refName = name || kt;
-    this.query.refs[refName] = cPK<string>(pk, kt);
+    this.query.refs[refName] = { key: cPK<string>(pk, kt) };
     return this;
   }
 
   public condition(
     column: string,
-    value: string[] | string | number[] | number | boolean | Date,
+    value: string[] | string | number[] | number | boolean | Date | null,
     operator: ConditionOperator = '==',
   ) {
     const condition: Condition = { column, value, operator };
@@ -145,7 +145,7 @@ export class IQFactory {
 
   public static condition(
     column: string,
-    value: string[] | string | number[] | number | boolean | Date,
+    value: string[] | string | number[] | number | boolean | Date | null,
     operator: ConditionOperator = '=='
   ) {
     const iqFactory = new IQFactory();

package/src/item/IQUtils.ts

@@ -1,4 +1,4 @@
-import { Item, ReferenceItem, References } from "../items";
+import { Item, Reference, ReferenceItem, References } from "../items";
 import { isItemKeyEqual, isPriKey } from "../key/KUtils";
 import { ComKey, PriKey } from "../keys";
 import LibLogger from "../logger";
@@ -103,7 +103,10 @@ const isRefQueryMatch =
   ): boolean => {
     logger.trace('doesRefMatch', { queryRef, references });
     logger.debug('Comparing Ref', { refKey, itemRef: references[refKey], queryRef });
-    return isItemKeyEqual(queryRef, references[refKey]);
+    if (!references[refKey]) {
+      return false;
+    }
+    return isItemKeyEqual(queryRef, references[refKey].key);
   }
 
 const isCompoundConditionQueryMatch = <
@@ -155,6 +158,20 @@ const isConditionQueryMatch = <
     return false;
   }
   logger.debug('Comparing Condition', { propKey, itemProp: item[propKey], queryCondition });
+  
+  // Handle null values - only == and != make sense with null
+  if (queryCondition.value === null) {
+    if (queryCondition.operator === '==') {
+      return item[propKey] === null;
+    } else if (queryCondition.operator === '!=') {
+      return item[propKey] !== null;
+    } else {
+      throw new Error(
+        `Operator ${queryCondition.operator} cannot be used with null value. Use '==' for null checks or '!=' for not-null checks.`
+      );
+    }
+  }
+  
   let result = false;
   switch (queryCondition.operator) {
     case '==':
@@ -207,6 +224,9 @@ const isAggQueryMatch = <
   const aggItem = agg.item;
   logger.debug('Comparing Agg', { aggKey, aggItem, aggQuery });
   // Fancy, right?  This is a recursive call to isQueryMatch
+  if (!aggItem) {
+    return false;
+  }
   return isQueryMatch(aggItem, aggQuery);
 }
 
@@ -257,7 +277,7 @@ export const isQueryMatch = <
   if (query.refs && item.refs) {
     for (const key in query.refs) {
       const queryRef = query.refs[key];
-      if (!isRefQueryMatch(key, queryRef, item.refs)) return false;
+      if (!isRefQueryMatch(key, queryRef.key, item.refs)) return false;
     }
   } else if (query.refs && !item.refs) {
     logger.debug('Query contains refs but item does not have refs', { query, item });
@@ -279,9 +299,21 @@ export const isQueryMatch = <
   if (query.aggs && item.aggs) {
     for (const key in query.aggs) {
       const aggQuery = query.aggs[key];
-      if (item.aggs[key] && !isAggQueryMatch(key, aggQuery, item.aggs[key])) return false;
+      // aggs is a record where each key maps to an array of aggregations
+      if (item.aggs[key]) {
+        let hasMatch = false;
+        for (const aggRecord of item.aggs[key]) {
+          if (isAggQueryMatch(key, aggQuery, aggRecord as ReferenceItem<any, any, any, any, any, any>)) {
+            hasMatch = true;
+            break;
+          }
+        }
+        if (!hasMatch) return false;
+      } else {
+        return false;
+      }
     }
-  } if (query.aggs && !item.aggs) {
+  } else if (query.aggs && !item.aggs) {
     logger.debug('Query contains aggs but item does not have aggs', { query, item });
     return false;
   }
@@ -332,12 +364,12 @@ export const abbrevRef = <
   L3 extends string = never,
   L4 extends string = never,
   L5 extends string = never
->(key: string, ref: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>): string => {
-  if (isPriKey(ref)) {
-    const priKey = ref as PriKey<S>;
+>(key: string, ref: Reference<S, L1, L2, L3, L4, L5>): string => {
+  if (isPriKey(ref.key)) {
+    const priKey = ref.key as PriKey<S>;
     return `R(${key},${priKey.kt},${priKey.pk})`;
   } else {
-    const comKey = ref as ComKey<S, L1, L2, L3, L4, L5>;
+    const comKey = ref.key as ComKey<S, L1, L2, L3, L4, L5>;
     return `R(${key},${JSON.stringify(comKey)})`;
   }
 }

package/src/item/ItemQuery.ts

@@ -14,7 +14,7 @@ export type ConditionOperator =
  */
 export type Condition = {
   column: string,
-  value: string[] | string | number[] | number | boolean | Date,
+  value: string[] | string | number[] | number | boolean | Date | null,
   operator: ConditionOperator,
 };
 
@@ -55,7 +55,8 @@ export const isCondition = (condition: any): condition is Condition => {
     typeof condition.value === 'string' ||
     typeof condition.value === 'number' ||
     typeof condition.value === 'boolean' ||
-    condition.value instanceof Date
+    condition.value instanceof Date ||
+    condition.value === null
   ) && (condition.operator ? typeof condition.operator === 'string' : true);
 }
 

package/src/items.ts

@@ -46,23 +46,32 @@ export interface Deletable extends Partial<Evented> {
 
 export type ManagedEvents = Timestamped & Deletable;
 
-export type References = Record<
-  string,
-  ComKey<string, string | never, string | never, string | never, string | never, string | never> |
-  PriKey<string>
->;
+export type Reference<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>, item?: Item<S, L1, L2, L3, L4, L5> };
 
-export type ReferenceItem<
-  S extends string,
+export type ReferenceItem<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>, item: Item<S, L1, L2, L3, L4, L5> };
+> = Reference<S, L1, L2, L3, L4, L5>;
+
+export type References = Record<string, Reference<any, any, any, any, any, any>>;
 
-export type ReferenceItems = Record<
-  string, ReferenceItem<string, string | never, string | never, string | never, string | never, string | never>>;
+export type Aggregation<
+  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>, item?: Item<S, L1, L2, L3, L4, L5> };
 
 export interface Item<S extends string = never,
   L1 extends string = never,
@@ -72,8 +81,8 @@ export interface Item<S extends string = never,
   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;
+  aggs?: Record<string, Aggregation<any, any, any, any, any, any>[]>;
+  refs?: Record<string, Reference<any, any, any, any, any, any>>;
   [key: string]: any
 }