// Any is used to prevent frustrating TS errors if we just want to store arbitrary json data
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type MetadataValue = Record<string, any>

export type MetadataBase = {
  [key: string]: MetadataValue
}

/**
 * Metadata access class to get, set (create and update), add (append to a record) and delete metadata on any record.
 *
 * set will override the previous value if it already exists
 *
 * note: To add persistence to these records, you have to update the record in the correct repository
 *
 * @example
 *
 * ```ts
 * connectionRecord.metadata.set('foo', { bar: 'baz' }) connectionRepository.update(connectionRecord)
 * ```
 */
export class Metadata<MetadataTypes> {
  public readonly data: MetadataBase

  public constructor(data: MetadataBase) {
    this.data = data
  }

  /**
   * Gets the value by key in the metadata
   *
   * Any extension of the `BaseRecord` can implement their own typed metadata
   *
   * @param key the key to retrieve the metadata by
   * @returns the value saved in the key value pair
   * @returns null when the key could not be found
   */
  public get<Value extends MetadataValue, Key extends string = string>(
    key: Key
  ): (Key extends keyof MetadataTypes ? MetadataTypes[Key] : Value) | null {
    return (this.data[key] as Key extends keyof MetadataTypes ? MetadataTypes[Key] : Value) ?? null
  }

  /**
   * Will set, or override, a key-value pair on the metadata
   *
   * @param key the key to set the metadata by
   * @param value the value to set in the metadata
   */
  public set<Value extends MetadataValue, Key extends string = string>(
    key: Key,
    value: Key extends keyof MetadataTypes ? MetadataTypes[Key] : Value
  ): void {
    this.data[key] = value as MetadataValue
  }

  /**
   * Adds a record to a metadata key
   *
   * @param key the key to add the metadata at
   * @param value the value to add in the metadata
   */
  public add<Value extends MetadataValue, Key extends string = string>(
    key: Key,
    value: Partial<Key extends keyof MetadataTypes ? MetadataTypes[Key] : Value>
  ): void {
    this.data[key] = {
      ...this.data[key],
      ...value,
    }
  }

  /**
   * Retrieves all the metadata for a record
   *
   * @returns all the metadata that exists on the record
   */
  public get keys(): string[] {
    return Object.keys(this.data)
  }

  /**
   * Will delete the key value pair in the metadata
   *
   * @param key the key to delete the data by
   */
  public delete<Key extends string = string>(key: Key): void {
    delete this.data[key]
  }
}