@plutocms/supabase 0.12.0 → 0.14.0

package/server/api/{access → _pluto/supabase/access}/users/[id]/resend.post.ts

@@ -1,16 +1,16 @@
 import { serverSupabaseClient } from '#supabase/server'
-import { mapAccessError } from '../../../../utils/access-errors'
-import { inviteRedirectUrl, isEmailExistsError, requireUserId, resendBodySchema } from '../../../../utils/access-invite'
+import { mapAccessError } from '../../../../../../utils/access-errors'
+import { inviteRedirectUrl, isEmailExistsError, requireUserId, resendBodySchema } from '../../../../../../utils/access-invite'
 import {
   assertInviteLocale,
   generateAcceptLink,
   inviterNameOf,
   plutoMailReady,
   sendInviteMail,
-} from '../../../../utils/access-mail'
-import { requireAdminRole } from '../../../../utils/admin-role-guard'
-import { enforceInviteRateLimit } from '../../../../utils/rate-limit'
-import { optionalServiceClient } from '../../../../utils/service-client'
+} from '../../../../../../utils/access-mail'
+import { requireAdminRole } from '../../../../../../utils/admin-role-guard'
+import { enforceInviteRateLimit } from '../../../../../../utils/rate-limit'
+import { optionalServiceClient } from '../../../../../../utils/service-client'
 import {
   emailInvalidError,
   emailNotAuthorizedError,
@@ -20,8 +20,8 @@ import {
   isEmailRateLimitError,
   sendSignInLink,
   signInLinkError,
-} from '../../../../utils/sign-in-link'
-import { parseBody } from '../../../../utils/validate'
+} from '../../../../../../utils/sign-in-link'
+import { parseBody } from '../../../../../../utils/validate'
 
 function notFound() {
   return createPlutoError({

package/server/api/{access → _pluto/supabase/access}/users/[id]/roles.delete.ts

@@ -1,7 +1,7 @@
 import { serverSupabaseClient } from '#supabase/server'
-import { mapAccessError } from '../../../../utils/access-errors'
-import { requireUserId } from '../../../../utils/access-invite'
-import { requireAdminRole } from '../../../../utils/admin-role-guard'
+import { mapAccessError } from '../../../../../../utils/access-errors'
+import { requireUserId } from '../../../../../../utils/access-invite'
+import { requireAdminRole } from '../../../../../../utils/admin-role-guard'
 
 /** Revokes the access of a user: it removes every role. The account stays. */
 export default defineEventHandler(async (event) => {

package/server/api/{access → _pluto/supabase/access}/users/[id]/roles.put.ts

@@ -1,8 +1,8 @@
 import { serverSupabaseClient } from '#supabase/server'
-import { mapAccessError } from '../../../../utils/access-errors'
-import { requireUserId, rolesBodySchema } from '../../../../utils/access-invite'
-import { requireAdminRole } from '../../../../utils/admin-role-guard'
-import { parseBody } from '../../../../utils/validate'
+import { mapAccessError } from '../../../../../../utils/access-errors'
+import { requireUserId, rolesBodySchema } from '../../../../../../utils/access-invite'
+import { requireAdminRole } from '../../../../../../utils/admin-role-guard'
+import { parseBody } from '../../../../../../utils/validate'
 
 /** Replaces the roles of a user. An empty list revokes the access. */
 export default defineEventHandler(async (event) => {

package/server/api/{access → _pluto/supabase/access}/users/invite-link.post.ts

@@ -1,10 +1,10 @@
 import { serverSupabaseClient } from '#supabase/server'
-import { inviteBodySchema, inviteRedirectUrl } from '../../../utils/access-invite'
-import { provisionAccess, serviceKeyRequiredError } from '../../../utils/access-mail'
-import { requireAdminRole } from '../../../utils/admin-role-guard'
-import { enforceInviteRateLimit } from '../../../utils/rate-limit'
-import { optionalServiceClient } from '../../../utils/service-client'
-import { parseBody } from '../../../utils/validate'
+import { inviteBodySchema, inviteRedirectUrl } from '../../../../../utils/access-invite'
+import { provisionAccess, serviceKeyRequiredError } from '../../../../../utils/access-mail'
+import { requireAdminRole } from '../../../../../utils/admin-role-guard'
+import { enforceInviteRateLimit } from '../../../../../utils/rate-limit'
+import { optionalServiceClient } from '../../../../../utils/service-client'
+import { parseBody } from '../../../../../utils/validate'
 
 /**
  * Grants the roles and returns a one-time sign-in link. No email is sent, so

package/server/api/{access → _pluto/supabase/access}/users/invite.post.ts

@@ -1,10 +1,10 @@
 import { serverSupabaseClient } from '#supabase/server'
-import { mapAccessError } from '../../../utils/access-errors'
+import { mapAccessError } from '../../../../../utils/access-errors'
 import {
   inviteBodySchema,
   inviteRedirectUrl,
   isEmailExistsError,
-} from '../../../utils/access-invite'
+} from '../../../../../utils/access-invite'
 import {
   addRoles,
   assertInviteLocale,
@@ -13,10 +13,10 @@ import {
   plutoMailReady,
   provisionAccess,
   sendInviteMail,
-} from '../../../utils/access-mail'
-import { requireAdminRole } from '../../../utils/admin-role-guard'
-import { enforceInviteRateLimit } from '../../../utils/rate-limit'
-import { optionalServiceClient } from '../../../utils/service-client'
+} from '../../../../../utils/access-mail'
+import { requireAdminRole } from '../../../../../utils/admin-role-guard'
+import { enforceInviteRateLimit } from '../../../../../utils/rate-limit'
+import { optionalServiceClient } from '../../../../../utils/service-client'
 import {
   emailInvalidError,
   emailNotAuthorizedError,
@@ -26,8 +26,8 @@ import {
   isEmailRateLimitError,
   sendSignInLink,
   signInLinkError,
-} from '../../../utils/sign-in-link'
-import { parseBody } from '../../../utils/validate'
+} from '../../../../../utils/sign-in-link'
+import { parseBody } from '../../../../../utils/validate'
 
 /**
  * Invites a user by email and grants the roles.

package/server/api/{access → _pluto/supabase/access}/users.get.ts

@@ -1,6 +1,6 @@
 import { serverSupabaseClient } from '#supabase/server'
-import { mapAccessError } from '../../utils/access-errors'
-import { requireCapability } from '../../utils/capability-guard'
+import { mapAccessError } from '../../../../utils/access-errors'
+import { requireCapability } from '../../../../utils/capability-guard'
 
 /** The staff: users with a role, or with the admin flag. */
 export default defineEventHandler(async (event) => {

package/server/api/{auth → _pluto/supabase/auth}/signup.post.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod'
 import { serverSupabaseClient } from '#supabase/server'
-import { parseBody } from '../../utils/validate'
+import { parseBody } from '../../../../utils/validate'
 
 // Supabase Auth (GoTrue) rejects a password under 6 characters with its own
 // opaque error. Matching that minimum here turns an empty/short password
@@ -30,11 +30,16 @@ export default defineEventHandler(async (event) => {
   })
 
   if (error) {
-    return {
-      success: false,
+    // A 4xx from Supabase Auth keeps its status (for example 429 for a rate
+    // limit). Any other status becomes a 502. The code goes in `data`, so
+    // the signup page can show the translated text of a known code.
+    const status = error.status ?? 400
+    throw createPlutoError({
+      statusCode: status >= 400 && status < 500 ? status : 502,
       message: error.message,
-      error,
-    }
+      key: 'supabase.errors.signupFailed',
+      data: { code: error.code },
+    })
   }
 
   return {

package/server/api/{profile → _pluto/supabase/me}/locale.get.ts

@@ -27,7 +27,7 @@ export default defineEventHandler(async (event) => {
     // upgraded this package but not yet applied that migration has no such
     // column. That state is expected and temporary, so degrade to
     // "Automatic" instead of a 500. The same choice is made in
-    // server/api/permissions/me.get.ts.
+    // server/api/_pluto/supabase/me/capabilities.get.ts.
     console.error(
       'profiles.locale read failed, returning no locale:',
       error.message

package/server/api/{profile/locale.post.ts → _pluto/supabase/me/locale.put.ts}

@@ -1,6 +1,6 @@
 import { z } from 'zod'
 import { serverSupabaseClient, serverSupabaseUser } from '#supabase/server'
-import { parseBody } from '../../utils/validate'
+import { parseBody } from '../../../../utils/validate'
 
 const localeSchema = z.object({
   locale: z.string().nullable(),
@@ -64,7 +64,12 @@ export default defineEventHandler(async (event) => {
       })
     }
 
-    throw createError({ statusCode: 500, statusMessage: error.message })
+    throw createPlutoError({
+      statusCode: 500,
+      message: `Could not save your language: ${error.message}`,
+      key: 'supabase.errors.localeSave',
+      params: { message: error.message },
+    })
   }
 
   return { locale }

package/server/api/{migrations/status.get.ts → _pluto/supabase/migrations/index.get.ts}

@@ -1,5 +1,5 @@
-import { requireAdmin } from '../../utils/admin-guard'
-import { getMigrationStatus } from '../../utils/pending-migrations'
+import { requireAdmin } from '../../../../utils/admin-guard'
+import { getMigrationStatus } from '../../../../utils/pending-migrations'
 
 export default defineEventHandler(async (event) => {
   // requireAdmin specifically, not a named capability — see admin-guard.ts

package/server/api/{migrations → _pluto/supabase/migrations}/run.post.ts

@@ -1,12 +1,12 @@
-import type { PlutoMigrationFile } from '../../../shared/types/migrations'
-import type { MigrationFileResult } from '../../utils/migrations'
+import type { PlutoMigrationFile } from '../../../../../shared/types/migrations'
+import type { MigrationFileResult } from '../../../../utils/migrations'
 import { z } from 'zod'
-import { requireAdmin } from '../../utils/admin-guard'
-import { persistDatabaseUrl } from '../../utils/env-file'
-import { resolveConnectionString, runPendingMigrations } from '../../utils/migrations'
-import { scrubConnectionString } from '../../utils/scrub-connection-string'
-import { regenerateSupabaseTypes } from '../../utils/typegen'
-import { parseBody } from '../../utils/validate'
+import { requireAdmin } from '../../../../utils/admin-guard'
+import { persistDatabaseUrl } from '../../../../utils/env-file'
+import { resolveConnectionString, runPendingMigrations } from '../../../../utils/migrations'
+import { scrubConnectionString } from '../../../../utils/scrub-connection-string'
+import { regenerateSupabaseTypes } from '../../../../utils/typegen'
+import { parseBody } from '../../../../utils/validate'
 
 // The whole body is optional: an already-configured DATABASE_URL means the
 // caller need not (and, per resolveConnectionString, cannot) supply one.
@@ -33,10 +33,12 @@ export default defineEventHandler(async (event) => {
     resolveConnectionString(body?.connectionString)
 
   if (!connStr) {
-    return {
-      success: false as const,
-      needsConnectionString: true,
-    }
+    throw createPlutoError({
+      statusCode: 400,
+      message: 'A database connection string is required.',
+      key: 'supabase.errors.connectionStringRequired',
+      data: { needsConnectionString: true },
+    })
   }
 
   const config = useRuntimeConfig()
@@ -102,9 +104,12 @@ export default defineEventHandler(async (event) => {
 
     console.error('Error applying migrations:', errorMessage)
 
-    return {
-      success: false as const,
-      error: errorMessage,
-    }
+    throw createPlutoError({
+      statusCode: 500,
+      message: `Migrations failed: ${errorMessage}`,
+      key: 'supabase.errors.migrationsFailed',
+      params: { message: errorMessage },
+      data: { error: errorMessage },
+    })
   }
 })

package/server/api/{settings/update.post.ts → _pluto/supabase/settings/index.put.ts}

@@ -1,7 +1,7 @@
 import { z } from 'zod'
 import { serverSupabaseClient } from '#supabase/server'
-import { requireCapability } from '../../utils/capability-guard'
-import { parseBody } from '../../utils/validate'
+import { requireCapability } from '../../../../utils/capability-guard'
+import { parseBody } from '../../../../utils/validate'
 
 // A key is lowercase segments separated by dots, e.g. 'website_title' or
 // 'blog.posts_per_page'. Mirrors the settings_setting_key_format check
@@ -39,12 +39,16 @@ export default defineEventHandler(async (event) => {
     .select()
 
   if (error) {
-    throw createError({ statusMessage: error.message })
+    throw createPlutoError({
+      statusCode: 500,
+      message: `Could not save the settings: ${error.message}`,
+      key: 'supabase.errors.settingsSave',
+      params: { message: error.message },
+    })
   }
 
   return {
     message: 'Settings updated successfully.',
-    statusCode: 200,
     data,
   }
 })

package/server/api/{settings/first_setup.get.ts → _pluto/supabase/setup/index.get.ts}

@@ -9,11 +9,12 @@ export default defineEventHandler(async (event) => {
   const { data, error } = await client.from('healthcheck').select('*')
 
   if (error) {
-    return {
-      success: false as const,
-      message: 'Error retrieving healthcheck settings',
-      error: error.message,
-    }
+    throw createPlutoError({
+      statusCode: 500,
+      message: `Could not read the setup state: ${error.message}`,
+      key: 'supabase.errors.setupStateRead',
+      params: { message: error.message },
+    })
   }
 
   // @ts-expect-error: Object.fromEntries may not infer the correct type

package/server/api/{setup/create.post.ts → _pluto/supabase/setup/index.post.ts}

@@ -1,10 +1,10 @@
-import type { PlutoMigrationFile } from '../../../shared/types/migrations'
+import type { PlutoMigrationFile } from '../../../../../shared/types/migrations'
 import postgres from 'postgres'
 import { z } from 'zod'
-import { persistDatabaseUrl } from '../../utils/env-file'
-import { runPendingMigrations } from '../../utils/migrations'
-import { scrubConnectionString } from '../../utils/scrub-connection-string'
-import { parseBody } from '../../utils/validate'
+import { persistDatabaseUrl } from '../../../../utils/env-file'
+import { runPendingMigrations } from '../../../../utils/migrations'
+import { scrubConnectionString } from '../../../../utils/scrub-connection-string'
+import { parseBody } from '../../../../utils/validate'
 
 // Only checks that a connection string was actually sent. A Postgres
 // connection string can take many valid forms (postgres:// URL, key=value
@@ -20,7 +20,7 @@ export default defineEventHandler(async (event) => {
   // before setup creates the profiles table — so once real setup has run,
   // this check is the only thing stopping anyone from re-running it against
   // an arbitrary database. Mirrors the same precedence rule in
-  // server/api/migrations/run.post.ts, which calls it "the whole security
+  // server/api/_pluto/supabase/migrations/run.post.ts, which calls it "the whole security
   // model for this endpoint."
   if (process.env.DATABASE_URL) {
     throw createPlutoError({
@@ -120,9 +120,12 @@ export default defineEventHandler(async (event) => {
 
     console.error('Error setting up the database:', message)
 
-    return {
-      success: false,
-      error: message,
-    }
+    throw createPlutoError({
+      statusCode: 500,
+      message: `Database setup failed: ${message}`,
+      key: 'supabase.errors.setupFailed',
+      params: { message },
+      data: { error: message },
+    })
   }
 })

package/server/utils/admin-guard.ts

@@ -10,7 +10,7 @@ import { serverSupabaseClient, serverSupabaseUser } from '#supabase/server'
  * `004_roles_and_capabilities.sql` respectively); a genuinely fresh site
  * that has never applied any migration beyond the original baseline
  * schema — an expected, normal state, not a broken one — has neither
- * function. `/api/migrations/*` (the only routes that call `requireAdmin`
+ * function. `/api/_pluto/supabase/migrations/*` (the only routes that call `requireAdmin`
  * today) are the one place this actually bites: they are the routes that
  * apply a pending migration, so they must work with zero migrations
  * applied, not just with `002`+ already in place. An earlier version of

package/server/utils/content-adapter.ts

@@ -1,5 +1,6 @@
 import type { PostgrestError, SupabaseClient } from '@supabase/supabase-js'
 import type { H3Event } from 'h3'
+import { createClient } from '@supabase/supabase-js'
 import { serverSupabaseClient } from '#supabase/server'
 import { requireCapability } from './capability-guard'
 
@@ -31,9 +32,44 @@ import { requireCapability } from './capability-guard'
  * type, not to assert against one.
  */
 async function getClient(event: H3Event): Promise<SupabaseClient> {
+  if (isPublicRead(event)) {
+    return getAnonymousClient(event)
+  }
+
   return (await serverSupabaseClient(event)) as unknown as SupabaseClient
 }
 
+/** The anonymous client and the url/key pair it was built from. */
+let anonymousClient: { url: string, key: string, client: SupabaseClient } | undefined
+
+/**
+ * A Supabase client with no user session, for public reads of the public
+ * API. It uses the anon key from the runtime config of `@nuxtjs/supabase`,
+ * reads no cookies and keeps no session. Row Level Security then applies as
+ * for an anonymous visitor, so the answer is the same for everyone and a CDN
+ * can cache it. It never uses the service role key. One client serves the
+ * whole process.
+ */
+function getAnonymousClient(event: H3Event): SupabaseClient {
+  const { url, key } = useRuntimeConfig(event).public.supabase as { url: string, key: string }
+
+  if (!anonymousClient || anonymousClient.url !== url || anonymousClient.key !== key) {
+    anonymousClient = {
+      url,
+      key,
+      client: createClient(url, key, {
+        auth: {
+          persistSession: false,
+          autoRefreshToken: false,
+          detectSessionInUrl: false,
+        },
+      }),
+    }
+  }
+
+  return anonymousClient.client
+}
+
 /**
  * Resolves the storage column for a content type's created/updated
  * timestamp. Returns `undefined` when timestamps are disabled entirely
@@ -70,6 +106,70 @@ export function resolveStatusColumn(type: PlutoContentType): string | undefined
   return type.status.column ?? 'status'
 }
 
+/**
+ * Resolves a sort field to its column. A timestamp column (the created, the
+ * updated or the published-at column) sorts directly, because it is not a
+ * declared field. Any other name must be a declared field.
+ */
+function resolveSortColumn(type: PlutoContentType, fieldName: string): string {
+  if (timestampColumns(type).includes(fieldName)) {
+    return fieldName
+  }
+
+  return resolveFieldColumn(type, fieldName, 'sort')
+}
+
+/** The columns of the created, updated and published-at timestamps that this type has. */
+function timestampColumns(type: PlutoContentType): string[] {
+  const { created, updated, published } = timestampKeys(type)
+
+  return [created, updated, published].filter((column): column is string => column !== undefined)
+}
+
+/**
+ * The item keys of the timestamps of a type. They are the column names,
+ * because a timestamp is not a declared field. A key is missing when its
+ * timestamp is off. Core uses this to sort and to show the public dates.
+ */
+function timestampKeys(type: PlutoContentType): { created?: string, updated?: string, published?: string } {
+  const keys: { created?: string, updated?: string, published?: string } = {}
+
+  const created = resolveTimestampColumn(type, 'created')
+  if (created) {
+    keys.created = created
+  }
+
+  const updated = resolveTimestampColumn(type, 'updated')
+  if (updated) {
+    keys.updated = updated
+  }
+
+  const published = type.status ? type.status.publishedAtColumn : undefined
+  if (published) {
+    keys.published = published
+  }
+
+  return keys
+}
+
+/**
+ * Maps a row to an item, then copies the timestamp columns onto it under
+ * their column names. `mapColumnsToFields` drops every column that no field
+ * declares, and a timestamp is not a field. A field with the same name as a
+ * timestamp column keeps its own value.
+ */
+function toItem(type: PlutoContentType, row: Record<string, unknown>): PlutoContentItem {
+  const item = mapColumnsToFields(type, row)
+
+  for (const column of timestampColumns(type)) {
+    if (!Object.hasOwn(item, column) && Object.hasOwn(row, column)) {
+      item[column] = row[column]
+    }
+  }
+
+  return item
+}
+
 /**
  * Maps a raw PostgREST error to an H3/Nuxt error safe to send to a
  * client. Logs the raw error first, so the real message always reaches
@@ -128,6 +228,10 @@ async function list(ctx: PlutoContentContext, query: PlutoContentQuery): Promise
     builder = builder.eq(statusColumn, publishedValue)
   }
 
+  for (const [field, value] of Object.entries(query.filters ?? {})) {
+    builder = builder.eq(resolveFieldColumn(ctx.type, field, 'filter'), value)
+  }
+
   if (query.search) {
     const titleColumn = resolveFieldColumn(ctx.type, ctx.type.titleField, 'titleField')
     builder = builder.ilike(titleColumn, `%${query.search}%`)
@@ -135,7 +239,7 @@ async function list(ctx: PlutoContentContext, query: PlutoContentQuery): Promise
 
   const sort = query.sort ?? ctx.type.defaultSort
   if (sort) {
-    const sortColumn = resolveFieldColumn(ctx.type, sort.field, 'sort')
+    const sortColumn = resolveSortColumn(ctx.type, sort.field)
     builder = builder.order(sortColumn, { ascending: sort.direction !== 'desc' })
   } else {
     const createdColumn = resolveTimestampColumn(ctx.type, 'created')
@@ -156,7 +260,7 @@ async function list(ctx: PlutoContentContext, query: PlutoContentQuery): Promise
   }
 
   return {
-    data: (data ?? []).map((row: Record<string, unknown>) => mapColumnsToFields(ctx.type, row)),
+    data: (data ?? []).map((row: Record<string, unknown>) => toItem(ctx.type, row)),
     total: count ?? undefined,
   }
 }
@@ -190,7 +294,7 @@ async function get(ctx: PlutoContentContext, idOrSlug: string | number): Promise
   }
 
   if (data) {
-    return mapColumnsToFields(ctx.type, data)
+    return toItem(ctx.type, data)
   }
 
   if (ctx.type.slug) {
@@ -207,7 +311,7 @@ async function get(ctx: PlutoContentContext, idOrSlug: string | number): Promise
     }
 
     if (bySlug.data) {
-      return mapColumnsToFields(ctx.type, bySlug.data)
+      return toItem(ctx.type, bySlug.data)
     }
   }
 
@@ -252,7 +356,7 @@ async function create(ctx: PlutoContentContext, values: Record<string, unknown>)
     throw toContentError(error)
   }
 
-  return mapColumnsToFields(ctx.type, data)
+  return toItem(ctx.type, data)
 }
 
 async function update(
@@ -319,7 +423,7 @@ async function update(
     throw toContentError(error)
   }
 
-  return mapColumnsToFields(ctx.type, data)
+  return toItem(ctx.type, data)
 }
 
 async function remove(ctx: PlutoContentContext, id: string | number): Promise<void> {
@@ -378,5 +482,6 @@ export function createSupabaseContentAdapter(): PlutoContentAdapter {
     remove,
     authorize,
     countCreated,
+    timestampKeys,
   }
 }

package/server/api/users/[id].get.ts

@@ -1,26 +0,0 @@
-import { serverSupabaseClient } from '#supabase/server'
-import { requireCapability } from '../../utils/capability-guard'
-
-export default defineEventHandler(async (event) => {
-  await requireCapability(event, 'users:read')
-
-  const client = await serverSupabaseClient<Database>(event)
-
-  const id = event.context.params?.id as string
-
-  const { data: user, error } = await client
-    .from('profiles')
-    .select('*')
-    .eq('id', id)
-
-  if (error) {
-    throw createPlutoError({
-      statusCode: 500,
-      message: `Error fetching user: ${error.message}`,
-      key: 'supabase.errors.fetchUser',
-      params: { message: error.message },
-    })
-  }
-
-  return user
-})

package/server/api/users/index.get.ts

@@ -1,21 +0,0 @@
-import { serverSupabaseClient } from '#supabase/server'
-import { requireCapability } from '../../utils/capability-guard'
-
-export default defineEventHandler(async (event) => {
-  await requireCapability(event, 'users:read')
-
-  const client = await serverSupabaseClient<Database>(event)
-
-  const { data: users, error } = await client.from('profiles').select('*')
-
-  if (error) {
-    throw createPlutoError({
-      statusCode: 500,
-      message: `Error fetching users: ${error.message}`,
-      key: 'supabase.errors.fetchUsers',
-      params: { message: error.message },
-    })
-  }
-
-  return users
-})