foreign/node/src/wire/token/create-token.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 type { CommandResponse } from '../../client/client.type.js';
import { deserializeCreateToken, type CreateTokenResponse } from './token.utils.js';
import { wrapCommand } from '../command.utils.js';
import { COMMAND_CODE } from '../command.code.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 const CREATE_TOKEN = {
  code: COMMAND_CODE.CreateAccessToken,

  serialize: ({ name, expiry = 600n }: CreateToken): Buffer => {
    const bName = Buffer.from(name);

    if (bName.length < 1 || bName.length > 255)
      throw new Error('Token name should be between 1 and 255 bytes');

    const b = Buffer.allocUnsafe(8 + 1 + bName.length);
    b.writeUInt8(bName.length);
    b.fill(bName, 1);
    b.writeBigUInt64LE(expiry, 1 + bName.length);

    return b;
  },

  deserialize: (r: CommandResponse) => deserializeCreateToken(r.data).data
};


/**
 * Executable create access token command function.
 */
export const createToken = wrapCommand<CreateToken, CreateTokenResponse>(CREATE_TOKEN);