foreign/node/src/wire/stream/purge-stream.command.ts

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
//

import { wrapCommand } from '../command.utils.js';
import { COMMAND_CODE } from '../command.code.js';
import { deserializeVoidResponse } from '../../client/client.utils.js';
import { serializeIdentifier, 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 const PURGE_STREAM = {
  code: COMMAND_CODE.PurgeStream,

  serialize: ({streamId}: PurgeStream) => {
    return serializeIdentifier(streamId);
  },

  deserialize: deserializeVoidResponse
};


/**
 * Executable purge stream command function.
 */
export const purgeStream = wrapCommand<PurgeStream, boolean>(PURGE_STREAM);