@vertikalx/vtx-backend-client 3.0.0-dev.8 → 3.0.1-dev-max.0

package/package.json

@@ -1,16 +1,29 @@
 {
     "name": "@vertikalx/vtx-backend-client",
-    "version": "3.0.0-dev.8",
+    "version": "3.0.1-dev-max.0",
     "description": "GraphQL API generated client for VTX",
     "types": "src/index.d.ts",
     "main": "src/index.js",
     "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1"
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "codegen": "graphql-codegen --config codegen.yml"
     },
     "keywords": [
         "GraphQL",
         "VTX"
     ],
     "author": "Daniel Castañeda <daniel@vtxathlete.com>",
-    "license": "SEE LICENSE IN LICENSE.md"
+    "license": "SEE LICENSE IN LICENSE.md",
+    "dependencies": {
+        "graphql": "^16.12.0",
+        "graphql-request": "^7.4.0",
+        "graphql-tag": "^2.12.6"
+    },
+    "devDependencies": {
+        "@graphql-codegen/cli": "^6.1.1",
+        "@graphql-codegen/typescript": "^5.0.7",
+        "@graphql-codegen/typescript-operations": "^5.0.7",
+        "@graphql-codegen/typescript-graphql-request": "^6.4.0",
+        "@graphql-codegen/add": "^6.0.0"
+    }
 }

package/src/api/api-call-headers.ts

@@ -0,0 +1,35 @@
+
+
+
+export type APICallHeaders = { [key: string]: string };
+
+
+// Default System ID for VTX backend
+export const DEFAULT_SYSTEM_ID = 'vtx';
+
+// Default HEADER key for System ID
+export const DEFAULT_SYSTEM_ID_HEADER = 'io-stackbus-cms-system-id';
+
+// Default HEADER key for system-key name (name of the key)
+export const DEFAULT_SYSTEM_KEY_NAME_HEADER = 'io-stackbus-cms-system-key-name';
+
+// Default HEADER key for system-key value (value of the key)
+export const DEFAULT_SYSTEM_KEY_VALUE_HEADER = 'io-stackbus-cms-system-key-value';
+
+// Default HEADER key for providing APP KEY (access key to API from non-trusted devices such as our mobile app)
+export const DEFAULT_APP_KEY_HEADER = 'io-stackbus-app-key';
+
+// Default HEADER key for sensing user backend token
+export const DEFAULT_SYSTEM_USER_TOKEN_HEADER = 'io-stackbus-cms-system-user-token';
+
+// Default HEADER key for api-key-id header key
+export const DEFAULT_API_KEY_ID_HEADER = 'io-stackbus-cms-api-key-id';
+
+// Default HEADER key for api-key-value header key
+export const DEFAULT_API_KEY_VALUE_HEADER = 'io-stackbus-cms-api-key-value';
+
+
+export const DEFAULT_HEADERS:APICallHeaders = {
+    ["Content-Type"]:"application/json",
+    [DEFAULT_SYSTEM_ID_HEADER]:DEFAULT_SYSTEM_ID
+};

package/src/api/backend-response.ts

@@ -0,0 +1,14 @@
+
+
+
+export interface BackendError{
+  httpStatus:number;
+  code:number;
+  message:string;  
+} 
+
+export interface ITypedBackendResponse<T>{
+    data?:T;
+    error?:BackendError
+    rawErrors?:any[];
+}

package/src/api/domains.ts

@@ -0,0 +1,6 @@
+
+export const DOMAIN_ATHLETE:string = "ATHLETE";
+export const DOMAIN_SPONSOR:string = "SPONSOR";
+export const DOMAIN_TEAM:string = "TEAM";
+export const DOMAIN_MEMBER:string = "MEMBER";
+

package/src/api/response-builder.ts

@@ -0,0 +1,165 @@
+import { AnyARecord } from "dns";
+import { BackendError, ITypedBackendResponse } from "./backend-response";
+import { VTX_ERRORS } from "@vertikalx/vtx-core-common";
+
+
+export type checkerFn = (response:any)=>boolean;
+
+const Logger = {
+  log:(msg:string)=>{
+    //console.log(msg)
+  }
+};
+
+export function buildResponse<T>(response:any, rootProperty:string, checker: checkerFn):ITypedBackendResponse<T>{
+    const retValue:ITypedBackendResponse<T> = {}
+
+    //console.log("=========== BEGIN buildResponse =============");
+    //console.log(JSON.stringify(response, null, 2));
+
+    //console.log("=========== END buildResponse =============");
+      
+      if (checker(response)){
+
+        //Logger.log('checker 1');
+        try {
+          retValue.data = response[rootProperty] as T;
+        } catch (casterr) {
+          Logger.log('Error trying to cast to return type');
+          retValue.error = {
+            httpStatus:500,
+            code:VTX_ERRORS.VTX_SERVER_ERROR.code,
+            message:"Error: Obtained incorrect data from Backend"
+          };
+          retValue.rawErrors = [
+            {
+              data:response,
+              error:casterr
+            }
+          ];          
+        }
+  
+      } else if (response?.errors) {        
+
+        //Logger.log('checker 2');
+        if (Array.isArray(response.errors)) {
+          retValue.rawErrors = response.errors;
+        } else {
+          retValue.rawErrors = [response.errors];
+        }
+  
+      } else if (response?.error) {
+        //Logger.log('checker 3');
+  
+        if (Array.isArray(response.error)) {
+          retValue.rawErrors = response.error;
+        } else {
+          retValue.rawErrors = [response.error];
+        }
+  
+      } else if (checker(response?.data)) {
+        //Logger.log('checker 4');
+  
+        try {
+          retValue.data = response.data[rootProperty] as T;
+        } catch (casterr) {
+          Logger.log('Error trying to cast to return type');
+          
+          retValue.error = {
+            httpStatus:500,
+            code:VTX_ERRORS.VTX_SERVER_ERROR.code,
+            message:"Error: Obtained incorrect data from Backend"
+          };
+          retValue.rawErrors = [
+            {
+              data:response.data,
+              error:casterr
+            }
+          ];    
+
+        }
+      } else {
+        //Logger.log('checker 5');
+        retValue.error = {
+          httpStatus:500,
+          code:VTX_ERRORS.VTX_SERVER_ERROR.code,
+          message:"Error: Obtained incorrect data from Backend"
+        };
+        retValue.rawErrors = ['Error: Obtained incorrect data from Backend'];
+      }
+  
+
+    Logger.log('buildResponse retValue:');
+    Logger.log(JSON.stringify(retValue,null,2));
+
+    return retValue;
+}
+export function buildErrorResponse<T>(error:any):ITypedBackendResponse<T>{
+
+  //Logger.log("=========== BEGIN buildErrorResponse received =============");
+  //Logger.log(JSON.stringify(error, null, 2));
+
+  //Logger.log("=========== END buildErrorResponse received =============");
+
+  const retValue:ITypedBackendResponse<T> = {}
+  if (error.errors){
+
+    if (Array.isArray(error.errors)){
+      retValue.rawErrors = error.errors;
+
+    }else{
+      retValue.rawErrors = [error.errors];
+      
+    }
+
+  }else{
+    if (Array.isArray(error)){
+      retValue.rawErrors = error;
+    }else{
+      retValue.rawErrors = [error];
+    }    
+  }
+
+  retValue.error = extractError(retValue.rawErrors );
+
+  //Logger.log("=========== BEGIN buildErrorResponse returned =============");
+  //Logger.log(JSON.stringify(retValue, null, 2));
+
+  //Logger.log("=========== END buildErrorResponse returned =============");
+
+    
+  return retValue;
+}
+function extractError(rawErrors: any[]|undefined): BackendError {
+  
+  let retValue:BackendError = {
+    httpStatus:500,
+    code:VTX_ERRORS.VTX_SERVER_ERROR.code,
+    message:VTX_ERRORS.VTX_SERVER_ERROR.description 
+  };
+
+  if (! rawErrors || rawErrors.length <= 0){    
+    return retValue;
+  }
+
+  let theError:any = rawErrors.find( e => {
+
+      if (e.extensions && e.extensions.type === "VtxError"){
+        return true;
+      }
+      return false;
+  });
+
+  if (theError){
+    retValue = {
+      httpStatus:theError?.extensions?.httpStatus ?? 500,
+      code: theError?.extensions?.vtxError?.code ?? VTX_ERRORS.VTX_SERVER_ERROR.code,
+      message: theError?.extensions?.vtxError?.description  ?? VTX_ERRORS.VTX_SERVER_ERROR.description 
+    }
+  }
+
+  return retValue;
+  
+
+}
+

package/src/api/types.ts

@@ -0,0 +1,9 @@
+import { QualificationDto,
+    AgeQualificationDto, GenderQualificationDto , 
+    ScoreQualificationDto, LocationQualificationDto, 
+    NationalityQualificationDto, DistanceQualificationDto, 
+    SportsQualificationDto, SportsLevelQualificationDto
+ } from "../client";
+
+
+export type QualificationDtoUnion = QualificationDto | AgeQualificationDto | GenderQualificationDto | ScoreQualificationDto | LocationQualificationDto | NationalityQualificationDto | DistanceQualificationDto | SportsQualificationDto | SportsLevelQualificationDto;

package/src/api/vtx-apikey-api.ts

@@ -0,0 +1,23 @@
+
+import pjson from "../../package.json";
+import { APICallHeaders, DEFAULT_API_KEY_ID_HEADER, DEFAULT_API_KEY_VALUE_HEADER, DEFAULT_APP_KEY_HEADER, DEFAULT_HEADERS } from "./api-call-headers";
+import { VTXBaseAPI } from "./vtx-base-api";
+
+
+
+
+
+export class VTXAPIKeyAPI extends VTXBaseAPI{
+
+    constructor(backendUrl:string, apiKeyId:string, apiKeyValue:string ){
+        super(backendUrl, VTXAPIKeyAPI.getDefaultHeaders(apiKeyId, apiKeyValue));
+    }
+
+    public static getDefaultHeaders(apiKeyId:string, apiKeyValue:string):APICallHeaders{
+        return {
+            [DEFAULT_API_KEY_ID_HEADER]: apiKeyId,
+            [DEFAULT_API_KEY_VALUE_HEADER]: apiKeyValue,
+            ...DEFAULT_HEADERS
+        }
+    }
+}