hoffmation-base 3.2.1-alpha.7 → 3.2.1-alpha.9

package/lib/command/baseCommand.d.ts

@@ -1,7 +1,7 @@
 import { CommandSource, CommandType } from '../enums';
 import { iBaseCommand } from './iBaseCommand';
-import { iJsonOmitKeys } from '../interfaces';
-export declare abstract class BaseCommand implements iBaseCommand, iJsonOmitKeys {
+import { iJsonCustomPrepend, iJsonOmitKeys } from '../interfaces';
+export declare abstract class BaseCommand implements iBaseCommand, iJsonOmitKeys, iJsonCustomPrepend {
     readonly source: CommandSource | iBaseCommand;
     readonly reason: string;
     /**
@@ -40,5 +40,6 @@ export declare abstract class BaseCommand implements iBaseCommand, iJsonOmitKeys
     get reasonTrace(): string;
     containsType(type: CommandType): boolean;
     get logMessage(): string;
+    customPrepend(): Partial<unknown>;
     toJSON(): Partial<BaseCommand>;
 }

package/lib/command/baseCommand.js

@@ -25,7 +25,7 @@ class BaseCommand {
         if (this.overrideCommandSource !== undefined) {
             return this.overrideCommandSource === enums_1.CommandSource.Automatic;
         }
-        if (this.source instanceof BaseCommand) {
+        if (typeof this.source === 'object') {
             return this.source.isAutomaticAction;
         }
         return this.source === enums_1.CommandSource.Automatic;
@@ -36,7 +36,7 @@ class BaseCommand {
                 this.overrideCommandSource === enums_1.CommandSource.API ||
                 this.overrideCommandSource === enums_1.CommandSource.Force);
         }
-        if (this.source instanceof BaseCommand) {
+        if (typeof this.source === 'object') {
             return this.source.isForceAction;
         }
         return (this.source === enums_1.CommandSource.Manual || this.source === enums_1.CommandSource.API || this.source === enums_1.CommandSource.Force);
@@ -45,7 +45,7 @@ class BaseCommand {
         if (this.overrideCommandSource !== undefined) {
             return this.overrideCommandSource === enums_1.CommandSource.Manual || this.overrideCommandSource === enums_1.CommandSource.API;
         }
-        if (this.source instanceof BaseCommand) {
+        if (typeof this.source === 'object') {
             return this.source.isManual;
         }
         return this.source === enums_1.CommandSource.Manual || this.source === enums_1.CommandSource.API;
@@ -54,7 +54,7 @@ class BaseCommand {
         if (this.overrideCommandSource !== undefined) {
             return this.overrideCommandSource === enums_1.CommandSource.Initial;
         }
-        if (this.source instanceof BaseCommand) {
+        if (typeof this.source === 'object') {
             return this.source.isInitial;
         }
         return this.source === enums_1.CommandSource.Initial;
@@ -67,16 +67,16 @@ class BaseCommand {
         if (this.ignoreReason !== undefined) {
             ownPart += ` ignored due to: "${this.ignoreReason}"`;
         }
-        if (this.source instanceof BaseCommand) {
+        if (typeof this.source === 'object') {
             return `${this.source.reasonTrace} -> ${ownPart}`;
         }
-        return `CommandType("${enums_1.CommandSource[this.source]}") stack => ${ownPart}`;
+        return `CommandSource("${enums_1.CommandSource[this.source]}") stack => ${ownPart}`;
     }
     containsType(type) {
         if (this.type === type) {
             return true;
         }
-        if (this.source instanceof BaseCommand) {
+        if (typeof this.source === 'object') {
             return this.source.containsType(type);
         }
         return false;
@@ -84,8 +84,13 @@ class BaseCommand {
     get logMessage() {
         return this.reasonTrace;
     }
+    customPrepend() {
+        return {
+            logMessage: this.logMessage,
+        };
+    }
     toJSON() {
-        // eslint-disable-next-line
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const result = lodash_1.default.omit(this, ['source']);
         result['logMessage'] = this.logMessage;
         return result;

package/lib/interfaces/iJsonCustomPrepend.d.ts

@@ -0,0 +1,9 @@
+/**
+ * An object which defines certain keys to append to the JSON output
+ */
+export interface iJsonCustomPrepend {
+    /**
+     * List of keys to append
+     */
+    readonly customPrepend: () => Partial<unknown>;
+}

package/lib/interfaces/iJsonCustomPrepend.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/interfaces/index.d.ts

@@ -16,6 +16,7 @@ export * from './iButtonCallback';
 export * from './iButtonCapabilities';
 export * from './iDeviceInfo';
 export * from './iIdHolder';
+export * from './iJsonCustomPrepend';
 export * from './iJsonOmitKeys';
 export * from './iLogSettings';
 export * from './iAsusConfig';

package/lib/interfaces/index.js

@@ -32,6 +32,7 @@ __exportStar(require("./iButtonCallback"), exports);
 __exportStar(require("./iButtonCapabilities"), exports);
 __exportStar(require("./iDeviceInfo"), exports);
 __exportStar(require("./iIdHolder"), exports);
+__exportStar(require("./iJsonCustomPrepend"), exports);
 __exportStar(require("./iJsonOmitKeys"), exports);
 __exportStar(require("./iLogSettings"), exports);
 __exportStar(require("./iAsusConfig"), exports);