Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.
Go dockerfossgomarkdownmemomicroblognote-takingnotesopen-sourceown-your-datareactself-hostedsqlitetimeline
import { matchPath } from "react-router-dom";
import { extractSpaceUidFromName } from "@/lib/space-display";
export const ROUTES = {
HOME: "/",
ABOUT: "/about",
ATTACHMENTS: "/attachments",
INBOX: "/inbox",
ARCHIVED: "/archived",
CALENDAR: "/calendar",
MAP: "/map",
VIEWS: "/views",
SETTING: "/setting",
EXPLORE: "/explore",
USER_PROFILE: "/u/:username",
AUTH: "/auth",
AUTH_SIGNUP: "/auth/signup",
AUTH_ADMIN: "/auth/admin",
AUTH_CALLBACK: "/auth/callback",
SHARED_MEMO: "/memos/shares",
} as const;
/** Router pattern for the calendar: month and day are optional so `/calendar` can redirect. */
export const CALENDAR_ROUTE_PATTERN = `${ROUTES.CALENDAR}/:year?/:month?/:day?`;
export type RouteKey = keyof typeof ROUTES;
export type RoutePath = (typeof ROUTES)[RouteKey];
export const SPACE_ROUTE_PATTERN = "/spaces/:spaceUid";
/** Collection pages that exist both globally and beneath a Space. */
const COLLECTION_ROUTE_PATTERNS = [ROUTES.HOME, ROUTES.EXPLORE, ROUTES.ATTACHMENTS, CALENDAR_ROUTE_PATTERN, ROUTES.MAP];
const isCollectionPathname = (pathname: string): boolean =>
COLLECTION_ROUTE_PATTERNS.some((path) => matchPath({ path, caseSensitive: false }, pathname) !== null);
export interface CollectionRoute {
spaceName?: string;
/** The global twin of a collection page; otherwise the normalized pathname. */
pathname: string;
isCollection: boolean;
}
/** The URL owns collection scope; unknown Space subroutes are not collection pages. */
export const resolveCollectionRoute = (path: string): CollectionRoute => {
const pathname = (path.split(/[?#]/, 1)[0] || ROUTES.HOME).replace(/\/+$/, "") || ROUTES.HOME;
const spaceMatch = matchPath({ path: `${SPACE_ROUTE_PATTERN}/*`, caseSensitive: false }, pathname);
if (!spaceMatch) return { pathname, isCollection: isCollectionPathname(pathname) };
const uid = spaceMatch.params.spaceUid ?? "";
const collectionPath = `/${spaceMatch.params["*"] ?? ""}`;
// An encoded slash decodes into a UID that cannot round-trip through buildCollectionPath.
if (!uid || uid.includes("/") || !isCollectionPathname(collectionPath)) return { pathname, isCollection: false };
return { spaceName: `spaces/${uid}`, pathname: collectionPath, isCollection: true };
};
/** Builds a collection URL from a global collection pathname and an optional Space. */
export const buildCollectionPath = (pathname: string, spaceName?: string): string => {
const route = resolveCollectionRoute(pathname);
if (!route.isCollection) return pathname;
if (!spaceName) return route.pathname;
const base = `/spaces/${encodeURIComponent(extractSpaceUidFromName(spaceName))}`;
return route.pathname === ROUTES.HOME ? base : `${base}${route.pathname}`;
};
/** Carries the current Space into another collection view. */
export const collectionPathForLocation = (pathname: string, currentPath: string): string =>
buildCollectionPath(pathname, resolveCollectionRoute(currentPath).spaceName);
/** An explicit creator is a URL-owned collection filter, independent of the selected Space. */
export const getCollectionCreator = (search: string): string | undefined => {
const username = new URLSearchParams(search).get("creator");
return username || undefined;
};
export const withCollectionCreator = (search: string, username?: string): string => {
const params = new URLSearchParams(search);
if (username) params.set("creator", username);
else params.delete("creator");
const query = params.toString();
return query ? `?${query}` : "";
};
/** The canonical all-Space collection for one creator. */
export const getCreatorHomePath = (username: string): string => `${ROUTES.HOME}${withCollectionCreator("", username)}`;
/** Home is personal; Explore is all readable creators. Other collection views keep explicit creator filters. */
export const getCollectionHomePath = (location: { pathname: string; search: string }): string => {
const route = resolveCollectionRoute(location.pathname);
const home =
route.pathname === ROUTES.EXPLORE || (route.isCollection && route.pathname !== ROUTES.HOME && !getCollectionCreator(location.search))
? ROUTES.EXPLORE
: ROUTES.HOME;
return buildCollectionPath(home, route.spaceName);
};
/** Carries creator scope and collection filters between views, excluding view-specific query state. */
export const collectionNavigationPath = (
pathname: string,
location: { pathname: string; search: string },
currentUsername?: string,
): string => {
const route = resolveCollectionRoute(location.pathname);
const creator =
route.pathname === ROUTES.EXPLORE
? undefined
: ((route.isCollection ? getCollectionCreator(location.search) : undefined) ??
(!route.isCollection || route.pathname === ROUTES.HOME ? currentUsername : undefined));
const filter = route.isCollection ? new URLSearchParams(location.search).get("filter") : null;
const search = filter ? new URLSearchParams({ filter }).toString() : "";
// A memo list without a creator is Explore; this also sends guests there from any page.
if (pathname === ROUTES.HOME) {
const home = buildCollectionPath(creator ? ROUTES.HOME : ROUTES.EXPLORE, route.spaceName);
return `${home}${withCollectionCreator(search, creator === currentUsername ? undefined : creator)}`;
}
return `${collectionPathForLocation(pathname, location.pathname)}${withCollectionCreator(search, creator)}`;
};
/** A creator change keeps the current collection view and Space. */
export const getCreatorSwitchPath = (
location: { pathname: string; search: string; hash?: string },
username?: string,
currentUsername?: string,
): string => {
const route = resolveCollectionRoute(location.pathname);
const isMemoList = route.pathname === ROUTES.HOME || route.pathname === ROUTES.EXPLORE || !route.isCollection;
const pathname = isMemoList ? buildCollectionPath(username ? ROUTES.HOME : ROUTES.EXPLORE, route.spaceName) : location.pathname;
const creator = username === currentUsername && isMemoList ? undefined : username;
return `${pathname}${withCollectionCreator(location.search, creator)}${location.hash || ""}`;
};
/** Switching preserves collection views and their query; other pages start at Home. */
export const getSpaceSwitchPath = (location: { pathname: string; search: string; hash?: string }, spaceName?: string): string => {
const route = resolveCollectionRoute(location.pathname);
return route.isCollection
? `${buildCollectionPath(route.pathname, spaceName)}${location.search}${location.hash || ""}`
: buildCollectionPath(ROUTES.HOME, spaceName);
};