@hg-ts/execution-mode 0.5.17 → 0.5.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hg-ts/execution-mode",
-  "version": "0.5.17",
+  "version": "0.5.18",
   "main": "dist/index.js",
   "type": "module",
   "exports": {
@@ -16,9 +16,9 @@
     "lint:ts:fix": "lint-ts --fix"
   },
   "devDependencies": {
-    "@hg-ts-config/typescript": "0.5.17",
-    "@hg-ts/linter": "0.5.17",
-    "@hg-ts/types": "0.5.17",
+    "@hg-ts-config/typescript": "0.5.18",
+    "@hg-ts/linter": "0.5.18",
+    "@hg-ts/types": "0.5.18",
     "@nestjs/common": "11.1.0",
     "@types/node": "22.19.1",
     "eslint": "9.18.0",

package/src/execution-mode.module.ts

@@ -0,0 +1,18 @@
+import {
+	Global,
+	Module,
+} from '@nestjs/common';
+import { ExecutionMode } from './execution-mode.js';
+import { HgExecutionMode } from './hg.execution-mode.js';
+
+@Global()
+@Module({
+	providers: [
+		{
+			provide: ExecutionMode,
+			useClass: HgExecutionMode,
+		},
+	],
+	exports: [ExecutionMode],
+})
+export class ExecutionModeModule {}

package/src/execution-mode.ts

@@ -0,0 +1,78 @@
+export enum ExecutionModeVariants {
+	DEBUG = 'debug',
+	DEV = 'dev',
+	TEST = 'test',
+	QA = 'qa',
+	DEMO = 'demo',
+	PROD = 'prod',
+}
+
+export class ExecutionMode<ValueType extends ExecutionModeVariants = ExecutionModeVariants> {
+	private value: ValueType;
+	private readonly projectName: string;
+	private readonly defaultValue: ValueType;
+
+	public constructor(projectName: string, defaultValue: ValueType) {
+		this.projectName = projectName.toUpperCase();
+		this.defaultValue = defaultValue;
+		this.initValue();
+	}
+
+	public isDebug(): boolean {
+		return this.value === ExecutionModeVariants.DEBUG;
+	}
+
+	public isDev(): boolean {
+		return this.value === ExecutionModeVariants.DEV;
+	}
+
+	public isTest(): boolean {
+		return this.value === ExecutionModeVariants.TEST;
+	}
+
+	public isQa(): boolean {
+		return this.value === ExecutionModeVariants.QA;
+	}
+
+	public isDemo(): boolean {
+		return this.value === ExecutionModeVariants.DEMO;
+	}
+
+	public isProd(): boolean {
+		return this.value === ExecutionModeVariants.PROD;
+	}
+
+	public getValue(): ValueType {
+		return this.value;
+	}
+
+	public isValueIn(variants: ValueType[]): boolean {
+		return variants.includes(this.value);
+	}
+
+	public is(expected: ValueType): boolean {
+		return expected === this.value;
+	}
+
+	protected getEnvName(): string {
+		return `${this.projectName}_ENV`;
+	}
+
+	protected isValueValid(value?: string): value is ValueType {
+		return Object.values(ExecutionModeVariants).includes(value as any);
+	}
+
+	protected getRawValue(): string | undefined {
+		return process.env[this.getEnvName()];
+	}
+
+	private initValue(): void {
+		const value = this.getRawValue();
+
+		if (this.isValueValid(value)) {
+			this.value = value;
+		} else {
+			this.value = this.defaultValue;
+		}
+	}
+}

package/src/hg.execution-mode.ts

@@ -0,0 +1,10 @@
+import {
+	ExecutionMode,
+	ExecutionModeVariants,
+} from './execution-mode.js';
+
+export class HgExecutionMode extends ExecutionMode {
+	public constructor() {
+		super('HG', ExecutionModeVariants.PROD);
+	}
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './execution-mode.js';
+export * from './hg.execution-mode.js';
+export * from './mock.execution-mode.js';
+export * from './execution-mode.module.js';

package/src/mock.execution-mode.ts

@@ -0,0 +1,11 @@
+import {
+	ExecutionMode,
+	ExecutionModeVariants,
+} from './execution-mode.js';
+
+export class MockExecutionMode<ValueType extends ExecutionModeVariants = ExecutionModeVariants>
+	extends ExecutionMode<ValueType> {
+	public constructor(value: ValueType) {
+		super('NEVER_USED', value);
+	}
+}