@mbc-cqrs-serverless/ui-setting 0.1.49-beta.0 → 0.1.50-beta.0

package/README.md

@@ -2,9 +2,201 @@
 
 # MBC CQRS serverless framework UI Setting package
 
+## Description
+
+The UI Setting package manages user interface configuration and preferences in the MBC CQRS Serverless framework. It provides:
+
+- User interface configuration management
+- Theme and layout settings
+- User preferences storage
+- Multi-tenant UI customization
+- Dynamic UI configuration updates
+- Settings synchronization
+
+## Installation
+
+```bash
+npm install @mbc-cqrs-serverless/ui-setting
+```
+
+## Usage
+
+### Basic Setup
+
+1. Import and configure the UI Setting module:
+```typescript
+import { UiSettingModule } from '@mbc-cqrs-serverless/ui-setting';
+import { Module } from '@nestjs/common';
+
+@Module({
+  imports: [
+    UiSettingModule.forRoot({
+      tableName: 'ui-settings',
+      region: 'ap-northeast-1',
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### Managing Settings
+
+1. Define settings schema:
+```typescript
+import { SettingSchema } from '@mbc-cqrs-serverless/ui-setting';
+
+const themeSettings: SettingSchema = {
+  name: 'theme',
+  properties: {
+    mode: { type: 'string', enum: ['light', 'dark'] },
+    primaryColor: { type: 'string' },
+    fontSize: { type: 'number' },
+  },
+};
+```
+
+2. Use the settings service:
+```typescript
+import { SettingService } from '@mbc-cqrs-serverless/ui-setting';
+
+@Injectable()
+export class ThemeService {
+  constructor(
+    private readonly settingService: SettingService
+  ) {}
+
+  async getUserTheme(userId: string): Promise<ThemeSettings> {
+    return this.settingService.getUserSettings(userId, 'theme');
+  }
+
+  async updateUserTheme(
+    userId: string,
+    theme: ThemeSettings
+  ): Promise<void> {
+    await this.settingService.updateUserSettings(
+      userId,
+      'theme',
+      theme
+    );
+  }
+}
+```
+
+### Multi-tenant Configuration
+
+1. Manage tenant-level settings:
+```typescript
+@Injectable()
+export class TenantConfigService {
+  constructor(
+    private readonly settingService: SettingService
+  ) {}
+
+  @UseTenant()
+  async getTenantLayout(
+    @TenantContext() tenantId: string
+  ): Promise<LayoutSettings> {
+    return this.settingService.getTenantSettings(
+      tenantId,
+      'layout'
+    );
+  }
+}
+```
+
+### Dynamic Updates
+
+1. Listen for setting changes:
+```typescript
+import { SettingUpdateEvent } from '@mbc-cqrs-serverless/ui-setting';
+
+@EventsHandler(SettingUpdateEvent)
+export class SettingUpdateHandler implements IEventHandler<SettingUpdateEvent> {
+  async handle(event: SettingUpdateEvent): Promise<void> {
+    // Handle setting update
+    if (event.settingType === 'theme') {
+      await this.notifyThemeChange(event.userId);
+    }
+  }
+}
+```
+
+### User Preferences
+
+1. Manage user preferences:
+```typescript
+@Injectable()
+export class PreferenceService {
+  constructor(
+    private readonly settingService: SettingService
+  ) {}
+
+  async getUserPreferences(userId: string): Promise<UserPreferences> {
+    const [theme, layout, notifications] = await Promise.all([
+      this.settingService.getUserSettings(userId, 'theme'),
+      this.settingService.getUserSettings(userId, 'layout'),
+      this.settingService.getUserSettings(userId, 'notifications'),
+    ]);
+
+    return { theme, layout, notifications };
+  }
+}
+```
+
+### Layout Management
+
+1. Configure layout settings:
+```typescript
+@Injectable()
+export class LayoutService {
+  constructor(
+    private readonly settingService: SettingService
+  ) {}
+
+  async updateLayout(
+    userId: string,
+    layout: LayoutConfig
+  ): Promise<void> {
+    await this.settingService.updateUserSettings(
+      userId,
+      'layout',
+      {
+        sidebar: layout.sidebar,
+        toolbar: layout.toolbar,
+        content: layout.content,
+      }
+    );
+  }
+}
+```
+
+### Settings Synchronization
+
+1. Implement real-time updates:
+```typescript
+@WebSocketGateway()
+export class SettingGateway {
+  @SubscribeMessage('syncSettings')
+  async handleSync(
+    client: Socket,
+    userId: string
+  ): Promise<void> {
+    const settings = await this.settingService.getAllUserSettings(
+      userId
+    );
+    client.emit('settingsUpdate', settings);
+  }
+}
+```
+
 ## Documentation
 
-Visit https://mbc-cqrs-serverless.mbc-net.com/ to view the full documentation.
+Visit https://mbc-cqrs-serverless.mbc-net.com/ to view the full documentation, including:
+- Configuration options
+- Theme customization
+- Layout management
+- User preferences
+- API reference
 
 ## License
 

package/dist/helpers/index.d.ts

@@ -1,5 +1,5 @@
 export declare const MASTER_PK_PREFIX = "MASTER";
-export declare const SETTING_SK_PREFIX = "master_setting";
+export declare const SETTING_SK_PREFIX = "MASTER_SETTING";
 export declare function generateSettingPk(tenantCode: string): string;
 export declare function generateSettingSk(code: string): string;
 export declare function generateDataSettingSk(settingCode: string, code: string): string;

package/dist/helpers/index.js

@@ -8,7 +8,7 @@ exports.parseDataSettingSk = parseDataSettingSk;
 exports.parsePk = parsePk;
 const core_1 = require("@mbc-cqrs-serverless/core");
 exports.MASTER_PK_PREFIX = 'MASTER';
-exports.SETTING_SK_PREFIX = 'master_setting';
+exports.SETTING_SK_PREFIX = 'MASTER_SETTING';
 function generateSettingPk(tenantCode) {
     return `${exports.MASTER_PK_PREFIX}${core_1.KEY_SEPARATOR}${tenantCode}`;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mbc-cqrs-serverless/ui-setting",
-  "version": "0.1.49-beta.0",
+  "version": "0.1.50-beta.0",
   "description": "Setting master data",
   "keywords": [
     "mbc",
@@ -15,7 +15,7 @@
     "fargate",
     "step-functions",
     "sqs",
-    "typpescript"
+    "typescript"
   ],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -41,7 +41,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@mbc-cqrs-serverless/core": "^0.1.49-beta.0"
+    "@mbc-cqrs-serverless/core": "^0.1.50-beta.0"
   },
-  "gitHead": "4fb13a54044022d4423830c985b51dd8ec58259a"
+  "gitHead": "d61475400eb1b00a1c427769875d2f056e48c73c"
 }