studiokit-scaffolding-js 5.2.0-next.2.6 → 5.2.0-next.2.8

package/lib/components/HOC/ModelErrorRedirectComponent.js

@@ -46,6 +46,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var react_1 = __importStar(require("react"));
 var react_router_dom_1 = require("react-router-dom");
 var modelStatus_1 = require("../../constants/modelStatus");
+var types_1 = require("../../types");
 /**
  * This component exists as a child to CollectionItemComponent to
  * redirect the user to a 404/500 page if errors occur while fetching data.
@@ -71,13 +72,13 @@ function modelErrorRedirectComponent(WrappedComponent) {
                 model._metadata &&
                 model._metadata.hasError &&
                 model._metadata.lastFetchErrorData &&
-                model._metadata.lastFetchErrorData.status === 404;
+                model._metadata.lastFetchErrorData.status === types_1.HTTP_STATUS_CODE.NOT_FOUND;
             var errorRoute = previousModelStatus === modelStatus_1.MODEL_STATUS.UNINITIALIZED &&
                 modelStatus === modelStatus_1.MODEL_STATUS.ERROR &&
                 model._metadata &&
                 model._metadata.hasError &&
                 model._metadata.lastFetchErrorData &&
-                model._metadata.lastFetchErrorData.status === 500;
+                model._metadata.lastFetchErrorData.status === types_1.HTTP_STATUS_CODE.INTERNAL_SERVER_ERROR;
             if (notFoundRoute) {
                 var pathname = window.location.pathname;
                 return (react_1.default.createElement(react_router_dom_1.Redirect, { to: {

package/lib/components/UserRoles/index.d.ts

@@ -96,7 +96,7 @@ export declare class UserRoles extends Component<UserRolesProps, UserRolesState>
     textForRole: (role: string, lowercase?: boolean) => string;
     singularArticleForRole: (role: string) => string;
     addUserRoles: (identifiers: string[], role: string) => void;
-    didAdd: (data?: FetchErrorData | AddBusinessModel | undefined) => void;
+    didAdd: (data: AddBusinessModel | FetchErrorData | null) => void;
     updateUserRole: (userRoleToUpdate: UserRole, newRole: string) => void;
     didUpdate: (isSuccess: boolean) => void;
     alertRemoveUserRole: (userRoleToRemove: UserRole) => void;

package/lib/redux/sagas/authSaga.js

@@ -43,6 +43,7 @@ var effects_1 = require("redux-saga/effects");
 var codeProviderService_1 = require("../../services/codeProviderService");
 var ticketProviderService_1 = require("../../services/ticketProviderService");
 var tokenPersistenceService_1 = require("../../services/tokenPersistenceService");
+var types_1 = require("../../types");
 var logger_1 = require("../../utils/logger");
 var actions_1 = require("../actions");
 //#region Helpers
@@ -138,7 +139,8 @@ function getTokenFromRefreshToken(oauthTokenParam) {
                 // any error response
                 if (fetchErrorAction) {
                     // ignore server errors
-                    if (((_b = fetchErrorAction.errorData) === null || _b === void 0 ? void 0 : _b.status) && fetchErrorAction.errorData.status >= 500) {
+                    if (((_b = fetchErrorAction.errorData) === null || _b === void 0 ? void 0 : _b.status) &&
+                        fetchErrorAction.errorData.status >= types_1.HTTP_STATUS_CODE.INTERNAL_SERVER_ERROR) {
                         return [2 /*return*/, oauthTokenParam];
                     }
                     return [2 /*return*/, null];
@@ -285,7 +287,7 @@ function handleAuthFailure(action) {
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
-                if (!(oauthToken && action.errorData && action.errorData.status === 401)) return [3 /*break*/, 2];
+                if (!(oauthToken && action.errorData && action.errorData.status === types_1.HTTP_STATUS_CODE.UNAUTHORIZED)) return [3 /*break*/, 2];
                 logger.debug('token expired - refreshing');
                 return [4 /*yield*/, effects_1.call(performTokenRefresh)];
             case 1:

package/lib/redux/sagas/modelFetchSaga.js

@@ -308,8 +308,10 @@ function modelFetch(modelFetchRequestAction) {
                 // log to the console
                 logger.error(error);
                 didFail = true;
-                // Do not continue to retry if the response is between 400-500 (except 408: server timeout)
-                if (errorData.status >= 400 && errorData.status < 500 && errorData.status !== 408) {
+                // Do not continue to retry if the response is between 400-500 (except 408: request timeout)
+                if (errorData.status >= types_1.HTTP_STATUS_CODE.BAD_REQUEST &&
+                    errorData.status < types_1.HTTP_STATUS_CODE.INTERNAL_SERVER_ERROR &&
+                    errorData.status !== types_1.HTTP_STATUS_CODE.REQUEST_TIMEOUT) {
                     tryCount = tryLimit;
                 }
                 if (!(tryCount < tryLimit)) return [3 /*break*/, 16];
@@ -340,7 +342,7 @@ function modelFetch(modelFetchRequestAction) {
                 // dispatch that the fetch failed, which updates `_metadata` (and `guid`, if provided) at the target redux `modelPath`
                 _a.sent();
                 // Send error to error handler, except for 401s
-                if (errorData.status !== 401) {
+                if (errorData.status !== types_1.HTTP_STATUS_CODE.UNAUTHORIZED) {
                     errorHandler(error, modelFetchRequestAction, fetchConfig, lastFetchResult, errorData);
                 }
                 _a.label = 20;

package/lib/redux/sagas/noStoreSaga.d.ts

@@ -1,18 +1,18 @@
 import { SagaIterator } from '@redux-saga/core';
 import { AnyAction } from 'redux';
+import { FetchErrorData } from '../../types';
 import { ModelFetchRequestAction } from '../actions';
-declare type HookFunction = (input: any) => void;
+export declare type HookFunction<T = any> = (input: T | FetchErrorData | null) => void;
 export declare const matchesNoStoreAction: (incomingAction: AnyAction) => incomingAction is ModelFetchRequestAction;
 export declare const matchesFailedNoStoreHookAction: (incomingAction: AnyAction, noStoreAction: ModelFetchRequestAction) => boolean;
 export declare const takeMatchesFailedNoStoreHookAction: (noStoreAction: ModelFetchRequestAction) => (incomingAction: AnyAction) => boolean;
 export declare const matchesReceivedNoStoreHookAction: (incomingAction: AnyAction, noStoreAction: ModelFetchRequestAction) => boolean;
 export declare const takeMatchesReceivedNoStoreHookAction: (noStoreAction: ModelFetchRequestAction) => (incomingAction: AnyAction) => boolean;
-export declare const registerNoStoreActionHook: (key: string, hook: HookFunction) => void;
+export declare const registerNoStoreActionHook: <T>(key: string, hook: HookFunction<T>) => void;
 export declare const unregisterNoStoreActionHook: (key: string) => void;
 export declare const noStoreHooks: {
-    registerNoStoreActionHook: (key: string, hook: HookFunction) => void;
+    registerNoStoreActionHook: <T>(key: string, hook: HookFunction<T>) => void;
     unregisterNoStoreActionHook: (key: string) => void;
 };
 export declare function handleAction(noStoreAction: ModelFetchRequestAction): SagaIterator;
 export default function noStoreSaga(): SagaIterator;
-export {};

package/lib/redux/sagas/noStoreSaga.js

@@ -89,15 +89,15 @@ function handleAction(noStoreAction) {
                 if (lodash_1.isNil(hook)) {
                     return [2 /*return*/];
                 }
-                if (errorAction === null || errorAction === void 0 ? void 0 : errorAction.errorData) {
+                // return `errorData` on failure. modelFetchSaga will ALWAYS create `errorData`
+                if (errorAction) {
                     hook(errorAction.errorData);
                     return [2 /*return*/];
                 }
-                if (!(resultAction === null || resultAction === void 0 ? void 0 : resultAction.data)) {
-                    hook(null);
-                    return [2 /*return*/];
-                }
-                hook(resultAction.data);
+                // return `data` or `null` on a successful fetch result
+                // `data` can technically be `undefined`, e.g. if the server response is a NoContent (204),
+                // so the caller will need to determine if `null` is treated as an error or success
+                hook((resultAction === null || resultAction === void 0 ? void 0 : resultAction.data) || null);
                 return [2 /*return*/];
         }
     });

package/lib/services/fetchService.js

@@ -30,6 +30,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.sendFetch = exports.constructPath = exports.getApiRoot = exports.setApiRoot = void 0;
 var lodash_1 = require("lodash");
 var effects_1 = require("redux-saga/effects");
+var types_1 = require("../types");
 var error_1 = require("../utils/error");
 var apiRoot;
 /**
@@ -138,7 +139,7 @@ function sendFetch(config) {
                 isResponseJson = !!response_1.headers &&
                     response_1.headers.has('Content-Type') &&
                     isContentTypeJson(response_1.headers.get('Content-Type'));
-                if (!(response_1.status === 204)) return [3 /*break*/, 3];
+                if (!(response_1.status === types_1.HTTP_STATUS_CODE.NO_CONTENT)) return [3 /*break*/, 3];
                 result.data = isBodyJson ? config.body : undefined;
                 return [3 /*break*/, 8];
             case 3:

package/lib/types/net/HTTPStatusCode.d.ts

@@ -5,6 +5,7 @@ export declare enum HTTP_STATUS_CODE {
     BAD_REQUEST = 400,
     UNAUTHORIZED = 401,
     FORBIDDEN = 403,
+    NOT_FOUND = 404,
     REQUEST_TIMEOUT = 408,
     INTERNAL_SERVER_ERROR = 500
 }

package/lib/types/net/HTTPStatusCode.js

@@ -9,6 +9,7 @@ var HTTP_STATUS_CODE;
     HTTP_STATUS_CODE[HTTP_STATUS_CODE["BAD_REQUEST"] = 400] = "BAD_REQUEST";
     HTTP_STATUS_CODE[HTTP_STATUS_CODE["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
     HTTP_STATUS_CODE[HTTP_STATUS_CODE["FORBIDDEN"] = 403] = "FORBIDDEN";
+    HTTP_STATUS_CODE[HTTP_STATUS_CODE["NOT_FOUND"] = 404] = "NOT_FOUND";
     HTTP_STATUS_CODE[HTTP_STATUS_CODE["REQUEST_TIMEOUT"] = 408] = "REQUEST_TIMEOUT";
     HTTP_STATUS_CODE[HTTP_STATUS_CODE["INTERNAL_SERVER_ERROR"] = 500] = "INTERNAL_SERVER_ERROR";
 })(HTTP_STATUS_CODE = exports.HTTP_STATUS_CODE || (exports.HTTP_STATUS_CODE = {}));

package/lib/utils/quill.js

@@ -19,6 +19,7 @@ var quill_1 = __importDefault(require("quill"));
 var uuid_1 = require("uuid");
 var actionCreator_1 = require("../redux/actionCreator");
 var noStoreSaga_1 = require("../redux/sagas/noStoreSaga");
+var types_1 = require("../types");
 var Delta = quill_1.default.import('delta');
 /**
  * Check for non-public in the provided quill contents. Update the ImageValue of an op if an image is found to be
@@ -31,40 +32,53 @@ var checkForNonPublicImages = function (quill, checkedImages) {
     var _a, _b;
     (_b = (_a = quill
         .getContents()) === null || _a === void 0 ? void 0 : _a.ops // Is the op an image and have we not seen it before?
-    ) === null || _b === void 0 ? void 0 : _b.filter(function (op) { var _a; return ((_a = op.insert) === null || _a === void 0 ? void 0 : _a.image) && !checkedImages.find(function (image) { return image.src === op.insert.image.src; }); }).forEach(function (op) {
+    ) === null || _b === void 0 ? void 0 : _b.filter(function (op) {
+        return op.insert.image &&
+            !checkedImages.find(function (image) { return image.src === op.insert.image.src; }) &&
+            op.insert.image.src.startsWith('http');
+    }).forEach(function (op) {
         // Check if the image is public. Do not check data:image urls
-        if (op.insert.image.src && op.insert.image.src.startsWith('http')) {
-            // Use the backend to check if the image is public
-            // Due to CSP and other security measures, we can't check this in the frontend
-            // uuidv5 is a deterministic uuid generator based on a namespace and a name
-            // uuidv5.URL is the namespace for urls
-            var hookId_1 = uuid_1.v5(op.insert.image.src, uuid_1.v5.URL);
-            noStoreSaga_1.noStoreHooks.registerNoStoreActionHook(hookId_1, function (data) {
-                noStoreSaga_1.noStoreHooks.unregisterNoStoreActionHook(hookId_1);
-                // Backend fetches the URL. If there is no data returned or if the data returned has headers
-                // but those headers are not of image type (i.e. it was a 302 that, when followed returned HTML
-                // (I'm looking at you, Brightspace), then we update the image insert op to be nonPublic
-                if (!data || (data['Content-Type'] && !data['Content-Type'][0].startsWith('image'))) {
-                    var contents = quill.getContents();
-                    var ops = contents.map(function (o) {
-                        var _a, _b;
-                        return ((_a = o.insert.image) === null || _a === void 0 ? void 0 : _a.src) && ((_b = op.insert.image) === null || _b === void 0 ? void 0 : _b.src) && o.insert.image.src === op.insert.image.src
-                            ? __assign(__assign({}, o), { insert: __assign(__assign({}, o.insert), { image: __assign(__assign({}, o.insert.image), { nonPublic: true }) }) }) : o;
-                    });
-                    var updatedContents = contents.diff(new Delta(ops));
-                    quill.updateContents(updatedContents);
-                }
-            });
-            // This endpoint returns headers for a url. If the url is nonexistent, it will return null
-            actionCreator_1.dispatchModelFetchRequest({
-                modelName: 'urlChecker',
-                guid: hookId_1,
-                noStore: true,
-                queryParams: {
-                    url: op.insert.image.src
-                }
-            });
-        }
+        // Use the backend to check if the image is public
+        // Due to CSP and other security measures, we can't check this in the frontend
+        // uuidv5 is a deterministic uuid generator based on a namespace and a name
+        // uuidv5.URL is the namespace for urls
+        var hookId = uuid_1.v5(op.insert.image.src, uuid_1.v5.URL);
+        noStoreSaga_1.noStoreHooks.registerNoStoreActionHook(hookId, function (data) {
+            noStoreSaga_1.noStoreHooks.unregisterNoStoreActionHook(hookId);
+            var contentTypeKey;
+            /**
+             * API fetches the URL, and `noStoreSaga` returns either the result or error
+             * * `data` is `null` when the API could not fetch the URL with a successful status code, and returns `null` => `nonPublic`
+             * * `data` is `FetchErrorData` if the API request itself failed, e.g. from some unknown error, we don't know if the image is public => do not update
+             * * `data` is a dictionary of headers when the API does fetch the URL
+             *   * if there is no `Content-Type` header, we don't know if the image is public => do not update
+             *   * if there is a `Content-Type` header, but is NOT an image type (i.e. it was a 302 that, when followed returned HTML)
+             *     (I'm looking at you, Brightspace) => `nonPublic`
+             *   * if there is a `Content-Type` header, and it is an image type, then the image is public => do not update
+             */
+            if (!data ||
+                (!types_1.isFetchErrorData(data) &&
+                    (contentTypeKey = Object.keys(data).find(function (k) { return k.toLowerCase() === 'content-type'; })) &&
+                    !data[contentTypeKey][0].startsWith('image'))) {
+                var contents = quill.getContents();
+                var ops = contents.map(function (o) {
+                    var _a;
+                    return ((_a = o.insert.image) === null || _a === void 0 ? void 0 : _a.src) && op.insert.image.src && o.insert.image.src === op.insert.image.src
+                        ? __assign(__assign({}, o), { insert: __assign(__assign({}, o.insert), { image: __assign(__assign({}, o.insert.image), { nonPublic: true }) }) }) : o;
+                });
+                var updatedContents = contents.diff(new Delta(ops));
+                quill.updateContents(updatedContents);
+            }
+        });
+        // This endpoint returns headers for a url. If the url is nonexistent, it will return null
+        actionCreator_1.dispatchModelFetchRequest({
+            modelName: 'urlChecker',
+            guid: hookId,
+            noStore: true,
+            queryParams: {
+                url: op.insert.image.src
+            }
+        });
     });
 };
 exports.checkForNonPublicImages = checkForNonPublicImages;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "studiokit-scaffolding-js",
-	"version": "5.2.0-next.2.6",
+	"version": "5.2.0-next.2.8",
 	"description": "Common scaffolding for Studio apps at Purdue",
 	"repository": "https://gitlab.com/purdue-informatics/studiokit/studiokit-scaffolding-js",
 	"license": "MIT",