@clikvn/showroom-visualizer 0.3.0-dev-07 → 0.3.0-dev-08

package/Planning/TEMPLATE.md

@@ -1,270 +0,0 @@
-# [Feature Name]
-
-> **Status:** Planning | In Progress | Completed
-> **Version:** 0.x.0
-> **Last Updated:** YYYY-MM-DD
-
-## Overview
-
-Brief description of what this feature does and why it's needed.
-
-**Key Benefits:**
-
-- Benefit 1
-- Benefit 2
-- Benefit 3
-
-## Quick Start
-
-```typescript
-// Basic usage example
-import ShowroomVisualizer from '@clikvn/showroom-visualizer';
-
-ShowroomVisualizer.initVisualizer({
-  apiHost: 'https://api.example.com',
-  config: { tourCode: 'TOUR_123' },
-
-  // Feature-specific configuration
-  featureName: {
-    option1: 'value1',
-    option2: true,
-  },
-});
-```
-
-## Requirements
-
-### Functional Requirements
-
-- [ ] Requirement 1
-- [ ] Requirement 2
-- [ ] Requirement 3
-
-### Non-Functional Requirements
-
-- [ ] Performance: [target metrics]
-- [ ] Backward compatibility: [yes/no and details]
-- [ ] Browser support: [supported browsers]
-
-## API Reference
-
-### Types
-
-```typescript
-/**
- * Description of the type
- */
-export interface FeatureType {
-  /** Description */
-  property1: string;
-  /** Description */
-  property2?: number;
-}
-
-/**
- * Description of the function type
- */
-export type FeatureCallback = (param: FeatureType) => void;
-```
-
-### Configuration Options
-
-| Option    | Type      | Required | Default | Description |
-| --------- | --------- | -------- | ------- | ----------- |
-| `option1` | `string`  | Yes      | -       | Description |
-| `option2` | `boolean` | No       | `false` | Description |
-| `option3` | `number`  | No       | `100`   | Description |
-
-### Methods
-
-#### `methodName(param: Type): ReturnType`
-
-Description of what the method does.
-
-**Parameters:**
-
-- `param` (Type) - Description
-
-**Returns:**
-
-- `ReturnType` - Description
-
-**Example:**
-
-```typescript
-const result = tool.methodName('value');
-```
-
-## Architecture
-
-### Component Hierarchy
-
-```
-ShowroomVisualizer
-├── FeatureComponent
-│   ├── SubComponent1
-│   └── SubComponent2
-└── AnotherComponent
-```
-
-### Data Flow
-
-```
-User Action → Component → Hook → Model → State Update → UI Render
-```
-
-### Key Files
-
-- `src/types/SkinLayer/feature.type.ts` - Type definitions
-- `src/hooks/useFeature.ts` - Custom hook
-- `src/components/FeatureComponent/index.tsx` - Main component
-- `src/models/Feature.ts` - Business logic model
-
-### Integration Points
-
-1. **Configuration Provider**: How the feature integrates with configuration
-2. **State Management**: Which state it manages
-3. **Event System**: What events it listens to/dispatches
-
-## Implementation Plan
-
-### Phase 1: Core Implementation
-
-- [ ] Create type definitions
-- [ ] Implement core hook
-- [ ] Add component integration
-- [ ] Unit tests
-
-### Phase 2: UI Integration
-
-- [ ] Add UI components
-- [ ] Style implementation
-- [ ] Mobile responsiveness
-- [ ] Integration tests
-
-### Phase 3: Documentation & Release
-
-- [ ] API documentation
-- [ ] Usage examples
-- [ ] Migration guide (if breaking changes)
-- [ ] Update CHANGELOG
-
-## Usage Examples
-
-### Example 1: Basic Usage
-
-```typescript
-import ShowroomVisualizer from '@clikvn/showroom-visualizer';
-
-ShowroomVisualizer.initVisualizer({
-  apiHost: 'https://api.example.com',
-  config: { tourCode: 'TOUR_123' },
-  feature: {
-    // configuration
-  },
-});
-```
-
-### Example 2: Advanced Usage
-
-```typescript
-// More complex example
-```
-
-### Example 3: Integration with Other Features
-
-```typescript
-// Example showing how it works with other features
-```
-
-## Error Handling
-
-### Common Errors
-
-| Error Code | Description | Solution   |
-| ---------- | ----------- | ---------- |
-| `ERR_001`  | Description | How to fix |
-| `ERR_002`  | Description | How to fix |
-
-### Best Practices
-
-- Best practice 1
-- Best practice 2
-- Best practice 3
-
-## Performance Considerations
-
-- Performance note 1
-- Performance note 2
-- Benchmark: [metrics]
-
-## Browser Compatibility
-
-| Browser | Minimum Version | Notes           |
-| ------- | --------------- | --------------- |
-| Chrome  | 90+             | Fully supported |
-| Firefox | 88+             | Fully supported |
-| Safari  | 14+             | Fully supported |
-| Edge    | 90+             | Fully supported |
-
-## Migration Guide
-
-### From Version X to Y
-
-If this feature introduces breaking changes:
-
-**Breaking Changes:**
-
-1. Change 1
-2. Change 2
-
-**Migration Steps:**
-
-```typescript
-// Before
-oldApi();
-
-// After
-newApi();
-```
-
-## Testing
-
-### Unit Tests
-
-- Test case 1
-- Test case 2
-
-### Integration Tests
-
-- Test case 1
-- Test case 2
-
-### Manual Testing Checklist
-
-- [ ] Test scenario 1
-- [ ] Test scenario 2
-- [ ] Test on mobile
-- [ ] Test on desktop
-
-## FAQ
-
-**Q: Question 1?**
-A: Answer 1
-
-**Q: Question 2?**
-A: Answer 2
-
-## References
-
-- [Related documentation](link)
-- [External resource](link)
-- [API specification](link)
-
-## Changelog
-
-### Version 0.x.0 (YYYY-MM-DD)
-
-- Initial implementation
-- Feature 1 added
-- Bug fix 1