studiokit-scaffolding-js 4.3.20 → 4.3.21

package/lib/endpointMappings.js

@@ -1,173 +1,173 @@
-"use strict";
-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);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.endpointMappings = exports.groupEndpointMapping = exports.entityUserRoleEndpointMappings = void 0;
-var entityUserRoleEndpointMappings = function (typename) {
-    return {
-        entityUserRoles: {
-            _config: {
-                isCollection: true,
-                fetch: {
-                    path: '/api/entityUserRoles',
-                    // for GET
-                    queryParams: {
-                        typename: typename
-                    },
-                    // for DELETE
-                    body: {
-                        typename: typename
-                    }
-                }
-            }
-        },
-        // use separate model for transient POSTs
-        addUserRoles: {
-            _config: {
-                fetch: {
-                    path: '/api/entityUserRoles',
-                    method: 'POST',
-                    body: {
-                        typename: typename
-                    }
-                }
-            }
-        }
-    };
-};
-exports.entityUserRoleEndpointMappings = entityUserRoleEndpointMappings;
-exports.groupEndpointMapping = __assign({ _config: {
-        isCollection: true,
-        fetch: {
-            path: '/api/groups'
-        }
-    }, syncRoster: {
-        _config: {
-            fetch: {
-                method: 'POST'
-            }
-        }
-    } }, exports.entityUserRoleEndpointMappings('Group'));
-exports.endpointMappings = {
-    urlChecker: {
-        _config: {
-            fetch: {
-                path: '/api/url/headers'
-            }
-        }
-    },
-    caliperToken: {
-        _config: {
-            fetch: {
-                path: '/api/caliper-eventstore/token'
-            }
-        }
-    },
-    configuration: {
-        _config: {
-            fetch: {
-                path: '/api/configuration'
-            }
-        }
-    },
-    client: {
-        _config: {
-            fetch: {
-                path: '/api/appClients/web'
-            }
-        }
-    },
-    identityProviders: {
-        _config: {
-            isCollection: true
-        }
-    },
-    externalTerms: {
-        _config: {
-            isCollection: true
-        }
-    },
-    externalProviders: {
-        _config: {
-            isCollection: true
-        }
-    },
-    userRoles: {
-        _config: {
-            isCollection: true
-        }
-    },
-    // use separate model for transient POSTs
-    addUserRoles: {
-        _config: {
-            fetch: {
-                path: '/api/userRoles',
-                method: 'POST'
-            }
-        }
-    },
-    uniTimeInstructorSchedule: {
-        _config: {
-            fetch: {
-                path: '/api/uniTime/instructorSchedule'
-            }
-        }
-    },
-    ltiLaunches: {
-        _config: {
-            isCollection: true
-        },
-        deepLinkingResponse: {
-            _config: {
-                fetch: {
-                    method: 'POST'
-                }
-            }
-        }
-    },
-    search: {
-        _config: {
-            fetch: {
-                path: ''
-            }
-        },
-        users: {
-            _config: {
-                isCollection: true,
-                fetch: {
-                    path: '/api/users'
-                }
-            }
-        }
-    },
-    time: {
-        _config: {
-            fetch: {
-                path: '/api/time'
-            }
-        }
-    },
-    startImpersonation: {
-        _config: {
-            fetch: {
-                path: '/api/account/startImpersonation'
-            }
-        }
-    },
-    stopImpersonation: {
-        _config: {
-            fetch: {
-                path: '/api/account/stopImpersonation'
-            }
-        }
-    }
-};
+"use strict";
+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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.endpointMappings = exports.groupEndpointMapping = exports.entityUserRoleEndpointMappings = void 0;
+var entityUserRoleEndpointMappings = function (typename) {
+    return {
+        entityUserRoles: {
+            _config: {
+                isCollection: true,
+                fetch: {
+                    path: '/api/entityUserRoles',
+                    // for GET
+                    queryParams: {
+                        typename: typename
+                    },
+                    // for DELETE
+                    body: {
+                        typename: typename
+                    }
+                }
+            }
+        },
+        // use separate model for transient POSTs
+        addUserRoles: {
+            _config: {
+                fetch: {
+                    path: '/api/entityUserRoles',
+                    method: 'POST',
+                    body: {
+                        typename: typename
+                    }
+                }
+            }
+        }
+    };
+};
+exports.entityUserRoleEndpointMappings = entityUserRoleEndpointMappings;
+exports.groupEndpointMapping = __assign({ _config: {
+        isCollection: true,
+        fetch: {
+            path: '/api/groups'
+        }
+    }, syncRoster: {
+        _config: {
+            fetch: {
+                method: 'POST'
+            }
+        }
+    } }, exports.entityUserRoleEndpointMappings('Group'));
+exports.endpointMappings = {
+    urlChecker: {
+        _config: {
+            fetch: {
+                path: '/api/url/headers'
+            }
+        }
+    },
+    caliperToken: {
+        _config: {
+            fetch: {
+                path: '/api/caliper-eventstore/token'
+            }
+        }
+    },
+    configuration: {
+        _config: {
+            fetch: {
+                path: '/api/configuration'
+            }
+        }
+    },
+    client: {
+        _config: {
+            fetch: {
+                path: '/api/appClients/web'
+            }
+        }
+    },
+    identityProviders: {
+        _config: {
+            isCollection: true
+        }
+    },
+    externalTerms: {
+        _config: {
+            isCollection: true
+        }
+    },
+    externalProviders: {
+        _config: {
+            isCollection: true
+        }
+    },
+    userRoles: {
+        _config: {
+            isCollection: true
+        }
+    },
+    // use separate model for transient POSTs
+    addUserRoles: {
+        _config: {
+            fetch: {
+                path: '/api/userRoles',
+                method: 'POST'
+            }
+        }
+    },
+    uniTimeInstructorSchedule: {
+        _config: {
+            fetch: {
+                path: '/api/uniTime/instructorSchedule'
+            }
+        }
+    },
+    ltiLaunches: {
+        _config: {
+            isCollection: true
+        },
+        deepLinkingResponse: {
+            _config: {
+                fetch: {
+                    method: 'POST'
+                }
+            }
+        }
+    },
+    search: {
+        _config: {
+            fetch: {
+                path: ''
+            }
+        },
+        users: {
+            _config: {
+                isCollection: true,
+                fetch: {
+                    path: '/api/users'
+                }
+            }
+        }
+    },
+    time: {
+        _config: {
+            fetch: {
+                path: '/api/time'
+            }
+        }
+    },
+    startImpersonation: {
+        _config: {
+            fetch: {
+                path: '/api/account/startImpersonation'
+            }
+        }
+    },
+    stopImpersonation: {
+        _config: {
+            fetch: {
+                path: '/api/account/stopImpersonation'
+            }
+        }
+    }
+};

package/lib/hooks/useCollection.d.ts

@@ -1,6 +1,6 @@
-import { Model } from 'studiokit-net-js';
-import { CollectionCommonProps, CollectionCommonState, CollectionMethods, CollectionReduxResponse } from '../types/Collection';
-export interface UseCollectionResponse<TModel extends Model> extends CollectionCommonState, CollectionReduxResponse<TModel>, CollectionMethods {
-    guid: string;
-}
-export declare function useCollection<TModel extends Model>(props: CollectionCommonProps): UseCollectionResponse<TModel>;
+import { Model } from 'studiokit-net-js';
+import { CollectionCommonProps, CollectionCommonState, CollectionMethods, CollectionReduxResponse } from '../types/Collection';
+export interface UseCollectionResponse<TModel extends Model> extends CollectionCommonState, CollectionReduxResponse<TModel>, CollectionMethods {
+    guid: string;
+}
+export declare function useCollection<TModel extends Model>(props: CollectionCommonProps): UseCollectionResponse<TModel>;

package/lib/hooks/useCollection.js

@@ -1,61 +1,61 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useCollection = void 0;
-var react_1 = require("react");
-var collection_1 = require("../utils/collection");
-var useCollectionConfiguration_1 = require("./useCollectionConfiguration");
-function useCollection(props) {
-    var modelName = props.modelName;
-    // state, route, and redux
-    var config = useCollectionConfiguration_1.useCollectionConfiguration(props, collection_1.selectCollectionFromState);
-    var guid = config.guid, model = config.model, pathParams = config.pathParams, previousPathParams = config.previousPathParams, queryParams = config.queryParams, previousQueryParams = config.previousQueryParams, fetchingId = config.fetchingId, modelStatus = config.modelStatus, previousModelStatus = config.previousModelStatus, isInitialized = config.isInitialized, setIsInitialized = config.setIsInitialized, methodConfig = config.methodConfig, modelArray = config.modelArray;
-    // decorated methods
-    var load = react_1.useCallback(function (params) {
-        if (params === void 0) { params = {}; }
-        collection_1.loadCollection(methodConfig, params);
-    }, [methodConfig]);
-    var stopPeriodicLoad = react_1.useCallback(function (taskId) {
-        collection_1.stopCollectionPeriodicLoad(modelName, taskId);
-    }, [modelName]);
-    var create = react_1.useCallback(function (params) {
-        collection_1.createItemInCollection(methodConfig, params);
-    }, [methodConfig]);
-    var update = react_1.useCallback(function (params) {
-        collection_1.updateItemInCollection(methodConfig, params);
-    }, [methodConfig]);
-    var deleteItem = react_1.useCallback(function (params) {
-        collection_1.deleteItemFromCollection(methodConfig, params);
-    }, [methodConfig]);
-    // initialize and auto-load, if needed (runs once)
-    react_1.useEffect(function () {
-        if (!isInitialized) {
-            collection_1.initializeCollection(model, load, methodConfig);
-            setIsInitialized(true);
-        }
-    }, [isInitialized, load, methodConfig, model, setIsInitialized]);
-    // re-load if `pathParams` or `queryParams` change
-    react_1.useEffect(function () {
-        collection_1.handleCollectionParamsChange(pathParams, previousPathParams, queryParams, previousQueryParams, load);
-    }, [load, modelName, pathParams, previousPathParams, previousQueryParams, queryParams]);
-    // cleanup on unmount
-    react_1.useEffect(function () {
-        return function cleanup() {
-            collection_1.cleanupCollectionGuidKey(model, methodConfig);
-        };
-        // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, []); // this effect should NOT be called more than once
-    return {
-        guid: guid,
-        model: model,
-        modelArray: modelArray,
-        modelStatus: modelStatus,
-        previousModelStatus: previousModelStatus,
-        fetchingId: fetchingId,
-        load: load,
-        stopPeriodicLoad: stopPeriodicLoad,
-        create: create,
-        update: update,
-        delete: deleteItem
-    };
-}
-exports.useCollection = useCollection;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useCollection = void 0;
+var react_1 = require("react");
+var collection_1 = require("../utils/collection");
+var useCollectionConfiguration_1 = require("./useCollectionConfiguration");
+function useCollection(props) {
+    var modelName = props.modelName;
+    // state, route, and redux
+    var config = useCollectionConfiguration_1.useCollectionConfiguration(props, collection_1.selectCollectionFromState);
+    var guid = config.guid, model = config.model, pathParams = config.pathParams, previousPathParams = config.previousPathParams, queryParams = config.queryParams, previousQueryParams = config.previousQueryParams, fetchingId = config.fetchingId, modelStatus = config.modelStatus, previousModelStatus = config.previousModelStatus, isInitialized = config.isInitialized, setIsInitialized = config.setIsInitialized, methodConfig = config.methodConfig, modelArray = config.modelArray;
+    // decorated methods
+    var load = react_1.useCallback(function (params) {
+        if (params === void 0) { params = {}; }
+        collection_1.loadCollection(methodConfig, params);
+    }, [methodConfig]);
+    var stopPeriodicLoad = react_1.useCallback(function (taskId) {
+        collection_1.stopCollectionPeriodicLoad(modelName, taskId);
+    }, [modelName]);
+    var create = react_1.useCallback(function (params) {
+        collection_1.createItemInCollection(methodConfig, params);
+    }, [methodConfig]);
+    var update = react_1.useCallback(function (params) {
+        collection_1.updateItemInCollection(methodConfig, params);
+    }, [methodConfig]);
+    var deleteItem = react_1.useCallback(function (params) {
+        collection_1.deleteItemFromCollection(methodConfig, params);
+    }, [methodConfig]);
+    // initialize and auto-load, if needed (runs once)
+    react_1.useEffect(function () {
+        if (!isInitialized) {
+            collection_1.initializeCollection(model, load, methodConfig);
+            setIsInitialized(true);
+        }
+    }, [isInitialized, load, methodConfig, model, setIsInitialized]);
+    // re-load if `pathParams` or `queryParams` change
+    react_1.useEffect(function () {
+        collection_1.handleCollectionParamsChange(pathParams, previousPathParams, queryParams, previousQueryParams, load);
+    }, [load, modelName, pathParams, previousPathParams, previousQueryParams, queryParams]);
+    // cleanup on unmount
+    react_1.useEffect(function () {
+        return function cleanup() {
+            collection_1.cleanupCollectionGuidKey(model, methodConfig);
+        };
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, []); // this effect should NOT be called more than once
+    return {
+        guid: guid,
+        model: model,
+        modelArray: modelArray,
+        modelStatus: modelStatus,
+        previousModelStatus: previousModelStatus,
+        fetchingId: fetchingId,
+        load: load,
+        stopPeriodicLoad: stopPeriodicLoad,
+        create: create,
+        update: update,
+        delete: deleteItem
+    };
+}
+exports.useCollection = useCollection;

package/lib/hooks/useCollectionConfiguration.d.ts

@@ -1,27 +1,27 @@
-/// <reference types="react" />
-import { Dictionary } from 'lodash';
-import { Model, ModelCollection } from 'studiokit-net-js';
-import { CollectionCommonProps, CollectionCommonState, CollectionMethodConfiguration, CollectionSelectorMethod } from '../types/Collection';
-/** Configuration returned by `useCollectionConfiguration` for use in `useCollection` and `useCollectionItem` */
-export interface CollectionConfiguration<TModel extends Model> extends CollectionCommonState {
-    guid: string;
-    model: TModel | ModelCollection<TModel>;
-    modelArray?: TModel[];
-    modelMinusRelations?: Partial<TModel>;
-    previousModel: TModel | ModelCollection<TModel>;
-    pathParams: string[];
-    previousPathParams: string[];
-    queryParams?: Dictionary<string>;
-    previousQueryParams?: Dictionary<string>;
-    methodConfig: CollectionMethodConfiguration;
-    isInitialized: boolean;
-    setIsInitialized: (value: React.SetStateAction<boolean>) => void;
-}
-/**
- * `useCollectionConfiguration` shares common logic between `useCollection` and `useCollectionItem`,
- * handling most of the state, route, and redux configuration.
- *
- * @param props The props used to call the outer hook, `useCollection` or `useCollectionItem`
- * @param selectorFunction The function that will be used to select the `model` from redux.
- */
-export declare function useCollectionConfiguration<TModel extends Model>(props: CollectionCommonProps, selectorFunction: CollectionSelectorMethod): CollectionConfiguration<TModel>;
+/// <reference types="react" />
+import { Dictionary } from 'lodash';
+import { Model, ModelCollection } from 'studiokit-net-js';
+import { CollectionCommonProps, CollectionCommonState, CollectionMethodConfiguration, CollectionSelectorMethod } from '../types/Collection';
+/** Configuration returned by `useCollectionConfiguration` for use in `useCollection` and `useCollectionItem` */
+export interface CollectionConfiguration<TModel extends Model> extends CollectionCommonState {
+    guid: string;
+    model: TModel | ModelCollection<TModel>;
+    modelArray?: TModel[];
+    modelMinusRelations?: Partial<TModel>;
+    previousModel: TModel | ModelCollection<TModel>;
+    pathParams: string[];
+    previousPathParams: string[];
+    queryParams?: Dictionary<string>;
+    previousQueryParams?: Dictionary<string>;
+    methodConfig: CollectionMethodConfiguration;
+    isInitialized: boolean;
+    setIsInitialized: (value: React.SetStateAction<boolean>) => void;
+}
+/**
+ * `useCollectionConfiguration` shares common logic between `useCollection` and `useCollectionItem`,
+ * handling most of the state, route, and redux configuration.
+ *
+ * @param props The props used to call the outer hook, `useCollection` or `useCollectionItem`
+ * @param selectorFunction The function that will be used to select the `model` from redux.
+ */
+export declare function useCollectionConfiguration<TModel extends Model>(props: CollectionCommonProps, selectorFunction: CollectionSelectorMethod): CollectionConfiguration<TModel>;