npm - @umituz/react-native-settings - Versions diffs - 4.20.61 → 4.21.1 - Mend

@umituz/react-native-settings 4.20.61 → 4.21.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (78) hide show

package/CODE_OF_CONDUCT.md DELETED Viewed

@@ -1,75 +0,0 @@
-# Code of Conduct
-## Our Pledge
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-## Our Standards
-### Positive Behavior
-- Using welcoming and inclusive language
-- Being respectful of differing viewpoints and experiences
-- Gracefully accepting constructive criticism
-- Focusing on what is best for the community
-- Showing empathy towards other community members
-### Unacceptable Behavior
-- The use of sexualized language or imagery
-- Trolling, insulting or derogatory comments
-- Personal or political attacks
-- Public or private harassment
-- Publishing others' private information
-- Other unethical or unprofessional conduct
-## Our Responsibilities
-Project maintainers are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-Project maintainers have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, or to ban temporarily or permanently any
-contributor for other behaviors that they deem inappropriate, threatening,
-offensive, or harmful.
-## Scope
-This Code of Conduct applies within all project spaces, and it also applies when
-an individual is officially representing the project or its community in public
-spaces. Examples of representing a project or community include using an official
-project e-mail address, posting via an official social media account, or acting
-as an appointed representative at an online or offline event.
-## Enforcement
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the project team at umit@umituz.com. All complaints will be reviewed
-and investigated and will result in a response that is deemed necessary and
-appropriate to the circumstances. The project team is obligated to maintain
-confidentiality with regard to the reporter of an incident.
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-## Attribution
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-[homepage]: https://www.contributor-covenant.org
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq

package/CONTRIBUTING.md DELETED Viewed

@@ -1,107 +0,0 @@
-# Contributing to @umituz/react-native-settings
-Thank you for your interest in contributing to this package! This document provides guidelines for contributing.
-## Purpose
-This document guides contributors on how to effectively participate in the development of `@umituz/react-native-settings`, ensuring code quality, consistency, and maintainability.
-## How to Contribute
-### Reporting Issues
-Before creating issues:
-- Check existing issues for duplicates
-- Use clear, descriptive titles
-- Provide reproduction steps
-- Include environment details (React Native version, platform, etc.)
-- Add screenshots for UI issues
-### Submitting Pull Requests
-1. Fork the repository
-2. Create a feature branch (`git checkout -b feature/amazing-feature`)
-3. Make your changes following our guidelines
-4. Write tests for new functionality
-5. Ensure all tests pass
-6. Commit your changes (`git commit -m 'Add amazing feature'`)
-7. Push to the branch (`git push origin feature/amazing-feature`)
-8. Open a Pull Request
-## Development Workflow
-### Getting Started
-1. Clone the repository
-2. Install dependencies: `npm install`
-3. Run type checking: `npm run typecheck`
-4. Run linting: `npm run lint`
-### Code Style
-Follow the existing code style:
-- Use TypeScript strict mode
-- Follow naming conventions
-- Add JSDoc comments for public APIs
-- Use meaningful variable names
-- Keep functions focused and small
-### Testing
-- Write unit tests for new features
-- Maintain test coverage above 80%
-- Test error conditions
-- Include accessibility tests
-- Update documentation for changes
-## Project Structure
-```
-src/
-├── domains/              # Feature domains
-├── presentation/         # UI layer
-├── application/          # Interfaces
-└── infrastructure/       # Data layer
-```
-Follow Domain-Driven Design principles when adding features.
-## Documentation
-All documentation must follow the new format:
-- No code examples
-- Use file paths instead
-- Include Purpose, File Paths, Strategy sections
-- Add Restrictions with ❌ markers
-- Add Rules with ✅ markers
-- Include AI Agent Guidelines
-See `DOCUMENTATION_TEMPLATE.md` for the template.
-## Commit Messages
-Use clear, descriptive commit messages:
-- `feat:` - New features
-- `fix:` - Bug fixes
-- `docs:` - Documentation changes
-- `refactor:` - Code refactoring
-- `test:` - Adding/updating tests
-- `chore:` - Maintenance tasks
-Example: `feat(appearance): add custom color palette support`
-## Code Review Process
-1. All PRs require review
-2. Address review feedback
-3. Ensure CI checks pass
-4. Update documentation as needed
-5. Squash commits if necessary
-## Questions?
-Feel free to open an issue for questions or discussions.
-## License
-By contributing, you agree that your contributions will be licensed under the MIT License.

package/DOCUMENTATION_MIGRATION.md DELETED Viewed

@@ -1,319 +0,0 @@
-# Documentation Migration Summary
-## New Documentation Format
-All documentation has been migrated to a **code-example-free**, **strategy-based** format.
-## Key Changes
-### ❌ Removed
-- All code examples
-- Code snippets
-- Inline code blocks
-- Implementation examples
-### ✅ Added
-- **Strategy Section**: How to use effectively
-- **Restrictions Section**: What NOT to do (with ❌ markers)
-- **Rules Section**: What MUST be done (with ✅ markers)
-- **AI Agent Guidelines**: Specific instructions for AI coding
-- **File Path References**: Exact paths to implementation
-## Documentation Template
-Every README now follows this structure:
-```markdown
-# [Component Name]
-## Purpose
-[Brief description]
-## File Path
-`src/path/to/File.tsx`
-## Imports
-[Import statements]
-## Strategy
-- [Strategic point 1]
-- [Strategic point 2]
-## Restrictions (Forbidden)
-### ❌ DO NOT
-- [What to avoid]
-### ❌ NEVER
-- [Critical restrictions]
-### ❌ AVOID
-- [Common mistakes]
-## Rules
-### ✅ ALWAYS
-- [Mandatory requirements]
-### ✅ MUST
-- [Critical rules]
-### ✅ SHOULD
-- [Recommended practices]
-## AI Agent Guidelines
-[Specific AI instructions]
-## Related Components
-- [Component]: [File path]
-```
-## Updated Documentation
-### ✅ Completed
-1. **Main README** (`README.md`)
-   - Package overview
-   - Strategy, Restrictions, Rules
-   - Component file references
-   - AI guidelines
-2. **Documentation Template** (`DOCUMENTATION_TEMPLATE.md`)
-   - Standard template for all docs
-   - Philosophy explanation
-3. **AI Guidelines** (`AI_AGENT_GUIDELINES.md`)
-   - Comprehensive AI coding rules
-   - File reference patterns
-   - Component creation checklist
-4. **Settings Screen Guide** (`SETTINGS_SCREEN_GUIDE.md`)
-   - Screen strategy
-   - Configuration patterns
-   - Restrictions and rules
-5. **SettingsItemCard Strategy** (`src/presentation/components/SettingsItemCard/STRATEGY.md`)
-   - Component-specific strategy
-   - Usage guidelines
-   - AI instructions
-### 🔄 In Progress (Background Tasks)
-Three background tasks are updating:
-**Task 1: Domain READMEs** (10 files)
-- src/domains/about/README.md
-- src/domains/appearance/README.md
-- src/domains/legal/README.md
-- src/domains/disclaimer/README.md
-- src/domains/feedback/README.md
-- src/domains/faqs/README.md
-- src/domains/rating/README.md
-- src/domains/video-tutorials/README.md
-- src/domains/cloud-sync/README.md
-- src/domains/dev/README.md
-**Task 2: Component READMEs** (14 files)
-- src/presentation/components/SettingsSection/README.md
-- src/presentation/components/SettingsErrorBoundary/README.md
-- src/presentation/components/SettingsFooter/README.md
-- src/presentation/screens/README.md
-- src/presentation/screens/components/SettingsHeader/README.md
-- src/presentation/screens/components/SettingsContent/README.md
-- src/presentation/screens/hooks/README.md
-- src/presentation/screens/utils/README.md
-- src/presentation/screens/types/README.md
-- src/presentation/hooks/README.md
-- src/presentation/navigation/README.md
-- src/presentation/navigation/components/README.md
-- src/presentation/navigation/hooks/README.md
-- src/presentation/navigation/utils/README.md
-**Task 3: Remaining READMEs** (15+ files)
-- src/application/README.md
-- src/infrastructure/README.md
-- src/presentation/hooks/mutations/README.md
-- src/presentation/hooks/queries/README.md
-- All domain component READMEs
-- All section component READMEs
-- And more...
-## Documentation Philosophy
-### Why No Code Examples?
-**Problem**: Code examples become outdated when implementation changes
-**Solution**: Reference file paths that stay stable
-**Benefits:**
-1. ✅ Documentation stays valid when code changes
-2. ✅ Developers check current implementation
-3. ✅ No maintenance overhead
-4. ✅ Always accurate
-5. ✅ AI-friendly
-### Why Strategy/Restrictions/Rules?
-**Strategy**: High-level guidance
-- When to use component
-- How to integrate it
-- Best practices
-- Common patterns
-**Restrictions (Forbidden)**: Clear anti-patterns
-- ❌ DO NOT: Common mistakes
-- ❌ NEVER: Critical restrictions
-- ❌ AVOID: Performance issues
-**Rules**: Mandatory requirements
-- ✅ ALWAYS: Required practices
-- ✅ MUST: Critical rules
-- ✅ SHOULD: Recommendations
-### Why AI-Friendly?
-AI agents need:
-- Clear guidelines
-- File paths to reference
-- Rules to follow
-- No outdated code examples
-- Specific restrictions
-- Mandatory requirements
-## File Reference Pattern
-### Old Way (Outdated)
-```tsx
-// Code example that becomes stale
-<SettingsItemCard icon="settings" title="Settings" />
-```
-### New Way (Always Valid)
-```markdown
-## File Path
-`src/presentation/components/SettingsItemCard/SettingsItemCard.tsx`
-## Strategy
-Use SettingsItemCard for ALL settings items
-## Restrictions
-❌ DO NOT create custom items
-## Rules
-✅ MUST provide icon and title props
-```
-## AI Agent Workflow
-When AI agent implements features:
-1. **Read Documentation**
-   - Check README for strategy
-   - Understand restrictions
-   - Know the rules
-2. **Reference Implementation**
-   - Open file path from docs
-   - Check current implementation
-   - Follow patterns
-3. **Follow Guidelines**
-   - Adhere to restrictions
-   - Apply rules
-   - Use existing components
-4. **No Guessing**
-   - File paths show exactly where to look
-   - Strategy shows how to use
-   - Rules show what to do
-## Migration Checklist
-For each documentation file:
-- [x] Remove all code examples
-- [x] Add file path section
-- [x] Add imports section
-- [x] Add strategy section
-- [x] Add restrictions section
-- [x] Add rules section
-- [x] Add AI guidelines section
-- [x] Update related components with file paths
-- [x] Keep in English
-- [x] Follow standard template
-## Benefits
-### For Developers
-- Always accurate documentation
-- Clear guidelines on what to do/not do
-- File paths for quick reference
-- Strategy-based approach
-### For AI Agents
-- Clear coding rules
-- Specific restrictions
-- Mandatory requirements
-- File paths to reference
-- No outdated examples to confuse
-### For Maintainers
-- No code example maintenance
-- Documentation stays valid
-- Easy to update strategies
-- Clear rules for new features
-## Next Steps
-### For New Documentation
-1. Use `DOCUMENTATION_TEMPLATE.md`
-2. Follow structure
-3. No code examples
-4. Strategy-focused
-5. File path references
-### For Existing Documentation
-1. Background tasks updating all READMEs
-2. Removing code examples
-3. Adding strategy/restrictions/rules
-4. Maintaining file references
-### For AI Coding
-1. Read `AI_AGENT_GUIDELINES.md`
-2. Check component STRATEGY.md files
-3. Follow restrictions and rules
-4. Reference implementation files
-5. Use existing components
-## Quality Assurance
-### Documentation Quality
-- ✅ No code examples
-- ✅ Clear file paths
-- ✅ Strategy sections
-- ✅ Restrictions with ❌ markers
-- ✅ Rules with ✅ markers
-- ✅ AI guidelines
-- ✅ All in English
-- ✅ Consistent format
-### Validation
-Check each README has:
-- Purpose section
-- File path section
-- Strategy section (3+ points)
-- Restrictions section with subsections
-- Rules section with subsections
-- AI guidelines section
-- Related components with file paths
-## Status
-- ✅ Main README updated
-- ✅ Template created
-- ✅ AI guidelines created
-- 🔄 Domain READMEs updating (background)
-- 🔄 Component READMEs updating (background)
-- 🔄 Remaining READMEs updating (background)
-All documentation is being migrated to the new format systematically!

package/DOCUMENTATION_TEMPLATE.md DELETED Viewed

@@ -1,155 +0,0 @@
-# Documentation Template
-Standard template for all `@umituz/react-native-settings` documentation.
-## Structure
-Each documentation file MUST include these sections:
-1. **Purpose** - What this component/module does
-2. **File Path** - Where to find the implementation
-3. **Imports** - What to import and from where
-4. **Strategy** - How to use it effectively
-5. **Restrictions** - What NOT to do (Forbidden)
-6. **Rules** - What MUST be followed
-7. **Related Components** - Related files and components
-## Example Template
-```markdown
-# [Component/Module Name]
-## Purpose
-[Brief description of what this does]
-## File Path
-`src/path/to/file.tsx`
-## Imports
-```typescript
-import { ComponentName } from '@umituz/react-native-settings';
-// OR
-import { ComponentName } from '../../path/to/file';
-```
-## Strategy
-- [Strategic point 1]
-- [Strategic point 2]
-- [Best practices]
-## Restrictions (Forbidden)
-- ❌ **DO NOT**: [What to avoid]
-- ❌ **NEVER**: [Critical restrictions]
-- ❌ **AVOID**: [Common mistakes]
-## Rules
-- ✅ **ALWAYS**: [Mandatory requirements]
-- ✅ **MUST**: [Critical rules]
-- ✅ **SHOULD**: [Recommended practices]
-## Related Components
-- **ComponentName**: Path/to/component
-- **ModuleName**: Path/to/module
-## AI Agent Guidelines
-When working with this component:
-1. [AI instruction 1]
-2. [AI instruction 2]
-3. [AI instruction 3]
-```
-## Philosophy
-### Why No Code Examples?
-**Problem**: Code examples become outdated when implementation changes
-**Solution**: Reference file paths that stay stable
-### Why Strategy/Restrictions/Rules?
-**Strategy**: High-level approach and best practices
-**Restrictions**: Clear anti-patterns to avoid
-**Rules**: Mandatory requirements for consistency
-### Why AI-Friendly?
-AI agents need:
-- Clear guidelines on what to do/not do
-- File paths to reference
-- Rules to follow
-- No outdated code examples to confuse them
-## Sections Explained
-### Purpose
-Single sentence describing what the component does.
-### File Path
-Exact path to the main implementation file.
-### Imports
-Show import statements (these rarely change).
-### Strategy
-High-level guidance:
-- When to use this component
-- How to integrate it
-- Best practices
-- Common patterns
-### Restrictions (Forbidden)
-What NOT to do:
-- ❌ Clear anti-patterns
-- ❌ Common mistakes
-- ❌ Performance issues to avoid
-- ❌ Security concerns
-### Rules
-What MUST be done:
-- ✅ Mandatory requirements
-- ✅ Consistency rules
-- ✅ Error handling requirements
-- ✅ TypeScript usage rules
-### Related Components
-Cross-references to related files.
-### AI Agent Guidelines
-Specific instructions for AI agents:
-- How to generate code for this component
-- What patterns to follow
-- What to avoid
-## Usage Pattern
-Instead of:
-```tsx
-// BAD: Code example that becomes outdated
-<SettingsItemCard icon="settings" title="Settings" />
-```
-Use:
-```markdown
-## File Path
-`src/presentation/components/SettingsItemCard/SettingsItemCard.tsx`
-## Strategy
-Use SettingsItemCard for all settings list items. Reference the implementation file for current props and usage patterns.
-## Restrictions
-- ❌ DO NOT create custom item cards - use SettingsItemCard
-- ❌ NEVER inline settings logic - keep in separate components
-## Rules
-- ✅ ALWAYS use SettingsItemCard from components
-- ✅ MUST pass required props: icon, title
-- ✅ SHOULD provide onPress handler for navigation
-```
-This approach:
-- Stays valid when code changes
-- Provides clear guidance
-- Easy to maintain
-- AI-friendly