Global Page Request (After)

This action manipulates the HTTP request or response after a page of any type loads on the live site.

JavaScript File Structure

Action files share the following basic structure:

module.exports = function(context, callback) {
   // Your custom code here
   callback();
};

When you code the custom function for an action, you have access to two arguments:

callback—This argument follows the established JavaScript callback pattern: it takes an error as the first argument (or null if there is no error) and a result as the second argument (if required).

context—This argument provides the function access to relevant objects and methods that interface with Kibo eCommerce.

Context: HTTP

The following methods and objects are available to this action through the use of the context argument.

Storefront Operation
This action occurs during the storefront operation that obtains and renders view and model data from Hypr particular to the requested page.

Context Objects Available to All HTTP Actions

• request
• response
• items.siteContext
• items.pageContext
• items.navigation

Context Methods Available to Storefront Actions

• exec.loginUser
• exec.logOut

Context Methods Available to All HTTP Actions

• request.get
• response.get
• response.set
• response.set
• response.remove
• response.redirect
• response.end
• get.resource
• get.resourceStatus
• items.urlHelper.getUrl

Context Objects Available to All Actions

• apiContext
• configuration

Context Objects Available to All HTTP Actions

request

Accesses the current HTTP request. In the case of Before actions, updates can be made to the request before Kibo eCommerce processes it.

Example:

context.request.url;

response

Accesses the current HTTP response. For both Before and After actions, updates can be made to the response before Kibo eCommerce processes it.

Example:

context.response.header;

items.siteContext

Accesses the current site context.

Example:

context.items.siteContext.siteId;

items.pageContext

Accesses the current page context.

Example:

context.items.pageContext.categoryCode;

items.navigation

Accesses the current navigation context.

Example:

context.items.navigation.breadcrumbs;

Context Methods Available to All Storefront Actions

exec.loginUser

Asynchronously retrieves a user, creates an authentication ticket, and sets the authentication cookies.

Example:

var config = {
   rememberUser:true,
   userId: '48577d74a86044bfb2872a4c184ce33c'
};

context.exec.loginUser(config, function (err, result){
//handle the possible error and call the callback
//if successful the result should be the customer auth ticket.
   if (err){
   //bubble up error to the platform
      callback (err);
      return;
   }

//return control flow to the platform
callback();
});

Response: NA

exec.logOut

Synchronously logs out the current user by resetting the user context to an anonymous user and updating the associated cookies.

Example:

context.exec.logOut();

Response: NA

Context Methods Available to All HTTP Actions

request.get

Returns an HTTP header value for the specified header key.

Example:

context.request.get(field);

Response:

"object"

response.get

Gets a field from the response.

Example:

context.response.get(field);

Response:

"string"

response.set

Sets the HTTP headers for the response.

Example:

context.response.set({ myCustomHeader: "howdy" });

Response: N/A

response.set2

Updates a field in the response.

Example:

context.response.set("name", "stuff");

Response: N/A

response.remove

Removes an HTTP header from the response.

Example:

context.response.remove(header);

Response: N/A

response.redirect

Redirects the incoming URL.

Example:

context.response.redirect("http://someOtherSite/foo");

Response: N/A

response.end

Ends the response so that other actions or Kibo eCommerce logic can run. Also, signals the callback to complete.

Example:

context.response.end();

Response: N/A

get.resource

Returns the currently persisted value of the requested resource. **Not available for all calls.

Example:

context.get.resource();

Response: N/A

get.resourceStatus

Gets the HTTP resource status.

Example:

context.get.resourceStatus();

Response: N/A

items.urlHelper.getUrl

Gets the current URL.

Example:

context.items.urlHelper.getUrl(type, object, config);

Context Objects Available to All Actions

apiContext

Accesses Kibo eCommerce tenant information.

Example:

context.apiContext.baseUrl;

configuration

Receives a JSON response that contains information about the configuration data set in the Action Management JSON editor.

Example:

context.configuration.customData;