vwo-fme-node-sdk 1.0.0

package/lib/utils/UuidUtil.ts

@@ -0,0 +1,33 @@
+import { v4 as uuidv4 } from 'uuid';
+import { v5 as uuidv5 } from 'uuid';
+
+// import { Constants } from '../constants';
+
+const VWO_NAMESPACE = uuidv5('https://vwo.com', uuidv5.URL);
+
+export function getRandomUUID(apiKey: string): string {
+  const namespace = uuidv5(apiKey, uuidv5.DNS);
+  const randomUUID = uuidv5(uuidv4(), namespace);
+
+  return randomUUID;
+}
+
+export function getUUID(userId: string, accountId: string): string {
+  // type case userId to string
+  userId = String(userId);
+  accountId = String(accountId);
+  const userIdNamespace = generateUUID(accountId, VWO_NAMESPACE);
+  const uuidForUserIdAccountId = generateUUID(userId, userIdNamespace);
+
+  const desiredUuid = uuidForUserIdAccountId.replace(/-/gi, '').toUpperCase();
+
+  return desiredUuid;
+}
+
+function generateUUID(name: string, namespace: string) {
+  if (!name || !namespace) {
+    return;
+  }
+
+  return uuidv5(name, namespace);
+}

package/lib/utils/WebServiceUtil.ts

@@ -0,0 +1,60 @@
+import UrlService from '../services/UrlService';
+import { Constants } from '../constants';
+import { NetworkManager, RequestModel, ResponseModel } from '../modules/networking';
+import { dynamic } from '../types/common';
+import { Deferred } from '../utils/PromiseUtil';
+import { LogManager } from '../modules/logger';
+import { UrlEnum } from '../enums/UrlEnum';
+
+export async function getFromWebService(queryParams: any, endpoint: any): Promise<any> {
+  // implementation
+  const deferredObject = new Deferred();
+  const networkInstance = NetworkManager.Instance;
+  if (UrlService.getBaseUrl() === UrlEnum.BASE_URL) {
+    LogManager.Instance.info('Invalid URL. Please provide a valid URL for vwo helper webService');
+    deferredObject.resolve(false);
+    return deferredObject.promise;
+  }
+  try {
+    const request: RequestModel = new RequestModel(
+      UrlService.getBaseUrl(),
+      'GET',
+      endpoint,
+      queryParams,
+      null,
+      null,
+      null,
+      UrlService.getPort(),
+    );
+
+    networkInstance
+      .get(request)
+      .then((response: ResponseModel) => {
+        deferredObject.resolve(response.getData());
+      })
+      .catch((err: ResponseModel) => {
+        deferredObject.reject(err);
+      });
+
+    return deferredObject.promise;
+  } catch (err) {
+    console.error('Error occurred while sending GET request:', err);
+    deferredObject.resolve(false);
+    return deferredObject.promise;
+  }
+}
+
+export function getQueryParamForLocationPreSegment(ipAddress: string): Record<string, dynamic> {
+  const path: Record<string, dynamic> = {
+    ipAddress: `${ipAddress}`,
+  };
+  return path;
+}
+
+export function getQueryParamForUaParser(userAgent: string): Record<string, dynamic> {
+  userAgent = encodeURIComponent(userAgent);
+  const path: Record<string, dynamic> = {
+    userAgent: `${userAgent}`,
+  };
+  return path;
+}

package/lib/utils/logMessageBuilder.ts

@@ -0,0 +1,60 @@
+import { LogLevelEnum } from '../enums/LogLevelEnum';
+import { dynamic } from '../types/common';
+
+interface ILogMessageBuilder {
+  loggerConfig: Record<string, dynamic>;
+  transportConfig: Record<string, dynamic>;
+  prefix: string;
+  dateTimeFormat: dynamic;
+
+  formatMessage(level: string, message: string): string;
+  getFormattedLevel(level: string): string;
+  getFormattedDateTime(): string;
+}
+
+export class LogMessageBuilder implements ILogMessageBuilder {
+  loggerConfig: Record<string, dynamic>;
+  transportConfig: Record<string, dynamic>;
+  prefix: any;
+  dateTimeFormat: any;
+
+  constructor(loggerConfig: Record<string, dynamic>, transportConfig: Record<string, dynamic>) {
+    this.loggerConfig = loggerConfig;
+    this.transportConfig = transportConfig;
+
+    this.prefix = this.transportConfig.prefix || this.loggerConfig.prefix || '';
+    this.dateTimeFormat = this.transportConfig.dateTimeFormat || this.loggerConfig.dateTimeFormat;
+  }
+
+  formatMessage(level: string, message: string): string {
+    return `${this.getFormattedLevel(level)} ${this.prefix} ${this.getFormattedDateTime()} ${message}`;
+  }
+
+  getFormattedLevel(level: string): string {
+    const upperCaseLevel = level.toUpperCase();
+    const AnsiColorEnum = {
+      BOLD: '\x1b[1m',
+      CYAN: '\x1b[36m',
+      GREEN: '\x1b[32m',
+      LIGHTBLUE: '\x1b[94m',
+      RED: '\x1b[31m',
+      RESET: '\x1b[0m',
+      WHITE: '\x1b[30m',
+      YELLOW: '\x1b[33m',
+    };
+
+    const LogLevelColorInfoEnum = {
+      [LogLevelEnum.TRACE]: `${AnsiColorEnum.BOLD}${AnsiColorEnum.WHITE}${upperCaseLevel}${AnsiColorEnum.RESET}`,
+      [LogLevelEnum.DEBUG]: `${AnsiColorEnum.BOLD}${AnsiColorEnum.LIGHTBLUE}${upperCaseLevel} ${AnsiColorEnum.RESET}`,
+      [LogLevelEnum.INFO]: `${AnsiColorEnum.BOLD}${AnsiColorEnum.CYAN}${upperCaseLevel}  ${AnsiColorEnum.RESET}`,
+      [LogLevelEnum.WARN]: `${AnsiColorEnum.BOLD}${AnsiColorEnum.YELLOW}${upperCaseLevel}  ${AnsiColorEnum.RESET}`,
+      [LogLevelEnum.ERROR]: `${AnsiColorEnum.BOLD}${AnsiColorEnum.RED}${upperCaseLevel} ${AnsiColorEnum.RESET}`,
+    };
+
+    return LogLevelColorInfoEnum[level];
+  }
+
+  getFormattedDateTime(): string {
+    return this.dateTimeFormat();
+  }
+}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "vwo-fme-node-sdk",
+  "version": "1.0.0",
+  "description": "VWO Node SDK for Feature Management and Experimentation",
+  "main": "dist/index",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "check:versions": "node -e 'require(\"./scripts/check-versions\")'",
+    "demo": "nodemon --inspect=0.0.0.0:9229 --legacy-watch --ignore node_modules demo/index.js",
+    "demo:server": "nodemon --inspect=0.0.0.0:9229 --legacy-watch --ignore node_modules demo/server.js",
+    "prettier": "prettier -w lib/**/*.ts *.md",
+    "tsc": "yarn check:versions && tsc -w"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wingify/vwo-fme-node-sdk"
+  },
+  "author": "VWO developers",
+  "license": "Apache-2.0",
+  "files": [
+    "dist/",
+    "package.json",
+    "yarn.lock",
+    "lib/**/*",
+    "LICENSE",
+    "README.md",
+    "CONTRIBUTING.md",
+    "CHANGELOG.md",
+    "NOTICE"
+  ],
+  "dependencies": {
+    "murmurhash": "^2.0.1",
+    "superstruct": "^1.0.4",
+    "uuid": "^9.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.7",
+    "express": "^4.19.2",
+    "nodemon": "^2.0.6",
+    "prettier": "^3.2.5",
+    "semver": "^7.6.0",
+    "shelljs": "^0.8.5",
+    "typescript": "^5.4.5"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "globOptions": {
+      "matchBase": false
+    },
+    "linters": {
+      "**/*.js": [
+        "yarn lint",
+        "prettier",
+        "git add"
+      ],
+      "**/*.{json,md}": [
+        "prettier",
+        "git add"
+      ]
+    }
+  },
+  "engineStrict": true,
+  "engines": {
+    "node": ">= 8.9.0"
+  }
+}