Compare commits
No files matched your search
+6
-43
@@ -1,44 +1,7 @@
|
||||
# Version control
|
||||
.git
|
||||
.gitignore
|
||||
.github
|
||||
|
||||
# Node.js
|
||||
node_modules
|
||||
npm-debug.log
|
||||
yarn-debug.log
|
||||
yarn-error.log
|
||||
|
||||
# Development files
|
||||
*.md
|
||||
!README.md
|
||||
!CHANGELOG.md
|
||||
*.log
|
||||
*.bak
|
||||
.DS_Store
|
||||
.vscode
|
||||
.idea
|
||||
.editorconfig
|
||||
.eslintrc
|
||||
.prettierrc
|
||||
|
||||
# Test files
|
||||
test
|
||||
__tests__
|
||||
coverage
|
||||
|
||||
# Docker
|
||||
Dockerfile
|
||||
docker-compose.yml
|
||||
.dockerignore
|
||||
|
||||
# Local data (should be mounted as volume)
|
||||
data/*
|
||||
!data/.gitkeep
|
||||
|
||||
# Debug scripts
|
||||
debug-*.js
|
||||
test-*.js
|
||||
|
||||
# Documentation
|
||||
docs
|
||||
data
|
||||
tts-cache
|
||||
.env
|
||||
*.db
|
||||
*.db-shm
|
||||
*.db-wal
|
||||
@@ -0,0 +1,28 @@
|
||||
name: Build and Push Docker Image
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
build-and-push:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Log in to Gitea Container Registry
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: git.necloud.us
|
||||
username: ${{ secrets.REGISTRY_USER }}
|
||||
password: ${{ secrets.REGISTRY_TOKEN }}
|
||||
|
||||
- name: Build and push
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: .
|
||||
push: true
|
||||
tags: git.necloud.us/nate/homeschool:latest
|
||||
@@ -1,42 +0,0 @@
|
||||
name: Docker Build and Push
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*.*.*'
|
||||
|
||||
jobs:
|
||||
build-and-push:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v2
|
||||
|
||||
- name: Extract version from tag
|
||||
id: get_version
|
||||
run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Login to GitHub Container Registry
|
||||
uses: docker/login-action@v2
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Build and push
|
||||
uses: docker/build-push-action@v4
|
||||
with:
|
||||
context: .
|
||||
push: true
|
||||
tags: |
|
||||
ghcr.io/${{ github.repository }}:latest
|
||||
ghcr.io/${{ github.repository }}:${{ steps.get_version.outputs.VERSION }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
@@ -1,55 +0,0 @@
|
||||
name: Build and Push Docker Image
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main ]
|
||||
tags: [ 'v*' ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
IMAGE_NAME: nmemmert/spelling
|
||||
|
||||
jobs:
|
||||
build-and-push:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v2
|
||||
|
||||
- name: Log in to the Container registry
|
||||
uses: docker/login-action@v2
|
||||
with:
|
||||
registry: ${{ env.REGISTRY }}
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Extract metadata (tags, labels) for Docker
|
||||
id: meta
|
||||
uses: docker/metadata-action@v4
|
||||
with:
|
||||
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||
tags: |
|
||||
type=semver,pattern={{version}}
|
||||
type=semver,pattern={{major}}.{{minor}}
|
||||
type=ref,event=branch
|
||||
type=sha,format=long
|
||||
latest
|
||||
|
||||
- name: Build and push Docker image
|
||||
uses: docker/build-push-action@v4
|
||||
with:
|
||||
context: .
|
||||
push: ${{ github.event_name != 'pull_request' }}
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
+2
-36
@@ -1,12 +1,9 @@
|
||||
# Dependencies
|
||||
node_modules/
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
||||
# Debug and testing files
|
||||
debug/
|
||||
*.log
|
||||
# App data (SQLite database)
|
||||
data/
|
||||
|
||||
# OS generated files
|
||||
.DS_Store
|
||||
@@ -14,7 +11,6 @@ debug/
|
||||
._*
|
||||
.Spotlight-V100
|
||||
.Trashes
|
||||
ehthumbs.db
|
||||
Thumbs.db
|
||||
|
||||
# IDE files
|
||||
@@ -28,37 +24,7 @@ Thumbs.db
|
||||
*.bak
|
||||
*.tmp
|
||||
*.backup
|
||||
*.new
|
||||
|
||||
# Environment variables
|
||||
.env
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
|
||||
# Runtime data
|
||||
pids
|
||||
*.pid
|
||||
*.seed
|
||||
*.pid.lock
|
||||
|
||||
# Coverage directory used by tools like istanbul
|
||||
coverage/
|
||||
.nyc_output
|
||||
|
||||
# Dependency directories
|
||||
node_modules/
|
||||
jspm_packages/
|
||||
|
||||
# Optional npm cache directory
|
||||
.npm
|
||||
|
||||
# Optional REPL history
|
||||
.node_repl_history
|
||||
|
||||
# Output of 'npm pack'
|
||||
*.tgz
|
||||
|
||||
# Yarn Integrity file
|
||||
.yarn-integrity
|
||||
Vendored
-13
@@ -1,13 +0,0 @@
|
||||
{
|
||||
"version": "2.0.0",
|
||||
"tasks": [
|
||||
{
|
||||
"type": "shell",
|
||||
"label": "Run Spelling Practice App",
|
||||
"command": "node server.js",
|
||||
"group": "build",
|
||||
"isBackground": true,
|
||||
"problemMatcher": []
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,35 +0,0 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to the Spelling Practice App will be documented in this file.
|
||||
|
||||
## [1.1.0] - 2025-08-13
|
||||
|
||||
### Fixed
|
||||
- Analytics graph no longer goes off the page (added SVG clipping paths)
|
||||
- Results and Sessions tabs now show correct data for all users
|
||||
- Admin1 sessions now visible in the interface
|
||||
- Fixed issues with reading results.json file
|
||||
|
||||
### Added
|
||||
- API Test Page for endpoint testing and debugging
|
||||
- Support for different session data formats
|
||||
- Filtering and pagination to the /getResults endpoint
|
||||
- Comprehensive error handling for file operations
|
||||
- Test script to verify data storage functionality
|
||||
- DEBUG.md with troubleshooting instructions
|
||||
|
||||
### Changed
|
||||
- Improved session data handling with better format compatibility
|
||||
- Enhanced error logging with emoji indicators for better readability
|
||||
- Simplified file reading operations with proper error handling
|
||||
- Updated saveResults endpoint to handle edge cases better
|
||||
|
||||
## [1.0.0] - 2024-10-15
|
||||
|
||||
### Initial Release
|
||||
- Spelling practice functionality
|
||||
- User management
|
||||
- Admin panel
|
||||
- Analytics
|
||||
- Gamification features
|
||||
- Spaced repetition system
|
||||
@@ -1,77 +0,0 @@
|
||||
# Code Cleanup Summary
|
||||
|
||||
## Cleanup Performed on Spelling Practice App
|
||||
|
||||
### 🗂️ File Organization
|
||||
- **Moved debug files**: Created `/debug` folder and moved all debugging scripts (`debug-*.js`, `generate-*.js`, `test_*.js`, etc.)
|
||||
- **Removed backup files**: Deleted `game.js.new` (outdated backup file)
|
||||
- **Created `.gitignore`**: Added comprehensive gitignore file to exclude debug files, logs, and temporary files
|
||||
|
||||
### 📦 Dependencies Cleanup
|
||||
- **Removed redundant packages**:
|
||||
- Removed `fs` (built-in Node.js module, no need to install)
|
||||
- Removed `path` (built-in Node.js module, no need to install)
|
||||
- **Updated package.json**: Now only includes necessary dependencies (`express`, `node-fetch`)
|
||||
- **Regenerated package-lock.json**: Clean dependency tree without unnecessary packages
|
||||
|
||||
### 🧹 Code Quality Improvements
|
||||
- **Reduced console logging**:
|
||||
- Cleaned up excessive logging in `analytics.js`
|
||||
- Removed debug console logs from `input-fix.js`
|
||||
- Kept only essential error logging
|
||||
- **Fixed code issues**:
|
||||
- Corrected duplicate word reference in analytics problem words display
|
||||
- Removed redundant chart coordinate validation warnings
|
||||
- Simplified error handling in chart rendering
|
||||
|
||||
### 📝 Documentation Fixes
|
||||
- **Fixed README formatting**: Corrected malformed headers and text in `Readme.md`
|
||||
- **Organized content**: Improved structure and readability
|
||||
|
||||
### 🏗️ Project Structure Improvements
|
||||
```
|
||||
Before:
|
||||
├── debug-*.js (scattered in root)
|
||||
├── generate-*.js (scattered in root)
|
||||
├── test_*.js (scattered in root)
|
||||
├── game.js.new (backup file)
|
||||
└── package.json (with unnecessary deps)
|
||||
|
||||
After:
|
||||
├── debug/ (organized folder)
|
||||
│ ├── debug-*.js
|
||||
│ ├── generate-*.js
|
||||
│ └── test_*.js
|
||||
├── .gitignore (comprehensive)
|
||||
└── package.json (clean dependencies)
|
||||
```
|
||||
|
||||
### ✅ Benefits of Cleanup
|
||||
1. **Improved Performance**: Removed unnecessary dependencies and logging
|
||||
2. **Better Organization**: Debug files are now properly organized
|
||||
3. **Cleaner Repository**: Added gitignore to prevent tracking temporary files
|
||||
4. **Reduced Noise**: Minimized console output for better debugging experience
|
||||
5. **Better Maintainability**: Code is now easier to read and maintain
|
||||
|
||||
### 🔧 Technical Details
|
||||
- **Dependencies reduced**: From 4 to 2 packages (50% reduction)
|
||||
- **Console logs reduced**: Removed ~15 verbose logging statements
|
||||
- **File organization**: Moved 10+ debug files to dedicated folder
|
||||
- **Code quality**: Fixed 3 redundant code patterns
|
||||
- **Documentation**: Fixed README formatting issues
|
||||
|
||||
### 🚀 Next Steps Recommended
|
||||
1. Consider adding automated linting (ESLint) for consistent code style
|
||||
2. Add automated testing framework for better code quality
|
||||
3. Consider using environment variables for configuration settings
|
||||
4. Add code documentation for complex functions
|
||||
|
||||
### ⚠️ No Breaking Changes
|
||||
All cleanup was performed without affecting the core functionality:
|
||||
- ✅ Server still runs normally
|
||||
- ✅ All features remain functional
|
||||
- ✅ User data is preserved
|
||||
- ✅ Admin functionality intact
|
||||
- ✅ All endpoints working
|
||||
|
||||
**Result**: A cleaner, more maintainable codebase without any functional changes.
|
||||
@@ -1,84 +0,0 @@
|
||||
# Debugging the Spelling Practice App
|
||||
|
||||
This document provides guidance on debugging and testing the app's data handling functionality.
|
||||
|
||||
## Testing Tools
|
||||
|
||||
### 1. API Test Page
|
||||
|
||||
A user-friendly interface for testing the API endpoints:
|
||||
|
||||
- **URL**: http://localhost:3000/api-test.html
|
||||
- **Features**:
|
||||
- Test the `/getResults` endpoint to retrieve session data
|
||||
- Create and save new test sessions with customizable parameters
|
||||
- View session details for specific users
|
||||
|
||||
### 2. Test Script
|
||||
|
||||
A Node.js script to verify the saveResults endpoint functionality:
|
||||
|
||||
```bash
|
||||
node test-save-results.js
|
||||
```
|
||||
|
||||
This script:
|
||||
1. Verifies the server is running
|
||||
2. Creates a test session for "testuser"
|
||||
3. Validates the session was saved correctly
|
||||
4. Shows summary information about the saved session
|
||||
|
||||
## Common Issues
|
||||
|
||||
### File Access Issues
|
||||
|
||||
If you're experiencing issues with data storage or retrieval:
|
||||
|
||||
1. **Check file permissions**:
|
||||
- Make sure the `data` directory is writable by the Node.js process
|
||||
- In Docker environments, ensure volume mounts are set up correctly
|
||||
|
||||
2. **Verify file formats**:
|
||||
- The app expects JSON files in a specific format
|
||||
- If manually editing files, validate the JSON structure before restarting
|
||||
|
||||
3. **Inspect server logs**:
|
||||
- The server outputs detailed logs with emoji indicators
|
||||
- Look for error messages marked with ❌
|
||||
|
||||
### Session Data Troubleshooting
|
||||
|
||||
If sessions aren't appearing correctly:
|
||||
|
||||
1. **Format compatibility**:
|
||||
- The app supports multiple data formats for backward compatibility
|
||||
- Session data may use either `timestamp` or `date` fields
|
||||
- Word data may be in `answers` or `words` arrays
|
||||
|
||||
2. **Data verification flow**:
|
||||
- Save a session using the API test page
|
||||
- Check the response from the `/saveResults` endpoint
|
||||
- Verify data using the `/getResults` endpoint
|
||||
- Confirm it appears in the UI
|
||||
|
||||
## Server Recovery
|
||||
|
||||
If the server stops working:
|
||||
|
||||
1. **Restart the server**:
|
||||
```bash
|
||||
node server.js
|
||||
```
|
||||
|
||||
2. **Check for errors in the logs**
|
||||
|
||||
3. **Data integrity check**:
|
||||
- Inspect JSON files in the `data` directory for formatting issues
|
||||
- Restore from backups or seed files if needed
|
||||
|
||||
## Recent Fixes
|
||||
|
||||
- Added backup data display when `results.json` can't be read
|
||||
- Improved error handling in saveResults endpoint
|
||||
- Created helper functions to handle different session data formats
|
||||
- Added SVG clipping paths to fix analytics graph display issues
|
||||
@@ -1,51 +0,0 @@
|
||||
## GitHub Container Registry Deployment Summary
|
||||
|
||||
### 🐳 Docker Images Published Successfully
|
||||
|
||||
✅ **Images Published:**
|
||||
- `ghcr.io/nmemmert/spelling:1.1.0` - Version tagged image
|
||||
- `ghcr.io/nmemmert/spelling:latest` - Latest version image
|
||||
|
||||
### 📦 Container Details
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| Base Image | Node 18 Alpine |
|
||||
| Size | ~293MB (optimized) |
|
||||
| Exposed Port | 3000/TCP |
|
||||
| User | Non-root (spelling) |
|
||||
| Entry Point | Tini init system |
|
||||
| Labels | org.opencontainers.image.source: https://github.com/nmemmert/spelling |
|
||||
|
||||
### 📝 Documentation & Release
|
||||
|
||||
1. **Updated README.md**
|
||||
- Enhanced Docker container usage instructions
|
||||
- Added specific commands for pulling and running containers
|
||||
- Improved update and maintenance instructions
|
||||
|
||||
2. **Git Tags & Releases**
|
||||
- Created tag: `v1.1.1-container`
|
||||
- Created GitHub Release: `v1.1.1 Container Release`
|
||||
|
||||
### 🚀 Next Steps
|
||||
|
||||
1. **Verify Package Visibility**
|
||||
- Go to https://github.com/nmemmert/spelling/packages
|
||||
- Ensure the package visibility is set to "Public" for easy access
|
||||
|
||||
2. **Consider Adding Badges to README.md**
|
||||
```markdown
|
||||
|
||||
|
||||
```
|
||||
|
||||
3. **Setup Automated Builds (Optional)**
|
||||
- Consider setting up GitHub Actions workflow for automated builds
|
||||
- This would rebuild the Docker image on each push to main branch
|
||||
|
||||
4. **Usage Testing**
|
||||
- Test pulling and running from another system
|
||||
- Verify all functionality works correctly in containerized version
|
||||
|
||||
Congratulations! Your Spelling Practice App is now fully containerized and available on GitHub Container Registry.
|
||||
+23
-42
@@ -1,49 +1,30 @@
|
||||
# ===== STAGE 1: Dependency Installation =====
|
||||
FROM node:20-slim AS deps
|
||||
|
||||
FROM node:26-slim
|
||||
WORKDIR /app
|
||||
|
||||
# Copy package files and install dependencies
|
||||
# Install piper TTS binary and an English voice model
|
||||
RUN apt-get update && apt-get install -y --no-install-recommends wget ca-certificates libespeak-ng1 \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
RUN wget -qO /tmp/piper.tar.gz \
|
||||
https://github.com/rhasspy/piper/releases/download/2023.11.14-2/piper_linux_x86_64.tar.gz \
|
||||
&& tar -xzf /tmp/piper.tar.gz -C /usr/local/lib \
|
||||
&& ln -s /usr/local/lib/piper/piper /usr/local/bin/piper \
|
||||
&& echo /usr/local/lib/piper > /etc/ld.so.conf.d/piper.conf \
|
||||
&& ldconfig \
|
||||
&& rm /tmp/piper.tar.gz
|
||||
|
||||
RUN mkdir -p /app/voices \
|
||||
&& wget -qO /app/voices/en_US-lessac-medium.onnx \
|
||||
"https://huggingface.co/rhasspy/piper-voices/resolve/v1.0.0/en/en_US/lessac/medium/en_US-lessac-medium.onnx" \
|
||||
&& wget -qO /app/voices/en_US-lessac-medium.onnx.json \
|
||||
"https://huggingface.co/rhasspy/piper-voices/resolve/v1.0.0/en/en_US/lessac/medium/en_US-lessac-medium.onnx.json"
|
||||
|
||||
COPY package*.json ./
|
||||
RUN npm ci --omit=dev
|
||||
|
||||
# ===== STAGE 2: Runtime =====
|
||||
FROM node:20-slim
|
||||
|
||||
# Install tini for proper signal handling
|
||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
tini \
|
||||
wget \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Create non-root user for better security
|
||||
RUN groupadd -r spelling && useradd -r -g spelling spelling
|
||||
|
||||
# Setup application directory
|
||||
WORKDIR /app
|
||||
|
||||
# Copy node modules and package files
|
||||
COPY --from=deps /app/node_modules /app/node_modules
|
||||
COPY --from=deps /app/package*.json /app/
|
||||
|
||||
# Copy application code
|
||||
COPY . .
|
||||
|
||||
# Create and set permissions for data directory
|
||||
RUN mkdir -p /app/data && chown -R spelling:spelling /app/data
|
||||
|
||||
# Switch to non-root user
|
||||
USER spelling
|
||||
|
||||
# Set version label
|
||||
LABEL version="1.1.0" \
|
||||
description="Spelling Practice Application" \
|
||||
maintainer="nmemmert" \
|
||||
org.opencontainers.image.source="https://github.com/nmemmert/spelling"
|
||||
|
||||
# Expose application port
|
||||
ENV NODE_ENV=production
|
||||
ENV DATA_DIR=/app/data
|
||||
EXPOSE 3000
|
||||
|
||||
# Use tini as init process and start application
|
||||
ENTRYPOINT ["/usr/bin/tini", "--"]
|
||||
HEALTHCHECK --interval=30s --timeout=10s --retries=3 \
|
||||
CMD wget -q -O - http://localhost:3000/health || exit 1
|
||||
CMD ["node", "server.js"]
|
||||
@@ -1,77 +0,0 @@
|
||||
# Spelling Practice App - Fix Summary
|
||||
|
||||
## Issues Fixed
|
||||
|
||||
1. **Analytics Graph Display Issues**
|
||||
- Fixed charts going off the page by adding SVG clipping paths
|
||||
- Enhanced chart containers for proper content display
|
||||
|
||||
2. **Session Data Display Problems**
|
||||
- Updated session display code to handle different data formats
|
||||
- Created helper functions in `session-helpers.js` to normalize data
|
||||
- Improved error handling for missing or malformed session data
|
||||
|
||||
3. **Results & Sessions Tab Data Issues**
|
||||
- Enhanced the `/getResults` endpoint to reliably return session data
|
||||
- Added fallback mechanism when file reading fails
|
||||
- Improved data format compatibility across different session structures
|
||||
|
||||
4. **File Access Issues**
|
||||
- Added robust error handling for file system operations
|
||||
- Implemented backup data provision when file access fails
|
||||
- Enhanced logging to better identify file access issues
|
||||
|
||||
5. **User Session Visibility**
|
||||
- Fixed issues with admin1 sessions not being displayed
|
||||
- Updated endpoint to ensure data for all users is returned
|
||||
- Added test data generation for empty user sessions
|
||||
|
||||
## New Features Added
|
||||
|
||||
1. **Debugging Tools**
|
||||
- Created API Test Page (`api-test.html`) for easy endpoint testing
|
||||
- Added test script (`test-save-results.js`) to verify data storage functionality
|
||||
- Created comprehensive debugging documentation (`DEBUG.md`)
|
||||
|
||||
2. **Enhanced Endpoints**
|
||||
- Added filtering and pagination to the `/getResults` endpoint
|
||||
- Enhanced `/saveResults` endpoint with improved error handling
|
||||
- Added logging to track data flow through the application
|
||||
|
||||
3. **UI Improvements**
|
||||
- Enhanced session display with fallbacks for different data formats
|
||||
- Improved error handling in session rendering
|
||||
|
||||
## Recommendations for Future Improvements
|
||||
|
||||
1. **Data Consistency**
|
||||
- Standardize session data format across all parts of the application
|
||||
- Add data migration utilities for older format sessions
|
||||
|
||||
2. **Error Recovery**
|
||||
- Implement automatic backups of data files
|
||||
- Add periodic data integrity checks
|
||||
|
||||
3. **Performance**
|
||||
- Consider pagination for large result sets in the UI
|
||||
- Add caching for frequently accessed data
|
||||
|
||||
4. **Security**
|
||||
- Add input validation to all endpoints
|
||||
- Implement authentication for API endpoints
|
||||
|
||||
## Testing Instructions
|
||||
|
||||
1. **Session Data Testing**
|
||||
- Use the API test page at http://localhost:3000/api-test.html
|
||||
- Create new test sessions with varying parameters
|
||||
- Verify sessions appear in both the test page and main application
|
||||
|
||||
2. **Data Persistence Testing**
|
||||
- Run the test script: `node test-save-results.js`
|
||||
- Verify data is properly stored and can be retrieved
|
||||
- Check that new users automatically get initialized in all data files
|
||||
|
||||
## Conclusion
|
||||
|
||||
The application now handles session data more robustly, with improved error handling and fallback mechanisms when file access issues occur. The UI components have been updated to handle different data formats, ensuring a consistent user experience regardless of how the data is stored. New debugging tools make it easier to identify and fix issues in the future.
|
||||
@@ -0,0 +1,52 @@
|
||||
# 🎓 Homeschool
|
||||
|
||||
A self-hosted homeschool learning platform — courses, lessons, assignments, quizzes, and a gradebook — with spelling practice and flashcards built in as first-class activity types. Two apps share one server: a kid-facing app (`index.html`) and a PIN-protected parent console (`admin.html`).
|
||||
|
||||
## How it's organized
|
||||
|
||||
- **Courses → Units → Items.** A parent builds courses (e.g. "Science 3"), each broken into units (e.g. "Week 1: Weather"), each holding items: lessons, assignments, quizzes, or an embedded spelling/flashcards activity.
|
||||
- **Lessons** are parent-authored content (text, images, YouTube embeds) the kid marks as read.
|
||||
- **Assignments** are turned in with a tap ("Mark as done") and graded by a parent from a grading queue.
|
||||
- **Quizzes** (multiple choice, true/false, short answer) are auto-graded on submission, with a right/wrong review shown immediately.
|
||||
- **Spelling and flashcards** activities reuse the same engines described below, and their results flow into the same gradebook.
|
||||
- **Daily agenda.** A parent schedules items (or free-text offline tasks like "Read Ch. 3") onto specific days in the weekly planner; the kid's home screen shows "Today's work" as a checklist that fills in as they go.
|
||||
- **Gradebook.** Every graded item (assignments, quizzes, spelling tests) rolls up per course into a percentage, with a printable weekly report for homeschool portfolio records.
|
||||
|
||||
## How the spelling module works
|
||||
|
||||
- **Dictation practice** — the browser speaks each word (and an example sentence if the list has one); the kid types it. No internet or API keys needed — it uses the browser's built-in speech synthesis.
|
||||
- **Letter-diff feedback** — a wrong answer shows exactly which letters were wrong, then the correct word appears for a few seconds, hides, and the kid retypes it from memory (look–cover–write–check).
|
||||
- **Leitner spaced repetition** — every word has a box (0–5). Right on the first try moves it up a box and pushes the next review out (1 → 2 → 4 → 7 → 14 days). A miss sends it back to box 1. Box 5 = mastered. Daily practice mixes the current list with whatever old words are due.
|
||||
- **Spelling test** — every word on the list, dictation only, no hints or retries. Scores are saved, and missed words automatically re-enter the practice rotation.
|
||||
|
||||
## How the flashcards module works
|
||||
|
||||
Classic flip-cards (front → reveal → "Got it!" / "Study more") using the same Leitner scheduler as spelling, so a deck's due cards resurface on the right day automatically. Works standalone or as a course item.
|
||||
|
||||
## Running it
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm start # http://localhost:3000
|
||||
```
|
||||
|
||||
Or with Docker:
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
The SQLite database lives in `./data/` (mounted as a volume in Docker).
|
||||
|
||||
Requires Node 24+ (uses the built-in `node:sqlite` module — no native dependencies).
|
||||
|
||||
## First-time setup
|
||||
|
||||
1. Open the app → **Parent dashboard** (`/admin.html`) → PIN `1234` (change it in Settings).
|
||||
2. Add your kids.
|
||||
3. Build a course: add units, then add items (lessons, assignments, quizzes, or a spelling/flashcards activity pointing at a list or deck).
|
||||
4. Enroll kids in the course, from the course's Roster section.
|
||||
5. Use the Weekly Planner to schedule items onto specific days — or let kids browse everything anytime from **My Courses**.
|
||||
6. For spelling specifically: pick a built-in Dolch list or create your own (one word per line, optional `word | example sentence`), then assign each kid a weekly list from the Spelling panel.
|
||||
|
||||
Kids just tap their name — no passwords. Everything they do (course work or spelling) reports back into the parent console automatically.
|
||||
@@ -1,481 +0,0 @@
|
||||
# 📝 Modern Spelling & Typing Practice App
|
||||
|
||||
A comprehensive educational application featuring spelling practice, typing exercises, and Bible verse typing with modern UI design. Built with **Node.js**, **Express**, and optimized for Docker deployment.
|
||||
|
||||
## ⚙️ Features Overview
|
||||
|
||||
### 🎓 Student Features
|
||||
- Interactive spelling practice with multiple word lists
|
||||
- Typing exercises for skill development
|
||||
- Bible verse typing practice
|
||||
- Gamification with points, badges, and challenges
|
||||
- Spaced repetition learning system
|
||||
- Progress tracking and analytics
|
||||
- Multiple input methods (keyboard, handwriting on tablets)
|
||||
|
||||
### 👨💼 Admin Panel Features
|
||||
- User management and administration
|
||||
- Word list creation and editing
|
||||
- Progress monitoring and reporting
|
||||
- Analytics dashboard with detailed insights
|
||||
- System configuration options
|
||||
|
||||
## 🔧 Configuration & Security
|
||||
|
||||
The application includes comprehensive security features and environment variable configuration options for deployment flexibility.
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Troubleshooting
|
||||
|
||||
If you encounter issues with the app, please refer to the [DEBUG.md](DEBUG.md) file for common problems and solutions.
|
||||
|
||||
---
|
||||
|
||||
## [Watch the Demo Video](https://www.youtube.com/watch?v=K29zCFZPEjE)
|
||||
[](https://www.youtube.com/watch?v=K29zCFZPEjE)
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Installation Options
|
||||
|
||||
### Option 1: Docker (Recommended)
|
||||
|
||||
#### Quick Start with Docker Compose
|
||||
```bash
|
||||
git clone https://github.com/nmemmert/spelling.git
|
||||
cd spelling
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
#### Using Pre-built Container
|
||||
```bash
|
||||
# Pull and run the latest container
|
||||
docker run -d \
|
||||
--name spelling-app \
|
||||
-p 3000:3000 \
|
||||
-v ./data:/app/data \
|
||||
--restart unless-stopped \
|
||||
--health-cmd "wget -q -O - http://localhost:3000/health || exit 1" \
|
||||
--health-interval 30s \
|
||||
--health-retries 3 \
|
||||
ghcr.io/nmemmert/spelling:latest
|
||||
```
|
||||
|
||||
#### Advanced Docker Compose
|
||||
```yaml
|
||||
version: "3.9"
|
||||
services:
|
||||
spelling-app:
|
||||
image: ghcr.io/nmemmert/spelling:latest
|
||||
container_name: spelling-app
|
||||
ports:
|
||||
- "3000:3000"
|
||||
volumes:
|
||||
- ./data:/app/data
|
||||
environment:
|
||||
- NODE_ENV=production
|
||||
# Optional environment variables:
|
||||
# - PORT=3000
|
||||
# - HOST=0.0.0.0
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ["CMD", "node", "-e", "require('http').get('http://localhost:3000/health', res => res.statusCode === 200 ? process.exit(0) : process.exit(1))"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
start_period: 10s
|
||||
```
|
||||
|
||||
#### Building Your Own Docker Image
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/nmemmert/spelling.git
|
||||
cd spelling
|
||||
|
||||
# Build the Docker image
|
||||
docker build -t spelling:local .
|
||||
|
||||
# Run your local image
|
||||
docker run -d --name spelling-app -p 3000:3000 -v ./data:/app/data spelling:local
|
||||
```
|
||||
|
||||
### Option 2: CasaOS Installation
|
||||
|
||||
#### Method 1: One-Click Install (Recommended)
|
||||
1. **Open CasaOS Dashboard** in your web browser
|
||||
2. Navigate to **App Store** → **Custom Install**
|
||||
3. **Paste this complete Docker Compose configuration:**
|
||||
|
||||
```yaml
|
||||
name: spelling-practice-app
|
||||
services:
|
||||
spelling-app:
|
||||
image: ghcr.io/nmemmert/spelling:latest
|
||||
container_name: spelling-practice
|
||||
ports:
|
||||
- "3000:3000"
|
||||
volumes:
|
||||
- /DATA/AppData/spelling:/app/data
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
- NODE_ENV=production
|
||||
labels:
|
||||
- "casaos.name=Spelling Practice"
|
||||
- "casaos.icon=📝"
|
||||
- "casaos.category=Education"
|
||||
- "casaos.description=Modern spelling and typing practice application"
|
||||
|
||||
x-casaos:
|
||||
author: NMemmert
|
||||
category: Education
|
||||
description:
|
||||
en_us: "A comprehensive educational application featuring spelling practice, typing exercises, and Bible verse typing with modern UI design."
|
||||
developer: "NMemmert"
|
||||
icon: "https://hotemoji.com/images/dl/7/memo-emoji-by-google.png"
|
||||
screenshot_link: ""
|
||||
tagline:
|
||||
en_us: "Modern Spelling & Typing Practice"
|
||||
thumbnail: ""
|
||||
title:
|
||||
en_us: "Spelling Practice App"
|
||||
tips: {}
|
||||
port_map: "3000"
|
||||
```
|
||||
|
||||
4. **Click Install** and wait for deployment to complete
|
||||
5. **Access the app** via CasaOS Dashboard or directly at `http://your-casaos-ip:3000`
|
||||
|
||||
> **💡 Tip**: The app will automatically appear in your CasaOS dashboard with the 📝 icon after installation
|
||||
|
||||
#### Method 2: Manual CasaOS Installation
|
||||
1. **Access CasaOS Terminal**:
|
||||
- Open CasaOS Dashboard
|
||||
- Go to **Terminal** or **SSH** into your CasaOS system
|
||||
|
||||
2. **Create application directory:**
|
||||
```bash
|
||||
mkdir -p /DATA/AppData/spelling
|
||||
cd /DATA/AppData/spelling
|
||||
```
|
||||
|
||||
3. **Create docker-compose.yml file:**
|
||||
```bash
|
||||
nano docker-compose.yml
|
||||
```
|
||||
|
||||
4. **Add this configuration and save:**
|
||||
```yaml
|
||||
version: "3.9"
|
||||
services:
|
||||
spelling-app:
|
||||
image: ghcr.io/nmemmert/spelling:latest
|
||||
container_name: spelling-practice
|
||||
ports:
|
||||
- "3000:3000"
|
||||
volumes:
|
||||
- /DATA/AppData/spelling:/app/data
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
- NODE_ENV=production
|
||||
```
|
||||
|
||||
5. **Deploy the application:**
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
6. **Verify deployment:**
|
||||
```bash
|
||||
docker ps | grep spelling-practice
|
||||
```
|
||||
|
||||
7. **Add to CasaOS Dashboard** (Optional):
|
||||
- Go to CasaOS **Settings** → **Custom Apps**
|
||||
- Click **Add Custom App**
|
||||
- **Name**: "Spelling Practice"
|
||||
- **URL**: `http://localhost:3000`
|
||||
- **Icon**: 📝 (or upload custom icon)
|
||||
- **Category**: Education
|
||||
|
||||
#### CasaOS-Specific Notes:
|
||||
- **Data Location**: All user data is stored in `/DATA/AppData/spelling/`
|
||||
- **Automatic Restart**: Container will restart automatically with CasaOS
|
||||
- **Port Access**: App will be accessible on port 3000
|
||||
- **Updates**: Use CasaOS container management to update the image
|
||||
- **Backups**: Data directory can be backed up through CasaOS file manager
|
||||
|
||||
#### Troubleshooting CasaOS Installation:
|
||||
```bash
|
||||
# Check if container is running
|
||||
docker ps
|
||||
|
||||
# View container logs
|
||||
docker logs spelling-practice
|
||||
|
||||
# Restart container if needed
|
||||
docker restart spelling-practice
|
||||
|
||||
# Check port availability
|
||||
netstat -tlnp | grep :3000
|
||||
```
|
||||
|
||||
### Option 3: Manual Installation
|
||||
```bash
|
||||
# Clone repository
|
||||
git clone https://github.com/nmemmert/spelling.git
|
||||
cd spelling
|
||||
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Start application
|
||||
npm start
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌐 Access & Default Credentials
|
||||
|
||||
After installation, access the application at:
|
||||
- **Local**: http://localhost:3000
|
||||
- **CasaOS**: http://your-casaos-ip:3000
|
||||
|
||||
### Default Login Credentials
|
||||
|
||||
| Username | Password | Role | Description |
|
||||
|-----------|----------|---------|-------------|
|
||||
| admin1 | password | Admin | Full access to admin panel |
|
||||
| student1 | 123456 | Student | Access to practice activities |
|
||||
|
||||
> 🔐 **Important**: Change default passwords immediately after first login via Admin Panel → Password Management
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Features Overview
|
||||
|
||||
### � Student Activities
|
||||
|
||||
#### 📝 **Spelling Practice**
|
||||
- Interactive word-by-word spelling challenges
|
||||
- Real-time feedback with visual indicators
|
||||
- Customizable word lists per student
|
||||
- Progress tracking and accuracy scoring
|
||||
- Retry system for missed words
|
||||
|
||||
#### ⌨️ **Typing Practice**
|
||||
- Speed and accuracy typing exercises
|
||||
- WPM (Words Per Minute) calculation
|
||||
- Error highlighting and correction
|
||||
- Progressive difficulty levels
|
||||
- Performance analytics
|
||||
|
||||
#### 📖 **Bible Typing (ESV)**
|
||||
- 15 popular Bible verses for typing practice
|
||||
- Verse-by-verse comparison and accuracy analysis
|
||||
- Word-level error detection and highlighting
|
||||
- Spiritual growth through Scripture memorization
|
||||
- Progress tracking for Bible study
|
||||
|
||||
### 🛠️ **Student Features**
|
||||
- **Theme Selection**: Choose from multiple UI themes
|
||||
- **Progress Dashboard**: View personal statistics and achievements
|
||||
- **Badge System**: Earn badges for milestones and consistent practice
|
||||
- **Responsive Design**: Optimized for desktop, tablet, and mobile
|
||||
- **Clean Interface**: Modern, distraction-free learning environment
|
||||
|
||||
---
|
||||
|
||||
### 👨� Admin Panel Features
|
||||
|
||||
#### 📊 **User Management**
|
||||
- Add, edit, and remove student accounts
|
||||
- Role-based access control (Admin/Student)
|
||||
- Password management and reset capabilities
|
||||
- User activity monitoring
|
||||
|
||||
#### 📝 **Content Management**
|
||||
- **Word List Editor**: Create and customize spelling lists per student
|
||||
- **Bulk Import**: Upload word lists from text/CSV files
|
||||
- **Category Organization**: Organize words by topics or difficulty
|
||||
- **Preview Mode**: Test activities before assigning to students
|
||||
|
||||
#### 📈 **Analytics & Reporting**
|
||||
- **Performance Analytics**: Track student progress and trends
|
||||
- **Detailed Reports**: Generate comprehensive progress reports
|
||||
- **Export Options**: Download data for external analysis
|
||||
- **Visual Charts**: Graphical representation of student performance
|
||||
|
||||
#### 🏆 **Badge Management**
|
||||
- **Achievement System**: Configure milestone badges
|
||||
- **Progress Tracking**: Monitor student achievements
|
||||
- **Custom Badges**: Create custom rewards for specific goals
|
||||
- **Badge Viewer**: Visual display of all earned achievements
|
||||
|
||||
#### ⚙️ **System Administration**
|
||||
- **Password Management**: Change admin and student passwords
|
||||
- **Security Controls**: Manage access permissions
|
||||
- **Data Backup**: Export/import user data and settings
|
||||
- **System Monitoring**: View application health and usage
|
||||
|
||||
---
|
||||
|
||||
## � Configuration
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# Optional environment variables
|
||||
NODE_ENV=production # Set to production for deployment
|
||||
PORT=3000 # Application port (default: 3000)
|
||||
```
|
||||
|
||||
### Data Persistence
|
||||
The application stores data in JSON files:
|
||||
- `data/users.json` - User accounts and authentication
|
||||
- `data/wordlists.json` - Custom word lists per student
|
||||
- `data/results.json` - Student progress and results
|
||||
- `data/badges.json` - Achievement and badge data
|
||||
|
||||
### Volume Mapping
|
||||
For Docker installations, map the data directory:
|
||||
```bash
|
||||
-v /host/data/path:/app/data
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## �️ Security Features
|
||||
|
||||
- **Password Hashing**: SHA-256 encryption for all passwords
|
||||
- **Role-Based Access**: Separate admin and student interfaces
|
||||
- **Session Management**: Secure login/logout functionality
|
||||
- **Input Validation**: Protection against common security vulnerabilities
|
||||
- **Data Isolation**: Per-user data segregation
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Updates & Maintenance
|
||||
|
||||
### Updating the Docker Container
|
||||
|
||||
#### Using Docker Compose (Recommended)
|
||||
```bash
|
||||
# Pull latest image and restart
|
||||
docker-compose pull
|
||||
docker-compose down
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
#### Using Docker CLI
|
||||
```bash
|
||||
# Pull latest image
|
||||
docker pull ghcr.io/nmemmert/spelling:latest
|
||||
|
||||
# Stop and remove the old container
|
||||
docker stop spelling-app
|
||||
docker rm spelling-app
|
||||
|
||||
# Run the new container with the same settings
|
||||
docker run -d \
|
||||
--name spelling-app \
|
||||
-p 3000:3000 \
|
||||
-v ./data:/app/data \
|
||||
--restart unless-stopped \
|
||||
ghcr.io/nmemmert/spelling:latest
|
||||
```
|
||||
|
||||
#### Updating to a Specific Version
|
||||
```bash
|
||||
# Edit your docker-compose.yml file and change:
|
||||
# image: ghcr.io/nmemmert/spelling:latest
|
||||
# to:
|
||||
# image: ghcr.io/nmemmert/spelling:1.1.0
|
||||
|
||||
# Then restart:
|
||||
docker-compose down && docker-compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Docker Image (GitHub Container Registry)
|
||||
|
||||
The application is available as a Docker image on GitHub Container Registry (GHCR). You can use it with:
|
||||
|
||||
### Pull the Image
|
||||
|
||||
```bash
|
||||
# Pull the latest version
|
||||
docker pull ghcr.io/nmemmert/spelling:latest
|
||||
|
||||
# Or pull a specific version
|
||||
docker pull ghcr.io/nmemmert/spelling:1.1.0
|
||||
```
|
||||
|
||||
### Run the Container
|
||||
|
||||
```bash
|
||||
# Basic run command
|
||||
docker run -d -p 3000:3000 -v ./data:/app/data ghcr.io/nmemmert/spelling:latest
|
||||
|
||||
# Advanced run command with all options
|
||||
docker run -d \
|
||||
--name spelling-app \
|
||||
-p 3000:3000 \
|
||||
-v ./data:/app/data \
|
||||
--restart unless-stopped \
|
||||
--health-cmd "wget -q -O - http://localhost:3000/health || exit 1" \
|
||||
--health-interval 30s \
|
||||
--health-retries 3 \
|
||||
ghcr.io/nmemmert/spelling:latest
|
||||
```
|
||||
|
||||
### Container Details
|
||||
|
||||
- **Base Image**: Node 18 Alpine (minimal footprint)
|
||||
- **Container Size**: ~293MB (optimized multi-stage build)
|
||||
- **Exposed Port**: 3000
|
||||
- **Volume Mount**: /app/data (for persistent data storage)
|
||||
- **Health Check**: Enabled (checks application availability every 30s)
|
||||
- **Security**: Non-root user, minimal dependencies, security scanning
|
||||
|
||||
The image is publicly available at: https://github.com/nmemmert/spelling/pkgs/container/spelling
|
||||
|
||||
### Backup Data
|
||||
```bash
|
||||
# Backup user data
|
||||
docker cp spelling-app:/app/data ./backup-$(date +%Y%m%d)
|
||||
```
|
||||
|
||||
### Logs & Troubleshooting
|
||||
```bash
|
||||
# View application logs
|
||||
docker logs spelling-app
|
||||
|
||||
# Follow live logs
|
||||
docker logs -f spelling-app
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Support & Contributing
|
||||
|
||||
- **Issues**: Report bugs and feature requests
|
||||
- **Documentation**: Comprehensive setup guides
|
||||
- **Community**: Educational technology discussions
|
||||
|
||||
### Technical Specifications
|
||||
- **Backend**: Node.js 18+ with Express.js
|
||||
- **Frontend**: Vanilla JavaScript with modern CSS
|
||||
- **Storage**: JSON-based file system
|
||||
- **Container**: Multi-stage Docker build (293MB)
|
||||
- **Security**: SHA-256 password hashing, role-based access
|
||||
|
||||
---
|
||||
|
||||
## 📄 License
|
||||
|
||||
This project is designed for educational use and community deployment.
|
||||
|
||||
---
|
||||
|
||||
*Built with ❤️ for educators and students everywhere*
|
||||
@@ -1,115 +0,0 @@
|
||||
# 📱 Tablet Handwriting Recognition Test Deployment
|
||||
|
||||
## 🚀 Quick Deploy
|
||||
|
||||
### Pull and Run the Test Image:
|
||||
```bash
|
||||
# Pull the test image
|
||||
docker pull ghcr.io/nmemmert/spelling:test
|
||||
|
||||
# Run the container
|
||||
docker run -d -p 80:3000 --name spelling-tablet-test ghcr.io/nmemmert/spelling:test
|
||||
```
|
||||
|
||||
### Alternative with Docker Compose:
|
||||
```yaml
|
||||
version: '3.8'
|
||||
services:
|
||||
spelling-test:
|
||||
image: ghcr.io/nmemmert/spelling:test
|
||||
ports:
|
||||
- "80:3000"
|
||||
restart: unless-stopped
|
||||
labels:
|
||||
- "test-version=1.2.0-tablet"
|
||||
- "features=handwriting-recognition"
|
||||
```
|
||||
|
||||
## 🖊️ What's Included in This Test Build:
|
||||
|
||||
### ✅ Native Tablet Support:
|
||||
- **Web Handwriting API** integration (Edge/Chrome experimental)
|
||||
- **Windows Ink Platform** compatibility
|
||||
- **Pointer Events API** with pressure sensitivity
|
||||
- **Touch Events API** optimization
|
||||
- **Force Touch** support (3D Touch devices)
|
||||
|
||||
### 🎯 Enhanced Recognition Features:
|
||||
- **Multi-algorithm recognition** chain
|
||||
- **Contextual word matching** for spelling practice
|
||||
- **Pressure-sensitive** stroke analysis
|
||||
- **Timing-based** pattern recognition
|
||||
- **Dictionary-based** post-processing
|
||||
|
||||
### 📝 Tablet-Optimized UI:
|
||||
- **Touch-friendly** interface elements
|
||||
- **Stylus-optimized** canvas
|
||||
- **Responsive** tablet layouts
|
||||
- **Visual feedback** for recognition status
|
||||
- **Auto-detection** of native capabilities
|
||||
|
||||
## 🧪 Testing Instructions:
|
||||
|
||||
### 1. **Access the Application:**
|
||||
- Open your tablet browser
|
||||
- Navigate to your server (e.g., `http://your-server/`)
|
||||
- Look for "📱 Native Tablet Recognition" status
|
||||
|
||||
### 2. **Enable Browser Features (if needed):**
|
||||
- **Edge:** `edge://flags/` → Enable "Experimental Web Platform features"
|
||||
- **Chrome:** `chrome://flags/` → Enable "Experimental Web Platform features"
|
||||
- **Safari:** Enable experimental features in settings
|
||||
|
||||
### 3. **Test Handwriting Recognition:**
|
||||
- Switch to "✏️ Write" mode
|
||||
- Draw letters/words on the canvas with stylus or finger
|
||||
- Click "🔍 Recognize" button
|
||||
- Test words: "Love", "Boy", "Cat", "Make", "Time"
|
||||
|
||||
### 4. **Check Native Features:**
|
||||
- Look for pressure sensitivity (if using stylus)
|
||||
- Test different drawing speeds
|
||||
- Try both print and cursive writing
|
||||
- Check recognition accuracy vs. desktop
|
||||
|
||||
## 📊 Expected Results:
|
||||
|
||||
### **On Modern Tablets:**
|
||||
- ✅ Pointer Events API should work
|
||||
- ✅ Touch Events should be detected
|
||||
- 🔧 Web Handwriting API (needs experimental flags)
|
||||
- ✅ Much better recognition accuracy than desktop
|
||||
|
||||
### **Performance Indicators:**
|
||||
- **Recognition Status:** Should show "Native" or "Enhanced"
|
||||
- **Pressure Data:** Available with compatible stylus
|
||||
- **Touch Optimization:** Smooth drawing experience
|
||||
- **Word Accuracy:** Significantly improved for spelling words
|
||||
|
||||
## 🐛 Troubleshooting:
|
||||
|
||||
### If Recognition is Poor:
|
||||
1. Enable experimental browser features
|
||||
2. Use a compatible stylus (Surface Pen, Apple Pencil, S-Pen)
|
||||
3. Write more slowly and clearly
|
||||
4. Try print letters instead of cursive
|
||||
|
||||
### If No Native Support:
|
||||
- Check browser compatibility
|
||||
- Enable experimental flags
|
||||
- Update to latest browser version
|
||||
- Test on different tablet models
|
||||
|
||||
## 🔗 Image Details:
|
||||
- **Image:** `ghcr.io/nmemmert/spelling:test`
|
||||
- **Version:** `1.2.0-tablet`
|
||||
- **Features:** Native handwriting + Enhanced fallback
|
||||
- **Build Date:** October 2, 2025
|
||||
|
||||
## 📞 Feedback:
|
||||
Test the handwriting recognition and report:
|
||||
- Which device/browser combination
|
||||
- Native API detection results
|
||||
- Recognition accuracy for different words
|
||||
- Any pressure sensitivity detected
|
||||
- Overall user experience improvements
|
||||
@@ -1,263 +0,0 @@
|
||||
# Tablet UI and Handwriting Recognition Features
|
||||
|
||||
This document outlines the new tablet-optimized UI and handwriting recognition features added to the Spelling Practice App.
|
||||
|
||||
## 🎨 Tablet UI Overhaul
|
||||
|
||||
### Features Added
|
||||
|
||||
1. **Tablet-Optimized CSS** (`public/tablet.css`)
|
||||
- Enhanced touch targets (minimum 48px)
|
||||
- Improved typography for tablet viewing
|
||||
- Better spacing and padding for tablet use
|
||||
- Responsive grid layouts
|
||||
- Landscape and portrait orientation support
|
||||
|
||||
2. **Enhanced Student Dashboard**
|
||||
- Card-based activity options with large touch targets
|
||||
- Visual icons and descriptions for each activity
|
||||
- Improved button layouts with better spacing
|
||||
- Better visual hierarchy
|
||||
|
||||
3. **Tablet Utilities** (`public/js/tablet-utils.js`)
|
||||
- Automatic tablet detection
|
||||
- Touch feedback and animations
|
||||
- Swipe gesture support
|
||||
- Orientation change handling
|
||||
- Haptic feedback (where supported)
|
||||
- Enhanced button interactions
|
||||
|
||||
### Tablet-Specific Optimizations
|
||||
|
||||
- **Touch Targets**: All interactive elements are at least 48px in size
|
||||
- **Font Sizes**: Optimized for tablet viewing distances
|
||||
- **Spacing**: Increased padding and margins for better touch interaction
|
||||
- **Visual Feedback**: Touch ripples and scale animations
|
||||
- **Keyboard Optimization**: Prevents zoom on input focus, auto-scroll to inputs
|
||||
|
||||
## ✏️ Handwriting Recognition
|
||||
|
||||
### Features Added
|
||||
|
||||
1. **Handwriting Canvas** (`public/js/handwriting.js`)
|
||||
- HTML5 Canvas for drawing
|
||||
- Multi-touch support
|
||||
- Smooth drawing with configurable pen settings
|
||||
- Stroke recording and playback
|
||||
|
||||
2. **Drawing Controls**
|
||||
- Clear canvas button
|
||||
- Undo last stroke
|
||||
- Adjustable pen size (1-10px)
|
||||
- Color selection
|
||||
- Auto-recognition toggle
|
||||
|
||||
3. **Recognition Engine**
|
||||
- Multiple recognition method support
|
||||
- Basic pattern recognition (fallback)
|
||||
- Integration with Google Vision API (configurable)
|
||||
- MyScript API support (configurable)
|
||||
|
||||
### Input Mode Toggle
|
||||
|
||||
Students can switch between:
|
||||
- **Typing Mode** (⌨️): Traditional keyboard input
|
||||
- **Handwriting Mode** (✏️): Canvas-based writing recognition
|
||||
|
||||
### Handwriting CSS Styles (`public/handwriting.css`)
|
||||
|
||||
- Canvas styling with proper focus indicators
|
||||
- Control buttons with touch-friendly sizing
|
||||
- Recognition status display
|
||||
- Tablet-optimized layouts
|
||||
- Mobile responsive design
|
||||
|
||||
## 🛠️ Implementation Details
|
||||
|
||||
### File Structure
|
||||
|
||||
```
|
||||
public/
|
||||
├── tablet.css # Tablet-optimized styles
|
||||
├── handwriting.css # Handwriting recognition styles
|
||||
└── js/
|
||||
├── handwriting.js # Handwriting recognition logic
|
||||
└── tablet-utils.js # Tablet optimization utilities
|
||||
```
|
||||
|
||||
### Key Functions
|
||||
|
||||
#### Tablet Utilities
|
||||
- `detectTablet()`: Automatic device detection
|
||||
- `optimizeButtons()`: Enhanced button interactions
|
||||
- `handleOrientationChange()`: Responsive orientation handling
|
||||
- `addSwipeGestures()`: Navigation gestures
|
||||
|
||||
#### Handwriting Recognition
|
||||
- `startDrawing()`: Begin stroke recording
|
||||
- `draw()`: Track drawing movements
|
||||
- `recognizeText()`: Convert drawing to text
|
||||
- `clearCanvas()`: Reset drawing area
|
||||
- `toggleInputMode()`: Switch between typing/writing
|
||||
|
||||
### Integration Points
|
||||
|
||||
1. **Game Integration**:
|
||||
- `submitAnswer()` function updated to handle both input types
|
||||
- `showWord()` function resets both input methods
|
||||
- Recognition results auto-fill the game input
|
||||
|
||||
2. **UI Enhancement**:
|
||||
- Activity cards with improved touch targets
|
||||
- Input mode toggle in game section
|
||||
- Canvas controls with tablet-friendly sizing
|
||||
|
||||
## 📱 Device Support
|
||||
|
||||
### Tablet Compatibility
|
||||
- iPad (all generations)
|
||||
- Android tablets
|
||||
- Windows tablets
|
||||
- Chrome OS tablets
|
||||
|
||||
### Browser Support
|
||||
- Safari (iOS)
|
||||
- Chrome (Android/Desktop)
|
||||
- Firefox
|
||||
- Edge
|
||||
|
||||
### Touch Features
|
||||
- Multi-touch drawing
|
||||
- Gesture navigation
|
||||
- Haptic feedback (where available)
|
||||
- Orientation detection
|
||||
|
||||
## 🚀 Usage Instructions
|
||||
|
||||
### For Students
|
||||
|
||||
1. **Starting the App**:
|
||||
- Login and access the student dashboard
|
||||
- Choose from improved activity cards
|
||||
|
||||
2. **Spelling Game with Handwriting**:
|
||||
- Start a spelling game
|
||||
- Use the toggle to switch between typing and handwriting
|
||||
- Draw letters on the canvas for recognition
|
||||
- Submit answers using either input method
|
||||
|
||||
3. **Drawing Tips**:
|
||||
- Write clearly with consistent letter sizes
|
||||
- Use print letters rather than cursive
|
||||
- Allow space between letters
|
||||
- Press firmly but write smoothly
|
||||
|
||||
### For Administrators
|
||||
|
||||
The tablet optimizations and handwriting features work seamlessly with existing admin functions:
|
||||
- User management remains unchanged
|
||||
- Word list management improved with better touch targets
|
||||
- Analytics display optimized for tablet viewing
|
||||
|
||||
## 🔧 Configuration
|
||||
|
||||
### Handwriting Recognition
|
||||
|
||||
To enable advanced recognition services, configure in `handwriting.js`:
|
||||
|
||||
```javascript
|
||||
// Google Vision API (requires API key)
|
||||
async recognizeWithGoogleVision(imageData) {
|
||||
// Add your Google Vision API implementation
|
||||
}
|
||||
|
||||
// MyScript API (requires API credentials)
|
||||
async recognizeWithMyScript() {
|
||||
// Add your MyScript API implementation
|
||||
}
|
||||
```
|
||||
|
||||
### Tablet Detection
|
||||
|
||||
Tablet detection can be customized in `tablet-utils.js`:
|
||||
|
||||
```javascript
|
||||
detectTablet() {
|
||||
// Customize detection logic based on your requirements
|
||||
const isTouch = 'ontouchstart' in window;
|
||||
const isTabletSize = window.innerWidth >= 768 && window.innerWidth <= 1024;
|
||||
return isTouch && isTabletSize;
|
||||
}
|
||||
```
|
||||
|
||||
## 🎯 Performance Considerations
|
||||
|
||||
### Optimization Features
|
||||
- Efficient canvas rendering
|
||||
- Minimal DOM manipulation
|
||||
- Event delegation for better performance
|
||||
- Throttled recognition requests
|
||||
- Optimized CSS animations
|
||||
|
||||
### Memory Management
|
||||
- Canvas cleanup on navigation
|
||||
- Event listener removal
|
||||
- Stroke data management
|
||||
- Automatic cleanup of drawing history
|
||||
|
||||
## 🔄 Future Enhancements
|
||||
|
||||
### Planned Features
|
||||
1. **Advanced Recognition**: ML-based handwriting models
|
||||
2. **Multi-language Support**: Recognition for different languages
|
||||
3. **Gesture Shortcuts**: Drawing gestures for common actions
|
||||
4. **Offline Recognition**: Client-side recognition capabilities
|
||||
5. **Collaborative Features**: Shared drawing sessions
|
||||
|
||||
### Accessibility
|
||||
- Voice commands integration
|
||||
- High contrast mode support
|
||||
- Screen reader compatibility
|
||||
- Keyboard navigation fallbacks
|
||||
|
||||
## 🐛 Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
1. **Canvas Not Responding**:
|
||||
- Check if touch events are properly bound
|
||||
- Verify canvas dimensions are set correctly
|
||||
- Ensure no CSS is blocking pointer events
|
||||
|
||||
2. **Recognition Not Working**:
|
||||
- Verify canvas has drawing data
|
||||
- Check console for recognition errors
|
||||
- Ensure fallback recognition is enabled
|
||||
|
||||
3. **Tablet Detection Issues**:
|
||||
- Test on actual tablet devices
|
||||
- Verify user agent detection
|
||||
- Check window dimensions
|
||||
|
||||
### Debug Mode
|
||||
|
||||
Enable debug logging by adding to console:
|
||||
```javascript
|
||||
localStorage.setItem('debugHandwriting', 'true');
|
||||
localStorage.setItem('debugTablet', 'true');
|
||||
```
|
||||
|
||||
## 📊 Analytics Integration
|
||||
|
||||
The new features integrate with existing analytics:
|
||||
- Track handwriting vs typing usage
|
||||
- Monitor recognition accuracy
|
||||
- Tablet interaction patterns
|
||||
- Performance metrics
|
||||
|
||||
## 🔒 Privacy and Security
|
||||
|
||||
- Canvas drawings are processed locally when possible
|
||||
- No drawing data is permanently stored
|
||||
- Recognition requests can be configured for privacy compliance
|
||||
- All touch interactions respect user privacy settings
|
||||
@@ -1,97 +0,0 @@
|
||||
# Tablet UI and Handwriting Issues - Troubleshooting Guide
|
||||
|
||||
## Current Status
|
||||
|
||||
### ✅ What's Been Implemented:
|
||||
|
||||
1. **Tablet-Optimized CSS**
|
||||
- `tablet.css` - Comprehensive tablet styles
|
||||
- `handwriting.css` - Canvas and handwriting-specific styles
|
||||
- Enhanced button sizes (min 50px height, larger fonts)
|
||||
- Touch-friendly spacing and padding
|
||||
- Responsive design for tablet viewports
|
||||
|
||||
2. **Handwriting Recognition System**
|
||||
- `handwriting.js` - Full canvas drawing implementation
|
||||
- Touch and mouse event handling
|
||||
- Basic pattern recognition (extendable)
|
||||
- Canvas controls (clear, undo, recognize)
|
||||
|
||||
3. **Enhanced HTML Structure**
|
||||
- Input mode toggle (Type ⌨️ / Write ✏️)
|
||||
- Canvas element with proper sizing
|
||||
- Tablet-friendly activity cards
|
||||
- Improved button layouts
|
||||
|
||||
### ❌ Current Issues Identified:
|
||||
|
||||
1. **Tablet CSS Not Fully Applied**
|
||||
- Media query might be too restrictive
|
||||
- Some styles being overridden by existing CSS
|
||||
- Need better tablet detection
|
||||
|
||||
2. **Handwriting Interface Not Visible**
|
||||
- Canvas might not be properly initialized
|
||||
- Toggle function might not be working
|
||||
- CSS display properties conflicting
|
||||
|
||||
## Quick Fixes Needed:
|
||||
|
||||
### Fix 1: Improve Tablet CSS Application
|
||||
```css
|
||||
/* Change media query to be more inclusive */
|
||||
@media screen and (min-width: 600px), (pointer: coarse) {
|
||||
/* Tablet styles */
|
||||
}
|
||||
```
|
||||
|
||||
### Fix 2: Force Tablet Styles in Main CSS
|
||||
Add `!important` declarations to critical tablet styles in `styles.css`
|
||||
|
||||
### Fix 3: Debug Canvas Initialization
|
||||
Add console logging to track canvas setup process
|
||||
|
||||
### Fix 4: Simplify Toggle Function
|
||||
Make input mode switching more reliable with explicit show/hide
|
||||
|
||||
## Immediate Action Plan:
|
||||
|
||||
1. **Test the separate tablet-test.html page** - This shows how it should work
|
||||
2. **Fix CSS conflicts** in the main app
|
||||
3. **Improve canvas initialization** with better error handling
|
||||
4. **Add debug logging** to track what's happening
|
||||
5. **Ensure student login works** to access handwriting features
|
||||
|
||||
## Files to Check:
|
||||
|
||||
- `public/index.html` - HTML structure
|
||||
- `public/styles.css` - Main styles (may need tablet overrides)
|
||||
- `public/tablet.css` - Tablet-specific styles
|
||||
- `public/handwriting.css` - Canvas styles
|
||||
- `public/js/handwriting.js` - Canvas functionality
|
||||
- `public/js/tablet-utils.js` - Tablet optimizations
|
||||
|
||||
## Testing Steps:
|
||||
|
||||
1. Open `tablet-test.html` to see working example
|
||||
2. Login as student (nate/nate123 or student1/123456)
|
||||
3. Start spelling game
|
||||
4. Check browser console for errors
|
||||
5. Try toggling between type/write modes
|
||||
6. Test canvas drawing if handwriting mode works
|
||||
|
||||
## Browser Console Commands for Testing:
|
||||
|
||||
```javascript
|
||||
// Check if handwriting is initialized
|
||||
console.log(window.handwritingRecognition);
|
||||
|
||||
// Check canvas element
|
||||
console.log(document.getElementById('handwritingCanvas'));
|
||||
|
||||
// Test toggle function
|
||||
window.toggleInputMode('handwriting');
|
||||
|
||||
// Check CSS loading
|
||||
console.log(document.querySelector('link[href*="tablet.css"]'));
|
||||
```
|
||||
@@ -1,168 +0,0 @@
|
||||
// Enhanced Analytics API endpoint for the Spelling Practice App
|
||||
|
||||
module.exports = function(app, DATA_DIR, files, readJsonSafe, path) {
|
||||
|
||||
// Get analytics data with additional metrics
|
||||
app.get('/getAnalytics', (req, res) => {
|
||||
try {
|
||||
const results = readJsonSafe(path.join(DATA_DIR, files.results), {});
|
||||
|
||||
// Prepare analytics data structure
|
||||
const analytics = {
|
||||
summary: {
|
||||
totalSessions: 0,
|
||||
totalWords: 0,
|
||||
correctWords: 0,
|
||||
overallAccuracy: 0,
|
||||
averageScore: 0,
|
||||
mostMissedWords: [],
|
||||
activityByDate: {}
|
||||
},
|
||||
userStats: {},
|
||||
wordStats: {}
|
||||
};
|
||||
|
||||
// Process all results data
|
||||
Object.keys(results).forEach(username => {
|
||||
// Skip if user has no results
|
||||
if (!Array.isArray(results[username]) || results[username].length === 0) return;
|
||||
|
||||
// Initialize user stats if not already present
|
||||
if (!analytics.userStats[username]) {
|
||||
analytics.userStats[username] = {
|
||||
totalSessions: 0,
|
||||
totalWords: 0,
|
||||
correctWords: 0,
|
||||
accuracy: 0,
|
||||
averageScore: 0,
|
||||
trend: [], // For progress over time
|
||||
recentResults: [],
|
||||
problemWords: []
|
||||
};
|
||||
}
|
||||
|
||||
// Process each session for this user
|
||||
results[username].forEach(session => {
|
||||
// Skip invalid sessions
|
||||
if (!session || !session.answers || !Array.isArray(session.answers)) return;
|
||||
|
||||
// Update summary counts
|
||||
analytics.summary.totalSessions++;
|
||||
analytics.userStats[username].totalSessions++;
|
||||
|
||||
// Process session date for activity tracking
|
||||
const sessionDate = new Date(session.timestamp || Date.now()).toISOString().split('T')[0];
|
||||
analytics.summary.activityByDate[sessionDate] = (analytics.summary.activityByDate[sessionDate] || 0) + 1;
|
||||
|
||||
// Collect score for trending data
|
||||
if (typeof session.score === 'number' && session.answers.length > 0) {
|
||||
const accuracy = session.score / session.answers.length;
|
||||
analytics.userStats[username].trend.push({
|
||||
date: sessionDate,
|
||||
accuracy: accuracy * 100,
|
||||
score: session.score,
|
||||
total: session.answers.length
|
||||
});
|
||||
}
|
||||
|
||||
// Keep only most recent 10 sessions for the trend data
|
||||
if (analytics.userStats[username].trend.length > 10) {
|
||||
analytics.userStats[username].trend = analytics.userStats[username].trend.slice(-10);
|
||||
}
|
||||
|
||||
// Get the 5 most recent results for display
|
||||
if (analytics.userStats[username].recentResults.length < 5) {
|
||||
analytics.userStats[username].recentResults.push({
|
||||
date: new Date(session.timestamp || Date.now()).toLocaleString(),
|
||||
score: session.score,
|
||||
total: session.answers.length,
|
||||
completed: session.completed
|
||||
});
|
||||
}
|
||||
|
||||
// Process individual words in the session
|
||||
session.answers.forEach(answer => {
|
||||
// Skip invalid answers
|
||||
if (!answer || typeof answer.word !== 'string') return;
|
||||
|
||||
// Update word stats
|
||||
const word = answer.word.toLowerCase();
|
||||
|
||||
if (!analytics.wordStats[word]) {
|
||||
analytics.wordStats[word] = {
|
||||
attempts: 0,
|
||||
correct: 0,
|
||||
incorrect: 0,
|
||||
accuracy: 0
|
||||
};
|
||||
}
|
||||
|
||||
analytics.wordStats[word].attempts++;
|
||||
analytics.summary.totalWords++;
|
||||
analytics.userStats[username].totalWords++;
|
||||
|
||||
if (answer.correct) {
|
||||
analytics.wordStats[word].correct++;
|
||||
analytics.summary.correctWords++;
|
||||
analytics.userStats[username].correctWords++;
|
||||
} else {
|
||||
analytics.wordStats[word].incorrect++;
|
||||
|
||||
// Track problem words for this user
|
||||
const problemWordIndex = analytics.userStats[username].problemWords.findIndex(pw => pw.word === word);
|
||||
|
||||
if (problemWordIndex >= 0) {
|
||||
analytics.userStats[username].problemWords[problemWordIndex].count++;
|
||||
} else {
|
||||
analytics.userStats[username].problemWords.push({
|
||||
word,
|
||||
count: 1
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// Calculate accuracy for this word
|
||||
analytics.wordStats[word].accuracy =
|
||||
analytics.wordStats[word].correct / analytics.wordStats[word].attempts * 100;
|
||||
});
|
||||
|
||||
// Calculate user accuracy and average score
|
||||
analytics.userStats[username].accuracy =
|
||||
analytics.userStats[username].correctWords / analytics.userStats[username].totalWords * 100 || 0;
|
||||
analytics.userStats[username].averageScore =
|
||||
analytics.userStats[username].correctWords / analytics.userStats[username].totalSessions || 0;
|
||||
});
|
||||
|
||||
// Sort problem words by count (descending)
|
||||
analytics.userStats[username].problemWords.sort((a, b) => b.count - a.count);
|
||||
|
||||
// Keep only top 5 problem words
|
||||
analytics.userStats[username].problemWords = analytics.userStats[username].problemWords.slice(0, 5);
|
||||
});
|
||||
|
||||
// Calculate overall metrics
|
||||
analytics.summary.overallAccuracy =
|
||||
analytics.summary.correctWords / analytics.summary.totalWords * 100 || 0;
|
||||
analytics.summary.averageScore =
|
||||
analytics.summary.correctWords / analytics.summary.totalSessions || 0;
|
||||
|
||||
// Find most missed words (top 5)
|
||||
const missedWords = Object.keys(analytics.wordStats)
|
||||
.map(word => ({
|
||||
word,
|
||||
missCount: analytics.wordStats[word].incorrect
|
||||
}))
|
||||
.filter(item => item.missCount > 0)
|
||||
.sort((a, b) => b.missCount - a.missCount)
|
||||
.slice(0, 5);
|
||||
|
||||
analytics.summary.mostMissedWords = missedWords;
|
||||
|
||||
res.json(analytics);
|
||||
} catch (error) {
|
||||
console.error('Error generating analytics:', error);
|
||||
res.status(500).send('Error generating analytics data');
|
||||
}
|
||||
});
|
||||
|
||||
}; // Close the module.exports function
|
||||
@@ -1,51 +0,0 @@
|
||||
# PowerShell script to build and push Docker image for Spelling Practice App
|
||||
|
||||
# Set variables
|
||||
$IMAGE_NAME = "ghcr.io/nmemmert/spelling"
|
||||
$VERSION = (Get-Content -Path "version.json" | ConvertFrom-Json).version
|
||||
|
||||
Write-Host "🔨 Building Docker image ${IMAGE_NAME}:${VERSION}..." -ForegroundColor Cyan
|
||||
|
||||
# Build the image
|
||||
docker build -t ${IMAGE_NAME}:${VERSION} -t ${IMAGE_NAME}:latest .
|
||||
|
||||
Write-Host "✅ Build completed." -ForegroundColor Green
|
||||
Write-Host "🧪 Testing the image..." -ForegroundColor Cyan
|
||||
|
||||
# Run container for testing
|
||||
docker run --name spelling-test -d -p 3001:3000 ${IMAGE_NAME}:${VERSION}
|
||||
|
||||
# Wait for container to start
|
||||
Start-Sleep -Seconds 5
|
||||
|
||||
# Test health endpoint
|
||||
try {
|
||||
$response = Invoke-WebRequest -Uri "http://localhost:3001/health" -UseBasicParsing
|
||||
if ($response.StatusCode -eq 200) {
|
||||
Write-Host "✅ Health check passed!" -ForegroundColor Green
|
||||
} else {
|
||||
Write-Host "❌ Health check failed with status $($response.StatusCode)" -ForegroundColor Red
|
||||
docker logs spelling-test
|
||||
docker stop spelling-test
|
||||
docker rm spelling-test
|
||||
exit 1
|
||||
}
|
||||
} catch {
|
||||
Write-Host "❌ Health check failed: $_" -ForegroundColor Red
|
||||
docker logs spelling-test
|
||||
docker stop spelling-test
|
||||
docker rm spelling-test
|
||||
exit 1
|
||||
}
|
||||
|
||||
# Stop and remove test container
|
||||
docker stop spelling-test
|
||||
docker rm spelling-test
|
||||
|
||||
Write-Host "📤 Pushing image to GitHub Container Registry..." -ForegroundColor Cyan
|
||||
docker push ${IMAGE_NAME}:${VERSION}
|
||||
docker push ${IMAGE_NAME}:latest
|
||||
|
||||
Write-Host "🚀 Successfully built and pushed ${IMAGE_NAME}:${VERSION}" -ForegroundColor Green
|
||||
Write-Host "Press any key to exit..."
|
||||
$null = $host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
|
||||
@@ -1,43 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Build and push Docker image for Spelling Practice App
|
||||
|
||||
# Set variables
|
||||
IMAGE_NAME="ghcr.io/nmemmert/spelling"
|
||||
VERSION=$(grep -o '"version": "[^"]*"' version.json | cut -d'"' -f4)
|
||||
|
||||
echo "🔨 Building Docker image ${IMAGE_NAME}:${VERSION}..."
|
||||
|
||||
# Build the image
|
||||
docker build -t ${IMAGE_NAME}:${VERSION} -t ${IMAGE_NAME}:latest .
|
||||
|
||||
echo "✅ Build completed."
|
||||
echo "🧪 Testing the image..."
|
||||
|
||||
# Run container for testing
|
||||
docker run --name spelling-test -d -p 3001:3000 ${IMAGE_NAME}:${VERSION}
|
||||
|
||||
# Wait for container to start
|
||||
sleep 5
|
||||
|
||||
# Test health endpoint
|
||||
HEALTH_STATUS=$(curl -s -o /dev/null -w "%{http_code}" http://localhost:3001/health)
|
||||
|
||||
if [ "$HEALTH_STATUS" = "200" ]; then
|
||||
echo "✅ Health check passed!"
|
||||
else
|
||||
echo "❌ Health check failed with status $HEALTH_STATUS"
|
||||
docker logs spelling-test
|
||||
docker stop spelling-test
|
||||
docker rm spelling-test
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Stop and remove test container
|
||||
docker stop spelling-test
|
||||
docker rm spelling-test
|
||||
|
||||
echo "📤 Pushing image to GitHub Container Registry..."
|
||||
docker push ${IMAGE_NAME}:${VERSION}
|
||||
docker push ${IMAGE_NAME}:latest
|
||||
|
||||
echo "🚀 Successfully built and pushed ${IMAGE_NAME}:${VERSION}"
|
||||
@@ -1,116 +0,0 @@
|
||||
# PowerShell script to build and push Docker image with "test" tag for tablet testing
|
||||
|
||||
# Set variables
|
||||
$IMAGE_NAME = "ghcr.io/nmemmert/spelling"
|
||||
$TEST_TAG = "test"
|
||||
$VERSION = (Get-Content -Path "version.json" | ConvertFrom-Json).version
|
||||
|
||||
Write-Host "🖊️ Building Docker image for TABLET HANDWRITING TESTING..." -ForegroundColor Magenta
|
||||
Write-Host "📦 Image: ${IMAGE_NAME}:${TEST_TAG}" -ForegroundColor Cyan
|
||||
Write-Host "🔖 Base Version: ${VERSION}" -ForegroundColor Cyan
|
||||
|
||||
# Add test-specific metadata to the build
|
||||
$BUILD_DATE = Get-Date -Format "yyyy-MM-ddTHH:mm:ssZ"
|
||||
$GIT_COMMIT = git rev-parse --short HEAD 2>$null
|
||||
if (-not $GIT_COMMIT) { $GIT_COMMIT = "unknown" }
|
||||
|
||||
Write-Host "📝 Git Commit: $GIT_COMMIT" -ForegroundColor Yellow
|
||||
Write-Host "📅 Build Date: $BUILD_DATE" -ForegroundColor Yellow
|
||||
|
||||
# Build the image with test tag and labels
|
||||
Write-Host "🔨 Building Docker image..." -ForegroundColor Cyan
|
||||
docker build `
|
||||
--label "version=${VERSION}-test" `
|
||||
--label "build-date=${BUILD_DATE}" `
|
||||
--label "git-commit=${GIT_COMMIT}" `
|
||||
--label "tablet-features=enabled" `
|
||||
--label "handwriting-recognition=native+enhanced" `
|
||||
-t ${IMAGE_NAME}:${TEST_TAG} `
|
||||
-t ${IMAGE_NAME}:${VERSION}-test `
|
||||
.
|
||||
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
Write-Host "❌ Docker build failed!" -ForegroundColor Red
|
||||
exit 1
|
||||
}
|
||||
|
||||
Write-Host "✅ Build completed." -ForegroundColor Green
|
||||
Write-Host "🧪 Testing the image..." -ForegroundColor Cyan
|
||||
|
||||
# Run container for testing
|
||||
docker run --name spelling-test-tablet -d -p 3002:3000 ${IMAGE_NAME}:${TEST_TAG}
|
||||
|
||||
# Wait for container to start
|
||||
Write-Host "⏱️ Waiting for container to start..." -ForegroundColor Yellow
|
||||
Start-Sleep -Seconds 8
|
||||
|
||||
# Test health endpoint
|
||||
try {
|
||||
$response = Invoke-WebRequest -Uri "http://localhost:3002/health" -UseBasicParsing -TimeoutSec 10
|
||||
if ($response.StatusCode -eq 200) {
|
||||
Write-Host "✅ Health check passed!" -ForegroundColor Green
|
||||
|
||||
# Test main page
|
||||
$mainResponse = Invoke-WebRequest -Uri "http://localhost:3002/" -UseBasicParsing -TimeoutSec 10
|
||||
if ($mainResponse.StatusCode -eq 200) {
|
||||
Write-Host "✅ Main page accessible!" -ForegroundColor Green
|
||||
|
||||
# Check for handwriting features in the HTML
|
||||
if ($mainResponse.Content -like "*native-handwriting.js*") {
|
||||
Write-Host "🖊️ Native handwriting support detected!" -ForegroundColor Green
|
||||
}
|
||||
if ($mainResponse.Content -like "*handwriting-canvas*") {
|
||||
Write-Host "🎨 Handwriting canvas found!" -ForegroundColor Green
|
||||
}
|
||||
}
|
||||
} else {
|
||||
Write-Host "❌ Health check failed with status $($response.StatusCode)" -ForegroundColor Red
|
||||
docker logs spelling-test-tablet
|
||||
docker stop spelling-test-tablet
|
||||
docker rm spelling-test-tablet
|
||||
exit 1
|
||||
}
|
||||
} catch {
|
||||
Write-Host "❌ Health check failed: $_" -ForegroundColor Red
|
||||
Write-Host "📋 Container logs:" -ForegroundColor Yellow
|
||||
docker logs spelling-test-tablet
|
||||
docker stop spelling-test-tablet
|
||||
docker rm spelling-test-tablet
|
||||
exit 1
|
||||
}
|
||||
|
||||
# Stop and remove test container
|
||||
docker stop spelling-test-tablet
|
||||
docker rm spelling-test-tablet
|
||||
|
||||
Write-Host "📤 Pushing image to GitHub Container Registry..." -ForegroundColor Cyan
|
||||
Write-Host "🏷️ Pushing tags: ${TEST_TAG} and ${VERSION}-test" -ForegroundColor Yellow
|
||||
|
||||
docker push ${IMAGE_NAME}:${TEST_TAG}
|
||||
docker push ${IMAGE_NAME}:${VERSION}-test
|
||||
|
||||
if ($LASTEXITCODE -eq 0) {
|
||||
Write-Host "" -ForegroundColor Green
|
||||
Write-Host "🚀 Successfully built and pushed TABLET TEST image!" -ForegroundColor Green
|
||||
Write-Host "" -ForegroundColor White
|
||||
Write-Host "📱 TABLET TESTING INSTRUCTIONS:" -ForegroundColor Magenta
|
||||
Write-Host "=================================" -ForegroundColor Magenta
|
||||
Write-Host "1. Deploy using: docker pull ${IMAGE_NAME}:${TEST_TAG}" -ForegroundColor White
|
||||
Write-Host "2. Run on tablet-accessible server" -ForegroundColor White
|
||||
Write-Host "3. Test handwriting recognition with stylus/touch" -ForegroundColor White
|
||||
Write-Host "4. Features included:" -ForegroundColor White
|
||||
Write-Host " • Native tablet handwriting APIs" -ForegroundColor Cyan
|
||||
Write-Host " • Pressure-sensitive stylus support" -ForegroundColor Cyan
|
||||
Write-Host " • Enhanced pattern recognition" -ForegroundColor Cyan
|
||||
Write-Host " • Touch event optimization" -ForegroundColor Cyan
|
||||
Write-Host " • Pointer Events API integration" -ForegroundColor Cyan
|
||||
Write-Host "" -ForegroundColor White
|
||||
Write-Host "🔗 Image: ${IMAGE_NAME}:${TEST_TAG}" -ForegroundColor Yellow
|
||||
Write-Host "" -ForegroundColor White
|
||||
} else {
|
||||
Write-Host "❌ Push failed!" -ForegroundColor Red
|
||||
exit 1
|
||||
}
|
||||
|
||||
Write-Host "Press any key to exit..."
|
||||
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
|
||||
@@ -1,63 +0,0 @@
|
||||
{
|
||||
"nate": {
|
||||
"earned": [
|
||||
{
|
||||
"id": "perfect_round",
|
||||
"name": "Perfect Round",
|
||||
"icon": "🏅",
|
||||
"earnedAt": "2025-08-14T13:36:30.690Z"
|
||||
},
|
||||
{
|
||||
"id": "no_misses",
|
||||
"name": "No Misses",
|
||||
"icon": "🏅",
|
||||
"earnedAt": "2025-08-14T13:36:30.690Z"
|
||||
},
|
||||
{
|
||||
"id": "accuracy_master",
|
||||
"name": "Accuracy Master",
|
||||
"icon": "🏅",
|
||||
"earnedAt": "2025-08-14T13:36:30.690Z"
|
||||
},
|
||||
{
|
||||
"id": "practice_streak",
|
||||
"name": "Practice Streak",
|
||||
"icon": "🏅",
|
||||
"earnedAt": "2025-08-14T13:36:30.690Z"
|
||||
},
|
||||
{
|
||||
"id": "vocabulary_pro",
|
||||
"name": "Vocabulary Pro",
|
||||
"icon": "🏅",
|
||||
"earnedAt": "2025-08-14T13:36:30.690Z"
|
||||
},
|
||||
{
|
||||
"id": "perfect_accuracy",
|
||||
"name": "Perfect Score",
|
||||
"icon": "🏆",
|
||||
"description": "You scored 100% on your spelling test!",
|
||||
"category": "accuracy",
|
||||
"earnedAt": "2025-08-14T13:36:30.690Z"
|
||||
}
|
||||
],
|
||||
"counts": {
|
||||
"accuracy": 1
|
||||
}
|
||||
},
|
||||
"admin1": {
|
||||
"earned": [
|
||||
{
|
||||
"id": "perfect_accuracy",
|
||||
"name": "Perfect Score",
|
||||
"icon": "🏆",
|
||||
"category": "accuracy",
|
||||
"earnedAt": "2025-08-13T20:29:17.744Z"
|
||||
}
|
||||
],
|
||||
"counts": {
|
||||
"accuracy": 1
|
||||
}
|
||||
},
|
||||
"student1": [],
|
||||
"testuser": []
|
||||
}
|
||||
@@ -1,89 +0,0 @@
|
||||
{
|
||||
"daily": [
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"name": "Practice Makes Perfect",
|
||||
"description": "Complete 10 practice words in a day",
|
||||
"type": "daily",
|
||||
"target": 10,
|
||||
"points": 50,
|
||||
"icon": "🎯"
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"name": "Sharp Shooter",
|
||||
"description": "Achieve 90% accuracy in daily practice",
|
||||
"type": "daily",
|
||||
"target": 0.9,
|
||||
"points": 75,
|
||||
"icon": "🎯"
|
||||
},
|
||||
{
|
||||
"id": "daily-streak-3",
|
||||
"name": "On Fire",
|
||||
"description": "Get 3 words correct in a row",
|
||||
"type": "daily",
|
||||
"target": 3,
|
||||
"points": 30,
|
||||
"icon": "🔥"
|
||||
}
|
||||
],
|
||||
"weekly": [
|
||||
{
|
||||
"id": "weekly-words-50",
|
||||
"name": "Word Warrior",
|
||||
"description": "Practice 50 words in a week",
|
||||
"type": "weekly",
|
||||
"target": 50,
|
||||
"points": 200,
|
||||
"icon": "⚔️"
|
||||
},
|
||||
{
|
||||
"id": "weekly-days-5",
|
||||
"name": "Dedicated Scholar",
|
||||
"description": "Practice on 5 different days this week",
|
||||
"type": "weekly",
|
||||
"target": 5,
|
||||
"points": 250,
|
||||
"icon": "📚"
|
||||
}
|
||||
],
|
||||
"achievements": [
|
||||
{
|
||||
"id": "achievement-words-100",
|
||||
"name": "Century Club",
|
||||
"description": "Practice 100 total words",
|
||||
"type": "achievement",
|
||||
"target": 100,
|
||||
"points": 100,
|
||||
"icon": "🏆"
|
||||
},
|
||||
{
|
||||
"id": "achievement-words-500",
|
||||
"name": "Word Master",
|
||||
"description": "Practice 500 total words",
|
||||
"type": "achievement",
|
||||
"target": 500,
|
||||
"points": 500,
|
||||
"icon": "👑"
|
||||
},
|
||||
{
|
||||
"id": "achievement-streak-7",
|
||||
"name": "Weekly Warrior",
|
||||
"description": "Maintain a 7-day practice streak",
|
||||
"type": "achievement",
|
||||
"target": 7,
|
||||
"points": 300,
|
||||
"icon": "📅"
|
||||
},
|
||||
{
|
||||
"id": "achievement-accuracy-95",
|
||||
"name": "Spelling Bee Champion",
|
||||
"description": "Maintain 95% accuracy across 100 words",
|
||||
"type": "achievement",
|
||||
"target": 0.95,
|
||||
"points": 400,
|
||||
"icon": "🐝"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,511 +0,0 @@
|
||||
{
|
||||
"allTime": {
|
||||
"accuracy": [
|
||||
{
|
||||
"username": "benjamina31",
|
||||
"value": 94.4,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "loganm87",
|
||||
"value": 93.4,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "williamh77",
|
||||
"value": 90,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "logant84",
|
||||
"value": 88.8,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "sophiaa25",
|
||||
"value": 87.5,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "emmaa72",
|
||||
"value": 86.7,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "jacobg47",
|
||||
"value": 84.6,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "oliverb12",
|
||||
"value": 81.7,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "student1",
|
||||
"value": 79,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "admin1",
|
||||
"value": 77.1,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "testuser",
|
||||
"value": 77.1,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "nate",
|
||||
"value": 76.3,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "ameliab34",
|
||||
"value": 74.5,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "masonl4",
|
||||
"value": 73.1,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
}
|
||||
],
|
||||
"totalWords": [
|
||||
{
|
||||
"username": "nate",
|
||||
"value": 1352,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "logant84",
|
||||
"value": 966,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "williamh77",
|
||||
"value": 846,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "oliverb12",
|
||||
"value": 835,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "student1",
|
||||
"value": 819,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "testuser",
|
||||
"value": 761,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "ameliab34",
|
||||
"value": 743,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "admin1",
|
||||
"value": 724,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "masonl4",
|
||||
"value": 530,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "sophiaa25",
|
||||
"value": 419,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "benjamina31",
|
||||
"value": 344,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "emmaa72",
|
||||
"value": 304,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "loganm87",
|
||||
"value": 252,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "jacobg47",
|
||||
"value": 110,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
}
|
||||
],
|
||||
"sessionsCompleted": [
|
||||
{
|
||||
"username": "nate",
|
||||
"value": 129,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "student1",
|
||||
"value": 80,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "admin1",
|
||||
"value": 73,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "testuser",
|
||||
"value": 71,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "logant84",
|
||||
"value": 45,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "benjamina31",
|
||||
"value": 41,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "jacobg47",
|
||||
"value": 37,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "loganm87",
|
||||
"value": 33,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "sophiaa25",
|
||||
"value": 31,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "emmaa72",
|
||||
"value": 28,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "masonl4",
|
||||
"value": 22,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "williamh77",
|
||||
"value": 21,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "ameliab34",
|
||||
"value": 9,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "oliverb12",
|
||||
"value": 7,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
}
|
||||
],
|
||||
"streakDays": [
|
||||
{
|
||||
"username": "nate",
|
||||
"value": 18,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "loganm87",
|
||||
"value": 14,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "logant84",
|
||||
"value": 12,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "benjamina31",
|
||||
"value": 12,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "student1",
|
||||
"value": 10,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "sophiaa25",
|
||||
"value": 10,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "williamh77",
|
||||
"value": 9,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "oliverb12",
|
||||
"value": 8,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "testuser",
|
||||
"value": 7,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "ameliab34",
|
||||
"value": 7,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "admin1",
|
||||
"value": 6,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "jacobg47",
|
||||
"value": 2,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "emmaa72",
|
||||
"value": 1,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "masonl4",
|
||||
"value": 1,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
}
|
||||
]
|
||||
},
|
||||
"weekly": {
|
||||
"accuracy": [
|
||||
{
|
||||
"username": "benjamina31",
|
||||
"value": 98.2,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "loganm87",
|
||||
"value": 95.80000000000001,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "logant84",
|
||||
"value": 89.8,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "emmaa72",
|
||||
"value": 89.3,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "williamh77",
|
||||
"value": 88.8,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "sophiaa25",
|
||||
"value": 87.5,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "student1",
|
||||
"value": 83.7,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "jacobg47",
|
||||
"value": 81.19999999999999,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "oliverb12",
|
||||
"value": 80.10000000000001,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "nate",
|
||||
"value": 77.2,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "ameliab34",
|
||||
"value": 76.9,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "masonl4",
|
||||
"value": 75.39999999999999,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "testuser",
|
||||
"value": 74.1,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "admin1",
|
||||
"value": 73.19999999999999,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
}
|
||||
],
|
||||
"totalWords": [
|
||||
{
|
||||
"username": "logant84",
|
||||
"value": 53,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "masonl4",
|
||||
"value": 52,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "oliverb12",
|
||||
"value": 50,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "ameliab34",
|
||||
"value": 40,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "admin1",
|
||||
"value": 35,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "sophiaa25",
|
||||
"value": 34,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "student1",
|
||||
"value": 33,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "testuser",
|
||||
"value": 32,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "benjamina31",
|
||||
"value": 31,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "nate",
|
||||
"value": 21,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "emmaa72",
|
||||
"value": 19,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "loganm87",
|
||||
"value": 17,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "williamh77",
|
||||
"value": 15,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
},
|
||||
{
|
||||
"username": "jacobg47",
|
||||
"value": 11,
|
||||
"timestamp": "2025-08-13T16:18:54.828Z"
|
||||
}
|
||||
],
|
||||
"sessionsCompleted": [
|
||||
{
|
||||
"username": "logant84",
|
||||
"value": 7,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
},
|
||||
{
|
||||
"username": "admin1",
|
||||
"value": 6,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
},
|
||||
{
|
||||
"username": "loganm87",
|
||||
"value": 5,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
},
|
||||
{
|
||||
"username": "emmaa72",
|
||||
"value": 5,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
},
|
||||
{
|
||||
"username": "jacobg47",
|
||||
"value": 5,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
},
|
||||
{
|
||||
"username": "benjamina31",
|
||||
"value": 5,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
},
|
||||
{
|
||||
"username": "masonl4",
|
||||
"value": 4,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
},
|
||||
{
|
||||
"username": "williamh77",
|
||||
"value": 3,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
},
|
||||
{
|
||||
"username": "nate",
|
||||
"value": 2,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
},
|
||||
{
|
||||
"username": "student1",
|
||||
"value": 2,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
},
|
||||
{
|
||||
"username": "sophiaa25",
|
||||
"value": 2,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
},
|
||||
{
|
||||
"username": "testuser",
|
||||
"value": 1,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
},
|
||||
{
|
||||
"username": "ameliab34",
|
||||
"value": 1,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
},
|
||||
{
|
||||
"username": "oliverb12",
|
||||
"value": 1,
|
||||
"timestamp": "2025-08-13T16:18:54.829Z"
|
||||
}
|
||||
]
|
||||
},
|
||||
"currentWeek": "2025-3"
|
||||
}
|
||||
@@ -1,551 +0,0 @@
|
||||
{
|
||||
"admin1": {
|
||||
"streak": {
|
||||
"current": 5,
|
||||
"longest": 11,
|
||||
"lastPractice": "2025-08-12"
|
||||
},
|
||||
"points": 1017,
|
||||
"level": 3,
|
||||
"dailyChallenges": [
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-13",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-12",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-12",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-streak-3",
|
||||
"date": "2025-08-12",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-10",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-09",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-09",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-streak-3",
|
||||
"date": "2025-08-09",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-08",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-08",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-streak-3",
|
||||
"date": "2025-08-08",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-07",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-07",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-streak-3",
|
||||
"date": "2025-08-07",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-06",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-06",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-streak-3",
|
||||
"date": "2025-08-06",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-05",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-05",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-04",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-04",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-02",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-07-31",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-07-31",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-streak-3",
|
||||
"date": "2025-07-31",
|
||||
"progress": 1
|
||||
}
|
||||
],
|
||||
"weeklyChallenges": [
|
||||
{
|
||||
"id": "weekly-days-5",
|
||||
"weekStart": "2025-07-30",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "weekly-words-50",
|
||||
"weekStart": "2025-07-23",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "weekly-days-5",
|
||||
"weekStart": "2025-07-16",
|
||||
"progress": 1
|
||||
}
|
||||
],
|
||||
"achievements": [
|
||||
{
|
||||
"id": "achievement-words-100",
|
||||
"date": "2025-07-22",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "achievement-words-500",
|
||||
"date": "2025-08-01",
|
||||
"progress": 1
|
||||
}
|
||||
],
|
||||
"stats": {
|
||||
"wordsAttempted": 574,
|
||||
"wordsCorrect": 415.86,
|
||||
"sessionsCompleted": 69,
|
||||
"averageAccuracy": 0.9
|
||||
}
|
||||
},
|
||||
"nate": {
|
||||
"streak": {
|
||||
"current": 2,
|
||||
"longest": 12,
|
||||
"lastPractice": "2025-08-12"
|
||||
},
|
||||
"points": 543,
|
||||
"level": 2,
|
||||
"dailyChallenges": [
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-13",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-13",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-11",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-11",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-09",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-09",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-07",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-07",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-06",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-05",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-05",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-04",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-04",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-streak-3",
|
||||
"date": "2025-08-04",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-03",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-03",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-02",
|
||||
"progress": 1
|
||||
}
|
||||
],
|
||||
"weeklyChallenges": [
|
||||
{
|
||||
"id": "weekly-words-50",
|
||||
"weekStart": "2025-07-23",
|
||||
"progress": 1
|
||||
}
|
||||
],
|
||||
"achievements": [
|
||||
{
|
||||
"id": "achievement-words-100",
|
||||
"date": "2025-08-01",
|
||||
"progress": 1
|
||||
}
|
||||
],
|
||||
"stats": {
|
||||
"wordsAttempted": 817,
|
||||
"wordsCorrect": 317.68,
|
||||
"sessionsCompleted": 79,
|
||||
"averageAccuracy": 0.95
|
||||
}
|
||||
},
|
||||
"student1": {
|
||||
"streak": {
|
||||
"current": 6,
|
||||
"longest": 9,
|
||||
"lastPractice": "2025-08-12"
|
||||
},
|
||||
"points": 574,
|
||||
"level": 2,
|
||||
"dailyChallenges": [
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-13",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-12",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-12",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-11",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-11",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-10",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-06",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-06",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-05",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-05",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-04",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-04",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-streak-3",
|
||||
"date": "2025-08-04",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-03",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-02",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-01",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-01",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-07-31",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-07-31",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-streak-3",
|
||||
"date": "2025-07-31",
|
||||
"progress": 1
|
||||
}
|
||||
],
|
||||
"weeklyChallenges": [
|
||||
{
|
||||
"id": "weekly-words-50",
|
||||
"weekStart": "2025-08-06",
|
||||
"progress": 1
|
||||
}
|
||||
],
|
||||
"achievements": [
|
||||
{
|
||||
"id": "achievement-words-100",
|
||||
"date": "2025-07-23",
|
||||
"progress": 1
|
||||
}
|
||||
],
|
||||
"stats": {
|
||||
"wordsAttempted": 102,
|
||||
"wordsCorrect": 648.1800000000001,
|
||||
"sessionsCompleted": 65,
|
||||
"averageAccuracy": 0.78
|
||||
}
|
||||
},
|
||||
"testuser": {
|
||||
"streak": {
|
||||
"current": 13,
|
||||
"longest": 20,
|
||||
"lastPractice": "2025-08-12"
|
||||
},
|
||||
"points": 843,
|
||||
"level": 2,
|
||||
"dailyChallenges": [
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-13",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-13",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-12",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-11",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-11",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-streak-3",
|
||||
"date": "2025-08-11",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-09",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-09",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-08",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-07",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-06",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-06",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-05",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-04",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-02",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-practice-10",
|
||||
"date": "2025-08-01",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-accuracy-90",
|
||||
"date": "2025-08-01",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "daily-streak-3",
|
||||
"date": "2025-08-01",
|
||||
"progress": 1
|
||||
}
|
||||
],
|
||||
"weeklyChallenges": [
|
||||
{
|
||||
"id": "weekly-words-50",
|
||||
"weekStart": "2025-08-06",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "weekly-words-50",
|
||||
"weekStart": "2025-07-30",
|
||||
"progress": 1
|
||||
}
|
||||
],
|
||||
"achievements": [
|
||||
{
|
||||
"id": "achievement-words-100",
|
||||
"date": "2025-08-03",
|
||||
"progress": 1
|
||||
},
|
||||
{
|
||||
"id": "achievement-words-500",
|
||||
"date": "2025-07-18",
|
||||
"progress": 1
|
||||
}
|
||||
],
|
||||
"stats": {
|
||||
"wordsAttempted": 353,
|
||||
"wordsCorrect": 789.4499999999999,
|
||||
"sessionsCompleted": 87,
|
||||
"averageAccuracy": 0.88
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,122 +0,0 @@
|
||||
{
|
||||
"admin1": [
|
||||
{
|
||||
"answers": [
|
||||
{
|
||||
"word": "example",
|
||||
"correct": true
|
||||
},
|
||||
{
|
||||
"word": "test",
|
||||
"correct": true
|
||||
}
|
||||
],
|
||||
"timestamp": "2025-08-13T18:38:39.3537417-04:00",
|
||||
"score": 100
|
||||
}
|
||||
],
|
||||
"student1": [],
|
||||
"nate": [
|
||||
{
|
||||
"score": 3,
|
||||
"completed": true,
|
||||
"answers": [
|
||||
{
|
||||
"word": "bate",
|
||||
"input": "bate",
|
||||
"correct": true
|
||||
},
|
||||
{
|
||||
"word": "hate",
|
||||
"input": "hate",
|
||||
"correct": true
|
||||
},
|
||||
{
|
||||
"word": "late",
|
||||
"input": "late",
|
||||
"correct": true
|
||||
}
|
||||
],
|
||||
"timestamp": "2025-08-14T13:36:05.098Z",
|
||||
"type": "typing"
|
||||
},
|
||||
{
|
||||
"score": 100,
|
||||
"completed": true,
|
||||
"answers": [
|
||||
{
|
||||
"word": "bate",
|
||||
"attempt": "bate",
|
||||
"correct": true
|
||||
},
|
||||
{
|
||||
"word": "hate",
|
||||
"attempt": "hate",
|
||||
"correct": true
|
||||
},
|
||||
{
|
||||
"word": "late",
|
||||
"attempt": "late",
|
||||
"correct": true
|
||||
}
|
||||
],
|
||||
"timestamp": "2025-08-14T13:36:30.685Z"
|
||||
}
|
||||
],
|
||||
"testuser": [
|
||||
{
|
||||
"score": 85,
|
||||
"completed": true,
|
||||
"answers": [
|
||||
{
|
||||
"word": "apple",
|
||||
"correct": true
|
||||
},
|
||||
{
|
||||
"word": "banana",
|
||||
"correct": true
|
||||
},
|
||||
{
|
||||
"word": "cherry",
|
||||
"correct": true
|
||||
},
|
||||
{
|
||||
"word": "difficult",
|
||||
"correct": false
|
||||
},
|
||||
{
|
||||
"word": "elephant",
|
||||
"correct": true
|
||||
}
|
||||
],
|
||||
"timestamp": "2025-08-13T22:55:01.443Z"
|
||||
},
|
||||
{
|
||||
"score": 90,
|
||||
"completed": true,
|
||||
"answers": [
|
||||
{
|
||||
"word": "apple",
|
||||
"correct": true
|
||||
},
|
||||
{
|
||||
"word": "banana",
|
||||
"correct": true
|
||||
},
|
||||
{
|
||||
"word": "cherry",
|
||||
"correct": true
|
||||
},
|
||||
{
|
||||
"word": "difficult",
|
||||
"correct": false
|
||||
},
|
||||
{
|
||||
"word": "elephant",
|
||||
"correct": true
|
||||
}
|
||||
],
|
||||
"timestamp": "2025-08-13T22:55:32.631Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
-18008
File diff suppressed because it is too large.
Load diff
@@ -1,300 +0,0 @@
|
||||
{
|
||||
"nate": {
|
||||
"settings": {
|
||||
"dailyLimit": 20,
|
||||
"reviewThreshold": 3,
|
||||
"newWordsPerDay": 5
|
||||
},
|
||||
"stats": {
|
||||
"totalReviews": 15,
|
||||
"correctReviews": 9,
|
||||
"totalWords": 6,
|
||||
"masteredWords": 0
|
||||
},
|
||||
"words": {
|
||||
"computer": {
|
||||
"easeFactor": 2.5,
|
||||
"interval": 3,
|
||||
"repetitions": 3,
|
||||
"lastReview": "2025-08-10",
|
||||
"nextReview": "2025-08-13"
|
||||
},
|
||||
"keyboard": {
|
||||
"easeFactor": 2.3,
|
||||
"interval": 2,
|
||||
"repetitions": 2,
|
||||
"lastReview": "2025-08-11",
|
||||
"nextReview": "2025-08-13"
|
||||
},
|
||||
"mouse": {
|
||||
"easeFactor": 2.8,
|
||||
"interval": 4,
|
||||
"repetitions": 4,
|
||||
"lastReview": "2025-08-09",
|
||||
"nextReview": "2025-08-13"
|
||||
},
|
||||
"screen": {
|
||||
"easeFactor": 3,
|
||||
"interval": 6,
|
||||
"repetitions": 5,
|
||||
"lastReview": "2025-08-07",
|
||||
"nextReview": "2025-08-13"
|
||||
},
|
||||
"printer": {
|
||||
"easeFactor": 2.2,
|
||||
"interval": 1,
|
||||
"repetitions": 1,
|
||||
"lastReview": "2025-08-12",
|
||||
"nextReview": "2025-08-13"
|
||||
},
|
||||
"not": {
|
||||
"easeFactor": 2.6,
|
||||
"interval": 7,
|
||||
"repetitions": 3,
|
||||
"lastReview": "2025-08-12",
|
||||
"nextReview": "2025-08-20"
|
||||
},
|
||||
"bot": {
|
||||
"easeFactor": 2.8,
|
||||
"interval": 15,
|
||||
"repetitions": 4,
|
||||
"lastReview": "2025-08-05",
|
||||
"nextReview": "2025-08-14"
|
||||
},
|
||||
"snot": {
|
||||
"easeFactor": 2.2,
|
||||
"interval": 1,
|
||||
"repetitions": 1,
|
||||
"lastReview": "2025-08-12",
|
||||
"nextReview": "2025-08-14"
|
||||
},
|
||||
"bate": {
|
||||
"easeFactor": 2.1,
|
||||
"interval": 1,
|
||||
"repetitions": 1,
|
||||
"lastReview": "2025-08-12",
|
||||
"nextReview": "2025-08-14"
|
||||
},
|
||||
"hate": {
|
||||
"easeFactor": 2.2,
|
||||
"interval": 3,
|
||||
"repetitions": 2,
|
||||
"lastReview": "2025-08-10",
|
||||
"nextReview": "2025-08-15"
|
||||
},
|
||||
"late": {
|
||||
"easeFactor": 2.5,
|
||||
"interval": 15,
|
||||
"repetitions": 4,
|
||||
"lastReview": "2025-08-11",
|
||||
"nextReview": "2025-08-11"
|
||||
}
|
||||
}
|
||||
},
|
||||
"student1": {
|
||||
"settings": {
|
||||
"dailyLimit": 20,
|
||||
"reviewThreshold": 3,
|
||||
"newWordsPerDay": 5
|
||||
},
|
||||
"stats": {
|
||||
"totalReviews": 10,
|
||||
"correctReviews": 5,
|
||||
"totalWords": 5,
|
||||
"masteredWords": 0
|
||||
},
|
||||
"words": {
|
||||
"apple": {
|
||||
"easeFactor": 2.2,
|
||||
"interval": 3,
|
||||
"repetitions": 2,
|
||||
"lastReview": "2025-08-10",
|
||||
"nextReview": "2025-08-10"
|
||||
},
|
||||
"banana": {
|
||||
"easeFactor": 2.1,
|
||||
"interval": 1,
|
||||
"repetitions": 1,
|
||||
"lastReview": "2025-08-12",
|
||||
"nextReview": "2025-08-14"
|
||||
},
|
||||
"cherry": {
|
||||
"easeFactor": 2.4,
|
||||
"interval": 3,
|
||||
"repetitions": 2,
|
||||
"lastReview": "2025-08-11",
|
||||
"nextReview": "2025-08-16"
|
||||
},
|
||||
"date": {
|
||||
"easeFactor": 2.5,
|
||||
"interval": 1,
|
||||
"repetitions": 1,
|
||||
"lastReview": "2025-08-12",
|
||||
"nextReview": "2025-08-13"
|
||||
},
|
||||
"elderberry": {
|
||||
"easeFactor": 2.3,
|
||||
"interval": 15,
|
||||
"repetitions": 4,
|
||||
"lastReview": "2025-08-11",
|
||||
"nextReview": "2025-08-11"
|
||||
}
|
||||
}
|
||||
},
|
||||
"admin1": {
|
||||
"settings": {
|
||||
"dailyLimit": 20,
|
||||
"reviewThreshold": 3,
|
||||
"newWordsPerDay": 5
|
||||
},
|
||||
"stats": {
|
||||
"totalReviews": 12,
|
||||
"correctReviews": 9,
|
||||
"totalWords": 3,
|
||||
"masteredWords": 1
|
||||
},
|
||||
"words": {
|
||||
"administration": {
|
||||
"easeFactor": 2.5,
|
||||
"interval": 3,
|
||||
"repetitions": 3,
|
||||
"lastReview": "2025-08-10",
|
||||
"nextReview": "2025-08-13"
|
||||
},
|
||||
"education": {
|
||||
"easeFactor": 2.8,
|
||||
"interval": 4,
|
||||
"repetitions": 4,
|
||||
"lastReview": "2025-08-09",
|
||||
"nextReview": "2025-08-13"
|
||||
},
|
||||
"technology": {
|
||||
"easeFactor": 2.3,
|
||||
"interval": 2,
|
||||
"repetitions": 2,
|
||||
"lastReview": "2025-08-11",
|
||||
"nextReview": "2025-08-13"
|
||||
},
|
||||
"development": {
|
||||
"easeFactor": 3,
|
||||
"interval": 6,
|
||||
"repetitions": 5,
|
||||
"lastReview": "2025-08-07",
|
||||
"nextReview": "2025-08-13"
|
||||
},
|
||||
"programming": {
|
||||
"easeFactor": 3,
|
||||
"interval": 6,
|
||||
"repetitions": 5,
|
||||
"lastReview": "2025-08-07",
|
||||
"nextReview": "2025-08-13"
|
||||
},
|
||||
"boy": {
|
||||
"easeFactor": 2.7,
|
||||
"interval": 15,
|
||||
"repetitions": 4,
|
||||
"lastReview": "2025-08-09",
|
||||
"nextReview": "2025-08-20"
|
||||
},
|
||||
"bot": {
|
||||
"easeFactor": 2.6,
|
||||
"interval": 40,
|
||||
"repetitions": 6,
|
||||
"lastReview": "2025-07-23",
|
||||
"nextReview": "2025-08-25"
|
||||
},
|
||||
"snot": {
|
||||
"easeFactor": 2.4,
|
||||
"interval": 3,
|
||||
"repetitions": 2,
|
||||
"lastReview": "2025-08-10",
|
||||
"nextReview": "2025-08-10"
|
||||
}
|
||||
}
|
||||
},
|
||||
"testuser": {
|
||||
"settings": {
|
||||
"dailyLimit": 20,
|
||||
"reviewThreshold": 3,
|
||||
"newWordsPerDay": 5
|
||||
},
|
||||
"stats": {
|
||||
"totalReviews": 32,
|
||||
"correctReviews": 23,
|
||||
"totalWords": 10,
|
||||
"masteredWords": 3
|
||||
},
|
||||
"words": {
|
||||
"hello": {
|
||||
"easeFactor": 2.4,
|
||||
"interval": 7,
|
||||
"repetitions": 3,
|
||||
"lastReview": "2025-08-07",
|
||||
"nextReview": "2025-08-14"
|
||||
},
|
||||
"world": {
|
||||
"easeFactor": 2.2,
|
||||
"interval": 3,
|
||||
"repetitions": 2,
|
||||
"lastReview": "2025-08-10",
|
||||
"nextReview": "2025-08-14"
|
||||
},
|
||||
"test": {
|
||||
"easeFactor": 2.2,
|
||||
"interval": 7,
|
||||
"repetitions": 3,
|
||||
"lastReview": "2025-08-08",
|
||||
"nextReview": "2025-08-14"
|
||||
},
|
||||
"sample": {
|
||||
"easeFactor": 2.2,
|
||||
"interval": 3,
|
||||
"repetitions": 2,
|
||||
"lastReview": "2025-08-11",
|
||||
"nextReview": "2025-08-16"
|
||||
},
|
||||
"basic": {
|
||||
"easeFactor": 2.7,
|
||||
"interval": 40,
|
||||
"repetitions": 6,
|
||||
"lastReview": "2025-08-03",
|
||||
"nextReview": "2025-08-14"
|
||||
},
|
||||
"learn": {
|
||||
"easeFactor": 2.4,
|
||||
"interval": 0,
|
||||
"repetitions": 0,
|
||||
"lastReview": null,
|
||||
"nextReview": "2025-08-13"
|
||||
},
|
||||
"spell": {
|
||||
"easeFactor": 2.2,
|
||||
"interval": 1,
|
||||
"repetitions": 1,
|
||||
"lastReview": "2025-08-12",
|
||||
"nextReview": "2025-08-14"
|
||||
},
|
||||
"word": {
|
||||
"easeFactor": 2.9,
|
||||
"interval": 20,
|
||||
"repetitions": 5,
|
||||
"lastReview": "2025-07-27",
|
||||
"nextReview": "2025-08-27"
|
||||
},
|
||||
"study": {
|
||||
"easeFactor": 2.4,
|
||||
"interval": 7,
|
||||
"repetitions": 3,
|
||||
"lastReview": "2025-08-08",
|
||||
"nextReview": "2025-08-14"
|
||||
},
|
||||
"practice": {
|
||||
"easeFactor": 2.8,
|
||||
"interval": 80,
|
||||
"repetitions": 7,
|
||||
"lastReview": "2025-07-06",
|
||||
"nextReview": "2025-08-14"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,22 +0,0 @@
|
||||
[
|
||||
{
|
||||
"username": "admin1",
|
||||
"hash": "5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8",
|
||||
"role": "admin"
|
||||
},
|
||||
{
|
||||
"username": "nate",
|
||||
"hash": "5a2a558c78d3717db731600c4f354fa1d9c84b556f108091a891f444f1bdec40",
|
||||
"role": "student"
|
||||
},
|
||||
{
|
||||
"username": "student1",
|
||||
"hash": "8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92",
|
||||
"role": "student"
|
||||
},
|
||||
{
|
||||
"username": "testuser",
|
||||
"hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
|
||||
"role": "student"
|
||||
}
|
||||
]
|
||||
@@ -1,47 +0,0 @@
|
||||
{
|
||||
"student1": [
|
||||
"apple",
|
||||
"banana",
|
||||
"cherry",
|
||||
"date",
|
||||
"elderberry"
|
||||
],
|
||||
"admin1": [
|
||||
"boy",
|
||||
"bot",
|
||||
"snot"
|
||||
],
|
||||
"nate": {
|
||||
"weeks": [
|
||||
{
|
||||
"date": "2025-08-03",
|
||||
"words": [
|
||||
"not",
|
||||
"bot",
|
||||
"snot"
|
||||
]
|
||||
},
|
||||
{
|
||||
"date": "2025-08-10",
|
||||
"words": [
|
||||
"bate",
|
||||
"hate",
|
||||
"late"
|
||||
]
|
||||
}
|
||||
],
|
||||
"activeWeek": "2025-08-10"
|
||||
},
|
||||
"testuser": [
|
||||
"hello",
|
||||
"world",
|
||||
"test",
|
||||
"sample",
|
||||
"basic",
|
||||
"learn",
|
||||
"spell",
|
||||
"word",
|
||||
"study",
|
||||
"practice"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,299 @@
|
||||
import { DatabaseSync } from 'node:sqlite';
|
||||
import { createHash } from 'node:crypto';
|
||||
import { mkdirSync, readFileSync } from 'node:fs';
|
||||
import { join, dirname } from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
|
||||
const ROOT = dirname(fileURLToPath(import.meta.url));
|
||||
const DATA_DIR = process.env.DATA_DIR || join(ROOT, 'data');
|
||||
mkdirSync(DATA_DIR, { recursive: true });
|
||||
|
||||
export const db = new DatabaseSync(join(DATA_DIR, 'spelling.db'));
|
||||
|
||||
db.exec(`
|
||||
PRAGMA journal_mode = WAL;
|
||||
PRAGMA foreign_keys = ON;
|
||||
|
||||
CREATE TABLE IF NOT EXISTS students (
|
||||
id INTEGER PRIMARY KEY,
|
||||
name TEXT NOT NULL,
|
||||
emoji TEXT NOT NULL DEFAULT '🙂',
|
||||
created_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS lists (
|
||||
id INTEGER PRIMARY KEY,
|
||||
name TEXT NOT NULL,
|
||||
builtin INTEGER NOT NULL DEFAULT 0
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS words (
|
||||
id INTEGER PRIMARY KEY,
|
||||
list_id INTEGER NOT NULL REFERENCES lists(id) ON DELETE CASCADE,
|
||||
word TEXT NOT NULL,
|
||||
sentence TEXT NOT NULL DEFAULT ''
|
||||
);
|
||||
|
||||
-- one active weekly assignment per student
|
||||
CREATE TABLE IF NOT EXISTS assignments (
|
||||
student_id INTEGER PRIMARY KEY REFERENCES students(id) ON DELETE CASCADE,
|
||||
list_id INTEGER NOT NULL REFERENCES lists(id) ON DELETE CASCADE,
|
||||
assigned_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||
);
|
||||
|
||||
-- Leitner state per student per word. box 0 = new, 5 = mastered.
|
||||
CREATE TABLE IF NOT EXISTS progress (
|
||||
student_id INTEGER NOT NULL REFERENCES students(id) ON DELETE CASCADE,
|
||||
word_id INTEGER NOT NULL REFERENCES words(id) ON DELETE CASCADE,
|
||||
box INTEGER NOT NULL DEFAULT 0,
|
||||
due TEXT NOT NULL DEFAULT (date('now')),
|
||||
attempts INTEGER NOT NULL DEFAULT 0,
|
||||
correct INTEGER NOT NULL DEFAULT 0,
|
||||
PRIMARY KEY (student_id, word_id)
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS attempts (
|
||||
id INTEGER PRIMARY KEY,
|
||||
student_id INTEGER NOT NULL REFERENCES students(id) ON DELETE CASCADE,
|
||||
word_id INTEGER NOT NULL REFERENCES words(id) ON DELETE CASCADE,
|
||||
typed TEXT NOT NULL,
|
||||
correct INTEGER NOT NULL,
|
||||
mode TEXT NOT NULL,
|
||||
at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS tests (
|
||||
id INTEGER PRIMARY KEY,
|
||||
student_id INTEGER NOT NULL REFERENCES students(id) ON DELETE CASCADE,
|
||||
list_id INTEGER NOT NULL REFERENCES lists(id) ON DELETE CASCADE,
|
||||
score INTEGER NOT NULL,
|
||||
total INTEGER NOT NULL,
|
||||
at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS test_answers (
|
||||
test_id INTEGER NOT NULL REFERENCES tests(id) ON DELETE CASCADE,
|
||||
word_id INTEGER NOT NULL REFERENCES words(id) ON DELETE CASCADE,
|
||||
typed TEXT NOT NULL,
|
||||
correct INTEGER NOT NULL
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS settings (
|
||||
key TEXT PRIMARY KEY,
|
||||
value TEXT NOT NULL
|
||||
);
|
||||
|
||||
-- flashcards module
|
||||
CREATE TABLE IF NOT EXISTS decks (
|
||||
id INTEGER PRIMARY KEY,
|
||||
name TEXT NOT NULL,
|
||||
builtin INTEGER NOT NULL DEFAULT 0
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS cards (
|
||||
id INTEGER PRIMARY KEY,
|
||||
deck_id INTEGER NOT NULL REFERENCES decks(id) ON DELETE CASCADE,
|
||||
front TEXT NOT NULL,
|
||||
back TEXT NOT NULL
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS card_progress (
|
||||
student_id INTEGER NOT NULL REFERENCES students(id) ON DELETE CASCADE,
|
||||
card_id INTEGER NOT NULL REFERENCES cards(id) ON DELETE CASCADE,
|
||||
box INTEGER NOT NULL DEFAULT 0,
|
||||
due TEXT NOT NULL DEFAULT (date('now')),
|
||||
attempts INTEGER NOT NULL DEFAULT 0,
|
||||
correct INTEGER NOT NULL DEFAULT 0,
|
||||
PRIMARY KEY (student_id, card_id)
|
||||
);
|
||||
|
||||
-- ---------- LMS layer ----------
|
||||
|
||||
CREATE TABLE IF NOT EXISTS courses (
|
||||
id INTEGER PRIMARY KEY,
|
||||
name TEXT NOT NULL,
|
||||
subject TEXT NOT NULL DEFAULT '',
|
||||
color TEXT NOT NULL DEFAULT '#4f86f7',
|
||||
archived INTEGER NOT NULL DEFAULT 0
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS enrollments (
|
||||
student_id INTEGER NOT NULL REFERENCES students(id) ON DELETE CASCADE,
|
||||
course_id INTEGER NOT NULL REFERENCES courses(id) ON DELETE CASCADE,
|
||||
PRIMARY KEY (student_id, course_id)
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS units (
|
||||
id INTEGER PRIMARY KEY,
|
||||
course_id INTEGER NOT NULL REFERENCES courses(id) ON DELETE CASCADE,
|
||||
name TEXT NOT NULL,
|
||||
sort INTEGER NOT NULL DEFAULT 0
|
||||
);
|
||||
|
||||
-- type: lesson | assignment | quiz | spelling_practice | spelling_test | flashcards
|
||||
-- ref_id: list_id for spelling_*, deck_id for flashcards. points: max score for assignment/quiz.
|
||||
CREATE TABLE IF NOT EXISTS items (
|
||||
id INTEGER PRIMARY KEY,
|
||||
unit_id INTEGER NOT NULL REFERENCES units(id) ON DELETE CASCADE,
|
||||
type TEXT NOT NULL,
|
||||
title TEXT NOT NULL,
|
||||
body TEXT NOT NULL DEFAULT '',
|
||||
points INTEGER NOT NULL DEFAULT 0,
|
||||
ref_id INTEGER,
|
||||
sort INTEGER NOT NULL DEFAULT 0
|
||||
);
|
||||
|
||||
-- type: mc | tf | short
|
||||
CREATE TABLE IF NOT EXISTS quiz_questions (
|
||||
id INTEGER PRIMARY KEY,
|
||||
item_id INTEGER NOT NULL REFERENCES items(id) ON DELETE CASCADE,
|
||||
type TEXT NOT NULL,
|
||||
prompt TEXT NOT NULL,
|
||||
choices TEXT NOT NULL DEFAULT '[]',
|
||||
correct_answer TEXT NOT NULL,
|
||||
points INTEGER NOT NULL DEFAULT 1,
|
||||
sort INTEGER NOT NULL DEFAULT 0
|
||||
);
|
||||
|
||||
-- one row per student per item. status: done (ungraded) | graded
|
||||
CREATE TABLE IF NOT EXISTS submissions (
|
||||
id INTEGER PRIMARY KEY,
|
||||
student_id INTEGER NOT NULL REFERENCES students(id) ON DELETE CASCADE,
|
||||
item_id INTEGER NOT NULL REFERENCES items(id) ON DELETE CASCADE,
|
||||
status TEXT NOT NULL DEFAULT 'done',
|
||||
score REAL,
|
||||
points_possible REAL,
|
||||
answers TEXT,
|
||||
completed_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||
graded_at TEXT,
|
||||
UNIQUE(student_id, item_id)
|
||||
);
|
||||
|
||||
-- daily agenda. item_id set = a scheduled course item; null = a standalone offline task (title used)
|
||||
CREATE TABLE IF NOT EXISTS schedule (
|
||||
id INTEGER PRIMARY KEY,
|
||||
student_id INTEGER NOT NULL REFERENCES students(id) ON DELETE CASCADE,
|
||||
date TEXT NOT NULL,
|
||||
item_id INTEGER REFERENCES items(id) ON DELETE CASCADE,
|
||||
title TEXT NOT NULL DEFAULT '',
|
||||
done INTEGER NOT NULL DEFAULT 0,
|
||||
done_at TEXT,
|
||||
sort INTEGER NOT NULL DEFAULT 0
|
||||
);
|
||||
CREATE INDEX IF NOT EXISTS idx_schedule_day ON schedule(student_id, date);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS quiz_templates (
|
||||
id INTEGER PRIMARY KEY,
|
||||
name TEXT NOT NULL,
|
||||
created_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||
);
|
||||
CREATE TABLE IF NOT EXISTS quiz_template_questions (
|
||||
id INTEGER PRIMARY KEY,
|
||||
template_id INTEGER NOT NULL REFERENCES quiz_templates(id) ON DELETE CASCADE,
|
||||
type TEXT NOT NULL,
|
||||
prompt TEXT NOT NULL,
|
||||
choices TEXT NOT NULL DEFAULT '[]',
|
||||
correct_answer TEXT NOT NULL,
|
||||
points INTEGER NOT NULL DEFAULT 1,
|
||||
sort INTEGER NOT NULL DEFAULT 0
|
||||
);
|
||||
CREATE TABLE IF NOT EXISTS submission_history (
|
||||
id INTEGER PRIMARY KEY,
|
||||
student_id INTEGER NOT NULL REFERENCES students(id) ON DELETE CASCADE,
|
||||
item_id INTEGER NOT NULL REFERENCES items(id) ON DELETE CASCADE,
|
||||
score REAL,
|
||||
points_possible REAL,
|
||||
answers TEXT,
|
||||
completed_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS messages (
|
||||
id INTEGER PRIMARY KEY,
|
||||
student_id INTEGER NOT NULL REFERENCES students(id) ON DELETE CASCADE,
|
||||
sender TEXT NOT NULL,
|
||||
body TEXT NOT NULL,
|
||||
sent_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||
read_at TEXT
|
||||
);
|
||||
`);
|
||||
|
||||
function tryAlter(sql) {
|
||||
try { db.exec(sql); } catch { /* column already exists */ }
|
||||
}
|
||||
tryAlter(`ALTER TABLE items ADD COLUMN due_date TEXT`);
|
||||
tryAlter(`ALTER TABLE items ADD COLUMN allow_retakes INTEGER NOT NULL DEFAULT 0`);
|
||||
tryAlter(`ALTER TABLE items ADD COLUMN prereq_item_id INTEGER`);
|
||||
tryAlter(`ALTER TABLE items ADD COLUMN evidence_mode TEXT NOT NULL DEFAULT 'none'`);
|
||||
tryAlter(`ALTER TABLE items ADD COLUMN retake_policy TEXT NOT NULL DEFAULT 'latest'`);
|
||||
tryAlter(`ALTER TABLE submissions ADD COLUMN evidence_notes TEXT`);
|
||||
tryAlter(`ALTER TABLE submissions ADD COLUMN evidence_photo TEXT`);
|
||||
tryAlter(`ALTER TABLE submissions ADD COLUMN student_note TEXT`);
|
||||
tryAlter(`ALTER TABLE submissions ADD COLUMN parent_comment TEXT`);
|
||||
tryAlter(`ALTER TABLE schedule ADD COLUMN status TEXT NOT NULL DEFAULT 'not_started'`);
|
||||
tryAlter(`ALTER TABLE schedule ADD COLUMN evidence_notes TEXT`);
|
||||
tryAlter(`ALTER TABLE words ADD COLUMN definition TEXT NOT NULL DEFAULT ''`);
|
||||
tryAlter(`ALTER TABLE schedule ADD COLUMN evidence_photo TEXT`);
|
||||
tryAlter(`ALTER TABLE students ADD COLUMN theme TEXT NOT NULL DEFAULT 'blue'`);
|
||||
tryAlter(`ALTER TABLE students ADD COLUMN streak_date TEXT`);
|
||||
tryAlter(`ALTER TABLE students ADD COLUMN streak_count INTEGER NOT NULL DEFAULT 0`);
|
||||
tryAlter(`ALTER TABLE students ADD COLUMN best_streak INTEGER NOT NULL DEFAULT 0`);
|
||||
tryAlter(`ALTER TABLE students ADD COLUMN bg_pattern TEXT NOT NULL DEFAULT 'none'`);
|
||||
tryAlter(`ALTER TABLE students ADD COLUMN young_learner INTEGER NOT NULL DEFAULT 0`);
|
||||
tryAlter(`ALTER TABLE students ADD COLUMN birthday TEXT`);
|
||||
tryAlter(`ALTER TABLE lists ADD COLUMN group_name TEXT NOT NULL DEFAULT ''`);
|
||||
tryAlter(`ALTER TABLE decks ADD COLUMN group_name TEXT NOT NULL DEFAULT ''`);
|
||||
tryAlter(`ALTER TABLE tests ADD COLUMN item_id INTEGER`);
|
||||
|
||||
db.exec(`CREATE TABLE IF NOT EXISTS documents (
|
||||
id INTEGER PRIMARY KEY,
|
||||
student_id INTEGER NOT NULL REFERENCES students(id) ON DELETE CASCADE,
|
||||
title TEXT NOT NULL DEFAULT 'Untitled Document',
|
||||
doc_key TEXT NOT NULL UNIQUE,
|
||||
filename TEXT NOT NULL,
|
||||
submitted INTEGER NOT NULL DEFAULT 0,
|
||||
submitted_at TEXT,
|
||||
parent_read INTEGER NOT NULL DEFAULT 0,
|
||||
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||
updated_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||
)`);
|
||||
|
||||
export const sha256 = (s) => createHash('sha256').update(String(s)).digest('hex');
|
||||
|
||||
// Default parent PIN on first run
|
||||
if (!db.prepare(`SELECT value FROM settings WHERE key = 'pin'`).get()) {
|
||||
db.prepare(`INSERT INTO settings (key, value) VALUES ('pin', ?)`).run(sha256('1234'));
|
||||
}
|
||||
|
||||
// Default scan config (local Ollama primary, no cloud key yet)
|
||||
const seedSetting = (key, val) => {
|
||||
if (!db.prepare(`SELECT value FROM settings WHERE key = ?`).get(key))
|
||||
db.prepare(`INSERT INTO settings (key, value) VALUES (?, ?)`).run(key, val);
|
||||
};
|
||||
seedSetting('school_name', '');
|
||||
seedSetting('passing_pct', '80');
|
||||
seedSetting('week_start_day', 'monday');
|
||||
|
||||
// Seed bundled word lists on first run
|
||||
if (db.prepare(`SELECT COUNT(*) AS n FROM lists`).get().n === 0) {
|
||||
const seed = JSON.parse(readFileSync(join(ROOT, 'seed-lists.json'), 'utf8'));
|
||||
const insList = db.prepare(`INSERT INTO lists (name, builtin) VALUES (?, 1)`);
|
||||
const insWord = db.prepare(`INSERT INTO words (list_id, word, sentence) VALUES (?, ?, ?)`);
|
||||
for (const list of seed) {
|
||||
const listId = insList.run(list.name).lastInsertRowid;
|
||||
for (const entry of list.words) {
|
||||
const { word, sentence = '' } = typeof entry === 'string' ? { word: entry } : entry;
|
||||
insWord.run(listId, word, sentence);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Seed bundled flashcard decks on first run
|
||||
if (db.prepare(`SELECT COUNT(*) AS n FROM decks`).get().n === 0) {
|
||||
const seed = JSON.parse(readFileSync(join(ROOT, 'seed-decks.json'), 'utf8'));
|
||||
const insDeck = db.prepare(`INSERT INTO decks (name, builtin) VALUES (?, 1)`);
|
||||
const insCard = db.prepare(`INSERT INTO cards (deck_id, front, back) VALUES (?, ?, ?)`);
|
||||
for (const deck of seed) {
|
||||
const deckId = insDeck.run(deck.name).lastInsertRowid;
|
||||
for (const c of deck.cards) insCard.run(deckId, c.front, c.back);
|
||||
}
|
||||
}
|
||||
@@ -1,51 +0,0 @@
|
||||
# PowerShell script for Docker build and push with GitHub authentication
|
||||
# This script will build and push your Docker image to GitHub Container Registry
|
||||
# You must set the CR_PAT environment variable with your GitHub Personal Access Token
|
||||
|
||||
# Check if CR_PAT environment variable is set
|
||||
if (-not $env:CR_PAT) {
|
||||
Write-Host "❌ Error: CR_PAT environment variable is not set." -ForegroundColor Red
|
||||
Write-Host "Please set your GitHub Personal Access Token as an environment variable:" -ForegroundColor Yellow
|
||||
Write-Host '$env:CR_PAT = "YOUR_GITHUB_PAT"' -ForegroundColor Yellow
|
||||
exit 1
|
||||
}
|
||||
|
||||
# Set variables
|
||||
$IMAGE_NAME = "ghcr.io/nmemmert/spelling"
|
||||
$VERSION = (Get-Content -Path "version.json" | ConvertFrom-Json).version
|
||||
$GITHUB_USERNAME = "nmemmert"
|
||||
|
||||
Write-Host "🔑 Logging in to GitHub Container Registry..." -ForegroundColor Cyan
|
||||
# Login to GitHub Container Registry using environment variable
|
||||
$env:CR_PAT | docker login ghcr.io -u $GITHUB_USERNAME --password-stdin
|
||||
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
Write-Host "❌ Login failed. Please check your GitHub token." -ForegroundColor Red
|
||||
exit 1
|
||||
}
|
||||
|
||||
Write-Host "✅ Successfully logged in to GitHub Container Registry." -ForegroundColor Green
|
||||
Write-Host "🔨 Building Docker image ${IMAGE_NAME}:${VERSION}..." -ForegroundColor Cyan
|
||||
|
||||
# Build the image
|
||||
docker build -t ${IMAGE_NAME}:${VERSION} -t ${IMAGE_NAME}:latest .
|
||||
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
Write-Host "❌ Docker build failed." -ForegroundColor Red
|
||||
exit 1
|
||||
}
|
||||
|
||||
Write-Host "✅ Build completed." -ForegroundColor Green
|
||||
Write-Host "📤 Pushing image to GitHub Container Registry..." -ForegroundColor Cyan
|
||||
|
||||
# Push both tags to registry
|
||||
docker push ${IMAGE_NAME}:${VERSION}
|
||||
docker push ${IMAGE_NAME}:latest
|
||||
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
Write-Host "❌ Docker push failed." -ForegroundColor Red
|
||||
exit 1
|
||||
}
|
||||
|
||||
Write-Host "✅ Successfully pushed ${IMAGE_NAME}:${VERSION} and ${IMAGE_NAME}:latest" -ForegroundColor Green
|
||||
Write-Host "🎉 Done! Your Docker image is now available at ${IMAGE_NAME}:${VERSION}" -ForegroundColor Cyan
|
||||
@@ -1,51 +0,0 @@
|
||||
# PowerShell script to build and push Docker image for Spelling Practice App
|
||||
|
||||
# Set variables
|
||||
$IMAGE_NAME = "ghcr.io/nmemmert/spelling"
|
||||
$VERSION = (Get-Content -Path "version.json" | ConvertFrom-Json).version
|
||||
|
||||
Write-Host "🔨 Building Docker image ${IMAGE_NAME}:${VERSION}..." -ForegroundColor Cyan
|
||||
|
||||
# Build the image
|
||||
docker build -t ${IMAGE_NAME}:${VERSION} -t ${IMAGE_NAME}:latest .
|
||||
|
||||
Write-Host "✅ Build completed." -ForegroundColor Green
|
||||
Write-Host "🧪 Testing the image..." -ForegroundColor Cyan
|
||||
|
||||
# Run container for testing
|
||||
docker run --name spelling-test -d -p 3001:3000 ${IMAGE_NAME}:${VERSION}
|
||||
|
||||
# Wait for container to start
|
||||
Start-Sleep -Seconds 5
|
||||
|
||||
# Test health endpoint
|
||||
try {
|
||||
$response = Invoke-WebRequest -Uri "http://localhost:3001/health" -UseBasicParsing
|
||||
if ($response.StatusCode -eq 200) {
|
||||
Write-Host "✅ Health check passed!" -ForegroundColor Green
|
||||
} else {
|
||||
Write-Host "❌ Health check failed with status $($response.StatusCode)" -ForegroundColor Red
|
||||
docker logs spelling-test
|
||||
docker stop spelling-test
|
||||
docker rm spelling-test
|
||||
exit 1
|
||||
}
|
||||
} catch {
|
||||
Write-Host "❌ Health check failed: $_" -ForegroundColor Red
|
||||
docker logs spelling-test
|
||||
docker stop spelling-test
|
||||
docker rm spelling-test
|
||||
exit 1
|
||||
}
|
||||
|
||||
# Stop and remove test container
|
||||
docker stop spelling-test
|
||||
docker rm spelling-test
|
||||
|
||||
Write-Host "📤 Pushing image to GitHub Container Registry..." -ForegroundColor Cyan
|
||||
docker push ${IMAGE_NAME}:${VERSION}
|
||||
docker push ${IMAGE_NAME}:latest
|
||||
|
||||
Write-Host "🚀 Successfully built and pushed ${IMAGE_NAME}:${VERSION}" -ForegroundColor Green
|
||||
Write-Host "Press any key to exit..."
|
||||
$null = $host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
|
||||
+7
-17
@@ -1,22 +1,12 @@
|
||||
version: "3.9"
|
||||
|
||||
services:
|
||||
spelling-app:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
image: ghcr.io/nmemmert/spelling:1.1.0
|
||||
container_name: spelling-app
|
||||
spelling:
|
||||
image: ghcr.io/nmemmert/spelling:latest
|
||||
container_name: spelling-v2
|
||||
ports:
|
||||
- "3000:3000"
|
||||
volumes:
|
||||
- ./data:/app/data
|
||||
environment:
|
||||
- NODE_ENV=production
|
||||
- spelling-data:/app/data
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ["CMD", "node", "-e", "require('http').get('http://localhost:3000/health', res => res.statusCode === 200 ? process.exit(0) : process.exit(1))"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
start_period: 10s
|
||||
|
||||
volumes:
|
||||
spelling-data:
|
||||
@@ -1,474 +0,0 @@
|
||||
// Gamification API endpoints for the Spelling Practice App
|
||||
|
||||
module.exports = function(app, DATA_DIR, files, readJsonSafe, isToday, isSameDay) {
|
||||
|
||||
// 🏆 Get leaderboards
|
||||
app.get('/getLeaderboards', (req, res) => {
|
||||
try {
|
||||
const leaderboards = readJsonSafe(path.join(DATA_DIR, files.leaderboards), {});
|
||||
res.json(leaderboards);
|
||||
} catch (error) {
|
||||
console.error('Error getting leaderboards:', error);
|
||||
res.status(500).send('Failed to get leaderboards');
|
||||
}
|
||||
});
|
||||
|
||||
// 🎯 Get current challenges
|
||||
app.get('/getChallenges', (req, res) => {
|
||||
try {
|
||||
const challenges = readJsonSafe(path.join(DATA_DIR, files.challenges), {});
|
||||
res.json(challenges);
|
||||
} catch (error) {
|
||||
console.error('Error getting challenges:', error);
|
||||
res.status(500).send('Failed to get challenges');
|
||||
}
|
||||
});
|
||||
|
||||
// 📈 Get user progress
|
||||
app.get('/getUserProgress', (req, res) => {
|
||||
try {
|
||||
const { username } = req.query;
|
||||
if (!username) {
|
||||
return res.status(400).send('Username is required');
|
||||
}
|
||||
|
||||
const progress = readJsonSafe(path.join(DATA_DIR, files.progress), {});
|
||||
|
||||
if (!progress[username]) {
|
||||
return res.status(404).send('User progress not found');
|
||||
}
|
||||
|
||||
res.json(progress[username]);
|
||||
} catch (error) {
|
||||
console.error('Error getting user progress:', error);
|
||||
res.status(500).send('Failed to get user progress');
|
||||
}
|
||||
});
|
||||
|
||||
// 📋 Get all users' progress
|
||||
app.get('/getAllProgress', (req, res) => {
|
||||
try {
|
||||
const progress = readJsonSafe(path.join(DATA_DIR, files.progress), {});
|
||||
res.json(progress);
|
||||
} catch (error) {
|
||||
console.error('Error getting all progress data:', error);
|
||||
res.status(500).send('Failed to get progress data');
|
||||
}
|
||||
});
|
||||
|
||||
// 🔄 Update user streak
|
||||
app.post('/updateStreak', (req, res) => {
|
||||
try {
|
||||
const { username } = req.body;
|
||||
if (!username) {
|
||||
return res.status(400).send('Username is required');
|
||||
}
|
||||
|
||||
const progress = readJsonSafe(path.join(DATA_DIR, files.progress), {});
|
||||
|
||||
if (!progress[username]) {
|
||||
return res.status(404).send('User progress not found');
|
||||
}
|
||||
|
||||
const userProgress = progress[username];
|
||||
const now = new Date();
|
||||
const lastActivity = userProgress.streaks.lastActivity ? new Date(userProgress.streaks.lastActivity) : null;
|
||||
|
||||
// If this is the first activity or it's a new day
|
||||
if (!lastActivity || !isToday(lastActivity)) {
|
||||
// Check if the streak continues (last activity was yesterday)
|
||||
if (lastActivity) {
|
||||
const yesterday = new Date();
|
||||
yesterday.setDate(yesterday.getDate() - 1);
|
||||
|
||||
if (isSameDay(lastActivity, yesterday)) {
|
||||
// Streak continues
|
||||
userProgress.streaks.current++;
|
||||
} else {
|
||||
// Streak broken
|
||||
userProgress.streaks.current = 1;
|
||||
}
|
||||
} else {
|
||||
// First activity
|
||||
userProgress.streaks.current = 1;
|
||||
}
|
||||
|
||||
// Update longest streak if needed
|
||||
if (userProgress.streaks.current > userProgress.streaks.longest) {
|
||||
userProgress.streaks.longest = userProgress.streaks.current;
|
||||
}
|
||||
|
||||
// Update last activity
|
||||
userProgress.streaks.lastActivity = now.toISOString();
|
||||
|
||||
// Write updated progress
|
||||
fs.writeFileSync(path.join(DATA_DIR, files.progress), JSON.stringify(progress, null, 2));
|
||||
|
||||
// Check for streak achievements
|
||||
checkStreakAchievements(username, userProgress.streaks.current);
|
||||
}
|
||||
|
||||
res.json({ streak: userProgress.streaks });
|
||||
} catch (error) {
|
||||
console.error('Error updating streak:', error);
|
||||
res.status(500).send('Failed to update streak');
|
||||
}
|
||||
});
|
||||
|
||||
// 📝 Complete challenge
|
||||
app.post('/completeChallenge', (req, res) => {
|
||||
try {
|
||||
const { username, challengeId, challengeType } = req.body;
|
||||
if (!username || !challengeId || !challengeType) {
|
||||
return res.status(400).send('Username, challengeId, and challengeType are required');
|
||||
}
|
||||
|
||||
// Valid challenge types
|
||||
if (!['daily', 'weekly', 'achievements'].includes(challengeType)) {
|
||||
return res.status(400).send('Invalid challenge type');
|
||||
}
|
||||
|
||||
const progress = readJsonSafe(path.join(DATA_DIR, files.progress), {});
|
||||
const challenges = readJsonSafe(path.join(DATA_DIR, files.challenges), {});
|
||||
|
||||
if (!progress[username]) {
|
||||
return res.status(404).send('User progress not found');
|
||||
}
|
||||
|
||||
// Find the challenge
|
||||
let challenge = null;
|
||||
if (challengeType === 'achievements') {
|
||||
challenge = challenges.achievements?.find(c => c.id === challengeId);
|
||||
} else {
|
||||
challenge = challenges[challengeType]?.current?.id === challengeId
|
||||
? challenges[challengeType].current
|
||||
: challenges[challengeType]?.history?.find(c => c.id === challengeId);
|
||||
}
|
||||
|
||||
if (!challenge) {
|
||||
return res.status(404).send('Challenge not found');
|
||||
}
|
||||
|
||||
// Check if already completed
|
||||
if (progress[username].challengesCompleted[challengeType].includes(challengeId)) {
|
||||
return res.status(409).send('Challenge already completed');
|
||||
}
|
||||
|
||||
// Mark as completed
|
||||
progress[username].challengesCompleted[challengeType].push(challengeId);
|
||||
|
||||
// Award points
|
||||
if (challenge.reward && challenge.reward.points) {
|
||||
progress[username].stats.points += challenge.reward.points;
|
||||
}
|
||||
|
||||
// Award badge if applicable
|
||||
if (challenge.reward && challenge.reward.badge) {
|
||||
const badges = readJsonSafe(path.join(DATA_DIR, files.badges), {});
|
||||
|
||||
if (!badges[username]) {
|
||||
badges[username] = [];
|
||||
}
|
||||
|
||||
if (!badges[username].includes(challenge.reward.badge)) {
|
||||
badges[username].push(challenge.reward.badge);
|
||||
fs.writeFileSync(path.join(DATA_DIR, files.badges), JSON.stringify(badges, null, 2));
|
||||
}
|
||||
}
|
||||
|
||||
// Write updated progress
|
||||
fs.writeFileSync(path.join(DATA_DIR, files.progress), JSON.stringify(progress, null, 2));
|
||||
|
||||
res.json({
|
||||
message: 'Challenge completed',
|
||||
updatedProgress: progress[username]
|
||||
});
|
||||
} catch (error) {
|
||||
console.error('Error completing challenge:', error);
|
||||
res.status(500).send('Failed to complete challenge');
|
||||
}
|
||||
});
|
||||
|
||||
// 🔄 Update leaderboards
|
||||
app.post('/updateLeaderboards', (req, res) => {
|
||||
try {
|
||||
// This should be an admin-only endpoint
|
||||
const leaderboards = readJsonSafe(path.join(DATA_DIR, files.leaderboards), {});
|
||||
const progress = readJsonSafe(path.join(DATA_DIR, files.progress), {});
|
||||
|
||||
// Update all-time leaderboards
|
||||
const accuracyLeaderboard = [];
|
||||
const wordsLeaderboard = [];
|
||||
const sessionsLeaderboard = [];
|
||||
const streaksLeaderboard = [];
|
||||
|
||||
Object.entries(progress).forEach(([username, data]) => {
|
||||
if (data.stats.totalSessions > 0) {
|
||||
// Accuracy leaderboard
|
||||
accuracyLeaderboard.push({
|
||||
username,
|
||||
value: data.stats.accuracy,
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
// Words leaderboard
|
||||
wordsLeaderboard.push({
|
||||
username,
|
||||
value: data.stats.totalWords,
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
// Sessions leaderboard
|
||||
sessionsLeaderboard.push({
|
||||
username,
|
||||
value: data.stats.totalSessions,
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
// Streaks leaderboard
|
||||
streaksLeaderboard.push({
|
||||
username,
|
||||
value: data.streaks.current,
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
// Sort and limit leaderboards
|
||||
leaderboards.allTime.accuracy = accuracyLeaderboard
|
||||
.sort((a, b) => b.value - a.value)
|
||||
.slice(0, 10);
|
||||
|
||||
leaderboards.allTime.totalWords = wordsLeaderboard
|
||||
.sort((a, b) => b.value - a.value)
|
||||
.slice(0, 10);
|
||||
|
||||
leaderboards.allTime.sessionsCompleted = sessionsLeaderboard
|
||||
.sort((a, b) => b.value - a.value)
|
||||
.slice(0, 10);
|
||||
|
||||
leaderboards.allTime.streakDays = streaksLeaderboard
|
||||
.sort((a, b) => b.value - a.value)
|
||||
.slice(0, 10);
|
||||
|
||||
// TODO: Implement weekly leaderboard calculations
|
||||
|
||||
leaderboards.lastUpdated = new Date().toISOString();
|
||||
|
||||
// Write updated leaderboards
|
||||
fs.writeFileSync(path.join(DATA_DIR, files.leaderboards), JSON.stringify(leaderboards, null, 2));
|
||||
|
||||
res.json({ message: 'Leaderboards updated successfully' });
|
||||
} catch (error) {
|
||||
console.error('Error updating leaderboards:', error);
|
||||
res.status(500).send('Failed to update leaderboards');
|
||||
}
|
||||
});
|
||||
|
||||
// 🆕 Generate new daily challenge
|
||||
app.post('/generateDailyChallenge', (req, res) => {
|
||||
try {
|
||||
const challenges = readJsonSafe(path.join(DATA_DIR, files.challenges), {});
|
||||
const today = new Date();
|
||||
const dayString = today.toISOString().split('T')[0];
|
||||
|
||||
// Check if today's challenge already exists
|
||||
if (challenges.daily.current && challenges.daily.current.date === dayString) {
|
||||
return res.status(409).send('Today\'s challenge already exists');
|
||||
}
|
||||
|
||||
// Move current challenge to history
|
||||
if (challenges.daily.current) {
|
||||
if (!challenges.daily.history) {
|
||||
challenges.daily.history = [];
|
||||
}
|
||||
challenges.daily.history.unshift(challenges.daily.current);
|
||||
|
||||
// Limit history size
|
||||
if (challenges.daily.history.length > 30) {
|
||||
challenges.daily.history = challenges.daily.history.slice(0, 30);
|
||||
}
|
||||
}
|
||||
|
||||
// Challenge types
|
||||
const challengeTypes = [
|
||||
{
|
||||
type: 'accuracy',
|
||||
description: 'Complete a spelling session with at least {target}% accuracy',
|
||||
target: Math.floor(Math.random() * 11) + 85, // 85-95% accuracy
|
||||
points: 50
|
||||
},
|
||||
{
|
||||
type: 'words',
|
||||
description: 'Spell {target} words correctly in one day',
|
||||
target: Math.floor(Math.random() * 16) + 10, // 10-25 words
|
||||
points: 40
|
||||
},
|
||||
{
|
||||
type: 'sessions',
|
||||
description: 'Complete {target} spelling sessions in one day',
|
||||
target: Math.floor(Math.random() * 3) + 2, // 2-4 sessions
|
||||
points: 60
|
||||
}
|
||||
];
|
||||
|
||||
// Choose random challenge type
|
||||
const challenge = challengeTypes[Math.floor(Math.random() * challengeTypes.length)];
|
||||
|
||||
// Create new challenge
|
||||
challenges.daily.current = {
|
||||
id: `daily-${dayString}`,
|
||||
title: `${today.toLocaleDateString('en-US', { month: 'long', day: 'numeric' })} Challenge`,
|
||||
description: challenge.description.replace('{target}', challenge.target),
|
||||
type: challenge.type,
|
||||
target: challenge.target,
|
||||
reward: {
|
||||
points: challenge.points,
|
||||
badge: null
|
||||
},
|
||||
date: dayString
|
||||
};
|
||||
|
||||
challenges.lastUpdated = today.toISOString();
|
||||
|
||||
// Write updated challenges
|
||||
fs.writeFileSync(path.join(DATA_DIR, files.challenges), JSON.stringify(challenges, null, 2));
|
||||
|
||||
res.json({ message: 'Daily challenge generated', challenge: challenges.daily.current });
|
||||
} catch (error) {
|
||||
console.error('Error generating daily challenge:', error);
|
||||
res.status(500).send('Failed to generate daily challenge');
|
||||
}
|
||||
});
|
||||
|
||||
// 🆕 Generate new weekly challenge
|
||||
app.post('/generateWeeklyChallenge', (req, res) => {
|
||||
try {
|
||||
const challenges = readJsonSafe(path.join(DATA_DIR, files.challenges), {});
|
||||
const today = new Date();
|
||||
const weekNum = getWeekNumber(today);
|
||||
const yearNum = today.getFullYear();
|
||||
const weekId = `weekly-${yearNum}-${weekNum}`;
|
||||
|
||||
// Check if this week's challenge already exists
|
||||
if (challenges.weekly.current && challenges.weekly.current.id === weekId) {
|
||||
return res.status(409).send('This week\'s challenge already exists');
|
||||
}
|
||||
|
||||
// Move current challenge to history
|
||||
if (challenges.weekly.current) {
|
||||
if (!challenges.weekly.history) {
|
||||
challenges.weekly.history = [];
|
||||
}
|
||||
challenges.weekly.history.unshift(challenges.weekly.current);
|
||||
|
||||
// Limit history size
|
||||
if (challenges.weekly.history.length > 12) {
|
||||
challenges.weekly.history = challenges.weekly.history.slice(0, 12);
|
||||
}
|
||||
}
|
||||
|
||||
// Challenge types
|
||||
const challengeTypes = [
|
||||
{
|
||||
type: 'streak',
|
||||
description: 'Practice spelling for {target} consecutive days',
|
||||
target: Math.floor(Math.random() * 3) + 4, // 4-6 days
|
||||
points: 100,
|
||||
badge: 'Weekly Warrior'
|
||||
},
|
||||
{
|
||||
type: 'correctWords',
|
||||
description: 'Spell {target} words correctly this week',
|
||||
target: Math.floor(Math.random() * 51) + 75, // 75-125 words
|
||||
points: 150,
|
||||
badge: 'Word Master'
|
||||
},
|
||||
{
|
||||
type: 'perfectSessions',
|
||||
description: 'Complete {target} perfect spelling sessions this week',
|
||||
target: Math.floor(Math.random() * 3) + 2, // 2-4 sessions
|
||||
points: 200,
|
||||
badge: 'Perfect Form'
|
||||
}
|
||||
];
|
||||
|
||||
// Choose random challenge type
|
||||
const challenge = challengeTypes[Math.floor(Math.random() * challengeTypes.length)];
|
||||
|
||||
// Create new challenge
|
||||
challenges.weekly.current = {
|
||||
id: weekId,
|
||||
title: `Week ${weekNum} Challenge`,
|
||||
description: challenge.description.replace('{target}', challenge.target),
|
||||
type: challenge.type,
|
||||
target: challenge.target,
|
||||
reward: {
|
||||
points: challenge.points,
|
||||
badge: challenge.badge
|
||||
},
|
||||
startDate: getWeekStartDate(today).toISOString().split('T')[0],
|
||||
endDate: getWeekEndDate(today).toISOString().split('T')[0]
|
||||
};
|
||||
|
||||
challenges.lastUpdated = today.toISOString();
|
||||
|
||||
// Write updated challenges
|
||||
fs.writeFileSync(path.join(DATA_DIR, files.challenges), JSON.stringify(challenges, null, 2));
|
||||
|
||||
res.json({ message: 'Weekly challenge generated', challenge: challenges.weekly.current });
|
||||
} catch (error) {
|
||||
console.error('Error generating weekly challenge:', error);
|
||||
res.status(500).send('Failed to generate weekly challenge');
|
||||
}
|
||||
});
|
||||
|
||||
// Helper function to check for streak achievements
|
||||
function checkStreakAchievements(username, currentStreak) {
|
||||
try {
|
||||
const challenges = readJsonSafe(path.join(DATA_DIR, files.challenges), {});
|
||||
const progress = readJsonSafe(path.join(DATA_DIR, files.progress), {});
|
||||
|
||||
// Find streak-based achievements
|
||||
const streakAchievements = challenges.achievements.filter(
|
||||
a => a.type === 'streak' && a.condition === 'dailyLogin'
|
||||
);
|
||||
|
||||
// Check if any achievement is unlocked by the current streak
|
||||
streakAchievements.forEach(achievement => {
|
||||
// If streak target met and not already completed
|
||||
if (currentStreak >= achievement.target &&
|
||||
!progress[username].challengesCompleted.achievements.includes(achievement.id)) {
|
||||
|
||||
// Mark as completed
|
||||
progress[username].challengesCompleted.achievements.push(achievement.id);
|
||||
|
||||
// Award points
|
||||
if (achievement.reward && achievement.reward.points) {
|
||||
progress[username].stats.points += achievement.reward.points;
|
||||
}
|
||||
|
||||
// Award badge if applicable
|
||||
if (achievement.reward && achievement.reward.badge) {
|
||||
const badges = readJsonSafe(path.join(DATA_DIR, files.badges), {});
|
||||
|
||||
if (!badges[username]) {
|
||||
badges[username] = [];
|
||||
}
|
||||
|
||||
if (!badges[username].includes(achievement.reward.badge)) {
|
||||
badges[username].push(achievement.reward.badge);
|
||||
fs.writeFileSync(path.join(DATA_DIR, files.badges), JSON.stringify(badges, null, 2));
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// Write updated progress if needed
|
||||
fs.writeFileSync(path.join(DATA_DIR, files.progress), JSON.stringify(progress, null, 2));
|
||||
} catch (error) {
|
||||
console.error('Error checking streak achievements:', error);
|
||||
}
|
||||
}
|
||||
|
||||
}; // Close the module.exports function
|
||||
-908
@@ -1,908 +0,0 @@
|
||||
{
|
||||
"name": "modern-spelling-practice",
|
||||
"version": "3.0.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"node_modules/accepts": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/accepts/-/accepts-2.0.0.tgz",
|
||||
"integrity": "sha512-5cvg6CtKwfgdmVqY1WIiXKc3Q1bkRqGLi+2W/6ao+6Y7gu/RCwRuAhGEzh5B4KlszSuTLgZYuqFqo5bImjNKng==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"mime-types": "^3.0.0",
|
||||
"negotiator": "^1.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/body-parser": {
|
||||
"version": "2.2.0",
|
||||
"resolved": "https://registry.npmjs.org/body-parser/-/body-parser-2.2.0.tgz",
|
||||
"integrity": "sha512-02qvAaxv8tp7fBa/mw1ga98OGm+eCbqzJOKoRt70sLmfEEi+jyBYVTDGfCL/k06/4EMk/z01gCe7HoCH/f2LTg==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"bytes": "^3.1.2",
|
||||
"content-type": "^1.0.5",
|
||||
"debug": "^4.4.0",
|
||||
"http-errors": "^2.0.0",
|
||||
"iconv-lite": "^0.6.3",
|
||||
"on-finished": "^2.4.1",
|
||||
"qs": "^6.14.0",
|
||||
"raw-body": "^3.0.0",
|
||||
"type-is": "^2.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=18"
|
||||
}
|
||||
},
|
||||
"node_modules/bytes": {
|
||||
"version": "3.1.2",
|
||||
"resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz",
|
||||
"integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/call-bind-apply-helpers": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz",
|
||||
"integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"es-errors": "^1.3.0",
|
||||
"function-bind": "^1.1.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
}
|
||||
},
|
||||
"node_modules/call-bound": {
|
||||
"version": "1.0.4",
|
||||
"resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz",
|
||||
"integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"call-bind-apply-helpers": "^1.0.2",
|
||||
"get-intrinsic": "^1.3.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/content-disposition": {
|
||||
"version": "1.0.0",
|
||||
"resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-1.0.0.tgz",
|
||||
"integrity": "sha512-Au9nRL8VNUut/XSzbQA38+M78dzP4D+eqg3gfJHMIHHYa3bg067xj1KxMUWj+VULbiZMowKngFFbKczUrNJ1mg==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"safe-buffer": "5.2.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/content-type": {
|
||||
"version": "1.0.5",
|
||||
"resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz",
|
||||
"integrity": "sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/cookie": {
|
||||
"version": "0.7.2",
|
||||
"resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.2.tgz",
|
||||
"integrity": "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/cookie-signature": {
|
||||
"version": "1.2.2",
|
||||
"resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.2.2.tgz",
|
||||
"integrity": "sha512-D76uU73ulSXrD1UXF4KE2TMxVVwhsnCgfAyTg9k8P6KGZjlXKrOLe4dJQKI3Bxi5wjesZoFXJWElNWBjPZMbhg==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=6.6.0"
|
||||
}
|
||||
},
|
||||
"node_modules/data-uri-to-buffer": {
|
||||
"version": "4.0.1",
|
||||
"resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.1.tgz",
|
||||
"integrity": "sha512-0R9ikRb668HB7QDxT1vkpuUBtqc53YyAwMwGeUFKRojY/NWKvdZ+9UYtRfGmhqNbRkTSVpMbmyhXipFFv2cb/A==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 12"
|
||||
}
|
||||
},
|
||||
"node_modules/debug": {
|
||||
"version": "4.4.1",
|
||||
"resolved": "https://registry.npmjs.org/debug/-/debug-4.4.1.tgz",
|
||||
"integrity": "sha512-KcKCqiftBJcZr++7ykoDIEwSa3XWowTfNPo92BYxjXiyYEVrUQh2aLyhxBCwww+heortUFxEJYcRzosstTEBYQ==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"ms": "^2.1.3"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=6.0"
|
||||
},
|
||||
"peerDependenciesMeta": {
|
||||
"supports-color": {
|
||||
"optional": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"node_modules/depd": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz",
|
||||
"integrity": "sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/dunder-proto": {
|
||||
"version": "1.0.1",
|
||||
"resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz",
|
||||
"integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"call-bind-apply-helpers": "^1.0.1",
|
||||
"es-errors": "^1.3.0",
|
||||
"gopd": "^1.2.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
}
|
||||
},
|
||||
"node_modules/ee-first": {
|
||||
"version": "1.1.1",
|
||||
"resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz",
|
||||
"integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/encodeurl": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-2.0.0.tgz",
|
||||
"integrity": "sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/es-define-property": {
|
||||
"version": "1.0.1",
|
||||
"resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz",
|
||||
"integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
}
|
||||
},
|
||||
"node_modules/es-errors": {
|
||||
"version": "1.3.0",
|
||||
"resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz",
|
||||
"integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
}
|
||||
},
|
||||
"node_modules/es-object-atoms": {
|
||||
"version": "1.1.1",
|
||||
"resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz",
|
||||
"integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"es-errors": "^1.3.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
}
|
||||
},
|
||||
"node_modules/escape-html": {
|
||||
"version": "1.0.3",
|
||||
"resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz",
|
||||
"integrity": "sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/etag": {
|
||||
"version": "1.8.1",
|
||||
"resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz",
|
||||
"integrity": "sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/express": {
|
||||
"version": "5.1.0",
|
||||
"resolved": "https://registry.npmjs.org/express/-/express-5.1.0.tgz",
|
||||
"integrity": "sha512-DT9ck5YIRU+8GYzzU5kT3eHGA5iL+1Zd0EutOmTE9Dtk+Tvuzd23VBU+ec7HPNSTxXYO55gPV/hq4pSBJDjFpA==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"accepts": "^2.0.0",
|
||||
"body-parser": "^2.2.0",
|
||||
"content-disposition": "^1.0.0",
|
||||
"content-type": "^1.0.5",
|
||||
"cookie": "^0.7.1",
|
||||
"cookie-signature": "^1.2.1",
|
||||
"debug": "^4.4.0",
|
||||
"encodeurl": "^2.0.0",
|
||||
"escape-html": "^1.0.3",
|
||||
"etag": "^1.8.1",
|
||||
"finalhandler": "^2.1.0",
|
||||
"fresh": "^2.0.0",
|
||||
"http-errors": "^2.0.0",
|
||||
"merge-descriptors": "^2.0.0",
|
||||
"mime-types": "^3.0.0",
|
||||
"on-finished": "^2.4.1",
|
||||
"once": "^1.4.0",
|
||||
"parseurl": "^1.3.3",
|
||||
"proxy-addr": "^2.0.7",
|
||||
"qs": "^6.14.0",
|
||||
"range-parser": "^1.2.1",
|
||||
"router": "^2.2.0",
|
||||
"send": "^1.1.0",
|
||||
"serve-static": "^2.2.0",
|
||||
"statuses": "^2.0.1",
|
||||
"type-is": "^2.0.1",
|
||||
"vary": "^1.1.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 18"
|
||||
},
|
||||
"funding": {
|
||||
"type": "opencollective",
|
||||
"url": "https://opencollective.com/express"
|
||||
}
|
||||
},
|
||||
"node_modules/fetch-blob": {
|
||||
"version": "3.2.0",
|
||||
"resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz",
|
||||
"integrity": "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==",
|
||||
"funding": [
|
||||
{
|
||||
"type": "github",
|
||||
"url": "https://github.com/sponsors/jimmywarting"
|
||||
},
|
||||
{
|
||||
"type": "paypal",
|
||||
"url": "https://paypal.me/jimmywarting"
|
||||
}
|
||||
],
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"node-domexception": "^1.0.0",
|
||||
"web-streams-polyfill": "^3.0.3"
|
||||
},
|
||||
"engines": {
|
||||
"node": "^12.20 || >= 14.13"
|
||||
}
|
||||
},
|
||||
"node_modules/finalhandler": {
|
||||
"version": "2.1.0",
|
||||
"resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-2.1.0.tgz",
|
||||
"integrity": "sha512-/t88Ty3d5JWQbWYgaOGCCYfXRwV1+be02WqYYlL6h0lEiUAMPM8o8qKGO01YIkOHzka2up08wvgYD0mDiI+q3Q==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"debug": "^4.4.0",
|
||||
"encodeurl": "^2.0.0",
|
||||
"escape-html": "^1.0.3",
|
||||
"on-finished": "^2.4.1",
|
||||
"parseurl": "^1.3.3",
|
||||
"statuses": "^2.0.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/formdata-polyfill": {
|
||||
"version": "4.0.10",
|
||||
"resolved": "https://registry.npmjs.org/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz",
|
||||
"integrity": "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"fetch-blob": "^3.1.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=12.20.0"
|
||||
}
|
||||
},
|
||||
"node_modules/forwarded": {
|
||||
"version": "0.2.0",
|
||||
"resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz",
|
||||
"integrity": "sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/fresh": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/fresh/-/fresh-2.0.0.tgz",
|
||||
"integrity": "sha512-Rx/WycZ60HOaqLKAi6cHRKKI7zxWbJ31MhntmtwMoaTeF7XFH9hhBp8vITaMidfljRQ6eYWCKkaTK+ykVJHP2A==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/function-bind": {
|
||||
"version": "1.1.2",
|
||||
"resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz",
|
||||
"integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==",
|
||||
"license": "MIT",
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/get-intrinsic": {
|
||||
"version": "1.3.0",
|
||||
"resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz",
|
||||
"integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"call-bind-apply-helpers": "^1.0.2",
|
||||
"es-define-property": "^1.0.1",
|
||||
"es-errors": "^1.3.0",
|
||||
"es-object-atoms": "^1.1.1",
|
||||
"function-bind": "^1.1.2",
|
||||
"get-proto": "^1.0.1",
|
||||
"gopd": "^1.2.0",
|
||||
"has-symbols": "^1.1.0",
|
||||
"hasown": "^2.0.2",
|
||||
"math-intrinsics": "^1.1.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/get-proto": {
|
||||
"version": "1.0.1",
|
||||
"resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz",
|
||||
"integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"dunder-proto": "^1.0.1",
|
||||
"es-object-atoms": "^1.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
}
|
||||
},
|
||||
"node_modules/gopd": {
|
||||
"version": "1.2.0",
|
||||
"resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz",
|
||||
"integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/has-symbols": {
|
||||
"version": "1.1.0",
|
||||
"resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz",
|
||||
"integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/hasown": {
|
||||
"version": "2.0.2",
|
||||
"resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz",
|
||||
"integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"function-bind": "^1.1.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
}
|
||||
},
|
||||
"node_modules/http-errors": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.0.tgz",
|
||||
"integrity": "sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"depd": "2.0.0",
|
||||
"inherits": "2.0.4",
|
||||
"setprototypeof": "1.2.0",
|
||||
"statuses": "2.0.1",
|
||||
"toidentifier": "1.0.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/http-errors/node_modules/statuses": {
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz",
|
||||
"integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/iconv-lite": {
|
||||
"version": "0.6.3",
|
||||
"resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz",
|
||||
"integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"safer-buffer": ">= 2.1.2 < 3.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=0.10.0"
|
||||
}
|
||||
},
|
||||
"node_modules/inherits": {
|
||||
"version": "2.0.4",
|
||||
"resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
|
||||
"integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==",
|
||||
"license": "ISC"
|
||||
},
|
||||
"node_modules/ipaddr.js": {
|
||||
"version": "1.9.1",
|
||||
"resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz",
|
||||
"integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.10"
|
||||
}
|
||||
},
|
||||
"node_modules/is-promise": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/is-promise/-/is-promise-4.0.0.tgz",
|
||||
"integrity": "sha512-hvpoI6korhJMnej285dSg6nu1+e6uxs7zG3BYAm5byqDsgJNWwxzM6z6iZiAgQR4TJ30JmBTOwqZUw3WlyH3AQ==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/math-intrinsics": {
|
||||
"version": "1.1.0",
|
||||
"resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz",
|
||||
"integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
}
|
||||
},
|
||||
"node_modules/media-typer": {
|
||||
"version": "1.1.0",
|
||||
"resolved": "https://registry.npmjs.org/media-typer/-/media-typer-1.1.0.tgz",
|
||||
"integrity": "sha512-aisnrDP4GNe06UcKFnV5bfMNPBUw4jsLGaWwWfnH3v02GnBuXX2MCVn5RbrWo0j3pczUilYblq7fQ7Nw2t5XKw==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/merge-descriptors": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-2.0.0.tgz",
|
||||
"integrity": "sha512-Snk314V5ayFLhp3fkUREub6WtjBfPdCPY1Ln8/8munuLuiYhsABgBVWsozAG+MWMbVEvcdcpbi9R7ww22l9Q3g==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=18"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/sindresorhus"
|
||||
}
|
||||
},
|
||||
"node_modules/mime-db": {
|
||||
"version": "1.54.0",
|
||||
"resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz",
|
||||
"integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/mime-types": {
|
||||
"version": "3.0.1",
|
||||
"resolved": "https://registry.npmjs.org/mime-types/-/mime-types-3.0.1.tgz",
|
||||
"integrity": "sha512-xRc4oEhT6eaBpU1XF7AjpOFD+xQmXNB5OVKwp4tqCuBpHLS/ZbBDrc07mYTDqVMg6PfxUjjNp85O6Cd2Z/5HWA==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"mime-db": "^1.54.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/ms": {
|
||||
"version": "2.1.3",
|
||||
"resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
|
||||
"integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/negotiator": {
|
||||
"version": "1.0.0",
|
||||
"resolved": "https://registry.npmjs.org/negotiator/-/negotiator-1.0.0.tgz",
|
||||
"integrity": "sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/node-domexception": {
|
||||
"version": "1.0.0",
|
||||
"resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz",
|
||||
"integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ==",
|
||||
"deprecated": "Use your platform's native DOMException instead",
|
||||
"funding": [
|
||||
{
|
||||
"type": "github",
|
||||
"url": "https://github.com/sponsors/jimmywarting"
|
||||
},
|
||||
{
|
||||
"type": "github",
|
||||
"url": "https://paypal.me/jimmywarting"
|
||||
}
|
||||
],
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=10.5.0"
|
||||
}
|
||||
},
|
||||
"node_modules/node-fetch": {
|
||||
"version": "3.3.2",
|
||||
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.3.2.tgz",
|
||||
"integrity": "sha512-dRB78srN/l6gqWulah9SrxeYnxeddIG30+GOqK/9OlLVyLg3HPnr6SqOWTWOXKRwC2eGYCkZ59NNuSgvSrpgOA==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"data-uri-to-buffer": "^4.0.0",
|
||||
"fetch-blob": "^3.1.4",
|
||||
"formdata-polyfill": "^4.0.10"
|
||||
},
|
||||
"engines": {
|
||||
"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
|
||||
},
|
||||
"funding": {
|
||||
"type": "opencollective",
|
||||
"url": "https://opencollective.com/node-fetch"
|
||||
}
|
||||
},
|
||||
"node_modules/object-inspect": {
|
||||
"version": "1.13.4",
|
||||
"resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz",
|
||||
"integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/on-finished": {
|
||||
"version": "2.4.1",
|
||||
"resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz",
|
||||
"integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"ee-first": "1.1.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/once": {
|
||||
"version": "1.4.0",
|
||||
"resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
|
||||
"integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"wrappy": "1"
|
||||
}
|
||||
},
|
||||
"node_modules/parseurl": {
|
||||
"version": "1.3.3",
|
||||
"resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz",
|
||||
"integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/path-to-regexp": {
|
||||
"version": "8.2.0",
|
||||
"resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-8.2.0.tgz",
|
||||
"integrity": "sha512-TdrF7fW9Rphjq4RjrW0Kp2AW0Ahwu9sRGTkS6bvDi0SCwZlEZYmcfDbEsTz8RVk0EHIS/Vd1bv3JhG+1xZuAyQ==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=16"
|
||||
}
|
||||
},
|
||||
"node_modules/proxy-addr": {
|
||||
"version": "2.0.7",
|
||||
"resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.7.tgz",
|
||||
"integrity": "sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"forwarded": "0.2.0",
|
||||
"ipaddr.js": "1.9.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.10"
|
||||
}
|
||||
},
|
||||
"node_modules/qs": {
|
||||
"version": "6.14.0",
|
||||
"resolved": "https://registry.npmjs.org/qs/-/qs-6.14.0.tgz",
|
||||
"integrity": "sha512-YWWTjgABSKcvs/nWBi9PycY/JiPJqOD4JA6o9Sej2AtvSGarXxKC3OQSk4pAarbdQlKAh5D4FCQkJNkW+GAn3w==",
|
||||
"license": "BSD-3-Clause",
|
||||
"dependencies": {
|
||||
"side-channel": "^1.1.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=0.6"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/range-parser": {
|
||||
"version": "1.2.1",
|
||||
"resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz",
|
||||
"integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/raw-body": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/raw-body/-/raw-body-3.0.0.tgz",
|
||||
"integrity": "sha512-RmkhL8CAyCRPXCE28MMH0z2PNWQBNk2Q09ZdxM9IOOXwxwZbN+qbWaatPkdkWIKL2ZVDImrN/pK5HTRz2PcS4g==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"bytes": "3.1.2",
|
||||
"http-errors": "2.0.0",
|
||||
"iconv-lite": "0.6.3",
|
||||
"unpipe": "1.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/router": {
|
||||
"version": "2.2.0",
|
||||
"resolved": "https://registry.npmjs.org/router/-/router-2.2.0.tgz",
|
||||
"integrity": "sha512-nLTrUKm2UyiL7rlhapu/Zl45FwNgkZGaCpZbIHajDYgwlJCOzLSk+cIPAnsEqV955GjILJnKbdQC1nVPz+gAYQ==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"debug": "^4.4.0",
|
||||
"depd": "^2.0.0",
|
||||
"is-promise": "^4.0.0",
|
||||
"parseurl": "^1.3.3",
|
||||
"path-to-regexp": "^8.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 18"
|
||||
}
|
||||
},
|
||||
"node_modules/safe-buffer": {
|
||||
"version": "5.2.1",
|
||||
"resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz",
|
||||
"integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==",
|
||||
"funding": [
|
||||
{
|
||||
"type": "github",
|
||||
"url": "https://github.com/sponsors/feross"
|
||||
},
|
||||
{
|
||||
"type": "patreon",
|
||||
"url": "https://www.patreon.com/feross"
|
||||
},
|
||||
{
|
||||
"type": "consulting",
|
||||
"url": "https://feross.org/support"
|
||||
}
|
||||
],
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/safer-buffer": {
|
||||
"version": "2.1.2",
|
||||
"resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz",
|
||||
"integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/send": {
|
||||
"version": "1.2.0",
|
||||
"resolved": "https://registry.npmjs.org/send/-/send-1.2.0.tgz",
|
||||
"integrity": "sha512-uaW0WwXKpL9blXE2o0bRhoL2EGXIrZxQ2ZQ4mgcfoBxdFmQold+qWsD2jLrfZ0trjKL6vOw0j//eAwcALFjKSw==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"debug": "^4.3.5",
|
||||
"encodeurl": "^2.0.0",
|
||||
"escape-html": "^1.0.3",
|
||||
"etag": "^1.8.1",
|
||||
"fresh": "^2.0.0",
|
||||
"http-errors": "^2.0.0",
|
||||
"mime-types": "^3.0.1",
|
||||
"ms": "^2.1.3",
|
||||
"on-finished": "^2.4.1",
|
||||
"range-parser": "^1.2.1",
|
||||
"statuses": "^2.0.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 18"
|
||||
}
|
||||
},
|
||||
"node_modules/serve-static": {
|
||||
"version": "2.2.0",
|
||||
"resolved": "https://registry.npmjs.org/serve-static/-/serve-static-2.2.0.tgz",
|
||||
"integrity": "sha512-61g9pCh0Vnh7IutZjtLGGpTA355+OPn2TyDv/6ivP2h/AdAVX9azsoxmg2/M6nZeQZNYBEwIcsne1mJd9oQItQ==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"encodeurl": "^2.0.0",
|
||||
"escape-html": "^1.0.3",
|
||||
"parseurl": "^1.3.3",
|
||||
"send": "^1.2.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 18"
|
||||
}
|
||||
},
|
||||
"node_modules/setprototypeof": {
|
||||
"version": "1.2.0",
|
||||
"resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz",
|
||||
"integrity": "sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==",
|
||||
"license": "ISC"
|
||||
},
|
||||
"node_modules/side-channel": {
|
||||
"version": "1.1.0",
|
||||
"resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz",
|
||||
"integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"es-errors": "^1.3.0",
|
||||
"object-inspect": "^1.13.3",
|
||||
"side-channel-list": "^1.0.0",
|
||||
"side-channel-map": "^1.0.1",
|
||||
"side-channel-weakmap": "^1.0.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/side-channel-list": {
|
||||
"version": "1.0.0",
|
||||
"resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz",
|
||||
"integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"es-errors": "^1.3.0",
|
||||
"object-inspect": "^1.13.3"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/side-channel-map": {
|
||||
"version": "1.0.1",
|
||||
"resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz",
|
||||
"integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"call-bound": "^1.0.2",
|
||||
"es-errors": "^1.3.0",
|
||||
"get-intrinsic": "^1.2.5",
|
||||
"object-inspect": "^1.13.3"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/side-channel-weakmap": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz",
|
||||
"integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"call-bound": "^1.0.2",
|
||||
"es-errors": "^1.3.0",
|
||||
"get-intrinsic": "^1.2.5",
|
||||
"object-inspect": "^1.13.3",
|
||||
"side-channel-map": "^1.0.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/statuses": {
|
||||
"version": "2.0.2",
|
||||
"resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.2.tgz",
|
||||
"integrity": "sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/toidentifier": {
|
||||
"version": "1.0.1",
|
||||
"resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz",
|
||||
"integrity": "sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/type-is": {
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/type-is/-/type-is-2.0.1.tgz",
|
||||
"integrity": "sha512-OZs6gsjF4vMp32qrCbiVSkrFmXtG/AZhY3t0iAMrMBiAZyV9oALtXO8hsrHbMXF9x6L3grlFuwW2oAz7cav+Gw==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"content-type": "^1.0.5",
|
||||
"media-typer": "^1.1.0",
|
||||
"mime-types": "^3.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/unpipe": {
|
||||
"version": "1.0.0",
|
||||
"resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz",
|
||||
"integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/vary": {
|
||||
"version": "1.1.2",
|
||||
"resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz",
|
||||
"integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/web-streams-polyfill": {
|
||||
"version": "3.3.3",
|
||||
"resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.3.3.tgz",
|
||||
"integrity": "sha512-d2JWLCivmZYTSIoge9MsgFCZrt571BikcWGYkjC1khllbTeDlGqZ2D8vD8E/lJa8WGWbb7Plm8/XJYV7IJHZZw==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 8"
|
||||
}
|
||||
},
|
||||
"node_modules/wrappy": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
|
||||
"integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==",
|
||||
"license": "ISC"
|
||||
}
|
||||
}
|
||||
}
|
||||
-250
@@ -1,250 +0,0 @@
|
||||
2.0.0 / 2024-08-31
|
||||
==================
|
||||
|
||||
* Drop node <18 support
|
||||
* deps: mime-types@^3.0.0
|
||||
* deps: negotiator@^1.0.0
|
||||
|
||||
1.3.8 / 2022-02-02
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.1.34
|
||||
- deps: mime-db@~1.51.0
|
||||
* deps: negotiator@0.6.3
|
||||
|
||||
1.3.7 / 2019-04-29
|
||||
==================
|
||||
|
||||
* deps: negotiator@0.6.2
|
||||
- Fix sorting charset, encoding, and language with extra parameters
|
||||
|
||||
1.3.6 / 2019-04-28
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.1.24
|
||||
- deps: mime-db@~1.40.0
|
||||
|
||||
1.3.5 / 2018-02-28
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.1.18
|
||||
- deps: mime-db@~1.33.0
|
||||
|
||||
1.3.4 / 2017-08-22
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.1.16
|
||||
- deps: mime-db@~1.29.0
|
||||
|
||||
1.3.3 / 2016-05-02
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.1.11
|
||||
- deps: mime-db@~1.23.0
|
||||
* deps: negotiator@0.6.1
|
||||
- perf: improve `Accept` parsing speed
|
||||
- perf: improve `Accept-Charset` parsing speed
|
||||
- perf: improve `Accept-Encoding` parsing speed
|
||||
- perf: improve `Accept-Language` parsing speed
|
||||
|
||||
1.3.2 / 2016-03-08
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.1.10
|
||||
- Fix extension of `application/dash+xml`
|
||||
- Update primary extension for `audio/mp4`
|
||||
- deps: mime-db@~1.22.0
|
||||
|
||||
1.3.1 / 2016-01-19
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.1.9
|
||||
- deps: mime-db@~1.21.0
|
||||
|
||||
1.3.0 / 2015-09-29
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.1.7
|
||||
- deps: mime-db@~1.19.0
|
||||
* deps: negotiator@0.6.0
|
||||
- Fix including type extensions in parameters in `Accept` parsing
|
||||
- Fix parsing `Accept` parameters with quoted equals
|
||||
- Fix parsing `Accept` parameters with quoted semicolons
|
||||
- Lazy-load modules from main entry point
|
||||
- perf: delay type concatenation until needed
|
||||
- perf: enable strict mode
|
||||
- perf: hoist regular expressions
|
||||
- perf: remove closures getting spec properties
|
||||
- perf: remove a closure from media type parsing
|
||||
- perf: remove property delete from media type parsing
|
||||
|
||||
1.2.13 / 2015-09-06
|
||||
===================
|
||||
|
||||
* deps: mime-types@~2.1.6
|
||||
- deps: mime-db@~1.18.0
|
||||
|
||||
1.2.12 / 2015-07-30
|
||||
===================
|
||||
|
||||
* deps: mime-types@~2.1.4
|
||||
- deps: mime-db@~1.16.0
|
||||
|
||||
1.2.11 / 2015-07-16
|
||||
===================
|
||||
|
||||
* deps: mime-types@~2.1.3
|
||||
- deps: mime-db@~1.15.0
|
||||
|
||||
1.2.10 / 2015-07-01
|
||||
===================
|
||||
|
||||
* deps: mime-types@~2.1.2
|
||||
- deps: mime-db@~1.14.0
|
||||
|
||||
1.2.9 / 2015-06-08
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.1.1
|
||||
- perf: fix deopt during mapping
|
||||
|
||||
1.2.8 / 2015-06-07
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.1.0
|
||||
- deps: mime-db@~1.13.0
|
||||
* perf: avoid argument reassignment & argument slice
|
||||
* perf: avoid negotiator recursive construction
|
||||
* perf: enable strict mode
|
||||
* perf: remove unnecessary bitwise operator
|
||||
|
||||
1.2.7 / 2015-05-10
|
||||
==================
|
||||
|
||||
* deps: negotiator@0.5.3
|
||||
- Fix media type parameter matching to be case-insensitive
|
||||
|
||||
1.2.6 / 2015-05-07
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.0.11
|
||||
- deps: mime-db@~1.9.1
|
||||
* deps: negotiator@0.5.2
|
||||
- Fix comparing media types with quoted values
|
||||
- Fix splitting media types with quoted commas
|
||||
|
||||
1.2.5 / 2015-03-13
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.0.10
|
||||
- deps: mime-db@~1.8.0
|
||||
|
||||
1.2.4 / 2015-02-14
|
||||
==================
|
||||
|
||||
* Support Node.js 0.6
|
||||
* deps: mime-types@~2.0.9
|
||||
- deps: mime-db@~1.7.0
|
||||
* deps: negotiator@0.5.1
|
||||
- Fix preference sorting to be stable for long acceptable lists
|
||||
|
||||
1.2.3 / 2015-01-31
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.0.8
|
||||
- deps: mime-db@~1.6.0
|
||||
|
||||
1.2.2 / 2014-12-30
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.0.7
|
||||
- deps: mime-db@~1.5.0
|
||||
|
||||
1.2.1 / 2014-12-30
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.0.5
|
||||
- deps: mime-db@~1.3.1
|
||||
|
||||
1.2.0 / 2014-12-19
|
||||
==================
|
||||
|
||||
* deps: negotiator@0.5.0
|
||||
- Fix list return order when large accepted list
|
||||
- Fix missing identity encoding when q=0 exists
|
||||
- Remove dynamic building of Negotiator class
|
||||
|
||||
1.1.4 / 2014-12-10
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.0.4
|
||||
- deps: mime-db@~1.3.0
|
||||
|
||||
1.1.3 / 2014-11-09
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.0.3
|
||||
- deps: mime-db@~1.2.0
|
||||
|
||||
1.1.2 / 2014-10-14
|
||||
==================
|
||||
|
||||
* deps: negotiator@0.4.9
|
||||
- Fix error when media type has invalid parameter
|
||||
|
||||
1.1.1 / 2014-09-28
|
||||
==================
|
||||
|
||||
* deps: mime-types@~2.0.2
|
||||
- deps: mime-db@~1.1.0
|
||||
* deps: negotiator@0.4.8
|
||||
- Fix all negotiations to be case-insensitive
|
||||
- Stable sort preferences of same quality according to client order
|
||||
|
||||
1.1.0 / 2014-09-02
|
||||
==================
|
||||
|
||||
* update `mime-types`
|
||||
|
||||
1.0.7 / 2014-07-04
|
||||
==================
|
||||
|
||||
* Fix wrong type returned from `type` when match after unknown extension
|
||||
|
||||
1.0.6 / 2014-06-24
|
||||
==================
|
||||
|
||||
* deps: negotiator@0.4.7
|
||||
|
||||
1.0.5 / 2014-06-20
|
||||
==================
|
||||
|
||||
* fix crash when unknown extension given
|
||||
|
||||
1.0.4 / 2014-06-19
|
||||
==================
|
||||
|
||||
* use `mime-types`
|
||||
|
||||
1.0.3 / 2014-06-11
|
||||
==================
|
||||
|
||||
* deps: negotiator@0.4.6
|
||||
- Order by specificity when quality is the same
|
||||
|
||||
1.0.2 / 2014-05-29
|
||||
==================
|
||||
|
||||
* Fix interpretation when header not in request
|
||||
* deps: pin negotiator@0.4.5
|
||||
|
||||
1.0.1 / 2014-01-18
|
||||
==================
|
||||
|
||||
* Identity encoding isn't always acceptable
|
||||
* deps: negotiator@~0.4.0
|
||||
|
||||
1.0.0 / 2013-12-27
|
||||
==================
|
||||
|
||||
* Genesis
|
||||
-23
@@ -1,23 +0,0 @@
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
|
||||
Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.com>
|
||||
|
||||
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.
|
||||
-140
@@ -1,140 +0,0 @@
|
||||
# accepts
|
||||
|
||||
[![NPM Version][npm-version-image]][npm-url]
|
||||
[![NPM Downloads][npm-downloads-image]][npm-url]
|
||||
[![Node.js Version][node-version-image]][node-version-url]
|
||||
[![Build Status][github-actions-ci-image]][github-actions-ci-url]
|
||||
[![Test Coverage][coveralls-image]][coveralls-url]
|
||||
|
||||
Higher level content negotiation based on [negotiator](https://www.npmjs.com/package/negotiator).
|
||||
Extracted from [koa](https://www.npmjs.com/package/koa) for general use.
|
||||
|
||||
In addition to negotiator, it allows:
|
||||
|
||||
- Allows types as an array or arguments list, ie `(['text/html', 'application/json'])`
|
||||
as well as `('text/html', 'application/json')`.
|
||||
- Allows type shorthands such as `json`.
|
||||
- Returns `false` when no types match
|
||||
- Treats non-existent headers as `*`
|
||||
|
||||
## Installation
|
||||
|
||||
This is a [Node.js](https://nodejs.org/en/) module available through the
|
||||
[npm registry](https://www.npmjs.com/). Installation is done using the
|
||||
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
|
||||
|
||||
```sh
|
||||
$ npm install accepts
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
```js
|
||||
var accepts = require('accepts')
|
||||
```
|
||||
|
||||
### accepts(req)
|
||||
|
||||
Create a new `Accepts` object for the given `req`.
|
||||
|
||||
#### .charset(charsets)
|
||||
|
||||
Return the first accepted charset. If nothing in `charsets` is accepted,
|
||||
then `false` is returned.
|
||||
|
||||
#### .charsets()
|
||||
|
||||
Return the charsets that the request accepts, in the order of the client's
|
||||
preference (most preferred first).
|
||||
|
||||
#### .encoding(encodings)
|
||||
|
||||
Return the first accepted encoding. If nothing in `encodings` is accepted,
|
||||
then `false` is returned.
|
||||
|
||||
#### .encodings()
|
||||
|
||||
Return the encodings that the request accepts, in the order of the client's
|
||||
preference (most preferred first).
|
||||
|
||||
#### .language(languages)
|
||||
|
||||
Return the first accepted language. If nothing in `languages` is accepted,
|
||||
then `false` is returned.
|
||||
|
||||
#### .languages()
|
||||
|
||||
Return the languages that the request accepts, in the order of the client's
|
||||
preference (most preferred first).
|
||||
|
||||
#### .type(types)
|
||||
|
||||
Return the first accepted type (and it is returned as the same text as what
|
||||
appears in the `types` array). If nothing in `types` is accepted, then `false`
|
||||
is returned.
|
||||
|
||||
The `types` array can contain full MIME types or file extensions. Any value
|
||||
that is not a full MIME type is passed to `require('mime-types').lookup`.
|
||||
|
||||
#### .types()
|
||||
|
||||
Return the types that the request accepts, in the order of the client's
|
||||
preference (most preferred first).
|
||||
|
||||
## Examples
|
||||
|
||||
### Simple type negotiation
|
||||
|
||||
This simple example shows how to use `accepts` to return a different typed
|
||||
respond body based on what the client wants to accept. The server lists it's
|
||||
preferences in order and will get back the best match between the client and
|
||||
server.
|
||||
|
||||
```js
|
||||
var accepts = require('accepts')
|
||||
var http = require('http')
|
||||
|
||||
function app (req, res) {
|
||||
var accept = accepts(req)
|
||||
|
||||
// the order of this list is significant; should be server preferred order
|
||||
switch (accept.type(['json', 'html'])) {
|
||||
case 'json':
|
||||
res.setHeader('Content-Type', 'application/json')
|
||||
res.write('{"hello":"world!"}')
|
||||
break
|
||||
case 'html':
|
||||
res.setHeader('Content-Type', 'text/html')
|
||||
res.write('<b>hello, world!</b>')
|
||||
break
|
||||
default:
|
||||
// the fallback is text/plain, so no need to specify it above
|
||||
res.setHeader('Content-Type', 'text/plain')
|
||||
res.write('hello, world!')
|
||||
break
|
||||
}
|
||||
|
||||
res.end()
|
||||
}
|
||||
|
||||
http.createServer(app).listen(3000)
|
||||
```
|
||||
|
||||
You can test this out with the cURL program:
|
||||
```sh
|
||||
curl -I -H'Accept: text/html' http://localhost:3000/
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
||||
[coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/accepts/master
|
||||
[coveralls-url]: https://coveralls.io/r/jshttp/accepts?branch=master
|
||||
[github-actions-ci-image]: https://badgen.net/github/checks/jshttp/accepts/master?label=ci
|
||||
[github-actions-ci-url]: https://github.com/jshttp/accepts/actions/workflows/ci.yml
|
||||
[node-version-image]: https://badgen.net/npm/node/accepts
|
||||
[node-version-url]: https://nodejs.org/en/download
|
||||
[npm-downloads-image]: https://badgen.net/npm/dm/accepts
|
||||
[npm-url]: https://npmjs.org/package/accepts
|
||||
[npm-version-image]: https://badgen.net/npm/v/accepts
|
||||
-238
@@ -1,238 +0,0 @@
|
||||
/*!
|
||||
* accepts
|
||||
* Copyright(c) 2014 Jonathan Ong
|
||||
* Copyright(c) 2015 Douglas Christopher Wilson
|
||||
* MIT Licensed
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
/**
|
||||
* Module dependencies.
|
||||
* @private
|
||||
*/
|
||||
|
||||
var Negotiator = require('negotiator')
|
||||
var mime = require('mime-types')
|
||||
|
||||
/**
|
||||
* Module exports.
|
||||
* @public
|
||||
*/
|
||||
|
||||
module.exports = Accepts
|
||||
|
||||
/**
|
||||
* Create a new Accepts object for the given req.
|
||||
*
|
||||
* @param {object} req
|
||||
* @public
|
||||
*/
|
||||
|
||||
function Accepts (req) {
|
||||
if (!(this instanceof Accepts)) {
|
||||
return new Accepts(req)
|
||||
}
|
||||
|
||||
this.headers = req.headers
|
||||
this.negotiator = new Negotiator(req)
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the given `type(s)` is acceptable, returning
|
||||
* the best match when true, otherwise `undefined`, in which
|
||||
* case you should respond with 406 "Not Acceptable".
|
||||
*
|
||||
* The `type` value may be a single mime type string
|
||||
* such as "application/json", the extension name
|
||||
* such as "json" or an array `["json", "html", "text/plain"]`. When a list
|
||||
* or array is given the _best_ match, if any is returned.
|
||||
*
|
||||
* Examples:
|
||||
*
|
||||
* // Accept: text/html
|
||||
* this.types('html');
|
||||
* // => "html"
|
||||
*
|
||||
* // Accept: text/*, application/json
|
||||
* this.types('html');
|
||||
* // => "html"
|
||||
* this.types('text/html');
|
||||
* // => "text/html"
|
||||
* this.types('json', 'text');
|
||||
* // => "json"
|
||||
* this.types('application/json');
|
||||
* // => "application/json"
|
||||
*
|
||||
* // Accept: text/*, application/json
|
||||
* this.types('image/png');
|
||||
* this.types('png');
|
||||
* // => undefined
|
||||
*
|
||||
* // Accept: text/*;q=.5, application/json
|
||||
* this.types(['html', 'json']);
|
||||
* this.types('html', 'json');
|
||||
* // => "json"
|
||||
*
|
||||
* @param {String|Array} types...
|
||||
* @return {String|Array|Boolean}
|
||||
* @public
|
||||
*/
|
||||
|
||||
Accepts.prototype.type =
|
||||
Accepts.prototype.types = function (types_) {
|
||||
var types = types_
|
||||
|
||||
// support flattened arguments
|
||||
if (types && !Array.isArray(types)) {
|
||||
types = new Array(arguments.length)
|
||||
for (var i = 0; i < types.length; i++) {
|
||||
types[i] = arguments[i]
|
||||
}
|
||||
}
|
||||
|
||||
// no types, return all requested types
|
||||
if (!types || types.length === 0) {
|
||||
return this.negotiator.mediaTypes()
|
||||
}
|
||||
|
||||
// no accept header, return first given type
|
||||
if (!this.headers.accept) {
|
||||
return types[0]
|
||||
}
|
||||
|
||||
var mimes = types.map(extToMime)
|
||||
var accepts = this.negotiator.mediaTypes(mimes.filter(validMime))
|
||||
var first = accepts[0]
|
||||
|
||||
return first
|
||||
? types[mimes.indexOf(first)]
|
||||
: false
|
||||
}
|
||||
|
||||
/**
|
||||
* Return accepted encodings or best fit based on `encodings`.
|
||||
*
|
||||
* Given `Accept-Encoding: gzip, deflate`
|
||||
* an array sorted by quality is returned:
|
||||
*
|
||||
* ['gzip', 'deflate']
|
||||
*
|
||||
* @param {String|Array} encodings...
|
||||
* @return {String|Array}
|
||||
* @public
|
||||
*/
|
||||
|
||||
Accepts.prototype.encoding =
|
||||
Accepts.prototype.encodings = function (encodings_) {
|
||||
var encodings = encodings_
|
||||
|
||||
// support flattened arguments
|
||||
if (encodings && !Array.isArray(encodings)) {
|
||||
encodings = new Array(arguments.length)
|
||||
for (var i = 0; i < encodings.length; i++) {
|
||||
encodings[i] = arguments[i]
|
||||
}
|
||||
}
|
||||
|
||||
// no encodings, return all requested encodings
|
||||
if (!encodings || encodings.length === 0) {
|
||||
return this.negotiator.encodings()
|
||||
}
|
||||
|
||||
return this.negotiator.encodings(encodings)[0] || false
|
||||
}
|
||||
|
||||
/**
|
||||
* Return accepted charsets or best fit based on `charsets`.
|
||||
*
|
||||
* Given `Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5`
|
||||
* an array sorted by quality is returned:
|
||||
*
|
||||
* ['utf-8', 'utf-7', 'iso-8859-1']
|
||||
*
|
||||
* @param {String|Array} charsets...
|
||||
* @return {String|Array}
|
||||
* @public
|
||||
*/
|
||||
|
||||
Accepts.prototype.charset =
|
||||
Accepts.prototype.charsets = function (charsets_) {
|
||||
var charsets = charsets_
|
||||
|
||||
// support flattened arguments
|
||||
if (charsets && !Array.isArray(charsets)) {
|
||||
charsets = new Array(arguments.length)
|
||||
for (var i = 0; i < charsets.length; i++) {
|
||||
charsets[i] = arguments[i]
|
||||
}
|
||||
}
|
||||
|
||||
// no charsets, return all requested charsets
|
||||
if (!charsets || charsets.length === 0) {
|
||||
return this.negotiator.charsets()
|
||||
}
|
||||
|
||||
return this.negotiator.charsets(charsets)[0] || false
|
||||
}
|
||||
|
||||
/**
|
||||
* Return accepted languages or best fit based on `langs`.
|
||||
*
|
||||
* Given `Accept-Language: en;q=0.8, es, pt`
|
||||
* an array sorted by quality is returned:
|
||||
*
|
||||
* ['es', 'pt', 'en']
|
||||
*
|
||||
* @param {String|Array} langs...
|
||||
* @return {Array|String}
|
||||
* @public
|
||||
*/
|
||||
|
||||
Accepts.prototype.lang =
|
||||
Accepts.prototype.langs =
|
||||
Accepts.prototype.language =
|
||||
Accepts.prototype.languages = function (languages_) {
|
||||
var languages = languages_
|
||||
|
||||
// support flattened arguments
|
||||
if (languages && !Array.isArray(languages)) {
|
||||
languages = new Array(arguments.length)
|
||||
for (var i = 0; i < languages.length; i++) {
|
||||
languages[i] = arguments[i]
|
||||
}
|
||||
}
|
||||
|
||||
// no languages, return all requested languages
|
||||
if (!languages || languages.length === 0) {
|
||||
return this.negotiator.languages()
|
||||
}
|
||||
|
||||
return this.negotiator.languages(languages)[0] || false
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert extnames to mime.
|
||||
*
|
||||
* @param {String} type
|
||||
* @return {String}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function extToMime (type) {
|
||||
return type.indexOf('/') === -1
|
||||
? mime.lookup(type)
|
||||
: type
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if mime is valid.
|
||||
*
|
||||
* @param {String} type
|
||||
* @return {Boolean}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function validMime (type) {
|
||||
return typeof type === 'string'
|
||||
}
|
||||
-47
@@ -1,47 +0,0 @@
|
||||
{
|
||||
"name": "accepts",
|
||||
"description": "Higher-level content negotiation",
|
||||
"version": "2.0.0",
|
||||
"contributors": [
|
||||
"Douglas Christopher Wilson <doug@somethingdoug.com>",
|
||||
"Jonathan Ong <me@jongleberry.com> (http://jongleberry.com)"
|
||||
],
|
||||
"license": "MIT",
|
||||
"repository": "jshttp/accepts",
|
||||
"dependencies": {
|
||||
"mime-types": "^3.0.0",
|
||||
"negotiator": "^1.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"deep-equal": "1.0.1",
|
||||
"eslint": "7.32.0",
|
||||
"eslint-config-standard": "14.1.1",
|
||||
"eslint-plugin-import": "2.25.4",
|
||||
"eslint-plugin-markdown": "2.2.1",
|
||||
"eslint-plugin-node": "11.1.0",
|
||||
"eslint-plugin-promise": "4.3.1",
|
||||
"eslint-plugin-standard": "4.1.0",
|
||||
"mocha": "9.2.0",
|
||||
"nyc": "15.1.0"
|
||||
},
|
||||
"files": [
|
||||
"LICENSE",
|
||||
"HISTORY.md",
|
||||
"index.js"
|
||||
],
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
},
|
||||
"scripts": {
|
||||
"lint": "eslint .",
|
||||
"test": "mocha --reporter spec --check-leaks --bail test/",
|
||||
"test-ci": "nyc --reporter=lcov --reporter=text npm test",
|
||||
"test-cov": "nyc --reporter=html --reporter=text npm test"
|
||||
},
|
||||
"keywords": [
|
||||
"content",
|
||||
"negotiation",
|
||||
"accept",
|
||||
"accepts"
|
||||
]
|
||||
}
|
||||
-731
@@ -1,731 +0,0 @@
|
||||
2.2.0 / 2025-03-27
|
||||
=========================
|
||||
|
||||
* refactor: normalize common options for all parsers
|
||||
* deps:
|
||||
* iconv-lite@^0.6.3
|
||||
|
||||
2.1.0 / 2025-02-10
|
||||
=========================
|
||||
|
||||
* deps:
|
||||
* type-is@^2.0.0
|
||||
* debug@^4.4.0
|
||||
* Removed destroy
|
||||
* refactor: prefix built-in node module imports
|
||||
* use the node require cache instead of custom caching
|
||||
|
||||
2.0.2 / 2024-10-31
|
||||
=========================
|
||||
|
||||
* remove `unpipe` package and use native `unpipe()` method
|
||||
|
||||
2.0.1 / 2024-09-10
|
||||
=========================
|
||||
|
||||
* Restore expected behavior `extended` to `false`
|
||||
|
||||
2.0.0 / 2024-09-10
|
||||
=========================
|
||||
* Propagate changes from 1.20.3
|
||||
* add brotli support #406
|
||||
* Breaking Change: Node.js 18 is the minimum supported version
|
||||
|
||||
2.0.0-beta.2 / 2023-02-23
|
||||
=========================
|
||||
|
||||
This incorporates all changes after 1.19.1 up to 1.20.2.
|
||||
|
||||
* Remove deprecated `bodyParser()` combination middleware
|
||||
* deps: debug@3.1.0
|
||||
- Add `DEBUG_HIDE_DATE` environment variable
|
||||
- Change timer to per-namespace instead of global
|
||||
- Change non-TTY date format
|
||||
- Remove `DEBUG_FD` environment variable support
|
||||
- Support 256 namespace colors
|
||||
* deps: iconv-lite@0.5.2
|
||||
- Add encoding cp720
|
||||
- Add encoding UTF-32
|
||||
* deps: raw-body@3.0.0-beta.1
|
||||
|
||||
2.0.0-beta.1 / 2021-12-17
|
||||
=========================
|
||||
|
||||
* Drop support for Node.js 0.8
|
||||
* `req.body` is no longer always initialized to `{}`
|
||||
- it is left `undefined` unless a body is parsed
|
||||
* `urlencoded` parser now defaults `extended` to `false`
|
||||
* Use `on-finished` to determine when body read
|
||||
|
||||
1.20.3 / 2024-09-10
|
||||
===================
|
||||
|
||||
* deps: qs@6.13.0
|
||||
* add `depth` option to customize the depth level in the parser
|
||||
* IMPORTANT: The default `depth` level for parsing URL-encoded data is now `32` (previously was `Infinity`)
|
||||
|
||||
1.20.2 / 2023-02-21
|
||||
===================
|
||||
|
||||
* Fix strict json error message on Node.js 19+
|
||||
* deps: content-type@~1.0.5
|
||||
- perf: skip value escaping when unnecessary
|
||||
* deps: raw-body@2.5.2
|
||||
|
||||
1.20.1 / 2022-10-06
|
||||
===================
|
||||
|
||||
* deps: qs@6.11.0
|
||||
* perf: remove unnecessary object clone
|
||||
|
||||
1.20.0 / 2022-04-02
|
||||
===================
|
||||
|
||||
* Fix error message for json parse whitespace in `strict`
|
||||
* Fix internal error when inflated body exceeds limit
|
||||
* Prevent loss of async hooks context
|
||||
* Prevent hanging when request already read
|
||||
* deps: depd@2.0.0
|
||||
- Replace internal `eval` usage with `Function` constructor
|
||||
- Use instance methods on `process` to check for listeners
|
||||
* deps: http-errors@2.0.0
|
||||
- deps: depd@2.0.0
|
||||
- deps: statuses@2.0.1
|
||||
* deps: on-finished@2.4.1
|
||||
* deps: qs@6.10.3
|
||||
* deps: raw-body@2.5.1
|
||||
- deps: http-errors@2.0.0
|
||||
|
||||
1.19.2 / 2022-02-15
|
||||
===================
|
||||
|
||||
* deps: bytes@3.1.2
|
||||
* deps: qs@6.9.7
|
||||
* Fix handling of `__proto__` keys
|
||||
* deps: raw-body@2.4.3
|
||||
- deps: bytes@3.1.2
|
||||
|
||||
1.19.1 / 2021-12-10
|
||||
===================
|
||||
|
||||
* deps: bytes@3.1.1
|
||||
* deps: http-errors@1.8.1
|
||||
- deps: inherits@2.0.4
|
||||
- deps: toidentifier@1.0.1
|
||||
- deps: setprototypeof@1.2.0
|
||||
* deps: qs@6.9.6
|
||||
* deps: raw-body@2.4.2
|
||||
- deps: bytes@3.1.1
|
||||
- deps: http-errors@1.8.1
|
||||
* deps: safe-buffer@5.2.1
|
||||
* deps: type-is@~1.6.18
|
||||
|
||||
1.19.0 / 2019-04-25
|
||||
===================
|
||||
|
||||
* deps: bytes@3.1.0
|
||||
- Add petabyte (`pb`) support
|
||||
* deps: http-errors@1.7.2
|
||||
- Set constructor name when possible
|
||||
- deps: setprototypeof@1.1.1
|
||||
- deps: statuses@'>= 1.5.0 < 2'
|
||||
* deps: iconv-lite@0.4.24
|
||||
- Added encoding MIK
|
||||
* deps: qs@6.7.0
|
||||
- Fix parsing array brackets after index
|
||||
* deps: raw-body@2.4.0
|
||||
- deps: bytes@3.1.0
|
||||
- deps: http-errors@1.7.2
|
||||
- deps: iconv-lite@0.4.24
|
||||
* deps: type-is@~1.6.17
|
||||
- deps: mime-types@~2.1.24
|
||||
- perf: prevent internal `throw` on invalid type
|
||||
|
||||
1.18.3 / 2018-05-14
|
||||
===================
|
||||
|
||||
* Fix stack trace for strict json parse error
|
||||
* deps: depd@~1.1.2
|
||||
- perf: remove argument reassignment
|
||||
* deps: http-errors@~1.6.3
|
||||
- deps: depd@~1.1.2
|
||||
- deps: setprototypeof@1.1.0
|
||||
- deps: statuses@'>= 1.3.1 < 2'
|
||||
* deps: iconv-lite@0.4.23
|
||||
- Fix loading encoding with year appended
|
||||
- Fix deprecation warnings on Node.js 10+
|
||||
* deps: qs@6.5.2
|
||||
* deps: raw-body@2.3.3
|
||||
- deps: http-errors@1.6.3
|
||||
- deps: iconv-lite@0.4.23
|
||||
* deps: type-is@~1.6.16
|
||||
- deps: mime-types@~2.1.18
|
||||
|
||||
1.18.2 / 2017-09-22
|
||||
===================
|
||||
|
||||
* deps: debug@2.6.9
|
||||
* perf: remove argument reassignment
|
||||
|
||||
1.18.1 / 2017-09-12
|
||||
===================
|
||||
|
||||
* deps: content-type@~1.0.4
|
||||
- perf: remove argument reassignment
|
||||
- perf: skip parameter parsing when no parameters
|
||||
* deps: iconv-lite@0.4.19
|
||||
- Fix ISO-8859-1 regression
|
||||
- Update Windows-1255
|
||||
* deps: qs@6.5.1
|
||||
- Fix parsing & compacting very deep objects
|
||||
* deps: raw-body@2.3.2
|
||||
- deps: iconv-lite@0.4.19
|
||||
|
||||
1.18.0 / 2017-09-08
|
||||
===================
|
||||
|
||||
* Fix JSON strict violation error to match native parse error
|
||||
* Include the `body` property on verify errors
|
||||
* Include the `type` property on all generated errors
|
||||
* Use `http-errors` to set status code on errors
|
||||
* deps: bytes@3.0.0
|
||||
* deps: debug@2.6.8
|
||||
* deps: depd@~1.1.1
|
||||
- Remove unnecessary `Buffer` loading
|
||||
* deps: http-errors@~1.6.2
|
||||
- deps: depd@1.1.1
|
||||
* deps: iconv-lite@0.4.18
|
||||
- Add support for React Native
|
||||
- Add a warning if not loaded as utf-8
|
||||
- Fix CESU-8 decoding in Node.js 8
|
||||
- Improve speed of ISO-8859-1 encoding
|
||||
* deps: qs@6.5.0
|
||||
* deps: raw-body@2.3.1
|
||||
- Use `http-errors` for standard emitted errors
|
||||
- deps: bytes@3.0.0
|
||||
- deps: iconv-lite@0.4.18
|
||||
- perf: skip buffer decoding on overage chunk
|
||||
* perf: prevent internal `throw` when missing charset
|
||||
|
||||
1.17.2 / 2017-05-17
|
||||
===================
|
||||
|
||||
* deps: debug@2.6.7
|
||||
- Fix `DEBUG_MAX_ARRAY_LENGTH`
|
||||
- deps: ms@2.0.0
|
||||
* deps: type-is@~1.6.15
|
||||
- deps: mime-types@~2.1.15
|
||||
|
||||
1.17.1 / 2017-03-06
|
||||
===================
|
||||
|
||||
* deps: qs@6.4.0
|
||||
- Fix regression parsing keys starting with `[`
|
||||
|
||||
1.17.0 / 2017-03-01
|
||||
===================
|
||||
|
||||
* deps: http-errors@~1.6.1
|
||||
- Make `message` property enumerable for `HttpError`s
|
||||
- deps: setprototypeof@1.0.3
|
||||
* deps: qs@6.3.1
|
||||
- Fix compacting nested arrays
|
||||
|
||||
1.16.1 / 2017-02-10
|
||||
===================
|
||||
|
||||
* deps: debug@2.6.1
|
||||
- Fix deprecation messages in WebStorm and other editors
|
||||
- Undeprecate `DEBUG_FD` set to `1` or `2`
|
||||
|
||||
1.16.0 / 2017-01-17
|
||||
===================
|
||||
|
||||
* deps: debug@2.6.0
|
||||
- Allow colors in workers
|
||||
- Deprecated `DEBUG_FD` environment variable
|
||||
- Fix error when running under React Native
|
||||
- Use same color for same namespace
|
||||
- deps: ms@0.7.2
|
||||
* deps: http-errors@~1.5.1
|
||||
- deps: inherits@2.0.3
|
||||
- deps: setprototypeof@1.0.2
|
||||
- deps: statuses@'>= 1.3.1 < 2'
|
||||
* deps: iconv-lite@0.4.15
|
||||
- Added encoding MS-31J
|
||||
- Added encoding MS-932
|
||||
- Added encoding MS-936
|
||||
- Added encoding MS-949
|
||||
- Added encoding MS-950
|
||||
- Fix GBK/GB18030 handling of Euro character
|
||||
* deps: qs@6.2.1
|
||||
- Fix array parsing from skipping empty values
|
||||
* deps: raw-body@~2.2.0
|
||||
- deps: iconv-lite@0.4.15
|
||||
* deps: type-is@~1.6.14
|
||||
- deps: mime-types@~2.1.13
|
||||
|
||||
1.15.2 / 2016-06-19
|
||||
===================
|
||||
|
||||
* deps: bytes@2.4.0
|
||||
* deps: content-type@~1.0.2
|
||||
- perf: enable strict mode
|
||||
* deps: http-errors@~1.5.0
|
||||
- Use `setprototypeof` module to replace `__proto__` setting
|
||||
- deps: statuses@'>= 1.3.0 < 2'
|
||||
- perf: enable strict mode
|
||||
* deps: qs@6.2.0
|
||||
* deps: raw-body@~2.1.7
|
||||
- deps: bytes@2.4.0
|
||||
- perf: remove double-cleanup on happy path
|
||||
* deps: type-is@~1.6.13
|
||||
- deps: mime-types@~2.1.11
|
||||
|
||||
1.15.1 / 2016-05-05
|
||||
===================
|
||||
|
||||
* deps: bytes@2.3.0
|
||||
- Drop partial bytes on all parsed units
|
||||
- Fix parsing byte string that looks like hex
|
||||
* deps: raw-body@~2.1.6
|
||||
- deps: bytes@2.3.0
|
||||
* deps: type-is@~1.6.12
|
||||
- deps: mime-types@~2.1.10
|
||||
|
||||
1.15.0 / 2016-02-10
|
||||
===================
|
||||
|
||||
* deps: http-errors@~1.4.0
|
||||
- Add `HttpError` export, for `err instanceof createError.HttpError`
|
||||
- deps: inherits@2.0.1
|
||||
- deps: statuses@'>= 1.2.1 < 2'
|
||||
* deps: qs@6.1.0
|
||||
* deps: type-is@~1.6.11
|
||||
- deps: mime-types@~2.1.9
|
||||
|
||||
1.14.2 / 2015-12-16
|
||||
===================
|
||||
|
||||
* deps: bytes@2.2.0
|
||||
* deps: iconv-lite@0.4.13
|
||||
* deps: qs@5.2.0
|
||||
* deps: raw-body@~2.1.5
|
||||
- deps: bytes@2.2.0
|
||||
- deps: iconv-lite@0.4.13
|
||||
* deps: type-is@~1.6.10
|
||||
- deps: mime-types@~2.1.8
|
||||
|
||||
1.14.1 / 2015-09-27
|
||||
===================
|
||||
|
||||
* Fix issue where invalid charset results in 400 when `verify` used
|
||||
* deps: iconv-lite@0.4.12
|
||||
- Fix CESU-8 decoding in Node.js 4.x
|
||||
* deps: raw-body@~2.1.4
|
||||
- Fix masking critical errors from `iconv-lite`
|
||||
- deps: iconv-lite@0.4.12
|
||||
* deps: type-is@~1.6.9
|
||||
- deps: mime-types@~2.1.7
|
||||
|
||||
1.14.0 / 2015-09-16
|
||||
===================
|
||||
|
||||
* Fix JSON strict parse error to match syntax errors
|
||||
* Provide static `require` analysis in `urlencoded` parser
|
||||
* deps: depd@~1.1.0
|
||||
- Support web browser loading
|
||||
* deps: qs@5.1.0
|
||||
* deps: raw-body@~2.1.3
|
||||
- Fix sync callback when attaching data listener causes sync read
|
||||
* deps: type-is@~1.6.8
|
||||
- Fix type error when given invalid type to match against
|
||||
- deps: mime-types@~2.1.6
|
||||
|
||||
1.13.3 / 2015-07-31
|
||||
===================
|
||||
|
||||
* deps: type-is@~1.6.6
|
||||
- deps: mime-types@~2.1.4
|
||||
|
||||
1.13.2 / 2015-07-05
|
||||
===================
|
||||
|
||||
* deps: iconv-lite@0.4.11
|
||||
* deps: qs@4.0.0
|
||||
- Fix dropping parameters like `hasOwnProperty`
|
||||
- Fix user-visible incompatibilities from 3.1.0
|
||||
- Fix various parsing edge cases
|
||||
* deps: raw-body@~2.1.2
|
||||
- Fix error stack traces to skip `makeError`
|
||||
- deps: iconv-lite@0.4.11
|
||||
* deps: type-is@~1.6.4
|
||||
- deps: mime-types@~2.1.2
|
||||
- perf: enable strict mode
|
||||
- perf: remove argument reassignment
|
||||
|
||||
1.13.1 / 2015-06-16
|
||||
===================
|
||||
|
||||
* deps: qs@2.4.2
|
||||
- Downgraded from 3.1.0 because of user-visible incompatibilities
|
||||
|
||||
1.13.0 / 2015-06-14
|
||||
===================
|
||||
|
||||
* Add `statusCode` property on `Error`s, in addition to `status`
|
||||
* Change `type` default to `application/json` for JSON parser
|
||||
* Change `type` default to `application/x-www-form-urlencoded` for urlencoded parser
|
||||
* Provide static `require` analysis
|
||||
* Use the `http-errors` module to generate errors
|
||||
* deps: bytes@2.1.0
|
||||
- Slight optimizations
|
||||
* deps: iconv-lite@0.4.10
|
||||
- The encoding UTF-16 without BOM now defaults to UTF-16LE when detection fails
|
||||
- Leading BOM is now removed when decoding
|
||||
* deps: on-finished@~2.3.0
|
||||
- Add defined behavior for HTTP `CONNECT` requests
|
||||
- Add defined behavior for HTTP `Upgrade` requests
|
||||
- deps: ee-first@1.1.1
|
||||
* deps: qs@3.1.0
|
||||
- Fix dropping parameters like `hasOwnProperty`
|
||||
- Fix various parsing edge cases
|
||||
- Parsed object now has `null` prototype
|
||||
* deps: raw-body@~2.1.1
|
||||
- Use `unpipe` module for unpiping requests
|
||||
- deps: iconv-lite@0.4.10
|
||||
* deps: type-is@~1.6.3
|
||||
- deps: mime-types@~2.1.1
|
||||
- perf: reduce try block size
|
||||
- perf: remove bitwise operations
|
||||
* perf: enable strict mode
|
||||
* perf: remove argument reassignment
|
||||
* perf: remove delete call
|
||||
|
||||
1.12.4 / 2015-05-10
|
||||
===================
|
||||
|
||||
* deps: debug@~2.2.0
|
||||
* deps: qs@2.4.2
|
||||
- Fix allowing parameters like `constructor`
|
||||
* deps: on-finished@~2.2.1
|
||||
* deps: raw-body@~2.0.1
|
||||
- Fix a false-positive when unpiping in Node.js 0.8
|
||||
- deps: bytes@2.0.1
|
||||
* deps: type-is@~1.6.2
|
||||
- deps: mime-types@~2.0.11
|
||||
|
||||
1.12.3 / 2015-04-15
|
||||
===================
|
||||
|
||||
* Slight efficiency improvement when not debugging
|
||||
* deps: depd@~1.0.1
|
||||
* deps: iconv-lite@0.4.8
|
||||
- Add encoding alias UNICODE-1-1-UTF-7
|
||||
* deps: raw-body@1.3.4
|
||||
- Fix hanging callback if request aborts during read
|
||||
- deps: iconv-lite@0.4.8
|
||||
|
||||
1.12.2 / 2015-03-16
|
||||
===================
|
||||
|
||||
* deps: qs@2.4.1
|
||||
- Fix error when parameter `hasOwnProperty` is present
|
||||
|
||||
1.12.1 / 2015-03-15
|
||||
===================
|
||||
|
||||
* deps: debug@~2.1.3
|
||||
- Fix high intensity foreground color for bold
|
||||
- deps: ms@0.7.0
|
||||
* deps: type-is@~1.6.1
|
||||
- deps: mime-types@~2.0.10
|
||||
|
||||
1.12.0 / 2015-02-13
|
||||
===================
|
||||
|
||||
* add `debug` messages
|
||||
* accept a function for the `type` option
|
||||
* use `content-type` to parse `Content-Type` headers
|
||||
* deps: iconv-lite@0.4.7
|
||||
- Gracefully support enumerables on `Object.prototype`
|
||||
* deps: raw-body@1.3.3
|
||||
- deps: iconv-lite@0.4.7
|
||||
* deps: type-is@~1.6.0
|
||||
- fix argument reassignment
|
||||
- fix false-positives in `hasBody` `Transfer-Encoding` check
|
||||
- support wildcard for both type and subtype (`*/*`)
|
||||
- deps: mime-types@~2.0.9
|
||||
|
||||
1.11.0 / 2015-01-30
|
||||
===================
|
||||
|
||||
* make internal `extended: true` depth limit infinity
|
||||
* deps: type-is@~1.5.6
|
||||
- deps: mime-types@~2.0.8
|
||||
|
||||
1.10.2 / 2015-01-20
|
||||
===================
|
||||
|
||||
* deps: iconv-lite@0.4.6
|
||||
- Fix rare aliases of single-byte encodings
|
||||
* deps: raw-body@1.3.2
|
||||
- deps: iconv-lite@0.4.6
|
||||
|
||||
1.10.1 / 2015-01-01
|
||||
===================
|
||||
|
||||
* deps: on-finished@~2.2.0
|
||||
* deps: type-is@~1.5.5
|
||||
- deps: mime-types@~2.0.7
|
||||
|
||||
1.10.0 / 2014-12-02
|
||||
===================
|
||||
|
||||
* make internal `extended: true` array limit dynamic
|
||||
|
||||
1.9.3 / 2014-11-21
|
||||
==================
|
||||
|
||||
* deps: iconv-lite@0.4.5
|
||||
- Fix Windows-31J and X-SJIS encoding support
|
||||
* deps: qs@2.3.3
|
||||
- Fix `arrayLimit` behavior
|
||||
* deps: raw-body@1.3.1
|
||||
- deps: iconv-lite@0.4.5
|
||||
* deps: type-is@~1.5.3
|
||||
- deps: mime-types@~2.0.3
|
||||
|
||||
1.9.2 / 2014-10-27
|
||||
==================
|
||||
|
||||
* deps: qs@2.3.2
|
||||
- Fix parsing of mixed objects and values
|
||||
|
||||
1.9.1 / 2014-10-22
|
||||
==================
|
||||
|
||||
* deps: on-finished@~2.1.1
|
||||
- Fix handling of pipelined requests
|
||||
* deps: qs@2.3.0
|
||||
- Fix parsing of mixed implicit and explicit arrays
|
||||
* deps: type-is@~1.5.2
|
||||
- deps: mime-types@~2.0.2
|
||||
|
||||
1.9.0 / 2014-09-24
|
||||
==================
|
||||
|
||||
* include the charset in "unsupported charset" error message
|
||||
* include the encoding in "unsupported content encoding" error message
|
||||
* deps: depd@~1.0.0
|
||||
|
||||
1.8.4 / 2014-09-23
|
||||
==================
|
||||
|
||||
* fix content encoding to be case-insensitive
|
||||
|
||||
1.8.3 / 2014-09-19
|
||||
==================
|
||||
|
||||
* deps: qs@2.2.4
|
||||
- Fix issue with object keys starting with numbers truncated
|
||||
|
||||
1.8.2 / 2014-09-15
|
||||
==================
|
||||
|
||||
* deps: depd@0.4.5
|
||||
|
||||
1.8.1 / 2014-09-07
|
||||
==================
|
||||
|
||||
* deps: media-typer@0.3.0
|
||||
* deps: type-is@~1.5.1
|
||||
|
||||
1.8.0 / 2014-09-05
|
||||
==================
|
||||
|
||||
* make empty-body-handling consistent between chunked requests
|
||||
- empty `json` produces `{}`
|
||||
- empty `raw` produces `new Buffer(0)`
|
||||
- empty `text` produces `''`
|
||||
- empty `urlencoded` produces `{}`
|
||||
* deps: qs@2.2.3
|
||||
- Fix issue where first empty value in array is discarded
|
||||
* deps: type-is@~1.5.0
|
||||
- fix `hasbody` to be true for `content-length: 0`
|
||||
|
||||
1.7.0 / 2014-09-01
|
||||
==================
|
||||
|
||||
* add `parameterLimit` option to `urlencoded` parser
|
||||
* change `urlencoded` extended array limit to 100
|
||||
* respond with 413 when over `parameterLimit` in `urlencoded`
|
||||
|
||||
1.6.7 / 2014-08-29
|
||||
==================
|
||||
|
||||
* deps: qs@2.2.2
|
||||
- Remove unnecessary cloning
|
||||
|
||||
1.6.6 / 2014-08-27
|
||||
==================
|
||||
|
||||
* deps: qs@2.2.0
|
||||
- Array parsing fix
|
||||
- Performance improvements
|
||||
|
||||
1.6.5 / 2014-08-16
|
||||
==================
|
||||
|
||||
* deps: on-finished@2.1.0
|
||||
|
||||
1.6.4 / 2014-08-14
|
||||
==================
|
||||
|
||||
* deps: qs@1.2.2
|
||||
|
||||
1.6.3 / 2014-08-10
|
||||
==================
|
||||
|
||||
* deps: qs@1.2.1
|
||||
|
||||
1.6.2 / 2014-08-07
|
||||
==================
|
||||
|
||||
* deps: qs@1.2.0
|
||||
- Fix parsing array of objects
|
||||
|
||||
1.6.1 / 2014-08-06
|
||||
==================
|
||||
|
||||
* deps: qs@1.1.0
|
||||
- Accept urlencoded square brackets
|
||||
- Accept empty values in implicit array notation
|
||||
|
||||
1.6.0 / 2014-08-05
|
||||
==================
|
||||
|
||||
* deps: qs@1.0.2
|
||||
- Complete rewrite
|
||||
- Limits array length to 20
|
||||
- Limits object depth to 5
|
||||
- Limits parameters to 1,000
|
||||
|
||||
1.5.2 / 2014-07-27
|
||||
==================
|
||||
|
||||
* deps: depd@0.4.4
|
||||
- Work-around v8 generating empty stack traces
|
||||
|
||||
1.5.1 / 2014-07-26
|
||||
==================
|
||||
|
||||
* deps: depd@0.4.3
|
||||
- Fix exception when global `Error.stackTraceLimit` is too low
|
||||
|
||||
1.5.0 / 2014-07-20
|
||||
==================
|
||||
|
||||
* deps: depd@0.4.2
|
||||
- Add `TRACE_DEPRECATION` environment variable
|
||||
- Remove non-standard grey color from color output
|
||||
- Support `--no-deprecation` argument
|
||||
- Support `--trace-deprecation` argument
|
||||
* deps: iconv-lite@0.4.4
|
||||
- Added encoding UTF-7
|
||||
* deps: raw-body@1.3.0
|
||||
- deps: iconv-lite@0.4.4
|
||||
- Added encoding UTF-7
|
||||
- Fix `Cannot switch to old mode now` error on Node.js 0.10+
|
||||
* deps: type-is@~1.3.2
|
||||
|
||||
1.4.3 / 2014-06-19
|
||||
==================
|
||||
|
||||
* deps: type-is@1.3.1
|
||||
- fix global variable leak
|
||||
|
||||
1.4.2 / 2014-06-19
|
||||
==================
|
||||
|
||||
* deps: type-is@1.3.0
|
||||
- improve type parsing
|
||||
|
||||
1.4.1 / 2014-06-19
|
||||
==================
|
||||
|
||||
* fix urlencoded extended deprecation message
|
||||
|
||||
1.4.0 / 2014-06-19
|
||||
==================
|
||||
|
||||
* add `text` parser
|
||||
* add `raw` parser
|
||||
* check accepted charset in content-type (accepts utf-8)
|
||||
* check accepted encoding in content-encoding (accepts identity)
|
||||
* deprecate `bodyParser()` middleware; use `.json()` and `.urlencoded()` as needed
|
||||
* deprecate `urlencoded()` without provided `extended` option
|
||||
* lazy-load urlencoded parsers
|
||||
* parsers split into files for reduced mem usage
|
||||
* support gzip and deflate bodies
|
||||
- set `inflate: false` to turn off
|
||||
* deps: raw-body@1.2.2
|
||||
- Support all encodings from `iconv-lite`
|
||||
|
||||
1.3.1 / 2014-06-11
|
||||
==================
|
||||
|
||||
* deps: type-is@1.2.1
|
||||
- Switch dependency from mime to mime-types@1.0.0
|
||||
|
||||
1.3.0 / 2014-05-31
|
||||
==================
|
||||
|
||||
* add `extended` option to urlencoded parser
|
||||
|
||||
1.2.2 / 2014-05-27
|
||||
==================
|
||||
|
||||
* deps: raw-body@1.1.6
|
||||
- assert stream encoding on node.js 0.8
|
||||
- assert stream encoding on node.js < 0.10.6
|
||||
- deps: bytes@1
|
||||
|
||||
1.2.1 / 2014-05-26
|
||||
==================
|
||||
|
||||
* invoke `next(err)` after request fully read
|
||||
- prevents hung responses and socket hang ups
|
||||
|
||||
1.2.0 / 2014-05-11
|
||||
==================
|
||||
|
||||
* add `verify` option
|
||||
* deps: type-is@1.2.0
|
||||
- support suffix matching
|
||||
|
||||
1.1.2 / 2014-05-11
|
||||
==================
|
||||
|
||||
* improve json parser speed
|
||||
|
||||
1.1.1 / 2014-05-11
|
||||
==================
|
||||
|
||||
* fix repeated limit parsing with every request
|
||||
|
||||
1.1.0 / 2014-05-10
|
||||
==================
|
||||
|
||||
* add `type` option
|
||||
* deps: pin for safety and consistency
|
||||
|
||||
1.0.2 / 2014-04-14
|
||||
==================
|
||||
|
||||
* use `type-is` module
|
||||
|
||||
1.0.1 / 2014-03-20
|
||||
==================
|
||||
|
||||
* lower default limits to 100kb
|
||||
-23
@@ -1,23 +0,0 @@
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
|
||||
Copyright (c) 2014-2015 Douglas Christopher Wilson <doug@somethingdoug.com>
|
||||
|
||||
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.
|
||||
-491
@@ -1,491 +0,0 @@
|
||||
# body-parser
|
||||
|
||||
[![NPM Version][npm-version-image]][npm-url]
|
||||
[![NPM Downloads][npm-downloads-image]][npm-url]
|
||||
[![Build Status][ci-image]][ci-url]
|
||||
[![Test Coverage][coveralls-image]][coveralls-url]
|
||||
[![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
|
||||
|
||||
Node.js body parsing middleware.
|
||||
|
||||
Parse incoming request bodies in a middleware before your handlers, available
|
||||
under the `req.body` property.
|
||||
|
||||
**Note** As `req.body`'s shape is based on user-controlled input, all
|
||||
properties and values in this object are untrusted and should be validated
|
||||
before trusting. For example, `req.body.foo.toString()` may fail in multiple
|
||||
ways, for example the `foo` property may not be there or may not be a string,
|
||||
and `toString` may not be a function and instead a string or other user input.
|
||||
|
||||
[Learn about the anatomy of an HTTP transaction in Node.js](https://nodejs.org/en/docs/guides/anatomy-of-an-http-transaction/).
|
||||
|
||||
_This does not handle multipart bodies_, due to their complex and typically
|
||||
large nature. For multipart bodies, you may be interested in the following
|
||||
modules:
|
||||
|
||||
* [busboy](https://www.npmjs.org/package/busboy#readme) and
|
||||
[connect-busboy](https://www.npmjs.org/package/connect-busboy#readme)
|
||||
* [multiparty](https://www.npmjs.org/package/multiparty#readme) and
|
||||
[connect-multiparty](https://www.npmjs.org/package/connect-multiparty#readme)
|
||||
* [formidable](https://www.npmjs.org/package/formidable#readme)
|
||||
* [multer](https://www.npmjs.org/package/multer#readme)
|
||||
|
||||
This module provides the following parsers:
|
||||
|
||||
* [JSON body parser](#bodyparserjsonoptions)
|
||||
* [Raw body parser](#bodyparserrawoptions)
|
||||
* [Text body parser](#bodyparsertextoptions)
|
||||
* [URL-encoded form body parser](#bodyparserurlencodedoptions)
|
||||
|
||||
Other body parsers you might be interested in:
|
||||
|
||||
- [body](https://www.npmjs.org/package/body#readme)
|
||||
- [co-body](https://www.npmjs.org/package/co-body#readme)
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
$ npm install body-parser
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
```js
|
||||
const bodyParser = require('body-parser')
|
||||
```
|
||||
|
||||
The `bodyParser` object exposes various factories to create middlewares. All
|
||||
middlewares will populate the `req.body` property with the parsed body when
|
||||
the `Content-Type` request header matches the `type` option.
|
||||
|
||||
The various errors returned by this module are described in the
|
||||
[errors section](#errors).
|
||||
|
||||
### bodyParser.json([options])
|
||||
|
||||
Returns middleware that only parses `json` and only looks at requests where
|
||||
the `Content-Type` header matches the `type` option. This parser accepts any
|
||||
Unicode encoding of the body and supports automatic inflation of `gzip`,
|
||||
`br` (brotli) and `deflate` encodings.
|
||||
|
||||
A new `body` object containing the parsed data is populated on the `request`
|
||||
object after the middleware (i.e. `req.body`).
|
||||
|
||||
#### Options
|
||||
|
||||
The `json` function takes an optional `options` object that may contain any of
|
||||
the following keys:
|
||||
|
||||
##### inflate
|
||||
|
||||
When set to `true`, then deflated (compressed) bodies will be inflated; when
|
||||
`false`, deflated bodies are rejected. Defaults to `true`.
|
||||
|
||||
##### limit
|
||||
|
||||
Controls the maximum request body size. If this is a number, then the value
|
||||
specifies the number of bytes; if it is a string, the value is passed to the
|
||||
[bytes](https://www.npmjs.com/package/bytes) library for parsing. Defaults
|
||||
to `'100kb'`.
|
||||
|
||||
##### reviver
|
||||
|
||||
The `reviver` option is passed directly to `JSON.parse` as the second
|
||||
argument. You can find more information on this argument
|
||||
[in the MDN documentation about JSON.parse](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Example.3A_Using_the_reviver_parameter).
|
||||
|
||||
##### strict
|
||||
|
||||
When set to `true`, will only accept arrays and objects; when `false` will
|
||||
accept anything `JSON.parse` accepts. Defaults to `true`.
|
||||
|
||||
##### type
|
||||
|
||||
The `type` option is used to determine what media type the middleware will
|
||||
parse. This option can be a string, array of strings, or a function. If not a
|
||||
function, `type` option is passed directly to the
|
||||
[type-is](https://www.npmjs.org/package/type-is#readme) library and this can
|
||||
be an extension name (like `json`), a mime type (like `application/json`), or
|
||||
a mime type with a wildcard (like `*/*` or `*/json`). If a function, the `type`
|
||||
option is called as `fn(req)` and the request is parsed if it returns a truthy
|
||||
value. Defaults to `application/json`.
|
||||
|
||||
##### verify
|
||||
|
||||
The `verify` option, if supplied, is called as `verify(req, res, buf, encoding)`,
|
||||
where `buf` is a `Buffer` of the raw request body and `encoding` is the
|
||||
encoding of the request. The parsing can be aborted by throwing an error.
|
||||
|
||||
### bodyParser.raw([options])
|
||||
|
||||
Returns middleware that parses all bodies as a `Buffer` and only looks at
|
||||
requests where the `Content-Type` header matches the `type` option. This
|
||||
parser supports automatic inflation of `gzip`, `br` (brotli) and `deflate`
|
||||
encodings.
|
||||
|
||||
A new `body` object containing the parsed data is populated on the `request`
|
||||
object after the middleware (i.e. `req.body`). This will be a `Buffer` object
|
||||
of the body.
|
||||
|
||||
#### Options
|
||||
|
||||
The `raw` function takes an optional `options` object that may contain any of
|
||||
the following keys:
|
||||
|
||||
##### inflate
|
||||
|
||||
When set to `true`, then deflated (compressed) bodies will be inflated; when
|
||||
`false`, deflated bodies are rejected. Defaults to `true`.
|
||||
|
||||
##### limit
|
||||
|
||||
Controls the maximum request body size. If this is a number, then the value
|
||||
specifies the number of bytes; if it is a string, the value is passed to the
|
||||
[bytes](https://www.npmjs.com/package/bytes) library for parsing. Defaults
|
||||
to `'100kb'`.
|
||||
|
||||
##### type
|
||||
|
||||
The `type` option is used to determine what media type the middleware will
|
||||
parse. This option can be a string, array of strings, or a function.
|
||||
If not a function, `type` option is passed directly to the
|
||||
[type-is](https://www.npmjs.org/package/type-is#readme) library and this
|
||||
can be an extension name (like `bin`), a mime type (like
|
||||
`application/octet-stream`), or a mime type with a wildcard (like `*/*` or
|
||||
`application/*`). If a function, the `type` option is called as `fn(req)`
|
||||
and the request is parsed if it returns a truthy value. Defaults to
|
||||
`application/octet-stream`.
|
||||
|
||||
##### verify
|
||||
|
||||
The `verify` option, if supplied, is called as `verify(req, res, buf, encoding)`,
|
||||
where `buf` is a `Buffer` of the raw request body and `encoding` is the
|
||||
encoding of the request. The parsing can be aborted by throwing an error.
|
||||
|
||||
### bodyParser.text([options])
|
||||
|
||||
Returns middleware that parses all bodies as a string and only looks at
|
||||
requests where the `Content-Type` header matches the `type` option. This
|
||||
parser supports automatic inflation of `gzip`, `br` (brotli) and `deflate`
|
||||
encodings.
|
||||
|
||||
A new `body` string containing the parsed data is populated on the `request`
|
||||
object after the middleware (i.e. `req.body`). This will be a string of the
|
||||
body.
|
||||
|
||||
#### Options
|
||||
|
||||
The `text` function takes an optional `options` object that may contain any of
|
||||
the following keys:
|
||||
|
||||
##### defaultCharset
|
||||
|
||||
Specify the default character set for the text content if the charset is not
|
||||
specified in the `Content-Type` header of the request. Defaults to `utf-8`.
|
||||
|
||||
##### inflate
|
||||
|
||||
When set to `true`, then deflated (compressed) bodies will be inflated; when
|
||||
`false`, deflated bodies are rejected. Defaults to `true`.
|
||||
|
||||
##### limit
|
||||
|
||||
Controls the maximum request body size. If this is a number, then the value
|
||||
specifies the number of bytes; if it is a string, the value is passed to the
|
||||
[bytes](https://www.npmjs.com/package/bytes) library for parsing. Defaults
|
||||
to `'100kb'`.
|
||||
|
||||
##### type
|
||||
|
||||
The `type` option is used to determine what media type the middleware will
|
||||
parse. This option can be a string, array of strings, or a function. If not
|
||||
a function, `type` option is passed directly to the
|
||||
[type-is](https://www.npmjs.org/package/type-is#readme) library and this can
|
||||
be an extension name (like `txt`), a mime type (like `text/plain`), or a mime
|
||||
type with a wildcard (like `*/*` or `text/*`). If a function, the `type`
|
||||
option is called as `fn(req)` and the request is parsed if it returns a
|
||||
truthy value. Defaults to `text/plain`.
|
||||
|
||||
##### verify
|
||||
|
||||
The `verify` option, if supplied, is called as `verify(req, res, buf, encoding)`,
|
||||
where `buf` is a `Buffer` of the raw request body and `encoding` is the
|
||||
encoding of the request. The parsing can be aborted by throwing an error.
|
||||
|
||||
### bodyParser.urlencoded([options])
|
||||
|
||||
Returns middleware that only parses `urlencoded` bodies and only looks at
|
||||
requests where the `Content-Type` header matches the `type` option. This
|
||||
parser accepts only UTF-8 encoding of the body and supports automatic
|
||||
inflation of `gzip`, `br` (brotli) and `deflate` encodings.
|
||||
|
||||
A new `body` object containing the parsed data is populated on the `request`
|
||||
object after the middleware (i.e. `req.body`). This object will contain
|
||||
key-value pairs, where the value can be a string or array (when `extended` is
|
||||
`false`), or any type (when `extended` is `true`).
|
||||
|
||||
#### Options
|
||||
|
||||
The `urlencoded` function takes an optional `options` object that may contain
|
||||
any of the following keys:
|
||||
|
||||
##### extended
|
||||
|
||||
The "extended" syntax allows for rich objects and arrays to be encoded into the
|
||||
URL-encoded format, allowing for a JSON-like experience with URL-encoded. For
|
||||
more information, please [see the qs
|
||||
library](https://www.npmjs.org/package/qs#readme).
|
||||
|
||||
Defaults to `false`.
|
||||
|
||||
##### inflate
|
||||
|
||||
When set to `true`, then deflated (compressed) bodies will be inflated; when
|
||||
`false`, deflated bodies are rejected. Defaults to `true`.
|
||||
|
||||
##### limit
|
||||
|
||||
Controls the maximum request body size. If this is a number, then the value
|
||||
specifies the number of bytes; if it is a string, the value is passed to the
|
||||
[bytes](https://www.npmjs.com/package/bytes) library for parsing. Defaults
|
||||
to `'100kb'`.
|
||||
|
||||
##### parameterLimit
|
||||
|
||||
The `parameterLimit` option controls the maximum number of parameters that
|
||||
are allowed in the URL-encoded data. If a request contains more parameters
|
||||
than this value, a 413 will be returned to the client. Defaults to `1000`.
|
||||
|
||||
##### type
|
||||
|
||||
The `type` option is used to determine what media type the middleware will
|
||||
parse. This option can be a string, array of strings, or a function. If not
|
||||
a function, `type` option is passed directly to the
|
||||
[type-is](https://www.npmjs.org/package/type-is#readme) library and this can
|
||||
be an extension name (like `urlencoded`), a mime type (like
|
||||
`application/x-www-form-urlencoded`), or a mime type with a wildcard (like
|
||||
`*/x-www-form-urlencoded`). If a function, the `type` option is called as
|
||||
`fn(req)` and the request is parsed if it returns a truthy value. Defaults
|
||||
to `application/x-www-form-urlencoded`.
|
||||
|
||||
##### verify
|
||||
|
||||
The `verify` option, if supplied, is called as `verify(req, res, buf, encoding)`,
|
||||
where `buf` is a `Buffer` of the raw request body and `encoding` is the
|
||||
encoding of the request. The parsing can be aborted by throwing an error.
|
||||
|
||||
##### defaultCharset
|
||||
|
||||
The default charset to parse as, if not specified in content-type. Must be
|
||||
either `utf-8` or `iso-8859-1`. Defaults to `utf-8`.
|
||||
|
||||
##### charsetSentinel
|
||||
|
||||
Whether to let the value of the `utf8` parameter take precedence as the charset
|
||||
selector. It requires the form to contain a parameter named `utf8` with a value
|
||||
of `✓`. Defaults to `false`.
|
||||
|
||||
##### interpretNumericEntities
|
||||
|
||||
Whether to decode numeric entities such as `☺` when parsing an iso-8859-1
|
||||
form. Defaults to `false`.
|
||||
|
||||
|
||||
#### depth
|
||||
|
||||
The `depth` option is used to configure the maximum depth of the `qs` library when `extended` is `true`. This allows you to limit the amount of keys that are parsed and can be useful to prevent certain types of abuse. Defaults to `32`. It is recommended to keep this value as low as possible.
|
||||
|
||||
## Errors
|
||||
|
||||
The middlewares provided by this module create errors using the
|
||||
[`http-errors` module](https://www.npmjs.com/package/http-errors). The errors
|
||||
will typically have a `status`/`statusCode` property that contains the suggested
|
||||
HTTP response code, an `expose` property to determine if the `message` property
|
||||
should be displayed to the client, a `type` property to determine the type of
|
||||
error without matching against the `message`, and a `body` property containing
|
||||
the read body, if available.
|
||||
|
||||
The following are the common errors created, though any error can come through
|
||||
for various reasons.
|
||||
|
||||
### content encoding unsupported
|
||||
|
||||
This error will occur when the request had a `Content-Encoding` header that
|
||||
contained an encoding but the "inflation" option was set to `false`. The
|
||||
`status` property is set to `415`, the `type` property is set to
|
||||
`'encoding.unsupported'`, and the `charset` property will be set to the
|
||||
encoding that is unsupported.
|
||||
|
||||
### entity parse failed
|
||||
|
||||
This error will occur when the request contained an entity that could not be
|
||||
parsed by the middleware. The `status` property is set to `400`, the `type`
|
||||
property is set to `'entity.parse.failed'`, and the `body` property is set to
|
||||
the entity value that failed parsing.
|
||||
|
||||
### entity verify failed
|
||||
|
||||
This error will occur when the request contained an entity that could not be
|
||||
failed verification by the defined `verify` option. The `status` property is
|
||||
set to `403`, the `type` property is set to `'entity.verify.failed'`, and the
|
||||
`body` property is set to the entity value that failed verification.
|
||||
|
||||
### request aborted
|
||||
|
||||
This error will occur when the request is aborted by the client before reading
|
||||
the body has finished. The `received` property will be set to the number of
|
||||
bytes received before the request was aborted and the `expected` property is
|
||||
set to the number of expected bytes. The `status` property is set to `400`
|
||||
and `type` property is set to `'request.aborted'`.
|
||||
|
||||
### request entity too large
|
||||
|
||||
This error will occur when the request body's size is larger than the "limit"
|
||||
option. The `limit` property will be set to the byte limit and the `length`
|
||||
property will be set to the request body's length. The `status` property is
|
||||
set to `413` and the `type` property is set to `'entity.too.large'`.
|
||||
|
||||
### request size did not match content length
|
||||
|
||||
This error will occur when the request's length did not match the length from
|
||||
the `Content-Length` header. This typically occurs when the request is malformed,
|
||||
typically when the `Content-Length` header was calculated based on characters
|
||||
instead of bytes. The `status` property is set to `400` and the `type` property
|
||||
is set to `'request.size.invalid'`.
|
||||
|
||||
### stream encoding should not be set
|
||||
|
||||
This error will occur when something called the `req.setEncoding` method prior
|
||||
to this middleware. This module operates directly on bytes only and you cannot
|
||||
call `req.setEncoding` when using this module. The `status` property is set to
|
||||
`500` and the `type` property is set to `'stream.encoding.set'`.
|
||||
|
||||
### stream is not readable
|
||||
|
||||
This error will occur when the request is no longer readable when this middleware
|
||||
attempts to read it. This typically means something other than a middleware from
|
||||
this module read the request body already and the middleware was also configured to
|
||||
read the same request. The `status` property is set to `500` and the `type`
|
||||
property is set to `'stream.not.readable'`.
|
||||
|
||||
### too many parameters
|
||||
|
||||
This error will occur when the content of the request exceeds the configured
|
||||
`parameterLimit` for the `urlencoded` parser. The `status` property is set to
|
||||
`413` and the `type` property is set to `'parameters.too.many'`.
|
||||
|
||||
### unsupported charset "BOGUS"
|
||||
|
||||
This error will occur when the request had a charset parameter in the
|
||||
`Content-Type` header, but the `iconv-lite` module does not support it OR the
|
||||
parser does not support it. The charset is contained in the message as well
|
||||
as in the `charset` property. The `status` property is set to `415`, the
|
||||
`type` property is set to `'charset.unsupported'`, and the `charset` property
|
||||
is set to the charset that is unsupported.
|
||||
|
||||
### unsupported content encoding "bogus"
|
||||
|
||||
This error will occur when the request had a `Content-Encoding` header that
|
||||
contained an unsupported encoding. The encoding is contained in the message
|
||||
as well as in the `encoding` property. The `status` property is set to `415`,
|
||||
the `type` property is set to `'encoding.unsupported'`, and the `encoding`
|
||||
property is set to the encoding that is unsupported.
|
||||
|
||||
### The input exceeded the depth
|
||||
|
||||
This error occurs when using `bodyParser.urlencoded` with the `extended` property set to `true` and the input exceeds the configured `depth` option. The `status` property is set to `400`. It is recommended to review the `depth` option and evaluate if it requires a higher value. When the `depth` option is set to `32` (default value), the error will not be thrown.
|
||||
|
||||
## Examples
|
||||
|
||||
### Express/Connect top-level generic
|
||||
|
||||
This example demonstrates adding a generic JSON and URL-encoded parser as a
|
||||
top-level middleware, which will parse the bodies of all incoming requests.
|
||||
This is the simplest setup.
|
||||
|
||||
```js
|
||||
const express = require('express')
|
||||
const bodyParser = require('body-parser')
|
||||
|
||||
const app = express()
|
||||
|
||||
// parse application/x-www-form-urlencoded
|
||||
app.use(bodyParser.urlencoded())
|
||||
|
||||
// parse application/json
|
||||
app.use(bodyParser.json())
|
||||
|
||||
app.use(function (req, res) {
|
||||
res.setHeader('Content-Type', 'text/plain')
|
||||
res.write('you posted:\n')
|
||||
res.end(String(JSON.stringify(req.body, null, 2)))
|
||||
})
|
||||
```
|
||||
|
||||
### Express route-specific
|
||||
|
||||
This example demonstrates adding body parsers specifically to the routes that
|
||||
need them. In general, this is the most recommended way to use body-parser with
|
||||
Express.
|
||||
|
||||
```js
|
||||
const express = require('express')
|
||||
const bodyParser = require('body-parser')
|
||||
|
||||
const app = express()
|
||||
|
||||
// create application/json parser
|
||||
const jsonParser = bodyParser.json()
|
||||
|
||||
// create application/x-www-form-urlencoded parser
|
||||
const urlencodedParser = bodyParser.urlencoded()
|
||||
|
||||
// POST /login gets urlencoded bodies
|
||||
app.post('/login', urlencodedParser, function (req, res) {
|
||||
if (!req.body || !req.body.username) res.sendStatus(400)
|
||||
res.send('welcome, ' + req.body.username)
|
||||
})
|
||||
|
||||
// POST /api/users gets JSON bodies
|
||||
app.post('/api/users', jsonParser, function (req, res) {
|
||||
if (!req.body) res.sendStatus(400)
|
||||
// create user in req.body
|
||||
})
|
||||
```
|
||||
|
||||
### Change accepted type for parsers
|
||||
|
||||
All the parsers accept a `type` option which allows you to change the
|
||||
`Content-Type` that the middleware will parse.
|
||||
|
||||
```js
|
||||
const express = require('express')
|
||||
const bodyParser = require('body-parser')
|
||||
|
||||
const app = express()
|
||||
|
||||
// parse various different custom JSON types as JSON
|
||||
app.use(bodyParser.json({ type: 'application/*+json' }))
|
||||
|
||||
// parse some custom thing into a Buffer
|
||||
app.use(bodyParser.raw({ type: 'application/vnd.custom-type' }))
|
||||
|
||||
// parse an HTML body into a string
|
||||
app.use(bodyParser.text({ type: 'text/html' }))
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
||||
[ci-image]: https://badgen.net/github/checks/expressjs/body-parser/master?label=ci
|
||||
[ci-url]: https://github.com/expressjs/body-parser/actions/workflows/ci.yml
|
||||
[coveralls-image]: https://badgen.net/coveralls/c/github/expressjs/body-parser/master
|
||||
[coveralls-url]: https://coveralls.io/r/expressjs/body-parser?branch=master
|
||||
[node-version-image]: https://badgen.net/npm/node/body-parser
|
||||
[node-version-url]: https://nodejs.org/en/download
|
||||
[npm-downloads-image]: https://badgen.net/npm/dm/body-parser
|
||||
[npm-url]: https://npmjs.org/package/body-parser
|
||||
[npm-version-image]: https://badgen.net/npm/v/body-parser
|
||||
[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/body-parser/badge
|
||||
[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/body-parser
|
||||
-80
@@ -1,80 +0,0 @@
|
||||
/*!
|
||||
* body-parser
|
||||
* Copyright(c) 2014-2015 Douglas Christopher Wilson
|
||||
* MIT Licensed
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
/**
|
||||
* @typedef Parsers
|
||||
* @type {function}
|
||||
* @property {function} json
|
||||
* @property {function} raw
|
||||
* @property {function} text
|
||||
* @property {function} urlencoded
|
||||
*/
|
||||
|
||||
/**
|
||||
* Module exports.
|
||||
* @type {Parsers}
|
||||
*/
|
||||
|
||||
exports = module.exports = bodyParser
|
||||
|
||||
/**
|
||||
* JSON parser.
|
||||
* @public
|
||||
*/
|
||||
|
||||
Object.defineProperty(exports, 'json', {
|
||||
configurable: true,
|
||||
enumerable: true,
|
||||
get: () => require('./lib/types/json')
|
||||
})
|
||||
|
||||
/**
|
||||
* Raw parser.
|
||||
* @public
|
||||
*/
|
||||
|
||||
Object.defineProperty(exports, 'raw', {
|
||||
configurable: true,
|
||||
enumerable: true,
|
||||
get: () => require('./lib/types/raw')
|
||||
})
|
||||
|
||||
/**
|
||||
* Text parser.
|
||||
* @public
|
||||
*/
|
||||
|
||||
Object.defineProperty(exports, 'text', {
|
||||
configurable: true,
|
||||
enumerable: true,
|
||||
get: () => require('./lib/types/text')
|
||||
})
|
||||
|
||||
/**
|
||||
* URL-encoded parser.
|
||||
* @public
|
||||
*/
|
||||
|
||||
Object.defineProperty(exports, 'urlencoded', {
|
||||
configurable: true,
|
||||
enumerable: true,
|
||||
get: () => require('./lib/types/urlencoded')
|
||||
})
|
||||
|
||||
/**
|
||||
* Create a middleware to parse json and urlencoded bodies.
|
||||
*
|
||||
* @param {object} [options]
|
||||
* @return {function}
|
||||
* @deprecated
|
||||
* @public
|
||||
*/
|
||||
|
||||
function bodyParser () {
|
||||
throw new Error('The bodyParser() generic has been split into individual middleware to use instead.')
|
||||
}
|
||||
-210
@@ -1,210 +0,0 @@
|
||||
/*!
|
||||
* body-parser
|
||||
* Copyright(c) 2014-2015 Douglas Christopher Wilson
|
||||
* MIT Licensed
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
/**
|
||||
* Module dependencies.
|
||||
* @private
|
||||
*/
|
||||
|
||||
var createError = require('http-errors')
|
||||
var getBody = require('raw-body')
|
||||
var iconv = require('iconv-lite')
|
||||
var onFinished = require('on-finished')
|
||||
var zlib = require('node:zlib')
|
||||
|
||||
/**
|
||||
* Module exports.
|
||||
*/
|
||||
|
||||
module.exports = read
|
||||
|
||||
/**
|
||||
* Read a request into a buffer and parse.
|
||||
*
|
||||
* @param {object} req
|
||||
* @param {object} res
|
||||
* @param {function} next
|
||||
* @param {function} parse
|
||||
* @param {function} debug
|
||||
* @param {object} options
|
||||
* @private
|
||||
*/
|
||||
|
||||
function read (req, res, next, parse, debug, options) {
|
||||
var length
|
||||
var opts = options
|
||||
var stream
|
||||
|
||||
// read options
|
||||
var encoding = opts.encoding !== null
|
||||
? opts.encoding
|
||||
: null
|
||||
var verify = opts.verify
|
||||
|
||||
try {
|
||||
// get the content stream
|
||||
stream = contentstream(req, debug, opts.inflate)
|
||||
length = stream.length
|
||||
stream.length = undefined
|
||||
} catch (err) {
|
||||
return next(err)
|
||||
}
|
||||
|
||||
// set raw-body options
|
||||
opts.length = length
|
||||
opts.encoding = verify
|
||||
? null
|
||||
: encoding
|
||||
|
||||
// assert charset is supported
|
||||
if (opts.encoding === null && encoding !== null && !iconv.encodingExists(encoding)) {
|
||||
return next(createError(415, 'unsupported charset "' + encoding.toUpperCase() + '"', {
|
||||
charset: encoding.toLowerCase(),
|
||||
type: 'charset.unsupported'
|
||||
}))
|
||||
}
|
||||
|
||||
// read body
|
||||
debug('read body')
|
||||
getBody(stream, opts, function (error, body) {
|
||||
if (error) {
|
||||
var _error
|
||||
|
||||
if (error.type === 'encoding.unsupported') {
|
||||
// echo back charset
|
||||
_error = createError(415, 'unsupported charset "' + encoding.toUpperCase() + '"', {
|
||||
charset: encoding.toLowerCase(),
|
||||
type: 'charset.unsupported'
|
||||
})
|
||||
} else {
|
||||
// set status code on error
|
||||
_error = createError(400, error)
|
||||
}
|
||||
|
||||
// unpipe from stream and destroy
|
||||
if (stream !== req) {
|
||||
req.unpipe()
|
||||
stream.destroy()
|
||||
}
|
||||
|
||||
// read off entire request
|
||||
dump(req, function onfinished () {
|
||||
next(createError(400, _error))
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
// verify
|
||||
if (verify) {
|
||||
try {
|
||||
debug('verify body')
|
||||
verify(req, res, body, encoding)
|
||||
} catch (err) {
|
||||
next(createError(403, err, {
|
||||
body: body,
|
||||
type: err.type || 'entity.verify.failed'
|
||||
}))
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// parse
|
||||
var str = body
|
||||
try {
|
||||
debug('parse body')
|
||||
str = typeof body !== 'string' && encoding !== null
|
||||
? iconv.decode(body, encoding)
|
||||
: body
|
||||
req.body = parse(str, encoding)
|
||||
} catch (err) {
|
||||
next(createError(400, err, {
|
||||
body: str,
|
||||
type: err.type || 'entity.parse.failed'
|
||||
}))
|
||||
return
|
||||
}
|
||||
|
||||
next()
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the content stream of the request.
|
||||
*
|
||||
* @param {object} req
|
||||
* @param {function} debug
|
||||
* @param {boolean} [inflate=true]
|
||||
* @return {object}
|
||||
* @api private
|
||||
*/
|
||||
|
||||
function contentstream (req, debug, inflate) {
|
||||
var encoding = (req.headers['content-encoding'] || 'identity').toLowerCase()
|
||||
var length = req.headers['content-length']
|
||||
|
||||
debug('content-encoding "%s"', encoding)
|
||||
|
||||
if (inflate === false && encoding !== 'identity') {
|
||||
throw createError(415, 'content encoding unsupported', {
|
||||
encoding: encoding,
|
||||
type: 'encoding.unsupported'
|
||||
})
|
||||
}
|
||||
|
||||
if (encoding === 'identity') {
|
||||
req.length = length
|
||||
return req
|
||||
}
|
||||
|
||||
var stream = createDecompressionStream(encoding, debug)
|
||||
req.pipe(stream)
|
||||
return stream
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a decompression stream for the given encoding.
|
||||
* @param {string} encoding
|
||||
* @param {function} debug
|
||||
* @return {object}
|
||||
* @api private
|
||||
*/
|
||||
function createDecompressionStream (encoding, debug) {
|
||||
switch (encoding) {
|
||||
case 'deflate':
|
||||
debug('inflate body')
|
||||
return zlib.createInflate()
|
||||
case 'gzip':
|
||||
debug('gunzip body')
|
||||
return zlib.createGunzip()
|
||||
case 'br':
|
||||
debug('brotli decompress body')
|
||||
return zlib.createBrotliDecompress()
|
||||
default:
|
||||
throw createError(415, 'unsupported content encoding "' + encoding + '"', {
|
||||
encoding: encoding,
|
||||
type: 'encoding.unsupported'
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Dump the contents of a request.
|
||||
*
|
||||
* @param {object} req
|
||||
* @param {function} callback
|
||||
* @api private
|
||||
*/
|
||||
|
||||
function dump (req, callback) {
|
||||
if (onFinished.isFinished(req)) {
|
||||
callback(null)
|
||||
} else {
|
||||
onFinished(req, callback)
|
||||
req.resume()
|
||||
}
|
||||
}
|
||||
-206
@@ -1,206 +0,0 @@
|
||||
/*!
|
||||
* body-parser
|
||||
* Copyright(c) 2014 Jonathan Ong
|
||||
* Copyright(c) 2014-2015 Douglas Christopher Wilson
|
||||
* MIT Licensed
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
/**
|
||||
* Module dependencies.
|
||||
* @private
|
||||
*/
|
||||
|
||||
var createError = require('http-errors')
|
||||
var debug = require('debug')('body-parser:json')
|
||||
var isFinished = require('on-finished').isFinished
|
||||
var read = require('../read')
|
||||
var typeis = require('type-is')
|
||||
var { getCharset, normalizeOptions } = require('../utils')
|
||||
|
||||
/**
|
||||
* Module exports.
|
||||
*/
|
||||
|
||||
module.exports = json
|
||||
|
||||
/**
|
||||
* RegExp to match the first non-space in a string.
|
||||
*
|
||||
* Allowed whitespace is defined in RFC 7159:
|
||||
*
|
||||
* ws = *(
|
||||
* %x20 / ; Space
|
||||
* %x09 / ; Horizontal tab
|
||||
* %x0A / ; Line feed or New line
|
||||
* %x0D ) ; Carriage return
|
||||
*/
|
||||
|
||||
var FIRST_CHAR_REGEXP = /^[\x20\x09\x0a\x0d]*([^\x20\x09\x0a\x0d])/ // eslint-disable-line no-control-regex
|
||||
|
||||
var JSON_SYNTAX_CHAR = '#'
|
||||
var JSON_SYNTAX_REGEXP = /#+/g
|
||||
|
||||
/**
|
||||
* Create a middleware to parse JSON bodies.
|
||||
*
|
||||
* @param {object} [options]
|
||||
* @return {function}
|
||||
* @public
|
||||
*/
|
||||
|
||||
function json (options) {
|
||||
var { inflate, limit, verify, shouldParse } = normalizeOptions(options, 'application/json')
|
||||
|
||||
var reviver = options?.reviver
|
||||
var strict = options?.strict !== false
|
||||
|
||||
function parse (body) {
|
||||
if (body.length === 0) {
|
||||
// special-case empty json body, as it's a common client-side mistake
|
||||
// TODO: maybe make this configurable or part of "strict" option
|
||||
return {}
|
||||
}
|
||||
|
||||
if (strict) {
|
||||
var first = firstchar(body)
|
||||
|
||||
if (first !== '{' && first !== '[') {
|
||||
debug('strict violation')
|
||||
throw createStrictSyntaxError(body, first)
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
debug('parse json')
|
||||
return JSON.parse(body, reviver)
|
||||
} catch (e) {
|
||||
throw normalizeJsonSyntaxError(e, {
|
||||
message: e.message,
|
||||
stack: e.stack
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
return function jsonParser (req, res, next) {
|
||||
if (isFinished(req)) {
|
||||
debug('body already parsed')
|
||||
next()
|
||||
return
|
||||
}
|
||||
|
||||
if (!('body' in req)) {
|
||||
req.body = undefined
|
||||
}
|
||||
|
||||
// skip requests without bodies
|
||||
if (!typeis.hasBody(req)) {
|
||||
debug('skip empty body')
|
||||
next()
|
||||
return
|
||||
}
|
||||
|
||||
debug('content-type %j', req.headers['content-type'])
|
||||
|
||||
// determine if request should be parsed
|
||||
if (!shouldParse(req)) {
|
||||
debug('skip parsing')
|
||||
next()
|
||||
return
|
||||
}
|
||||
|
||||
// assert charset per RFC 7159 sec 8.1
|
||||
var charset = getCharset(req) || 'utf-8'
|
||||
if (charset.slice(0, 4) !== 'utf-') {
|
||||
debug('invalid charset')
|
||||
next(createError(415, 'unsupported charset "' + charset.toUpperCase() + '"', {
|
||||
charset: charset,
|
||||
type: 'charset.unsupported'
|
||||
}))
|
||||
return
|
||||
}
|
||||
|
||||
// read
|
||||
read(req, res, next, parse, debug, {
|
||||
encoding: charset,
|
||||
inflate,
|
||||
limit,
|
||||
verify
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create strict violation syntax error matching native error.
|
||||
*
|
||||
* @param {string} str
|
||||
* @param {string} char
|
||||
* @return {Error}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function createStrictSyntaxError (str, char) {
|
||||
var index = str.indexOf(char)
|
||||
var partial = ''
|
||||
|
||||
if (index !== -1) {
|
||||
partial = str.substring(0, index) + JSON_SYNTAX_CHAR
|
||||
|
||||
for (var i = index + 1; i < str.length; i++) {
|
||||
partial += JSON_SYNTAX_CHAR
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
JSON.parse(partial); /* istanbul ignore next */ throw new SyntaxError('strict violation')
|
||||
} catch (e) {
|
||||
return normalizeJsonSyntaxError(e, {
|
||||
message: e.message.replace(JSON_SYNTAX_REGEXP, function (placeholder) {
|
||||
return str.substring(index, index + placeholder.length)
|
||||
}),
|
||||
stack: e.stack
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the first non-whitespace character in a string.
|
||||
*
|
||||
* @param {string} str
|
||||
* @return {function}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function firstchar (str) {
|
||||
var match = FIRST_CHAR_REGEXP.exec(str)
|
||||
|
||||
return match
|
||||
? match[1]
|
||||
: undefined
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalize a SyntaxError for JSON.parse.
|
||||
*
|
||||
* @param {SyntaxError} error
|
||||
* @param {object} obj
|
||||
* @return {SyntaxError}
|
||||
*/
|
||||
|
||||
function normalizeJsonSyntaxError (error, obj) {
|
||||
var keys = Object.getOwnPropertyNames(error)
|
||||
|
||||
for (var i = 0; i < keys.length; i++) {
|
||||
var key = keys[i]
|
||||
if (key !== 'stack' && key !== 'message') {
|
||||
delete error[key]
|
||||
}
|
||||
}
|
||||
|
||||
// replace stack before message for Node.js 0.10 and below
|
||||
error.stack = obj.stack.replace(error.message, obj.message)
|
||||
error.message = obj.message
|
||||
|
||||
return error
|
||||
}
|
||||
-75
@@ -1,75 +0,0 @@
|
||||
/*!
|
||||
* body-parser
|
||||
* Copyright(c) 2014-2015 Douglas Christopher Wilson
|
||||
* MIT Licensed
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
/**
|
||||
* Module dependencies.
|
||||
*/
|
||||
|
||||
var debug = require('debug')('body-parser:raw')
|
||||
var isFinished = require('on-finished').isFinished
|
||||
var read = require('../read')
|
||||
var typeis = require('type-is')
|
||||
var { normalizeOptions } = require('../utils')
|
||||
|
||||
/**
|
||||
* Module exports.
|
||||
*/
|
||||
|
||||
module.exports = raw
|
||||
|
||||
/**
|
||||
* Create a middleware to parse raw bodies.
|
||||
*
|
||||
* @param {object} [options]
|
||||
* @return {function}
|
||||
* @api public
|
||||
*/
|
||||
|
||||
function raw (options) {
|
||||
var { inflate, limit, verify, shouldParse } = normalizeOptions(options, 'application/octet-stream')
|
||||
|
||||
function parse (buf) {
|
||||
return buf
|
||||
}
|
||||
|
||||
return function rawParser (req, res, next) {
|
||||
if (isFinished(req)) {
|
||||
debug('body already parsed')
|
||||
next()
|
||||
return
|
||||
}
|
||||
|
||||
if (!('body' in req)) {
|
||||
req.body = undefined
|
||||
}
|
||||
|
||||
// skip requests without bodies
|
||||
if (!typeis.hasBody(req)) {
|
||||
debug('skip empty body')
|
||||
next()
|
||||
return
|
||||
}
|
||||
|
||||
debug('content-type %j', req.headers['content-type'])
|
||||
|
||||
// determine if request should be parsed
|
||||
if (!shouldParse(req)) {
|
||||
debug('skip parsing')
|
||||
next()
|
||||
return
|
||||
}
|
||||
|
||||
// read
|
||||
read(req, res, next, parse, debug, {
|
||||
encoding: null,
|
||||
inflate,
|
||||
limit,
|
||||
verify
|
||||
})
|
||||
}
|
||||
}
|
||||
-80
@@ -1,80 +0,0 @@
|
||||
/*!
|
||||
* body-parser
|
||||
* Copyright(c) 2014-2015 Douglas Christopher Wilson
|
||||
* MIT Licensed
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
/**
|
||||
* Module dependencies.
|
||||
*/
|
||||
|
||||
var debug = require('debug')('body-parser:text')
|
||||
var isFinished = require('on-finished').isFinished
|
||||
var read = require('../read')
|
||||
var typeis = require('type-is')
|
||||
var { getCharset, normalizeOptions } = require('../utils')
|
||||
|
||||
/**
|
||||
* Module exports.
|
||||
*/
|
||||
|
||||
module.exports = text
|
||||
|
||||
/**
|
||||
* Create a middleware to parse text bodies.
|
||||
*
|
||||
* @param {object} [options]
|
||||
* @return {function}
|
||||
* @api public
|
||||
*/
|
||||
|
||||
function text (options) {
|
||||
var { inflate, limit, verify, shouldParse } = normalizeOptions(options, 'text/plain')
|
||||
|
||||
var defaultCharset = options?.defaultCharset || 'utf-8'
|
||||
|
||||
function parse (buf) {
|
||||
return buf
|
||||
}
|
||||
|
||||
return function textParser (req, res, next) {
|
||||
if (isFinished(req)) {
|
||||
debug('body already parsed')
|
||||
next()
|
||||
return
|
||||
}
|
||||
|
||||
if (!('body' in req)) {
|
||||
req.body = undefined
|
||||
}
|
||||
|
||||
// skip requests without bodies
|
||||
if (!typeis.hasBody(req)) {
|
||||
debug('skip empty body')
|
||||
next()
|
||||
return
|
||||
}
|
||||
|
||||
debug('content-type %j', req.headers['content-type'])
|
||||
|
||||
// determine if request should be parsed
|
||||
if (!shouldParse(req)) {
|
||||
debug('skip parsing')
|
||||
next()
|
||||
return
|
||||
}
|
||||
|
||||
// get charset
|
||||
var charset = getCharset(req) || defaultCharset
|
||||
|
||||
// read
|
||||
read(req, res, next, parse, debug, {
|
||||
encoding: charset,
|
||||
inflate,
|
||||
limit,
|
||||
verify
|
||||
})
|
||||
}
|
||||
}
|
||||
-177
@@ -1,177 +0,0 @@
|
||||
/*!
|
||||
* body-parser
|
||||
* Copyright(c) 2014 Jonathan Ong
|
||||
* Copyright(c) 2014-2015 Douglas Christopher Wilson
|
||||
* MIT Licensed
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
/**
|
||||
* Module dependencies.
|
||||
* @private
|
||||
*/
|
||||
|
||||
var createError = require('http-errors')
|
||||
var debug = require('debug')('body-parser:urlencoded')
|
||||
var isFinished = require('on-finished').isFinished
|
||||
var read = require('../read')
|
||||
var typeis = require('type-is')
|
||||
var qs = require('qs')
|
||||
var { getCharset, normalizeOptions } = require('../utils')
|
||||
|
||||
/**
|
||||
* Module exports.
|
||||
*/
|
||||
|
||||
module.exports = urlencoded
|
||||
|
||||
/**
|
||||
* Create a middleware to parse urlencoded bodies.
|
||||
*
|
||||
* @param {object} [options]
|
||||
* @return {function}
|
||||
* @public
|
||||
*/
|
||||
|
||||
function urlencoded (options) {
|
||||
var { inflate, limit, verify, shouldParse } = normalizeOptions(options, 'application/x-www-form-urlencoded')
|
||||
|
||||
var defaultCharset = options?.defaultCharset || 'utf-8'
|
||||
if (defaultCharset !== 'utf-8' && defaultCharset !== 'iso-8859-1') {
|
||||
throw new TypeError('option defaultCharset must be either utf-8 or iso-8859-1')
|
||||
}
|
||||
|
||||
// create the appropriate query parser
|
||||
var queryparse = createQueryParser(options)
|
||||
|
||||
function parse (body, encoding) {
|
||||
return body.length
|
||||
? queryparse(body, encoding)
|
||||
: {}
|
||||
}
|
||||
|
||||
return function urlencodedParser (req, res, next) {
|
||||
if (isFinished(req)) {
|
||||
debug('body already parsed')
|
||||
next()
|
||||
return
|
||||
}
|
||||
|
||||
if (!('body' in req)) {
|
||||
req.body = undefined
|
||||
}
|
||||
|
||||
// skip requests without bodies
|
||||
if (!typeis.hasBody(req)) {
|
||||
debug('skip empty body')
|
||||
next()
|
||||
return
|
||||
}
|
||||
|
||||
debug('content-type %j', req.headers['content-type'])
|
||||
|
||||
// determine if request should be parsed
|
||||
if (!shouldParse(req)) {
|
||||
debug('skip parsing')
|
||||
next()
|
||||
return
|
||||
}
|
||||
|
||||
// assert charset
|
||||
var charset = getCharset(req) || defaultCharset
|
||||
if (charset !== 'utf-8' && charset !== 'iso-8859-1') {
|
||||
debug('invalid charset')
|
||||
next(createError(415, 'unsupported charset "' + charset.toUpperCase() + '"', {
|
||||
charset: charset,
|
||||
type: 'charset.unsupported'
|
||||
}))
|
||||
return
|
||||
}
|
||||
|
||||
// read
|
||||
read(req, res, next, parse, debug, {
|
||||
encoding: charset,
|
||||
inflate,
|
||||
limit,
|
||||
verify
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the extended query parser.
|
||||
*
|
||||
* @param {object} options
|
||||
*/
|
||||
|
||||
function createQueryParser (options) {
|
||||
var extended = Boolean(options?.extended)
|
||||
var parameterLimit = options?.parameterLimit !== undefined
|
||||
? options?.parameterLimit
|
||||
: 1000
|
||||
var charsetSentinel = options?.charsetSentinel
|
||||
var interpretNumericEntities = options?.interpretNumericEntities
|
||||
var depth = extended ? (options?.depth !== undefined ? options?.depth : 32) : 0
|
||||
|
||||
if (isNaN(parameterLimit) || parameterLimit < 1) {
|
||||
throw new TypeError('option parameterLimit must be a positive number')
|
||||
}
|
||||
|
||||
if (isNaN(depth) || depth < 0) {
|
||||
throw new TypeError('option depth must be a zero or a positive number')
|
||||
}
|
||||
|
||||
if (isFinite(parameterLimit)) {
|
||||
parameterLimit = parameterLimit | 0
|
||||
}
|
||||
|
||||
return function queryparse (body, encoding) {
|
||||
var paramCount = parameterCount(body, parameterLimit)
|
||||
|
||||
if (paramCount === undefined) {
|
||||
debug('too many parameters')
|
||||
throw createError(413, 'too many parameters', {
|
||||
type: 'parameters.too.many'
|
||||
})
|
||||
}
|
||||
|
||||
var arrayLimit = extended ? Math.max(100, paramCount) : 0
|
||||
|
||||
debug('parse ' + (extended ? 'extended ' : '') + 'urlencoding')
|
||||
try {
|
||||
return qs.parse(body, {
|
||||
allowPrototypes: true,
|
||||
arrayLimit: arrayLimit,
|
||||
depth: depth,
|
||||
charsetSentinel: charsetSentinel,
|
||||
interpretNumericEntities: interpretNumericEntities,
|
||||
charset: encoding,
|
||||
parameterLimit: parameterLimit,
|
||||
strictDepth: true
|
||||
})
|
||||
} catch (err) {
|
||||
if (err instanceof RangeError) {
|
||||
throw createError(400, 'The input exceeded the depth', {
|
||||
type: 'querystring.parse.rangeError'
|
||||
})
|
||||
} else {
|
||||
throw err
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Count the number of parameters, stopping once limit reached
|
||||
*
|
||||
* @param {string} body
|
||||
* @param {number} limit
|
||||
* @api private
|
||||
*/
|
||||
|
||||
function parameterCount (body, limit) {
|
||||
var len = body.split('&').length
|
||||
|
||||
return len > limit ? undefined : len - 1
|
||||
}
|
||||
-83
@@ -1,83 +0,0 @@
|
||||
'use strict'
|
||||
|
||||
/**
|
||||
* Module dependencies.
|
||||
*/
|
||||
|
||||
var bytes = require('bytes')
|
||||
var contentType = require('content-type')
|
||||
var typeis = require('type-is')
|
||||
|
||||
/**
|
||||
* Module exports.
|
||||
*/
|
||||
|
||||
module.exports = {
|
||||
getCharset,
|
||||
normalizeOptions
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the charset of a request.
|
||||
*
|
||||
* @param {object} req
|
||||
* @api private
|
||||
*/
|
||||
|
||||
function getCharset (req) {
|
||||
try {
|
||||
return (contentType.parse(req).parameters.charset || '').toLowerCase()
|
||||
} catch {
|
||||
return undefined
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the simple type checker.
|
||||
*
|
||||
* @param {string | string[]} type
|
||||
* @return {function}
|
||||
*/
|
||||
|
||||
function typeChecker (type) {
|
||||
return function checkType (req) {
|
||||
return Boolean(typeis(req, type))
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalizes the common options for all parsers.
|
||||
*
|
||||
* @param {object} options options to normalize
|
||||
* @param {string | string[] | function} defaultType default content type(s) or a function to determine it
|
||||
* @returns {object}
|
||||
*/
|
||||
function normalizeOptions (options, defaultType) {
|
||||
if (!defaultType) {
|
||||
// Parsers must define a default content type
|
||||
throw new TypeError('defaultType must be provided')
|
||||
}
|
||||
|
||||
var inflate = options?.inflate !== false
|
||||
var limit = typeof options?.limit !== 'number'
|
||||
? bytes.parse(options?.limit || '100kb')
|
||||
: options?.limit
|
||||
var type = options?.type || defaultType
|
||||
var verify = options?.verify || false
|
||||
|
||||
if (verify !== false && typeof verify !== 'function') {
|
||||
throw new TypeError('option verify must be function')
|
||||
}
|
||||
|
||||
// create the appropriate type checking function
|
||||
var shouldParse = typeof type !== 'function'
|
||||
? typeChecker(type)
|
||||
: type
|
||||
|
||||
return {
|
||||
inflate,
|
||||
limit,
|
||||
verify,
|
||||
shouldParse
|
||||
}
|
||||
}
|
||||
-49
@@ -1,49 +0,0 @@
|
||||
{
|
||||
"name": "body-parser",
|
||||
"description": "Node.js body parsing middleware",
|
||||
"version": "2.2.0",
|
||||
"contributors": [
|
||||
"Douglas Christopher Wilson <doug@somethingdoug.com>",
|
||||
"Jonathan Ong <me@jongleberry.com> (http://jongleberry.com)"
|
||||
],
|
||||
"license": "MIT",
|
||||
"repository": "expressjs/body-parser",
|
||||
"dependencies": {
|
||||
"bytes": "^3.1.2",
|
||||
"content-type": "^1.0.5",
|
||||
"debug": "^4.4.0",
|
||||
"http-errors": "^2.0.0",
|
||||
"iconv-lite": "^0.6.3",
|
||||
"on-finished": "^2.4.1",
|
||||
"qs": "^6.14.0",
|
||||
"raw-body": "^3.0.0",
|
||||
"type-is": "^2.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"eslint": "8.34.0",
|
||||
"eslint-config-standard": "14.1.1",
|
||||
"eslint-plugin-import": "2.27.5",
|
||||
"eslint-plugin-markdown": "3.0.0",
|
||||
"eslint-plugin-node": "11.1.0",
|
||||
"eslint-plugin-promise": "6.1.1",
|
||||
"eslint-plugin-standard": "4.1.0",
|
||||
"mocha": "^11.1.0",
|
||||
"nyc": "^17.1.0",
|
||||
"supertest": "^7.0.0"
|
||||
},
|
||||
"files": [
|
||||
"lib/",
|
||||
"LICENSE",
|
||||
"HISTORY.md",
|
||||
"index.js"
|
||||
],
|
||||
"engines": {
|
||||
"node": ">=18"
|
||||
},
|
||||
"scripts": {
|
||||
"lint": "eslint .",
|
||||
"test": "mocha --reporter spec --check-leaks test/",
|
||||
"test-ci": "nyc --reporter=lcovonly --reporter=text npm test",
|
||||
"test-cov": "nyc --reporter=html --reporter=text npm test"
|
||||
}
|
||||
}
|
||||
-97
@@ -1,97 +0,0 @@
|
||||
3.1.2 / 2022-01-27
|
||||
==================
|
||||
|
||||
* Fix return value for un-parsable strings
|
||||
|
||||
3.1.1 / 2021-11-15
|
||||
==================
|
||||
|
||||
* Fix "thousandsSeparator" incorrecting formatting fractional part
|
||||
|
||||
3.1.0 / 2019-01-22
|
||||
==================
|
||||
|
||||
* Add petabyte (`pb`) support
|
||||
|
||||
3.0.0 / 2017-08-31
|
||||
==================
|
||||
|
||||
* Change "kB" to "KB" in format output
|
||||
* Remove support for Node.js 0.6
|
||||
* Remove support for ComponentJS
|
||||
|
||||
2.5.0 / 2017-03-24
|
||||
==================
|
||||
|
||||
* Add option "unit"
|
||||
|
||||
2.4.0 / 2016-06-01
|
||||
==================
|
||||
|
||||
* Add option "unitSeparator"
|
||||
|
||||
2.3.0 / 2016-02-15
|
||||
==================
|
||||
|
||||
* Drop partial bytes on all parsed units
|
||||
* Fix non-finite numbers to `.format` to return `null`
|
||||
* Fix parsing byte string that looks like hex
|
||||
* perf: hoist regular expressions
|
||||
|
||||
2.2.0 / 2015-11-13
|
||||
==================
|
||||
|
||||
* add option "decimalPlaces"
|
||||
* add option "fixedDecimals"
|
||||
|
||||
2.1.0 / 2015-05-21
|
||||
==================
|
||||
|
||||
* add `.format` export
|
||||
* add `.parse` export
|
||||
|
||||
2.0.2 / 2015-05-20
|
||||
==================
|
||||
|
||||
* remove map recreation
|
||||
* remove unnecessary object construction
|
||||
|
||||
2.0.1 / 2015-05-07
|
||||
==================
|
||||
|
||||
* fix browserify require
|
||||
* remove node.extend dependency
|
||||
|
||||
2.0.0 / 2015-04-12
|
||||
==================
|
||||
|
||||
* add option "case"
|
||||
* add option "thousandsSeparator"
|
||||
* return "null" on invalid parse input
|
||||
* support proper round-trip: bytes(bytes(num)) === num
|
||||
* units no longer case sensitive when parsing
|
||||
|
||||
1.0.0 / 2014-05-05
|
||||
==================
|
||||
|
||||
* add negative support. fixes #6
|
||||
|
||||
0.3.0 / 2014-03-19
|
||||
==================
|
||||
|
||||
* added terabyte support
|
||||
|
||||
0.2.1 / 2013-04-01
|
||||
==================
|
||||
|
||||
* add .component
|
||||
|
||||
0.2.0 / 2012-10-28
|
||||
==================
|
||||
|
||||
* bytes(200).should.eql('200b')
|
||||
|
||||
0.1.0 / 2012-07-04
|
||||
==================
|
||||
|
||||
* add bytes to string conversion [yields]
|
||||
-23
@@ -1,23 +0,0 @@
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2012-2014 TJ Holowaychuk <tj@vision-media.ca>
|
||||
Copyright (c) 2015 Jed Watson <jed.watson@me.com>
|
||||
|
||||
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.
|
||||
-152
@@ -1,152 +0,0 @@
|
||||
# Bytes utility
|
||||
|
||||
[![NPM Version][npm-image]][npm-url]
|
||||
[![NPM Downloads][downloads-image]][downloads-url]
|
||||
[![Build Status][ci-image]][ci-url]
|
||||
[![Test Coverage][coveralls-image]][coveralls-url]
|
||||
|
||||
Utility to parse a string bytes (ex: `1TB`) to bytes (`1099511627776`) and vice-versa.
|
||||
|
||||
## Installation
|
||||
|
||||
This is a [Node.js](https://nodejs.org/en/) module available through the
|
||||
[npm registry](https://www.npmjs.com/). Installation is done using the
|
||||
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
|
||||
|
||||
```bash
|
||||
$ npm install bytes
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
var bytes = require('bytes');
|
||||
```
|
||||
|
||||
#### bytes(number｜string value, [options]): number｜string｜null
|
||||
|
||||
Default export function. Delegates to either `bytes.format` or `bytes.parse` based on the type of `value`.
|
||||
|
||||
**Arguments**
|
||||
|
||||
| Name | Type | Description |
|
||||
|---------|----------|--------------------|
|
||||
| value | `number`｜`string` | Number value to format or string value to parse |
|
||||
| options | `Object` | Conversion options for `format` |
|
||||
|
||||
**Returns**
|
||||
|
||||
| Name | Type | Description |
|
||||
|---------|------------------|-------------------------------------------------|
|
||||
| results | `string`｜`number`｜`null` | Return null upon error. Numeric value in bytes, or string value otherwise. |
|
||||
|
||||
**Example**
|
||||
|
||||
```js
|
||||
bytes(1024);
|
||||
// output: '1KB'
|
||||
|
||||
bytes('1KB');
|
||||
// output: 1024
|
||||
```
|
||||
|
||||
#### bytes.format(number value, [options]): string｜null
|
||||
|
||||
Format the given value in bytes into a string. If the value is negative, it is kept as such. If it is a float, it is
|
||||
rounded.
|
||||
|
||||
**Arguments**
|
||||
|
||||
| Name | Type | Description |
|
||||
|---------|----------|--------------------|
|
||||
| value | `number` | Value in bytes |
|
||||
| options | `Object` | Conversion options |
|
||||
|
||||
**Options**
|
||||
|
||||
| Property | Type | Description |
|
||||
|-------------------|--------|-----------------------------------------------------------------------------------------|
|
||||
| decimalPlaces | `number`｜`null` | Maximum number of decimal places to include in output. Default value to `2`. |
|
||||
| fixedDecimals | `boolean`｜`null` | Whether to always display the maximum number of decimal places. Default value to `false` |
|
||||
| thousandsSeparator | `string`｜`null` | Example of values: `' '`, `','` and `'.'`... Default value to `''`. |
|
||||
| unit | `string`｜`null` | The unit in which the result will be returned (B/KB/MB/GB/TB). Default value to `''` (which means auto detect). |
|
||||
| unitSeparator | `string`｜`null` | Separator to use between number and unit. Default value to `''`. |
|
||||
|
||||
**Returns**
|
||||
|
||||
| Name | Type | Description |
|
||||
|---------|------------------|-------------------------------------------------|
|
||||
| results | `string`｜`null` | Return null upon error. String value otherwise. |
|
||||
|
||||
**Example**
|
||||
|
||||
```js
|
||||
bytes.format(1024);
|
||||
// output: '1KB'
|
||||
|
||||
bytes.format(1000);
|
||||
// output: '1000B'
|
||||
|
||||
bytes.format(1000, {thousandsSeparator: ' '});
|
||||
// output: '1 000B'
|
||||
|
||||
bytes.format(1024 * 1.7, {decimalPlaces: 0});
|
||||
// output: '2KB'
|
||||
|
||||
bytes.format(1024, {unitSeparator: ' '});
|
||||
// output: '1 KB'
|
||||
```
|
||||
|
||||
#### bytes.parse(string｜number value): number｜null
|
||||
|
||||
Parse the string value into an integer in bytes. If no unit is given, or `value`
|
||||
is a number, it is assumed the value is in bytes.
|
||||
|
||||
Supported units and abbreviations are as follows and are case-insensitive:
|
||||
|
||||
* `b` for bytes
|
||||
* `kb` for kilobytes
|
||||
* `mb` for megabytes
|
||||
* `gb` for gigabytes
|
||||
* `tb` for terabytes
|
||||
* `pb` for petabytes
|
||||
|
||||
The units are in powers of two, not ten. This means 1kb = 1024b according to this parser.
|
||||
|
||||
**Arguments**
|
||||
|
||||
| Name | Type | Description |
|
||||
|---------------|--------|--------------------|
|
||||
| value | `string`｜`number` | String to parse, or number in bytes. |
|
||||
|
||||
**Returns**
|
||||
|
||||
| Name | Type | Description |
|
||||
|---------|-------------|-------------------------|
|
||||
| results | `number`｜`null` | Return null upon error. Value in bytes otherwise. |
|
||||
|
||||
**Example**
|
||||
|
||||
```js
|
||||
bytes.parse('1KB');
|
||||
// output: 1024
|
||||
|
||||
bytes.parse('1024');
|
||||
// output: 1024
|
||||
|
||||
bytes.parse(1024);
|
||||
// output: 1024
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
||||
[ci-image]: https://badgen.net/github/checks/visionmedia/bytes.js/master?label=ci
|
||||
[ci-url]: https://github.com/visionmedia/bytes.js/actions?query=workflow%3Aci
|
||||
[coveralls-image]: https://badgen.net/coveralls/c/github/visionmedia/bytes.js/master
|
||||
[coveralls-url]: https://coveralls.io/r/visionmedia/bytes.js?branch=master
|
||||
[downloads-image]: https://badgen.net/npm/dm/bytes
|
||||
[downloads-url]: https://npmjs.org/package/bytes
|
||||
[npm-image]: https://badgen.net/npm/v/bytes
|
||||
[npm-url]: https://npmjs.org/package/bytes
|
||||
-170
@@ -1,170 +0,0 @@
|
||||
/*!
|
||||
* bytes
|
||||
* Copyright(c) 2012-2014 TJ Holowaychuk
|
||||
* Copyright(c) 2015 Jed Watson
|
||||
* MIT Licensed
|
||||
*/
|
||||
|
||||
'use strict';
|
||||
|
||||
/**
|
||||
* Module exports.
|
||||
* @public
|
||||
*/
|
||||
|
||||
module.exports = bytes;
|
||||
module.exports.format = format;
|
||||
module.exports.parse = parse;
|
||||
|
||||
/**
|
||||
* Module variables.
|
||||
* @private
|
||||
*/
|
||||
|
||||
var formatThousandsRegExp = /\B(?=(\d{3})+(?!\d))/g;
|
||||
|
||||
var formatDecimalsRegExp = /(?:\.0*|(\.[^0]+)0+)$/;
|
||||
|
||||
var map = {
|
||||
b: 1,
|
||||
kb: 1 << 10,
|
||||
mb: 1 << 20,
|
||||
gb: 1 << 30,
|
||||
tb: Math.pow(1024, 4),
|
||||
pb: Math.pow(1024, 5),
|
||||
};
|
||||
|
||||
var parseRegExp = /^((-|\+)?(\d+(?:\.\d+)?)) *(kb|mb|gb|tb|pb)$/i;
|
||||
|
||||
/**
|
||||
* Convert the given value in bytes into a string or parse to string to an integer in bytes.
|
||||
*
|
||||
* @param {string|number} value
|
||||
* @param {{
|
||||
* case: [string],
|
||||
* decimalPlaces: [number]
|
||||
* fixedDecimals: [boolean]
|
||||
* thousandsSeparator: [string]
|
||||
* unitSeparator: [string]
|
||||
* }} [options] bytes options.
|
||||
*
|
||||
* @returns {string|number|null}
|
||||
*/
|
||||
|
||||
function bytes(value, options) {
|
||||
if (typeof value === 'string') {
|
||||
return parse(value);
|
||||
}
|
||||
|
||||
if (typeof value === 'number') {
|
||||
return format(value, options);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Format the given value in bytes into a string.
|
||||
*
|
||||
* If the value is negative, it is kept as such. If it is a float,
|
||||
* it is rounded.
|
||||
*
|
||||
* @param {number} value
|
||||
* @param {object} [options]
|
||||
* @param {number} [options.decimalPlaces=2]
|
||||
* @param {number} [options.fixedDecimals=false]
|
||||
* @param {string} [options.thousandsSeparator=]
|
||||
* @param {string} [options.unit=]
|
||||
* @param {string} [options.unitSeparator=]
|
||||
*
|
||||
* @returns {string|null}
|
||||
* @public
|
||||
*/
|
||||
|
||||
function format(value, options) {
|
||||
if (!Number.isFinite(value)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
var mag = Math.abs(value);
|
||||
var thousandsSeparator = (options && options.thousandsSeparator) || '';
|
||||
var unitSeparator = (options && options.unitSeparator) || '';
|
||||
var decimalPlaces = (options && options.decimalPlaces !== undefined) ? options.decimalPlaces : 2;
|
||||
var fixedDecimals = Boolean(options && options.fixedDecimals);
|
||||
var unit = (options && options.unit) || '';
|
||||
|
||||
if (!unit || !map[unit.toLowerCase()]) {
|
||||
if (mag >= map.pb) {
|
||||
unit = 'PB';
|
||||
} else if (mag >= map.tb) {
|
||||
unit = 'TB';
|
||||
} else if (mag >= map.gb) {
|
||||
unit = 'GB';
|
||||
} else if (mag >= map.mb) {
|
||||
unit = 'MB';
|
||||
} else if (mag >= map.kb) {
|
||||
unit = 'KB';
|
||||
} else {
|
||||
unit = 'B';
|
||||
}
|
||||
}
|
||||
|
||||
var val = value / map[unit.toLowerCase()];
|
||||
var str = val.toFixed(decimalPlaces);
|
||||
|
||||
if (!fixedDecimals) {
|
||||
str = str.replace(formatDecimalsRegExp, '$1');
|
||||
}
|
||||
|
||||
if (thousandsSeparator) {
|
||||
str = str.split('.').map(function (s, i) {
|
||||
return i === 0
|
||||
? s.replace(formatThousandsRegExp, thousandsSeparator)
|
||||
: s
|
||||
}).join('.');
|
||||
}
|
||||
|
||||
return str + unitSeparator + unit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse the string value into an integer in bytes.
|
||||
*
|
||||
* If no unit is given, it is assumed the value is in bytes.
|
||||
*
|
||||
* @param {number|string} val
|
||||
*
|
||||
* @returns {number|null}
|
||||
* @public
|
||||
*/
|
||||
|
||||
function parse(val) {
|
||||
if (typeof val === 'number' && !isNaN(val)) {
|
||||
return val;
|
||||
}
|
||||
|
||||
if (typeof val !== 'string') {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Test if the string passed is valid
|
||||
var results = parseRegExp.exec(val);
|
||||
var floatValue;
|
||||
var unit = 'b';
|
||||
|
||||
if (!results) {
|
||||
// Nothing could be extracted from the given string
|
||||
floatValue = parseInt(val, 10);
|
||||
unit = 'b'
|
||||
} else {
|
||||
// Retrieve the value and the unit
|
||||
floatValue = parseFloat(results[1]);
|
||||
unit = results[4].toLowerCase();
|
||||
}
|
||||
|
||||
if (isNaN(floatValue)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return Math.floor(map[unit] * floatValue);
|
||||
}
|
||||
-42
@@ -1,42 +0,0 @@
|
||||
{
|
||||
"name": "bytes",
|
||||
"description": "Utility to parse a string bytes to bytes and vice-versa",
|
||||
"version": "3.1.2",
|
||||
"author": "TJ Holowaychuk <tj@vision-media.ca> (http://tjholowaychuk.com)",
|
||||
"contributors": [
|
||||
"Jed Watson <jed.watson@me.com>",
|
||||
"Théo FIDRY <theo.fidry@gmail.com>"
|
||||
],
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"byte",
|
||||
"bytes",
|
||||
"utility",
|
||||
"parse",
|
||||
"parser",
|
||||
"convert",
|
||||
"converter"
|
||||
],
|
||||
"repository": "visionmedia/bytes.js",
|
||||
"devDependencies": {
|
||||
"eslint": "7.32.0",
|
||||
"eslint-plugin-markdown": "2.2.1",
|
||||
"mocha": "9.2.0",
|
||||
"nyc": "15.1.0"
|
||||
},
|
||||
"files": [
|
||||
"History.md",
|
||||
"LICENSE",
|
||||
"Readme.md",
|
||||
"index.js"
|
||||
],
|
||||
"engines": {
|
||||
"node": ">= 0.8"
|
||||
},
|
||||
"scripts": {
|
||||
"lint": "eslint .",
|
||||
"test": "mocha --check-leaks --reporter spec",
|
||||
"test-ci": "nyc --reporter=lcov --reporter=text npm test",
|
||||
"test-cov": "nyc --reporter=html --reporter=text npm test"
|
||||
}
|
||||
}
|
||||
-17
@@ -1,17 +0,0 @@
|
||||
{
|
||||
"root": true,
|
||||
|
||||
"extends": "@ljharb",
|
||||
|
||||
"rules": {
|
||||
"func-name-matching": 0,
|
||||
"id-length": 0,
|
||||
"new-cap": [2, {
|
||||
"capIsNewExceptions": [
|
||||
"GetIntrinsic",
|
||||
],
|
||||
}],
|
||||
"no-extra-parens": 0,
|
||||
"no-magic-numbers": 0,
|
||||
},
|
||||
}
|
||||
-12
@@ -1,12 +0,0 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: [ljharb]
|
||||
patreon: # Replace with a single Patreon username
|
||||
open_collective: # Replace with a single Open Collective username
|
||||
ko_fi: # Replace with a single Ko-fi username
|
||||
tidelift: npm/call-bind-apply-helpers
|
||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||
liberapay: # Replace with a single Liberapay username
|
||||
issuehunt: # Replace with a single IssueHunt username
|
||||
otechie: # Replace with a single Otechie username
|
||||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
{
|
||||
"all": true,
|
||||
"check-coverage": false,
|
||||
"reporter": ["text-summary", "text", "html", "json"],
|
||||
"exclude": [
|
||||
"coverage",
|
||||
"test"
|
||||
]
|
||||
}
|
||||
-30
@@ -1,30 +0,0 @@
|
||||
# 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).
|
||||
|
||||
## [v1.0.2](https://github.com/ljharb/call-bind-apply-helpers/compare/v1.0.1...v1.0.2) - 2025-02-12
|
||||
|
||||
### Commits
|
||||
|
||||
- [types] improve inferred types [`e6f9586`](https://github.com/ljharb/call-bind-apply-helpers/commit/e6f95860a3c72879cb861a858cdfb8138fbedec1)
|
||||
- [Dev Deps] update `@arethetypeswrong/cli`, `@ljharb/tsconfig`, `@types/tape`, `es-value-fixtures`, `for-each`, `has-strict-mode`, `object-inspect` [`e43d540`](https://github.com/ljharb/call-bind-apply-helpers/commit/e43d5409f97543bfbb11f345d47d8ce4e066d8c1)
|
||||
|
||||
## [v1.0.1](https://github.com/ljharb/call-bind-apply-helpers/compare/v1.0.0...v1.0.1) - 2024-12-08
|
||||
|
||||
### Commits
|
||||
|
||||
- [types] `reflectApply`: fix types [`4efc396`](https://github.com/ljharb/call-bind-apply-helpers/commit/4efc3965351a4f02cc55e836fa391d3d11ef2ef8)
|
||||
- [Fix] `reflectApply`: oops, Reflect is not a function [`83cc739`](https://github.com/ljharb/call-bind-apply-helpers/commit/83cc7395de6b79b7730bdf092f1436f0b1263c75)
|
||||
- [Dev Deps] update `@arethetypeswrong/cli` [`80bd5d3`](https://github.com/ljharb/call-bind-apply-helpers/commit/80bd5d3ae58b4f6b6995ce439dd5a1bcb178a940)
|
||||
|
||||
## v1.0.0 - 2024-12-05
|
||||
|
||||
### Commits
|
||||
|
||||
- Initial implementation, tests, readme [`7879629`](https://github.com/ljharb/call-bind-apply-helpers/commit/78796290f9b7430c9934d6f33d94ae9bc89fce04)
|
||||
- Initial commit [`3f1dc16`](https://github.com/ljharb/call-bind-apply-helpers/commit/3f1dc164afc43285631b114a5f9dd9137b2b952f)
|
||||
- npm init [`081df04`](https://github.com/ljharb/call-bind-apply-helpers/commit/081df048c312fcee400922026f6e97281200a603)
|
||||
- Only apps should have lockfiles [`5b9ca0f`](https://github.com/ljharb/call-bind-apply-helpers/commit/5b9ca0fe8101ebfaf309c549caac4e0a017ed930)
|
||||
-21
@@ -1,21 +0,0 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 Jordan Harband
|
||||
|
||||
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.
|
||||
-62
@@ -1,62 +0,0 @@
|
||||
# call-bind-apply-helpers <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
|
||||
|
||||
[![github actions][actions-image]][actions-url]
|
||||
[![coverage][codecov-image]][codecov-url]
|
||||
[![dependency status][deps-svg]][deps-url]
|
||||
[![dev dependency status][dev-deps-svg]][dev-deps-url]
|
||||
[![License][license-image]][license-url]
|
||||
[![Downloads][downloads-image]][downloads-url]
|
||||
|
||||
[![npm badge][npm-badge-png]][package-url]
|
||||
|
||||
Helper functions around Function call/apply/bind, for use in `call-bind`.
|
||||
|
||||
The only packages that should likely ever use this package directly are `call-bind` and `get-intrinsic`.
|
||||
Please use `call-bind` unless you have a very good reason not to.
|
||||
|
||||
## Getting started
|
||||
|
||||
```sh
|
||||
npm install --save call-bind-apply-helpers
|
||||
```
|
||||
|
||||
## Usage/Examples
|
||||
|
||||
```js
|
||||
const assert = require('assert');
|
||||
const callBindBasic = require('call-bind-apply-helpers');
|
||||
|
||||
function f(a, b) {
|
||||
assert.equal(this, 1);
|
||||
assert.equal(a, 2);
|
||||
assert.equal(b, 3);
|
||||
assert.equal(arguments.length, 2);
|
||||
}
|
||||
|
||||
const fBound = callBindBasic([f, 1]);
|
||||
|
||||
delete Function.prototype.call;
|
||||
delete Function.prototype.bind;
|
||||
|
||||
fBound(2, 3);
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
Clone the repo, `npm install`, and run `npm test`
|
||||
|
||||
[package-url]: https://npmjs.org/package/call-bind-apply-helpers
|
||||
[npm-version-svg]: https://versionbadg.es/ljharb/call-bind-apply-helpers.svg
|
||||
[deps-svg]: https://david-dm.org/ljharb/call-bind-apply-helpers.svg
|
||||
[deps-url]: https://david-dm.org/ljharb/call-bind-apply-helpers
|
||||
[dev-deps-svg]: https://david-dm.org/ljharb/call-bind-apply-helpers/dev-status.svg
|
||||
[dev-deps-url]: https://david-dm.org/ljharb/call-bind-apply-helpers#info=devDependencies
|
||||
[npm-badge-png]: https://nodei.co/npm/call-bind-apply-helpers.png?downloads=true&stars=true
|
||||
[license-image]: https://img.shields.io/npm/l/call-bind-apply-helpers.svg
|
||||
[license-url]: LICENSE
|
||||
[downloads-image]: https://img.shields.io/npm/dm/call-bind-apply-helpers.svg
|
||||
[downloads-url]: https://npm-stat.com/charts.html?package=call-bind-apply-helpers
|
||||
[codecov-image]: https://codecov.io/gh/ljharb/call-bind-apply-helpers/branch/main/graphs/badge.svg
|
||||
[codecov-url]: https://app.codecov.io/gh/ljharb/call-bind-apply-helpers/
|
||||
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/call-bind-apply-helpers
|
||||
[actions-url]: https://github.com/ljharb/call-bind-apply-helpers/actions
|
||||
-1
@@ -1 +0,0 @@
|
||||
export = Reflect.apply;
|
||||
-10
@@ -1,10 +0,0 @@
|
||||
'use strict';
|
||||
|
||||
var bind = require('function-bind');
|
||||
|
||||
var $apply = require('./functionApply');
|
||||
var $call = require('./functionCall');
|
||||
var $reflectApply = require('./reflectApply');
|
||||
|
||||
/** @type {import('./actualApply')} */
|
||||
module.exports = $reflectApply || bind.call($call, $apply);
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
import actualApply from './actualApply';
|
||||
|
||||
type TupleSplitHead<T extends any[], N extends number> = T['length'] extends N
|
||||
? T
|
||||
: T extends [...infer R, any]
|
||||
? TupleSplitHead<R, N>
|
||||
: never
|
||||
|
||||
type TupleSplitTail<T, N extends number, O extends any[] = []> = O['length'] extends N
|
||||
? T
|
||||
: T extends [infer F, ...infer R]
|
||||
? TupleSplitTail<[...R], N, [...O, F]>
|
||||
: never
|
||||
|
||||
type TupleSplit<T extends any[], N extends number> = [TupleSplitHead<T, N>, TupleSplitTail<T, N>]
|
||||
|
||||
declare function applyBind(...args: TupleSplit<Parameters<typeof actualApply>, 2>[1]): ReturnType<typeof actualApply>;
|
||||
|
||||
export = applyBind;
|
||||
-10
@@ -1,10 +0,0 @@
|
||||
'use strict';
|
||||
|
||||
var bind = require('function-bind');
|
||||
var $apply = require('./functionApply');
|
||||
var actualApply = require('./actualApply');
|
||||
|
||||
/** @type {import('./applyBind')} */
|
||||
module.exports = function applyBind() {
|
||||
return actualApply(bind, $apply, arguments);
|
||||
};
|
||||
-1
@@ -1 +0,0 @@
|
||||
export = Function.prototype.apply;
|
||||
-4
@@ -1,4 +0,0 @@
|
||||
'use strict';
|
||||
|
||||
/** @type {import('./functionApply')} */
|
||||
module.exports = Function.prototype.apply;
|
||||
-1
@@ -1 +0,0 @@
|
||||
export = Function.prototype.call;
|
||||
-4
@@ -1,4 +0,0 @@
|
||||
'use strict';
|
||||
|
||||
/** @type {import('./functionCall')} */
|
||||
module.exports = Function.prototype.call;
|
||||
-64
@@ -1,64 +0,0 @@
|
||||
type RemoveFromTuple<
|
||||
Tuple extends readonly unknown[],
|
||||
RemoveCount extends number,
|
||||
Index extends 1[] = []
|
||||
> = Index["length"] extends RemoveCount
|
||||
? Tuple
|
||||
: Tuple extends [infer First, ...infer Rest]
|
||||
? RemoveFromTuple<Rest, RemoveCount, [...Index, 1]>
|
||||
: Tuple;
|
||||
|
||||
type ConcatTuples<
|
||||
Prefix extends readonly unknown[],
|
||||
Suffix extends readonly unknown[]
|
||||
> = [...Prefix, ...Suffix];
|
||||
|
||||
type ExtractFunctionParams<T> = T extends (this: infer TThis, ...args: infer P extends readonly unknown[]) => infer R
|
||||
? { thisArg: TThis; params: P; returnType: R }
|
||||
: never;
|
||||
|
||||
type BindFunction<
|
||||
T extends (this: any, ...args: any[]) => any,
|
||||
TThis,
|
||||
TBoundArgs extends readonly unknown[],
|
||||
ReceiverBound extends boolean
|
||||
> = ExtractFunctionParams<T> extends {
|
||||
thisArg: infer OrigThis;
|
||||
params: infer P extends readonly unknown[];
|
||||
returnType: infer R;
|
||||
}
|
||||
? ReceiverBound extends true
|
||||
? (...args: RemoveFromTuple<P, Extract<TBoundArgs["length"], number>>) => R extends [OrigThis, ...infer Rest]
|
||||
? [TThis, ...Rest] // Replace `this` with `thisArg`
|
||||
: R
|
||||
: <U, RemainingArgs extends RemoveFromTuple<P, Extract<TBoundArgs["length"], number>>>(
|
||||
thisArg: U,
|
||||
...args: RemainingArgs
|
||||
) => R extends [OrigThis, ...infer Rest]
|
||||
? [U, ...ConcatTuples<TBoundArgs, Rest>] // Preserve bound args in return type
|
||||
: R
|
||||
: never;
|
||||
|
||||
declare function callBind<
|
||||
const T extends (this: any, ...args: any[]) => any,
|
||||
Extracted extends ExtractFunctionParams<T>,
|
||||
const TBoundArgs extends Partial<Extracted["params"]> & readonly unknown[],
|
||||
const TThis extends Extracted["thisArg"]
|
||||
>(
|
||||
args: [fn: T, thisArg: TThis, ...boundArgs: TBoundArgs]
|
||||
): BindFunction<T, TThis, TBoundArgs, true>;
|
||||
|
||||
declare function callBind<
|
||||
const T extends (this: any, ...args: any[]) => any,
|
||||
Extracted extends ExtractFunctionParams<T>,
|
||||
const TBoundArgs extends Partial<Extracted["params"]> & readonly unknown[]
|
||||
>(
|
||||
args: [fn: T, ...boundArgs: TBoundArgs]
|
||||
): BindFunction<T, Extracted["thisArg"], TBoundArgs, false>;
|
||||
|
||||
declare function callBind<const TArgs extends readonly unknown[]>(
|
||||
args: [fn: Exclude<TArgs[0], Function>, ...rest: TArgs]
|
||||
): never;
|
||||
|
||||
// export as namespace callBind;
|
||||
export = callBind;
|
||||
-15
@@ -1,15 +0,0 @@
|
||||
'use strict';
|
||||
|
||||
var bind = require('function-bind');
|
||||
var $TypeError = require('es-errors/type');
|
||||
|
||||
var $call = require('./functionCall');
|
||||
var $actualApply = require('./actualApply');
|
||||
|
||||
/** @type {(args: [Function, thisArg?: unknown, ...args: unknown[]]) => Function} TODO FIXME, find a way to use import('.') */
|
||||
module.exports = function callBindBasic(args) {
|
||||
if (args.length < 1 || typeof args[0] !== 'function') {
|
||||
throw new $TypeError('a function is required');
|
||||
}
|
||||
return $actualApply(bind, $call, args);
|
||||
};
|
||||
-85
@@ -1,85 +0,0 @@
|
||||
{
|
||||
"name": "call-bind-apply-helpers",
|
||||
"version": "1.0.2",
|
||||
"description": "Helper functions around Function call/apply/bind, for use in `call-bind`",
|
||||
"main": "index.js",
|
||||
"exports": {
|
||||
".": "./index.js",
|
||||
"./actualApply": "./actualApply.js",
|
||||
"./applyBind": "./applyBind.js",
|
||||
"./functionApply": "./functionApply.js",
|
||||
"./functionCall": "./functionCall.js",
|
||||
"./reflectApply": "./reflectApply.js",
|
||||
"./package.json": "./package.json"
|
||||
},
|
||||
"scripts": {
|
||||
"prepack": "npmignore --auto --commentLines=auto",
|
||||
"prepublish": "not-in-publish || npm run prepublishOnly",
|
||||
"prepublishOnly": "safe-publish-latest",
|
||||
"prelint": "evalmd README.md",
|
||||
"lint": "eslint --ext=.js,.mjs .",
|
||||
"postlint": "tsc -p . && attw -P",
|
||||
"pretest": "npm run lint",
|
||||
"tests-only": "nyc tape 'test/**/*.js'",
|
||||
"test": "npm run tests-only",
|
||||
"posttest": "npx npm@'>=10.2' audit --production",
|
||||
"version": "auto-changelog && git add CHANGELOG.md",
|
||||
"postversion": "auto-changelog && git add CHANGELOG.md && git commit --no-edit --amend && git tag -f \"v$(node -e \"console.log(require('./package.json').version)\")\""
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/ljharb/call-bind-apply-helpers.git"
|
||||
},
|
||||
"author": "Jordan Harband <ljharb@gmail.com>",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/ljharb/call-bind-apply-helpers/issues"
|
||||
},
|
||||
"homepage": "https://github.com/ljharb/call-bind-apply-helpers#readme",
|
||||
"dependencies": {
|
||||
"es-errors": "^1.3.0",
|
||||
"function-bind": "^1.1.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@arethetypeswrong/cli": "^0.17.3",
|
||||
"@ljharb/eslint-config": "^21.1.1",
|
||||
"@ljharb/tsconfig": "^0.2.3",
|
||||
"@types/for-each": "^0.3.3",
|
||||
"@types/function-bind": "^1.1.10",
|
||||
"@types/object-inspect": "^1.13.0",
|
||||
"@types/tape": "^5.8.1",
|
||||
"auto-changelog": "^2.5.0",
|
||||
"encoding": "^0.1.13",
|
||||
"es-value-fixtures": "^1.7.1",
|
||||
"eslint": "=8.8.0",
|
||||
"evalmd": "^0.0.19",
|
||||
"for-each": "^0.3.5",
|
||||
"has-strict-mode": "^1.1.0",
|
||||
"in-publish": "^2.0.1",
|
||||
"npmignore": "^0.3.1",
|
||||
"nyc": "^10.3.2",
|
||||
"object-inspect": "^1.13.4",
|
||||
"safe-publish-latest": "^2.0.0",
|
||||
"tape": "^5.9.0",
|
||||
"typescript": "next"
|
||||
},
|
||||
"testling": {
|
||||
"files": "test/index.js"
|
||||
},
|
||||
"auto-changelog": {
|
||||
"output": "CHANGELOG.md",
|
||||
"template": "keepachangelog",
|
||||
"unreleased": false,
|
||||
"commitLimit": false,
|
||||
"backfillLimit": false,
|
||||
"hideCredit": true
|
||||
},
|
||||
"publishConfig": {
|
||||
"ignore": [
|
||||
".github/workflows"
|
||||
]
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
}
|
||||
}
|
||||
-3
@@ -1,3 +0,0 @@
|
||||
declare const reflectApply: false | typeof Reflect.apply;
|
||||
|
||||
export = reflectApply;
|
||||
-4
@@ -1,4 +0,0 @@
|
||||
'use strict';
|
||||
|
||||
/** @type {import('./reflectApply')} */
|
||||
module.exports = typeof Reflect !== 'undefined' && Reflect && Reflect.apply;
|
||||
-63
@@ -1,63 +0,0 @@
|
||||
'use strict';
|
||||
|
||||
var callBind = require('../');
|
||||
var hasStrictMode = require('has-strict-mode')();
|
||||
var forEach = require('for-each');
|
||||
var inspect = require('object-inspect');
|
||||
var v = require('es-value-fixtures');
|
||||
|
||||
var test = require('tape');
|
||||
|
||||
test('callBindBasic', function (t) {
|
||||
forEach(v.nonFunctions, function (nonFunction) {
|
||||
t['throws'](
|
||||
// @ts-expect-error
|
||||
function () { callBind([nonFunction]); },
|
||||
TypeError,
|
||||
inspect(nonFunction) + ' is not a function'
|
||||
);
|
||||
});
|
||||
|
||||
var sentinel = { sentinel: true };
|
||||
/** @type {<T, A extends number, B extends number>(this: T, a: A, b: B) => [T | undefined, A, B]} */
|
||||
var func = function (a, b) {
|
||||
// eslint-disable-next-line no-invalid-this
|
||||
return [!hasStrictMode && this === global ? undefined : this, a, b];
|
||||
};
|
||||
t.equal(func.length, 2, 'original function length is 2');
|
||||
|
||||
/** type {(thisArg: unknown, a: number, b: number) => [unknown, number, number]} */
|
||||
var bound = callBind([func]);
|
||||
/** type {((a: number, b: number) => [typeof sentinel, typeof a, typeof b])} */
|
||||
var boundR = callBind([func, sentinel]);
|
||||
/** type {((b: number) => [typeof sentinel, number, typeof b])} */
|
||||
var boundArg = callBind([func, sentinel, /** @type {const} */ (1)]);
|
||||
|
||||
// @ts-expect-error
|
||||
t.deepEqual(bound(), [undefined, undefined, undefined], 'bound func with no args');
|
||||
|
||||
// @ts-expect-error
|
||||
t.deepEqual(func(), [undefined, undefined, undefined], 'unbound func with too few args');
|
||||
// @ts-expect-error
|
||||
t.deepEqual(bound(1, 2), [hasStrictMode ? 1 : Object(1), 2, undefined], 'bound func too few args');
|
||||
// @ts-expect-error
|
||||
t.deepEqual(boundR(), [sentinel, undefined, undefined], 'bound func with receiver, with too few args');
|
||||
// @ts-expect-error
|
||||
t.deepEqual(boundArg(), [sentinel, 1, undefined], 'bound func with receiver and arg, with too few args');
|
||||
|
||||
t.deepEqual(func(1, 2), [undefined, 1, 2], 'unbound func with right args');
|
||||
t.deepEqual(bound(1, 2, 3), [hasStrictMode ? 1 : Object(1), 2, 3], 'bound func with right args');
|
||||
t.deepEqual(boundR(1, 2), [sentinel, 1, 2], 'bound func with receiver, with right args');
|
||||
t.deepEqual(boundArg(2), [sentinel, 1, 2], 'bound func with receiver and arg, with right arg');
|
||||
|
||||
// @ts-expect-error
|
||||
t.deepEqual(func(1, 2, 3), [undefined, 1, 2], 'unbound func with too many args');
|
||||
// @ts-expect-error
|
||||
t.deepEqual(bound(1, 2, 3, 4), [hasStrictMode ? 1 : Object(1), 2, 3], 'bound func with too many args');
|
||||
// @ts-expect-error
|
||||
t.deepEqual(boundR(1, 2, 3), [sentinel, 1, 2], 'bound func with receiver, with too many args');
|
||||
// @ts-expect-error
|
||||
t.deepEqual(boundArg(2, 3), [sentinel, 1, 2], 'bound func with receiver and arg, with too many args');
|
||||
|
||||
t.end();
|
||||
});
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
{
|
||||
"extends": "@ljharb/tsconfig",
|
||||
"compilerOptions": {
|
||||
"target": "es2021",
|
||||
},
|
||||
"exclude": [
|
||||
"coverage",
|
||||
],
|
||||
}
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
{
|
||||
"root": true,
|
||||
|
||||
"extends": "@ljharb",
|
||||
|
||||
"rules": {
|
||||
"new-cap": [2, {
|
||||
"capIsNewExceptions": [
|
||||
"GetIntrinsic",
|
||||
],
|
||||
}],
|
||||
},
|
||||
}
|
||||
-12
@@ -1,12 +0,0 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: [ljharb]
|
||||
patreon: # Replace with a single Patreon username
|
||||
open_collective: # Replace with a single Open Collective username
|
||||
ko_fi: # Replace with a single Ko-fi username
|
||||
tidelift: npm/call-bound
|
||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||
liberapay: # Replace with a single Liberapay username
|
||||
issuehunt: # Replace with a single IssueHunt username
|
||||
otechie: # Replace with a single Otechie username
|
||||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
{
|
||||
"all": true,
|
||||
"check-coverage": false,
|
||||
"reporter": ["text-summary", "text", "html", "json"],
|
||||
"exclude": [
|
||||
"coverage",
|
||||
"test"
|
||||
]
|
||||
}
|
||||
-42
@@ -1,42 +0,0 @@
|
||||
# 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).
|
||||
|
||||
## [v1.0.4](https://github.com/ljharb/call-bound/compare/v1.0.3...v1.0.4) - 2025-03-03
|
||||
|
||||
### Commits
|
||||
|
||||
- [types] improve types [`e648922`](https://github.com/ljharb/call-bound/commit/e6489222a9e54f350fbf952ceabe51fd8b6027ff)
|
||||
- [Dev Deps] update `@arethetypeswrong/cli`, `@ljharb/tsconfig`, `@types/tape`, `es-value-fixtures`, `for-each`, `has-strict-mode`, `object-inspect` [`a42a5eb`](https://github.com/ljharb/call-bound/commit/a42a5ebe6c1b54fcdc7997c7dc64fdca9e936719)
|
||||
- [Deps] update `call-bind-apply-helpers`, `get-intrinsic` [`f529eac`](https://github.com/ljharb/call-bound/commit/f529eac132404c17156bbc23ab2297a25d0f20b8)
|
||||
|
||||
## [v1.0.3](https://github.com/ljharb/call-bound/compare/v1.0.2...v1.0.3) - 2024-12-15
|
||||
|
||||
### Commits
|
||||
|
||||
- [Refactor] use `call-bind-apply-helpers` instead of `call-bind` [`5e0b134`](https://github.com/ljharb/call-bound/commit/5e0b13496df14fb7d05dae9412f088da8d3f75be)
|
||||
- [Deps] update `get-intrinsic` [`41fc967`](https://github.com/ljharb/call-bound/commit/41fc96732a22c7b7e8f381f93ccc54bb6293be2e)
|
||||
- [readme] fix example [`79a0137`](https://github.com/ljharb/call-bound/commit/79a0137723f7c6d09c9c05452bbf8d5efb5d6e49)
|
||||
- [meta] add `sideEffects` flag [`08b07be`](https://github.com/ljharb/call-bound/commit/08b07be7f1c03f67dc6f3cdaf0906259771859f7)
|
||||
|
||||
## [v1.0.2](https://github.com/ljharb/call-bound/compare/v1.0.1...v1.0.2) - 2024-12-10
|
||||
|
||||
### Commits
|
||||
|
||||
- [Dev Deps] update `@arethetypeswrong/cli`, `@ljharb/tsconfig`, `gopd` [`e6a5ffe`](https://github.com/ljharb/call-bound/commit/e6a5ffe849368fe4f74dfd6cdeca1b9baa39e8d5)
|
||||
- [Deps] update `call-bind`, `get-intrinsic` [`2aeb5b5`](https://github.com/ljharb/call-bound/commit/2aeb5b521dc2b2683d1345c753ea1161de2d1c14)
|
||||
- [types] improve return type [`1a0c9fe`](https://github.com/ljharb/call-bound/commit/1a0c9fe3114471e7ca1f57d104e2efe713bb4871)
|
||||
|
||||
## v1.0.1 - 2024-12-05
|
||||
|
||||
### Commits
|
||||
|
||||
- Initial implementation, tests, readme, types [`6d94121`](https://github.com/ljharb/call-bound/commit/6d94121a9243602e506334069f7a03189fe3363d)
|
||||
- Initial commit [`0eae867`](https://github.com/ljharb/call-bound/commit/0eae867334ea025c33e6e91cdecfc9df96680cf9)
|
||||
- npm init [`71b2479`](https://github.com/ljharb/call-bound/commit/71b2479c6723e0b7d91a6b663613067e98b7b275)
|
||||
- Only apps should have lockfiles [`c3754a9`](https://github.com/ljharb/call-bound/commit/c3754a949b7f9132b47e2d18c1729889736741eb)
|
||||
- [actions] skip `npm ls` in node < 10 [`74275a5`](https://github.com/ljharb/call-bound/commit/74275a5186b8caf6309b6b97472bdcb0df4683a8)
|
||||
- [Dev Deps] add missing peer dep [`1354de8`](https://github.com/ljharb/call-bound/commit/1354de8679413e4ae9c523d85f76fa7a5e032d97)
|
||||
-21
@@ -1,21 +0,0 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 Jordan Harband
|
||||
|
||||
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.
|
||||
-53
@@ -1,53 +0,0 @@
|
||||
# call-bound <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
|
||||
|
||||
[![github actions][actions-image]][actions-url]
|
||||
[![coverage][codecov-image]][codecov-url]
|
||||
[![dependency status][deps-svg]][deps-url]
|
||||
[![dev dependency status][dev-deps-svg]][dev-deps-url]
|
||||
[![License][license-image]][license-url]
|
||||
[![Downloads][downloads-image]][downloads-url]
|
||||
|
||||
[![npm badge][npm-badge-png]][package-url]
|
||||
|
||||
Robust call-bound JavaScript intrinsics, using `call-bind` and `get-intrinsic`.
|
||||
|
||||
## Getting started
|
||||
|
||||
```sh
|
||||
npm install --save call-bound
|
||||
```
|
||||
|
||||
## Usage/Examples
|
||||
|
||||
```js
|
||||
const assert = require('assert');
|
||||
const callBound = require('call-bound');
|
||||
|
||||
const slice = callBound('Array.prototype.slice');
|
||||
|
||||
delete Function.prototype.call;
|
||||
delete Function.prototype.bind;
|
||||
delete Array.prototype.slice;
|
||||
|
||||
assert.deepEqual(slice([1, 2, 3, 4], 1, -1), [2, 3]);
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
Clone the repo, `npm install`, and run `npm test`
|
||||
|
||||
[package-url]: https://npmjs.org/package/call-bound
|
||||
[npm-version-svg]: https://versionbadg.es/ljharb/call-bound.svg
|
||||
[deps-svg]: https://david-dm.org/ljharb/call-bound.svg
|
||||
[deps-url]: https://david-dm.org/ljharb/call-bound
|
||||
[dev-deps-svg]: https://david-dm.org/ljharb/call-bound/dev-status.svg
|
||||
[dev-deps-url]: https://david-dm.org/ljharb/call-bound#info=devDependencies
|
||||
[npm-badge-png]: https://nodei.co/npm/call-bound.png?downloads=true&stars=true
|
||||
[license-image]: https://img.shields.io/npm/l/call-bound.svg
|
||||
[license-url]: LICENSE
|
||||
[downloads-image]: https://img.shields.io/npm/dm/call-bound.svg
|
||||
[downloads-url]: https://npm-stat.com/charts.html?package=call-bound
|
||||
[codecov-image]: https://codecov.io/gh/ljharb/call-bound/branch/main/graphs/badge.svg
|
||||
[codecov-url]: https://app.codecov.io/gh/ljharb/call-bound/
|
||||
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/call-bound
|
||||
[actions-url]: https://github.com/ljharb/call-bound/actions
|
||||
-94
@@ -1,94 +0,0 @@
|
||||
type Intrinsic = typeof globalThis;
|
||||
|
||||
type IntrinsicName = keyof Intrinsic | `%${keyof Intrinsic}%`;
|
||||
|
||||
type IntrinsicPath = IntrinsicName | `${StripPercents<IntrinsicName>}.${string}` | `%${StripPercents<IntrinsicName>}.${string}%`;
|
||||
|
||||
type AllowMissing = boolean;
|
||||
|
||||
type StripPercents<T extends string> = T extends `%${infer U}%` ? U : T;
|
||||
|
||||
type BindMethodPrecise<F> =
|
||||
F extends (this: infer This, ...args: infer Args) => infer R
|
||||
? (obj: This, ...args: Args) => R
|
||||
: F extends {
|
||||
(this: infer This1, ...args: infer Args1): infer R1;
|
||||
(this: infer This2, ...args: infer Args2): infer R2
|
||||
}
|
||||
? {
|
||||
(obj: This1, ...args: Args1): R1;
|
||||
(obj: This2, ...args: Args2): R2
|
||||
}
|
||||
: never
|
||||
|
||||
// Extract method type from a prototype
|
||||
type GetPrototypeMethod<T extends keyof typeof globalThis, M extends string> =
|
||||
(typeof globalThis)[T] extends { prototype: any }
|
||||
? M extends keyof (typeof globalThis)[T]['prototype']
|
||||
? (typeof globalThis)[T]['prototype'][M]
|
||||
: never
|
||||
: never
|
||||
|
||||
// Get static property/method
|
||||
type GetStaticMember<T extends keyof typeof globalThis, P extends string> =
|
||||
P extends keyof (typeof globalThis)[T] ? (typeof globalThis)[T][P] : never
|
||||
|
||||
// Type that maps string path to actual bound function or value with better precision
|
||||
type BoundIntrinsic<S extends string> =
|
||||
S extends `${infer Obj}.prototype.${infer Method}`
|
||||
? Obj extends keyof typeof globalThis
|
||||
? BindMethodPrecise<GetPrototypeMethod<Obj, Method & string>>
|
||||
: unknown
|
||||
: S extends `${infer Obj}.${infer Prop}`
|
||||
? Obj extends keyof typeof globalThis
|
||||
? GetStaticMember<Obj, Prop & string>
|
||||
: unknown
|
||||
: unknown
|
||||
|
||||
declare function arraySlice<T>(array: readonly T[], start?: number, end?: number): T[];
|
||||
declare function arraySlice<T>(array: ArrayLike<T>, start?: number, end?: number): T[];
|
||||
declare function arraySlice<T>(array: IArguments, start?: number, end?: number): T[];
|
||||
|
||||
// Special cases for methods that need explicit typing
|
||||
interface SpecialCases {
|
||||
'%Object.prototype.isPrototypeOf%': (thisArg: {}, obj: unknown) => boolean;
|
||||
'%String.prototype.replace%': {
|
||||
(str: string, searchValue: string | RegExp, replaceValue: string): string;
|
||||
(str: string, searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string
|
||||
};
|
||||
'%Object.prototype.toString%': (obj: {}) => string;
|
||||
'%Object.prototype.hasOwnProperty%': (obj: {}, v: PropertyKey) => boolean;
|
||||
'%Array.prototype.slice%': typeof arraySlice;
|
||||
'%Array.prototype.map%': <T, U>(array: readonly T[], callbackfn: (value: T, index: number, array: readonly T[]) => U, thisArg?: any) => U[];
|
||||
'%Array.prototype.filter%': <T>(array: readonly T[], predicate: (value: T, index: number, array: readonly T[]) => unknown, thisArg?: any) => T[];
|
||||
'%Array.prototype.indexOf%': <T>(array: readonly T[], searchElement: T, fromIndex?: number) => number;
|
||||
'%Function.prototype.apply%': <T, A extends any[], R>(fn: (...args: A) => R, thisArg: any, args: A) => R;
|
||||
'%Function.prototype.call%': <T, A extends any[], R>(fn: (...args: A) => R, thisArg: any, ...args: A) => R;
|
||||
'%Function.prototype.bind%': <T, A extends any[], R>(fn: (...args: A) => R, thisArg: any, ...args: A) => (...remainingArgs: A) => R;
|
||||
'%Promise.prototype.then%': {
|
||||
<T, R>(promise: Promise<T>, onfulfilled: (value: T) => R | PromiseLike<R>): Promise<R>;
|
||||
<T, R>(promise: Promise<T>, onfulfilled: ((value: T) => R | PromiseLike<R>) | undefined | null, onrejected: (reason: any) => R | PromiseLike<R>): Promise<R>;
|
||||
};
|
||||
'%RegExp.prototype.test%': (regexp: RegExp, str: string) => boolean;
|
||||
'%RegExp.prototype.exec%': (regexp: RegExp, str: string) => RegExpExecArray | null;
|
||||
'%Error.prototype.toString%': (error: Error) => string;
|
||||
'%TypeError.prototype.toString%': (error: TypeError) => string;
|
||||
'%String.prototype.split%': (
|
||||
obj: unknown,
|
||||
splitter: string | RegExp | {
|
||||
[Symbol.split](string: string, limit?: number): string[];
|
||||
},
|
||||
limit?: number | undefined
|
||||
) => string[];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a bound function for a prototype method, or a value for a static property.
|
||||
*
|
||||
* @param name - The name of the intrinsic (e.g. 'Array.prototype.slice')
|
||||
* @param {AllowMissing} [allowMissing] - Whether to allow missing intrinsics (default: false)
|
||||
*/
|
||||
declare function callBound<K extends keyof SpecialCases | StripPercents<keyof SpecialCases>, S extends IntrinsicPath>(name: K, allowMissing?: AllowMissing): SpecialCases[`%${StripPercents<K>}%`];
|
||||
declare function callBound<K extends keyof SpecialCases | StripPercents<keyof SpecialCases>, S extends IntrinsicPath>(name: S, allowMissing?: AllowMissing): BoundIntrinsic<S>;
|
||||
|
||||
export = callBound;
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
'use strict';
|
||||
|
||||
var GetIntrinsic = require('get-intrinsic');
|
||||
|
||||
var callBindBasic = require('call-bind-apply-helpers');
|
||||
|
||||
/** @type {(thisArg: string, searchString: string, position?: number) => number} */
|
||||
var $indexOf = callBindBasic([GetIntrinsic('%String.prototype.indexOf%')]);
|
||||
|
||||
/** @type {import('.')} */
|
||||
module.exports = function callBoundIntrinsic(name, allowMissing) {
|
||||
/* eslint no-extra-parens: 0 */
|
||||
|
||||
var intrinsic = /** @type {(this: unknown, ...args: unknown[]) => unknown} */ (GetIntrinsic(name, !!allowMissing));
|
||||
if (typeof intrinsic === 'function' && $indexOf(name, '.prototype.') > -1) {
|
||||
return callBindBasic(/** @type {const} */ ([intrinsic]));
|
||||
}
|
||||
return intrinsic;
|
||||
};
|
||||
-99
@@ -1,99 +0,0 @@
|
||||
{
|
||||
"name": "call-bound",
|
||||
"version": "1.0.4",
|
||||
"description": "Robust call-bound JavaScript intrinsics, using `call-bind` and `get-intrinsic`.",
|
||||
"main": "index.js",
|
||||
"exports": {
|
||||
".": "./index.js",
|
||||
"./package.json": "./package.json"
|
||||
},
|
||||
"sideEffects": false,
|
||||
"scripts": {
|
||||
"prepack": "npmignore --auto --commentLines=auto",
|
||||
"prepublish": "not-in-publish || npm run prepublishOnly",
|
||||
"prepublishOnly": "safe-publish-latest",
|
||||
"prelint": "evalmd README.md",
|
||||
"lint": "eslint --ext=.js,.mjs .",
|
||||
"postlint": "tsc -p . && attw -P",
|
||||
"pretest": "npm run lint",
|
||||
"tests-only": "nyc tape 'test/**/*.js'",
|
||||
"test": "npm run tests-only",
|
||||
"posttest": "npx npm@'>=10.2' audit --production",
|
||||
"version": "auto-changelog && git add CHANGELOG.md",
|
||||
"postversion": "auto-changelog && git add CHANGELOG.md && git commit --no-edit --amend && git tag -f \"v$(node -e \"console.log(require('./package.json').version)\")\""
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/ljharb/call-bound.git"
|
||||
},
|
||||
"keywords": [
|
||||
"javascript",
|
||||
"ecmascript",
|
||||
"es",
|
||||
"js",
|
||||
"callbind",
|
||||
"callbound",
|
||||
"call",
|
||||
"bind",
|
||||
"bound",
|
||||
"call-bind",
|
||||
"call-bound",
|
||||
"function",
|
||||
"es-abstract"
|
||||
],
|
||||
"author": "Jordan Harband <ljharb@gmail.com>",
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
},
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/ljharb/call-bound/issues"
|
||||
},
|
||||
"homepage": "https://github.com/ljharb/call-bound#readme",
|
||||
"dependencies": {
|
||||
"call-bind-apply-helpers": "^1.0.2",
|
||||
"get-intrinsic": "^1.3.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@arethetypeswrong/cli": "^0.17.4",
|
||||
"@ljharb/eslint-config": "^21.1.1",
|
||||
"@ljharb/tsconfig": "^0.3.0",
|
||||
"@types/call-bind": "^1.0.5",
|
||||
"@types/get-intrinsic": "^1.2.3",
|
||||
"@types/tape": "^5.8.1",
|
||||
"auto-changelog": "^2.5.0",
|
||||
"encoding": "^0.1.13",
|
||||
"es-value-fixtures": "^1.7.1",
|
||||
"eslint": "=8.8.0",
|
||||
"evalmd": "^0.0.19",
|
||||
"for-each": "^0.3.5",
|
||||
"gopd": "^1.2.0",
|
||||
"has-strict-mode": "^1.1.0",
|
||||
"in-publish": "^2.0.1",
|
||||
"npmignore": "^0.3.1",
|
||||
"nyc": "^10.3.2",
|
||||
"object-inspect": "^1.13.4",
|
||||
"safe-publish-latest": "^2.0.0",
|
||||
"tape": "^5.9.0",
|
||||
"typescript": "next"
|
||||
},
|
||||
"testling": {
|
||||
"files": "test/index.js"
|
||||
},
|
||||
"auto-changelog": {
|
||||
"output": "CHANGELOG.md",
|
||||
"template": "keepachangelog",
|
||||
"unreleased": false,
|
||||
"commitLimit": false,
|
||||
"backfillLimit": false,
|
||||
"hideCredit": true
|
||||
},
|
||||
"publishConfig": {
|
||||
"ignore": [
|
||||
".github/workflows"
|
||||
]
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
}
|
||||
}
|
||||
-61
@@ -1,61 +0,0 @@
|
||||
'use strict';
|
||||
|
||||
var test = require('tape');
|
||||
|
||||
var callBound = require('../');
|
||||
|
||||
/** @template {true} T @template U @typedef {T extends U ? T : never} AssertType */
|
||||
|
||||
test('callBound', function (t) {
|
||||
// static primitive
|
||||
t.equal(callBound('Array.length'), Array.length, 'Array.length yields itself');
|
||||
t.equal(callBound('%Array.length%'), Array.length, '%Array.length% yields itself');
|
||||
|
||||
// static non-function object
|
||||
t.equal(callBound('Array.prototype'), Array.prototype, 'Array.prototype yields itself');
|
||||
t.equal(callBound('%Array.prototype%'), Array.prototype, '%Array.prototype% yields itself');
|
||||
t.equal(callBound('Array.constructor'), Array.constructor, 'Array.constructor yields itself');
|
||||
t.equal(callBound('%Array.constructor%'), Array.constructor, '%Array.constructor% yields itself');
|
||||
|
||||
// static function
|
||||
t.equal(callBound('Date.parse'), Date.parse, 'Date.parse yields itself');
|
||||
t.equal(callBound('%Date.parse%'), Date.parse, '%Date.parse% yields itself');
|
||||
|
||||
// prototype primitive
|
||||
t.equal(callBound('Error.prototype.message'), Error.prototype.message, 'Error.prototype.message yields itself');
|
||||
t.equal(callBound('%Error.prototype.message%'), Error.prototype.message, '%Error.prototype.message% yields itself');
|
||||
|
||||
var x = callBound('Object.prototype.toString');
|
||||
var y = callBound('%Object.prototype.toString%');
|
||||
|
||||
// prototype function
|
||||
t.notEqual(x, Object.prototype.toString, 'Object.prototype.toString does not yield itself');
|
||||
t.notEqual(y, Object.prototype.toString, '%Object.prototype.toString% does not yield itself');
|
||||
t.equal(x(true), Object.prototype.toString.call(true), 'call-bound Object.prototype.toString calls into the original');
|
||||
t.equal(y(true), Object.prototype.toString.call(true), 'call-bound %Object.prototype.toString% calls into the original');
|
||||
|
||||
t['throws'](
|
||||
// @ts-expect-error
|
||||
function () { callBound('does not exist'); },
|
||||
SyntaxError,
|
||||
'nonexistent intrinsic throws'
|
||||
);
|
||||
t['throws'](
|
||||
// @ts-expect-error
|
||||
function () { callBound('does not exist', true); },
|
||||
SyntaxError,
|
||||
'allowMissing arg still throws for unknown intrinsic'
|
||||
);
|
||||
|
||||
t.test('real but absent intrinsic', { skip: typeof WeakRef !== 'undefined' }, function (st) {
|
||||
st['throws'](
|
||||
function () { callBound('WeakRef'); },
|
||||
TypeError,
|
||||
'real but absent intrinsic throws'
|
||||
);
|
||||
st.equal(callBound('WeakRef', true), undefined, 'allowMissing arg avoids exception');
|
||||
st.end();
|
||||
});
|
||||
|
||||
t.end();
|
||||
});
|
||||
-10
@@ -1,10 +0,0 @@
|
||||
{
|
||||
"extends": "@ljharb/tsconfig",
|
||||
"compilerOptions": {
|
||||
"target": "ESNext",
|
||||
"lib": ["es2024"],
|
||||
},
|
||||
"exclude": [
|
||||
"coverage",
|
||||
],
|
||||
}
|
||||
-66
@@ -1,66 +0,0 @@
|
||||
1.0.0 / 2024-08-31
|
||||
==================
|
||||
|
||||
* drop node <18
|
||||
* allow utf8 as alias for utf-8
|
||||
|
||||
0.5.4 / 2021-12-10
|
||||
==================
|
||||
|
||||
* deps: safe-buffer@5.2.1
|
||||
|
||||
0.5.3 / 2018-12-17
|
||||
==================
|
||||
|
||||
* Use `safe-buffer` for improved Buffer API
|
||||
|
||||
0.5.2 / 2016-12-08
|
||||
==================
|
||||
|
||||
* Fix `parse` to accept any linear whitespace character
|
||||
|
||||
0.5.1 / 2016-01-17
|
||||
==================
|
||||
|
||||
* perf: enable strict mode
|
||||
|
||||
0.5.0 / 2014-10-11
|
||||
==================
|
||||
|
||||
* Add `parse` function
|
||||
|
||||
0.4.0 / 2014-09-21
|
||||
==================
|
||||
|
||||
* Expand non-Unicode `filename` to the full ISO-8859-1 charset
|
||||
|
||||
0.3.0 / 2014-09-20
|
||||
==================
|
||||
|
||||
* Add `fallback` option
|
||||
* Add `type` option
|
||||
|
||||
0.2.0 / 2014-09-19
|
||||
==================
|
||||
|
||||
* Reduce ambiguity of file names with hex escape in buggy browsers
|
||||
|
||||
0.1.2 / 2014-09-19
|
||||
==================
|
||||
|
||||
* Fix periodic invalid Unicode filename header
|
||||
|
||||
0.1.1 / 2014-09-19
|
||||
==================
|
||||
|
||||
* Fix invalid characters appearing in `filename*` parameter
|
||||
|
||||
0.1.0 / 2014-09-18
|
||||
==================
|
||||
|
||||
* Make the `filename` argument optional
|
||||
|
||||
0.0.0 / 2014-09-18
|
||||
==================
|
||||
|
||||
* Initial release
|
||||
-22
@@ -1,22 +0,0 @@
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2014-2017 Douglas Christopher Wilson
|
||||
|
||||
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.
|
||||
-142
@@ -1,142 +0,0 @@
|
||||
# content-disposition
|
||||
|
||||
[![NPM Version][npm-image]][npm-url]
|
||||
[![NPM Downloads][downloads-image]][downloads-url]
|
||||
[![Node.js Version][node-version-image]][node-version-url]
|
||||
[![Build Status][github-actions-ci-image]][github-actions-ci-url]
|
||||
[![Test Coverage][coveralls-image]][coveralls-url]
|
||||
|
||||
Create and parse HTTP `Content-Disposition` header
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
$ npm install content-disposition
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
```js
|
||||
var contentDisposition = require('content-disposition')
|
||||
```
|
||||
|
||||
### contentDisposition(filename, options)
|
||||
|
||||
Create an attachment `Content-Disposition` header value using the given file name,
|
||||
if supplied. The `filename` is optional and if no file name is desired, but you
|
||||
want to specify `options`, set `filename` to `undefined`.
|
||||
|
||||
```js
|
||||
res.setHeader('Content-Disposition', contentDisposition('∫ maths.pdf'))
|
||||
```
|
||||
|
||||
**note** HTTP headers are of the ISO-8859-1 character set. If you are writing this
|
||||
header through a means different from `setHeader` in Node.js, you'll want to specify
|
||||
the `'binary'` encoding in Node.js.
|
||||
|
||||
#### Options
|
||||
|
||||
`contentDisposition` accepts these properties in the options object.
|
||||
|
||||
##### fallback
|
||||
|
||||
If the `filename` option is outside ISO-8859-1, then the file name is actually
|
||||
stored in a supplemental field for clients that support Unicode file names and
|
||||
a ISO-8859-1 version of the file name is automatically generated.
|
||||
|
||||
This specifies the ISO-8859-1 file name to override the automatic generation or
|
||||
disables the generation all together, defaults to `true`.
|
||||
|
||||
- A string will specify the ISO-8859-1 file name to use in place of automatic
|
||||
generation.
|
||||
- `false` will disable including a ISO-8859-1 file name and only include the
|
||||
Unicode version (unless the file name is already ISO-8859-1).
|
||||
- `true` will enable automatic generation if the file name is outside ISO-8859-1.
|
||||
|
||||
If the `filename` option is ISO-8859-1 and this option is specified and has a
|
||||
different value, then the `filename` option is encoded in the extended field
|
||||
and this set as the fallback field, even though they are both ISO-8859-1.
|
||||
|
||||
##### type
|
||||
|
||||
Specifies the disposition type, defaults to `"attachment"`. This can also be
|
||||
`"inline"`, or any other value (all values except inline are treated like
|
||||
`attachment`, but can convey additional information if both parties agree to
|
||||
it). The type is normalized to lower-case.
|
||||
|
||||
### contentDisposition.parse(string)
|
||||
|
||||
```js
|
||||
var disposition = contentDisposition.parse('attachment; filename="EURO rates.txt"; filename*=UTF-8\'\'%e2%82%ac%20rates.txt')
|
||||
```
|
||||
|
||||
Parse a `Content-Disposition` header string. This automatically handles extended
|
||||
("Unicode") parameters by decoding them and providing them under the standard
|
||||
parameter name. This will return an object with the following properties (examples
|
||||
are shown for the string `'attachment; filename="EURO rates.txt"; filename*=UTF-8\'\'%e2%82%ac%20rates.txt'`):
|
||||
|
||||
- `type`: The disposition type (always lower case). Example: `'attachment'`
|
||||
|
||||
- `parameters`: An object of the parameters in the disposition (name of parameter
|
||||
always lower case and extended versions replace non-extended versions). Example:
|
||||
`{filename: "€ rates.txt"}`
|
||||
|
||||
## Examples
|
||||
|
||||
### Send a file for download
|
||||
|
||||
```js
|
||||
var contentDisposition = require('content-disposition')
|
||||
var destroy = require('destroy')
|
||||
var fs = require('fs')
|
||||
var http = require('http')
|
||||
var onFinished = require('on-finished')
|
||||
|
||||
var filePath = '/path/to/public/plans.pdf'
|
||||
|
||||
http.createServer(function onRequest (req, res) {
|
||||
// set headers
|
||||
res.setHeader('Content-Type', 'application/pdf')
|
||||
res.setHeader('Content-Disposition', contentDisposition(filePath))
|
||||
|
||||
// send file
|
||||
var stream = fs.createReadStream(filePath)
|
||||
stream.pipe(res)
|
||||
onFinished(res, function () {
|
||||
destroy(stream)
|
||||
})
|
||||
})
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
```sh
|
||||
$ npm test
|
||||
```
|
||||
|
||||
## References
|
||||
|
||||
- [RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1][rfc-2616]
|
||||
- [RFC 5987: Character Set and Language Encoding for Hypertext Transfer Protocol (HTTP) Header Field Parameters][rfc-5987]
|
||||
- [RFC 6266: Use of the Content-Disposition Header Field in the Hypertext Transfer Protocol (HTTP)][rfc-6266]
|
||||
- [Test Cases for HTTP Content-Disposition header field (RFC 6266) and the Encodings defined in RFCs 2047, 2231 and 5987][tc-2231]
|
||||
|
||||
[rfc-2616]: https://tools.ietf.org/html/rfc2616
|
||||
[rfc-5987]: https://tools.ietf.org/html/rfc5987
|
||||
[rfc-6266]: https://tools.ietf.org/html/rfc6266
|
||||
[tc-2231]: http://greenbytes.de/tech/tc2231/
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
||||
[npm-image]: https://img.shields.io/npm/v/content-disposition.svg
|
||||
[npm-url]: https://npmjs.org/package/content-disposition
|
||||
[node-version-image]: https://img.shields.io/node/v/content-disposition.svg
|
||||
[node-version-url]: https://nodejs.org/en/download
|
||||
[coveralls-image]: https://img.shields.io/coveralls/jshttp/content-disposition.svg
|
||||
[coveralls-url]: https://coveralls.io/r/jshttp/content-disposition?branch=master
|
||||
[downloads-image]: https://img.shields.io/npm/dm/content-disposition.svg
|
||||
[downloads-url]: https://npmjs.org/package/content-disposition
|
||||
[github-actions-ci-image]: https://img.shields.io/github/workflow/status/jshttp/content-disposition/ci/master?label=ci
|
||||
[github-actions-ci-url]: https://github.com/jshttp/content-disposition?query=workflow%3Aci
|
||||
-459
@@ -1,459 +0,0 @@
|
||||
/*!
|
||||
* content-disposition
|
||||
* Copyright(c) 2014-2017 Douglas Christopher Wilson
|
||||
* MIT Licensed
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
/**
|
||||
* Module exports.
|
||||
* @public
|
||||
*/
|
||||
|
||||
module.exports = contentDisposition
|
||||
module.exports.parse = parse
|
||||
|
||||
/**
|
||||
* Module dependencies.
|
||||
* @private
|
||||
*/
|
||||
|
||||
var basename = require('path').basename
|
||||
var Buffer = require('safe-buffer').Buffer
|
||||
|
||||
/**
|
||||
* RegExp to match non attr-char, *after* encodeURIComponent (i.e. not including "%")
|
||||
* @private
|
||||
*/
|
||||
|
||||
var ENCODE_URL_ATTR_CHAR_REGEXP = /[\x00-\x20"'()*,/:;<=>?@[\\\]{}\x7f]/g // eslint-disable-line no-control-regex
|
||||
|
||||
/**
|
||||
* RegExp to match percent encoding escape.
|
||||
* @private
|
||||
*/
|
||||
|
||||
var HEX_ESCAPE_REGEXP = /%[0-9A-Fa-f]{2}/
|
||||
var HEX_ESCAPE_REPLACE_REGEXP = /%([0-9A-Fa-f]{2})/g
|
||||
|
||||
/**
|
||||
* RegExp to match non-latin1 characters.
|
||||
* @private
|
||||
*/
|
||||
|
||||
var NON_LATIN1_REGEXP = /[^\x20-\x7e\xa0-\xff]/g
|
||||
|
||||
/**
|
||||
* RegExp to match quoted-pair in RFC 2616
|
||||
*
|
||||
* quoted-pair = "\" CHAR
|
||||
* CHAR = <any US-ASCII character (octets 0 - 127)>
|
||||
* @private
|
||||
*/
|
||||
|
||||
var QESC_REGEXP = /\\([\u0000-\u007f])/g // eslint-disable-line no-control-regex
|
||||
|
||||
/**
|
||||
* RegExp to match chars that must be quoted-pair in RFC 2616
|
||||
* @private
|
||||
*/
|
||||
|
||||
var QUOTE_REGEXP = /([\\"])/g
|
||||
|
||||
/**
|
||||
* RegExp for various RFC 2616 grammar
|
||||
*
|
||||
* parameter = token "=" ( token | quoted-string )
|
||||
* token = 1*<any CHAR except CTLs or separators>
|
||||
* separators = "(" | ")" | "<" | ">" | "@"
|
||||
* | "," | ";" | ":" | "\" | <">
|
||||
* | "/" | "[" | "]" | "?" | "="
|
||||
* | "{" | "}" | SP | HT
|
||||
* quoted-string = ( <"> *(qdtext | quoted-pair ) <"> )
|
||||
* qdtext = <any TEXT except <">>
|
||||
* quoted-pair = "\" CHAR
|
||||
* CHAR = <any US-ASCII character (octets 0 - 127)>
|
||||
* TEXT = <any OCTET except CTLs, but including LWS>
|
||||
* LWS = [CRLF] 1*( SP | HT )
|
||||
* CRLF = CR LF
|
||||
* CR = <US-ASCII CR, carriage return (13)>
|
||||
* LF = <US-ASCII LF, linefeed (10)>
|
||||
* SP = <US-ASCII SP, space (32)>
|
||||
* HT = <US-ASCII HT, horizontal-tab (9)>
|
||||
* CTL = <any US-ASCII control character (octets 0 - 31) and DEL (127)>
|
||||
* OCTET = <any 8-bit sequence of data>
|
||||
* @private
|
||||
*/
|
||||
|
||||
var PARAM_REGEXP = /;[\x09\x20]*([!#$%&'*+.0-9A-Z^_`a-z|~-]+)[\x09\x20]*=[\x09\x20]*("(?:[\x20!\x23-\x5b\x5d-\x7e\x80-\xff]|\\[\x20-\x7e])*"|[!#$%&'*+.0-9A-Z^_`a-z|~-]+)[\x09\x20]*/g // eslint-disable-line no-control-regex
|
||||
var TEXT_REGEXP = /^[\x20-\x7e\x80-\xff]+$/
|
||||
var TOKEN_REGEXP = /^[!#$%&'*+.0-9A-Z^_`a-z|~-]+$/
|
||||
|
||||
/**
|
||||
* RegExp for various RFC 5987 grammar
|
||||
*
|
||||
* ext-value = charset "'" [ language ] "'" value-chars
|
||||
* charset = "UTF-8" / "ISO-8859-1" / mime-charset
|
||||
* mime-charset = 1*mime-charsetc
|
||||
* mime-charsetc = ALPHA / DIGIT
|
||||
* / "!" / "#" / "$" / "%" / "&"
|
||||
* / "+" / "-" / "^" / "_" / "`"
|
||||
* / "{" / "}" / "~"
|
||||
* language = ( 2*3ALPHA [ extlang ] )
|
||||
* / 4ALPHA
|
||||
* / 5*8ALPHA
|
||||
* extlang = *3( "-" 3ALPHA )
|
||||
* value-chars = *( pct-encoded / attr-char )
|
||||
* pct-encoded = "%" HEXDIG HEXDIG
|
||||
* attr-char = ALPHA / DIGIT
|
||||
* / "!" / "#" / "$" / "&" / "+" / "-" / "."
|
||||
* / "^" / "_" / "`" / "|" / "~"
|
||||
* @private
|
||||
*/
|
||||
|
||||
var EXT_VALUE_REGEXP = /^([A-Za-z0-9!#$%&+\-^_`{}~]+)'(?:[A-Za-z]{2,3}(?:-[A-Za-z]{3}){0,3}|[A-Za-z]{4,8}|)'((?:%[0-9A-Fa-f]{2}|[A-Za-z0-9!#$&+.^_`|~-])+)$/
|
||||
|
||||
/**
|
||||
* RegExp for various RFC 6266 grammar
|
||||
*
|
||||
* disposition-type = "inline" | "attachment" | disp-ext-type
|
||||
* disp-ext-type = token
|
||||
* disposition-parm = filename-parm | disp-ext-parm
|
||||
* filename-parm = "filename" "=" value
|
||||
* | "filename*" "=" ext-value
|
||||
* disp-ext-parm = token "=" value
|
||||
* | ext-token "=" ext-value
|
||||
* ext-token = <the characters in token, followed by "*">
|
||||
* @private
|
||||
*/
|
||||
|
||||
var DISPOSITION_TYPE_REGEXP = /^([!#$%&'*+.0-9A-Z^_`a-z|~-]+)[\x09\x20]*(?:$|;)/ // eslint-disable-line no-control-regex
|
||||
|
||||
/**
|
||||
* Create an attachment Content-Disposition header.
|
||||
*
|
||||
* @param {string} [filename]
|
||||
* @param {object} [options]
|
||||
* @param {string} [options.type=attachment]
|
||||
* @param {string|boolean} [options.fallback=true]
|
||||
* @return {string}
|
||||
* @public
|
||||
*/
|
||||
|
||||
function contentDisposition (filename, options) {
|
||||
var opts = options || {}
|
||||
|
||||
// get type
|
||||
var type = opts.type || 'attachment'
|
||||
|
||||
// get parameters
|
||||
var params = createparams(filename, opts.fallback)
|
||||
|
||||
// format into string
|
||||
return format(new ContentDisposition(type, params))
|
||||
}
|
||||
|
||||
/**
|
||||
* Create parameters object from filename and fallback.
|
||||
*
|
||||
* @param {string} [filename]
|
||||
* @param {string|boolean} [fallback=true]
|
||||
* @return {object}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function createparams (filename, fallback) {
|
||||
if (filename === undefined) {
|
||||
return
|
||||
}
|
||||
|
||||
var params = {}
|
||||
|
||||
if (typeof filename !== 'string') {
|
||||
throw new TypeError('filename must be a string')
|
||||
}
|
||||
|
||||
// fallback defaults to true
|
||||
if (fallback === undefined) {
|
||||
fallback = true
|
||||
}
|
||||
|
||||
if (typeof fallback !== 'string' && typeof fallback !== 'boolean') {
|
||||
throw new TypeError('fallback must be a string or boolean')
|
||||
}
|
||||
|
||||
if (typeof fallback === 'string' && NON_LATIN1_REGEXP.test(fallback)) {
|
||||
throw new TypeError('fallback must be ISO-8859-1 string')
|
||||
}
|
||||
|
||||
// restrict to file base name
|
||||
var name = basename(filename)
|
||||
|
||||
// determine if name is suitable for quoted string
|
||||
var isQuotedString = TEXT_REGEXP.test(name)
|
||||
|
||||
// generate fallback name
|
||||
var fallbackName = typeof fallback !== 'string'
|
||||
? fallback && getlatin1(name)
|
||||
: basename(fallback)
|
||||
var hasFallback = typeof fallbackName === 'string' && fallbackName !== name
|
||||
|
||||
// set extended filename parameter
|
||||
if (hasFallback || !isQuotedString || HEX_ESCAPE_REGEXP.test(name)) {
|
||||
params['filename*'] = name
|
||||
}
|
||||
|
||||
// set filename parameter
|
||||
if (isQuotedString || hasFallback) {
|
||||
params.filename = hasFallback
|
||||
? fallbackName
|
||||
: name
|
||||
}
|
||||
|
||||
return params
|
||||
}
|
||||
|
||||
/**
|
||||
* Format object to Content-Disposition header.
|
||||
*
|
||||
* @param {object} obj
|
||||
* @param {string} obj.type
|
||||
* @param {object} [obj.parameters]
|
||||
* @return {string}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function format (obj) {
|
||||
var parameters = obj.parameters
|
||||
var type = obj.type
|
||||
|
||||
if (!type || typeof type !== 'string' || !TOKEN_REGEXP.test(type)) {
|
||||
throw new TypeError('invalid type')
|
||||
}
|
||||
|
||||
// start with normalized type
|
||||
var string = String(type).toLowerCase()
|
||||
|
||||
// append parameters
|
||||
if (parameters && typeof parameters === 'object') {
|
||||
var param
|
||||
var params = Object.keys(parameters).sort()
|
||||
|
||||
for (var i = 0; i < params.length; i++) {
|
||||
param = params[i]
|
||||
|
||||
var val = param.slice(-1) === '*'
|
||||
? ustring(parameters[param])
|
||||
: qstring(parameters[param])
|
||||
|
||||
string += '; ' + param + '=' + val
|
||||
}
|
||||
}
|
||||
|
||||
return string
|
||||
}
|
||||
|
||||
/**
|
||||
* Decode a RFC 5987 field value (gracefully).
|
||||
*
|
||||
* @param {string} str
|
||||
* @return {string}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function decodefield (str) {
|
||||
var match = EXT_VALUE_REGEXP.exec(str)
|
||||
|
||||
if (!match) {
|
||||
throw new TypeError('invalid extended field value')
|
||||
}
|
||||
|
||||
var charset = match[1].toLowerCase()
|
||||
var encoded = match[2]
|
||||
var value
|
||||
|
||||
// to binary string
|
||||
var binary = encoded.replace(HEX_ESCAPE_REPLACE_REGEXP, pdecode)
|
||||
|
||||
switch (charset) {
|
||||
case 'iso-8859-1':
|
||||
value = getlatin1(binary)
|
||||
break
|
||||
case 'utf-8':
|
||||
case 'utf8':
|
||||
value = Buffer.from(binary, 'binary').toString('utf8')
|
||||
break
|
||||
default:
|
||||
throw new TypeError('unsupported charset in extended field')
|
||||
}
|
||||
|
||||
return value
|
||||
}
|
||||
|
||||
/**
|
||||
* Get ISO-8859-1 version of string.
|
||||
*
|
||||
* @param {string} val
|
||||
* @return {string}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function getlatin1 (val) {
|
||||
// simple Unicode -> ISO-8859-1 transformation
|
||||
return String(val).replace(NON_LATIN1_REGEXP, '?')
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse Content-Disposition header string.
|
||||
*
|
||||
* @param {string} string
|
||||
* @return {object}
|
||||
* @public
|
||||
*/
|
||||
|
||||
function parse (string) {
|
||||
if (!string || typeof string !== 'string') {
|
||||
throw new TypeError('argument string is required')
|
||||
}
|
||||
|
||||
var match = DISPOSITION_TYPE_REGEXP.exec(string)
|
||||
|
||||
if (!match) {
|
||||
throw new TypeError('invalid type format')
|
||||
}
|
||||
|
||||
// normalize type
|
||||
var index = match[0].length
|
||||
var type = match[1].toLowerCase()
|
||||
|
||||
var key
|
||||
var names = []
|
||||
var params = {}
|
||||
var value
|
||||
|
||||
// calculate index to start at
|
||||
index = PARAM_REGEXP.lastIndex = match[0].slice(-1) === ';'
|
||||
? index - 1
|
||||
: index
|
||||
|
||||
// match parameters
|
||||
while ((match = PARAM_REGEXP.exec(string))) {
|
||||
if (match.index !== index) {
|
||||
throw new TypeError('invalid parameter format')
|
||||
}
|
||||
|
||||
index += match[0].length
|
||||
key = match[1].toLowerCase()
|
||||
value = match[2]
|
||||
|
||||
if (names.indexOf(key) !== -1) {
|
||||
throw new TypeError('invalid duplicate parameter')
|
||||
}
|
||||
|
||||
names.push(key)
|
||||
|
||||
if (key.indexOf('*') + 1 === key.length) {
|
||||
// decode extended value
|
||||
key = key.slice(0, -1)
|
||||
value = decodefield(value)
|
||||
|
||||
// overwrite existing value
|
||||
params[key] = value
|
||||
continue
|
||||
}
|
||||
|
||||
if (typeof params[key] === 'string') {
|
||||
continue
|
||||
}
|
||||
|
||||
if (value[0] === '"') {
|
||||
// remove quotes and escapes
|
||||
value = value
|
||||
.slice(1, -1)
|
||||
.replace(QESC_REGEXP, '$1')
|
||||
}
|
||||
|
||||
params[key] = value
|
||||
}
|
||||
|
||||
if (index !== -1 && index !== string.length) {
|
||||
throw new TypeError('invalid parameter format')
|
||||
}
|
||||
|
||||
return new ContentDisposition(type, params)
|
||||
}
|
||||
|
||||
/**
|
||||
* Percent decode a single character.
|
||||
*
|
||||
* @param {string} str
|
||||
* @param {string} hex
|
||||
* @return {string}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function pdecode (str, hex) {
|
||||
return String.fromCharCode(parseInt(hex, 16))
|
||||
}
|
||||
|
||||
/**
|
||||
* Percent encode a single character.
|
||||
*
|
||||
* @param {string} char
|
||||
* @return {string}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function pencode (char) {
|
||||
return '%' + String(char)
|
||||
.charCodeAt(0)
|
||||
.toString(16)
|
||||
.toUpperCase()
|
||||
}
|
||||
|
||||
/**
|
||||
* Quote a string for HTTP.
|
||||
*
|
||||
* @param {string} val
|
||||
* @return {string}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function qstring (val) {
|
||||
var str = String(val)
|
||||
|
||||
return '"' + str.replace(QUOTE_REGEXP, '\\$1') + '"'
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode a Unicode string for HTTP (RFC 5987).
|
||||
*
|
||||
* @param {string} val
|
||||
* @return {string}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function ustring (val) {
|
||||
var str = String(val)
|
||||
|
||||
// percent encode as UTF-8
|
||||
var encoded = encodeURIComponent(str)
|
||||
.replace(ENCODE_URL_ATTR_CHAR_REGEXP, pencode)
|
||||
|
||||
return 'UTF-8\'\'' + encoded
|
||||
}
|
||||
|
||||
/**
|
||||
* Class for parsed Content-Disposition header for v8 optimization
|
||||
*
|
||||
* @public
|
||||
* @param {string} type
|
||||
* @param {object} parameters
|
||||
* @constructor
|
||||
*/
|
||||
|
||||
function ContentDisposition (type, parameters) {
|
||||
this.type = type
|
||||
this.parameters = parameters
|
||||
}
|
||||
-44
@@ -1,44 +0,0 @@
|
||||
{
|
||||
"name": "content-disposition",
|
||||
"description": "Create and parse Content-Disposition header",
|
||||
"version": "1.0.0",
|
||||
"author": "Douglas Christopher Wilson <doug@somethingdoug.com>",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"content-disposition",
|
||||
"http",
|
||||
"rfc6266",
|
||||
"res"
|
||||
],
|
||||
"repository": "jshttp/content-disposition",
|
||||
"dependencies": {
|
||||
"safe-buffer": "5.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"deep-equal": "1.0.1",
|
||||
"eslint": "7.32.0",
|
||||
"eslint-config-standard": "13.0.1",
|
||||
"eslint-plugin-import": "2.25.3",
|
||||
"eslint-plugin-markdown": "2.2.1",
|
||||
"eslint-plugin-node": "11.1.0",
|
||||
"eslint-plugin-promise": "5.2.0",
|
||||
"eslint-plugin-standard": "4.1.0",
|
||||
"mocha": "^9.2.2",
|
||||
"nyc": "15.1.0"
|
||||
},
|
||||
"files": [
|
||||
"LICENSE",
|
||||
"HISTORY.md",
|
||||
"README.md",
|
||||
"index.js"
|
||||
],
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
},
|
||||
"scripts": {
|
||||
"lint": "eslint .",
|
||||
"test": "mocha --reporter spec --bail --check-leaks test/",
|
||||
"test-ci": "nyc --reporter=lcovonly --reporter=text npm test",
|
||||
"test-cov": "nyc --reporter=html --reporter=text npm test"
|
||||
}
|
||||
}
|
||||
-29
@@ -1,29 +0,0 @@
|
||||
1.0.5 / 2023-01-29
|
||||
==================
|
||||
|
||||
* perf: skip value escaping when unnecessary
|
||||
|
||||
1.0.4 / 2017-09-11
|
||||
==================
|
||||
|
||||
* perf: skip parameter parsing when no parameters
|
||||
|
||||
1.0.3 / 2017-09-10
|
||||
==================
|
||||
|
||||
* perf: remove argument reassignment
|
||||
|
||||
1.0.2 / 2016-05-09
|
||||
==================
|
||||
|
||||
* perf: enable strict mode
|
||||
|
||||
1.0.1 / 2015-02-13
|
||||
==================
|
||||
|
||||
* Improve missing `Content-Type` header error message
|
||||
|
||||
1.0.0 / 2015-02-01
|
||||
==================
|
||||
|
||||
* Initial implementation, derived from `media-typer@0.3.0`
|
||||
-22
@@ -1,22 +0,0 @@
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2015 Douglas Christopher Wilson
|
||||
|
||||
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.
|
||||
-94
@@ -1,94 +0,0 @@
|
||||
# content-type
|
||||
|
||||
[![NPM Version][npm-version-image]][npm-url]
|
||||
[![NPM Downloads][npm-downloads-image]][npm-url]
|
||||
[![Node.js Version][node-image]][node-url]
|
||||
[![Build Status][ci-image]][ci-url]
|
||||
[![Coverage Status][coveralls-image]][coveralls-url]
|
||||
|
||||
Create and parse HTTP Content-Type header according to RFC 7231
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
$ npm install content-type
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
```js
|
||||
var contentType = require('content-type')
|
||||
```
|
||||
|
||||
### contentType.parse(string)
|
||||
|
||||
```js
|
||||
var obj = contentType.parse('image/svg+xml; charset=utf-8')
|
||||
```
|
||||
|
||||
Parse a `Content-Type` header. This will return an object with the following
|
||||
properties (examples are shown for the string `'image/svg+xml; charset=utf-8'`):
|
||||
|
||||
- `type`: The media type (the type and subtype, always lower case).
|
||||
Example: `'image/svg+xml'`
|
||||
|
||||
- `parameters`: An object of the parameters in the media type (name of parameter
|
||||
always lower case). Example: `{charset: 'utf-8'}`
|
||||
|
||||
Throws a `TypeError` if the string is missing or invalid.
|
||||
|
||||
### contentType.parse(req)
|
||||
|
||||
```js
|
||||
var obj = contentType.parse(req)
|
||||
```
|
||||
|
||||
Parse the `Content-Type` header from the given `req`. Short-cut for
|
||||
`contentType.parse(req.headers['content-type'])`.
|
||||
|
||||
Throws a `TypeError` if the `Content-Type` header is missing or invalid.
|
||||
|
||||
### contentType.parse(res)
|
||||
|
||||
```js
|
||||
var obj = contentType.parse(res)
|
||||
```
|
||||
|
||||
Parse the `Content-Type` header set on the given `res`. Short-cut for
|
||||
`contentType.parse(res.getHeader('content-type'))`.
|
||||
|
||||
Throws a `TypeError` if the `Content-Type` header is missing or invalid.
|
||||
|
||||
### contentType.format(obj)
|
||||
|
||||
```js
|
||||
var str = contentType.format({
|
||||
type: 'image/svg+xml',
|
||||
parameters: { charset: 'utf-8' }
|
||||
})
|
||||
```
|
||||
|
||||
Format an object into a `Content-Type` header. This will return a string of the
|
||||
content type for the given object with the following properties (examples are
|
||||
shown that produce the string `'image/svg+xml; charset=utf-8'`):
|
||||
|
||||
- `type`: The media type (will be lower-cased). Example: `'image/svg+xml'`
|
||||
|
||||
- `parameters`: An object of the parameters in the media type (name of the
|
||||
parameter will be lower-cased). Example: `{charset: 'utf-8'}`
|
||||
|
||||
Throws a `TypeError` if the object contains an invalid type or parameter names.
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
||||
[ci-image]: https://badgen.net/github/checks/jshttp/content-type/master?label=ci
|
||||
[ci-url]: https://github.com/jshttp/content-type/actions/workflows/ci.yml
|
||||
[coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/content-type/master
|
||||
[coveralls-url]: https://coveralls.io/r/jshttp/content-type?branch=master
|
||||
[node-image]: https://badgen.net/npm/node/content-type
|
||||
[node-url]: https://nodejs.org/en/download
|
||||
[npm-downloads-image]: https://badgen.net/npm/dm/content-type
|
||||
[npm-url]: https://npmjs.org/package/content-type
|
||||
[npm-version-image]: https://badgen.net/npm/v/content-type
|
||||
-225
@@ -1,225 +0,0 @@
|
||||
/*!
|
||||
* content-type
|
||||
* Copyright(c) 2015 Douglas Christopher Wilson
|
||||
* MIT Licensed
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
/**
|
||||
* RegExp to match *( ";" parameter ) in RFC 7231 sec 3.1.1.1
|
||||
*
|
||||
* parameter = token "=" ( token / quoted-string )
|
||||
* token = 1*tchar
|
||||
* tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*"
|
||||
* / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~"
|
||||
* / DIGIT / ALPHA
|
||||
* ; any VCHAR, except delimiters
|
||||
* quoted-string = DQUOTE *( qdtext / quoted-pair ) DQUOTE
|
||||
* qdtext = HTAB / SP / %x21 / %x23-5B / %x5D-7E / obs-text
|
||||
* obs-text = %x80-FF
|
||||
* quoted-pair = "\" ( HTAB / SP / VCHAR / obs-text )
|
||||
*/
|
||||
var PARAM_REGEXP = /; *([!#$%&'*+.^_`|~0-9A-Za-z-]+) *= *("(?:[\u000b\u0020\u0021\u0023-\u005b\u005d-\u007e\u0080-\u00ff]|\\[\u000b\u0020-\u00ff])*"|[!#$%&'*+.^_`|~0-9A-Za-z-]+) */g // eslint-disable-line no-control-regex
|
||||
var TEXT_REGEXP = /^[\u000b\u0020-\u007e\u0080-\u00ff]+$/ // eslint-disable-line no-control-regex
|
||||
var TOKEN_REGEXP = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+$/
|
||||
|
||||
/**
|
||||
* RegExp to match quoted-pair in RFC 7230 sec 3.2.6
|
||||
*
|
||||
* quoted-pair = "\" ( HTAB / SP / VCHAR / obs-text )
|
||||
* obs-text = %x80-FF
|
||||
*/
|
||||
var QESC_REGEXP = /\\([\u000b\u0020-\u00ff])/g // eslint-disable-line no-control-regex
|
||||
|
||||
/**
|
||||
* RegExp to match chars that must be quoted-pair in RFC 7230 sec 3.2.6
|
||||
*/
|
||||
var QUOTE_REGEXP = /([\\"])/g
|
||||
|
||||
/**
|
||||
* RegExp to match type in RFC 7231 sec 3.1.1.1
|
||||
*
|
||||
* media-type = type "/" subtype
|
||||
* type = token
|
||||
* subtype = token
|
||||
*/
|
||||
var TYPE_REGEXP = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+\/[!#$%&'*+.^_`|~0-9A-Za-z-]+$/
|
||||
|
||||
/**
|
||||
* Module exports.
|
||||
* @public
|
||||
*/
|
||||
|
||||
exports.format = format
|
||||
exports.parse = parse
|
||||
|
||||
/**
|
||||
* Format object to media type.
|
||||
*
|
||||
* @param {object} obj
|
||||
* @return {string}
|
||||
* @public
|
||||
*/
|
||||
|
||||
function format (obj) {
|
||||
if (!obj || typeof obj !== 'object') {
|
||||
throw new TypeError('argument obj is required')
|
||||
}
|
||||
|
||||
var parameters = obj.parameters
|
||||
var type = obj.type
|
||||
|
||||
if (!type || !TYPE_REGEXP.test(type)) {
|
||||
throw new TypeError('invalid type')
|
||||
}
|
||||
|
||||
var string = type
|
||||
|
||||
// append parameters
|
||||
if (parameters && typeof parameters === 'object') {
|
||||
var param
|
||||
var params = Object.keys(parameters).sort()
|
||||
|
||||
for (var i = 0; i < params.length; i++) {
|
||||
param = params[i]
|
||||
|
||||
if (!TOKEN_REGEXP.test(param)) {
|
||||
throw new TypeError('invalid parameter name')
|
||||
}
|
||||
|
||||
string += '; ' + param + '=' + qstring(parameters[param])
|
||||
}
|
||||
}
|
||||
|
||||
return string
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse media type to object.
|
||||
*
|
||||
* @param {string|object} string
|
||||
* @return {Object}
|
||||
* @public
|
||||
*/
|
||||
|
||||
function parse (string) {
|
||||
if (!string) {
|
||||
throw new TypeError('argument string is required')
|
||||
}
|
||||
|
||||
// support req/res-like objects as argument
|
||||
var header = typeof string === 'object'
|
||||
? getcontenttype(string)
|
||||
: string
|
||||
|
||||
if (typeof header !== 'string') {
|
||||
throw new TypeError('argument string is required to be a string')
|
||||
}
|
||||
|
||||
var index = header.indexOf(';')
|
||||
var type = index !== -1
|
||||
? header.slice(0, index).trim()
|
||||
: header.trim()
|
||||
|
||||
if (!TYPE_REGEXP.test(type)) {
|
||||
throw new TypeError('invalid media type')
|
||||
}
|
||||
|
||||
var obj = new ContentType(type.toLowerCase())
|
||||
|
||||
// parse parameters
|
||||
if (index !== -1) {
|
||||
var key
|
||||
var match
|
||||
var value
|
||||
|
||||
PARAM_REGEXP.lastIndex = index
|
||||
|
||||
while ((match = PARAM_REGEXP.exec(header))) {
|
||||
if (match.index !== index) {
|
||||
throw new TypeError('invalid parameter format')
|
||||
}
|
||||
|
||||
index += match[0].length
|
||||
key = match[1].toLowerCase()
|
||||
value = match[2]
|
||||
|
||||
if (value.charCodeAt(0) === 0x22 /* " */) {
|
||||
// remove quotes
|
||||
value = value.slice(1, -1)
|
||||
|
||||
// remove escapes
|
||||
if (value.indexOf('\\') !== -1) {
|
||||
value = value.replace(QESC_REGEXP, '$1')
|
||||
}
|
||||
}
|
||||
|
||||
obj.parameters[key] = value
|
||||
}
|
||||
|
||||
if (index !== header.length) {
|
||||
throw new TypeError('invalid parameter format')
|
||||
}
|
||||
}
|
||||
|
||||
return obj
|
||||
}
|
||||
|
||||
/**
|
||||
* Get content-type from req/res objects.
|
||||
*
|
||||
* @param {object}
|
||||
* @return {Object}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function getcontenttype (obj) {
|
||||
var header
|
||||
|
||||
if (typeof obj.getHeader === 'function') {
|
||||
// res-like
|
||||
header = obj.getHeader('content-type')
|
||||
} else if (typeof obj.headers === 'object') {
|
||||
// req-like
|
||||
header = obj.headers && obj.headers['content-type']
|
||||
}
|
||||
|
||||
if (typeof header !== 'string') {
|
||||
throw new TypeError('content-type header is missing from object')
|
||||
}
|
||||
|
||||
return header
|
||||
}
|
||||
|
||||
/**
|
||||
* Quote a string if necessary.
|
||||
*
|
||||
* @param {string} val
|
||||
* @return {string}
|
||||
* @private
|
||||
*/
|
||||
|
||||
function qstring (val) {
|
||||
var str = String(val)
|
||||
|
||||
// no need to quote tokens
|
||||
if (TOKEN_REGEXP.test(str)) {
|
||||
return str
|
||||
}
|
||||
|
||||
if (str.length > 0 && !TEXT_REGEXP.test(str)) {
|
||||
throw new TypeError('invalid parameter value')
|
||||
}
|
||||
|
||||
return '"' + str.replace(QUOTE_REGEXP, '\\$1') + '"'
|
||||
}
|
||||
|
||||
/**
|
||||
* Class to represent a content type.
|
||||
* @private
|
||||
*/
|
||||
function ContentType (type) {
|
||||
this.parameters = Object.create(null)
|
||||
this.type = type
|
||||
}
|
||||
-42
@@ -1,42 +0,0 @@
|
||||
{
|
||||
"name": "content-type",
|
||||
"description": "Create and parse HTTP Content-Type header",
|
||||
"version": "1.0.5",
|
||||
"author": "Douglas Christopher Wilson <doug@somethingdoug.com>",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"content-type",
|
||||
"http",
|
||||
"req",
|
||||
"res",
|
||||
"rfc7231"
|
||||
],
|
||||
"repository": "jshttp/content-type",
|
||||
"devDependencies": {
|
||||
"deep-equal": "1.0.1",
|
||||
"eslint": "8.32.0",
|
||||
"eslint-config-standard": "15.0.1",
|
||||
"eslint-plugin-import": "2.27.5",
|
||||
"eslint-plugin-node": "11.1.0",
|
||||
"eslint-plugin-promise": "6.1.1",
|
||||
"eslint-plugin-standard": "4.1.0",
|
||||
"mocha": "10.2.0",
|
||||
"nyc": "15.1.0"
|
||||
},
|
||||
"files": [
|
||||
"LICENSE",
|
||||
"HISTORY.md",
|
||||
"README.md",
|
||||
"index.js"
|
||||
],
|
||||
"engines": {
|
||||
"node": ">= 0.6"
|
||||
},
|
||||
"scripts": {
|
||||
"lint": "eslint .",
|
||||
"test": "mocha --reporter spec --check-leaks --bail test/",
|
||||
"test-ci": "nyc --reporter=lcovonly --reporter=text npm test",
|
||||
"test-cov": "nyc --reporter=html --reporter=text npm test",
|
||||
"version": "node scripts/version-history.js && git add HISTORY.md"
|
||||
}
|
||||
}
|
||||
-70
@@ -1,70 +0,0 @@
|
||||
1.2.2 / 2024-10-29
|
||||
==================
|
||||
|
||||
* various metadata/documentation tweaks (incl. #51)
|
||||
|
||||
|
||||
1.2.1 / 2023-02-27
|
||||
==================
|
||||
|
||||
* update annotations for allowed secret key types (#44, thanks @jyasskin!)
|
||||
|
||||
|
||||
1.2.0 / 2022-02-17
|
||||
==================
|
||||
|
||||
* allow buffer and other node-supported types as key (#33)
|
||||
* be pickier about extra content after signed portion (#40)
|
||||
* some internal code clarity/cleanup improvements (#26)
|
||||
|
||||
|
||||
1.1.0 / 2018-01-18
|
||||
==================
|
||||
|
||||
* switch to built-in `crypto.timingSafeEqual` for validation instead of previous double-hash method (thank you @jodevsa!)
|
||||
|
||||
|
||||
1.0.7 / 2023-04-12
|
||||
==================
|
||||
|
||||
Later release for older node.js versions. See the [v1.0.x branch notes](https://github.com/tj/node-cookie-signature/blob/v1.0.x/History.md#107--2023-04-12).
|
||||
|
||||
|
||||
1.0.6 / 2015-02-03
|
||||
==================
|
||||
|
||||
* use `npm test` instead of `make test` to run tests
|
||||
* clearer assertion messages when checking input
|
||||
|
||||
|
||||
1.0.5 / 2014-09-05
|
||||
==================
|
||||
|
||||
* add license to package.json
|
||||
|
||||
1.0.4 / 2014-06-25
|
||||
==================
|
||||
|
||||
* corrected avoidance of timing attacks (thanks @tenbits!)
|
||||
|
||||
1.0.3 / 2014-01-28
|
||||
==================
|
||||
|
||||
* [incorrect] fix for timing attacks
|
||||
|
||||
1.0.2 / 2014-01-28
|
||||
==================
|
||||
|
||||
* fix missing repository warning
|
||||
* fix typo in test
|
||||
|
||||
1.0.1 / 2013-04-15
|
||||
==================
|
||||
|
||||
* Revert "Changed underlying HMAC algo. to sha512."
|
||||
* Revert "Fix for timing attacks on MAC verification."
|
||||
|
||||
0.0.1 / 2010-01-03
|
||||
==================
|
||||
|
||||
* Initial release
|
||||
Loaded 100 of 833 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user