@plutocms/supabase 0.7.2 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.8.0](https://github.com/plutocms/supabase/compare/v0.7.2...v0.8.0) (2026-09-13)
4
+
5
+
6
+ ### Features
7
+
8
+ * **content:** add Supabase-backed PlutoContentAdapter (wave 4) ([#60](https://github.com/plutocms/supabase/issues/60)) ([834136d](https://github.com/plutocms/supabase/commit/834136d39f2297ad771cf00de5bc33f0e811a4b9))
9
+
3
10
  ## [0.7.2](https://github.com/plutocms/supabase/compare/v0.7.1...v0.7.2) (2026-09-13)
4
11
 
5
12
 
package/FEATURES.md CHANGED
@@ -10,3 +10,6 @@ policies shared by every project here.
10
10
  after initial setup. @.claude/skills/layer-migrations/SKILL.md
11
11
  - Permissions storage: role-based capabilities backing server route guards and RLS policies.
12
12
  @.claude/skills/permissions-storage/SKILL.md
13
+ - Content adapter: a Supabase/PostgREST-backed `PlutoContentAdapter`, plugging any layer's
14
+ declared content type into `@plutocms/pluto`'s generic content routes.
15
+ @.claude/skills/content-adapter/SKILL.md
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@plutocms/supabase",
3
3
  "type": "module",
4
- "version": "0.7.2",
4
+ "version": "0.8.0",
5
5
  "trustedDependencies": [
6
6
  "@parcel/watcher",
7
7
  "@plutocms/pluto",
@@ -39,7 +39,7 @@
39
39
  "@nuxt/eslint": "^1.16.0",
40
40
  "@nuxt/ui": "^4.9.0",
41
41
  "@nuxtjs/supabase": "^2.0.9",
42
- "@plutocms/pluto": "^0.5.0",
42
+ "@plutocms/pluto": "^0.8.1",
43
43
  "@plutocms/utils": "^0.2.1",
44
44
  "postgres": "^3.4.9",
45
45
  "supabase": "^2.109.1"
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Registers this layer's Supabase/PostgREST-backed `PlutoContentAdapter`
3
+ * with core's generic content routes, at Nitro startup.
4
+ */
5
+ export default defineNitroPlugin(() => {
6
+ registerContentAdapter(createSupabaseContentAdapter())
7
+ })
@@ -0,0 +1,336 @@
1
+ import type { PostgrestError, SupabaseClient } from '@supabase/supabase-js'
2
+ import type { H3Event } from 'h3'
3
+ import { serverSupabaseClient } from '#supabase/server'
4
+ import { requireCapability } from './capability-guard'
5
+
6
+ /**
7
+ * A Supabase client for one request, deliberately untyped.
8
+ *
9
+ * A content type's table name (`type.source`) is a plain runtime string —
10
+ * it is not known until a layer declares a content type, in a different
11
+ * repo, at that repo's build time. `serverSupabaseClient` defaults to
12
+ * this app's own `Database` type (see `shared/types/supabase.ts`), whose
13
+ * `.from()` only accepts this repo's own table names as literals. Casting
14
+ * to the bare `SupabaseClient` type (whose own generic defaults to `any`)
15
+ * is the one, deliberate place this file loses compile-time table/column
16
+ * safety. See `.claude/skills/content-adapter/SKILL.md` for the full
17
+ * write-up.
18
+ */
19
+ async function getClient(event: H3Event): Promise<SupabaseClient> {
20
+ return (await serverSupabaseClient(event)) as SupabaseClient
21
+ }
22
+
23
+ /**
24
+ * Resolves the storage column for a content type's created/updated
25
+ * timestamp. Returns `undefined` when timestamps are disabled entirely
26
+ * (`type.timestamps === false`) or when this one timestamp is disabled
27
+ * (`type.timestamps[key] === false`).
28
+ */
29
+ export function resolveTimestampColumn(
30
+ type: PlutoContentType,
31
+ key: 'created' | 'updated'
32
+ ): string | undefined {
33
+ if (type.timestamps === false) {
34
+ return undefined
35
+ }
36
+
37
+ const configured = type.timestamps?.[key]
38
+
39
+ if (configured === false) {
40
+ return undefined
41
+ }
42
+
43
+ return configured ?? (key === 'created' ? 'created_at' : 'updated_at')
44
+ }
45
+
46
+ /**
47
+ * Resolves the storage column for a content type's status field. Returns
48
+ * `undefined` when status is disabled entirely (`type.status === false`
49
+ * or unset).
50
+ */
51
+ export function resolveStatusColumn(type: PlutoContentType): string | undefined {
52
+ if (!type.status) {
53
+ return undefined
54
+ }
55
+
56
+ return type.status.column ?? 'status'
57
+ }
58
+
59
+ /**
60
+ * Maps a raw PostgREST error to an H3/Nuxt error safe to send to a
61
+ * client. Logs the raw error first, so the real message always reaches
62
+ * server logs even when the client-facing message is generic. No return
63
+ * type annotation: `createError`'s own return type (`NuxtError`) is left
64
+ * to flow through, rather than restated here.
65
+ */
66
+ export function toContentError(error: PostgrestError) {
67
+ console.error('[content-adapter] Postgres error:', error)
68
+
69
+ // 23505: unique_violation.
70
+ if (error.code === '23505') {
71
+ return createError({
72
+ statusCode: 409,
73
+ statusMessage: 'A record with this value already exists.',
74
+ })
75
+ }
76
+
77
+ // 23503: foreign_key_violation.
78
+ if (error.code === '23503') {
79
+ return createError({
80
+ statusCode: 400,
81
+ statusMessage: 'This references a record that does not exist.',
82
+ })
83
+ }
84
+
85
+ return createError({ statusCode: 500, statusMessage: error.message })
86
+ }
87
+
88
+ /** Resolves a field's storage column by name, warning and falling back to the raw name when the field is missing. This signals a misconfigured content type. */
89
+ function resolveFieldColumn(type: PlutoContentType, fieldName: string, context: string): string {
90
+ const field = type.fields.find((candidate) => candidate.name === fieldName)
91
+
92
+ if (field) {
93
+ return fieldColumn(field)
94
+ }
95
+
96
+ console.warn(
97
+ `[content-adapter] Content type "${type.name}" has no field named "${fieldName}" (${context}). Falling back to the raw name as the column.`
98
+ )
99
+
100
+ return fieldName
101
+ }
102
+
103
+ async function list(ctx: PlutoContentContext, query: PlutoContentQuery): Promise<PlutoContentListResult> {
104
+ const client = await getClient(ctx.event)
105
+ const pkColumn = ctx.type.primaryKey ?? 'id'
106
+
107
+ let builder = client.from(ctx.type.source).select('*', { count: 'exact' })
108
+
109
+ const statusColumn = resolveStatusColumn(ctx.type)
110
+ if (statusColumn && query.includeUnpublished !== true) {
111
+ const publishedValue = (ctx.type.status && ctx.type.status.publishedValue) || 'published'
112
+ builder = builder.eq(statusColumn, publishedValue)
113
+ }
114
+
115
+ if (query.search) {
116
+ const titleColumn = resolveFieldColumn(ctx.type, ctx.type.titleField, 'titleField')
117
+ builder = builder.ilike(titleColumn, `%${query.search}%`)
118
+ }
119
+
120
+ const sort = query.sort ?? ctx.type.defaultSort
121
+ if (sort) {
122
+ const sortColumn = resolveFieldColumn(ctx.type, sort.field, 'sort')
123
+ builder = builder.order(sortColumn, { ascending: sort.direction !== 'desc' })
124
+ } else {
125
+ const createdColumn = resolveTimestampColumn(ctx.type, 'created')
126
+ builder = builder.order(createdColumn ?? pkColumn, { ascending: false })
127
+ }
128
+
129
+ if (query.offset !== undefined) {
130
+ const limit = query.limit ?? 50
131
+ builder = builder.range(query.offset, query.offset + limit - 1)
132
+ } else if (query.limit !== undefined) {
133
+ builder = builder.limit(query.limit)
134
+ }
135
+
136
+ const { data, error, count } = await builder
137
+
138
+ if (error) {
139
+ throw toContentError(error)
140
+ }
141
+
142
+ return {
143
+ data: (data ?? []).map((row: Record<string, unknown>) => mapColumnsToFields(ctx.type, row)),
144
+ total: count ?? undefined,
145
+ }
146
+ }
147
+
148
+ /**
149
+ * 22P02 (invalid_text_representation): the value doesn't parse as the
150
+ * primary key column's own SQL type — for example a slug like
151
+ * "hello-world" against a `bigint` id column. This is not a real error:
152
+ * it means "not found by id, at the database level", the same outcome as
153
+ * a clean empty result, and `get()` must fall through to trying the slug
154
+ * column exactly as it would for an empty result. Postgres reports a type
155
+ * mismatch as an error rather than zero rows, so this has to be handled
156
+ * separately from the empty-result case, not folded into it.
157
+ */
158
+ function isInvalidIdShape(error: PostgrestError): boolean {
159
+ return error.code === '22P02'
160
+ }
161
+
162
+ async function get(ctx: PlutoContentContext, idOrSlug: string | number): Promise<PlutoContentItem | null> {
163
+ const client = await getClient(ctx.event)
164
+ const pkColumn = ctx.type.primaryKey ?? 'id'
165
+
166
+ const { data, error } = await client
167
+ .from(ctx.type.source)
168
+ .select('*')
169
+ .eq(pkColumn, idOrSlug)
170
+ .maybeSingle()
171
+
172
+ if (error && !isInvalidIdShape(error)) {
173
+ throw toContentError(error)
174
+ }
175
+
176
+ if (data) {
177
+ return mapColumnsToFields(ctx.type, data)
178
+ }
179
+
180
+ if (ctx.type.slug) {
181
+ const slugColumn = resolveFieldColumn(ctx.type, ctx.type.slug.field, 'slug.field')
182
+
183
+ const bySlug = await client
184
+ .from(ctx.type.source)
185
+ .select('*')
186
+ .eq(slugColumn, idOrSlug)
187
+ .maybeSingle()
188
+
189
+ if (bySlug.error) {
190
+ throw toContentError(bySlug.error)
191
+ }
192
+
193
+ if (bySlug.data) {
194
+ return mapColumnsToFields(ctx.type, bySlug.data)
195
+ }
196
+ }
197
+
198
+ return null
199
+ }
200
+
201
+ async function create(ctx: PlutoContentContext, values: Record<string, unknown>): Promise<PlutoContentItem> {
202
+ const client = await getClient(ctx.event)
203
+ const row = mapFieldsToColumns(ctx.type, values)
204
+
205
+ // Status is not a declared field (see PlutoContentType.status — a
206
+ // separate, top-level concern from `fields`, unlike `slug`, which
207
+ // references a field also present in `fields`), so mapFieldsToColumns
208
+ // never sees it — it filters strictly to declared field names. A
209
+ // payload's status lives at the fixed conceptual key `status`,
210
+ // regardless of what `type.status.column` names in storage, mirroring
211
+ // how a field's own name (not its storage column) is the payload key
212
+ // everywhere else in this contract.
213
+ const statusColumn = resolveStatusColumn(ctx.type)
214
+ if (statusColumn) {
215
+ if (Object.hasOwn(values, 'status')) {
216
+ row[statusColumn] = values.status
217
+ } else if (ctx.type.status && ctx.type.status.default !== undefined) {
218
+ row[statusColumn] = ctx.type.status.default
219
+ }
220
+ }
221
+
222
+ // A client never controls its own creation timestamp. Always stamp it,
223
+ // overwriting anything the caller's payload tried to set.
224
+ const createdColumn = resolveTimestampColumn(ctx.type, 'created')
225
+ if (createdColumn) {
226
+ row[createdColumn] = new Date().toISOString()
227
+ }
228
+
229
+ const { data, error } = await client
230
+ .from(ctx.type.source)
231
+ .insert(row)
232
+ .select('*')
233
+ .single()
234
+
235
+ if (error) {
236
+ throw toContentError(error)
237
+ }
238
+
239
+ return mapColumnsToFields(ctx.type, data)
240
+ }
241
+
242
+ async function update(
243
+ ctx: PlutoContentContext,
244
+ id: string | number,
245
+ values: Record<string, unknown>
246
+ ): Promise<PlutoContentItem> {
247
+ const client = await getClient(ctx.event)
248
+ const pkColumn = ctx.type.primaryKey ?? 'id'
249
+ const row = mapFieldsToColumns(ctx.type, values)
250
+
251
+ // See the matching comment in create(): status is not a declared field,
252
+ // so mapFieldsToColumns never sees it. Read it from the fixed
253
+ // conceptual key `status` in the raw payload.
254
+ const statusColumn = resolveStatusColumn(ctx.type)
255
+ if (statusColumn && Object.hasOwn(values, 'status')) {
256
+ row[statusColumn] = values.status
257
+ }
258
+
259
+ // A client never controls its own update timestamp. Always stamp it,
260
+ // overwriting anything the caller's payload tried to set.
261
+ const updatedColumn = resolveTimestampColumn(ctx.type, 'updated')
262
+ if (updatedColumn) {
263
+ row[updatedColumn] = new Date().toISOString()
264
+ }
265
+
266
+ // Published-at preservation, generalizing supabase-blog's hand-written
267
+ // edit route: stamp published-at the first time a row is published, but
268
+ // never overwrite an already-set value on a later edit.
269
+ if (
270
+ statusColumn
271
+ && ctx.type.status
272
+ && ctx.type.status.publishedAtColumn
273
+ && row[statusColumn] === ctx.type.status.publishedValue
274
+ ) {
275
+ const publishedAtColumn = ctx.type.status.publishedAtColumn
276
+ // Selects the whole row rather than the one dynamic column name:
277
+ // postgrest-js parses a `select()` argument at the type level, and a
278
+ // non-literal (runtime) column name resolves to its own
279
+ // `GenericStringError` type instead of a usable row shape.
280
+ const { data: existing, error: fetchError } = await client
281
+ .from(ctx.type.source)
282
+ .select('*')
283
+ .eq(pkColumn, id)
284
+ .maybeSingle()
285
+
286
+ if (fetchError) {
287
+ throw toContentError(fetchError)
288
+ }
289
+
290
+ if (existing && (existing as Record<string, unknown>)[publishedAtColumn] == null) {
291
+ row[publishedAtColumn] = new Date().toISOString()
292
+ }
293
+ }
294
+
295
+ const { data, error } = await client
296
+ .from(ctx.type.source)
297
+ .update(row)
298
+ .eq(pkColumn, id)
299
+ .select('*')
300
+ .single()
301
+
302
+ if (error) {
303
+ throw toContentError(error)
304
+ }
305
+
306
+ return mapColumnsToFields(ctx.type, data)
307
+ }
308
+
309
+ async function remove(ctx: PlutoContentContext, id: string | number): Promise<void> {
310
+ const client = await getClient(ctx.event)
311
+ const pkColumn = ctx.type.primaryKey ?? 'id'
312
+
313
+ const { error } = await client.from(ctx.type.source).delete().eq(pkColumn, id)
314
+
315
+ if (error) {
316
+ throw toContentError(error)
317
+ }
318
+ }
319
+
320
+ /** Delegates straight to `requireCapability`, unchanged. */
321
+ async function authorize(event: H3Event, capability: string): Promise<void> {
322
+ await requireCapability(event, capability)
323
+ }
324
+
325
+ /** Builds the Supabase/PostgREST-backed `PlutoContentAdapter`. Register it with `registerContentAdapter` from a `server/plugins/*.ts` file. */
326
+ export function createSupabaseContentAdapter(): PlutoContentAdapter {
327
+ return {
328
+ id: 'supabase',
329
+ list,
330
+ get,
331
+ create,
332
+ update,
333
+ remove,
334
+ authorize,
335
+ }
336
+ }