@alphayard/unibox-sdk
v0.1.4
Published
UniBox storage SDK for Boundary and other UniApps clients
Maintainers
Readme
@alphayard/unibox-sdk
UniBox client SDK for file storage in Boundary and other UniApps clients.
What it does
- Upload files
- List files
- List folders
- Create folders
- Load circle folders
- Read folder breadcrumb paths
- Fetch file details
- Update file metadata
- Delete files
- Search files
- Read quota and analytics
- Build public or proxied file URLs
Install
npm install @alphayard/unibox-sdkFor local development in this monorepo, boundary-app uses:
"@alphayard/unibox-sdk": "file:../packages/unibox-sdk"Usage
import { createUniBoxClient } from '@alphayard/unibox-sdk';
const unibox = createUniBoxClient({
baseURL: 'http://localhost:4000/api/v1',
appId: 'your-app-id',
getAccessToken: async () => 'jwt-token',
});
const result = await unibox.uploadFile({
file,
description: 'Profile image',
isPublic: true,
});
const folders = await unibox.getCircleFolders('circle-id');
const createdFolder = await unibox.createCircleFolder('circle-id', {
name: 'Invoices',
parentId: 'optional-parent-folder-id',
});Publish
For local Boundary app development, Metro resolves the package from src/index.ts.
Before publishing to npm, build the package so dist/ is up to date:
cd packages/unibox-sdk
npm run buildPublishing still requires an authenticated npm session:
cd packages/unibox-sdk
npm publish