@eyeseetea/d2-logger 0.1.0 → 0.1.1

package/README.md

@@ -19,28 +19,21 @@ There are two types of logger output:
 
     await logger.init({
         type: "program",
-        debug: debug,
-        baseUrl: baseUrl,
-        auth: auth,
-        organisationUnitId: organisationUnitId,
-        programId: programId,
-        loggerDataElements: {
-            messageId: messageId,
-            messageTypeId: messageTypeId,
+        debug: true,
+        baseUrl: "https://play.dhis2.org/40.2.2",
+        auth: "admin:district",
+        organisationUnitId: "H8RixfF8ugH",
+        programId: "zARxYmOD18Z",
+        dataElements: {
+            messageId: "BjUzF5E4eR8",
+            messageTypeId: "NpS5LoLuhgS",
         },
     });
-
-    logger.debug("This is a Debug message");
-    logger.info("This is an Info message");
-    logger.success("This is a Success message");
-    logger.warn("This is a Warn message");
-    logger.error("This is an Error message");
     ```
 
     Notice:
 
     - Please note that `auth` is not mandatory if it's used in the DHIS2 app instead of in a script.
-    - Please note that if the `organisationUnitId` is not added to the configuration, then the logs will be registered in the DHIS2 program in the global organization unit.
     - If `debug` is `true`, then in addition to registering the logs in the DHIS2 program, they will also be displayed on the console.
 
 2. Displaying the logs only in the console:
@@ -53,17 +46,22 @@ There are two types of logger output:
     logger.init({
         type: "console",
     });
-
-    logger.debug("This is a Debug message");
-    logger.info("This is an Info message");
-    logger.success("This is a Success message");
-    logger.warn("This is a Warn message");
-    logger.error("This is an Error message");
     ```
 
+To log messages:
+
+```typescript
+logger.debug("This is a Debug message");
+logger.info("This is an Info message");
+logger.success("This is a Success message");
+logger.warn("This is a Warn message");
+logger.error("This is an Error message");
+```
+
 ## Development
 
 ```bash
+$ nvm use # Selects node in .nvmrc
 $ yarn install
 $ yarn build
 $ cd build
@@ -90,7 +88,8 @@ $ yarn code-quality
 
 ## Publish
 
+First, change in package.json the new version and then run:
+
 ```bash
-$ yarn prerelease
-$ yarn release [--tag beta] [--patch | --minor | --major]
+$ yarn release
 ```

package/data/repositories/ProgramD2Repository.js

@@ -8,20 +8,18 @@ var ProgramD2Repository = /** @class */ (function () {
     function ProgramD2Repository() {
     }
     ProgramD2Repository.prototype.checkConfig = function (config) {
-        var baseUrl = config.baseUrl, auth = config.auth, programId = config.programId, loggerDataElements = config.loggerDataElements;
-        var d2Api = auth
-            ? new d2_api_1.D2Api({ baseUrl: baseUrl, auth: auth })
-            : new d2_api_1.D2Api({ baseUrl: baseUrl });
-        return this.checkProgramIsOk(d2Api, programId, loggerDataElements).flatMap(function (programIsOk) {
+        var baseUrl = config.baseUrl, auth = config.auth, programId = config.programId, dataElements = config.dataElements;
+        var d2Api = new d2_api_1.D2Api({ baseUrl: baseUrl, auth: auth });
+        return this.checkProgramIsOk(d2Api, programId, dataElements).flatMap(function (programIsOk) {
             if (programIsOk) {
                 return Future_1.Future.success(programIsOk);
             }
             else {
-                return Future_1.Future.error(new Error("Logger not initialized properly. Please check configuration of program ".concat(programId, ", message data element ").concat(loggerDataElements.messageId, " and message type data element ").concat(loggerDataElements.messageTypeId, ".")));
+                return Future_1.Future.error(new Error("Logger not initialized properly. Please check configuration of program ".concat(programId, ", message data element ").concat(dataElements.messageId, " and message type data element ").concat(dataElements.messageTypeId, ".")));
             }
         });
     };
-    ProgramD2Repository.prototype.checkProgramIsOk = function (api, programId, loggerDataElements) {
+    ProgramD2Repository.prototype.checkProgramIsOk = function (api, programId, dataElements) {
         return (0, api_futures_1.apiToFuture)(api.models.programs.get({
             fields: programFields,
             filter: { id: { eq: programId } },
@@ -31,11 +29,11 @@ var ProgramD2Repository = /** @class */ (function () {
                 var programStageDataElements = response.objects[0].programStages[0].programStageDataElements;
                 var messageDataElement = (_b = programStageDataElements.find(function (_a) {
                     var dataElement = _a.dataElement;
-                    return dataElement.id === (loggerDataElements === null || loggerDataElements === void 0 ? void 0 : loggerDataElements.messageId);
+                    return dataElement.id === (dataElements === null || dataElements === void 0 ? void 0 : dataElements.messageId);
                 })) === null || _b === void 0 ? void 0 : _b.dataElement;
                 var messageTypeDataElement = (_c = programStageDataElements.find(function (_a) {
                     var dataElement = _a.dataElement;
-                    return dataElement.id === (loggerDataElements === null || loggerDataElements === void 0 ? void 0 : loggerDataElements.messageTypeId);
+                    return dataElement.id === (dataElements === null || dataElements === void 0 ? void 0 : dataElements.messageTypeId);
                 })) === null || _c === void 0 ? void 0 : _c.dataElement;
                 var isMessageDataElementOk = (messageDataElement === null || messageDataElement === void 0 ? void 0 : messageDataElement.valueType) === "TEXT" ||
                     (messageDataElement === null || messageDataElement === void 0 ? void 0 : messageDataElement.valueType) === "LONG_TEXT";

package/data/repositories/ProgramLoggerD2Repository.js

@@ -4,19 +4,16 @@ exports.ProgramLoggerD2Repository = void 0;
 var d2_api_1 = require("../../types/d2-api");
 var api_futures_1 = require("../api-futures");
 var Future_1 = require("../../domain/entities/generic/Future");
-var GLOBAL_ORGANISATION_UNIT_ID = "H8RixfF8ugH";
 var IMPORT_STRATEGY_CREATE = "CREATE";
 var TRACKER_IMPORT_JOB = "TRACKER_IMPORT_JOB";
 var EVENT_PROGRAM_STATUS = "COMPLETED";
 var ProgramLoggerD2Repository = /** @class */ (function () {
     function ProgramLoggerD2Repository(config) {
-        var baseUrl = config.baseUrl, auth = config.auth, programId = config.programId, loggerDataElements = config.loggerDataElements, _a = config.organisationUnitId, organisationUnitId = _a === void 0 ? GLOBAL_ORGANISATION_UNIT_ID : _a;
-        this.api = auth
-            ? new d2_api_1.D2Api({ baseUrl: baseUrl, auth: auth })
-            : new d2_api_1.D2Api({ baseUrl: baseUrl });
+        var baseUrl = config.baseUrl, auth = config.auth, programId = config.programId, dataElements = config.dataElements, organisationUnitId = config.organisationUnitId;
+        this.api = new d2_api_1.D2Api({ baseUrl: baseUrl, auth: auth });
         this.programId = programId;
-        this.messageId = loggerDataElements.messageId;
-        this.messageTypeId = loggerDataElements.messageTypeId;
+        this.messageId = dataElements.messageId;
+        this.messageTypeId = dataElements.messageTypeId;
         this.organisationUnitId = organisationUnitId;
     }
     ProgramLoggerD2Repository.prototype.log = function (log) {
@@ -39,9 +36,10 @@ var ProgramLoggerD2Repository = /** @class */ (function () {
             fields: programFields,
             filter: { id: { eq: this.programId } },
         })).flatMap(function (response) {
-            var _a, _b;
-            if ((_a = response.objects[0]) === null || _a === void 0 ? void 0 : _a.programStages[0]) {
-                return Future_1.Future.success((_b = response.objects[0]) === null || _b === void 0 ? void 0 : _b.programStages[0]);
+            var _a;
+            var programStage = (_a = response.objects[0]) === null || _a === void 0 ? void 0 : _a.programStages[0];
+            if (programStage) {
+                return Future_1.Future.success(programStage);
             }
             else {
                 return Future_1.Future.error(new Error("Program stage of program with id ".concat(_this.programId, " not found")));

package/domain/entities/LoggerConfig.d.ts

@@ -1,3 +1,4 @@
+import { Maybe } from "../../utils/ts-utils";
 import { Id } from "./Base";
 interface LoggerConfigBase {
     debug?: boolean;
@@ -9,16 +10,16 @@ export interface ConsoleLoggerConfig extends LoggerConfigBase {
 export interface ProgramLoggerConfig extends LoggerConfigBase {
     type: "program";
     baseUrl: string;
-    auth?: Auth;
+    auth: Maybe<Auth>;
     programId: Id;
-    loggerDataElements: LoggerDataElements;
-    organisationUnitId?: Id;
+    dataElements: DataElements;
+    organisationUnitId: Id;
 }
 type Auth = {
     username: string;
     password: string;
 };
-export type LoggerDataElements = {
+export type DataElements = {
     messageId: Id;
     messageTypeId: Id;
 };

package/domain/repositories/LoggerRepository.d.ts

@@ -1,5 +1,7 @@
 import { FutureData } from "../../data/api-futures";
 import { Log } from "../../domain/entities/Log";
 export interface LoggerRepository {
-    log(log: Log, isDebug?: boolean): FutureData<void>;
+    log(log: Log, options?: {
+        isDebug: boolean;
+    }): FutureData<void>;
 }

package/domain/usecases/LogMessageUseCase.d.ts

@@ -4,5 +4,7 @@ import { LoggerRepository } from "../../domain/repositories/LoggerRepository";
 export declare class LogMessageUseCase {
     private loggerRepository;
     constructor(loggerRepository: LoggerRepository);
-    execute(log: Log, isDebug?: boolean): FutureData<void>;
+    execute(log: Log, options?: {
+        isDebug?: boolean;
+    }): FutureData<void>;
 }

package/domain/usecases/LogMessageUseCase.js

@@ -5,8 +5,8 @@ var LogMessageUseCase = /** @class */ (function () {
     function LogMessageUseCase(loggerRepository) {
         this.loggerRepository = loggerRepository;
     }
-    LogMessageUseCase.prototype.execute = function (log, isDebug) {
-        if (isDebug) {
+    LogMessageUseCase.prototype.execute = function (log, options) {
+        if (options === null || options === void 0 ? void 0 : options.isDebug) {
             // eslint-disable-next-line no-console
             console.log(log);
         }

package/index.js

@@ -85,8 +85,9 @@ var Logger = /** @class */ (function () {
     };
     Logger.prototype.log = function (message, messageType) {
         if (this.loggerRepository) {
+            var options = { isDebug: this.isDebug };
             return new LogMessageUseCase_1.LogMessageUseCase(this.loggerRepository)
-                .execute({ message: message, messageType: messageType }, this.isDebug)
+                .execute({ message: message, messageType: messageType }, options)
                 .toPromise();
         }
         else {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@eyeseetea/d2-logger",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "description": "DHIS2 library that allows a certain application to register events in a DHIS2 program",
     "author": "EyeSeeTea team <info@eyeseetea.com>",
     "license": "GPL-3.0",
@@ -18,7 +18,7 @@
         "code-quality": "yarn lint && yarn prettify && echo disabled yarn test",
         "lint": "eslint src --ext .js,.jsx,.ts,.tsx",
         "prettify": "prettier \"{.,src}/**/*.{js,jsx,ts,tsx,json}\" --write",
-        "perelease": "yarn build",
+        "prerelease": "yarn build",
         "release": "bash scripts/publish.sh",
         "test": "vitest",
         "script-program-example": "npx ts-node src/scripts/index.ts programLogger log",

package/scripts/commands/programLogger.js

@@ -99,7 +99,7 @@ function getCommand() {
                                 auth: auth,
                                 organisationUnitId: orgUnitId,
                                 programId: programId,
-                                loggerDataElements: {
+                                dataElements: {
                                     messageId: messageId,
                                     messageTypeId: messageTypeId,
                                 },