@rubixstudios/payload-typesense 1.0.0

package/dist/lib/types.d.ts

@@ -0,0 +1,183 @@
+export interface BaseDocument {
+    _status?: 'draft' | 'published';
+    createdAt: Date | string;
+    id: string;
+    slug?: string;
+    updatedAt: Date | string;
+}
+export interface SearchResult<T = any> {
+    collection?: string;
+    content?: string;
+    displayName?: string;
+    document: T;
+    highlight?: {
+        [field: string]: {
+            matched_tokens: string[];
+            snippet: string;
+            value: string;
+        };
+    };
+    highlights?: Array<{
+        field: string;
+        matched_tokens: string[];
+        snippet: string;
+        value: string;
+    }>;
+    icon?: string;
+    id: string;
+    text_match?: number;
+    text_match_info?: {
+        best_field_score: string;
+        best_field_weight: number;
+        fields_matched: number;
+        score: string;
+        tokens_matched: number;
+    };
+    title?: string;
+    updatedAt?: string;
+}
+export interface SearchResponse<T = any> {
+    collections?: Array<{
+        collection: string;
+        displayName: string;
+        error?: string;
+        found: number;
+        icon: string;
+    }>;
+    found: number;
+    hits: SearchResult<T>[];
+    page: number;
+    request_params: {
+        page?: number;
+        per_page: number;
+        q: string;
+        sort_by?: string;
+    };
+    search_cutoff: boolean;
+    search_time_ms: number;
+}
+export interface SuggestResult<T = any> {
+    collection?: string;
+    displayName?: string;
+    document: T;
+    highlight?: Record<string, string>;
+    icon?: string;
+    text_match?: number;
+}
+export type SearchResultProps<T = any> = {
+    onClick?: (result: SearchResult<T>) => void;
+    result: SearchResult<T>;
+};
+export interface SuggestResponse<T = any> {
+    found: number;
+    hits: SuggestResult<T>[];
+    page: number;
+    request_params: {
+        per_page: number;
+        q: string;
+    };
+    search_cutoff: boolean;
+    search_time_ms: number;
+}
+export interface CollectionConfig<T = any> {
+    displayName?: string;
+    enabled?: boolean;
+    facetFields?: Array<keyof T | string>;
+    fieldMapping?: Record<string, string>;
+    icon?: string;
+    searchFields?: Array<keyof T | string>;
+}
+export interface TypesenseSearchConfig<T = Record<string, any>> {
+    collections: Record<string, CollectionConfig<T>>;
+    settings?: {
+        cache?: {
+            maxSize?: number;
+            ttl?: number;
+        };
+        categorized?: boolean;
+    };
+    typesense: {
+        apiKey: string;
+        connectionTimeoutSeconds?: number;
+        nodes: Array<{
+            host: string;
+            port: number;
+            protocol: 'http' | 'https';
+        }>;
+        numRetries?: number;
+        retryIntervalSeconds?: number;
+    };
+}
+export interface SearchParams {
+    facets?: string[];
+    filters?: Record<string, any>;
+    highlight_fields?: string[];
+    num_typos?: number;
+    page?: number;
+    per_page?: number;
+    q: string;
+    snippet_threshold?: number;
+    sort_by?: string;
+    typo_tokens_threshold?: number;
+}
+export interface BaseSearchInputProps<T = any> {
+    baseUrl: string;
+    className?: string;
+    collection?: string;
+    debounceMs?: number;
+    errorClassName?: string;
+    inputClassName?: string;
+    inputWrapperClassName?: string;
+    loadingClassName?: string;
+    maxResults?: number;
+    minQueryLength?: number;
+    noResultsClassName?: string;
+    onError?: (error: string) => void;
+    onLoading?: (loading: boolean) => void;
+    onResultClick?: (result: SearchResult<T>) => void;
+    onResults?: (results: SearchResponse<T>) => void;
+    onSearch?: (query: string, results: SearchResponse<T>) => void;
+    placeholder?: string;
+    resultsHeaderClassName?: string;
+    resultsListClassName?: string;
+}
+export interface CacheEntry<T = any> {
+    data: T;
+    timestamp: number;
+    ttl: number;
+}
+export interface CacheOptions {
+    maxSize?: number;
+    ttl?: number;
+}
+export interface HealthCheckResponse {
+    cache?: {
+        maxSize: number;
+        size: number;
+    };
+    collections?: string[];
+    error?: string;
+    lastSync?: number;
+    status: 'healthy' | 'unhealthy';
+    typesense?: {
+        ok: boolean;
+        version?: string;
+    };
+}
+export interface ErrorResponse {
+    code?: string;
+    details?: string;
+    error: string;
+    timestamp?: string;
+}
+export interface ApiResponse<T = any> {
+    data?: T;
+    error?: ErrorResponse;
+    meta?: {
+        cached?: boolean;
+        requestId?: string;
+        timestamp: string;
+    };
+    success: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW,CAAA;IAC/B,SAAS,EAAE,IAAI,GAAG,MAAM,CAAA;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,IAAI,GAAG,MAAM,CAAA;CACzB;AAGD,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,GAAG;IACnC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,CAAC,CAAA;IACX,SAAS,CAAC,EAAE;QACV,CAAC,KAAK,EAAE,MAAM,GAAG;YACf,cAAc,EAAE,MAAM,EAAE,CAAA;YACxB,OAAO,EAAE,MAAM,CAAA;YACf,KAAK,EAAE,MAAM,CAAA;SACd,CAAA;KACF,CAAA;IACD,UAAU,CAAC,EAAE,KAAK,CAAC;QACjB,KAAK,EAAE,MAAM,CAAA;QACb,cAAc,EAAE,MAAM,EAAE,CAAA;QACxB,OAAO,EAAE,MAAM,CAAA;QACf,KAAK,EAAE,MAAM,CAAA;KACd,CAAC,CAAA;IACF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,eAAe,CAAC,EAAE;QAChB,gBAAgB,EAAE,MAAM,CAAA;QACxB,iBAAiB,EAAE,MAAM,CAAA;QACzB,cAAc,EAAE,MAAM,CAAA;QACtB,KAAK,EAAE,MAAM,CAAA;QACb,cAAc,EAAE,MAAM,CAAA;KACvB,CAAA;IAED,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAGD,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,GAAG;IACrC,WAAW,CAAC,EAAE,KAAK,CAAC;QAClB,UAAU,EAAE,MAAM,CAAA;QAClB,WAAW,EAAE,MAAM,CAAA;QACnB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,MAAM,CAAA;KACb,CAAC,CAAA;IACF,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAA;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,cAAc,EAAE;QACd,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,MAAM,CAAA;QAChB,CAAC,EAAE,MAAM,CAAA;QACT,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,aAAa,EAAE,OAAO,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;CACvB;AAGD,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG;IACpC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,CAAC,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,GAAG,IAAI;IACvC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IAC3C,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;CACxB,CAAA;AAGD,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,GAAG;IACtC,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,CAAA;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,cAAc,EAAE;QACd,QAAQ,EAAE,MAAM,CAAA;QAChB,CAAC,EAAE,MAAM,CAAA;KACV,CAAA;IACD,aAAa,EAAE,OAAO,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;CACvB;AAGD,MAAM,WAAW,gBAAgB,CAAC,CAAC,GAAG,GAAG;IACvC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAA;IAErC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAA;CACvC;AAGD,MAAM,WAAW,qBAAqB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAC5D,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAA;IAChD,QAAQ,CAAC,EAAE;QACT,KAAK,CAAC,EAAE;YACN,OAAO,CAAC,EAAE,MAAM,CAAA;YAChB,GAAG,CAAC,EAAE,MAAM,CAAA;SACb,CAAA;QACD,WAAW,CAAC,EAAE,OAAO,CAAA;KACtB,CAAA;IACD,SAAS,EAAE;QACT,MAAM,EAAE,MAAM,CAAA;QACd,wBAAwB,CAAC,EAAE,MAAM,CAAA;QACjC,KAAK,EAAE,KAAK,CAAC;YACX,IAAI,EAAE,MAAM,CAAA;YACZ,IAAI,EAAE,MAAM,CAAA;YACZ,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAA;SAC3B,CAAC,CAAA;QACF,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,oBAAoB,CAAC,EAAE,MAAM,CAAA;KAC9B,CAAA;CACF;AAGD,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,CAAC,EAAE,MAAM,CAAA;IACT,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAGD,MAAM,WAAW,oBAAoB,CAAC,CAAC,GAAG,GAAG;IAC3C,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACjC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;IACtC,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IACjD,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IAChD,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAC9B;AAGD,MAAM,WAAW,UAAU,CAAC,CAAC,GAAG,GAAG;IACjC,IAAI,EAAE,CAAC,CAAA;IACP,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;CACZ;AAGD,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAGD,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,CAAA;QACf,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IACD,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,SAAS,GAAG,WAAW,CAAA;IAC/B,SAAS,CAAC,EAAE;QACV,EAAE,EAAE,OAAO,CAAA;QACX,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;CACF;AAGD,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAGD,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,IAAI,CAAC,EAAE,CAAC,CAAA;IACR,KAAK,CAAC,EAAE,aAAa,CAAA;IACrB,IAAI,CAAC,EAAE;QACL,MAAM,CAAC,EAAE,OAAO,CAAA;QAChB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,OAAO,EAAE,OAAO,CAAA;CACjB"}

package/dist/lib/types.js

@@ -0,0 +1,2 @@
+// Generic API response wrapper
+export { };

package/dist/lib/typesense-client.d.ts

@@ -0,0 +1,5 @@
+import Typesense from 'typesense';
+import type { TypesenseSearchConfig } from '../index.js';
+export declare const createTypesenseClient: (typesenseConfig: TypesenseSearchConfig["typesense"]) => Typesense.Client;
+export declare const testTypesenseConnection: (client: Typesense.Client) => Promise<boolean>;
+//# sourceMappingURL=typesense-client.d.ts.map

package/dist/lib/typesense-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesense-client.d.ts","sourceRoot":"","sources":["../../src/lib/typesense-client.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAA;AAEjC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAExD,eAAO,MAAM,qBAAqB,GAAI,iBAAiB,qBAAqB,CAAC,WAAW,CAAC,qBASxF,CAAA;AAED,eAAO,MAAM,uBAAuB,GAAU,QAAQ,SAAS,CAAC,MAAM,KAAG,OAAO,CAAC,OAAO,CAQvF,CAAA"}

package/dist/lib/typesense-client.js

@@ -0,0 +1,20 @@
+import Typesense from 'typesense';
+export const createTypesenseClient = (typesenseConfig)=>{
+    return new Typesense.Client({
+        apiKey: typesenseConfig.apiKey,
+        connectionTimeoutSeconds: typesenseConfig.connectionTimeoutSeconds || 2,
+        nodes: typesenseConfig.nodes.map((node)=>({
+                ...node,
+                port: typeof node.port === 'string' ? parseInt(node.port) : node.port
+            }))
+    });
+};
+export const testTypesenseConnection = async (client)=>{
+    try {
+        await client.health.retrieve();
+        return true;
+    } catch (_error) {
+        // Handle Typesense connection error
+        return false;
+    }
+};

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@rubixstudios/payload-typesense",
+  "version": "1.0.0",
+  "description": "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.",
+  "license": "MIT",
+  "author": "Rubix Studios <hello@rubixstudios.com.au> (https://rubixstudios.com.au)",
+  "homepage": "https://rubixstudios.com.au",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rubix-studios-pty-ltd/payload-typesense.git",
+    "directory": "packages/payload-typesense"
+  },
+  "bugs": {
+    "url": "https://github.com/rubix-studios-pty-ltd/payload-typesense/issues"
+  },
+  "maintainers": [
+    {
+      "name": "Rubix Studios",
+      "email": "hello@rubixstudios.com.au",
+      "url": "https://rubixstudios.com.au"
+    }
+  ],
+  "type": "module",
+  "keywords": [
+    "payload",
+    "payloadcms",
+    "typesense",
+    "search",
+    "plugin",
+    "cms",
+    "headless",
+    "typescript",
+    "react",
+    "nextjs"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pnpm build:types && pnpm build:swc",
+    "build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
+    "build:types": "tsc -p tsconfig.json",
+    "clean": "rimraf -g {dist,*.tsbuildinfo}",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "prepublishOnly": "pnpm clean && pnpm build"
+  },
+  "devDependencies": {
+    "@payloadcms/eslint-config": "3.28.0",
+    "@swc/cli": "^0.7.8",
+    "@swc/core": "^1.13.5",
+    "@types/react": "19.1.15",
+    "eslint": "^9.36.0",
+    "payload": "3.57.0",
+    "rimraf": "6.0.1",
+    "typescript": "5.9.2"
+  },
+  "peerDependencies": {
+    "payload": "^3.57.0"
+  },
+  "engines": {
+    "node": "^22.19.0 || >=20.9.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/",
+    "exports": {
+      ".": {
+        "import": "./dist/index.js",
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts"
+  },
+  "dependencies": {
+    "typesense": "^2.1.0",
+    "zod": "^4.1.11"
+  },
+  "packageManager": "pnpm@10.17.1"
+}