Skip to content

fix: support top-level record-based queries #369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kettanaito merged 1 commit into from
Jul 8, 2026
+65 −19
Merged

fix: support top-level record-based queries #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions src/collection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,8 @@ export class Collection<Schema extends StandardSchemaV1> {
*/
public findFirst<Strict extends boolean>(
predicate?:
| ((query: Query<StandardSchemaV1.InferOutput<Schema>>) => Query<any>)
| Query<StandardSchemaV1.InferOutput<Schema>>,
| ((query: Query<RecordType<StandardSchemaV1.InferOutput<Schema>>>) => Query<any>)
| Query<RecordType<StandardSchemaV1.InferOutput<Schema>>>,
options?: StrictOptions<Strict>,
): Strict extends true
? RecordType<StandardSchemaV1.InferOutput<Schema>>
Expand Down Expand Up @@ -248,8 +248,8 @@ export class Collection<Schema extends StandardSchemaV1> {
*/
public findMany(
predicate?:
| ((query: Query<StandardSchemaV1.InferOutput<Schema>>) => Query<any>)
| Query<StandardSchemaV1.InferOutput<Schema>>,
| ((query: Query<RecordType<StandardSchemaV1.InferOutput<Schema>>>) => Query<any>)
| Query<RecordType<StandardSchemaV1.InferOutput<Schema>>>,
options?: PaginationOptions<Schema> & SortOptions<Schema> & StrictOptions,
): Array<RecordType<StandardSchemaV1.InferOutput<Schema>>> {
const query =
Expand Down Expand Up @@ -291,8 +291,8 @@ export class Collection<Schema extends StandardSchemaV1> {
*/
public async update<Strict extends boolean>(
predicate:
| ((query: Query<StandardSchemaV1.InferOutput<Schema>>) => Query<any>)
| Query<StandardSchemaV1.InferOutput<Schema>>
| ((query: Query<RecordType<StandardSchemaV1.InferOutput<Schema>>>) => Query<any>)
| Query<RecordType<StandardSchemaV1.InferOutput<Schema>>>
| RecordType<StandardSchemaV1.InferOutput<Schema>>,
options: UpdateOptions<StandardSchemaV1.InferOutput<Schema>> &
StrictOptions<Strict>,
Expand Down Expand Up @@ -340,8 +340,8 @@ export class Collection<Schema extends StandardSchemaV1> {
*/
public async updateMany(
predicate:
| ((query: Query<StandardSchemaV1.InferOutput<Schema>>) => Query<any>)
| Query<StandardSchemaV1.InferOutput<Schema>>,
| ((query: Query<RecordType<StandardSchemaV1.InferOutput<Schema>>>) => Query<any>)
| Query<RecordType<StandardSchemaV1.InferOutput<Schema>>>,
options: UpdateOptions<StandardSchemaV1.InferOutput<Schema>> &
SortOptions<Schema> &
StrictOptions,
Expand Down Expand Up @@ -380,8 +380,8 @@ export class Collection<Schema extends StandardSchemaV1> {
*/
public delete<Strict extends boolean>(
predicate:
| ((query: Query<StandardSchemaV1.InferOutput<Schema>>) => Query<any>)
| Query<StandardSchemaV1.InferOutput<Schema>>
| ((query: Query<RecordType<StandardSchemaV1.InferOutput<Schema>>>) => Query<any>)
| Query<RecordType<StandardSchemaV1.InferOutput<Schema>>>
| RecordType<StandardSchemaV1.InferOutput<Schema>>,
options?: StrictOptions<Strict>,
): Strict extends true
Expand Down Expand Up @@ -415,8 +415,8 @@ export class Collection<Schema extends StandardSchemaV1> {
*/
public deleteMany(
predicate:
| ((query: Query<StandardSchemaV1.InferOutput<Schema>>) => Query<any>)
| Query<StandardSchemaV1.InferOutput<Schema>>,
| ((query: Query<RecordType<StandardSchemaV1.InferOutput<Schema>>>) => Query<any>)
| Query<RecordType<StandardSchemaV1.InferOutput<Schema>>>,
options?: SortOptions<Schema> & StrictOptions,
): Array<RecordType<StandardSchemaV1.InferOutput<Schema>>> {
/**
Expand Down Expand Up @@ -618,7 +618,7 @@ export class Collection<Schema extends StandardSchemaV1> {
}

*#query(
query: Query<StandardSchemaV1.InferOutput<Schema>>,
query: Query<RecordType<StandardSchemaV1.InferOutput<Schema>>>,
options: PaginationOptions<Schema> = { take: Infinity },
): Generator<
RecordType<StandardSchemaV1.InferOutput<Schema>> | undefined,
Expand Down Expand Up @@ -668,7 +668,7 @@ export class Collection<Schema extends StandardSchemaV1> {
for (let i = start; i !== end; i += delta) {
const record = this.#records[i]

if (query.test(record)) {
if (record != null && query.test(record)) {
if (skip != null) {
if (skipped < skip) {
skipped++
Expand Down
12 changes: 8 additions & 4 deletions src/query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export type Condition<T> =
}
: never

export type PredicateFunction<T> = (value: T) => boolean
export type PredicateFunction<T> = (value: T) => unknown

export class Query<T> {
#predicate?: PredicateFunction<T>
Expand All @@ -33,19 +33,23 @@ export class Query<T> {
return !!this.#predicate?.(value)
}

public where(condition: Condition<T>) {
public where(condition: Condition<T> | PredicateFunction<T>) {
return new Query<T>(
Query.#and(this.#predicate, Query.#normalize(condition)),
)
}

public and(...conditions: Array<Query<T> | Condition<T>>) {
public and(
...conditions: Array<Query<T> | Condition<T> | PredicateFunction<T>>
) {
return new Query<T>(
Query.#and(this.#predicate, ...conditions.map(Query.#normalize)),
)
}

public or(...conditions: Array<Query<T> | Condition<T>>) {
public or(
...conditions: Array<Query<T> | Condition<T> | PredicateFunction<T>>
) {
return new Query<T>(
Query.#or(this.#predicate, ...conditions.map(Query.#normalize)),
)
Expand Down
14 changes: 14 additions & 0 deletions tests/find-first.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,3 +159,17 @@ it('queries by nullable properties', async () => {
users.findFirst((q) => q.where({ organizationId: (id) => id !== null })),
).toEqual({ id: 2, organizationId: 5 })
})

it('supports top-level record-based predicate via `q.where`', async () => {
const users = new Collection({
schema: z.object({ id: z.number(), name: z.string() }),
})

const john = await users.create({ id: 1, name: 'John' })
await users.create({ id: 2, name: 'Kate' })

expect(users.findFirst((q) => q.where((user) => user.id === 1))).toEqual(john)
expect(
users.findFirst((q) => q.where((user) => user.id === 123)),
).toBeUndefined()
})
14 changes: 14 additions & 0 deletions tests/find-many.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,17 @@ it('queries by nullable properties', async () => {
users.findMany((q) => q.where({ organizationId: (id) => id !== null })),
).toEqual([{ id: 2, organizationId: 5 }])
})

it('supports top-level record-based predicate via `q.where`', async () => {
const users = new Collection({
schema: z.object({ id: z.number(), name: z.string() }),
})

const john = await users.create({ id: 1, name: 'John' })
const johnatan = await users.create({ id: 2, name: 'Johnatan' })

expect(
users.findMany((q) => q.where((user) => user.name.startsWith('John'))),
).toEqual([john, johnatan])
expect(users.findMany((q) => q.where((user) => user.id > 3))).toEqual([])
})
16 changes: 15 additions & 1 deletion tests/types/find-first.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Collection, type RecordType } from '#/src/collection.js'
import { z } from 'zod'
import { Collection, type RecordType } from '#/src/collection.js'

it('does not require a query argument', () => {
const users = new Collection({
Expand Down Expand Up @@ -69,3 +69,17 @@ it('supports a strict mode', () => {
.toHaveProperty('strict')
.toEqualTypeOf<boolean | undefined>()
})

it('supports top-level record-based predicate via `q.where`', () => {
const users = new Collection({
schema: z.object({ id: z.number(), name: z.string() }),
})

users.findFirst((q) =>
q.where((user) => {
expectTypeOf(user).toEqualTypeOf<
RecordType<{ id: number; name: string }>
>()
}),
)
})
Loading