@fjell/core 4.4.49 → 4.4.51

package/src/item/IQUtils.ts

@@ -1,392 +0,0 @@
-import { Item, Reference, ReferenceItem, References } from "../items";
-import { isItemKeyEqual, isPriKey } from "../key/KUtils";
-import { ComKey, PriKey } from "../keys";
-import LibLogger from "../logger";
-import * as luxon from 'luxon';
-import { CompoundCondition, Condition, EventQuery, isCondition, ItemQuery, QueryParams } from "./ItemQuery";
-
-const logger = LibLogger.get('IQUtils');
-
-/**
- * When we query or search, we're sending a GET request.  This converts everything in ItemQuery into a flat
- * object that can be sent over a GET request.
- *
- * Note that there is some discussion about this.  Evidently Elastic supports search with POST, but that also
- * feels like a bit of a hack. It's not a RESTful way to do things.  So we're sticking with GET for now.
- *
- * For reference, look at RFC 9110 "HTTP Semantics", June which clarified on top of and RFC 7231.  It's possible
- * but there are so many caveats and conditions in the standard, it's not worth it.
- *
- * Anticipating the next question - "isn't there a limit to the length of a URL?"   The specification does not
- * specify a limit, and there are limits in various browsers and servers - Apache is 4,000 chars, Chrome is 2M chars.
- * Short answer is that if this query is being used to craft something that complex, it is probably a better idea
- * to provide an action or a custom query endpoint on the server.
- *
- * @param query
- * @returns QueryParams ready to be get over a GET request.
- */
-export const queryToParams = (query: ItemQuery): QueryParams => {
-  const params: QueryParams = {};
-  if (query.compoundCondition) {
-    params.compoundCondition = JSON.stringify(query.compoundCondition);
-  }
-  if (query.refs) {
-    params.refs = JSON.stringify(query.refs);
-  }
-  if (query.limit) {
-    params.limit = query.limit;
-  }
-  if (query.offset) {
-    params.offset = query.offset;
-  }
-  if (query.aggs) {
-    params.aggs = JSON.stringify(query.aggs);
-  }
-  if (query.events) {
-    params.events = JSON.stringify(query.events);
-  }
-  return params;
-}
-
-// This is a dateTimeReviver used for JSON parse - when we convert a param back to a query, we need this.
-const dateTimeReviver = function (key: string, value: string) {
-  if (typeof value === 'string') {
-    const parsedDate = luxon.DateTime.fromISO(value);
-    if (parsedDate.isValid) {
-      return parsedDate.toJSDate();;
-    }
-  }
-  return value;
-}
-
-/**
- * This method translates from a flat QueryParams object with stringify'd JSON back to a full ItemQuery.
- *
- * @param params Parameters sent over a GET request
- * @returns A fully hydrated ItemQuery object.
- */
-export const paramsToQuery = (params: QueryParams): ItemQuery => {
-  const query: ItemQuery = {};
-  if (params.compoundCondition) {
-    query.compoundCondition = JSON.parse(params.compoundCondition as string) as CompoundCondition;
-  }
-  if (params.refs) {
-    query.refs = JSON.parse(params.refs as string) as References;
-  }
-  if (params.limit) {
-    query.limit = Number(params.limit);
-  }
-  if (params.offset) {
-    query.offset = Number(params.offset);
-  }
-  if (params.aggs) {
-    query.aggs = JSON.parse(params.aggs as string) as Record<string, ItemQuery>;
-  }
-  if (params.events) {
-    query.events = JSON.parse(params.events as string, dateTimeReviver) as Record<string, { start?: Date, end?: Date }>;
-  }
-  return query;
-}
-
-const isRefQueryMatch =
-  <
-    S extends string,
-    L1 extends string = never,
-    L2 extends string = never,
-    L3 extends string = never,
-    L4 extends string = never,
-    L5 extends string = never
-  >(
-    refKey: string,
-    queryRef: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-    references: References,
-  ): boolean => {
-    logger.trace('doesRefMatch', { queryRef, references });
-    logger.debug('Comparing Ref', { refKey, itemRef: references[refKey], queryRef });
-    if (!references[refKey]) {
-      return false;
-    }
-    return isItemKeyEqual(queryRef, references[refKey].key);
-  }
-
-const isCompoundConditionQueryMatch = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(
-    queryCondition: CompoundCondition,
-    item: Item<S, L1, L2, L3, L4, L5>,
-  ): boolean => {
-  if (queryCondition.compoundType === 'AND') {
-    // If this is an AND compound condition, we need to check if all of the conditions match
-    return queryCondition.conditions.every(
-      (condition: Condition | CompoundCondition) =>
-        isCondition(condition) ?
-          isConditionQueryMatch(condition, item) :
-          isCompoundConditionQueryMatch(condition, item)
-    );
-  } else {
-    // If this is an OR compound condition, we need to check if any of the conditions match
-    return queryCondition.conditions.some(
-      (condition: Condition | CompoundCondition) =>
-        isCondition(condition) ?
-          isConditionQueryMatch(condition, item) :
-          isCompoundConditionQueryMatch(condition, item)
-    );
-  }
-}
-
-const isConditionQueryMatch = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(
-    queryCondition: Condition,
-    item: Item<S, L1, L2, L3, L4, L5>,
-  ): boolean => {
-  const propKey = queryCondition.column;
-  logger.trace('doesConditionMatch', { propKey, queryCondition, item });
-  // eslint-disable-next-line no-undefined
-  if (item[propKey] === undefined) {
-    logger.debug('Item does not contain prop under key', { propKey, item });
-    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 '==':
-      result = item[propKey] === queryCondition.value;
-      break;
-    case '!=':
-      result = item[propKey] !== queryCondition.value;
-      break;
-    case '>':
-      result = item[propKey] > queryCondition.value;
-      break;
-    case '>=':
-      result = item[propKey] >= queryCondition.value;
-      break;
-    case '<':
-      result = item[propKey] < queryCondition.value;
-      break;
-    case '<=':
-      result = item[propKey] <= queryCondition.value;
-      break;
-    case 'in':
-      result = (queryCondition.value as unknown as string[]).includes(item[propKey] as string);
-      break;
-    case 'not-in':
-      result = !(queryCondition.value as unknown as string[]).includes(item[propKey] as string);
-      break;
-    case 'array-contains':
-      result = (item[propKey] as unknown as string[]).includes(queryCondition.value as string);
-      break;
-    case 'array-contains-any':
-      result = (queryCondition.value as unknown as string[])
-        .some(value => (item[propKey] as unknown as string[]).includes(value));
-      break;
-  }
-  return result;
-}
-
-const isAggQueryMatch = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(
-    aggKey: string,
-    aggQuery: ItemQuery,
-    agg: ReferenceItem<S, L1, L2, L3, L4, L5>
-  ): boolean => {
-  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);
-}
-
-const isEventQueryMatch = <
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
->(
-    eventKey: string,
-    eventQuery: EventQuery,
-    item: Item<S, L1, L2, L3, L4, L5>,
-  ): boolean => {
-  if (!item.events[eventKey]) {
-    logger.debug('Item does not contain event under key', { eventKey, events: item.events });
-    return false;
-  } else {
-    const itemEvent = item.events[eventKey];
-    if (itemEvent.at !== null) {
-      if (eventQuery.start && !(eventQuery.start.getTime() <= itemEvent.at.getTime())) {
-        logger.debug('Item date before event start query', { eventQuery, itemEvent });
-        return false;
-      }
-      if (eventQuery.end && !(eventQuery.end.getTime() > itemEvent.at.getTime())) {
-        logger.debug('Item date after event end query', { eventQuery, itemEvent });
-        return false;
-      }
-    } else {
-      logger.debug('Item event does contains a null at', { itemEvent });
-      return false;
-    }
-    return true;
-  }
-}
-
-export 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 => {
-
-  logger.trace('isMatch', { item, query });
-  if (query.refs && item.refs) {
-    for (const key in query.refs) {
-      const queryRef = query.refs[key];
-      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 });
-    return false;
-  }
-
-  if (query.compoundCondition && item) {
-    if (!isCompoundConditionQueryMatch(query.compoundCondition, item)) return false;
-  }
-
-  if (query.events && item.events) {
-    for (const key in query.events) {
-      const queryEvent = query.events[key];
-      if (!isEventQueryMatch(key, queryEvent, item)) return false
-    }
-    return true;
-  }
-
-  if (query.aggs && item.aggs) {
-    for (const key in query.aggs) {
-      const aggQuery = query.aggs[key];
-      // 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;
-      }
-    }
-  } else if (query.aggs && !item.aggs) {
-    logger.debug('Query contains aggs but item does not have aggs', { query, item });
-    return false;
-  }
-
-  // If it hasn't returned false by now, it must be a match
-  return true;
-}
-
-export const abbrevQuery = (query: ItemQuery | null | undefined): string => {
-  const abbrev = ['IQ'];
-  if( query ) {
-    if (query.refs) {
-      for (const key in query.refs) {
-        const ref = abbrevRef(key, query.refs[key]);
-        abbrev.push(ref);
-      }
-    }
-    if (query.compoundCondition) {
-      const props = abbrevCompoundCondition(query.compoundCondition);
-      abbrev.push(props);
-    }
-    if (query.aggs) {
-      for (const key in query.aggs) {
-        const agg = abbrevAgg(key, query.aggs[key]);
-        abbrev.push(agg);
-      }
-    }
-    if (query.events) {
-      const events = `(E${Object.keys(query.events).join(',')})`;
-      abbrev.push(events);
-    }
-    if (query.limit) {
-      abbrev.push(`L${query.limit}`);
-    }
-    if (query.offset) {
-      abbrev.push(`O${query.offset}`);
-    }
-  } else {
-    abbrev.push('(empty)');
-  }
-  return abbrev.join(' ');
-}
-
-export 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 => {
-  if (isPriKey(ref.key)) {
-    const priKey = ref.key as PriKey<S>;
-    return `R(${key},${priKey.kt},${priKey.pk})`;
-  } else {
-    const comKey = ref.key as ComKey<S, L1, L2, L3, L4, L5>;
-    return `R(${key},${JSON.stringify(comKey)})`;
-  }
-}
-
-export const abbrevAgg = (key: string, agg: ItemQuery): string => {
-  return `A(${key},${abbrevQuery(agg)})`;
-}
-
-export const abbrevCompoundCondition = (compoundCondition: CompoundCondition): string => {
-  return `CC(${compoundCondition.compoundType},` +
-    `${compoundCondition.conditions ? compoundCondition.conditions.map(abbrevCondition).join(',') : 'No Conditions'})`;
-}
-
-export const abbrevCondition = (condition: Condition | CompoundCondition): string => {
-  if (isCondition(condition)) {
-    return `(${condition.column},${condition.value},${condition.operator})`;
-  } else {
-    return abbrevCompoundCondition(condition);
-  }
-}

package/src/item/IUtils.ts

@@ -1,40 +0,0 @@
-/* eslint-disable indent */
- 
-import { Item } from "../items";
-import { isComKey, isPriKey } from "../key/KUtils";
-import { ComKey, PriKey } from "../keys";
-
-/**
- * @deprecated Use validatePK from @fjell/core/validation instead
- * Re-exported for backward compatibility
- */
-export { validatePK, validateKeys } from '../validation/ItemValidator';
-
-// validatePK and validateKeys have been moved to ../validation/ItemValidator.ts
-// They are re-exported above for backward compatibility
-
-export const isPriItem = <
-  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>,
-): item is Item<S> & { key: PriKey<S> } => {
-  return !!(item && item.key && isPriKey(item.key));
-};
-
-export const isComItem = <
-  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>,
-): 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/item/ItemQuery.ts

@@ -1,88 +0,0 @@
-import { References } from '../items';
-
-export type QueryParams = Record<string, string | number | boolean | Date>;
-
-/**
- * The operator for a condition.  This is the same as the operators used in the Firestore query language.
- */
-export type ConditionOperator =
-  '==' | '!=' | '>' | '>=' | '<' | '<=' | 'in' | 'not-in' | 'array-contains' | 'array-contains-any';
-
-/**
- * A single property condition is defined with a column, value, and operator.
- * This is a condition that is used in a query.
- */
-export type Condition = {
-  column: string,
-  value: string[] | string | number[] | number | boolean | Date | null,
-  operator: ConditionOperator,
-};
-
-/**
- * When applying a compound condition, the CompoundType defines the type of compound condition.
- */
-export type CompoundType = 'AND' | 'OR';
-
-/**
- * When configuring a CompoundCondition this can contain a collection of conditions
- * that will be applied to the query.  By default, this is an AND conditiion that is associated
- * with an array of Condition objects OR an array of CompoundCondition objects.
- *
- * For example, I could have { compoundType: 'AND', conditions: [{column: 'name', value: 'test', operator: '=='},
- * {column: 'age', value: 21, operator: '>='}]} which would filter the query to only include items
- * where the name is 'test' and the age is greater than or equal to 21.
- *
- * Or, I could have a { compoundType: 'OR', conditions: [{column: 'name', value: 'test', operator: '=='},
- * {column: 'age', value: 21, operator: '>='}]} which would filter the query to only include items
- * where the name is 'test' OR the age is greater than or equal to 21.
- *
- * I could also nest an OR within an AND, like this:
- * ['AND', [{column: 'name', value: 'test', operator: '=='},
- * { compoundType: 'OR', conditions: [{column: 'age', value: 21, operator: '<='},
- * {column: 'age', value: 52, operator: '>='}]}]] which would filter the query to only include items where the
- * name is 'test' and the age is less than or equal to 21 or greater than or equal to 52.
- */
-export type CompoundCondition = {
-  compoundType: CompoundType,
-  conditions: Array<Condition | CompoundCondition>
-};
-
-export const isCondition = (condition: any): condition is Condition => {
-  return (
-    typeof condition.column === 'string' &&
-    (Array.isArray(condition.value) && condition.value.every((item: any) => typeof item === 'string')) ||
-    (Array.isArray(condition.value) && condition.value.every((item: any) => 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);
-}
-
-export type EventQuery = {
-  start?: Date,
-  end?: Date,
-  by?: string,
-}
-
-export type OrderDirection = 'asc' | 'desc';
-
-export type OrderBy = {
-  field: string;
-  direction: OrderDirection;
-}
-
-export type ItemQuery = {
-  refs?: References;
-  compoundCondition?: CompoundCondition;
-  limit?: number;
-  offset?: number;
-  aggs?: Record<
-    string,
-    ItemQuery
-  >;
-  events?: Record<string, EventQuery>;
-  orderBy?: OrderBy[];
-};
-

package/src/items.ts

@@ -1,120 +0,0 @@
-import { ComKey, PriKey } from './keys';
-
-export type RecursivePartial<T> = {
-  [P in keyof T]?:
-  T[P] extends (infer U)[] ? RecursivePartial<U>[] :
-  T[P] extends object | undefined ? RecursivePartial<T[P]> :
-  T[P];
-};
-
-export type Identified<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>;
-  };
-
-/**
- * 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.
- */
-export interface ItemEvent {
-  at: Date | null;
-  by?: ComKey<any, any | never, any | never, any | never, any | never, any | never> | PriKey<any>;
-  agg?: Item<any, any, any, any, any, any>;
-}
-
-/**
- * This is a required item event, and it's here mainly to define that there are events that must be present.
- */
-export interface RequiredItemEvent extends ItemEvent {
-  at: Date;
-}
-
-export type Evented = Record<string, ItemEvent>;
-
-export interface Timestamped extends Evented {
-  created: RequiredItemEvent;
-  updated: RequiredItemEvent;
-};
-
-export interface Deletable extends Partial<Evented> {
-  deleted: ItemEvent;
-};
-
-export type ManagedEvents = Timestamped & Deletable;
-
-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,
-  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 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;
-  // TODO: This is a bit of a hack to get around the fact that we don't want to pass all these generics
-  aggs?: Record<string, Aggregation<any, any, any, any, any, any>[]>;
-  refs?: Record<string, Reference<any, any, any, any, any, any>>;
-  [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'>>;