Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.
TypeScript acmeagentsai-agentscertificate-managementdevsecopsenvironment-variableskubernetesopen-sourcepampkipostgresprivate-caprivileged-access-managementsecret-managementsecret-managersecretssecrets-managementsecuritysecurity-toolsvault
import { RefObject, useEffect, useMemo, useRef, useState } from "react";
import {
ArrowLeftIcon,
ChevronRightIcon,
FolderIcon,
KeyRoundIcon,
LayersIcon
} from "lucide-react";
import { useOrganization, useProject, useSubscription } from "@app/context";
import { useDebounce } from "@app/hooks";
import { useGetProjectFolders, useGetProjectSecrets, useGetWorkspaceById } from "@app/hooks/api";
import { useGetProjectSecretsQuickSearch } from "@app/hooks/api/dashboard";
import { useListProjectFolderGrantsReceived } from "@app/hooks/api/projectFolderGrants";
import { TProjectFolderGrantReceived } from "@app/hooks/api/projectFolderGrants/types";
import { Tabs, TabsContent, TabsList, TabsTrigger } from "../../generic/Tabs";
import { cn } from "../../utils";
type WizardTab = "this-project" | "another-project";
type WizardState = {
tab: WizardTab;
step: "project" | "env" | "browse";
selectedProjectFolderGrant: TProjectFolderGrantReceived | null;
env: { slug: string; name: string } | null;
secretPath: string;
};
type Props = {
inputRef: RefObject<HTMLTextAreaElement | null>;
onSelect: (referenceContent: string) => void;
onNavigate: (referenceContent: string) => void;
isEnabled: boolean;
onFocusItem: () => void;
currentInput?: string;
};
const DEEP_SEARCH_MIN_LENGTH = 2;
const DEEP_SEARCH_LIMIT = 50;
const INITIAL_STATE: WizardState = {
tab: "this-project",
step: "env",
selectedProjectFolderGrant: null,
env: null,
secretPath: "/"
};
export const SecretReferenceWizard = ({
inputRef,
onSelect,
onNavigate,
isEnabled,
onFocusItem,
currentInput = ""
}: Props) => {
const { currentProject } = useProject();
const { currentOrg } = useOrganization();
const { subscription } = useSubscription();
const projectId = currentProject?.id || "";
const canCrossProjectShare =
subscription?.crossProjectSecretSharing && currentOrg?.allowCrossProjectSecretSharing;
const [state, setState] = useState<WizardState>(INITIAL_STATE);
const [highlightedIndex, setHighlightedIndex] = useState(0);
const contentRef = useRef<HTMLDivElement>(null);
const { data: receivedGrants } = useListProjectFolderGrantsReceived(
canCrossProjectShare ? projectId : ""
);
const { data: selectedSourceProject } = useGetWorkspaceById(
state.selectedProjectFolderGrant?.sourceProjectId || ""
);
const browseProjectId =
state.step === "browse" && state.selectedProjectFolderGrant
? state.selectedProjectFolderGrant.sourceProjectId
: projectId;
const { data: secrets } = useGetProjectSecrets({
projectId: browseProjectId,
environment: state.env?.slug || "",
secretPath: state.secretPath,
viewSecretValue: false,
options: {
enabled:
isEnabled && state.step === "browse" && Boolean(browseProjectId) && Boolean(state.env?.slug)
}
});
const { data: folders } = useGetProjectFolders({
projectId: browseProjectId,
environment: state.env?.slug || "",
path: state.secretPath,
options: {
enabled:
isEnabled && state.step === "browse" && Boolean(browseProjectId) && Boolean(state.env?.slug)
}
});
const uniqueSourceProjects = useMemo(() => {
if (!receivedGrants) return [];
const seen = new Set<string>();
return receivedGrants.filter((g) => {
if (seen.has(g.sourceProjectId)) return false;
seen.add(g.sourceProjectId);
return true;
});
}, [receivedGrants]);
const parsedCrossProjectInput = useMemo(() => {
if (!currentInput.startsWith("@")) return null;
const segments = currentInput.slice(1).split(".");
const projectSlug = segments[0] || "";
const hasProjectDot = currentInput.indexOf(".") !== -1;
const envSlug = segments[1] || "";
const hasEnvDot = segments.length > 2;
const folderSegments = hasEnvDot ? segments.slice(2, -1) : [];
const lastSegment = hasEnvDot ? segments[segments.length - 1] : "";
return { projectSlug, hasProjectDot, envSlug, hasEnvDot, folderSegments, lastSegment };
}, [currentInput]);
const parsedSameProjectInput = useMemo(() => {
if (currentInput.startsWith("@") || !currentInput.includes(".")) return null;
const segments = currentInput.split(".");
const envSlug = segments[0] || "";
const hasEnvDot = segments.length > 1;
const folderSegments = hasEnvDot ? segments.slice(1, -1) : [];
const lastSegment = hasEnvDot ? segments[segments.length - 1] : "";
return { envSlug, hasEnvDot, folderSegments, lastSegment };
}, [currentInput]);
useEffect(() => {
if (!parsedCrossProjectInput) return;
const { projectSlug, hasProjectDot, envSlug, hasEnvDot, folderSegments } =
parsedCrossProjectInput;
if (!hasProjectDot) {
setState({
...INITIAL_STATE,
tab: "another-project",
step: "project"
});
return;
}
const matchedGrant = uniqueSourceProjects.find(
(g) => g.sourceProjectSlug.toLowerCase() === projectSlug.toLowerCase()
);
if (!matchedGrant) {
setState({
...INITIAL_STATE,
tab: "another-project",
step: "project"
});
return;
}
if (!hasEnvDot) {
setState({
tab: "another-project",
step: "env",
selectedProjectFolderGrant: matchedGrant,
env: null,
secretPath: "/"
});
return;
}
const envGrants =
receivedGrants?.filter((g) => g.sourceProjectId === matchedGrant.sourceProjectId) || [];
const matchedEnv = envGrants.find(
(g) => g.environmentSlug.toLowerCase() === envSlug.toLowerCase()
);
if (!matchedEnv) {
setState({
tab: "another-project",
step: "env",
selectedProjectFolderGrant: matchedGrant,
env: null,
secretPath: "/"
});
return;
}
const secretPath = folderSegments.length > 0 ? `/${folderSegments.join("/")}/` : "/";
setState({
tab: "another-project",
step: "browse",
selectedProjectFolderGrant: matchedGrant,
env: { slug: matchedEnv.environmentSlug, name: matchedEnv.environmentName },
secretPath
});
}, [parsedCrossProjectInput, uniqueSourceProjects, receivedGrants]);
useEffect(() => {
if (currentInput.startsWith("@")) return;
if (!parsedSameProjectInput) {
setState(INITIAL_STATE);
return;
}
const { envSlug, hasEnvDot, folderSegments } = parsedSameProjectInput;
const envs = currentProject?.environments || [];
const matchedEnv = envs.find((e) => e.slug.toLowerCase() === envSlug.toLowerCase());
if (!matchedEnv) {
setState({
...INITIAL_STATE,
tab: "this-project",
step: "env"
});
return;
}
if (!hasEnvDot) {
setState({
...INITIAL_STATE,
tab: "this-project",
step: "env"
});
return;
}
const secretPath = folderSegments.length > 0 ? `/${folderSegments.join("/")}/` : "/";
setState({
tab: "this-project",
step: "browse",
selectedProjectFolderGrant: null,
env: { slug: matchedEnv.slug, name: matchedEnv.name },
secretPath
});
}, [currentInput, parsedSameProjectInput, currentProject?.environments]);
const projectFilter =
parsedCrossProjectInput && !parsedCrossProjectInput.hasProjectDot
? parsedCrossProjectInput.projectSlug.toLowerCase()
: "";
const envFilter = (() => {
if (parsedCrossProjectInput?.hasProjectDot && !parsedCrossProjectInput.hasEnvDot)
return parsedCrossProjectInput.envSlug.toLowerCase();
if (
!parsedCrossProjectInput &&
!parsedSameProjectInput &&
currentInput &&
!currentInput.startsWith("@")
)
return currentInput.toLowerCase();
return "";
})();
const browseFilter = (() => {
if (parsedCrossProjectInput?.hasEnvDot)
return parsedCrossProjectInput.lastSegment.toLowerCase();
if (parsedSameProjectInput?.hasEnvDot) return parsedSameProjectInput.lastSegment.toLowerCase();
return "";
})();
const availableEnvs = useMemo(() => {
if (state.tab === "this-project") {
return (currentProject?.environments || []).map((e) => ({ name: e.name, slug: e.slug }));
}
if (!state.selectedProjectFolderGrant) return [];
const projectFolderGrants =
receivedGrants?.filter(
(g) => g.sourceProjectId === state.selectedProjectFolderGrant!.sourceProjectId
) || [];
const seen = new Set<string>();
return projectFolderGrants
.filter((g) => {
if (seen.has(g.environmentSlug)) return false;
seen.add(g.environmentSlug);
return true;
})
.map((g) => ({ name: g.environmentName, slug: g.environmentSlug }));
}, [state.tab, state.selectedProjectFolderGrant, currentProject, receivedGrants]);
const filteredProjects = projectFilter
? uniqueSourceProjects.filter((g) => g.sourceProjectSlug.toLowerCase().includes(projectFilter))
: uniqueSourceProjects;
const filteredEnvs = envFilter
? availableEnvs.filter((e) => e.slug.toLowerCase().includes(envFilter))
: availableEnvs;
const [debouncedEnvFilter] = useDebounce(envFilter, 300);
const isDeepSearchEnabled =
isEnabled &&
state.tab === "this-project" &&
state.step === "env" &&
debouncedEnvFilter.length >= DEEP_SEARCH_MIN_LENGTH;
const {
data: deepSearchResult,
isFetching: isDeepSearchFetching,
isPlaceholderData: isDeepSearchPlaceholder
} = useGetProjectSecretsQuickSearch(
{
projectId,
secretPath: "/",
search: debouncedEnvFilter,
environments: availableEnvs.map((env) => env.slug),
tags: {},
limit: DEEP_SEARCH_LIMIT,
offset: 0
},
{ enabled: isDeepSearchEnabled }
);
const isDeepSearchSettled =
isDeepSearchEnabled && envFilter === debouncedEnvFilter && !isDeepSearchPlaceholder;
const envOrder = availableEnvs.map((env) => env.slug);
const searchedSecrets = isDeepSearchSettled
? Object.values(deepSearchResult?.secrets ?? {})
.flat()
.sort(
(a, b) =>
a.key.localeCompare(b.key) ||
(a.path ?? "/").localeCompare(b.path ?? "/") ||
envOrder.indexOf(a.env) - envOrder.indexOf(b.env)
)
: [];
const isDeepSearchPending =
envFilter.length >= DEEP_SEARCH_MIN_LENGTH &&
state.tab === "this-project" &&
(!isDeepSearchSettled || isDeepSearchFetching);
const envNameBySlug = new Map(availableEnvs.map((env) => [env.slug, env.name]));
const filteredFolders = browseFilter
? (folders || []).filter((f) => f.name.toLowerCase().includes(browseFilter))
: folders || [];
const filteredSecrets = browseFilter
? (secrets || []).filter((s) => s.key.toLowerCase().includes(browseFilter))
: secrets || [];
const navigableCount = (() => {
switch (state.step) {
case "project":
return filteredProjects.length;
case "env":
return filteredEnvs.length + searchedSecrets.length;
case "browse":
return filteredFolders.length + filteredSecrets.length;
default:
return 0;
}
})();
useEffect(() => {
setHighlightedIndex(0);
}, [state.step, state.secretPath, navigableCount]);
useEffect(() => {
if (highlightedIndex < 0) return;
const el = contentRef.current?.querySelector(`[data-nav-index="${highlightedIndex}"]`);
if (el) el.scrollIntoView({ block: "nearest" });
}, [highlightedIndex]);
const breadcrumbs = useMemo(() => {
if (state.step !== "browse" || !state.env) return [];
const pathParts = state.secretPath.split("/").filter(Boolean);
return [state.env.name, ...pathParts];
}, [state]);
const referencePrefix = state.selectedProjectFolderGrant
? `@${state.selectedProjectFolderGrant.sourceProjectSlug}.`
: "";
const navigateToPath = (envSlug: string, pathParts: string[]) => {
onNavigate(`${referencePrefix}${[envSlug, ...pathParts].join(".")}.`);
};
const handleTabChange = (tab: string) => {
onNavigate(tab === "another-project" ? "@" : "");
};
const handleSelectProject = (grant: TProjectFolderGrantReceived) => {
onNavigate(`@${grant.sourceProjectSlug}.`);
};
const handleSelectEnv = (envSlug: string) => {
navigateToPath(envSlug, []);
};
const handleSelectFolder = (folderName: string) => {
if (!state.env) return;
navigateToPath(state.env.slug, [...state.secretPath.split("/").filter(Boolean), folderName]);
};
const handleSelectSecret = (secretKey: string) => {
if (!state.env) return;
const pathParts = state.secretPath.split("/").filter(Boolean);
const segments = [state.env.slug, ...pathParts, secretKey];
let reference: string;
if (state.selectedProjectFolderGrant && selectedSourceProject?.slug) {
reference = `@${selectedSourceProject.slug}.${segments.join(".")}`;
} else {
reference = segments.join(".");
}
onSelect(reference);
};
const handleSelectSearchedSecret = (envSlug: string, secretPath: string, secretKey: string) => {
onSelect([envSlug, ...secretPath.split("/").filter(Boolean), secretKey].join("."));
};
const handleBreadcrumbClick = (index: number) => {
if (index === -1 || !state.env) {
onNavigate(referencePrefix);
return;
}
navigateToPath(state.env.slug, state.secretPath.split("/").filter(Boolean).slice(0, index));
};
const navigableCountRef = useRef(navigableCount);
navigableCountRef.current = navigableCount;
const selectHighlightedRef = useRef(() => {});
selectHighlightedRef.current = () => {
if (highlightedIndex < 0 || highlightedIndex >= navigableCount) return;
onFocusItem();
switch (state.step) {
case "project":
if (filteredProjects[highlightedIndex])
handleSelectProject(filteredProjects[highlightedIndex]);
break;
case "env": {
if (highlightedIndex < filteredEnvs.length) {
handleSelectEnv(filteredEnvs[highlightedIndex].slug);
} else {
const secret = searchedSecrets[highlightedIndex - filteredEnvs.length];
if (secret) handleSelectSearchedSecret(secret.env, secret.path ?? "/", secret.key);
}
break;
}
case "browse": {
if (highlightedIndex < filteredFolders.length) {
handleSelectFolder(filteredFolders[highlightedIndex].name);
} else {
const secretIdx = highlightedIndex - filteredFolders.length;
if (filteredSecrets[secretIdx]) handleSelectSecret(filteredSecrets[secretIdx].key);
}
break;
}
default:
break;
}
};
useEffect(() => {
const input = inputRef.current;
if (!isEnabled || !input) return undefined;
const handleKeyDown = (e: KeyboardEvent) => {
if (e.defaultPrevented || e.isComposing) return;
const count = navigableCountRef.current;
if (count === 0) return;
if (e.key === "ArrowDown" || (e.key === "Tab" && !e.shiftKey)) {
e.preventDefault();
e.stopPropagation();
setHighlightedIndex((prev) => (prev + 1) % count);
} else if (e.key === "ArrowUp" || (e.key === "Tab" && e.shiftKey)) {
e.preventDefault();
e.stopPropagation();
setHighlightedIndex((prev) => (prev - 1 + count) % count);
} else if (e.key === "Enter") {
e.preventDefault();
e.stopPropagation();
selectHighlightedRef.current();
}
};
input.addEventListener("keydown", handleKeyDown);
return () => input.removeEventListener("keydown", handleKeyDown);
}, [isEnabled, inputRef]);
const renderProjectStep = () => {
return (
<div className="flex flex-col">
{filteredProjects.length === 0 ? (
<div className="flex flex-col items-center justify-center py-8 text-sm text-muted">
{projectFilter ? "No matching projects" : "No projects have shared secrets with you"}
</div>
) : (
<>
<div className="px-2 py-1.5 text-[10px] font-semibold tracking-wider text-muted uppercase">
Available projects
</div>
{filteredProjects.map((grant, i) => (
<button
key={grant.sourceProjectId}
type="button"
data-secret-reference-item
data-nav-index={i}
onClick={() => {
onFocusItem();
handleSelectProject(grant);
}}
className={cn(
"flex w-full cursor-pointer items-center justify-between px-2 py-2 text-left text-sm transition-colors hover:bg-foreground/10",
highlightedIndex === i && "bg-foreground/10"
)}
>
<div className="flex items-center gap-2">
<div className="flex size-6 shrink-0 items-center justify-center rounded bg-project/20 text-xs font-semibold text-project">
{grant.sourceProjectName[0]?.toUpperCase()}
</div>
<span className="truncate">{grant.sourceProjectName}</span>
</div>
<ChevronRightIcon className="size-3.5 shrink-0 text-muted" />
</button>
))}
</>
)}
</div>
);
};
const renderEnvStep = () => {
return (
<div className="flex flex-col">
{state.selectedProjectFolderGrant && (
<button
type="button"
data-secret-reference-item
onClick={() => {
onFocusItem();
onNavigate("@");
}}
className="flex items-center gap-1.5 border-b border-border px-2 py-1.5 text-xs text-muted transition-colors hover:text-foreground"
>
<ArrowLeftIcon className="size-3 shrink-0" />
<span className="truncate">{state.selectedProjectFolderGrant.sourceProjectName}</span>
</button>
)}
{filteredEnvs.length > 0 && (
<>
<div className="px-2 py-1.5 text-[10px] font-semibold tracking-wider text-muted uppercase">
Environments
</div>
{filteredEnvs.map((env, i) => (
<button
key={env.slug}
type="button"
data-secret-reference-item
data-nav-index={i}
onClick={() => {
onFocusItem();
handleSelectEnv(env.slug);
}}
className={cn(
"flex w-full cursor-pointer items-center justify-between px-2 py-2 text-left text-sm transition-colors hover:bg-foreground/10",
highlightedIndex === i && "bg-foreground/10"
)}
>
<div className="flex items-center gap-2">
<LayersIcon className="size-4 text-success" />
<span>{env.name}</span>
</div>
<ChevronRightIcon className="size-3.5 shrink-0 text-muted" />
</button>
))}
</>
)}
{filteredEnvs.length > 0 && searchedSecrets.length > 0 && (
<div className="my-1 border-t border-border" />
)}
{searchedSecrets.length > 0 && (
<>
<div className="px-2 py-1.5 text-[10px] font-semibold tracking-wider text-muted uppercase">
Secrets in this project
</div>
{searchedSecrets.map((secret, i) => {
const navIndex = filteredEnvs.length + i;
const location = [
envNameBySlug.get(secret.env) ?? secret.env,
...(secret.path ?? "/").split("/").filter(Boolean)
].join(" / ");
return (
<button
key={`${secret.env}-${secret.id}`}
type="button"
data-secret-reference-item
data-nav-index={navIndex}
onClick={() => {
onFocusItem();
handleSelectSearchedSecret(secret.env, secret.path ?? "/", secret.key);
}}
className={cn(
"flex w-full cursor-pointer items-center justify-between gap-3 px-2 py-2 text-left text-sm transition-colors hover:bg-foreground/10",
highlightedIndex === navIndex && "bg-foreground/10"
)}
>
<div className="flex min-w-0 items-center gap-2">
<KeyRoundIcon className="size-4 shrink-0 text-muted" />
<span className="truncate">{secret.key}</span>
</div>
<span className="truncate text-xs text-muted">{location}</span>
</button>
);
})}
</>
)}
{filteredEnvs.length === 0 && searchedSecrets.length === 0 && (
<div className="flex items-center justify-center py-6 text-sm text-muted">
{isDeepSearchPending && "Searching secrets…"}
{!isDeepSearchPending &&
(envFilter ? "No matching environments or secrets" : "No environments available")}
</div>
)}
</div>
);
};
const renderBrowseStep = () => {
const isEmpty = filteredFolders.length === 0 && filteredSecrets.length === 0;
return (
<div className="flex flex-col">
<div className="no-scrollbar flex min-w-0 items-center gap-0.5 overflow-x-auto border-b border-border px-2 py-1.5 text-xs text-muted">
<button
type="button"
data-secret-reference-item
onClick={() => {
onFocusItem();
handleBreadcrumbClick(-1);
}}
className="shrink-0 transition-colors hover:text-foreground"
>
Envs
</button>
{breadcrumbs.map((crumb, i) => (
<span key={`crumb-${i + 1}`} className="flex shrink-0 items-center gap-0.5">
<ChevronRightIcon className="size-3" />
<button
type="button"
data-secret-reference-item
onClick={() => {
onFocusItem();
handleBreadcrumbClick(i);
}}
className={cn(
"transition-colors hover:text-foreground",
i === breadcrumbs.length - 1 && "font-medium text-foreground"
)}
>
{crumb}
</button>
</span>
))}
</div>
{isEmpty && (
<div className="flex items-center justify-center py-6 text-sm text-muted">
No secrets found
</div>
)}
{filteredFolders.map((folder, i) => (
<button
key={folder.id}
type="button"
data-secret-reference-item
data-nav-index={i}
onClick={() => {
onFocusItem();
handleSelectFolder(folder.name);
}}
className={cn(
"flex w-full cursor-pointer items-center justify-between px-2 py-2 text-left text-sm transition-colors hover:bg-foreground/10",
highlightedIndex === i && "bg-foreground/10"
)}
>
<div className="flex items-center gap-2">
<FolderIcon className="size-4 text-warning" />
<span>{folder.name}</span>
</div>
<ChevronRightIcon className="size-3.5 shrink-0 text-muted" />
</button>
))}
{filteredFolders.length > 0 && filteredSecrets.length > 0 && (
<div className="my-1 border-t border-border" />
)}
{filteredSecrets.length > 0 && (
<div className="px-2 py-1.5 text-[10px] font-semibold tracking-wider text-muted uppercase">
Secrets in this {state.tab === "another-project" ? "project" : "environment"}
</div>
)}
{filteredSecrets.map((secret, i) => {
const navIndex = filteredFolders.length + i;
return (
<button
key={secret.id}
type="button"
data-secret-reference-item
data-nav-index={navIndex}
onClick={() => {
onFocusItem();
handleSelectSecret(secret.key);
}}
className={cn(
"group flex w-full cursor-pointer items-center justify-between px-2 py-2 text-left text-sm transition-colors hover:bg-foreground/10",
highlightedIndex === navIndex && "bg-foreground/10"
)}
>
<div className="flex items-center gap-2">
<KeyRoundIcon className="size-4 text-muted" />
<span>{secret.key}</span>
</div>
<span className="text-xs text-muted opacity-0 transition-opacity group-hover:opacity-100">
insert
</span>
</button>
);
})}
</div>
);
};
const renderStepContent = () => {
switch (state.step) {
case "project":
return renderProjectStep();
case "env":
return renderEnvStep();
case "browse":
return renderBrowseStep();
default:
return null;
}
};
if (uniqueSourceProjects.length === 0) {
// If the user is typing a cross-project reference but cross-project sharing
// is not available (e.g. license downgrade), hide the wizard entirely so it
// does not block the input or the revealed value.
if (currentInput.startsWith("@")) {
return null;
}
return <div ref={contentRef}>{renderStepContent()}</div>;
}
return (
<Tabs value={state.tab} onValueChange={handleTabChange} className="gap-0">
<TabsList
aria-label="Secret reference source"
className="h-auto w-full rounded-none rounded-t-md border-0 border-b border-border bg-transparent p-0"
>
<TabsTrigger
value="this-project"
className="flex-1 rounded-none rounded-tl-md py-2 text-xs"
>
This project
</TabsTrigger>
<TabsTrigger
value="another-project"
className="flex-1 rounded-none rounded-tr-md py-2 text-xs"
>
Another project
</TabsTrigger>
</TabsList>
<TabsContent value="this-project">
{state.tab === "this-project" && <div ref={contentRef}>{renderStepContent()}</div>}
</TabsContent>
<TabsContent value="another-project">
{state.tab === "another-project" && <div ref={contentRef}>{renderStepContent()}</div>}
</TabsContent>
</Tabs>
);
};