@rubixstudios/payload-typesense 1.1.1 → 1.1.2

package/dist/endpoints/handler/createSearch.js

@@ -0,0 +1,119 @@
+import { searchCache } from '../../lib/cache.js';
+import { getValidationErrors, validateSearchParams } from '../../lib/validation.js';
+import { getAllCollections } from '../../utils/getAllCollections.js';
+export const createSearch = (typesenseClient, pluginOptions)=>{
+    return async (request)=>{
+        try {
+            if (!request.url) {
+                return Response.json({
+                    error: 'Request URL missing'
+                }, {
+                    status: 400
+                });
+            }
+            const url = new URL(request.url);
+            const parts = url.pathname.split('/');
+            const searchIndex = parts.indexOf('search');
+            const collectionName = searchIndex >= 0 ? parts[searchIndex + 1] : '';
+            const collection = String(collectionName || '');
+            const q = url.searchParams.get('q') || '';
+            const page = Number(url.searchParams.get('page') || 1);
+            const per_page = Number(url.searchParams.get('per_page') || 10);
+            const sort_by = url.searchParams.get('sort_by') || undefined;
+            if (isNaN(page) || page < 1) {
+                return Response.json({
+                    error: 'Invalid page parameter'
+                }, {
+                    status: 400
+                });
+            }
+            if (isNaN(per_page) || per_page < 1 || per_page > 250) {
+                return Response.json({
+                    error: 'Invalid per_page parameter'
+                }, {
+                    status: 400
+                });
+            }
+            const validation = validateSearchParams({
+                page,
+                per_page,
+                q,
+                sort_by
+            });
+            if (!validation.success) {
+                return Response.json({
+                    details: getValidationErrors(validation.errors || []),
+                    error: 'Invalid search parameters'
+                }, {
+                    status: 400
+                });
+            }
+            if (!collection) {
+                if (!q.trim()) {
+                    return Response.json({
+                        details: 'Use /api/search?q=keyword',
+                        error: 'Query parameter "q" is required'
+                    }, {
+                        status: 400
+                    });
+                }
+                return getAllCollections(typesenseClient, pluginOptions, q, {
+                    filters: {},
+                    page,
+                    per_page,
+                    sort_by
+                });
+            }
+            if (!pluginOptions.collections?.[collection]?.enabled) {
+                return Response.json({
+                    error: 'Collection not enabled for search'
+                }, {
+                    status: 400
+                });
+            }
+            if (!q.trim()) {
+                return Response.json({
+                    error: 'Query parameter "q" is required'
+                }, {
+                    status: 400
+                });
+            }
+            const fields = pluginOptions.collections?.[collection]?.searchFields?.join(',') || 'title,content';
+            const searchParams = {
+                highlight_full_fields: fields,
+                num_typos: 0,
+                page,
+                per_page,
+                q,
+                query_by: fields,
+                snippet_threshold: 30,
+                typo_tokens_threshold: 1,
+                ...sort_by ? {
+                    sort_by
+                } : {}
+            };
+            const cached = searchCache.get(q, collection, {
+                page,
+                per_page,
+                sort_by
+            });
+            if (cached) {
+                return Response.json(cached);
+            }
+            const results = await typesenseClient.collections(collection).documents().search(searchParams);
+            searchCache.set(q, results, collection, {
+                page,
+                per_page,
+                sort_by
+            });
+            return Response.json(results);
+        } catch (error) {
+            return Response.json({
+                details: error instanceof Error ? error.message : 'Unknown error',
+                error: 'Search handler failed'
+            }, {
+                status: 500
+            });
+        }
+    };
+};

package/dist/endpoints/handler/createSuggest.d.ts

@@ -0,0 +1,5 @@
+import type Typesense from 'typesense';
+import { type PayloadHandler } from 'payload';
+import { type TypesenseSearchConfig } from '../../index.js';
+export declare const createSuggest: (typesenseClient: Typesense.Client, pluginOptions: TypesenseSearchConfig) => PayloadHandler;
+//# sourceMappingURL=createSuggest.d.ts.map

package/dist/endpoints/handler/createSuggest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createSuggest.d.ts","sourceRoot":"","sources":["../../../src/endpoints/handler/createSuggest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,SAAS,MAAM,WAAW,CAAA;AAEtC,OAAO,EAAE,KAAK,cAAc,EAAuB,MAAM,SAAS,CAAA;AAElE,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAE3D,eAAO,MAAM,aAAa,GACxB,iBAAiB,SAAS,CAAC,MAAM,EACjC,eAAe,qBAAqB,KACnC,cA0CF,CAAA"}

package/dist/endpoints/handler/createSuggest.js

@@ -0,0 +1,50 @@
+export const createSuggest = (typesenseClient, pluginOptions)=>{
+    return async (request)=>{
+        if (!request.url) {
+            return Response.json({
+                error: 'Request URL missing'
+            }, {
+                status: 400
+            });
+        }
+        const url = new URL(request.url);
+        const parts = url.pathname.split('/');
+        const searchIndex = parts.indexOf('search');
+        const collectionName = searchIndex >= 0 ? parts[searchIndex + 1] : '';
+        const collection = String(collectionName || '');
+        if (!collection || !pluginOptions.collections?.[collection]?.enabled) {
+            return Response.json({
+                error: 'Collection not enabled for search'
+            }, {
+                status: 400
+            });
+        }
+        const q = url.searchParams.get('q');
+        const limitStr = url.searchParams.get('limit');
+        const limit = Number(limitStr ?? 5);
+        if (!q) {
+            return Response.json({
+                error: 'Query parameter "q" is required'
+            }, {
+                status: 400
+            });
+        }
+        const fields = pluginOptions.collections?.[collection]?.searchFields?.join(',') || 'title,content';
+        try {
+            const suggestResults = await typesenseClient.collections(collection).documents().search({
+                highlight_full_fields: fields,
+                per_page: limit,
+                q,
+                query_by: fields,
+                snippet_threshold: 30
+            });
+            return Response.json(suggestResults);
+        } catch  {
+            return Response.json({
+                error: 'Suggest failed'
+            }, {
+                status: 500
+            });
+        }
+    };
+};

package/dist/endpoints/health.d.ts

@@ -1,12 +1,6 @@
-import type { PayloadHandler } from 'payload';
 import type Typesense from 'typesense';
-import type { TypesenseSearchConfig } from '../index.js';
-/**
- * Create health check handler
- */
-export declare const createHealthCheckHandler: (typesenseClient: Typesense.Client, pluginOptions: TypesenseSearchConfig, lastSyncTime?: number) => PayloadHandler;
-/**
- * Create detailed health check handler with more information
- */
-export declare const createDetailedHealthCheckHandler: (typesenseClient: Typesense.Client, pluginOptions: TypesenseSearchConfig, lastSyncTime?: number) => PayloadHandler;
+import { type PayloadHandler } from 'payload';
+import { type TypesenseSearchConfig } from '../index.js';
+export declare const createHealthCheck: (typesenseClient: Typesense.Client, _pluginOptions: TypesenseSearchConfig, lastSyncTime?: number) => PayloadHandler;
+export declare const createDetailedHealthCheck: (typesenseClient: Typesense.Client, pluginOptions: TypesenseSearchConfig, lastSyncTime?: number) => PayloadHandler;
 //# sourceMappingURL=health.d.ts.map

package/dist/endpoints/health.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"health.d.ts","sourceRoot":"","sources":["../../src/endpoints/health.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAC7C,OAAO,KAAK,SAAS,MAAM,WAAW,CAAA;AAEtC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AA4CxD;;GAEG;AACH,eAAO,MAAM,wBAAwB,GACnC,iBAAiB,SAAS,CAAC,MAAM,EACjC,eAAe,qBAAqB,EACpC,eAAe,MAAM,KACpB,cA2DF,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,gCAAgC,GAC3C,iBAAiB,SAAS,CAAC,MAAM,EACjC,eAAe,qBAAqB,EACpC,eAAe,MAAM,KACpB,cAuFF,CAAA"}
+{"version":3,"file":"health.d.ts","sourceRoot":"","sources":["../../src/endpoints/health.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,SAAS,MAAM,WAAW,CAAA;AAEtC,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,SAAS,CAAA;AAG7C,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAOxD,eAAO,MAAM,iBAAiB,GAC5B,iBAAiB,SAAS,CAAC,MAAM,EACjC,gBAAgB,qBAAqB,EACrC,eAAe,MAAM,KACpB,cAsCF,CAAA;AAED,eAAO,MAAM,yBAAyB,GACpC,iBAAiB,SAAS,CAAC,MAAM,EACjC,eAAe,qBAAqB,EACpC,eAAe,MAAM,KACpB,cAsFF,CAAA"}

package/dist/endpoints/health.js

@@ -1,88 +1,43 @@
 import pkg from '../../package.json';
-import { searchCache } from '../lib/cache.js';
-/**
- * Test Typesense connection
- */ const testTypesenseConnection = async (typesenseClient)=>{
-    try {
-        const health = await typesenseClient.health.retrieve();
-        return health.ok === true;
-    } catch (_error) {
-        // Handle health check error
-        return false;
-    }
-};
-/**
- * Get collection information
- */ const getCollectionInfo = async (typesenseClient)=>{
-    try {
-        const collections = await typesenseClient.collections().retrieve();
-        return collections.map((col)=>col.name);
-    } catch (_error) {
-        // Handle collections retrieval error
-        return [];
-    }
-};
-/**
- * Get cache statistics
- */ const getCacheStats = ()=>{
-    const stats = searchCache.getStats();
-    return {
-        hitRate: stats.hitRate || 0,
-        maxSize: stats.maxSize,
-        size: stats.size
-    };
-};
-/**
- * Create health check handler
- */ export const createHealthCheckHandler = (typesenseClient, pluginOptions, lastSyncTime)=>{
+import { buildError } from '../utils/buildError.js';
+import { getCacheStats } from '../utils/getCacheStats.js';
+import { getCollectionInfo } from '../utils/getCollectionInfo.js';
+import { testConnection } from '../utils/testConnection.js';
+export const createHealthCheck = (typesenseClient, _pluginOptions, lastSyncTime)=>{
     return async ()=>{
+        const start = Date.now();
         try {
-            const startTime = Date.now();
-            // Test Typesense connection
-            const isTypesenseHealthy = await testTypesenseConnection(typesenseClient);
-            const typesenseInfo = isTypesenseHealthy ? {
-                ok: true,
-                version: 'unknown'
-            } : {
-                ok: false
-            };
-            // Get collection information
+            const isTypesenseHealthy = await testConnection(typesenseClient);
             const collections = isTypesenseHealthy ? await getCollectionInfo(typesenseClient) : [];
-            // Get cache statistics
             const cacheStats = getCacheStats();
-            // Determine overall health status
             const isHealthy = isTypesenseHealthy && collections.length > 0;
-            const response = {
+            const base = {
                 cache: cacheStats,
                 collections,
+                status: isHealthy ? 'healthy' : 'unhealthy',
+                typesense: {
+                    ok: isTypesenseHealthy,
+                    version: 'unknown'
+                },
                 ...lastSyncTime !== undefined && {
                     lastSync: lastSyncTime
-                },
-                status: isHealthy ? 'healthy' : 'unhealthy',
-                typesense: typesenseInfo
-            };
-            // Add error details if unhealthy
-            if (!isHealthy) {
-                const errors = [];
-                if (!isTypesenseHealthy) {
-                    errors.push('Typesense connection failed');
-                }
-                if (collections.length === 0) {
-                    errors.push('No collections available');
                 }
-                response.error = errors.join(', ');
-            }
-            const responseTime = Date.now() - startTime;
+            };
+            const error = buildError(isTypesenseHealthy, collections.length > 0);
+            const responseTime = Date.now() - start;
             return Response.json({
-                ...response,
+                ...base,
+                ...error && {
+                    error
+                },
                 responseTime,
                 timestamp: new Date().toISOString(),
                 version: pkg.version
             });
-        } catch (_error) {
+        } catch (err) {
             const errorResponse = {
                 cache: getCacheStats(),
-                error: _error instanceof Error ? _error.message : 'Unknown error',
+                error: err instanceof Error ? err.message : 'Unknown error',
                 status: 'unhealthy'
             };
             return Response.json(errorResponse, {
@@ -91,32 +46,27 @@ import { searchCache } from '../lib/cache.js';
         }
     };
 };
-/**
- * Create detailed health check handler with more information
- */ export const createDetailedHealthCheckHandler = (typesenseClient, pluginOptions, lastSyncTime)=>{
+export const createDetailedHealthCheck = (typesenseClient, pluginOptions, lastSyncTime)=>{
     return async ()=>{
+        const start = Date.now();
         try {
-            const startTime = Date.now();
-            // Test Typesense connection
-            const isTypesenseHealthy = await testTypesenseConnection(typesenseClient);
-            // Get detailed collection information
-            let collections = [];
+            const isTypesenseHealthy = await testConnection(typesenseClient);
+            let collectionDetails = [];
             if (isTypesenseHealthy) {
                 try {
                     const collectionsData = await typesenseClient.collections().retrieve();
-                    collections = collectionsData.map((col)=>({
+                    collectionDetails = collectionsData.map((col)=>({
                             name: col.name,
                             createdAt: col.created_at,
                             fields: col.fields?.length || 0,
                             numDocuments: col.num_documents
                         }));
-                } catch (_error) {
-                // Handle detailed collection info error
+                } catch  {
+                // ignore detailed retrieval error
                 }
             }
-            // Get cache statistics
+            const collections = collectionDetails.map((c)=>c.name);
             const cacheStats = getCacheStats();
-            // Get plugin configuration info
             const configInfo = {
                 enabledCollections: Object.entries(pluginOptions.collections || {}).filter(([_, config])=>config?.enabled).map(([name, config])=>({
                         name,
@@ -127,45 +77,37 @@ import { searchCache } from '../lib/cache.js';
                 settings: pluginOptions.settings,
                 totalCollections: Object.keys(pluginOptions.collections || {}).length
             };
-            // Determine overall health status
-            const isHealthy = isTypesenseHealthy && collections.length > 0;
+            const isHealthy = isTypesenseHealthy && collectionDetails.length > 0;
             const response = {
                 cache: cacheStats,
-                collectionDetails: collections,
-                collections: collections.map((col)=>col.name),
+                collectionDetails,
+                collections,
                 config: configInfo,
                 lastSync: lastSyncTime,
-                responseTime: Date.now() - startTime,
+                responseTime: Date.now() - start,
                 status: isHealthy ? 'healthy' : 'unhealthy',
                 timestamp: new Date().toISOString(),
                 typesense: {
                     ok: isTypesenseHealthy,
                     version: 'unknown'
                 },
-                version: pkg.version
-            };
-            // Add error details if unhealthy
-            if (!isHealthy) {
-                const errors = [];
-                if (!isTypesenseHealthy) {
-                    errors.push('Typesense connection failed');
+                version: pkg.version,
+                ...isHealthy ? {} : {
+                    error: [
+                        !isTypesenseHealthy && 'Typesense connection failed',
+                        collectionDetails.length === 0 && 'No collections available'
+                    ].filter(Boolean).join(', ')
                 }
-                if (collections.length === 0) {
-                    errors.push('No collections available');
-                }
-                response.error = errors.join(', ');
-            }
+            };
             return Response.json(response);
-        } catch (_error) {
-            // Handle detailed health check error
-            const errorResponse = {
+        } catch (error) {
+            return Response.json({
                 cache: getCacheStats(),
-                error: _error instanceof Error ? _error.message : 'Unknown error',
+                error: error instanceof Error ? error.message : 'Unknown error',
                 status: 'unhealthy',
                 timestamp: new Date().toISOString(),
                 version: pkg.version
-            };
-            return Response.json(errorResponse, {
+            }, {
                 status: 500
             });
         }

package/dist/endpoints/search.d.ts

@@ -1,12 +1,11 @@
-import type { PayloadHandler } from "payload";
-import type Typesense from "typesense";
-import type { TypesenseSearchConfig } from "../index.js";
+import type Typesense from 'typesense';
+import { type TypesenseSearchConfig } from '../index.js';
 export declare const createSearchEndpoints: (typesenseClient: Typesense.Client, pluginOptions: TypesenseSearchConfig, lastSyncTime?: number) => ({
-    handler: PayloadHandler;
+    handler: import("payload").PayloadHandler;
     method: "get";
     path: string;
 } | {
-    handler: PayloadHandler;
+    handler: import("payload").PayloadHandler;
     method: "post";
     path: string;
 })[];

package/dist/endpoints/search.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../src/endpoints/search.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAC7C,OAAO,KAAK,SAAS,MAAM,WAAW,CAAA;AAEtC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AA0IxD,eAAO,MAAM,qBAAqB,GACjC,iBAAiB,SAAS,CAAC,MAAM,EACjC,eAAe,qBAAqB,EACpC,eAAe,MAAM;;;;;;;;IA+CrB,CAAA"}
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../src/endpoints/search.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,SAAS,MAAM,WAAW,CAAA;AAEtC,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAOxD,eAAO,MAAM,qBAAqB,GAChC,iBAAiB,SAAS,CAAC,MAAM,EACjC,eAAe,qBAAqB,EACpC,eAAe,MAAM;;;;;;;;IAuCtB,CAAA"}