@kkuffour/solid-moderation-plugin 0.2.3 → 0.3.0

package/MIGRATION.md

@@ -1,81 +0,0 @@
-# Migration Guide: Extracting Moderation to External Plugin
-
-## Overview
-
-This guide walks through migrating the moderation feature from CSS core to the standalone `@solid/moderation-plugin` package.
-
-## Steps
-
-### 1. Publish Plugin Package
-
-```bash
-cd mod-package-struct
-npm install
-npm run build
-npm publish --access public
-```
-
-### 2. Update CSS to Use Plugin
-
-In your CSS project:
-
-```bash
-npm install @solid/moderation-plugin
-```
-
-### 3. Update Configuration
-
-Replace `config/file-moderation.json` with:
-
-```json
-{
-  "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^7.0.0/components/context.jsonld",
-  "import": [
-    "css:config/file.json",
-    "@solid/moderation-plugin:config/default.json"
-  ]
-}
-```
-
-### 4. Remove Core Moderation Code
-
-Delete from CSS repository:
-- `src/moderation/` directory
-- `src/http/ldp/ModerationOperationHandler.ts`
-- `src/http/ldp/ModerationMixin.ts`
-- `config/moderation-settings.json`
-- `config/file-moderation.json`
-
-### 5. Update Exports
-
-Remove from `src/index.ts`:
-- ModerationOperationHandler export
-- ModerationConfig export
-- ModerationStore export
-- ModerationMixin export
-
-### 6. Test
-
-```bash
-# Start server with plugin
-npm start -- -c config-with-moderation.json
-
-# Test image upload
-curl -X PUT http://localhost:3000/test.jpg \
-  -H "Content-Type: image/jpeg" \
-  --data-binary @test-image.jpg
-```
-
-## Rollback Plan
-
-If issues occur:
-1. Keep plugin package unpublished
-2. Revert CSS changes
-3. Continue using embedded moderation
-
-## Timeline
-
-- Week 1: Extract and test plugin locally
-- Week 2: Publish plugin to npm
-- Week 3: Update CSS to use plugin
-- Week 4: Remove core moderation code

package/PRODUCTION.md

@@ -1,186 +0,0 @@
-# Production Deployment Guide
-
-## Installation
-
-1. **Install the plugin:**
-   ```bash
-   npm install @solid/moderation-plugin
-   ```
-
-2. **Create config file** in your CSS project (e.g., `config-with-moderation.json`):
-   ```json
-   {
-     "@context": [
-       "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^7.0.0/components/context.jsonld",
-       "https://linkedsoftwaredependencies.org/bundles/npm/@solid/moderation-plugin/^1.0.0/components/context.jsonld"
-     ],
-     "import": [
-       "css:config/file.json",
-       "@solid/moderation-plugin:config/default.json"
-     ]
-   }
-   ```
-
-3. **Set environment variables** (choose one method):
-
-## Environment Variable Setup
-
-### Option 1: Shell Profile (Simple)
-Add to `~/.bashrc` or `~/.zshrc`:
-```bash
-export SIGHTENGINE_API_USER=your_api_user
-export SIGHTENGINE_API_SECRET=your_api_secret
-```
-
-### Option 2: Systemd Service (Recommended for Production)
-Create `/etc/systemd/system/solid-server.service`:
-```ini
-[Unit]
-Description=Community Solid Server with Moderation
-After=network.target
-
-[Service]
-Type=simple
-User=solid
-WorkingDirectory=/opt/solid-server
-Environment="SIGHTENGINE_API_USER=your_api_user"
-Environment="SIGHTENGINE_API_SECRET=your_api_secret"
-ExecStart=/usr/bin/npx @solid/community-server -c config-with-moderation.json
-Restart=always
-
-[Install]
-WantedBy=multi-user.target
-```
-
-Enable and start:
-```bash
-sudo systemctl enable solid-server
-sudo systemctl start solid-server
-```
-
-### Option 3: Docker
-Create `docker-compose.yml`:
-```yaml
-version: '3'
-services:
-  solid-server:
-    image: node:20
-    working_dir: /app
-    volumes:
-      - ./:/app
-    environment:
-      - SIGHTENGINE_API_USER=your_api_user
-      - SIGHTENGINE_API_SECRET=your_api_secret
-    command: npx @solid/community-server -c config-with-moderation.json
-    ports:
-      - "3000:3000"
-```
-
-Run:
-```bash
-docker-compose up -d
-```
-
-### Option 4: PM2 Process Manager
-Create `ecosystem.config.js`:
-```javascript
-module.exports = {
-  apps: [{
-    name: 'solid-server',
-    script: 'npx',
-    args: '@solid/community-server -c config-with-moderation.json',
-    env: {
-      SIGHTENGINE_API_USER: 'your_api_user',
-      SIGHTENGINE_API_SECRET: 'your_api_secret'
-    }
-  }]
-};
-```
-
-Run:
-```bash
-pm2 start ecosystem.config.js
-pm2 save
-pm2 startup
-```
-
-## How It Works in Production
-
-### Local Testing vs Production
-
-| Aspect | Local Testing | Production |
-|--------|--------------|------------|
-| Plugin Location | `/Users/opendata/solid-moderation` (source) | `node_modules/@solid/moderation-plugin` (npm) |
-| Installation | `npm link` | `npm install @solid/moderation-plugin` |
-| Config Import | Full path to local file | `@solid/moderation-plugin:config/default.json` |
-| Components | Loaded from local `dist/` | Loaded from `node_modules/@solid/moderation-plugin/dist/` |
-
-### What Happens When CSS Starts
-
-1. **CSS reads your config file**
-2. **Sees import:** `@solid/moderation-plugin:config/default.json`
-3. **Resolves to:** `node_modules/@solid/moderation-plugin/config/default.json`
-4. **Loads components from:** `node_modules/@solid/moderation-plugin/dist/components/`
-5. **Instantiates:** ModerationOperationHandler wrapping PUT/POST/PATCH
-6. **Reads env vars:** `${SIGHTENGINE_API_USER}` → actual value
-7. **Server starts** with moderation active
-
-### File Locations in Production
-
-```
-your-css-project/
-├── node_modules/
-│   └── @solid/
-│       └── moderation-plugin/          ← Installed here
-│           ├── dist/
-│           │   ├── components/
-│           │   ├── *.js
-│           │   └── *.jsonld
-│           ├── config/
-│           │   └── default.json        ← Imported by your config
-│           └── package.json
-│
-├── config-with-moderation.json         ← Your config file
-├── data/
-│   └── moderation-logs/                ← Runtime logs
-└── package.json
-```
-
-## Customizing Thresholds in Production
-
-Override specific settings in your config:
-```json
-{
-  "import": [
-    "css:config/file.json",
-    "@solid/moderation-plugin:config/default.json"
-  ],
-  "@graph": [
-    {
-      "@id": "urn:solid-moderation:default:Config",
-      "ModerationConfig:_images_thresholds": {
-        "ModerationConfig:_images_thresholds_nudity": 0.3
-      }
-    }
-  ]
-}
-```
-
-## Monitoring
-
-Check logs:
-```bash
-# Systemd
-sudo journalctl -u solid-server -f
-
-# PM2
-pm2 logs solid-server
-
-# Docker
-docker-compose logs -f
-```
-
-View moderation violations:
-```bash
-cat data/moderation-logs/$(date +%Y-%m-%d).jsonl
-```

package/PUBLISHING.md

@@ -1,104 +0,0 @@
-# Publishing Guide
-
-## Before Publishing
-
-Replace `@kkuffour` with your actual npm username/organization in these files:
-- `package.json` (name, lsd:module, lsd:contexts)
-- `components/context.jsonld` (smp prefix)
-- `components/components.jsonld` (@context, @id, requireName)
-- `config-with-moderation.json` (@context)
-
-## Steps to Publish
-
-### 1. Login to npm
-```bash
-npm login
-```
-
-### 2. Build the package
-```bash
-cd /Users/opendata/solid-moderation
-npm run build
-```
-
-### 3. Test locally first (optional)
-```bash
-npm pack
-# This creates a .tgz file you can test with
-```
-
-### 4. Publish to npm
-```bash
-# For scoped package (recommended for testing)
-npm publish --access public
-
-# Or for private testing
-npm publish --access restricted
-```
-
-### 5. Install in CSS
-```bash
-cd /Users/opendata/CommunitySolidServer
-npm install @kkuffour/solid-moderation-plugin@latest
-```
-
-### 6. Update config reference
-The config file path stays the same:
-```bash
-npm start -- -c /Users/opendata/solid-moderation/config-with-moderation.json -f data/ -p 3009 -l debug
-```
-
-## Version Updates
-
-After making changes:
-```bash
-# Update version
-npm version patch  # 0.1.0 -> 0.1.1
-# or
-npm version minor  # 0.1.0 -> 0.2.0
-
-# Rebuild and republish
-npm run build
-npm publish
-```
-
-## Moving to @solid Namespace
-
-Once tested and ready for official release:
-
-1. Request access to @solid npm organization
-2. Update all references from `@kkuffour/solid-moderation-plugin` to `@solid/moderation-plugin`
-3. Update version to `1.0.0`
-4. Publish to @solid namespace
-
-## Troubleshooting
-
-**If publish fails with 403:**
-- Check you're logged in: `npm whoami`
-- Verify package name is available: `npm view @kkuffour/solid-moderation-plugin`
-- Ensure `--access public` for scoped packages
-
-**If Components.js can't find module after install:**
-- Verify `lsd:module`, `lsd:components`, and `lsd:contexts` paths in package.json
-- Check that `components/` directory exists with `.jsonld` files
-- Rebuild: `npm run build`
-
-## Current Configuration
-
-**Package Name**: `@kkuffour/solid-moderation-plugin`
-**Version**: `0.1.0`
-**Entry Point**: `dist/index.js`
-**Components**: `components/components.jsonld`
-**Context**: `components/context.jsonld`
-
-**Environment Variables Required**:
-```bash
-export SIGHTENGINE_API_USER="1060049443"
-export SIGHTENGINE_API_SECRET="QRQ8HUmh4hyvhZjksBJq5ZaNYPLPEKXu"
-```
-
-**Thresholds** (configurable in config-with-moderation.json):
-- Image Nudity: 0.1 (10%)
-- Text Sexual: 0.1 (10%)
-- Text Toxic: 0.1 (10%)
-- Video Nudity: 0.1 (10%)

package/TESTING.md

@@ -1,93 +0,0 @@
-# Testing ResourceStore Approach Locally
-
-## Setup
-
-1. Build the plugin:
-```bash
-npm run build
-```
-
-2. Link locally for testing:
-```bash
-npm link
-```
-
-3. In your CSS directory:
-```bash
-npm link @kkuffour/solid-moderation-plugin
-```
-
-4. Set environment variables:
-```bash
-export SIGHTENGINE_API_USER=1060049443
-export SIGHTENGINE_API_SECRET=QRQ8HUmh4hyvhZjksBJq5ZaNYPLPEKXu
-```
-
-5. Create test config in CSS directory (`config-moderation-test.json`):
-```json
-{
-  "@context": [
-    "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^7.0.0/components/context.jsonld",
-    "https://linkedsoftwaredependencies.org/bundles/npm/@kkuffour/solid-moderation-plugin/^0.2.0/components/context.jsonld"
-  ],
-  "import": [
-    "css:config/file.json"
-  ],
-  "@graph": [
-    {
-      "@id": "urn:solid-moderation:SightEngineProvider",
-      "@type": "ksmp:dist/providers/SightEngineProvider.jsonld#SightEngineProvider",
-      "ksmp:dist/providers/SightEngineProvider.jsonld#SightEngineProvider_apiUser": "1060049443",
-      "ksmp:dist/providers/SightEngineProvider.jsonld#SightEngineProvider_apiSecret": "QRQ8HUmh4hyvhZjksBJq5ZaNYPLPEKXu"
-    },
-    {
-      "@id": "urn:solid-server:default:ResourceStore_Original",
-      "@type": "DataAccessorBasedStore",
-      "identifierStrategy": { "@id": "urn:solid-server:default:IdentifierStrategy" },
-      "auxiliaryStrategy": { "@id": "urn:solid-server:default:AuxiliaryStrategy" },
-      "accessor": { "@id": "urn:solid-server:default:DataAccessor" },
-      "metadataStrategy": { "@id": "urn:solid-server:default:MetadataStrategy" }
-    },
-    {
-      "@id": "urn:solid-server:default:ResourceStore",
-      "@type": "ksmp:dist/ModerationResourceStore.jsonld#ModerationResourceStore",
-      "ksmp:dist/ModerationResourceStore.jsonld#ModerationResourceStore_source": { 
-        "@id": "urn:solid-server:default:ResourceStore_Original" 
-      },
-      "ksmp:dist/ModerationResourceStore.jsonld#ModerationResourceStore_client": { 
-        "@id": "urn:solid-moderation:SightEngineProvider" 
-      },
-      "ksmp:dist/ModerationResourceStore.jsonld#ModerationResourceStore_enabled": true,
-      "ksmp:dist/ModerationResourceStore.jsonld#ModerationResourceStore_imageNudityThreshold": 0.1,
-      "ksmp:dist/ModerationResourceStore.jsonld#ModerationResourceStore_textSexualThreshold": 0.1,
-      "ksmp:dist/ModerationResourceStore.jsonld#ModerationResourceStore_textToxicThreshold": 0.1,
-      "ksmp:dist/ModerationResourceStore.jsonld#ModerationResourceStore_videoNudityThreshold": 0.1
-    }
-  ]
-}
-```
-
-6. Start CSS:
-```bash
-npx @solid/community-server -c config-moderation-test.json
-```
-
-## Expected Behavior
-
-- Server should start without errors
-- Log should show: "ModerationResourceStore initialized"
-- Uploading images/videos/text should trigger moderation
-- Content exceeding thresholds should be blocked with 403 Forbidden
-
-## Testing
-
-Upload a test image:
-```bash
-curl -X PUT http://localhost:3000/test.jpg \
-  -H "Content-Type: image/jpeg" \
-  --data-binary @test-image.jpg
-```
-
-Check logs for:
-- "Moderating image/jpeg upload to /test.jpg"
-- "Image APPROVED" or "Image BLOCKED"