[RFC] Consolidate packages and update names to hypergraph approach

[cmwhited]

Description

The repo is currently split into very separated and siloed packages:

Utility/helper packages

• graph-framework-utils
• graph-framework-identity
• graph-framework-key
• graph-framework-schema
• graph-framework-messages
• graph-framework-space-events

Top-level export

• graph-framework
  • reexports from the utility helper packages

This approach creates a bit of a dependency and tree-shaking problem for apps using the framework.

Potential approaches:

1. Put all code under the graph-framework package and rename to hypergraph with the publishable package name as @graphprotocol/hypergraph with sub-directories in the package for the utility/helpers above:

packages/
- hypergraph/
  - src/
    - index.ts -> barrel-file exports
    - utils/ -> contains code from graph-framework-utils package
    - key/ -> contains code from graph-framework-key package
    - schema/ -> contains code from graph-framework-schema package
    - messages/ -> contains code from graph-framework-messages package
    - space-events/ -> contains code from graph-framework-space-events package

Update package.json so that can import from sub-directories:

import { encodeBase58 } from '@graphprotocol/hypergraph/utils'

2. Very similar to approach 1, but with a caveat that @graphprotocol/hypergraph is framework-agnostic; just a TS lib. Some of the sub-packages have a requirement on react, meaning the top-level graph-framework has a requirement on react. IMO, the @graphprotocol/hypergraph package should not not have a requirement on react (or any framework) and then additional, extending, packages can be created for a react (and next, vue, angular, svelte, etc)

packages/
- hypergraph/
  - src/
    - index.ts -> barrel-file exports
    - utils/ -> contains code from graph-framework-utils package
    - key/ -> contains code from graph-framework-key package
    - schema/ -> contains code from graph-framework-schema package
    - messages/ -> contains code from graph-framework-messages package
    - space-events/ -> contains code from graph-framework-space-events package
- react/ -> contains react-specific logic for hypergraph. contexts, react-query, state, etc
  - src/ 

With this, rename from graph-framework to hypergraph

[nikgraf]

Currently createSchemaHooks, type, useGraphLogin, GraphLogin are the 4 things devs import to build an App. I think I understand what you suggested, but better to clarify before I form an opinion :)

1.1. In case 1 which approach would devs use?

import { createSchemaHooks, type, useGraphLogin, GraphLogin } from '@graphprotocol/hypergraph'
vs
import { createSchemaHooks, type } from '@graphprotocol/hypergraph/schema'
import { useGraphLogin, GraphLogin } from '@graphprotocol/hypergraph/identity'
vs
import { Schema, Identity } from '@graphprotocol/hypergraph'
// Schema.createSchemaHooks, Schema.type
// Identity.useGraphLogin, Identity.GraphLogin

1.2. For case 2 which one would it be?

import { type } from '@graphprotocol/hypergraph'
import { createSchemaHooks, useGraphLogin, GraphLogin } from '@graphprotocol/hypergraph-react'
vs
import { type } from '@graphprotocol/hypergraph/schema'
import { useGraphLogin, GraphLogin, createSchemaHooks } from '@graphprotocol/hypergraph-react'
vs
import { Schema } from '@graphprotocol/hypergraph'
// Schema.type
import { useGraphLogin, GraphLogin, createSchemaHooks } from '@graphprotocol/hypergraph-react'

[cmwhited]

1.1 Based off the comments in the thread from @fubhy I think the answer is either. But make it available so devs could import from the top-level @graphprotocol/hypergraph pkg

import { createSchemaHooks, type, useGraphLogin, GraphLogin } from '@graphprotocol/hypergraph'`

They could also import createSchemaHooks directly from @graphprotocol/hypergraph/schema and could also import all like:

import * as Schema from '@graphprotocol/hypergraph/schema'

1.2 For importing react specific exports, then I think it would be option 3

import { Schema } from '@graphprotocol/hypergraph'
// Schema.type
import { useGraphLogin, GraphLogin, createSchemaHooks } from '@graphprotocol/hypergraph-react'

Because useGraphLogin would not be exported from @graphprotocol/hypergraph

[nikgraf]

got it, both sounds good to me. Can you check in with Yaniv. If I remember correctly he had a strong preference here