Merge pull request #6 from webmate-io/testmgmt

Major JavaScript/TypeScript SDK upgrade

Author: JeannedArk

.eslintrc

@@ -0,0 +1,18 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2017
+  },
+  "rules": {
+    "semi": ["warn", "always"]
+  }
+}

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2021 Testfabrik Consulting + Solutions AG
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,9 +1,10 @@
-# webmate Javascript SDK
+# webmate JavaScript and TypeScript SDK
 
 The webmate SaaS test automation platform provides testing services for testers and developers of web applications.
-This SDK contains wrapper code used to call the webmate API from Java applications.
+This SDK contains wrapper code used to call the webmate API from JavaScript and TypeScript applications.
 
-There is no official version of the webmate Javascript SDK, yet. This is a preview release, which provides wrappers for the following tasks:
+The webmate JavaScript SDK is still under development and maintained regularly.
+This release provides wrappers for the following tasks:
 
 * Perform state extraction in an existing browser session, e.g. one that has been created via Selenium.
 * Execute a new JobRun in the webmate Job service, e.g. to start a Job comparing the layout of web pages in multiple browsers.
@@ -12,12 +13,13 @@ There is no official version of the webmate Javascript SDK, yet. This is a previ
 
 This SDK pre-release gives access to a small subset of the features available in the API. The SDK will be completed over time.
 
-For a list of recent change refer to the [changelog](CHANGES.md)
+For a complete list of recent changes, please refer to the [changelog](CHANGES.md).
+
 
 ## Using the SDK in your Project
 
 This release is also distributed via npm under the package name webmate-sdk-js.
-To use the SDK we recommed to install it via npm:
+To use the SDK we recommend to install it via npm:
 
 ```bash
 $ npm install webmate-sdk-js --save
@@ -29,13 +31,13 @@ To use the SDK afterwards, import it into your test files as follows:
 var webmate = require("webmate-sdk-js");
 ```
 
-If you're using typescript:
+If you're using TypeScript:
 
 ```ts
 import * as Webmate from "webmate-sdk-js";
 ```
 
-In typescript, you can also import the necessary type-definitions or classes directly:
+In TypeScript, you can also import the necessary type-definitions or classes directly:
 
 ```ts
 import {
@@ -48,29 +50,23 @@ import {
 ```
 
 
-## Usage
+## Sample Code
 
-With this SDK, you can automate Selenium testing, as well as CrossBrowser and Regression testing via webmate.
-Use 
-```js
-var webmateSession = Webmate.startSession(MY_WEBMATE_USER, MY_WEBMATE_APIKEY, WEBMATE_API_URL);
-```
-to connect to the webmate API.
-
-During tests, you can create states using
-Use 
-```js
-webmateSession.browserSession.createState(sessionId, state_name, [timeout], [STATE_EXTRACTION_CONFIG])
-```
+See the following sample projects:
+* [Java Samples](https://github.com/webmate-io/webmate-sdk-samples)
+* [JavaScript And TypeScript Samples](https://github.com/webmate-io/webmate-sdk-js-samples)
 
-After executing the tests, you can create a CrossBrowser or Regression job based on your selenium sessions like this:
-```js
-webmateSession.jobEngine.startKnownJob(test_name, new webmate.CrossbrowserJobInput(firstSession, sessionIds), MY_WEBMATE_PROJECTID)
-```
+In order to use these samples, you need to have an account at webmate SaaS or a commercial on-premise installation.
+Please contact Testfabrik ([email protected]) if you are interested in evaluating webmate.
 
-Information about how to build a ```StateExtractionConfig``` can be found at https://github.com/webmate-io/webmate-sdk-java/wiki/BrowserSessionStateExtractionConfig
 
+## Usage
 
 In order to use this SDK, you need to have an account at webmate SaaS or a commercial on-premise installation.
 Please contact Testfabrik ([email protected]) if you are interested in evaluating webmate.
 
+
+## webmate API
+
+Although, the SDK provides a number of features and convenience wrappers it doesn't exhaust the full potential of the webmate API.
+See the REST API [Swagger documentation](https://app.webmate.io/api/swagger) for a comprehensive summary of the webmate functionalities.

index.ts

@@ -1,20 +1,98 @@
 import {WebmateAPISession} from "./src/webmate-api-session";
 import {WebmateEnvironment} from "./src/webmate-environment";
 import {WebmateAuthInfo} from "./src/webmate-auth-info";
+import {ProjectId} from "./src/types";
 
+// Add entries in lexical order!
+
+// root
+export * from './src/browser';
+export * from './src/browser-type';
+export * from './src/platform';
+export * from './src/platform-type';
+export * from './src/tag';
 export * from './src/types';
+export * from './src/webmate-api-session';
+export * from './src/webmate-auth-info';
+export * from './src/webmate-capability-type';
+export * from './src/webmate-environment';
+// artifacts
+export * from './src/artifacts/artifact-client';
+export * from './src/artifacts/artifact-types';
+// blobs
+export * from './src/blobs/blob-client';
+// browsersession
 export * from './src/browsersession/browser-session-client';
+export * from './src/browsersession/browser-session-ref';
+export * from './src/browsersession/browser-session-screenshot-extraction-config';
 export * from './src/browsersession/browser-session-state-extraction-config';
-export * from './src/jobs/job-engine';
-export * from './src/jobs/well-known-job-input';
+export * from './src/browsersession/browser-session-warm-up-config';
+export * from './src/browsersession/browser-specification';
+export * from './src/browsersession/driver-specification';
+export * from './src/browsersession/expedition-spec';
+export * from './src/browsersession/expedition-spec-factory';
+export * from './src/browsersession/finish-story-action-add-artifact-data';
+export * from './src/browsersession/live-expedition-spec';
+export * from './src/browsersession/start-story-action-add-artifact-data';
+export * from './src/browsersession/url-list-driver-specification';
+export * from './src/browsersession/vehicle-specification';
+// commonutils
+export * from './src/commonutils/Dimension';
+// device
+export * from './src/device/device-client';
+export * from './src/device/device-dto';
+export * from './src/device/device-properties';
+export * from './src/device/device-request';
+// jobs
 export * from './src/jobs/jobconfigs/crossbrowser-job-input';
 export * from './src/jobs/jobconfigs/regression-job-input';
-export * from './src/webmate-api-session';
-export * from './src/webmate-environment';
-export * from './src/webmate-auth-info';
+export * from './src/jobs/job-engine';
+export * from './src/jobs/job-run-summary';
+export * from './src/jobs/well-known-job-input';
+export * from './src/jobs/wm-data-type';
+export * from './src/jobs/wm-value';
+export * from './src/jobs/wm-value-factory';
+// mailTest
+export * from './src/mailTest/mail-test-client';
+export * from './src/mailTest/mail-test-types';
+// packagemgmt
+export * from './src/packagemgmt/package';
+export * from './src/packagemgmt/packagemgmt-client';
+// selenium
+export * from './src/selenium/selenium-capability';
+export * from './src/selenium/selenium-service-client';
+export * from './src/selenium/selenium-session';
+export * from './src/selenium/selenium-session-proxy';
+export * from './src/selenium/webmate-selenium-session';
+export * from './src/selenium/webmate-selenium-session';
+// testmgmt
+export * from './src/testmgmt/spec/expedition-comparison-spec';
+export * from './src/testmgmt/spec/story-check-spec';
+export * from './src/testmgmt/spec/test-execution-spec';
+export * from './src/testmgmt/testtypes/standard-test-types';
+export * from './src/testmgmt/testtypes/test-type';
+export * from './src/testmgmt/create-test-execution-response';
+export * from './src/testmgmt/test';
+export * from './src/testmgmt/test-execution-evaluation-status';
+export * from './src/testmgmt/test-execution-execution-status';
+export * from './src/testmgmt/test-execution-spec-builder';
+export * from './src/testmgmt/test-execution-summary';
+export * from './src/testmgmt/test-info';
+export * from './src/testmgmt/test-mgmt-client';
+export * from './src/testmgmt/test-parameter';
+export * from './src/testmgmt/test-result';
+export * from './src/testmgmt/test-run';
+export * from './src/testmgmt/test-run-evaluation-status';
+export * from './src/testmgmt/test-run-execution-status';
+export * from './src/testmgmt/test-run-finish-data';
+export * from './src/testmgmt/test-run-info';
+export * from './src/testmgmt/test-run-summary';
+export * from './src/testmgmt/test-session';
+export * from './src/testmgmt/test-template';
+export * from './src/testmgmt/test-template-info';
 
-export function startSession(emailAddress: string, apiKey: string, baseUri?: string): WebmateAPISession {
+export function startSession(emailAddress: string, apiKey: string, baseUri?: string, projectId?: ProjectId): WebmateAPISession {
     let env = new WebmateEnvironment(baseUri);
     let auth = new WebmateAuthInfo(emailAddress, apiKey);
-    return new WebmateAPISession(auth, env);
+    return new WebmateAPISession(auth, env, projectId);
 }