@fjell/lib-sequelize 4.4.0 → 4.4.2

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;
-}

package/src/ops/remove.ts

@@ -1,81 +0,0 @@
-import { ComKey, isValidItemKey, PriKey } from "@fjell/core";
-
-import { abbrevIK, isComKey, isPriKey, Item, ItemProperties } from "@fjell/core";
-
-import { Definition } from "@/Definition";
-import { populateEvents } from "@/EventCoordinator";
-import { populateKey } from "@/KeyMaster";
-import LibLogger from '@/logger';
-import { ModelStatic } from "sequelize";
-
-const logger = LibLogger.get('sequelize', 'ops', 'remove');
-
-export const getRemoveOperation = <
-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, options } = definition;
-  const { kta } = coordinate;
-
-  const remove = async (
-    key: PriKey<S> | ComKey<S, L1, L2, L3, L4, L5>,
-  ): Promise<V> => {
-    logger.default('Remove', { key });
-
-    if (!isValidItemKey(key)) {
-      logger.error('Key for Remove is not a valid ItemKey: %j', key);
-      throw new Error('Key for Remove is not a valid ItemKey');
-    }
-
-    // @ts-ignore
-    const model = models[0];
-
-    let item;
-    let returnItem;
-
-    logger.debug('remove: %s', abbrevIK(key));
-    if( isPriKey(key) ) {
-      item = await model.findByPk((key as PriKey<S>).pk);
-    } else if( isComKey(key) ) {
-      const comKey = key as ComKey<S, L1, L2, L3, L4, L5>;
-      item = await model.findOne({ where: { id: comKey.pk, [comKey?.loc[0]?.kt + 'Id']: comKey?.loc[0]?.lk } });
-    }
-
-    const isDeletedAttribute = model.getAttributes().isDeleted;
-    const deletedAtAttribute = model.getAttributes().deletedAt;
-
-    if( isDeletedAttribute || deletedAtAttribute ) {
-      if( model.getAttributes().isDeleted ) {
-        item.isDeleted = true;
-      }
-    
-      if( model.getAttributes().deletedAt ) {
-        item.deletedAt = new Date();
-      }
-
-      // Save the object
-      await item?.save();
-      returnItem = item?.get({ plain: true }) as ItemProperties<S, L1, L2, L3, L4, L5>;
-      returnItem = populateKey(returnItem, kta);
-      returnItem = populateEvents(returnItem);
-    } else if( options.deleteOnRemove ) {
-      await item?.destroy();
-      returnItem = item?.get({ plain: true }) as ItemProperties<S, L1, L2, L3, L4, L5>;
-      returnItem = populateKey(returnItem, kta);
-      returnItem = populateEvents(returnItem);
-    } else {
-      throw new Error('No deletedAt or isDeleted attribute found in model, and deleteOnRemove is not set');
-    }
-    return returnItem as V;
-  }
-
-  return remove;
-}

package/src/ops/update.ts

@@ -1,78 +0,0 @@
-import { abbrevIK, isComKey, ItemProperties } from "@fjell/core";
-
-import { isPriKey } from "@fjell/core";
-
-import { ComKey, Item, PriKey, TypesProperties } from "@fjell/core";
-
-import { Definition } from "@/Definition";
-import { populateEvents, removeEvents } from "@/EventCoordinator";
-import { populateKey, removeKey } from "@/KeyMaster";
-import LibLogger from '@/logger';
-import { ModelStatic } from "sequelize";
-import { NotFoundError } from "@fjell/lib";
-
-const logger = LibLogger.get('sequelize', 'ops', 'update');
-
-export const getUpdateOperation = <
-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 update = async (
-    key: PriKey<S> | ComKey<S, L1, L2, L3, L4, L5>,
-    item: TypesProperties<V, S, L1, L2, L3, L4, L5>,
-  ): Promise<V> => {
-    const { coordinate } = definition;
-    const { kta } = coordinate;
-
-    logger.debug('update: %s, %j', abbrevIK(key), item);
-    // Find the object we're updating
-    // @ts-ignore
-    const model = models[0];
-
-    let response;
-
-    if( isPriKey(key) ) {
-    // Find the model by using the PK
-      const priKey = key as PriKey<S>;
-      response = await model.findByPk(priKey.pk);
-    } else if( isComKey(key) ) {
-      const comKey = key as ComKey<S, L1, L2, L3, L4, L5>;
-      // Find the model by using both of the identifiers.
-      response = await model.findOne({ where: {
-        [comKey?.loc[0]?.kt + 'Id']: comKey?.loc[0]?.lk,
-        id: comKey?.pk
-      } });
-    }
-
-    if( response ) {
-    
-      // Remove the key and events
-      let updateProps = removeKey(item)
-      updateProps = removeEvents(item);
-
-      // Update the object
-      response = { ...response, ...updateProps };
-      await response?.save();
-    
-      // Populate the key and events
-      let returnItem = response?.get({ plain: true }) as ItemProperties<S, L1, L2, L3, L4, L5>;
-      returnItem = populateKey(returnItem, kta);
-      returnItem = populateEvents(returnItem);
-      return returnItem as V;
-    } else {
-      throw new NotFoundError<S, L1, L2, L3, L4, L5>('update', coordinate, key);
-    }
-
-  }
-
-  return update;
-}

package/src/primary/Instance.ts

@@ -1,40 +0,0 @@
-import { Instance as AbstractSequelizeInstance } from '@/Instance';
-import { Item } from '@fjell/core';
-import { Primary } from '@fjell/lib';
-import { createDefinition } from '@/Definition';
-import { createOperations } from '@/Operations';
-import { ModelStatic } from 'sequelize';
-import { Options } from '@/Options';
-
-import LibLogger from '@/logger';
-
-const logger = LibLogger.get('lib-sequelize', 'primary', 'instance');
-
-export interface Instance<
-  V extends Item<S>,
-  S extends string
-> extends AbstractSequelizeInstance<V, S> {
-  models: ModelStatic<any>[];
-}
- 
-export function createInstance<
-  V extends Item<S>,
-  S extends string
->(
-  keyType: S,
-  models: ModelStatic<any>[],
-  libOptions: Options<V, S> = {},
-  scopes: string[] = [],
-): Instance<V, S> {
-  logger.debug('createInstance', { keyType, models, libOptions, scopes });
-  const definition = createDefinition([keyType], scopes, libOptions);
-
-  const operations = createOperations(models, definition);
-
-  return {
-    definition,
-    operations: Primary.wrapOperations(operations, definition),
-    models
-  } as Instance<V, S>;
-
-}

package/src/primary/index.ts

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