box-node-sdk/src/serialization/json.ts

Official SDK for Box Platform APIs

export type SerializedData =
  | undefined
  | null
  | boolean
  | number
  | string
  | SerializedDataList
  | SerializedDataMap;

type SerializedDataList = readonly SerializedData[];
type SerializedDataMap = { readonly [key: string]: SerializedData | undefined };

export function jsonToSerializedData(text: string): SerializedData {
  return JSON.parse(text);
}

export function sdToJson(data: SerializedData): string {
  return JSON.stringify(data);
}

export function sdToUrlParams(data: SerializedData): string {
  if (!sdIsMap(data) && !sdIsString(data)) {
    throw new Error(
      'Expecting an object or string as an argument for sdToUrlParams',
    );
  }
  const dataAsMap: SerializedDataMap = sdIsString(data)
    ? JSON.parse(data)
    : data;
  return new URLSearchParams(
    Object.fromEntries(
      Object.entries(dataAsMap).filter(([key, value]) => value != null),
    ) as Record<string, string>,
  ).toString();
}

export function getSdValueByKey(obj: SerializedData, key: string): string {
  if (sdIsMap(obj)) {
    return obj[key]!.toString();
  }
  return '';
}

export function sdIsEmpty(data: SerializedData): data is undefined | null {
  return data == null;
}

export function sdIsBoolean(data: SerializedData): data is boolean {
  return typeof data == 'boolean';
}

export function sdIsNumber(data: SerializedData): data is number {
  return typeof data == 'number';
}

export function sdIsString(data: SerializedData): data is string {
  return typeof data == 'string';
}

export function sdIsList(data: SerializedData): data is SerializedDataList {
  return Array.isArray(data);
}

export function sdIsMap(data: SerializedData): data is SerializedDataMap {
  return typeof data === 'object' && data != null && !Array.isArray(data);
}

/**
 * Returns a string replacement for sensitive data.
 */
export function sanitizedValue(): string {
  return '---[redacted]---';
}

/**
 * Sanitize serialized data by replacing sensitive values with a placeholder.
 * @param sd SerializedData to sanitize
 * @param keysToSanitize Keys to sanitize
 */
export function sanitizeSerializedData(
  sd: SerializedData,
  keysToSanitize: Record<string, string>,
): SerializedData {
  if (!sdIsMap(sd)) {
    return sd;
  }
  const sanitizedDictionary: { [key: string]: SerializedData | undefined } = {};
  for (const [key, value] of Object.entries(sd)) {
    if (key.toLowerCase() in keysToSanitize && typeof value === 'string') {
      sanitizedDictionary[key] = sanitizedValue();
    } else if (typeof value === 'object') {
      sanitizedDictionary[key] = sanitizeSerializedData(value, keysToSanitize);
    } else {
      sanitizedDictionary[key] = value;
    }
  }
  return sanitizedDictionary;
}