Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

feat: refactor edge-functions templates (#45234)

Kalleby Santosf584fdc97553
diff --git a/apps/studio/components/interfaces/Functions/Functions.templates.ts b/apps/studio/components/interfaces/Functions/Functions.templates.ts
index 4fb7f014e68..bc43a65f487 100644
--- a/apps/studio/components/interfaces/Functions/Functions.templates.ts
+++ b/apps/studio/components/interfaces/Functions/Functions.templates.ts
@@ -5,23 +5,30 @@ export const EDGE_FUNCTION_TEMPLATES = [
description: 'Basic function that returns a JSON response',
content: `// Setup type definitions for built-in Supabase Runtime APIs
import "jsr:@supabase/functions-js/edge-runtime.d.ts";
-interface reqPayload {
+import { withSupabase } from "jsr:@supabase/server@^1";
+
+interface ReqPayload {
name: string;
}
-console.info('server started');
+console.info("server started");
+
+export default {
+ fetch: withSupabase({ auth: ["publishable", "secret"] }, async (req, ctx) => {
+ const { name }: ReqPayload = await req.json();
-Deno.serve(async (req: Request) => {
- const { name }: reqPayload = await req.json();
- const data = {
- message: \`Hello \${name}!\`,
- };
+ // Using 'sb_secret_xyz' bypasses RLS — use for privileged operations
+ if (ctx.authType === "secret") {
+ return Response.json({
+ message: \`Hello \${name} admin!\`,
+ });
+ }
- return new Response(
- JSON.stringify(data),
- { headers: { 'Content-Type': 'application/json', 'Connection': 'keep-alive' }}
- );
-});`,
+ return Response.json({
+ message: \`Hello \${name}!\`,
+ });
+ }),
+};`,
},
{
value: 'database-access',
@@ -29,34 +36,24 @@ Deno.serve(async (req: Request) => {
description: 'Example using Supabase client to query your database',
content: `// Setup type definitions for built-in Supabase Runtime APIs
import "jsr:@supabase/functions-js/edge-runtime.d.ts";
-import { createClient } from 'jsr:@supabase/supabase-js@2'
-
-Deno.serve(async (req) => {
- try {
- const supabase = createClient(
- Deno.env.get('SUPABASE_URL') ?? '',
- Deno.env.get('SUPABASE_ANON_KEY') ?? '',
- { global: { headers: { Authorization: req.headers.get('Authorization')! } } }
- )
+import { withSupabase } from "jsr:@supabase/server@^1";
+// This endpoint uses 'user' access, credentials is required.
+export default {
+ fetch: withSupabase({ auth: "user" }, async (_req, { supabase }) => {
// TODO: Change the table_name to your table
- const { data, error } = await supabase.from('table_name').select('*')
+ const { data, error } = await supabase.from("table_name").select("*");
if (error) {
- throw error
+ return Response.json(
+ { error: error.message },
+ { status: 500 },
+ );
}
- return new Response(JSON.stringify({ data }), {
- headers: { 'Content-Type': 'application/json' },
- status: 200,
- })
- } catch (err) {
- return new Response(JSON.stringify({ message: err?.message ?? err }), {
- headers: { 'Content-Type': 'application/json' },
- status: 500
- })
- }
-})`,
+ return Response.json({ data });
+ }),
+};`,
},
{
value: 'storage-upload',
@@ -64,33 +61,34 @@ Deno.serve(async (req) => {
description: 'Upload files to Supabase Storage',
content: `// Setup type definitions for built-in Supabase Runtime APIs
import "jsr:@supabase/functions-js/edge-runtime.d.ts";
-import { createClient } from 'jsr:@supabase/supabase-js@2'
-import { randomUUID } from 'node:crypto'
-
-const supabase = createClient(
- Deno.env.get('SUPABASE_URL') ?? '',
- Deno.env.get('SUPABASE_ANON_KEY') ?? ''
-)
-
-Deno.serve(async (req) => {
- const formData = await req.formData()
- const file = formData.get('file')
-
- // TODO: update your-bucket to the bucket you want to write files
- const { data, error } = await supabase
- .storage
- .from('your-bucket')
- .upload(
- \`\${file.name}-\${randomUUID()}\`,
- file,
- { contentType: file.type }
- )
- if (error) throw error
- return new Response(
- JSON.stringify({ data }),
- { headers: { 'Content-Type': 'application/json' }}
- )
-})`,
+import { withSupabase } from "jsr:@supabase/server@^1";
+import { randomUUID } from "node:crypto"
+
+export default {
+ fetch: withSupabase({ auth: "publishable" }, async (req, { supabase }) => {
+ const formData = await req.formData()
+ const file = formData.get('file')
+
+ // TODO: update your-bucket to the bucket you want to write files
+ const { data, error } = await supabase
+ .storage
+ .from('your-bucket')
+ .upload(
+ \`\${file.name}-\${randomUUID()}\`,
+ file,
+ { contentType: file.type }
+ )
+
+ if (error) {
+ return Response.json(
+ { error: error.message },
+ { status: 500 },
+ );
+ }
+
+ return Response.json({ data });
+ }),
+};`,
},
{
value: 'node-api',
@@ -142,111 +140,99 @@ app.listen(8000);`,
content: `/*
* Setup OPENAI_API_KEY secret to get started.
* For usage with useChat, point transport.api to this endpoint
- * and include your publishable key as Authorization: Bearer <key> in transport.headers.
+ * and include your publishable key as ApiKey: <key> in transport.headers.
*/
-import { createOpenAI } from 'npm:@ai-sdk/openai';
-import { convertToModelMessages, streamText } from 'npm:ai';
-
-const corsHeaders = {
- 'Access-Control-Allow-Origin': '*',
- 'Access-Control-Allow-Methods': 'POST, OPTIONS',
- 'Access-Control-Allow-Headers': 'authorization, content-type',
- 'Access-Control-Max-Age': '3600',
- Vary: 'Access-Control-Request-Headers',
+import "jsr:@supabase/functions-js/edge-runtime.d.ts";
+import { withSupabase } from "jsr:@supabase/server@^1";
+import { createOpenAI } from "npm:@ai-sdk/openai";
+import { convertToModelMessages, streamText } from "npm:ai";
+
+const cors = {
+ "Access-Control-Allow-Origin": "*",
+ "Access-Control-Allow-Methods": "POST, OPTIONS",
+ "Access-Control-Allow-Headers": "authorization, content-type",
+ "Access-Control-Max-Age": "3600",
+ Vary: "Access-Control-Request-Headers",
};
-const json = (status: number, body: unknown) =>
- new Response(JSON.stringify(body), {
- status,
- headers: { ...corsHeaders, 'Content-Type': 'application/json' },
- });
-
class ClientError extends Error {}
const openai = createOpenAI({
- apiKey: Deno.env.get('OPENAI_API_KEY'),
+ apiKey: Deno.env.get("OPENAI_API_KEY"),
});
-const SYSTEM_PROMPT = 'You are a helpful AI assistant.';
-
-Deno.serve(async (req) => {
- if (req.method === 'OPTIONS') {
- return new Response('ok', { headers: corsHeaders });
- }
-
- try {
- const body = await req.json().catch(() => {
- throw new ClientError('Invalid JSON payload');
- }) as { messages?: unknown; model?: unknown };
-
- const { messages, model: modelName } = body;
-
- if (!Array.isArray(messages)) {
- throw new ClientError('Request must include a messages array');
- }
-
- const normalizedMessages = await convertToModelMessages(messages);
-
- const model = openai(
- typeof modelName === 'string' ? modelName : 'gpt-5.1-chat-latest',
- );
-
- const result = streamText({
- model,
- messages: normalizedMessages,
- system: SYSTEM_PROMPT,
- });
-
- return result.toUIMessageStreamResponse({
- headers: corsHeaders,
- sendReasoning: true,
- sendSources: true,
- });
- } catch (err) {
- if (err instanceof ClientError) {
- return json(400, { error: err.message });
+const SYSTEM_PROMPT = "You are a helpful AI assistant.";
+
+export default {
+ fetch: withSupabase({ auth: "publishable", cors }, async (req, _ctx) => {
+ try {
+ const body = await req.json().catch(() => {
+ throw new ClientError("Invalid JSON payload");
+ }) as { messages?: unknown; model?: unknown };
+
+ const { messages, model: modelName } = body;
+
+ if (!Array.isArray(messages)) {
+ throw new ClientError("Request must include a messages array");
+ }
+
+ const normalizedMessages = await convertToModelMessages(messages);
+
+ const model = openai(
+ typeof modelName === "string" ? modelName : "gpt-5.1-chat-latest",
+ );
+
+ const result = streamText({
+ model,
+ messages: normalizedMessages,
+ system: SYSTEM_PROMPT,
+ });
+
+ return result.toUIMessageStreamResponse({
+ sendReasoning: true,
+ sendSources: true,
+ });
+ } catch (err) {
+ if (err instanceof ClientError) {
+ return Response.json({ error: err.message }, { status: 400 });
+ }
+
+ console.error("Assistant chat error:", err);
+ return Response.json({
+ error: "Failed to process chat request",
+ details: err instanceof Error ? err.message : String(err),
+ }, { status: 500 });
}
-
- console.error('Assistant chat error:', err);
- return json(500, {
- error: 'Failed to process chat request',
- details: err instanceof Error ? err.message : String(err),
- });
- }
-});`,
+ }),
+};`,
},
{
value: 'generate-recipes-with-ai-sdk',
name: 'Generate recipes with AI SDK',
description: 'Generate structured cooking recipes with Vercel AI SDK',
content: `/*
-* 1) Setup OPENAI_API_KEY secret to get started.
-* 2) Call this endpoint with { prompt, model? } to generate a recipe object matching the schema below.
-*/
-
-import { createOpenAI } from 'npm:@ai-sdk/openai';
+ * 1) Setup OPENAI_API_KEY secret to get started.
+ * 2) Call this endpoint with { prompt, model? } to generate a recipe object matching the schema below.
+ */
+import "jsr:@supabase/functions-js/edge-runtime.d.ts";
+import { withSupabase } from "jsr:@supabase/server@^1";
+import { createOpenAI } from "npm:@ai-sdk/openai";
import { generateText, Output } from "npm:ai";
-import { z } from 'npm:zod';
-
-const corsHeaders = {
- 'Access-Control-Allow-Origin': '*',
- 'Access-Control-Allow-Methods': 'POST, OPTIONS',
- 'Access-Control-Allow-Headers': 'authorization, content-type',
- 'Access-Control-Max-Age': '3600',
- Vary: 'Access-Control-Request-Headers',
+import { z } from "npm:zod";
+
+const cors = {
+ "Access-Control-Allow-Origin": "*",
+ "Access-Control-Allow-Methods": "POST, OPTIONS",
+ "Access-Control-Allow-Headers": "authorization, content-type",
+ "Access-Control-Max-Age": "3600",
+ Vary: "Access-Control-Request-Headers",
};
-const json = (status: number, body: unknown) =>
- new Response(JSON.stringify(body), {
- status,
- headers: { ...corsHeaders, 'Content-Type': 'application/json' },
- });
-
class ClientError extends Error {}
const openai = createOpenAI({
- apiKey: Deno.env.get('OPENAI_API_KEY'),
+ apiKey: Deno.env.get("OPENAI_API_KEY"),
});
const RecipeSchema = z.object({
@@ -258,53 +244,52 @@ const RecipeSchema = z.object({
});
const SYSTEM_PROMPT =
- 'You are a recipe generator. Always return a structured recipe matching the given schema.';
-
-Deno.serve(async (req) => {
- if (req.method === 'OPTIONS') {
- return new Response('ok', { headers: corsHeaders });
- }
-
- try {
- const body = await req.json().catch(() => {
- throw new ClientError('Invalid JSON payload');
- }) as {
- model?: unknown;
- prompt?: unknown;
- };
-
- const { model: modelName, prompt } = body;
-
- if (typeof prompt !== 'string' || !prompt.trim()) {
- throw new ClientError('Request must include a non-empty prompt string');
+ "You are a recipe generator. Always return a structured recipe matching the given schema.";
+
+export default {
+ fetch: withSupabase({ auth: "publishable", cors }, async (req, _ctx) => {
+ try {
+ const body = await req.json().catch(() => {
+ throw new ClientError("Invalid JSON payload");
+ }) as {
+ model?: unknown;
+ prompt?: unknown;
+ };
+
+ const { model: modelName, prompt } = body;
+
+ if (typeof prompt !== "string" || !prompt.trim()) {
+ throw new ClientError("Request must include a non-empty prompt string");
+ }
+
+ const model = openai(
+ typeof modelName === "string" ? modelName : "gpt-5.1-chat-latest",
+ );
+
+ const result = await generateText({
+ model,
+ system: SYSTEM_PROMPT,
+ prompt,
+ output: Output.object({
+ schema: RecipeSchema,
+ }),
+ });
+
+ return Response.json(result.output, { status: 200 });
+ } catch (err) {
+ if (err instanceof ClientError) {
+ return Response.json({ error: err.message }, { status: 400 });
+ }
+
+ console.error("generateText error:", err);
+ console.error("Assistant chat error:", err);
+ return Response.json({
+ error: "Failed to process generateText request",
+ details: err instanceof Error ? err.message : String(err),
+ }, { status: 500 });
}
-
- const model = openai(
- typeof modelName === 'string' ? modelName : 'gpt-5.1-chat-latest',
- );
-
- const result = await generateText({
- model,
- system: SYSTEM_PROMPT,
- prompt,
- output: Output.object({
- schema: RecipeSchema,
- }),
- });
-
- return json(200, result.output);
- } catch (err) {
- if (err instanceof ClientError) {
- return json(400, { error: err.message });
- }
-
- console.error('generateText error:', err);
- return json(500, {
- error: 'Failed to process generateText request',
- details: err instanceof Error ? err.message : String(err),
- });
- }
-});`,
+ }),
+};`,
},
{
value: 'stripe-webhook',
@@ -312,40 +297,45 @@ Deno.serve(async (req) => {
description: 'Handle Stripe webhook events securely',
content: `// Setup type definitions for built-in Supabase Runtime APIs
import "jsr:@supabase/functions-js/edge-runtime.d.ts";
-import Stripe from 'npm:[email protected]'
-
-const stripe = new Stripe(Deno.env.get('STRIPE_API_KEY') as string, {
- // This is needed to use the Fetch API rather than relying on the Node http
- // package.
- apiVersion: '2024-11-20'
-})
-
-// This is needed in order to use the Web Crypto API in Deno.
-const cryptoProvider = Stripe.createSubtleCryptoProvider()
-
-console.log('Stripe Webhook Function booted!')
-
-Deno.serve(async (request) => {
- const signature = request.headers.get('Stripe-Signature')
-
- // First step is to verify the event. The .text() method must be used as the
- // verification relies on the raw request body rather than the parsed JSON.
- const body = await request.text()
- let receivedEvent
- try {
- receivedEvent = await stripe.webhooks.constructEventAsync(
- body,
- signature!,
- Deno.env.get('STRIPE_WEBHOOK_SIGNING_SECRET')!,
- undefined,
- cryptoProvider
- )
- } catch (err) {
- return new Response(err.message, { status: 400 })
- }
- console.log(\`🔔 Event received: \${receivedEvent.id}\`)
- return new Response(JSON.stringify({ ok: true }), { status: 200 })
-});`,
+import { withSupabase } from "jsr:@supabase/server@^1";
+import Stripe from "npm:stripe";
+
+const stripe = new Stripe(Deno.env.get("STRIPE_SECRET_KEY")!);
+
+export default {
+ fetch: withSupabase({ auth: "none" }, async (req, { supabaseAdmin }) => {
+ const body = await req.text();
+ const sig = req.headers.get("stripe-signature")!;
+
+ let event: Stripe.Event;
+ try {
+ event = await stripe.webhooks.constructEventAsync(
+ body,
+ sig,
+ Deno.env.get("STRIPE_WEBHOOK_SECRET")!,
+ );
+ } catch {
+ return Response.json({ error: "Invalid signature" }, { status: 401 });
+ }
+
+ /*
+ switch (event.type) {
+ case "checkout.session.completed": {
+ const session = event.data.object as Stripe.Checkout.Session;
+ await supabaseAdmin
+ .from("orders")
+ .update({ status: "paid" })
+ .eq("stripe_session_id", session.id);
+ break;
+ }
+ }
+ */
+
+ console.log(\`🔔 Event received: \${event.id}\`)
+ return Response.json({ received: true });
+ }),
+};
+`,
},
{
value: 'resend-email',
@@ -353,29 +343,31 @@ Deno.serve(async (request) => {
description: 'Send emails using the Resend API',
content: `// Setup type definitions for built-in Supabase Runtime APIs
import "jsr:@supabase/functions-js/edge-runtime.d.ts";
+import { withSupabase } from "jsr:@supabase/server@^1";
+
+const RESEND_API_KEY = Deno.env.get("RESEND_API_KEY")!;
+
+export default {
+ fetch: withSupabase({ auth: "user" }, async (req, _ctx) => {
+ const { to, subject, html } = await req.json();
+ const res = await fetch("https://api.resend.com/emails", {
+ method: "POST",
+ headers: {
+ "Content-Type": "application/json",
+ Authorization: \`Bearer \${RESEND_API_KEY}\`,
+ },
+ body: JSON.stringify({
+ to,
+ subject,
+ html,
+ }),
+ });
+ const data = await res.json();
-const RESEND_API_KEY = Deno.env.get('RESEND_API_KEY')!
-
-Deno.serve(async (req) => {
- const { to, subject, html } = await req.json()
- const res = await fetch('https://api.resend.com/emails', {
- method: 'POST',
- headers: {
- 'Content-Type': 'application/json',
- Authorization: \`Bearer \${RESEND_API_KEY}\`,
- },
- body: JSON.stringify({
- to,
- subject,
- html,
- }),
- })
- const data = await res.json()
- return new Response(JSON.stringify(data), {
- headers: { 'Content-Type': 'application/json' },
- })
-})`,
+ return Response.json(data);
+ }),
+};`,
},
{
value: 'image-transform',
@@ -383,27 +375,32 @@ Deno.serve(async (req) => {
description: 'Transform images using ImageMagick WASM',
content: `// Setup type definitions for built-in Supabase Runtime APIs
import "jsr:@supabase/functions-js/edge-runtime.d.ts";
+import { withSupabase } from "jsr:@supabase/server@^1";
import {
ImageMagick,
initializeImageMagick,
-} from "npm:@imagemagick/[email protected]"
-
-await initializeImageMagick()
-
-Deno.serve(async (req) => {
- const formData = await req.formData()
- const file = formData.get('file')
- const content = await file.arrayBuffer()
- const result = await ImageMagick.read(new Uint8Array(content), (img) => {
- img.resize(500, 300)
- img.blur(60, 5)
- return img.write(data => data)
- })
- return new Response(
- result,
- { headers: { 'Content-Type': 'image/png' }}
- )
-})`,
+} from "npm:@imagemagick/[email protected]";
+
+await initializeImageMagick();
+
+export default {
+ fetch: withSupabase({ auth: "publishable" }, async (req, _ctx) => {
+ const formData = await req.formData();
+ const file = formData.get("file");
+ const content = await file.arrayBuffer();
+
+ const result = await ImageMagick.read(new Uint8Array(content), (img) => {
+ img.resize(500, 300);
+ img.blur(60, 5);
+ return img.write((data) => data);
+ });
+
+ return new Response(
+ result,
+ { headers: { "Content-Type": "image/png" } },
+ );
+ }),
+};`,
},
{
value: 'websocket-server',
@@ -411,22 +408,29 @@ Deno.serve(async (req) => {
description: 'Create a real-time WebSocket server',
content: `// Setup type definitions for built-in Supabase Runtime APIs
import "jsr:@supabase/functions-js/edge-runtime.d.ts";
+import { withSupabase } from "jsr:@supabase/server@^1";
-Deno.serve((req) => {
- const upgrade = req.headers.get("upgrade") || ""
- if (upgrade.toLowerCase() != "websocket") {
- return new Response("request isn't trying to upgrade to websocket.")
- }
- const { socket, response } = Deno.upgradeWebSocket(req)
- socket.onopen = () => {
- console.log("client connected!")
- socket.send('Welcome to Supabase Edge Functions!')
- }
- socket.onmessage = (e) => {
- console.log("client sent message:", e.data)
- socket.send(new Date().toString())
- }
- return response
-})`,
+export default {
+ fetch: withSupabase({ auth: "publishable" }, async (req, _ctx) => {
+ const upgrade = req.headers.get("upgrade") || "";
+ if (upgrade.toLowerCase() != "websocket") {
+ return new Response("request isn't trying to upgrade to websocket.");
+ }
+
+ const { socket, response } = Deno.upgradeWebSocket(req);
+
+ socket.onopen = () => {
+ console.log("client connected!");
+ socket.send("Welcome to Supabase Edge Functions!");
+ };
+
+ socket.onmessage = (e) => {
+ console.log("client sent message:", e.data);
+ socket.send(new Date().toString());
+ };
+
+ return response;
+ }),
+};`,
},
]