1.0.12

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @gitzone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
+      "type": "node-terminal"
     }
   ]
 }

npmextra.json

@@ -3,10 +3,10 @@
     "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "smartobject",
-      "shortDescription": "work with objects",
-      "npmPackagename": "@pushrocks/smartobject",
+      "description": "work with objects",
+      "npmPackagename": "@push.rocks/smartobject",
       "license": "MIT",
       "projectDomain": "push.rocks"
     }

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@pushrocks/smartobject",
-  "version": "1.0.6",
+  "name": "@push.rocks/smartobject",
+  "version": "1.0.12",
   "private": false,
   "description": "work with objects",
   "main": "dist_ts/index.js",
@@ -10,18 +10,19 @@
   "scripts": {
     "test": "(tstest test/)",
     "build": "(tsbuild --web)",
-    "format": "(gitzone format)"
+    "format": "(gitzone format)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.2.14",
-    "@types/node": "^14.14.35",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.15.0"
+    "@gitzone/tsbuild": "^2.1.66",
+    "@gitzone/tsrun": "^1.2.42",
+    "@gitzone/tstest": "^1.0.74",
+    "@push.rocks/tapbundle": "^5.0.8",
+    "@types/node": "^20.4.1"
   },
   "dependencies": {
-    "fast-deep-equal": "^3.1.3"
+    "fast-deep-equal": "^3.1.3",
+    "minimatch": "^9.0.3"
   },
   "browserslist": [
     "last 1 chrome versions"
@@ -37,5 +38,6 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
-  ]
+  ],
+  "type": "module"
 }

readme.md

@@ -1,27 +1,26 @@
-# @pushrocks/smartobject
+# @push.rocks/smartobject
 work with objects
 
 ## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartobject)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartobject)
-* [github.com (source mirror)](https://github.com/pushrocks/smartobject)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartobject/)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartobject)
+* [gitlab.com (source)](https://gitlab.com/push.rocks/smartobject)
+* [github.com (source mirror)](https://github.com/push.rocks/smartobject)
+* [docs (typedoc)](https://push.rocks.gitlab.io/smartobject/)
 
 ## Status for master
 
 Status Category | Status Badge
 -- | --
-GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartobject/badges/master/pipeline.svg)](https://lossless.cloud)
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartobject/badges/master/coverage.svg)](https://lossless.cloud)
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartobject)](https://lossless.cloud)
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartobject)](https://lossless.cloud)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smartobject/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smartobject/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartobject)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/smartobject)](https://lossless.cloud)
 TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
 node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
 Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
-PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartobject)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartobject)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartobject)](https://lossless.cloud)
-Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartobject)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartobject)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartobject)](https://lossless.cloud)
 
 ## Usage
 
@@ -33,7 +32,6 @@ We are always happy for code contributions. If you are not the code contributing
 
 For further information read the linked docs at the top of this readme.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
 | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
-
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.both.ts

@@ -1,5 +1,5 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartobject from '../ts/index';
+import { expect, tap } from '@push.rocks/tapbundle';
+import * as smartobject from '../ts/index.js';
 
 tap.test('first test', async () => {
   const result = smartobject.compareObjects(
@@ -10,8 +10,60 @@ tap.test('first test', async () => {
 });
 
 tap.test('should fast deep equal objects', async () => {
-  expect(smartobject.fastDeepEqual({ hello: 'yes' }, { hello: 'yes' })).to.be.true;
-  expect(smartobject.fastDeepEqual({ hello: 'yes' }, { hello: 3 })).to.be.false;
+  expect(smartobject.fastDeepEqual({ hello: 'yes' }, { hello: 'yes' })).toBeTrue();
+  expect(smartobject.fastDeepEqual({ hello: 'yes' }, { hello: 3 })).toBeFalse();
+});
+
+let parentObject: any = {};
+let childObject: any = {};
+
+tap.test('childObject should not yet be in parentObject', async () => {
+  expect(smartobject.exists(parentObject, 'childObject')).toBeFalse();
+  parentObject.childObject = childObject;
+});
+
+tap.test('childObject should now be in parentObject', async () => {
+  expect(smartobject.exists(parentObject, 'childObject')).toBeTrue();
+});
+
+tap.test('should be able to deepAdd an childParam', async () => {
+  const parentObject = {
+    hello: 'there',
+  };
+  const parentObject2 = smartobject.smartAdd(parentObject, 'wow.za', 'yes');
+  console.log(parentObject2);
+  expect(smartobject.exists(parentObject2.wow, 'za')).toBeTrue();
+});
+
+tap.test('should be able to deep get an item', async () => {
+  const testObject = {
+    hey: {
+      there: {
+        so: 'cool',
+      },
+    },
+  };
+
+  const item = smartobject.smartGet(testObject, 'hey.there.so');
+  expect(item).toEqual('cool');
+});
+
+tap.test('should call properties for minimatched properties', async () => {
+  let testObject = {
+    matchedOne: 'Hey!',
+    matchedTwo: 'this works!',
+    notmatched: 'NOT!',
+  };
+
+  const matchedStrings: string[] = [];
+  await smartobject.forEachMinimatch(testObject, 'matched*', (matchedProperty) => {
+    matchedStrings.push(matchedProperty);
+    console.log(matchedProperty);
+  });
+
+  expect(matchedStrings).toContain('Hey!');
+  expect(matchedStrings).toContain('this works!');
+  expect(matchedStrings).not.toContain('NOT!');
 });
 
 tap.start();

test/test.smartobject.ts

@@ -0,0 +1,24 @@
+import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
+import * as smartobject from '../ts/index.js';
+
+let testSmartobject: smartobject.SmartObject;
+
+tap.test('should create a smartobject', async () => {
+  const originalObject = {
+    test: 'hey',
+    deep: {
+      yeah: 'so deep',
+      evendeeper: {
+        sodeep: 2,
+        deepArray: ['one array', 'two array'],
+      },
+    },
+  };
+  testSmartobject = new smartobject.SmartObject(originalObject);
+  testSmartobject.addValueAtFlatPathString('deep.nice', 'yeah that has been added');
+  console.log(testSmartobject.originalObject);
+  console.log(testSmartobject.toFlatObject());
+  expect(testSmartobject.getValueAtFlatPathString('deep.yeah')).toEqual('so deep');
+});
+
+tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartobject',
+  version: '1.0.12',
+  description: 'work with objects'
+}

ts/index.ts

@@ -1,83 +1,6 @@
-import * as plugins from './smartobject.plugins';
-
+import * as plugins from './smartobject.plugins.js';
 const fastDeepEqual = plugins.fastDeepEqual;
 export { fastDeepEqual };
 
-export interface IObjectCompareResult {
-  presentInBothProperties: string[];
-  missingProperties: string[];
-  additionalProperties: string[];
-  nulledProperties: string[];
-  undefinedProperties: string[];
-  divergingProperties: string[];
-  equalProperties: string[];
-}
-
-export const compareObjects = (
-  referenceObjectArg: any,
-  comparisonObjectArg: any
-): IObjectCompareResult => {
-  const returnComparisonObject = {
-    missingProperties: [],
-    additionalProperties: [],
-    presentInBothProperties: [],
-    nulledProperties: [],
-    undefinedProperties: [],
-    divergingProperties: [],
-    equalProperties: [],
-  };
-
-  const allProperties = Object.keys(referenceObjectArg).concat(Object.keys(comparisonObjectArg));
-  for (const currentProperty of allProperties) {
-    // lets find presentInBothProperties
-    if (referenceObjectArg[currentProperty] && comparisonObjectArg[currentProperty]) {
-      returnComparisonObject.presentInBothProperties.push(currentProperty);
-    }
-
-    // lets find missingProperties
-    if (referenceObjectArg[currentProperty] && !comparisonObjectArg[currentProperty]) {
-      returnComparisonObject.missingProperties.push(currentProperty);
-    }
-
-    // lets find additionalProperties
-    if (!referenceObjectArg[currentProperty] && comparisonObjectArg[currentProperty]) {
-      returnComparisonObject.additionalProperties.push(currentProperty);
-    }
-
-    // lets find nulledProperties
-    if (comparisonObjectArg[currentProperty] === null) {
-      returnComparisonObject.nulledProperties.push(currentProperty);
-    }
-
-    // lets find undefinedProperties
-    if (comparisonObjectArg[currentProperty] === undefined) {
-      returnComparisonObject.undefinedProperties.push(currentProperty);
-    }
-
-    // lets find divergingProperties
-    if (
-      JSON.stringify(referenceObjectArg[currentProperty]) !==
-      JSON.stringify(comparisonObjectArg[currentProperty])
-    ) {
-      returnComparisonObject.divergingProperties.push(currentProperty);
-    }
-
-    // lets find equalProperties
-    if (
-      JSON.stringify(referenceObjectArg[currentProperty]) ===
-      JSON.stringify(comparisonObjectArg[currentProperty])
-    ) {
-      returnComparisonObject.equalProperties.push(currentProperty);
-    }
-  }
-
-  for (const currentProperty of Object.keys(returnComparisonObject)) {
-    const onlyUnique = (value, index, self) => {
-      return self.indexOf(value) === index;
-    };
-    const uniqueArray = returnComparisonObject[currentProperty].filter(onlyUnique);
-    returnComparisonObject[currentProperty] = uniqueArray;
-  }
-
-  return returnComparisonObject;
-};
+export * from './smartobject.classes.smartobject.js';
+export * from './tools/index.js';

ts/smartobject.classes.smartobject.ts

@@ -0,0 +1,24 @@
+import * as tools from './tools/index.js';
+
+/**
+ * a smartobject that simplifies accessing objects
+ */
+export class SmartObject {
+  // instance
+  public originalObject: object;
+  constructor(originalObjectArg: object) {
+    this.originalObject = originalObjectArg;
+  }
+
+  public getValueAtFlatPathString(pathArg: string) {
+    return tools.smartGet(this.originalObject, pathArg);
+  }
+
+  public addValueAtFlatPathString(pathArg: string, valueArg: any) {
+    return tools.smartAdd(this.originalObject, pathArg, valueArg);
+  }
+
+  public toFlatObject() {
+    return tools.toFlatObject(this.originalObject);
+  }
+}

ts/smartobject.plugins.ts

@@ -1,4 +1,6 @@
+// thirdparty scope
 // tslint:disable-next-line: no-submodule-imports
-import fastDeepEqual from 'fast-deep-equal/es6';
+import fastDeepEqual from 'fast-deep-equal/es6/index.js';
+import * as minimatch from 'minimatch';
 
-export { fastDeepEqual };
+export { fastDeepEqual, minimatch };

ts/tools/compareobjects.ts

@@ -0,0 +1,85 @@
+import * as plugins from '../smartobject.plugins.js';
+
+export interface IObjectCompareResult {
+  presentInBothProperties: string[];
+  missingProperties: string[];
+  additionalProperties: string[];
+  nulledProperties: string[];
+  undefinedProperties: string[];
+  divergingProperties: string[];
+  equalProperties: string[];
+}
+
+export const compareObjects = (
+  referenceObjectArg: any,
+  comparisonObjectArg: any
+): IObjectCompareResult => {
+  const returnComparisonObject = {
+    missingProperties: [] as string[],
+    additionalProperties: [] as string[],
+    presentInBothProperties: [] as string[],
+    nulledProperties: [] as string[],
+    undefinedProperties: [] as string[],
+    divergingProperties: [] as string[],
+    equalProperties: [] as string[],
+  };
+
+  const allProperties = Object.keys(referenceObjectArg).concat(Object.keys(comparisonObjectArg));
+  for (const currentProperty of allProperties) {
+    // lets find presentInBothProperties
+    if (referenceObjectArg[currentProperty] && comparisonObjectArg[currentProperty]) {
+      returnComparisonObject.presentInBothProperties.push(currentProperty);
+    }
+
+    // lets find missingProperties
+    if (referenceObjectArg[currentProperty] && !comparisonObjectArg[currentProperty]) {
+      returnComparisonObject.missingProperties.push(currentProperty);
+    }
+
+    // lets find additionalProperties
+    if (!referenceObjectArg[currentProperty] && comparisonObjectArg[currentProperty]) {
+      returnComparisonObject.additionalProperties.push(currentProperty);
+    }
+
+    // lets find nulledProperties
+    if (comparisonObjectArg[currentProperty] === null) {
+      returnComparisonObject.nulledProperties.push(currentProperty);
+    }
+
+    // lets find undefinedProperties
+    if (comparisonObjectArg[currentProperty] === undefined) {
+      returnComparisonObject.undefinedProperties.push(currentProperty);
+    }
+
+    // lets find divergingProperties
+    if (
+      JSON.stringify(referenceObjectArg[currentProperty]) !==
+      JSON.stringify(comparisonObjectArg[currentProperty])
+    ) {
+      returnComparisonObject.divergingProperties.push(currentProperty);
+    }
+
+    // lets find equalProperties
+    if (
+      plugins.fastDeepEqual(
+        referenceObjectArg[currentProperty],
+        comparisonObjectArg[currentProperty]
+      )
+    ) {
+      returnComparisonObject.equalProperties.push(currentProperty);
+    }
+  }
+
+  for (const currentProperty of Object.keys(returnComparisonObject)) {
+    const onlyUnique = (value: any, index: number, self: Array<any>) => {
+      return self.indexOf(value) === index;
+    };
+    const uniqueArray =
+      returnComparisonObject[currentProperty as keyof typeof returnComparisonObject].filter(
+        onlyUnique
+      );
+    returnComparisonObject[currentProperty as keyof typeof returnComparisonObject] = uniqueArray;
+  }
+
+  return returnComparisonObject;
+};

ts/tools/exists.ts

@@ -0,0 +1,14 @@
+import * as plugins from '../smartobject.plugins.js';
+
+/**
+ * checks if an object has a parameter with a given key name, returns true if yes.
+ * @param parentObject
+ * @param childParam
+ * @returns {boolean}
+ */
+export let exists = (parentObject: object, childParam: string): boolean => {
+  if (parentObject.hasOwnProperty(childParam)) {
+    return true;
+  }
+  return false;
+};

ts/tools/foreachminimatch.ts

@@ -0,0 +1,21 @@
+import * as plugins from '../smartobject.plugins.js';
+
+/**
+ * runs a function for all properties of an object whose key matches a regex expression
+ * @param parentObjectArg the parent object
+ * @param wildcardArg the rege expression to match the property keys against
+ * @param callbackArg the function to run with those properties
+ */
+export let forEachMinimatch = async (
+  parentObjectArg: any,
+  wildcardArg: string,
+  callbackArg: (matchedArg: string) => void
+) => {
+  let propertyNames = Object.getOwnPropertyNames(parentObjectArg);
+  let propertyNamesMatched = propertyNames.filter((propertyNameArg) => {
+    return plugins.minimatch.minimatch(propertyNameArg, wildcardArg);
+  });
+  for (let propertyNameArg of propertyNamesMatched) {
+    await callbackArg(parentObjectArg[propertyNameArg]);
+  }
+};

ts/tools/index.ts

@@ -0,0 +1,5 @@
+export * from './compareobjects.js';
+export * from './exists.js';
+export * from './foreachminimatch.js';
+export * from './smart_add_get.js';
+export * from './toFlatObject.js';

ts/tools/smart_add_get.ts

@@ -0,0 +1,92 @@
+import * as plugins from '../smartobject.plugins.js';
+
+/**
+ * adds an object to the parent object if it doesn't exists
+ * @param parentObject
+ * @param childParam
+ * @param logBool
+ * @returns {boolean}
+ */
+export const smartAdd = (
+  parentObject: object,
+  childParam: string,
+  valueArg: any = {},
+  optionsArg?: {
+    interpretDotsAsLevel: boolean;
+  }
+): typeof parentObject & any => {
+  optionsArg = {
+    interpretDotsAsLevel: true,
+    ...optionsArg,
+  };
+
+  let paramLevels: string[];
+  let referencePointer: any = parentObject;
+  if (optionsArg.interpretDotsAsLevel) {
+    paramLevels = childParam.split('.');
+  } else {
+    paramLevels = [childParam];
+  }
+
+  for (let i = 0; i !== paramLevels.length; i++) {
+    const varName: string = paramLevels[i];
+
+    // is there a next variable ?
+    const varNameNext: string = (() => {
+      if (paramLevels[i + 1]) {
+        return paramLevels[i + 1];
+      }
+      return null;
+    })();
+
+    // build the tree in parentObject
+    if (!referencePointer[varName] && !varNameNext) {
+      referencePointer[varName] = valueArg;
+      referencePointer = null;
+    } else if (!referencePointer[varName] && varNameNext) {
+      referencePointer[varName] = {};
+      referencePointer = referencePointer[varName];
+    } else if (referencePointer[varName] && varNameNext) {
+      referencePointer = referencePointer[varName];
+    } else {
+      throw new Error('Something is strange!');
+    }
+  }
+  return parentObject;
+};
+
+/**
+ * gets an object from the parent object using dots as levels by default
+ * @param parentObject
+ * @param childParam
+ * @param optionsArg
+ */
+export const smartGet = <T>(
+  parentObject: object,
+  childParam: string,
+  optionsArg?: {
+    interpretDotsAsLevel: boolean;
+  }
+): T => {
+  optionsArg = {
+    interpretDotsAsLevel: true,
+    ...optionsArg,
+  };
+
+  let paramLevels: string[];
+  if (optionsArg.interpretDotsAsLevel) {
+    paramLevels = childParam.split('.');
+  } else {
+    paramLevels = [childParam];
+  }
+
+  let referencePointer: any = parentObject;
+  for (const level of paramLevels) {
+    if (referencePointer[level as any]) {
+      referencePointer = referencePointer[level as any];
+    } else {
+      return null;
+    }
+  }
+  return referencePointer as T;
+};

ts/tools/toFlatObject.ts

@@ -0,0 +1,29 @@
+export const toFlatObject = (objectArg: object) => {
+  const returnObject: { [key: string]: any } = {};
+  const extractLayer = (
+    subObject: { [key: string]: any },
+    pathArg: string,
+    loopProtection: object[]
+  ) => {
+    if (loopProtection.indexOf(subObject) > -1) {
+      return;
+    }
+    if (subObject)
+      for (const key of Object.keys(subObject)) {
+        let localPathArg = pathArg;
+        if (typeof subObject[key] === 'object' && !(subObject[key] instanceof Array)) {
+          const newLoopbackArray = loopProtection.slice();
+          newLoopbackArray.push(subObject);
+          extractLayer(
+            subObject[key],
+            localPathArg ? (localPathArg += `.${key}`) : key,
+            newLoopbackArray
+          );
+        } else {
+          returnObject[localPathArg ? (localPathArg += `.${key}`) : key] = subObject[key];
+        }
+      }
+  };
+  extractLayer(objectArg, '', []);
+  return returnObject;
+};

tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true,
+  }
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}