@casual-simulation/aux-records 3.6.0 → 3.7.0-alpha.16977445547

package/search/SearchRecordsController.d.ts

@@ -0,0 +1,491 @@
+import type { ResourceKinds, ActionKinds, Result, SimpleError } from '@casual-simulation/aux-common';
+import type { AuthorizationContext, AuthorizeUserAndInstancesSuccess, AuthorizeUserAndInstancesForResourcesSuccess } from '../PolicyController';
+import type { CrudRecordsConfiguration, CheckSubscriptionMetricsFailure, CheckSubscriptionMetricsSuccess } from '../crud';
+import { CrudRecordsController } from '../crud';
+import type { NotificationFeaturesConfiguration, SubscriptionConfiguration } from '../SubscriptionConfiguration';
+import type { SearchRecord, SearchRecordsStore, SearchSubscriptionMetrics } from './SearchRecordsStore';
+import { z } from 'zod';
+import type { SearchCollectionField, SearchDocument, SearchDocumentInfo, SearchInterface, SearchNode, SearchQuery, SearchResult } from './SearchInterface';
+import type { IQueue } from '../queue';
+import type { SearchSyncQueueEvent } from './SearchSyncProcessor';
+/**
+ * Defines the configuration for a webhook records controller.
+ */
+export interface SearchRecordsConfiguration extends Omit<CrudRecordsConfiguration<SearchRecord, SearchRecordsStore>, 'resourceKind' | 'allowRecordKeys' | 'name'> {
+    /**
+     * The interface to the search engine that should be used.
+     */
+    searchInterface: SearchInterface;
+    /**
+     * The queue that should be used to schedule search sync events.
+     *
+     * If null, then the controller will not be able to schedule search sync events.
+     */
+    queue: IQueue<SearchSyncQueueEvent> | null;
+}
+/**
+ * Defines a controller that can be used to interact with SearchRecords.
+ */
+export declare class SearchRecordsController extends CrudRecordsController<SearchRecordInput, SearchRecord, SearchRecordsStore, SearchRecordOutput> {
+    private _searchInterface;
+    private _queue;
+    constructor(config: SearchRecordsConfiguration);
+    protected _eraseItemCore(recordName: string, address: string, item: SearchRecord, authorization: AuthorizeUserAndInstancesSuccess | AuthorizeUserAndInstancesForResourcesSuccess): Promise<Result<void, SimpleError>>;
+    storeDocument(request: StoreDocumentRequest): Promise<StoreDocumentResult>;
+    eraseDocument(request: EraseDocumentRequest): Promise<EraseDocumentResult>;
+    sync(request: SyncSearchRecordRequest): Promise<SyncSearchRecordResult>;
+    unsync(request: UnsyncSearchRecordRequest): Promise<UnsyncSearchRecordResult>;
+    search(request: SearchRequest): Promise<SearchResult>;
+    protected _convertItemToResult(item: SearchRecord, context: AuthorizationContext, action: ActionKinds): Promise<SearchRecordOutput>;
+    protected _transformInputItem(item: SearchRecordInput, existingItem: SearchRecord, action: ActionKinds, context: AuthorizationContext, authorization: AuthorizeUserAndInstancesSuccess | AuthorizeUserAndInstancesForResourcesSuccess): Promise<Result<SearchRecord, SimpleError>>;
+    protected _checkSubscriptionMetrics(action: ActionKinds, context: AuthorizationContext, authorization: AuthorizeUserAndInstancesSuccess | AuthorizeUserAndInstancesForResourcesSuccess, item?: SearchRecord): Promise<SearchRecordsSubscriptionMetricsResult>;
+}
+export type SearchRecordsSubscriptionMetricsResult = SearchRecordsSubscriptionMetricsSuccess | CheckSubscriptionMetricsFailure;
+export interface SearchRecordsSubscriptionMetricsSuccess extends CheckSubscriptionMetricsSuccess {
+    config: SubscriptionConfiguration;
+    metrics: SearchSubscriptionMetrics;
+    features: NotificationFeaturesConfiguration;
+}
+export declare const SEARCH_COLLECTION_FIELD: z.ZodObject<{
+    type: z.ZodEnum<["string", "string[]", "int32", "int32[]", "int64", "int64[]", "float", "float[]", "bool", "bool[]", "geopoint", "geopoint[]", "geopolygon", "object", "object[]", "string*", "image", "auto"]>;
+    optional: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    index: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    store: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    sort: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    infix: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    locale: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    stem: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    drop: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}>;
+export declare const SEARCH_COLLECTION_SCHEMA: z.ZodEffects<z.ZodEffects<z.ZodObject<{}, "strip", z.ZodObject<{
+    type: z.ZodEnum<["string", "string[]", "int32", "int32[]", "int64", "int64[]", "float", "float[]", "bool", "bool[]", "geopoint", "geopoint[]", "geopolygon", "object", "object[]", "string*", "image", "auto"]>;
+    optional: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    index: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    store: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    sort: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    infix: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    locale: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    stem: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    drop: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}>, z.objectOutputType<{}, z.ZodObject<{
+    type: z.ZodEnum<["string", "string[]", "int32", "int32[]", "int64", "int64[]", "float", "float[]", "bool", "bool[]", "geopoint", "geopoint[]", "geopolygon", "object", "object[]", "string*", "image", "auto"]>;
+    optional: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    index: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    store: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    sort: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    infix: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    locale: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    stem: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    drop: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}>, "strip">, z.objectInputType<{}, z.ZodObject<{
+    type: z.ZodEnum<["string", "string[]", "int32", "int32[]", "int64", "int64[]", "float", "float[]", "bool", "bool[]", "geopoint", "geopoint[]", "geopolygon", "object", "object[]", "string*", "image", "auto"]>;
+    optional: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    index: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    store: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    sort: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    infix: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    locale: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    stem: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    drop: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}>, "strip">>, z.objectOutputType<{}, z.ZodObject<{
+    type: z.ZodEnum<["string", "string[]", "int32", "int32[]", "int64", "int64[]", "float", "float[]", "bool", "bool[]", "geopoint", "geopoint[]", "geopolygon", "object", "object[]", "string*", "image", "auto"]>;
+    optional: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    index: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    store: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    sort: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    infix: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    locale: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    stem: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    drop: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}>, "strip">, z.objectInputType<{}, z.ZodObject<{
+    type: z.ZodEnum<["string", "string[]", "int32", "int32[]", "int64", "int64[]", "float", "float[]", "bool", "bool[]", "geopoint", "geopoint[]", "geopolygon", "object", "object[]", "string*", "image", "auto"]>;
+    optional: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    index: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    store: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    sort: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    infix: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    locale: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    stem: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    drop: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}>, "strip">>, z.objectOutputType<{}, z.ZodObject<{
+    type: z.ZodEnum<["string", "string[]", "int32", "int32[]", "int64", "int64[]", "float", "float[]", "bool", "bool[]", "geopoint", "geopoint[]", "geopolygon", "object", "object[]", "string*", "image", "auto"]>;
+    optional: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    index: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    store: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    sort: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    infix: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    locale: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    stem: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    drop: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}>, "strip">, z.objectInputType<{}, z.ZodObject<{
+    type: z.ZodEnum<["string", "string[]", "int32", "int32[]", "int64", "int64[]", "float", "float[]", "bool", "bool[]", "geopoint", "geopoint[]", "geopolygon", "object", "object[]", "string*", "image", "auto"]>;
+    optional: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    index: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    store: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    sort: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    infix: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    locale: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    stem: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    drop: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}, {
+    type?: "string" | "object" | "float" | "auto" | "image" | "string[]" | "int32" | "int32[]" | "int64" | "int64[]" | "float[]" | "bool" | "bool[]" | "geopoint" | "geopoint[]" | "geopolygon" | "object[]" | "string*";
+    optional?: boolean;
+    index?: boolean;
+    store?: boolean;
+    sort?: boolean;
+    infix?: boolean;
+    locale?: string;
+    stem?: boolean;
+    drop?: boolean;
+}>, "strip">>;
+/**
+ * Defines the schema for a search collection.
+ *
+ * @doctitle Search Types
+ * @docsidebar Search
+ * @docdescription Search types define the structure of data that can be stored in search collections.
+ * @dochash types/records/search
+ * @docName SearchCollectionSchema
+ */
+export interface SearchCollectionSchema {
+    /**
+     * The schema that defines the fields in the search collection.
+     */
+    [key: string]: SearchCollectionSchemaField;
+}
+/**
+ * Defines a field for a search collection schema.
+ *
+ * @dochash types/records/search
+ * @docname SearchCollectionField
+ */
+export interface SearchCollectionSchemaField extends Omit<SearchCollectionField, 'name'> {
+}
+export declare const SEARCH_DOCUMENT_SCHEMA: z.ZodEffects<z.ZodObject<{
+    recordName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    address: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    resourceKind: z.ZodNullable<z.ZodOptional<z.ZodEnum<["data", "file", "event", "marker", "role", "inst", "loom", "ai.sloyd", "ai.hume", "ai.openai.realtime", "webhook", "notification", "package", "package.version", "search"]>>>;
+}, "strip", z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodNumber, "many">, z.ZodArray<z.ZodBoolean, "many">, z.ZodEffects<z.ZodObject<{}, "strip", z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, z.objectOutputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">, z.objectInputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">>, z.objectOutputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">, z.objectInputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">>]>, z.objectOutputType<{
+    recordName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    address: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    resourceKind: z.ZodNullable<z.ZodOptional<z.ZodEnum<["data", "file", "event", "marker", "role", "inst", "loom", "ai.sloyd", "ai.hume", "ai.openai.realtime", "webhook", "notification", "package", "package.version", "search"]>>>;
+}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodNumber, "many">, z.ZodArray<z.ZodBoolean, "many">, z.ZodEffects<z.ZodObject<{}, "strip", z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, z.objectOutputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">, z.objectInputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">>, z.objectOutputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">, z.objectInputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">>]>, "strip">, z.objectInputType<{
+    recordName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    address: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    resourceKind: z.ZodNullable<z.ZodOptional<z.ZodEnum<["data", "file", "event", "marker", "role", "inst", "loom", "ai.sloyd", "ai.hume", "ai.openai.realtime", "webhook", "notification", "package", "package.version", "search"]>>>;
+}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodNumber, "many">, z.ZodArray<z.ZodBoolean, "many">, z.ZodEffects<z.ZodObject<{}, "strip", z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, z.objectOutputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">, z.objectInputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">>, z.objectOutputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">, z.objectInputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">>]>, "strip">>, z.objectOutputType<{
+    recordName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    address: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    resourceKind: z.ZodNullable<z.ZodOptional<z.ZodEnum<["data", "file", "event", "marker", "role", "inst", "loom", "ai.sloyd", "ai.hume", "ai.openai.realtime", "webhook", "notification", "package", "package.version", "search"]>>>;
+}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodNumber, "many">, z.ZodArray<z.ZodBoolean, "many">, z.ZodEffects<z.ZodObject<{}, "strip", z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, z.objectOutputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">, z.objectInputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">>, z.objectOutputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">, z.objectInputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">>]>, "strip">, z.objectInputType<{
+    recordName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    address: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    resourceKind: z.ZodNullable<z.ZodOptional<z.ZodEnum<["data", "file", "event", "marker", "role", "inst", "loom", "ai.sloyd", "ai.hume", "ai.openai.realtime", "webhook", "notification", "package", "package.version", "search"]>>>;
+}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodNumber, "many">, z.ZodArray<z.ZodBoolean, "many">, z.ZodEffects<z.ZodObject<{}, "strip", z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, z.objectOutputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">, z.objectInputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">>, z.objectOutputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">, z.objectInputType<{}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "strip">>]>, "strip">>;
+export interface SearchRecordInput extends Omit<SearchRecord, 'collectionName' | 'searchApiKey'> {
+    /**
+     * The schema that should be used for the documents into the search record collection.
+     *
+     * This is also used to validate the documents that are added to the collection.
+     */
+    schema: z.infer<typeof SEARCH_COLLECTION_SCHEMA>;
+}
+/**
+ * Defines a record that represents a collection of documents that can be searched.
+ *
+ * @dochash types/records/search
+ * @docName SearchRecord
+ */
+export interface SearchRecordOutput extends SearchRecord {
+    /**
+     * The search nodes that should be used by clients to connect to the search engine.
+     */
+    nodes?: SearchNode[];
+    /**
+     * The schema that is defined in the schema.
+     */
+    schema?: SearchCollectionSchema;
+}
+export interface StoreDocumentRequest {
+    /**
+     * The name of the record that the document should be stored in.
+     */
+    recordName: string;
+    /**
+     * The address of the search record that the document should be stored in.
+     */
+    address: string;
+    /**
+     * The document to store in the search record.
+     */
+    document: SearchDocument;
+    /**
+     * The ID of the user that is currently logged in.
+     */
+    userId: string;
+    /**
+     * The instance(s) that are making the request.
+     */
+    instances: string[];
+}
+/**
+ * Defines the result of an store document operation.
+ *
+ * @dochash types/records/search
+ * @docname StoreDocumentResult
+ */
+export type StoreDocumentResult = Result<SearchDocumentInfo, SimpleError>;
+export interface EraseDocumentRequest {
+    /**
+     * The name of the record that the document should be erased from.
+     */
+    recordName: string;
+    /**
+     * The address of the search record that the document should be erased from.
+     */
+    address: string;
+    /**
+     * The ID of the user that is currently logged in.
+     */
+    userId: string;
+    /**
+     * The ID of the document to erase.
+     */
+    documentId: string;
+    /**
+     * The instance(s) that are making the request.
+     */
+    instances: string[];
+}
+/**
+ * Defines the result of an erase document operation.
+ *
+ * @dochash types/records/search
+ * @docname EraseDocumentResult
+ */
+export type EraseDocumentResult = Result<SearchDocumentInfo, SimpleError>;
+export interface SyncSearchRecordRequest {
+    /**
+     * The name of the record that should be synced.
+     */
+    recordName: string;
+    /**
+     * The address of the search record that should be synced.
+     */
+    address: string;
+    /**
+     * The name of the record that the data should be synced from.
+     */
+    targetRecordName: string;
+    /**
+     * The kind of resources that should be synced.
+     */
+    targetResourceKind: ResourceKinds;
+    /**
+     * The marker of the resources that should be synced.
+     */
+    targetMarker: string;
+    /**
+     * The mapping of the target properties to the search document properties.
+     */
+    targetMapping: [string, string][];
+    /**
+     * The ID of the user that is currently logged in.
+     */
+    userId: string | null;
+    /**
+     * The instance(s) that are making the request.
+     */
+    instances: string[];
+}
+export type SyncSearchRecordResult = Result<{
+    syncId: string;
+}, SimpleError>;
+export interface UnsyncSearchRecordRequest {
+    /**
+     * The ID of the sync that should be deleted.
+     */
+    syncId: string;
+    /**
+     * The ID of the user that is currently logged in.
+     */
+    userId: string | null;
+    /**
+     * The instance(s) that are making the request.
+     */
+    instances: string[];
+}
+export type UnsyncSearchRecordResult = Result<void, SimpleError>;
+export interface SearchRequest {
+    /**
+     * The name of the record that the search should be performed on.
+     */
+    recordName: string;
+    /**
+     * The address of the search record that the search should be performed on.
+     */
+    address: string;
+    /**
+     * The search query.
+     */
+    query: SearchQuery;
+    /**
+     * The ID of the user that is currently logged in.
+     */
+    userId: string | null;
+    /**
+     * The instance(s) that are making the request.
+     */
+    instances: string[];
+}
+//# sourceMappingURL=SearchRecordsController.d.ts.map