@rljson/bs 0.0.18 → 0.0.19

package/dist/bs-peer.d.ts

@@ -0,0 +1,77 @@
+import { BlobProperties, Bs, DownloadBlobOptions, ListBlobsOptions, ListBlobsResult } from './bs.ts';
+import { Socket } from './socket.ts';
+/**
+ * Peer implementation of the Bs interface that communicates over a socket.
+ * Allows remote access to a blob storage instance.
+ */
+export declare class BsPeer implements Bs {
+    private _socket;
+    isOpen: boolean;
+    constructor(_socket: Socket);
+    /**
+     * Initializes the Peer connection.
+     */
+    init(): Promise<void>;
+    /**
+     * Closes the Peer connection.
+     */
+    close(): Promise<void>;
+    /**
+     * Returns a promise that resolves once the Peer connection is ready.
+     */
+    isReady(): Promise<void>;
+    /**
+     * Stores a blob from Buffer, string, or ReadableStream and returns properties.
+     * @param content - The blob content to store
+     * @returns Promise resolving to blob properties
+     */
+    setBlob(content: Buffer | string | ReadableStream<Uint8Array>): Promise<BlobProperties>;
+    /**
+     * Retrieves a blob by its ID as a Buffer.
+     * @param blobId - The unique identifier of the blob
+     * @param options - Download options
+     * @returns Promise resolving to blob content and properties
+     */
+    getBlob(blobId: string, options?: DownloadBlobOptions): Promise<{
+        content: Buffer;
+        properties: BlobProperties;
+    }>;
+    /**
+     * Retrieves a blob by its ID as a ReadableStream.
+     * @param blobId - The unique identifier of the blob
+     * @returns Promise resolving to readable stream
+     */
+    getBlobStream(blobId: string): Promise<ReadableStream<Uint8Array>>;
+    /**
+     * Deletes a blob by its ID.
+     * @param blobId - The unique identifier of the blob
+     * @returns Promise that resolves when deletion is complete
+     */
+    deleteBlob(blobId: string): Promise<void>;
+    /**
+     * Checks if a blob exists.
+     * @param blobId - The unique identifier of the blob
+     * @returns Promise resolving to true if blob exists
+     */
+    blobExists(blobId: string): Promise<boolean>;
+    /**
+     * Gets blob properties (size, createdAt) without retrieving content.
+     * @param blobId - The unique identifier of the blob
+     * @returns Promise resolving to blob properties
+     */
+    getBlobProperties(blobId: string): Promise<BlobProperties>;
+    /**
+     * Lists all blobs with optional filtering and pagination.
+     * @param options - Optional listing configuration
+     * @returns Promise resolving to list of blobs
+     */
+    listBlobs(options?: ListBlobsOptions): Promise<ListBlobsResult>;
+    /**
+     * Generates a signed URL for temporary blob access.
+     * @param blobId - The unique identifier of the blob
+     * @param expiresIn - Expiration time in seconds
+     * @param permissions - Permissions for the URL
+     * @returns Promise resolving to signed URL
+     */
+    generateSignedUrl(blobId: string, expiresIn: number, permissions?: 'read' | 'delete'): Promise<string>;
+}

package/dist/bs-server.d.ts

@@ -0,0 +1,32 @@
+import { Bs } from './bs.ts';
+import { Socket } from './socket.ts';
+/**
+ * Server implementation that exposes a Bs instance over socket connections.
+ * Allows multiple clients to access the same blob storage instance remotely.
+ */
+export declare class BsServer {
+    private readonly _bs;
+    private _sockets;
+    constructor(_bs: Bs);
+    /**
+     * Adds a socket to the BsServer instance.
+     * @param socket - The socket to add.
+     */
+    addSocket(socket: Socket): Promise<void>;
+    /**
+     * Removes a socket from the BsServer instance.
+     * @param socket - The socket to remove.
+     */
+    removeSocket(socket: Socket): void;
+    /**
+     * Adds a transport layer to the given socket.
+     * @param socket - The socket to add the transport layer to.
+     */
+    private _addTransportLayer;
+    /**
+     * Generates a transport layer object for the given Bs instance.
+     * @param bs - The Bs instance to generate the transport layer for.
+     * @returns An object containing methods that correspond to the Bs interface.
+     */
+    private _generateTransportLayer;
+}