@fjell/core 4.4.2 → 4.4.3

package/dist/cjs/item/IQUtils.js

@@ -0,0 +1,316 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const KUtils = require('../key/KUtils.js');
+const logger$1 = require('../logger.js');
+const luxon = require('luxon');
+const ItemQuery = require('./ItemQuery.js');
+
+const logger = logger$1.default.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.
+ */ const queryToParams = (query)=>{
+    const params = {};
+    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, value) {
+    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.
+ */ const paramsToQuery = (params)=>{
+    const query = {};
+    if (params.compoundCondition) {
+        query.compoundCondition = JSON.parse(params.compoundCondition);
+    }
+    if (params.refs) {
+        query.refs = JSON.parse(params.refs);
+    }
+    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);
+    }
+    if (params.events) {
+        query.events = JSON.parse(params.events, dateTimeReviver);
+    }
+    return query;
+};
+const isRefQueryMatch = (refKey, queryRef, references)=>{
+    logger.trace('doesRefMatch', {
+        queryRef,
+        references
+    });
+    logger.debug('Comparing Ref', {
+        refKey,
+        itemRef: references[refKey],
+        queryRef
+    });
+    return KUtils.isItemKeyEqual(queryRef, references[refKey]);
+};
+const isCompoundConditionQueryMatch = (queryCondition, item)=>{
+    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)=>ItemQuery.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)=>ItemQuery.isCondition(condition) ? isConditionQueryMatch(condition, item) : isCompoundConditionQueryMatch(condition, item));
+    }
+};
+const isConditionQueryMatch = (queryCondition, item)=>{
+    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
+    });
+    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.includes(item[propKey]);
+            break;
+        case 'not-in':
+            result = !queryCondition.value.includes(item[propKey]);
+            break;
+        case 'array-contains':
+            result = item[propKey].includes(queryCondition.value);
+            break;
+        case 'array-contains-any':
+            result = queryCondition.value.some((value)=>item[propKey].includes(value));
+            break;
+    }
+    return result;
+};
+const isAggQueryMatch = (aggKey, aggQuery, agg)=>{
+    const aggItem = agg.item;
+    logger.debug('Comparing Agg', {
+        aggKey,
+        aggItem,
+        aggQuery
+    });
+    // Fancy, right?  This is a recursive call to isQueryMatch
+    return isQueryMatch(aggItem, aggQuery);
+};
+const isEventQueryMatch = (eventKey, eventQuery, item)=>{
+    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;
+    }
+};
+const isQueryMatch = (item, query)=>{
+    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, 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];
+            if (item.aggs[key] && !isAggQueryMatch(key, aggQuery, item.aggs[key])) return false;
+        }
+    }
+    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;
+};
+const abbrevQuery = (query)=>{
+    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(' ');
+};
+const abbrevRef = (key, ref)=>{
+    if (KUtils.isPriKey(ref)) {
+        const priKey = ref;
+        return `R(${key},${priKey.kt},${priKey.pk})`;
+    } else {
+        const comKey = ref;
+        return `R(${key},${JSON.stringify(comKey)})`;
+    }
+};
+const abbrevAgg = (key, agg)=>{
+    return `A(${key},${abbrevQuery(agg)})`;
+};
+const abbrevCompoundCondition = (compoundCondition)=>{
+    return `CC(${compoundCondition.compoundType},` + `${compoundCondition.conditions ? compoundCondition.conditions.map(abbrevCondition).join(',') : 'No Conditions'})`;
+};
+const abbrevCondition = (condition)=>{
+    if (ItemQuery.isCondition(condition)) {
+        return `(${condition.column},${condition.value},${condition.operator})`;
+    } else {
+        return abbrevCompoundCondition(condition);
+    }
+};
+
+exports.abbrevAgg = abbrevAgg;
+exports.abbrevCompoundCondition = abbrevCompoundCondition;
+exports.abbrevCondition = abbrevCondition;
+exports.abbrevQuery = abbrevQuery;
+exports.abbrevRef = abbrevRef;
+exports.isQueryMatch = isQueryMatch;
+exports.paramsToQuery = paramsToQuery;
+exports.queryToParams = queryToParams;
+//# sourceMappingURL=IQUtils.js.map

package/dist/cjs/item/IQUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IQUtils.js","sources":["../../../src/item/IQUtils.ts"],"sourcesContent":["import { Item, ReferenceItem, References } from \"@/items\";\nimport { isItemKeyEqual, isPriKey } from \"@/key/KUtils\";\nimport { ComKey, PriKey } from \"@/keys\";\nimport LibLogger from \"@/logger\";\nimport { DateTime } from \"luxon\";\nimport { CompoundCondition, Condition, EventQuery, isCondition, ItemQuery, QueryParams } from \"./ItemQuery\";\n\nconst logger = LibLogger.get('IQUtils');\n\n/**\n * When we query or search, we're sending a GET request.  This converts everything in ItemQuery into a flat\n * object that can be sent over a GET request.\n *\n * Note that there is some discussion about this.  Evidently Elastic supports search with POST, but that also\n * feels like a bit of a hack. It's not a RESTful way to do things.  So we're sticking with GET for now.\n *\n * For reference, look at RFC 9110 \"HTTP Semantics\", June which clarified on top of and RFC 7231.  It's possible\n * but there are so many caveats and conditions in the standard, it's not worth it.\n *\n * Anticipating the next question - \"isn't there a limit to the length of a URL?\"   The specification does not\n * specify a limit, and there are limits in various browsers and servers - Apache is 4,000 chars, Chrome is 2M chars.\n * Short answer is that if this query is being used to craft something that complex, it is probably a better idea\n * to provide an action or a custom query endpoint on the server.\n *\n * @param query\n * @returns QueryParams ready to be get over a GET request.\n */\nexport const queryToParams = (query: ItemQuery): QueryParams => {\n  const params: QueryParams = {};\n  if (query.compoundCondition) {\n    params.compoundCondition = JSON.stringify(query.compoundCondition);\n  }\n  if (query.refs) {\n    params.refs = JSON.stringify(query.refs);\n  }\n  if (query.limit) {\n    params.limit = query.limit;\n  }\n  if (query.offset) {\n    params.offset = query.offset;\n  }\n  if (query.aggs) {\n    params.aggs = JSON.stringify(query.aggs);\n  }\n  if (query.events) {\n    params.events = JSON.stringify(query.events);\n  }\n  return params;\n}\n\n// This is a dateTimeReviver used for JSON parse - when we convert a param back to a query, we need this.\nconst dateTimeReviver = function (key: string, value: string) {\n  if (typeof value === 'string') {\n    const parsedDate = DateTime.fromISO(value);\n    if (parsedDate.isValid) {\n      return parsedDate.toJSDate();;\n    }\n  }\n  return value;\n}\n\n/**\n * This method translates from a flat QueryParams object with stringify'd JSON back to a full ItemQuery.\n *\n * @param params Parameters sent over a GET request\n * @returns A fully hydrated ItemQuery object.\n */\nexport const paramsToQuery = (params: QueryParams): ItemQuery => {\n  const query: ItemQuery = {};\n  if (params.compoundCondition) {\n    query.compoundCondition = JSON.parse(params.compoundCondition as string) as CompoundCondition;\n  }\n  if (params.refs) {\n    query.refs = JSON.parse(params.refs as string) as References;\n  }\n  if (params.limit) {\n    query.limit = Number(params.limit);\n  }\n  if (params.offset) {\n    query.offset = Number(params.offset);\n  }\n  if (params.aggs) {\n    query.aggs = JSON.parse(params.aggs as string) as Record<string, ItemQuery>;\n  }\n  if (params.events) {\n    query.events = JSON.parse(params.events as string, dateTimeReviver) as Record<string, { start?: Date, end?: Date }>;\n  }\n  return query;\n}\n\nconst isRefQueryMatch =\n  <\n    S extends string,\n    L1 extends string = never,\n    L2 extends string = never,\n    L3 extends string = never,\n    L4 extends string = never,\n    L5 extends string = never\n  >(\n    refKey: string,\n    queryRef: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,\n    references: References,\n  ): boolean => {\n    logger.trace('doesRefMatch', { queryRef, references });\n    logger.debug('Comparing Ref', { refKey, itemRef: references[refKey], queryRef });\n    return isItemKeyEqual(queryRef, references[refKey]);\n  }\n\nconst isCompoundConditionQueryMatch = <\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n>(\n    queryCondition: CompoundCondition,\n    item: Item<S, L1, L2, L3, L4, L5>,\n  ): boolean => {\n  if (queryCondition.compoundType === 'AND') {\n    // If this is an AND compound condition, we need to check if all of the conditions match\n    return queryCondition.conditions.every(\n      (condition: Condition | CompoundCondition) =>\n        isCondition(condition) ?\n          isConditionQueryMatch(condition, item) :\n          isCompoundConditionQueryMatch(condition, item)\n    );\n  } else {\n    // If this is an OR compound condition, we need to check if any of the conditions match\n    return queryCondition.conditions.some(\n      (condition: Condition | CompoundCondition) =>\n        isCondition(condition) ?\n          isConditionQueryMatch(condition, item) :\n          isCompoundConditionQueryMatch(condition, item)\n    );\n  }\n}\n\nconst isConditionQueryMatch = <\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n>(\n    queryCondition: Condition,\n    item: Item<S, L1, L2, L3, L4, L5>,\n  ): boolean => {\n  const propKey = queryCondition.column;\n  logger.trace('doesConditionMatch', { propKey, queryCondition, item });\n  // eslint-disable-next-line no-undefined\n  if (item[propKey] === undefined) {\n    logger.debug('Item does not contain prop under key', { propKey, item });\n    return false;\n  }\n  logger.debug('Comparing Condition', { propKey, itemProp: item[propKey], queryCondition });\n  let result = false;\n  switch (queryCondition.operator) {\n    case '==':\n      result = item[propKey] === queryCondition.value;\n      break;\n    case '!=':\n      result = item[propKey] !== queryCondition.value;\n      break;\n    case '>':\n      result = item[propKey] > queryCondition.value;\n      break;\n    case '>=':\n      result = item[propKey] >= queryCondition.value;\n      break;\n    case '<':\n      result = item[propKey] < queryCondition.value;\n      break;\n    case '<=':\n      result = item[propKey] <= queryCondition.value;\n      break;\n    case 'in':\n      result = (queryCondition.value as unknown as string[]).includes(item[propKey] as string);\n      break;\n    case 'not-in':\n      result = !(queryCondition.value as unknown as string[]).includes(item[propKey] as string);\n      break;\n    case 'array-contains':\n      result = (item[propKey] as unknown as string[]).includes(queryCondition.value as string);\n      break;\n    case 'array-contains-any':\n      result = (queryCondition.value as unknown as string[])\n        .some(value => (item[propKey] as unknown as string[]).includes(value));\n      break;\n  }\n  return result;\n}\n\nconst isAggQueryMatch = <\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n>(\n    aggKey: string,\n    aggQuery: ItemQuery,\n    agg: ReferenceItem<S, L1, L2, L3, L4, L5>\n  ): boolean => {\n  const aggItem = agg.item;\n  logger.debug('Comparing Agg', { aggKey, aggItem, aggQuery });\n  // Fancy, right?  This is a recursive call to isQueryMatch\n  return isQueryMatch(aggItem, aggQuery);\n}\n\nconst isEventQueryMatch = <\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n>(\n    eventKey: string,\n    eventQuery: EventQuery,\n    item: Item<S, L1, L2, L3, L4, L5>,\n  ): boolean => {\n  if (!item.events[eventKey]) {\n    logger.debug('Item does not contain event under key', { eventKey, events: item.events });\n    return false;\n  } else {\n    const itemEvent = item.events[eventKey];\n    if (itemEvent.at !== null) {\n      if (eventQuery.start && !(eventQuery.start.getTime() <= itemEvent.at.getTime())) {\n        logger.debug('Item date before event start query', { eventQuery, itemEvent });\n        return false;\n      }\n      if (eventQuery.end && !(eventQuery.end.getTime() > itemEvent.at.getTime())) {\n        logger.debug('Item date after event end query', { eventQuery, itemEvent });\n        return false;\n      }\n    } else {\n      logger.debug('Item event does contains a null at', { itemEvent });\n      return false;\n    }\n    return true;\n  }\n}\n\nexport const isQueryMatch = <\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n>(item: Item<S, L1, L2, L3, L4, L5>, query: ItemQuery): boolean => {\n\n  logger.trace('isMatch', { item, query });\n  if (query.refs && item.refs) {\n    for (const key in query.refs) {\n      const queryRef = query.refs[key];\n      if (!isRefQueryMatch(key, queryRef, item.refs)) return false;\n    }\n  } else if (query.refs && !item.refs) {\n    logger.debug('Query contains refs but item does not have refs', { query, item });\n    return false;\n  }\n\n  if (query.compoundCondition && item) {\n    if (!isCompoundConditionQueryMatch(query.compoundCondition, item)) return false;\n  }\n\n  if (query.events && item.events) {\n    for (const key in query.events) {\n      const queryEvent = query.events[key];\n      if (!isEventQueryMatch(key, queryEvent, item)) return false\n    }\n    return true;\n  }\n\n  if (query.aggs && item.aggs) {\n    for (const key in query.aggs) {\n      const aggQuery = query.aggs[key];\n      if (item.aggs[key] && !isAggQueryMatch(key, aggQuery, item.aggs[key])) return false;\n    }\n  } if (query.aggs && !item.aggs) {\n    logger.debug('Query contains aggs but item does not have aggs', { query, item });\n    return false;\n  }\n\n  // If it hasn't returned false by now, it must be a match\n  return true;\n}\n\nexport const abbrevQuery = (query: ItemQuery | null | undefined): string => {\n  const abbrev = ['IQ'];\n  if( query ) {\n    if (query.refs) {\n      for (const key in query.refs) {\n        const ref = abbrevRef(key, query.refs[key]);\n        abbrev.push(ref);\n      }\n    }\n    if (query.compoundCondition) {\n      const props = abbrevCompoundCondition(query.compoundCondition);\n      abbrev.push(props);\n    }\n    if (query.aggs) {\n      for (const key in query.aggs) {\n        const agg = abbrevAgg(key, query.aggs[key]);\n        abbrev.push(agg);\n      }\n    }\n    if (query.events) {\n      const events = `(E${Object.keys(query.events).join(',')})`;\n      abbrev.push(events);\n    }\n    if (query.limit) {\n      abbrev.push(`L${query.limit}`);\n    }\n    if (query.offset) {\n      abbrev.push(`O${query.offset}`);\n    }\n  } else {\n    abbrev.push('(empty)');\n  }\n  return abbrev.join(' ');\n}\n\nexport const abbrevRef = <\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n>(key: string, ref: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>): string => {\n  if (isPriKey(ref)) {\n    const priKey = ref as PriKey<S>;\n    return `R(${key},${priKey.kt},${priKey.pk})`;\n  } else {\n    const comKey = ref as ComKey<S, L1, L2, L3, L4, L5>;\n    return `R(${key},${JSON.stringify(comKey)})`;\n  }\n}\n\nexport const abbrevAgg = (key: string, agg: ItemQuery): string => {\n  return `A(${key},${abbrevQuery(agg)})`;\n}\n\nexport const abbrevCompoundCondition = (compoundCondition: CompoundCondition): string => {\n  return `CC(${compoundCondition.compoundType},` +\n    `${compoundCondition.conditions ? compoundCondition.conditions.map(abbrevCondition).join(',') : 'No Conditions'})`;\n}\n\nexport const abbrevCondition = (condition: Condition | CompoundCondition): string => {\n  if (isCondition(condition)) {\n    return `(${condition.column},${condition.value},${condition.operator})`;\n  } else {\n    return abbrevCompoundCondition(condition);\n  }\n}"],"names":["logger","LibLogger","get","queryToParams","query","params","compoundCondition","JSON","stringify","refs","limit","offset","aggs","events","dateTimeReviver","key","value","parsedDate","DateTime","fromISO","isValid","toJSDate","paramsToQuery","parse","Number","isRefQueryMatch","refKey","queryRef","references","trace","debug","itemRef","isItemKeyEqual","isCompoundConditionQueryMatch","queryCondition","item","compoundType","conditions","every","condition","isCondition","isConditionQueryMatch","some","propKey","column","undefined","itemProp","result","operator","includes","isAggQueryMatch","aggKey","aggQuery","agg","aggItem","isQueryMatch","isEventQueryMatch","eventKey","eventQuery","itemEvent","at","start","getTime","end","queryEvent","abbrevQuery","abbrev","ref","abbrevRef","push","props","abbrevCompoundCondition","abbrevAgg","Object","keys","join","isPriKey","priKey","kt","pk","comKey","map","abbrevCondition"],"mappings":";;;;;;;;;AAOA,MAAMA,MAAAA,GAASC,gBAAUC,CAAAA,GAAG,CAAC,SAAA,CAAA;AAE7B;;;;;;;;;;;;;;;;;IAkBaC,MAAAA,aAAAA,GAAgB,CAACC,KAAAA,GAAAA;AAC5B,IAAA,MAAMC,SAAsB,EAAC;IAC7B,IAAID,KAAAA,CAAME,iBAAiB,EAAE;AAC3BD,QAAAA,MAAAA,CAAOC,iBAAiB,GAAGC,IAAAA,CAAKC,SAAS,CAACJ,MAAME,iBAAiB,CAAA;AACnE;IACA,IAAIF,KAAAA,CAAMK,IAAI,EAAE;AACdJ,QAAAA,MAAAA,CAAOI,IAAI,GAAGF,IAAAA,CAAKC,SAAS,CAACJ,MAAMK,IAAI,CAAA;AACzC;IACA,IAAIL,KAAAA,CAAMM,KAAK,EAAE;QACfL,MAAOK,CAAAA,KAAK,GAAGN,KAAAA,CAAMM,KAAK;AAC5B;IACA,IAAIN,KAAAA,CAAMO,MAAM,EAAE;QAChBN,MAAOM,CAAAA,MAAM,GAAGP,KAAAA,CAAMO,MAAM;AAC9B;IACA,IAAIP,KAAAA,CAAMQ,IAAI,EAAE;AACdP,QAAAA,MAAAA,CAAOO,IAAI,GAAGL,IAAAA,CAAKC,SAAS,CAACJ,MAAMQ,IAAI,CAAA;AACzC;IACA,IAAIR,KAAAA,CAAMS,MAAM,EAAE;AAChBR,QAAAA,MAAAA,CAAOQ,MAAM,GAAGN,IAAAA,CAAKC,SAAS,CAACJ,MAAMS,MAAM,CAAA;AAC7C;IACA,OAAOR,MAAAA;AACT;AAEA;AACA,MAAMS,eAAkB,GAAA,SAAUC,GAAW,EAAEC,KAAa,EAAA;IAC1D,IAAI,OAAOA,UAAU,QAAU,EAAA;QAC7B,MAAMC,UAAAA,GAAaC,cAASC,CAAAA,OAAO,CAACH,KAAAA,CAAAA;QACpC,IAAIC,UAAAA,CAAWG,OAAO,EAAE;AACtB,YAAA,OAAOH,WAAWI,QAAQ,EAAA;AAC5B;AACF;IACA,OAAOL,KAAAA;AACT,CAAA;AAEA;;;;;IAMaM,MAAAA,aAAAA,GAAgB,CAACjB,MAAAA,GAAAA;AAC5B,IAAA,MAAMD,QAAmB,EAAC;IAC1B,IAAIC,MAAAA,CAAOC,iBAAiB,EAAE;AAC5BF,QAAAA,KAAAA,CAAME,iBAAiB,GAAGC,IAAAA,CAAKgB,KAAK,CAAClB,OAAOC,iBAAiB,CAAA;AAC/D;IACA,IAAID,MAAAA,CAAOI,IAAI,EAAE;AACfL,QAAAA,KAAAA,CAAMK,IAAI,GAAGF,IAAAA,CAAKgB,KAAK,CAAClB,OAAOI,IAAI,CAAA;AACrC;IACA,IAAIJ,MAAAA,CAAOK,KAAK,EAAE;AAChBN,QAAAA,KAAAA,CAAMM,KAAK,GAAGc,MAAOnB,CAAAA,MAAAA,CAAOK,KAAK,CAAA;AACnC;IACA,IAAIL,MAAAA,CAAOM,MAAM,EAAE;AACjBP,QAAAA,KAAAA,CAAMO,MAAM,GAAGa,MAAOnB,CAAAA,MAAAA,CAAOM,MAAM,CAAA;AACrC;IACA,IAAIN,MAAAA,CAAOO,IAAI,EAAE;AACfR,QAAAA,KAAAA,CAAMQ,IAAI,GAAGL,IAAAA,CAAKgB,KAAK,CAAClB,OAAOO,IAAI,CAAA;AACrC;IACA,IAAIP,MAAAA,CAAOQ,MAAM,EAAE;AACjBT,QAAAA,KAAAA,CAAMS,MAAM,GAAGN,IAAAA,CAAKgB,KAAK,CAAClB,MAAAA,CAAOQ,MAAM,EAAYC,eAAAA,CAAAA;AACrD;IACA,OAAOV,KAAAA;AACT;AAEA,MAAMqB,eAAAA,GACJ,CAQEC,MAAAA,EACAC,QACAC,EAAAA,UAAAA,GAAAA;IAEA5B,MAAO6B,CAAAA,KAAK,CAAC,cAAgB,EAAA;AAAEF,QAAAA,QAAAA;AAAUC,QAAAA;AAAW,KAAA,CAAA;IACpD5B,MAAO8B,CAAAA,KAAK,CAAC,eAAiB,EAAA;AAAEJ,QAAAA,MAAAA;QAAQK,OAASH,EAAAA,UAAU,CAACF,MAAO,CAAA;AAAEC,QAAAA;AAAS,KAAA,CAAA;AAC9E,IAAA,OAAOK,qBAAeL,CAAAA,QAAAA,EAAUC,UAAU,CAACF,MAAO,CAAA,CAAA;AACpD,CAAA;AAEF,MAAMO,6BAAAA,GAAgC,CAQlCC,cACAC,EAAAA,IAAAA,GAAAA;IAEF,IAAID,cAAAA,CAAeE,YAAY,KAAK,KAAO,EAAA;;AAEzC,QAAA,OAAOF,cAAeG,CAAAA,UAAU,CAACC,KAAK,CACpC,CAACC,SACCC,GAAAA,qBAAAA,CAAYD,SACVE,CAAAA,GAAAA,qBAAAA,CAAsBF,SAAWJ,EAAAA,IAAAA,CAAAA,GACjCF,8BAA8BM,SAAWJ,EAAAA,IAAAA,CAAAA,CAAAA;KAE1C,MAAA;;AAEL,QAAA,OAAOD,cAAeG,CAAAA,UAAU,CAACK,IAAI,CACnC,CAACH,SACCC,GAAAA,qBAAAA,CAAYD,SACVE,CAAAA,GAAAA,qBAAAA,CAAsBF,SAAWJ,EAAAA,IAAAA,CAAAA,GACjCF,8BAA8BM,SAAWJ,EAAAA,IAAAA,CAAAA,CAAAA;AAEjD;AACF,CAAA;AAEA,MAAMM,qBAAAA,GAAwB,CAQ1BP,cACAC,EAAAA,IAAAA,GAAAA;IAEF,MAAMQ,OAAAA,GAAUT,eAAeU,MAAM;IACrC5C,MAAO6B,CAAAA,KAAK,CAAC,oBAAsB,EAAA;AAAEc,QAAAA,OAAAA;AAAST,QAAAA,cAAAA;AAAgBC,QAAAA;AAAK,KAAA,CAAA;;AAEnE,IAAA,IAAIA,IAAI,CAACQ,OAAQ,CAAA,KAAKE,SAAW,EAAA;QAC/B7C,MAAO8B,CAAAA,KAAK,CAAC,sCAAwC,EAAA;AAAEa,YAAAA,OAAAA;AAASR,YAAAA;AAAK,SAAA,CAAA;QACrE,OAAO,KAAA;AACT;IACAnC,MAAO8B,CAAAA,KAAK,CAAC,qBAAuB,EAAA;AAAEa,QAAAA,OAAAA;QAASG,QAAUX,EAAAA,IAAI,CAACQ,OAAQ,CAAA;AAAET,QAAAA;AAAe,KAAA,CAAA;AACvF,IAAA,IAAIa,MAAS,GAAA,KAAA;AACb,IAAA,OAAQb,eAAec,QAAQ;QAC7B,KAAK,IAAA;AACHD,YAAAA,MAAAA,GAASZ,IAAI,CAACQ,OAAQ,CAAA,KAAKT,eAAelB,KAAK;AAC/C,YAAA;QACF,KAAK,IAAA;AACH+B,YAAAA,MAAAA,GAASZ,IAAI,CAACQ,OAAQ,CAAA,KAAKT,eAAelB,KAAK;AAC/C,YAAA;QACF,KAAK,GAAA;AACH+B,YAAAA,MAAAA,GAASZ,IAAI,CAACQ,OAAQ,CAAA,GAAGT,eAAelB,KAAK;AAC7C,YAAA;QACF,KAAK,IAAA;AACH+B,YAAAA,MAAAA,GAASZ,IAAI,CAACQ,OAAQ,CAAA,IAAIT,eAAelB,KAAK;AAC9C,YAAA;QACF,KAAK,GAAA;AACH+B,YAAAA,MAAAA,GAASZ,IAAI,CAACQ,OAAQ,CAAA,GAAGT,eAAelB,KAAK;AAC7C,YAAA;QACF,KAAK,IAAA;AACH+B,YAAAA,MAAAA,GAASZ,IAAI,CAACQ,OAAQ,CAAA,IAAIT,eAAelB,KAAK;AAC9C,YAAA;QACF,KAAK,IAAA;YACH+B,MAAS,GAACb,eAAelB,KAAK,CAAyBiC,QAAQ,CAACd,IAAI,CAACQ,OAAQ,CAAA,CAAA;AAC7E,YAAA;QACF,KAAK,QAAA;YACHI,MAAS,GAAA,CAAC,cAAgB/B,CAAAA,KAAK,CAAyBiC,QAAQ,CAACd,IAAI,CAACQ,OAAQ,CAAA,CAAA;AAC9E,YAAA;QACF,KAAK,gBAAA;YACHI,MAAS,GAACZ,IAAI,CAACQ,OAAAA,CAAQ,CAAyBM,QAAQ,CAACf,eAAelB,KAAK,CAAA;AAC7E,YAAA;QACF,KAAK,oBAAA;AACH+B,YAAAA,MAAAA,GAAS,cAACb,CAAelB,KAAK,CAC3B0B,IAAI,CAAC1B,CAAAA,KAAS,GAACmB,IAAI,CAACQ,OAAQ,CAAA,CAAyBM,QAAQ,CAACjC,KAAAA,CAAAA,CAAAA;AACjE,YAAA;AACJ;IACA,OAAO+B,MAAAA;AACT,CAAA;AAEA,MAAMG,eAAAA,GAAkB,CAQpBC,MAAAA,EACAC,QACAC,EAAAA,GAAAA,GAAAA;IAEF,MAAMC,OAAAA,GAAUD,IAAIlB,IAAI;IACxBnC,MAAO8B,CAAAA,KAAK,CAAC,eAAiB,EAAA;AAAEqB,QAAAA,MAAAA;AAAQG,QAAAA,OAAAA;AAASF,QAAAA;AAAS,KAAA,CAAA;;AAE1D,IAAA,OAAOG,aAAaD,OAASF,EAAAA,QAAAA,CAAAA;AAC/B,CAAA;AAEA,MAAMI,iBAAAA,GAAoB,CAQtBC,QAAAA,EACAC,UACAvB,EAAAA,IAAAA,GAAAA;AAEF,IAAA,IAAI,CAACA,IAAAA,CAAKtB,MAAM,CAAC4C,SAAS,EAAE;QAC1BzD,MAAO8B,CAAAA,KAAK,CAAC,uCAAyC,EAAA;AAAE2B,YAAAA,QAAAA;AAAU5C,YAAAA,MAAAA,EAAQsB,KAAKtB;AAAO,SAAA,CAAA;QACtF,OAAO,KAAA;KACF,MAAA;AACL,QAAA,MAAM8C,SAAYxB,GAAAA,IAAAA,CAAKtB,MAAM,CAAC4C,QAAS,CAAA;QACvC,IAAIE,SAAAA,CAAUC,EAAE,KAAK,IAAM,EAAA;AACzB,YAAA,IAAIF,UAAWG,CAAAA,KAAK,IAAI,EAAEH,UAAWG,CAAAA,KAAK,CAACC,OAAO,MAAMH,SAAUC,CAAAA,EAAE,CAACE,OAAO,EAAC,CAAI,EAAA;gBAC/E9D,MAAO8B,CAAAA,KAAK,CAAC,oCAAsC,EAAA;AAAE4B,oBAAAA,UAAAA;AAAYC,oBAAAA;AAAU,iBAAA,CAAA;gBAC3E,OAAO,KAAA;AACT;AACA,YAAA,IAAID,UAAWK,CAAAA,GAAG,IAAI,EAAEL,UAAWK,CAAAA,GAAG,CAACD,OAAO,KAAKH,SAAUC,CAAAA,EAAE,CAACE,OAAO,EAAC,CAAI,EAAA;gBAC1E9D,MAAO8B,CAAAA,KAAK,CAAC,iCAAmC,EAAA;AAAE4B,oBAAAA,UAAAA;AAAYC,oBAAAA;AAAU,iBAAA,CAAA;gBACxE,OAAO,KAAA;AACT;SACK,MAAA;YACL3D,MAAO8B,CAAAA,KAAK,CAAC,oCAAsC,EAAA;AAAE6B,gBAAAA;AAAU,aAAA,CAAA;YAC/D,OAAO,KAAA;AACT;QACA,OAAO,IAAA;AACT;AACF,CAAA;AAEO,MAAMJ,YAAe,GAAA,CAO1BpB,IAAmC/B,EAAAA,KAAAA,GAAAA;IAEnCJ,MAAO6B,CAAAA,KAAK,CAAC,SAAW,EAAA;AAAEM,QAAAA,IAAAA;AAAM/B,QAAAA;AAAM,KAAA,CAAA;AACtC,IAAA,IAAIA,KAAMK,CAAAA,IAAI,IAAI0B,IAAAA,CAAK1B,IAAI,EAAE;AAC3B,QAAA,IAAK,MAAMM,GAAAA,IAAOX,KAAMK,CAAAA,IAAI,CAAE;AAC5B,YAAA,MAAMkB,QAAWvB,GAAAA,KAAAA,CAAMK,IAAI,CAACM,GAAI,CAAA;AAChC,YAAA,IAAI,CAACU,eAAgBV,CAAAA,GAAAA,EAAKY,UAAUQ,IAAK1B,CAAAA,IAAI,GAAG,OAAO,KAAA;AACzD;AACF,KAAA,MAAO,IAAIL,KAAMK,CAAAA,IAAI,IAAI,CAAC0B,IAAAA,CAAK1B,IAAI,EAAE;QACnCT,MAAO8B,CAAAA,KAAK,CAAC,iDAAmD,EAAA;AAAE1B,YAAAA,KAAAA;AAAO+B,YAAAA;AAAK,SAAA,CAAA;QAC9E,OAAO,KAAA;AACT;IAEA,IAAI/B,KAAAA,CAAME,iBAAiB,IAAI6B,IAAM,EAAA;AACnC,QAAA,IAAI,CAACF,6BAA8B7B,CAAAA,KAAAA,CAAME,iBAAiB,EAAE6B,OAAO,OAAO,KAAA;AAC5E;AAEA,IAAA,IAAI/B,KAAMS,CAAAA,MAAM,IAAIsB,IAAAA,CAAKtB,MAAM,EAAE;AAC/B,QAAA,IAAK,MAAME,GAAAA,IAAOX,KAAMS,CAAAA,MAAM,CAAE;AAC9B,YAAA,MAAMmD,UAAa5D,GAAAA,KAAAA,CAAMS,MAAM,CAACE,GAAI,CAAA;AACpC,YAAA,IAAI,CAACyC,iBAAAA,CAAkBzC,GAAKiD,EAAAA,UAAAA,EAAY7B,OAAO,OAAO,KAAA;AACxD;QACA,OAAO,IAAA;AACT;AAEA,IAAA,IAAI/B,KAAMQ,CAAAA,IAAI,IAAIuB,IAAAA,CAAKvB,IAAI,EAAE;AAC3B,QAAA,IAAK,MAAMG,GAAAA,IAAOX,KAAMQ,CAAAA,IAAI,CAAE;AAC5B,YAAA,MAAMwC,QAAWhD,GAAAA,KAAAA,CAAMQ,IAAI,CAACG,GAAI,CAAA;AAChC,YAAA,IAAIoB,IAAKvB,CAAAA,IAAI,CAACG,GAAAA,CAAI,IAAI,CAACmC,eAAAA,CAAgBnC,GAAKqC,EAAAA,QAAAA,EAAUjB,IAAKvB,CAAAA,IAAI,CAACG,GAAAA,CAAI,GAAG,OAAO,KAAA;AAChF;AACF;AAAE,IAAA,IAAIX,MAAMQ,IAAI,IAAI,CAACuB,IAAAA,CAAKvB,IAAI,EAAE;QAC9BZ,MAAO8B,CAAAA,KAAK,CAAC,iDAAmD,EAAA;AAAE1B,YAAAA,KAAAA;AAAO+B,YAAAA;AAAK,SAAA,CAAA;QAC9E,OAAO,KAAA;AACT;;IAGA,OAAO,IAAA;AACT;AAEO,MAAM8B,cAAc,CAAC7D,KAAAA,GAAAA;AAC1B,IAAA,MAAM8D,MAAS,GAAA;AAAC,QAAA;AAAK,KAAA;AACrB,IAAA,IAAI9D,KAAQ,EAAA;QACV,IAAIA,KAAAA,CAAMK,IAAI,EAAE;AACd,YAAA,IAAK,MAAMM,GAAAA,IAAOX,KAAMK,CAAAA,IAAI,CAAE;AAC5B,gBAAA,MAAM0D,MAAMC,SAAUrD,CAAAA,GAAAA,EAAKX,KAAMK,CAAAA,IAAI,CAACM,GAAI,CAAA,CAAA;AAC1CmD,gBAAAA,MAAAA,CAAOG,IAAI,CAACF,GAAAA,CAAAA;AACd;AACF;QACA,IAAI/D,KAAAA,CAAME,iBAAiB,EAAE;YAC3B,MAAMgE,KAAAA,GAAQC,uBAAwBnE,CAAAA,KAAAA,CAAME,iBAAiB,CAAA;AAC7D4D,YAAAA,MAAAA,CAAOG,IAAI,CAACC,KAAAA,CAAAA;AACd;QACA,IAAIlE,KAAAA,CAAMQ,IAAI,EAAE;AACd,YAAA,IAAK,MAAMG,GAAAA,IAAOX,KAAMQ,CAAAA,IAAI,CAAE;AAC5B,gBAAA,MAAMyC,MAAMmB,SAAUzD,CAAAA,GAAAA,EAAKX,KAAMQ,CAAAA,IAAI,CAACG,GAAI,CAAA,CAAA;AAC1CmD,gBAAAA,MAAAA,CAAOG,IAAI,CAAChB,GAAAA,CAAAA;AACd;AACF;QACA,IAAIjD,KAAAA,CAAMS,MAAM,EAAE;AAChB,YAAA,MAAMA,MAAS,GAAA,CAAC,EAAE,EAAE4D,OAAOC,IAAI,CAACtE,KAAMS,CAAAA,MAAM,CAAE8D,CAAAA,IAAI,CAAC,GAAA,CAAA,CAAK,CAAC,CAAC;AAC1DT,YAAAA,MAAAA,CAAOG,IAAI,CAACxD,MAAAA,CAAAA;AACd;QACA,IAAIT,KAAAA,CAAMM,KAAK,EAAE;AACfwD,YAAAA,MAAAA,CAAOG,IAAI,CAAC,CAAC,CAAC,EAAEjE,KAAAA,CAAMM,KAAK,CAAE,CAAA,CAAA;AAC/B;QACA,IAAIN,KAAAA,CAAMO,MAAM,EAAE;AAChBuD,YAAAA,MAAAA,CAAOG,IAAI,CAAC,CAAC,CAAC,EAAEjE,KAAAA,CAAMO,MAAM,CAAE,CAAA,CAAA;AAChC;KACK,MAAA;AACLuD,QAAAA,MAAAA,CAAOG,IAAI,CAAC,SAAA,CAAA;AACd;IACA,OAAOH,MAAAA,CAAOS,IAAI,CAAC,GAAA,CAAA;AACrB;AAEO,MAAMP,SAAY,GAAA,CAOvBrD,GAAaoD,EAAAA,GAAAA,GAAAA;AACb,IAAA,IAAIS,gBAAST,GAAM,CAAA,EAAA;AACjB,QAAA,MAAMU,MAASV,GAAAA,GAAAA;AACf,QAAA,OAAO,CAAC,EAAE,EAAEpD,GAAAA,CAAI,CAAC,EAAE8D,MAAAA,CAAOC,EAAE,CAAC,CAAC,EAAED,MAAAA,CAAOE,EAAE,CAAC,CAAC,CAAC;KACvC,MAAA;AACL,QAAA,MAAMC,MAASb,GAAAA,GAAAA;QACf,OAAO,CAAC,EAAE,EAAEpD,GAAI,CAAA,CAAC,EAAER,IAAAA,CAAKC,SAAS,CAACwE,MAAQ,CAAA,CAAA,CAAC,CAAC;AAC9C;AACF;AAEO,MAAMR,SAAY,GAAA,CAACzD,GAAasC,EAAAA,GAAAA,GAAAA;IACrC,OAAO,CAAC,EAAE,EAAEtC,GAAAA,CAAI,CAAC,EAAEkD,WAAAA,CAAYZ,GAAK,CAAA,CAAA,CAAC,CAAC;AACxC;AAEO,MAAMkB,0BAA0B,CAACjE,iBAAAA,GAAAA;IACtC,OAAO,CAAC,GAAG,EAAEA,iBAAkB8B,CAAAA,YAAY,CAAC,CAAC,CAAC,GAC5C,CAAA,EAAG9B,iBAAkB+B,CAAAA,UAAU,GAAG/B,iBAAkB+B,CAAAA,UAAU,CAAC4C,GAAG,CAACC,eAAAA,CAAAA,CAAiBP,IAAI,CAAC,GAAA,CAAA,GAAO,eAAgB,CAAA,CAAC,CAAC;AACtH;AAEO,MAAMO,kBAAkB,CAAC3C,SAAAA,GAAAA;AAC9B,IAAA,IAAIC,sBAAYD,SAAY,CAAA,EAAA;AAC1B,QAAA,OAAO,CAAC,CAAC,EAAEA,SAAUK,CAAAA,MAAM,CAAC,CAAC,EAAEL,SAAUvB,CAAAA,KAAK,CAAC,CAAC,EAAEuB,UAAUS,QAAQ,CAAC,CAAC,CAAC;KAClE,MAAA;AACL,QAAA,OAAOuB,uBAAwBhC,CAAAA,SAAAA,CAAAA;AACjC;AACF;;;;;;;;;;;"}

package/dist/cjs/item/IUtils.js

@@ -0,0 +1,84 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const KUtils = require('../key/KUtils.js');
+const logger$1 = require('../logger.js');
+
+const logger = logger$1.default.get('IUtils');
+const validatePK = (input, pkType)=>{
+    logger.trace('Checking Return Type', {
+        input
+    });
+    if (Array.isArray(input)) {
+        const itemArray = input;
+        return itemArray.map((item)=>validatePK(item, pkType));
+    } else {
+        const item = input;
+        if (item) {
+            if (item.key) {
+                const keyTypeArray = KUtils.toKeyTypeArray(item.key);
+                const match = 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');
+        }
+    }
+};
+const validateKeys = (item, keyTypes)=>{
+    logger.trace('Checking Return Type', {
+        item
+    });
+    if (item) {
+        if (item.key) {
+            const keyTypeArray = KUtils.toKeyTypeArray(item.key);
+            if (keyTypeArray.length !== keyTypes.length) {
+                throw new Error('Item does not have the correct number of keys');
+            } else {
+                const match = 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 {
+        throw new Error('validating keys, item is undefined');
+    }
+};
+const isPriItem = (item)=>{
+    return item && item.key ? KUtils.isPriKey(item.key) : false;
+};
+const isComItem = (item)=>{
+    return item && item.key ? KUtils.isComKey(item.key) : false;
+};
+
+exports.isComItem = isComItem;
+exports.isPriItem = isPriItem;
+exports.validateKeys = validateKeys;
+exports.validatePK = validatePK;
+//# sourceMappingURL=IUtils.js.map

package/dist/cjs/item/IUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IUtils.js","sources":["../../../src/item/IUtils.ts"],"sourcesContent":["import { Item } from \"@/items\";\nimport { isComKey, isPriKey, toKeyTypeArray } from \"@/key/KUtils\";\nimport { AllItemTypeArrays, ComKey, PriKey } from \"@/keys\";\n\nimport LibLogger from '@/logger';\n\nconst logger = LibLogger.get('IUtils');\n\nexport const validatePK = <\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n>(input: Item<S, L1, L2, L3, L4, L5> | Item<S, L1, L2, L3, L4, L5>[], pkType: S):\n  Item<S, L1, L2, L3, L4, L5> | Item<S, L1, L2, L3, L4, L5>[] => {\n\n  logger.trace('Checking Return Type', { input });\n\n  if (Array.isArray(input)) {\n    const itemArray = input as Item<S, L1, L2, L3, L4, L5>[];\n    return itemArray.map((item) => validatePK(item, pkType)) as Item<S, L1, L2, L3, L4, L5>[];\n  } else {\n    const item = input as Item<S, L1, L2, L3, L4, L5>;\n    if( item ) {\n      if (item.key) {\n        const keyTypeArray = toKeyTypeArray(item.key as ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>);\n        const match: boolean = keyTypeArray[0] === pkType;\n        if (!match) {\n          logger.error('Key Type Array Mismatch', { keyTypeArray, pkType });\n          throw new Error('Item does not have the correct primary key type');\n        } else {\n          return item;\n        }\n      } else {\n        logger.error('Validating PK, Item does not have a key', { item });\n        throw new Error('Validating PK, Item does not have a key');\n      }\n    } else {\n      logger.error('Validating PK, Item is undefined', { item });\n      throw new Error('Validating PK, Item is undefined');\n    }\n  }\n};\n\nexport const validateKeys = <\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n>(item: Item<S, L1, L2, L3, L4, L5>, keyTypes: AllItemTypeArrays<S, L1, L2, L3, L4, L5>):\n  Item<S, L1, L2, L3, L4, L5> => {\n  logger.trace('Checking Return Type', { item });\n  if( item ) {\n    if (item.key) {\n      const keyTypeArray = toKeyTypeArray(item.key as ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>);\n      if (keyTypeArray.length !== keyTypes.length) {\n        throw new Error('Item does not have the correct number of keys');\n      } else {\n        const match: boolean = JSON.stringify(keyTypeArray) === JSON.stringify(keyTypes);\n        if (!match) {\n          logger.error('Key Type Array Mismatch', { keyTypeArray, thisKeyTypes: keyTypes });\n          throw new Error('Item does not have the correct key types');\n        } else {\n          return item;\n        }\n      }\n    } else {\n      throw new Error('validating keys, item does not have a key: ' + JSON.stringify(item));\n    }\n  } else {\n    throw new Error('validating keys, item is undefined');\n  }\n};\n\nexport const isPriItem = <\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n>(item: Item<S, L1, L2, L3, L4, L5>): item is Item<S, L1, L2, L3, L4, L5> => {\n  return (item && item.key) ? isPriKey(item.key as PriKey<S>) : false;\n}\n\nexport const isComItem = <\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n>(item: Item<S, L1, L2, L3, L4, L5>): item is Item<S, L1, L2, L3, L4, L5> => {\n  return (item && item.key) ? isComKey(item.key as ComKey<S, L1, L2, L3, L4, L5>) : false;\n}"],"names":["logger","LibLogger","get","validatePK","input","pkType","trace","Array","isArray","itemArray","map","item","key","keyTypeArray","toKeyTypeArray","match","error","Error","validateKeys","keyTypes","length","JSON","stringify","thisKeyTypes","isPriItem","isPriKey","isComItem","isComKey"],"mappings":";;;;;;;AAMA,MAAMA,MAAAA,GAASC,gBAAUC,CAAAA,GAAG,CAAC,QAAA,CAAA;AAEtB,MAAMC,UAAa,GAAA,CAOxBC,KAAoEC,EAAAA,MAAAA,GAAAA;IAGpEL,MAAOM,CAAAA,KAAK,CAAC,sBAAwB,EAAA;AAAEF,QAAAA;AAAM,KAAA,CAAA;IAE7C,IAAIG,KAAAA,CAAMC,OAAO,CAACJ,KAAQ,CAAA,EAAA;AACxB,QAAA,MAAMK,SAAYL,GAAAA,KAAAA;AAClB,QAAA,OAAOK,UAAUC,GAAG,CAAC,CAACC,IAAAA,GAASR,WAAWQ,IAAMN,EAAAA,MAAAA,CAAAA,CAAAA;KAC3C,MAAA;AACL,QAAA,MAAMM,IAAOP,GAAAA,KAAAA;AACb,QAAA,IAAIO,IAAO,EAAA;YACT,IAAIA,IAAAA,CAAKC,GAAG,EAAE;gBACZ,MAAMC,YAAAA,GAAeC,qBAAeH,CAAAA,IAAAA,CAAKC,GAAG,CAAA;AAC5C,gBAAA,MAAMG,KAAiBF,GAAAA,YAAY,CAAC,CAAA,CAAE,KAAKR,MAAAA;AAC3C,gBAAA,IAAI,CAACU,KAAO,EAAA;oBACVf,MAAOgB,CAAAA,KAAK,CAAC,yBAA2B,EAAA;AAAEH,wBAAAA,YAAAA;AAAcR,wBAAAA;AAAO,qBAAA,CAAA;AAC/D,oBAAA,MAAM,IAAIY,KAAM,CAAA,iDAAA,CAAA;iBACX,MAAA;oBACL,OAAON,IAAAA;AACT;aACK,MAAA;gBACLX,MAAOgB,CAAAA,KAAK,CAAC,yCAA2C,EAAA;AAAEL,oBAAAA;AAAK,iBAAA,CAAA;AAC/D,gBAAA,MAAM,IAAIM,KAAM,CAAA,yCAAA,CAAA;AAClB;SACK,MAAA;YACLjB,MAAOgB,CAAAA,KAAK,CAAC,kCAAoC,EAAA;AAAEL,gBAAAA;AAAK,aAAA,CAAA;AACxD,YAAA,MAAM,IAAIM,KAAM,CAAA,kCAAA,CAAA;AAClB;AACF;AACF;AAEO,MAAMC,YAAe,GAAA,CAO1BP,IAAmCQ,EAAAA,QAAAA,GAAAA;IAEnCnB,MAAOM,CAAAA,KAAK,CAAC,sBAAwB,EAAA;AAAEK,QAAAA;AAAK,KAAA,CAAA;AAC5C,IAAA,IAAIA,IAAO,EAAA;QACT,IAAIA,IAAAA,CAAKC,GAAG,EAAE;YACZ,MAAMC,YAAAA,GAAeC,qBAAeH,CAAAA,IAAAA,CAAKC,GAAG,CAAA;AAC5C,YAAA,IAAIC,YAAaO,CAAAA,MAAM,KAAKD,QAAAA,CAASC,MAAM,EAAE;AAC3C,gBAAA,MAAM,IAAIH,KAAM,CAAA,+CAAA,CAAA;aACX,MAAA;AACL,gBAAA,MAAMF,QAAiBM,IAAKC,CAAAA,SAAS,CAACT,YAAkBQ,CAAAA,KAAAA,IAAAA,CAAKC,SAAS,CAACH,QAAAA,CAAAA;AACvE,gBAAA,IAAI,CAACJ,KAAO,EAAA;oBACVf,MAAOgB,CAAAA,KAAK,CAAC,yBAA2B,EAAA;AAAEH,wBAAAA,YAAAA;wBAAcU,YAAcJ,EAAAA;AAAS,qBAAA,CAAA;AAC/E,oBAAA,MAAM,IAAIF,KAAM,CAAA,0CAAA,CAAA;iBACX,MAAA;oBACL,OAAON,IAAAA;AACT;AACF;SACK,MAAA;AACL,YAAA,MAAM,IAAIM,KAAAA,CAAM,6CAAgDI,GAAAA,IAAAA,CAAKC,SAAS,CAACX,IAAAA,CAAAA,CAAAA;AACjF;KACK,MAAA;AACL,QAAA,MAAM,IAAIM,KAAM,CAAA,oCAAA,CAAA;AAClB;AACF;AAEO,MAAMO,YAAY,CAOvBb,IAAAA,GAAAA;IACA,OAAQA,QAAQA,IAAKC,CAAAA,GAAG,GAAIa,eAASd,CAAAA,IAAAA,CAAKC,GAAG,CAAiB,GAAA,KAAA;AAChE;AAEO,MAAMc,YAAY,CAOvBf,IAAAA,GAAAA;IACA,OAAQA,QAAQA,IAAKC,CAAAA,GAAG,GAAIe,eAAShB,CAAAA,IAAAA,CAAKC,GAAG,CAAqC,GAAA,KAAA;AACpF;;;;;;;"}

package/dist/cjs/item/ItemQuery.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const 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);
+};
+
+exports.isCondition = isCondition;
+//# sourceMappingURL=ItemQuery.js.map

package/dist/cjs/item/ItemQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ItemQuery.js","sources":["../../../src/item/ItemQuery.ts"],"sourcesContent":["import { References } from '@/items';\n\nexport type QueryParams = Record<string, string | number | boolean | Date>;\n\n/**\n * The operator for a condition.  This is the same as the operators used in the Firestore query language.\n */\nexport type ConditionOperator =\n  '==' | '!=' | '>' | '>=' | '<' | '<=' | 'in' | 'not-in' | 'array-contains' | 'array-contains-any';\n\n/**\n * A single property condition is defined with a column, value, and operator.\n * This is a condition that is used in a query.\n */\nexport type Condition = {\n  column: string,\n  value: string[] | string | number[] | number | boolean | Date,\n  operator: ConditionOperator,\n};\n\n/**\n * When applying a compound condition, the CompoundType defines the type of compound condition.\n */\nexport type CompoundType = 'AND' | 'OR';\n\n/**\n * When configuring a CompoundCondition this can contain a collection of conditions\n * that will be applied to the query.  By default, this is an AND conditiion that is associated\n * with an array of Condition objects OR an array of CompoundCondition objects.\n *\n * For example, I could have { compoundType: 'AND', conditions: [{column: 'name', value: 'test', operator: '=='},\n * {column: 'age', value: 21, operator: '>='}]} which would filter the query to only include items\n * where the name is 'test' and the age is greater than or equal to 21.\n *\n * Or, I could have a { compoundType: 'OR', conditions: [{column: 'name', value: 'test', operator: '=='},\n * {column: 'age', value: 21, operator: '>='}]} which would filter the query to only include items\n * where the name is 'test' OR the age is greater than or equal to 21.\n *\n * I could also nest an OR within an AND, like this:\n * ['AND', [{column: 'name', value: 'test', operator: '=='},\n * { compoundType: 'OR', conditions: [{column: 'age', value: 21, operator: '<='},\n * {column: 'age', value: 52, operator: '>='}]}]] which would filter the query to only include items where the\n * name is 'test' and the age is less than or equal to 21 or greater than or equal to 52.\n */\nexport type CompoundCondition = {\n  compoundType: CompoundType,\n  conditions: Array<Condition | CompoundCondition>\n};\n\nexport const isCondition = (condition: any): condition is Condition => {\n  return (\n    typeof condition.column === 'string' &&\n    (Array.isArray(condition.value) && condition.value.every((item: any) => typeof item === 'string')) ||\n    (Array.isArray(condition.value) && condition.value.every((item: any) => typeof item === 'number')) ||\n    typeof condition.value === 'string' ||\n    typeof condition.value === 'number' ||\n    typeof condition.value === 'boolean' ||\n    condition.value instanceof Date\n  ) && (condition.operator ? typeof condition.operator === 'string' : true);\n}\n\nexport type EventQuery = {\n  start?: Date,\n  end?: Date,\n  by?: string,\n}\n\nexport type OrderDirection = 'asc' | 'desc';\n\nexport type OrderBy = {\n  field: string;\n  direction: OrderDirection;\n}\n\nexport type ItemQuery = {\n  refs?: References;\n  compoundCondition?: CompoundCondition;\n  limit?: number;\n  offset?: number;\n  aggs?: Record<\n    string,\n    ItemQuery\n  >;\n  events?: Record<string, EventQuery>;\n  orderBy?: OrderBy[];\n};\n\n"],"names":["isCondition","condition","column","Array","isArray","value","every","item","Date","operator"],"mappings":";;;;AAiDO,MAAMA,cAAc,CAACC,SAAAA,GAAAA;AAC1B,IAAA,OAAO,CACL,OAAOA,SAAAA,CAAUC,MAAM,KAAK,QAAA,IAC3BC,KAAMC,CAAAA,OAAO,CAACH,SAAAA,CAAUI,KAAK,CAAA,IAAKJ,UAAUI,KAAK,CAACC,KAAK,CAAC,CAACC,IAAAA,GAAc,OAAOA,IAAAA,KAAS,aACvFJ,KAAMC,CAAAA,OAAO,CAACH,SAAAA,CAAUI,KAAK,CAAA,IAAKJ,SAAUI,CAAAA,KAAK,CAACC,KAAK,CAAC,CAACC,IAAAA,GAAc,OAAOA,IAAAA,KAAS,QACxF,CAAA,IAAA,OAAON,UAAUI,KAAK,KAAK,QAC3B,IAAA,OAAOJ,SAAUI,CAAAA,KAAK,KAAK,QAAA,IAC3B,OAAOJ,SAAUI,CAAAA,KAAK,KAAK,SAAA,IAC3BJ,SAAUI,CAAAA,KAAK,YAAYG,IAAG,MAC1BP,SAAAA,CAAUQ,QAAQ,GAAG,OAAOR,SAAAA,CAAUQ,QAAQ,KAAK,WAAW,IAAG,CAAA;AACzE;;;;"}