← All Plugins/ORM & Data Modeling/v0.1.0Official

Veap Categorizable

Polymorphic categorization trait for Veap Models with category hierarchies, slug resolution, and multilingual category support.

bun add @veap/categorizable

[See clean architecture layers, Knex migrations & configuration below]

Purpose & Overview

Adds polymorphic morphToMany category relations, query scopes (whereCategory, whereInCategories), and automatic slug lookups to any Model.

Installation & Setup

Install the package

bash

bun add @veap/categorizable

Apply trait to your domain Model

models/YourModel.ts

typescript

// models/Article.ts
import { Model } from "@veap/database";
import { Categorizable } from "@veap/categorizable";

export class Article extends Categorizable(Model) {
  static table = "articles";
}

// Querying with category scopes:
const articles = await Article.query()
  .whereCategory("technology")
  .withCategories()
  .get();

Start application

bash

bun dev

Migrations run automatically on boot via MigrationServiceProvider.

Keep in mind

Uses a polymorphic `morphToMany` relation with the `categorizables` table.
Provides query scopes: `whereCategory('tech')` and `whereInCategories(['tech', 'design'])`.
Supports automated category name translations when integrated with @veap/translatable.