マスター
マスターサービスは、マルチテナント環境でのマスターデータと設定の管理機能を提供します。
概要
マスターサービスは2つの主要コンポーネントで構成されています。
Master Setting Service
- 階層的な設定管理を実装
- すべてのレベルでの設定作成をサポート
- テナント設定の更新および削除操作を提供
- 階層的な設定取得を実装
マスターデータサービス
- マスターデータエンティティのCRUD操作を実装
- リストおよび取得機能を提供
- コード検証機能を含む
- テナント間のデータ整合性を確保
インストール
npm install @mbc-cqrs-serverless/master
基本的な使い方
MasterModule
の動作をカスタマイズするには、静的な register()
メソッドでオプションの object
を渡します。オプションオブジェクトには1つのプロパティのみが含まれます:
enableController
: デフォルトのマスターコントローラーを有効または無効にします。
import { MasterModule } from '@mbc-cqrs-serverless/master'
@Module({
imports: [ MasterModule.register({
enableController: true,
})],
controllers: [],
exports: [],
})
APIリファレンス
マスター設定サービス
MasterSettingService インターフェースは、ユーザー、グループ、テナント、共通のさまざまなレベルで設定を管理します。設定の取得、更新、作成、削除を可能にします。
getSetting(dto: GetSettingDto, context: { invokeContext: IInvoke }): Promise<MasterSettingEntity>
指定された設定コードに基づいて特定の設定を取得します。
const masterSetting = await this.masterSettingService.getSetting(
{
code: "service",
}
);
createCommonTenantSetting(dto: CommonSettingDto, context: { invokeContext: IInvoke }): Promise<CommandModel>
システム全体で共有される共通のテナント設定を作成します。
const masterSetting = await this.masterSettingService.createGroupSetting(
{
name: "common setting",
code: "service",
settingValue: {
region: "US",
plan: "common"
}
});
createTenantSetting(dto: TenantSettingDto, context: { invokeContext: IInvoke }): Promise<CommandModel>
テナント固有の設定を作成します。
const masterSetting = await this.masterSettingService.createGroupSetting(
{
name: "tenant setting",
code: "service",
tenantCode: "mbc",
settingValue: {
region: "US",
plan: "tenant"
}
});
createGroupSetting(dto: GroupSettingDto, context: { invokeContext: IInvoke }): Promise<CommandModel>
テナント内でグループ固有の設定を作成します。
const masterSetting = await this.masterSettingService.createGroupSetting(
{
name: "group setting",
code: "service",
tenantCode: "mbc",
groupId: "12",
settingValue: {
region: "US",
plan: "USER"
}
});
createUserSetting(dto: UserSettingDto, context: { invokeContext: IInvoke }): Promise<CommandModel>
テナント内でユーザー固有の設定を作成します。
const masterSetting = await this.masterSettingService.createUserSetting(
{
name: "user setting",
code: "service",
tenantCode: "mbc",
userId: "92ca4f68-9ac6-4080-9ae2-2f02a86206a4",
settingValue: {
region: "US",
plan: "USER"
}
});
updateSetting(params: DetailKey, dto: UpdateSettingDto, context: { invokeContext: IInvoke }): Promise<CommandModel>
既存の設定を更新します。
const masterSetting = await this.masterSettingService.updateSetting(
{
pk:"MASTER#abc",
sk:"MASTER_SETTING#service"
},
{
name: 'Example Master Setting',
settingValue: {
homepage: "url",
desc: "string"
}
});
deleteSetting(key: DetailKey, context: { invokeContext: IInvoke }): Promise<CommandModel>
指定されたキーに基づいて特定の設定を削除します。
const masterSetting = await this.masterSettingService.deleteSetting(
{
pk:"MASTER#abc",
sk:"MASTER_SETTING#service"
}
);
マスターデータサービス
MasterDataService サービスは、マスターデータと操作を管理するためのメソッドを提供します。これには、リスト、取得、作成、更新、削除、および特定のコードの存在確認が含まれます。
list( searchDto: MasterDataSearchDto): Promise<MasterDataListEntity>
指定された検索条件に基づいてマスターデータをリストします。
const masterData = await this.masterDataService.list(
{
tenantCode: "mbc",
settingCode: "service"
}
);
get(key: DetailDto): Promise<MasterDataEntity>
主キー (pk) およびソートキー (sk) によるマスターデータの取得。
const masterData = await this.masterDataService.get(
{
pk:"MASTER#abc",
sk:"MASTER_DATA#service#01"
}
);
create(data: CreateMasterDataDto, context: { invokeContext: IInvoke })
新しいマスターデータエンティティを作成します。
const masterData = await this.masterDataService.create({
code: 'MASTER001',
name: 'Example Master Data',
settingCode: "service",
tenantCode: "COMMON",
attributes: {
homepage: "http://mbc.com",
desc: "description for mbc"
}
});
update(key: DetailDto, updateDto: UpdateDataSettingDto, context: { invokeContext: IInvoke })
既存のマスターデータを更新します。
const masterData = await this.masterDataService.update(
{
pk:"MASTER#abc",
sk:"MASTER_DATA#service#01"
},
{
name: 'Example Master Data',
attributes: {
homepage: "http://mbc.com",
desc: "description for mbc"
}
});
delete(key: DetailDto, opts: { invokeContext: IInvoke })
指定されたキーに基づいて特定のマスターデータを削除します。
const masterData = await this.masterDataService.delete(
{
pk:"MASTER#abc",
sk:"MASTER_DATA#service#01"
}
);
checkExistCode(tenantCode: string, type: string, code: string)
指定されたテナントとタイプ内で特定のコードが存在するかどうかを確認します。
const masterData = await this.masterDataService.checkExistCode("mbc", "service", "01");