studiokit-scaffolding-js 4.3.20 → 4.3.21

package/lib/components/HOC/AccessibleAppComponent.js

@@ -1,135 +1,135 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setupAccessibleComponent = void 0;
-var react_1 = __importStar(require("react"));
-var react_router_dom_1 = require("react-router-dom");
-var configuration_1 = require("../../constants/configuration");
-var documentService_1 = __importDefault(require("../../services/documentService"));
-function setupAccessibleComponent(WrappedComponent) {
-    return /** @class */ (function (_super) {
-        __extends(AccessibleComponent, _super);
-        function AccessibleComponent(props) {
-            var _this = _super.call(this, props) || this;
-            _this.resetFocusIgnorePatterns = [
-                /\/help\/scoring-docs(\/.+)?$/,
-                /\/courses\/\d+\/groupAssignments\/\d+\/scores(\/.+)?$/
-            ];
-            _this.onTitleChange = function (mutations) {
-                var appName = configuration_1.getAppConfig().APP_NAME;
-                // Only change the title when we have more than the default appName added to it.
-                if (!!mutations[0] && !!mutations[0].target.textContent && mutations[0].target.textContent !== appName) {
-                    _this.setState({ title: mutations[0].target.textContent });
-                }
-            };
-            _this.shouldResetFocus = function (oldPath, newPath) {
-                // Path is the same or either parameter is not a path
-                if (!newPath || !oldPath || oldPath === newPath) {
-                    return false;
-                }
-                for (var _i = 0, _a = _this.resetFocusIgnorePatterns; _i < _a.length; _i++) {
-                    var route = _a[_i];
-                    if (route.test(oldPath) && route.test(newPath)) {
-                        // Both paths are sub-paths in the same page
-                        return false;
-                    }
-                }
-                // Paths are different and not in the same page
-                return true;
-            };
-            _this.root = react_1.default.createRef();
-            _this.titleObserver = new MutationObserver(_this.onTitleChange);
-            _this.state = {
-                title: undefined
-            };
-            return _this;
-        }
-        AccessibleComponent.prototype.componentDidMount = function () {
-            var titleElement = document.querySelector('title');
-            if (titleElement) {
-                this.titleObserver.observe(titleElement, {
-                    subtree: true,
-                    characterData: true,
-                    childList: true
-                });
-            }
-        };
-        AccessibleComponent.prototype.componentWillUnmount = function () {
-            this.titleObserver.disconnect();
-        };
-        AccessibleComponent.prototype.componentDidUpdate = function (prevProps) {
-            // Do not reset focus if the new route matches the same router path
-            if (this.shouldResetFocus(prevProps.location.pathname, this.props.location.pathname)) {
-                if (!!this.root && !!this.root.current) {
-                    documentService_1.default.setActiveDocument(this.root.current);
-                }
-            }
-        };
-        AccessibleComponent.prototype.render = function () {
-            var title = this.state.title;
-            return (react_1.default.createElement(react_1.default.Fragment, null,
-                react_1.default.createElement("span", { className: "clip accessible-title", "aria-live": "polite", "aria-atomic": "true" }, title),
-                react_1.default.createElement("div", { className: "outline-0 app-root", ref: this.root, tabIndex: -1 },
-                    react_1.default.createElement(WrappedComponent, __assign({}, this.props)))));
-        };
-        return AccessibleComponent;
-    }(react_1.Component));
-}
-exports.setupAccessibleComponent = setupAccessibleComponent;
-/**
- * Wrap around the main application to add support for resetting focus on page changes
- * and reading title changes to screen reader users
- *
- * @param WrappedComponent - The root of your application UI components
- */
-function accessibleAppComponent(WrappedComponent) {
-    var component = setupAccessibleComponent(WrappedComponent);
-    // @ts-ignore: could not match inferred type from the HOC
-    return react_router_dom_1.withRouter(component);
-}
-exports.default = accessibleAppComponent;
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupAccessibleComponent = void 0;
+var react_1 = __importStar(require("react"));
+var react_router_dom_1 = require("react-router-dom");
+var configuration_1 = require("../../constants/configuration");
+var documentService_1 = __importDefault(require("../../services/documentService"));
+function setupAccessibleComponent(WrappedComponent) {
+    return /** @class */ (function (_super) {
+        __extends(AccessibleComponent, _super);
+        function AccessibleComponent(props) {
+            var _this = _super.call(this, props) || this;
+            _this.resetFocusIgnorePatterns = [
+                /\/help\/scoring-docs(\/.+)?$/,
+                /\/courses\/\d+\/groupAssignments\/\d+\/scores(\/.+)?$/
+            ];
+            _this.onTitleChange = function (mutations) {
+                var appName = configuration_1.getAppConfig().APP_NAME;
+                // Only change the title when we have more than the default appName added to it.
+                if (!!mutations[0] && !!mutations[0].target.textContent && mutations[0].target.textContent !== appName) {
+                    _this.setState({ title: mutations[0].target.textContent });
+                }
+            };
+            _this.shouldResetFocus = function (oldPath, newPath) {
+                // Path is the same or either parameter is not a path
+                if (!newPath || !oldPath || oldPath === newPath) {
+                    return false;
+                }
+                for (var _i = 0, _a = _this.resetFocusIgnorePatterns; _i < _a.length; _i++) {
+                    var route = _a[_i];
+                    if (route.test(oldPath) && route.test(newPath)) {
+                        // Both paths are sub-paths in the same page
+                        return false;
+                    }
+                }
+                // Paths are different and not in the same page
+                return true;
+            };
+            _this.root = react_1.default.createRef();
+            _this.titleObserver = new MutationObserver(_this.onTitleChange);
+            _this.state = {
+                title: undefined
+            };
+            return _this;
+        }
+        AccessibleComponent.prototype.componentDidMount = function () {
+            var titleElement = document.querySelector('title');
+            if (titleElement) {
+                this.titleObserver.observe(titleElement, {
+                    subtree: true,
+                    characterData: true,
+                    childList: true
+                });
+            }
+        };
+        AccessibleComponent.prototype.componentWillUnmount = function () {
+            this.titleObserver.disconnect();
+        };
+        AccessibleComponent.prototype.componentDidUpdate = function (prevProps) {
+            // Do not reset focus if the new route matches the same router path
+            if (this.shouldResetFocus(prevProps.location.pathname, this.props.location.pathname)) {
+                if (!!this.root && !!this.root.current) {
+                    documentService_1.default.setActiveDocument(this.root.current);
+                }
+            }
+        };
+        AccessibleComponent.prototype.render = function () {
+            var title = this.state.title;
+            return (react_1.default.createElement(react_1.default.Fragment, null,
+                react_1.default.createElement("span", { className: "clip accessible-title", "aria-live": "polite", "aria-atomic": "true" }, title),
+                react_1.default.createElement("div", { className: "outline-0 app-root", ref: this.root, tabIndex: -1 },
+                    react_1.default.createElement(WrappedComponent, __assign({}, this.props)))));
+        };
+        return AccessibleComponent;
+    }(react_1.Component));
+}
+exports.setupAccessibleComponent = setupAccessibleComponent;
+/**
+ * Wrap around the main application to add support for resetting focus on page changes
+ * and reading title changes to screen reader users
+ *
+ * @param WrappedComponent - The root of your application UI components
+ */
+function accessibleAppComponent(WrappedComponent) {
+    var component = setupAccessibleComponent(WrappedComponent);
+    // @ts-ignore: could not match inferred type from the HOC
+    return react_router_dom_1.withRouter(component);
+}
+exports.default = accessibleAppComponent;

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

@@ -1,105 +1,105 @@
-import React, { ComponentClass, ComponentType } from 'react';
-import { Model } from 'studiokit-net-js';
-import { BaseReduxState, OptionalRecord } from '../../types';
-import { ActivityOptions } from '../../utils/baseActivity';
-export interface ActivityRequiredStateProps {
-    hasAccess: boolean;
-}
-export declare const configureActivityRequiredComponent: <TOwnProps extends {}>(WrappedComponent: React.ComponentType<TOwnProps>) => {
-    new (props: (TOwnProps & ActivityRequiredStateProps) | Readonly<TOwnProps & ActivityRequiredStateProps>): {
-        render(): JSX.Element;
-        context: any;
-        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<TOwnProps & ActivityRequiredStateProps>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
-        forceUpdate(callback?: (() => void) | undefined): void;
-        readonly props: Readonly<TOwnProps & ActivityRequiredStateProps> & Readonly<{
-            children?: React.ReactNode;
-        }>;
-        state: Readonly<{}>;
-        refs: {
-            [key: string]: React.ReactInstance;
-        };
-        componentDidMount?(): void;
-        shouldComponentUpdate?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextState: Readonly<{}>, nextContext: any): boolean;
-        componentWillUnmount?(): void;
-        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
-        getSnapshotBeforeUpdate?(prevProps: Readonly<TOwnProps & ActivityRequiredStateProps>, prevState: Readonly<{}>): any;
-        componentDidUpdate?(prevProps: Readonly<TOwnProps & ActivityRequiredStateProps>, prevState: Readonly<{}>, snapshot?: any): void;
-        componentWillMount?(): void;
-        UNSAFE_componentWillMount?(): void;
-        componentWillReceiveProps?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextContext: any): void;
-        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextContext: any): void;
-        componentWillUpdate?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextState: Readonly<{}>, nextContext: any): void;
-        UNSAFE_componentWillUpdate?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextState: Readonly<{}>, nextContext: any): void;
-    };
-    new (props: TOwnProps & ActivityRequiredStateProps, context: any): {
-        render(): JSX.Element;
-        context: any;
-        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<TOwnProps & ActivityRequiredStateProps>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
-        forceUpdate(callback?: (() => void) | undefined): void;
-        readonly props: Readonly<TOwnProps & ActivityRequiredStateProps> & Readonly<{
-            children?: React.ReactNode;
-        }>;
-        state: Readonly<{}>;
-        refs: {
-            [key: string]: React.ReactInstance;
-        };
-        componentDidMount?(): void;
-        shouldComponentUpdate?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextState: Readonly<{}>, nextContext: any): boolean;
-        componentWillUnmount?(): void;
-        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
-        getSnapshotBeforeUpdate?(prevProps: Readonly<TOwnProps & ActivityRequiredStateProps>, prevState: Readonly<{}>): any;
-        componentDidUpdate?(prevProps: Readonly<TOwnProps & ActivityRequiredStateProps>, prevState: Readonly<{}>, snapshot?: any): void;
-        componentWillMount?(): void;
-        UNSAFE_componentWillMount?(): void;
-        componentWillReceiveProps?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextContext: any): void;
-        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextContext: any): void;
-        componentWillUpdate?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextState: Readonly<{}>, nextContext: any): void;
-        UNSAFE_componentWillUpdate?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextState: Readonly<{}>, nextContext: any): void;
-    };
-    contextType?: React.Context<any> | undefined;
-};
-/**
- * Return `mapStateToProps` function. Add a `hasAccess` boolean property to the component's props
- * checking whether the user has the passed `requiredActivity`
- *
- * @param {function} accessPredicate A predicate accepting a required activity and an optional entity and/or
- * 		userInfo object
- * @param {string} requiredActivity The required activity which is passed to the predicate for evaluation
- * @param {string} modelsProperty The property used to locate the entity or entities needed for entity-level
- * activity grants
- */
-export declare const configureMapStateToProps: <TOwnProps extends {}>(accessPredicate: (requiredActivity: string, options: ActivityOptions) => boolean, requiredActivity: string, modelsProperty?: string | undefined) => (state: BaseReduxState, ownProps?: TOwnProps | undefined) => ActivityRequiredStateProps;
-/**
- * This HOC ensures that the wrapped component is only rendered if the predicate provided is satisfied.
- *
- * Typically this component is used by passing one of the functions in utils/activities as the
- * `accessPredicate` and a constant from "constants/activities" as the `requiredActivity`.
- *
- * If a lambda is passed as the predicate, it is passed (but may or may not opt to utilize) the `requiredActivity`
- * parameter. It can be ignored if not needed by the lambda.
- *
- * @param {Component} WrappedComponent The component which requires activity/activities in order to render
- * @param {function} accessPredicate A predicate accepting a required activity and an optional entity and/or
- * 		userInfo object
- * @param {string} requiredActivity The required activity which is passed to the predicate for evaluation
- *
- */
-export default function activityRequiredComponent<TOwnProps extends {}>(WrappedComponent: ComponentType<TOwnProps>, accessPredicate: (requiredActivity: string, options: any) => boolean, requiredActivity: string): ComponentClass<TOwnProps>;
-/**
- * This HOC ensures that the wrapped component is rendered iff the predicate provided is satisfied.
- *
- * Typically this component is used by passing one of the functions in utils/activities as the
- * `accessPredicate` and a constant from "constants/activities" as the `requiredActivity`.
- *
- * If a lambda is passed as the predicate, it is passed (but may or may not opt to utilize) the `requiredActivity`
- * and `modelsProperty` parameters. They can be ignored if not needed by the lambda.
- *
- * @param {Component} WrappedComponent The component which requires activity/activities in order to render
- * @param {function} accessPredicate A predicate accepting a required activity and an optional entity and/or
- * 		userInfo object
- * @param {string} requiredActivity The required activity which is passed to the predicate for evaluation
- * @param {string} modelsProperty The property used to locate the entity or entities needed for entity-level
- * activity grants
- *
- */
-export default function activityRequiredComponent<TOwnProps extends {}, TPropName extends string>(WrappedComponent: ComponentType<TOwnProps>, accessPredicate: (requiredActivity: string, options: any) => boolean, requiredActivity: string, modelsProperty: TPropName): ComponentClass<TOwnProps & OptionalRecord<TPropName, Model>>;
+import React, { ComponentClass, ComponentType } from 'react';
+import { Model } from 'studiokit-net-js';
+import { BaseReduxState, OptionalRecord } from '../../types';
+import { ActivityOptions } from '../../utils/baseActivity';
+export interface ActivityRequiredStateProps {
+    hasAccess: boolean;
+}
+export declare const configureActivityRequiredComponent: <TOwnProps extends {}>(WrappedComponent: React.ComponentType<TOwnProps>) => {
+    new (props: (TOwnProps & ActivityRequiredStateProps) | Readonly<TOwnProps & ActivityRequiredStateProps>): {
+        render(): JSX.Element;
+        context: any;
+        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<TOwnProps & ActivityRequiredStateProps>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<TOwnProps & ActivityRequiredStateProps> & Readonly<{
+            children?: React.ReactNode;
+        }>;
+        state: Readonly<{}>;
+        refs: {
+            [key: string]: React.ReactInstance;
+        };
+        componentDidMount?(): void;
+        shouldComponentUpdate?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextState: Readonly<{}>, nextContext: any): boolean;
+        componentWillUnmount?(): void;
+        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<TOwnProps & ActivityRequiredStateProps>, prevState: Readonly<{}>): any;
+        componentDidUpdate?(prevProps: Readonly<TOwnProps & ActivityRequiredStateProps>, prevState: Readonly<{}>, snapshot?: any): void;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextState: Readonly<{}>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextState: Readonly<{}>, nextContext: any): void;
+    };
+    new (props: TOwnProps & ActivityRequiredStateProps, context: any): {
+        render(): JSX.Element;
+        context: any;
+        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<TOwnProps & ActivityRequiredStateProps>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<TOwnProps & ActivityRequiredStateProps> & Readonly<{
+            children?: React.ReactNode;
+        }>;
+        state: Readonly<{}>;
+        refs: {
+            [key: string]: React.ReactInstance;
+        };
+        componentDidMount?(): void;
+        shouldComponentUpdate?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextState: Readonly<{}>, nextContext: any): boolean;
+        componentWillUnmount?(): void;
+        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<TOwnProps & ActivityRequiredStateProps>, prevState: Readonly<{}>): any;
+        componentDidUpdate?(prevProps: Readonly<TOwnProps & ActivityRequiredStateProps>, prevState: Readonly<{}>, snapshot?: any): void;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextState: Readonly<{}>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<TOwnProps & ActivityRequiredStateProps>, nextState: Readonly<{}>, nextContext: any): void;
+    };
+    contextType?: React.Context<any> | undefined;
+};
+/**
+ * Return `mapStateToProps` function. Add a `hasAccess` boolean property to the component's props
+ * checking whether the user has the passed `requiredActivity`
+ *
+ * @param {function} accessPredicate A predicate accepting a required activity and an optional entity and/or
+ * 		userInfo object
+ * @param {string} requiredActivity The required activity which is passed to the predicate for evaluation
+ * @param {string} modelsProperty The property used to locate the entity or entities needed for entity-level
+ * activity grants
+ */
+export declare const configureMapStateToProps: <TOwnProps extends {}>(accessPredicate: (requiredActivity: string, options: ActivityOptions) => boolean, requiredActivity: string, modelsProperty?: string | undefined) => (state: BaseReduxState, ownProps?: TOwnProps | undefined) => ActivityRequiredStateProps;
+/**
+ * This HOC ensures that the wrapped component is only rendered if the predicate provided is satisfied.
+ *
+ * Typically this component is used by passing one of the functions in utils/activities as the
+ * `accessPredicate` and a constant from "constants/activities" as the `requiredActivity`.
+ *
+ * If a lambda is passed as the predicate, it is passed (but may or may not opt to utilize) the `requiredActivity`
+ * parameter. It can be ignored if not needed by the lambda.
+ *
+ * @param {Component} WrappedComponent The component which requires activity/activities in order to render
+ * @param {function} accessPredicate A predicate accepting a required activity and an optional entity and/or
+ * 		userInfo object
+ * @param {string} requiredActivity The required activity which is passed to the predicate for evaluation
+ *
+ */
+export default function activityRequiredComponent<TOwnProps extends {}>(WrappedComponent: ComponentType<TOwnProps>, accessPredicate: (requiredActivity: string, options: any) => boolean, requiredActivity: string): ComponentClass<TOwnProps>;
+/**
+ * This HOC ensures that the wrapped component is rendered iff the predicate provided is satisfied.
+ *
+ * Typically this component is used by passing one of the functions in utils/activities as the
+ * `accessPredicate` and a constant from "constants/activities" as the `requiredActivity`.
+ *
+ * If a lambda is passed as the predicate, it is passed (but may or may not opt to utilize) the `requiredActivity`
+ * and `modelsProperty` parameters. They can be ignored if not needed by the lambda.
+ *
+ * @param {Component} WrappedComponent The component which requires activity/activities in order to render
+ * @param {function} accessPredicate A predicate accepting a required activity and an optional entity and/or
+ * 		userInfo object
+ * @param {string} requiredActivity The required activity which is passed to the predicate for evaluation
+ * @param {string} modelsProperty The property used to locate the entity or entities needed for entity-level
+ * activity grants
+ *
+ */
+export default function activityRequiredComponent<TOwnProps extends {}, TPropName extends string>(WrappedComponent: ComponentType<TOwnProps>, accessPredicate: (requiredActivity: string, options: any) => boolean, requiredActivity: string, modelsProperty: TPropName): ComponentClass<TOwnProps & OptionalRecord<TPropName, Model>>;