studiokit-scaffolding-js 5.2.0-next.2.7 → 5.2.0-next.2.9

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/actions/AuthAction.d.ts

@@ -2,7 +2,6 @@ import { Action } from 'redux';
 import { CasV1LoginRequestBody, IdentityProvider } from '../../types';
 import { LocalLoginRequestBody } from '../../types/auth/LocalLoginRequestBody';
 import { OAuthToken, OAuthTokenOrNull } from '../../types/net';
-import { BaseModelFetchRequestAction } from './ModelAction';
 export declare enum AUTH_ACTION_TYPE {
     CAS_LOGIN_REQUESTED = "auth/CAS_LOGIN_REQUESTED",
     LOGIN_REQUESTED = "auth/LOGIN_REQUESTED",
@@ -43,12 +42,12 @@ export interface AuthIdentityProviderRequestAction extends Action<AUTH_IDENTITY_
 export declare enum AUTH_CAS_V1_LOGIN_REQUEST_ACTION_TYPE {
     CAS_V1_LOGIN_REQUEST = "auth/CAS_V1_LOGIN_REQUEST"
 }
-export interface AuthCasV1LoginRequestAction extends Omit<BaseModelFetchRequestAction<AUTH_CAS_V1_LOGIN_REQUEST_ACTION_TYPE>, 'modelName' | 'pathParams'> {
+export interface AuthCasV1LoginRequestAction extends Action<AUTH_CAS_V1_LOGIN_REQUEST_ACTION_TYPE> {
     body: CasV1LoginRequestBody;
 }
 export declare enum AUTH_LOCAL_LOGIN_REQUEST_ACTION_TYPE {
     LOCAL_LOGIN_REQUEST = "auth/LOCAL_LOGIN_REQUEST"
 }
-export interface AuthLocalLoginRequestAction extends Omit<BaseModelFetchRequestAction<AUTH_LOCAL_LOGIN_REQUEST_ACTION_TYPE>, 'modelName' | 'pathParams'> {
+export interface AuthLocalLoginRequestAction extends Action<AUTH_LOCAL_LOGIN_REQUEST_ACTION_TYPE> {
     body: LocalLoginRequestBody;
 }

package/lib/redux/sagas/authSaga.js

@@ -1,15 +1,4 @@
 "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);
-};
 var __generator = (this && this.__generator) || function (thisArg, body) {
     var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
     return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
@@ -236,9 +225,16 @@ function credentialsLoginFlow(action, modelName) {
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
-                modelFetchRequestAction = __assign(__assign({}, action), { 
-                    // set required overrides
-                    type: actions_1.MODEL_FETCH_REQUEST_ACTION_TYPE.FETCH_REQUEST, modelName: modelName, noStore: true });
+                modelFetchRequestAction = {
+                    // set required defaults
+                    type: actions_1.MODEL_FETCH_REQUEST_ACTION_TYPE.FETCH_REQUEST,
+                    modelName: modelName,
+                    noStore: true,
+                    // force no retry
+                    noRetry: true,
+                    // pass thru body
+                    body: action.body
+                };
                 return [4 /*yield*/, effects_1.call(loginFlow, modelFetchRequestAction)];
             case 1: return [2 /*return*/, _a.sent()];
         }
@@ -323,7 +319,7 @@ var getOAuthToken = function (modelName) {
 };
 exports.getOAuthToken = getOAuthToken;
 function authSaga(clientCredentialsParam, tokenPersistenceServiceParam, ticketProviderService, codeProviderService) {
-    var casTicket, service, code, _a, casV1Action, localAction;
+    var casTicket, service, code, _a, casV1Action, localLoginAction;
     if (tokenPersistenceServiceParam === void 0) { tokenPersistenceServiceParam = tokenPersistenceService_1.tokenPersistenceService; }
     if (ticketProviderService === void 0) { ticketProviderService = ticketProviderService_1.ticketProviderService; }
     if (codeProviderService === void 0) { codeProviderService = codeProviderService_1.codeProviderService; }
@@ -381,10 +377,10 @@ function authSaga(clientCredentialsParam, tokenPersistenceServiceParam, ticketPr
                 if (!!oauthToken) return [3 /*break*/, 16];
                 return [4 /*yield*/, effects_1.race({
                         casV1Action: effects_1.take(actions_1.AUTH_CAS_V1_LOGIN_REQUEST_ACTION_TYPE.CAS_V1_LOGIN_REQUEST),
-                        localAction: effects_1.take(actions_1.AUTH_LOCAL_LOGIN_REQUEST_ACTION_TYPE.LOCAL_LOGIN_REQUEST)
+                        localLoginAction: effects_1.take(actions_1.AUTH_LOCAL_LOGIN_REQUEST_ACTION_TYPE.LOCAL_LOGIN_REQUEST)
                     })];
             case 11:
-                _a = _b.sent(), casV1Action = _a.casV1Action, localAction = _a.localAction;
+                _a = _b.sent(), casV1Action = _a.casV1Action, localLoginAction = _a.localLoginAction;
                 return [4 /*yield*/, effects_1.put({ type: actions_1.AUTH_ACTION_TYPE.LOGIN_REQUESTED })];
             case 12:
                 _b.sent();
@@ -394,8 +390,8 @@ function authSaga(clientCredentialsParam, tokenPersistenceServiceParam, ticketPr
                 oauthToken = _b.sent();
                 return [3 /*break*/, 16];
             case 14:
-                if (!localAction) return [3 /*break*/, 16];
-                return [4 /*yield*/, effects_1.call(localLoginFlow, localAction)];
+                if (!localLoginAction) return [3 /*break*/, 16];
+                return [4 /*yield*/, effects_1.call(localLoginFlow, localLoginAction)];
             case 15:
                 oauthToken = _b.sent();
                 _b.label = 16;

package/lib/redux/sagas/modelFetchSaga.js

@@ -308,7 +308,7 @@ 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: request timeout)
+                // Do not 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) {

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/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.7",
+	"version": "5.2.0-next.2.9",
 	"description": "Common scaffolding for Studio apps at Purdue",
 	"repository": "https://gitlab.com/purdue-informatics/studiokit/studiokit-scaffolding-js",
 	"license": "MIT",