@drieam/common

@drieam/common

This package include some utilities used by Drieam LTI apps.

Table of Contents

• Getting Started
  • Installation
  • Usage
• Components
  • setStore(...) => Store
  • Options

Getting Started

Installation

Install the @drieam/common and its dependencies.

yarn add @drieam/common @drieam/api @drieam/models @drieam/ui

Usage

import { connectActions, connectReducers } from "@drieam/api";
import { User } from "../models";
import { setStore } from "@drieam/common";

type API = {
  user: User
};

type Store = RootReducer<{
  api: ConnectReducers<API>
}>;

const api: ApiRoutes<API> = {
  user: {
    onError,
    path: "/lti/proxy/api/v1/users/:id?",
    mapper: User,
    list: true
  }
};

const actions = connectActions < API > api;
const rootReducer = connectReducers < API > api;
const store = setStore(
  api,
  rootReducer,
  [
    /** EMPTY MIDDLEWARES **/
  ],
  defaultOptions
)({
  /* EMPTY INITIAL STATE */
});

Read the full API Documentation

Components

• ApiTable
• ApiSelect
• Loading
• ApiWrapper

setStore(...) => Store

Create a redux store.

• Arguments:
  1. api (ReactRoutes): Rest API configuration.
  2. rootReducer (Reducer): Root combined reducers.
  3. extraMiddlewares (Middleware[]): Array of redux middlewares.
  4. options (object): Configuration options.

import { setStore } from '@drieam/common';
...

type Store = RootReducer<{
  api: ConnectReducers<API>;
}>;
...
const store = setStore(
  api,
  rootReducer,
  [/** EMPTY MIDDLEWARES **/],
  defaultOptions,
)({
  /* EMPTY INITIAL STATE */
});

• Return Store: The redux store.

Options

General settings of an action as an extension of api actions.

{
  withErrorHandler: true,
  csrfToken: getCSRFToken(),
  history: createBrowserHistory(),
  toasts: {
    offline: {
      duration: 0,
      message: 'Not connected.',
    },
    save: { message: 'Saved success.' },
    delete: { message: 'Deleted success.' },
  },
};
}

• Attributes:
  1. withErrorHandler (boolean): Enables ErrorHandlingMiddleware (Default: true). Provides feedback through an Antd Notification on offline, save success or fail action.
  2. toasts (object): Notification settings, you can express which message can be provided by the error handler.
  3. history (object): history is a JavaScript library that lets you easily manage session history anywhere JavaScript runs. (default: require 'history').
  4. csfrToken (string): Cross-site request forgery token. (Default: <meta [name="csrf-token"] />).
  5. Api options