5.0.15

npmextra.json

@@ -23,7 +23,6 @@
         "tool management",
         "key-value store",
         "project setup",
-        "npm scripts",
         "typescript",
         "environment setup",
         "dependencies management",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/npmextra",
-  "version": "5.0.13",
+  "version": "5.0.15",
   "private": false,
   "description": "Enhances npm with additional configuration and tool management capabilities, including a key-value store for project setups.",
   "main": "dist_ts/index.js",
@@ -12,30 +12,30 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@gitlab.com/pushrocks/npmextra.git"
+    "url": "https://code.foss.global/push.rocks/npmextra.git"
   },
   "author": "Lossless GmbH",
   "license": "MIT",
   "bugs": {
     "url": "https://gitlab.com/pushrocks/npmextra/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/npmextra#README",
+  "homepage": "https://code.foss.global/push.rocks/npmextra",
   "dependencies": {
     "@push.rocks/qenv": "^6.0.5",
-    "@push.rocks/smartfile": "^11.0.4",
+    "@push.rocks/smartfile": "^11.0.20",
-    "@push.rocks/smartjson": "^5.0.10",
+    "@push.rocks/smartjson": "^5.0.20",
-    "@push.rocks/smartlog": "^3.0.2",
+    "@push.rocks/smartlog": "^3.0.7",
-    "@push.rocks/smartpath": "^5.0.11",
+    "@push.rocks/smartpath": "^5.0.18",
     "@push.rocks/smartpromise": "^4.0.2",
     "@push.rocks/smartrx": "^3.0.7",
     "@push.rocks/taskbuffer": "^3.1.7"
   },
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.66",
+    "@git.zone/tsbuild": "^2.1.80",
     "@git.zone/tsrun": "^1.2.44",
-    "@git.zone/tstest": "^1.0.77",
+    "@git.zone/tstest": "^1.0.90",
-    "@push.rocks/tapbundle": "^5.0.15",
+    "@push.rocks/tapbundle": "^5.0.23",
-    "@types/node": "^20.11.17"
+    "@types/node": "^20.14.2"
   },
   "files": [
     "ts/**/*",
@@ -59,7 +59,6 @@
     "tool management",
     "key-value store",
     "project setup",
-    "npm scripts",
     "typescript",
     "environment setup",
     "dependencies management",

readme.md

@@ -1,5 +1,5 @@
 # @push.rocks/npmextra
-Enhances npm with additional configuration and tool management capabilities.
+Enhances npm with additional configuration and tool management capabilities, including a key-value store for project setups.
 
 ## Install
 To install `@push.rocks/npmextra`, use the following npm command:
@@ -11,7 +11,7 @@ npm install @push.rocks/npmextra --save
 This package is available on [npm](https://www.npmjs.com/package/@push.rocks/npmextra) and can be installed into your project as a dependency to enhance npm with additional configuration and tool management capabilities.
 
 ## Usage
-`@push.rocks/npmextra` is designed to supplement npm functionalities with enhanced configuration and tool management. It facilitates managing project configurations and tool setups in a consolidated manner, enabling a smoother workflow and maintenance process. Below are detailed use cases and examples implemented with ESM syntax and TypeScript.
+`@push.rocks/npmextra` is designed to supplement npm functionalities with enhanced configuration and tool management. It facilitates the management of project configurations and tool setups in a consolidated manner, enabling a smoother workflow and maintenance process. Below are detailed use cases and examples implemented with ESM syntax and TypeScript.
 
 ### Initial Setup and Configuration
 To start using npmextra in your project, first include it in your project with an import statement:
@@ -27,7 +27,7 @@ const npmExtraInstance = new Npmextra('/path/to/your/project');
 ```
 
 ### Managing Tool Configurations with `npmextra.json`
-`@push.rocks/npmextra` excels in unifying tool configurations through a single `npmextra.json` file. Instead of scattering configurations across multiple files, `@push.rocks/npmextra` enables you to define tool-specific settings within this centralized configuration file.
+`@push.rocks/npmextra` excels in unifying tool configurations through a single `npmextra.json` file. Instead of scattering configurations across multiple files, `@push.rocks/npmextra` enables you to define tool-specific settings within this centralized configuration file, which can then be accessed programmatically.
 
 #### Creating and Utilizing `npmextra.json`
 
@@ -49,13 +49,13 @@ For example, to configure a hypothetical tool named `toolname`, define its setti
 With the configuration defined, you can easily access these settings in your TypeScript code as follows:
 
 ```typescript
-// import the npmextra module
+// Import the npmextra module
 import { Npmextra } from '@push.rocks/npmextra';
 
-// create an instance pointing at the current directory
+// Create an instance pointing at the current directory
 const npmExtraInstance = new Npmextra();
 
-// retrieve the configuration for 'toolname', merging defaults with any found in npmextra.json
+// Retrieve the configuration for 'toolname', merging defaults with any found in npmextra.json
 const toolConfig = npmExtraInstance.dataFor('toolname', {
   defaultKey1: 'defaultValue1',
   defaultKey2: 'defaultValue2'
@@ -102,12 +102,227 @@ console.log(allData); // Outputs the entire store's contents
 ```
 
 ### Integrating with Tools
-`@push.rocks/npmextra` seamlessly integrates with numerous tools, enabling them to leverage `npmextra.json` for configuration purposes. Tools such as `npmts`, `npmci`, and `npmdocker` are already utilizing this feature for enhanced configuration management.
+`@push.rocks/npmextra` seamlessly integrates with numerous tools, enabling them to leverage `npmextra.json` for configuration purposes. Tools such as `npmts`, `npmci`, and `npmdocker` are already utilizing this feature for enhanced configuration management. Below is an example of integrating a fictional tool named `toolname` with `npmextra`.
 
-For tool developers, integrating with `npmextra` requires reading the tool-specific configuration from `npmextra.json` and adjusting the tool's behavior based on these settings. This creates a unified and streamlined configuration process across different tools used within a project.
+#### Example: Tool Integration
 
-### Conclusion
+Imagine you have a custom tool called `toolname` that requires specific configurations. Here's how you might configure and use it with `npmextra`:
-By centralizing configuration management and offering a versatile key-value store, `@push.rocks/npmextra` significantly simplifies the setup and management of tools and settings in modern JavaScript and TypeScript projects. Whether you're managing project-wide configurations or need persistent storage for key-value pairs, `@push.rocks/npmextra` provides an efficient and streamlined solution.
+
+1. Define the configuration in `npmextra.json`:
+
+```json
+{
+  "toolname": {
+    "configKey1": "configValue1",
+    "configKey2": "configValue2",
+  }
+}
+```
+
+2. Access the configuration within your tool:
+
+```typescript
+// Import npmextra
+import { Npmextra } from '@push.rocks/npmextra';
+
+class ToolName {
+  config: any;
+
+  constructor() {
+    const npmExtraInstance = new Npmextra();
+    this.config = npmExtraInstance.dataFor('toolname', {
+      configKey1: 'defaultValue1',
+      configKey2: 'defaultValue2'
+    });
+  }
+
+  run() {
+    // Utilize the configuration
+    console.log(this.config.configKey1); // Outputs: configValue1
+    console.log(this.config.configKey2); // Outputs: configValue2
+  }
+}
+
+const toolInstance = new ToolName();
+toolInstance.run();
+```
+
+### Advanced Key-Value Store Usage
+In addition to basic read/write operations, `@push.rocks/npmextra`’s `KeyValueStore` supports advanced usage scenarios, such as mandatory keys and custom file paths.
+
+#### Example: Mandatory Keys and Custom Paths
+
+```typescript
+import { KeyValueStore } from '@push.rocks/npmextra';
+
+interface CustomData {
+  key1: string;
+  key2: number;
+  key3?: boolean;
+}
+
+const kvStore = new KeyValueStore<CustomData>({
+  typeArg: 'custom',
+  identityArg: 'customApp',
+  customPath: '/custom/path/to/store.json',
+  mandatoryKeys: ['key1', 'key2']
+});
+
+// Ensure all mandatory keys are present
+const missingKeys = await kvStore.getMissingMandatoryKeys();
+if (missingKeys.length) {
+  console.log(`Missing mandatory keys: ${missingKeys.join(', ')}`);
+}
+
+// Use the KeyValueStore
+await kvStore.writeKey('key1', 'value1');
+await kvStore.writeKey('key2', 123);
+
+const key1Value = await kvStore.readKey('key1');
+const allData = await kvStore.readAll();
+
+console.log(key1Value); // Outputs: value1
+console.log(allData); // Outputs: { key1: 'value1', key2: 123 }
+```
+
+### Combining AppData and KeyValueStore
+The `AppData` class extends the functionality of `KeyValueStore` by integrating environmental variables and specifying additional configurations.
+
+#### Example: AppData Usage
+
+```typescript
+import { AppData } from '@push.rocks/npmextra';
+
+interface AppSettings {
+  settingA: string;
+  settingB: number;
+  nestedSetting: {
+    innerSetting: boolean;
+  }
+}
+
+const appDataInstance = await AppData.createAndInit<AppSettings>({
+  dirPath: '/custom/path/to/appdata',
+  requiredKeys: ['settingA', 'settingB'],
+  envMapping: {
+    settingA: 'MY_ENV_A',
+    settingB: 'hard:42',
+    nestedSetting: {
+      innerSetting: 'MY_ENV_INNER'
+    }
+  }
+});
+
+const appDataKvStore = await appDataInstance.getKvStore();
+
+// Writing values
+await appDataKvStore.writeKey('settingA', 'exampleValue');
+await appDataKvStore.writeKey('settingB', 100);
+await appDataKvStore.writeKey('nestedSetting', { innerSetting: true });
+
+// Reading values
+const settingA = await appDataKvStore.readKey('settingA');
+const allSettings = await appDataKvStore.readAll();
+
+console.log(settingA); // Outputs: 'exampleValue'
+console.log(allSettings); // Outputs: { settingA: 'exampleValue', settingB: 100, nestedSetting: { innerSetting: true } }
+```
+
+### Error Handling and Debugging
+Proper error handling ensures that your integrations with `npmextra` are robust and stable. Below are some strategies for error handling and debugging potential issues.
+
+#### Example: Error Handling in KeyValueStore
+
+```typescript
+import { KeyValueStore } from '@push.rocks/npmextra';
+
+const kvStore = new KeyValueStore('userHomeDir', 'errorHandlingApp');
+
+try {
+  await kvStore.writeKey('importantKey', 'importantValue');
+  const value = await kvStore.readKey('importantKey');
+  console.log(value); // Outputs: importantValue
+} catch (error) {
+  console.error('Error managing key-value store:', error);
+}
+```
+
+#### Debugging Configuration Issues in `npmextra.json`
+
+To debug configuration issues, you can utilize conditional logging and checks:
+
+```typescript
+import { Npmextra } from '@push.rocks/npmextra';
+
+const npmExtraInstance = new Npmextra();
+const toolConfig = npmExtraInstance.dataFor('toolname', {
+  configKey1: 'defaultValue1',
+  configKey2: 'defaultValue2'
+});
+
+if (!toolConfig.configKey1) {
+  console.error('configKey1 is missing in npmextra.json');
+}
+
+console.log(toolConfig);
+```
+
+### Integration Tests
+Writing tests ensures that your integration with `npmextra` works as expected. Below are examples of integration tests for both `Npmextra` and `KeyValueStore`.
+
+#### Example: Testing `Npmextra` Class
+
+```typescript
+import { expect, tap } from '@push.rocks/tapbundle';
+import { Npmextra } from '@push.rocks/npmextra';
+
+let npmExtraInstance: Npmextra;
+
+tap.test('should create an instance of Npmextra', async () => {
+  npmExtraInstance = new Npmextra();
+  expect(npmExtraInstance).toBeInstanceOf(Npmextra);
+});
+
+tap.test('should load configuration from npmextra.json', async () => {
+  const config = npmExtraInstance.dataFor('toolname', {
+    defaultKey1: 'defaultValue1',
+  });
+  expect(config).toHaveProperty('defaultKey1');
+});
+
+tap.start();
+```
+
+#### Example: Testing `KeyValueStore` Class
+
+```typescript
+import { expect, tap } from '@push.rocks/tapbundle';
+import { KeyValueStore } from '@push.rocks/npmextra';
+
+let kvStore: KeyValueStore<{ key1: string, key2: number }>;
+
+tap.test('should create a KeyValueStore instance', async () => {
+  kvStore = new KeyValueStore('userHomeDir', 'testApp');
+  expect(kvStore).toBeInstanceOf(KeyValueStore);
+});
+
+tap.test('should write and read back a value', async () => {
+  await kvStore.writeKey('key1', 'value1');
+  const result = await kvStore.readKey('key1');
+  expect(result).toEqual('value1');
+});
+
+tap.test('should write and read back multiple values', async () => {
+  await kvStore.writeAll({ key1: 'updatedValue1', key2: 2 });
+  const result = await kvStore.readAll();
+  expect(result).toEqual({ key1: 'updatedValue1', key2: 2 });
+});
+
+tap.start();
+```
+
+### Summary
+By centralizing configuration management and offering a versatile key-value store, `@push.rocks/npmextra` significantly simplifies the setup and management of tools and settings in modern JavaScript and TypeScript projects. Whether you're managing project-wide configurations or need persistent storage for key-value pairs, `@push.rocks/npmextra` provides an efficient and streamlined solution. Leveraging these robust features will ensure your project is well-configured and maintainable.
 
 ## License and Legal Information
 

test/test.kvstore.ts

@@ -2,10 +2,14 @@ import { expect, tap } from '@push.rocks/tapbundle';
 
 import * as npmextra from '../ts/index.js';
 
-let myKeyValueStore: npmextra.KeyValueStore;
+let myKeyValueStore: npmextra.KeyValueStore<any>;
 
 tap.test('should create a keyValueStore', async () => {
-  myKeyValueStore = new npmextra.KeyValueStore('custom', 'test', 'test/somekv.json');
+  myKeyValueStore = new npmextra.KeyValueStore<any>({
+    typeArg: 'custom',
+    identityArg: 'test',
+    customPath: 'test/somekv.json',
+  });
   expect(myKeyValueStore).toBeInstanceOf(npmextra.KeyValueStore);
 });
 

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/npmextra',
-  version: '5.0.13',
+  version: '5.0.15',
   description: 'Enhances npm with additional configuration and tool management capabilities, including a key-value store for project setups.'
 }

ts/npmextra.classes.appdata.ts

@@ -3,15 +3,15 @@ import * as paths from './npmextra.paths.js';
 import { KeyValueStore } from './npmextra.classes.keyvaluestore.js';
 import { env } from 'process';
 
-export interface IAppDataOptions {
+export interface IAppDataOptions<T = any> {
   dirPath?: string;
-  requiredKeys?: string[];
+  requiredKeys?: Array<keyof T>;
 
   /**
    * kvStoreKey: 'MY_ENV_VAR'
    */
   envMapping?: {
-    [key: string]: string | object;
+    [key in keyof T]?: string | object;
   };
 }
 
@@ -22,17 +22,18 @@ export class AppData<T = any> {
    * @param pathArg
    * @returns
    */
-  public static async createAndInit<T = any>(optionsArg: IAppDataOptions = {}): Promise<AppData<T>> {
+  public static async createAndInit<T = any>(optionsArg: IAppDataOptions<T> = {}): Promise<AppData<T>> {
     const appData = new AppData<T>(optionsArg);
     await appData.readyDeferred.promise;
     return appData;
   }
 
   // instance
-  public readyDeferred = plugins.smartpromise.defer();
+  public readyDeferred = plugins.smartpromise.defer<void>();
-  public options: IAppDataOptions;
+  public options: IAppDataOptions<T>;
   private kvStore: KeyValueStore<T>;
-  constructor(optionsArg: IAppDataOptions = {}) {
+
+  constructor(optionsArg: IAppDataOptions<T> = {}) {
     this.options = optionsArg;
     this.init();
   }
@@ -59,28 +60,29 @@ export class AppData<T = any> {
         this.options.dirPath = nogitAppData;
       }
     }
-    this.kvStore = new KeyValueStore({
+
+    this.kvStore = new KeyValueStore<T>({
       typeArg: 'custom',
       identityArg: 'appkv',
       customPath: this.options.dirPath,
-      mandatoryKeys: this.options.requiredKeys
+      mandatoryKeys: this.options.requiredKeys as Array<keyof T>
     });
 
     if (this.options.envMapping) {
       const qenvInstance = new plugins.qenv.Qenv(process.cwd(), plugins.path.join(process.cwd(), '.nogit'));
 
       // Recursive function to handle nested objects, now includes key parameter
-      const processEnvMapping = async (key: string, mappingValue: any, parentKey: string = ''): Promise<any> => {
+      const processEnvMapping = async (key: keyof T, mappingValue: any, parentKey: keyof T | '' = ''): Promise<any> => {
         if (typeof mappingValue === 'string') {
-          let envValue: string;
+          let envValue: string | T[keyof T];
           if (mappingValue.startsWith('hard:')) {
-            envValue = mappingValue.replace('hard:', '');
+            envValue = mappingValue.replace('hard:', '') as T[keyof T];
           } else {
-            envValue = await qenvInstance.getEnvVarOnDemand(mappingValue);
+            envValue = await qenvInstance.getEnvVarOnDemand(mappingValue) as T[keyof T];
           }
           if (envValue) {
-            if (mappingValue.endsWith('_JSON')) {
+            if (typeof envValue === 'string' && mappingValue.endsWith('_JSON')) {
-              envValue = JSON.parse(envValue);
+              envValue = JSON.parse(envValue) as T[keyof T];
             }
             if (!parentKey) {
               await this.kvStore.writeKey(key, envValue);
@@ -91,16 +93,16 @@ export class AppData<T = any> {
             return undefined;
           }
         } else if (typeof mappingValue === 'object' && mappingValue !== null) {
-          const resultObject = {};
+          const resultObject: Partial<T> = {};
           for (const innerKey in mappingValue) {
             const nestedValue = mappingValue[innerKey];
             // For nested objects, call recursively but do not immediately write to kvStore
-            const nestedResult = await processEnvMapping(innerKey, nestedValue, key);
+            const nestedResult = await processEnvMapping(innerKey as keyof T, nestedValue, key);
-            resultObject[innerKey] = nestedResult;
+            resultObject[innerKey as keyof T] = nestedResult;
           }
           if (parentKey === '') {
             // Only write to kvStore if at the top level
-            await this.kvStore.writeKey(key, resultObject);
+            await this.kvStore.writeKey(key, resultObject as T[keyof T]);
           } else {
             // For nested objects, return the constructed object instead of writing to kvStore
             return resultObject;
@@ -109,24 +111,22 @@ export class AppData<T = any> {
       };
 
       for (const key in this.options.envMapping) {
-        await processEnvMapping(key, this.options.envMapping[key]);
+        await processEnvMapping(key as keyof T, this.options.envMapping[key]);
       }
     }
 
-    
-
     this.readyDeferred.resolve();
   }
 
   /**
-   * returns a kvtore that resides in appdata
+   * returns a kvstore that resides in appdata
    */
-  public async getKvStore() {
+  public async getKvStore(): Promise<KeyValueStore<T>> {
     await this.readyDeferred.promise;
     return this.kvStore;
   }
 
-  public async logMissingKeys() {
+  public async logMissingKeys(): Promise<Array<keyof T>> {
     const kvStore = await this.getKvStore();
     const missingMandatoryKeys = await kvStore.getMissingMandatoryKeys();
     if (missingMandatoryKeys.length > 0) {
@@ -141,9 +141,9 @@ export class AppData<T = any> {
     return missingMandatoryKeys;
   }
 
-  public async waitForAndGetKey(keyArg: string) {
+  public async waitForAndGetKey<K extends keyof T>(keyArg: K): Promise<T[K] | undefined> {
     await this.readyDeferred.promise;
     await this.kvStore.waitForKeysPresent([keyArg]);
-    return this.kvStore.readKey[keyArg];
+    return this.kvStore.readKey(keyArg);
   }
 }

ts/npmextra.classes.keyvaluestore.ts

@@ -5,11 +5,11 @@ import { Task } from '@push.rocks/taskbuffer';
 
 export type TKeyValueStore = 'custom' | 'userHomeDir';
 
-export interface IKvStoreConstructorOptions {
+export interface IKvStoreConstructorOptions<T> {
   typeArg: TKeyValueStore;
   identityArg: string;
   customPath?: string;
-  mandatoryKeys?: string[];
+  mandatoryKeys?: Array<keyof T>;
 }
 
 /**
@@ -17,9 +17,9 @@ export interface IKvStoreConstructorOptions {
  */
 export class KeyValueStore<T = any> {
   private dataObject: Partial<T> = {};
-  private deletedObject: any = {};
+  private deletedObject: Partial<T> = {};
-  private mandatoryKeys: Set<string> = new Set();
+  private mandatoryKeys: Set<keyof T> = new Set();
-  public changeSubject = new plugins.smartrx.rxjs.Subject();
+  public changeSubject = new plugins.smartrx.rxjs.Subject<Partial<T>>();
   
   private storedStateString: string = '';
   public syncTask = new Task({
@@ -28,12 +28,11 @@ export class KeyValueStore<T = any> {
     bufferMax: 1,
     execDelay: 0,
     taskFunction: async () => {
-      
       this.dataObject = {
         ...plugins.smartfile.fs.toObjectSync(this.filePath),
         ...this.dataObject,
       };
-      for (const key of Object.keys(this.deletedObject)) {
+      for (const key of Object.keys(this.deletedObject) as Array<keyof T>) {
         delete this.dataObject[key];
       }
       this.deletedObject = {};
@@ -89,7 +88,7 @@ export class KeyValueStore<T = any> {
    * @param identityArg
    * @param customPath Optional custom path for the keyValue store
    */
-  constructor(optionsArg: IKvStoreConstructorOptions) {
+  constructor(optionsArg: IKvStoreConstructorOptions<T>) {
     if (optionsArg.customPath && optionsArg.typeArg !== 'custom') {
       throw new Error('customPath can only be provided if typeArg is custom');
     }
@@ -108,7 +107,7 @@ export class KeyValueStore<T = any> {
   /**
    * reads all keyValue pairs at once and returns them
    */
-  public async readAll() {
+  public async readAll(): Promise<Partial<T>> {
     await this.syncTask.trigger();
     return this.dataObject;
   }
@@ -116,21 +115,21 @@ export class KeyValueStore<T = any> {
   /**
    * reads a keyValueFile from disk
    */
-  public async readKey(keyArg: string) {
+  public async readKey<K extends keyof T>(keyArg: K): Promise<T[K]> {
     await this.syncTask.trigger();
-    return this.dataObject[keyArg];
+    return this.dataObject[keyArg] as T[K];
   }
 
   /**
    * writes a specific key to the keyValueStore
    */
-  public async writeKey(keyArg: string, valueArg: any) {
+  public async writeKey<K extends keyof T>(keyArg: K, valueArg: T[K]): Promise<void> {
     await this.writeAll({
       [keyArg]: valueArg,
-    });
+    } as unknown as Partial<T>);
   }
 
-  public async deleteKey(keyArg: string) {
+  public async deleteKey<K extends keyof T>(keyArg: K): Promise<void> {
     this.deletedObject[keyArg] = this.dataObject[keyArg];
     await this.syncTask.trigger();
   }
@@ -138,7 +137,7 @@ export class KeyValueStore<T = any> {
   /**
    * writes all keyValue pairs in the object argument
    */
-  public async writeAll(keyValueObject: { [key: string]: any }) {
+  public async writeAll(keyValueObject: Partial<T>): Promise<void> {
     this.dataObject = { ...this.dataObject, ...keyValueObject };
     await this.syncTask.trigger();
   }
@@ -146,7 +145,7 @@ export class KeyValueStore<T = any> {
   /**
    * wipes a key value store from disk
    */
-  public async wipe() {
+  public async wipe(): Promise<void> {
     this.dataObject = {};
     await plugins.smartfile.fs.remove(this.filePath);
   }
@@ -154,11 +153,11 @@ export class KeyValueStore<T = any> {
   /**
    * resets the KeyValueStore to the initial state by syncing first, deleting all keys, and then triggering a sync again
    */
-  public async reset() {
+  public async reset(): Promise<void> {
     await this.syncTask.trigger(); // Sync to get the latest state
 
     // Delete all keys from the dataObject and add them to deletedObject
-    for (const key of Object.keys(this.dataObject)) {
+    for (const key of Object.keys(this.dataObject) as Array<keyof T>) {
       this.deletedObject[key] = this.dataObject[key];
       delete this.dataObject[key];
     }
@@ -166,21 +165,21 @@ export class KeyValueStore<T = any> {
     await this.syncTask.trigger(); // Sync again to reflect the deletion
   }
 
-  private setMandatoryKeys(keys: string[]) {
+  private setMandatoryKeys(keys: Array<keyof T>) {
     keys.forEach(key => this.mandatoryKeys.add(key));
   }
 
-  public async getMissingMandatoryKeys(): Promise<string[]> {
+  public async getMissingMandatoryKeys(): Promise<Array<keyof T>> {
     await this.readAll();
     return Array.from(this.mandatoryKeys).filter(key => !(key in this.dataObject));
   }
 
-  public async waitForKeysPresent(keysArg: string[]): Promise<void> {
+  public async waitForKeysPresent<K extends keyof T>(keysArg: K[]): Promise<void> {
     const missingKeys = keysArg.filter(keyArg => !this.dataObject[keyArg]);
     if (missingKeys.length === 0) {
       return;
     }
-    return new Promise((resolve, reject) => {
+    return new Promise<void>((resolve, reject) => {
       const subscription = this.changeSubject.subscribe(() => {
         const missingKeys = keysArg.filter(keyArg => !this.dataObject[keyArg]);
         if (missingKeys.length === 0) {
@@ -190,4 +189,9 @@ export class KeyValueStore<T = any> {
       });
     });
   }
+
+  public async waitForAndGetKey<K extends keyof T>(keyArg: K): Promise<T[K] | undefined> {
+    await this.waitForKeysPresent([keyArg]);
+    return this.readKey(keyArg);
+  }
 }