[Feat] Environment loader (#69)

* feat(shared/environment): add shared environment library with services, providers, and interfaces

* chore(scripts): add environment loading scripts and example .env file

* refactor(ui): switch to shared EnvironmentService and remove legacy environment.ts

* chore(config): update workspace and package config for new environment library

* fix: base config spread object is not iterable.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fix: dynamic import of env files from a library is fragile; prefer injected/global env

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* refactor(environment): remove google config caching

Remove the internal caching mechanism for Google configuration.
The `IGoogleConfig` object is now computed dynamically on each access.
This simplifies the `EnvironmentService` by removing mutable state and
associated cache invalidation logic, as direct `getValue` calls are
sufficiently performant.

* refactor(core-environment): use specific types for validation errors and warnings

Improve type safety and clarity by using `ValidationError` and `ValidationWarning`
types for the validation results arrays instead of `any[]`. This enhances
readability and maintainability of the environment validation logic.

* feat(desktop): make application name configurable

Allow setting the application name via the `APP_NAME` environment
variable. If `APP_NAME` is not provided, the name defaults to
'Ever Rec Desktop'.
This enables easier branding and custom naming for different build
targets or white-labeling scenarios.
Includes minor trailing comma formatting adjustments.

* build(scripts): remove explicit env loading from package scripts

The dedicated `prestart` and `prebuild` hooks for loading environment
variables are no longer required. Environment variables are now implicitly
managed by the Nx build system or handled by individual application
processes.

* chore(env): remove obsolete example env vars

Removes `DATABASE_URL` and `JWT_SECRET` from `.env.example`. These
variables are no longer part of the standard application setup
or are handled differently, making their inclusion in the example
file misleading or unnecessary.

* refactor(environment): remove unused database and JWT environment config

The `DATABASE_URL` and `JWT_SECRET` variables, along with their
accessors, are no longer required in the shared environment
configuration. This simplifies the environment interface by removing
properties that are either unused or are now managed through more
secure or direct injection methods.

* chore(env): quote app name value in example

Ensures the application name, which contains a space, is correctly parsed
when loaded from the environment file.

* refactor(environment): use inject function for CoreEnvironmentService

Migrates the EnvironmentService to use the `inject` function from
`@angular/core` instead of constructor-based dependency injection for
CoreEnvironmentService. This aligns with modern Angular practices.

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: adkif

.env.example

@@ -0,0 +1,18 @@
+# Example environment variables
+# Copy this file to .env and fill in your actual values
+
+# API Configuration
+API_URL=http://localhost:3000
+
+# App Configuration
+DEBUG=true
+PORT=4201
+APP_NAME="Ever Rec"
+APP_ICON=fiber_smart_record
+IS_PLUGIN=false
+CAN_USE_WEB_WORKER=true
+USE_EMULATORS=true
+
+# Google OAuth Configuration
+GOOGLE_REDIRECT_URI=http://localhost:4200/authorize
+GOOGLE_CLIENT_ID=your-google-client-id

.gitignore

@@ -46,6 +46,14 @@ Thumbs.db
 
 .nx
 
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# Generated environment files
+apps/ui/src/environment/environment.dev.ts
+apps/ui/src/environment/environment.prod.ts
 
 #Ignore cursor AI rules
 .cursor/rules/codacy.mdc

apps/desktop/src/app/app.ts

@@ -10,7 +10,7 @@ export default class App {
 
   static main(app: Electron.App): void {
     App.application = app;
-    App.application.setName('Ever Rec Desktop');
+    App.application.setName(process.env['APP_NAME'] || 'Ever Rec Desktop');
 
     App.application.on('ready', App.handleAppReady);
     App.application.on('activate', App.handleAppActivate);
@@ -49,7 +49,7 @@ export default class App {
         } else {
           callback(false); // Denied
         }
-      }
+      },
     );
   }
 
@@ -63,7 +63,7 @@ export default class App {
             callback({ video: sources[0], audio: 'loopback' });
           });
       },
-      { useSystemPicker: true }
+      { useSystemPicker: true },
     );
   }
 

apps/ui/project.json

@@ -6,8 +6,27 @@
   "sourceRoot": "apps/ui/src",
   "tags": [],
   "targets": {
+    "load-env": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "node scripts/load-env.js",
+        "cwd": "{workspaceRoot}"
+      },
+      "configurations": {
+        "production": {
+          "command": "node scripts/load-env-prod.js",
+          "cwd": "{workspaceRoot}"
+        }
+      }
+    },
     "build": {
       "executor": "@angular-devkit/build-angular:application",
+      "dependsOn": [
+        {
+          "target": "load-env",
+          "params": "forward"
+        }
+      ],
       "outputs": ["{options.outputPath}"],
       "options": {
         "outputPath": "dist/apps/ui",
@@ -60,6 +79,12 @@
     },
     "serve": {
       "executor": "@angular-devkit/build-angular:dev-server",
+      "dependsOn": [
+        {
+          "target": "load-env",
+          "params": "forward"
+        }
+      ],
       "configurations": {
         "production": {
           "buildTarget": "ui:build:production"

apps/ui/src/app/app.config.ts

@@ -23,7 +23,6 @@ import { provideGenerateVideoDataAccess } from '@ever-co/generate-video-data-acc
 import { provideNotificationDataAccess } from '@ever-co/notification-data-access';
 import { providePhotoDataAccess } from '@ever-co/photo-data-access';
 import { provideScreenshotDataAccess } from '@ever-co/screenshot-data-access';
-import { REC_ENV } from '@ever-co/shared-service';
 import { provideSidebarDataAccess } from '@ever-co/sidebar-data-access';
 import { provideTimelineDataAccess } from '@ever-co/timeline-data-access';
 import { provideTimeLogDataAccess } from '@ever-co/timesheet-data-access';
@@ -35,12 +34,13 @@ import { provideWebcamDataAccess } from '@ever-co/webcam-data-access';
 import { provideEffects } from '@ngrx/effects';
 import { provideStore } from '@ngrx/store';
 import { provideStoreDevtools } from '@ngrx/store-devtools';
-import { Environment } from '../environment/environment';
+import { provideEnvironment } from '@ever-co/shared-environment';
 import { appRoutes } from './app.routes';
 import { provideCoreDataAccess } from '@ever-co/core-data-access';
 
 export const appConfig: ApplicationConfig = {
   providers: [
+    // Core providers
     provideScreenshotDataAccess(),
     provideBreadcrumbDataAccess(),
     provideVideoDataAccess(),
@@ -68,9 +68,6 @@ export const appConfig: ApplicationConfig = {
     provideUserDataAccess(),
     provideAuthDataAccess(),
     provideCoreDataAccess(),
-    {
-      provide: REC_ENV,
-      useClass: Environment,
-    },
+    provideEnvironment(),
   ],
 };

apps/ui/src/environment/environment.ts

@@ -0,0 +1,112 @@
+# @ever-co/shared-environment
+
+A robust, SOLID-principles-based environment management library for Angular applications.
+
+## Features
+
+- 🏗️ **SOLID Principles** - Follows all five SOLID principles
+- 🎨 **Design Patterns** - Implements Singleton, Factory, Builder, Strategy, Adapter, Facade, Command, and Observer patterns
+- 🔒 **Type Safety** - Full TypeScript support with comprehensive interfaces
+- ✅ **Validation** - Extensible validation system with custom rules
+- 🔄 **Async/Sync** - Support for both asynchronous and synchronous operations
+- 🧪 **Testable** - Comprehensive unit tests included
+- 📦 **Reusable** - Can be used across multiple Angular applications
+
+## Installation
+
+```bash
+npm install @ever-co/shared-environment
+```
+
+## Quick Start
+
+```typescript
+import { Environment, EnvironmentService, createEnvironmentProviders } from '@ever-co/shared-environment';
+
+// Configure environment loading
+Environment.setLoadFunction(() => {
+  // Your environment loading logic
+  return { API_URL: 'http://localhost:3000' };
+});
+
+// Use in components
+@Component({
+  providers: [...createEnvironmentProviders()]
+})
+export class MyComponent {
+  constructor(private envService: EnvironmentService) {}
+  
+  async ngOnInit() {
+    const apiUrl = await this.envService.get('API_URL');
+    console.log('API URL:', apiUrl);
+  }
+}
+```
+
+## Architecture
+
+The library implements multiple design patterns:
+
+- **Singleton Pattern** - Environment class ensures single instance
+- **Factory Pattern** - ConfigurationFactory creates configuration objects
+- **Builder Pattern** - ConfigurationBuilder constructs complex configurations
+- **Strategy Pattern** - Different loading strategies for various environments
+- **Adapter Pattern** - Adapts new system to legacy interfaces
+- **Facade Pattern** - EnvironmentService provides simplified interface
+
+## API Reference
+
+### Environment Class
+
+```typescript
+// Get singleton instance
+const env = Environment.getInstance();
+
+// Access configuration
+console.log(env.apiUrl);
+console.log(env.appName);
+console.log(env.debug);
+```
+
+### EnvironmentService
+
+```typescript
+// Async operations
+const apiUrl = await envService.get('API_URL', 'default');
+const isDebug = await envService.getBoolean('DEBUG', false);
+const port = await envService.getNumber('PORT', 3000);
+
+// Validation
+const validation = await envService.getValidationResult();
+```
+
+### Configuration Models
+
+```typescript
+import { ConfigurationFactory } from '@ever-co/shared-environment';
+
+const config = ConfigurationFactory.createConfiguration(envVars);
+console.log(config.apiUrl);
+console.log(config.google.clientId);
+```
+
+## Testing
+
+```bash
+# Run tests
+nx test environment
+
+# Build library
+nx build environment
+```
+
+## Contributing
+
+1. Follow SOLID principles
+2. Add comprehensive tests
+3. Update documentation
+4. Ensure backward compatibility
+
+## License
+
+AGPL-3.0

libs/shared/environment/README.md

@@ -0,0 +1,48 @@
+const nx = require('@nx/eslint-plugin');
+const baseConfig = require('../../../.eslintrc.json');
+
+module.exports = [
+  ...(Array.isArray(baseConfig) ? baseConfig : [baseConfig]),
+  {
+    files: ['**/*.json'],
+    rules: {
+      '@nx/dependency-checks': [
+        'error',
+        {
+          ignoredFiles: ['{projectRoot}/eslint.config.{js,cjs,mjs,ts,cts,mts}'],
+        },
+      ],
+    },
+    languageOptions: {
+      parser: require('jsonc-eslint-parser'),
+    },
+  },
+  ...nx.configs['flat/angular'],
+  ...nx.configs['flat/angular-template'],
+  {
+    files: ['**/*.ts'],
+    rules: {
+      '@angular-eslint/directive-selector': [
+        'error',
+        {
+          type: 'attribute',
+          prefix: 'lib',
+          style: 'camelCase',
+        },
+      ],
+      '@angular-eslint/component-selector': [
+        'error',
+        {
+          type: 'element',
+          prefix: 'lib',
+          style: 'kebab-case',
+        },
+      ],
+    },
+  },
+  {
+    files: ['**/*.html'],
+    // Override or add rules here
+    rules: {},
+  },
+];

libs/shared/environment/eslint.config.cjs

@@ -0,0 +1,21 @@
+export default {
+  displayName: 'environment',
+  preset: '../../../jest.preset.js',
+  setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
+  coverageDirectory: '../../../coverage/libs/shared/environment',
+  transform: {
+    '^.+\\.(ts|mjs|js|html)$': [
+      'jest-preset-angular',
+      {
+        tsconfig: '<rootDir>/tsconfig.spec.json',
+        stringifyContentPathRegex: '\\.(html|svg)$',
+      },
+    ],
+  },
+  transformIgnorePatterns: ['node_modules/(?!.*\\.mjs$)'],
+  snapshotSerializers: [
+    'jest-preset-angular/build/serializers/no-ng-attributes',
+    'jest-preset-angular/build/serializers/ng-snapshot',
+    'jest-preset-angular/build/serializers/html-comment',
+  ],
+};

libs/shared/environment/jest.config.ts

@@ -0,0 +1,7 @@
+{
+  "$schema": "../../../node_modules/ng-packagr/ng-package.schema.json",
+  "dest": "../../../dist/libs/shared/environment",
+  "lib": {
+    "entryFile": "src/index.ts"
+  }
+}