@neo4j/[email protected]

Updates the @neo4j/graphql dependency, and introduces the changes listed below (if any).

@neo4j/[email protected] 🎉

Introducing @neo4j/introspector

The purpose for this tool is to generate a starting point for putting a GraphQL schema in front of Neo4j and to save developers time.
This is via introspecting the Neo4j data shape and generating GraphQL Type Definitions from it.

After generating the typedefs developers probably want to continue to work on it manually to add @auth etc and maybe remove fields to only expose what's intended.

The docs: https://neo4j.com/docs/graphql-manual/current/introspector/

API

At this point we expose the feature only through a programatic node API. We do aim to expose this through a CLI in the future, but no promises 🤞

There's also a readonly flag to have all types being annotated with a @exclude(operations: [CREATE, DELETE, UPDATE]) directive.

Sample usage

From the docs example:

const { toGraphQLTypeDefs } = require("@neo4j/introspector")
const neo4j = require("neo4j-driver");
const fs = require('fs');

const driver = neo4j.driver(
    "neo4j://localhost:7687",
    neo4j.auth.basic("neo4j", "password")
);

const sessionFactory = () => driver.session({ defaultAccessMode: neo4j.session.READ, database: "neo4j" })

// We create a async function here until "top level await" has landed
// so we can use async/await
async function main() {
    const typeDefs = await toGraphQLTypeDefs(sessionFactory)
    fs.writeFileSync('schema.graphql', typeDefs)
    await driver.close();
}
main()

Generated example

A database with this data:

CREATE (m:Movie {title: "Title"})
CREATE (a:Actor {name: "Actor Name"})
CREATE (a2:Actor {name: "Actor 2 Name"})
MERGE (a)-[:ACTED_IN {roles: ["Role 1", "Role 2"], pay: toFloat(200), amb: "string"}]->(m)
MERGE (a2)-[:ACTED_IN {roles: ["Palm tree"], amb: toInteger(3)}]->(m)
MERGE (a)-[:DIRECTED {skill: toInteger(4)}]->(m)
MERGE (a)<-[:WON_PRIZE_FOR]-(m)

would generate these GraphQL typedefs:

interface ActedInProperties @relationshipProperties {
    pay: Float
    roles: [String]!
}

type Actor {
    actedInMovies: [Movie!]! @relationship(type: "ACTED_IN", direction: OUT, properties: "ActedInProperties")
    directedMovies: [Movie!]! @relationship(type: "DIRECTED", direction: OUT, properties: "DirectedProperties")
    moviesWonPrizeFor: [Movie!]! @relationship(type: "WON_PRIZE_FOR", direction: IN)
    name: String!
}

interface DirectedProperties @relationshipProperties {
    skill: BigInt!
}

type Movie {
    actorsActedIn: [Actor!]! @relationship(type: "ACTED_IN", direction: IN, properties: "ActedInProperties")
    actorsDirected: [Actor!]! @relationship(type: "DIRECTED", direction: IN, properties: "DirectedProperties")
    title: String!
    wonPrizeForActors: [Actor!]! @relationship(type: "WON_PRIZE_FOR", direction: OUT)
}

@neo4j/[email protected]

🚀 Features

• Feat/fulltext
  • PR: #563
• Sorting by relationship properties for union and interface fields
  • PR: #598
• Feat/Aggregate Sum
  • PR: #597
• Feature/connectOrCreate
  • PR: #575

🐛 Fixes

• Fixed edge updates on one to one relationships
  • PR: #579
• fix/559: add subscription type fields to resolve tree field resolver
  • PR: #576
• Querying DateTime in the edge of a connection throws an error
  • PR: #587
• Generate scalar typedefs before extra definitions
  • PR: #599
• Fix/564: Async error when reading from JWKS endpoint
  • PR: #578
• Fix for missing auth parameter
  • PR: #603
• Fix: Project All Interface Fields For Types Implementing @relationship Interface
  • PR: #590
• Fix: Escape all @node directive labels
  • PR: #617

@neo4j/[email protected]

Updates the @neo4j/graphql dependency, and introduces the changes listed below (if any).

🚀 Features

• Feat/fulltext
  • PR: #563
• Feat: Autogenerated Typescript for OGM
  • PR: #528
• Feat/Aggregate Sum
  • PR: #597
• Feature/connectOrCreate
  • PR: #575

@neo4j/[email protected]

🚀 Features

• Feature: Support Order By for Primitive @cypher Fields
  • PR: #501
• Inject context in additional labels
  • PR: #536
• Interface relationship fields
  • PR: #525
• Field-level aggregations
  • PR: #521
• Feature/unique directive
  • PR: #547
• Added OpenID Json Web Key Sets for verification via the @auth directive
  • PR: #564

🐛 Fixes

• Fix: Project Interface Fields In Union Relationship
  • PR: #509
• Solution for operations being duplicated following multiple deletes
  • PR: #537
• Fix fieldAggregation types
  • PR: #539
• Test the right thing in multi-database integration tests
  • PR: #548
• Fix issue 488 handle union where on connections
  • PR: #540
• Bugfix/dbms version check
  • PR: #550
• Fix: call new on GraphQLString
  • PR: #566
• Fix/null points
  • PR: #565
• fix: error when only selecting info on update and create operations
  • PR: #568

@neo4j/[email protected]

Updates the @neo4j/graphql dependency, and introduces the changes listed below (if any).

@neo4j/[email protected]

🚀 Features

• Specify mapping of GraphQL type -> Neo4j node label using @node directive
  • PR: #475
• Custom pluralization
  • PR: #492
• Feat/where aggregations
  • PR: #519
• Feat/top level aggregations
  • PR: #470
• Refactor: dateTimeFields to temporalFields
  • PR: #466

🐛 Fixes

• Fix missing subscription payload
  • PR: #503
• Fix: Creation of Empty {Create,Update}Input for Relationship Properties
  • PR: #497
• Fix: Filter Null Values In Union Relationship
  • PR: #494
• fix: wrap auth sub clauses in parentheses to preserve precedence
  • PR: #506
• Fix transformation of arguments to @cypher directives
  • PR: #527
• Top level string aggregations length
  • PR: #529
• Fix: Alias count top level
  • PR: #530
• Add remaining node input types into validation
  • PR: #532

@neo4j/[email protected]

Updates the @neo4j/graphql dependency, and introduces the changes listed below (if any).

🚀 Features

• Feat/top level aggregations
  • PR: #470
• Refactor: dateTimeFields to temporalFields
  • PR: #466

@neo4j/[email protected]

🚀 Features

• @alias directive - map a GraphQL field to a Neo4j node/relationship property under a different name
  • PR: #463
• Feature: Add Duration Scalar
  • PR: #459

🐛 Fixes

• Fix: Project Interface Fields
  • PR: #477

@neo4j/[email protected]

Updates the @neo4j/graphql dependency, and introduces the changes listed below (if any).