Merge d618c3c into 144d55b

CalderaWP · Nov 3, 2018 · 39c1788 · 39c1788
2 parents 144d55b + d618c3c
commit 39c1788
Show file tree

Hide file tree

Showing 9 changed files with 232 additions and 166 deletions.
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/__tests__/apiClient.test.js b/__tests__/apiClient.test.js
@@ -106,6 +106,18 @@ describe('Makes requests', () => {
 
 			expect(fetch.mock.calls).toHaveLength(1);
 		});
+
+		it( 'sets CORS mode', () => {
+			const formsClient = new ApiClient('/forms', {});
+			formsClient.setCorsMode(true);
+			expect(formsClient.corsMode).toBe(true);
+
+			formsClient.setCorsMode(false);
+			expect(formsClient.corsMode).toBe(false);
+
+			formsClient.setCorsMode(true);
+			expect(formsClient.corsMode).toBe(true);
+		});
 	});
 
 	describe('PUT', () => {
@@ -159,4 +171,4 @@ describe('Makes requests', () => {
 		});
 	});
 
-});
+});
diff --git a/docs/index.html b/docs/index.html
@@ -263,14 +263,13 @@
 <div class="manual-card-wrap" data-ice="cards">
       <div class="manual-card">
         <div data-ice="card"><h1>caldera-api-client</h1><p>JavaScript API client for <a href="https://calderaforms.com/doc/caldera-forms-rest-api/">Caldera Forms REST API</a> and Caldera Forms Pro REST API.</p><p>&#x1F30B; &#x1F440; <a href="https://calderalabs.org/caldera-api-client/">Documentation</a></p><p><a href="https://travis-ci.org/CalderaWP/caldera-api-client.svg"><img src="https://travis-ci.org/CalderaWP/caldera-api-client.svg?branch=master" alt="Build Status"></a>
-<a href="https://coveralls.io/github/CalderaWP/caldera-api-client?branch=master"><img src="https://coveralls.io/repos/github/CalderaWP/caldera-api-client/badge.svg?branch=master" alt="Coverage Status"></a>
-<a href="https://calderalabs.org/caldera-api-client/source.html"><img src="https://calderalabs.org/caldera-api-client/badge.svg" alt="Documentation Status"></a>
+<a href="https://travis-ci.org/CalderaWP/caldera-api-client.svg"><img src="https://travis-ci.org/CalderaWP/caldera-api-client.svg?branch=master" alt="Documentation Status"></a>
 <a href="https://codeclimate.com/github/CalderaWP/caldera-api-client/maintainability"><img src="https://api.codeclimate.com/v1/badges/a2e2c1afbb3eae8a6635/maintainability" alt="Maintainability"></a></p><h2>Install</h2><p><code>npm i @caldera-labs/api-client</code></p><h2>Usage</h2><p>Create a form client and use it to get page one of form configs via API</p><pre><code class="lang-js"><code class="source-code prettyprint">import {wpClientFactory} from &apos;@caldera-labs/api-client&apos;;
 
 const formsAdminApiClient = wpClientFactory(
     &apos;https://hiroy.club/wp-json/cf-api/v2&apos;, //root of Caldera Forms REST API namespace
     &apos;12345&apos;, //the nonce for REST API cookie authentication
-    &apos;forms&apos; //type of client to get
+        &apos;forms&apos; //type of client to get
 );
 let forms = [];
 formsAdminApiClient(page).then(r =&gt; {

diff --git a/docs/index.json b/docs/index.json
diff --git a/docs/manual/README.html b/docs/manual/README.html
@@ -78,8 +78,7 @@
 <div class="content" data-ice="content"><div class="github-markdown" data-ice="content"><h1 id="caldera-api-client">caldera-api-client</h1><p>JavaScript API client for <a href="https://calderaforms.com/doc/caldera-forms-rest-api/">Caldera Forms REST API</a> and Caldera Forms Pro REST API.</p>
 <p>&#x1F30B; &#x1F440; <a href="https://calderalabs.org/caldera-api-client/">Documentation</a></p>
 <p><a href="https://travis-ci.org/CalderaWP/caldera-api-client.svg"><img src="https://travis-ci.org/CalderaWP/caldera-api-client.svg?branch=master" alt="Build Status"></a>
-<a href="https://coveralls.io/github/CalderaWP/caldera-api-client?branch=master"><img src="https://coveralls.io/repos/github/CalderaWP/caldera-api-client/badge.svg?branch=master" alt="Coverage Status"></a>
-<a href="https://calderalabs.org/caldera-api-client/source.html"><img src="https://calderalabs.org/caldera-api-client/badge.svg" alt="Documentation Status"></a>
+<a href="https://travis-ci.org/CalderaWP/caldera-api-client.svg"><img src="https://travis-ci.org/CalderaWP/caldera-api-client.svg?branch=master" alt="Documentation Status"></a>
 <a href="https://codeclimate.com/github/CalderaWP/caldera-api-client/maintainability"><img src="https://api.codeclimate.com/v1/badges/a2e2c1afbb3eae8a6635/maintainability" alt="Maintainability"></a></p>
 <h2 id="install">Install</h2><p><code>npm i @caldera-labs/api-client</code></p>
 <h2 id="usage">Usage</h2><p>Create a form client and use it to get page one of form configs via API</p>
@@ -88,7 +87,7 @@ <h2 id="usage">Usage</h2><p>Create a form client and use it to get page one of f
 const formsAdminApiClient = wpClientFactory(
     &apos;https://hiroy.club/wp-json/cf-api/v2&apos;, //root of Caldera Forms REST API namespace
     &apos;12345&apos;, //the nonce for REST API cookie authentication
-    &apos;forms&apos; //type of client to get
+        &apos;forms&apos; //type of client to get
 );
 let forms = [];
 formsAdminApiClient(page).then(r =&gt; {

diff --git a/docs/manual/index.html b/docs/manual/index.html
@@ -263,14 +263,13 @@
 <div class="manual-card-wrap" data-ice="cards">
       <div class="manual-card">
         <div data-ice="card"><h1>caldera-api-client</h1><p>JavaScript API client for <a href="https://calderaforms.com/doc/caldera-forms-rest-api/">Caldera Forms REST API</a> and Caldera Forms Pro REST API.</p><p>&#x1F30B; &#x1F440; <a href="https://calderalabs.org/caldera-api-client/">Documentation</a></p><p><a href="https://travis-ci.org/CalderaWP/caldera-api-client.svg"><img src="https://travis-ci.org/CalderaWP/caldera-api-client.svg?branch=master" alt="Build Status"></a>
-<a href="https://coveralls.io/github/CalderaWP/caldera-api-client?branch=master"><img src="https://coveralls.io/repos/github/CalderaWP/caldera-api-client/badge.svg?branch=master" alt="Coverage Status"></a>
-<a href="https://calderalabs.org/caldera-api-client/source.html"><img src="https://calderalabs.org/caldera-api-client/badge.svg" alt="Documentation Status"></a>
+<a href="https://travis-ci.org/CalderaWP/caldera-api-client.svg"><img src="https://travis-ci.org/CalderaWP/caldera-api-client.svg?branch=master" alt="Documentation Status"></a>
 <a href="https://codeclimate.com/github/CalderaWP/caldera-api-client/maintainability"><img src="https://api.codeclimate.com/v1/badges/a2e2c1afbb3eae8a6635/maintainability" alt="Maintainability"></a></p><h2>Install</h2><p><code>npm i @caldera-labs/api-client</code></p><h2>Usage</h2><p>Create a form client and use it to get page one of form configs via API</p><pre><code class="lang-js"><code class="source-code prettyprint">import {wpClientFactory} from &apos;@caldera-labs/api-client&apos;;
 
 const formsAdminApiClient = wpClientFactory(
     &apos;https://hiroy.club/wp-json/cf-api/v2&apos;, //root of Caldera Forms REST API namespace
     &apos;12345&apos;, //the nonce for REST API cookie authentication
-    &apos;forms&apos; //type of client to get
+        &apos;forms&apos; //type of client to get
 );
 let forms = [];
 formsAdminApiClient(page).then(r =&gt; {

diff --git a/manual/overview.md b/manual/overview.md
@@ -51,6 +51,19 @@ const formsAdminApiClient = calderaApiClient.wpClientFactory(
 );
 ```
 
+#### Enabling Cross-Origin Requests
+By default, requests are same-origin only. Cross-origin requests are possible. The WP REST API nonce auth will not work cross-origin. You must implement your own auth.
+```js
+import {wpClientFactory} from '@caldera-labs/api-client';
+const formsAdminApiClient = calderaApiClient.wpClientFactory(
+	'https://hiroy.club/wp-json/cf-api/v2', 
+    '12345', 
+    'forms' 
+);
+formsAdminApiClient.setCorsMode(true);
+```
+
+
 ### WordPress Admin Clients
 
 * Get or update Caldera Forms form configs or other settings.
@@ -234,4 +247,4 @@ describe('Forms API', () => {
 #### Helpful Links About Fetch and Testing With Fetch
 * [MDN Fetch docs](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
 * [David Walsh blog post about Fetch](https://davidwalsh.name/fetch)
-* [Why tests using fetch mocks must catch errors](https://github.com/jefflau/jest-fetch-mock/issues/60#issuecomment-402489882)
+* [Why tests using fetch mocks must catch errors](https://github.com/jefflau/jest-fetch-mock/issues/60#issuecomment-402489882)
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@caldera-labs/api-client",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "API client for Caldera Forms and Caldera Forms Pro",
   "main": "./dist/index.js",
   "scripts": {

diff --git a/src/ApiClient.js b/src/ApiClient.js
@@ -5,6 +5,27 @@ function removeForwardSlash(endpoint) {
 	return endpoint;
 }
 
+function createRequestArgs(method: string, headers: Headers,corsMode:boolean = true ){
+	const args = {
+		method,
+		redirect: 'follow',
+		headers
+	};
+
+	if( corsMode ){
+		return {
+			...args,
+			mode:'cors',
+		}
+	}else{
+		return {
+			...args,
+			mode:'same-origin',
+			credentials: 'same-origin',
+		}
+	}
+};
+
 //@flow
 /**
  * Generic API client
@@ -23,6 +44,13 @@ export class ApiClient{
 	 */
 	headers: Headers;
 
+	/**
+	 * Is CORS mode enabled?
+	 *
+	 * @type string
+	 */
+	corsMode: boolean;
+
 	/**
 	 *
 	 * @param {String} route The full URL of API route is a client for
@@ -45,6 +73,14 @@ export class ApiClient{
 		this.headers = newHeaders;
 	}
 
+	/**
+	 * Set CORS mode
+	 *
+	 * @param {boolean} corsMode
+	 */
+	setCorsMode(corsMode: boolean){
+		this.corsMode = corsMode;
+	}
 	/**
 	 * Make a request to an endpoint
 	 *
@@ -68,13 +104,7 @@ export class ApiClient{
 	 * @returns {Request}
 	 */
 	createRequest(endpoint: string, data: Object, method: string): Request {
-		let args = {
-			method,
-			mode:'same-origin',
-			credentials: 'same-origin',
-			redirect: 'follow',
-			headers: this.headers
-		};
+		let args = createRequestArgs(method,this.headers,this.corsMode);
 
 		if ('POST' === method || 'PUT' === method) {
 			args.body = JSON.stringify(data);
@@ -85,6 +115,7 @@ export class ApiClient{
 		return new Request(this.urlFromEndpoint(endpoint, method,data), args);
 
 	}
+
 	/**
 	 * Create URL for route with endpoint
 	 * @param endpoint
@@ -223,4 +254,4 @@ export class ApiClient{
 		return this.route + '?' + str;
 	}
 
-}
+}