README

EWEA API States

Simplify API calls and state management on top of redux and others.

Installation

Using npm

npm install @codetanzania/ewea-api-states

Using yarn

yarn add @codetanzania/ewea-api-states

Usage

All actions exposed by ewea-api-states are wrapped with dispatch function, so the is no need to dispatch them again just invoke them.

The following is the list of all resources exposed by this library.

AdministrativeArea
agency
event
eventAction
eventFunction
eventGroup
eventType
feature
focalPerson
notificationTemplate
partyRole

For each resource you can get it's exposed actions as follows;

Replace events with the name of the module you want

import { reduxActions } from '@codetanzania/ewea-api-states';
const {
  clearEventFilters,
  clearEventsSort,
  closeEventForm,
  deleteEvent,
  filterEvents,
  getEvents,
  getEvent,
  selectEvent,
  openEventForm,
  paginateEvents,
  postEvent,
  putEvent,
  refreshEvents,
  searchEvents,
  sortEvents,
  loadMoreEvents,
  eventsReport,
} = reduxActions;

Store Structure

The structure of the store for each resource is

const store = {
 events: {
    list: [],
    selected: null,
    page: 1,
    total: 0,
    size: 0,
    pages: 1,
    loading: false,
    posting: false,
    showForm: false,
    schema: null,
    filter: null,
    sort: null,
    hasMore:false,
    q: undefined
  },
  ...
};

StoreProvider

This is a wrapper around react-redux Provider component. You can use it as follows

import { render } from 'react-dom';
import { StoreProvider } from '@codetanzania/ewea-api-states';

// store provider
render(
  <StoreProvider>
    <App />
  </StoreProvider>,
  document.getElementById('root')
);

Connect

This is a wrapper around react-redux connect HOC with little improvement over it. You can use it as follows

import { Connect } from '@codetanzania/ewea-api-states';

// for component
function EventList({ events }){
  return(
    // jsx stuff
  );
}

// connect EventList component to store
export Connect(EventList, {
    events: 'events.list'
});

How to use exposed actions

Some of these actions accepts two callback functions which will be executed on Success and Error scenarios as shown below;

Fetch Data

const { getEvents, getEvent } = reduxActions;

getEvents();

getEvents(eventId);

Create Data

const { postEvent } = reduxActions;

postEvent(event, onSuccess, onError);

If you want to keep filters upon successful update action

postEvent(event, onSuccess, onError, { filters: {} });

Update Data

const { putEvent } = reduxActions;

putEvent(event, onSuccess, onError);

Archive/Delete Data

const { deleteEvent } = reduxActions;

deleteEvent(eventId, onSuccess, onError);

Searching

const { searchEvents } = reduxActions;

searchEvents(searchQueryString);

Filtering

const { filterEvents, clearEventFilters } = reduxActions;

filterEvents({ eventType: eventTypeId }, onSuccess, onError);

// clearing filters
clearEventFilters(onSuccess, onError);

//  keep some filters from being cleared. This won't reset plan field in filter object
clearEventFilters(onSuccess, onError, ['eventType']);

Pagination

const { paginateEvents } = reduxActions;

paginateEvents(pageNumber);

Sorting

const { sortEvents, clearEventsSort } = reduxActions;

sortEvents({ name: 1 }, onSuccess, onError);

// clear sort

clearEventsSort(onSuccess, onError);

Infinity Scroll

const { loadMoreEvents } = reduxActions;

loadMoreEvents();

Get Report

const { getEventsReport } = reduxActions;

getEventsReport();

Note: This library depends on ewea-api-client to work, so in order to specify API URL add .env file on your project root folder and specify your API URL under REACT_APP_EWEA_API_URL=[specify API BASE URL here]

LICENSE

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!