Veltyr TS Client

Client TypeScript pour appeler l'API back Veltyr depuis un autre projet.

Installation

Si tu veux l'utiliser localement depuis un autre repo:

yarn add /absolute/path/to/veltyr/back/ts-client

Build

cd back/ts-client
yarn install
yarn build

Usage

import { VeltyrClient } from "@bakiversehq/veltyr-ts-client";

const client = new VeltyrClient("https://api.example.com", {
  apiKey: "veltyr_live_xxx", // optionnel
  // sessionId: "uuid-session", // optionnel (Bearer)
  credentials: "include", // utile côté browser pour cookie session
});

Usage URL statique (apiKey only)

import { createVeltyrClientWithApiKey } from "@bakiversehq/veltyr-ts-client";

const client = createVeltyrClientWithApiKey("veltyr_live_xxx");

La valeur statique est STATIC_VELTYR_BASE_URL dans src/index.ts.

API disponible

• uploadFile({ file, fileName?, isPrivate?, customMetadata? })
• getOwnedFiles({ offset?, limit? })
• getPublicFileMetadata(cidOrLookup)
• getPublicFileMetadataByMetadata({ key, value })
• downloadPublicFile(cid)
• downloadFile(cid)
• getSeekableFileResponse(cid, { public?, range? })
• togglePrivate(cid)
• deleteFile(cid)
• getPublicFileUrl(cid)
• getPublicSeekableFileUrl(cid)
• getPublicMetadataUrl(cid)

Exemple upload

const file = new File(["hello"], "hello.txt", { type: "text/plain" });

const uploaded = await client.uploadFile({
  file,
  isPrivate: false,
  customMetadata: {
    source: "my-app",
    tags: ["demo", "v1"],
  },
});

Exemple metadata publique

const metadata = await client.getPublicFileMetadata("bafy...");
console.log(metadata.custom_metadata);

const byTradeId = await client.getPublicFileMetadata({
  key: "trade_id",
  value: "trade-123",
});