mirror of
https://github.com/supabase/supabase.git
synced 2026-10-16 14:49:10 +03:00
* feat: add documentation and UI integration for Before User Created hook - Added new guide: `before-user-created-hook.mdx`, documenting usage, inputs, outputs, and multiple complete examples for HTTP and SQL. - Updated navigation menu and hook index table to include the new hook. - Hook is now listed as available on Free and Pro plans. Studio changes: - Registered `Before User Created` hook in `hooks.constants.ts` with proper title, slug, and configuration keys. - Enabled Docs button linking to hook guide in both `CreateHookSheet` and `HookCard` components. - Extended hook listing page to support docs access via `secondaryActions`. This hook allows developers to intercept and reject user creation across all flows (email/password, OAuth, SSO, SAML, anonymous) - enabling custom signup logic like domain allowlists, geofencing, or account gating. * fix: add subnet to mdx lint allowed list * fix: incorporate feedback and spelling changes * feat: add allow/deny domain and CIDR examples to before-user-created hook This commit enhances the documentation for the before-user-created auth hook: - Adds production-ready SQL examples for blocking or allowing signups by email domain (signup_email_domains) and IP address or CIDR (signup_networks) - Introduces enum-based classification (allow vs deny) for both domain and network restrictions - Adds full migration-style snippets for easy copy/paste into Supabase SQL Editor - Includes updated HTTP examples that delegate to Postgres functions via Supabase client rpc() - Adds environment setup guidance and edge function scaffolding * fix: pnpm format --------- Co-authored-by: Chris Stockton <chris.stockton@supabase.io>
131 lines
5.2 KiB
TypeScript
131 lines
5.2 KiB
TypeScript
import { PermissionAction } from '@supabase/shared-types/out/constants'
|
|
import { Check, Webhook } from 'lucide-react'
|
|
import { Badge, Input, copyToClipboard } from 'ui'
|
|
|
|
import { ButtonTooltip } from 'components/ui/ButtonTooltip'
|
|
import { useCheckPermissions } from 'hooks/misc/useCheckPermissions'
|
|
import { Hook } from './hooks.constants'
|
|
import { DocsButton } from 'components/ui/DocsButton'
|
|
|
|
interface HookCardProps {
|
|
hook: Hook
|
|
onSelect: () => void
|
|
}
|
|
|
|
export const HookCard = ({ hook, onSelect }: HookCardProps) => {
|
|
const canUpdateAuthHook = useCheckPermissions(PermissionAction.AUTH_EXECUTE, '*')
|
|
|
|
return (
|
|
<div className="bg-surface-100 border-default overflow-hidden border shadow px-5 py-4 flex flex-row first:rounded-t-md last:rounded-b-md space-x-4">
|
|
<div className="">
|
|
<Webhook size={21} strokeWidth="1" />
|
|
</div>
|
|
<div className="flex flex-col flex-0 overflow-y-auto w-full">
|
|
<span className="text-sm text-foreground">{hook.title}</span>
|
|
<span className="text-sm text-foreground-lighter">{hook.subtitle}</span>
|
|
<div className="text-sm flex flex-row space-x-5 py-4">
|
|
{hook.method.type === 'postgres' ? (
|
|
<div className="flex flex-col w-full space-y-2">
|
|
<div className="flex flex-row items-center">
|
|
<span className="text-foreground-light w-20">type</span>
|
|
<span className="text-foreground">Postgres function</span>
|
|
</div>
|
|
<div className="flex flex-row items-center">
|
|
<span className="text-foreground-light w-20">schema</span>
|
|
<Input
|
|
title={hook.method.schema}
|
|
copy
|
|
readOnly
|
|
disabled
|
|
className="input-mono [&>div>div>div>input]:text-xs [&>div>div>div>input]:opacity-100 flex-1"
|
|
value={hook.method.schema}
|
|
onCopy={() =>
|
|
hook.method.type === 'postgres' && copyToClipboard(hook.method.schema)
|
|
}
|
|
/>
|
|
</div>
|
|
<div className="flex flex-row items-center">
|
|
<span className="text-foreground-light w-20">function</span>
|
|
<Input
|
|
title={hook.method.functionName}
|
|
copy
|
|
readOnly
|
|
disabled
|
|
className="input-mono [&>div>div>div>input]:text-xs [&>div>div>div>input]:opacity-100 flex-1"
|
|
value={hook.method.functionName}
|
|
onCopy={() =>
|
|
hook.method.type === 'postgres' && copyToClipboard(hook.method.functionName)
|
|
}
|
|
/>
|
|
</div>
|
|
</div>
|
|
) : (
|
|
<div className="flex flex-col w-full space-y-2">
|
|
<div className="flex flex-row items-center">
|
|
<span className="text-foreground-light w-20">type</span>
|
|
<span className="text-foreground">HTTPS endpoint</span>
|
|
</div>
|
|
<div className="flex flex-row items-center">
|
|
<span className="text-foreground-light w-20">endpoint</span>
|
|
<Input
|
|
title={hook.method.url}
|
|
copy
|
|
readOnly
|
|
disabled
|
|
className="input-mono [&>div>div>div>input]:text-xs [&>div>div>div>input]:opacity-100 flex-1"
|
|
value={hook.method.url}
|
|
onCopy={() => hook.method.type === 'https' && copyToClipboard(hook.method.url)}
|
|
/>
|
|
</div>
|
|
<div className="flex flex-row items-center">
|
|
<span className="text-foreground-light w-20">secret</span>
|
|
<Input
|
|
copy
|
|
title={hook.method.secret}
|
|
reveal={true}
|
|
readOnly
|
|
disabled
|
|
className="input-mono [&>div>div>div>input]:text-xs [&>div>div>div>input]:opacity-100 flex-1"
|
|
value={hook.method.secret}
|
|
/>
|
|
</div>
|
|
</div>
|
|
)}
|
|
</div>
|
|
<div className="flex flex-row gap-2">
|
|
<ButtonTooltip
|
|
type="default"
|
|
disabled={!canUpdateAuthHook}
|
|
onClick={() => onSelect()}
|
|
tooltip={{
|
|
content: {
|
|
side: 'bottom',
|
|
text: !canUpdateAuthHook
|
|
? 'You need additional permissions to configure auth hooks'
|
|
: undefined,
|
|
},
|
|
}}
|
|
>
|
|
Configure hook
|
|
</ButtonTooltip>
|
|
<DocsButton href={'https://supabase.com/docs/guides/auth/auth-hooks/' + hook.docSlug} />
|
|
</div>
|
|
</div>
|
|
<div className="flex-1">
|
|
{hook.enabled ? (
|
|
<Badge className="space-x-1" variant="brand">
|
|
<div className="h-3.5 w-3.5 bg-brand rounded-full flex justify-center items-center">
|
|
<Check className="h-2 w-2 text-background-overlay " strokeWidth={6} />
|
|
</div>
|
|
<span>Enabled</span>
|
|
</Badge>
|
|
) : (
|
|
<Badge variant="warning">
|
|
<span>Disabled</span>
|
|
</Badge>
|
|
)}
|
|
</div>
|
|
</div>
|
|
)
|
|
}
|