Requestor-api NPM

Http Generic Type Callback

Installation

$ npm install --save requestor-api

Usage

server

Server response object has to extend the followng models:

On Success

  success:boolean

On Failure

  success: boolean,
  messages: string[]
  errorCode: number

client

Implement OnRequestorCallback

   export default class ButtonComponent extends Vue implements  OnRequestorCallback{...}

Will implements 3 methods

    
    onProgress(requstName?: string): void {
        // progress, by default requestName is empty
    }

    onSuccess<T>(data?: T, requstName?: string, message?: string): void;
    onSuccess<T>(data?: T[], requstName?: string, message?: string): void;
    
    onSuccess(data?: any, requstName?: any, message?: any) {
        // success return object or array
    }
    
    onError(message: string, code: number, requstName?: string): void {
        // error with message and code
    }

Headers

    
    let header: Header = new Header()
    
    header.append("Authorization","Bearer xxx.xxx")
          .append("UserToken","some-token-for-user")
          ....
          .append("More","headers-parameters");

Url Parameters

Query String (over url)

    let qs = new QueryString()
               .append("token", "xxx.xxx.xxx")
               .append("type", "jwt")

will generate url like -> www.some-url.com/?token=xxx.xxx.xxx&type=jwt

Routing Rule (over url)

 let rr = new RoutingRule()
             .append("user")
             .append("xxx.xxx.xxx")

will generate url like -> www.some-url.com/user/xxx.xxx.xxx

Requests

Http Get, Post, Put, Delete

In all requests you shuold call commit

commit<T>(baseUrl: string, apiUrl: string, callback: OnRequestorCallback, requestName?: string): void;

Get

// Without url parameters & no request name
    new HttpGet().commit(baseUrl, apiUrl, requestorCallback);


//  with Header and Query String
    new HttpGet().setHeader(header)
                 .setQueryString(qs)
                 .commit(baseUrl, apiUrl, requestorCallback, name);

// With Routing Parameters & Header
    new HttpGet().setHeader(header)
                 .setRoutingRule(rr)
                 .commit(baseUrl, apiUrl, requestorCallback, name);

Post

//Example for POCO class
    class User{
        userId:number;
        name:string;
        email:string;
    }

    let user = new User();
        user.userId = 1;
        user.name = "jhon doe";
        user.email = "some@email.com";

    new HttpPost().setHeader(header)
                .setBody(user)
                .commit<User>(baseUrl,apiUrl,this,'usersData');

    // With Url Parameters
    new HttpPost().setHeader(header)
                .setQueryString(qs)
                .setBody(user)
                .commit<User>(baseUrl,apiUrl,this,'dataWithBody');

    // Or
    new HttpPost().setHeader(header)
                .setRoutingRule(rr)
                .setBody(user)
                .commit<User>(baseUrl,apiUrl,this,'dataWithBodyAndRR');

Button Login Example based on requestor with Http Post Request

import Vue from 'vue';
import Component from 'vue-class-component';
import { OnRequestorCallback, HttpGet, Header, HttpPost, RoutingRule, QueryString } from 'requestor';


//Create Your POCO class
export class User {
  managingCompanyId: number;
  idNumber: string;
  password: string;
}


@Component({})
export default class LoginButton extends Vue implements OnRequestorCallback {

  private header: Header = new Header();

  constructor() {
    super();
    this.header.append("Authorization", "some-auth");
  }

  //Login event
  onLogin() {

    // Create routeing params
    let rr: RoutingRule = new RoutingRule()
      .append("user")

    // Create your new User
    let user: User = new User();
    user.managingCompanyId = 1;
    user.fname = "mad"
    user.lname = "max"
    user.idNumber = "123";
    user.password = "22445445";

    //Call to http Post request
    new HttpPost()
      .setHeader(this.header)
      .setRoutingRule(rr)
      .setBody(user)
      .commit(baseUrl,api, this, "Valhalla")


  }

  onProgress(requstName?: string | undefined): void {

  }

  onSuccess<User>(data?: User | undefined, requstName?: string | undefined, message?: string | undefined): void;
  onSuccess<User>(data?: User[] | undefined, requstName?: string | undefined, message?: string | undefined): void;
  onSuccess(data?: any, requstName?: any, message?: any) {

    /*
      Return Serilized User Object
    */

  }

  onError(message: string, code: number, requstName?: string | undefined): void {
    /*
      Return error with status code and message as expected format (success/failure) explain above
    */
  }

  onProgressFinished(success: boolean): void {
    
  }

}

Delete // Todo