chore: import upstream snapshot with attribution
This commit is contained in:
@@ -0,0 +1,156 @@
|
||||
import type { UIMatch } from "@remix-run/react";
|
||||
import { useMatches } from "@remix-run/react";
|
||||
|
||||
const DEFAULT_REDIRECT = "/";
|
||||
|
||||
// Pathnames that are NOT user-navigable destinations: fetcher endpoints,
|
||||
// OAuth/auth callbacks, JSON APIs, the magic-link redemption route, and the
|
||||
// auth flow routes themselves (which would create a redirect loop). Note
|
||||
// `/admin/api/` covers admin JSON endpoints while leaving `/admin`,
|
||||
// `/admin/back-office/*`, `/admin/orgs`, etc. navigable.
|
||||
const NON_NAVIGABLE_PREFIXES = ["/resources/", "/auth/", "/admin/api/", "/api/", "/engine/"];
|
||||
const NON_NAVIGABLE_EXACT = new Set([
|
||||
"/magic",
|
||||
"/logout",
|
||||
"/login",
|
||||
"/login/magic",
|
||||
"/login/mfa",
|
||||
"/login/sso",
|
||||
]);
|
||||
|
||||
function isNavigablePath(pathname: string): boolean {
|
||||
if (NON_NAVIGABLE_EXACT.has(pathname)) return false;
|
||||
return !NON_NAVIGABLE_PREFIXES.some((prefix) => pathname.startsWith(prefix));
|
||||
}
|
||||
|
||||
/**
|
||||
* This should be used any time the redirect path is user-provided
|
||||
* (Like the query string on our login/signup pages). This avoids
|
||||
* open-redirect vulnerabilities and prevents redirecting users to
|
||||
* non-page routes (e.g. fetcher endpoints) that would render blank.
|
||||
* @param {string} path The redirect destination
|
||||
* @param {string} defaultRedirect The redirect to use if the to is unsafe.
|
||||
*/
|
||||
export function sanitizeRedirectPath(
|
||||
path: string | undefined | null,
|
||||
defaultRedirect: string = DEFAULT_REDIRECT
|
||||
): string {
|
||||
if (!path || typeof path !== "string") {
|
||||
return defaultRedirect;
|
||||
}
|
||||
|
||||
if (!path.startsWith("/") || path.startsWith("//")) {
|
||||
return defaultRedirect;
|
||||
}
|
||||
|
||||
try {
|
||||
// should not parse as a full URL
|
||||
new URL(path);
|
||||
return defaultRedirect;
|
||||
} catch {}
|
||||
|
||||
let parsed: URL;
|
||||
try {
|
||||
// ensure it's a valid relative path
|
||||
parsed = new URL(path, "https://example.com");
|
||||
if (parsed.hostname !== "example.com") {
|
||||
return defaultRedirect;
|
||||
}
|
||||
} catch {
|
||||
return defaultRedirect;
|
||||
}
|
||||
|
||||
if (!isNavigablePath(parsed.pathname)) {
|
||||
return defaultRedirect;
|
||||
}
|
||||
|
||||
return path;
|
||||
}
|
||||
|
||||
/**
|
||||
* This base hook is used in other hooks to quickly search for specific data
|
||||
* across all loader data using useMatches.
|
||||
* @param {string} id The route id
|
||||
* @returns {JSON|undefined} The router data or undefined if not found
|
||||
*/
|
||||
export function useMatchesData(id: string | string[], debug: boolean = false): UIMatch | undefined {
|
||||
const matchingRoutes = useMatches();
|
||||
|
||||
if (debug) {
|
||||
console.log("matchingRoutes", matchingRoutes);
|
||||
}
|
||||
|
||||
const paths = Array.isArray(id) ? id : [id];
|
||||
|
||||
// Get the first matching route
|
||||
const route = paths.reduce(
|
||||
(acc, path) => {
|
||||
if (acc) return acc;
|
||||
return matchingRoutes.find((route) => route.id === path);
|
||||
},
|
||||
undefined as UIMatch | undefined
|
||||
);
|
||||
|
||||
return route;
|
||||
}
|
||||
|
||||
export function validateEmail(email: unknown): email is string {
|
||||
return typeof email === "string" && email.length > 3 && email.includes("@");
|
||||
}
|
||||
|
||||
export function hydrateObject<T>(object: any): T {
|
||||
return hydrateDates(object) as T;
|
||||
}
|
||||
|
||||
export function hydrateDates(object: any): any {
|
||||
if (object === null || object === undefined) {
|
||||
return object;
|
||||
}
|
||||
|
||||
if (object instanceof Date) {
|
||||
return object;
|
||||
}
|
||||
|
||||
if (
|
||||
typeof object === "string" &&
|
||||
object.match(/\d{4}-\d{2}-\d{2}/) &&
|
||||
!Number.isNaN(Date.parse(object))
|
||||
) {
|
||||
return new Date(object);
|
||||
}
|
||||
|
||||
if (typeof object === "object") {
|
||||
if (Array.isArray(object)) {
|
||||
return object.map((item) => hydrateDates(item));
|
||||
} else {
|
||||
const hydratedObject: any = {};
|
||||
for (const key in object) {
|
||||
hydratedObject[key] = hydrateDates(object[key]);
|
||||
}
|
||||
return hydratedObject;
|
||||
}
|
||||
}
|
||||
|
||||
return object;
|
||||
}
|
||||
|
||||
export function titleCase(original: string): string {
|
||||
return original
|
||||
.split(" ")
|
||||
.map((word) => word[0].toUpperCase() + word.slice(1))
|
||||
.join(" ");
|
||||
}
|
||||
|
||||
// Takes an api key (either trigger_live_xxxx or trigger_development_xxxx) and returns trigger_live_********
|
||||
export const obfuscateApiKey = (apiKey: string) => {
|
||||
const [prefix, slug, secretPart] = apiKey.split("_");
|
||||
return `${prefix}_${slug}_${"*".repeat(secretPart.length)}`;
|
||||
};
|
||||
|
||||
export function appEnvTitleTag(appEnv?: string): string {
|
||||
if (!appEnv || appEnv === "production") {
|
||||
return "";
|
||||
}
|
||||
|
||||
return ` (${appEnv})`;
|
||||
}
|
||||
Reference in New Issue
Block a user