AGPLv3 license header on all files

Author: dem1fo

src/config/Config.ts

@@ -1,3 +1,19 @@
+// Common Identifier Application
+// Copyright (C) 2024 World Food Programme
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 export namespace Config {
   export interface Column {
     name: string;

src/config/appConfig.ts

@@ -1,19 +1,18 @@
-/*
- * This file is part of Building Blocks CommonID Tool
- * Copyright (c) 2024 WFP
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, version 3.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
+// Common Identifier Application
+// Copyright (C) 2024 World Food Programme
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import fs from 'node:fs';
 import { attemptToReadTOMLData } from './utils.js';

src/config/configStore.ts

@@ -1,22 +1,20 @@
-/*
- * This file is part of Building Blocks CommonID Tool
- * Copyright (c) 2024 WFP
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, version 3.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-
-import { join, dirname } from 'node:path';
-import { fileURLToPath } from 'node:url';
+// Common Identifier Application
+// Copyright (C) 2024 World Food Programme
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import { dirname } from 'node:path';
 import fs from 'node:fs';
 import Debug from 'debug';
 const log = Debug('CID:ConfigStore');
@@ -29,7 +27,7 @@ import type { AppConfigData, Config } from './Config.js';
 // Ensure the application's config file directory exists
 function ensureAppDirectoryExists(appDir: string) {
   if (!fs.existsSync(appDir)) {
-    console.log("Application directory '", appDir, "' does not exits -- creating it");
+    log("Application directory '", appDir, "' does not exits -- creating it");
     fs.mkdirSync(appDir /*, { recursive: true } */);
   }
 }
@@ -42,7 +40,7 @@ function saveConfig(configData: Config.Options, outputPath: string) {
   // update the config hash on import to account for the
   const outputData = JSON.stringify(configData, null, '    ');
   fs.writeFileSync(outputPath, outputData, CONFIG_FILE_ENCODING);
-  console.log('Written config data to ', outputPath);
+  log('Written config data to ', outputPath);
 }
 
 interface ConfigStorePaths {
@@ -110,20 +108,20 @@ export class ConfigStore {
     // if the load succesds we have a valid config -- use it as a
     // user-provided one
     if (userConfigLoad.success) {
-      console.log('User config validation success - using it as config');
+      log('User config validation success - using it as config');
       this.useUserConfig(userConfigLoad.config, userConfigLoad.lastUpdated);
       return;
     }
 
-    console.log('User config validation not successful - attempting to load backup config');
+    log('User config validation not successful - attempting to load backup config');
     // if the default config load failed use the backup default
     // from the app distribution
     const backupConfigLoad = loadConfig(this.getBackupConfigFilePath(), this.getRegion());
 
     // if the load succesds we have a valid config -- use it as
     // a config-from-backup
     if (backupConfigLoad.success) {
-      console.log('Backup config validation success - using it as config');
+      log('Backup config validation success - using it as config');
       backupConfigLoad.config.isBackup = true;
       this.useBackupConfig(backupConfigLoad.config);
       return;
@@ -133,7 +131,7 @@ export class ConfigStore {
     this.loadError = backupConfigLoad.error;
 
     // if the backup config fails to load we are screwed
-    console.log(
+    log(
       'Backup config load failed - the application should alert the user: ',
       backupConfigLoad.error,
     );
@@ -178,21 +176,21 @@ export class ConfigStore {
   // This method does not save the backup as the user config, only deletes the user config file
   removeUserConfig() {
     // attempt to load the backup config
-    console.log('[removeUserConfig] Attempting to remove user configuration and replace with backup.');
+    log('[removeUserConfig] Attempting to remove user configuration and replace with backup.');
 
     // if the current config is already a backup config don't do anything
     if (this.isCurrentConfigBackup()) {
-      console.log('[removeUserConfig] Already using a backup config -- bailing');
+      log('[removeUserConfig] Already using a backup config -- bailing');
       // this is not an error - we're already using the backup
       return;
     }
 
-    console.log('[removeUserConfig] Trying to load backup config file');
+    log('[removeUserConfig] Trying to load backup config file');
     const backupConfigLoad = loadConfig(this.getBackupConfigFilePath(), this.getRegion());
 
     // if failed return the error message (do not delete the user config yet)
     if (!backupConfigLoad.success) {
-      console.log(
+      log(
         'Backup config validation failed -- returning error and keeping existing user config:',
         backupConfigLoad.error,
       );
@@ -203,7 +201,7 @@ export class ConfigStore {
     }
 
     // if successful use the loaded backup configuration
-    console.log('[removeUserConfig] Backup config validation success - using it as config');
+    log('[removeUserConfig] Backup config validation success - using it as config');
     backupConfigLoad.config.isBackup = true;
     this.useBackupConfig(backupConfigLoad.config);
 
@@ -244,7 +242,7 @@ export class ConfigStore {
   // deletes the user configuration file
   _deleteUserConfigFile() {
     const configPath = this.getConfigFilePath();
-    console.log('Deleting config file: ', configPath);
+    log('Deleting config file: ', configPath);
     fs.unlinkSync(configPath);
   }
 

src/config/generateConfigHash.ts

@@ -1,19 +1,18 @@
-/*
- * This file is part of Building Blocks CommonID Tool
- * Copyright (c) 2024 WFP
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, version 3.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
+// Common Identifier Application
+// Copyright (C) 2024 World Food Programme
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import stableStringify from 'safe-stable-stringify';
 import { createHash } from 'node:crypto';
@@ -22,9 +21,7 @@ import type { Config } from './Config.js';
 const DEFAULT_HASH_TYPE = 'md5';
 const HASH_DIGEST_TYPE = 'hex';
 
-type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 type RecursivePartial<T> = { [P in keyof T]?: RecursivePartial<T[P]> };
-type RecursivePartialExcept<T, K extends keyof T> = RecursivePartial<T> & Pick<T, K>;
 
 // Takes a config, removes the "signature" and salt keys from it, generates
 // a stable JSON representation and hashes it using the provided algorithm

src/config/loadConfig.ts

@@ -1,19 +1,18 @@
-/*
- * This file is part of Building Blocks CommonID Tool
- * Copyright (c) 2024 WFP
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, version 3.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
+// Common Identifier Application
+// Copyright (C) 2024 World Food Programme
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import fs from 'node:fs';
 

src/config/loadSaltFile.ts

@@ -1,19 +1,18 @@
-/*
- * This file is part of Building Blocks CommonID Tool
- * Copyright (c) 2024 WFP
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, version 3.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
+// Common Identifier Application
+// Copyright (C) 2024 World Food Programme
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 import fs from 'node:fs';
 import path from 'node:path';
 import Debug from 'debug';

src/config/utils.ts

@@ -1,19 +1,18 @@
-/*
- * This file is part of Building Blocks CommonID Tool
- * Copyright (c) 2024 WFP
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, version 3.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
+// Common Identifier Application
+// Copyright (C) 2024 World Food Programme
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import fs from 'node:fs';
 import os from 'node:os';

src/config/validateConfig.ts

@@ -1,19 +1,18 @@
-/*
- * This file is part of Building Blocks CommonID Tool
- * Copyright (c) 2024 WFP
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, version 3.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
+// Common Identifier Application
+// Copyright (C) 2024 World Food Programme
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import { isRegExp } from 'util/types';
 import type { Config } from './Config.js';