btrz-api-client 3.40.1 → 3.42.3

package/lib/endpoints/operations/manifest.js

@@ -1,13 +1,12 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 function manifestFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -32,7 +31,9 @@ function manifestFactory(_ref) {
     return client({
       url: "/manifests/" + manifestId,
       method: "get",
-      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      headers: authorizationHeaders({
+        token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
+      })
     });
   }
 
@@ -64,7 +65,9 @@ function manifestFactory(_ref) {
       url: "/outlook-manifests",
       method: "get",
       params: query,
-      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      headers: authorizationHeaders({
+        token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
+      })
     });
   }
 
@@ -81,7 +84,9 @@ function manifestFactory(_ref) {
       method: "patch",
       params: query,
       headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
-      data: { operations: operations }
+      data: {
+        operations: operations
+      }
     });
   }
 
@@ -113,7 +118,9 @@ function manifestFactory(_ref) {
     return client({
       url: "/manifests/" + manifestId + "/users",
       method: "post",
-      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      headers: authorizationHeaders({
+        token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
+      }),
       params: query,
       data: data
     });
@@ -129,7 +136,29 @@ function manifestFactory(_ref) {
     return client({
       url: "/manifests/" + manifestId + "/users/" + userId,
       method: "delete",
-      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      headers: authorizationHeaders({
+        token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
+      })
+    });
+  }
+
+  function updateComment(_ref10) {
+    var token = _ref10.token,
+        jwtToken = _ref10.jwtToken,
+        manifestId = _ref10.manifestId,
+        _ref10$query = _ref10.query,
+        query = _ref10$query === undefined ? {} : _ref10$query,
+        data = _ref10.data,
+        headers = _ref10.headers;
+
+    return client({
+      url: "/manifests/" + manifestId + "/comments",
+      method: "put",
+      headers: authorizationHeaders({
+        token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
+      }),
+      params: query,
+      data: data
     });
   }
 
@@ -141,7 +170,8 @@ function manifestFactory(_ref) {
     patch: patch,
     save: save,
     addUser: addUser,
-    removeUser: removeUser
+    removeUser: removeUser,
+    updateComment: updateComment
   };
 }
 

package/lib/initializedClient.js

@@ -0,0 +1,6 @@
+"use strict";
+
+var _require = require("./client.js"),
+    createApiClient = _require.createApiClient;
+
+module.exports = createApiClient();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "3.40.1",
+  "version": "3.42.3",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {
@@ -9,9 +9,11 @@
     "test:integration": "mocha --recursive -r test-integration/ports.js  test-integration/",
     "browserify": "browserify lib/client.js --standalone BtrzApiClient -p tinyify -o lib/client-standalone-min.js",
     "commit-transpile": "git add lib/ && (git diff-index --quiet HEAD || git commit -m \"transpiled src\")",
+    "commit-types": "git add types/ && (git diff-index --quiet HEAD || git commit -m \"generated types from src\")",
     "pretranspile": "rm -rf lib/",
+    "types": "npx -p typescript tsc src/**.js --declaration --allowJs --emitDeclarationOnly --outDir types",
     "transpile": "babel --presets es2015 -d lib/ src/",
-    "preversion": "npm test && npm run transpile && npm run browserify && npm run commit-transpile",
+    "preversion": "npm test && npm run transpile && npm run browserify && npm run types && npm run commit-transpile && npm run commit-types",
     "postversion": "git push origin master && git push --tags",
     "version": "git tag $1"
   },

package/src/client.js

@@ -333,7 +333,6 @@ function createGPS({baseURL, headers, timeout, overrideFn, internalAuthTokenProv
  *                                              returns an authorization token that's valid for making service-to-service API calls.
  * @param {Function} options.internalAuthTokenProvider.getToken
  * @param {{httpAgent: import("http").Agent, httpsAgent: import("https").Agent}} options.agents - An object containg one or both http agents
- * @returns {Object} An object with a client for every "module" (needed to override baseURL)
  */
 function createApiClient(options) {
   const {baseURL, baseURLOverride = {}, headers, timeout = 0, internalAuthTokenProvider, agents} = options || productionOptions;

package/src/endpoints/operations/manifest.js

@@ -1,7 +1,10 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
-
-function manifestFactory({ client, internalAuthTokenProvider }) {
+const {
+  authorizationHeaders
+} = require("./../endpoints_helpers.js");
 
+function manifestFactory({
+  client, internalAuthTokenProvider
+}) {
   function get({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/manifests",
@@ -11,11 +14,15 @@ function manifestFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function getById({ token, jwtToken, manifestId, headers }) {
+  function getById({
+    token, jwtToken, manifestId, headers
+  }) {
     return client({
       url: `/manifests/${manifestId}`,
       method: "get",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({
+        token, jwtToken, internalAuthTokenProvider, headers
+      })
     });
   }
 
@@ -30,28 +37,38 @@ function manifestFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function outlook({ token, jwtToken, query = {}, headers }) {
+  function outlook({
+    token, jwtToken, query = {}, headers
+  }) {
     return client({
       url: "/outlook-manifests",
       method: "get",
       params: query,
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({
+        token, jwtToken, internalAuthTokenProvider, headers
+      })
     });
   }
 
-  function patch({ token, jwtToken, query = {}, operations, headers }) {
+  function patch({
+    token, jwtToken, query = {}, operations, headers
+  }) {
     return client({
       url: "/manifests",
       method: "patch",
       params: query,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { operations }
+      data: {
+        operations
+      }
     });
   }
 
-  function save({ token, jwtToken, providerId, data, headers }) {
+  function save({
+    token, jwtToken, providerId, data, headers
+  }) {
     return client({
-      url: `/manifests`,
+      url: "/manifests",
       method: "put",
       params: {providerId, manifestId: data.manifestId},
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
@@ -59,21 +76,43 @@ function manifestFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function addUser({ token, jwtToken, manifestId, query = {}, data, headers }) {  
+  function addUser({
+    token, jwtToken, manifestId, query = {}, data, headers
+  }) {
     return client({
       url: `/manifests/${manifestId}/users`,
       method: "post",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({
+        token, jwtToken, internalAuthTokenProvider, headers
+      }),
       params: query,
       data
     });
   }
 
-  function removeUser({ token, jwtToken, manifestId, userId, headers }) {
+  function removeUser({
+    token, jwtToken, manifestId, userId, headers
+  }) {
     return client({
       url: `/manifests/${manifestId}/users/${userId}`,
       method: "delete",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({
+        token, jwtToken, internalAuthTokenProvider, headers
+      })
+    });
+  }
+
+  function updateComment({
+    token, jwtToken, manifestId, query = {}, data, headers
+  }) {
+    return client({
+      url: `/manifests/${manifestId}/comments`,
+      method: "put",
+      headers: authorizationHeaders({
+        token, jwtToken, internalAuthTokenProvider, headers
+      }),
+      params: query,
+      data
     });
   }
 
@@ -85,7 +124,8 @@ function manifestFactory({ client, internalAuthTokenProvider }) {
     patch,
     save,
     addUser,
-    removeUser
+    removeUser,
+    updateComment
   };
 }
 

package/src/initializedClient.js

@@ -0,0 +1,3 @@
+const {createApiClient} = require("./client.js");
+
+module.exports = createApiClient();

package/test/endpoints/operations/manifest.test.js

@@ -1,11 +1,15 @@
 const {expect} = require("chai");
-const { axiosMock, expectRequest } = require("./../../test-helpers"),
-  api = require("./../../../src/client").createApiClient({ baseURL: "http://test.com" });
+const {
+  axiosMock, expectRequest
+} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({
+  baseURL: "http://test.com"
+});
 
 describe("operations/manifest", () => {
-  const token = "I owe you a token",
-    jwtToken = "I owe you a JWT token",
-    providerId = "providerId";
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+  const providerId = "providerId";
 
   afterEach(() => {
     axiosMock.reset();
@@ -18,14 +22,22 @@ describe("operations/manifest", () => {
       scheduleId: "abc",
       date: "2017-10-10"
     };
-    axiosMock.onGet("/manifests").reply(expectRequest({ statusCode: 200, token }));
-    return api.operations.manifest.get({ token, jwtToken, query });
+    axiosMock.onGet("/manifests").reply(expectRequest({
+      statusCode: 200, token
+    }));
+    return api.operations.manifest.get({
+      token, jwtToken, query
+    });
   });
 
   it("should get a manifest by manifestId", () => {
     const manifestId = "manifestId";
-    axiosMock.onGet(`/manifests/${manifestId}`).reply(expectRequest({ statusCode: 200, token }));
-    return api.operations.manifest.getById({ token, jwtToken, manifestId });
+    axiosMock.onGet(`/manifests/${manifestId}`).reply(expectRequest({
+      statusCode: 200, token
+    }));
+    return api.operations.manifest.getById({
+      token, jwtToken, manifestId
+    });
   });
 
   it("should get many manifests", () => {
@@ -46,13 +58,21 @@ describe("operations/manifest", () => {
       productId: "productId",
       date: "2018-01-01"
     };
-    axiosMock.onGet("/outlook-manifests").reply(expectRequest({ statusCode: 200, token, jwtToken }));
-    return api.operations.manifest.outlook({ token, jwtToken, query });
+    axiosMock.onGet("/outlook-manifests").reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    return api.operations.manifest.outlook({
+      token, jwtToken, query
+    });
   });
 
   it("should patch a manifest", () => {
-    axiosMock.onPatch("/manifests").reply(expectRequest({ statusCode: 200, token, jwtToken }));
-    return api.operations.manifest.patch({ token, jwtToken, query: {providerId}, operations: {op: "add_tickets", tickets: []} });
+    axiosMock.onPatch("/manifests").reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    return api.operations.manifest.patch({
+      token, jwtToken, query: {providerId}, operations: {op: "add_tickets", tickets: []}
+    });
   });
 
   it("should save a manifest", () => {
@@ -61,8 +81,33 @@ describe("operations/manifest", () => {
       comments: "This is a comment!",
       capacity: 22
     };
-    axiosMock.onPut("/manifests").reply(expectRequest({ statusCode: 200, token, jwtToken }));
-    return api.operations.manifest.save({ token, jwtToken, providerId, data });
+    axiosMock.onPut("/manifests").reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    return api.operations.manifest.save({
+      token, jwtToken, providerId, data
+    });
+  });
+
+  it("should add comment to the manifest", async () => {
+    const manifestId = "theId";
+    const data = {
+      comment: {
+        test: "The comment"
+      }
+    };
+
+    // optional query
+    const query = {
+      accountId: providerId,
+      routeId: "2349283409238429348",
+      scheduleId: "abc",
+      date: "2017-10-10"
+    };
+    axiosMock.onPut(`/manifests/${manifestId}/comments`).reply(expectRequest({statusCode: 201, token, jwtToken}));
+    const call = await api.operations.manifest.updateComment({token, jwtToken, manifestId, data, query});
+    expect(call.config.params).to.be.eql(query);
+    return call;
   });
 
   it("should add user to the manifest", async () => {
@@ -90,7 +135,11 @@ describe("operations/manifest", () => {
     const manifestId = "theId";
     const userId = "theUserId";
 
-    axiosMock.onDelete(`/manifests/${manifestId}/users/${userId}`).reply(expectRequest({ statusCode: 201, token, jwtToken }));
-    return api.operations.manifest.removeUser({ token, jwtToken, manifestId, userId });
+    axiosMock.onDelete(`/manifests/${manifestId}/users/${userId}`).reply(expectRequest({
+      statusCode: 201, token, jwtToken
+    }));
+    return api.operations.manifest.removeUser({
+      token, jwtToken, manifestId, userId
+    });
   });
 });