@rubixstudios/payload-typesense 1.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Front Tribe (https://fronttribe.com)
+Copyright (c) 2025 Rubix Studios Pty. Ltd. <hello@rubixstudios.com.au>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,182 @@
+# Typesense Plugin for Payload CMS
+
+This plugin is a fork of FrontTribe's Typesense Search Plugin for Payload CMS…
+
+A production-ready search plugin that integrates Typesense with Payload CMS, offering fast, typo-tolerant search with real-time synchronization. This fork by Rubix Studios reduces bloat and introduces targeted changes for improved performance, maintainability, and flexibility.
+
+## Installation
+
+```sh
+pnpm add @rubixstudios/typesense
+```
+
+```typescript
+// payload.config.ts
+import { buildConfig } from 'payload/config'
+import { typesenseSearch } from '@rubixstudios/typesense'
+
+export default buildConfig({
+  plugins: [
+    typesenseSearch({
+      typesense: {
+        apiKey: 'xyz',
+        nodes: [{ host: 'localhost', port: 8108, protocol: 'http' }],
+      },
+      collections: {
+        posts: {
+          enabled: true,
+          searchFields: ['title', 'content'],
+          facetFields: ['category', 'status'],
+          displayName: 'Blog Posts',
+          icon: '📝',
+        },
+      },
+    }),
+  ],
+})
+```
+
+```tsx
+// 4. Use the search component
+import { HeadlessSearchInput } from '@rubixstudios/typesense'
+
+function SearchPage() {
+  return (
+    <HeadlessSearchInput
+      baseUrl="http://localhost:3000"
+      theme="modern" // Choose from: modern, dark
+      placeholder="Search everything..."
+      onResultClick={(result) => {
+        console.log('Selected:', result.document)
+      }}
+    />
+  )
+}
+
+// Multi-collection search
+function MultiCollectionSearch() {
+  return (
+    <HeadlessSearchInput
+      baseUrl="http://localhost:3000"
+      collections={['posts', 'products']}
+      placeholder="Search posts & products..."
+      onResultClick={(result) => {
+        console.log('Selected:', result.document)
+      }}
+    />
+  )
+}
+
+// Single collection search
+function PostSearch() {
+  return (
+    <HeadlessSearchInput
+      baseUrl="http://localhost:3000"
+      collection="posts"
+      placeholder="Search posts..."
+      onResultClick={(result) => {
+        console.log('Selected:', result.document)
+      }}
+    />
+  )
+}
+```
+
+## Features
+
+- **Performance**: Sub-millisecond response times for search queries
+- **Flexible Search**: Single, multiple, or universal collection search with one component
+- **Modern Interface**: Responsive design implemented with Tailwind CSS
+- **Optimized API**: Automatically routes requests to the most efficient endpoint
+- **Real-Time Sync**: Continuous data sync with Payload CMS
+- **Built-in Caching**: In-memory cache with configurable time-to-live settings
+- **Production Ready**: Robust error handling and performance optimization
+- **Responsive**: Mobile-first architecture ensuring compatibility across devices
+
+## API Endpoints
+
+- `GET /api/search` - Universal search across all collections
+- `GET /api/search/{collection}` - Search specific collection
+- `POST /api/search/{collection}` - Advanced search with filters
+- `GET /api/search/{collection}/suggest` - Search suggestions
+- `GET /api/search/collections` - Collection metadata
+- `GET /api/search/health` - Health check
+
+## Components
+
+- **HeadlessSearchInput** - Single component supporting all search patterns:
+- **Single Collection**: `collection="posts"` - Direct API calls for optimal performance
+- **Multiple Collections**: `collections={['posts', 'products']}` - Smart filtering with universal search
+- **Universal Search**: No collection props - Search across all collections
+- **Complete UI Control**: Customizable rendering with comprehensive theme system
+
+## Theme System
+
+The plugin includes a powerful theme system with 5 pre-built themes and unlimited customization:
+
+### Pre-built Themes
+
+```tsx
+// Modern theme (default) - Clean and professional
+<HeadlessSearchInput theme="modern" />
+
+// Minimal theme - Flat design with minimal styling
+<HeadlessSearchInput theme="minimal" />
+
+// Elegant theme - Sophisticated with gradients
+<HeadlessSearchInput theme="elegant" />
+
+// Dark theme - Perfect for dark mode
+<HeadlessSearchInput theme="dark" />
+
+// Colorful theme - Vibrant and modern
+<HeadlessSearchInput theme="colorful" />
+```
+
+### Custom Themes
+
+```tsx
+const customTheme = {
+  theme: 'modern',
+  colors: {
+    inputBorderFocus: '#10b981',
+    inputBackground: '#f0fdf4',
+    resultsBackground: '#f0fdf4',
+  },
+  spacing: {
+    inputPadding: '1rem 1.25rem',
+    inputBorderRadius: '1.5rem',
+  },
+  enableAnimations: true,
+  enableShadows: true,
+}
+
+<HeadlessSearchInput theme={customTheme} />
+```
+
+### Theme Features
+
+- **2 Pre-built Themes**: Modern, Dark
+- **Unlimited Customization**: Override any color, spacing, typography, or animation
+- **Performance Options**: Disable animations/shadows for better performance
+- **Responsive Design**: Automatic mobile optimization
+- **CSS Variables**: Advanced styling with CSS custom properties
+- **TypeScript Support**: Full type safety for all theme configurations
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests
+5. Submit a pull request
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- [FrontTribe](https://github.com/FrontTribe/typesense-search)
+- [Typesense](https://typesense.org/)
+- [Payload CMS](https://payloadcms.com/)

package/dist/components/HeadlessSearchInput.d.ts

@@ -0,0 +1,86 @@
+import React from 'react';
+import type { BaseSearchInputProps, SearchResult } from '../lib/types.js';
+import type { ThemeConfig } from './themes/types.js';
+export interface HeadlessSearchInputProps<T = Record<string, unknown>> extends BaseSearchInputProps<T> {
+    /**
+     * Collection to search in (for single collection search)
+     */
+    collection?: string;
+    /**
+     * Collections to search in (for multi-collection search)
+     */
+    collections?: string[];
+    /**
+     * Enable suggestions
+     */
+    enableSuggestions?: boolean;
+    /**
+     * Number of results to show per page
+     */
+    perPage?: number;
+    /**
+     * Custom render function for error state
+     */
+    renderError?: (error: string) => React.ReactNode;
+    /**
+     * Custom input element (for complete control)
+     */
+    renderInput?: (props: {
+        className: string;
+        onBlur: (e: React.FocusEvent) => void;
+        onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+        onFocus: () => void;
+        onKeyDown: (e: React.KeyboardEvent) => void;
+        placeholder: string;
+        ref: React.RefObject<HTMLInputElement | null>;
+        value: string;
+    }) => React.ReactNode;
+    /**
+     * Custom render function for loading state
+     */
+    renderLoading?: () => React.ReactNode;
+    /**
+     * Custom render function for no results
+     */
+    renderNoResults?: (query: string) => React.ReactNode;
+    /**
+     * Custom render function for results
+     */
+    renderResult?: (result: SearchResult<T>, index: number) => React.ReactNode;
+    /**
+     * Custom render function for results header
+     */
+    renderResultsHeader?: (found: number, searchTime: number) => React.ReactNode;
+    /**
+     * Custom CSS class for individual result items
+     */
+    resultItemClassName?: string;
+    /**
+     * Custom CSS class for the results container
+     */
+    resultsClassName?: string;
+    /**
+     * Custom CSS class for results container
+     */
+    resultsContainerClassName?: string;
+    /**
+     * Show loading state
+     */
+    showLoading?: boolean;
+    /**
+     * Show result count
+     */
+    showResultCount?: boolean;
+    /**
+     * Show search time
+     */
+    showSearchTime?: boolean;
+    /**
+     * Theme configuration
+     */
+    theme?: string | ThemeConfig;
+}
+declare const HeadlessSearchInput: <T = Record<string, unknown>>({ baseUrl, className, collection, collections, debounceMs, enableSuggestions: _enableSuggestions, errorClassName, inputClassName, inputWrapperClassName, minQueryLength, noResultsClassName, onResultClick, onResults, onSearch, perPage, placeholder, renderError, renderInput, renderNoResults, renderResult, renderResultsHeader, resultItemClassName, resultsClassName, resultsContainerClassName, resultsHeaderClassName, resultsListClassName, showLoading, showResultCount, showSearchTime, theme, }: HeadlessSearchInputProps<T>) => React.ReactElement;
+export default HeadlessSearchInput;
+export { HeadlessSearchInput };
+//# sourceMappingURL=HeadlessSearchInput.d.ts.map

package/dist/components/HeadlessSearchInput.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HeadlessSearchInput.d.ts","sourceRoot":"","sources":["../../src/components/HeadlessSearchInput.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAmD,MAAM,OAAO,CAAA;AAEvE,OAAO,KAAK,EAAE,oBAAoB,EAAkB,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACzF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAIpD,MAAM,WAAW,wBAAwB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACnE,SAAQ,oBAAoB,CAAC,CAAC,CAAC;IAC/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,KAAK,CAAC,SAAS,CAAA;IAChD;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE;QACpB,SAAS,EAAE,MAAM,CAAA;QACjB,MAAM,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,KAAK,IAAI,CAAA;QACrC,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,KAAK,IAAI,CAAA;QAC1D,OAAO,EAAE,MAAM,IAAI,CAAA;QACnB,SAAS,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,aAAa,KAAK,IAAI,CAAA;QAC3C,WAAW,EAAE,MAAM,CAAA;QACnB,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAA;QAC7C,KAAK,EAAE,MAAM,CAAA;KACd,KAAK,KAAK,CAAC,SAAS,CAAA;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,KAAK,CAAC,SAAS,CAAA;IACrC;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,KAAK,CAAC,SAAS,CAAA;IACpD;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,KAAK,CAAC,SAAS,CAAA;IAC1E;;OAEG;IACH,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,KAAK,CAAC,SAAS,CAAA;IAC5E;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;CAC7B;AAED,QAAA,MAAM,mBAAmB,GAAI,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAG,6eA+BxD,wBAAwB,CAAC,CAAC,CAAC,KAAG,KAAK,CAAC,YAotBtC,CAAA;AAED,eAAe,mBAAmB,CAAA;AAClC,OAAO,EAAE,mBAAmB,EAAE,CAAA"}