Module lifecycle

Backend plugin pack / load / teardown — @Module နှင့် lifecycle hook များ (@OnInit, @OnAllModuleLoaded, @OnUninstall)။

IPlugin entry

backend/src/index.ts သည် IPlugin ကို implement လုပ်သော class ကို default-export လုပ်ရပါသည်။ Root @Module class နှင့် module.metadata.json မှ metadata ကို ပြန်ပေးပါသည်။

TSXbackend/src/index.ts

import type { IPlugin, PluginMetadata } from "@quan-erp/shared-types";
import metadata from "../module.metadata.json" with { type: "json" };
import { MyPluginModule } from "./my-plugin.module.js";

export default class MyPlugin implements IPlugin {
  getRootModule() { return MyPluginModule; }
  getName() { return metadata.name; }
  getVersion() { return metadata.pluginVersion; }
  getMetadata() { return metadata as PluginMetadata; }
}

Root @Module

Providers၊ controllers၊ entities (plugin: "default") နှင့် optional websocket handler များကို မှတ်ပုံတင်ရပါသည်။ Module-level cache အတွက် @Cache နှင့် တွဲသုံးနိုင်ပါသည်။ Lifecycle hook များကို များသောအားဖြင့် ဤ class (သို့မဟုတ် @Service) ပေါ်တွင် ထားရှိရပါသည်။

@Module({ name, providers, controllers, entities, websocket? })
@Cache(options) — in-memory သို့မဟုတ် redis; @Module class ပေါ်တွင်သာ

TSXmodule

import { Cache, Module } from "@quan-erp/shared-backend-core";
import metadata from "../../module.metadata.json" with { type: "json" };
import { ChatWebsocket } from "./chat.websocket.js";
import { MyController } from "./my.controller.js";
import { MyEntity } from "./my.entity.js";
import { MyService } from "./my.service.js";

@Module({
  name: metadata.name,
  providers: [MyService],
  controllers: [MyController],
  entities: [{ plugin: "default", entities: [MyEntity] }],
  websocket: [ChatWebsocket],
})
@Cache({ type: "in-memory", checkperiod: 1000 })
export class MyPluginModule {}

Lifecycle annotations

Boot နှင့် teardown အတွက် hook သုံးခု ရှိပါသည်။ Root @Module (သို့မဟုတ် DI-managed @Service) ပေါ်ရှိ method များတွင် အသုံးပြုရပါသည်။

@OnInit() — ဤ module/service အဆင်သင့်; seed / local setup
@OnAllModuleLoaded() — module အားလုံး @OnInit ပြီး; workers၊ cron listeners၊ cross-plugin
@OnUninstall() — plugin ဖယ်ရှားချိန်; queue/worker cleanup

@OnInit

Host module သို့မဟုတ် service အပြည့်အစုံ initialize ပြီးနောက် တစ်ကြိမ် အလုပ်လုပ်ပါသည်။ Default settings / seed အတွက် သင့်တော်ပါသည်။ Cross-plugin worker များကို ဤနေရာတွင် မစရပါ — @OnAllModuleLoaded ကို အသုံးပြုရပါသည်။

TSX@OnInit on module

import {
  ContainerRegistryManager,
  DataSeedHistoryService,
  Inject,
  InjectBuiltinLogger,
  Module,
  OnInit,
} from "@quan-erp/shared-backend-core";
import type { Loggable } from "@quan-erp/shared-backend-core";
import metadata from "../../module.metadata.json" with { type: "json" };
import { MyService } from "./my.service.js";

@Module({
  name: metadata.name,
  providers: [MyService],
  controllers: [],
  entities: [],
})
export class MyPluginModule {
  @InjectBuiltinLogger()
  logger: Loggable;

  @Inject(DataSeedHistoryService, ContainerRegistryManager.BUILTIN_PLUGIN)
  dataSeedHistoryService: DataSeedHistoryService;

  @OnInit()
  async init() {
    const alreadySeeded = await this.dataSeedHistoryService.find(
      metadata.name,
      metadata.pluginVersion,
      "init",
    );
    if (alreadySeeded) {
      this.logger.log("Seeding skipped (already initialized)");
      return;
    }
    // … seed defaults …
    await this.dataSeedHistoryService.add({
      data: {
        pluginName: metadata.name,
        pluginVersion: metadata.pluginVersion,
        name: "init",
      },
    });
    this.logger.log("Module seeded successfully");
  }
}

TSX@OnInit on service

import { InjectBuiltinLogger, OnInit, Service } from "@quan-erp/shared-backend-core";
import type { Loggable } from "@quan-erp/shared-backend-core";

@Service()
export class CacheWarmupService {
  @InjectBuiltinLogger()
  logger: Loggable;

  @OnInit()
  async init() {
    this.logger.log("Warming local caches");
    // …
  }
}

@OnAllModuleLoaded

Installed module အားလုံး @OnInit ပြီးဆုံးပြီးနောက် တစ်ကြိမ် အလုပ်လုပ်ပါသည်။ Background worker၊ CronJobService listener သို့မဟုတ် အခြား plugin service လိုအပ်သော အလုပ်အတွက် အသုံးပြုရပါသည်။

TSX@OnAllModuleLoaded

import {
  ContainerRegistryManager,
  CronJobService,
  Inject,
  InjectBuiltinLogger,
  Module,
  OnAllModuleLoaded,
} from "@quan-erp/shared-backend-core";
import type { Loggable } from "@quan-erp/shared-backend-core";
import metadata from "../../module.metadata.json" with { type: "json" };
import { MaturedSweepService } from "./matured-sweep.service.js";

@Module({
  name: metadata.name,
  providers: [MaturedSweepService],
  controllers: [],
  entities: [],
})
export class MyPluginModule {
  @InjectBuiltinLogger()
  logger: Loggable;

  @Inject(CronJobService, ContainerRegistryManager.BUILTIN_PLUGIN)
  cronJobService: CronJobService;

  @Inject(MaturedSweepService)
  sweep: MaturedSweepService;

  @OnAllModuleLoaded()
  async onAllModuleLoaded() {
    this.logger.log("All modules loaded — attaching cron listeners");
    this.cronJobService.addEventListener(
      metadata.name,
      "matured-sweep",
      () => this.sweep.run(),
    );
  }
}

@OnUninstall

Plugin ကို system မှ uninstall လုပ်သောအခါ အလုပ်လုပ်ပါသည်။ @OnInit / @OnAllModuleLoaded တွင် စတင်ထားသော Redis/BullMQ worker၊ socket စသည်ကို ဖြတ်တောက်ရပါသည်။

TSX@OnUninstall

import {
  InjectBuiltinLogger,
  Module,
  OnUninstall,
} from "@quan-erp/shared-backend-core";
import type { Loggable } from "@quan-erp/shared-backend-core";
import metadata from "../../module.metadata.json" with { type: "json" };
import { BackgroundWorker } from "./background.worker.js";

@Module({
  name: metadata.name,
  providers: [BackgroundWorker],
  controllers: [],
  entities: [],
})
export class MyPluginModule {
  @InjectBuiltinLogger()
  logger: Loggable;

  private worker = new BackgroundWorker();

  @OnUninstall()
  async cleanup() {
    this.logger.log("Uninstalling — stopping worker");
    await this.worker.disconnect();
  }
}

Boot & teardown order

01
Installed plugin များကို စကင်ခြင်း
installed=true ရှိသော module များသာ installed-plugins မှ load ဖြစ်ပါသည်။
02
module.js ကို import လုပ်ခြင်း
IPlugin ကို instantiate လုပ်ပြီး getRootModule() ခေါ်ပါသည်။
03
DI + entities
Service များကို ချိတ်ဆက်ပြီး ဇယားများကို sync လုပ်ပါသည်။
04
@OnInit
Module/service အလိုက် init — seed နှင့် local setup။
05
@OnAllModuleLoaded
Cross-module hook — workers၊ cron listeners။
06
@OnUninstall
Plugin ဖယ်ရှားချိန် — resource cleanup။

Build lifecycle

quan-erp watch <plugin> (သို့မဟုတ် အချို့ repo တွင် quan-erp watch) ဖြင့် backend + frontend ကို base/available-plugins/ သို့ compile လုပ်ပြီး ERP UI မှ install လုပ်ရပါသည်။

Module lifecycle

IPlugin entry

Root @Module

Lifecycle annotations

@OnInit

@OnAllModuleLoaded

@OnUninstall

Boot & teardown order

Installed plugin များကို စကင်ခြင်း

module.js ကို import လုပ်ခြင်း

DI + entities

@OnInit

@OnAllModuleLoaded

@OnUninstall

Build lifecycle