network-client

1.1.8 • Public • Published

Network-Client

Network-Client it's a small footprint javascript REST client.
Aim to give a declarative simple interface with capabilities of storage, retries, And event handling.
it has no dependencies and written to support old browsers like IE8.

Installing

npm install network-client

Examples

https://github.com/shacoshe/network-client/tree/master/test

Running tests

npx mocha

Running In The Browser

These are only basic functionalities tests.

cd test/web
node index.js

Open the WEB Browser and navigate to http://localhost:8080/

Contributing

Please read CONTRIBUTING.md for more details on our code of conduct, and the process for submitting pull requests to us.

Contributors

Shay Tessler - github

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Instructions

Request Configuration

The configuration is a simple JSON object that can be used globally for all requests, And for an individual request. When no configuration specified the default config object is used.

Global configuration can be set at the creation of NetwortClient. For example:

Network = new NetworkClient({"json": true, ..});

Available Options

  • baseURL String suffix for the request URL, (type: string, default: "")
  • json Indicating the request should be send as a JSON or FORM (encodeURIComponent string) . (type: boolean, default: false)
  • headers Additional to addRequestHeader/removeRequestHeader. (type: object, default: {})
  • retries Number of retires in case when the request return with status_code == 0 OR status_code == 408. (type: number, default: 0)
  • backOffFactor Number of milliseconds between each retry. (type: number, default: 0)
  • store. When a request is successful the result will be stored. Calling to another request with the same methods, URL And parameters will get the last stored result. Without sending any request to the server. (All METHOD types will be store the return data.) (type: boolean, default: false)
  • storeExpiration have 3 options that control for how long results are stored. (type: number,default: 0).
    • undefined never expires, will use localStorage if available, otherwise will use a "polyfill" that will expire on reload.
    • 0 expires on reload
    • 123.. time in milliseconds
  • debug Will print networks errors to console.error . (type: boolean, default: false)
  • withCredentials property is a boolean value that indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates. (type: boolean, default: false)
  • responseType What type of data you are expecting in the response, e.g. blob, arraybuffer. (type: string, default: '')

Modules

Modules are a great way to group REST operation, make separation of concerns And load them only when they are needed.

The module is a simple javascript function that accepts an instance of NetworkClient for its first parameter. NetowrkClient instance expose functions to send HTTP request. with or without Promise.

Available functions to send a request with Promise

var network = new NetworkClient();
network.get_promise(path, data, configutation)
network.set_promise(path, data, configutation)
network.put_promise(path, data, configutation)
network.del_promise(path, data, configutation)
network.use_promise(method, path, data, configutation)

Available functions to send a request with the traditional success And error callback

var network = new NetworkClient();
network.get(path, data, configutation, success, error)
network.set(path, data, configutation, success, error)
network.put(path, data, configutation, success, error)
network.del(path, data, configutation, success, error)
network.use(method, path, data, configutation, success, error)

NOTICE: When sending a GET request. The request Data will be sent inside the URL as Query String parameters.

Examples

networkItem.js
var moduleItems = function(network, additionaArgument1, additionaArgument2) {
   return {
      get: function(item_id) {
         return network.get_promise('api/item/' + item_id);
      },
      set: function(item_id, data) {
         return network.post_promise('api/item/' + item_id, data);
      }
   };
}

After the module is registered we can call it in the following why.

var additionaArgument1 = ...., additionaArgument2 = ...;
network.registerModule('items', moduleItems, additionaArgument1, additionaArgument2);

await network.items.get(1);
await network.items.set(2, {'x':'y'});

Declaring Modules Using Callbacks

networkPosts.js
var modulePosts = function(network) {
    var proc_get = function(data, success) {
        ... process the "data" into "proccesedData"
        var proccesedData= ...
        success(proccesedData);
   }
    
   return {
      get: function(post_id, success, error) {
         return network.get('api/posts/' + item_id, {}, {}, 
                            function(data, status){proc_get(data, success)}, 
                            error);
      },
      create: function(data, success, error) {
         return network.post('api/posts', data, {}, success, error);

      }
   };
}

And using the module

Network.registerModule('posts', modulePosts);

Network.posts.get(1, function(data) {
                   ... do somthing 
                 });

Request With Configuration

In case we will fetch information that is large and may not change we can store it in browser

networkDetails.js
var moduleDetails = function(network) {
   return {
      get: function(data_id) {
            var config = {
                retries: 3, // Try to fetch data 3 times.
                backOffFactor: 505, // Wait 505 miliseconds between requests.
                store: true, // Store the returned data.
                storeExpiration: undefined // Store in localstorage or fallback storage.
                withCredentials: true // Will send cookies or other credentials with the request to the server
                responseType: 'blob' // Will process the reponse as a blob object.
            };
         return network.get_promise('api/data/' + data_id, {}, config);
      },
   };
}

And using the module

Network.registerModule('details', moduleDetails);

var response = await Network.posts.get(1);
console.log(response.data); // prints the response data
console.log(response.status); // prints the response status code

Headers

Supported headers values are String, Array, Function, and undefined.

Global Headers
var NetworkClient = require("network-client");
var Network = new NetworkClient();

// Cache headers
Network.addRequestHeader("Content-Type", "application/json");
Network.addRequestHeader("Pragma", "no-cache");
Network.addRequestHeader("Expires", "0");

// Array headers
Network.addRequestHeader("Cache-control", ["no-cache", "no-store"]);

// function headers
var tokenElement = document.getElementsByName("csrfmiddlewaretoken")
if(tokenElement && tokenElement.length > 0) {
    var checkCsrfHeader = function(method, url, data, contentType) {
        if(!(/^(GET|HEAD|OPTIONS|TRACE)$/.test(method))) {
            return tokenElement[0].value;
        }
        return; // Don't return anything will skip this header
    }
    Network.addRequestHeader("X-CSRFToken", checkCsrfHeader);
}

...

// undefined headers will remove `some-header` from the request
Network.removeRequestHeader("some-header");
Request Headers
Network.post('/some/url', {}, {'Content-Type': undefined}, successCallback,);
var exampleModule = function(network) {
   return { 
        get_x: function() { 
            // Will set headers for this specfic request
            var x_headers = {'Expires': 'Wed, 21 Oct 2015 07:28:00 GMT'};
            return network.get_promise('api/x', {}, {headers:x_headers}); 
        }
        get_y: function() { 
            // Will delete the 'Content-Type' header for this epcific request
            var y_headers = {'Content-Type': undefined};
            return network.get_promise('api/y', {}, {headers:y_headers});
        }
   };
}

Promise Support

By default, NetwokrClient is using the native Promise object. in cases where native Promise is not available, NetworkClient can be told what is the Promise object.

Network.setPromise(MyPromiseObject);

Network Events

NetworkClient can notify NetworkClient.NetworkListener event listener on API calls such as start, end, error, And when storage is used.

var netowrkListener = new NetworkClient.NetworkListener({
    networkStart: function(method, url, data, options) {
        if(method == NetworkClient.HttpMethod.GET && url.indexOf("/user") > -1) {
            //Show saving user information notifications
        }
    },
    networkEnd: function(method, url, data, options, status) {
    },
    networkError: function(method, url, data, options, status) {
        console.error("Error while calling url: " + url);
        if(method == NetworkClient.HttpMethod.POST &&  url != "../error") {
            NetowrkClient.errors.register(data)
        }
    }    
})
Network.addNetworkListener(networkListener);

...
...

Network.removeNetworkListener(networkListener);

File Upload

var moduleAssets = function(network) {
    return {
        upload: function(inputFile, Settingsuccess, error) {
            var fd = new FormData();
            fd.append('file', inputFile);
            // By removing the 'Content-Type' header.
            // The browser will generate the correct value `multipart/form-data; boundary=----WebKitFormBoundaryrjNI4ttyPd2AVBfI` 
            var uploadConfig = {headers: {'Content-Type': undefined}};
            network.post('api/user/photo', fd, uploadConfig, success, error);
        }
   };
}
Network.registerModule('assets', moduleAssets);

// React change event
function onFileInputChange(e) {
	Network.assets.upload(inputFile.current.files[0], 
						  function() {...}, 
						  function() {...});
}
// React JSX
<input type='file' id='file' ref={inputFile} style={{display: 'none'}} accept="image/*" onChange={onFileInputChange}/>

Thank You For Reading !.

You Are a Star.

(If you like this project please star it)

Readme

Keywords

Package Sidebar

Install

npm i network-client

Weekly Downloads

15

Version

1.1.8

License

MIT

Unpacked Size

64.8 kB

Total Files

19

Last publish

Collaborators

  • shacoshe