studiokit-scaffolding-js 4.3.20-next.3.2 → 4.3.21

package/lib/components/HOC/AuthenticatedComponent.js

@@ -1,104 +1,104 @@
-"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 __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;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.configureMapStateToProps = exports.configureAuthenticatedComponent = void 0;
-var react_1 = __importStar(require("react"));
-var react_redux_1 = require("react-redux");
-var react_router_dom_1 = require("react-router-dom");
-var persistenceService_1 = __importStar(require("../../services/persistenceService"));
-var configureAuthenticatedComponent = function (WrappedComponent) {
-    return /** @class */ (function (_super) {
-        __extends(AuthenticatedComponent, _super);
-        function AuthenticatedComponent() {
-            return _super !== null && _super.apply(this, arguments) || this;
-        }
-        AuthenticatedComponent.prototype.isNotAuthenticated = function () {
-            var _a = this.props, isAuthenticating = _a.isAuthenticating, isAuthenticated = _a.isAuthenticated;
-            return !isAuthenticating && !isAuthenticated;
-        };
-        AuthenticatedComponent.prototype.persistReturnUrlIfNeeded = function () {
-            var pathname = this.props.location.pathname;
-            var returnUrl = persistenceService_1.default.getItem(persistenceService_1.returnUrlKey);
-            if (!returnUrl) {
-                void persistenceService_1.default.setItem(persistenceService_1.returnUrlKey, pathname);
-            }
-        };
-        AuthenticatedComponent.prototype.render = function () {
-            var _a = this.props, isAuthenticating = _a.isAuthenticating, isAuthenticated = _a.isAuthenticated, history = _a.history, location = _a.location, match = _a.match, staticContext = _a.staticContext, rest = __rest(_a, ["isAuthenticating", "isAuthenticated", "history", "location", "match", "staticContext"]);
-            if (this.isNotAuthenticated()) {
-                this.persistReturnUrlIfNeeded();
-                return react_1.default.createElement(react_router_dom_1.Redirect, { to: "/login" });
-            }
-            return react_1.default.createElement(WrappedComponent, __assign({}, rest));
-        };
-        return AuthenticatedComponent;
-    }(react_1.Component));
-};
-exports.configureAuthenticatedComponent = configureAuthenticatedComponent;
-var configureMapStateToProps = function () { return function (state) {
-    return {
-        isAuthenticating: !state.auth.isAuthenticated && state.auth.isAuthenticating,
-        isAuthenticated: state.auth.isAuthenticated
-    };
-}; };
-exports.configureMapStateToProps = configureMapStateToProps;
-function authenticatedComponent(WrappedComponent) {
-    var AuthenticatedComponent = exports.configureAuthenticatedComponent(WrappedComponent);
-    var mapStateToProps = exports.configureMapStateToProps();
-    // @ts-ignore: could not match inferred type from the `connect` HOC
-    return react_router_dom_1.withRouter(react_redux_1.connect(mapStateToProps)(AuthenticatedComponent));
-}
-exports.default = authenticatedComponent;
+"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 __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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureMapStateToProps = exports.configureAuthenticatedComponent = void 0;
+var react_1 = __importStar(require("react"));
+var react_redux_1 = require("react-redux");
+var react_router_dom_1 = require("react-router-dom");
+var persistenceService_1 = __importStar(require("../../services/persistenceService"));
+var configureAuthenticatedComponent = function (WrappedComponent) {
+    return /** @class */ (function (_super) {
+        __extends(AuthenticatedComponent, _super);
+        function AuthenticatedComponent() {
+            return _super !== null && _super.apply(this, arguments) || this;
+        }
+        AuthenticatedComponent.prototype.isNotAuthenticated = function () {
+            var _a = this.props, isAuthenticating = _a.isAuthenticating, isAuthenticated = _a.isAuthenticated;
+            return !isAuthenticating && !isAuthenticated;
+        };
+        AuthenticatedComponent.prototype.persistReturnUrlIfNeeded = function () {
+            var pathname = this.props.location.pathname;
+            var returnUrl = persistenceService_1.default.getItem(persistenceService_1.returnUrlKey);
+            if (!returnUrl) {
+                void persistenceService_1.default.setItem(persistenceService_1.returnUrlKey, pathname);
+            }
+        };
+        AuthenticatedComponent.prototype.render = function () {
+            var _a = this.props, isAuthenticating = _a.isAuthenticating, isAuthenticated = _a.isAuthenticated, history = _a.history, location = _a.location, match = _a.match, staticContext = _a.staticContext, rest = __rest(_a, ["isAuthenticating", "isAuthenticated", "history", "location", "match", "staticContext"]);
+            if (this.isNotAuthenticated()) {
+                this.persistReturnUrlIfNeeded();
+                return react_1.default.createElement(react_router_dom_1.Redirect, { to: "/login" });
+            }
+            return react_1.default.createElement(WrappedComponent, __assign({}, rest));
+        };
+        return AuthenticatedComponent;
+    }(react_1.Component));
+};
+exports.configureAuthenticatedComponent = configureAuthenticatedComponent;
+var configureMapStateToProps = function () { return function (state) {
+    return {
+        isAuthenticating: !state.auth.isAuthenticated && state.auth.isAuthenticating,
+        isAuthenticated: state.auth.isAuthenticated
+    };
+}; };
+exports.configureMapStateToProps = configureMapStateToProps;
+function authenticatedComponent(WrappedComponent) {
+    var AuthenticatedComponent = exports.configureAuthenticatedComponent(WrappedComponent);
+    var mapStateToProps = exports.configureMapStateToProps();
+    // @ts-ignore: could not match inferred type from the `connect` HOC
+    return react_router_dom_1.withRouter(react_redux_1.connect(mapStateToProps)(AuthenticatedComponent));
+}
+exports.default = authenticatedComponent;

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

@@ -1,61 +1,61 @@
-import React, { ComponentClass, ComponentType } from 'react';
-import { RouteComponentProps } from 'react-router';
-import { Model } from 'studiokit-net-js';
-import MODEL_STATUS from '../../constants/modelStatus';
-import { BaseReduxState } from '../../types';
-import { CollectionCommonProps, CollectionCommonState, CollectionCreateParams, CollectionDeleteParams, CollectionLoadParams, CollectionMethodConfiguration, CollectionMethods, CollectionReduxResponse, CollectionUpdateParams } from '../../types/Collection';
-import { GuidComponentWrappedProps } from './GuidComponent';
-/** The props passed into `CollectionComponent` from the user and other HOCs. */
-export interface CollectionComponentProps<TModel extends Model> extends CollectionCommonProps, GuidComponentWrappedProps, RouteComponentProps, CollectionReduxResponse<TModel> {
-}
-/** The props passed down to the `WrappedComponent`. */
-export interface CollectionComponentWrappedProps<TModel extends Model> extends Omit<CollectionComponentProps<TModel>, keyof RouteComponentProps>, CollectionMethods, CollectionCommonState {
-}
-export declare function configureCollectionComponent<TModel extends Model, TOwnProps extends {}>(WrappedComponent: ComponentType<TOwnProps & CollectionComponentWrappedProps<TModel>>, LoaderComponent?: ComponentType): {
-    new (props: TOwnProps & CollectionComponentProps<TModel>): {
-        componentDidMount(): void;
-        componentDidUpdate(prevProps: TOwnProps & CollectionComponentProps<TModel>): void;
-        componentWillUnmount(): void;
-        changeModelStatus: (newModelStatus: MODEL_STATUS, fetchingId?: string | undefined) => void;
-        getCollectionMethodConfig: () => CollectionMethodConfiguration;
-        load: (params?: CollectionLoadParams) => void;
-        stopPeriodicLoad: (taskId: string) => void;
-        create: (params: CollectionCreateParams) => void;
-        update: (params: CollectionUpdateParams) => void;
-        delete: (params: CollectionDeleteParams) => void;
-        render(): JSX.Element;
-        context: any;
-        setState<K extends "modelStatus" | "previousModelStatus" | "fetchingId">(state: CollectionCommonState | ((prevState: Readonly<CollectionCommonState>, props: Readonly<TOwnProps & CollectionComponentProps<TModel>>) => CollectionCommonState | Pick<CollectionCommonState, K> | null) | Pick<CollectionCommonState, K> | null, callback?: (() => void) | undefined): void;
-        forceUpdate(callback?: (() => void) | undefined): void;
-        readonly props: Readonly<TOwnProps & CollectionComponentProps<TModel>> & Readonly<{
-            children?: React.ReactNode;
-        }>;
-        state: Readonly<CollectionCommonState>;
-        refs: {
-            [key: string]: React.ReactInstance;
-        };
-        shouldComponentUpdate?(nextProps: Readonly<TOwnProps & CollectionComponentProps<TModel>>, nextState: Readonly<CollectionCommonState>, nextContext: any): boolean;
-        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
-        getSnapshotBeforeUpdate?(prevProps: Readonly<TOwnProps & CollectionComponentProps<TModel>>, prevState: Readonly<CollectionCommonState>): any;
-        componentWillMount?(): void;
-        UNSAFE_componentWillMount?(): void;
-        componentWillReceiveProps?(nextProps: Readonly<TOwnProps & CollectionComponentProps<TModel>>, nextContext: any): void;
-        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<TOwnProps & CollectionComponentProps<TModel>>, nextContext: any): void;
-        componentWillUpdate?(nextProps: Readonly<TOwnProps & CollectionComponentProps<TModel>>, nextState: Readonly<CollectionCommonState>, nextContext: any): void;
-        UNSAFE_componentWillUpdate?(nextProps: Readonly<TOwnProps & CollectionComponentProps<TModel>>, nextState: Readonly<CollectionCommonState>, nextContext: any): void;
-    };
-    contextType?: React.Context<any> | undefined;
-};
-export declare const configureMapStateToProps: <TModel extends Model, TOwnProps extends Pick<CollectionComponentProps<TModel>, "match" | "guid" | "location" | "history" | "staticContext" | "modelName" | "pathParams" | "queryParams" | "disableAutoLoad">>(modelName: string) => (state: BaseReduxState, ownProps: TOwnProps & Partial<CollectionComponentProps<TModel>>) => import("../../types").CollectionSelectorMethodResponse<Model>;
-/**
- * HOC that provides "collection" related functionality, using redux `connect()`, react-router-dom `withRouter()`, and `GuidComponent`.
- *
- * @template T The type of model that is in this collection.
- *
- * @param WrappedComponent The component to wrap.
- * @param modelName The generic path (no Ids) to where the collection is stored in redux.
- * A path relating to an item in defined in `constants/configuration/getEndpointMappings()` (levels separated by a '.').
- * Can override at render time, e.g. `<C modelName="otherModel" />`.
- * @param LoaderComponent Component to use as the Loader. Defaults to `<Loading />`.
- */
-export default function collectionComponent<TModel extends Model, TOwnProps extends CollectionComponentWrappedProps<TModel>>(WrappedComponent: ComponentType<TOwnProps>, modelName: string, LoaderComponent?: ComponentType): ComponentClass<Omit<TOwnProps, keyof CollectionComponentWrappedProps<TModel>> & Partial<CollectionCommonProps>>;
+import React, { ComponentClass, ComponentType } from 'react';
+import { RouteComponentProps } from 'react-router';
+import { Model } from 'studiokit-net-js';
+import MODEL_STATUS from '../../constants/modelStatus';
+import { BaseReduxState } from '../../types';
+import { CollectionCommonProps, CollectionCommonState, CollectionCreateParams, CollectionDeleteParams, CollectionLoadParams, CollectionMethodConfiguration, CollectionMethods, CollectionReduxResponse, CollectionUpdateParams } from '../../types/Collection';
+import { GuidComponentWrappedProps } from './GuidComponent';
+/** The props passed into `CollectionComponent` from the user and other HOCs. */
+export interface CollectionComponentProps<TModel extends Model> extends CollectionCommonProps, GuidComponentWrappedProps, RouteComponentProps, CollectionReduxResponse<TModel> {
+}
+/** The props passed down to the `WrappedComponent`. */
+export interface CollectionComponentWrappedProps<TModel extends Model> extends Omit<CollectionComponentProps<TModel>, keyof RouteComponentProps>, CollectionMethods, CollectionCommonState {
+}
+export declare function configureCollectionComponent<TModel extends Model, TOwnProps extends {}>(WrappedComponent: ComponentType<TOwnProps & CollectionComponentWrappedProps<TModel>>, LoaderComponent?: ComponentType): {
+    new (props: TOwnProps & CollectionComponentProps<TModel>): {
+        componentDidMount(): void;
+        componentDidUpdate(prevProps: TOwnProps & CollectionComponentProps<TModel>): void;
+        componentWillUnmount(): void;
+        changeModelStatus: (newModelStatus: MODEL_STATUS, fetchingId?: string | undefined) => void;
+        getCollectionMethodConfig: () => CollectionMethodConfiguration;
+        load: (params?: CollectionLoadParams) => void;
+        stopPeriodicLoad: (taskId: string) => void;
+        create: (params: CollectionCreateParams) => void;
+        update: (params: CollectionUpdateParams) => void;
+        delete: (params: CollectionDeleteParams) => void;
+        render(): JSX.Element;
+        context: any;
+        setState<K extends "modelStatus" | "previousModelStatus" | "fetchingId">(state: CollectionCommonState | ((prevState: Readonly<CollectionCommonState>, props: Readonly<TOwnProps & CollectionComponentProps<TModel>>) => CollectionCommonState | Pick<CollectionCommonState, K> | null) | Pick<CollectionCommonState, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<TOwnProps & CollectionComponentProps<TModel>> & Readonly<{
+            children?: React.ReactNode;
+        }>;
+        state: Readonly<CollectionCommonState>;
+        refs: {
+            [key: string]: React.ReactInstance;
+        };
+        shouldComponentUpdate?(nextProps: Readonly<TOwnProps & CollectionComponentProps<TModel>>, nextState: Readonly<CollectionCommonState>, nextContext: any): boolean;
+        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<TOwnProps & CollectionComponentProps<TModel>>, prevState: Readonly<CollectionCommonState>): any;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<TOwnProps & CollectionComponentProps<TModel>>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<TOwnProps & CollectionComponentProps<TModel>>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<TOwnProps & CollectionComponentProps<TModel>>, nextState: Readonly<CollectionCommonState>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<TOwnProps & CollectionComponentProps<TModel>>, nextState: Readonly<CollectionCommonState>, nextContext: any): void;
+    };
+    contextType?: React.Context<any> | undefined;
+};
+export declare const configureMapStateToProps: <TModel extends Model, TOwnProps extends Pick<CollectionComponentProps<TModel>, "match" | "guid" | "location" | "history" | "staticContext" | "modelName" | "pathParams" | "queryParams" | "disableAutoLoad">>(modelName: string) => (state: BaseReduxState, ownProps: TOwnProps & Partial<CollectionComponentProps<TModel>>) => import("../../types").CollectionSelectorMethodResponse<Model>;
+/**
+ * HOC that provides "collection" related functionality, using redux `connect()`, react-router-dom `withRouter()`, and `GuidComponent`.
+ *
+ * @template T The type of model that is in this collection.
+ *
+ * @param WrappedComponent The component to wrap.
+ * @param modelName The generic path (no Ids) to where the collection is stored in redux.
+ * A path relating to an item in defined in `constants/configuration/getEndpointMappings()` (levels separated by a '.').
+ * Can override at render time, e.g. `<C modelName="otherModel" />`.
+ * @param LoaderComponent Component to use as the Loader. Defaults to `<Loading />`.
+ */
+export default function collectionComponent<TModel extends Model, TOwnProps extends CollectionComponentWrappedProps<TModel>>(WrappedComponent: ComponentType<TOwnProps>, modelName: string, LoaderComponent?: ComponentType): ComponentClass<Omit<TOwnProps, keyof CollectionComponentWrappedProps<TModel>> & Partial<CollectionCommonProps>>;