renamed

Author: chriscdn

README.md

@@ -1,12 +1,13 @@
-# @chriscdn/cs-rest
+# @kweli/cs-rest
 
-Simplified authentication and REST calls for OpenText Content Server.
+Simple authentication and REST calls for OpenText Content Server.
 
 ## Features
 
 - Provides a simplified interface for managing authentication with the OpenText Content Server REST API
 - Automatically adds the `OTCSTicket` header to each subsequent request
 - Refreshes the `OTCSTicket` token automatically (minimising token expiration errors)
+- Simplifies POST, PUT, & PATCH requests (since Content Server doesn't support the `application/json` content type)
 - Based on the [axios](https://github.com/axios/axios) HTTP client
 - Works with Node.js and the browser
 
@@ -15,29 +16,29 @@ Simplified authentication and REST calls for OpenText Content Server.
 Using npm:
 
 ```bash
-$ npm install @chriscdn/cs-rest
+$ npm install @kweli/cs-rest
 ```
 
 Using yarn:
 
 ```bash
-$ yarn add @chriscdn/cs-rest
+$ yarn add @kweli/cs-rest
 ```
 
 Using unpkg CDN:
 
 ```html
 <script src="https://cdn.jsdelivr.net/npm/es6-promise@4/dist/es6-promise.auto.min.js"></script>
 <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
-<script src="https://unpkg.com/@chriscdn/cs-rest/lib/index.min.js"></script>
+<script src="https://unpkg.com/@kweli/cs-rest"></script>
 ```
 
 ## Example
 
 Authenticate with a username and password and get the details of a node:
 
 ```js
-const CSREST = require('@chriscdn/cs-rest')
+const CSREST = require('@kweli/cs-rest')
 
 // session wraps an axios instance
 const session = new CSREST.Session({
@@ -63,11 +64,11 @@ const session = new CSREST.Session({
 
 Requests can be made with the `get`, `post`, `put`, `patch`, `delete`, and `options` methods on the `Session` instance.  These have the same interface as the respective methods in [axios](https://github.com/axios/axios).
 
-Content Server returns a fresh `OTCSTicket` with each successful API call.  The `Session` instance will automatically retain it for the subsequent request.
+Content Server returns a fresh `OTCSTicket` with each successful API call.  The `Session` instance automatically retains it for the subsequent request.
 
 #### POST, PUT, & PATCH
 
-The OpenText Content Server REST API doesn't accept requests that use the `application/json` content type.  This means post, put, & patch requests need to use a content type of `multipart/form-data`, which makes writing the request a little more verbose.  For example, to create a new folder:
+The OpenText Content Server REST API doesn't accept requests that use the `application/json` content type.  This means POST, PUT, & PATCH requests need to use a content type of `multipart/form-data`, which makes writing a request a little more verbose.  For example, to create a new folder:
 
 ```js
 const formData = new FormData()
@@ -78,7 +79,7 @@ formDAta.append('name', 'My New Folder')
 const response = await session.post('api/v2/nodes', formData)
 ```
 
-The `Session` class provides a `postForm` (also `putForm` and `patchForm`) method to simplify this to:
+The `Session` class provides a `postForm` (also `putForm` and `patchForm`) method to simplify this:
 
 ```js
 const response = await session.postForm('api/v2/nodes', {
@@ -109,7 +110,7 @@ const response = await session.nodes.addFolder(2000, 'My New Folder')
 A method also exists for uploading a document, where `file` is either:
 
 - a browser [File](https://developer.mozilla.org/en-US/docs/Web/API/File) object (e.g,. from drag and drop); or
-- a Node.js file (e.g., `const file = fs.readFileSync('<file path>')`
+- a Node.js file (e.g., `const file = fs.readFileSync('<file path>')`.
 
 ```js
 const response = await session.nodes.uploadDocument(2000, "My New File", file)
@@ -120,7 +121,7 @@ See the `src/` directory for more examples.
 ## Credits
 
 - [OpenText Content Server REST API](https://developer.opentext.com/webaccess/#url=%2Fawd%2Fresources%2Fapis%2Fcs-rest-api-for-cs-16-s&tab=501)
-- [kwe.li GmbH](https://kwe.li/)
+- [Kwe.li GmbH](https://kwe.li/)
 
 ## License
 

lib/index.cjs.js

@@ -1,12 +1,12 @@
 {
-	"name": "@chriscdn/cs-rest",
-	"version": "1.0.4",
-	"description": "Simplified authentication and REST calls for OpenText Content Server.",
+	"name": "@kweli/cs-rest",
+	"version": "1.0.5",
+	"description": "Simple authentication and REST calls for OpenText Content Server.",
 	"main": "lib/index.cjs.js",
 	"module": "lib/index.es.js",
 	"unpkg": "lib/index.min.js",
 	"repository": "https://github.com/chriscdn/cs-rest",
-	"author": "Christopher Meyer",
+	"author": "Christopher Meyer <chris.meyer@kwe.li> (https://kwe.li/)",
 	"license": "MIT",
 	"scripts": {
 		"build": "rollup -c"

lib/index.cjs.js.map

@@ -72,19 +72,16 @@ module.exports = class Session {
 
 	putForm(url, params) {
 		const formData = this._objectToForm(params)
-
 		return process.node ? this.put(url, formData.getBuffer(), { headers: formData.getHeaders() }) : this.put(url, formData)
 	}
 
 	postForm(url, params) {
 		const formData = this._objectToForm(params)
-
 		return process.node ? this.post(url, formData.getBuffer(), { headers: formData.getHeaders() }) : this.post(url, formData)
 	}
 
 	patchForm(url, params) {
 		const formData = this._objectToForm(params)
-
 		return process.node ? this.patch(url, formData.getBuffer(), { headers: formData.getHeaders() }) : this.patch(url, formData)
 	}
 

lib/index.es.js

@@ -48,9 +48,7 @@ function axiosFactory(options) {
 				formData.append('username', username)
 				formData.append('password', password)
 
-				let response = process.node 
-					? await axios.post(`${options.baseURL}/api/v1/auth/`, formData.getBuffer(), {headers: formData.getHeaders()})
-					: await axios.post(`${options.baseURL}/api/v1/auth/`, formData)
+				let response = process.node ? await axios.post(`${options.baseURL}/api/v1/auth/`, formData.getBuffer(), { headers: formData.getHeaders() }) : await axios.post(`${options.baseURL}/api/v1/auth/`, formData)
 
 				request.headers.common['OTCSTicket'] = get(response, 'data.ticket')