@devilsdev/rag-pipeline-utils 2.2.0 → 2.3.0

package/contracts/contract-schema.json

@@ -0,0 +1,189 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://github.com/devilsdev/rag-pipeline-utils/schemas/contract.json",
+  "title": "Plugin Contract Schema",
+  "description": "Schema for validating plugin contract specifications in the RAG pipeline utilities",
+  "type": "object",
+  "required": [
+    "type",
+    "version",
+    "title",
+    "description",
+    "methods",
+    "properties",
+    "required"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "description": "JSON Schema specification URI"
+    },
+    "type": {
+      "type": "string",
+      "description": "Plugin type identifier",
+      "enum": [
+        "loader",
+        "embedder",
+        "retriever",
+        "llm",
+        "reranker",
+        "evaluator"
+      ]
+    },
+    "version": {
+      "type": "string",
+      "description": "Contract version (semantic versioning)",
+      "pattern": "^\\d+\\.\\d+\\.\\d+$"
+    },
+    "title": {
+      "type": "string",
+      "description": "Human-readable contract title",
+      "minLength": 1
+    },
+    "description": {
+      "type": "string",
+      "description": "Contract description",
+      "minLength": 1
+    },
+    "methods": {
+      "type": "array",
+      "description": "Array of method specifications",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "required": ["name", "parameters", "returns"],
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Method name",
+            "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$"
+          },
+          "parameters": {
+            "type": "array",
+            "description": "Method parameter names",
+            "items": {
+              "type": "string",
+              "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$"
+            }
+          },
+          "returns": {
+            "type": "string",
+            "description": "Return type description",
+            "minLength": 1
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "properties": {
+      "type": "object",
+      "description": "Detailed method property specifications",
+      "minProperties": 1,
+      "patternProperties": {
+        "^[a-zA-Z_][a-zA-Z0-9_]*$": {
+          "type": "object",
+          "required": ["type", "description"],
+          "properties": {
+            "type": {
+              "type": "string",
+              "description": "Property type",
+              "enum": [
+                "function",
+                "string",
+                "number",
+                "boolean",
+                "object",
+                "array"
+              ]
+            },
+            "description": {
+              "type": "string",
+              "description": "Property description",
+              "minLength": 1
+            },
+            "parameters": {
+              "type": "object",
+              "description": "Parameter schema (for function properties)",
+              "properties": {
+                "type": {
+                  "const": "object"
+                },
+                "properties": {
+                  "type": "object"
+                },
+                "required": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              }
+            },
+            "returns": {
+              "type": "object",
+              "description": "Return value schema (for function properties)"
+            }
+          },
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "required": {
+      "type": "array",
+      "description": "List of required methods",
+      "minItems": 1,
+      "items": {
+        "type": "string",
+        "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$"
+      },
+      "uniqueItems": true
+    }
+  },
+  "additionalProperties": false,
+  "examples": [
+    {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "loader",
+      "version": "1.0.0",
+      "title": "Loader Contract",
+      "description": "Contract for loader plugins",
+      "methods": [
+        {
+          "name": "load",
+          "parameters": ["source"],
+          "returns": "documents"
+        }
+      ],
+      "properties": {
+        "load": {
+          "type": "function",
+          "description": "Load documents from source",
+          "parameters": {
+            "type": "object",
+            "properties": {
+              "source": {
+                "type": "string",
+                "description": "Source path or identifier"
+              }
+            },
+            "required": ["source"]
+          },
+          "returns": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": { "type": "string" },
+                "content": { "type": "string" },
+                "metadata": { "type": "object" }
+              },
+              "required": ["id", "content"]
+            }
+          }
+        }
+      },
+      "required": ["load"]
+    }
+  ]
+}

package/contracts/reranker-contract.json

@@ -0,0 +1,69 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "reranker",
+  "version": "1.0.0",
+  "title": "Reranker Contract",
+  "description": "Contract for reranker plugins",
+  "methods": [
+    {
+      "name": "rerank",
+      "parameters": ["results", "query", "options"],
+      "returns": "rankedResults"
+    }
+  ],
+  "properties": {
+    "rerank": {
+      "type": "function",
+      "description": "Rerank search results based on relevance to query",
+      "parameters": {
+        "type": "object",
+        "properties": {
+          "results": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": { "type": "string" },
+                "content": { "type": "string" },
+                "score": { "type": "number" }
+              },
+              "required": ["id", "content"]
+            }
+          },
+          "query": {
+            "type": "string",
+            "description": "The original search query"
+          },
+          "options": {
+            "type": "object",
+            "properties": {
+              "topK": {
+                "type": "number",
+                "description": "Number of top results to return"
+              },
+              "threshold": {
+                "type": "number",
+                "description": "Minimum relevance score threshold"
+              }
+            }
+          }
+        },
+        "required": ["results", "query"]
+      },
+      "returns": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "id": { "type": "string" },
+            "content": { "type": "string" },
+            "score": { "type": "number" },
+            "relevanceScore": { "type": "number" }
+          },
+          "required": ["id", "content", "relevanceScore"]
+        }
+      }
+    }
+  },
+  "required": ["rerank"]
+}

package/dist/index.cjs

@@ -16,6 +16,7 @@ const pluginRegistry = require('../src/core/plugin-registry');
 
 // Utilities
 const logger = require('../src/utils/logger');
+const errorFormatter = require('../src/utils/error-formatter');
 
 // AI/ML capabilities
 const MultiModalProcessor = require('../src/ai/multimodal');
@@ -33,6 +34,13 @@ const metrics = require('../src/core/observability/metrics');
 const { AuditLogger } = require('../src/enterprise/audit-logging');
 const { DataGovernance } = require('../src/enterprise/data-governance');
 
+// Development tools
+const {
+  HotReloadManager,
+  createHotReloadManager,
+} = require('../src/dev/hot-reload');
+const { DevServer, createDevServer } = require('../src/dev/dev-server');
+
 module.exports = {
   // Core API
   createRagPipeline,
@@ -48,6 +56,11 @@ module.exports = {
 
   // Utilities
   logger,
+  errorFormatter,
+  // Error handling utilities
+  createError: errorFormatter.createError,
+  wrapError: errorFormatter.wrapError,
+  ERROR_CODES: errorFormatter.ERROR_CODES,
 
   // AI/ML
   MultiModalProcessor,
@@ -64,4 +77,10 @@ module.exports = {
   // Enterprise
   AuditLogger,
   DataGovernance,
+
+  // Development tools
+  HotReloadManager,
+  createHotReloadManager,
+  DevServer,
+  createDevServer,
 };

package/dist/index.mjs

@@ -25,6 +25,7 @@ import pluginRegistry from '../src/core/plugin-registry.js';
 
 // Utilities
 import logger from '../src/utils/logger.js';
+import errorFormatter from '../src/utils/error-formatter.js';
 
 // AI/ML capabilities
 import MultiModalProcessor from '../src/ai/multimodal.js';
@@ -45,6 +46,14 @@ const { AuditLogger  } = auditloggingModule;
 import datagovernanceModule from '../src/enterprise/data-governance.js';
 const { DataGovernance  } = datagovernanceModule;
 
+// Development tools
+import hotreloadModule from '../src/dev/hot-reload.js';
+const { HotReloadManager,
+  createHotReloadManager,
+ } = hotreloadModule;
+import devserverModule from '../src/dev/dev-server.js';
+const { DevServer, createDevServer  } = devserverModule;
+
 export {
   createRagPipeline,
   loadConfig,
@@ -52,6 +61,7 @@ export {
   normalizeConfig,
   pluginRegistry,
   logger,
+  errorFormatter,
   MultiModalProcessor,
   AdaptiveRetrievalEngine,
   DAGEngine,
@@ -59,7 +69,11 @@ export {
   eventLogger,
   metrics,
   AuditLogger,
-  DataGovernance
+  DataGovernance,
+  HotReloadManager,
+  createHotReloadManager,
+  DevServer,
+  createDevServer
 };
 
 // Backward compatibility aliases

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devilsdev/rag-pipeline-utils",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "A comprehensive enterprise-grade toolkit for building RAG (Retrieval-Augmented Generation) pipelines with advanced AI/ML capabilities",
   "main": "dist/index.cjs",
   "type": "commonjs",
@@ -167,7 +167,7 @@
     "eslint-plugin-storybook": "^0.12.0",
     "framer-motion": "^12.7.4",
     "husky": "^8.0.3",
-    "isolated-vm": "6.0.1",
+    "isolated-vm": "5.0.4",
     "jest": "^29.7.0",
     "jest-junit": "^16.0.0",
     "jest-transform-stub": "^2.0.0",
@@ -186,12 +186,14 @@
     "ajv": "^8.17.1",
     "axios": "^1.8.4",
     "chalk": "^5.4.1",
+    "chokidar": "^4.0.3",
     "commander": "^13.1.0",
     "csv-parse": "^5.6.0",
     "dotenv": "^16.5.0",
     "fast-glob": "^3.3.3",
     "inquirer": "^8.2.5",
     "jsdom": "^26.1.0",
+    "jsonwebtoken": "9.0.2",
     "openai": "^4.93.0",
     "pino": "^9.6.0"
   }