started adapter.ts port (#1917)

* started adapter.ts port

* added more types to AdapterOptions

* more types

* more types

* more types fixed

* started porting first methods in our new style

* some more methods ported

* added more signatures to methods

* start porting async methods

* more async methods defined

* do not use this.log internally

* more types

* switch to interface merging

* imports

* dynamic methods with overloads need to be defined by interface merging

* ported lots of methods

* more types fixed

* more types

* more types

* working towards first compile

* more fixes

* finish line for first build is close

* first build

* some types improved

* fix some tests

* fixed setState signature and strictObjectCheck

* some type improvements + tests fixed

* fix build

* better types

* more types

* more types

* typo

* fix tests

* more types

* only 10 methods left

* fix tests

* deleteDevice

* more types

* port finished for first review

* fix this context

* fix forbidden_chars, generated typedoc docs via postbuild

* incorporate #1923

* use markdown docs instead of html, to be easier compatible with offical docs

* exlucde private methods and attributes from public docs

* forgot private prefix on one method

* remove jsdoc memberof and alias as it is redundant

* asserts -> assert

* fix build

* fix this context test

* some review addressed

* some more review

* some more review

* move simple definitions above constructor

* move types into separate file and fix missing unknown strategy on some methods

* type adapterConfig

* fix del state

* fix missing overloads

* fix format date

* address comments

Author: foxriver76

package-lock.json

@@ -34,6 +34,8 @@
     "@types/mocha": "^9.0.0",
     "@types/node": "^17.0.5",
     "@types/node-forge": "^1.0.0",
+    "@types/node-schedule": "^2.1.0",
+    "@types/pidusage": "^2.0.2",
     "@types/readline-sync": "^1.4.4",
     "@types/semver": "^7.3.10",
     "@types/tar": "^6.1.1",
@@ -59,6 +61,8 @@
     "semver": "^7.3.7",
     "sinon": "^13.0.2",
     "sinon-chai": "^3.7.0",
+    "typedoc": "^0.22.15",
+    "typedoc-plugin-markdown": "^3.12.1",
     "typescript": "^4.7.4"
   },
   "scripts": {

package.json

@@ -13,6 +13,7 @@
     "@iobroker/db-states-jsonl": "file:../db-states-jsonl",
     "@iobroker/db-states-redis": "file:../db-states-redis",
     "@iobroker/js-controller-common": "file:../common",
+    "@iobroker/js-controller-common-db": "file:../common-db",
     "@iobroker/plugin-base": "~1.2.1",
     "@iobroker/plugin-sentry": "~1.2.0",
     "deep-clone": "^3.0.3",
@@ -39,7 +40,7 @@
   },
   "scripts": {
     "build": "tsc -b tsconfig.build.json",
-    "postbuild": "cpy ./src/cert/ ./build/"
+    "postbuild": "cpy ./cert ../build/ --cwd=src && typedoc --excludePrivate --plugin typedoc-plugin-markdown src/lib/adapter/adapter.ts --out ../controller/doc"
   },
   "main": "build/index.js",
   "types": "build/index.d.ts",

packages/adapter/package.json

@@ -1,2 +1,3 @@
-export { default as Adapter } from './lib/adapter/adapter';
+export { Adapter } from './lib/adapter/adapter';
 export { Utils } from './lib/adapter/utils';
+export * from './lib/_Types';