[feat] introduce prefixes for saved documents in config

Author: dem1fo

src/config/Config.ts

@@ -23,6 +23,7 @@ export namespace Config {
   }
   export interface ColumnMap {
     columns: Column[];
+    prefix?: string;
     postfix?: string;
   }
   export interface AlgorithmColumns {

src/config/validateConfig.ts

@@ -118,6 +118,7 @@ const checkSource = (source: Config.CoreConfiguration['source']) => {
 const checkDestination = (label: string, destination: Config.FileConfiguration['destination']) => {
   return (
     isObject(`[${label}]`, destination) ||
+    isOptional(`[${label}].prefix?`, destination.prefix, isString) ||
     isOptional(`[${label}].postfix?`, destination.postfix, isString) ||
     checkColumns(`[${label}]`, destination.columns)
   );

src/encoding/base.ts

@@ -84,11 +84,12 @@ export abstract class EncoderBase {
     return this.outputPath;
   }
 
-  // internal helper to return a full name (with a timestamp according to the config)
-  protected getOutputNameFor(baseFileName: string) {
-    let fullName = `${baseFileName}${this.mapping.postfix}`;
-    // TODO: add logic from config
-    return formatName(fullName, new Date());
+  // take a file path, split into filename, apply prefix/postfix, resolve subsitutions, return full path
+  protected getOutputNameFor(filePath: string) {
+    const fileParts = path.parse(filePath);
+    const fileName = `${this.mapping.prefix ?? ''}${fileParts.name}${this.mapping.postfix ?? ''}`;
+    const formatted = formatName(fileName, new Date());
+    return path.join(fileParts.dir, formatted);
   }  
 
   protected withTemporaryFile(outputPath: string, pred: CallableFunction) {

tests/encoding/base.test.ts

@@ -18,6 +18,7 @@ import { EncoderBase } from '@/encoding/base';
 import type { Config } from '@/config/Config';
 
 const BASE_CFG: Config.ColumnMap = {
+  prefix: "PREFIX_",
   postfix: '_POSTFIX',
   columns: [
     { name: 'A', alias: 'col_a' },
@@ -48,12 +49,12 @@ function makeEncoderBase(cfg = BASE_CFG) {
 
 test('EncoderBase::getOutputNameFor', () => {
   let e = makeEncoderBase(BASE_CFG);
-  expect(e.test__getOutputNameFor('output')).toEqual('output_POSTFIX');
+  expect(e.test__getOutputNameFor('output')).toEqual('PREFIX_output_POSTFIX');
 
   BASE_CFG.postfix = '_PF_{{yyyy}}';
   e = makeEncoderBase(BASE_CFG);
   const d = new Date();
-  expect(e.test__getOutputNameFor('output')).toEqual(`output_PF_${d.getFullYear()}`);
+  expect(e.test__getOutputNameFor('output')).toEqual(`PREFIX_output_PF_${d.getFullYear()}`);
 });