* Update Supabase docs URLs to use env variable Co-authored-by: a <a@alaisteryoung.com> * Refactor: Use DOCS_URL constant for documentation links This change centralizes documentation links using a new DOCS_URL constant, improving maintainability and consistency. Co-authored-by: a <a@alaisteryoung.com> * Refactor: Use DOCS_URL constant for all documentation links This change replaces hardcoded documentation URLs with a centralized constant, improving maintainability and consistency. Co-authored-by: a <a@alaisteryoung.com> * replace more instances * ci: Autofix updates from GitHub workflow * remaining instances * fix duplicate useRouter --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: alaister <10985857+alaister@users.noreply.github.com>
399 lines
16 KiB
TypeScript
399 lines
16 KiB
TypeScript
import { Code, Github, Lock, Play, Server, Terminal } from 'lucide-react'
|
|
import Link from 'next/link'
|
|
import { useRouter } from 'next/router'
|
|
import { useMemo } from 'react'
|
|
|
|
import { useParams } from 'common'
|
|
import { ScaffoldSectionTitle } from 'components/layouts/Scaffold'
|
|
import { DocsButton } from 'components/ui/DocsButton'
|
|
import { ResourceItem } from 'components/ui/Resource/ResourceItem'
|
|
import { ResourceList } from 'components/ui/Resource/ResourceList'
|
|
import { useSendEventMutation } from 'data/telemetry/send-event-mutation'
|
|
import { useIsFeatureEnabled } from 'hooks/misc/useIsFeatureEnabled'
|
|
import { useSelectedOrganizationQuery } from 'hooks/misc/useSelectedOrganization'
|
|
import { DOCS_URL } from 'lib/constants'
|
|
import { useAiAssistantStateSnapshot } from 'state/ai-assistant-state'
|
|
import {
|
|
AiIconAnimation,
|
|
Button,
|
|
Card,
|
|
CardContent,
|
|
CardHeader,
|
|
CardTitle,
|
|
cn,
|
|
CodeBlock,
|
|
Dialog,
|
|
DialogContent,
|
|
DialogDescription,
|
|
DialogHeader,
|
|
DialogSection,
|
|
DialogTitle,
|
|
DialogTrigger,
|
|
Separator,
|
|
} from 'ui'
|
|
import { EDGE_FUNCTION_TEMPLATES } from './Functions.templates'
|
|
import { TerminalInstructions } from './TerminalInstructions'
|
|
|
|
export const FunctionsEmptyState = () => {
|
|
const { ref } = useParams()
|
|
const router = useRouter()
|
|
const aiSnap = useAiAssistantStateSnapshot()
|
|
|
|
const { mutate: sendEvent } = useSendEventMutation()
|
|
const { data: org } = useSelectedOrganizationQuery()
|
|
|
|
const showStripeExample = useIsFeatureEnabled('edge_functions:show_stripe_example')
|
|
const templates = useMemo(() => {
|
|
if (showStripeExample) {
|
|
return EDGE_FUNCTION_TEMPLATES
|
|
}
|
|
|
|
// Filter out Stripe template
|
|
return EDGE_FUNCTION_TEMPLATES.filter((template) => template.value !== 'stripe-webhook')
|
|
}, [showStripeExample])
|
|
|
|
return (
|
|
<>
|
|
<Card>
|
|
<CardHeader>
|
|
<CardTitle>Create your first edge function</CardTitle>
|
|
</CardHeader>
|
|
<CardContent className="p-0 grid grid-cols-[repeat(auto-fit,minmax(240px,1fr))] divide-y md:divide-y-0 md:divide-x divide-default items-stretch">
|
|
{/* Editor Option */}
|
|
<div className="p-8">
|
|
<div className="flex items-center gap-2">
|
|
<Code strokeWidth={1.5} size={20} />
|
|
<h4 className="text-base text-foreground">Via Editor</h4>
|
|
</div>
|
|
<p className="text-sm text-foreground-light mb-4 mt-1">
|
|
Create and edit functions directly in the browser. Download to local at any time.
|
|
</p>
|
|
<Button
|
|
type="default"
|
|
onClick={() => {
|
|
router.push(`/project/${ref}/functions/new`)
|
|
sendEvent({
|
|
action: 'edge_function_via_editor_button_clicked',
|
|
properties: { origin: 'no_functions_block' },
|
|
groups: { project: ref ?? 'Unknown', organization: org?.slug ?? 'Unknown' },
|
|
})
|
|
}}
|
|
>
|
|
Open Editor
|
|
</Button>
|
|
</div>
|
|
|
|
{/* AI Assistant Option */}
|
|
<div className="p-8">
|
|
<div className="flex items-center gap-2">
|
|
<AiIconAnimation size={20} />
|
|
<h4 className="text-base text-foreground">AI Assistant</h4>
|
|
</div>
|
|
<p className="text-sm text-foreground-light mb-4 mt-1">
|
|
Let our AI assistant help you create functions. Perfect for kickstarting a function.
|
|
</p>
|
|
<Button
|
|
type="default"
|
|
onClick={() => {
|
|
aiSnap.newChat({
|
|
name: 'Create new edge function',
|
|
open: true,
|
|
initialInput: 'Create a new edge function that ...',
|
|
suggestions: {
|
|
title:
|
|
'I can help you create a new edge function. Here are a few example prompts to get you started:',
|
|
prompts: [
|
|
{
|
|
label: 'Stripe Payments',
|
|
description:
|
|
'Create a new edge function that processes payments with Stripe',
|
|
},
|
|
{
|
|
label: 'Email with Resend',
|
|
description: 'Create a new edge function that sends emails with Resend',
|
|
},
|
|
{
|
|
label: 'PDF Generator',
|
|
description:
|
|
'Create a new edge function that generates PDFs from HTML templates',
|
|
},
|
|
],
|
|
},
|
|
})
|
|
sendEvent({
|
|
action: 'edge_function_ai_assistant_button_clicked',
|
|
properties: { origin: 'no_functions_block' },
|
|
groups: { project: ref ?? 'Unknown', organization: org?.slug ?? 'Unknown' },
|
|
})
|
|
}}
|
|
>
|
|
Open Assistant
|
|
</Button>
|
|
</div>
|
|
|
|
{/* CLI Option */}
|
|
<div className="p-8">
|
|
<div className="flex items-center gap-2">
|
|
<Terminal strokeWidth={1.5} size={20} />
|
|
<h4 className="text-base text-foreground">Via CLI</h4>
|
|
</div>
|
|
<p className="text-sm text-foreground-light mb-4 mt-1">
|
|
Create and deploy functions using the Supabase CLI. Ideal for local development and
|
|
version control.
|
|
</p>
|
|
|
|
<Dialog>
|
|
<DialogTrigger asChild>
|
|
<Button
|
|
type="default"
|
|
onClick={() =>
|
|
sendEvent({
|
|
action: 'edge_function_via_cli_button_clicked',
|
|
properties: { origin: 'no_functions_block' },
|
|
groups: { project: ref ?? 'Unknown', organization: org?.slug ?? 'Unknown' },
|
|
})
|
|
}
|
|
>
|
|
View CLI Instructions
|
|
</Button>
|
|
</DialogTrigger>
|
|
<DialogContent size="large">
|
|
<DialogSection padding="small">
|
|
<TerminalInstructions />
|
|
</DialogSection>
|
|
</DialogContent>
|
|
</Dialog>
|
|
</div>
|
|
</CardContent>
|
|
</Card>
|
|
<ScaffoldSectionTitle className="text-xl mb-4 mt-12">
|
|
Start with a template
|
|
</ScaffoldSectionTitle>
|
|
<ResourceList>
|
|
{templates.map((template) => (
|
|
<ResourceItem
|
|
key={template.name}
|
|
media={<Code strokeWidth={1.5} size={16} className="-translate-y-[9px]" />}
|
|
onClick={() => {
|
|
sendEvent({
|
|
action: 'edge_function_template_clicked',
|
|
properties: { templateName: template.name, origin: 'functions_page' },
|
|
groups: { project: ref ?? 'Unknown', organization: org?.slug ?? 'Unknown' },
|
|
})
|
|
}}
|
|
>
|
|
<Link href={`/project/${ref}/functions/new?template=${template.value}`}>
|
|
<p>{template.name}</p>
|
|
<p className="text-sm text-foreground-lighter">{template.description}</p>
|
|
</Link>
|
|
</ResourceItem>
|
|
))}
|
|
</ResourceList>
|
|
</>
|
|
)
|
|
}
|
|
|
|
export const FunctionsEmptyStateLocal = () => {
|
|
const showStripeExample = useIsFeatureEnabled('edge_functions:show_stripe_example')
|
|
const templates = useMemo(() => {
|
|
if (showStripeExample) {
|
|
return EDGE_FUNCTION_TEMPLATES
|
|
}
|
|
|
|
// Filter out Stripe template
|
|
return EDGE_FUNCTION_TEMPLATES.filter((template) => template.value !== 'stripe-webhook')
|
|
}, [showStripeExample])
|
|
|
|
return (
|
|
<>
|
|
<div className="flex flex-col gap-y-4">
|
|
<Card>
|
|
<CardHeader>
|
|
<CardTitle>Developing Edge Functions locally</CardTitle>
|
|
</CardHeader>
|
|
<CardContent
|
|
className={cn(
|
|
'p-0 flex flex-col',
|
|
'2xl:grid 2xl:grid-cols-[repeat(auto-fit,minmax(240px,1fr))] 2xl:divide-y-0 2xl:divide-x',
|
|
'divide-y divide-default items-stretch'
|
|
)}
|
|
>
|
|
<div className="p-8">
|
|
<div className="flex items-center gap-2">
|
|
<Code size={20} />
|
|
<h4 className="text-base text-foreground">Create an Edge Function</h4>
|
|
</div>
|
|
<p className="text-sm text-foreground-light mt-1 mb-4 prose [&>code]:text-xs text-sm max-w-full">
|
|
Create a new edge function called <code>hello-world</code> in your project via the
|
|
Supabase CLI.
|
|
</p>
|
|
<div className="mb-4">
|
|
<CodeBlock
|
|
language="bash"
|
|
hideLineNumbers={true}
|
|
className={cn(
|
|
'px-3.5 max-w-full prose dark:prose-dark [&>code]:m-0 2xl:min-h-28'
|
|
)}
|
|
value="supabase functions new hello-world"
|
|
/>
|
|
</div>
|
|
<DocsButton
|
|
href={`${DOCS_URL}/guides/functions/local-quickstart#create-an-edge-function`}
|
|
/>
|
|
</div>
|
|
|
|
<div className="p-8">
|
|
<div className="flex items-center gap-2">
|
|
<Play size={20} />
|
|
<h4 className="text-base text-foreground">Run Edge Functions locally</h4>
|
|
</div>
|
|
<p className="text-sm text-foreground-light mt-1 mb-4 prose [&>code]:text-xs text-sm max-w-full">
|
|
You can run your Edge Function locally using <code>supabase functions serve</code>.
|
|
</p>
|
|
<div className="mb-4">
|
|
<CodeBlock
|
|
language="bash"
|
|
hideLineNumbers={true}
|
|
className={cn(
|
|
'px-3.5 max-w-full prose dark:prose-dark [&>code]:m-0 2xl:min-h-28'
|
|
)}
|
|
value={`
|
|
supabase start # start the supabase stack
|
|
supabase functions serve # start the Functions watcher`.trim()}
|
|
/>
|
|
</div>
|
|
<DocsButton
|
|
href={`${DOCS_URL}/guides/functions/local-quickstart#running-edge-functions-locally`}
|
|
/>
|
|
</div>
|
|
|
|
<div className="p-8">
|
|
<div className="flex items-center gap-2">
|
|
<Terminal strokeWidth={1.5} size={20} />
|
|
<h4 className="text-base text-foreground">Invoke Edge Functions locally</h4>
|
|
</div>
|
|
<p className="text-sm text-foreground-light mt-1 mb-4">
|
|
While serving your local Edge Functions, you can invoke it using cURL or one of the
|
|
client libraries.
|
|
</p>
|
|
<div className="mb-4">
|
|
<CodeBlock
|
|
language="bash"
|
|
hideLineNumbers={true}
|
|
className={cn(
|
|
'px-3.5 max-w-full prose dark:prose-dark [&>code]:m-0 2xl:min-h-28'
|
|
)}
|
|
value={`
|
|
curl --request POST 'http://localhost:54321/functions/v1/hello-world' \\
|
|
--header 'Authorization: Bearer SUPABASE_ANON_KEY' \\
|
|
--header 'Content-Type: application/json' \\
|
|
--data '{ "name":"Functions" }'`.trim()}
|
|
/>
|
|
</div>
|
|
<DocsButton
|
|
href={`${DOCS_URL}/guides/functions/local-quickstart#invoking-edge-functions-locally`}
|
|
/>
|
|
</div>
|
|
</CardContent>
|
|
</Card>
|
|
|
|
<Card>
|
|
<CardHeader>
|
|
<CardTitle>Self-hosting Edge Functions</CardTitle>
|
|
</CardHeader>
|
|
<CardContent className="p-0 grid grid-cols-[repeat(auto-fit,minmax(240px,1fr))] divide-y md:divide-y-0 md:divide-x divide-default items-stretch">
|
|
<div className="p-8">
|
|
<div className="flex items-center gap-2">
|
|
<Server size={20} />
|
|
<h4 className="text-base text-foreground">Self-hosting Edge Functions</h4>
|
|
</div>
|
|
<p className="text-sm text-foreground-light mt-1 mb-4 max-w-3xl">
|
|
Supabase Edge Runtime consists of a web server based on the Deno runtime, capable of
|
|
running Javascript, Typescript, and WASM services. You may self-host edge functions
|
|
on providers like Fly.io, Digital Ocean, or AWS.
|
|
</p>
|
|
<div className="flex items-center gap-x-2">
|
|
<DocsButton href={`${DOCS_URL}/reference/self-hosting-functions/introduction`} />
|
|
<Button asChild type="default" icon={<Github />}>
|
|
<a href="https://github.com/supabase/edge-runtime/">GitHub</a>
|
|
</Button>
|
|
</div>
|
|
</div>
|
|
</CardContent>
|
|
</Card>
|
|
|
|
<ScaffoldSectionTitle className="text-xl mt-12">Explore our templates</ScaffoldSectionTitle>
|
|
<ResourceList>
|
|
{templates.map((template) => (
|
|
<Dialog>
|
|
<DialogTrigger asChild>
|
|
<ResourceItem
|
|
key={template.name}
|
|
media={<Code strokeWidth={1.5} size={16} className="-translate-y-[9px]" />}
|
|
>
|
|
<div>
|
|
<p>{template.name}</p>
|
|
<p className="text-sm text-foreground-lighter">{template.description}</p>
|
|
</div>
|
|
</ResourceItem>
|
|
</DialogTrigger>
|
|
<DialogContent size="large">
|
|
<DialogHeader>
|
|
<DialogTitle>{template.name}</DialogTitle>
|
|
<DialogDescription>{template.description}</DialogDescription>
|
|
</DialogHeader>
|
|
<Separator />
|
|
<DialogSection className="!p-0">
|
|
<CodeBlock
|
|
language="ts"
|
|
hideLineNumbers={true}
|
|
className={cn(
|
|
'border-0 rounded-none px-3.5 max-w-full prose dark:prose-dark [&>code]:m-0 max-h-[420px]'
|
|
)}
|
|
value={template.content}
|
|
/>
|
|
</DialogSection>
|
|
</DialogContent>
|
|
</Dialog>
|
|
))}
|
|
</ResourceList>
|
|
</div>
|
|
</>
|
|
)
|
|
}
|
|
|
|
export const FunctionsSecretsEmptyStateLocal = () => {
|
|
return (
|
|
<Card>
|
|
<CardHeader>
|
|
<CardTitle>Managing secrets and environment variables locally</CardTitle>
|
|
</CardHeader>
|
|
<CardContent className="p-0 grid grid-cols-[repeat(auto-fit,minmax(240px,1fr))] divide-y md:divide-y-0 md:divide-x divide-default items-stretch">
|
|
<div className="p-8">
|
|
<div className="flex items-center gap-2">
|
|
<Lock size={20} />
|
|
<h4 className="text-base text-foreground">Managing secrets</h4>
|
|
</div>
|
|
<div className="text-sm text-foreground-light mt-1 mb-4 max-w-3xl">
|
|
<p>
|
|
Local secrets and environment variables can be loaded in either of the following two
|
|
ways
|
|
</p>
|
|
<ul className="list-disc pl-6">
|
|
<li className="prose [&>code]:text-xs text-sm max-w-full">
|
|
Through an <code>.env</code> file placed at <code>supabase/functions/.env</code>,
|
|
which is automatically loaded on <code>supabase start</code>
|
|
</li>
|
|
<li className="prose [&>code]:text-xs text-sm max-w-full">
|
|
Through the <code>--env-file</code> option for <code>supabase functions serve</code>
|
|
, for example: <code>supabase functions serve --env-file ./path/to/.env-file</code>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<DocsButton href={`${DOCS_URL}/guides/functions/secrets#using-the-cli`} />
|
|
</div>
|
|
</CardContent>
|
|
</Card>
|
|
)
|
|
}
|