mirror of
https://github.com/outline/outline.git
synced 2026-11-22 22:02:35 +03:00
* React 19 upgrade Bumps react and react-dom to 19.2.8, with the dependency changes React 19 requires: react-is 19, @types/react 19, @types/react-dom 19, react-helmet-async 3 and react-avatar-editor 15 (which now ships its own types). framer-motion moves to 13 — its v6 types reference React.ReactHTML, removed from @types/react 19. The type changes fall into a few classes: - The global JSX namespace is gone, so JSX.Element becomes React.JSX.Element and the custom element declarations move into a module augmentation. - useRef() now requires an initial value. - A ref created with a null initial value is typed nullable, so consumers that accept one are widened to RefObject<T | null>. - React.ReactChild was removed; tooltips take React.ReactNode. - Ref callbacks may only return a cleanup function. react-dnd connectors return the connected node, so useDragRef and useDropRef wrap useDrag and useDrop and hand back a ref callback. react-i18next stays on v12: i18next 23 drops compatibilityJSON "v3", which would rewrite all 64 _plural keys across every locale. outline-icons, oy-vey and react-waypoint have no release that lists React 19 as a peer. All three render correctly under it; the install reports them as unmet peers. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * Remove react-helmet and forwardRef --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
126 lines
4.1 KiB
TypeScript
126 lines
4.1 KiB
TypeScript
import { useCallback, useMemo, useRef, useState } from "react";
|
|
import type Document from "~/models/Document";
|
|
import { LRUCache } from "@shared/utils/LRUCache";
|
|
import { ProsemirrorHelper } from "~/models/helpers/ProsemirrorHelper";
|
|
import {
|
|
SearchIndex,
|
|
type SearchIndexDocument,
|
|
type SearchIndexResult,
|
|
} from "./SearchIndex";
|
|
|
|
const plainTextCache = new LRUCache<{ updatedAt: string; text: string }>({
|
|
max: 100,
|
|
storage: "memory",
|
|
});
|
|
|
|
/**
|
|
* Returns the plain text content of a document, memoized so that repeated
|
|
* indexing passes do not reparse unchanged ProseMirror data. The cache holds at
|
|
* most one entry per document, invalidated when the document is edited, and is
|
|
* bounded to the most recently used documents.
|
|
*/
|
|
function getPlainText(doc: Document): string {
|
|
const updatedAt = String(doc.updatedAt ?? "");
|
|
const cached = plainTextCache.get(doc.id);
|
|
if (cached?.updatedAt === updatedAt) {
|
|
return cached.text;
|
|
}
|
|
const text = ProsemirrorHelper.toPlainText(doc);
|
|
plainTextCache.set(doc.id, { updatedAt, text });
|
|
return text;
|
|
}
|
|
|
|
/** Removes server-generated `<b>` highlight tags from a context snippet. */
|
|
function stripHighlightTags(context: string | undefined): string | undefined {
|
|
return context?.replace(/<b\b[^>]*>(.*?)<\/b>/gi, "$1");
|
|
}
|
|
|
|
/**
|
|
* Builds an index record from a document model, using its content when loaded
|
|
* and otherwise falling back to a server-provided context snippet.
|
|
*
|
|
* @param doc the document to index.
|
|
* @param context an optional server search context snippet to use as content.
|
|
* @returns the index record.
|
|
*/
|
|
export function toSearchRecord(
|
|
doc: Document,
|
|
context?: string
|
|
): SearchIndexDocument {
|
|
return {
|
|
id: doc.id,
|
|
title: doc.titleWithDefault,
|
|
url: doc.url,
|
|
text: doc.data ? getPlainText(doc) : stripHighlightTags(context),
|
|
icon: doc.icon,
|
|
color: doc.color,
|
|
isArchived: doc.isArchived,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Returns the command bar priority that preserves a result's position in the
|
|
* list. The command bar re-ranks registered actions with its own fuzzy matcher
|
|
* and orders each section by `priority + score`, where score never spans more
|
|
* than 0.5 — so a step of one per position keeps our ordering intact.
|
|
*
|
|
* @param index the position of the result.
|
|
* @param total the total number of results.
|
|
* @returns the priority to assign to the action.
|
|
*/
|
|
export function toActionPriority(index: number, total: number): number {
|
|
return total - index;
|
|
}
|
|
|
|
export interface UseSearchIndex {
|
|
/** Fuzzy matches for the current query, ordered by relevance. */
|
|
results: SearchIndexResult[];
|
|
/** Merges documents into the index, re-running the search if anything changed. */
|
|
feed: (documents: SearchIndexDocument[]) => void;
|
|
/** Empties the index and any cached document content. */
|
|
reset: () => void;
|
|
}
|
|
|
|
/**
|
|
* Maintains a client-side fuzzy search index and searches it for the given
|
|
* query. The index is fed incrementally via the returned `feed` function, and
|
|
* results are computed synchronously so they never lag behind the query.
|
|
*
|
|
* @param query the current search query.
|
|
* @returns the current results and functions to feed or reset the index.
|
|
*/
|
|
export function useSearchIndex(query: string): UseSearchIndex {
|
|
const indexRef = useRef<SearchIndex | undefined>(undefined);
|
|
if (!indexRef.current) {
|
|
indexRef.current = new SearchIndex();
|
|
}
|
|
const index = indexRef.current;
|
|
|
|
// Bumped whenever the index changes, to re-run the memoized search below.
|
|
const [version, setVersion] = useState(0);
|
|
|
|
const feed = useCallback(
|
|
(documents: SearchIndexDocument[]) => {
|
|
if (index.update(documents)) {
|
|
setVersion((v) => v + 1);
|
|
}
|
|
},
|
|
[index]
|
|
);
|
|
|
|
const reset = useCallback(() => {
|
|
index.clear();
|
|
plainTextCache.clear();
|
|
setVersion((v) => v + 1);
|
|
}, [index]);
|
|
|
|
const results = useMemo<SearchIndexResult[]>(
|
|
() => (query ? index.search(query) : []),
|
|
// The index mutates in place, so `version` is what marks the memo stale.
|
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
[index, query, version]
|
|
);
|
|
|
|
return { results, feed, reset };
|
|
}
|