studiokit-scaffolding-js 7.0.5-alpha.2 → 7.0.5-alpha.3.2

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

@@ -1,6 +1,10 @@
 import React, { ComponentType } from 'react';
 import { ConnectedModalWrappedProps } from './ConnectedModalComponent';
 import { GuidComponentWrappedProps } from './GuidComponent';
+/**
+ * The props that are provided to the HOC component directly from the caller, not other wrapping HOCs
+ * NOTE: if more flexibility is needed, add more props from `ReactModal.Props`
+ */
 export interface FullscreenModalOwnProps {
     isOpen?: boolean;
     /**
@@ -10,10 +14,15 @@ export interface FullscreenModalOwnProps {
     closeModal?: () => void;
     contentLabel?: string;
 }
-export interface FullscreenModalWrappedProps {
+/** The props that are provided to the HOC component, either directly or from other wrapping HOCs */
+export declare type FullscreenModalComponentProps = FullscreenModalOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps;
+/** The props that are provided internally from the HOC to the wrapped component. */
+export interface FullscreenModalProvidedWrappedProps {
     /** Function that will close the modal. */
     closeModal: () => void;
 }
+/** All the props that are provided to the wrapped component. All props are passed through. */
+export declare type FullscreenModalWrappedProps = FullscreenModalProvidedWrappedProps & Omit<FullscreenModalOwnProps, keyof 'contentLabel' | 'closeModal'>;
 export interface FullscreenModalState {
     isOpen: boolean;
 }
@@ -25,34 +34,35 @@ export interface FullscreenModalState {
  *
  * @param WrappedComponent The component to wrap.
  */
-export declare function configureFullscreenModalComponent<TOwnProps extends FullscreenModalOwnProps>(WrappedComponent: ComponentType<TOwnProps & FullscreenModalWrappedProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>): {
-    new (props: TOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps): {
+export declare function configureFullscreenModalComponent<TOwnProps extends {}>(WrappedComponent: ComponentType<TOwnProps & FullscreenModalWrappedProps>): {
+    new (props: TOwnProps & FullscreenModalOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps): {
         componentDidMount(): void;
         componentWillUnmount(): void;
-        componentDidUpdate(prevProps: TOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps, prevState: FullscreenModalState): void;
+        componentDidUpdate(prevProps: TOwnProps & FullscreenModalOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps, prevState: FullscreenModalState): void;
         disableScroll: (e: Event) => boolean;
         onOpen: () => void;
         closeModal: () => void;
+        getWrappedProps: () => FullscreenModalWrappedProps;
         render(): React.JSX.Element;
         context: any;
-        setState<K extends "isOpen">(state: FullscreenModalState | ((prevState: Readonly<FullscreenModalState>, props: Readonly<TOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>) => FullscreenModalState | Pick<FullscreenModalState, K> | null) | Pick<FullscreenModalState, K> | null, callback?: (() => void) | undefined): void;
+        setState<K extends "isOpen">(state: FullscreenModalState | ((prevState: Readonly<FullscreenModalState>, props: Readonly<TOwnProps & FullscreenModalOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>) => FullscreenModalState | Pick<FullscreenModalState, K> | null) | Pick<FullscreenModalState, K> | null, callback?: (() => void) | undefined): void;
         forceUpdate(callback?: (() => void) | undefined): void;
-        readonly props: Readonly<TOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps> & Readonly<{
+        readonly props: Readonly<TOwnProps & FullscreenModalOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps> & Readonly<{
             children?: React.ReactNode;
         }>;
         state: Readonly<FullscreenModalState>;
         refs: {
             [key: string]: React.ReactInstance;
         };
-        shouldComponentUpdate?(nextProps: Readonly<TOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>, nextState: Readonly<FullscreenModalState>, nextContext: any): boolean;
+        shouldComponentUpdate?(nextProps: Readonly<TOwnProps & FullscreenModalOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>, nextState: Readonly<FullscreenModalState>, nextContext: any): boolean;
         componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
-        getSnapshotBeforeUpdate?(prevProps: Readonly<TOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>, prevState: Readonly<FullscreenModalState>): any;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<TOwnProps & FullscreenModalOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>, prevState: Readonly<FullscreenModalState>): any;
         componentWillMount?(): void;
         UNSAFE_componentWillMount?(): void;
-        componentWillReceiveProps?(nextProps: Readonly<TOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>, nextContext: any): void;
-        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<TOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>, nextContext: any): void;
-        componentWillUpdate?(nextProps: Readonly<TOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>, nextState: Readonly<FullscreenModalState>, nextContext: any): void;
-        UNSAFE_componentWillUpdate?(nextProps: Readonly<TOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>, nextState: Readonly<FullscreenModalState>, nextContext: any): void;
+        componentWillReceiveProps?(nextProps: Readonly<TOwnProps & FullscreenModalOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<TOwnProps & FullscreenModalOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<TOwnProps & FullscreenModalOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>, nextState: Readonly<FullscreenModalState>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<TOwnProps & FullscreenModalOwnProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>, nextState: Readonly<FullscreenModalState>, nextContext: any): void;
     };
     contextType?: React.Context<any> | undefined;
 };
@@ -70,5 +80,5 @@ export declare function configureFullscreenModalComponent<TOwnProps extends Full
  *
  * @param WrappedComponent The component to wrap.
  */
-export declare function fullscreenModalComponent<TOwnProps extends FullscreenModalOwnProps>(WrappedComponent: ComponentType<TOwnProps & FullscreenModalWrappedProps & ConnectedModalWrappedProps & GuidComponentWrappedProps>): ComponentType<TOwnProps>;
+export declare function fullscreenModalComponent<TOwnProps extends FullscreenModalWrappedProps>(WrappedComponent: ComponentType<TOwnProps>): ComponentType<Omit<TOwnProps, keyof FullscreenModalProvidedWrappedProps>>;
 export default fullscreenModalComponent;

package/lib/components/HOC/FullscreenModalComponent.js

@@ -42,6 +42,17 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -82,6 +93,11 @@ function configureFullscreenModalComponent(WrappedComponent) {
                     isOpen: false
                 });
             };
+            _this.getWrappedProps = function () {
+                var _a = _this.props, contentLabel = _a.contentLabel, isTopOpenFullscreenModal = _a.isTopOpenFullscreenModal, onEntering = _a.onEntering, onExited = _a.onExited, _ = _a.isOpen, closeModal = _a.closeModal, guid = _a.guid, remainingProps = __rest(_a, ["contentLabel", "isTopOpenFullscreenModal", "onEntering", "onExited", "isOpen", "closeModal", "guid"]);
+                var wrappedProps = __assign(__assign({}, remainingProps), { closeModal: _this.closeModal });
+                return wrappedProps;
+            };
             _this.state = {
                 isOpen: props.isOpen === undefined ? true : props.isOpen
             };
@@ -122,7 +138,8 @@ function configureFullscreenModalComponent(WrappedComponent) {
             });
         };
         FullscreenModalComponent.prototype.render = function () {
-            var _a = this.props, contentLabel = _a.contentLabel, isTopOpenFullscreenModal = _a.isTopOpenFullscreenModal;
+            var _a = this.props, contentLabel = _a.contentLabel, isTopOpenFullscreenModal = _a.isTopOpenFullscreenModal, onEntering = _a.onEntering, onExited = _a.onExited, _ = _a.isOpen, closeModal = _a.closeModal, guid = _a.guid, remainingProps = __rest(_a, ["contentLabel", "isTopOpenFullscreenModal", "onEntering", "onExited", "isOpen", "closeModal", "guid"]);
+            var wrappedProps = __assign(__assign({}, remainingProps), { closeModal: this.closeModal });
             var isOpen = this.state.isOpen;
             return (react_1.default.createElement(react_modal_1.default, { isOpen: isOpen, contentLabel: contentLabel, style: {
                     content: {
@@ -147,7 +164,7 @@ function configureFullscreenModalComponent(WrappedComponent) {
                 }, 
                 // hide the rendered portal if this is not the top open fullscreen modal
                 portalClassName: "ReactModalPortal" + (!isTopOpenFullscreenModal ? ' dn' : ''), shouldCloseOnOverlayClick: false },
-                react_1.default.createElement(WrappedComponent, __assign({}, this.props, { closeModal: this.closeModal }))));
+                react_1.default.createElement(WrappedComponent, __assign({}, wrappedProps))));
         };
         return FullscreenModalComponent;
     }(react_1.Component));
@@ -169,6 +186,7 @@ exports.configureFullscreenModalComponent = configureFullscreenModalComponent;
  */
 function fullscreenModalComponent(WrappedComponent) {
     var component = configureFullscreenModalComponent(WrappedComponent);
+    // @ts-ignore: could not match inferred type from the `connect` HOC
     return ConnectedModalComponent_1.connectedModalComponent(component, true);
 }
 exports.fullscreenModalComponent = fullscreenModalComponent;

package/package.json

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