Blog Post With Categories Example

ℹ️

This page haven't been written yet. Help us write it by contributing!

In this example we will create a Category Entity for our Blog Post Entity and it'll consist of the following fields:

Slug (blog-post-category url / unique id)
Name
Description
Image

Reminder: The fields we just presented are just an example, you can customize them and add your own as you wish.

Blog Post Example Steps

ℹ️

IMPORTANT: Before starting this tutorial / example we assume you have alreaady completed the Blog Post Example.

Create Blog Post Category Entity

Start by creating a new blog-post-category.ts file under src/models directory. And add to it the censsary fields.

src/models/blog-post-category.ts

import { Column, Entity, BeforeInsert } from "typeorm";
 
import { BaseEntity, generateEntityId } from "@medusajs/medusa";
 
@Entity()
export default class BlogPostCategory extends BaseEntity {
  @Column({ type: "string", nullable: false, unique: true })
  slug: string;
 
  @Column({ type: "string"})
  name: string;
 
  @Column({ type: "string" })
  description: string;
 
  @Column({ type: "string" })
  image: string;
 
  @BeforeInsert()
  private beforeInsert(): void {
    this.id = generateEntityId(this.id, "blog-post-category");
  }
}

Add Ultimate Decorators to BlogPostCategory Entity

This decorators will tell to the plugin what UI to generate for your entity.

src/models/blog-post-category.ts

import { Column, Entity, BeforeInsert } from "typeorm";
 
import { BaseEntity, generateEntityId } from "@medusajs/medusa";
 
import {
  UltimateEntity,
  UltimateEntityField,
  UltimateEntityFieldTypes,
} from "medusa-plugin-ultimate/dist/index";
 
@Entity()
@UltimateEntity({})
export default class BlogPostCategory extends BaseEntity {
  @UltimateEntityField({
    type: UltimateEntityFieldTypes.STRING,
  })
  @Column({ type: "string", nullable: false, unique: true })
  slug: string;
 
  @UltimateEntityField({
    type: UltimateEntityFieldTypes.STRING,
  })
  @Column({ type: "string"})
  name: string;
 
  @UltimateEntityField({
    type: UltimateEntityFieldTypes.TEXT,
  })
  @Column({ type: "string" })
  description: string;
 
  @UltimateEntityField({
    type: UltimateEntityFieldTypes.IMAGE,
  })
  @Column({ type: "string" })
  image: string;
 
  @BeforeInsert()
  private beforeInsert(): void {
    this.id = generateEntityId(this.id, "blog-post-category");
  }
}

Link BlogPost and BlogPostCategory Entities

If you correctly followed the Blog Post Example Tutorial you should have a blog-post.ts file under the src/models directory.

We will open it and add the following code to it:

src/models/blog-post.ts

import {
  UltimateEntityRelation,
  UltimateEntityRelationTypes,
} from "medusa-plugin-ultimate/dist/index";
 
import BlogPostCategory from "./blog-post-category.ts";
 
export default class BlogPost extends BaseEntity {
 
  // other fields..
 
  @Column({ type: "varchar", nullable: true })
  category_id?: string | null;
 
  @UltimateEntityRelation({
    type: UltimateEntityRelationTypes.MANY_TO_ONE_RELATION_SELECT,
    relationEntityId: "blog_post_category",
    relationEntityPropertyName: "blogPosts",
  })
  @ManyToOne(() => BlogPostCategory)
  @JoinColumn({
    name: "category_id",
    referencedColumnName: "id",
  })
  category?: BlogPostCategory | null;
 
  // other fields..
 
}