Instructions for incorporating a TypeScript type into a Prisma model

Question

Instructions for incorporating a TypeScript type into a Prisma model

I am trying to incorporate a Type Board into one of my Prisma models. However, I am encountering an error stating that "Type 'Board' is neither a built-in type, nor refers to another model, custom type, or enum." Can someone provide guidance on how to resolve this issue?

The structure of the Board type is as follows:

export type Board = {
  title: string;
  boardId?: string;
  id?: string;
  orgId: string;
  imageId: string;
  imageThumbUrl: string;
  imageFullUrl: string;
  imageUserName: string;
  imageLinkHTML: string;

  createdAt?: Date;
  updatedAt?: Date;
};

Within schema.prisma:

// This is your Prisma schema file,
// learn more about it in the docs: https://pris.ly/d/prisma-schema

generator client {
  provider = "prisma-client-js"
}

datasource db {
  provider = "sqlite"
  url      = "file:./data/dev.db"
  // url      = env("DATABASE_URL")
}


model List {
  id        String @id @default(uuid())
  title     String
  order     Int

  boardId   String
  board     Board @relation(fields: [boardId], references: [id], onDelete: Cascade)

  cards     Card[]

  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt

  @@index([boardId])
}

typescript next.js prisma

Answer 1

Answer №1

Board data is housed in MockApi.io database.

As a result, Prisma is not aware of this connection.

If you want to retrieve a Board from a List, you'll need to implement something like the following code:

const list = await prisma.list.findUnique({ where: { id: listId } })
const board = await mockApiIoClient.board.findById(list.boardId) // psuedocode

You should also delete the following line from the schema file:

  board     Board @relation(fields: [boardId], references: [id], onDelete: Cascade)

This relationship cannot be managed by Prisma.

Your code must act as a liaison between the two systems. Therefore, it is not Prisma's responsibility to handle or provide the Board type.

Prisma generates TypeScript types from the database schema. Including a TypeScript type within the schema doesn't align logically.

Answer 2

Board data is housed in MockApi.io database.

As a result, Prisma is not aware of this connection.

If you want to retrieve a Board from a List, you'll need to implement something like the following code:

const list = await prisma.list.findUnique({ where: { id: listId } })
const board = await mockApiIoClient.board.findById(list.boardId) // psuedocode

You should also delete the following line from the schema file:

  board     Board @relation(fields: [boardId], references: [id], onDelete: Cascade)

This relationship cannot be managed by Prisma.

Your code must act as a liaison between the two systems. Therefore, it is not Prisma's responsibility to handle or provide the Board type.

Prisma generates TypeScript types from the database schema. Including a TypeScript type within the schema doesn't align logically.

Answer 3

Answer №2

In Prisma models, you are unable to directly reference a TypeScript type.

Models in Prisma can only refer to other models and enums that are defined within the same schema file.

If you want to incorporate Board information into your model, you have two options: define a model for Board and store the data in your database, or simply store the boardId in the List model and load the Board information through a resolver or an API call.

If you choose to store Board data with the Prisma method:

model List {
  id        String @id @default(uuid())
  title     String
  order     Int

  boardId   String
  board     Board @relation(fields: [boardId], references: [id], onDelete: Cascade)

  cards     Card[]

  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt

  @@index([boardId])
}

model Board {
  id        String @id @default(uuid())
  title String
  //... Other things
  imageLinkHTML: string;

  createdAt?: Date;
  updatedAt?: Date;
}

Alternatively, you could opt for a simpler approach by creating a List model in the database and storing just the boardId:

model List {
  id        String @id @default(uuid())
  title     String
  order     Int

  boardId   String

  cards     Card[]

  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt

  @@index([boardId])
}

When retrieving Board data from mockapi.io, extend the Prisma type with your custom Board type after running npx prisma generate:

import { List } from "@prisma/client";

// Fetch List from your database using Prisma
// Fetch Board from mockapi.io
// Combine List and Board data and Extend the List type with {board: Board}

// Inside of your getAllLists query:
const listData = await prisma.list.findUnique({ where: {
id: yourId }}) // Get one List
const boardData: Board = await fetch("mockapi.io api") // Retrieve Board data from mockapi.io

const newListData: List & {board: Board} = {...listData, board: boardData}

Answer 4

In Prisma models, you are unable to directly reference a TypeScript type.

Models in Prisma can only refer to other models and enums that are defined within the same schema file.

If you want to incorporate Board information into your model, you have two options: define a model for Board and store the data in your database, or simply store the boardId in the List model and load the Board information through a resolver or an API call.

If you choose to store Board data with the Prisma method:

model List {
  id        String @id @default(uuid())
  title     String
  order     Int

  boardId   String
  board     Board @relation(fields: [boardId], references: [id], onDelete: Cascade)

  cards     Card[]

  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt

  @@index([boardId])
}

model Board {
  id        String @id @default(uuid())
  title String
  //... Other things
  imageLinkHTML: string;

  createdAt?: Date;
  updatedAt?: Date;
}

Alternatively, you could opt for a simpler approach by creating a List model in the database and storing just the boardId:

model List {
  id        String @id @default(uuid())
  title     String
  order     Int

  boardId   String

  cards     Card[]

  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt

  @@index([boardId])
}

When retrieving Board data from mockapi.io, extend the Prisma type with your custom Board type after running npx prisma generate:

import { List } from "@prisma/client";

// Fetch List from your database using Prisma
// Fetch Board from mockapi.io
// Combine List and Board data and Extend the List type with {board: Board}

// Inside of your getAllLists query:
const listData = await prisma.list.findUnique({ where: {
id: yourId }}) // Get one List
const boardData: Board = await fetch("mockapi.io api") // Retrieve Board data from mockapi.io

const newListData: List & {board: Board} = {...listData, board: boardData}

Instructions for incorporating a TypeScript type into a Prisma model

Answer №1

Answer №2

Similar questions

Removing special characters when pasting into text box in Angular 2 or higher versions

After subscribing, creating the form results in receiving an error message that says "formgroup instance expected."

Installation of Shadcn UI results in the disruption of Tailwind CSS

Ways to enhance focus on childNodes using Javascript

Subtracted TypeScript concept

Issue with popup display in React Big Calendar

Redirect Conditions in NextJS

Enhancing MUI themes by incorporating module augmentation for multiple typings

The TypeScript error "Issue with Type Assertion: 'This expression is not callable Type'...' has no call signatures" occurs when there is a missing semicolon

What is the best way to display toasts in React server components?

Issue with setting cookies in Node.js using Express

Utilizing Vue class-style components for creating a recursive component

Do I still need to include getStaticPaths if I am already utilizing Link within the HTML in getStaticProps?

Generate types based on properties of a nested interface dynamically

Leveraging the power of react-hook-form in combination with the latest version 6 of @mui

Avoiding the pitfalls of hierarchical dependency injection in Angular 6

Opening a modal in Angular2+ when selecting an item from ngx-chips (tag-input)

What are the steps for creating a TypeScript version of a custom CKEditor5 build?

Classify the array types based on their indexes within the map

Is it possible to utilize the router.query feature in a function within Next.js?