cht-conf 3.22.0 → 4.0.0

package/.sonarcloud.properties

@@ -0,0 +1,11 @@
+sonar.sources=.
+# Can have multiple comma-separated entries
+sonar.exclusions=test/**/*
+
+sonar.tests=.
+# Can have multiple comma-separated entries
+sonar.test.inclusions=test/**/*
+
+sonar.issue.ignore.block=e1
+sonar.issue.ignore.block.e1.beginBlockRegexp=NOSONAR_BEGIN
+sonar.issue.ignore.block.e1.endBlockRegexp=NOSONAR_END

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [4.0.0](https://github.com/medic/cht-conf/compare/v3.23.0...v4.0.0) (2024-07-01)
+
+
+### Performance Improvements
+
+* **#600:** drop support for Node versions < 18 ([#619](https://github.com/medic/cht-conf/issues/619)) ([496d074](https://github.com/medic/cht-conf/commit/496d0742890f1347557caecc1241bdd590c774c0)), closes [#600](https://github.com/medic/cht-conf/issues/600)
+
+
+### BREAKING CHANGES
+
+* **#600:** Dropping support for NodeJS versions < 18
+
+# [3.23.0](https://github.com/medic/cht-conf/compare/v3.22.0...v3.23.0) (2024-06-20)
+
+
+### Features
+
+*  session token authentication ([efbc9cf](https://github.com/medic/cht-conf/commit/efbc9cfc5dc972f355fa07b3a394c63d84b352de))
+
 # [3.22.0](https://github.com/medic/cht-conf/compare/v3.21.5...v3.22.0) (2024-04-29)
 
 

package/README.md

@@ -5,8 +5,8 @@ CHT Conf is a command-line interface tool to manage and configure your apps buil
 
 # Requirements
 
-* nodejs 8 or later
-* python 2.7
+* nodejs 18 or later
+* python 3
 * or Docker
 
 # Installation
@@ -106,6 +106,12 @@ If a different username is required, add the `--user` switch:
 
 **NB** - When specifying the URL with `--url`, be sure not to specify the CouchDB database name in the URL. The CHT API will find the correct database.
 
+### Using a session token for authentication
+
+CHT Conf supports authentication using a session token by adding `--session-token` parameter:
+
+	cht --url=https://example.com:12345 --session-token=*my_token* 
+
 ### Into an archive to be uploaded later
 
     cht --archive
@@ -343,7 +349,7 @@ Builds brought to you courtesy of GitHub actions.
 
 # Copyright
 
-Copyright 2013-2023 Medic Mobile, Inc. <hello@medic.org>
+Copyright 2013-2024 Medic Mobile, Inc. <hello@medic.org>
 
 # License
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "cht-conf",
-  "version": "3.22.0",
+  "version": "4.0.0",
   "description": "Configure CHT deployments",
   "main": "./src/lib/main.js",
   "engines": {
-    "node": ">=8.10.0"
+    "node": ">=18.0.0"
   },
   "scripts": {
     "clean": "rm -rf ./build/",
@@ -58,6 +58,7 @@
     "pouchdb-adapter-http": "^7.2.2",
     "pouchdb-core": "^7.2.2",
     "pouchdb-mapreduce": "^7.2.2",
+    "pouchdb-session-authentication": "^1.3.0",
     "properties": "^1.2.1",
     "queue-promise": "^2.2.1",
     "readline-sync": "^1.4.10",

package/src/lib/api.js

@@ -7,8 +7,34 @@ const log = require('./log');
 const url = require('url');
 
 const cache = new Map();
+const sessionCookieName = 'AuthSession';
+
+// Helper function to create request headers with session token (if available)
+const withSessionCookie = (...args) => {
+  const options = typeof args[0] === 'object' ? Object.assign({}, args[0]) : { url: args[0] };
+
+  if (args.length > 1) {
+    // Merge remaining arguments
+    Object.assign(options, ...args.slice(1));
+  }
+
+  const sessionToken = environment.sessionToken;
+  if (sessionToken || options.headers) {
+    options.headers = Object.assign(
+      {}, 
+      options.headers || {}, 
+      sessionToken ? { Cookie: `${sessionCookieName}=${sessionToken}` } : {}
+    );
+  }
+
+  return options;
+};
+
+const _request = (method) => (...args) => {
+  const requestOptions = withSessionCookie(...args);
+  return retry(() => rpn[method](requestOptions), { retries: 5, randomize: false, factor: 1.5 });
+};
 
-const _request = (method) => (...args) => retry(() => rpn[method](...args), { retries: 5, randomize: false, factor: 1.5 });
 const request = {
   get: _request('get'),
   post: _request('post'),

package/src/lib/db.js

@@ -1,6 +1,7 @@
 const PouchDB = require('pouchdb-core');
 PouchDB.plugin(require('pouchdb-adapter-http'));
 PouchDB.plugin(require('pouchdb-mapreduce'));
+PouchDB.plugin(require('pouchdb-session-authentication'));
 
 const ArchivingDB = require('./archiving-db');
 const environment = require('./environment');
@@ -10,6 +11,7 @@ module.exports = () => {
     return new ArchivingDB(environment.archiveDestination);
   }
 
-  return new PouchDB(environment.apiUrl, { ajax: { timeout: 60000 } });
+  return new PouchDB(environment.apiUrl, {
+    session: environment.sessionToken,
+  });
 };
-

package/src/lib/environment.js

@@ -13,7 +13,8 @@ const initialize = (
   apiUrl,
   force,
   skipTranslationCheck,
-  skipValidate
+  skipValidate,
+  sessionToken
 ) => {
   if (state.initialized) {
     throw Error('environment is already initialized');
@@ -28,7 +29,8 @@ const initialize = (
     pathToProject,
     force,
     skipTranslationCheck,
-    skipValidate
+    skipValidate,
+    sessionToken
   });
 };
 
@@ -54,6 +56,7 @@ module.exports = {
   get force() { return getState('force'); },
   get skipTranslationCheck() { return getState('skipTranslationCheck'); },
   get skipValidate() { return getState('skipValidate'); },
+  get sessionToken() { return getState('sessionToken'); },
 
   /**
    * Return `true` if the environment **seems** to be production.

package/src/lib/main.js

@@ -160,7 +160,8 @@ module.exports = async (argv, env) => {
     apiUrl,
     cmdArgs.force,
     cmdArgs['skip-translation-check'],
-    skipValidate
+    skipValidate,
+    cmdArgs['session-token'],
   );
 
   if (requiresInstance && apiUrl) {