Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
name: Bug Report
about: Report a bug to help us improve express-storage
title: '[BUG] '
labels: bug
assignees: ''
---

## Bug Description

A clear and concise description of what the bug is.

## Steps to Reproduce

1. Configure storage with '...'
2. Call method '...'
3. Pass parameters '...'
4. See error

## Expected Behavior

What you expected to happen.

## Actual Behavior

What actually happened.

## Code Sample

```typescript
// Minimal code to reproduce the issue
import { StorageManager } from 'express-storage';

const storage = new StorageManager({
driver: 'local', // or s3, gcs, azure
});

// Your code here
```

## Error Message

```
Paste any error messages or stack traces here
```

## Environment

- **express-storage version**:
- **Node.js version**:
- **Operating System**:
- **Storage Provider**: (local / s3 / gcs / azure)
- **Express version**:

## Additional Context

Add any other context about the problem here (screenshots, logs, etc.).

## Possible Solution

If you have ideas on how to fix this, please share.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Documentation
url: https://github.com/th3hero/express-storage#readme
about: Check the README for usage examples and API documentation
- name: Stack Overflow
url: https://stackoverflow.com/questions/tagged/express-storage
about: Ask questions on Stack Overflow with the express-storage tag
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: Feature Request
about: Suggest an idea for express-storage
title: '[FEATURE] '
labels: enhancement
assignees: ''
---

## Problem Statement

A clear description of what problem this feature would solve.

**Example:** "I'm always frustrated when..."

## Proposed Solution

Describe the solution you'd like to see.

## Example Usage

```typescript
// How would you like to use this feature?
import { StorageManager } from 'express-storage';

const storage = new StorageManager();

// Example of the new feature in action
```

## Alternatives Considered

Describe any alternative solutions or features you've considered.

## Use Case

Explain the real-world scenario where this feature would be helpful.

- **Who**: Who would benefit from this feature?
- **What**: What are they trying to accomplish?
- **Why**: Why is the current solution insufficient?

## Additional Context

Add any other context, screenshots, or examples about the feature request here.

## Willingness to Contribute

- [ ] I'm willing to submit a PR for this feature
- [ ] I can help with testing
- [ ] I can help with documentation
56 changes: 56 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
## Description

Brief description of the changes in this PR.

## Type of Change

- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring
- [ ] Test coverage improvement

## Related Issue

Fixes #(issue number)

## Changes Made

- Change 1
- Change 2
- Change 3

## Testing

Describe the tests you ran to verify your changes:

- [ ] Unit tests pass (`npm test`)
- [ ] Linting passes (`npm run lint`)
- [ ] Type checking passes (`npm run type-check`)
- [ ] Build succeeds (`npm run build`)
- [ ] Manual testing performed

### Test Configuration

- **Node.js version**:
- **Storage provider tested**:

## Screenshots (if applicable)

Add screenshots to help explain your changes.

## Checklist

- [ ] My code follows the project's code style
- [ ] I have commented my code where necessary
- [ ] I have updated the documentation accordingly
- [ ] I have added tests that prove my fix/feature works
- [ ] All new and existing tests pass
- [ ] My changes generate no new warnings
- [ ] I have checked for potential security implications

## Additional Notes

Any additional information that reviewers should know.
80 changes: 80 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# 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.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- Improved SEO and package discoverability
- Additional documentation and community files

## [1.1.4] - 2025-01-XX

### Changed
- Removed GitHub Packages publishing (npm-only distribution)
- Simplified package distribution strategy

### Fixed
- Package naming conflicts resolved

## [1.1.3] - 2025-01-XX

### Added
- GitHub Packages publishing support (later removed)

## [1.1.2] - 2025-01-XX

### Changed
- Migrated to npm trusted publishing for secure releases

## [1.1.1] - 2025-01-XX

### Added
- npm trusted publishing support
- Automated CI/CD pipeline improvements

## [1.1.0] - 2025-01-XX

### Added
- **Multi-cloud storage support**: AWS S3, Google Cloud Storage, Azure Blob Storage, and local disk
- **Unified API**: Single interface for all storage providers
- **Security features**:
- Path traversal prevention
- Filename sanitization
- Null byte protection
- File validation (size, MIME type, extensions)
- **Presigned URLs**: Client-side direct uploads for S3, GCS, and Azure
- **Large file handling**: Automatic streaming for files >100MB
- **TypeScript support**: Full type definitions and intelligent autocomplete
- **Driver caching**: LRU cache for optimized performance
- **Batch operations**: Upload/delete multiple files with concurrency limits
- **Custom logging**: Pluggable logger interface
- **Retry mechanism**: Exponential backoff for transient failures
- **Utility functions**: File type helpers, size formatting, and more

### Security
- Built-in protection against common file upload vulnerabilities
- Secure filename generation: `{timestamp}_{random}_{sanitized_name}`
- Azure post-upload validation for presigned URL uploads

## [1.0.0] - 2025-01-XX

### Added
- Initial release
- Core storage abstraction layer
- Express.js middleware integration
- Multer compatibility
- Basic file upload and management operations

---

[Unreleased]: https://github.com/th3hero/express-storage/compare/V1.1.4...HEAD
[1.1.4]: https://github.com/th3hero/express-storage/compare/V1.1.3...V1.1.4
[1.1.3]: https://github.com/th3hero/express-storage/compare/V1.1.2...V1.1.3
[1.1.2]: https://github.com/th3hero/express-storage/compare/V1.1.1...V1.1.2
[1.1.1]: https://github.com/th3hero/express-storage/compare/V1.1.0...V1.1.1
[1.1.0]: https://github.com/th3hero/express-storage/compare/V1.0.0...V1.1.0
[1.0.0]: https://github.com/th3hero/express-storage/releases/tag/V1.0.0
48 changes: 48 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Contributor Covenant 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, caste, color, 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

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will
Loading