Skip to content

add value filtering for useQuery(Type, { mode: "public", … }) #439

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
merged 7 commits into from
Aug 7, 2025
Merged

add value filtering for useQuery(Type, { mode: "public", … }) #439

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1617a9a
pipe filter to useQueryPublic
nikgraf Aug 4, 2025
14cbca2
connect filters
nikgraf Aug 4, 2025
f5b1651
implement translateFilterToGraphql
nikgraf Aug 4, 2025
e8d9b1c
test integration example
nikgraf Aug 6, 2025
977f900
improve typing
nikgraf Aug 6, 2025
7b2c6c4
add changeset
nikgraf Aug 6, 2025
690d948
update docs
nikgraf Aug 6, 2025
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
5 changes: 5 additions & 0 deletions apps/events/src/components/playground.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ export const Playground = ({ spaceId }: { spaceId: string }) => {
jobOffers: {},
},
},
// filter: {
// name: {
// startsWith: 'test',
// },
// },
first: 100,
space: spaceId,
});
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/filtering-query-results.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ The filter API supports different filters for different property types and offer
const { data } = useQuery(Person, {
filter: {
or: [
not: { name: { is: "Jane Doe" } },
not: { name: { is: "John Doe" } },
{ not: { name: { is: 'Jane Doe' } } },
{ not: { name: { is: 'John Doe' } } },
],
},
});
Expand All @@ -99,11 +99,11 @@ const { data } = useQuery(Person, {
const { data } = useQuery(Person, {
filter: {
age: {
equals: 42
is: 42
},
or: [
not: { name: { is: "Jane Doe" } },
not: { name: { is: "John Doe" } },
{ not: { name: { is: 'Jane Doe' } } },
{ not: { name: { is: 'John Doe' } } },
],
not: {
or: [
Expand Down
348 changes: 348 additions & 0 deletions packages/hypergraph-react/src/internal/translate-filter-to-graphql.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,348 @@
import { Graph, Id } from '@graphprotocol/grc-20';
import { Entity, type Mapping, Type } from '@graphprotocol/hypergraph';
import { describe, expect, it } from 'vitest';
import { translateFilterToGraphql } from './translate-filter-to-graphql.js';

export class Todo extends Entity.Class<Todo>('Todo')({
name: Type.String,
completed: Type.Boolean,
priority: Type.Number,
}) {}

const mapping: Mapping.Mapping = {
Todo: {
typeIds: [Id('a288444f-06a3-4037-9ace-66fe325864d0')],
properties: {
name: Id('a126ca53-0c8e-48d5-b888-82c734c38935'),
completed: Id('d2d64cd3-a337-4784-9e30-25bea0349471'),
priority: Id('ee920534-42ce-4113-a63b-8f3c889dd772'),
},
},
};

describe('translateFilterToGraphql string filters', () => {
it('should translate string `is` filter correctly', () => {
const filter: Entity.EntityFilter<Todo> = {
name: { is: 'test' },
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
values: {
some: {
propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' },
string: { is: 'test' },
},
},
});
});

it('should translate string `contains` filter correctly', () => {
const filter: Entity.EntityFilter<Todo> = {
name: { contains: 'test' },
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
values: {
some: {
propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' },
string: { includes: 'test' },
},
},
});
});

it('should translate string `startsWith` filter correctly', () => {
const filter: Entity.EntityFilter<Todo> = {
name: { startsWith: 'test' },
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
values: {
some: {
propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' },
string: { startsWith: 'test' },
},
},
});
});

it('should translate string `endsWith` filter correctly', () => {
const filter: Entity.EntityFilter<Todo> = {
name: { endsWith: 'test' },
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
values: {
some: {
propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' },
string: { endsWith: 'test' },
},
},
});
});
});

describe('translateFilterToGraphql boolean filters', () => {
it('should translate boolean `is` filter correctly', () => {
const filter: Entity.EntityFilter<Todo> = {
completed: { is: true },
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
values: {
some: {
propertyId: { is: 'd2d64cd3-a337-4784-9e30-25bea0349471' },
boolean: { is: true },
},
},
});
});
});

describe('translateFilterToGraphql number filters', () => {
it('should translate number `is` filter correctly', () => {
const filter: Entity.EntityFilter<Todo> = {
priority: { is: 1 },
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
values: {
some: {
propertyId: { is: 'ee920534-42ce-4113-a63b-8f3c889dd772' },
number: { is: Graph.serializeNumber(1) },
},
},
});
});

it('should translate number `greaterThan` filter correctly', () => {
const filter: Entity.EntityFilter<Todo> = {
priority: { greaterThan: 1 },
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
values: {
some: {
propertyId: { is: 'ee920534-42ce-4113-a63b-8f3c889dd772' },
number: { greaterThan: Graph.serializeNumber(1) },
},
},
});
});
});

describe('translateFilterToGraphql multiple filters', () => {
it('should translate multiple filters correctly', () => {
const filter: Entity.EntityFilter<Todo> = {
name: { is: 'test' },
completed: { is: true },
priority: { greaterThan: 1 },
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
and: [
{
values: {
some: {
propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' },
string: { is: 'test' },
},
},
},
{
values: {
some: {
propertyId: { is: 'd2d64cd3-a337-4784-9e30-25bea0349471' },
boolean: { is: true },
},
},
},
{
values: {
some: {
propertyId: { is: 'ee920534-42ce-4113-a63b-8f3c889dd772' },
number: { greaterThan: Graph.serializeNumber(1) },
},
},
},
],
});
});
});

describe('translateFilterToGraphql with OR operator', () => {
it('should translate OR operator in nested filter array', () => {
const filter: Entity.EntityFilter<Todo> = {
or: [{ name: { is: 'test' } }, { name: { is: 'test2' } }],
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
or: [
{
values: { some: { propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' }, string: { is: 'test' } } },
},
{
values: { some: { propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' }, string: { is: 'test2' } } },
},
],
});
});

it('should translate OR operator in nested filter array', () => {
const filter: Entity.EntityFilter<Todo> = {
or: [{ name: { is: 'test' } }, { completed: { is: true } }],
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
or: [
{
values: { some: { propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' }, string: { is: 'test' } } },
},
{
values: { some: { propertyId: { is: 'd2d64cd3-a337-4784-9e30-25bea0349471' }, boolean: { is: true } } },
},
],
});
});
});

describe('translateFilterToGraphql with NOT operator', () => {
it('should translate NOT operator', () => {
const filter: Entity.EntityFilter<Todo> = {
not: { name: { is: 'test' } },
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
not: { values: { some: { propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' }, string: { is: 'test' } } } },
});
});

it('should translate NOT operator with multiple filters', () => {
const filter: Entity.EntityFilter<Todo> = {
not: { name: { is: 'test' }, completed: { is: true } },
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
not: {
and: [
{ values: { some: { propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' }, string: { is: 'test' } } } },
{ values: { some: { propertyId: { is: 'd2d64cd3-a337-4784-9e30-25bea0349471' }, boolean: { is: true } } } },
],
},
});
});
});

describe('translateFilterToGraphql with complex nested filters', () => {
it('should translate complex nested filters with or and not', () => {
const filter: Entity.EntityFilter<Todo> = {
or: [{ not: { name: { is: 'Jane Doe' } } }, { not: { name: { is: 'John Doe' } } }],
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
or: [
{
not: {
values: {
some: { propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' }, string: { is: 'Jane Doe' } },
},
},
},
{
not: {
values: {
some: { propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' }, string: { is: 'John Doe' } },
},
},
},
],
});
});

it('should translate complex nested filters with and, or and not', () => {
const filter: Entity.EntityFilter<Todo> = {
priority: {
is: 42,
},
or: [{ not: { name: { is: 'Jane Doe' } } }, { not: { name: { is: 'John Doe' } } }],
not: {
or: [{ name: { is: 'Jane Doe' } }, { name: { is: 'John Doe' } }],
},
};

const result = translateFilterToGraphql(filter, Todo, mapping);

expect(result).toEqual({
and: [
{
values: {
some: {
propertyId: { is: 'ee920534-42ce-4113-a63b-8f3c889dd772' },
number: { is: Graph.serializeNumber(42) },
},
},
},
{
or: [
{
not: {
values: {
some: { propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' }, string: { is: 'Jane Doe' } },
},
},
},
{
not: {
values: {
some: { propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' }, string: { is: 'John Doe' } },
},
},
},
],
},
{
not: {
or: [
{
values: {
some: { propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' }, string: { is: 'Jane Doe' } },
},
},
{
values: {
some: { propertyId: { is: 'a126ca53-0c8e-48d5-b888-82c734c38935' }, string: { is: 'John Doe' } },
},
},
],
},
},
],
});
});
});
Loading
Loading