@gen3/core 0.12.51 → 0.12.53

package/dist/cjs/index.js

@@ -997,96 +997,6 @@ const ExtractValueFromObject = (obj, key, valueIfNotFound)=>{
     return obj?.[key] ?? valueIfNotFound;
 };
 
-const DAYS_IN_YEAR = 365.25;
-/**
- * Converts HistogramData to HistogramDataAsStringKey by ensuring the key is a string.
- * If the key is already a string, it's used as is.
- * If the key is a number tuple [min, max], it's converted to a string in the format "min-max".
- *
- * @param data The HistogramData object to convert
- * @returns HistogramDataAsStringKey with the converted key
- */ const convertToHistogramDataAsStringKey = (data)=>{
-    return {
-        key: typeof data.key === 'string' ? data.key : `${data.key[0]}-${data.key[1]}`,
-        count: data.count
-    };
-};
-const calculatePercentageAsNumber = (count, total)=>count ? count / total * 100 : 0;
-const calculatePercentageAsString = (count, total)=>`${(count / total * 100).toFixed(2)}%`;
-const capitalize$1 = (original)=>{
-    const customCapitalizations = {
-        id: 'ID',
-        uuid: 'UUID',
-        dna: 'DNA',
-        dbsnp: 'dbSNP',
-        cosmic: 'COSMIC',
-        civic: 'CIViC',
-        dbgap: 'dbGaP',
-        ecog: 'ECOG',
-        bmi: 'BMI',
-        gdc: 'GDC',
-        cnv: 'CNV',
-        ssm: 'SSM',
-        aa: 'AA'
-    };
-    return original.split(' ').map((word)=>customCapitalizations[word.toLowerCase()] || `${word.charAt(0).toUpperCase()}${word.slice(1)}`).join(' ');
-};
-const humanify = ({ term = '', capitalize: cap = true, facetTerm = false })=>{
-    let original;
-    let humanified;
-    if (facetTerm) {
-        // Splits on capital letters followed by lowercase letters to find
-        // words squished together in a string.
-        original = term?.split(/(?=[A-Z][a-z])/).join(' ');
-        humanified = term?.replace(/\./g, ' ').replace(/_/g, ' ').trim();
-    } else {
-        const split = (original || term)?.split('.');
-        humanified = split[split.length - 1]?.replace(/_/g, ' ').trim();
-        // Special case 'name' to include any parent nested for sake of
-        // specificity in the UI
-        if (humanified === 'name' && split?.length > 1) {
-            humanified = `${split[split?.length - 2]} ${humanified}`;
-        }
-    }
-    return cap ? capitalize$1(humanified) : humanified;
-};
-/*https://github.com/NCI-GDC/portal-ui/blob/develop/src/packages/%40ncigdc/utils/ageDisplay.js*/ /**
- * Converts age in days into a human-readable format.
- *
- * @param ageInDays - The age in days.
- * @param yearsOnly - If true, only display years.
- *   @defaultValue false
- * @param defaultValue - The default value to return if ageInDays is falsy.
- *   @defaultValue "--"
- * @returns The formatted age string.
- */ const ageDisplay = (ageInDays, yearsOnly = false, defaultValue = '--')=>{
-    if (ageInDays !== 0 && !ageInDays) {
-        return defaultValue;
-    }
-    const calculateYearsAndDays = (years, days)=>days === 365 ? [
-            years + 1,
-            0
-        ] : [
-            years,
-            days
-        ];
-    const ABS_AGE_DAYS = Math.abs(ageInDays);
-    const [years, remainingDays] = calculateYearsAndDays(Math.floor(ABS_AGE_DAYS / DAYS_IN_YEAR), Math.ceil(ABS_AGE_DAYS % DAYS_IN_YEAR));
-    const formattedYears = years === 0 ? '' : `${years} ${years === 1 ? 'year' : 'years'}`;
-    const formattedDays = !yearsOnly && remainingDays > 0 ? `${remainingDays} ${remainingDays === 1 ? 'day' : 'days'}` : years === 0 && remainingDays === 0 ? '0 days' : '';
-    const ageString = [
-        formattedYears,
-        formattedDays
-    ].filter(Boolean).join(' ');
-    return ageInDays >= 0 ? ageString : `-${ageString}`;
-};
-/**
- * Given an object of JSON, stringify it into a string.
- * @param obj - the object to stringify
- * @param defaults - the default value to return if the object is undefined
- * @category Utility
- */ const stringifyJSONParam = (obj, defaults = '{}')=>obj ? JSON.stringify(obj) : defaults;
-
 // type guard functions
 const isHistogramRangeData = (key)=>{
     return Array.isArray(key) && key.length === 2 && key.every((item)=>typeof item === 'number');
@@ -1183,7 +1093,75 @@ function isHttpStatusError(error) {
  */ function isFetchParseError(error) {
     return typeof error === 'object' && error != null && 'originalStatus' in error && 'status' in error && error['status'] === 'PARSING_ERROR';
 }
+/**
+ * Type predicate to narrow an unknown error to a `SerializedError`
+ */ function isSerializedError(error) {
+    return typeof error === 'object' && error != null && !('status' in error) && ('message' in error || 'name' in error || 'code' in error || 'stack' in error);
+}
+
+const HTTPUserFriendlyErrorMessages = {
+    // 4xx Client Errors
+    400: 'Sorry, there was a problem with your request. Please check the information you provided and try again.',
+    401: 'Please sign in to access this content. If you need to create an account, please contact support.',
+    402: 'This feature requires payment to continue. Please update your subscription.',
+    403: "You don't have permission to access this. If you think this is a mistake, please contact support.",
+    404: "We couldn't find what you're looking for. The link might be broken or the content may have been moved.",
+    405: 'This action is not supported. Please try a different approach.',
+    406: "Your browser sent a request that this server couldn't understand. Try updating your browser.",
+    407: 'Please authenticate with the network proxy first.',
+    408: 'The request took too long to complete. Please check your internet connection and try again.',
+    409: 'There was a conflict with your request. Someone might have modified the same content.',
+    410: 'This content has been permanently removed and is no longer available.',
+    411: 'There was a technical problem with your request. Please try again.',
+    412: "Some conditions for this request weren't met. Please try again.",
+    413: "The file you're trying to upload is too large. Please choose a smaller file.",
+    414: 'The web address is too long. Please try a shorter URL.',
+    415: 'This type of file is not supported. Please try a different format.',
+    416: 'The requested content range is not available.',
+    417: "Your request couldn't be completed as expected. Please try again.",
+    418: 'Unusual error occurred. Please try again or contact support if the problem persists.',
+    421: 'Your request was sent to the wrong server. Please try again.',
+    422: "We couldn't process your request. Please check the information and try again.",
+    423: 'This resource is temporarily locked. Please try again in a few moments.',
+    424: 'The request failed because it depends on another request that failed.',
+    425: 'Your request was processed too early. Please try again in a moment.',
+    426: 'You need to upgrade your browser or app to continue.',
+    428: "Some required conditions weren't met. Please check all requirements and try again.",
+    429: "You've made too many requests. Please wait a while before trying again.",
+    431: 'Request failed because the headers are too large. Please simplify your request.',
+    451: 'This content is not available for legal reasons.',
+    // 5xx Server Errors
+    500: 'Something went wrong with the service. Please try again later.',
+    501: "This feature isn't available yet. Check back later.",
+    502: "We're having trouble connecting to our servers. Please try again in a few minutes.",
+    503: "Our service is temporarily unavailable. We're working to restore it as quickly as possible.",
+    504: 'The server took too long to respond. Please try again later.',
+    505: "Your browser's HTTP version isn't supported. Please try updating your browser.",
+    506: 'We encountered a configuration error.',
+    507: "We're out of storage space.",
+    508: 'We detected an infinite loop in our servers.',
+    510: 'This server requires additional extensions to process your request.',
+    511: 'Please sign in to the network before continuing.'
+};
 
+const MAX_ERROR_LENGTH = 256;
+const DEFAULT_API_ERROR_MESSAGE = 'API Query Error';
+/**
+ * Checks if a string appears to be an HTML page
+ */ function isHtmlContent(str) {
+    const trimmed = str.trim().toLowerCase();
+    return trimmed.startsWith('<!doctype html') || trimmed.startsWith('<html') || /<html[\s>]/i.test(str);
+}
+/**
+ * Sanitizes an error message - returns DEFAULT_API_ERROR_MESSAGE if
+ * the message is too long or contains HTML content
+ */ function sanitizeErrorMessage(message) {
+    if (!message) return DEFAULT_API_ERROR_MESSAGE;
+    if (message.length > MAX_ERROR_LENGTH || isHtmlContent(message)) {
+        return DEFAULT_API_ERROR_MESSAGE;
+    }
+    return message;
+}
 /** Best-effort message extraction from an HTTP error body */ function extractMessage(data) {
     if (typeof data === 'string') return data;
     if (typeof data === 'object' && data != null) {
@@ -1210,10 +1188,11 @@ function normalizeRtkError(error) {
     if (isFetchBaseQueryError(error)) {
         // status is number for HTTP errors, string literal for the others
         if (typeof error.status === 'number') {
+            const extractedMessage = extractMessage(error.data);
             return {
                 type: 'HTTP_ERROR',
                 status: error.status,
-                message: extractMessage(error.data) ?? `Request failed with status ${error.status}`,
+                message: sanitizeErrorMessage(extractedMessage) !== DEFAULT_API_ERROR_MESSAGE ? sanitizeErrorMessage(extractedMessage) : HTTPUserFriendlyErrorMessages[error.status] ?? `Request failed with status ${error.status}`,
                 data: error.data
             };
         }
@@ -1227,18 +1206,18 @@ function normalizeRtkError(error) {
                 return {
                     type: 'PARSING_ERROR',
                     status: error.originalStatus,
-                    message: error.error,
+                    message: HTTPUserFriendlyErrorMessages[error.originalStatus] ?? `Request failed with status ${error.originalStatus}`,
                     data: error.data
                 };
             case 'TIMEOUT_ERROR':
                 return {
                     type: 'TIMEOUT_ERROR',
-                    message: error.error
+                    message: sanitizeErrorMessage(error.error)
                 };
             case 'CUSTOM_ERROR':
                 return {
                     type: 'CUSTOM_ERROR',
-                    message: error.error,
+                    message: sanitizeErrorMessage(error.error),
                     data: error.data
                 };
         }
@@ -1247,7 +1226,7 @@ function normalizeRtkError(error) {
     if ('message' in error || 'name' in error) {
         return {
             type: 'SERIALIZED_ERROR',
-            message: error.message ?? 'An error occurred'
+            message: sanitizeErrorMessage(error.message) || 'An error occurred'
         };
     }
     return {
@@ -1256,6 +1235,96 @@ function normalizeRtkError(error) {
     };
 }
 
+const DAYS_IN_YEAR = 365.25;
+/**
+ * Converts HistogramData to HistogramDataAsStringKey by ensuring the key is a string.
+ * If the key is already a string, it's used as is.
+ * If the key is a number tuple [min, max], it's converted to a string in the format "min-max".
+ *
+ * @param data The HistogramData object to convert
+ * @returns HistogramDataAsStringKey with the converted key
+ */ const convertToHistogramDataAsStringKey = (data)=>{
+    return {
+        key: typeof data.key === 'string' ? data.key : `${data.key[0]}-${data.key[1]}`,
+        count: data.count
+    };
+};
+const calculatePercentageAsNumber = (count, total)=>count ? count / total * 100 : 0;
+const calculatePercentageAsString = (count, total)=>`${(count / total * 100).toFixed(2)}%`;
+const capitalize$1 = (original)=>{
+    const customCapitalizations = {
+        id: 'ID',
+        uuid: 'UUID',
+        dna: 'DNA',
+        dbsnp: 'dbSNP',
+        cosmic: 'COSMIC',
+        civic: 'CIViC',
+        dbgap: 'dbGaP',
+        ecog: 'ECOG',
+        bmi: 'BMI',
+        gdc: 'GDC',
+        cnv: 'CNV',
+        ssm: 'SSM',
+        aa: 'AA'
+    };
+    return original.split(' ').map((word)=>customCapitalizations[word.toLowerCase()] || `${word.charAt(0).toUpperCase()}${word.slice(1)}`).join(' ');
+};
+const humanify = ({ term = '', capitalize: cap = true, facetTerm = false })=>{
+    let original;
+    let humanified;
+    if (facetTerm) {
+        // Splits on capital letters followed by lowercase letters to find
+        // words squished together in a string.
+        original = term?.split(/(?=[A-Z][a-z])/).join(' ');
+        humanified = term?.replace(/\./g, ' ').replace(/_/g, ' ').trim();
+    } else {
+        const split = (original || term)?.split('.');
+        humanified = split[split.length - 1]?.replace(/_/g, ' ').trim();
+        // Special case 'name' to include any parent nested for sake of
+        // specificity in the UI
+        if (humanified === 'name' && split?.length > 1) {
+            humanified = `${split[split?.length - 2]} ${humanified}`;
+        }
+    }
+    return cap ? capitalize$1(humanified) : humanified;
+};
+/*https://github.com/NCI-GDC/portal-ui/blob/develop/src/packages/%40ncigdc/utils/ageDisplay.js*/ /**
+ * Converts age in days into a human-readable format.
+ *
+ * @param ageInDays - The age in days.
+ * @param yearsOnly - If true, only display years.
+ *   @defaultValue false
+ * @param defaultValue - The default value to return if ageInDays is falsy.
+ *   @defaultValue "--"
+ * @returns The formatted age string.
+ */ const ageDisplay = (ageInDays, yearsOnly = false, defaultValue = '--')=>{
+    if (ageInDays !== 0 && !ageInDays) {
+        return defaultValue;
+    }
+    const calculateYearsAndDays = (years, days)=>days === 365 ? [
+            years + 1,
+            0
+        ] : [
+            years,
+            days
+        ];
+    const ABS_AGE_DAYS = Math.abs(ageInDays);
+    const [years, remainingDays] = calculateYearsAndDays(Math.floor(ABS_AGE_DAYS / DAYS_IN_YEAR), Math.ceil(ABS_AGE_DAYS % DAYS_IN_YEAR));
+    const formattedYears = years === 0 ? '' : `${years} ${years === 1 ? 'year' : 'years'}`;
+    const formattedDays = !yearsOnly && remainingDays > 0 ? `${remainingDays} ${remainingDays === 1 ? 'day' : 'days'}` : years === 0 && remainingDays === 0 ? '0 days' : '';
+    const ageString = [
+        formattedYears,
+        formattedDays
+    ].filter(Boolean).join(' ');
+    return ageInDays >= 0 ? ageString : `-${ageString}`;
+};
+/**
+ * Given an object of JSON, stringify it into a string.
+ * @param obj - the object to stringify
+ * @param defaults - the default value to return if the object is undefined
+ * @category Utility
+ */ const stringifyJSONParam = (obj, defaults = '{}')=>obj ? JSON.stringify(obj) : defaults;
+
 const queryWTSFederatedLoginStatus = async (signal)=>{
     try {
         const results = await fetchJSONDataFromURL(`${GEN3_WTS_API}/external_oidc/`, false, HttpMethod.GET, undefined, signal);
@@ -6956,6 +7025,7 @@ exports.GEN3_SUBMISSION_API = GEN3_SUBMISSION_API;
 exports.GEN3_WORKSPACE_API = GEN3_WORKSPACE_API;
 exports.HTTPError = HTTPError;
 exports.HTTPErrorMessages = HTTPErrorMessages;
+exports.HTTPUserFriendlyErrorMessages = HTTPUserFriendlyErrorMessages;
 exports.HttpMethod = HttpMethod;
 exports.MissingServiceConfigurationError = MissingServiceConfigurationError;
 exports.Modals = Modals;
@@ -7095,6 +7165,7 @@ exports.isOperatorWithFieldAndArrayOfOperands = isOperatorWithFieldAndArrayOfOpe
 exports.isPending = isPending;
 exports.isProgramUrl = isProgramUrl;
 exports.isRootUrl = isRootUrl;
+exports.isSerializedError = isSerializedError;
 exports.isStatsValue = isStatsValue;
 exports.isStatsValuesArray = isStatsValuesArray;
 exports.isString = isString;