Skip to content

Refactor useArtifact hook for improved clarity #1472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sujaicodes wants to merge 1 commit into
base: main
Choose a base branch
from
+26 −57
Open

Refactor useArtifact hook for improved clarity #1472

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 26 additions & 57 deletions hooks/use-artifact.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,79 +11,48 @@ export const initialArtifactData: UIArtifact = {
title: "",
status: "idle",
isVisible: false,
boundingBox: {
top: 0,
left: 0,
width: 0,
height: 0,
},
boundingBox: { top: 0, left: 0, width: 0, height: 0 },
};

type Selector<T> = (state: UIArtifact) => T;

export function useArtifactSelector<Selected>(selector: Selector<Selected>) {
const { data: localArtifact } = useSWR<UIArtifact>("artifact", null, {
fallbackData: initialArtifactData,
});

const selectedValue = useMemo(() => {
if (!localArtifact) {
return selector(initialArtifactData);
}
return selector(localArtifact);
}, [localArtifact, selector]);

return selectedValue;
}
const SWR_OPTIONS = { fallbackData: initialArtifactData };

export function useArtifact() {
const { data: localArtifact, mutate: setLocalArtifact } = useSWR<UIArtifact>(
"artifact",
null,
{
fallbackData: initialArtifactData,
}
);

const artifact = useMemo(() => {
if (!localArtifact) {
return initialArtifactData;
}
return localArtifact;
}, [localArtifact]);
// Main artifact SWR
const { data: artifact = initialArtifactData, mutate: setArtifactData } =
useSWR<UIArtifact>("artifact", null, SWR_OPTIONS);

// Setter function for artifact
const setArtifact = useCallback(
(updaterFn: UIArtifact | ((currentArtifact: UIArtifact) => UIArtifact)) => {
setLocalArtifact((currentArtifact) => {
const artifactToUpdate = currentArtifact || initialArtifactData;

if (typeof updaterFn === "function") {
return updaterFn(artifactToUpdate);
}
(updater: UIArtifact | ((current: UIArtifact) => UIArtifact)) =>
setArtifactData((current = initialArtifactData) =>
typeof updater === "function" ? updater(current) : updater
),
[setArtifactData]
);

return updaterFn;
});
},
[setLocalArtifact]
// Metadata per documentId
const { data: metadata, mutate: setMetadata } = useSWR(
artifact.documentId ? `artifact-metadata-${artifact.documentId}` : null,
null,
{ fallbackData: null }
);

const { data: localArtifactMetadata, mutate: setLocalArtifactMetadata } =
useSWR<any>(
() =>
artifact.documentId ? `artifact-metadata-${artifact.documentId}` : null,
null,
{
fallbackData: null,
}
);
// Selector helper
const selectArtifact = useCallback(
<Selected>(selector: Selector<Selected>) => selector(artifact),
[artifact]
);

return useMemo(
() => ({
artifact,
setArtifact,
metadata: localArtifactMetadata,
setMetadata: setLocalArtifactMetadata,
metadata,
setMetadata,
selectArtifact, // function to select from artifact
}),
[artifact, setArtifact, localArtifactMetadata, setLocalArtifactMetadata]
[artifact, setArtifact, metadata, setMetadata, selectArtifact]
);
}