@natlibfi/melinda-rest-api-commons 6.1.0-alpha.0 → 6.2.0-alpha.0

package/{tests/testUtils.js → test/testUtils.ts}

@@ -1,23 +1,39 @@
-
 import assert from 'node:assert';
 import createDebugLogger from 'debug';
-import createMongoOperator from '../src/mongo.js';
+import type {Readable} from 'node:stream';
+import createMongoOperator from '../src/mongo.ts';
 
 
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:test');
 
-export async function getMongoOperator(mongoFixtures) {
+// the fixura-mongo fixtures object is intentionally untyped in tests
+// (fixture-driven scaffolding, see the eslint house rules for test/)
+export async function getMongoOperator(mongoFixtures: any) {
   const mongoUri = await mongoFixtures.getUri();
   const mongoOperator = await createMongoOperator(mongoUri, 'foobar', '');
   return mongoOperator;
 }
 
-export async function compareToFirstDbEntry({mongoFixtures, expectedResult, expectModificationTime = false, formatDates = true, expectedFileCount = undefined}) {
+interface DbEntryCompareParams {
+  mongoFixtures: any;
+  expectedResult: unknown;
+  expectModificationTime?: boolean;
+  formatDates?: boolean;
+  expectedFileCount?: number;
+}
+
+export async function compareToFirstDbEntry(params: DbEntryCompareParams) {
+  const {mongoFixtures, expectedResult, expectModificationTime = false, formatDates = true, expectedFileCount = undefined} = params;
   const result = await compareToDbEntry({mongoFixtures, expectedResult, resultIndex: 0, expectModificationTime, formatDates, expectedFileCount});
   return result;
 }
 
-export async function compareToDbEntry({mongoFixtures, expectedResult, resultIndex = 0, expectModificationTime = false, formatDates = true, expectedFileCount = undefined}) {
+interface DbEntryParams extends DbEntryCompareParams {
+  resultIndex?: number;
+}
+
+export async function compareToDbEntry(params: DbEntryParams) {
+  const {mongoFixtures, expectedResult, resultIndex = 0, expectModificationTime = false, formatDates = true, expectedFileCount = undefined} = params;
   const dump = await mongoFixtures.dump();
   debug(`--- We have ${dump.foobar.length} documents in db`);
   debug(dump.foobar);
@@ -39,7 +55,13 @@ export async function compareToDbEntry({mongoFixtures, expectedResult, resultInd
   return;
 }
 
-function checkFileCount({dump, expectedFileCount}) {
+interface CheckFileCountParams {
+  dump: any;
+  expectedFileCount: number | undefined;
+}
+
+function checkFileCount(params: CheckFileCountParams) {
+  const {dump, expectedFileCount} = params;
   if (expectedFileCount !== undefined) {
     const fileCount = dump['foobar.files']?.length;
     debug(`--- We have ${fileCount} files in db`);
@@ -50,7 +72,13 @@ function checkFileCount({dump, expectedFileCount}) {
 
 }
 
-function checkModificationTime({result, expectModificationTime}) {
+interface CheckModificationTimeParams {
+  result: any;
+  expectModificationTime: boolean;
+}
+
+function checkModificationTime(params: CheckModificationTimeParams) {
+  const {result, expectModificationTime} = params;
   if (expectModificationTime) {
     debug('Check if modificationTime was edited');
     const isNotEmpty = result.modificationTime !== '';
@@ -62,7 +90,7 @@ function checkModificationTime({result, expectModificationTime}) {
 }
 
 
-export function formatQueueItem(queueItem) {
+export function formatQueueItem(queueItem: any): any {
   const filteredQueueItem = {
     ...queueItem,
     creationTime: '',
@@ -72,12 +100,19 @@ export function formatQueueItem(queueItem) {
   return filteredQueueItem;
 }
 
-export function handleError({error, expectedToThrow, expectedErrorMessage, expectedErrorStatus}) {
+interface HandleErrorParams {
+  error: any;
+  expectedToThrow: boolean;
+  expectedErrorMessage: string;
+  expectedErrorStatus: string;
+}
+
+export function handleError(params: HandleErrorParams) {
+  const {error, expectedToThrow, expectedErrorMessage, expectedErrorStatus} = params;
   debug(error);
   if (expectedToThrow) {
     debug('OK. Expected to throw');
     debug(JSON.stringify(error));
-    // eslint-disable-next-line max-lines
     if (expectedErrorMessage !== '' || expectedErrorStatus !== '') {
       const errorMessage = error.message || error.payload.message || error.payload || '';
       debug(errorMessage);
@@ -92,12 +127,11 @@ export function handleError({error, expectedToThrow, expectedErrorMessage, expec
   throw error;
 }
 
-export function streamToString(stream) {
-  const chunks = [];
+export function streamToString(stream: Readable): Promise<string> {
+  const chunks: Buffer[] = [];
   return new Promise((resolve, reject) => {
-    // eslint-disable-next-line functional/immutable-data
-    stream.on('data', (chunk) => chunks.push(Buffer.from(chunk)));
-    stream.on('error', (err) => reject(err));
+    stream.on('data', (chunk: Buffer) => chunks.push(Buffer.from(chunk)));
+    stream.on('error', (err: unknown) => reject(err));
     stream.on('end', () => resolve(Buffer.concat(chunks).toString('utf8')));
   });
 }

package/{tests/utils.test.js → test/utils.test.ts}

@@ -9,7 +9,7 @@ import {
   createRecordResponseItem,
   addRecordResponseItem,
   addRecordResponseItems
-} from '../src/utils.js';
+} from '../src/utils.ts';
 
 test('createImportJobState should return state object for valid operation and state', () => {
   const result = createImportJobState('CREATE', 'EMPTY');
@@ -267,9 +267,9 @@ test('createRecordResponseItem should map UNKNOWN status to ERROR with ids', ()
 });
 
 test('addRecordResponseItem should push the recordResponseItem via mongoOperator', async () => {
-  let captured;
+  let captured: unknown;
   const mongoOperator = {
-    pushMessages: async (args) => {
+    pushMessages: async (args: unknown) => {
       captured = args;
     }
   };
@@ -304,10 +304,10 @@ test('addRecordResponseItem should throw for non-object input', async () => {
 });
 
 test('addRecordResponseItems should push all items in one call', async () => {
-  let captured;
+  let captured: unknown;
   let callCount = 0;
   const mongoOperator = {
-    pushMessages: async (args) => {
+    pushMessages: async (args: unknown) => {
       callCount += 1;
       captured = args;
     }

package/tsconfig.json

@@ -0,0 +1,62 @@
+{
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ],
+  "compilerOptions": {
+    // File Layout
+    "rootDir": "./src",
+    "outDir": "./dist",
+    // Environment Settings
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "target": "esnext",
+    "typeRoots": [
+      "./node_modules/@types"
+    ],
+    "types": [
+      "node"
+    ],
+    "lib": [
+      "esnext"
+    ],
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    // Style Options
+    "noImplicitReturns": true,
+    "noImplicitOverride": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "noPropertyAccessFromIndexSignature": true,
+    // Recommended Options
+    "strict": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+    "allowImportingTsExtensions": true,
+    "noEmit": false,
+    // Customized options
+    "allowJs": true,
+    "checkJs": true,
+    "esModuleInterop": true,
+    "allowUnreachableCode": false,
+    "strictFunctionTypes": true,
+    "strictNullChecks": true,
+    "removeComments": true,
+    // Only allow syntax accepted by Node >= 23.6
+    "erasableSyntaxOnly": true,
+    // Proposed options from Node docs: https://nodejs.org/api/typescript.html#type-stripping
+    "rewriteRelativeImportExtensions": true,
+    "verbatimModuleSyntax": true,
+    "forceConsistentCasingInFileNames": true
+  }
+}

package/tsconfig.test.json

@@ -0,0 +1,17 @@
+{
+  "extends": "./tsconfig.json",
+  "include": [
+    "src",
+    "test"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ],
+  "compilerOptions": {
+    // Typechecking only — never emits. The build config (tsconfig.json)
+    // keeps rootDir ./src so `npm run build` still emits only src/ -> dist/.
+    "noEmit": true,
+    "rootDir": "."
+  }
+}

package/dist/helpers/fix-utils.js

@@ -1,39 +0,0 @@
-export function removeSubfield(field, code) {
-  if (!isNaN(field.tag) && parseInt(field.tag, 10) >= 10) {
-    const filteredSubfields = field.subfields.filter((sf) => sf.code !== code);
-    if (filteredSubfields.length < 1) {
-      return false;
-    }
-    return {
-      tag: field.tag,
-      ind1: field.ind1,
-      ind2: field.ind2,
-      subfields: filteredSubfields
-    };
-  }
-  return field;
-}
-export function sortFieldsBySubfieldValue(fields, subfieldCode) {
-  return [...fields].sort((a, b) => {
-    const a1value = getFirstSubfieldValue(a, subfieldCode);
-    const b1value = getFirstSubfieldValue(b, subfieldCode);
-    if (a1value && !b1value) {
-      return -1;
-    }
-    if (!a1value && b1value) {
-      return 1;
-    }
-    if (a1value > b1value) {
-      return 1;
-    }
-    if (b1value > a1value) {
-      return -1;
-    }
-    return 0;
-  });
-  function getFirstSubfieldValue(field, subfieldCode2) {
-    const subs = field.subfields ? field.subfields.filter((subf) => subf.code === subfieldCode2) : [];
-    return subs.length > 0 ? subs[0].value : "";
-  }
-}
-//# sourceMappingURL=fix-utils.js.map

package/dist/helpers/fix-utils.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../src/helpers/fix-utils.js"],
-  "sourcesContent": ["export function removeSubfield(field, code) {\n\n  // Handle non-numeric fields, and fields with a numeric tag of 010 and greater\n  // Aleph's FMT as a controlfield might be a problem\n  if (!isNaN(field.tag) && parseInt(field.tag, 10) >= 10) {\n\n    const filteredSubfields = field.subfields.filter(sf => sf.code !== code);\n\n    // Remove whole field if there are no subfields left\n    if (filteredSubfields.length < 1) {\n      return false;\n    }\n\n    return {\n      tag: field.tag,\n      ind1: field.ind1,\n      ind2: field.ind2,\n      subfields: filteredSubfields\n    };\n  }\n  // return controlFields as is\n  return field;\n}\n\n\n// sort fields by value of each fields first subfield with subfielCode\nexport function sortFieldsBySubfieldValue(fields, subfieldCode) {\n  return [...fields].sort((a, b) => {\n    const a1value = getFirstSubfieldValue(a, subfieldCode);\n    const b1value = getFirstSubfieldValue(b, subfieldCode);\n    if (a1value && !b1value) {\n      return -1;\n    }\n    if (!a1value && b1value) {\n      return 1;\n    }\n    if (a1value > b1value) {\n      return 1;\n    }\n    if (b1value > a1value) {\n      return -1;\n    }\n    return 0;\n  });\n  // get value for the for instance of subfield with subfieldCode\n  function getFirstSubfieldValue(field, subfieldCode) {\n    const subs = field.subfields ? field.subfields.filter(subf => subf.code === subfieldCode) : [];\n    return subs.length > 0 ? subs[0].value : '';\n  }\n}\n"],
-  "mappings": "AAAO,gBAAS,eAAe,OAAO,MAAM;AAI1C,MAAI,CAAC,MAAM,MAAM,GAAG,KAAK,SAAS,MAAM,KAAK,EAAE,KAAK,IAAI;AAEtD,UAAM,oBAAoB,MAAM,UAAU,OAAO,QAAM,GAAG,SAAS,IAAI;AAGvE,QAAI,kBAAkB,SAAS,GAAG;AAChC,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,MACL,KAAK,MAAM;AAAA,MACX,MAAM,MAAM;AAAA,MACZ,MAAM,MAAM;AAAA,MACZ,WAAW;AAAA,IACb;AAAA,EACF;AAEA,SAAO;AACT;AAIO,gBAAS,0BAA0B,QAAQ,cAAc;AAC9D,SAAO,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,GAAG,MAAM;AAChC,UAAM,UAAU,sBAAsB,GAAG,YAAY;AACrD,UAAM,UAAU,sBAAsB,GAAG,YAAY;AACrD,QAAI,WAAW,CAAC,SAAS;AACvB,aAAO;AAAA,IACT;AACA,QAAI,CAAC,WAAW,SAAS;AACvB,aAAO;AAAA,IACT;AACA,QAAI,UAAU,SAAS;AACrB,aAAO;AAAA,IACT;AACA,QAAI,UAAU,SAAS;AACrB,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT,CAAC;AAED,WAAS,sBAAsB,OAAOA,eAAc;AAClD,UAAM,OAAO,MAAM,YAAY,MAAM,UAAU,OAAO,UAAQ,KAAK,SAASA,aAAY,IAAI,CAAC;AAC7F,WAAO,KAAK,SAAS,IAAI,KAAK,CAAC,EAAE,QAAQ;AAAA,EAC3C;AACF;",
-  "names": ["subfieldCode"]
-}

package/eslint.config.js

@@ -1,53 +0,0 @@
-// Eslint configuration object for src
-const configSrc = {
-  files: [
-    "src/*",
-    "tests/*"
-  ],
-  linterOptions: {
-    reportUnusedDisableDirectives: true,
-  },
-  rules: {
-    "no-console": "warn",
-    "eqeqeq": ["error", "always"],
-    "no-const-assign": "error",
-    "max-depth": ["warn", 4],
-    "max-lines": ["warn", 500],
-    "max-lines-per-function": ["warn", {"max": 100}],
-    "no-else-return": ["error", {allowElseIf: false}],
-    "no-plusplus": [
-      "error",
-      {
-        "allowForLoopAfterthoughts": true
-      }
-    ],
-    "array-callback-return": [
-      "error",
-      {
-        "checkForEach": false
-      }
-    ],
-    "no-unused-vars": [
-      "error",
-      {
-        "argsIgnorePattern": "next"
-      }
-    ],
-    "no-warning-comments": "off"
-  }
-};
-
-// Eslint configuration object for globally ignoring .js files
-// - ignore all files that start with a dot
-// - ignore all files inside directories named 'dist'
-const configIgnores = {
-  ignores: [
-    "**/.*",
-    "**/dist/"
-  ]
-};
-
-export default [
-  configSrc,
-  configIgnores
-];