@mixpeek/prebid 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,153 @@
+# Changelog
+
+All notable changes to the Mixpeek Context Adapter for Prebid.js 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).
+
+## [1.0.0] - 2025-10-08
+
+### Added
+
+#### Core Features
+- **Mixpeek Context Adapter** for Prebid.js integration
+- Real-time contextual analysis using Mixpeek's multimodal AI engine
+- Support for page, video, and image content extraction
+- Automatic IAB taxonomy classification
+- Brand safety scoring
+- Keyword extraction
+- Sentiment analysis
+
+#### Content Extraction
+- **Page Extractor**: Extracts text, meta tags, Open Graph data, and structured data
+- **Video Extractor**: Extracts video metadata, source URLs, and frame snapshots
+- **Image Extractor**: Extracts primary images with metadata and dimensions
+- Auto-detection mode for optimal content type selection
+
+#### API Integration
+- Full Mixpeek API client with retry logic and timeout handling
+- Support for multiple feature extractors
+- Custom feature extractor configuration
+- Document creation and retrieval
+- Health check endpoint
+
+#### Caching
+- In-memory cache with configurable TTL
+- LocalStorage persistence
+- Automatic cache expiration and pruning
+- Cache statistics and monitoring
+
+#### Targeting
+- Injection of contextual targeting keys into Prebid ad requests
+- Support for both `ortb2Imp` and legacy bid params
+- Comprehensive key-value schema (taxonomy, brand safety, keywords, etc.)
+
+#### Events
+- `mixpeekContextReady` - Context successfully loaded
+- `mixpeekContextError` - Error during enrichment
+- `mixpeekContextCached` - Cached context used
+- `mixpeekApiRequest` - API request initiated
+- `mixpeekApiResponse` - API response received
+
+#### Testing
+- Comprehensive unit test suite
+- Integration tests for end-to-end workflows
+- Test setup with mocked browser environment
+- Coverage for all core modules
+
+#### Documentation
+- Detailed README with quickstart guide
+- Integration guide with step-by-step instructions
+- API reference documentation
+- Example implementation with live demo
+- Postman collection for API testing
+
+#### Examples
+- Publisher demo with contextual ad enrichment
+- Debug panel for real-time monitoring
+- Multiple ad unit configurations
+- Event listener examples
+
+#### Configuration
+- Flexible configuration via `pbjs.setConfig()`
+- Support for API key, collection ID, and namespace
+- Configurable timeout, cache TTL, and retry attempts
+- Debug mode for development
+- Multiple content modes (auto, page, video, image)
+
+### Technical Details
+
+- **Language**: JavaScript (ES6)
+- **Module Format**: UMD (Universal Module Definition)
+- **Browser Support**: Modern browsers with ES6 support
+- **Dependencies**: None (standalone)
+- **Build System**: Webpack
+- **Testing**: Jest
+- **Linting**: ESLint with Standard config
+
+### Performance
+
+- API latency: <250ms (typical)
+- Cache hit latency: <10ms
+- No blocking of ad auction
+- Graceful fallback on errors
+
+### Security
+
+- HTTPS-only API communication
+- Bearer token authentication
+- No PII collection or transmission
+- Content-only analysis
+- Optional namespace isolation
+
+### Compliance
+
+- GDPR compliant (no user tracking)
+- CCPA compliant (contextual only)
+- No cookies or user identifiers
+- Privacy-first targeting
+
+---
+
+## [Unreleased]
+
+### Planned for v1.1.0
+- Server-side adapter for Prebid Server
+- WebSocket support for real-time video scene changes
+- Batched API calls for multi-slot pages
+- Extended video analysis with frame-by-frame processing
+- Custom taxonomy support
+- Analytics dashboard integration
+
+### Planned for v1.2.0
+- Machine learning model caching
+- Edge function deployment support
+- Advanced clustering and similarity matching
+- Multi-language support
+- Enhanced brand safety categories
+
+---
+
+## Release History
+
+- **v1.0.0** (2025-10-08) - Initial release
+
+---
+
+## Upgrade Guide
+
+### From Development to v1.0.0
+
+This is the first stable release. No migration required.
+
+---
+
+## Support
+
+For questions, issues, or feature requests:
+
+- **Documentation**: https://docs.mixpeek.com
+- **GitHub Issues**: https://github.com/mixpeek/prebid-contextual-adapter/issues
+- **Email**: support@mixpeek.com
+- **Slack**: https://mixpeek.com/slack
+

package/ENDPOINTS.md

@@ -0,0 +1,308 @@
+# API Endpoint Configuration
+
+The Mixpeek adapter can work with different API endpoints. This is useful for development, staging, and production environments.
+
+## Available Endpoints
+
+| Environment | URL | Use Case |
+|-------------|-----|----------|
+| **Development** | `https://server-xb24.onrender.com` | Testing and development (default) |
+| **Production** | `https://api.mixpeek.com` | Production deployment |
+| **Local** | `http://localhost:8000` | Local development |
+
+## Quick Configuration
+
+### Method 1: Environment Variable (Recommended)
+
+Set the endpoint before running tests or building:
+
+```bash
+# Use development server (default)
+export MIXPEEK_API_ENDPOINT=https://server-xb24.onrender.com
+
+# Or use production
+export MIXPEEK_API_ENDPOINT=https://api.mixpeek.com
+
+# Or use local server
+export MIXPEEK_API_ENDPOINT=http://localhost:8000
+```
+
+### Method 2: Configuration File
+
+Edit `.mixpeek.config.js`:
+
+```javascript
+module.exports = {
+  // Option 1: Direct URL
+  endpoint: 'https://server-xb24.onrender.com',
+  
+  // Option 2: Use predefined names
+  endpoint: 'development', // or 'production', 'local'
+  
+  // Your credentials
+  apiKey: process.env.MIXPEEK_API_KEY,
+  collectionId: process.env.MIXPEEK_COLLECTION_ID,
+  
+  // Other settings...
+  timeout: 5000,
+  debug: true
+}
+```
+
+### Method 3: Prebid Configuration
+
+Set the endpoint directly in your Prebid setup:
+
+```javascript
+pbjs.setConfig({
+  mixpeek: {
+    apiKey: 'YOUR_API_KEY',
+    collectionId: 'YOUR_COLLECTION_ID',
+    endpoint: 'https://server-xb24.onrender.com', // Development server
+    // endpoint: 'https://api.mixpeek.com', // Production server
+    timeout: 5000,
+    featureExtractors: ['taxonomy']
+  }
+});
+```
+
+### Method 4: Window Global (Browser)
+
+For browser-based configuration:
+
+```html
+<script>
+  // Set before loading the adapter
+  window.MIXPEEK_API_ENDPOINT = 'https://server-xb24.onrender.com';
+</script>
+<script src="mixpeekContextAdapter.js"></script>
+```
+
+## Switching Between Endpoints
+
+### For Development & Testing
+
+```bash
+# Set development endpoint
+export MIXPEEK_API_ENDPOINT=https://server-xb24.onrender.com
+export MIXPEEK_API_KEY=your_dev_key
+
+# Validate setup
+npm run validate
+
+# Run tests
+npm run test:live
+```
+
+### For Production Deployment
+
+```bash
+# Set production endpoint
+export MIXPEEK_API_ENDPOINT=https://api.mixpeek.com
+export MIXPEEK_API_KEY=your_prod_key
+
+# Build
+npm run build
+
+# Test
+npm run test:live
+```
+
+### Quick Switch Script
+
+Create a shell script for easy switching:
+
+```bash
+#!/bin/bash
+# switch-endpoint.sh
+
+case "$1" in
+  dev|development)
+    export MIXPEEK_API_ENDPOINT=https://server-xb24.onrender.com
+    echo "✅ Switched to development: https://server-xb24.onrender.com"
+    ;;
+  prod|production)
+    export MIXPEEK_API_ENDPOINT=https://api.mixpeek.com
+    echo "✅ Switched to production: https://api.mixpeek.com"
+    ;;
+  local)
+    export MIXPEEK_API_ENDPOINT=http://localhost:8000
+    echo "✅ Switched to local: http://localhost:8000"
+    ;;
+  *)
+    echo "Usage: source switch-endpoint.sh [dev|prod|local]"
+    return 1
+    ;;
+esac
+
+# Usage:
+# source switch-endpoint.sh dev
+# npm run test:live
+```
+
+## Environment-Specific Configuration
+
+### Development (.env.development)
+
+```bash
+MIXPEEK_API_ENDPOINT=https://server-xb24.onrender.com
+MIXPEEK_API_KEY=sk_dev_key
+MIXPEEK_COLLECTION_ID=col_dev_collection
+MIXPEEK_NAMESPACE=development
+```
+
+### Production (.env.production)
+
+```bash
+MIXPEEK_API_ENDPOINT=https://api.mixpeek.com
+MIXPEEK_API_KEY=sk_prod_key
+MIXPEEK_COLLECTION_ID=col_prod_collection
+MIXPEEK_NAMESPACE=production
+```
+
+Load with:
+
+```bash
+# Development
+export $(cat .env.development | xargs)
+npm run test:live
+
+# Production
+export $(cat .env.production | xargs)
+npm run build
+```
+
+## Verifying Current Endpoint
+
+Check which endpoint is configured:
+
+```bash
+# Validation script shows current endpoint
+npm run validate
+```
+
+Output will show:
+```
+📋 Configuration Check:
+   API Key: ✅ Set
+   Collection ID: ✅ Set
+   Namespace: ⚠️  Not set (using default)
+   Endpoint: https://server-xb24.onrender.com  👈 Current endpoint
+```
+
+## CI/CD Configuration
+
+### GitHub Actions
+
+```yaml
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test-dev:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Test against dev server
+        env:
+          MIXPEEK_API_ENDPOINT: https://server-xb24.onrender.com
+          MIXPEEK_API_KEY: ${{ secrets.MIXPEEK_DEV_API_KEY }}
+        run: npm run test:live
+
+  test-prod:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - uses: actions/checkout@v3
+      - name: Test against production
+        env:
+          MIXPEEK_API_ENDPOINT: https://api.mixpeek.com
+          MIXPEEK_API_KEY: ${{ secrets.MIXPEEK_PROD_API_KEY }}
+        run: npm run test:live
+```
+
+## Performance Considerations
+
+Different endpoints may have different performance characteristics:
+
+| Endpoint | Typical Latency | Notes |
+|----------|----------------|-------|
+| Development | 500-2000ms | Slower, may cold start |
+| Production | 100-500ms | Optimized, globally distributed |
+| Local | 10-50ms | Fastest, no network latency |
+
+Adjust timeout accordingly:
+
+```javascript
+pbjs.setConfig({
+  mixpeek: {
+    endpoint: 'https://server-xb24.onrender.com',
+    timeout: 5000 // Higher timeout for dev server
+  }
+});
+```
+
+## Troubleshooting
+
+### "Cannot connect to endpoint"
+
+Check if the server is running:
+
+```bash
+curl https://server-xb24.onrender.com/v1/health
+```
+
+Expected response:
+```json
+{
+  "status": "healthy",
+  "version": "0.1.0"
+}
+```
+
+### "Wrong endpoint being used"
+
+Verify environment variable is set:
+
+```bash
+echo $MIXPEEK_API_ENDPOINT
+```
+
+Clear and reset if needed:
+
+```bash
+unset MIXPEEK_API_ENDPOINT
+export MIXPEEK_API_ENDPOINT=https://server-xb24.onrender.com
+```
+
+### "Different results between endpoints"
+
+Development and production may have:
+- Different feature extractor versions
+- Different taxonomy versions
+- Different data/collections
+
+Use the same collection ID across environments when possible.
+
+## Current Default
+
+The adapter currently defaults to the **development server** for testing:
+
+```
+https://server-xb24.onrender.com
+```
+
+This can be changed in:
+- `.env.example` - Default environment file
+- `.mixpeek.config.js` - Configuration file
+- `src/config/constants.js` - Code default
+- `tests/live-api/setup.js` - Test default
+
+## Support
+
+For endpoint-specific issues:
+- **Development server**: Check [https://server-xb24.onrender.com/](https://server-xb24.onrender.com/) status
+- **Production API**: Check [https://status.mixpeek.com](https://status.mixpeek.com)
+- **General help**: support@mixpeek.com
+

package/LICENSE

@@ -0,0 +1,68 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work.
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner.
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2025 Mixpeek
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+