apache-iggy 0.6.0 → 0.7.0

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

@@ -16,13 +16,23 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import type { CommandResponse } from '../../client/client.type.js';
 import type { GetOffset } from './get-offset.command.js';
+/**
+ * Parameters for the delete offset command.
+ * Same as GetOffset parameters.
+ */
 export type DeleteOffset = GetOffset;
+/**
+ * Delete offset command definition.
+ * Removes a stored consumer offset.
+ */
 export declare const DELETE_OFFSET: {
     code: number;
     serialize: ({ streamId, topicId, consumer, partitionId }: DeleteOffset) => Buffer<ArrayBuffer>;
-    deserialize: (r: CommandResponse) => boolean;
+    deserialize: (r: import("../../index.js").CommandResponse) => boolean;
 };
-export declare const deleteOffset: (getClient: import("../../client/client.type.js").ClientProvider) => (arg: GetOffset) => Promise<boolean>;
+/**
+ * Executable delete offset command function.
+ */
+export declare const deleteOffset: (getClient: import("../../index.js").ClientProvider) => (arg: GetOffset) => Promise<boolean>;
 //# sourceMappingURL=delete-offset.command.d.ts.map

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

@@ -20,6 +20,10 @@ import { deserializeVoidResponse } from '../../client/client.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { serializeGetOffset } from './offset.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
+/**
+ * Delete offset command definition.
+ * Removes a stored consumer offset.
+ */
 export const DELETE_OFFSET = {
     code: COMMAND_CODE.DeleteConsumerOffset,
     serialize: ({ streamId, topicId, consumer, partitionId = 0 }) => {
@@ -27,5 +31,8 @@ export const DELETE_OFFSET = {
     },
     deserialize: deserializeVoidResponse
 };
+/**
+ * Executable delete offset command function.
+ */
 export const deleteOffset = wrapCommand(DELETE_OFFSET);
 //# sourceMappingURL=delete-offset.command.js.map

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

@@ -19,12 +19,23 @@
 import type { CommandResponse } from '../../client/client.type.js';
 import type { Id } from '../identifier.utils.js';
 import { type Consumer, type OffsetResponse } from './offset.utils.js';
+/**
+ * Parameters for the get offset command.
+ */
 export type GetOffset = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
+    /** Topic identifier (ID or name) */
     topicId: Id;
+    /** Consumer identifier (single or group) */
     consumer: Consumer;
+    /** Partition ID (required for single consumer, null for group) */
     partitionId: number | null;
 };
+/**
+ * Get offset command definition.
+ * Retrieves the current and stored offset for a consumer.
+ */
 export declare const GET_OFFSET: {
     code: number;
     serialize: ({ streamId, topicId, consumer, partitionId }: GetOffset) => Buffer<ArrayBuffer>;
@@ -34,5 +45,8 @@ export declare const GET_OFFSET: {
         storedOffset: bigint;
     } | null;
 };
+/**
+ * Executable get offset command function.
+ */
 export declare const getOffset: (getClient: import("../../client/client.type.js").ClientProvider) => (arg: GetOffset) => Promise<OffsetResponse | null>;
 //# sourceMappingURL=get-offset.command.d.ts.map

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

@@ -19,6 +19,10 @@
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
 import { serializeGetOffset } from './offset.utils.js';
+/**
+ * Get offset command definition.
+ * Retrieves the current and stored offset for a consumer.
+ */
 export const GET_OFFSET = {
     code: COMMAND_CODE.GetOffset,
     serialize: ({ streamId, topicId, consumer, partitionId = 0 }) => {
@@ -37,5 +41,8 @@ export const GET_OFFSET = {
         };
     }
 };
+/**
+ * Executable get offset command function.
+ */
 export const getOffset = wrapCommand(GET_OFFSET);
 //# sourceMappingURL=get-offset.command.js.map

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

@@ -18,37 +18,85 @@
  */
 import type { ValueOf } from '../../type.utils.js';
 import { type Id } from '../identifier.utils.js';
+/**
+ * Consumer kind options for offset operations.
+ */
 export declare const ConsumerKind: {
+    /** Single consumer (not part of a group) */
     readonly Single: 1;
+    /** Consumer group member */
     readonly Group: 2;
 };
+/** Type alias for the ConsumerKind object */
 export type ConsumerKind = typeof ConsumerKind;
+/** String literal type of consumer kind names */
 export type ConsumerKindId = keyof ConsumerKind;
+/** Numeric values of consumer kinds */
 export type ConsumerKindValue = ValueOf<ConsumerKind>;
+/**
+ * Consumer identifier for offset operations.
+ */
 export type Consumer = {
+    /** Consumer kind (Single or Group) */
     kind: ConsumerKindValue;
+    /** Consumer or group identifier */
     id: Id;
 };
+/**
+ * Default single consumer instance.
+ */
 export declare const ConsumerSingle: {
     kind: 1;
     id: number;
 };
+/** Type for single consumer */
 export type ConsumerSingle = typeof ConsumerSingle;
+/**
+ * Consumer factory for creating consumer identifiers.
+ */
 export declare const Consumer: {
+    /** Single consumer instance */
     Single: {
         kind: 1;
         id: number;
     };
+    /** Creates a group consumer identifier */
     Group: (groupId: Id) => {
         kind: 2;
         id: Id;
     };
 };
+/**
+ * Response from offset operations.
+ */
 export type OffsetResponse = {
+    /** Partition ID */
     partitionId: number;
+    /** Current offset in the partition */
     currentOffset: bigint;
+    /** Stored consumer offset */
     storedOffset: bigint;
 };
+/**
+ * Serializes parameters for get/delete offset operations.
+ *
+ * @param streamId - Stream identifier (ID or name)
+ * @param topicId - Topic identifier (ID or name)
+ * @param consumer - Consumer identifier (single or group)
+ * @param partitionId - Partition ID (required for single consumer, optional for group)
+ * @returns Buffer containing serialized offset request
+ * @throws Error if partitionId is null for single consumer kind
+ */
 export declare const serializeGetOffset: (streamId: Id, topicId: Id, consumer: Consumer, partitionId: number | null) => Buffer<ArrayBuffer>;
+/**
+ * Serializes parameters for store offset operation.
+ *
+ * @param streamId - Stream identifier (ID or name)
+ * @param topicId - Topic identifier (ID or name)
+ * @param consumer - Consumer identifier (single or group)
+ * @param partitionId - Partition ID (required for single consumer, optional for group)
+ * @param offset - Offset value to store
+ * @returns Buffer containing serialized store offset request
+ */
 export declare const serializeStoreOffset: (streamId: Id, topicId: Id, consumer: Consumer, partitionId: number | null, offset: bigint) => Buffer<ArrayBuffer>;
 //# sourceMappingURL=offset.utils.d.ts.map

package/dist/wire/offset/offset.utils.js

@@ -18,21 +18,44 @@
  */
 import { serializeIdentifier } from '../identifier.utils.js';
 import { uint8ToBuf } from '../number.utils.js';
+/**
+ * Consumer kind options for offset operations.
+ */
 export const ConsumerKind = {
+    /** Single consumer (not part of a group) */
     Single: 1,
+    /** Consumer group member */
     Group: 2
 };
+/**
+ * Default single consumer instance.
+ */
 export const ConsumerSingle = {
     kind: ConsumerKind.Single,
     id: 0
 };
+/**
+ * Consumer factory for creating consumer identifiers.
+ */
 export const Consumer = {
+    /** Single consumer instance */
     Single: ConsumerSingle,
+    /** Creates a group consumer identifier */
     Group: (groupId) => ({
         kind: ConsumerKind.Group,
         id: groupId
     })
 };
+/**
+ * Serializes parameters for get/delete offset operations.
+ *
+ * @param streamId - Stream identifier (ID or name)
+ * @param topicId - Topic identifier (ID or name)
+ * @param consumer - Consumer identifier (single or group)
+ * @param partitionId - Partition ID (required for single consumer, optional for group)
+ * @returns Buffer containing serialized offset request
+ * @throws Error if partitionId is null for single consumer kind
+ */
 export const serializeGetOffset = (streamId, topicId, consumer, partitionId) => {
     if (consumer.kind === ConsumerKind.Single && partitionId === null)
         throw new Error('getOffset error: partitionId must be provided for single consumer kind');
@@ -58,6 +81,16 @@ export const serializeGetOffset = (streamId, topicId, consumer, partitionId) =>
         b2
     ]);
 };
+/**
+ * Serializes parameters for store offset operation.
+ *
+ * @param streamId - Stream identifier (ID or name)
+ * @param topicId - Topic identifier (ID or name)
+ * @param consumer - Consumer identifier (single or group)
+ * @param partitionId - Partition ID (required for single consumer, optional for group)
+ * @param offset - Offset value to store
+ * @returns Buffer containing serialized store offset request
+ */
 export const serializeStoreOffset = (streamId, topicId, consumer, partitionId, offset) => {
     const b = Buffer.allocUnsafe(8);
     b.writeBigUInt64LE(offset, 0);

package/dist/wire/offset/store-offset.command.d.ts

@@ -18,17 +18,32 @@
  */
 import { type Id } from '../identifier.utils.js';
 import { type Consumer } from './offset.utils.js';
+/**
+ * Parameters for the store offset command.
+ */
 export type StoreOffset = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
+    /** Topic identifier (ID or name) */
     topicId: Id;
+    /** Consumer identifier (single or group) */
     consumer: Consumer;
+    /** Partition ID (required for single consumer, null for group) */
     partitionId: number | null;
+    /** Offset value to store */
     offset: bigint;
 };
+/**
+ * Store offset command definition.
+ * Persists a consumer's offset for a partition.
+ */
 export declare const STORE_OFFSET: {
     code: number;
     serialize: ({ streamId, topicId, consumer, partitionId, offset }: StoreOffset) => Buffer<ArrayBuffer>;
     deserialize: (r: import("../../index.js").CommandResponse) => boolean;
 };
+/**
+ * Executable store offset command function.
+ */
 export declare const storeOffset: (getClient: import("../../index.js").ClientProvider) => (arg: StoreOffset) => Promise<boolean>;
 //# sourceMappingURL=store-offset.command.d.ts.map

package/dist/wire/offset/store-offset.command.js

@@ -20,10 +20,17 @@ import { deserializeVoidResponse } from '../../client/client.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
 import { serializeStoreOffset } from './offset.utils.js';
+/**
+ * Store offset command definition.
+ * Persists a consumer's offset for a partition.
+ */
 export const STORE_OFFSET = {
     code: COMMAND_CODE.StoreOffset,
     serialize: ({ streamId, topicId, consumer, partitionId, offset }) => serializeStoreOffset(streamId, topicId, consumer, partitionId, offset),
     deserialize: deserializeVoidResponse
 };
+/**
+ * Executable store offset command function.
+ */
 export const storeOffset = wrapCommand(STORE_OFFSET);
 //# sourceMappingURL=store-offset.command.js.map

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

@@ -17,15 +17,28 @@
  * under the License.
  */
 import type { Id } from '../identifier.utils.js';
+/**
+ * Parameters for the create partition command.
+ */
 export type CreatePartition = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
+    /** Topic identifier (ID or name) */
     topicId: Id;
+    /** Number of partitions to create (1-1000, default: 1) */
     partitionCount?: number;
 };
+/**
+ * Create partition command definition.
+ * Adds new partitions to a topic.
+ */
 export declare const CREATE_PARTITION: {
     code: number;
     serialize: ({ streamId, topicId, partitionCount }: CreatePartition) => Buffer<ArrayBuffer>;
     deserialize: (r: import("../../index.js").CommandResponse) => boolean;
 };
+/**
+ * Executable create partition command function.
+ */
 export declare const createPartition: (getClient: import("../../index.js").ClientProvider) => (arg: CreatePartition) => Promise<boolean>;
 //# sourceMappingURL=create-partition.command.d.ts.map

package/dist/wire/partition/create-partition.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 { serializePartitionParams } from './partition.utils.js';
+/**
+ * Create partition command definition.
+ * Adds new partitions to a topic.
+ */
 export const CREATE_PARTITION = {
     code: COMMAND_CODE.CreatePartitions,
     serialize: ({ streamId, topicId, partitionCount = 1 }) => {
@@ -27,5 +31,8 @@ export const CREATE_PARTITION = {
     },
     deserialize: deserializeVoidResponse
 };
+/**
+ * Executable create partition command function.
+ */
 export const createPartition = wrapCommand(CREATE_PARTITION);
 //# sourceMappingURL=create-partition.command.js.map

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

@@ -17,15 +17,28 @@
  * under the License.
  */
 import type { Id } from '../identifier.utils.js';
+/**
+ * Parameters for the delete partition command.
+ */
 export type DeletePartition = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
+    /** Topic identifier (ID or name) */
     topicId: Id;
+    /** Number of partitions to delete (1-1000) */
     partitionCount: number;
 };
+/**
+ * Delete partitions command definition.
+ * Removes partitions from a topic.
+ */
 export declare const DELETE_PARTITIONS: {
     code: number;
     serialize: ({ streamId, topicId, partitionCount }: DeletePartition) => Buffer<ArrayBuffer>;
     deserialize: (r: import("../../index.js").CommandResponse) => boolean;
 };
+/**
+ * Executable delete partition command function.
+ */
 export declare const deletePartition: (getClient: import("../../index.js").ClientProvider) => (arg: DeletePartition) => Promise<boolean>;
 //# sourceMappingURL=delete-partition.command.d.ts.map

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

@@ -20,6 +20,10 @@ import { deserializeVoidResponse } from '../../client/client.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { serializePartitionParams } from './partition.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
+/**
+ * Delete partitions command definition.
+ * Removes partitions from a topic.
+ */
 export const DELETE_PARTITIONS = {
     code: COMMAND_CODE.DeletePartitions,
     serialize: ({ streamId, topicId, partitionCount }) => {
@@ -27,5 +31,8 @@ export const DELETE_PARTITIONS = {
     },
     deserialize: deserializeVoidResponse
 };
+/**
+ * Executable delete partition command function.
+ */
 export const deletePartition = wrapCommand(DELETE_PARTITIONS);
 //# sourceMappingURL=delete-partition.command.js.map

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

@@ -17,5 +17,14 @@
  * under the License.
  */
 import { type Id } from '../identifier.utils.js';
+/**
+ * Serializes partition parameters for create/delete operations.
+ *
+ * @param streamId - Stream identifier (ID or name)
+ * @param topicId - Topic identifier (ID or name)
+ * @param partitionCount - Number of partitions (1-1000)
+ * @returns Buffer containing serialized partition request
+ * @throws Error if partitionCount is not between 1 and 1000
+ */
 export declare const serializePartitionParams: (streamId: Id, topicId: Id, partitionCount?: number) => Buffer<ArrayBuffer>;
 //# sourceMappingURL=partition.utils.d.ts.map

package/dist/wire/partition/partition.utils.js

@@ -18,6 +18,15 @@
  */
 import { serializeIdentifier } from '../identifier.utils.js';
 import { uint32ToBuf } from '../number.utils.js';
+/**
+ * Serializes partition parameters for create/delete operations.
+ *
+ * @param streamId - Stream identifier (ID or name)
+ * @param topicId - Topic identifier (ID or name)
+ * @param partitionCount - Number of partitions (1-1000)
+ * @returns Buffer containing serialized partition request
+ * @throws Error if partitionCount is not between 1 and 1000
+ */
 export const serializePartitionParams = (streamId, topicId, partitionCount = 1) => {
     if (partitionCount < 1 || partitionCount > 1000)
         throw new Error('Topic partition_count must be between 1 and 1000');

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

@@ -16,7 +16,27 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+/**
+ * Converts a microsecond timestamp (BigInt) to a JavaScript Date object.
+ *
+ * @param n - Timestamp in microseconds as BigInt
+ * @returns JavaScript Date object
+ */
 export declare const toDate: (n: bigint) => Date;
+/**
+ * Serializes a UUID string to a 16-byte Buffer.
+ * Removes dashes from the UUID and converts to binary format.
+ *
+ * @param id - UUID string (e.g., "550e8400-e29b-41d4-a716-446655440000")
+ * @returns 16-byte Buffer containing the UUID
+ */
 export declare const serializeUUID: (id: string) => Buffer<ArrayBuffer>;
+/**
+ * Deserializes a 16-byte Buffer to a UUID string.
+ * Converts binary format to standard UUID string with dashes.
+ *
+ * @param p - 16-byte Buffer containing the UUID
+ * @returns UUID string (e.g., "550e8400-e29b-41d4-a716-446655440000")
+ */
 export declare const deserializeUUID: (p: Buffer) => string;
 //# sourceMappingURL=serialize.utils.d.ts.map

package/dist/wire/serialize.utils.js

@@ -16,8 +16,28 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+/**
+ * Converts a microsecond timestamp (BigInt) to a JavaScript Date object.
+ *
+ * @param n - Timestamp in microseconds as BigInt
+ * @returns JavaScript Date object
+ */
 export const toDate = (n) => new Date(Number(n / BigInt(1000)));
+/**
+ * Serializes a UUID string to a 16-byte Buffer.
+ * Removes dashes from the UUID and converts to binary format.
+ *
+ * @param id - UUID string (e.g., "550e8400-e29b-41d4-a716-446655440000")
+ * @returns 16-byte Buffer containing the UUID
+ */
 export const serializeUUID = (id) => Buffer.from(id.replaceAll('-', ''), 'hex');
+/**
+ * Deserializes a 16-byte Buffer to a UUID string.
+ * Converts binary format to standard UUID string with dashes.
+ *
+ * @param p - 16-byte Buffer containing the UUID
+ * @returns UUID string (e.g., "550e8400-e29b-41d4-a716-446655440000")
+ */
 export const deserializeUUID = (p) => {
     const v = p.toString('hex');
     return `${v.slice(0, 8)}-` +

package/dist/wire/session/login-with-token.command.d.ts

@@ -18,9 +18,17 @@
  */
 import type { CommandResponse } from '../../client/client.type.js';
 import { type LoginResponse } from './login.utils.js';
+/**
+ * Parameters for the login with token command.
+ */
 export type LoginWithTokenParam = {
+    /** Access token string (1-255 bytes) */
     token: string;
 };
+/**
+ * Login with token command definition.
+ * Authenticates a user with an access token.
+ */
 export declare const LOGIN_WITH_TOKEN: {
     code: number;
     serialize: ({ token }: LoginWithTokenParam) => Buffer<ArrayBuffer>;
@@ -28,5 +36,8 @@ export declare const LOGIN_WITH_TOKEN: {
         userId: number;
     };
 };
+/**
+ * Executable login with token command function.
+ */
 export declare const loginWithToken: (getClient: import("../../client/client.type.js").ClientProvider) => (arg: LoginWithTokenParam) => Promise<LoginResponse>;
 //# sourceMappingURL=login-with-token.command.d.ts.map

package/dist/wire/session/login-with-token.command.js

@@ -19,6 +19,10 @@
 import { serializeLoginWithToken } from './login.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
+/**
+ * Login with token command definition.
+ * Authenticates a user with an access token.
+ */
 export const LOGIN_WITH_TOKEN = {
     code: COMMAND_CODE.LoginWithAccessToken,
     serialize: ({ token }) => serializeLoginWithToken(token),
@@ -26,5 +30,8 @@ export const LOGIN_WITH_TOKEN = {
         userId: r.data.readUInt32LE(0)
     })
 };
+/**
+ * Executable login with token command function.
+ */
 export const loginWithToken = wrapCommand(LOGIN_WITH_TOKEN);
 //# sourceMappingURL=login-with-token.command.js.map

package/dist/wire/session/login.command.d.ts

@@ -18,6 +18,10 @@
  */
 import type { CommandResponse } from '../../client/client.type.js';
 import { type LoginResponse, type LoginCredentials } from './login.utils.js';
+/**
+ * Login command definition.
+ * Authenticates a user with username and password.
+ */
 export declare const LOGIN: {
     code: number;
     serialize: ({ username, password, version, context }: LoginCredentials) => Buffer<ArrayBuffer>;
@@ -25,5 +29,8 @@ export declare const LOGIN: {
         userId: number;
     };
 };
+/**
+ * Executable login command function.
+ */
 export declare const login: (getClient: import("../../client/client.type.js").ClientProvider) => (arg: LoginCredentials) => Promise<LoginResponse>;
 //# sourceMappingURL=login.command.d.ts.map

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

@@ -19,6 +19,10 @@
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
 import { serializeLoginUser } from './login.utils.js';
+/**
+ * Login command definition.
+ * Authenticates a user with username and password.
+ */
 export const LOGIN = {
     code: COMMAND_CODE.LoginUser,
     serialize: serializeLoginUser,
@@ -26,5 +30,8 @@ export const LOGIN = {
         userId: r.data.readUInt32LE(0)
     })
 };
+/**
+ * Executable login command function.
+ */
 export const login = wrapCommand(LOGIN);
 //# sourceMappingURL=login.command.js.map

package/dist/wire/session/login.utils.d.ts

@@ -16,15 +16,40 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+/**
+ * Response from a successful login.
+ */
 export type LoginResponse = {
+    /** The authenticated user's ID */
     userId: number;
 };
+/**
+ * Credentials for user login.
+ */
 export type LoginCredentials = {
+    /** Username (1-255 bytes) */
     username: string;
+    /** Password (1-255 bytes) */
     password: string;
+    /** Optional client version string */
     version?: string;
+    /** Optional client context string */
     context?: string;
 };
+/**
+ * Serializes login credentials for the login command.
+ *
+ * @param credentials - Login credentials object
+ * @returns Buffer containing serialized login request
+ * @throws Error if username or password is not between 1 and 255 bytes
+ */
 export declare const serializeLoginUser: ({ username, password, version, context }: LoginCredentials) => Buffer<ArrayBuffer>;
+/**
+ * Serializes a token for the login with token command.
+ *
+ * @param token - Access token string (1-255 bytes)
+ * @returns Buffer containing serialized token login request
+ * @throws Error if token is not between 1 and 255 bytes
+ */
 export declare const serializeLoginWithToken: (token: string) => Buffer<ArrayBuffer>;
 //# sourceMappingURL=login.utils.d.ts.map

package/dist/wire/session/login.utils.js

@@ -17,6 +17,13 @@
  * under the License.
  */
 import { uint32ToBuf, uint8ToBuf } from "../number.utils.js";
+/**
+ * Serializes login credentials for the login command.
+ *
+ * @param credentials - Login credentials object
+ * @returns Buffer containing serialized login request
+ * @throws Error if username or password is not between 1 and 255 bytes
+ */
 export const serializeLoginUser = ({ username, password, version, context }) => {
     const bUsername = Buffer.from(username);
     const bPassword = Buffer.from(password);
@@ -41,6 +48,13 @@ export const serializeLoginUser = ({ username, password, version, context }) =>
         bContext
     ]);
 };
+/**
+ * Serializes a token for the login with token command.
+ *
+ * @param token - Access token string (1-255 bytes)
+ * @returns Buffer containing serialized token login request
+ * @throws Error if token is not between 1 and 255 bytes
+ */
 export const serializeLoginWithToken = (token) => {
     const bToken = Buffer.from(token);
     if (bToken.length < 1 || bToken.length > 255)

package/dist/wire/session/logout.command.d.ts

@@ -16,10 +16,17 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+/**
+ * Logout command definition.
+ * Ends the current user session.
+ */
 export declare const LOGOUT: {
     code: number;
     serialize: () => Buffer<ArrayBuffer>;
     deserialize: (r: import("../../index.js").CommandResponse) => boolean;
 };
+/**
+ * Executable logout command function.
+ */
 export declare const logout: (getClient: import("../../index.js").ClientProvider) => (arg: void) => Promise<boolean>;
 //# sourceMappingURL=logout.command.d.ts.map