storage-js

JS Client library to interact with Kozmodb Storage.

• Documentation: https://kozmodb.io/docs/reference/javascript/storage-createbucket

Quick Start Guide

Installing the module

npm install @kozmodb/storage-js

Connecting to the storage backend

import { StorageClient } from '@kozmodb/storage-js'

const STORAGE_URL = 'https://<project_ref>.kozmodb.co/storage/v1'
const SERVICE_KEY = '<service_role>' //! service key, not anon key

const storageClient = new StorageClient(STORAGE_URL, {
  apikey: SERVICE_KEY,
  Authorization: `Bearer ${SERVICE_KEY}`,
})

Handling resources

Handling Storage Buckets

• Create a new Storage bucket:

  const { data, error } = await storageClient.createBucket(
    'test_bucket', // Bucket name (must be unique)
    { public: false } // Bucket options
  )

• Retrieve the details of an existing Storage bucket:

  const { data, error } = await storageClient.getBucket('test_bucket')

• Update a new Storage bucket:

  const { data, error } = await storageClient.updateBucket(
    'test_bucket', // Bucket name
    { public: false } // Bucket options
  )

• Remove all objects inside a single bucket:

  const { data, error } = await storageClient.emptyBucket('test_bucket')

• Delete an existing bucket (a bucket can't be deleted with existing objects inside it):

  const { data, error } = await storageClient.deleteBucket('test_bucket')

• Retrieve the details of all Storage buckets within an existing project:

  const { data, error } = await storageClient.listBuckets()

Handling Files

• Upload a file to an existing bucket:

  const fileBody = ... // load your file here
  
  const { data, error } = await storageClient.from('bucket').upload('path/to/file', fileBody)

  Note:
  The path in data.Key is prefixed by the bucket ID and is not the value which should be passed to the download method in order to fetch the file.
  To fetch the file via the download method, use data.path and data.bucketId as follows:

  const { data, error } = await storageClient.from('bucket').upload('/folder/file.txt', fileBody)
  // check for errors
  const { data2, error2 } = await storageClient.from(data.bucketId).download(data.path)

  Note: The upload method also accepts a map of optional parameters. For a complete list see the Kozmodb API reference.

• Download a file from an exisiting bucket:

  const { data, error } = await storageClient.from('bucket').download('path/to/file')

• List all the files within a bucket:

  const { data, error } = await storageClient.from('bucket').list('folder')

  Note: The list method also accepts a map of optional parameters. For a complete list see the Kozmodb API reference.

• Replace an existing file at the specified path with a new one:

  const fileBody = ... // load your file here
  
  const { data, error } = await storageClient
    .from('bucket')
    .update('path/to/file', fileBody)

  Note: The upload method also accepts a map of optional parameters. For a complete list see the Kozmodb API reference.

• Move an existing file:

  const { data, error } = await storageClient
    .from('bucket')
    .move('old/path/to/file', 'new/path/to/file')

• Delete files within the same bucket:

  const { data, error } = await storageClient.from('bucket').remove(['path/to/file'])

• Create signed URL to download file without requiring permissions:

  const expireIn = 60
  
  const { data, error } = await storageClient
    .from('bucket')
    .createSignedUrl('path/to/file', expireIn)

• Retrieve URLs for assets in public buckets:

  const { data, error } = await storageClient.from('public-bucket').getPublicUrl('path/to/file')