pinia-plugin-subscription 0.0.3 → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-08-07
+
+### Added
+- **Core Plugin System:** `createPlugin()` function to create Pinia plugins from subscribers
+- **PluginSubscriber Class:** Abstract base class for creating reusable plugin subscribers
+- **Store Helper Class:** Wrapper around PiniaStore with utilities for state and subscription management
+- **PluginSubscriberInterface:** Interface for implementing custom subscribers
+- **Debug Mode:** Detailed logging support for plugin development and troubleshooting
+- **Reset Callbacks:** Custom store reset logic via `resetStoreCallback`
+- **Type Definitions:** Full TypeScript support with comprehensive type exports
+- **Test Suite:** Comprehensive Vitest coverage for all core functionality
+- **Documentation:** Complete README with API reference and examples
+- **MIT License:** Open source license for community use
+
+### Features
+- Centralized subscriber registration for Pinia stores
+- `$reset` method added to all stores modified by the plugin
+- Support for store mutations and action subscriptions
+- Plugin-specific subscription management
+- State helper methods: `addToState()`, `stateHas()`, `getValue()`
+- Store helper methods: `storeHas()`
+- Performance monitoring utilities
+- Validation utilities for common object operations
+
+### Documentation
+- Installation and usage examples
+- API reference for all public classes and functions
+- Contributing guidelines
+- Security policy
+
+[0.1.0]: https://github.com/AlxBDo/pinia-plugin-subscription/releases/tag/v0.1.0

package/CONTRIBUTING.md

@@ -0,0 +1,142 @@
+# Contributing to pinia-plugin-subscription
+
+Thank you for your interest in contributing! This document provides guidelines and instructions for contributing to this project.
+
+## Code of Conduct
+
+Please be respectful and constructive in all interactions with other contributors and maintainers.
+
+## Getting Started
+
+1. **Fork the repository** on GitHub
+2. **Clone your fork** locally:
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/pinia-plugin-subscription.git
+   cd pinia-plugin-subscription
+   ```
+3. **Install dependencies**:
+   ```bash
+   npm install
+   ```
+4. **Create a feature branch**:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+## Development Workflow
+
+### Running Tests
+
+```bash
+npm run test          # Run tests in watch mode
+npm run test -- run   # Run tests once
+npm run coverage      # Generate coverage report
+```
+
+### Building
+
+```bash
+npm run build         # Run tests, build, and generate types
+```
+
+### Preview Changes
+
+```bash
+npm run dev           # Start development server
+npm run preview       # Preview production build
+```
+
+## Making Changes
+
+### Code Style
+
+- Follow the existing code style in the project
+- Use TypeScript for all new code
+- Ensure strict TypeScript compiler options are satisfied
+- Write descriptive variable and function names
+
+### Testing
+
+- Write tests for all new features and bug fixes
+- Ensure all existing tests pass before submitting
+- Aim for >80% code coverage
+
+### Commits
+
+- Write clear, descriptive commit messages
+- Use conventional commits format when possible:
+  - `feat:` for new features
+  - `fix:` for bug fixes
+  - `docs:` for documentation
+  - `test:` for tests
+  - `refactor:` for code refactoring
+  - `chore:` for build/dependencies
+
+Example:
+```
+feat: add support for custom reset callbacks
+
+- Implement resetStoreCallback in PluginSubscriberInterface
+- Add tests for reset functionality
+- Update documentation
+```
+
+## Submitting Changes
+
+1. **Push to your fork**:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+2. **Create a Pull Request** on GitHub with:
+   - Clear title describing the change
+   - Detailed description of what changed and why
+   - Reference to related issues if applicable
+   - Test results showing coverage
+3. **Address review feedback** respectfully and promptly
+
+## Pull Request Guidelines
+
+- Keep PRs focused on a single feature or bug fix
+- Include tests for your changes
+- Update documentation if needed
+- Ensure CI checks pass
+- Request review from maintainers
+
+## Reporting Bugs
+
+Found a bug? Please create an issue on GitHub with:
+
+1. **Title:** Clear, concise description
+2. **Environment:** Node.js version, npm version, OS
+3. **Steps to Reproduce:** Minimal reproduction steps
+4. **Expected Behavior:** What should happen
+5. **Actual Behavior:** What actually happens
+6. **Additional Context:** Screenshots, error traces, etc.
+
+## Proposing Features
+
+Have an idea? Open a GitHub issue with:
+
+1. **Title:** Clear feature name
+2. **Description:** What problem does it solve?
+3. **Use Cases:** When would this be useful?
+4. **Proposed Solution:** How might it work?
+5. **Alternatives:** Other approaches considered
+
+## Release Process
+
+Maintainers will:
+
+1. Update `CHANGELOG.md` with changes
+2. Bump version in `package.json` following Semantic Versioning
+3. Create a git tag
+4. Publish to npm
+5. Create a GitHub release
+
+## Questions?
+
+- Check existing issues and discussions
+- Open a new GitHub discussion if needed
+- Contact maintainers via email
+
+Thank you for contributing! 🙏

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Alexandre Bidaud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -150,4 +150,8 @@ This plugin is tested with Vitest. Coverage reports are available in the `covera
 
 ## License
 
-MIT
+MIT
+
+## Publishing
+
+Releases are published to npm via GitHub Actions. The workflow uses npm provenance for better supply-chain security and requires a `NPM_TOKEN` secret in the repository settings.

package/SECURITY.md

@@ -0,0 +1,75 @@
+# Security Policy
+
+## Reporting Security Vulnerabilities
+
+If you discover a security vulnerability in pinia-plugin-subscription, please do **NOT** open a public GitHub issue. Instead, please email the maintainers privately.
+
+**Email:** [Security Contact - reach out via GitHub profile]
+
+Please include:
+
+- Description of the vulnerability
+- Steps to reproduce
+- Potential impact
+- Suggested fix (if available)
+
+We will:
+
+1. Acknowledge your report within 48 hours
+2. Investigate the issue thoroughly
+3. Work on a fix
+4. Release a patched version
+5. Credit you (if desired) in the release notes
+
+## Supported Versions
+
+| Version | Supported |
+|---------|-----------|
+| 0.1.x   | ✅ Yes    |
+| < 0.1   | ❌ No     |
+
+## Security Best Practices
+
+When using pinia-plugin-subscription:
+
+1. **Keep Dependencies Updated:** Regularly update Pinia, Vue, and other dependencies to the latest versions
+2. **Review Plugin Code:** Always review subscriber code before using in production
+3. **Validate Store Data:** Validate data before storing in Pinia stores
+4. **Debug Mode:** Disable debug mode in production (set `false` when calling `createPlugin`)
+
+## Dependencies Security
+
+This project depends on:
+
+- **Pinia** - Vue state management
+- **Vue** - JavaScript framework
+
+We monitor these dependencies for vulnerabilities and recommend keeping them updated.
+
+## Vulnerability Disclosure Timeline
+
+- **Day 0:** Report received
+- **Day 1-2:** Initial assessment
+- **Day 3-7:** Fix development
+- **Day 7-14:** Security release
+- **Day 14:** Public disclosure
+
+## Scope
+
+This policy covers:
+
+- ✅ Code in the pinia-plugin-subscription repository
+- ✅ Published npm packages
+- ✅ Security of the plugin API
+
+This policy does NOT cover:
+
+- ❌ Security of Pinia or Vue (report to their respective projects)
+- ❌ Security of applications using this plugin
+- ❌ Social engineering attacks
+
+## Questions
+
+For general security questions or concerns, open a private security advisory on GitHub.
+
+Thank you for helping keep pinia-plugin-subscription secure! 🔒