@opensaas/stack-rag 0.1.6

package/dist/config/plugin.js

@@ -0,0 +1,215 @@
+import { normalizeRAGConfig } from './index.js';
+import { createEmbeddingProvider } from '../providers/index.js';
+/**
+ * RAG plugin for OpenSaas Stack
+ * Provides vector embeddings, semantic search, and automatic embedding generation
+ *
+ * @example
+ * ```typescript
+ * import { config, list } from '@opensaas/stack-core'
+ * import { text } from '@opensaas/stack-core/fields'
+ * import { ragPlugin, openaiEmbeddings, pgvectorStorage } from '@opensaas/stack-rag'
+ * import { embedding } from '@opensaas/stack-rag/fields'
+ *
+ * export default config({
+ *   plugins: [
+ *     ragPlugin({
+ *       provider: openaiEmbeddings({ apiKey: process.env.OPENAI_API_KEY }),
+ *       storage: pgvectorStorage()
+ *     })
+ *   ],
+ *   db: { provider: 'postgresql', url: process.env.DATABASE_URL },
+ *   lists: {
+ *     Article: list({
+ *       fields: {
+ *         content: text(),
+ *         contentEmbedding: embedding({
+ *           sourceField: 'content',
+ *           provider: 'openai',
+ *           autoGenerate: true
+ *         })
+ *       }
+ *     })
+ *   }
+ * })
+ * ```
+ */
+export function ragPlugin(config) {
+    const normalized = normalizeRAGConfig(config);
+    return {
+        name: 'rag',
+        version: '0.1.0',
+        init: async (context) => {
+            // Find all embedding fields with autoGenerate enabled
+            for (const [listName, listConfig] of Object.entries(context.config.lists)) {
+                for (const [fieldName, fieldConfig] of Object.entries(listConfig.fields)) {
+                    if (fieldConfig.type === 'embedding' &&
+                        fieldConfig.autoGenerate) {
+                        const embeddingConfig = fieldConfig;
+                        const sourceField = embeddingConfig.sourceField;
+                        if (!sourceField) {
+                            throw new Error(`RAG plugin: Field "${listName}.${fieldName}" has autoGenerate enabled but no sourceField specified`);
+                        }
+                        // Inject afterOperation hook to auto-generate embeddings
+                        context.extendList(listName, {
+                            hooks: {
+                                resolveInput: async (args) => {
+                                    // Skip if item is missing
+                                    if (!args.resolvedData)
+                                        throw new Error('RAG plugin: Missing resolvedData in resolveInput hook');
+                                    const sourceText = args.resolvedData[sourceField];
+                                    const currentEmbedding = args.resolvedData[fieldName];
+                                    // Skip if source text is empty
+                                    if (!sourceText)
+                                        return args.resolvedData;
+                                    // Check if we need to regenerate (source text changed)
+                                    const sourceHash = await hashText(sourceText);
+                                    if (currentEmbedding && currentEmbedding.metadata.sourceHash === sourceHash) {
+                                        // Source text hasn't changed, skip regeneration
+                                        return args.resolvedData;
+                                    }
+                                    // Get provider for this field
+                                    const providerName = embeddingConfig.provider || 'default';
+                                    const providerConfig = providerName === 'default'
+                                        ? normalized.provider
+                                        : normalized.providers[providerName] || normalized.provider;
+                                    if (!providerConfig) {
+                                        console.warn(`RAG plugin: No provider configured for field "${listName}.${fieldName}"`);
+                                        return args.resolvedData;
+                                    }
+                                    // Generate embedding
+                                    const provider = createEmbeddingProvider(providerConfig);
+                                    const vector = await provider.embed(sourceText);
+                                    return {
+                                        ...args.resolvedData,
+                                        [fieldName]: {
+                                            vector,
+                                            metadata: {
+                                                model: provider.model,
+                                                provider: provider.type,
+                                                dimensions: provider.dimensions,
+                                                generatedAt: new Date().toISOString(),
+                                                sourceHash,
+                                            },
+                                        },
+                                    };
+                                },
+                            },
+                        });
+                    }
+                }
+            }
+            // Register MCP tools if enabled
+            if (normalized.enableMcpTools && context.registerMcpTool) {
+                // Find all lists with embedding fields
+                for (const [listName, listConfig] of Object.entries(context.config.lists)) {
+                    const embeddingFields = Object.entries(listConfig.fields).filter(([, fieldConfig]) => fieldConfig.type === 'embedding');
+                    if (embeddingFields.length > 0) {
+                        // Register semantic search tool for this list
+                        const toolName = `semantic_search_${listName.toLowerCase()}`;
+                        context.registerMcpTool({
+                            name: toolName,
+                            description: `Search ${listName} using natural language (semantic search)`,
+                            inputSchema: {
+                                type: 'object',
+                                properties: {
+                                    query: { type: 'string', description: 'Natural language search query' },
+                                    limit: { type: 'number', description: 'Maximum results', default: 10 },
+                                    minScore: {
+                                        type: 'number',
+                                        description: 'Minimum similarity score (0-1)',
+                                        default: 0.5,
+                                    },
+                                    field: {
+                                        type: 'string',
+                                        description: 'Embedding field to search',
+                                        default: embeddingFields[0][0],
+                                        enum: embeddingFields.map(([name]) => name),
+                                    },
+                                },
+                                required: ['query'],
+                            },
+                            handler: async ({ input, context }) => {
+                                const { query, limit = 10, minScore = 0.5, field = embeddingFields[0][0] } = input;
+                                // Get provider
+                                const providerConfig = normalized.provider;
+                                if (!providerConfig) {
+                                    throw new Error('RAG plugin: No default provider configured');
+                                }
+                                // Generate query embedding
+                                const provider = createEmbeddingProvider(providerConfig);
+                                const queryVector = await provider.embed(query);
+                                // Search using configured storage backend
+                                // Note: This is a simplified implementation
+                                // Full implementation would use VectorStorage interface
+                                const dbKey = listName.charAt(0).toLowerCase() + listName.slice(1);
+                                const allItems = await context.db[dbKey].findMany();
+                                // Calculate cosine similarity for each item
+                                const results = allItems
+                                    .map((item) => {
+                                    const embedding = item[field];
+                                    if (!embedding || !embedding.vector)
+                                        return null;
+                                    const score = cosineSimilarity(queryVector, embedding.vector);
+                                    return { item, score };
+                                })
+                                    .filter((r) => r !== null && r.score >= minScore)
+                                    .sort((a, b) => b.score - a.score)
+                                    .slice(0, limit);
+                                return {
+                                    results: results.map((r) => {
+                                        // Ensure item is an object before spreading
+                                        const item = r.item;
+                                        return {
+                                            ...item,
+                                            _similarity: r.score,
+                                        };
+                                    }),
+                                    count: results.length,
+                                };
+                            },
+                        });
+                    }
+                }
+            }
+            // Store RAG config for runtime access
+            // Access at runtime via: config._pluginData.rag
+            context.setPluginData('rag', normalized);
+        },
+    };
+}
+/**
+ * Hash text using SHA-256 for change detection
+ */
+async function hashText(text) {
+    // Simple hash implementation
+    // In production, could use crypto.subtle.digest for better performance
+    let hash = 0;
+    for (let i = 0; i < text.length; i++) {
+        const char = text.charCodeAt(i);
+        hash = (hash << 5) - hash + char;
+        hash = hash & hash; // Convert to 32-bit integer
+    }
+    return hash.toString(36);
+}
+/**
+ * Calculate cosine similarity between two vectors
+ */
+function cosineSimilarity(a, b) {
+    if (a.length !== b.length) {
+        throw new Error('Vectors must have same dimensions');
+    }
+    let dotProduct = 0;
+    let normA = 0;
+    let normB = 0;
+    for (let i = 0; i < a.length; i++) {
+        dotProduct += a[i] * b[i];
+        normA += a[i] * a[i];
+        normB += b[i] * b[i];
+    }
+    const denominator = Math.sqrt(normA) * Math.sqrt(normB);
+    if (denominator === 0)
+        return 0;
+    return dotProduct / denominator;
+}
+//# sourceMappingURL=plugin.js.map

package/dist/config/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/config/plugin.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAA;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,UAAU,SAAS,CAAC,MAAiB;IACzC,MAAM,UAAU,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAA;IAE7C,OAAO;QACL,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,OAAO;QAEhB,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YACtB,sDAAsD;YACtD,KAAK,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1E,KAAK,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;oBACzE,IACE,WAAW,CAAC,IAAI,KAAK,WAAW;wBAC/B,WAA0C,CAAC,YAAY,EACxD,CAAC;wBACD,MAAM,eAAe,GAAG,WAIvB,CAAA;wBAED,MAAM,WAAW,GAAG,eAAe,CAAC,WAAW,CAAA;wBAC/C,IAAI,CAAC,WAAW,EAAE,CAAC;4BACjB,MAAM,IAAI,KAAK,CACb,sBAAsB,QAAQ,IAAI,SAAS,yDAAyD,CACrG,CAAA;wBACH,CAAC;wBAED,yDAAyD;wBACzD,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE;4BAC3B,KAAK,EAAE;gCACL,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;oCAC3B,0BAA0B;oCAC1B,IAAI,CAAC,IAAI,CAAC,YAAY;wCACpB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAA;oCAE1E,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAuB,CAAA;oCACvE,MAAM,gBAAgB,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAG5C,CAAA;oCAER,+BAA+B;oCAC/B,IAAI,CAAC,UAAU;wCAAE,OAAO,IAAI,CAAC,YAAY,CAAA;oCAEzC,uDAAuD;oCACvD,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAA;oCAC7C,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,QAAQ,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;wCAC5E,gDAAgD;wCAChD,OAAO,IAAI,CAAC,YAAY,CAAA;oCAC1B,CAAC;oCAED,8BAA8B;oCAC9B,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,IAAI,SAAS,CAAA;oCAC1D,MAAM,cAAc,GAClB,YAAY,KAAK,SAAS;wCACxB,CAAC,CAAC,UAAU,CAAC,QAAQ;wCACrB,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAA;oCAE/D,IAAI,CAAC,cAAc,EAAE,CAAC;wCACpB,OAAO,CAAC,IAAI,CACV,iDAAiD,QAAQ,IAAI,SAAS,GAAG,CAC1E,CAAA;wCACD,OAAO,IAAI,CAAC,YAAY,CAAA;oCAC1B,CAAC;oCAED,qBAAqB;oCACrB,MAAM,QAAQ,GAAG,uBAAuB,CAAC,cAAc,CAAC,CAAA;oCACxD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;oCAE/C,OAAO;wCACL,GAAG,IAAI,CAAC,YAAY;wCACpB,CAAC,SAAS,CAAC,EAAE;4CACX,MAAM;4CACN,QAAQ,EAAE;gDACR,KAAK,EAAE,QAAQ,CAAC,KAAK;gDACrB,QAAQ,EAAE,QAAQ,CAAC,IAAI;gDACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gDAC/B,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gDACrC,UAAU;6CACX;yCACF;qCACF,CAAA;gCACH,CAAC;6BACF;yBACF,CAAC,CAAA;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;YAED,gCAAgC;YAChC,IAAI,UAAU,CAAC,cAAc,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;gBACzD,uCAAuC;gBACvC,KAAK,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1E,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,CAC9D,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,WAAW,CACtD,CAAA;oBAED,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAC/B,8CAA8C;wBAC9C,MAAM,QAAQ,GAAG,mBAAmB,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAA;wBAE5D,OAAO,CAAC,eAAe,CAAC;4BACtB,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,UAAU,QAAQ,2CAA2C;4BAC1E,WAAW,EAAE;gCACX,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,+BAA+B,EAAE;oCACvE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,iBAAiB,EAAE,OAAO,EAAE,EAAE,EAAE;oCACtE,QAAQ,EAAE;wCACR,IAAI,EAAE,QAAQ;wCACd,WAAW,EAAE,gCAAgC;wCAC7C,OAAO,EAAE,GAAG;qCACb;oCACD,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,WAAW,EAAE,2BAA2B;wCACxC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;wCAC9B,IAAI,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC;qCAC5C;iCACF;gCACD,QAAQ,EAAE,CAAC,OAAO,CAAC;6BACpB;4BACD,OAAO,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE;gCACpC,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,EAAE,EAAE,QAAQ,GAAG,GAAG,EAAE,KAAK,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAA;gCAElF,eAAe;gCACf,MAAM,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAA;gCAC1C,IAAI,CAAC,cAAc,EAAE,CAAC;oCACpB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;gCAC/D,CAAC;gCAED,2BAA2B;gCAC3B,MAAM,QAAQ,GAAG,uBAAuB,CAAC,cAAc,CAAC,CAAA;gCACxD,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;gCAE/C,0CAA0C;gCAC1C,4CAA4C;gCAC5C,wDAAwD;gCACxD,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gCAClE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAA;gCAEnD,4CAA4C;gCAC5C,MAAM,OAAO,GAAG,QAAQ;qCACrB,GAAG,CAAC,CAAC,IAAoD,EAAE,EAAE;oCAC5D,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;oCAC7B,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,MAAM;wCAAE,OAAO,IAAI,CAAA;oCAEhD,MAAM,KAAK,GAAG,gBAAgB,CAAC,WAAW,EAAE,SAAS,CAAC,MAAM,CAAC,CAAA;oCAC7D,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gCACxB,CAAC,CAAC;qCACD,MAAM,CAAC,CAAC,CAA2B,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,KAAK,IAAI,QAAQ,CAAC;qCAC1E,IAAI,CAAC,CAAC,CAAoB,EAAE,CAAoB,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;qCACvE,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;gCAElB,OAAO;oCACL,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAmC,EAAE,EAAE;wCAC3D,4CAA4C;wCAC5C,MAAM,IAAI,GAAG,CAAC,CAAC,IAA+B,CAAA;wCAC9C,OAAO;4CACL,GAAG,IAAI;4CACP,WAAW,EAAE,CAAC,CAAC,KAAK;yCACrB,CAAA;oCACH,CAAC,CAAC;oCACF,KAAK,EAAE,OAAO,CAAC,MAAM;iCACtB,CAAA;4BACH,CAAC;yBACF,CAAC,CAAA;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;YAED,sCAAsC;YACtC,gDAAgD;YAChD,OAAO,CAAC,aAAa,CAAsB,KAAK,EAAE,UAAU,CAAC,CAAA;QAC/D,CAAC;KACF,CAAA;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,QAAQ,CAAC,IAAY;IAClC,6BAA6B;IAC7B,uEAAuE;IACvE,IAAI,IAAI,GAAG,CAAC,CAAA;IACZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;QAC/B,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAA;QAChC,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA,CAAC,4BAA4B;IACjD,CAAC;IACD,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;AAC1B,CAAC;AAED;;GAEG;AACH,SAAS,gBAAgB,CAAC,CAAW,EAAE,CAAW;IAChD,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;IACtD,CAAC;IAED,IAAI,UAAU,GAAG,CAAC,CAAA;IAClB,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,IAAI,KAAK,GAAG,CAAC,CAAA;IAEb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAClC,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QACzB,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QACpB,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IACtB,CAAC;IAED,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACvD,IAAI,WAAW,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IAE/B,OAAO,UAAU,GAAG,WAAW,CAAA;AACjC,CAAC"}

package/dist/config/plugin.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=plugin.test.d.ts.map

package/dist/config/plugin.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.test.d.ts","sourceRoot":"","sources":["../../src/config/plugin.test.ts"],"names":[],"mappings":""}