@happychef/algorithm 1.2.12 → 1.2.14

package/BRANCH_PROTECTION_SETUP.md

@@ -1,167 +1,167 @@
-# Branch Protection Setup Guide
-
-This guide explains how to configure GitHub branch protection rules to require all tests to pass before merging pull requests.
-
-## Why Branch Protection?
-
-Branch protection ensures:
-- ✅ All tests must pass before merging PRs
-- ✅ No direct pushes to main without review (optional)
-- ✅ Code quality is maintained
-- ✅ Broken code never reaches production
-
-## Setup Instructions
-
-### Step 1: Go to Branch Protection Settings
-
-1. Navigate to your GitHub repository: `https://github.com/thibaultvandesompele2/15-happy-algorithm`
-2. Click on **Settings** (tab at the top)
-3. In the left sidebar, click **Branches** (under "Code and automation")
-4. Click **Add branch protection rule** (or **Add rule**)
-
-### Step 2: Configure the Rule
-
-#### Basic Settings:
-1. **Branch name pattern**: Enter `main`
-
-#### Required Settings:
-
-✅ **Check these boxes:**
-
-1. ☑️ **Require a pull request before merging**
-   - This prevents direct pushes to main
-   - Optional: Set "Required number of approvals" to 1 or more
-
-2. ☑️ **Require status checks to pass before merging**
-   - This is the CRITICAL setting for test enforcement
-   - Check: **Require branches to be up to date before merging**
-
-3. In the **Status checks** search box, you'll see:
-   - `Run Tests` (your test job)
-
-   ☑️ **Select both Node.js test jobs:**
-   - `Run Tests (18.x)`
-   - `Run Tests (20.x)`
-
-   *Note: These will appear after the first workflow run completes*
-
-4. ☑️ **Do not allow bypassing the above settings** (recommended)
-   - Even admins must follow these rules
-
-#### Optional but Recommended:
-
-5. ☑️ **Require conversation resolution before merging**
-   - All PR comments must be resolved
-
-6. ☑️ **Require linear history**
-   - Prevents messy merge commits
-
-### Step 3: Save
-
-1. Scroll to the bottom
-2. Click **Create** or **Save changes**
-
-## What Happens After Setup
-
-### On Pull Requests:
-- GitHub automatically runs the CI/CD tests
-- You'll see status checks at the bottom of the PR
-- **Merge button will be DISABLED** until all tests pass
-- If tests fail, you must fix them before merging
-
-### Visual Indicators:
-
-**Tests Running:**
-```
-⏳ Run Tests (18.x) — In progress
-⏳ Run Tests (20.x) — In progress
-```
-
-**Tests Passed:**
-```
-✅ Run Tests (18.x) — Passed
-✅ Run Tests (20.x) — Passed
-🟢 Merge pull request button is ENABLED
-```
-
-**Tests Failed:**
-```
-❌ Run Tests (18.x) — Failed
-❌ Run Tests (20.x) — Failed
-🔴 Merge pull request button is DISABLED
-```
-
-## Testing the Protection
-
-### Create a Test PR:
-
-1. Create a new branch:
-   ```bash
-   git checkout -b test-branch-protection
-   ```
-
-2. Make a small change:
-   ```bash
-   echo "# Test" >> test-file.txt
-   git add test-file.txt
-   git commit -m "Test branch protection"
-   git push origin test-branch-protection
-   ```
-
-3. Go to GitHub and create a pull request
-
-4. Observe:
-   - Tests run automatically
-   - Merge button is disabled until tests complete
-   - After tests pass, merge button becomes available
-
-## Workflow Behavior
-
-### For Pull Requests:
-- ✅ Runs all 70 tests on Node.js 18.x and 20.x
-- ✅ Must pass before merge is allowed
-- ✅ Shows test summary in PR
-- ❌ Does NOT publish to npm (only tests)
-
-### For Pushes to Main:
-- ✅ Runs all tests
-- ✅ If version changed AND tests pass → publishes to npm
-- ✅ Creates git tag
-- ✅ Shows summary of all actions
-
-## Troubleshooting
-
-### "Status checks not found"
-- The status checks only appear after the first workflow run completes
-- Push this branch protection setup, wait for workflow to run, then configure protection
-
-### "Can't find Run Tests in status checks"
-- Make sure the workflow has run at least once
-- Check the Actions tab to see workflow runs
-- The job name must match exactly: `Run Tests`
-
-### "Tests are running but merge button isn't disabled"
-- You need to enable "Require status checks to pass before merging"
-- Make sure you selected the specific test jobs (18.x and 20.x)
-
-## Quick Setup Checklist
-
-- [ ] Go to Settings → Branches
-- [ ] Add branch protection rule for `main`
-- [ ] Enable "Require status checks to pass before merging"
-- [ ] Select `Run Tests (18.x)` and `Run Tests (20.x)`
-- [ ] Enable "Do not allow bypassing"
-- [ ] Save the rule
-- [ ] Test with a PR
-
-## Additional Security (Optional)
-
-For additional security, you can also enable:
-
-- **Require deployments to succeed** - Wait for tests before deploying
-- **Lock branch** - Temporarily prevent all changes
-- **Restrict who can push** - Only specific users/teams can push
-
----
-
-**Result:** After setup, no code can be merged to `main` without passing all 70 tests! 🎉
+# Branch Protection Setup Guide
+
+This guide explains how to configure GitHub branch protection rules to require all tests to pass before merging pull requests.
+
+## Why Branch Protection?
+
+Branch protection ensures:
+- ✅ All tests must pass before merging PRs
+- ✅ No direct pushes to main without review (optional)
+- ✅ Code quality is maintained
+- ✅ Broken code never reaches production
+
+## Setup Instructions
+
+### Step 1: Go to Branch Protection Settings
+
+1. Navigate to your GitHub repository: `https://github.com/thibaultvandesompele2/15-happy-algorithm`
+2. Click on **Settings** (tab at the top)
+3. In the left sidebar, click **Branches** (under "Code and automation")
+4. Click **Add branch protection rule** (or **Add rule**)
+
+### Step 2: Configure the Rule
+
+#### Basic Settings:
+1. **Branch name pattern**: Enter `main`
+
+#### Required Settings:
+
+✅ **Check these boxes:**
+
+1. ☑️ **Require a pull request before merging**
+   - This prevents direct pushes to main
+   - Optional: Set "Required number of approvals" to 1 or more
+
+2. ☑️ **Require status checks to pass before merging**
+   - This is the CRITICAL setting for test enforcement
+   - Check: **Require branches to be up to date before merging**
+
+3. In the **Status checks** search box, you'll see:
+   - `Run Tests` (your test job)
+
+   ☑️ **Select both Node.js test jobs:**
+   - `Run Tests (18.x)`
+   - `Run Tests (20.x)`
+
+   *Note: These will appear after the first workflow run completes*
+
+4. ☑️ **Do not allow bypassing the above settings** (recommended)
+   - Even admins must follow these rules
+
+#### Optional but Recommended:
+
+5. ☑️ **Require conversation resolution before merging**
+   - All PR comments must be resolved
+
+6. ☑️ **Require linear history**
+   - Prevents messy merge commits
+
+### Step 3: Save
+
+1. Scroll to the bottom
+2. Click **Create** or **Save changes**
+
+## What Happens After Setup
+
+### On Pull Requests:
+- GitHub automatically runs the CI/CD tests
+- You'll see status checks at the bottom of the PR
+- **Merge button will be DISABLED** until all tests pass
+- If tests fail, you must fix them before merging
+
+### Visual Indicators:
+
+**Tests Running:**
+```
+⏳ Run Tests (18.x) — In progress
+⏳ Run Tests (20.x) — In progress
+```
+
+**Tests Passed:**
+```
+✅ Run Tests (18.x) — Passed
+✅ Run Tests (20.x) — Passed
+🟢 Merge pull request button is ENABLED
+```
+
+**Tests Failed:**
+```
+❌ Run Tests (18.x) — Failed
+❌ Run Tests (20.x) — Failed
+🔴 Merge pull request button is DISABLED
+```
+
+## Testing the Protection
+
+### Create a Test PR:
+
+1. Create a new branch:
+   ```bash
+   git checkout -b test-branch-protection
+   ```
+
+2. Make a small change:
+   ```bash
+   echo "# Test" >> test-file.txt
+   git add test-file.txt
+   git commit -m "Test branch protection"
+   git push origin test-branch-protection
+   ```
+
+3. Go to GitHub and create a pull request
+
+4. Observe:
+   - Tests run automatically
+   - Merge button is disabled until tests complete
+   - After tests pass, merge button becomes available
+
+## Workflow Behavior
+
+### For Pull Requests:
+- ✅ Runs all 70 tests on Node.js 18.x and 20.x
+- ✅ Must pass before merge is allowed
+- ✅ Shows test summary in PR
+- ❌ Does NOT publish to npm (only tests)
+
+### For Pushes to Main:
+- ✅ Runs all tests
+- ✅ If version changed AND tests pass → publishes to npm
+- ✅ Creates git tag
+- ✅ Shows summary of all actions
+
+## Troubleshooting
+
+### "Status checks not found"
+- The status checks only appear after the first workflow run completes
+- Push this branch protection setup, wait for workflow to run, then configure protection
+
+### "Can't find Run Tests in status checks"
+- Make sure the workflow has run at least once
+- Check the Actions tab to see workflow runs
+- The job name must match exactly: `Run Tests`
+
+### "Tests are running but merge button isn't disabled"
+- You need to enable "Require status checks to pass before merging"
+- Make sure you selected the specific test jobs (18.x and 20.x)
+
+## Quick Setup Checklist
+
+- [ ] Go to Settings → Branches
+- [ ] Add branch protection rule for `main`
+- [ ] Enable "Require status checks to pass before merging"
+- [ ] Select `Run Tests (18.x)` and `Run Tests (20.x)`
+- [ ] Enable "Do not allow bypassing"
+- [ ] Save the rule
+- [ ] Test with a PR
+
+## Additional Security (Optional)
+
+For additional security, you can also enable:
+
+- **Require deployments to succeed** - Wait for tests before deploying
+- **Lock branch** - Temporarily prevent all changes
+- **Restrict who can push** - Only specific users/teams can push
+
+---
+
+**Result:** After setup, no code can be merged to `main` without passing all 70 tests! 🎉

package/CHANGELOG.md

@@ -1,8 +1,8 @@
-PR 2:
-ADDED:
-- Modified the `getAvailableTimeblocks.js` file to change the default value of `uurOpVoorhand` from 4 hours to 0 hours, enabling immediate bookings when the field is not explicitly set in general settings.
-
-REMOVED:
-- No functions, features, or code were removed; only a configuration default value was updated.
-
----
+PR 2:
+ADDED:
+- Modified the `getAvailableTimeblocks.js` file to change the default value of `uurOpVoorhand` from 4 hours to 0 hours, enabling immediate bookings when the field is not explicitly set in general settings.
+
+REMOVED:
+- No functions, features, or code were removed; only a configuration default value was updated.
+
+---

package/README.md

@@ -1,144 +1,144 @@
-# @happychef/algorithm
-
-Restaurant and reservation algorithm utilities for Happy Chef.
-
-[![CI/CD Pipeline](https://github.com/YOUR_USERNAME/YOUR_REPO/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/YOUR_USERNAME/YOUR_REPO/actions/workflows/ci-cd.yml)
-[![codecov](https://codecov.io/gh/YOUR_USERNAME/YOUR_REPO/branch/main/graph/badge.svg)](https://codecov.io/gh/YOUR_USERNAME/YOUR_REPO)
-[![npm version](https://badge.fury.io/js/%40happychef%2Falgorithm.svg)](https://www.npmjs.com/package/@happychef/algorithm)
-
-## Installation
-
-```bash
-npm install @happychef/algorithm
-```
-
-## Features
-
-- **Date & Time Availability**: Check if specific dates and times are available for reservations
-- **Timeblock Management**: Get available timeblocks based on restaurant settings
-- **Table Assignment**: Automatically assign tables to reservations
-- **Smart Filtering**: Filter timeblocks based on max arrivals, max groups, and other constraints
-- **Exception Handling**: Support for restaurant opening hours exceptions and closures
-- **Comprehensive Testing**: 70+ unit tests ensuring reliability
-
-## Usage
-
-```javascript
-const {
-  isDateAvailable,
-  isTimeAvailable,
-  getAvailableTimeblocks,
-  assignTablesIfPossible
-} = require('@happychef/algorithm');
-
-// Check if a date is available
-const available = isDateAvailable(
-  restaurantData,
-  '2025-06-15',
-  reservations,
-  guests
-);
-
-// Get available timeblocks
-const timeblocks = getAvailableTimeblocks(
-  restaurantData,
-  '2025-06-15',
-  reservations,
-  guests
-);
-
-// Check if specific time is available
-const timeAvailable = isTimeAvailable(
-  restaurantData,
-  '2025-06-15',
-  '12:00',
-  reservations,
-  guests
-);
-```
-
-## Development
-
-### Running Tests
-
-```bash
-# Run all tests
-npm test
-
-# Run tests in watch mode
-npm run test:watch
-
-# Run tests with coverage
-npm run test:coverage
-```
-
-### Test Coverage
-
-The package includes comprehensive unit tests covering:
-- Helper functions (parseTime, getMealTypeByTime, etc.)
-- Date and time availability checks
-- Timeblock filtering
-- Restaurant data and exceptions handling
-- Table assignment logic
-- Filter functions (max arrivals, max groups)
-
-All tests are automatically run on every push to the main branch via GitHub Actions.
-
-## CI/CD Pipeline
-
-This package uses GitHub Actions for continuous integration and deployment:
-
-1. **Automated Testing**: Tests run on Node.js 18.x and 20.x
-2. **Coverage Reports**: Automatically uploaded to Codecov
-3. **Automatic Publishing**: When tests pass on main branch and version changes, package is automatically published to npm
-4. **Git Tagging**: Successful releases are automatically tagged
-
-### Setup Instructions
-
-To enable automatic publishing:
-
-1. **Create an NPM Token**:
-   - Go to [npmjs.com](https://www.npmjs.com/)
-   - Navigate to Access Tokens
-   - Generate a new "Automation" token
-   - Copy the token
-
-2. **Add NPM Token to GitHub Secrets**:
-   - Go to your GitHub repository
-   - Navigate to Settings > Secrets and variables > Actions
-   - Click "New repository secret"
-   - Name: `NPM_TOKEN`
-   - Value: Paste your NPM token
-   - Click "Add secret"
-
-3. **Optional: Add Codecov Token** (for coverage reports):
-   - Go to [codecov.io](https://codecov.io/)
-   - Add your repository
-   - Copy the token
-   - Add as `CODECOV_TOKEN` secret in GitHub
-
-4. **Publish New Version**:
-   - Update version in `package.json`
-   - Commit and push to main branch
-   - GitHub Actions will automatically:
-     - Run all tests
-     - Publish to npm if tests pass
-     - Create a git tag for the release
-
-## Contributing
-
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/amazing-feature`)
-3. Write tests for your changes
-4. Ensure all tests pass (`npm test`)
-5. Commit your changes (`git commit -m 'Add some amazing feature'`)
-6. Push to the branch (`git push origin feature/amazing-feature`)
-7. Open a Pull Request
-
-## License
-
-MIT
-
-## Author
-
-Happy Chef
+# @happychef/algorithm
+
+Restaurant and reservation algorithm utilities for Happy Chef.
+
+[![CI/CD Pipeline](https://github.com/YOUR_USERNAME/YOUR_REPO/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/YOUR_USERNAME/YOUR_REPO/actions/workflows/ci-cd.yml)
+[![codecov](https://codecov.io/gh/YOUR_USERNAME/YOUR_REPO/branch/main/graph/badge.svg)](https://codecov.io/gh/YOUR_USERNAME/YOUR_REPO)
+[![npm version](https://badge.fury.io/js/%40happychef%2Falgorithm.svg)](https://www.npmjs.com/package/@happychef/algorithm)
+
+## Installation
+
+```bash
+npm install @happychef/algorithm
+```
+
+## Features
+
+- **Date & Time Availability**: Check if specific dates and times are available for reservations
+- **Timeblock Management**: Get available timeblocks based on restaurant settings
+- **Table Assignment**: Automatically assign tables to reservations
+- **Smart Filtering**: Filter timeblocks based on max arrivals, max groups, and other constraints
+- **Exception Handling**: Support for restaurant opening hours exceptions and closures
+- **Comprehensive Testing**: 70+ unit tests ensuring reliability
+
+## Usage
+
+```javascript
+const {
+  isDateAvailable,
+  isTimeAvailable,
+  getAvailableTimeblocks,
+  assignTablesIfPossible
+} = require('@happychef/algorithm');
+
+// Check if a date is available
+const available = isDateAvailable(
+  restaurantData,
+  '2025-06-15',
+  reservations,
+  guests
+);
+
+// Get available timeblocks
+const timeblocks = getAvailableTimeblocks(
+  restaurantData,
+  '2025-06-15',
+  reservations,
+  guests
+);
+
+// Check if specific time is available
+const timeAvailable = isTimeAvailable(
+  restaurantData,
+  '2025-06-15',
+  '12:00',
+  reservations,
+  guests
+);
+```
+
+## Development
+
+### Running Tests
+
+```bash
+# Run all tests
+npm test
+
+# Run tests in watch mode
+npm run test:watch
+
+# Run tests with coverage
+npm run test:coverage
+```
+
+### Test Coverage
+
+The package includes comprehensive unit tests covering:
+- Helper functions (parseTime, getMealTypeByTime, etc.)
+- Date and time availability checks
+- Timeblock filtering
+- Restaurant data and exceptions handling
+- Table assignment logic
+- Filter functions (max arrivals, max groups)
+
+All tests are automatically run on every push to the main branch via GitHub Actions.
+
+## CI/CD Pipeline
+
+This package uses GitHub Actions for continuous integration and deployment:
+
+1. **Automated Testing**: Tests run on Node.js 18.x and 20.x
+2. **Coverage Reports**: Automatically uploaded to Codecov
+3. **Automatic Publishing**: When tests pass on main branch and version changes, package is automatically published to npm
+4. **Git Tagging**: Successful releases are automatically tagged
+
+### Setup Instructions
+
+To enable automatic publishing:
+
+1. **Create an NPM Token**:
+   - Go to [npmjs.com](https://www.npmjs.com/)
+   - Navigate to Access Tokens
+   - Generate a new "Automation" token
+   - Copy the token
+
+2. **Add NPM Token to GitHub Secrets**:
+   - Go to your GitHub repository
+   - Navigate to Settings > Secrets and variables > Actions
+   - Click "New repository secret"
+   - Name: `NPM_TOKEN`
+   - Value: Paste your NPM token
+   - Click "Add secret"
+
+3. **Optional: Add Codecov Token** (for coverage reports):
+   - Go to [codecov.io](https://codecov.io/)
+   - Add your repository
+   - Copy the token
+   - Add as `CODECOV_TOKEN` secret in GitHub
+
+4. **Publish New Version**:
+   - Update version in `package.json`
+   - Commit and push to main branch
+   - GitHub Actions will automatically:
+     - Run all tests
+     - Publish to npm if tests pass
+     - Create a git tag for the release
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Write tests for your changes
+4. Ensure all tests pass (`npm test`)
+5. Commit your changes (`git commit -m 'Add some amazing feature'`)
+6. Push to the branch (`git push origin feature/amazing-feature`)
+7. Open a Pull Request
+
+## License
+
+MIT
+
+## Author
+
+Happy Chef