apache-iggy 0.6.0 → 0.7.0

package/dist/wire/session/logout.command.js

@@ -19,6 +19,10 @@
 import { deserializeVoidResponse } from '../../client/client.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
+/**
+ * Logout command definition.
+ * Ends the current user session.
+ */
 export const LOGOUT = {
     code: COMMAND_CODE.LogoutUser,
     serialize: () => {
@@ -26,5 +30,8 @@ export const LOGOUT = {
     },
     deserialize: deserializeVoidResponse
 };
+/**
+ * Executable logout command function.
+ */
 export const logout = wrapCommand(LOGOUT);
 //# sourceMappingURL=logout.command.js.map

package/dist/wire/stream/create-stream.command.d.ts

@@ -18,14 +18,26 @@
  */
 import type { CommandResponse } from '../../client/client.type.js';
 import { type Stream } from './stream.utils.js';
+/**
+ * Parameters for the create stream command.
+ */
 export type CreateStream = {
+    /** Optional stream ID (auto-assigned by server if not provided) */
     streamId?: number;
+    /** Stream name (1-255 bytes) */
     name: string;
 };
+/**
+ * Create stream command definition.
+ * Creates a new stream with the specified name.
+ */
 export declare const CREATE_STREAM: {
     code: number;
     serialize: ({ name }: CreateStream) => Buffer<ArrayBuffer>;
     deserialize: (r: CommandResponse) => Stream;
 };
+/**
+ * Executable create stream command function.
+ */
 export declare const createStream: (getClient: import("../../client/client.type.js").ClientProvider) => (arg: CreateStream) => Promise<Stream>;
 //# sourceMappingURL=create-stream.command.d.ts.map

package/dist/wire/stream/create-stream.command.js

@@ -19,6 +19,10 @@
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
 import { deserializeToStream } from './stream.utils.js';
+/**
+ * Create stream command definition.
+ * Creates a new stream with the specified name.
+ */
 export const CREATE_STREAM = {
     code: COMMAND_CODE.CreateStream,
     serialize: ({ name }) => {
@@ -37,5 +41,8 @@ export const CREATE_STREAM = {
         return deserializeToStream(r.data, 0).data;
     }
 };
+/**
+ * Executable create stream command function.
+ */
 export const createStream = wrapCommand(CREATE_STREAM);
 //# sourceMappingURL=create-stream.command.js.map

package/dist/wire/stream/delete-stream.command.d.ts

@@ -17,13 +17,24 @@
  * under the License.
  */
 import { type Id } from '../identifier.utils.js';
+/**
+ * Parameters for the delete stream command.
+ */
 export type DeleteStream = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
 };
+/**
+ * Delete stream command definition.
+ * Removes a stream and all its topics from the system.
+ */
 export declare const DELETE_STREAM: {
     code: number;
     serialize: ({ streamId }: DeleteStream) => Buffer<ArrayBufferLike>;
     deserialize: (r: import("../../index.js").CommandResponse) => boolean;
 };
+/**
+ * Executable delete stream command function.
+ */
 export declare const deleteStream: (getClient: import("../../index.js").ClientProvider) => (arg: DeleteStream) => Promise<boolean>;
 //# sourceMappingURL=delete-stream.command.d.ts.map

package/dist/wire/stream/delete-stream.command.js

@@ -20,6 +20,10 @@ import { deserializeVoidResponse } from '../../client/client.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
 import { serializeIdentifier } from '../identifier.utils.js';
+/**
+ * Delete stream command definition.
+ * Removes a stream and all its topics from the system.
+ */
 export const DELETE_STREAM = {
     code: COMMAND_CODE.DeleteStream,
     serialize: ({ streamId }) => {
@@ -27,5 +31,8 @@ export const DELETE_STREAM = {
     },
     deserialize: deserializeVoidResponse
 };
+/**
+ * Executable delete stream command function.
+ */
 export const deleteStream = wrapCommand(DELETE_STREAM);
 //# sourceMappingURL=delete-stream.command.js.map

package/dist/wire/stream/ensure-stream.virtual.command.d.ts

@@ -16,6 +16,13 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { ClientProvider } from '../../client/index.js';
+import type { ClientProvider } from '../../client/index.js';
+/**
+ * Creates a virtual command that ensures a stream exists.
+ * If the stream does not exist, it will be created.
+ *
+ * @param c - Client provider function
+ * @returns Function that ensures a stream exists by name
+ */
 export declare const ensureStream: (c: ClientProvider) => (streamName: string) => Promise<import("./stream.utils.js").Stream>;
 //# sourceMappingURL=ensure-stream.virtual.command.d.ts.map

package/dist/wire/stream/ensure-stream.virtual.command.js

@@ -18,6 +18,13 @@
  */
 import { createStream } from './create-stream.command.js';
 import { getStream } from './get-stream.command.js';
+/**
+ * Creates a virtual command that ensures a stream exists.
+ * If the stream does not exist, it will be created.
+ *
+ * @param c - Client provider function
+ * @returns Function that ensures a stream exists by name
+ */
 export const ensureStream = (c) => async function ensureStream(streamName) {
     const stream = await getStream(c)({ streamId: streamName });
     return stream === null ?

package/dist/wire/stream/get-stream.command.d.ts

@@ -19,13 +19,24 @@
 import type { CommandResponse } from '../../client/client.type.js';
 import { type Id } from '../identifier.utils.js';
 import { type Stream } from './stream.utils.js';
+/**
+ * Parameters for the get stream command.
+ */
 export type GetStream = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
 };
+/**
+ * Get stream command definition.
+ * Retrieves a single stream by ID or name.
+ */
 export declare const GET_STREAM: {
     code: number;
     serialize: ({ streamId }: GetStream) => Buffer<ArrayBufferLike>;
     deserialize: (r: CommandResponse) => Stream | null;
 };
+/**
+ * Executable get stream command function.
+ */
 export declare const getStream: (getClient: import("../../client/client.type.js").ClientProvider) => (arg: GetStream) => Promise<Stream | null>;
 //# sourceMappingURL=get-stream.command.d.ts.map

package/dist/wire/stream/get-stream.command.js

@@ -20,6 +20,10 @@ import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
 import { serializeIdentifier } from '../identifier.utils.js';
 import { deserializeToStream } from './stream.utils.js';
+/**
+ * Get stream command definition.
+ * Retrieves a single stream by ID or name.
+ */
 export const GET_STREAM = {
     code: COMMAND_CODE.GetStream,
     serialize: ({ streamId }) => {
@@ -31,5 +35,8 @@ export const GET_STREAM = {
         return deserializeToStream(r.data, 0).data;
     }
 };
+/**
+ * Executable get stream command function.
+ */
 export const getStream = wrapCommand(GET_STREAM);
 //# sourceMappingURL=get-stream.command.js.map

package/dist/wire/stream/get-streams.command.d.ts

@@ -18,10 +18,17 @@
  */
 import type { CommandResponse } from '../../client/client.type.js';
 import { type Stream } from './stream.utils.js';
+/**
+ * Get streams command definition.
+ * Retrieves all streams.
+ */
 export declare const GET_STREAMS: {
     code: number;
     serialize: () => Buffer<ArrayBuffer>;
     deserialize: (r: CommandResponse) => Stream[];
 };
+/**
+ * Executable get streams command function.
+ */
 export declare const getStreams: (getClient: import("../../client/client.type.js").ClientProvider) => (arg: void) => Promise<Stream[]>;
 //# sourceMappingURL=get-streams.command.d.ts.map

package/dist/wire/stream/get-streams.command.js

@@ -19,6 +19,10 @@
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
 import { deserializeToStream } from './stream.utils.js';
+/**
+ * Get streams command definition.
+ * Retrieves all streams.
+ */
 export const GET_STREAMS = {
     code: COMMAND_CODE.GetStreams,
     serialize: () => Buffer.alloc(0),
@@ -34,5 +38,8 @@ export const GET_STREAMS = {
         return streams;
     }
 };
+/**
+ * Executable get streams command function.
+ */
 export const getStreams = wrapCommand(GET_STREAMS);
 //# sourceMappingURL=get-streams.command.js.map

package/dist/wire/stream/purge-stream.command.d.ts

@@ -17,13 +17,24 @@
  * under the License.
  */
 import { type Id } from '../identifier.utils.js';
+/**
+ * Parameters for the purge stream command.
+ */
 export type PurgeStream = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
 };
+/**
+ * Purge stream command definition.
+ * Deletes all messages from a stream while keeping the stream itself.
+ */
 export declare const PURGE_STREAM: {
     code: number;
     serialize: ({ streamId }: PurgeStream) => Buffer<ArrayBufferLike>;
     deserialize: (r: import("../../index.js").CommandResponse) => boolean;
 };
+/**
+ * Executable purge stream command function.
+ */
 export declare const purgeStream: (getClient: import("../../index.js").ClientProvider) => (arg: PurgeStream) => Promise<boolean>;
 //# sourceMappingURL=purge-stream.command.d.ts.map

package/dist/wire/stream/purge-stream.command.js

@@ -20,6 +20,10 @@ import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
 import { deserializeVoidResponse } from '../../client/client.utils.js';
 import { serializeIdentifier } from '../identifier.utils.js';
+/**
+ * Purge stream command definition.
+ * Deletes all messages from a stream while keeping the stream itself.
+ */
 export const PURGE_STREAM = {
     code: COMMAND_CODE.PurgeStream,
     serialize: ({ streamId }) => {
@@ -27,5 +31,8 @@ export const PURGE_STREAM = {
     },
     deserialize: deserializeVoidResponse
 };
+/**
+ * Executable purge stream command function.
+ */
 export const purgeStream = wrapCommand(PURGE_STREAM);
 //# sourceMappingURL=purge-stream.command.js.map

package/dist/wire/stream/stream.utils.d.ts

@@ -16,18 +16,40 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+/**
+ * Stream information returned from the server.
+ */
 export type Stream = {
+    /** Stream ID */
     id: number;
+    /** Stream name */
     name: string;
+    /** Number of topics in the stream */
     topicsCount: number;
+    /** Total size of the stream in bytes */
     sizeBytes: bigint;
+    /** Total number of messages in the stream */
     messagesCount: bigint;
+    /** Stream creation timestamp */
     createdAt: Date;
 };
+/**
+ * Result of deserializing a stream.
+ */
 type StreamDeserialized = {
+    /** Number of bytes consumed */
     bytesRead: number;
+    /** Deserialized stream data */
     data: Stream;
 };
+/**
+ * Deserializes a stream from a buffer.
+ *
+ * @param r - Buffer containing serialized stream data
+ * @param pos - Starting position in the buffer
+ * @returns Object with bytes read and deserialized stream data
+ * @throws Error if the buffer is empty (stream does not exist)
+ */
 export declare const deserializeToStream: (r: Buffer, pos?: number) => StreamDeserialized;
 export {};
 //# sourceMappingURL=stream.utils.d.ts.map

package/dist/wire/stream/stream.utils.js

@@ -17,6 +17,14 @@
  * under the License.
  */
 import { toDate } from '../serialize.utils.js';
+/**
+ * Deserializes a stream from a buffer.
+ *
+ * @param r - Buffer containing serialized stream data
+ * @param pos - Starting position in the buffer
+ * @returns Object with bytes read and deserialized stream data
+ * @throws Error if the buffer is empty (stream does not exist)
+ */
 export const deserializeToStream = (r, pos = 0) => {
     if (r.length === 0)
         throw new Error('Steam does not exist');

package/dist/wire/stream/update-stream.command.d.ts

@@ -17,14 +17,26 @@
  * under the License.
  */
 import { type Id } from '../identifier.utils.js';
+/**
+ * Parameters for the update stream command.
+ */
 export type UpdateStream = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
+    /** New stream name (1-255 bytes) */
     name: string;
 };
+/**
+ * Update stream command definition.
+ * Updates a stream's name.
+ */
 export declare const UPDATE_STREAM: {
     code: number;
     serialize: ({ streamId, name }: UpdateStream) => Buffer<ArrayBuffer>;
     deserialize: (r: import("../../index.js").CommandResponse) => boolean;
 };
+/**
+ * Executable update stream command function.
+ */
 export declare const updateStream: (getClient: import("../../index.js").ClientProvider) => (arg: UpdateStream) => Promise<boolean>;
 //# sourceMappingURL=update-stream.command.d.ts.map

package/dist/wire/stream/update-stream.command.js

@@ -21,6 +21,10 @@ import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
 import { serializeIdentifier } from '../identifier.utils.js';
 import { uint8ToBuf } from '../number.utils.js';
+/**
+ * Update stream command definition.
+ * Updates a stream's name.
+ */
 export const UPDATE_STREAM = {
     code: COMMAND_CODE.UpdateStream,
     serialize: ({ streamId, name }) => {
@@ -36,5 +40,8 @@ export const UPDATE_STREAM = {
     },
     deserialize: deserializeVoidResponse
 };
+/**
+ * Executable update stream command function.
+ */
 export const updateStream = wrapCommand(UPDATE_STREAM);
 //# sourceMappingURL=update-stream.command.js.map

package/dist/wire/token/create-token.command.d.ts

@@ -18,14 +18,26 @@
  */
 import type { CommandResponse } from '../../client/client.type.js';
 import { type CreateTokenResponse } from './token.utils.js';
+/**
+ * Parameters for the create access token command.
+ */
 export type CreateToken = {
+    /** Token name (1-255 bytes) */
     name: string;
+    /** Token expiry time in seconds (default: 600) */
     expiry?: bigint;
 };
+/**
+ * Create access token command definition.
+ * Creates a new access token for authentication.
+ */
 export declare const CREATE_TOKEN: {
     code: number;
     serialize: ({ name, expiry }: CreateToken) => Buffer;
     deserialize: (r: CommandResponse) => CreateTokenResponse;
 };
+/**
+ * Executable create access token command function.
+ */
 export declare const createToken: (getClient: import("../../client/client.type.js").ClientProvider) => (arg: CreateToken) => Promise<CreateTokenResponse>;
 //# sourceMappingURL=create-token.command.d.ts.map

package/dist/wire/token/create-token.command.js

@@ -19,6 +19,10 @@
 import { deserializeCreateToken } from './token.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
+/**
+ * Create access token command definition.
+ * Creates a new access token for authentication.
+ */
 export const CREATE_TOKEN = {
     code: COMMAND_CODE.CreateAccessToken,
     serialize: ({ name, expiry = 600n }) => {
@@ -33,5 +37,8 @@ export const CREATE_TOKEN = {
     },
     deserialize: (r) => deserializeCreateToken(r.data).data
 };
+/**
+ * Executable create access token command function.
+ */
 export const createToken = wrapCommand(CREATE_TOKEN);
 //# sourceMappingURL=create-token.command.js.map

package/dist/wire/token/delete-token.command.d.ts

@@ -16,13 +16,24 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+/**
+ * Parameters for the delete access token command.
+ */
 export type DeleteToken = {
+    /** Token name (1-255 bytes) */
     name: string;
 };
+/**
+ * Delete access token command definition.
+ * Removes an existing access token.
+ */
 export declare const DELETE_TOKEN: {
     code: number;
     serialize: ({ name }: DeleteToken) => Buffer;
     deserialize: (r: import("../../index.js").CommandResponse) => boolean;
 };
+/**
+ * Executable delete access token command function.
+ */
 export declare const deleteToken: (getClient: import("../../index.js").ClientProvider) => (arg: DeleteToken) => Promise<boolean>;
 //# sourceMappingURL=delete-token.command.d.ts.map

package/dist/wire/token/delete-token.command.js

@@ -20,6 +20,10 @@ import { deserializeVoidResponse } from '../../client/client.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
 import { uint8ToBuf } from '../number.utils.js';
+/**
+ * Delete access token command definition.
+ * Removes an existing access token.
+ */
 export const DELETE_TOKEN = {
     code: COMMAND_CODE.DeleteAccessToken,
     serialize: ({ name }) => {
@@ -34,5 +38,8 @@ export const DELETE_TOKEN = {
     },
     deserialize: deserializeVoidResponse
 };
+/**
+ * Executable delete access token command function.
+ */
 export const deleteToken = wrapCommand(DELETE_TOKEN);
 //# sourceMappingURL=delete-token.command.js.map

package/dist/wire/token/get-tokens.command.d.ts

@@ -18,10 +18,17 @@
  */
 import type { CommandResponse } from '../../client/client.type.js';
 import { type Token } from './token.utils.js';
+/**
+ * Get access tokens command definition.
+ * Retrieves all access tokens for the current user.
+ */
 export declare const GET_TOKENS: {
     code: number;
     serialize: () => Buffer;
     deserialize: (r: CommandResponse) => Token[];
 };
+/**
+ * Executable get access tokens command function.
+ */
 export declare const getTokens: (getClient: import("../../client/client.type.js").ClientProvider) => (arg: void) => Promise<Token[]>;
 //# sourceMappingURL=get-tokens.command.d.ts.map

package/dist/wire/token/get-tokens.command.js

@@ -19,10 +19,17 @@
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
 import { deserializeTokens } from './token.utils.js';
+/**
+ * Get access tokens command definition.
+ * Retrieves all access tokens for the current user.
+ */
 export const GET_TOKENS = {
     code: COMMAND_CODE.GetAccessTokens,
     serialize: () => Buffer.alloc(0),
     deserialize: (r) => deserializeTokens(r.data)
 };
+/**
+ * Executable get access tokens command function.
+ */
 export const getTokens = wrapCommand(GET_TOKENS);
 //# sourceMappingURL=get-tokens.command.js.map

package/dist/wire/token/token.utils.d.ts

@@ -16,23 +16,63 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+/**
+ * Response from creating an access token.
+ */
 export type CreateTokenResponse = {
+    /** The generated access token string */
     token: string;
 };
+/**
+ * Result of deserializing a token creation response.
+ */
 type TokenDeserialized = {
+    /** Number of bytes consumed */
     bytesRead: number;
+    /** Deserialized token response */
     data: CreateTokenResponse;
 };
+/**
+ * Access token information.
+ */
 export type Token = {
+    /** Token name */
     name: string;
+    /** Token expiry timestamp (null if no expiry) */
     expiry: Date | null;
 };
+/**
+ * Result of deserializing a token.
+ */
 type TokenSerialized = {
+    /** Number of bytes consumed */
     bytesRead: number;
+    /** Deserialized token data */
     data: Token;
 };
+/**
+ * Deserializes a token creation response from a buffer.
+ *
+ * @param p - Buffer containing serialized token response
+ * @param pos - Starting position in the buffer
+ * @returns Object with bytes read and token string
+ */
 export declare const deserializeCreateToken: (p: Buffer, pos?: number) => TokenDeserialized;
+/**
+ * Deserializes a token from a buffer.
+ *
+ * @param p - Buffer containing serialized token data
+ * @param pos - Starting position in the buffer
+ * @returns Object with bytes read and deserialized token data
+ */
 export declare const deserializeToken: (p: Buffer, pos?: number) => TokenSerialized;
+/**
+ * Deserializes multiple tokens from a buffer.
+ *
+ * @param p - Buffer containing serialized tokens data
+ * @param pos - Starting position in the buffer
+ * @returns Array of deserialized tokens
+ */
 export declare const deserializeTokens: (p: Buffer, pos?: number) => Token[];
 export {};
 //# sourceMappingURL=token.utils.d.ts.map

package/dist/wire/token/token.utils.js

@@ -17,11 +17,25 @@
  * under the License.
  */
 import { toDate } from '../serialize.utils.js';
+/**
+ * Deserializes a token creation response from a buffer.
+ *
+ * @param p - Buffer containing serialized token response
+ * @param pos - Starting position in the buffer
+ * @returns Object with bytes read and token string
+ */
 export const deserializeCreateToken = (p, pos = 0) => {
     const len = p.readUInt8(pos);
     const token = p.subarray(pos + 1, pos + 1 + len).toString();
     return { bytesRead: 1 + len, data: { token } };
 };
+/**
+ * Deserializes a token from a buffer.
+ *
+ * @param p - Buffer containing serialized token data
+ * @param pos - Starting position in the buffer
+ * @returns Object with bytes read and deserialized token data
+ */
 export const deserializeToken = (p, pos = 0) => {
     const nameLength = p.readUInt8(pos);
     const name = p.subarray(pos + 1, pos + 1 + nameLength).toString();
@@ -40,6 +54,13 @@ export const deserializeToken = (p, pos = 0) => {
         }
     };
 };
+/**
+ * Deserializes multiple tokens from a buffer.
+ *
+ * @param p - Buffer containing serialized tokens data
+ * @param pos - Starting position in the buffer
+ * @returns Array of deserialized tokens
+ */
 export const deserializeTokens = (p, pos = 0) => {
     const tokens = [];
     const len = p.length;

package/dist/wire/topic/create-topic.command.d.ts

@@ -19,19 +19,36 @@
 import type { CommandResponse } from '../../client/client.type.js';
 import { type Id } from '../identifier.utils.js';
 import { type Topic, type CompressionAlgorithm as CompressionAlgorithmT } from './topic.utils.js';
+/**
+ * Parameters for the create topic command.
+ */
 export type CreateTopic = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
+    /** Topic name (1-255 bytes) */
     name: string;
+    /** Number of partitions to create */
     partitionCount: number;
+    /** Compression algorithm (None or Gzip) */
     compressionAlgorithm: CompressionAlgorithmT;
+    /** Message expiry time in microseconds (0 = unlimited) */
     messageExpiry?: bigint;
+    /** Maximum topic size in bytes (0 = unlimited) */
     maxTopicSize?: bigint;
+    /** Replication factor (1-255) */
     replicationFactor?: number;
 };
+/**
+ * Create topic command definition.
+ * Creates a new topic within a stream.
+ */
 export declare const CREATE_TOPIC: {
     code: number;
     serialize: ({ streamId, name, partitionCount, compressionAlgorithm, messageExpiry, maxTopicSize, replicationFactor }: CreateTopic) => Buffer<ArrayBuffer>;
     deserialize: (r: CommandResponse) => Topic;
 };
+/**
+ * Executable create topic command function.
+ */
 export declare const createTopic: (getClient: import("../../client/client.type.js").ClientProvider) => (arg: CreateTopic) => Promise<Topic>;
 //# sourceMappingURL=create-topic.command.d.ts.map