Merge pull request #88 from dolittle/21.0.0-gimli

Gimli: New SDK setup configuration, Dependency Injection, Version Compatibility Check, Express integration

Author: woksin

.github/workflows/workflow.yml

@@ -1,7 +1,7 @@
 name: TypeScript Library CI/CD
 
 env:
-  PRERELEASE_BRANCHES: legolas # Comma separated list of prerelease branch names. 'alpha,rc, ...'
+  PRERELEASE_BRANCHES: legolas, gimli # Comma separated list of prerelease branch names. 'alpha,rc, ...'
 
 on:
   push:
@@ -22,15 +22,12 @@ jobs:
       with:
         node-version: 12.x
         registry-url: 'https://registry.npmjs.org'
-    - run: yarn
-    - run: yarn ci
 
     - name: Establish context
       id: context
       uses: dolittle/establish-context-action@v2
       with:
         prerelease-branches: ${{ env.PRERELEASE_BRANCHES }}
-
     - name: Increment version
       id: increment-version
       if: ${{ steps.context.outputs.should-publish == 'true' }}
@@ -39,6 +36,15 @@ jobs:
         version: ${{ steps.context.outputs.current-version }}
         release-type: ${{ steps.context.outputs.release-type }}
 
+    - name: Update VersionInfo
+      uses: dolittle/update-version-info-action@v1
+      with:
+        version: ${{ steps.increment-version.outputs.next-version || '0.0.0-prerelease' }}
+        files-to-update: Source/sdk/VersionInfo.ts
+
+    - run: yarn
+    - run: yarn ci
+
     - name: Prepend to Changelog
       if: ${{ steps.context.outputs.should-publish == 'true' && steps.context.outputs.release-type != 'prerelease' }}
       uses: dolittle/add-to-changelog-action@v2

.gitignore

@@ -64,3 +64,4 @@ package-lock.json
 Samples/**/data
 Source/**/Distribution
 Samples/**/Distribution
+Source/**/README.md

.vscode/launch.json

@@ -43,6 +43,35 @@
                 "<node_internals>/**",
                 "node_modules/**"
             ]
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Debug Tutorial - Getting Started",
+            "program": "${workspaceFolder}/Samples/Tutorials/GettingStarted/Distribution/index.js",
+            "cwd": "${workspaceFolder}/Samples/Tutorials/GettingStarted",
+            "preLaunchTask": "tsc: build - Samples/Tutorials/GettingStarted/tsconfig.json",
+            "outputCapture": "std",
+            "internalConsoleOptions": "openOnSessionStart",
+            "outFiles": [
+                "${workspaceFolder}/Samples/Tutorials/GettingStarted/Distribution/**/*.js",
+                "${workspaceFolder}/Source/*/Distribution/**/*.js",
+            ]
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Debug 'events' Tests",
+            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+            "cwd": "${workspaceFolder}/Source/events",
+            "args": [
+                "-r",
+                "ts-node/register",
+                "--timeout",
+                "999999",
+                "--colors",
+                "${workspaceFolder}/Source/events/**/for_*/**/*.ts",
+            ],
         }
     ]
 }

Assets/PACKAGE-README.md

@@ -0,0 +1,20 @@
+![Dolittle](https://raw.githubusercontent.com/dolittle/Runtime/master/Documentation/dolittle_negativ_horisontal_RGB.svg "Dolittle")
+
+Dolittle is a decentralized, distributed, event-driven microservice platform built to harness the power of events.
+
+This is our JavaScript and TypeScript SDK, install it with:
+```shell
+$ npm install @dolittle/sdk 
+```
+
+# Get Started
+- Try our [getting started tutorial](https://dolittle.io/docs/tutorials/getting_started/)
+- Check out our [documentation](https://dolittle.io)
+
+# Want to try another language?
+- Check out the [.NET SDK](https://github.com/dolittle/DotNet.SDK)
+
+# Issues and Contributing
+Issues and contributions are always welcome!
+
+To learn how to contribute, please read our [contributing](https://dolittle.io/docs/contributing/) guide.

Assets/copy-readme.js

@@ -0,0 +1,40 @@
+// Copyright (c) Dolittle. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+const path = require('path');
+const fs = require('fs');
+
+(async () => {
+    const readmePath = path.resolve(__dirname, 'PACKAGE-README.md');
+    const readmeFile = await new Promise((resolve, reject) =>
+        fs.readFile(readmePath, (error, data) => {
+            if (error) {
+                console.error('Failed to open README from', readmePath);
+                reject(error);
+            } else {
+                resolve(data);
+            }
+        }));
+
+    const destinations = process.argv.slice(2);
+
+    if (destinations.length < 1) {
+        throw new Error('No desitionations specified to copy the README.md file to.');
+    }
+
+    for (const destination of destinations) {
+        const destinationPath = path.resolve(destination, 'README.md');
+        await new Promise((resolve, reject) =>
+            fs.writeFile(destinationPath, readmeFile, (error) => {
+                if (error) {
+                    console.error('Failed to copy to', destinationPath, error);
+                    reject(error);
+                } else {
+                    resolve();
+                }
+            }));
+    }
+})().catch(error => {
+    console.error(error);
+    process.exit(1);
+});

Samples/Advanced/MyEvent.ts

@@ -5,6 +5,5 @@ import { eventType } from '@dolittle/sdk.events';
 
 @eventType('c7b37f26-ffe4-4ffc-9a53-8d67acbecd4d')
 export class MyEvent {
-    anInteger!: number;
-    aString!: string;
+    constructor(readonly aNumber: number, readonly aString: string) {}
 }