@sockethub/data-layer 1.0.0-alpha.6 → 1.0.0-alpha.7

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sockethub/data-layer",
   "description": "Storing and RPC of data for Sockethub",
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.0-alpha.7",
   "type": "module",
   "private": false,
   "author": "Nick Jennings <nick@silverbucket.net>",
@@ -9,7 +9,18 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "src/index.ts",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "bun": "./src/index.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "src/",
+    "dist/"
+  ],
   "engines": {
     "bun": ">=1.2"
   },
@@ -28,23 +39,25 @@
   },
   "homepage": "https://github.com/sockethub/sockethub/tree/master/packages/data-layer",
   "scripts": {
+    "build": "bun build src/index.ts --outdir dist --target node --format esm --sourcemap=external",
+    "clean": "rm -rf dist",
     "doc": "typedoc --options typedoc.json"
   },
   "dependencies": {
-    "@sockethub/crypto": "1.0.0-alpha.6",
-    "@sockethub/schemas": "3.0.0-alpha.6",
-    "bullmq": "5.66.4",
-    "debug": "4.3.4",
-    "ioredis": "5.3.2",
-    "secure-store-redis": "3.0.7"
+    "@sockethub/crypto": "^1.0.0-alpha.7",
+    "@sockethub/schemas": "^3.0.0-alpha.7",
+    "bullmq": "^5.66.5",
+    "debug": "^4.4.3",
+    "ioredis": "^5.9.2",
+    "secure-store-redis": "^3.0.7"
   },
   "devDependencies": {
     "@types/bun": "latest",
-    "@types/debug": "4.1.12",
-    "@types/sinon": "17.0.2",
-    "sinon": "17.0.1",
-    "typedoc": "^0.28.14",
+    "@types/debug": "^4.1.12",
+    "@types/sinon": "^17.0.4",
+    "sinon": "^17.0.2",
+    "typedoc": "^0.28.16",
     "typedoc-plugin-markdown": "^4.9.0"
   },
-  "gitHead": "f8a937e071e7a209f94b94f63e68faa27784e00e"
+  "gitHead": "38927776c210a22bc54ceb86ccc7276c5f27b463"
 }

package/API.md

@@ -1,23 +0,0 @@
-# API Documentation
-
-This package provides the data layer for Sockethub, including job queue management and secure credential storage.
-
-## Main Classes
-
-### JobQueue
-Redis-backed job queue for managing ActivityStreams message processing. Creates isolated queues per platform instance and session, providing reliable message delivery and processing coordination between Sockethub server and platform workers.
-
-### JobWorker  
-Worker for processing jobs from a Redis queue within platform child processes. Connects to the same queue as its corresponding JobQueue instance and processes jobs using a platform-specific handler function.
-
-### CredentialsStore
-Secure, encrypted storage for user credentials with session-based isolation. Provides automatic encryption/decryption of credential objects stored in Redis, ensuring that sensitive authentication data is never stored in plaintext.
-
-## Complete API Reference
-
-For detailed API documentation including method signatures, parameters, and examples, see the [generated TypeDoc documentation](./docs/index.html).
-
-## Related Documentation
-
-- [Queue Architecture](./QUEUE.md) - Conceptual overview of the queueing system
-- [Main Sockethub Documentation](https://github.com/sockethub/sockethub)

package/QUEUE.md

@@ -1,130 +0,0 @@
-# Sockethub Queue System
-
-The queue system is Sockethub's core infrastructure that enables reliable, scalable
-communication between web clients and protocol platforms.
-
-## Why a Queue System?
-
-Web applications need to communicate with network protocols (IRC, XMPP, RSS) that:
-
-- Have slow or unreliable connections
-- Require persistent state that browsers can't maintain  
-- Need to operate across multiple concurrent user sessions
-
-The queue system solves this by:
-
-- **Decoupling** web clients from protocol complexity
-- **Ensuring reliability** through message persistence
-- **Enabling concurrency** via process isolation
-- **Maintaining security** through encrypted message handling
-
-## Architecture Overview
-
-```
-┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
-│   Web Clients   │    │  Sockethub      │    │   Protocol      │
-│                 │    │  Queue System   │    │   Platforms     │
-│ • Browser Apps  │◄──►│                 │◄──►│                 │
-│ • Mobile Apps   │    │ • Job Queues    │    │ • IRC Client    │
-│ • Desktop Apps  │    │ • Message       │    │ • XMPP Client   │
-│ • APIs          │    │   Routing       │    │ • RSS Parser    │
-│                 │    │ • Session Mgmt  │    │ • Metadata      │
-└─────────────────┘    └─────────────────┘    └─────────────────┘
-```
-
-## Message Flow
-
-### 1. Web Request → Queue
-
-```
-Web App → Socket.IO → Sockethub Server → Redis Queue
-```
-
-- Client sends ActivityStreams message
-- Server validates and queues the request
-- Client gets immediate acknowledgment
-
-### 2. Queue → Platform Processing  
-
-```
-Redis Queue → Platform Worker → External Protocol → Response
-```
-
-- Platform worker picks up job
-- Processes protocol-specific logic in isolation
-- Connects to external services (IRC, XMPP, etc.)
-
-### 3. Response → Client
-
-```
-Platform Result → Queue Event → Sockethub Server → Socket.IO → Web App
-```
-
-- Results flow back through the queue
-- Real-time updates delivered via Socket.IO
-- Clients receive responses and ongoing events
-
-## Key Design Principles
-
-**Process Isolation**: Each protocol runs in its own child process
-
-- Crashed platforms don't affect others
-- Memory leaks and resource issues are contained
-- Different platforms can use different dependencies
-
-**Session-Based Queues**: Each client gets dedicated queue infrastructure  
-
-- Complete privacy between users
-- Natural load distribution
-- Session-specific configurations possible
-
-**Message Durability**: All messages persist until processed
-
-- Server restarts don't lose messages
-- Failed operations can be retried
-- Audit trail for debugging
-
-## Real-World Example
-
-A chat application connecting to both IRC and XMPP:
-
-```
-User message → Queue → [IRC Platform] + [XMPP Platform]
-                          ↓               ↓
-                     IRC Network    XMPP Network
-```
-
-**Benefits:**
-
-- Both protocols process concurrently
-- Slow IRC doesn't block XMPP messages  
-- Platform crashes only affect that protocol
-- Independent delivery confirmations
-
-## Operational Characteristics
-
-**Reliability**: Messages are never lost, even during:
-
-- Server restarts
-- Platform process crashes  
-- Temporary network failures
-- Redis downtime
-
-**Scalability**: Natural horizontal scaling:
-
-- Multiple server instances share Redis
-- Per-session queue isolation
-- No coordination between servers required
-
-**Performance**: Asynchronous design provides:
-
-- Immediate web request responses
-- Concurrent protocol processing
-- Efficient resource utilization
-
-## Related Documentation
-
-- [Data Layer Package README](README.md) - Package overview and usage
-- [Main Sockethub README](../../README.md) - Overall project documentation
-- [BullMQ Documentation](https://bullmq.io/) - Underlying queue library
-- [ActivityStreams Specification](https://www.w3.org/TR/activitystreams-core/) - Message format standard

package/typedoc.json

@@ -1,11 +0,0 @@
-{
-  "entryPoints": ["./src/index.ts"],
-  "out": "./docs",
-  "readme": "none",
-  "includeVersion": true,
-  "exclude": ["**/*.test.ts", "**/*.spec.ts", "**/node_modules/**"],
-  "skipErrorChecking": true,
-  "compilerOptions": {
-    "skipLibCheck": true
-  }
-}