@fjell/lib-sequelize 4.3.1

package/dist/src/primary/Instance.js

@@ -0,0 +1,17 @@
+import { Primary } from '@fjell/lib';
+import { createDefinition } from '../Definition';
+import { createOperations } from '../Operations';
+import LibLogger from '../logger';
+const logger = LibLogger.get('lib-sequelize', 'primary', 'instance');
+// eslint-disable-next-line max-params
+export function createInstance(keyType, models, libOptions = {}, scopes = []) {
+    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
+    };
+}
+//# sourceMappingURL=Instance.js.map

package/dist/src/primary/Instance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Instance.js","sourceRoot":"","sources":["../../../src/primary/Instance.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAIhD,OAAO,SAAS,MAAM,UAAU,CAAC;AAEjC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,eAAe,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;AASrE,sCAAsC;AACtC,MAAM,UAAU,cAAc,CAI5B,OAAU,EACV,MAA0B,EAC1B,aAA4B,EAAE,EAC9B,SAAmB,EAAE;IAErB,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC;IACxE,MAAM,UAAU,GAAG,gBAAgB,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAEnE,MAAM,UAAU,GAAG,gBAAgB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAExD,OAAO;QACL,UAAU;QACV,UAAU,EAAE,OAAO,CAAC,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC;QAC1D,MAAM;KACW,CAAC;AAEtB,CAAC"}

package/dist/src/primary/index.d.ts

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

package/dist/src/primary/index.js

@@ -0,0 +1,2 @@
+export * from './Instance';
+//# sourceMappingURL=index.js.map

package/dist/src/primary/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/primary/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}

package/eslint.config.mjs

@@ -0,0 +1,70 @@
+import typescriptEslint from "@typescript-eslint/eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all
+});
+
+export default [{
+  ignores: ["**/dist", "**/node_modules"],
+}, ...compat.extends("plugin:@typescript-eslint/recommended"), {
+  plugins: {
+    "@typescript-eslint": typescriptEslint,
+  },
+
+  languageOptions: {
+    parser: tsParser,
+  },
+
+  rules: {
+    "@typescript-eslint/no-unused-expressions": "off",
+    "no-console": 0,
+    "no-unused-vars": "off",
+
+    "max-len": ["error", {
+      code: 120,
+    }],
+
+    "max-depth": ["error", 4],
+    "max-params": ["error", 4],
+    "max-lines": ["error", 500],
+
+    "no-multiple-empty-lines": ["error", {
+      max: 1,
+      maxEOF: 1,
+    }],
+
+    "no-trailing-spaces": ["error", {
+      skipBlankLines: true,
+    }],
+
+    indent: ["error", 2, {
+      SwitchCase: 1,
+    }],
+
+    "sort-imports": ["error", {
+      ignoreCase: true,
+      ignoreDeclarationSort: true,
+      ignoreMemberSort: false,
+      memberSyntaxSortOrder: ["none", "all", "multiple", "single"],
+    }],
+
+    "no-var": "error",
+    "no-undefined": "error",
+    "@typescript-eslint/no-unused-vars": "error",
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+
+    "no-restricted-imports": ["error", {
+      patterns: ["..*", "src/*"],
+    }],
+  },
+}];

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@fjell/lib-sequelize",
+  "version": "4.3.1",
+  "license": "UNLICENSED",
+  "description": "Sequelize Library for Fjell",
+  "engines": {
+    "node": ">=21"
+  },
+  "main": "dist/src/index.js",
+  "exports": {
+    ".": {
+      "require": "./dist/src/index.js",
+      "import": "./dist/src/index.js",
+      "types": "./dist/src/index.d.ts"
+    }
+  },
+  "type": "module",
+  "scripts": {
+    "build": "yarn run lint && tsc && tsc-alias -p tsconfig.json",
+    "dev": "concurrently \"tsc -w\" \"tsc-alias -w\"",
+    "lint": "eslint .",
+    "clean": "rimraf dist",
+    "test": "yarn run lint && NODE_OPTIONS='--experimental-require-module' yarn run jest --coverage"
+  },
+  "dependencies": {
+    "@fjell/core": "^4.3.1",
+    "@fjell/lib": "^4.3.0",
+    "@fjell/logging": "^4.3.4",
+    "dayjs": "^1.11.13",
+    "deepmerge": "^4.3.1",
+    "multer": "^1.4.5-lts.1",
+    "sequelize": "^6.37.5",
+    "specifier-resolution-node": "^1.1.4",
+    "winston": "^3.17.0"
+  },
+  "devDependencies": {
+    "@babel/preset-env": "^7.26.9",
+    "@babel/preset-react": "^7.26.3",
+    "@babel/preset-typescript": "^7.26.0",
+    "@tsconfig/recommended": "^1.0.8",
+    "@types/jest": "^29.5.14",
+    "@types/multer": "^1.4.11",
+    "@types/node": "^20.10.4",
+    "@typescript-eslint/eslint-plugin": "^7",
+    "@typescript-eslint/parser": "^7",
+    "concurrently": "^8.2.2",
+    "eslint": "^8.57.1",
+    "jest": "^29.7.0",
+    "nodemon": "^3.1.9",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
+    "tsc-alias": "^1.8.10",
+    "typescript": "^5.7.3"
+  },
+  "packageManager": "yarn@4.6.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/getfjell/lib-sequelize.git"
+  }
+}

package/src/Coordinate.ts

@@ -0,0 +1,16 @@
+import { ItemTypeArray } from '@fjell/core';
+import * as Library from '@fjell/lib';
+
+export const SCOPE_SEQUELIZE = 'sequelize';
+
+export const createCoordinate = <
+  S extends string,
+  L1 extends string = never,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never
+>(kta: ItemTypeArray<S, L1, L2, L3, L4, L5>, scopes?: string[]) => {
+  const coordinate = Library.createCoordinate(kta,[SCOPE_SEQUELIZE, ...(scopes || [])])
+  return coordinate;
+};

package/src/Definition.ts

@@ -0,0 +1,49 @@
+import {
+  Item,
+  ItemTypeArray
+} from '@fjell/core';
+  
+import * as Library from '@fjell/lib';
+import { createCoordinate } from './Coordinate';
+import { createOptions } from './Options';
+import { Options } from './Options';
+import LibLogger from './logger';
+
+const logger = LibLogger.get('lib-sequelize', 'Definition');
+  
+export interface Definition<
+    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.Definition<V, S, L1, L2, L3, L4, L5> {
+    options: Options<V, S, L1, L2, L3, L4, L5>;
+  }
+  
+export function createDefinition<
+    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
+  >(
+  kta: ItemTypeArray<S, L1, L2, L3, L4, L5>,
+  scopes: string[],
+  libOptions?: Options<V, S, L1, L2, L3, L4, L5>,
+): Definition<V, S, L1, L2, L3, L4, L5> {
+  logger.debug('createDefinition', { kta, scopes, libOptions });
+  const coordinate = createCoordinate(kta, scopes);
+  const options = createOptions(libOptions);
+  
+  const definition = Library.createDefinition(coordinate, options);
+  
+  return {
+    ...definition,
+    options,
+  }
+}

package/src/EventCoordinator.ts

@@ -0,0 +1,103 @@
+import {
+  Evented,
+  ItemProperties,
+  ManagedEvents
+} from '@fjell/core';
+import deepmerge from 'deepmerge';
+  
+import LibLogger from '@/logger';
+  
+const logger = LibLogger.get("sequelize", "EventCoordinator");
+  
+export const createEvents = <
+    S extends string,
+    L1 extends string = never,
+    L2 extends string = never,
+    L3 extends string = never,
+    L4 extends string = never,
+    L5 extends string = never
+  >(item: ItemProperties<S, L1, L2, L3, L4, L5>):
+    ItemProperties<S, L1, L2, L3, L4, L5> => {
+  logger.default('Creating Events', { item });
+  const currentDate = new Date();
+  
+  let events = item.events;
+  
+  if (events) {
+    if (!events.created) {
+      events = deepmerge(events, { created: { at: currentDate } });
+    }
+    if (!events.updated) {
+      events = deepmerge(events, { updated: { at: currentDate } });
+    }
+    if (!events.deleted) {
+      events = deepmerge(events, { deleted: { at: null } });
+    }
+  
+  } else {
+    events = {
+      created: { at: currentDate },
+      updated: { at: currentDate },
+      deleted: { at: null },
+    };
+  }
+  
+  return deepmerge(item, { events }) as
+        ItemProperties<S, L1, L2, L3, L4, L5>;
+}
+  
+export const updateEvents = <
+    S extends string,
+    L1 extends string = never,
+    L2 extends string = never,
+    L3 extends string = never,
+    L4 extends string = never,
+    L5 extends string = never
+  >(item: ItemProperties<S, L1, L2, L3, L4, L5>):
+    ItemProperties<S, L1, L2, L3, L4, L5> => {
+  logger.default('Updating Events', { item });
+  const currentDate = new Date();
+  const events: Evented = {
+    updated: { at: currentDate },
+  };
+  
+  // TODO: This is clean-up code, we should remove it
+  // If the event lacks a created data, let's just insert it here...
+  if (!item.events || !item.events.created || !item.events.created.at) {
+    events.created = { at: currentDate };
+  }
+  
+  return deepmerge(item, { events }) as ItemProperties<S, L1, L2, L3, L4, L5>;
+}
+//#endregion
+  
+export const populateEvents = <
+    S extends string,
+    L1 extends string = never,
+    L2 extends string = never,
+    L3 extends string = never,
+    L4 extends string = never,
+    L5 extends string = never
+  >(item: ItemProperties<S, L1, L2, L3, L4, L5>): ItemProperties<S, L1, L2, L3, L4, L5> => {
+  const events: ManagedEvents = {
+    created: { at: item.createdAt },
+    updated: { at: item.updatedAt },
+    deleted: { at: null }
+  };
+  item.events = events;
+  return item;
+}
+
+export const removeEvents = <
+    S extends string,
+    L1 extends string = never,
+    L2 extends string = never,
+    L3 extends string = never,
+    L4 extends string = never,
+    L5 extends string = never
+  >(item: ItemProperties<S, L1, L2, L3, L4, L5>): ItemProperties<S, L1, L2, L3, L4, L5> => {
+  logger.default('Removing Events', { item });
+  delete item.events;
+  return item;
+}
+  

package/src/Instance.ts

@@ -0,0 +1,45 @@
+import * as Library from '@fjell/lib';
+import { Item, ItemTypeArray } from '@fjell/core';
+import { createDefinition } from './Definition';
+import { createOperations } from './Operations';
+import { ModelStatic } from 'sequelize';
+import { Options } from './Options';
+
+export interface Instance<
+  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.Instance<V, S, L1, L2, L3, L4, L5> {
+  models: ModelStatic<any>[];
+}
+
+// eslint-disable-next-line max-params
+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: 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: Library.wrapOperations(operations, definition),
+    models
+  }
+
+}

package/src/KeyMaster.ts

@@ -0,0 +1,90 @@
+import {
+  AllItemTypeArrays,
+  Item,
+  ItemProperties
+} from '@fjell/core';
+  
+import LibLogger from '@/logger';
+
+const logger = LibLogger.get('sequelize', 'KeyMaster');
+
+export const removeKey = <
+  S extends string,
+  L1 extends string = never,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never
+>(
+    item: ItemProperties<S, L1, L2, L3, L4, L5>
+  ): ItemProperties<S, L1, L2, L3, L4, L5> => {
+  logger.default('Removing Key', { item });
+  delete item.key;
+  return item;
+}
+  
+export const populateKey = <
+    S extends string,
+    L1 extends string = never,
+    L2 extends string = never,
+    L3 extends string = never,
+    L4 extends string = never,
+    L5 extends string = never
+  >(
+    item: ItemProperties<S, L1, L2, L3, L4, L5>,
+    keyTypes: AllItemTypeArrays<S, L1, L2, L3, L4, L5>
+  ): ItemProperties<S, L1, L2, L3, L4, L5> => {
+  if( keyTypes.length === 1 ) {
+    item.key = { kt: keyTypes[0], pk: item.id };
+    delete item.id;
+  } else if( keyTypes.length === 2 ) {
+    item.key = {
+      kt: keyTypes[0], pk: item.id,
+      // TODO: Shouldn't this be inspecting the model to get the primary key type?
+      loc: [{ kt: keyTypes[1], lk: item[keyTypes[1] + 'Id']}],
+    };
+    delete item.id;
+    delete item[keyTypes[1] + 'Id'];
+  } else {
+    throw new Error('Not implemented');
+  }
+  return item;
+}
+  
+export const addKey = <
+    S extends string,
+    L1 extends string = never,
+    L2 extends string = never,
+    L3 extends string = never,
+    L4 extends string = never,
+    L5 extends string = never
+  >(
+    item: Partial<Item<S, L1, L2, L3, L4, L5>>,
+    keyTypes: AllItemTypeArrays<S, L1, L2, L3, L4, L5>
+  ): void => {
+  logger.default('Adding Key', { item });
+  const key = {};
+  if (Array.isArray(keyTypes) && keyTypes.length > 1) {
+    const type = [...keyTypes];
+    const pkType = type.shift();
+    Object.assign(key, { kt: pkType, pk: item.id });
+    // TODO: This is really just for primary items
+    if (type.length === 1) {
+      // TODO: This should be looking at the model to get the primary key of the reference item or association
+      const locKeyTypeId = type[0] + 'Id';
+      Object.assign(key, { loc: [{ kt: type[0], lk: item[locKeyTypeId] }] });
+    } else if (type.length === 2) {
+      throw new Error('Not implemented');
+    } else if (type.length === 3) {
+      throw new Error('Not implemented');
+    } else if (type.length === 4) {
+      throw new Error('Not implemented');
+    } else if (type.length === 5) {
+      throw new Error('Not implemented');
+    }
+  } else {
+    Object.assign(key, { kt: keyTypes[0], pk: item.id });
+  }
+  Object.assign(item, { key });
+};
+  

package/src/Operations.ts

@@ -0,0 +1,42 @@
+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>,
+  // eslint-disable-next-line max-params
+  ): 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

@@ -0,0 +1,41 @@
+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>;
+}