Merge pull request #41 from switcherapi/3.0.0

3.0.0

Author: petruki

package.json

@@ -1,7 +1,7 @@
 {
   "name": "switcher-client",
   "version": "2.1.1",
-  "description": "Module for working with Switcher-API",
+  "description": "SDK for working with Switcher-API",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
   "author": {

src/index.d.ts

@@ -1,3 +1,5 @@
+import Key from "./lib/key";
+
 /**
  * Quick start with the following 3 steps.
  * 
@@ -7,13 +9,15 @@
  */
 declare class Switcher {
 
+  constructor();
+
   /**
    * Create the necessary configuration to communicate with the API
    * 
    * @param context Necessary arguments
    * @param options 
    */
- static buildContext(context: SwitcherContext, options: SwitcherOptions): void;
+ static buildContext(context: Switcher.SwitcherContext, options: Switcher.SwitcherOptions): void;
 
  /**
   * Creates a new instance of Switcher
@@ -39,7 +43,7 @@ declare class Switcher {
   /**
   * Strategies available to use as Switcher input
   */
- static get StrategiesType(): StrategiesType;
+ static get StrategiesType(): Switcher.StrategiesType;
 
  /**
   * Force a switcher value to return a given value by calling one of both methods - true() false()
@@ -97,32 +101,35 @@ declare class Switcher {
 
 }
 
-declare interface SwitcherContext {
- url: string;
- apiKey: string;
- domain: string;
- component: string;
- environment: string;
- token?: string;
- exp?: number;
-}
-
-declare interface SwitcherOptions {
- offline: boolean;
- logger: boolean;
- snapshotLocation: string;
- snapshotAutoload: string;
- silentMode: boolean;
- retryAfter: string;
-}
-
-declare interface StrategiesType {
- NETWORK: string;
- VALUE: string;
- NUMERIC: string;
- TIME: string;
- DATE: string;
- REGEX: string;
+declare namespace Switcher {
+
+  interface SwitcherContext {
+    url: string;
+    apiKey: string;
+    domain: string;
+    component: string;
+    environment: string;
+    token?: string;
+    exp?: number;
+   }
+   
+   interface SwitcherOptions {
+    offline: boolean;
+    logger: boolean;
+    snapshotLocation: string;
+    snapshotAutoload: string;
+    silentMode: boolean;
+    retryAfter: string;
+   }
+   
+   interface StrategiesType {
+    NETWORK: string;
+    VALUE: string;
+    NUMERIC: string;
+    TIME: string;
+    DATE: string;
+    REGEX: string;
+   }
 }
 
 export = Switcher;

src/index.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const Bypasser = require('./lib/bypasser');
-const ExecutionLogger = require('./lib/executionLogger');
+const ExecutionLogger = require('./lib/utils/executionLogger');
 const { loadDomain, validateSnapshot, StrategiesType } = require('./lib/snapshot');
 const services = require('./lib/services');
 const checkCriteriaOffline = require('./lib/resolver');

src/lib/bypasser.d.ts

@@ -5,6 +5,11 @@ var bypassedKeys = new Array();
 
 class Bypasser {
 
+    /**
+     * Force a switcher value to return a given value by calling one of both methods - true() false()
+     * 
+     * @param key 
+     */
     static assume(key) {
         const existentKey = this.searchBypassed(key, bypassedKeys);
         if (existentKey) {
@@ -16,11 +21,21 @@ class Bypasser {
         return keyBypassed;
     }
 
+    /**
+     * Remove forced value from a switcher
+     * 
+     * @param key 
+     */
     static forget(key) {
         bypassedKeys.splice(
             bypassedKeys.indexOf(this.searchBypassed(key, bypassedKeys)), 1);
     }
 
+    /**
+     * Search for key registered via 'assume'
+     * 
+     * @param key 
+    */
     static searchBypassed(key) {
         let existentKey;
         bypassedKeys.forEach(async bk => {

src/lib/bypasser.js renamed to src/lib/bypasser/index.js

@@ -1,23 +1,39 @@
 'use strict';
 
+/**
+ * Type definition for Switcher Keys which are used to mock results
+ */
 class Key {
+    
     constructor(key) {
         this.key = key;
         this.value = undefined;
     }
 
+    /**
+     * Force result to true
+     */
     true() {
         this.value = true;
     }
 
+    /**
+     * Force result to false
+     */
     false() {
         this.value = false;
     }
 
+    /**
+     * Return selected switcher name
+     */
     getKey() {
         return this.key;
     }
 
+    /**
+     * Return current value
+     */
     getValue() {
         return this.value;
     }

src/lib/key.js renamed to src/lib/bypasser/key.js

@@ -1,5 +1,5 @@
 const axios = require('axios');
-const DateMoment = require('./datemoment');
+const DateMoment = require('./utils/datemoment');
 
 const getConnectivityError = (code) => `Connection has been refused - ${code}`;