dyngoose/src/query/filters.ts

Elegant DynamoDB object modeling for Typescript

import { type Table } from '../table'

export type AttributeNames<T extends Table> = Exclude<Exclude<keyof T, keyof Table>, () => any>

export type ContainsType<Type> = Type extends Array<infer E> | Set<infer E> ? E : Type

export type IntersectsType<Type> = Type extends Array<infer E> | Set<infer E> ? E : never

export type SimpleTypesOnly<Type> = Type extends string | number | bigint | number | bigint ? Type : never

export type Filter<Type> =
  ['=', Type] |
  ['<>', Type] | // not equals
  ['<', Type] |
  ['<=', Type] |
  ['>', Type] |
  ['>=', Type] |
  ['beginsWith', Exclude<Type, number>] | // causes a type error when a number is used with beginsWith, which is unsupported by DynamoDB
  ['between', Type, Type] |
  ['includes', Type[]] |
  ['excludes', Type[]] |
  ['contains', ContainsType<Type>] | // contains can be used on a list, string, or set attributes
  ['not contains', ContainsType<Type>] | // not contains can be used on a list, string, or set attributes
  ['null'] |
  ['not null'] |
  ['exists'] |
  ['not exists']

export type Filters<T extends Table> = {
  [A in AttributeNames<T>]?: T[A] | Filter<T[A]>
}

// you have filter groups, which are joined as AND operators and separated by OR statements
export type ComplexFilters<T extends Table> = Array<Filters<T> | ComplexFilters<T> | 'OR'>

export type UpdateConditions<T extends Table> = Filters<T>