shogun-relay-sdk 1.3.0 → 1.4.0

package/README.md

@@ -76,6 +76,108 @@ const result = await sdk.ipfs.uploadFile(
 );
 ```
 
+## API Keys
+
+Manage API keys for programmatic access to all relay services:
+
+```typescript
+// List all API keys
+const keys = await sdk.apiKeys.list();
+
+// Create a new API key
+const newKey = await sdk.apiKeys.create('My App Key', 30); // 30 days expiration
+console.log('API Key:', newKey.token); // Save this, it's only shown once!
+
+// Use the API key for authentication
+sdk.apiKeys.useApiKey(newKey.token);
+
+// Or use it directly
+sdk.setToken(newKey.token);
+
+// Revoke an API key
+await sdk.apiKeys.revoke(newKey.keyId);
+```
+
+**Note**: API keys work across all relay services (Drive, IPFS, etc.) and use the prefix `shogun-api-`.
+
+## Drive Operations
+
+The Drive module provides file system operations for the admin drive:
+
+### List Files
+
+```typescript
+// List root directory
+const files = await sdk.drive.list();
+
+// List specific directory
+const files = await sdk.drive.list('folder/subfolder');
+```
+
+### Upload Files
+
+```typescript
+// Upload single file
+const result = await sdk.drive.uploadFile(
+  fileBuffer,
+  'example.txt',
+  'folder' // optional path
+);
+
+// Upload multiple files
+const result = await sdk.drive.uploadFiles([
+  { file: fileBuffer1, filename: 'file1.txt' },
+  { file: fileBuffer2, filename: 'file2.txt' }
+], 'folder');
+```
+
+### Download Files
+
+```typescript
+const fileBuffer = await sdk.drive.download('path/to/file.txt');
+```
+
+### Directory Operations
+
+```typescript
+// Create directory
+await sdk.drive.createDirectory('new-folder', 'parent-folder');
+
+// Rename file/directory
+await sdk.drive.rename('old-name.txt', 'new-name.txt');
+
+// Move file/directory
+await sdk.drive.move('source.txt', 'destination/folder/source.txt');
+
+// Delete file/directory
+await sdk.drive.delete('path/to/item');
+```
+
+### Storage Statistics
+
+```typescript
+const stats = await sdk.drive.getStats();
+console.log(`Total: ${stats.stats.totalSizeMB} MB`);
+console.log(`Files: ${stats.stats.fileCount}`);
+```
+
+### Public Links
+
+```typescript
+// Create a public sharing link
+const link = await sdk.drive.createPublicLink('document.pdf', 7); // 7 days expiration
+console.log('Public URL:', link.publicUrl);
+
+// List all public links
+const links = await sdk.drive.listPublicLinks();
+
+// Revoke a link
+await sdk.drive.revokePublicLink(link.linkId);
+
+// Get public file URL (for direct access)
+const publicUrl = sdk.drive.getPublicFileUrl(link.linkId, 'https://shogun-relay.scobrudot.dev');
+```
+
 ## IPFS Operations
 
 ### Upload Single File
@@ -290,6 +392,8 @@ See the main [API Documentation](../docs/API.md) for complete endpoint reference
 
 - **System**: Health checks, stats, system information
 - **IPFS**: File uploads, directory uploads, content retrieval, pinning
+- **Drive**: Admin drive file system operations, public link sharing
+- **API Keys**: API key management for programmatic access
 - **Deals**: Storage deal creation, activation, management
 - **Registry**: On-chain relay registry operations
 - **Network**: Network federation, reputation, relay discovery

package/dist/index.d.ts

@@ -8,8 +8,12 @@ import { RegistryModule } from "./modules/registry";
 import { UploadsModule } from "./modules/uploads";
 import { BridgeModule } from "./modules/bridge";
 import { AnnasArchiveModule } from "./modules/annas-archive";
+import { DriveModule } from "./modules/drive";
+import { ApiKeysModule } from "./modules/api-keys";
 export * from "./types";
 export * from "./modules/annas-archive";
+export * from "./modules/drive";
+export * from "./modules/api-keys";
 export * from "./utils/wallet";
 export declare class ShogunRelaySDK {
     private client;
@@ -22,6 +26,8 @@ export declare class ShogunRelaySDK {
     uploads: UploadsModule;
     bridge: BridgeModule;
     annasArchive: AnnasArchiveModule;
+    drive: DriveModule;
+    apiKeys: ApiKeysModule;
     constructor(config: ApiClientConfig);
     setToken(token: string): void;
 }

package/dist/index.js

@@ -25,9 +25,13 @@ const registry_1 = require("./modules/registry");
 const uploads_1 = require("./modules/uploads");
 const bridge_1 = require("./modules/bridge");
 const annas_archive_1 = require("./modules/annas-archive");
+const drive_1 = require("./modules/drive");
+const api_keys_1 = require("./modules/api-keys");
 // Export types
 __exportStar(require("./types"), exports);
 __exportStar(require("./modules/annas-archive"), exports);
+__exportStar(require("./modules/drive"), exports);
+__exportStar(require("./modules/api-keys"), exports);
 // Export wallet utilities
 __exportStar(require("./utils/wallet"), exports);
 class ShogunRelaySDK {
@@ -42,6 +46,8 @@ class ShogunRelaySDK {
         this.uploads = new uploads_1.UploadsModule(this.client);
         this.bridge = new bridge_1.BridgeModule(this.client);
         this.annasArchive = new annas_archive_1.AnnasArchiveModule(this.client);
+        this.drive = new drive_1.DriveModule(this.client);
+        this.apiKeys = new api_keys_1.ApiKeysModule(this.client);
     }
     setToken(token) {
         this.client.setToken(token);

package/dist/modules/api-keys.d.ts

@@ -0,0 +1,44 @@
+import { ApiClient } from "../client";
+export interface ApiKey {
+    keyId: string;
+    name: string;
+    createdAt: number;
+    lastUsedAt: number | null;
+    expiresAt: number | null;
+}
+export interface ApiKeyCreateResponse {
+    success: boolean;
+    keyId: string;
+    token: string;
+    name: string;
+    createdAt: number;
+    expiresAt: number | null;
+    message: string;
+}
+export interface ApiKeysListResponse {
+    success: boolean;
+    keys: ApiKey[];
+}
+export declare class ApiKeysModule {
+    private client;
+    constructor(client: ApiClient);
+    /**
+     * List all API keys
+     */
+    list(): Promise<ApiKeysListResponse>;
+    /**
+     * Create a new API key
+     */
+    create(name: string, expiresInDays?: number): Promise<ApiKeyCreateResponse>;
+    /**
+     * Revoke an API key
+     */
+    revoke(keyId: string): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+    /**
+     * Set the API key as the authentication token for future requests
+     */
+    useApiKey(apiKeyToken: string): void;
+}

package/dist/modules/api-keys.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKeysModule = void 0;
+class ApiKeysModule {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all API keys
+     */
+    async list() {
+        return this.client.get("/api/v1/api-keys");
+    }
+    /**
+     * Create a new API key
+     */
+    async create(name, expiresInDays) {
+        return this.client.post("/api/v1/api-keys", {
+            name,
+            expiresInDays,
+        });
+    }
+    /**
+     * Revoke an API key
+     */
+    async revoke(keyId) {
+        return this.client.delete(`/api/v1/api-keys/${keyId}`);
+    }
+    /**
+     * Set the API key as the authentication token for future requests
+     */
+    useApiKey(apiKeyToken) {
+        this.client.setToken(apiKeyToken);
+    }
+}
+exports.ApiKeysModule = ApiKeysModule;

package/dist/modules/drive.d.ts

@@ -0,0 +1,135 @@
+import { ApiClient } from "../client";
+export interface DriveFileItem {
+    name: string;
+    path: string;
+    type: "file" | "directory";
+    size: number;
+    modified: number;
+}
+export interface DriveListResponse {
+    success: boolean;
+    items: DriveFileItem[];
+    path: string;
+}
+export interface DriveStatsResponse {
+    success: boolean;
+    stats: {
+        totalBytes: number;
+        totalSizeMB: string;
+        totalSizeGB: string;
+        fileCount: number;
+        dirCount: number;
+    };
+}
+export interface PublicLink {
+    linkId: string;
+    filePath: string;
+    createdAt: number;
+    expiresAt: number | null;
+    accessCount: number;
+    lastAccessedAt: number | null;
+}
+export interface PublicLinkResponse {
+    success: boolean;
+    linkId: string;
+    filePath: string;
+    publicUrl: string;
+    createdAt: number;
+    expiresAt: number | null;
+}
+export interface PublicLinksListResponse {
+    success: boolean;
+    links: PublicLink[];
+}
+export declare class DriveModule {
+    private client;
+    constructor(client: ApiClient);
+    /**
+     * List files and folders in the specified directory
+     */
+    list(path?: string): Promise<DriveListResponse>;
+    /**
+     * Upload a single file
+     */
+    uploadFile(file: Buffer | Blob, filename: string, path?: string): Promise<{
+        success: boolean;
+        message: string;
+        files: Array<{
+            name: string;
+            path: string;
+            size: number;
+        }>;
+    }>;
+    /**
+     * Upload multiple files
+     */
+    uploadFiles(files: Array<{
+        file: Buffer | Blob;
+        filename: string;
+    }>, path?: string): Promise<{
+        success: boolean;
+        message: string;
+        files: Array<{
+            name: string;
+            path: string;
+            size: number;
+        }>;
+    }>;
+    /**
+     * Download a file
+     */
+    download(path: string): Promise<Buffer>;
+    /**
+     * Delete a file or directory
+     */
+    delete(path: string): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+    /**
+     * Create a directory
+     */
+    createDirectory(name: string, path?: string): Promise<{
+        success: boolean;
+        message: string;
+        path: string;
+    }>;
+    /**
+     * Rename a file or directory
+     */
+    rename(oldPath: string, newName: string): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+    /**
+     * Move a file or directory
+     */
+    move(sourcePath: string, destPath: string): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+    /**
+     * Get storage statistics
+     */
+    getStats(): Promise<DriveStatsResponse>;
+    /**
+     * Create a public sharing link for a file
+     */
+    createPublicLink(filePath: string, expiresInDays?: number): Promise<PublicLinkResponse>;
+    /**
+     * List all public links
+     */
+    listPublicLinks(): Promise<PublicLinksListResponse>;
+    /**
+     * Revoke a public link
+     */
+    revokePublicLink(linkId: string): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+    /**
+     * Get public file URL (for direct access without authentication)
+     * Note: This requires the baseURL from the SDK configuration to construct the full URL
+     */
+    getPublicFileUrl(linkId: string, baseURL?: string): string;
+}

package/dist/modules/drive.js

@@ -0,0 +1,125 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DriveModule = void 0;
+const form_data_1 = __importDefault(require("form-data"));
+class DriveModule {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List files and folders in the specified directory
+     */
+    async list(path) {
+        const url = path ? `/api/v1/drive/list/${encodeURIComponent(path)}` : "/api/v1/drive/list";
+        return this.client.get(url);
+    }
+    /**
+     * Upload a single file
+     */
+    async uploadFile(file, filename, path) {
+        const formData = new form_data_1.default();
+        formData.append("file", file, filename);
+        const url = path ? `/api/v1/drive/upload/${encodeURIComponent(path)}` : "/api/v1/drive/upload";
+        return this.client.post(url, formData, {
+            headers: formData.getHeaders(),
+        });
+    }
+    /**
+     * Upload multiple files
+     */
+    async uploadFiles(files, path) {
+        const formData = new form_data_1.default();
+        files.forEach(({ file, filename }) => {
+            formData.append("files", file, filename);
+        });
+        const url = path ? `/api/v1/drive/upload/${encodeURIComponent(path)}` : "/api/v1/drive/upload";
+        return this.client.post(url, formData, {
+            headers: formData.getHeaders(),
+        });
+    }
+    /**
+     * Download a file
+     */
+    async download(path) {
+        const url = `/api/v1/drive/download/${encodeURIComponent(path)}`;
+        // Use the internal axios client to handle arraybuffer response
+        const response = await this.client.client.get(url, {
+            responseType: "arraybuffer",
+        });
+        return Buffer.from(response.data);
+    }
+    /**
+     * Delete a file or directory
+     */
+    async delete(path) {
+        const url = `/api/v1/drive/delete/${encodeURIComponent(path)}`;
+        return this.client.delete(url);
+    }
+    /**
+     * Create a directory
+     */
+    async createDirectory(name, path) {
+        const url = path ? `/api/v1/drive/mkdir/${encodeURIComponent(path)}` : "/api/v1/drive/mkdir";
+        return this.client.post(url, { name });
+    }
+    /**
+     * Rename a file or directory
+     */
+    async rename(oldPath, newName) {
+        return this.client.post("/api/v1/drive/rename", {
+            oldPath,
+            newName,
+        });
+    }
+    /**
+     * Move a file or directory
+     */
+    async move(sourcePath, destPath) {
+        return this.client.post("/api/v1/drive/move", {
+            sourcePath,
+            destPath,
+        });
+    }
+    /**
+     * Get storage statistics
+     */
+    async getStats() {
+        return this.client.get("/api/v1/drive/stats");
+    }
+    /**
+     * Create a public sharing link for a file
+     */
+    async createPublicLink(filePath, expiresInDays) {
+        return this.client.post("/api/v1/drive/links", {
+            filePath,
+            expiresInDays,
+        });
+    }
+    /**
+     * List all public links
+     */
+    async listPublicLinks() {
+        return this.client.get("/api/v1/drive/links");
+    }
+    /**
+     * Revoke a public link
+     */
+    async revokePublicLink(linkId) {
+        return this.client.delete(`/api/v1/drive/links/${linkId}`);
+    }
+    /**
+     * Get public file URL (for direct access without authentication)
+     * Note: This requires the baseURL from the SDK configuration to construct the full URL
+     */
+    getPublicFileUrl(linkId, baseURL) {
+        if (baseURL) {
+            return `${baseURL}/api/v1/drive/public/${linkId}`;
+        }
+        // If baseURL is not provided, return relative path
+        return `/api/v1/drive/public/${linkId}`;
+    }
+}
+exports.DriveModule = DriveModule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shogun-relay-sdk",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "SDK for interacting with Shogun Relay API - HTTP client for IPFS, deals, registry, and network operations",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",