npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

prisma-models-graph

v1.5.1

Published

Generates a bi-directional models graph for schema without strict relationship

Downloads

73

Readme

Prisma Models Graph Generator

This generator was bootstraped using create-prisma-generator

Generates a bi-directional models graph for schema without strict relationship defined in the schema, works via a custom schema annotation.

Getting Stared

1. Install npm:

npm install prisma-models-graph

2. Add the generator to the schema

generator modelsGraph {
  provider = "prisma-models-graph"
}

Additional options

generator modelsGraph {
  provider = "prisma-models-graph"
  exportJSON = true // Will also export a JSON models graph along with the typesafe models
}

Usage

  • Add custom relation annotation next to the field you want annotate relationship.

  • Format: /// [[<Relation Model>.<Relation Model Attribute>]] (The triple slash is important.)

    userId Int @map("user_id) /// [[User.id]]
  • With the above annotation, the generated models graph will be like this:

    {
      "users": {
        "attributes": [
          "id",
          "email",
          "name",
          "user_type_id"
        ],
        "relations": [
          {
            "modelName": "posts",
            "condition": "users.id = posts.user_id"
          }
        ]
      },
      "posts": {
        "attributes": [
          "id",
          "subject",
          "body",
          "user_id"
        ],
        "relations": [
          {
            "modelName": "users",
            "condition": "posts.user_id = users.id"
          }
        ]
      }
    }
  • To access the generated models graph, import it from @generated/models-graph. The generated models graph will be a typesafe object matching the models declared in schema.prisma.

    import { ModelsGraph } from '@generated/models-graph'
  • There are a few helper types available:

    import {
      ModelsGraph, // Generated models graph object
      ParsedModel, // Type definition of a singular generated model graph
      ParsedModels, // Type definition of all generated models graph
      ParsedModelRelation, // Type definition of the relation between two models
      ModelNames, // List of all generated models name,
      ParsedModelAttribute, // Type definition of generated models attribute
    } from '@generated/models-graph'