@nexo-labs/payload-typesense 1.9.8 → 1.10.0

package/dist/index.d.mts

@@ -6,6 +6,71 @@ import { Agent } from "http";
 import { Agent as Agent$1 } from "https";
 import { ReadStream } from "fs";
 
+//#region src/adapter/types.d.ts
+
+/**
+ * All valid Typesense field types
+ * @see https://typesense.org/docs/latest/api/collections.html#schema-parameters
+ */
+type TypesenseFieldType = 'string' | 'int32' | 'int64' | 'float' | 'bool' | 'string[]' | 'float[]' | 'int32[]' | 'int64[]' | 'bool[]' | 'object' | 'object[]' | 'geopoint' | 'geopoint[]' | 'auto';
+/**
+ * Typesense-specific field mapping
+ * Extends the base FieldMapping with Typesense-specific properties
+ *
+ * @example
+ * ```typescript
+ * const fields: TypesenseFieldMapping[] = [
+ *   { name: 'title', type: 'string', index: true },
+ *   { name: 'views', type: 'int64' },
+ *   { name: 'tags', type: 'string[]', facet: true },
+ *   { name: 'category', payloadField: 'category.name', type: 'string', facet: true },
+ * ];
+ * ```
+ */
+interface TypesenseFieldMapping extends FieldMapping {
+  /**
+   * Typesense field type
+   */
+  type: TypesenseFieldType;
+  /**
+   * Whether the field should be faceted (filterable in Typesense UI)
+   */
+  facet?: boolean;
+  /**
+   * Whether the field should be indexed (searchable)
+   * @default true
+   */
+  index?: boolean;
+  /**
+   * Whether the field is optional (can be missing from documents)
+   */
+  optional?: boolean;
+}
+/**
+ * Typesense field schema for collection creation
+ * Used internally when creating/updating collections
+ */
+interface TypesenseFieldSchema {
+  name: string;
+  type: TypesenseFieldType;
+  facet?: boolean;
+  index?: boolean;
+  optional?: boolean;
+  /** Number of dimensions for vector fields (float[]) */
+  vectorDimensions?: number;
+  /** Allow additional properties for compatibility with BaseCollectionSchema */
+  [key: string]: unknown;
+}
+/**
+ * Typesense collection schema for creation/update
+ * Extends BaseCollectionSchema with Typesense-specific options
+ */
+interface TypesenseCollectionSchema extends BaseCollectionSchema {
+  fields: TypesenseFieldSchema[];
+  /** Default sorting field (must be a numeric field) */
+  defaultSortingField?: string;
+}
+//#endregion
 //#region src/shared/types/plugin-types.d.ts
 /**
  * Hybrid search configuration for combining semantic and keyword search
@@ -393,10 +458,10 @@ interface TypesenseSearchConfig {
  * Configuration for the Typesense RAG plugin
  * ...
  */
-interface TypesenseRAGPluginConfig<TSlug extends CollectionSlug> {
+interface TypesenseRAGPluginConfig {
   /** Typesense connection configuration */
   typesense: TypesenseConnectionConfig;
-  collectionName: TSlug;
+  collectionName: CollectionSlug;
   /**
    * Embedding provider config (for RAG query embedding)
    * Note: The RAG handler creates its own provider instance to track usage/spending.
@@ -404,7 +469,7 @@ interface TypesenseRAGPluginConfig<TSlug extends CollectionSlug> {
    */
   embeddingConfig?: EmbeddingProviderConfig;
   /** Collection configurations (for schema sync) */
-  collections?: Record<string, TableConfig[]>;
+  collections?: Record<string, TableConfig<TypesenseFieldMapping>[]>;
   /** Search configuration */
   search?: TypesenseSearchConfig;
   /** RAG agent configurations */
@@ -434,7 +499,7 @@ interface TypesenseRAGPluginConfig<TSlug extends CollectionSlug> {
  * @param config - Typesense RAG plugin configuration
  * @returns Payload config modifier function
  */
-declare function createTypesenseRAGPlugin<TConfig extends Config, TSlug extends CollectionSlug>(config: TypesenseRAGPluginConfig<TSlug>): (payloadConfig: TConfig) => TConfig;
+declare function createTypesenseRAGPlugin(config: TypesenseRAGPluginConfig): (payloadConfig: Config) => Config;
 //#endregion
 //#region ../../node_modules/.pnpm/typesense@2.1.0_@babel+runtime@7.28.6/node_modules/typesense/lib/Typesense/Errors/TypesenseError.d.ts
 declare class TypesenseError extends Error {
@@ -1828,70 +1893,6 @@ declare class Client {
   nlSearchModels(id: string): NLSearchModel;
 }
 //#endregion
-//#region src/adapter/types.d.ts
-/**
- * All valid Typesense field types
- * @see https://typesense.org/docs/latest/api/collections.html#schema-parameters
- */
-type TypesenseFieldType = 'string' | 'int32' | 'int64' | 'float' | 'bool' | 'string[]' | 'float[]' | 'int32[]' | 'int64[]' | 'bool[]' | 'object' | 'object[]' | 'geopoint' | 'geopoint[]' | 'auto';
-/**
- * Typesense-specific field mapping
- * Extends the base FieldMapping with Typesense-specific properties
- *
- * @example
- * ```typescript
- * const fields: TypesenseFieldMapping[] = [
- *   { name: 'title', type: 'string', index: true },
- *   { name: 'views', type: 'int64' },
- *   { name: 'tags', type: 'string[]', facet: true },
- *   { name: 'category', payloadField: 'category.name', type: 'string', facet: true },
- * ];
- * ```
- */
-interface TypesenseFieldMapping extends FieldMapping {
-  /**
-   * Typesense field type
-   */
-  type: TypesenseFieldType;
-  /**
-   * Whether the field should be faceted (filterable in Typesense UI)
-   */
-  facet?: boolean;
-  /**
-   * Whether the field should be indexed (searchable)
-   * @default true
-   */
-  index?: boolean;
-  /**
-   * Whether the field is optional (can be missing from documents)
-   */
-  optional?: boolean;
-}
-/**
- * Typesense field schema for collection creation
- * Used internally when creating/updating collections
- */
-interface TypesenseFieldSchema {
-  name: string;
-  type: TypesenseFieldType;
-  facet?: boolean;
-  index?: boolean;
-  optional?: boolean;
-  /** Number of dimensions for vector fields (float[]) */
-  vectorDimensions?: number;
-  /** Allow additional properties for compatibility with BaseCollectionSchema */
-  [key: string]: unknown;
-}
-/**
- * Typesense collection schema for creation/update
- * Extends BaseCollectionSchema with Typesense-specific options
- */
-interface TypesenseCollectionSchema extends BaseCollectionSchema {
-  fields: TypesenseFieldSchema[];
-  /** Default sorting field (must be a numeric field) */
-  defaultSortingField?: string;
-}
-//#endregion
 //#region src/adapter/typesense-adapter.d.ts
 /**
  * Typesense implementation of the IndexerAdapter interface
@@ -2036,7 +2037,7 @@ interface FeatureFlags {
 interface ModularPluginConfig {
   typesense: TypesenseConnectionConfig;
   features: FeatureFlags;
-  collections: Record<CollectionSlug | string, TableConfig[]>;
+  collections: Record<CollectionSlug | string, TableConfig<TypesenseFieldMapping>[]>;
   /** Resolve document type from Typesense collection name */
   documentTypeResolver?: (collectionName: string) => string;
 }
@@ -2393,23 +2394,28 @@ declare function executeRAGSearch(typesenseConfig: TypesenseConnectionConfig, se
 //#endregion
 //#region src/features/rag/handlers/session-handlers.d.ts
 /**
- * Session data structure
+ * Common fields shared between public session data and internal session documents
  */
-type ChatSessionData = {
+type ChatSessionBase = {
+  total_tokens?: number;
+  total_cost?: number;
+  last_activity?: string;
+};
+/**
+ * Public session data structure
+ */
+type ChatSessionData = ChatSessionBase & {
   conversation_id: string;
   title?: string;
   messages: Array<Record<string, unknown>>;
   status: string;
-  total_tokens?: number;
-  total_cost?: number;
-  last_activity?: string;
 };
 /**
  * Configuration for session operations
  */
-type SessionConfig<TSlug extends CollectionSlug> = {
+type SessionConfig = {
   /** Collection name for sessions */
-  collectionName?: TSlug;
+  collectionName?: CollectionSlug;
   /** Time window for active sessions in milliseconds */
   activeSessionWindow?: number;
 };
@@ -2421,7 +2427,7 @@ type SessionConfig<TSlug extends CollectionSlug> = {
  * @param config - Session configuration
  * @returns Promise with session data or null
  */
-declare function getActiveSession<TSlug extends CollectionSlug>(payload: Payload, userId: string | number, config?: SessionConfig<TSlug>): Promise<ChatSessionData | null>;
+declare function getActiveSession(payload: Payload, userId: string | number, config?: SessionConfig): Promise<ChatSessionData | null>;
 /**
  * Get session by conversation ID
  *
@@ -2431,7 +2437,7 @@ declare function getActiveSession<TSlug extends CollectionSlug>(payload: Payload
  * @param config - Session configuration
  * @returns Promise with session data or null
  */
-declare function getSessionByConversationId<TSlug extends CollectionSlug>(payload: Payload, userId: string | number, conversationId: string, config?: SessionConfig<TSlug>): Promise<ChatSessionData | null>;
+declare function getSessionByConversationId(payload: Payload, userId: string | number, conversationId: string, config?: SessionConfig): Promise<ChatSessionData | null>;
 /**
  * Close a chat session
  *
@@ -2441,7 +2447,7 @@ declare function getSessionByConversationId<TSlug extends CollectionSlug>(payloa
  * @param config - Session configuration
  * @returns Promise with updated session data or null if not found
  */
-declare function closeSession<TSlug extends CollectionSlug>(payload: Payload, userId: string | number, conversationId: string, config?: SessionConfig<TSlug>): Promise<ChatSessionData | null>;
+declare function closeSession(payload: Payload, userId: string | number, conversationId: string, config?: SessionConfig): Promise<ChatSessionData | null>;
 //#endregion
 //#region src/features/rag/query-builder.d.ts
 /**
@@ -2627,7 +2633,7 @@ declare const deleteDocumentFromTypesense: (typesenseClient: Client, collectionS
  *
  * @param config - RAG plugin configuration (composable, doesn't depend on ModularPluginConfig)
  */
-declare function createRAGPayloadHandlers<TSlug extends CollectionSlug>(config: TypesenseRAGPluginConfig<TSlug>): Array<{
+declare function createRAGPayloadHandlers(config: TypesenseRAGPluginConfig): Array<{
   path: string;
   method: 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put';
   handler: PayloadHandler;