feat: endpoint to update bucket visibility

to make a bucket public or private

Author: inian

src/routes/bucket/index.ts

@@ -4,6 +4,7 @@ import deleteBucket from './deleteBucket'
 import emptyBucket from './emptyBucket'
 import getAllBuckets from './getAllBuckets'
 import getBucket from './getBucket'
+import updateBucket from './updateBucket'
 
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export default async function routes(fastify: FastifyInstance) {
@@ -12,4 +13,5 @@ export default async function routes(fastify: FastifyInstance) {
   emptyBucket(fastify)
   getAllBuckets(fastify)
   getBucket(fastify)
+  updateBucket(fastify)
 }

src/routes/bucket/updateBucket.ts

@@ -0,0 +1,69 @@
+import { FastifyInstance } from 'fastify'
+import { FromSchema } from 'json-schema-to-ts'
+import { AuthenticatedRequest, Bucket } from '../../types/types'
+import { getPostgrestClient, transformPostgrestError } from '../../utils'
+import { createDefaultSchema, createResponse } from '../../utils/generic-routes'
+
+const updateBucketBodySchema = {
+  type: 'object',
+  properties: {
+    public: { type: 'boolean', example: false },
+  },
+} as const
+const updateBucketParamsSchema = {
+  type: 'object',
+  properties: {
+    bucketId: { type: 'string', example: 'avatars' },
+  },
+  required: ['bucketId'],
+} as const
+
+const successResponseSchema = {
+  type: 'object',
+  properties: {
+    message: { type: 'string', example: 'Successfully updated' },
+  },
+  required: ['message'],
+}
+interface updateBucketRequestInterface extends AuthenticatedRequest {
+  Body: FromSchema<typeof updateBucketBodySchema>
+  Params: FromSchema<typeof updateBucketParamsSchema>
+}
+
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+export default async function routes(fastify: FastifyInstance) {
+  const summary = 'Update properties of a bucket'
+  const schema = createDefaultSchema(successResponseSchema, {
+    body: updateBucketBodySchema,
+    summary,
+    tags: ['bucket'],
+  })
+  fastify.put<updateBucketRequestInterface>(
+    '/:bucketId',
+    {
+      schema,
+    },
+    async (request, response) => {
+      const authHeader = request.headers.authorization
+      const jwt = authHeader.substring('Bearer '.length)
+      const postgrest = getPostgrestClient(jwt)
+      const { bucketId } = request.params
+
+      const { public: isPublic } = request.body
+
+      const { error, status } = await postgrest
+        .from<Bucket>('buckets')
+        .update({
+          public: isPublic,
+        })
+        .match({ id: bucketId })
+        .single()
+
+      if (error) {
+        request.log.error({ error }, 'error updating bucket')
+        return response.status(400).send(transformPostgrestError(error, status))
+      }
+      return response.status(200).send(createResponse('Successfully updated'))
+    }
+  )
+}