add type tests

Author: nikgraf

packages/hypergraph-react/test/space-ids-types.test.ts

@@ -0,0 +1,41 @@
+import { Id } from '@graphprotocol/grc-20';
+import { Entity, Type } from '@graphprotocol/hypergraph';
+import { describe, expectTypeOf, it } from 'vitest';
+import type { useEntities } from '../src/hooks/use-entities.js';
+import type { useEntity } from '../src/hooks/use-entity.js';
+
+const Example = Entity.Schema(
+  {
+    title: Type.String,
+  },
+  {
+    types: [Id('2f608104-53e2-41bc-9efd-9e0fc984d02e')],
+    properties: {
+      title: Id('7f52b98b-6d7d-4131-b5d8-fd2b2cf597a5'),
+    },
+  },
+);
+
+describe('spaceIds type inference for React hooks', () => {
+  it('includes spaceIds for useEntity when includeSpaceIds is true', () => {
+    type Result = ReturnType<typeof useEntity<typeof Example, true, 'public'>>;
+    expectTypeOf<Result['data']>().toMatchTypeOf<(Entity.Entity<typeof Example> & { spaceIds: string[] }) | null>();
+  });
+
+  it('omits spaceIds for useEntity by default', () => {
+    type Result = ReturnType<typeof useEntity<typeof Example, false, 'public'>>;
+    expectTypeOf<Result['data']>().toMatchTypeOf<Entity.Entity<typeof Example> | null>();
+    expectTypeOf<Result['data']>().not.toMatchTypeOf<Entity.Entity<typeof Example> & { spaceIds: string[] }>();
+  });
+
+  it('includes spaceIds for useEntities when includeSpaceIds is true', () => {
+    type Result = ReturnType<typeof useEntities<typeof Example, true, 'public'>>;
+    expectTypeOf<Result['data'][number]>().toMatchTypeOf<Entity.Entity<typeof Example> & { spaceIds: string[] }>();
+  });
+
+  it('omits spaceIds for useEntities by default', () => {
+    type Result = ReturnType<typeof useEntities<typeof Example, false, 'public'>>;
+    expectTypeOf<Result['data'][number]>().toMatchTypeOf<Entity.Entity<typeof Example>>();
+    expectTypeOf<Result['data'][number]>().not.toMatchTypeOf<Entity.Entity<typeof Example> & { spaceIds: string[] }>();
+  });
+});

packages/hypergraph/test/entity/space-ids-types.test.ts

@@ -0,0 +1,76 @@
+import { Id } from '@graphprotocol/grc-20';
+import { describe, expectTypeOf, it } from 'vitest';
+import type { FindManyPublicParams, findManyPublic } from '../../src/entity/find-many-public.js';
+import type { FindOnePublicParams, findOnePublic } from '../../src/entity/find-one-public.js';
+import * as Entity from '../../src/entity/index.js';
+import type { SearchManyPublicParams, searchManyPublic } from '../../src/entity/search-many-public.js';
+import * as Type from '../../src/type/type.js';
+
+const Example = Entity.Schema(
+  {
+    title: Type.String,
+  },
+  {
+    types: [Id('e3c9a9ea-4a76-4d93-bcd7-bcfd277f1d43')],
+    properties: {
+      title: Id('2a2c8a86-1f6c-4051-868f-b0f2eddd86db'),
+    },
+  },
+);
+
+// biome-ignore lint/suspicious/noExplicitAny: fine here
+type AsyncReturnTypeWithParams<Fn extends (...args: any) => any, Params extends any[]> = Fn extends (
+  ...args: Params
+) => infer Result
+  ? Awaited<Result>
+  : never;
+
+describe('spaceIds type inference for entity helpers', () => {
+  it('adds spaceIds for findOnePublic when includeSpaceIds is true', () => {
+    type Result = AsyncReturnTypeWithParams<
+      typeof findOnePublic,
+      [typeof Example, FindOnePublicParams<typeof Example, true>]
+    >['entity'];
+    expectTypeOf<Result>().toEqualTypeOf<(Entity.Entity<typeof Example> & { spaceIds: string[] }) | null>();
+  });
+
+  it('omits spaceIds for findOnePublic by default', () => {
+    type Result = AsyncReturnTypeWithParams<
+      typeof findOnePublic,
+      [typeof Example, FindOnePublicParams<typeof Example>]
+    >['entity'];
+    expectTypeOf<Result>().toEqualTypeOf<Entity.Entity<typeof Example> | null>();
+  });
+
+  it('adds spaceIds for findManyPublic when includeSpaceIds is true', () => {
+    type Result = AsyncReturnTypeWithParams<
+      typeof findManyPublic,
+      [typeof Example, FindManyPublicParams<typeof Example, true>]
+    >['data'][number];
+    expectTypeOf<Result>().toEqualTypeOf<Entity.Entity<typeof Example> & { spaceIds: string[] }>();
+  });
+
+  it('omits spaceIds for findManyPublic by default', () => {
+    type Result = AsyncReturnTypeWithParams<
+      typeof findManyPublic,
+      [typeof Example, FindManyPublicParams<typeof Example>]
+    >['data'][number];
+    expectTypeOf<Result>().toEqualTypeOf<Entity.Entity<typeof Example>>();
+  });
+
+  it('adds spaceIds for searchManyPublic when includeSpaceIds is true', () => {
+    type Result = AsyncReturnTypeWithParams<
+      typeof searchManyPublic,
+      [typeof Example, SearchManyPublicParams<typeof Example, true>]
+    >['data'][number];
+    expectTypeOf<Result>().toEqualTypeOf<Entity.Entity<typeof Example> & { spaceIds: string[] }>();
+  });
+
+  it('omits spaceIds for searchManyPublic by default', () => {
+    type Result = AsyncReturnTypeWithParams<
+      typeof searchManyPublic,
+      [typeof Example, SearchManyPublicParams<typeof Example>]
+    >['data'][number];
+    expectTypeOf<Result>().toEqualTypeOf<Entity.Entity<typeof Example>>();
+  });
+});