v1.0.6

Author: heliomarpm

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -3,43 +3,52 @@ description: Suggest an idea or feature.
 labels:
 - enhancement
 - needs-triage
+
 body:
+- type: markdown
+  attributes:
+    value: 'Please read and follow the instructions before submitting an issue:'
+
+- type: markdown
+  attributes:
+    value: |
+      - Read all our documentation, especially the [README](https://github.com/heliomarpm/keyvalues-storage/blob/master/README.md). It may contain information that helps you solve your issue.
+      - Ensure your issue isn't already [reported](https://github.com/heliomarpm/keyvalues-storage/issues?utf8=%E2%9C%93&q=is%3Aissue).
+
+- type: markdown
+  attributes:
+    value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️'
+
+- type: textarea
+  id: description
+  attributes:
+    label: 'Is your feature request related to a problem? Please describe.'
+    description: A clear and concise description of what the problem is.
+    placeholder: I'm always frustrated when [...]
+  validations:
+    required: true
+
+- type: textarea
+  id: solution
+  attributes:
+    label: Describe the solution you'd like
+    description: A clear and concise description of what you want to happen.
+  validations:
+    required: false
+
+- type: textarea
+  id: alternative
+  attributes:
+    label: Describe alternatives you've considered
+    description: A clear and concise description of any alternative solutions or features you've considered.
+  validations:
+    required: false
 
-  - type: markdown
-    attributes:
-      value: |
-        - Read all our documentation, especially the [README](https://github.com/heliomarpm/keyvalues-storage/blob/master/README.md). It may contain information that helps you solve your issue.
-        - Ensure your issue isn't already [reported](https://github.com/heliomarpm/keyvalues-storage/issues?utf8=%E2%9C%93&q=is%3Aissue).
-   - type: markdown
-    attributes:
-      value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️'
-  - type: textarea
-    id: description
-    attributes:
-      label: 'Is your feature request related to a problem? Please describe.'
-      description: A clear and concise description of what the problem is.
-      placeholder: I'm always frustrated when [...]
-    validations:
-      required: true
-  - type: textarea
-    id: solution
-    attributes:
-      label: Describe the solution you'd like
-      description: A clear and concise description of what you want to happen.
-    validations:
-      required: false
-  - type: textarea
-    id: alternative
-    attributes:
-      label: Describe alternatives you've considered
-      description: A clear and concise description of any alternative solutions or features you've considered.
-    validations:
-      required: false
-  - type: textarea
-    id: additional-context
-    attributes:
-      label: 'Additional context/Screenshots'
-      description: Add any other context or screenshots about the feature request here.
-      render: bash
-    validations:
-      required: false
+- type: textarea
+  id: additional-context
+  attributes:
+    label: 'Additional context/Screenshots'
+    description: Add any other context or screenshots about the feature request here.
+    render: bash
+  validations:
+    required: false

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 localdb
+data
 dist
 lib
 tmp

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heliomarpm/kvs",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "A simple and robust KeyValues Storage's library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -36,7 +36,7 @@
     "build": "tsc",
     "test": "jest --detectOpenHandles",
     "test:c": "jest --coverage",
-    "commit": "node ./cmd/modules/release/index.js"
+    "pub:release": "node ./cmd/modules/release/index.js"
   },
   "dependencies": {
     "lodash": "^4.17.21",
@@ -54,4 +54,4 @@
     "@types/lodash": "^4.14.194",
     "@types/write-file-atomic": "^4.0.0"
   }
-}
+}

src/internal/JsonFileHelper.ts

@@ -4,6 +4,9 @@ import writeFileAtomic from 'write-file-atomic';
 
 import './types';
 
+export const DEFAULT_DIR_NAME = 'localdb';
+export const DEFAULT_FILE_NAME = 'keyvalues.json';
+
 export class JsonFileHelper {
 
   options: Options;
@@ -21,7 +24,8 @@ export class JsonFileHelper {
    * @internal
    */
   private getJsonDirPath(): string {
-    return this.options.dir ?? path.resolve('localdb')
+    let dir = (this.options.dir ?? path.resolve(DEFAULT_DIR_NAME)).trim();
+    return dir === '' ? './' : dir;
   }
 
   /**
@@ -33,8 +37,10 @@ export class JsonFileHelper {
    */
   public getJsonFilePath(): string {
     const dir = this.getJsonDirPath();
+    let fileName = this.options.fileName.trim();
+    fileName = fileName === '' ? DEFAULT_FILE_NAME : fileName;
 
-    return path.join(dir, this.options.fileName);
+    return path.join(dir, fileName);
   }
 
   /**
@@ -48,7 +54,7 @@ export class JsonFileHelper {
     const filePath = this.getJsonFilePath();
 
     return new Promise((resolve, reject) => {
-      fs.stat(filePath, (err) => {
+      fs.stat(filePath, (err: any) => {
         if (err) {
           if (err.code === 'ENOENT') {
             this.saveKeyValues({}).then(resolve, reject);
@@ -93,10 +99,10 @@ export class JsonFileHelper {
     const dirPath = this.getJsonDirPath();
 
     return new Promise((resolve, reject) => {
-      fs.stat(dirPath, (err) => {
+      fs.stat(dirPath, (err: any) => {
         if (err) {
           if (err.code === 'ENOENT') {
-            fs.mkdir(dirPath, { recursive: true }, (error) => {
+            fs.mkdir(dirPath, { recursive: true }, (error: any) => {
               error ? reject(error) : resolve();
             });
             // mkdirp(dirPath).then(() => resolve(), reject);
@@ -143,12 +149,13 @@ export class JsonFileHelper {
     const filePath = this.getJsonFilePath();
 
     return await new Promise((resolve, reject) => {
-      fs.readFile(filePath, 'utf-8', (err, data) => {
+      fs.readFile(filePath, 'utf-8', (err: any, data: string | any[]) => {
         if (err) {
           reject(err);
         } else {
           try {
-            resolve(JSON.parse(data.length ? data : "{}"));
+            // resolve(JSON.parse(data.length ? data : "{}"));
+            resolve(JSON.parse(data ? (Array.isArray(data) ? data.join('') : data) : "{}"));
           } catch (err_1) {
             reject(err_1);
           }
@@ -193,7 +200,7 @@ export class JsonFileHelper {
             : resolve();
         });
       } else {
-        fs.writeFile(filePath, data, (err_1) => {
+        fs.writeFile(filePath, data, (err_1: any) => {
           return err_1 ? reject(err_1)
             : resolve();
         });

src/keyvalues.ts

@@ -1,12 +1,13 @@
 import { get as _get, set as _set, has as _has, unset as _unset } from 'lodash';
 
 import './internal/types';
-import { JsonFileHelper } from './internal/JsonFileHelper'
+import { DEFAULT_DIR_NAME, DEFAULT_FILE_NAME, JsonFileHelper } from './internal/JsonFileHelper'
 
 /** @internal */
 const defaultOptions: Options = {
   atomicSave: true,
-  fileName: 'keyvalues.json',
+  dir: DEFAULT_DIR_NAME,
+  fileName: DEFAULT_FILE_NAME,
   prettify: false,
   numSpaces: 2,
 };

test/codium.test.ts

@@ -0,0 +1,69 @@
+// Generated by CodiumAI
+
+import { KeyValues } from '../src/keyvalues';
+import { JsonFileHelper } from '../src/internal/JsonFileHelper';
+
+describe('Codium Complex Test', () => {
+  it('healthCheck', () => {
+    expect(1).toBe(1);
+  });
+  // Tests that the set method sets the value of a key
+  it('should set the value of a key', async () => {
+    const mockSaveKeyValues = jest.spyOn(JsonFileHelper.prototype, 'saveKeyValues').mockResolvedValue();
+
+    const kvs = new KeyValues({fileName: 'complex.json', prettify: true});
+    await kvs.set('key', 'value');
+
+    expect(mockSaveKeyValues).toHaveBeenCalledWith({ key: 'value' });
+    mockSaveKeyValues.mockRestore();
+  });
+
+  // Tests that the set method sets the value of a nested key
+  it('should set the value of a nested key', async () => {
+    const mockLoadKeyValues = jest.spyOn(JsonFileHelper.prototype, 'loadKeyValues');
+    const mockSaveKeyValues = jest.spyOn(JsonFileHelper.prototype, 'saveKeyValues');
+    mockLoadKeyValues.mockResolvedValue({ parent: {} });
+
+    const kvs = new KeyValues({fileName: 'complex.json', prettify: true});
+    await kvs.set('parent.child', 'value');
+
+    expect(mockLoadKeyValues).toHaveBeenCalled();
+    expect(mockSaveKeyValues).toHaveBeenCalledWith({ parent: { child: 'value' } });
+    mockLoadKeyValues.mockRestore();
+    mockSaveKeyValues.mockRestore();
+  });
+
+  // Tests that the unset method removes a key and its value
+  it('should remove a key and its value', async () => {
+    const mockLoadKeyValues = jest.spyOn(JsonFileHelper.prototype, 'loadKeyValues');
+    const mockSaveKeyValues = jest.spyOn(JsonFileHelper.prototype, 'saveKeyValues');
+    mockLoadKeyValues.mockResolvedValue({ key: 'value' });
+
+    const kvs = new KeyValues({fileName: 'complex.json', prettify: true});
+    await kvs.unset('key');
+
+    expect(mockLoadKeyValues).toHaveBeenCalled();
+    expect(mockSaveKeyValues).toHaveBeenCalledWith({});
+    mockLoadKeyValues.mockRestore();
+    mockSaveKeyValues.mockRestore();
+  });
+
+  it('shold get complex value', () => {
+    const color = {
+      name: 'cerulean',
+      code: {
+        rgb: [0, 179, 230],
+        hex: '#003BE6',
+      },
+    };
+    const keyValues = new KeyValues({ fileName: 'color.json', prettify: true });
+    keyValues.setSync('color', color);
+    expect(keyValues.getSync('color')).toEqual(color);
+
+    expect(keyValues.getSync('color.name')).toEqual('cerulean');
+    expect(keyValues.getSync('color.code.hex')).toEqual('#003BE6');
+    expect(keyValues.getSync(['color', 'code'])).toEqual({ hex: '#003BE6', rgb: [0, 179, 230] });
+
+    expect(keyValues.getSync(['color', 'hue'])).toBeUndefined();
+  });
+});