JC Storage SDK

SDK oficial para integração com o JC Storage - serviço de armazenamento de arquivos.

Instalação

npm install jc-storage-sdk

Configuração

Primeiro, inicialize o cliente com suas credenciais:

import { Client } from "jc-storage-sdk";

const client = new Client({
  accessKey: "sua-access-key",
  secretKey: "sua-secret-key",
});

Uso

Upload de Arquivos

Faça upload de arquivos para um bucket específico:

import fs from "fs";

// Ler o arquivo como Buffer
const buffer = fs.readFileSync("/caminho/para/arquivo.jpg");

const result = await client.storage().upload({
  bucket: "meu-bucket",
  buffer: buffer,
  filename: "nome-do-arquivo.jpg",
  mimeType: "image/jpeg",
  isPrivate: false, // opcional - padrão: false
});

console.log(result);
// {
//   file: {
//     id: "uuid-do-arquivo",
//     filename: "nome-do-arquivo.jpg",
//     is_private: false,
//     path: "caminho/no/storage",
//     bucket_id: "uuid-do-bucket",
//     size: 12345,
//     mime_type: "image/jpeg",
//     updated_at: "2026-01-16T00:00:00.000Z",
//     created_at: "2026-01-16T00:00:00.000Z"
//   },
//   url: "https://..." // URL pública (null se o arquivo for privado)
// }

Deletar Arquivo

Remova um arquivo pelo seu ID:

await client.storage().delete("uuid-do-arquivo");

Obter URL de Arquivo Privado

Gere uma URL assinada temporária para acessar arquivos privados:

const { url, expires_at } = await client.storage().getPrivateFileUrl("uuid-do-arquivo");

console.log(url);        // URL assinada para acesso temporário
console.log(expires_at); // Data/hora de expiração da URL

Parâmetros

UploadParams

| Parâmetro | Tipo | Obrigatório | Descrição | | ----------- | --------- | ----------- | -------------------------------------------------------- | | bucket | string | ✅ | Nome do bucket de destino | | buffer | Buffer | ✅ | Buffer contendo os dados do arquivo | | filename | string | ✅ | Nome do arquivo | | mimeType | string | ✅ | Tipo MIME do arquivo (ex: image/jpeg, application/pdf) | | isPrivate | boolean | ❌ | Define se o arquivo é privado (padrão: false) |

Licença

MIT © JCDEV