@whatworks/payload-select-search-field 1.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+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,48 @@
+# Payload Search Select Field
+
+Server-backed search select field and plugin for Payload. The client component queries a shared endpoint
+and passes the current search query plus any currently selected values.
+
+## Usage
+
+Add the plugin:
+
+```ts
+import { selectSearchPlugin } from '@whatworks/payload-select-search-field'
+
+export default buildConfig({
+  plugins: [selectSearchPlugin()],
+})
+```
+
+Add a field with `selectSearch` (recommended):c
+
+```ts
+import { selectSearch } from '@whatworks/payload-select-search-field'
+
+selectSearch({
+  name: 'stripeCustomer',
+  hasMany: true,
+  searchFunction: async ({ query, selectedValues }) => {
+    return [
+      { value: 'cus_123', label: `Result for ${query}` },
+      ...selectedValues.map((value) => ({
+        value,
+        label: `Selected: ${value}`,
+      })),
+    ]
+  },
+  admin: {
+    components: {
+      Field: '@whatworks/payload-select-search-field/client#SelectSearchField',
+    },
+  },
+})
+```
+
+`searchFunction` receives:
+- `query`: the current input text.
+- `selectedValues`: an array of currently selected values (empty array when nothing is selected).
+- `req`, `field`, and `collection`/`global` context.
+
+The client component calls the shared endpoint path from `selectSearchEndpoint`.

package/dist/src/endpoint.d.ts

@@ -0,0 +1,2 @@
+import type { Endpoint } from 'payload';
+export declare const selectSearchEndpointHandler: () => Endpoint;

package/dist/src/endpointName.d.ts

@@ -0,0 +1 @@
+export declare const selectSearchEndpoint = "/select-search";

package/dist/src/exports/client.d.ts

@@ -0,0 +1 @@
+export { SelectSearchField } from '../ui/SelectSearchField.js';

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+export { selectSearchPlugin as selectSearchPlugin } from './plugin.js';
+export { selectSearchEndpoint } from './endpointName.js';
+export { selectSearchEndpointHandler } from './endpoint.js';
+export { selectSearchField } from './selectSearchField.js';
+export type { SelectSearchFunction, SelectSearchFunctionArgs, SelectSearchOption, SelectSearchRequest, SelectSearchResponse, } from './types.js';

package/dist/src/plugin.d.ts

@@ -0,0 +1,2 @@
+import type { Plugin } from 'payload';
+export declare const selectSearchPlugin: () => Plugin;

package/dist/src/selectSearchField.d.ts

@@ -0,0 +1,10 @@
+import type { Field, TextField } from 'payload';
+import type { SelectSearchFunction } from './types.js';
+export type SelectSearchFieldArgs = Omit<TextField, 'admin' | 'custom' | 'type' | 'hasMany'> & {
+    hasMany?: boolean;
+    type?: 'text';
+    searchFunction: SelectSearchFunction;
+    custom?: Record<string, unknown>;
+    admin?: TextField['admin'];
+};
+export declare const selectSearchField: (args: SelectSearchFieldArgs) => Field;

package/dist/src/types.d.ts

@@ -0,0 +1,25 @@
+import type { FlattenedField, PayloadRequest, SanitizedCollectionConfig, SanitizedGlobalConfig } from 'payload';
+export type SelectSearchOption = {
+    label: string;
+    value: string;
+    [key: string]: unknown;
+};
+export type SelectSearchFunctionArgs = {
+    req: PayloadRequest;
+    query: string;
+    selectedValues: string[];
+    field: FlattenedField;
+    collection?: SanitizedCollectionConfig;
+    global?: SanitizedGlobalConfig;
+};
+export type SelectSearchFunction = (args: SelectSearchFunctionArgs) => Promise<SelectSearchOption[]> | SelectSearchOption[];
+export type SelectSearchRequest = {
+    entityType: 'collection' | 'global';
+    slug: string;
+    schemaPath: string;
+    query?: string;
+    selectedValues?: string[];
+};
+export type SelectSearchResponse = {
+    options: SelectSearchOption[];
+};

package/dist/src/ui/SelectSearchField.d.ts

@@ -0,0 +1,2 @@
+import type { TextFieldClientComponent } from 'payload';
+export declare const SelectSearchField: TextFieldClientComponent;