I think I have a working document cache solution that's actually pretty good.

This commit is contained in:
2025-07-03 16:24:58 -07:00
parent db4ce36c27
commit 503c98c895
26 changed files with 317 additions and 212 deletions

View File

@@ -1,13 +1,12 @@
import * as Icons from "@/components/Icons.tsx";
import type { AnyDocument, DocumentId } from "@/lib/types"; import type { AnyDocument, DocumentId } from "@/lib/types";
import { import {
Dialog, Dialog,
DialogPanel, DialogPanel,
DialogTitle,
Transition, Transition,
TransitionChild, TransitionChild,
} from "@headlessui/react"; } from "@headlessui/react";
import { Fragment, useCallback, useState } from "react"; import { Fragment, useCallback, useState } from "react";
import * as Icons from "@/components/Icons.tsx";
type Props<T extends AnyDocument> = { type Props<T extends AnyDocument> = {
title: React.ReactNode; title: React.ReactNode;
@@ -75,13 +74,13 @@ export function DocumentList<T extends AnyDocument>({
{error && ( {error && (
<div className="bg-red-900 rounded p-4 text-slate-100">{error}</div> <div className="bg-red-900 rounded p-4 text-slate-100">{error}</div>
)} )}
<ul className="space-y-2"> <ul className="flex flex-col space-y-2">
{items.map((item) => ( {items.map((item) => (
<li <li
key={item.id} key={item.id}
className="bg-slate-800 rounded p-4 text-slate-100 flex flex-row justify-between items-center" className="p-4 bg-slate-800 rounded text-slate-100 flex flex-row justify-between items-center"
> >
<div>{renderRow(item)}</div> {renderRow(item)}
{isEditing && ( {isEditing && (
<div> <div>

View File

@@ -1,5 +1,5 @@
import { DocumentList } from "@/components/DocumentList"; import { DocumentList } from "@/components/DocumentList";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache, useDocument } from "@/context/document/hooks";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import { displayName } from "@/lib/relationships"; import { displayName } from "@/lib/relationships";
import type { import type {
@@ -28,17 +28,30 @@ export function RelationshipList({
}: RelationshipListProps) { }: RelationshipListProps) {
const [_loading, setLoading] = useState(true); const [_loading, setLoading] = useState(true);
const [error, setError] = useState<string | null>(null); const [error, setError] = useState<string | null>(null);
const { state, dispatch } = useDocument(); const { docResult, dispatch } = useDocument(root.id);
const { cache } = useDocumentCache();
if (state.status === "loading") { if (docResult.type !== "ready") {
return <Loader />; return <Loader />;
} }
const doc = docResult.value.doc;
console.info("Rendering relationship list: ", relationshipType); console.info("Rendering relationship list: ", relationshipType);
const relationship = state.relationships[relationshipType]; const relationshipResult = docResult.value.relationships[relationshipType];
const itemIds = relationship?.secondary ?? [];
const items = itemIds.map((id) => state.relatedDocs[id]).filter((d) => !!d); if (relationshipResult?.type !== "ready") {
return <Loader />;
}
const relationship = relationshipResult.value;
const itemIds = relationship.secondary ?? [];
const items = itemIds
.map((id) => cache.documents[id])
.filter((d) => d && d.type === "ready")
.map((d) => d.value.doc);
const handleCreate = async (doc: AnyDocument) => { const handleCreate = async (doc: AnyDocument) => {
setLoading(true); setLoading(true);
@@ -54,6 +67,7 @@ export function RelationshipList({
}); });
dispatch({ dispatch({
type: "setRelationship", type: "setRelationship",
docId: doc.id,
relationship: updatedRelationship, relationship: updatedRelationship,
}); });
} else { } else {
@@ -67,6 +81,7 @@ export function RelationshipList({
}); });
dispatch({ dispatch({
type: "setRelationship", type: "setRelationship",
docId: doc.id,
relationship: updatedRelationship, relationship: updatedRelationship,
}); });
} }
@@ -91,6 +106,7 @@ export function RelationshipList({
}); });
dispatch({ dispatch({
type: "setRelationship", type: "setRelationship",
docId: doc.id,
relationship: updatedRelationship, relationship: updatedRelationship,
}); });
} }

View File

@@ -1,24 +1,35 @@
import { RelationshipList } from "@/components/RelationshipList"; import { RelationshipList } from "@/components/RelationshipList";
import { DocumentEditForm } from "@/components/documents/DocumentEditForm"; import { DocumentEditForm } from "@/components/documents/DocumentEditForm";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocument } from "@/context/document/hooks";
import { displayName, relationshipsForDocument } from "@/lib/relationships"; import { displayName, relationshipsForDocument } from "@/lib/relationships";
import { Tab, TabGroup, TabList, TabPanel, TabPanels } from "@headlessui/react"; import { Tab, TabGroup, TabList, TabPanel, TabPanels } from "@headlessui/react";
import { Link } from "@tanstack/react-router"; import { Link } from "@tanstack/react-router";
import { Loader } from "../Loader"; import { Loader } from "../Loader";
import type { DocumentId } from "@/lib/types";
export function DocumentView() { export function DocumentView({ documentId }: { documentId: DocumentId }) {
const { state } = useDocument(); const { docResult } = useDocument(documentId);
if (state.status === "loading") { console.info(`Rendering document: `, docResult);
if (docResult?.type !== "ready") {
return <Loader />; return <Loader />;
} }
const doc = state.doc; const doc = docResult.value.doc;
const relationshipList = relationshipsForDocument(doc); const relationshipList = relationshipsForDocument(doc);
return ( return (
<div key={doc.id} className="max-w-xl mx-auto py-2 px-4"> <div key={doc.id} className="max-w-xl mx-auto py-2 px-4">
<div>
<Link
to="/document/$documentId/print"
params={{ documentId: doc.id }}
className="text-slate-400 hover:text-violet-400 text-sm underline underline-offset-2 transition-colors mb-4"
>
Back to campaign
</Link>
<Link <Link
to="/document/$documentId/print" to="/document/$documentId/print"
params={{ documentId: doc.id }} params={{ documentId: doc.id }}
@@ -26,6 +37,7 @@ export function DocumentView() {
> >
Print Print
</Link> </Link>
</div>
<DocumentEditForm document={doc} /> <DocumentEditForm document={doc} />
<TabGroup> <TabGroup>
<TabList className="flex flex-row flex-wrap gap-1 mt-2"> <TabList className="flex flex-row flex-wrap gap-1 mt-2">

View File

@@ -1,15 +1,17 @@
import { AutoSaveTextarea } from "@/components/AutoSaveTextarea"; import { AutoSaveTextarea } from "@/components/AutoSaveTextarea";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import type { Location } from "@/lib/types"; import type { Location } from "@/lib/types";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache } from "@/context/document/hooks";
/** /**
* Renders an editable location form * Renders an editable location form
*/ */
export const LocationEditForm = ({ location }: { location: Location }) => { export const LocationEditForm = ({ location }: { location: Location }) => {
const { dispatch } = useDocument(); const { dispatch } = useDocumentCache();
async function saveLocationName(name: string) { async function saveLocationName(name: string) {
const updated: Location = await pb.collection("documents").update(location.id, { const updated: Location = await pb
.collection("documents")
.update(location.id, {
data: { data: {
...location.data, ...location.data,
name, name,
@@ -19,7 +21,9 @@ export const LocationEditForm = ({ location }: { location: Location }) => {
} }
async function saveLocationDescription(description: string) { async function saveLocationDescription(description: string) {
const updated: Location = await pb.collection("documents").update(location.id, { const updated: Location = await pb
.collection("documents")
.update(location.id, {
data: { data: {
...location.data, ...location.data,
description, description,

View File

@@ -4,7 +4,7 @@ import { pb } from "@/lib/pocketbase";
import { BaseForm } from "@/components/form/BaseForm"; import { BaseForm } from "@/components/form/BaseForm";
import { MultiLineInput } from "@/components/form/MultiLineInput"; import { MultiLineInput } from "@/components/form/MultiLineInput";
import { SingleLineInput } from "@/components/form/SingleLineInput"; import { SingleLineInput } from "@/components/form/SingleLineInput";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache } from "@/context/document/hooks";
/** /**
* Renders a form to add a new location. Calls onCreate with the new location document. * Renders a form to add a new location. Calls onCreate with the new location document.
@@ -16,7 +16,7 @@ export const NewLocationForm = ({
campaign: CampaignId; campaign: CampaignId;
onCreate: (location: Location) => Promise<void>; onCreate: (location: Location) => Promise<void>;
}) => { }) => {
const { dispatch } = useDocument(); const { dispatch } = useDocumentCache();
const [name, setName] = useState(""); const [name, setName] = useState("");
const [description, setDescription] = useState(""); const [description, setDescription] = useState("");
const [adding, setAdding] = useState(false); const [adding, setAdding] = useState(false);

View File

@@ -1,15 +1,17 @@
import { AutoSaveTextarea } from "@/components/AutoSaveTextarea"; import { AutoSaveTextarea } from "@/components/AutoSaveTextarea";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import type { Monster } from "@/lib/types"; import type { Monster } from "@/lib/types";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache } from "@/context/document/hooks";
/** /**
* Renders an editable monster row * Renders an editable monster row
*/ */
export const MonsterEditForm = ({ monster }: { monster: Monster }) => { export const MonsterEditForm = ({ monster }: { monster: Monster }) => {
const { dispatch } = useDocument(); const { dispatch } = useDocumentCache();
async function saveMonsterName(name: string) { async function saveMonsterName(name: string) {
const updated = await pb.collection("documents").update(monster.id, { const updated: Monster = await pb
.collection("documents")
.update(monster.id, {
data: { data: {
...monster.data, ...monster.data,
name, name,

View File

@@ -3,7 +3,7 @@ import type { CampaignId, Monster } from "@/lib/types";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import { BaseForm } from "@/components/form/BaseForm"; import { BaseForm } from "@/components/form/BaseForm";
import { SingleLineInput } from "@/components/form/SingleLineInput"; import { SingleLineInput } from "@/components/form/SingleLineInput";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache } from "@/context/document/hooks";
/** /**
* Renders a form to add a new monster. Calls onCreate with the new monster document. * Renders a form to add a new monster. Calls onCreate with the new monster document.
@@ -15,7 +15,7 @@ export const NewMonsterForm = ({
campaign: CampaignId; campaign: CampaignId;
onCreate: (monster: Monster) => Promise<void>; onCreate: (monster: Monster) => Promise<void>;
}) => { }) => {
const { dispatch } = useDocument(); const { dispatch } = useDocumentCache();
const [name, setName] = useState(""); const [name, setName] = useState("");
const [adding, setAdding] = useState(false); const [adding, setAdding] = useState(false);
const [error, setError] = useState<string | null>(null); const [error, setError] = useState<string | null>(null);

View File

@@ -4,7 +4,7 @@ import { pb } from "@/lib/pocketbase";
import { BaseForm } from "@/components/form/BaseForm"; import { BaseForm } from "@/components/form/BaseForm";
import { SingleLineInput } from "@/components/form/SingleLineInput"; import { SingleLineInput } from "@/components/form/SingleLineInput";
import { MultiLineInput } from "@/components/form/MultiLineInput"; import { MultiLineInput } from "@/components/form/MultiLineInput";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache } from "@/context/document/hooks";
/** /**
* Renders a form to add a new npc. Calls onCreate with the new npc document. * Renders a form to add a new npc. Calls onCreate with the new npc document.
@@ -16,7 +16,7 @@ export const NewNpcForm = ({
campaign: CampaignId; campaign: CampaignId;
onCreate: (npc: Npc) => Promise<void>; onCreate: (npc: Npc) => Promise<void>;
}) => { }) => {
const { dispatch } = useDocument(); const { dispatch } = useDocumentCache();
const [name, setName] = useState(""); const [name, setName] = useState("");
const [description, setDescription] = useState(""); const [description, setDescription] = useState("");
const [adding, setAdding] = useState(false); const [adding, setAdding] = useState(false);

View File

@@ -1,5 +1,5 @@
import { AutoSaveTextarea } from "@/components/AutoSaveTextarea"; import { AutoSaveTextarea } from "@/components/AutoSaveTextarea";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache } from "@/context/document/hooks";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import type { Npc } from "@/lib/types"; import type { Npc } from "@/lib/types";
@@ -7,7 +7,7 @@ import type { Npc } from "@/lib/types";
* Renders an editable npc form * Renders an editable npc form
*/ */
export const NpcEditForm = ({ npc }: { npc: Npc }) => { export const NpcEditForm = ({ npc }: { npc: Npc }) => {
const { dispatch } = useDocument(); const { dispatch } = useDocumentCache();
async function saveNpcName(name: string) { async function saveNpcName(name: string) {
const updated: Npc = await pb.collection("documents").update(npc.id, { const updated: Npc = await pb.collection("documents").update(npc.id, {
data: { data: {

View File

@@ -5,7 +5,7 @@ import type { CampaignId, Scene } from "@/lib/types";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import { BaseForm } from "@/components/form/BaseForm"; import { BaseForm } from "@/components/form/BaseForm";
import { MultiLineInput } from "@/components/form/MultiLineInput"; import { MultiLineInput } from "@/components/form/MultiLineInput";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache } from "@/context/document/hooks";
/** /**
* Renders a form to add a new scene. Calls onCreate with the new scene document. * Renders a form to add a new scene. Calls onCreate with the new scene document.
@@ -17,7 +17,7 @@ export const NewSceneForm = ({
campaign: CampaignId; campaign: CampaignId;
onCreate: (scene: Scene) => Promise<void>; onCreate: (scene: Scene) => Promise<void>;
}) => { }) => {
const { dispatch } = useDocument(); const { dispatch } = useDocumentCache();
const [text, setText] = useState(""); const [text, setText] = useState("");
const [adding, setAdding] = useState(false); const [adding, setAdding] = useState(false);
const [error, setError] = useState<string | null>(null); const [error, setError] = useState<string | null>(null);

View File

@@ -1,15 +1,13 @@
import { AutoSaveTextarea } from "@/components/AutoSaveTextarea"; import { AutoSaveTextarea } from "@/components/AutoSaveTextarea";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import type { Scene } from "@/lib/types"; import type { Scene } from "@/lib/types";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache } from "@/context/document/hooks";
import { useQueryClient } from "@tanstack/react-query";
/** /**
* Renders an editable scene form * Renders an editable scene form
*/ */
export const SceneEditForm = ({ scene }: { scene: Scene }) => { export const SceneEditForm = ({ scene }: { scene: Scene }) => {
const { dispatch } = useDocument(); const { dispatch } = useDocumentCache();
const queryClient = useQueryClient();
async function saveScene(text: string) { async function saveScene(text: string) {
const updated: Scene = await pb.collection("documents").update(scene.id, { const updated: Scene = await pb.collection("documents").update(scene.id, {

View File

@@ -5,7 +5,7 @@ import type { CampaignId, Secret } from "@/lib/types";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import { BaseForm } from "@/components/form/BaseForm"; import { BaseForm } from "@/components/form/BaseForm";
import { SingleLineInput } from "@/components/form/SingleLineInput"; import { SingleLineInput } from "@/components/form/SingleLineInput";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache } from "@/context/document/hooks";
/** /**
* Renders a form to add a new secret. Calls onCreate with the new secret document. * Renders a form to add a new secret. Calls onCreate with the new secret document.
@@ -17,7 +17,7 @@ export const NewSecretForm = ({
campaign: CampaignId; campaign: CampaignId;
onCreate: (secret: Secret) => Promise<void>; onCreate: (secret: Secret) => Promise<void>;
}) => { }) => {
const { dispatch } = useDocument(); const { dispatch } = useDocumentCache();
const [newSecret, setNewSecret] = useState(""); const [newSecret, setNewSecret] = useState("");
const [adding, setAdding] = useState(false); const [adding, setAdding] = useState(false);
const [error, setError] = useState<string | null>(null); const [error, setError] = useState<string | null>(null);

View File

@@ -1,6 +1,6 @@
// Displays a single secret with discovered checkbox and text. // Displays a single secret with discovered checkbox and text.
import { AutoSaveTextarea } from "@/components/AutoSaveTextarea"; import { AutoSaveTextarea } from "@/components/AutoSaveTextarea";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache } from "@/context/document/hooks";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import type { Secret } from "@/lib/types"; import type { Secret } from "@/lib/types";
import { useState } from "react"; import { useState } from "react";
@@ -10,7 +10,7 @@ import { useState } from "react";
* Handles updating the discovered state and discoveredIn relationship. * Handles updating the discovered state and discoveredIn relationship.
*/ */
export const SecretEditForm = ({ secret }: { secret: Secret }) => { export const SecretEditForm = ({ secret }: { secret: Secret }) => {
const { dispatch } = useDocument(); const { dispatch } = useDocumentCache();
const [checked, setChecked] = useState( const [checked, setChecked] = useState(
!!(secret.data as any)?.secret?.discovered, !!(secret.data as any)?.secret?.discovered,
); );

View File

@@ -1,7 +1,7 @@
// SecretRow.tsx // SecretRow.tsx
// Displays a single secret with discovered checkbox and text. // Displays a single secret with discovered checkbox and text.
import type { Secret, Session } from "@/lib/types";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import type { Secret, Session } from "@/lib/types";
import { useState } from "react"; import { useState } from "react";
/** /**
@@ -21,6 +21,8 @@ export const SecretToggleRow = ({
const [loading, setLoading] = useState(false); const [loading, setLoading] = useState(false);
async function handleChange(e: React.ChangeEvent<HTMLInputElement>) { async function handleChange(e: React.ChangeEvent<HTMLInputElement>) {
e.stopPropagation();
e.preventDefault();
const newChecked = e.target.checked; const newChecked = e.target.checked;
setLoading(true); setLoading(true);
setChecked(newChecked); setChecked(newChecked);
@@ -59,7 +61,7 @@ export const SecretToggleRow = ({
} }
return ( return (
<div className="flex items-center gap-3"> <div className="flex items-center justify-stretch gap-3 w-full">
<input <input
type="checkbox" type="checkbox"
checked={checked} checked={checked}
@@ -68,7 +70,7 @@ export const SecretToggleRow = ({
aria-label="Discovered" aria-label="Discovered"
disabled={loading} disabled={loading}
/> />
<span>{secret.data.text}</span> {secret.data.text}
</div> </div>
); );
}; };

View File

@@ -1,10 +1,10 @@
import { AutoSaveTextarea } from "@/components/AutoSaveTextarea"; import { AutoSaveTextarea } from "@/components/AutoSaveTextarea";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache } from "@/context/document/hooks";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import type { Session } from "@/lib/types"; import type { Session } from "@/lib/types";
export const SessionEditForm = ({ session }: { session: Session }) => { export const SessionEditForm = ({ session }: { session: Session }) => {
const { dispatch } = useDocument(); const { dispatch } = useDocumentCache();
async function saveStrongStart(strongStart: string) { async function saveStrongStart(strongStart: string) {
const doc: Session = await pb.collection("documents").update(session.id, { const doc: Session = await pb.collection("documents").update(session.id, {

View File

@@ -5,7 +5,7 @@ import type { CampaignId, Treasure } from "@/lib/types";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import { BaseForm } from "@/components/form/BaseForm"; import { BaseForm } from "@/components/form/BaseForm";
import { SingleLineInput } from "@/components/form/SingleLineInput"; import { SingleLineInput } from "@/components/form/SingleLineInput";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache } from "@/context/document/hooks";
/** /**
* Renders a form to add a new treasure. Calls onCreate with the new treasure document. * Renders a form to add a new treasure. Calls onCreate with the new treasure document.
@@ -17,7 +17,7 @@ export const NewTreasureForm = ({
campaign: CampaignId; campaign: CampaignId;
onCreate: (treasure: Treasure) => Promise<void>; onCreate: (treasure: Treasure) => Promise<void>;
}) => { }) => {
const { dispatch } = useDocument(); const { dispatch } = useDocumentCache();
const [newTreasure, setNewTreasure] = useState(""); const [newTreasure, setNewTreasure] = useState("");
const [adding, setAdding] = useState(false); const [adding, setAdding] = useState(false);
const [error, setError] = useState<string | null>(null); const [error, setError] = useState<string | null>(null);

View File

@@ -1,6 +1,6 @@
// Displays a single treasure with discovered checkbox and text. // Displays a single treasure with discovered checkbox and text.
import { AutoSaveTextarea } from "@/components/AutoSaveTextarea"; import { AutoSaveTextarea } from "@/components/AutoSaveTextarea";
import { useDocument } from "@/context/document/DocumentContext"; import { useDocumentCache } from "@/context/document/hooks";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import type { Treasure } from "@/lib/types"; import type { Treasure } from "@/lib/types";
import { useState } from "react"; import { useState } from "react";
@@ -10,7 +10,7 @@ import { useState } from "react";
* Handles updating the discovered state and discoveredIn relationship. * Handles updating the discovered state and discoveredIn relationship.
*/ */
export const TreasureEditForm = ({ treasure }: { treasure: Treasure }) => { export const TreasureEditForm = ({ treasure }: { treasure: Treasure }) => {
const { dispatch } = useDocument(); const { dispatch } = useDocumentCache();
const [checked, setChecked] = useState( const [checked, setChecked] = useState(
!!(treasure.data as any)?.treasure?.discovered, !!(treasure.data as any)?.treasure?.discovered,
); );

View File

@@ -1,7 +1,8 @@
// TreasureRow.tsx // TreasureRow.tsx
// Displays a single treasure with discovered checkbox and text. // Displays a single treasure with discovered checkbox and text.
import type { Treasure, Session } from "@/lib/types";
import { pb } from "@/lib/pocketbase"; import { pb } from "@/lib/pocketbase";
import type { Session, Treasure } from "@/lib/types";
import { Link } from "@tanstack/react-router";
import { useState } from "react"; import { useState } from "react";
/** /**
@@ -68,7 +69,13 @@ export const TreasureToggleRow = ({
aria-label="Discovered" aria-label="Discovered"
disabled={loading} disabled={loading}
/> />
<span>{treasure.data.text}</span> <Link
to="/document/$documentId"
params={{ documentId: treasure.id }}
className="text-lg !no-underline text-slate-100 hover:underline hover:text-violet-400"
>
{treasure.data.text}
</Link>
</div> </div>
); );
}; };

View File

@@ -1,59 +1,28 @@
import { pb } from "@/lib/pocketbase";
import { type AnyDocument, type DocumentId } from "@/lib/types";
import type { RecordModel } from "pocketbase";
import type { ReactNode } from "react"; import type { ReactNode } from "react";
import { createContext, useContext, useEffect, useReducer } from "react"; import { createContext, useReducer } from "react";
import type { DocumentAction } from "./actions"; import type { DocumentAction } from "./actions";
import { reducer } from "./reducer"; import { reducer } from "./reducer";
import { loading, type DocumentState } from "./state"; import { initialState, type DocumentState } from "./state";
type DocumentContextValue = { export type DocumentContextValue = {
state: DocumentState<AnyDocument>; cache: DocumentState;
dispatch: (action: DocumentAction<AnyDocument>) => void; dispatch: (action: DocumentAction) => void;
}; };
const DocumentContext = createContext<DocumentContextValue | undefined>( export const DocumentContext = createContext<DocumentContextValue | undefined>(
undefined, undefined,
); );
/** /**
* Provider for the record cache context. Provides a singleton RecordCache instance to children. * Provider for the record cache context. Provides a singleton RecordCache instance to children.
*/ */
export function DocumentProvider({ export function DocumentProvider({ children }: { children: ReactNode }) {
documentId, const [state, dispatch] = useReducer(reducer, initialState());
children,
}: {
documentId: DocumentId;
children: ReactNode;
}) {
const [state, dispatch] = useReducer(reducer, loading());
useEffect(() => {
async function fetchDocumentAndRelations() {
const doc: AnyDocument = await pb
.collection("documents")
.getOne(documentId, {
expand:
"relationships_via_primary,relationships_via_primary.secondary",
});
dispatch({
type: "ready",
doc,
relationships: doc.expand?.relationships_via_primary || [],
relatedDocuments:
doc.expand?.relationships_via_primary?.flatMap(
(r: RecordModel) => r.expand?.secondary,
) || [],
});
}
fetchDocumentAndRelations();
}, [documentId]);
return ( return (
<DocumentContext.Provider <DocumentContext.Provider
value={{ value={{
state, cache: state,
dispatch, dispatch,
}} }}
> >
@@ -61,10 +30,3 @@ export function DocumentProvider({
</DocumentContext.Provider> </DocumentContext.Provider>
); );
} }
export function useDocument(): DocumentContextValue {
const ctx = useContext(DocumentContext);
if (!ctx)
throw new Error("useDocument must be used within a DocumentProvider");
return ctx;
}

View File

@@ -0,0 +1,48 @@
import { pb } from "@/lib/pocketbase";
import { type AnyDocument, type DocumentId } from "@/lib/types";
import type { RecordModel } from "pocketbase";
import type { ReactNode } from "react";
import { useEffect } from "react";
import { useDocumentCache } from "./hooks";
/**
* Provider for the record cache context. Provides a singleton RecordCache instance to children.
*/
export function DocumentLoader({
documentId,
children,
}: {
documentId: DocumentId;
children: ReactNode;
}) {
const { dispatch } = useDocumentCache();
useEffect(() => {
async function fetchDocumentAndRelations() {
dispatch({
type: "loadingDocument",
docId: documentId,
});
const doc: AnyDocument = await pb
.collection("documents")
.getOne(documentId, {
expand:
"relationships_via_primary,relationships_via_primary.secondary",
});
dispatch({
type: "setDocumentTree",
doc,
relationships: doc.expand?.relationships_via_primary || [],
relatedDocuments:
doc.expand?.relationships_via_primary?.flatMap(
(r: RecordModel) => r.expand?.secondary,
) || [],
});
}
fetchDocumentAndRelations();
}, [documentId]);
return children;
}

View File

@@ -1,14 +1,9 @@
import type { AnyDocument, Relationship } from "@/lib/types"; import type { AnyDocument, DocumentId, Relationship } from "@/lib/types";
export type DocumentAction<D extends AnyDocument> = export type DocumentAction =
| { | {
type: "loading"; type: "loadingDocument";
} docId: DocumentId;
| {
type: "ready";
doc: D;
relationships: Relationship[];
relatedDocuments: AnyDocument[];
} }
| { | {
type: "setDocument"; type: "setDocument";
@@ -16,5 +11,12 @@ export type DocumentAction<D extends AnyDocument> =
} }
| { | {
type: "setRelationship"; type: "setRelationship";
docId: DocumentId;
relationship: Relationship; relationship: Relationship;
}
| {
type: "setDocumentTree";
doc: AnyDocument;
relationships: Relationship[];
relatedDocuments: AnyDocument[];
}; };

View File

@@ -0,0 +1,23 @@
import type { DocumentId } from "@/lib/types";
import { useContext } from "react";
import { DocumentContext } from "./DocumentContext";
export function useDocument(id: DocumentId) {
const ctx = useContext(DocumentContext);
if (!ctx)
throw new Error("useDocument must be used within a DocumentProvider");
return {
docResult: ctx.cache.documents[id],
dispatch: ctx.dispatch,
};
}
export function useDocumentCache() {
const ctx = useContext(DocumentContext);
if (!ctx)
throw new Error("useDocument must be used within a DocumentProvider");
return {
cache: ctx.cache,
dispatch: ctx.dispatch,
};
}

View File

@@ -1,71 +1,88 @@
import _ from "lodash"; import type { AnyDocument, DocumentId, Relationship } from "@/lib/types";
import type {
AnyDocument,
DocumentId,
Relationship,
RelationshipType,
} from "@/lib/types";
import type { DocumentAction } from "./actions"; import type { DocumentAction } from "./actions";
import type { DocumentState } from "./state"; import { ready, loading, unloaded, type DocumentState } from "./state";
import { relationshipsForDocument } from "@/lib/relationships";
function ifStatus<D extends AnyDocument, S extends DocumentState<D>["status"]>( function setLoadingDocument(
status: S, docId: DocumentId,
state: DocumentState<D>, state: DocumentState,
newState: (state: DocumentState<D> & { status: S }) => DocumentState<D>, ): DocumentState {
) {
// TODO: Is there a better way to express the type of type narrowing?
return state.status === status
? newState(state as DocumentState<D> & { status: S })
: state;
}
export function reducer<D extends AnyDocument>(
state: DocumentState<D>,
action: DocumentAction<D>,
): DocumentState<D> {
switch (action.type) {
case "loading":
return {
status: "loading",
};
case "ready":
return {
status: "ready",
doc: action.doc,
relationships: _.keyBy(action.relationships, (r) => r.type) as Record<
RelationshipType,
Relationship
>,
relatedDocs: _.keyBy(action.relatedDocuments, (r) => r.id) as Record<
DocumentId,
AnyDocument
>,
};
case "setDocument":
return ifStatus("ready", state, (state) => {
if (state.doc.id === action.doc.id) {
return { return {
...state, ...state,
doc: action.doc as D, documents: {
}; ...state.documents,
} [docId]: loading(),
return {
...state,
relatedDocs: {
...state.relatedDocs,
[action.doc.id]: action.doc,
}, },
}; };
}); }
case "setRelationship":
return ifStatus("ready", state, (state) => ({ function setDocument(state: DocumentState, doc: AnyDocument): DocumentState {
const previous = state.documents[doc.id];
const relationships =
previous?.type === "ready"
? previous.value.relationships
: Object.fromEntries(
relationshipsForDocument(doc).map((relationshipType) => [
relationshipType,
unloaded(),
]),
);
return {
...state, ...state,
documents: {
...state.documents,
[doc.id]: ready({
doc: doc,
relationships,
}),
},
};
}
function setRelationship(
docId: DocumentId,
state: DocumentState,
relationship: Relationship,
): DocumentState {
const previousResult = state.documents[docId];
if (previousResult?.type !== "ready") {
return state;
}
const previousEntry = previousResult.value;
return {
...state,
documents: {
...state.documents,
[docId]: ready({
...previousEntry,
relationships: { relationships: {
...state.relationships, ...previousEntry.relationships,
[action.relationship.type]: action.relationship, [relationship.type]: ready(relationship),
}, },
})); }),
},
};
}
export function reducer(
state: DocumentState,
action: DocumentAction,
): DocumentState {
switch (action.type) {
case "loadingDocument":
return setLoadingDocument(action.docId, state);
case "setDocument":
return setDocument(state, action.doc);
case "setRelationship":
return setRelationship(action.docId, state, action.relationship);
case "setDocumentTree":
return action.relatedDocuments.reduce(
setDocument,
action.relationships.reduce(
setRelationship.bind(null, action.doc.id),
setDocument(state, action.doc),
),
);
} }
} }

View File

@@ -5,17 +5,28 @@ import type {
RelationshipType, RelationshipType,
} from "@/lib/types"; } from "@/lib/types";
export type DocumentState<D extends AnyDocument> = export type Result<V> =
| { | { type: "unloaded" }
status: "loading"; | { type: "error"; err: unknown }
} | { type: "loading" }
| { | { type: "ready"; value: V };
status: "ready";
doc: D; export const unloaded = (): Result<any> => ({ type: "unloaded" });
relationships: Record<RelationshipType, Relationship>; export const error = (err: unknown): Result<any> => ({ type: "error", err });
relatedDocs: Record<DocumentId, AnyDocument>; export const loading = (): Result<any> => ({ type: "loading" });
export const ready = <V>(value: V): Result<V> => ({ type: "ready", value });
export type DocumentState = {
documents: Record<
DocumentId,
Result<{
doc: AnyDocument;
relationships: Record<RelationshipType, Result<Relationship>>;
}>
>;
}; };
export const loading = <D extends AnyDocument>(): DocumentState<D> => ({ export const initialState = (): DocumentState =>
status: "loading", ({
}); documents: {},
}) as DocumentState;

View File

@@ -1,4 +1,5 @@
import { AuthProvider } from "@/context/auth/AuthContext"; import { AuthProvider } from "@/context/auth/AuthContext";
import { DocumentProvider } from "@/context/document/DocumentContext";
import { ReactQueryDevtools } from "@tanstack/react-query-devtools"; import { ReactQueryDevtools } from "@tanstack/react-query-devtools";
import { Outlet, createRootRoute } from "@tanstack/react-router"; import { Outlet, createRootRoute } from "@tanstack/react-router";
import { TanStackRouterDevtools } from "@tanstack/react-router-devtools"; import { TanStackRouterDevtools } from "@tanstack/react-router-devtools";
@@ -7,7 +8,9 @@ export const Route = createRootRoute({
component: () => ( component: () => (
<> <>
<AuthProvider> <AuthProvider>
<DocumentProvider>
<Outlet /> <Outlet />
</DocumentProvider>
</AuthProvider> </AuthProvider>
<TanStackRouterDevtools /> <TanStackRouterDevtools />
<ReactQueryDevtools buttonPosition="bottom-right" /> <ReactQueryDevtools buttonPosition="bottom-right" />

View File

@@ -1,5 +1,5 @@
import { DocumentView } from "@/components/documents/DocumentView"; import { DocumentView } from "@/components/documents/DocumentView";
import { DocumentProvider } from "@/context/document/DocumentContext"; import { DocumentLoader } from "@/context/document/DocumentLoader";
import type { DocumentId } from "@/lib/types"; import type { DocumentId } from "@/lib/types";
import { createFileRoute } from "@tanstack/react-router"; import { createFileRoute } from "@tanstack/react-router";
@@ -11,11 +11,10 @@ export const Route = createFileRoute(
function RouteComponent() { function RouteComponent() {
const { documentId } = Route.useParams(); const { documentId } = Route.useParams();
console.info("Rendering document route: ", documentId);
return ( return (
<DocumentProvider documentId={documentId as DocumentId}> <DocumentLoader documentId={documentId as DocumentId}>
<DocumentView /> <DocumentView documentId={documentId as DocumentId} />
</DocumentProvider> </DocumentLoader>
); );
} }