redux-paginator-immutable 17.0.16 → 17.0.21

package/src/types/{actions.js → actions.ts}

@@ -1,10 +1,8 @@
-// @flow
-
 import type { EndPointCb } from "./index";
 
 export type RequestPageAction = {
-  type : "@@redux-paginator-immutable/REQUEST_PAGE";
-  meta : {
+  type: "@@redux-paginator-immutable/REQUEST_PAGE";
+  meta: {
     endpoint: string;
     endpointCb: EndPointCb;
     manageEntity: any;
@@ -18,10 +16,9 @@ export type RequestPageAction = {
     token: string;
   };
 };
-
 export type ReceivePageAction = {
-  type : "@@redux-paginator-immutable/RECEIVE_PAGE";
-  meta : {
+  type: "@@redux-paginator-immutable/RECEIVE_PAGE";
+  meta: {
     endpoint: string;
     endpointCb: EndPointCb;
     manageEntity: any;
@@ -33,14 +30,13 @@ export type ReceivePageAction = {
     token: string;
     items: Array<any>;
     total: number;
-    error: bool;
+    error: boolean;
     raw?: string;
   };
 };
-
 export type ChangeViewAction = {
-  type : "@@redux-paginator-immutable/CHANGE_VIEW";
-  meta : {
+  type: "@@redux-paginator-immutable/CHANGE_VIEW";
+  meta: {
     endpoint: string;
   };
   payload: {
@@ -48,44 +44,38 @@ export type ChangeViewAction = {
     token: string;
   };
 };
-
 export type ResetViewAction = {
-  type : "@@redux-paginator-immutable/RESET_VIEW";
-  meta : {
+  type: "@@redux-paginator-immutable/RESET_VIEW";
+  meta: {
     endpoint: string;
   };
   payload: {
     token: string;
   };
 };
-
 export type ClearDataAction = {
-  type : "@@redux-paginator-immutable/CLEAR_DATA";
-  meta : {
+  type: "@@redux-paginator-immutable/CLEAR_DATA";
+  meta: {
     endpoint: string;
   };
 };
-
 export type FetchCurrentCompanyInfoPending = {
-  type : "FETCH_CURRENT_COMPANY_INFO_PENDING";
+  type: "FETCH_CURRENT_COMPANY_INFO_PENDING";
 };
-
 export type FetchItemDataPending = {
-  type : "@@redux-paginator-immutable/FETCH_ITEM_DATA_PENDING";
+  type: "@@redux-paginator-immutable/FETCH_ITEM_DATA_PENDING";
   meta: {
     id: string;
-  }
+  };
 };
-
 export type FetchItemDataRejected = {
-  type : "@@redux-paginator-immutable/FETCH_ITEM_DATA_REJECTED";
+  type: "@@redux-paginator-immutable/FETCH_ITEM_DATA_REJECTED";
   meta: {
     id: string;
-  }
+  };
 };
-
 export type FetchItemDataFulFilled = {
-  type : "@@redux-paginator-immutable/FETCH_ITEM_DATA_FULFILLED";
+  type: "@@redux-paginator-immutable/FETCH_ITEM_DATA_FULFILLED";
   payload: {
     Data: any;
   };
@@ -93,15 +83,13 @@ export type FetchItemDataFulFilled = {
     id: string;
   };
 };
-
-export type Action = RequestPageAction
-| ReceivePageAction
-| ResetViewAction
-| ChangeViewAction
-| ClearDataAction
-
-| FetchCurrentCompanyInfoPending
-
-|FetchItemDataPending
-|FetchItemDataRejected
-|FetchItemDataFulFilled;
+export type Action =
+RequestPageAction |
+ReceivePageAction |
+ResetViewAction |
+ChangeViewAction |
+ClearDataAction |
+FetchCurrentCompanyInfoPending |
+FetchItemDataPending |
+FetchItemDataRejected |
+FetchItemDataFulFilled;

package/src/types/{index.js → index.ts}

@@ -1,9 +1,6 @@
-// @flow
 /* eslint-disable no-use-before-define */
-
 export * from "./actions";
 export * from "./state";
-
 import type { State } from "./state";
 import type { Action } from "./actions";
 
@@ -11,28 +8,24 @@ export type GetState = () => State;
 export type PromiseAction = Promise<Action>;
 export type ThunkAction = (dispatch: Dispatch, getState: GetState) => any;
 export type Dispatch = (action: Action | ThunkAction | PromiseAction | Array<Action>) => any;
+export type EndPointCb = ((token?: string) => string) | null;
 
-export type EndPointCb = ((token? : string) => string) | null;
 
 export type PaginatorSettings = {
   key: string;
   manageEntity: any;
   resultsKey: string;
-  dataItemURL: string;
-  normalizeDataItem: any;
-
   // by default "{rowsPerLoad} from x25/utility/others"
   rowsPerLoad?: number;
-
   // by default "(items) => items"
   manipulateItems?: (items: any) => any;
-
   // by default "Total"
   totalKey?: string;
-
-   // by default "page"
+  // by default "page"
   pageArgName?: string;
-
   // default "ID"
   idKey?: string;
-}
+
+  dataItemURL?: string;
+  normalizeDataItem?: any;
+};

package/src/types/{state.js → state.ts}

@@ -1,9 +1,6 @@
-// @flow
-
 export type PagesState = any;
 export type ItemsState = any;
-
 export type State = {
-  +pages: PagesState;
-  +itemsReducer: ItemsState;
-}
+  readonly pages: PagesState;
+  readonly itemsReducer: ItemsState;
+};

package/src/util.ts

@@ -0,0 +1,51 @@
+/* eslint-disable no-duplicate-imports */
+type NormalizrEntity = (data: any) => any;
+
+import type { Map as ImmutableMap } from "immutable";
+import * as Immutable from "immutable";
+import { createSelector } from "reselect";
+
+type ManageDataEntity = ImmutableMap<string, any>;
+
+// simple item
+const
+  manageEntity = (normalizrEntity: NormalizrEntity) => (
+    (item: any, state: any, keyID: string): ManageDataEntity => {
+      // prevent rewrite
+      const old = state.get(String(item[keyID]));
+
+      if (typeof old === "undefined") {
+        return Immutable.Map(normalizrEntity(item));
+      }
+
+      return old;
+    }
+  ),
+  manipulateItems = (sortKey = "ID") => createSelector(
+    (data : any) => data,
+    (data : any) => data.sortBy((current : any) => -current.get(sortKey)),
+  ),
+
+  // data item
+  manageDataEntity = (normalizrEntity: NormalizrEntity) => (
+    (item: any, state: any, keyID: string): ManageDataEntity => {
+      // prevent rewrite
+      const old = state.get(String(item[keyID]));
+
+      if (typeof old === "undefined") {
+        return Immutable.Map({
+          Data: normalizrEntity(item),
+        });
+      }
+
+      return old;
+    }
+  ),
+  manipulateDataItems = (sortKey = "ID") => (
+    createSelector(
+      (data : any) => data,
+      (data : any) => data.sortBy((current : any) => -current.getIn(["Data", sortKey])),
+    )
+  );
+
+export { manageDataEntity, manipulateDataItems, manipulateItems, manageEntity };

package/src/{words.js → words.ts}

@@ -1,5 +1,3 @@
-// @flow
-
 const words = {
   ThereWasAProblem : "There was a problem. Try again",
   Showing          : "Showing",

package/lib/__tests__/actions.spec.js

@@ -1,117 +0,0 @@
-"use strict";
-
-var _expect = require("expect");
-
-var _expect2 = _interopRequireDefault(_expect);
-
-var _fluxStandardAction = require("flux-standard-action");
-
-var _actions = require("../actions");
-
-var _actions2 = _interopRequireDefault(_actions);
-
-var _actionTypes = require("../actionTypes");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-var receivePage = _actions2.default.receivePage,
-    requestPage = _actions2.default.requestPage,
-    resetView = _actions2.default.resetView,
-    changeView = _actions2.default.changeView; /* eslint-disable no-undefined, max-lines-per-function, no-magic-numbers */
-
-describe("actions", function () {
-
-  it("should create receive page action", function () {
-    var action = receivePage({
-      endpoint: "some/api/endpoint/",
-      pageArgName: "p",
-      idKey: "id",
-      page: 2,
-      token: "foo=bar",
-      items: ["foo", "bar", "baz"],
-      total: 42
-    });
-
-    (0, _expect2.default)(action).toEqual({
-      type: _actionTypes.RECEIVE_PAGE,
-      meta: {
-        endpoint: "some/api/endpoint/",
-        pageArgName: "p",
-        idKey: "id"
-      },
-      payload: {
-        token: "foo=bar",
-        page: 2,
-        items: ["foo", "bar", "baz"],
-        total: 42
-      }
-    });
-
-    (0, _expect2.default)((0, _fluxStandardAction.isFSA)(action)).toEqual(true);
-  });
-
-  it("should create request page action", function () {
-    var action = requestPage({
-      endpoint: "some/api/endpoint/",
-      resultsKey: "results",
-      totalKey: "total",
-      pageArgName: "p",
-      idKey: "id",
-      page: 2,
-      token: "foo=bar"
-    });
-
-    (0, _expect2.default)(action).toEqual({
-      type: _actionTypes.REQUEST_PAGE,
-      meta: {
-        endpoint: "some/api/endpoint/",
-        resultsKey: "results",
-        totalKey: "total",
-        pageArgName: "p",
-        idKey: "id"
-      },
-      payload: {
-        token: "foo=bar",
-        page: 2
-      }
-    });
-
-    (0, _expect2.default)((0, _fluxStandardAction.isFSA)(action)).toEqual(true);
-  });
-
-  it("should create reset view action", function () {
-    var action = resetView("some/api/endpoint/", "name");
-
-    (0, _expect2.default)(action).toEqual({
-      type: _actionTypes.RESET_VIEW,
-      meta: {
-        endpoint: "some/api/endpoint/"
-      },
-      payload: {
-        token: "name"
-      }
-    });
-
-    (0, _expect2.default)((0, _fluxStandardAction.isFSA)(action)).toEqual(true);
-  });
-
-  it("should create change view action", function () {
-    var action = changeView("some/api/endpoint/", {
-      token: "name",
-      view: 2
-    });
-
-    (0, _expect2.default)(action).toEqual({
-      type: _actionTypes.CHANGE_VIEW,
-      meta: {
-        endpoint: "some/api/endpoint/"
-      },
-      payload: {
-        view: 2,
-        token: "name"
-      }
-    });
-
-    (0, _expect2.default)((0, _fluxStandardAction.isFSA)(action)).toEqual(true);
-  });
-});

package/lib/__tests__/agent.spec.js

@@ -1,32 +0,0 @@
-"use strict";
-
-var _expect = require("expect");
-
-var _expect2 = _interopRequireDefault(_expect);
-
-var _agent = require("../agent");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-describe("buildSuffix", function () {
-
-  it("should correctly build the url suffix when simple params are provided", function () {
-    (0, _expect2.default)((0, _agent.buildSuffix)("p", 1, "foo=bar")).toEqual("?foo=bar&p=1");
-  });
-
-  it("should correctly build the url suffix when less simple params are provided", function () {
-    (0, _expect2.default)((0, _agent.buildSuffix)("p", 1, "foo=bar&baz=foo")).toEqual("?baz=foo&foo=bar&p=1");
-  });
-
-  it("should correctly build the url suffix when params contains no extractable query params", function () {
-    (0, _expect2.default)((0, _agent.buildSuffix)("p", 1, "foo/bar")).toEqual("foo/bar?p=1");
-  });
-
-  it('should correctly build the url suffix when "params" is not provided', function () {
-    (0, _expect2.default)((0, _agent.buildSuffix)("p", 1, "")).toEqual("?p=1");
-  });
-
-  it("should correctly build the url suffix when complex params are provided", function () {
-    (0, _expect2.default)((0, _agent.buildSuffix)("p", 1, "foo/bar?bar=biz&baz=foo")).toEqual("foo/bar?baz=foo&bar=biz&p=1");
-  });
-});

package/lib/__tests__/createPaginator.spec.js

@@ -1,39 +0,0 @@
-"use strict";
-
-var _expect = require("expect");
-
-var _expect2 = _interopRequireDefault(_expect);
-
-var _actions = require("../actions");
-
-var _actions2 = _interopRequireDefault(_actions);
-
-var _createPaginator = require("../createPaginator");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-var requestPage = _actions2.default.requestPage; /* eslint-disable max-len, no-undefined, no-magic-numbers */
-
-describe("createPaginator", function () {
-
-  it("should create correct request action creator", function () {
-    var paginator = (0, _createPaginator.createPaginator)("some/api/endpoint", {
-      pageArgName: "p",
-      idKey: "id_field",
-      resultsKey: "results",
-      totalKey: "count"
-    });
-    var action = paginator.requestPage(42, "foo=bar");
-
-    (0, _expect2.default)(action).toEqual(requestPage({
-      endpoint: "some/api/endpoint",
-      endpointCb: null,
-      resultsKey: "results",
-      totalKey: "count",
-      pageArgName: "p",
-      idKey: "id_field",
-      page: 42,
-      token: "foo=bar"
-    }));
-  });
-});

package/lib/__tests__/reducers.spec.js

@@ -1,126 +0,0 @@
-"use strict";
-
-var _immutable = require("immutable");
-
-var Immutable = _interopRequireWildcard(_immutable);
-
-var _chai = require("chai");
-
-var _chai2 = _interopRequireDefault(_chai);
-
-var _chaiImmutable = require("chai-immutable");
-
-var _chaiImmutable2 = _interopRequireDefault(_chaiImmutable);
-
-var _actions = require("../actions");
-
-var _actions2 = _interopRequireDefault(_actions);
-
-var _reducers = require("../reducers");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) newObj[key] = obj[key]; } } newObj.default = obj; return newObj; } }
-
-_chai2.default.use(_chaiImmutable2.default); /* eslint-disable max-len, no-undefined, max-lines-per-function */
-
-var requestPage = _actions2.default.requestPage,
-    receivePage = _actions2.default.receivePage;
-
-
-var requestPageAction = requestPage({
-  endpoint: "some/api/endpoint",
-  resultsKey: "results",
-  totalKey: "total",
-  pageArgName: "p",
-  idKey: "id",
-  page: 2,
-  token: "foo=bar"
-});
-
-var receivePageAction = receivePage({
-  endpoint: "some/api/endpoint/",
-  pageArgName: "p",
-  idKey: "id",
-  page: 2,
-  token: "foo=bar",
-  items: [{
-    id: "baz",
-    fooField: "bazValue"
-  }, {
-    id: "bar",
-    fooField: "barValue"
-  }],
-  total: 2
-});
-
-describe("pages reducer", function () {
-
-  it("should return the state by default", function () {
-    var state = (0, _reducers.pages)(Immutable.Map({
-      some: "state"
-    }), { type: "some action" });
-
-    (0, _chai.expect)(state).to.equal(Immutable.Map({
-      some: "state"
-    }));
-  });
-
-  it("should initialize the pages map with a new page entry when requesting new page", function () {
-    var state = (0, _reducers.pages)(undefined, requestPageAction);
-
-    (0, _chai.expect)(state).to.equal(Immutable.Map({
-      "foo=bar": Immutable.Map({
-        page: 2,
-        token: "foo=bar",
-        ids: Immutable.List(),
-        fetching: true,
-        error: false,
-        view: 1,
-        fetched: false
-      })
-    }));
-  });
-
-  it("should populate the pages map at the page url key with the item ids", function () {
-    var state = (0, _reducers.pages)(Immutable.Map({
-      "foo=bar": Immutable.Map({
-        page: 2,
-        token: "foo=bar",
-        ids: Immutable.List(),
-        fetching: true,
-        fetched: false
-      })
-    }), receivePageAction);
-
-    (0, _chai.expect)(state).to.equal(Immutable.Map({
-      "foo=bar": Immutable.Map({
-        page: 2,
-        token: "foo=bar",
-        ids: Immutable.List(["baz", "bar"]),
-        fetching: false,
-        fetched: true,
-        error: false,
-        total: 2
-      })
-    }));
-  });
-});
-
-describe("items reducer", function () {
-
-  it("should populate the items map with item received", function () {
-    var state = (0, _reducers.items)(undefined, receivePageAction);
-
-    (0, _chai.expect)(state).to.equal(Immutable.Map({
-      "baz": Immutable.Map({
-        id: "baz",
-        fooField: "bazValue"
-      }),
-      "bar": Immutable.Map({
-        id: "bar",
-        fooField: "barValue"
-      })
-    }));
-  });
-});