@darseen/vaze 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,170 @@
+# Vaze SDK
+
+<div align="center">
+
+<img src="../../.github/images/vaze.png" alt="logo" width="200"/>
+
+![NPM Downloads](https://img.shields.io/npm/dm/@darseen/vaze?style=for-the-badge)
+![NPM Version](https://img.shields.io/npm/v/@darseen/vaze?style=for-the-badge)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
+
+**@darseen/vaze** The official JavaScript/TypeScript SDK for Vaze, a self-hosted, local-first file storage and hosting service. This SDK provides a simple and type-safe way to interact with your Vaze instance's API from your Node.js backend or frontend applications.
+
+## </div>
+
+# Installation
+
+Install the package using your preferred package manager:
+
+```
+npm install @darseen/vaze
+# or
+yarn add @darseen/vaze
+# or
+pnpm add @darseen/vaze
+```
+
+# Initialization
+
+To use the SDK, you must instantiate the `Vaze` client. You can provide your configuration either directly through the constructor options or via environment variables. Using Constructor Options
+
+```ts
+import Vaze from "@darseen/vaze";
+
+const vaze = new Vaze({
+  vazeUrl: "http://your-server-ip:3000",
+  apiKey: "YOUR_API_KEY",
+});
+```
+
+# Using Environment Variables
+
+If you set `VAZE_URL` and `VAZE_API_KEY` in your environment, you can initialize the client without passing arguments:
+
+```ts
+import Vaze from "@darseen/vaze";
+
+// Automatically picks up process.env.VAZE_URL and process.env.VAZE_API_KEY
+const vaze = new Vaze();
+```
+
+# API Documentation
+
+The SDK is divided into two main modules: `files` and `folders`. All methods are asynchronous and return a standard `ApiResponse` object containing either `data` or an `error`. Files API Access file-related methods via `vaze.files.getAll(options?)` Retrieve a paginated list of all files.
+
+- options (optional):
+  - `limit`
+  - `offset`
+  - `orderBy`
+  - `orderDirection`
+
+```ts
+const { data, error } = await vaze.files.getAll({
+  limit: 10,
+  orderBy: "created_at",
+  orderDirection: "DESC",
+});
+
+if (data) {
+  console.log(data.files);
+}
+```
+
+`getById(id)` Retrieve a specific file by its ID.
+
+```ts
+const { data, error } = await vaze.files.getById("file-id");
+```
+
+`getByName(name, options?)` Search for files by name.
+
+```ts
+const { data, error } = await vaze.files.getByName("document.pdf", {
+  limit: 5,
+});
+```
+
+`upload(data)` Upload one or multiple files to your Vaze instance.
+
+- data:
+  - `files` (File[]): An array of standard `File` objects.
+  - `folder?` (string): The ID or name of the target folder.
+
+```ts
+const { data, error } = await vaze.files.upload({
+  files,
+  folder: "optional-folder-name", // example: "documents" or "projects/work" (supports sub-folders)
+});
+```
+
+`rename(data)` Rename an existing file.
+
+- data:
+  - `id` (string): The ID of the file to rename.
+  - `name` (string): The new name for the file.
+
+```ts
+const { data, error } = await vaze.files.rename({
+  id: "file-id-123",
+  name: "new-document-name.pdf",
+});
+```
+
+`delete(id)` Delete a file by its ID.
+
+```ts
+const { data, error } = await vaze.files.delete("file-id-123");
+```
+
+Folders API Access folder-related methods via `vaze.folders`. `get(options?)` Retrieve folders and their contents.
+
+- options (optional):
+  - `id`
+  - `path` example: "projects/work"
+  - `limit`
+  - `offset`
+  - `orderBy`
+  - `orderDirection`
+
+```ts
+const { data, error } = await vaze.folders.get({
+  path: "/documents/work",
+  limit: 20,
+});
+
+if (data) {
+  console.log("Files:", data.files);
+  console.log("Sub-folders:", data.folders);
+}
+```
+
+`create(folder)` Create a new folder.
+
+- folder: The name or path of the new folder. Example: "projects" or "projects/work"
+
+```ts
+const { data, error } = await vaze.folders.create("projects/work");
+```
+
+`rename(data)` Rename an existing folder.
+
+- data:
+  - `id`: The ID of the folder to rename.
+  - `name`: The new name.
+
+```ts
+const { data, error } = await vaze.folders.rename({
+  id: "folder-id-456",
+  name: "new-name",
+});
+```
+
+`delete(id)` Delete a folder by its ID.
+
+```ts
+const { data, error } = await vaze.folders.delete("folder-id");
+```
+
+# Types
+
+This SDK is built with TypeScript and exports all necessary types to ensure type safety in your applications. Types such as `FileWithUrl`, `Folder`, and `ApiResponse`.

package/dist/index.d.cts

@@ -1,5 +1,6 @@
 import * as _repo_types from '@repo/types';
 import { ApiResponse, FileWithUrl, Folder } from '@repo/types';
+export { ApiResponse, FileWithUrl as File, Folder } from '@repo/types';
 
 declare class Base {
     private apiKey;
@@ -32,7 +33,7 @@ declare class Files extends Base {
         files: FileWithUrl[];
     }>>;
     upload(data: {
-        files: File[];
+        files: FileWithUrl[];
         folder?: string;
     }): Promise<_repo_types.ApiResponse<{
         files: FileWithUrl[];
@@ -68,6 +69,7 @@ declare class Folders extends Base {
 
 interface IVaze {
     files: Files;
+    folders: Folders;
 }
 
 declare class Vaze extends Base implements IVaze {

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import * as _repo_types from '@repo/types';
 import { ApiResponse, FileWithUrl, Folder } from '@repo/types';
+export { ApiResponse, FileWithUrl as File, Folder } from '@repo/types';
 
 declare class Base {
     private apiKey;
@@ -32,7 +33,7 @@ declare class Files extends Base {
         files: FileWithUrl[];
     }>>;
     upload(data: {
-        files: File[];
+        files: FileWithUrl[];
         folder?: string;
     }): Promise<_repo_types.ApiResponse<{
         files: FileWithUrl[];
@@ -68,6 +69,7 @@ declare class Folders extends Base {
 
 interface IVaze {
     files: Files;
+    folders: Folders;
 }
 
 declare class Vaze extends Base implements IVaze {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darseen/vaze",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Vaze Self-Hosted file storage and hosting service SKD.",
   "keywords": [
     "api",

package/.turbo/turbo-build.log

@@ -1,28 +0,0 @@
-
-> @darseen/vaze@1.0.0 prebuild /home/runner/work/vaze/vaze/packages/sdk
-> pnpm lint && rimraf ./dist
-
-
-> @darseen/vaze@1.0.0 lint /home/runner/work/vaze/vaze/packages/sdk
-> tsc --noEmit
-
-
-> @darseen/vaze@1.0.0 build /home/runner/work/vaze/vaze/packages/sdk
-> tsup
-
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v8.5.1
-CLI Using tsup config: /home/runner/work/vaze/vaze/packages/sdk/tsup.config.ts
-CLI Target: esnext
-CLI Cleaning output folder
-CJS Build start
-ESM Build start
-ESM dist/index.js 3.70 KB
-ESM ⚡️ Build success in 67ms
-CJS dist/index.cjs 3.74 KB
-CJS ⚡️ Build success in 71ms
-DTS Build start
-DTS ⚡️ Build success in 776ms
-DTS dist/index.d.cts 2.23 KB
-DTS dist/index.d.ts  2.23 KB