Merge release-v0.1.2 into master

Author: johnboxall

.babelrc

@@ -1,12 +1,15 @@
 {
-    "presets": [
-        [
-            "es2015",
-            {
-                "modules": false
-            }
-        ],
-        "stage-0"
-    ],
-    "plugins": ["babel-plugin-transform-es2015-modules-commonjs"]
-}
+    "env": {
+        "production": {
+            "presets": [
+                ["env", {"modules": false}]
+            ],
+            "plugins": [
+                "external-helpers"
+            ]
+        },
+        "test": {
+            "presets": ["env"]
+        }
+    }
+}

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,29 @@
+# Description
+
+Please include a summary of the change. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+<!-- If this PR fixes an issue, please specify issue #. -->
+
+## Type of change
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+
+## Changes
+
+- (change1)
+
+# How to test this PR?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project (`npm run lint`)
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation (`README.md` and `CHANGELOG.md`)
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes (`npm test`)

.gitignore

@@ -1,6 +1,8 @@
 .DS_Store
 *.tgz
 
+dist/
+es/
 lib/
 tmp/
 node_modules

CHANGELOG.md

@@ -1,3 +1,6 @@
+## v0.1.2 (April 3, 2018)
+- Update npm package to ship with three builds: `UMD`, `CommonJS` and `ES2015`
+
 ## v0.1.1 (November 7, 2017)
 - Update Rollup output format to 'es'
 

README.md

@@ -15,50 +15,21 @@ _(___ _(___/_/_/__/_/_/__/_(___ _/_____(___ _(___ _(___ _/___(___/_(___(__(___/_
 
 [![CircleCI](https://circleci.com/gh/mobify/commercecloud-ocapi-client.svg?style=svg)](https://circleci.com/gh/mobify/commercecloud-ocapi-client)
 
-## Introduction
+## 🙌 Introduction
 
-ShopApi - ES6 JavaScript client for Salesforce Commerce Cloud OCAPI Shop API.
+Salesforce Commerce Cloud Open Commerce API (OCAPI) for Node and browsers.
 
 - API version: 17.8
 
-## Installation
+### ⚒ Installation
 
-### For [Node.js](https://nodejs.org/)
-
-#### npm
-
-To publish the library as a [npm](https://www.npmjs.com/),
-please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
-
-Then install it via:
+This library is distributed on npm, in order to add it as a dependency, run the following command:
 
 ```shell
 npm install commercecloud-ocapi-client --save
 ```
 
-#### git
-#
-If the library is hosted at a git repository, e.g.
-https://github.com/GIT_USER_ID/GIT_REPO_ID
-then install it via:
-
-```shell
-    npm install GIT_USER_ID/GIT_REPO_ID --save
-```
-
-### For browser
-
-The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
-the above steps with Node.js and installing browserify with `npm install -g browserify`,
-perform the following (assuming *main.js* is your entry file):
-
-```shell
-browserify main.js > bundle.js
-```
-
-Then include *bundle.js* in the HTML pages.
-
-### Webpack Configuration
+### 🔦 Webpack Configuration
 
 Using Webpack you may encounter the following error: "Module not found: Error:
 Cannot resolve module", most certainly you should disable AMD loader. Add/merge
@@ -76,53 +47,135 @@ module: {
 }
 ```
 
-## Getting Started
+## 👨🏻‍💻 Getting Started
+
+### 💡 Usage
 
 Please follow the [installation](#installation) instruction and execute the following JS code:
 
 ```javascript
 import ShopApi from 'commercecloud-ocapi-client'
 
-ShopApi.ApiClient.instance = new ShopApi.ApiClient({
-    clientUsername: 'YOUR USERNAME', // Configure HTTP basic authorization: customers_auth
-    clientPassword: 'YOUR PASSWORD', // Configure HTTP basic authorization: customers_auth
-    oAuthAccessToken: '' // Configure OAuth2 access token for authorization: oauth2_application
-})
-
-const api = new ShopApi.BasketsApi()
+ShopApi.ApiClient.instance = new ShopApi.ApiClient()
 
-const basketId = "basketId_example" // {String} the id of the basket to be retrieved
+const api = new ShopApi.CategoriesApi()
 
-api.deleteBasketsByID(basketId)
+api.getCategoriesByIDs(['mens', 'newarrivals'])
     .then(() {
         console.log('API called successfully.')
     })
     .catch((fault) => {
         console.error(fault)
     })
+```
+
+
+### 🔌 Configuration
+
+The API client accepts an configuration object, example:
+
+```js
+import ShopApi from 'commercecloud-ocapi-client'
+
+const config = {
+  basePath: 'https://localhost/s/siteId/dw/shop/v17_8',
+  defaultHeaders: {}, // HTTP header for all requests
+  timeout: 60000, // Request timeout in milliseconds
+  cache: true, // If set to false an additional timestamp parameter is added to all API GET calls to prevent browser caching
+  enableCookies: false, //If set to true, the client will save the cookies from each server response, and return them in the next request.
+}
 
+ShopApi.ApiClient.instance = new ShopApi.ApiClient(config)
 ```
 
-## Documentation for API Endpoints
+    
 
-- [API Docs](https://mobify.github.io/commercecloud-ocapi-client/)
+### 🔐 Authorization
+
+To access secure end points, you can pass the username, password in the configuration, example:
+
+```js
+import ShopApi from 'commercecloud-ocapi-client'
 
-## Documentation for Authorization
+const config = {
+  clientUsername: 'username',
+  clientPassword: 'password',
+}
+
+ShopApi.ApiClient.instance = new ShopApi.ApiClient(config)
+```
 
+Or to use oAuth token:
+
+```js
+import ShopApi from 'commercecloud-ocapi-client'
+
+const config = {
+  oauth2AccessToken: 'token'
+}
+
+ShopApi.ApiClient.instance = new ShopApi.ApiClient(config)
+```
+
+## ✅ Testing
+
+Because Salesforce OCAPI is not publicly available, you need to have a running instance that you can test against. In the test folder, there is a file `config.json` that has the example configuration for your environment. Simply update the file with your instance information
+
+Example: 
+```json
+{
+  "clientId": "5640cc6b-f5e9-466e-9134-9853e9f9db93",
+  "baseUrl": "https://localhost/s/siteId/dw/shop/v17_8"
+}
+```
+Then run the following command:
+
+```sh
+npm test
+```
+
+### ♻️ Continuous Integration
+
+We use Circle CI to protect the `develop` and `master` branch to make sure the builds follows the code style and passes all tests. For every pull request, it is required to pass ALL checks including the following tests:
+
+- Linting: `npm run lint`
+- Unit Tests: `npm run test`
+
+## 📦 Build and Deployment
+
+At Mobify, we practice several branching strategies, [Release Deployment](https://github.com/mobify/branching-strategy/blob/master/release-deployment.md) is a strategy for projects where feature gets bundled into a release periodically. `master` contains the code for current version, `develop` has the features that is under development and waiting to be released. For new features and bug fixes, please propose pull requests to merge into `develop`.
+
+This package is distributed on npm, on every release, we run scripts to automatically merge `develop` into `master`, test the build in Circle CI as well as publish the package on NPM.
+
+### Changelog
+
+To understand the change between versions, please read [CHANGELOG.md](./CHANGELOG.md). Note that it is required to have a `# To be released` section filled out if you are planning to make pull requests that include new features or bug fixes.
+
+Example:
+```markdown
+## To be released
+- Update npm package to ship with three builds: `UMD`, `CommonJS` and `ES2015` [#4](https://github.com/mobify/commercecloud-ocapi-client/pull/4)
+
+## v0.1.1 (November 7, 2017)
+- Update Rollup output format to 'es'
+
+...
+```
+
+
+## 📖 Documentation
+
+- [API Docs](https://mobify.github.io/commercecloud-ocapi-client/)
 
-### client_id
 
-- **Type**: API key
-- **API key parameter name**: x-dw-client-id
-- **Location**: HTTP header
+## 👥 Owner
 
-### customers_auth
+This project is open sourced and actively maintained by [Mobify](https://github.com/mobify).
+We will make an effort to support the library, but we reserve the right to make incompatible changes when necessary.
 
-- **Type**: HTTP basic authentication
 
-### oauth2_application
+## 🏅 Contributors
 
-- **Type**: OAuth
-- **Flow**: application
-- **Authorization URL**:
-- **Scopes**: N/A
+- [@jeremywiebe](https://github.com/jeremywiebe)
+- [@bendvc](https://github.com/bendvc)
+- [@kevinxh](https://github.com/kevinxh)