@ngrok/ngrok-api 0.0.9 → 0.3.0

package/src/util.ts

@@ -0,0 +1,48 @@
+export function onFulfilled(f) {
+  return f;
+}
+
+export function onRejected(e: Error) {
+  const errMsg = deserializeResult(JSON.parse(e.message));
+  errMsg.details = new Map(Object.entries(errMsg.details));
+  throw errMsg;
+}
+
+export function deserializeResult(obj) {
+  return objectKeysTo(obj, snakeToLowerCamel);
+}
+
+export function serializeArgument(obj) {
+  return JSON.stringify(objectKeysTo(obj, lowerCamelToSnake), replacer);
+}
+
+function replacer(key, value) {
+  if (value instanceof Map) {
+    return Object.fromEntries(value);
+  } else {
+    return value;
+  }
+}
+
+function snakeToLowerCamel(s: string): string {
+  return s.replace(/([-_]\w)/g, g => g[1].toUpperCase());
+}
+
+function lowerCamelToSnake(s: string): string {
+  return s.replace(/[A-Z]/g, g => `_${g.toLowerCase()}`);
+}
+
+function objectKeysTo(obj, keyFunc) {
+  if (obj === null) {
+    return obj;
+  } else if (Array.isArray(obj)) {
+    return obj.map(item => objectKeysTo(item, keyFunc));
+  } else if (typeof obj === 'object') {
+    return Object.keys(obj).reduce((acc, k) => {
+      acc[keyFunc(k)] = objectKeysTo(obj[k], keyFunc);
+      return acc;
+    }, {});
+  } else {
+    return obj;
+  }
+}

package/test/apikey.test.js

@@ -5,54 +5,68 @@ global.fetch = require('node-fetch');
 
 describe('valid ngrok api key', () => {
   let ngrok;
+  let noMocks = process.env.TEST_NO_MOCK == '1';
+  let ifMock = fn => {
+    if (!noMocks) {
+      return fn();
+    }
+  };
 
   beforeAll(() => {
     ngrok = new Ngrok({
       apiToken: process.env.NGROK_API_KEY,
-      baseUrl: 'https://api.ngrok.com.lan',
+      baseUrl: 'https://api.ngrok.com',
     });
   });
 
   test('non-empty api keys list', () => {
-    nock('https://api.ngrok.com.lan')
-      .get('/api_keys')
-      .reply(200, {
-        keys: [
-          {
-            id: 'ak_1jCnOTFMXku4RbU8icW3lncpCoz',
-            uri: 'https://api.ngrok.com.lan/api_keys/ak_1jCnOTFMXku4RbU8icW3lncpCoz',
-            description: '',
-            metadata: '',
-            created_at: '2020-10-21T21:48:28Z',
-            token: null,
-          },
-        ],
-        uri: 'https://api.ngrok.com.lan/api_keys',
-        next_page_uri: null,
-      });
+    ifMock(() =>
+      nock('https://api.ngrok.com')
+        .get('/api_keys')
+        .query({
+          limit: '100',
+        })
+        .reply(200, {
+          keys: [
+            {
+              id: 'ak_1jCnOTFMXku4RbU8icW3lncpCoz',
+              uri: 'https://api.ngrok.com/api_keys/ak_1jCnOTFMXku4RbU8icW3lncpCoz',
+              description: '',
+              metadata: '',
+              created_at: '2020-10-21T21:48:28Z',
+              token: null,
+            },
+          ],
+          uri: 'https://api.ngrok.com/api_keys',
+          next_page_uri: null,
+        })
+    );
 
     expect.assertions(1);
-    return ngrok.APIKeys.list({}).then(data => {
-      expect(data.keys.length).toBeGreaterThan(0);
+    return ngrok.apiKeys.list().then(result => {
+      expect(result.length).toBeGreaterThan(0);
     });
   });
 
   test('api keys invalid id', () => {
-    nock('https://api.ngrok.com.lan')
-      .get('/api_keys/1000')
-      .reply(404, {
-        error_code: 'ERR_NGROK_222',
-        status_code: 404,
-        msg: "The API Key resource identified by '100' could not be found because the identifier is not a valid identifier.",
-        details: { operation_id: 'op_1jF49fn7npJRATGKUgqig5GgHMA' },
-      });
+    ifMock(() =>
+      nock('https://api.ngrok.com')
+        .get('/api_keys/1000')
+        .reply(404, {
+          error_code: 'ERR_NGROK_222',
+          status_code: 404,
+          msg: "The API Key resource identified by '100' could not be found because the identifier is not a valid identifier.",
+          details: { operation_id: 'op_1jF49fn7npJRATGKUgqig5GgHMA' },
+        })
+    );
 
     expect.assertions(1);
     return (
-      ngrok.APIKeys.get({ id: '1000' })
+      ngrok.apiKeys
+        .get({ id: '1000' })
         /* eslint jest/no-conditional-expect: "warn" */
-        .catch(data => {
-          expect(JSON.stringify(data)).toMatch(
+        .catch(result => {
+          expect(JSON.stringify(result)).toMatch(
             'the identifier is not a valid identifier'
           );
         })

package/test/endpointConfigurations.test.js

@@ -6,58 +6,62 @@ const nock = require('nock');
 
 describe('valid ngrok api key', () => {
   let ngrok;
+  let noMocks = process.env.TEST_NO_MOCK == '1';
+  let ifMock = fn => {
+    if (!noMocks) {
+      return fn();
+    }
+  };
 
   beforeAll(() => {
     ngrok = new Ngrok({
       apiToken: process.env.NGROK_API_KEY,
-      baseUrl: 'https://api.ngrok.com.lan',
+      baseUrl: 'https://api.ngrok.com',
     });
   });
 
   test('create endpoint configuration', () => {
     expect.assertions(1);
 
-    nock('https://api.ngrok.com.lan')
-      .post('/endpoint_configurations')
-      .reply(200, {
-        id: 'ec_1jFQm2FyjAGRYLijtEADZ2S9O3f',
-        type: 'https',
-        description: 'some endpoint configuration description',
-        metadata: 'some endpoint configuration metadata',
-        created_at: '2020-10-22T20:11:54Z',
-        uri: 'https://api.ngrok.com.lan/endpoint_configurations/ec_1jFQm2FyjAGRYLijtEADZ2S9O3f',
-        basic_auth: {
-          enabled: true,
-          auth_provider_id: 'agent',
-          realm: 'ngrok',
-          allow_options: true,
-        },
-        circuit_breaker: null,
-        compression: null,
-        request_headers: null,
-        response_headers: null,
-        ip_policy: null,
-        mutual_tls: null,
-        tls_termination: null,
-        webhook_validation: null,
-        oauth: null,
-        logging: null,
-      });
+    ifMock(() =>
+      nock('https://api.ngrok.com')
+        .post('/endpoint_configurations')
+        .reply(200, {
+          id: 'ec_1jFQm2FyjAGRYLijtEADZ2S9O3f',
+          type: 'https',
+          description: 'some endpoint configuration description',
+          metadata: 'some endpoint configuration metadata',
+          created_at: '2020-10-22T20:11:54Z',
+          uri: 'https://api.ngrok.com/endpoint_configurations/ec_1jFQm2FyjAGRYLijtEADZ2S9O3f',
+          basic_auth: null,
+          circuit_breaker: {
+            enabled: true,
+            errorThresholdPercentage: 0.6,
+            numBuckets: 16,
+          },
+          compression: null,
+          request_headers: null,
+          response_headers: null,
+          ip_policy: null,
+          mutual_tls: null,
+          tls_termination: null,
+          webhook_validation: null,
+          oauth: null,
+          logging: null,
+        })
+    );
 
     let epConfCreate = {
       type: 'https',
       description: 'some endpoint configuration description',
       metadata: 'some endpoint configuration metadata',
-      basic_auth: {
-        enabled: true,
-        auth_provider_id: 'agent',
-        realm: 'ngrok',
-        allow_options: true,
+      circuitBreaker: {
+        errorThresholdPercentage: 0.6,
       },
     };
 
-    return ngrok.EndpointConfigurations.create(epConfCreate).then(data => {
-      expect(data.basic_auth.enabled).toBeTruthy();
+    return ngrok.endpointConfigurations.create(epConfCreate).then(data => {
+      expect(data.circuitBreaker.enabled).toBeTruthy();
     });
   });
 });

package/tsconfig.json

@@ -1,17 +1,27 @@
 {
+  "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
-    "declaration": true,
-    "outDir": "lib",
+    "target": "es6",
     "module": "commonjs",
-    "lib": [ "es2015" ],
-    "target": "es5",
+    "declaration": true,
     "sourceMap": true,
-    "skipLibCheck": true
+    "declarationMap": true,
+    "skipLibCheck": true,
+    "types": [
+    ],
+    "lib": [
+      "es2019"
+    ],
+    "outDir": "lib"
   },
   "include": [
-    "src"
+    "src/**/*.ts"
   ],
   "exclude": [
     "node_modules"
-  ]
+  ],
+  "typedocOptions": {
+    "entryPoints": ["src/index.ts"],
+    "out": "docs"
+  }
 }

package/lib/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}