dce-reactkit 3.6.16 → 3.6.17

package/dist/cjs/types/helpers/addDBEditorEndpoints.d.ts

@@ -6,7 +6,7 @@ import express from 'express';
 type DCEMangoCollection = {
     /**
      * Find all items in the collection that match the filter query
-     * @param filterQuery
+     * @param filterQuery query for the filter
      * @returns list of items that match the filter query
      */
     find: (filterQuery: any) => Promise<any[]>;

package/dist/cjs/types/helpers/useForceRender.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Create a function that forces a render of a component. Use this only when
+ *   absolutely necessary
+ * @author Gabe Abrams
+ * @param useReducer the useReducer hook
+ * @returns forceRender function
+ */
+declare const useForceRender: (useReducer: any) => () => void;
+export default useForceRender;

package/dist/esm/types/helpers/addDBEditorEndpoints.d.ts

@@ -6,7 +6,7 @@ import express from 'express';
 type DCEMangoCollection = {
     /**
      * Find all items in the collection that match the filter query
-     * @param filterQuery
+     * @param filterQuery query for the filter
      * @returns list of items that match the filter query
      */
     find: (filterQuery: any) => Promise<any[]>;

package/dist/esm/types/helpers/useForceRender.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Create a function that forces a render of a component. Use this only when
+ *   absolutely necessary
+ * @author Gabe Abrams
+ * @param useReducer the useReducer hook
+ * @returns forceRender function
+ */
+declare const useForceRender: (useReducer: any) => () => void;
+export default useForceRender;

package/dist/index.d.ts

@@ -1293,7 +1293,7 @@ declare const getLocalTimeInfo: (dateOrTimestamp?: Date | number) => {
 type DCEMangoCollection = {
     /**
      * Find all items in the collection that match the filter query
-     * @param filterQuery
+     * @param filterQuery query for the filter
      * @returns list of items that match the filter query
      */
     find: (filterQuery: any) => Promise<any[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "3.6.16",
+  "version": "3.6.17",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/helpers/addDBEditorEndpoints.ts

@@ -15,7 +15,7 @@ import ParamType from '../types/ParamType';
 type DCEMangoCollection = {
   /**
    * Find all items in the collection that match the filter query
-   * @param filterQuery 
+   * @param filterQuery query for the filter
    * @returns list of items that match the filter query
    */
   find: (filterQuery: any) => Promise<any[]>,

package/src/helpers/useForceRender.tsx

@@ -0,0 +1,46 @@
+/* -------- State Definition -------- */
+
+type State = {
+  // The number of times the component has been forced to render
+  renderCount: number,
+};
+
+/* ------------- Reducer ------------ */
+
+/**
+ * Reducer that executes actions
+ * @author Gabe Abrams
+ * @param state current state
+ */
+const reducer = (state: State): State => {
+  return {
+    renderCount: state.renderCount + 1,
+  };
+};
+
+/* -------------- Main -------------- */
+
+/**
+ * Create a function that forces a render of a component. Use this only when
+ *   absolutely necessary
+ * @author Gabe Abrams
+ * @param useReducer the useReducer hook
+ * @returns forceRender function
+ */
+const useForceRender = (useReducer: any) => {
+  // Initial state
+  const initialState: State = {
+    renderCount: 0,
+  };
+
+  // Initialize state
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  const [state, dispatch] = useReducer(reducer, initialState);
+
+  // Create and return the forceRender function
+  return () => {
+    dispatch();
+  };
+};
+
+export default useForceRender;