studiokit-scaffolding-js 4.3.20 → 4.3.21

package/lib/components/HOC/CollectionFirstItemComponent.js

@@ -1,94 +1,94 @@
-"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 __spreadArrays = (this && this.__spreadArrays) || function () {
-    for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
-    for (var r = Array(s), k = 0, i = 0; i < il; i++)
-        for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
-            r[k] = a[j];
-    return r;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.configureCollectionFirstItemComponent = void 0;
-var react_1 = __importStar(require("react"));
-var model_1 = require("../../utils/model");
-/**
- * HOC meant to pass the first collection item to the wrapped component as its model.
- * Should be wrapped in `CollectionComponent`.
- */
-function configureCollectionFirstItemComponent(WrappedComponent) {
-    return /** @class */ (function (_super) {
-        __extends(CollectionFirstItemComponent, _super);
-        function CollectionFirstItemComponent() {
-            var _this = _super !== null && _super.apply(this, arguments) || this;
-            _this.getFirstItem = function () {
-                var _a = _this.props, model = _a.model, modelArray = _a.modelArray, guid = _a.guid;
-                var singleItem = modelArray.length > 0
-                    ? modelArray[0]
-                    : model[guid]
-                        ? model[guid]
-                        : {};
-                return singleItem;
-            };
-            return _this;
-        }
-        CollectionFirstItemComponent.prototype.render = function () {
-            var pathParams = this.props.pathParams;
-            var firstItem = this.getFirstItem();
-            var modelMinusRelations = model_1.getModelMinusRelations(firstItem);
-            var p = __spreadArrays(pathParams);
-            if (firstItem.id) {
-                p.push(firstItem.id.toString());
-            }
-            return (react_1.default.createElement(WrappedComponent, __assign({}, this.props, { pathParams: p, model: firstItem, modelMinusRelations: modelMinusRelations })));
-        };
-        return CollectionFirstItemComponent;
-    }(react_1.Component));
-}
-exports.configureCollectionFirstItemComponent = configureCollectionFirstItemComponent;
-function collectionFirstItemComponent(wrappedComponent) {
-    // @ts-ignore: Could not match inferred type from HOC
-    return configureCollectionFirstItemComponent(wrappedComponent);
-}
-exports.default = collectionFirstItemComponent;
+"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 __spreadArrays = (this && this.__spreadArrays) || function () {
+    for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
+    for (var r = Array(s), k = 0, i = 0; i < il; i++)
+        for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
+            r[k] = a[j];
+    return r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureCollectionFirstItemComponent = void 0;
+var react_1 = __importStar(require("react"));
+var model_1 = require("../../utils/model");
+/**
+ * HOC meant to pass the first collection item to the wrapped component as its model.
+ * Should be wrapped in `CollectionComponent`.
+ */
+function configureCollectionFirstItemComponent(WrappedComponent) {
+    return /** @class */ (function (_super) {
+        __extends(CollectionFirstItemComponent, _super);
+        function CollectionFirstItemComponent() {
+            var _this = _super !== null && _super.apply(this, arguments) || this;
+            _this.getFirstItem = function () {
+                var _a = _this.props, model = _a.model, modelArray = _a.modelArray, guid = _a.guid;
+                var singleItem = modelArray.length > 0
+                    ? modelArray[0]
+                    : model[guid]
+                        ? model[guid]
+                        : {};
+                return singleItem;
+            };
+            return _this;
+        }
+        CollectionFirstItemComponent.prototype.render = function () {
+            var pathParams = this.props.pathParams;
+            var firstItem = this.getFirstItem();
+            var modelMinusRelations = model_1.getModelMinusRelations(firstItem);
+            var p = __spreadArrays(pathParams);
+            if (firstItem.id) {
+                p.push(firstItem.id.toString());
+            }
+            return (react_1.default.createElement(WrappedComponent, __assign({}, this.props, { pathParams: p, model: firstItem, modelMinusRelations: modelMinusRelations })));
+        };
+        return CollectionFirstItemComponent;
+    }(react_1.Component));
+}
+exports.configureCollectionFirstItemComponent = configureCollectionFirstItemComponent;
+function collectionFirstItemComponent(wrappedComponent) {
+    // @ts-ignore: Could not match inferred type from HOC
+    return configureCollectionFirstItemComponent(wrappedComponent);
+}
+exports.default = collectionFirstItemComponent;

package/lib/components/HOC/CollectionItemComponent.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, CollectionItemDeleteParams, CollectionItemLoadParams, CollectionItemMethods, CollectionItemReduxResponse, CollectionItemUpdateParams, CollectionMethodConfiguration } from '../../types/Collection';
-import { GuidComponentWrappedProps } from './GuidComponent';
-/** The props passed into `CollectionItemComponent` from the user and other HOCs. */
-export interface CollectionItemComponentProps<TModel extends Model> extends CollectionCommonProps, GuidComponentWrappedProps, RouteComponentProps, CollectionItemReduxResponse<TModel> {
-}
-/** The props passed down to the `WrappedComponent`. */
-export interface CollectionItemComponentWrappedProps<TModel extends Model> extends Omit<CollectionItemComponentProps<TModel>, keyof RouteComponentProps>, CollectionItemMethods, CollectionCommonState {
-}
-export declare function configureCollectionItemComponent<TModel extends Model, TOwnProps extends {}>(WrappedComponent: ComponentType<TOwnProps & CollectionItemComponentWrappedProps<TModel>>, LoaderComponent?: ComponentType): {
-    new (props: TOwnProps & CollectionItemComponentProps<TModel>): {
-        componentDidMount(): void;
-        componentDidUpdate(prevProps: TOwnProps & CollectionItemComponentProps<TModel>): void;
-        setModelStatus: (newModelStatus: MODEL_STATUS) => void;
-        getCollectionMethodConfig: () => CollectionMethodConfiguration;
-        load: (params?: CollectionItemLoadParams) => void;
-        stopPeriodicLoad: (taskId: string) => void;
-        create: (params: CollectionCreateParams) => void;
-        update: (params: CollectionItemUpdateParams) => void;
-        delete: (params?: CollectionItemDeleteParams) => void;
-        render(): JSX.Element;
-        context: any;
-        setState<K extends "modelStatus" | "previousModelStatus" | "fetchingId">(state: CollectionCommonState | ((prevState: Readonly<CollectionCommonState>, props: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>) => CollectionCommonState | Pick<CollectionCommonState, K> | null) | Pick<CollectionCommonState, K> | null, callback?: (() => void) | undefined): void;
-        forceUpdate(callback?: (() => void) | undefined): void;
-        readonly props: Readonly<TOwnProps & CollectionItemComponentProps<TModel>> & Readonly<{
-            children?: React.ReactNode;
-        }>;
-        state: Readonly<CollectionCommonState>;
-        refs: {
-            [key: string]: React.ReactInstance;
-        };
-        shouldComponentUpdate?(nextProps: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>, nextState: Readonly<CollectionCommonState>, nextContext: any): boolean;
-        componentWillUnmount?(): void;
-        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
-        getSnapshotBeforeUpdate?(prevProps: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>, prevState: Readonly<CollectionCommonState>): any;
-        componentWillMount?(): void;
-        UNSAFE_componentWillMount?(): void;
-        componentWillReceiveProps?(nextProps: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>, nextContext: any): void;
-        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>, nextContext: any): void;
-        componentWillUpdate?(nextProps: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>, nextState: Readonly<CollectionCommonState>, nextContext: any): void;
-        UNSAFE_componentWillUpdate?(nextProps: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>, nextState: Readonly<CollectionCommonState>, nextContext: any): void;
-    };
-    contextType?: React.Context<any> | undefined;
-};
-export declare const configureMapStateToProps: <TModel extends Model, TOwnProps extends Pick<CollectionItemComponentProps<TModel>, "match" | "guid" | "location" | "history" | "staticContext" | "modelName" | "pathParams" | "queryParams" | "disableAutoLoad">>(modelName: string) => (state: BaseReduxState, ownProps: TOwnProps) => import("../../types").CollectionSelectorMethodResponse<Model>;
-/**
- * HOC that provides "collection" related functionality for a single item in a collection, using redux `connect()`, react-router-dom `withRouter()`, and `GuidComponent`.
- *
- * @template T The type of model.
- *
- * @param WrappedComponent The component to wrap.
- * @param modelName The generic path (no Ids) to where the collection item 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 collectionItemComponent<TModel extends Model, TOwnProps extends CollectionItemComponentWrappedProps<TModel>>(WrappedComponent: ComponentType<TOwnProps>, modelName: string, LoaderComponent?: ComponentType): ComponentClass<Omit<TOwnProps, keyof CollectionItemComponentWrappedProps<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, CollectionItemDeleteParams, CollectionItemLoadParams, CollectionItemMethods, CollectionItemReduxResponse, CollectionItemUpdateParams, CollectionMethodConfiguration } from '../../types/Collection';
+import { GuidComponentWrappedProps } from './GuidComponent';
+/** The props passed into `CollectionItemComponent` from the user and other HOCs. */
+export interface CollectionItemComponentProps<TModel extends Model> extends CollectionCommonProps, GuidComponentWrappedProps, RouteComponentProps, CollectionItemReduxResponse<TModel> {
+}
+/** The props passed down to the `WrappedComponent`. */
+export interface CollectionItemComponentWrappedProps<TModel extends Model> extends Omit<CollectionItemComponentProps<TModel>, keyof RouteComponentProps>, CollectionItemMethods, CollectionCommonState {
+}
+export declare function configureCollectionItemComponent<TModel extends Model, TOwnProps extends {}>(WrappedComponent: ComponentType<TOwnProps & CollectionItemComponentWrappedProps<TModel>>, LoaderComponent?: ComponentType): {
+    new (props: TOwnProps & CollectionItemComponentProps<TModel>): {
+        componentDidMount(): void;
+        componentDidUpdate(prevProps: TOwnProps & CollectionItemComponentProps<TModel>): void;
+        setModelStatus: (newModelStatus: MODEL_STATUS) => void;
+        getCollectionMethodConfig: () => CollectionMethodConfiguration;
+        load: (params?: CollectionItemLoadParams) => void;
+        stopPeriodicLoad: (taskId: string) => void;
+        create: (params: CollectionCreateParams) => void;
+        update: (params: CollectionItemUpdateParams) => void;
+        delete: (params?: CollectionItemDeleteParams) => void;
+        render(): JSX.Element;
+        context: any;
+        setState<K extends "modelStatus" | "previousModelStatus" | "fetchingId">(state: CollectionCommonState | ((prevState: Readonly<CollectionCommonState>, props: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>) => CollectionCommonState | Pick<CollectionCommonState, K> | null) | Pick<CollectionCommonState, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<TOwnProps & CollectionItemComponentProps<TModel>> & Readonly<{
+            children?: React.ReactNode;
+        }>;
+        state: Readonly<CollectionCommonState>;
+        refs: {
+            [key: string]: React.ReactInstance;
+        };
+        shouldComponentUpdate?(nextProps: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>, nextState: Readonly<CollectionCommonState>, nextContext: any): boolean;
+        componentWillUnmount?(): void;
+        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>, prevState: Readonly<CollectionCommonState>): any;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>, nextState: Readonly<CollectionCommonState>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<TOwnProps & CollectionItemComponentProps<TModel>>, nextState: Readonly<CollectionCommonState>, nextContext: any): void;
+    };
+    contextType?: React.Context<any> | undefined;
+};
+export declare const configureMapStateToProps: <TModel extends Model, TOwnProps extends Pick<CollectionItemComponentProps<TModel>, "match" | "guid" | "location" | "history" | "staticContext" | "modelName" | "pathParams" | "queryParams" | "disableAutoLoad">>(modelName: string) => (state: BaseReduxState, ownProps: TOwnProps) => import("../../types").CollectionSelectorMethodResponse<Model>;
+/**
+ * HOC that provides "collection" related functionality for a single item in a collection, using redux `connect()`, react-router-dom `withRouter()`, and `GuidComponent`.
+ *
+ * @template T The type of model.
+ *
+ * @param WrappedComponent The component to wrap.
+ * @param modelName The generic path (no Ids) to where the collection item 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 collectionItemComponent<TModel extends Model, TOwnProps extends CollectionItemComponentWrappedProps<TModel>>(WrappedComponent: ComponentType<TOwnProps>, modelName: string, LoaderComponent?: ComponentType): ComponentClass<Omit<TOwnProps, keyof CollectionItemComponentWrappedProps<TModel>> & Partial<CollectionCommonProps>>;