fix: update TypeScript support and type definitions (#147)

* feat: add TypeScript implementation of TCK and update types
* fix: resolve tsd-jsdoc warnings
* fix: add type verification and tidy up mixed approach
* tck: replace with typescript implementation
* fix: reintroduce jsdoc for all user-facing types
* update: move tsc compile options to tsconfig

Author: pvlugter

.circleci/config.yml

@@ -224,7 +224,7 @@ jobs:
           command: |
             source /opt/circleci/.nvm/nvm.sh
             pushd sdk && nvm install && npm ci && npm pack && popd
-            pushd tck && nvm install && npm install && npm ci && npm run tck && popd
+            pushd tck && npm install && npm run tck && popd
 
   validate-docs:
     machine: true

.gitignore

@@ -1,4 +1,3 @@
 node_modules
 .DS_Store
 .idea
-tck/package-lock.json

.prettierignore

@@ -1,6 +1,10 @@
 package.json
 package-lock.json
 jsdoc.json
-/tck/proto/**/*.*
+/sdk/apidocs/**/*.*
 /sdk/dist/**/*.*
 /sdk/proto/**/*.*
+/sdk/test/proto/**/*.*
+/tck/dist/**/*.*
+/tck/generated/**/*.*
+/tck/proto/**/*.*

build/license.json

@@ -1,6 +1,19 @@
 {
   "ignoreFile": "sdk/.gitignore",
-  "ignore": ["build", "codegen", "docs", "**/.*", "**/bin", "**/template", "**/Dockerfile", "**/*.md", "**/*.yml", "samples/*/lib/generated", "sdk/test/*.desc"],
+  "ignore": [
+    "build",
+    "codegen",
+    "docs",
+    "**/.*",
+    "**/bin",
+    "**/template",
+    "**/Dockerfile",
+    "**/*.md",
+    "**/*.yml",
+    "samples/*/lib/generated",
+    "sdk/test/*.desc",
+    "tck/generated"
+  ],
   "license": "build/header.txt",
   "licenseFormats": {
     "js": {
@@ -17,6 +30,13 @@
         "prepend": " * "
       }
     },
+    "jsdoc": {
+      "prepend": "/*",
+      "append": " */",
+      "eachLine": {
+        "prepend": " * "
+      }
+    },
     "proto": {
       "eachLine": {
         "prepend": "// "

samples/js-replicated-entity-example/replicated-entity-example.js

@@ -15,10 +15,9 @@
  */
 
 
-const ReplicatedEntity = require("@lightbend/akkaserverless-javascript-sdk").replicatedentity.ReplicatedEntity;
-const ReplicatedData = require("@lightbend/akkaserverless-javascript-sdk").replicatedentity.ReplicatedData;
+const replicatedentity = require("@lightbend/akkaserverless-javascript-sdk").replicatedentity;
 
-const entity = new ReplicatedEntity(
+const entity = new replicatedentity.ReplicatedEntity(
   "replicated_entity_example.proto",
   "com.example.replicatedentity.ReplicatedEntityExample",
   "replicated-entity-example"
@@ -33,7 +32,7 @@ entity.commandHandlers = {
 
 function updateReplicatedCounter(update, ctx) {
   if (ctx.state === null) {
-    ctx.state = new ReplicatedData.ReplicatedCounter();
+    ctx.state = new replicatedentity.ReplicatedCounter();
   }
 
   if (update.value !== 0) {
@@ -46,7 +45,7 @@ function updateReplicatedCounter(update, ctx) {
 
 function getReplicatedCounter(get, ctx) {
   if (ctx.state === null) {
-    ctx.state = new ReplicatedData.ReplicatedCounter();
+    ctx.state = new replicatedentity.ReplicatedCounter();
   }
 
   return {
@@ -56,7 +55,7 @@ function getReplicatedCounter(get, ctx) {
 
 function mutateReplicatedSet(update, ctx) {
   if (ctx.state === null) {
-    ctx.state = new ReplicatedData.ReplicatedSet();
+    ctx.state = new replicatedentity.ReplicatedSet();
   }
 
   if (update.clear) {
@@ -76,7 +75,7 @@ function mutateReplicatedSet(update, ctx) {
 
 function getReplicatedSet(get, ctx) {
   if (ctx.state === null) {
-    ctx.state = new ReplicatedData.ReplicatedSet();
+    ctx.state = new replicatedentity.ReplicatedSet();
   }
 
   return {

sdk/bin/prepare.sh

@@ -6,8 +6,8 @@
 rm -rf ./proto
 mkdir -p ./proto
 
-# get the framework version from settings.js
-readonly framework_version=$(node --print 'require("./settings").frameworkVersion')
+# get the framework version from config.json
+readonly framework_version=$(node --print 'require("./config.json").frameworkVersion')
 
 function download_protocol {
   local module="$1"
@@ -33,12 +33,12 @@ if [ -n "$PROXY_SNAPSHOT_DIRECTORY" ]; then
 ./bin/compile-protobuf.sh
 
 # Generate TS type definitions based on the JSDocs
+cp index.d.preamble.ts index.d.ts
 jsdoc -t ./node_modules/@lightbend/tsd-jsdoc/dist -c ./jsdoc.json -d .
-mv types.d.ts index.d.ts
+cat types.d.ts >> index.d.ts && rm -f types.d.ts
 # There replacements are quite dirty, but even the patched tsd-jsdoc generator can't deal with these (mostly module related) issues currently
 perl -i -pe 's/declare module \"akkaserverless\"/declare module \"\@lightbend\/akkaserverless-javascript-sdk\"/g' index.d.ts
 perl -i -pe 's/module:akkaserverless\.//g' index.d.ts
+perl -i -pe 's/import\("akkaserverless"\).([a-zA-Z]*)/$1/g' index.d.ts
 perl -i -pe 's/import\("akkaserverless\.([a-zA-Z.]*)([a-zA-Z]*)\"\).(?!default\W)([a-zA-Z]*)/$1$2.$3/g' index.d.ts
 perl -i -pe 's/import\("akkaserverless\.([a-zA-Z.]*)([a-zA-Z]*)\"\)([.a-zA-Z]*)/$1$2/g' index.d.ts
-perl -i -pe 's/Promise(?!<)/Promise<any>/g' index.d.ts
-perl -i -pe 's/Component\[\]/import(\"\.\/proto\/protobuf-bundle")\.akkaserverless\.protocol\.Component\[\]/g' index.d.ts

sdk/config.json

@@ -0,0 +1,3 @@
+{
+  "frameworkVersion": "0.7.0-beta.14"
+}

sdk/settings.js sdk/index.d.preamble.tssdk/settings.js renamed to sdk/index.d.preamble.ts

@@ -14,16 +14,4 @@
  * limitations under the License.
  */
 
-const settings = {
-  frameworkVersion: '0.7.0-beta.14',
-  protocolVersion: function () {
-    const versions = this.frameworkVersion.split(/[.-]/);
-    return { major: versions[0], minor: versions[1] };
-  },
-  baseVersion: function () {
-    const version = this.protocolVersion();
-    return `${version.major}.${version.minor}`;
-  },
-};
-
-module.exports = settings;
+import * as protobuf from 'protobufjs';

sdk/jsdoc.json

@@ -6,6 +6,7 @@
         "include": [
             "src",
             "index.js",
+            "settings.jsdoc",
             "README.md"
         ],
         "exclude": [],

sdk/package.json

@@ -82,7 +82,8 @@
     "clean": "rm -rf ./dist",
     "copy-files": "cp -r ./proto ./dist && cp index.d.ts ./dist",
     "compile": "tsc && npm run copy-files",
-    "prepack": "npm run compile",
+    "verify-types": "tsc dist/index.d.ts --noEmit",
+    "prepack": "npm run compile && npm run verify-types",
     "print-version": "echo $npm_package_version",
     "watch-jsdoc": "npm-watch jsdoc",
     "jsdoc": "jsdoc -c jsdoc.json",