return type

Author: nikgraf

.changeset/add-space-type.md

@@ -0,0 +1,6 @@
+---
+"@graphprotocol/hypergraph": patch
+"@graphprotocol/hypergraph-react": patch
+---
+
+Add `type` field to `PublicSpace` type returned by `Space.findManyPublic()` and `usePublicSpaces()`. The type is either `"PERSONAL"` or `"DAO"`.

.claude/settings.local.json

@@ -5,7 +5,10 @@
       "Bash(pnpm typecheck:*)",
       "Bash(pnpm check:*)",
       "Bash(pnpm --filter events test:script:*)",
-      "Bash(pnpm test:*)"
+      "Bash(pnpm test:*)",
+      "Bash(pnpm vitest:*)",
+      "Bash(pnpm changeset:*)",
+      "Bash(npx tsc:*)"
     ],
     "deny": [],
     "ask": []

packages/hypergraph/src/space/find-many-public.ts

@@ -6,6 +6,7 @@ import { request } from 'graphql-request';
 
 const spaceFields = `
   id
+  type
   page {
     name
     relationsList(filter: {
@@ -53,8 +54,16 @@ query editorSpaces($accountId: UUID!) {
 }
 `;
 
+export const SpaceTypeSchema = EffectSchema.Union(
+  EffectSchema.Literal('PERSONAL'),
+  EffectSchema.Literal('DAO'),
+);
+
+export type SpaceType = typeof SpaceTypeSchema.Type;
+
 export const PublicSpaceSchema = EffectSchema.Struct({
   id: EffectSchema.String,
+  type: SpaceTypeSchema,
   name: EffectSchema.String,
   avatar: EffectSchema.optional(EffectSchema.String),
   editorIds: EffectSchema.Array(EffectSchema.String),
@@ -66,6 +75,7 @@ export type PublicSpace = typeof PublicSpaceSchema.Type;
 type SpacesQueryResult = {
   spaces?: {
     id: string;
+    type: 'PERSONAL' | 'DAO';
     page: {
       name?: string | null;
       relationsList?: {
@@ -120,6 +130,7 @@ export const parseSpacesQueryResult = (queryResult: SpacesQueryResult) => {
   for (const space of spaces) {
     const rawSpace: Record<string, unknown> = {
       id: space.id,
+      type: space.type,
       name: space.page?.name ?? undefined,
       avatar: getAvatarFromSpace(space),
       editorIds: getEditorIdsFromSpace(space),

packages/hypergraph/test/space/find-many-public.test.ts

@@ -3,19 +3,22 @@ import { parseSpacesQueryResult } from '../../src/space/find-many-public.js';
 
 const buildQuerySpace = ({
   id = 'space-id',
+  type = 'PERSONAL',
   name = 'Space name',
   avatar,
   editorsList = [],
   membersList = [],
 }: {
   id?: string;
+  type?: 'PERSONAL' | 'DAO';
   name?: string | null;
   avatar?: string | null;
   editorsList?: { memberSpaceId: string }[];
   membersList?: { memberSpaceId: string }[];
 } = {}) => {
   return {
     id,
+    type,
     page: {
       name,
       relationsList:
@@ -51,6 +54,7 @@ describe('parseSpacesQueryResult', () => {
     expect(data).toEqual([
       {
         id: 'space-1',
+        type: 'PERSONAL',
         name: 'Space 1',
         avatar: 'https://example.com/avatar.png',
         editorIds: [],
@@ -68,13 +72,30 @@ describe('parseSpacesQueryResult', () => {
     expect(data).toEqual([
       {
         id: 'space-2',
+        type: 'PERSONAL',
         name: 'Space 2',
         editorIds: [],
         memberIds: [],
       },
     ]);
   });
 
+  it('parses DAO type', () => {
+    const { data } = parseSpacesQueryResult({
+      spaces: [buildQuerySpace({ id: 'space-dao', type: 'DAO', name: 'DAO Space' })],
+    });
+
+    expect(data).toEqual([
+      {
+        id: 'space-dao',
+        type: 'DAO',
+        name: 'DAO Space',
+        editorIds: [],
+        memberIds: [],
+      },
+    ]);
+  });
+
   it('filters invalid data', () => {
     const { data, invalidSpaces } = parseSpacesQueryResult({
       spaces: [
@@ -86,6 +107,7 @@ describe('parseSpacesQueryResult', () => {
     expect(data).toEqual([
       {
         id: 'space-valid',
+        type: 'PERSONAL',
         name: 'Space valid',
         avatar: 'https://example.com/a.png',
         editorIds: [],
@@ -111,6 +133,7 @@ describe('parseSpacesQueryResult', () => {
     expect(data).toEqual([
       {
         id: 'space-with-members',
+        type: 'PERSONAL',
         name: 'Space with members',
         editorIds: ['editor-1', 'editor-2'],
         memberIds: ['member-1'],