@fjell/lib-sequelize 4.4.0 → 4.4.1

package/src/Operations.ts

@@ -1,42 +0,0 @@
-import { Item } from "@fjell/core";
-
-import * as Library from "@fjell/lib";
-import { getAllOperation } from "./ops/all";
-import { getCreateOperation } from "./ops/create";
-import { getFindOperation } from "./ops/find";
-import { getGetOperation } from "./ops/get";
-import { getOneOperation } from "./ops/one";
-import { getRemoveOperation } from "./ops/remove";
-import { getUpdateOperation } from "./ops/update";
-import { ModelStatic } from "sequelize";
-import { Definition } from "@fjell/lib";
-
-export const createOperations = <
-  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,
->(
-    models: Array<ModelStatic<any>>,
-    definition: Definition<V, S, L1, L2, L3, L4, L5>,
-   
-  ): Library.Operations<V, S, L1, L2, L3, L4, L5> => {
-
-  const operations = {} as Library.Operations<V, S, L1, L2, L3, L4, L5>;
-
-  operations.all = getAllOperation<V, S, L1, L2, L3, L4, L5>(models, definition);
-  operations.one = getOneOperation<V, S, L1, L2, L3, L4, L5>(models, definition);
-  operations.create = getCreateOperation<V, S, L1, L2, L3, L4, L5>(models, definition);
-  operations.update = getUpdateOperation<V, S, L1, L2, L3, L4, L5>(models, definition);
-  operations.get = getGetOperation<V, S, L1, L2, L3, L4, L5>(models, definition);
-  operations.remove = getRemoveOperation<V, S, L1, L2, L3, L4, L5>(models, definition);
-  operations.find = getFindOperation<V, S, L1, L2, L3, L4, L5>(models, definition);
-  operations.upsert = () => {
-    throw new Error('Not implemented');
-  };
-
-  return operations;
-}

package/src/Options.ts

@@ -1,41 +0,0 @@
-import * as Library from '@fjell/lib';
-import { Item } from '@fjell/core';
-import deepmerge from 'deepmerge';
-
-export interface Options<
-  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
-> extends Library.Options<V, S, L1, L2, L3, L4, L5> {
-  deleteOnRemove?: boolean;
-}
-
-export const defaultOptions: Options<any, any, any, any, any, any, any> = {
-  deleteOnRemove: false,
-};
-
-export const createOptions = <
-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
->(libOptions?: Options<V, S, L1, L2, L3, L4, L5>): Options<V, S, L1, L2, L3, L4, L5> => {
-  const defaultOptions = {
-    deleteOnRemove: false,
-  } as Options<V, S, L1, L2, L3, L4, L5>;
-
-  const options = Library.createOptions(libOptions);
-
-  const mergedOptions = deepmerge(defaultOptions, options);
-
-  return {
-    ...mergedOptions,
-  } as Options<V, S, L1, L2, L3, L4, L5>;
-}

package/src/QueryBuilder.ts

@@ -1,208 +0,0 @@
-import {
-  CompoundCondition,
-  Condition,
-  EventQuery,
-  isComKey,
-  isCondition,
-  isPriKey,
-  ItemQuery,
-  OrderBy,
-  PriKey,
-  References
-} from '@fjell/core';
-  
-import { ModelStatic, Op } from 'sequelize';
-import LibLogger from '@/logger';
-
-const logger = LibLogger.get('sequelize', 'QueryBuilder');
-
-export type QueryOptions = {
-  where: Record<string, any>;
-  limit?: number;
-  offset?: number;
-  order?: Array<[string, string]>;
-}
-
-const addDeleteQuery = (options: QueryOptions, model: ModelStatic<any>): QueryOptions => {
-  logger.default('Adding Delete Query', { options });
-  if(model.getAttributes().deletedAt) {
-    options.where['deletedAt'] = {
-      [Op.eq]: null
-    }
-  } else if(model.getAttributes().isDeleted) {
-    options.where['isDeleted'] = {
-      [Op.eq]: false
-    }
-  }
-
-  return options;
-}
-  
-const addEventQueries = (
-  options: QueryOptions, events: Record<string, EventQuery>, model: ModelStatic<any>): QueryOptions => {
-  logger.default('Adding Event Queries', { options, events });
-  Object.keys(events).forEach((key: string) => {
-
-    if(!model.getAttributes()[`${key}At`]) {
-      throw new Error(`Event ${key} is not supported on this model, column ${key}At not found`);
-    }
-
-    let whereClauses = {};
-
-    const event = events[key];
-    if (event.start) {
-      whereClauses = { ...whereClauses, [Op.gte]: new Date(event.start) };
-    }
-    if (event.end) {
-      whereClauses = { ...whereClauses, [Op.lt]: new Date(event.end) };
-    }
-
-    if(event.by) {
-      if(!model.getAttributes()[`${key}By`]) {
-        throw new Error(`Event ${key} is not supported on this model, column ${key}By not found`);
-      }
-      whereClauses = { ...whereClauses, [Op.eq]: event.by };
-    }
-
-    options.where[`${key}At`] = whereClauses;
-
-  });
-  return options;
-}
-
-// Add the references to the query
-const addReferenceQueries = (options: any, references: References, model: ModelStatic<any>): any => {
-  logger.default('Adding Reference Queries', { options, references });
-
-  Object.keys(references).forEach((key: string) => {
-    logger.default('Adding Reference Query', { key, references });
-
-    if(!model.getAttributes()[`${key}Id`]) {
-      throw new Error(`Reference ${key} is not supported on this model, column ${key}Id not found`);
-    }
-
-    if (isPriKey(references[key])) {
-      const priKey: PriKey<string> = references[key] as PriKey<string>;
-
-      options.where[`${key}Id`] = {
-        [Op.eq]: priKey.pk
-      }
-    } else if (isComKey(references[key])) {
-      throw new Error('ComKeys are not supported in Sequelize');
-    }
-  });
-  return options;
-}
-
-export const addCompoundCondition = (options: any, compoundCondition: CompoundCondition, model: ModelStatic<any>) => {
-  const where: Record<symbol, any> = {};
-  
-  let compoundOp: symbol;
-  const compoundType = compoundCondition.compoundType;
-  if( compoundType === "AND" ) {
-    compoundOp = Op.and;
-  } else {
-    compoundOp = Op.or;
-  };
-
-  let conditions: Record<symbol, any> = {};
-  compoundCondition.conditions.forEach((condition: Condition | CompoundCondition) => {
-    if(isCondition(condition)) {
-      conditions = addCondition(conditions,condition, model);
-    } else {
-      throw new Error('Nest Compound conditions not supported');
-    }
-  });
-
-  where[compoundOp] = conditions;
-  options.where = where;
-
-  return options;
-}
-
-export const addCondition = (conditions: Record<string, any>, condition: Condition, model: ModelStatic<any>) => {
-  let conditionOp: symbol;
-  const conditionColumn: string = condition.column;
-
-  if(!model.getAttributes()[conditionColumn]) {
-    throw new Error(`Condition column ${conditionColumn} not found on model ${model.name}`);
-  }
-
-  if(condition.operator === '==') {
-    conditionOp = Op.eq;
-  } else if(condition.operator === '<') {
-    conditionOp = Op.lt;
-  } else if(condition.operator === '>') {
-    conditionOp = Op.gt;
-  } else if(condition.operator === '<=') {
-    conditionOp = Op.lte;
-  } else if(condition.operator === '>=') {
-    conditionOp = Op.gte;
-  } else if(condition.operator === 'in') {
-    conditionOp = Op.in;
-  } else {
-    throw new Error(`Operator ${condition.operator} not supported`);
-  }
-
-  conditions[conditionColumn] = {
-    [conditionOp]: condition.value
-  }
-
-  return conditions;
-}
-
-export const buildQuery = (
-  itemQuery: ItemQuery,
-  model: ModelStatic<any>
-): any => {
-  logger.default('build', { itemQuery });
-
-  let options: any = {
-    where: {},
-  };
-
-  if (itemQuery.compoundCondition) {
-    logger.default('Adding Conditions', { compoundCondition: itemQuery.compoundCondition });
-    options = addCompoundCondition(options, itemQuery.compoundCondition, model);
-  }
-
-  // If the model has a deletedAt column, we need to add a delete query
-  if(model.getAttributes().deletedAt || model.getAttributes().isDeleted) {
-    options = addDeleteQuery(options, model);
-  }
-
-  if (itemQuery.refs) {
-    options = addReferenceQueries(options, itemQuery.refs, model);
-  }
-  if (itemQuery.events) {
-    options = addEventQueries(options, itemQuery.events, model);
-  }
-  
-  // TODO: Once we start to support Aggs on the server-side, we'll need to parse agg queries
-  
-  // Apply a limit to the result set
-  if (itemQuery.limit) {
-    logger.default('Limiting to', { limit: itemQuery.limit });
-    options.limit = itemQuery.limit;
-  }
-  
-  // Apply an offset to the result set
-  if (itemQuery.offset) {
-    options.offset = itemQuery.offset;
-  }
-  
-  // Add orderBy to the query
-  if (itemQuery.orderBy) {
-    itemQuery.orderBy.forEach((orderBy: OrderBy) => {
-      if(!model.getAttributes()[orderBy.field]) {
-        throw new Error(`Order by field ${orderBy.field} not found on model ${model.name}`);
-      }
-      options.order = [
-        [orderBy.field, orderBy.direction]
-      ];
-    });
-  }
-
-  return options;
-}
-  

package/src/RowProcessor.ts

@@ -1,23 +0,0 @@
-import { AllItemTypeArrays, Item } from "@fjell/core";
-import { Model } from "sequelize";
-
-import LibLogger from "@/logger";
-import { addKey } from "./KeyMaster";
-
-const logger = LibLogger.get('sequelize', 'RowProcessor');
-
-export const processRow = <S extends string,
-L1 extends string = never,
-L2 extends string = never,
-L3 extends string = never,
-L4 extends string = never,
-L5 extends string = never>(
-    row: Model<any, any>,
-    keyTypes: AllItemTypeArrays<S, L1, L2, L3, L4, L5>
-  ): Item<S, L1, L2, L3, L4, L5> => {
-  logger.default('Processing Row', { row });
-  const item = row.get({ plain: true }) as any;
-  addKey(item, keyTypes);
-  logger.default('Processed Row: ' + JSON.stringify(item));
-  return item as Item<S, L1, L2, L3, L4, L5>;
-};

package/src/contained/Instance.ts

@@ -1,44 +0,0 @@
-import { Instance as AbstractSequelizeInstance } from '@/Instance';
-import { Item, ItemTypeArray } from '@fjell/core';
-import { Contained } from '@fjell/lib';
-import { createDefinition } from '@/Definition';
-import { createOperations } from '@/Operations';
-import { ModelStatic } from 'sequelize';
-
-export interface Instance<
-  V extends Item<S>,
-  S extends string,
-  L1 extends string = never,
-  L2 extends string = never,
-  L3 extends string = never,
-  L4 extends string = never,
-  L5 extends string = never
-> extends AbstractSequelizeInstance<V, S, L1, L2, L3, L4, L5> {
-  models: ModelStatic<any>[];
-}
- 
-export function createInstance<
-  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
->(
-  keyTypes: ItemTypeArray<S, L1, L2, L3, L4, L5>,
-  models: ModelStatic<any>[],
-  libOptions: Contained.Options<V, S, L1, L2, L3, L4, L5> = {},
-  scopes: string[] = [],
-): Instance<V, S, L1, L2, L3, L4, L5> {
-
-  const definition = createDefinition(keyTypes, scopes, libOptions);
-  const operations = createOperations(models, definition);
-
-  return {
-    definition,
-    operations: Contained.wrapOperations(operations, definition),
-    models
-  } as Instance<V, S, L1, L2, L3, L4, L5>;
-
-}

package/src/contained/index.ts

@@ -1 +0,0 @@
-export * from './Instance';

package/src/index.ts

@@ -1,7 +0,0 @@
-export * from './Coordinate';
-export * from './Definition';
-export * from './Instance';
-export * from './Options';
-export * from './Operations';
-export * as Contained from './contained';
-export * as Primary from './primary';

package/src/logger.ts

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

package/src/ops/all.ts

@@ -1,76 +0,0 @@
-import { validateKeys } from "@fjell/core";
-
-import { buildQuery } from "@/QueryBuilder";
-
-import { Definition } from "@/Definition";
-import LibLogger from '@/logger';
-import { processRow } from "@/RowProcessor";
-import { Item, ItemQuery, LocKeyArray } from "@fjell/core";
-import { Association, ModelStatic, Op } from "sequelize";
-
-const logger = LibLogger.get('sequelize', 'ops', 'all');
-
-export const getAllOperation = <
-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
->(models: ModelStatic<any>[], definition: Definition<V, S, L1, L2, L3, L4, L5>) => {
-
-  const { coordinate } = definition;
-
-  //#region Query
-  const all = async (
-    itemQuery: ItemQuery,
-    locations?: LocKeyArray<L1, L2, L3, L4, L5> | [] | undefined,
-     
-  ): Promise<V[]> => {
-    logger.default('All', { itemQuery, locations });
-    const loc: LocKeyArray<L1, L2, L3, L4, L5> | [] = locations || [];
-
-    // SQ Libs don't support locations
-    if( loc.length > 1 ) {
-      throw new Error('Not implemented for more than one location key');
-    }
-
-    // We have the model here?
-    // @ts-ignore
-    const model = models[0];
-    
-    // We have the model here?
-    const options = buildQuery(itemQuery, model);
-
-    // If this has a location array, we need to add a where clause
-    if( loc.length === 1 ) {
-      const locKeyType = loc[0].kt;
-      if( model.associations[locKeyType] ) {
-        const association: Association<any, any> = model.associations[locKeyType];
-        options.where = {
-          ...options.where,
-          [association.foreignKey]: {
-            [Op.eq]: loc[0].lk
-          }
-        };
-      } else {
-        logger.error('Location key type not found in sequelize model association for: %s', locKeyType);
-        throw new Error('Location key type not found in model');
-      }
-    }
-
-    logger.default('Configured this Item Query', { itemQuery, options });
-
-    const matchingItems = await model.findAll(options);
-
-    // this.logger.default('Matching Items', { matchingItems });
-
-    // TODO: Move this Up!
-    return matchingItems.map((row: any) => validateKeys(processRow(row, coordinate.kta), coordinate.kta)) as V[];
-  }
-
-  return all;
-
-}
-

package/src/ops/create.ts

@@ -1,40 +0,0 @@
-import { ComKey, Item, LocKeyArray, PriKey, TypesProperties } from "@fjell/core";
-
-import LibLogger from '@/logger';
-import { ModelStatic } from "sequelize";
-import { Definition } from "@/Definition";
-
-const logger = LibLogger.get('sequelize', 'ops', 'create');
-
-export const getCreateOperation = <
-  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
->(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    models: ModelStatic<any>[],
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    definition: Definition<V, S, L1, L2, L3, L4, L5>,
-  ) => {
-
-  const create = async (
-    item: TypesProperties<V, S, L1, L2, L3, L4, L5>,
-    options? :     {
-      key: PriKey<S> | ComKey<S, L1, L2, L3, L4, L5>,
-      locations?: never;
-    } | {
-      key?: never;
-      locations: LocKeyArray<L1, L2, L3, L4, L5>,
-    },
-  ): Promise<V> => {
-    logger.default('Create', { item, options });
-
-    throw new Error('Not implemented');
-  }
-
-  return create;
-}

package/src/ops/find.ts

@@ -1,49 +0,0 @@
-import { Item, LocKeyArray } from "@fjell/core";
-
-import { Definition } from "@/Definition";
-import LibLogger from '@/logger';
-import { ModelStatic } from "sequelize";
-
-const logger = LibLogger.get('sequelize', 'ops', 'find');
-
-export const getFindOperation = <
-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
->(
-    models: ModelStatic<any>[],
-    definition: Definition<V, S, L1, L2, L3, L4, L5>,
-  ) => {
-
-  const { options } = definition;
-
-  const find = async (
-    finder: string,
-    finderParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
-    locations?: LocKeyArray<L1, L2, L3, L4, L5> | [],
-     
-  ): Promise<V[]> => {
-    logger.default('Find', { finder, finderParams, locations });
-
-    // Note that we execute the createFinders function here because we want to make sure we're always getting the
-    // most up to date methods.
-    if(options.finders && options.finders[finder]) {
-      const finderMethod  = options.finders[finder];
-      if (finderMethod) {
-        return finderMethod(finderParams, locations) as Promise<V[]>;
-      } else {
-        logger.error(`Finder %s not found`, finder);
-        throw new Error(`Finder ${finder} not found`);
-      }
-    } else {
-      logger.error(`No finders have been defined for this lib`);
-      throw new Error(`No finders found`);
-    }
-  }
-
-  return find;
-}

package/src/ops/get.ts

@@ -1,67 +0,0 @@
-import {
-  ComKey,
-  isComKey,
-  isPriKey,
-  isValidItemKey,
-  Item,
-  PriKey,
-  validateKeys
-} from '@fjell/core';
-
-import LibLogger from '@/logger';
-import { ModelStatic } from 'sequelize';
-import { processRow } from '@/RowProcessor';
-import { Definition } from '@/Definition';
-import { NotFoundError } from '@fjell/lib';
-
-const logger = LibLogger.get('sequelize', 'ops', 'get');
-
-export const getGetOperation = <
-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
->(
-    models: Array<ModelStatic<any>>,
-    definition: Definition<V, S, L1, L2, L3, L4, L5>,
-  ) => {
-
-  const { coordinate } = definition;
-  const { kta } = coordinate;
-
-  const get = async (
-    key: PriKey<S> | ComKey<S, L1, L2, L3, L4, L5>,
-  ): Promise<V> => {
-    logger.default('Get', { key });
-    if (!isValidItemKey(key)) {
-      logger.error('Key for Get is not a valid ItemKey: %j', key);
-      throw new Error('Key for Get is not a valid ItemKey');
-    }
-
-    const itemKey = key;
-
-    // @ts-ignore
-    const model = models[0];
-
-    let item;
-
-    if( isPriKey(itemKey) ) {
-      item = await model.findByPk((itemKey as PriKey<S>).pk);
-    } else if( isComKey(itemKey) ) {
-      const comKey = itemKey as ComKey<S, L1, L2, L3, L4, L5>;
-      // TODO: This should probably interrogate the model?
-      item = await model.findOne({ where: { id: comKey.pk, [comKey?.loc[0]?.kt + 'Id']: comKey?.loc[0]?.lk } });
-    }
-
-    if (!item) {
-      throw new NotFoundError<S, L1, L2, L3, L4, L5>('get', coordinate, key);
-    } else {
-      return validateKeys(processRow(item, kta), kta) as V;
-    }
-  }
-
-  return get;
-}

package/src/ops/one.ts

@@ -1,37 +0,0 @@
-import { Item, ItemQuery, LocKeyArray } from "@fjell/core";
-
-import { Definition } from "@/Definition";
-import LibLogger from '@/logger';
-import { ModelStatic } from "sequelize";
-import { getAllOperation } from "./all";
-
-const logger = LibLogger.get('sequelize', 'ops', 'one');
-
-export const getOneOperation = <
-  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
->(
-    models: ModelStatic<any>[],
-    definition: Definition<V, S, L1, L2, L3, L4, L5>,
-  ) => {
-  const one = async (
-    itemQuery: ItemQuery,
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = [],
-  ): Promise<V | null> => {
-    logger.default('One', { itemQuery, locations });
-
-    const items = await getAllOperation(models, definition)(itemQuery, locations);
-    if (items.length > 0) {
-      return items[0] as V;
-    } else {
-      return null;
-    }
-  }
-
-  return one;
-}