2.0.0

.gitlab-ci.yml

@@ -12,30 +12,38 @@ stages:
   - release
   - metadata
 
+before_script:
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
+
 # ====================
 # security stage
 # ====================
-mirror:
+# ====================
-  stage: security
+# security stage
-  script:
+# ====================
-    - npmci git mirror
+auditProductionDependencies:
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-audit:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
+     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm install --ignore-scripts
+     - npmci command pnpm audit --audit-level=high --prod
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high
   tags:
     - lossless
     - docker
-    - notpriv
+  allow_failure: true
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command pnpm audit --audit-level=high --dev
+  tags:
+    - lossless
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
@@ -44,28 +52,22 @@ audit:
 testStable:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
-    - npmci command npm run build
+    - npmci npm build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,11 +87,12 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -109,11 +112,9 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
+    - npmci node install stable
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
+      "command": "npm test",
-      "type": "node",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
+      "type": "node-terminal"
-        "${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"
     }
   ]
 }

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

npmextra.json

@@ -5,7 +5,7 @@
       "githost": "gitlab.com",
       "gitscope": "apiglobal",
       "gitrepo": "test-sdk",
-      "shortDescription": "an sdk for testing ag handlers",
+      "description": "an sdk for testing ag handlers",
       "npmPackagename": "@apiglobal/test-sdk",
       "license": "MIT",
       "projectDomain": "api.global"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apiglobal/test-sdk",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "private": false,
   "description": "an sdk for testing ag handlers",
   "main": "dist_ts/index.js",
@@ -8,19 +8,24 @@
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tstest test/)",
+    "test": "(tstest test/ --web)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web)",
-    "format": "(gitzone format)"
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^5.0.4",
-    "@types/node": "^10.11.7",
+    "@types/node": "^18.15.3"
-    "tslint": "^5.11.0",
+  },
-    "tslint-config-prettier": "^1.15.0"
+  "dependencies": {
+    "@apiglobal/sdk": "^2.0.1",
+    "@apiglobal/typedrequest": "^2.0.12",
+    "@apiglobal/typedrequest-interfaces": "^2.0.1",
+    "@pushrocks/qenv": "^5.0.2",
+    "@pushrocks/smartexpress": "^4.0.28",
+    "@pushrocks/smartobject": "^1.0.4"
   },
-  "dependencies": {},
   "files": [
     "ts/**/*",
     "ts_web/**/*",
@@ -32,5 +37,9 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
-  ]
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "type": "module"
 }

readme.md

@@ -21,7 +21,6 @@ Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](htt
 PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@apiglobal/test-sdk)](https://lossless.cloud)
 PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@apiglobal/test-sdk)](https://lossless.cloud)
 BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@apiglobal/test-sdk)](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)
 
 ## 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.ts

@@ -1,8 +1,10 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as testSdk from '../ts/index';
+import * as testSdk from '../ts/index.js';
+
+let testServer: testSdk.AgTestServer;
 
 tap.test('first test', async () => {
-  console.log(testSdk.standardExport);
+  console.log('TODO');
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@apiglobal/test-sdk',
+  version: '2.0.0',
+  description: 'an sdk for testing ag handlers'
+}

ts/index.ts

@@ -1,3 +1,88 @@
-import * as plugins from './test-sdk.plugins';
+import * as plugins from './test-sdk.plugins.js';
+import { AgTestServer } from './test-sdk.classes.testserver.js';
+import { AAgHandler } from '@apiglobal/sdk';
 
-export let standardExport = 'Hi there! :) This is an exported string';
+export { AgTestServer };
+
+let testServer: AgTestServer;
+let handler: AAgHandler<any>;
+export const createTestServer = async (handlerArg: {
+  new (envManagerArg: plugins.agSdk.AgEnvironment): plugins.agSdk.AAgHandler<any>;
+}) => {
+  class AgEnvironement extends plugins.agSdk.AgEnvironment {
+    public qenv = new plugins.qenv.Qenv('./', './.nogit');
+    public async getEnvVar(nameArg: string) {
+      return this.qenv.getEnvVarOnDemand(nameArg);
+    }
+  }
+  handler = new handlerArg(new AgEnvironement());
+  console.log(`now checking requirements for handler with slug ${handler.slug}...`);
+  await handler.checkRequirements();
+  testServer = new AgTestServer(handler);
+  await testServer.start();
+  return testServer;
+};
+
+export const testFire = <
+  A extends plugins.agSdk.AAgHandler<any>,
+  T extends plugins.typedrequestInterfaces.ITypedRequest
+>(
+  slugArg: A['slug'],
+  methodArg: T['method'],
+  requestArg: T['request']
+) => {
+  if (!testServer) {
+    throw new Error('you need to create and start a testServer first!');
+  }
+  if (testServer.server.serverStatus !== 'running') {
+    throw new Error('you need to start the testServer first!');
+  }
+  const typedRequest = new plugins.typedrequest.TypedRequest<T>(
+    `http://localhost:${testServer.server.options.port}/${slugArg}`,
+    methodArg
+  );
+  const responsePromise = typedRequest.fire(requestArg);
+  const expect = async (expectedResponseArg: T['response']) => {
+    const actualResponse = await responsePromise;
+    const comparisonResult = plugins.smartobject.compareObjects(
+      expectedResponseArg,
+      actualResponse
+    );
+    let throwErrorBool = false;
+    if (comparisonResult.divergingProperties.length > 0) {
+      console.log(`The following properties diverged:`);
+      console.log(comparisonResult.divergingProperties);
+      for (const divProperty of comparisonResult.divergingProperties) {
+        if (expectedResponseArg[divProperty] !== 'maydiverge') {
+          throwErrorBool = true;
+        } else {
+          console.log(`${divProperty} may diverge, not throwing for this one`);
+        }
+      }
+    }
+    if (comparisonResult.missingProperties.length > 0) {
+      console.log(`The following properties diverged:`);
+      console.log(comparisonResult.divergingProperties);
+      throwErrorBool = true;
+    }
+    if (throwErrorBool) {
+      console.log('Result: response did not comply');
+      console.log('-> expected:');
+      console.log(expectedResponseArg);
+      console.log('-> but actually received:');
+      console.log(actualResponse);
+      throw new Error('response did not comply');
+    }
+    return actualResponse;
+  };
+  return {
+    expect,
+  };
+};
+
+export const stopTestServer = async () => {
+  if (testServer) {
+    await testServer.stop();
+    await handler.stop();
+  }
+};

ts/test-sdk.classes.testserver.ts

@@ -0,0 +1,52 @@
+import * as plugins from './test-sdk.plugins.js';
+
+export class AgTestServer {
+  public handlers: Array<plugins.agSdk.AAgHandler<any>> = [];
+  public server: plugins.smartexpress.Server;
+
+  constructor(handlerArg?: plugins.agSdk.AAgHandler<any>) {
+    if (handlerArg) {
+      this.addAgHandler(handlerArg);
+    }
+  }
+
+  public async addAgHandler(handlerArg: plugins.agSdk.AAgHandler<any>) {
+    this.handlers.push(handlerArg);
+    console.log(`added handler with slug ${handlerArg.slug}`);
+    if (this.server && this.server.serverStatus === 'running') {
+      await this.stop();
+      await this.start();
+    }
+  }
+
+  public async start() {
+    this.server = new plugins.smartexpress.Server({
+      cors: true,
+      forceSsl: false,
+      defaultAnswer: async () => 'apiglobal testserver',
+      domain: 'localhost',
+      port: 3000,
+    });
+    for (const handlerArg of this.handlers) {
+      console.log(`found handler with slug ${handlerArg.slug}`);
+      await handlerArg.start();
+      console.log(`started handler with slug ${handlerArg.slug}`);
+      const slugroute = `/${handlerArg.slug}`;
+      this.server.addRoute(
+        slugroute,
+        new plugins.smartexpress.HandlerTypedRouter(handlerArg.typedrouter)
+      );
+      console.log(`added slugroute ${slugroute}`);
+    }
+    await this.server.start();
+  }
+
+  public async stop() {
+    if (this.server) {
+      const previousServer = this.server;
+      this.server = null;
+      await previousServer.startedPromise;
+      await previousServer.stop();
+    }
+  }
+}

ts/test-sdk.plugins.ts

@@ -1,2 +1,13 @@
-const removeme = {};
+// apiglobal scope
-export { removeme };
+import * as agSdk from '@apiglobal/sdk';
+import * as typedrequest from '@apiglobal/typedrequest';
+import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
+
+export { agSdk, typedrequest, typedrequestInterfaces };
+
+// pushrocks scope
+import * as qenv from '@pushrocks/qenv';
+import * as smartexpress from '@pushrocks/smartexpress';
+import * as smartobject from '@pushrocks/smartobject';
+
+export { qenv, smartexpress, smartobject };

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": 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"
-}