studiokit-scaffolding-js 4.5.0 → 4.5.1

package/lib/components/HOC/SearchPersistorComponent.d.ts

@@ -1,17 +1,13 @@
-import React, { ComponentClass, ComponentType } from 'react';
+import { ComponentClass, ComponentType } from 'react';
 import { Dispatch } from 'redux';
 import { BaseReduxState, Search } from '../../types';
-export interface SearchPersistorProps {
-    persistSearch: (search?: Search) => void;
-    persistedSearch: Search;
+export interface SearchPersistorProps<T extends Search = Search> {
+    persistSearch: (search?: T) => void;
+    persistedSearch: T;
 }
-interface SearchPersistorState {
-    search: Search | undefined;
-    defaultSearch: Search | undefined;
-}
-export interface SearchPersistorMethods {
-    setSearchDefaults: (doSearch: () => void, search: Search) => void;
-    updateAndPersistSearch: (search?: Search, callback?: () => void) => void;
+export interface SearchPersistorMethods<T extends Search = Search> {
+    setSearchDefaults: (doSearch: () => void, search: T) => void;
+    updateAndPersistSearch: (search?: Search | T, callback?: () => void) => void;
     handleSearchClick: () => void;
     handleChangeTab: (selectedTab: number) => void;
     handleKeywordsChange: (event: any) => void;
@@ -19,48 +15,13 @@ export interface SearchPersistorMethods {
     handleQueryAllChange: (event: any) => void;
     resetSearch: () => void;
 }
-export interface SearchPersistorWrappedProps extends SearchPersistorProps, SearchPersistorMethods {
-    search?: Search;
+export interface SearchPersistorWrappedProps<T extends Search = Search> extends SearchPersistorProps<T>, SearchPersistorMethods<T> {
+    search?: T;
 }
-export declare function configureSearchPersistorComponent<TOwnProps extends {}>(WrappedComponent: ComponentType<TOwnProps & SearchPersistorWrappedProps>): {
-    new (props: TOwnProps & SearchPersistorProps): {
-        doSearch: () => void;
-        componentDidMount(): void;
-        setSearchDefaults: (doSearch: () => void, search: Search) => void;
-        updateAndPersistSearch: (search?: Search | undefined, callback?: (() => void) | undefined) => void;
-        handleSearchClick: () => void;
-        handleChangeTab: (selectedTab: number) => void;
-        handleKeywordsChange: (event: any) => void;
-        handleKeywordsKeyDown: (event: any) => void;
-        handleQueryAllChange: (event: any) => void;
-        resetSearch: () => void;
-        render(): JSX.Element;
-        context: any;
-        setState<K extends "search" | "defaultSearch">(state: SearchPersistorState | ((prevState: Readonly<SearchPersistorState>, props: Readonly<TOwnProps & SearchPersistorProps>) => SearchPersistorState | Pick<SearchPersistorState, K> | null) | Pick<SearchPersistorState, K> | null, callback?: (() => void) | undefined): void;
-        forceUpdate(callback?: (() => void) | undefined): void;
-        readonly props: Readonly<TOwnProps & SearchPersistorProps> & Readonly<{
-            children?: React.ReactNode;
-        }>;
-        state: Readonly<SearchPersistorState>;
-        refs: {
-            [key: string]: React.ReactInstance;
-        };
-        shouldComponentUpdate?(nextProps: Readonly<TOwnProps & SearchPersistorProps>, nextState: Readonly<SearchPersistorState>, nextContext: any): boolean;
-        componentWillUnmount?(): void;
-        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
-        getSnapshotBeforeUpdate?(prevProps: Readonly<TOwnProps & SearchPersistorProps>, prevState: Readonly<SearchPersistorState>): any;
-        componentDidUpdate?(prevProps: Readonly<TOwnProps & SearchPersistorProps>, prevState: Readonly<SearchPersistorState>, snapshot?: any): void;
-        componentWillMount?(): void;
-        UNSAFE_componentWillMount?(): void;
-        componentWillReceiveProps?(nextProps: Readonly<TOwnProps & SearchPersistorProps>, nextContext: any): void;
-        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<TOwnProps & SearchPersistorProps>, nextContext: any): void;
-        componentWillUpdate?(nextProps: Readonly<TOwnProps & SearchPersistorProps>, nextState: Readonly<SearchPersistorState>, nextContext: any): void;
-        UNSAFE_componentWillUpdate?(nextProps: Readonly<TOwnProps & SearchPersistorProps>, nextState: Readonly<SearchPersistorState>, nextContext: any): void;
-    };
-    contextType?: React.Context<any> | undefined;
-};
-export declare const configureMapStateToProps: (key: string) => (state: BaseReduxState) => SearchPersistorProps;
-export declare const configureMapDispatchToProps: (key: string) => (dispatch: Dispatch) => SearchPersistorProps;
+export declare function configureSearchPersistorComponent<TOwnProps extends {}>(WrappedComponent: ComponentType<TOwnProps & SearchPersistorWrappedProps>): ComponentType<TOwnProps & SearchPersistorProps>;
+export declare function configureSearchPersistorComponent<TOwnProps extends {}, TSearchType extends Search>(WrappedComponent: ComponentType<TOwnProps & SearchPersistorWrappedProps<TSearchType>>): ComponentType<TOwnProps & SearchPersistorProps<TSearchType>>;
+export declare const configureMapStateToProps: <TSearchType extends Search>(key: string) => (state: BaseReduxState) => SearchPersistorProps<TSearchType>;
+export declare const configureMapDispatchToProps: <TSearchType extends Search>(key: string) => (dispatch: Dispatch) => SearchPersistorProps<TSearchType>;
 /**
  * HOC to handle persistence and restoration of "Manage" components search parameters.
  * Note: if you store a search date in a child component, make sure it’s called `date`.
@@ -82,4 +43,24 @@ export declare const configureMapDispatchToProps: (key: string) => (dispatch: Di
  * @returns The wrapped component, passing down `search` and `persistSearch` as props
  */
 export default function searchPersistorComponent<TOwnProps extends SearchPersistorWrappedProps>(WrappedComponent: ComponentType<TOwnProps>, key: string): ComponentClass<Omit<TOwnProps, keyof SearchPersistorWrappedProps>>;
-export {};
+/**
+ * HOC to handle persistence and restoration of "Manage" components search parameters.
+ * Note: if you store a search date in a child component, make sure it’s called `date`.
+ * Rehydration of dates doesn’t work as expected out of the box with redux-persist.
+ * Something more generic might be in order in the future.
+ *
+ * Note: this also uses the `configureX` pattern of declaration for testability.
+ *
+ * API for child components:
+ *  - Call `setSearchDefaults(this.doSearch, this.getDefaultSearch())` in child’s `componentDidMount`
+ *  - Implement `getDefaultSearch`
+ *  - Call this HOC’s handlers as needed
+ *  - Implement any additional child-specific handlers and call this HOC’s `updateAndPersistSearch` in them
+ *  - Make sure your `doSearch` and `render` handle undefined search props
+ *  - Avoid intoxicating substances and wash your hands regularly
+ *
+ * @param WrappedComponent The component to wrap
+ * @param key The key under "search" in redux where the component’s search params will be stored
+ * @returns The wrapped component, passing down `search` and `persistSearch` as props
+ */
+export default function searchPersistorComponent<TOwnProps extends SearchPersistorWrappedProps<TSearchType>, TSearchType extends Search>(WrappedComponent: ComponentType<TOwnProps>, key: string): ComponentClass<Omit<TOwnProps, keyof SearchPersistorWrappedProps<TSearchType>>>;

package/lib/components/HOC/SearchPersistorComponent.js

@@ -168,26 +168,6 @@ var configureMapDispatchToProps = function (key) { return function (dispatch) {
     };
 }; };
 exports.configureMapDispatchToProps = configureMapDispatchToProps;
-/**
- * HOC to handle persistence and restoration of "Manage" components search parameters.
- * Note: if you store a search date in a child component, make sure it’s called `date`.
- * Rehydration of dates doesn’t work as expected out of the box with redux-persist.
- * Something more generic might be in order in the future.
- *
- * Note: this also uses the `configureX` pattern of declaration for testability.
- *
- * API for child components:
- *  - Call `setSearchDefaults(this.doSearch, this.getDefaultSearch())` in child’s `componentDidMount`
- *  - Implement `getDefaultSearch`
- *  - Call this HOC’s handlers as needed
- *  - Implement any additional child-specific handlers and call this HOC’s `updateAndPersistSearch` in them
- *  - Make sure your `doSearch` and `render` handle undefined search props
- *  - Avoid intoxicating substances and wash your hands regularly
- *
- * @param WrappedComponent The component to wrap
- * @param key The key under "search" in redux where the component’s search params will be stored
- * @returns The wrapped component, passing down `search` and `persistSearch` as props
- */
 function searchPersistorComponent(WrappedComponent, key) {
     var SearchPersistorComponent = configureSearchPersistorComponent(WrappedComponent);
     var mapStateToProps = exports.configureMapStateToProps(key);

package/lib/redux/reducers/searchReducer.js

@@ -1,9 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var lodash_1 = __importDefault(require("lodash"));
+var lodash_1 = require("lodash");
 var actions_1 = require("../actions");
 /**
  * Store the state of a manage component's search parameters so the params can be
@@ -18,7 +15,7 @@ function searchReducer(state, action) {
     if (state === void 0) { state = {}; }
     switch (action.type) {
         case actions_1.ACTION.PERSIST_SEARCH:
-            return lodash_1.default.merge({}, state, action.data);
+            return lodash_1.mergeWith({}, state, action.data, function (target, source) { return (lodash_1.isArray(source) ? source : undefined); });
         default:
             return state;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "studiokit-scaffolding-js",
-	"version": "4.5.0",
+	"version": "4.5.1",
 	"description": "Common scaffolding for Studio apps at Purdue",
 	"repository": "https://gitlab.com/purdue-informatics/studiokit/studiokit-scaffolding-js",
 	"license": "MIT",