bluera-knowledge 0.13.3 → 0.14.1

package/tests/fixtures/documentation/deployment-guide.md

@@ -1,420 +0,0 @@
-# Deployment Guide
-
-## Overview
-
-This guide covers deployment procedures for the application across different environments, including local development, staging, and production.
-
-## Prerequisites
-
-### System Requirements
-
-- Node.js 18.x or higher
-- npm 9.x or higher
-- SQLite 3.x (for local storage)
-- 2GB RAM minimum (4GB recommended)
-- 10GB disk space
-
-### Environment Variables
-
-Create a `.env` file with the following variables:
-
-```bash
-# Application
-NODE_ENV=production
-PORT=3000
-LOG_LEVEL=info
-
-# Authentication
-JWT_SECRET=your-secure-jwt-secret-key
-REFRESH_SECRET=your-secure-refresh-secret-key
-ACCESS_TOKEN_EXPIRY=15m
-REFRESH_TOKEN_EXPIRY=7d
-
-# Database
-DATABASE_URL=file:./data/knowledge.db
-
-# Embedding Service
-EMBEDDING_MODEL=text-embedding-3-small
-EMBEDDING_DIMENSIONS=1536
-
-# Rate Limiting
-RATE_LIMIT_WINDOW=60000
-RATE_LIMIT_MAX=100
-```
-
-## Local Development
-
-### Quick Start
-
-```bash
-# Clone the repository
-git clone https://github.com/example/knowledge-store.git
-cd knowledge-store
-
-# Install dependencies
-npm install
-
-# Build the application
-npm run build
-
-# Run in development mode
-npm run dev
-```
-
-### Development Server
-
-The development server includes hot reloading:
-
-```bash
-npm run dev
-```
-
-Access the application at `http://localhost:3000`.
-
-### Running Tests
-
-```bash
-# Run all tests
-npm test
-
-# Run with coverage
-npm run test:coverage
-
-# Run specific test file
-npm test -- tests/integration/search.test.ts
-```
-
-## Docker Deployment
-
-### Building the Image
-
-```dockerfile
-# Dockerfile
-FROM node:18-alpine AS builder
-WORKDIR /app
-COPY package*.json ./
-RUN npm ci
-COPY . .
-RUN npm run build
-
-FROM node:18-alpine
-WORKDIR /app
-COPY --from=builder /app/dist ./dist
-COPY --from=builder /app/node_modules ./node_modules
-COPY package*.json ./
-EXPOSE 3000
-CMD ["node", "dist/index.js", "serve"]
-```
-
-Build the Docker image:
-
-```bash
-docker build -t knowledge-store:latest .
-```
-
-### Running with Docker
-
-```bash
-# Run container
-docker run -d \
-  --name knowledge-store \
-  -p 3000:3000 \
-  -v $(pwd)/data:/app/data \
-  -e JWT_SECRET=your-secret \
-  knowledge-store:latest
-```
-
-### Docker Compose
-
-```yaml
-# docker-compose.yml
-version: '3.8'
-services:
-  knowledge-store:
-    build: .
-    ports:
-      - "3000:3000"
-    volumes:
-      - ./data:/app/data
-    environment:
-      - NODE_ENV=production
-      - JWT_SECRET=${JWT_SECRET}
-    restart: unless-stopped
-    healthcheck:
-      test: ["CMD", "curl", "-f", "http://localhost:3000/health"]
-      interval: 30s
-      timeout: 10s
-      retries: 3
-```
-
-## Production Deployment
-
-### Pre-deployment Checklist
-
-- [ ] Environment variables configured
-- [ ] Secrets stored securely
-- [ ] Database backups configured
-- [ ] Monitoring and alerting set up
-- [ ] SSL certificates installed
-- [ ] Rate limiting configured
-- [ ] CORS policy defined
-
-### Cloud Deployment Options
-
-#### AWS Deployment
-
-**Using AWS ECS:**
-
-1. Create ECR repository
-2. Push Docker image to ECR
-3. Create ECS cluster
-4. Define task definition
-5. Create service with load balancer
-
-```bash
-# Push to ECR
-aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin $ECR_REPO
-docker tag knowledge-store:latest $ECR_REPO/knowledge-store:latest
-docker push $ECR_REPO/knowledge-store:latest
-```
-
-**Using AWS Lambda:**
-
-```yaml
-# serverless.yml
-service: knowledge-store
-provider:
-  name: aws
-  runtime: nodejs18.x
-  region: us-east-1
-functions:
-  api:
-    handler: dist/lambda.handler
-    events:
-      - http:
-          path: /{proxy+}
-          method: any
-```
-
-#### Google Cloud Platform
-
-**Using Cloud Run:**
-
-```bash
-# Deploy to Cloud Run
-gcloud run deploy knowledge-store \
-  --image gcr.io/$PROJECT_ID/knowledge-store \
-  --platform managed \
-  --region us-central1 \
-  --allow-unauthenticated
-```
-
-#### Kubernetes
-
-```yaml
-# kubernetes/deployment.yaml
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: knowledge-store
-spec:
-  replicas: 3
-  selector:
-    matchLabels:
-      app: knowledge-store
-  template:
-    metadata:
-      labels:
-        app: knowledge-store
-    spec:
-      containers:
-      - name: knowledge-store
-        image: knowledge-store:latest
-        ports:
-        - containerPort: 3000
-        env:
-        - name: JWT_SECRET
-          valueFrom:
-            secretKeyRef:
-              name: app-secrets
-              key: jwt-secret
-        resources:
-          requests:
-            memory: "256Mi"
-            cpu: "250m"
-          limits:
-            memory: "512Mi"
-            cpu: "500m"
-        livenessProbe:
-          httpGet:
-            path: /health
-            port: 3000
-          initialDelaySeconds: 10
-          periodSeconds: 30
-        readinessProbe:
-          httpGet:
-            path: /health
-            port: 3000
-          initialDelaySeconds: 5
-          periodSeconds: 10
----
-apiVersion: v1
-kind: Service
-metadata:
-  name: knowledge-store
-spec:
-  selector:
-    app: knowledge-store
-  ports:
-  - port: 80
-    targetPort: 3000
-  type: LoadBalancer
-```
-
-## Database Management
-
-### Migrations
-
-```bash
-# Run pending migrations
-npm run migrate
-
-# Rollback last migration
-npm run migrate:rollback
-
-# Create new migration
-npm run migrate:create -- add_user_preferences
-```
-
-### Backups
-
-```bash
-# Create backup
-sqlite3 data/knowledge.db ".backup 'backup-$(date +%Y%m%d).db'"
-
-# Restore from backup
-sqlite3 data/knowledge.db ".restore 'backup-20240115.db'"
-```
-
-### Performance Optimization
-
-```sql
--- Create indexes for common queries
-CREATE INDEX idx_documents_created_at ON documents(created_at);
-CREATE INDEX idx_chunks_document_id ON chunks(document_id);
-
--- Analyze tables for query optimization
-ANALYZE documents;
-ANALYZE chunks;
-```
-
-## Monitoring
-
-### Health Checks
-
-The `/health` endpoint provides system status:
-
-```json
-{
-  "status": "healthy",
-  "version": "1.0.0",
-  "uptime": 86400,
-  "checks": {
-    "database": "ok",
-    "vectorStore": "ok",
-    "memory": "ok"
-  }
-}
-```
-
-### Logging
-
-Configure log aggregation:
-
-```javascript
-// Winston configuration
-const logger = winston.createLogger({
-  level: process.env.LOG_LEVEL || 'info',
-  format: winston.format.combine(
-    winston.format.timestamp(),
-    winston.format.json()
-  ),
-  transports: [
-    new winston.transports.Console(),
-    new winston.transports.File({ filename: 'logs/error.log', level: 'error' }),
-    new winston.transports.File({ filename: 'logs/combined.log' })
-  ]
-});
-```
-
-### Metrics
-
-Export Prometheus metrics:
-
-```bash
-# prometheus.yml
-scrape_configs:
-  - job_name: 'knowledge-store'
-    static_configs:
-      - targets: ['localhost:3000']
-    metrics_path: '/metrics'
-```
-
-## Troubleshooting
-
-### Common Issues
-
-**Issue: High memory usage**
-- Solution: Increase Node.js heap size with `--max-old-space-size=4096`
-- Check for memory leaks in long-running processes
-
-**Issue: Slow search queries**
-- Solution: Ensure vector indexes are optimized
-- Check FTS index fragmentation
-- Consider increasing result cache TTL
-
-**Issue: Connection timeouts**
-- Solution: Adjust connection pool settings
-- Check network latency
-- Verify firewall rules
-
-### Debug Mode
-
-Enable verbose logging for debugging:
-
-```bash
-DEBUG=knowledge:* npm start
-```
-
-## Security Hardening
-
-### Production Security Checklist
-
-- [ ] Use HTTPS only (redirect HTTP)
-- [ ] Enable security headers (Helmet.js)
-- [ ] Configure CORS properly
-- [ ] Enable rate limiting
-- [ ] Sanitize user inputs
-- [ ] Keep dependencies updated
-- [ ] Use secure session configuration
-- [ ] Implement request size limits
-
-### Security Headers
-
-```javascript
-app.use(helmet({
-  contentSecurityPolicy: {
-    directives: {
-      defaultSrc: ["'self'"],
-      styleSrc: ["'self'", "'unsafe-inline'"],
-      scriptSrc: ["'self'"],
-      imgSrc: ["'self'", "data:", "https:"]
-    }
-  },
-  hsts: {
-    maxAge: 31536000,
-    includeSubDomains: true,
-    preload: true
-  }
-}));
-```

package/tests/fixtures/github-readmes/express.md

@@ -1,133 +0,0 @@
-# Express
-
-Fast, unopinionated, minimalist web framework for [Node.js](http://nodejs.org).
-
-[![NPM Version][npm-version-image]][npm-url]
-[![NPM Install Size][npm-install-size-image]][npm-install-size-url]
-[![NPM Downloads][npm-downloads-image]][npm-downloads-url]
-
-## Installation
-
-This is a [Node.js](https://nodejs.org/en/) module available through the
-[npm registry](https://www.npmjs.com/).
-
-Before installing, [download and install Node.js](https://nodejs.org/en/download/).
-Node.js 18 or higher is required.
-
-Installation is done using the
-[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
-
-```bash
-npm install express
-```
-
-## Features
-
-  * Robust routing
-  * Focus on high performance
-  * Super-high test coverage
-  * HTTP helpers (redirection, caching, etc)
-  * View system supporting 14+ template engines
-  * Content negotiation
-  * Executable for generating applications quickly
-
-## Quick Start
-
-The quickest way to get started with express is to utilize the executable [`express-generator`](https://github.com/expressjs/generator) to generate an application as shown below:
-
-Install the executable. The executable's major version will match Express's:
-
-```bash
-npm install -g express-generator@4
-```
-
-Create the app:
-
-```bash
-express /tmp/foo && cd /tmp/foo
-```
-
-Install dependencies:
-
-```bash
-npm install
-```
-
-Start the server:
-
-```bash
-npm start
-```
-
-View the website at: http://localhost:3000
-
-## Quick Example
-
-Here is a basic example of an Express server:
-
-```js
-const express = require('express')
-const app = express()
-
-app.get('/', function (req, res) {
-  res.send('Hello World')
-})
-
-app.listen(3000)
-```
-
-## Philosophy
-
-The Express philosophy is to provide small, robust tooling for HTTP servers, making
-it a great solution for single page applications, web sites, hybrids, or public
-HTTP APIs.
-
-Express does not force you to use any specific ORM or template engine. With support for over
-14 template engines via [Consolidate.js](https://github.com/tj/consolidate.js),
-you can quickly craft your perfect framework.
-
-## Documentation
-
-  * [express.com](https://expressjs.com/)
-  * [API Reference](https://expressjs.com/en/4x/api.html)
-
-## Getting Started Guide
-
-  * [Hello World](https://expressjs.com/en/starter/hello-world.html)
-  * [Express Generator](https://expressjs.com/en/starter/generator.html)
-  * [Basic routing](https://expressjs.com/en/starter/basic-routing.html)
-  * [Static files](https://expressjs.com/en/starter/static-files.html)
-
-## Middleware
-
-Express is a routing and middleware web framework that has minimal functionality of its own: An Express application is essentially a series of middleware function calls.
-
-Middleware functions are functions that have access to the request object (req), the response object (res), and the next middleware function in the application's request-response cycle. The next middleware function is commonly denoted by a variable named next.
-
-```js
-const express = require('express')
-const app = express()
-
-const myLogger = function (req, res, next) {
-  console.log('LOGGED')
-  next()
-}
-
-app.use(myLogger)
-
-app.get('/', function (req, res) {
-  res.send('Hello World!')
-})
-
-app.listen(3000)
-```
-
-## People
-
-The original author of Express is [TJ Holowaychuk](https://github.com/tj)
-
-The current lead maintainer is [Douglas Christopher Wilson](https://github.com/dougwilson)
-
-## License
-
-  [MIT](LICENSE)

package/tests/fixtures/github-readmes/nextjs.md

@@ -1,106 +0,0 @@
-# Next.js
-
-The React Framework for the Web
-
-Used by some of the world's largest companies, Next.js enables you to create high-quality web applications with the power of React components.
-
-## Getting Started
-
-Visit [nextjs.org/learn](https://nextjs.org/learn) to get started with Next.js.
-
-## Documentation
-
-Visit [nextjs.org/docs](https://nextjs.org/docs) to view the full documentation.
-
-## Features
-
-- **Built-in Optimizations**: Automatic Image, Font, and Script Optimizations for improved UX and Core Web Vitals.
-- **Dynamic HTML Streaming**: Instantly stream UI from the server, integrated with the App Router and React Suspense.
-- **React Server Components**: Add components without sending additional client-side JavaScript. Built on the latest React features.
-- **Data Fetching**: Make your React component async and await your data. Next.js supports both server and client data fetching.
-- **CSS Support**: Style your application with your favorite tools, including support for CSS Modules, Tailwind CSS, and popular community libraries.
-- **Client and Server Rendering**: Flexible rendering and caching options, including Incremental Static Regeneration (ISR), on a per-page level.
-- **Server Actions**: Run server code by calling a function. Skip the API. Then, easily revalidate cached data and update your UI in one network roundtrip.
-- **Route Handlers**: Build API endpoints to securely connect with third-party services for handling auth or listening for webhooks.
-- **Advanced Routing & Nested Layouts**: Create routes using the file system, including support for more advanced routing patterns and UI layouts.
-- **Middleware**: Take control of the incoming request. Use code to define routing and access rules for authentication, experimentation, and internationalization.
-
-## Quick Start
-
-We recommend creating a new Next.js app using `create-next-app`, which sets up everything automatically for you:
-
-```bash
-npx create-next-app@latest
-```
-
-For more information on what to do next, see the [Getting Started](https://nextjs.org/docs/getting-started) documentation.
-
-## File Structure
-
-Next.js uses file-system based routing, which means you can use folders to define routes:
-
-```
-app/
-├── layout.tsx       // Root layout (required)
-├── page.tsx         // Home page (/)
-├── about/
-│   └── page.tsx     // About page (/about)
-├── blog/
-│   ├── page.tsx     // Blog index (/blog)
-│   └── [slug]/
-│       └── page.tsx // Blog post (/blog/my-post)
-└── api/
-    └── route.ts     // API route (/api)
-```
-
-## Server Components
-
-React Server Components allow you to write UI that can be rendered and optionally cached on the server:
-
-```tsx
-// This component runs on the server
-async function getData() {
-  const res = await fetch('https://api.example.com/...')
-  return res.json()
-}
-
-export default async function Page() {
-  const data = await getData()
-
-  return <main>{data.title}</main>
-}
-```
-
-## Client Components
-
-Client Components allow you to add client-side interactivity to your application:
-
-```tsx
-'use client'
-
-import { useState } from 'react'
-
-export function Counter() {
-  const [count, setCount] = useState(0)
-
-  return (
-    <button onClick={() => setCount(count + 1)}>
-      Count: {count}
-    </button>
-  )
-}
-```
-
-## Community
-
-The Next.js community can be found on [GitHub Discussions](https://github.com/vercel/next.js/discussions) where you can ask questions, voice ideas, and share your projects with other people.
-
-To chat with other community members you can join the Next.js [Discord](https://discord.com/invite/bUG2bvbtHy) server.
-
-## Contributing
-
-Contributions to Next.js are welcome and encouraged! Please see the [contributing.md](./contributing.md) for more information on how to get started.
-
-## License
-
-Next.js is [MIT licensed](./LICENSE).