@memberjunction/search-engine 0.0.1 → 5.26.0

package/dist/generic/EntitySearchProvider.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @fileoverview Entity search provider using RunView with UserSearchString.
+ *
+ * Searches entities where AllowUserSearchAPI=true using the database-native
+ * LIKE-based search infrastructure. Returns scored candidates suitable for
+ * RRF fusion with vector and full-text results.
+ *
+ * @module @memberjunction/search-engine
+ */
+import { UserInfo } from '@memberjunction/core';
+import { BaseSearchProvider } from './ISearchProvider.js';
+import { SearchSource, SearchFilters, SearchResultItem } from './search.types.js';
+/**
+ * Provides entity-level LIKE-based search using RunView + UserSearchString.
+ * Searches all entities where AllowUserSearchAPI=true, returning results
+ * with rank-based scores.
+ */
+export declare class EntitySearchProvider extends BaseSearchProvider {
+    readonly SourceType: SearchSource;
+    /**
+     * Execute an entity search across all entities with AllowUserSearchAPI=true.
+     *
+     * @param query - The search query text
+     * @param topK - Maximum number of results per entity
+     * @param filters - Optional filters (EntityNames to restrict search scope)
+     * @param contextUser - The user performing the search
+     * @returns Scored result items from entity search
+     */
+    Search(query: string, topK: number, filters: SearchFilters | undefined, contextUser: UserInfo): Promise<SearchResultItem[]>;
+    /**
+     * Get the list of entities eligible for search, optionally filtered by name.
+     */
+    private getSearchableEntities;
+    /**
+     * Search a single entity using RunView with UserSearchString.
+     */
+    private searchOneEntity;
+    /**
+     * Convert RunView results to SearchResultItem format with field-match relevance scores.
+     * Score is based on how many searchable fields contain the query and whether
+     * the match is in a name/title field (higher weight) vs description/other fields.
+     */
+    private convertResults;
+    /**
+     * Extract a display title from record data using entity metadata.
+     * Combines IsNameField fields in Sequence order.
+     */
+    private extractTitle;
+    /**
+     * Extract a display snippet from record data using entity metadata.
+     */
+    private extractSnippet;
+}
+//# sourceMappingURL=EntitySearchProvider.d.ts.map

package/dist/generic/EntitySearchProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntitySearchProvider.d.ts","sourceRoot":"","sources":["../../src/generic/EntitySearchProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAA0C,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAExF,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,gBAAgB,EAAoB,MAAM,gBAAgB,CAAC;AAEjG;;;;GAIG;AACH,qBACa,oBAAqB,SAAQ,kBAAkB;IACxD,SAAgB,UAAU,EAAE,YAAY,CAAY;IAEpD;;;;;;;;OAQG;IACU,MAAM,CACf,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,aAAa,GAAG,SAAS,EAClC,WAAW,EAAE,QAAQ,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAyC9B;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAc7B;;OAEG;YACW,eAAe;IA4B7B;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAwDtB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAmCpB;;OAEG;IACH,OAAO,CAAC,cAAc;CAczB"}

package/dist/generic/EntitySearchProvider.js

@@ -0,0 +1,207 @@
+/**
+ * @fileoverview Entity search provider using RunView with UserSearchString.
+ *
+ * Searches entities where AllowUserSearchAPI=true using the database-native
+ * LIKE-based search infrastructure. Returns scored candidates suitable for
+ * RRF fusion with vector and full-text results.
+ *
+ * @module @memberjunction/search-engine
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { LogError, LogStatus, Metadata, RunView } from '@memberjunction/core';
+import { RegisterClass } from '@memberjunction/global';
+import { BaseSearchProvider } from './ISearchProvider.js';
+/**
+ * Provides entity-level LIKE-based search using RunView + UserSearchString.
+ * Searches all entities where AllowUserSearchAPI=true, returning results
+ * with rank-based scores.
+ */
+let EntitySearchProvider = class EntitySearchProvider extends BaseSearchProvider {
+    constructor() {
+        super(...arguments);
+        this.SourceType = 'entity';
+    }
+    /**
+     * Execute an entity search across all entities with AllowUserSearchAPI=true.
+     *
+     * @param query - The search query text
+     * @param topK - Maximum number of results per entity
+     * @param filters - Optional filters (EntityNames to restrict search scope)
+     * @param contextUser - The user performing the search
+     * @returns Scored result items from entity search
+     */
+    async Search(query, topK, filters, contextUser) {
+        try {
+            const md = new Metadata();
+            const searchableEntities = this.getSearchableEntities(md, filters);
+            if (searchableEntities.length === 0) {
+                LogStatus('EntitySearchProvider: No searchable entities found');
+                return [];
+            }
+            // Debug: log searchable entities and their search fields
+            LogStatus(`EntitySearchProvider: Searching ${searchableEntities.length} entities for "${query}"`);
+            for (const e of searchableEntities.slice(0, 3)) {
+                const entity = md.Entities.find(ent => ent.Name === e.Name);
+                if (entity) {
+                    const searchFields = entity.Fields.filter(f => f.IncludeInUserSearchAPI);
+                    LogStatus(`  Entity "${e.Name}": ${searchFields.length} searchable fields [${searchFields.slice(0, 5).map(f => f.Name).join(', ')}${searchFields.length > 5 ? '...' : ''}]`);
+                }
+            }
+            // Calculate per-entity limit: distribute topK across entities
+            const perEntityLimit = Math.max(3, Math.ceil(topK / Math.max(1, searchableEntities.length)));
+            // Search all entities in parallel
+            const searchPromises = searchableEntities.map(entity => this.searchOneEntity(entity.Name, query, perEntityLimit, contextUser));
+            const results = await Promise.all(searchPromises);
+            const allResults = results.flat();
+            // Sort by score descending and limit to topK
+            allResults.sort((a, b) => b.Score - a.Score);
+            return allResults.slice(0, topK);
+        }
+        catch (error) {
+            const msg = error instanceof Error ? error.message : String(error);
+            LogError(`EntitySearchProvider: Search failed: ${msg}`);
+            return [];
+        }
+    }
+    /**
+     * Get the list of entities eligible for search, optionally filtered by name.
+     */
+    getSearchableEntities(md, filters) {
+        let entities = md.Entities.filter(e => e.AllowUserSearchAPI);
+        if (filters?.EntityNames?.length) {
+            const allowedNames = new Set(filters.EntityNames.map(n => n.toLowerCase()));
+            entities = entities.filter(e => allowedNames.has(e.Name.toLowerCase()));
+        }
+        return entities;
+    }
+    /**
+     * Search a single entity using RunView with UserSearchString.
+     */
+    async searchOneEntity(entityName, query, maxRows, contextUser) {
+        try {
+            const rv = new RunView();
+            const result = await rv.RunView({
+                EntityName: entityName,
+                UserSearchString: query,
+                MaxRows: maxRows,
+                ResultType: 'simple'
+            }, contextUser);
+            if (!result.Success) {
+                LogError(`EntitySearchProvider: Failed to search "${entityName}": ${result.ErrorMessage}`);
+                return [];
+            }
+            return this.convertResults(result.Results, entityName, query);
+        }
+        catch (error) {
+            const msg = error instanceof Error ? error.message : String(error);
+            LogError(`EntitySearchProvider: Error searching "${entityName}": ${msg}`);
+            return [];
+        }
+    }
+    /**
+     * Convert RunView results to SearchResultItem format with field-match relevance scores.
+     * Score is based on how many searchable fields contain the query and whether
+     * the match is in a name/title field (higher weight) vs description/other fields.
+     */
+    convertResults(records, entityName, query) {
+        const md = new Metadata();
+        const entityInfo = md.Entities.find(e => e.Name === entityName);
+        const queryLower = query.toLowerCase();
+        // Get searchable fields and classify them by importance
+        const searchFields = entityInfo?.Fields.filter(f => f.IncludeInUserSearchAPI) ?? [];
+        const nameFields = searchFields.filter(f => f.IsNameField);
+        const totalSearchableFields = Math.max(searchFields.length, 1);
+        return records.map((record) => {
+            const recordID = String(record.ID ?? '');
+            const title = this.extractTitle(record, entityInfo);
+            const snippet = this.extractSnippet(record, entityInfo);
+            // Calculate relevance: check how many fields match the query
+            let matchedFields = 0;
+            let nameFieldMatch = false;
+            for (const field of searchFields) {
+                const val = record[field.Name];
+                if (val != null && String(val).toLowerCase().includes(queryLower)) {
+                    matchedFields++;
+                    if (nameFields.some(nf => nf.Name === field.Name)) {
+                        nameFieldMatch = true;
+                    }
+                }
+            }
+            // Score: base from field match ratio, boost for name field matches
+            // Range: ~0.15 (weak match in one field) to ~0.95 (name field + multiple fields)
+            const fieldRatio = matchedFields / totalSearchableFields;
+            const baseScore = 0.15 + (fieldRatio * 0.45); // 0.15 to 0.60
+            const nameBoost = nameFieldMatch ? 0.35 : 0; // +0.35 for name field match
+            const score = Math.min(baseScore + nameBoost, 0.95);
+            return {
+                ID: recordID,
+                EntityName: entityName,
+                RecordID: recordID,
+                SourceType: 'entity',
+                ResultType: 'entity-record',
+                Title: title,
+                Snippet: snippet,
+                Score: Math.round(score * 100) / 100, // Round to 2 decimal places
+                ScoreBreakdown: { Entity: Math.round(score * 100) / 100 },
+                Tags: [],
+                EntityIcon: entityInfo?.Icon ?? undefined,
+                MatchedAt: new Date()
+            };
+        });
+    }
+    /**
+     * Extract a display title from record data using entity metadata.
+     * Combines IsNameField fields in Sequence order.
+     */
+    extractTitle(record, entityInfo) {
+        if (entityInfo) {
+            // Try IsNameField fields first
+            const nameFields = entityInfo.Fields
+                .filter(f => f.IsNameField)
+                .sort((a, b) => (a.Sequence ?? 9999) - (b.Sequence ?? 9999));
+            if (nameFields.length > 0) {
+                const parts = nameFields
+                    .map(f => record[f.Name])
+                    .filter(v => v != null && String(v).trim() !== '')
+                    .map(v => String(v));
+                if (parts.length > 0)
+                    return parts.join(' ');
+            }
+            // Single NameField fallback
+            if (entityInfo.NameField && record[entityInfo.NameField.Name]) {
+                return String(record[entityInfo.NameField.Name]);
+            }
+        }
+        // Heuristic fallbacks
+        const heuristicFields = ['Name', 'Title', 'Subject', 'Label', 'DisplayName'];
+        for (const field of heuristicFields) {
+            if (record[field] && typeof record[field] === 'string') {
+                return record[field];
+            }
+        }
+        return `Record`;
+    }
+    /**
+     * Extract a display snippet from record data using entity metadata.
+     */
+    extractSnippet(record, entityInfo) {
+        const descFields = ['Description', 'Summary', 'Body', 'Content', 'Text', 'Notes'];
+        for (const field of descFields) {
+            if (record[field] && typeof record[field] === 'string') {
+                const val = record[field];
+                return val.length > 200 ? val.substring(0, 200) + '...' : val;
+            }
+        }
+        return entityInfo ? `Matched in ${entityInfo.Name}` : 'Matched record';
+    }
+};
+EntitySearchProvider = __decorate([
+    RegisterClass(BaseSearchProvider, 'EntitySearchProvider')
+], EntitySearchProvider);
+export { EntitySearchProvider };
+//# sourceMappingURL=EntitySearchProvider.js.map

package/dist/generic/EntitySearchProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntitySearchProvider.js","sourceRoot":"","sources":["../../src/generic/EntitySearchProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;;;;;;;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAY,MAAM,sBAAsB,CAAC;AACxF,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAGvD;;;;GAIG;AAEI,IAAM,oBAAoB,GAA1B,MAAM,oBAAqB,SAAQ,kBAAkB;IAArD;;QACa,eAAU,GAAiB,QAAQ,CAAC;IA8NxD,CAAC;IA5NG;;;;;;;;OAQG;IACI,KAAK,CAAC,MAAM,CACf,KAAa,EACb,IAAY,EACZ,OAAkC,EAClC,WAAqB;QAErB,IAAI,CAAC;YACD,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC1B,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;YAEnE,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClC,SAAS,CAAC,oDAAoD,CAAC,CAAC;gBAChE,OAAO,EAAE,CAAC;YACd,CAAC;YAED,yDAAyD;YACzD,SAAS,CAAC,mCAAmC,kBAAkB,CAAC,MAAM,kBAAkB,KAAK,GAAG,CAAC,CAAC;YAClG,KAAK,MAAM,CAAC,IAAI,kBAAkB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBAC7C,MAAM,MAAM,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;gBAC5D,IAAI,MAAM,EAAE,CAAC;oBACT,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC;oBACzE,SAAS,CAAC,aAAa,CAAC,CAAC,IAAI,MAAM,YAAY,CAAC,MAAM,uBAAuB,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;gBACjL,CAAC;YACL,CAAC;YAED,8DAA8D;YAC9D,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAE7F,kCAAkC;YAClC,MAAM,cAAc,GAAG,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CACnD,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,WAAW,CAAC,CACxE,CAAC;YAEF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAClD,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;YAElC,6CAA6C;YAC7C,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;YAC7C,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QACrC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,GAAG,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnE,QAAQ,CAAC,wCAAwC,GAAG,EAAE,CAAC,CAAC;YACxD,OAAO,EAAE,CAAC;QACd,CAAC;IACL,CAAC;IAED;;OAEG;IACK,qBAAqB,CACzB,EAAY,EACZ,OAAkC;QAElC,IAAI,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7D,IAAI,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;YAC/B,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;YAC5E,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC5E,CAAC;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,eAAe,CACzB,UAAkB,EAClB,KAAa,EACb,OAAe,EACf,WAAqB;QAErB,IAAI,CAAC;YACD,MAAM,EAAE,GAAG,IAAI,OAAO,EAAE,CAAC;YACzB,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,OAAO,CAA0B;gBACrD,UAAU,EAAE,UAAU;gBACtB,gBAAgB,EAAE,KAAK;gBACvB,OAAO,EAAE,OAAO;gBAChB,UAAU,EAAE,QAAQ;aACvB,EAAE,WAAW,CAAC,CAAC;YAEhB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAClB,QAAQ,CAAC,2CAA2C,UAAU,MAAM,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;gBAC3F,OAAO,EAAE,CAAC;YACd,CAAC;YAED,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAClE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,GAAG,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnE,QAAQ,CAAC,0CAA0C,UAAU,MAAM,GAAG,EAAE,CAAC,CAAC;YAC1E,OAAO,EAAE,CAAC;QACd,CAAC;IACL,CAAC;IAED;;;;OAIG;IACK,cAAc,CAClB,OAAkC,EAClC,UAAkB,EAClB,KAAa;QAEb,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC1B,MAAM,UAAU,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;QAChE,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAEvC,wDAAwD;QACxD,MAAM,YAAY,GAAG,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,sBAAsB,CAAC,IAAI,EAAE,CAAC;QACpF,MAAM,UAAU,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;QAC3D,MAAM,qBAAqB,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAE/D,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1B,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;YACzC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YACpD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YAExD,6DAA6D;YAC7D,IAAI,aAAa,GAAG,CAAC,CAAC;YACtB,IAAI,cAAc,GAAG,KAAK,CAAC;YAC3B,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;gBAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC/B,IAAI,GAAG,IAAI,IAAI,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;oBAChE,aAAa,EAAE,CAAC;oBAChB,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;wBAChD,cAAc,GAAG,IAAI,CAAC;oBAC1B,CAAC;gBACL,CAAC;YACL,CAAC;YAED,mEAAmE;YACnE,iFAAiF;YACjF,MAAM,UAAU,GAAG,aAAa,GAAG,qBAAqB,CAAC;YACzD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,eAAe;YAC7D,MAAM,SAAS,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,6BAA6B;YAC3E,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,SAAS,EAAE,IAAI,CAAC,CAAC;YAEpD,OAAO;gBACH,EAAE,EAAE,QAAQ;gBACZ,UAAU,EAAE,UAAU;gBACtB,QAAQ,EAAE,QAAQ;gBAClB,UAAU,EAAE,QAAQ;gBACpB,UAAU,EAAE,eAAmC;gBAC/C,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,OAAO;gBAChB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE,4BAA4B;gBAClE,cAAc,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE;gBACzD,IAAI,EAAE,EAAE;gBACR,UAAU,EAAE,UAAU,EAAE,IAAI,IAAI,SAAS;gBACzC,SAAS,EAAE,IAAI,IAAI,EAAE;aACxB,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACK,YAAY,CAChB,MAA+B,EAC/B,UAAkI;QAElI,IAAI,UAAU,EAAE,CAAC;YACb,+BAA+B;YAC/B,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM;iBAC/B,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;iBAC1B,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC;YAEjE,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,MAAM,KAAK,GAAG,UAAU;qBACnB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;qBACxB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;qBACjD,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBACzB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;oBAAE,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACjD,CAAC;YAED,4BAA4B;YAC5B,IAAI,UAAU,CAAC,SAAS,IAAI,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC5D,OAAO,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;YACrD,CAAC;QACL,CAAC;QAED,sBAAsB;QACtB,MAAM,eAAe,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;QAC7E,KAAK,MAAM,KAAK,IAAI,eAAe,EAAE,CAAC;YAClC,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACrD,OAAO,MAAM,CAAC,KAAK,CAAW,CAAC;YACnC,CAAC;QACL,CAAC;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;OAEG;IACK,cAAc,CAClB,MAA+B,EAC/B,UAAwC;QAExC,MAAM,UAAU,GAAG,CAAC,aAAa,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAClF,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACrD,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAW,CAAC;gBACpC,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;YAClE,CAAC;QACL,CAAC;QAED,OAAO,UAAU,CAAC,CAAC,CAAC,cAAc,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;IAC3E,CAAC;CACJ,CAAA;AA/NY,oBAAoB;IADhC,aAAa,CAAC,kBAAkB,EAAE,sBAAsB,CAAC;GAC7C,oBAAoB,CA+NhC"}

package/dist/generic/FullTextSearchProvider.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @fileoverview Full-text search provider for the SearchEngine.
+ *
+ * Uses Metadata.FullTextSearch() which delegates to the database-native FTS
+ * capabilities (SQL Server FREETEXT, PostgreSQL tsvector) via RunView +
+ * UserSearchString. Enriches results with tags from TaggedItems and
+ * ContentItemTags entities.
+ *
+ * @module @memberjunction/search-engine
+ */
+import { UserInfo } from '@memberjunction/core';
+import { BaseSearchProvider } from './ISearchProvider.js';
+import { SearchSource, SearchFilters, SearchResultItem } from './search.types.js';
+import { SearchEnricher } from './SearchEnricher.js';
+/**
+ * Provides full-text search using the MJ Metadata.FullTextSearch() method.
+ * Always available since it relies on the standard MJ provider infrastructure.
+ */
+export declare class FullTextSearchProvider extends BaseSearchProvider {
+    readonly SourceType: SearchSource;
+    private enricher;
+    /** Set the enricher instance. Called by SearchEngine after construction. */
+    SetEnricher(enricher: SearchEnricher): void;
+    /**
+     * Execute a full-text search across all FTS-enabled entities.
+     *
+     * @param query - The search query text
+     * @param topK - Maximum number of results
+     * @param filters - Optional filters (EntityNames, Tags)
+     * @param contextUser - The user performing the search
+     * @returns Scored result items from full-text search
+     */
+    Search(query: string, topK: number, filters: SearchFilters | undefined, contextUser: UserInfo): Promise<SearchResultItem[]>;
+}
+//# sourceMappingURL=FullTextSearchProvider.d.ts.map

package/dist/generic/FullTextSearchProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FullTextSearchProvider.d.ts","sourceRoot":"","sources":["../../src/generic/FullTextSearchProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAsB,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEpE,OAAO,EAAE,kBAAkB,EAAwB,MAAM,mBAAmB,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,gBAAgB,EAAoB,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;GAGG;AACH,qBACa,sBAAuB,SAAQ,kBAAkB;IAC1D,SAAgB,UAAU,EAAE,YAAY,CAAc;IAEtD,OAAO,CAAC,QAAQ,CAA+B;IAE/C,4EAA4E;IACrE,WAAW,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI;IAIlD;;;;;;;;OAQG;IACU,MAAM,CACf,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,aAAa,GAAG,SAAS,EAClC,WAAW,EAAE,QAAQ,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC;CA6CjC"}

package/dist/generic/FullTextSearchProvider.js

@@ -0,0 +1,89 @@
+/**
+ * @fileoverview Full-text search provider for the SearchEngine.
+ *
+ * Uses Metadata.FullTextSearch() which delegates to the database-native FTS
+ * capabilities (SQL Server FREETEXT, PostgreSQL tsvector) via RunView +
+ * UserSearchString. Enriches results with tags from TaggedItems and
+ * ContentItemTags entities.
+ *
+ * @module @memberjunction/search-engine
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { LogError, Metadata } from '@memberjunction/core';
+import { RegisterClass } from '@memberjunction/global';
+import { BaseSearchProvider } from './ISearchProvider.js';
+/**
+ * Provides full-text search using the MJ Metadata.FullTextSearch() method.
+ * Always available since it relies on the standard MJ provider infrastructure.
+ */
+let FullTextSearchProvider = class FullTextSearchProvider extends BaseSearchProvider {
+    constructor() {
+        super(...arguments);
+        this.SourceType = 'fulltext';
+        this.enricher = null;
+    }
+    /** Set the enricher instance. Called by SearchEngine after construction. */
+    SetEnricher(enricher) {
+        this.enricher = enricher;
+    }
+    /**
+     * Execute a full-text search across all FTS-enabled entities.
+     *
+     * @param query - The search query text
+     * @param topK - Maximum number of results
+     * @param filters - Optional filters (EntityNames, Tags)
+     * @param contextUser - The user performing the search
+     * @returns Scored result items from full-text search
+     */
+    async Search(query, topK, filters, contextUser) {
+        try {
+            const md = new Metadata();
+            const ftsResult = await md.FullTextSearch({
+                SearchText: query,
+                EntityNames: filters?.EntityNames,
+                MaxRowsPerEntity: Math.max(3, Math.ceil(topK / 10))
+            }, contextUser);
+            if (!ftsResult.Success) {
+                LogError(`FullTextSearchProvider: FTS error: ${ftsResult.ErrorMessage}`);
+                return [];
+            }
+            const results = ftsResult.Results.map(r => ({
+                ID: r.RecordID,
+                EntityName: r.EntityName,
+                RecordID: r.RecordID,
+                SourceType: 'fulltext',
+                ResultType: 'entity-record',
+                Title: r.Title,
+                Snippet: r.Snippet,
+                Score: r.Score,
+                ScoreBreakdown: { FullText: r.Score },
+                Tags: [],
+                MatchedAt: new Date()
+            }));
+            // Batch-load tags for FTS results
+            if (this.enricher) {
+                await this.enricher.EnrichWithTags(results, contextUser);
+                // Apply tag filter if specified
+                if (filters?.Tags?.length) {
+                    return this.enricher.FilterByTags(results, filters.Tags);
+                }
+            }
+            return results;
+        }
+        catch (error) {
+            const msg = error instanceof Error ? error.message : String(error);
+            LogError(`FullTextSearchProvider: Full-text search error: ${msg}`);
+            return [];
+        }
+    }
+};
+FullTextSearchProvider = __decorate([
+    RegisterClass(BaseSearchProvider, 'FullTextSearchProvider')
+], FullTextSearchProvider);
+export { FullTextSearchProvider };
+//# sourceMappingURL=FullTextSearchProvider.js.map

package/dist/generic/FullTextSearchProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FullTextSearchProvider.js","sourceRoot":"","sources":["../../src/generic/FullTextSearchProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;;;;;;;AAEH,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAY,MAAM,sBAAsB,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAwB,MAAM,mBAAmB,CAAC;AAI7E;;;GAGG;AAEI,IAAM,sBAAsB,GAA5B,MAAM,sBAAuB,SAAQ,kBAAkB;IAAvD;;QACa,eAAU,GAAiB,UAAU,CAAC;QAE9C,aAAQ,GAA0B,IAAI,CAAC;IAkEnD,CAAC;IAhEG,4EAA4E;IACrE,WAAW,CAAC,QAAwB;QACvC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,MAAM,CACf,KAAa,EACb,IAAY,EACZ,OAAkC,EAClC,WAAqB;QAErB,IAAI,CAAC;YACD,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC1B,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,cAAc,CAAC;gBACtC,UAAU,EAAE,KAAK;gBACjB,WAAW,EAAE,OAAO,EAAE,WAAW;gBACjC,gBAAgB,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;aACtD,EAAE,WAAW,CAAC,CAAC;YAEhB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;gBACrB,QAAQ,CAAC,sCAAsC,SAAS,CAAC,YAAY,EAAE,CAAC,CAAC;gBACzE,OAAO,EAAE,CAAC;YACd,CAAC;YAED,MAAM,OAAO,GAAuB,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBAC5D,EAAE,EAAE,CAAC,CAAC,QAAQ;gBACd,UAAU,EAAE,CAAC,CAAC,UAAU;gBACxB,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,UAAU,EAAE,UAAU;gBACtB,UAAU,EAAE,eAAmC;gBAC/C,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,OAAO,EAAE,CAAC,CAAC,OAAO;gBAClB,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,cAAc,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE;gBACrC,IAAI,EAAE,EAAc;gBACpB,SAAS,EAAE,IAAI,IAAI,EAAE;aACxB,CAAC,CAAC,CAAC;YAEJ,kCAAkC;YAClC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAChB,MAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;gBAEzD,gCAAgC;gBAChC,IAAI,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;oBACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC7D,CAAC;YACL,CAAC;YAED,OAAO,OAAO,CAAC;QACnB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,GAAG,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnE,QAAQ,CAAC,mDAAmD,GAAG,EAAE,CAAC,CAAC;YACnE,OAAO,EAAE,CAAC;QACd,CAAC;IACL,CAAC;CACJ,CAAA;AArEY,sBAAsB;IADlC,aAAa,CAAC,kBAAkB,EAAE,wBAAwB,CAAC;GAC/C,sBAAsB,CAqElC"}

package/dist/generic/ISearchProvider.d.ts

@@ -0,0 +1,90 @@
+/**
+ * @fileoverview Base class and interface for search providers.
+ *
+ * Each search provider implements a single retrieval strategy
+ * (vector similarity, full-text, entity LIKE-search, storage, etc.)
+ * and returns scored candidates suitable for RRF fusion.
+ *
+ * Providers are discovered at runtime via @RegisterClass and the
+ * SearchProvider metadata entity. The DriverClass column in the
+ * SearchProvider table maps to the @RegisterClass key.
+ *
+ * @module @memberjunction/search-engine
+ */
+import { UserInfo } from '@memberjunction/core';
+import { SearchSource, SearchFilters, SearchResultItem } from './search.types.js';
+/**
+ * Configuration passed to a search provider during initialization.
+ * Populated from the SearchProvider entity record.
+ */
+export interface SearchProviderConfig {
+    /** The provider's display name from the metadata record */
+    Name: string;
+    /** Optional JSON config blob from ProviderConfig column (already parsed) */
+    ProviderConfig: Record<string, unknown> | null;
+    /** Optional credential ID for providers that need authentication */
+    CredentialID: string | null;
+    /** Per-provider max results override (null = use engine default) */
+    MaxResultsOverride: number | null;
+    /** Whether this provider should participate in preview/autocomplete searches */
+    SupportsPreview: boolean;
+    /** Priority value from the metadata record (lower = higher priority) */
+    Priority: number;
+}
+/**
+ * Abstract base class for search providers. Subclasses must be registered
+ * with @RegisterClass(BaseSearchProvider, 'DriverClassName') to be
+ * discoverable by the SearchEngine.
+ *
+ * Lifecycle:
+ * 1. SearchEngine loads active SearchProvider records from the database
+ * 2. For each record, ClassFactory creates an instance using DriverClass
+ * 3. Initialize() is called with the provider's config from the DB record
+ * 4. CheckAvailability() is called to verify the provider is operational
+ * 5. If IsAvailable(), the provider participates in searches
+ */
+export declare abstract class BaseSearchProvider {
+    /** Which search source this provider represents */
+    abstract readonly SourceType: SearchSource;
+    /** Config from the SearchProvider metadata record, set during Initialize() */
+    protected config: SearchProviderConfig | null;
+    /**
+     * Initialize the provider with configuration from the SearchProvider entity.
+     * Called once during SearchEngine.Config(). Override to perform provider-specific
+     * setup (e.g., connecting to external APIs using credentials).
+     *
+     * @param config - Configuration from the SearchProvider metadata record
+     * @param contextUser - The user context for initialization
+     */
+    Initialize(config: SearchProviderConfig, contextUser: UserInfo): Promise<void>;
+    /**
+     * Check and cache whether this provider is operational.
+     * Called after Initialize(). Override for providers that need to verify
+     * external dependencies (e.g., vector indexes exist, API keys are valid).
+     *
+     * The default implementation returns true (always available).
+     *
+     * @param contextUser - The user context for availability checks
+     */
+    CheckAvailability(contextUser: UserInfo): Promise<void>;
+    /**
+     * Whether this provider is currently available (configured and operational).
+     * The SearchEngine will skip providers that return false.
+     */
+    IsAvailable(): boolean;
+    /**
+     * Execute a search and return result items with scores.
+     *
+     * @param query - The search query text
+     * @param topK - Maximum number of results to retrieve
+     * @param filters - Optional filters to narrow results
+     * @param contextUser - The user performing the search
+     * @returns Scored result items from this provider
+     */
+    abstract Search(query: string, topK: number, filters: SearchFilters | undefined, contextUser: UserInfo): Promise<SearchResultItem[]>;
+}
+/**
+ * @deprecated Use BaseSearchProvider instead. Kept for backwards compatibility.
+ */
+export type ISearchProvider = BaseSearchProvider;
+//# sourceMappingURL=ISearchProvider.d.ts.map

package/dist/generic/ISearchProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISearchProvider.d.ts","sourceRoot":"","sources":["../../src/generic/ISearchProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAE/E;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAC;IACb,4EAA4E;IAC5E,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC/C,oEAAoE;IACpE,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,oEAAoE;IACpE,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,gFAAgF;IAChF,eAAe,EAAE,OAAO,CAAC;IACzB,wEAAwE;IACxE,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;GAWG;AACH,8BAAsB,kBAAkB;IACpC,mDAAmD;IACnD,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC;IAE3C,8EAA8E;IAC9E,SAAS,CAAC,MAAM,EAAE,oBAAoB,GAAG,IAAI,CAAQ;IAErD;;;;;;;OAOG;IACU,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,WAAW,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3F;;;;;;;;OAQG;IACU,iBAAiB,CAAC,WAAW,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpE;;;OAGG;IACI,WAAW,IAAI,OAAO;IAI7B;;;;;;;;OAQG;IACH,QAAQ,CAAC,MAAM,CACX,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,aAAa,GAAG,SAAS,EAClC,WAAW,EAAE,QAAQ,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,kBAAkB,CAAC"}

package/dist/generic/ISearchProvider.js

@@ -0,0 +1,62 @@
+/**
+ * @fileoverview Base class and interface for search providers.
+ *
+ * Each search provider implements a single retrieval strategy
+ * (vector similarity, full-text, entity LIKE-search, storage, etc.)
+ * and returns scored candidates suitable for RRF fusion.
+ *
+ * Providers are discovered at runtime via @RegisterClass and the
+ * SearchProvider metadata entity. The DriverClass column in the
+ * SearchProvider table maps to the @RegisterClass key.
+ *
+ * @module @memberjunction/search-engine
+ */
+/**
+ * Abstract base class for search providers. Subclasses must be registered
+ * with @RegisterClass(BaseSearchProvider, 'DriverClassName') to be
+ * discoverable by the SearchEngine.
+ *
+ * Lifecycle:
+ * 1. SearchEngine loads active SearchProvider records from the database
+ * 2. For each record, ClassFactory creates an instance using DriverClass
+ * 3. Initialize() is called with the provider's config from the DB record
+ * 4. CheckAvailability() is called to verify the provider is operational
+ * 5. If IsAvailable(), the provider participates in searches
+ */
+export class BaseSearchProvider {
+    constructor() {
+        /** Config from the SearchProvider metadata record, set during Initialize() */
+        this.config = null;
+    }
+    /**
+     * Initialize the provider with configuration from the SearchProvider entity.
+     * Called once during SearchEngine.Config(). Override to perform provider-specific
+     * setup (e.g., connecting to external APIs using credentials).
+     *
+     * @param config - Configuration from the SearchProvider metadata record
+     * @param contextUser - The user context for initialization
+     */
+    async Initialize(config, contextUser) {
+        this.config = config;
+    }
+    /**
+     * Check and cache whether this provider is operational.
+     * Called after Initialize(). Override for providers that need to verify
+     * external dependencies (e.g., vector indexes exist, API keys are valid).
+     *
+     * The default implementation returns true (always available).
+     *
+     * @param contextUser - The user context for availability checks
+     */
+    async CheckAvailability(contextUser) {
+        // Default: no-op, provider is always available
+    }
+    /**
+     * Whether this provider is currently available (configured and operational).
+     * The SearchEngine will skip providers that return false.
+     */
+    IsAvailable() {
+        return true;
+    }
+}
+//# sourceMappingURL=ISearchProvider.js.map

package/dist/generic/ISearchProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISearchProvider.js","sourceRoot":"","sources":["../../src/generic/ISearchProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAwBH;;;;;;;;;;;GAWG;AACH,MAAM,OAAgB,kBAAkB;IAAxC;QAII,8EAA8E;QACpE,WAAM,GAAgC,IAAI,CAAC;IAkDzD,CAAC;IAhDG;;;;;;;OAOG;IACI,KAAK,CAAC,UAAU,CAAC,MAA4B,EAAE,WAAqB;QACvE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,iBAAiB,CAAC,WAAqB;QAChD,+CAA+C;IACnD,CAAC;IAED;;;OAGG;IACI,WAAW;QACd,OAAO,IAAI,CAAC;IAChB,CAAC;CAiBJ"}