Merge pull request #5 from Crowdhandler/maintenance/private-api-support-tweaks

recordPerformance() improvement and more examples

Author: luke-owen-crowdhandler

README.md

@@ -273,35 +273,35 @@ This method returns a `Resource` instance for interacting with the `/v1/codes/ID
 
 This method returns a `Resource` instance for interacting with the `/v1/domains/ID_PLACEHOLDER` endpoint.
 
-### domainsIPs()
+### domainIPs()
 
 This method returns a `Resource` instance for interacting with the `/v1/domains/ID_PLACEHOLDER/ips` endpoint.
 
-### domainsReports()
+### domainReports()
 
 This method returns a `Resource` instance for interacting with the `/v1/domains/ID_PLACEHOLDER/reports` endpoint.
 
-### domainsRequests()
+### domainRequests()
 
 This method returns a `Resource` instance for interacting with the `/v1/domains/ID_PLACEHOLDER/requests` endpoint.
 
-### domainsRooms()
+### domainRooms()
 
 This method returns a `Resource` instance for interacting with the `/v1/domains/ID_PLACEHOLDER/rooms` endpoint.
 
-### domainsURLs()
+### domainURLs()
 
 This method returns a `Resource` instance for interacting with the `/v1/domains/ID_PLACEHOLDER/urls` endpoint.
 
 ### groups()
 
 This method returns a `Resource` instance for interacting with the `/v1/groups/ID_PLACEHOLDER` endpoint.
 
-### groupsBatch()
+### groupBatch()
 
 This method returns a `Resource` instance for interacting with the `/v1/groups/ID_PLACEHOLDER/batch` endpoint.
 
-### groupsCodes()
+### groupCodes()
 
 This method returns a `Resource` instance for interacting with the `/v1/groups/ID_PLACEHOLDER/codes` endpoint.
 
@@ -317,11 +317,11 @@ This method returns a `Resource` instance for interacting with the `/v1/reports/
 
 This method returns a `Resource` instance for interacting with the `/v1/rooms/ID_PLACEHOLDER` endpoint.
 
-### roomsReports()
+### roomReports()
 
 This method returns a `Resource` instance for interacting with the `/v1/rooms/ID_PLACEHOLDER/reports` endpoint.
 
-### roomsSessions()
+### roomSessions()
 
 This method returns a `Resource` instance for interacting with the `/v1/rooms/ID_PLACEHOLDER/sessions` endpoint.
 

examples/node-16-9-1/express-4-16-1/api_only_protection/index.js

@@ -15,7 +15,7 @@ const crowdHandlerMiddleware = async (req, res, next) => {
     const ch_gatekeeper = new crowdhandler.Gatekeeper(
       public_client,
       ch_context,
-      {publicKey: publicKey}
+      { publicKey: publicKey }
     );
 
     let decodedBody;
@@ -81,6 +81,18 @@ router.all("*", (req, res, next) => {
     if (res.locals.ch_gatekeeper) {
       res.locals.ch_gatekeeper.recordPerformance();
     }
+
+    /*
+     * IMPORTANT CONSIDERATION:
+     *
+     * The default status code sent to CrowdHandler is '200'. However, if a different status code needs to be sent,
+     * it can be achieved by passing it as a parameter to the 'recordPerformance' method.
+     *
+     * Example:
+     * chGatekeeper.recordPerformance({status: 404});
+     *
+     * If you are using CrowdHandler's autotune feature, is is crucial to pass accurate status codes to CrowdHandler to ensure the precision of analytics and autotune results.
+     */
   });
 });
 

examples/node-16-9-1/express-4-16-1/full_protection/index.js

@@ -7,7 +7,9 @@ const crowdHandlerMiddleware = async (req, res, next) => {
   const publicKey = "YOUR_PUBLIC_KEY";
   const publicClient = new crowdhandler.PublicClient(publicKey);
   const chContext = new crowdhandler.RequestContext(req, res);
-  const chGatekeeper = new crowdhandler.Gatekeeper(publicClient, chContext, {publicKey: publicKey});
+  const chGatekeeper = new crowdhandler.Gatekeeper(publicClient, chContext, {
+    publicKey: publicKey,
+  });
 
   try {
     const chStatus = await chGatekeeper.validateRequest();
@@ -41,7 +43,7 @@ router.use(crowdHandlerMiddleware);
 // Route handler for all paths
 router.get("*", (req, res, next) => {
   //YOUR CODE BELOW THIS COMMENT
-  
+
   // Render the view and send the HTML
   res.render("index", { title: "hello" }, (err, html) => {
     // Handle any errors during rendering
@@ -55,6 +57,18 @@ router.get("*", (req, res, next) => {
     if (res.locals.chGatekeeper) {
       res.locals.chGatekeeper.recordPerformance();
     }
+
+    /*
+     * IMPORTANT CONSIDERATION:
+     *
+     * The default status code sent to CrowdHandler is '200'. However, if a different status code needs to be sent,
+     * it can be achieved by passing it as a parameter to the 'recordPerformance' method.
+     *
+     * Example:
+     * chGatekeeper.recordPerformance({status: 404});
+     *
+     * If you are using CrowdHandler's autotune feature, is is crucial to pass accurate status codes to CrowdHandler to ensure the precision of analytics and autotune results.
+     */
   });
 });
 

examples/node-16-9-1/express-4-16-1/private_api_interaction/index.js

@@ -1,6 +1,29 @@
-//This file provides a few different examples of how the SDK can be used to interact with private CrowdHandler API methods
-//To understand the required parameters, request methods and expected responses, please refer to the full API documentation
-//API documentation can be found in the CrowdHandler control panel Under "Account -> API"
+/* 
+* This file provides a few different examples of how the SDK can be used to interact with private CrowdHandler API methods.
+* To understand the required parameters, request methods and expected responses, please refer to the full API documentation.
+* API documentation can be found in the CrowdHandler control panel Under "Account -> API".
+  
+ * account() -> /v1/account
+ * accountPlan() -> /v1/account/plan
+ * codes() -> /v1/codes/:code-id
+ * domains() -> /v1/domains/:domain-id
+ * domainIPs() -> /v1/domains/:domain-id/ips
+ * domainReports() -> /v1/domains/:domain-id/reports
+ * domainRequests() -> /v1/domains/:domain-id/requests
+ * domainRooms() -> /v1/domains/:domain-id/rooms
+ * domainURLs() -> /v1/domains/:domain-id/urls
+ * groups() -> /v1/groups/:group-id
+ * groupsBatch() -> /v1/groups/:group-id/batch
+ * groupsCodes() -> /v1/groups/:group-id/codes
+ * ips() -> /v1/ips/:ip-id
+ * reports() -> /v1/reports/:report-id
+ * rooms() -> /v1/rooms/:room-id
+ * roomReports() -> /v1/rooms/:room-id/reports
+ * roomSessions() -> /v1/rooms/:room-id/sessions
+ * sessions() -> /v1/sessions/:session-id
+ * templates() -> /v1/templates/:template-id
+ 
+*/
 
 //Import the CrowdHandler SDK
 const crowdhandler = require("crowdhandler-sdk");
@@ -21,11 +44,13 @@ await private_client.domains().put("dom_4RQg2RBH7DLA", {
 
 //Fetch a domains report
 //Parameters are passed as an object
-let domainsReport = await private_client.domainsReports().get("dom_4RQg2RBH7DLA", {
-  from: "2023-06-06T19:59:00.000Z",
-  to: "2023-07-06T19:59:00.000Z",
-  day: "day",
-});
+let domainsReport = await private_client
+  .domainsReports()
+  .get("dom_4RQg2RBH7DLA", {
+    from: "2023-06-06T19:59:00.000Z",
+    to: "2023-07-06T19:59:00.000Z",
+    day: "day",
+  });
 
 //Fetch waiting rooms associated with the key
 let rooms = await private_client.rooms().get();
@@ -34,10 +59,9 @@ let rooms = await private_client.rooms().get();
 let yourRoom = await private_client.rooms().get("room_5SRg2RBH7DLA");
 
 //Get a list of sessions associated with a room
-let roomSessions = await private_client.roomsSessions().get("room_5SRg2RBH7DLA");
+let roomSessions = await private_client
+  .roomsSessions()
+  .get("room_5SRg2RBH7DLA");
 
 //Delete a session
 await private_client.sessions().delete("ses_5SRg2RBH7DLA");
-
-
-

examples/react/App.js

@@ -0,0 +1,76 @@
+// Description: This is a basic example of how to use the CrowdHandler SDK in a React application.
+
+import React, { useEffect, useState } from "react";
+import { useLocation } from "react-router-dom";
+const crowdhandler = require("crowdhandler-sdk");
+
+function App() {
+  const [data, setData] = useState(null);
+
+  const LocationListener = () => {
+    const location = useLocation();
+
+    // This is the main CrowdHandler code. It should be executed as early as possible each time a new page/screen is loaded.
+    useEffect(() => {
+      async function crowdhandler_gatekeeper() {
+        console.log("URL changed:", location.pathname);
+
+        //create a new instance of the CrowdHandler SDK
+        const publicClient = new crowdhandler.PublicClient("YOUR_PUBLIC_KEY");
+        const chContext = new crowdhandler.RequestContext();
+        const chGatekeeper = new crowdhandler.Gatekeeper(
+          publicClient,
+          chContext,
+          {
+            publicKey: "YOUR_PUBLIC_KEY",
+          },
+          //Make sure to pass this mode if CrowdHandler is going to run on the client side
+          { mode: "clientside" }
+        );
+
+        //validate the request
+        const chStatus = await chGatekeeper.validateRequest();
+
+        //session management
+        if (chStatus.setLocalStorage) {
+          chGatekeeper.setLocalStorage();
+        }
+
+        //remove CrowdHandler guff from the URL
+        if (chStatus.stripParams) {
+          chGatekeeper.redirectToCleanUrl(chStatus.targetURL);
+        }
+
+        //to redirect or to not redirect, that is the question
+        if (!chStatus.promoted) {
+          return chGatekeeper.redirectIfNotPromoted();
+        }
+
+        /* Think carefull about where you include this.
+         *
+         *The intention is to inform CrowdHandler of the performance of the page
+         *For example, in a single page application, you should defer this call until all critical components of the page have finished loading and the page is ready to be used.
+         */
+        chGatekeeper.recordPerformance();
+
+        /*
+         * IMPORTANT CONSIDERATION:
+         *
+         * The default status code sent to CrowdHandler is '200'. However, if a different status code needs to be sent,
+         * it can be achieved by passing it as a parameter to the 'recordPerformance' method.
+         *
+         * Example:
+         * chGatekeeper.recordPerformance({status: 404});
+         *
+         * If you are using CrowdHandler's autotune feature, is is crucial to pass accurate status codes to CrowdHandler to ensure the precision of analytics and autotune results.
+         */
+      }
+
+      crowdhandler_gatekeeper();
+    }, [location]);
+
+    return null; // this component doesn't render anything
+  };
+}
+
+export default App;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "crowdhandler-sdk",
-  "version": "1.2.2-beta.1",
+  "version": "2.0.0-beta.1",
   "description": "",
   "homepage": "https://github.com/Crowdhandler/crowdhandler-javascript-sdk#readme",
   "repository": {

src/client/private_client.ts

@@ -46,39 +46,39 @@ export class PrivateClient extends Client {
     });
   }
 
-  domainsIPs() {
+  domainIPs() {
     return new Resource(this.key, "/v1/domains/ID_PLACEHOLDER/ips", {
       timeout: this.timeout,
       debug: this.debug,
       api_url: this.api_url,
     });
   }
 
-  domainsReports() {
+  domainReports() {
     return new Resource(this.key, "/v1/domains/ID_PLACEHOLDER/reports", {
       timeout: this.timeout,
       debug: this.debug,
       api_url: this.api_url,
     });
   }
 
-  domainsRequests() {
+  domainRequests() {
     return new Resource(this.key, "/v1/domains/ID_PLACEHOLDER/requests", {
       timeout: this.timeout,
       debug: this.debug,
       api_url: this.api_url,
     });
   }
 
-  domainsRooms() {
+  domainRooms() {
     return new Resource(this.key, "/v1/domains/ID_PLACEHOLDER/rooms", {
       timeout: this.timeout,
       debug: this.debug,
       api_url: this.api_url,
     });
   }
 
-  domainsURLs() {
+  domainURLs() {
     return new Resource(this.key, "/v1/domains/ID_PLACEHOLDER/urls", {
       timeout: this.timeout,
       debug: this.debug,
@@ -94,15 +94,15 @@ export class PrivateClient extends Client {
     });
   }
 
-  groupsBatch() {
+  groupBatch() {
     return new Resource(this.key, "/v1/groups/ID_PLACEHOLDER/batch", {
       timeout: this.timeout,
       debug: this.debug,
       api_url: this.api_url,
     });
   }
 
-  groupsCodes() {
+  groupCodes() {
     return new Resource(this.key, "/v1/groups/ID_PLACEHOLDER/codes", {
       timeout: this.timeout,
       debug: this.debug,
@@ -134,15 +134,15 @@ export class PrivateClient extends Client {
     });
   }
 
-  roomsReports() {
+  roomReports() {
     return new Resource(this.key, "/v1/rooms/ID_PLACEHOLDER/reports", {
       timeout: this.timeout,
       debug: this.debug,
       api_url: this.api_url,
     });
   }
 
-  roomsSessions() {
+  roomSessions() {
     return new Resource(this.key, "/v1/rooms/ID_PLACEHOLDER/sessions", {
       timeout: this.timeout,
       debug: this.debug,