import { AttributeValue } from '@aws-sdk/client-dynamodb';
import { EntityType } from '../../constants/Repository.constants';

/**
 * The base interface for job runner entities.
 * @export
 * @interface BaseItem
 */
export interface BaseItem {
  /**
   * The property representing the corresponding record's partition key.
   * @type {EntityType}
   * @memberof BaseItem
   */
  type: EntityType;
}

/**
 * The base interface representing the attributes of a DynamoDB record.
 * @export
 * @interface BaseRecord
 */
export interface BaseRecord {
  /**
   * The partition key.
   * @type {EntityType}
   * @memberof BaseRecord
   */
  pk: EntityType;

  /**
   * The sort key.
   * @type {string}
   * @memberof BaseRecord
   */
  sk: string;
}

/**
 * The base dto interface.
 * @export
 * @interface BaseDto
 */
export type BaseDto = Record<keyof BaseRecord, AttributeValue>;

export type ListParameters<TFilters> = {
  filters?: TFilters;
  consistentRead?: boolean;
  limit?: number;
};