The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
import { WorkspaceSchemaExtended } from "@/lib/zod/schemas/workspaces";
import { PRO_PLAN, fetcher, getNextPlan } from "@dub/utils";
import { useParams, useSearchParams } from "next/navigation";
import useSWR, { SWRConfiguration } from "swr";
import * as z from "zod/v4";
import { MEGA_WORKSPACE_LINKS_LIMIT } from "../constants/misc";
export default function useWorkspace({
swrOpts,
}: {
swrOpts?: SWRConfiguration;
} = {}) {
let { slug } = useParams() as { slug: string | string[] | null };
const searchParams = useSearchParams();
// catch-all routes (e.g. /marketplace/[[...slug]]) surface `slug` as an array,
// which is never a workspace slug - ignore it so we don't fetch /api/workspaces/<segment>
if (Array.isArray(slug)) {
slug = null;
}
if (!slug) {
slug = searchParams.get("slug") || searchParams.get("workspace");
}
const {
data: workspace,
error,
mutate,
} = useSWR<z.infer<typeof WorkspaceSchemaExtended>>(
slug && `/api/workspaces/${slug}`,
fetcher,
{
dedupingInterval: 60000,
...swrOpts,
},
);
return {
...workspace,
id: workspace?.id,
slug: workspace?.slug ?? slug ?? undefined,
nextPlan: workspace?.plan ? getNextPlan(workspace.plan) : PRO_PLAN,
role: (workspace?.users && workspace.users[0].role) || "member",
isOwner: workspace?.users && workspace.users[0].role === "owner",
exceededEvents: workspace && workspace.usage >= workspace.usageLimit,
exceededLinks: workspace && workspace.linksUsage >= workspace.linksLimit,
exceededAI: workspace && workspace.aiUsage >= workspace.aiLimit,
exceededDomains:
workspace?.domains && workspace.domains.length >= workspace.domainsLimit,
isMegaWorkspace:
workspace && workspace.totalLinks >= MEGA_WORKSPACE_LINKS_LIMIT,
error,
defaultFolderId: workspace?.users && workspace.users[0].defaultFolderId,
mutate,
loading: slug && !workspace && !error ? true : false,
};
}