fumadocs-core/dist/search/orama-cloud.d.ts

The React.js library for building a documentation website

import "../remark-gfm-CeWpMwyk.js";
import "../rehype-code-vVWG4-ej.js";
import { n as StructuredData } from "../remark-structure-RZD2gGKp.js";
import "../remark-heading-CXvCY0go.js";
import "../remark-code-tab-CXsYlims.js";
import "../mdx-plugins/index.js";
import { OramaCloud } from "@orama/core";

//#region src/search/orama-cloud.d.ts
interface SyncOptions {
  /**
   * Index name to sync
   */
  index: string;
  documents: OramaDocument[];
  /**
   * Deploy changes
   *
   * @defaultValue true
   */
  autoDeploy?: boolean;
}
type I18nSyncOptions = Omit<SyncOptions, 'index' | 'documents'> & {
  /**
   * Indexes to sync.
   *
   * Pairs of `locale`-`index`.
   **/
  indexes: Record<string, string>;
  documents: {
    locale: string;
    items: OramaDocument[];
  }[];
};
interface OramaDocument {
  /**
   * The ID of document, must be unique
   */
  id: string;
  title: string;
  description?: string;
  /**
   * URL to the page
   */
  url: string;
  structured: StructuredData;
  /**
   * Tag to filter results
   */
  tag?: string;
  /**
   * Data to be added to each section index
   */
  extra_data?: object;
  breadcrumbs?: string[];
}
interface OramaIndex {
  id: string;
  title: string;
  url: string;
  tag?: string;
  /**
   * The id of page, used for `group by`
   */
  page_id: string;
  /**
   * Heading content
   */
  section?: string;
  breadcrumbs?: string[];
  /**
   * Heading (anchor) id
   */
  section_id?: string;
  content: string;
}
declare function sync(orama: OramaCloud, options: SyncOptions): Promise<void>;
declare function syncI18n(orama: OramaCloud, options: I18nSyncOptions): Promise<void>;
//#endregion
export { I18nSyncOptions, OramaDocument, OramaIndex, SyncOptions, sync, syncI18n };
//# sourceMappingURL=orama-cloud.d.ts.map