1.0.15

.gitlab-ci.yml

@@ -19,23 +19,35 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+
+auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +62,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +73,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +93,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/settings.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apiglobal/sdk",
-  "version": "1.0.10",
+  "version": "1.0.15",
   "private": false,
   "description": "an sdk package for api.global",
   "main": "dist_ts/index.js",
@@ -21,6 +21,7 @@
   },
   "dependencies": {
     "@apiglobal/typedrequest": "^1.0.38",
+    "@pushrocks/smartfile": "^8.0.0",
     "@tsclass/tsclass": "^3.0.18"
   },
   "files": [
@@ -34,5 +35,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

test/test.ts

@@ -3,11 +3,11 @@ import * as sdk from '../ts/index';
 import { ISimpleRequest } from '@tsclass/tsclass/dist_ts/network';
 import { TypedRouter } from '@apiglobal/typedrequest';
 
-
 tap.test('should create a valid Handler', async () => {
   class MyHandler extends sdk.AAgHandler<any> {
     public slug: 'testapi';
     public typedrouter = new TypedRouter();
+
     public async checkReqirements() {
       return {
         allOk: true,
@@ -22,12 +22,19 @@ tap.test('should create a valid Handler', async () => {
     public async checkRequirements(): Promise<sdk.IRequirementResult> {
       return {
         allOk: true,
-        reason: ''
-      }
+        reason: '',
+      };
     }
   }
 
-  const myHandlerInstance = new MyHandler();
+  // tslint:disable-next-line: max-classes-per-file
+  class AgEnvironement extends sdk.AgEnvironment {
+    public async getEnvVar(nameArg: string) {
+      return '';
+    }
+  }
+
+  const myHandlerInstance = new MyHandler(new AgEnvironement());
 
   expect(myHandlerInstance).to.be.instanceOf(sdk.AAgHandler);
 });

ts/index.ts

@@ -1,3 +1,5 @@
 export * from './sdk.classes.agenvironment';
 export * from './sdk.classes.aghandler';
 export * from './sdk.classes.authinfo';
+
+export * from './interfaces';

ts/interfaces/index.ts

@@ -1 +1 @@
-export {};
+export * from './projectsettings';

ts/interfaces/projectsettings.ts

@@ -0,0 +1,10 @@
+export interface IProjectSettings {
+  slug: string;
+  packageName: string;
+  environmentVariables: { [key: string]: string };
+  registryId: string;
+  registryDescriptor: {
+    registryUrl: string;
+    registryToken: string;
+  };
+}

ts/sdk.classes.agenvironment.ts

@@ -3,6 +3,6 @@ import * as plugins from './sdk.plugins';
 /**
  * AgEnvironment handles the provision of environment variables to handlers
  */
-export class AgEnvironment {
-  
+export abstract class AgEnvironment {
+  public abstract async getEnvVar(envVarName: string): Promise<string>;
 }

ts/sdk.classes.aghandler.ts

@@ -1,5 +1,6 @@
 import * as plugins from './sdk.plugins';
 import { AuthInfo } from './sdk.classes.authinfo';
+import { AgEnvironment } from './sdk.classes.agenvironment';
 
 export interface IRequirementResult {
   allOk: boolean;
@@ -7,6 +8,8 @@ export interface IRequirementResult {
 }
 
 export abstract class AAgHandler<TClaim> {
+  public agEnvironment: AgEnvironment;
+
   /**
    * a slug that separates the handler from other handlers
    */
@@ -14,6 +17,30 @@ export abstract class AAgHandler<TClaim> {
   public abstract typedrouter: plugins.typedrequest.TypedRouter;
   public abstract checkRequirements(): Promise<IRequirementResult>;
 
+  public async checkQenvFile(pathToQenvFileArg: string) {
+    if(!(await plugins.smartfile.fs.fileExists(pathToQenvFileArg))) {
+      throw new Error(`AgHandler with slug '${this.slug}': qenv file does not exists at ${pathToQenvFileArg}`);
+    }
+    const qenvFile = plugins.smartfile.fs.toObjectSync(pathToQenvFileArg);
+    const missingEnvironmentVariables: string[] = [];
+    for (const envVar of qenvFile.required as string[]) {
+      const result = this.agEnvironment.getEnvVar(envVar);
+      if (!result) {
+        missingEnvironmentVariables.push(envVar);
+      }
+    }
+    if (missingEnvironmentVariables.length > 0) {
+      console.log(`AgHandler with slug '${this.slug}': There are ${missingEnvironmentVariables.length} missing environment variables`);
+      const errorMessage = `AgHandler with slug '${this.slug}': The missing env Varibles are ${missingEnvironmentVariables}`;
+      console.log(errorMessage);
+      throw new Error(errorMessage);
+    }
+  }
+
+  constructor(agEnvironmentArg: AgEnvironment) {
+    this.agEnvironment = agEnvironmentArg;
+  }
+
   /**
    * start the ag-handler
    */

ts/sdk.plugins.ts

@@ -4,8 +4,13 @@ import * as path from 'path';
 // @apiglobal scope
 import * as typedrequest from '@apiglobal/typedrequest';
 
+export { typedrequest };
+
+// pushrocks scope
+import * as smartfile from '@pushrocks/smartfile';
+
 export {
-  typedrequest
+  smartfile
 };
 
 // @tsclass scope