@wix/auto_sdk_igor_document-search 1.0.2 → 1.0.3

package/build/cjs/index.js

@@ -129,6 +129,7 @@ var DocumentType = /* @__PURE__ */ ((DocumentType2) => {
   DocumentType2["WIX_HEADLESS"] = "WIX_HEADLESS";
   DocumentType2["CLI"] = "CLI";
   DocumentType2["BUSINESS_SOLUTIONS"] = "BUSINESS_SOLUTIONS";
+  DocumentType2["OVERVIEW"] = "OVERVIEW";
   return DocumentType2;
 })(DocumentType || {});
 async function searchDocuments2(searchTerm, options) {

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../index.ts","../../src/igor-v1-document-entry-document-search.universal.ts","../../src/igor-v1-document-entry-document-search.http.ts","../../src/igor-v1-document-entry-document-search.public.ts","../../src/igor-v1-document-entry-document-search.context.ts"],"sourcesContent":["export * from './src/igor-v1-document-entry-document-search.context.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixIgorV1DocumentEntry from './igor-v1-document-entry-document-search.http.js';\n\n/** A Wix documentation entry returned as a search result. */\nexport interface DocumentEntry {\n  /**\n   * The unique identifier for this documentation entry.\n   * @maxLength 500\n   */\n  _id?: string;\n  /** The date the document was last updated. */\n  _updatedDate?: Date | null;\n  /**\n   * The title of the documentation entry.\n   * @maxLength 1000\n   */\n  title?: string;\n  /**\n   * The full text content of the documentation entry.\n   * @maxLength 100000\n   */\n  content?: string;\n  /**\n   * The direct URL to the documentation page for this entry.\n   * @maxLength 2000\n   */\n  url?: string;\n  /** The relevance score in the range [0, 1]. Higher means more relevant. */\n  relevanceScore?: number;\n  /**\n   * The knowledge base this entry was retrieved from (e.g. \"REST_METHODS_KB_ID\").\n   * @maxLength 100\n   */\n  kbName?: string;\n}\n\n/** The parameters for a SearchDocuments call. */\nexport interface SearchDocumentsRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The type of Wix documentation to search. */\nexport enum DocumentType {\n  /** Default value. Must not be used. */\n  DOCUMENT_TYPE_UNSPECIFIED = 'DOCUMENT_TYPE_UNSPECIFIED',\n  /** Velo JavaScript APIs for Wix sites. */\n  VELO = 'VELO',\n  /** Wix JavaScript SDK for headless and external applications. */\n  SDK = 'SDK',\n  /** Wix REST APIs. */\n  REST = 'REST',\n  /** Wix Design System documentation. */\n  WDS = 'WDS',\n  /** Documentation for building Wix apps. */\n  BUILD_APPS = 'BUILD_APPS',\n  /** Wix Headless documentation for external and headless applications. */\n  WIX_HEADLESS = 'WIX_HEADLESS',\n  /** Wix CLI documentation. */\n  CLI = 'CLI',\n  /** Wix business solutions and workflow documentation. */\n  BUSINESS_SOLUTIONS = 'BUSINESS_SOLUTIONS',\n}\n\n/** @enumType */\nexport type DocumentTypeWithLiterals =\n  | DocumentType\n  | 'DOCUMENT_TYPE_UNSPECIFIED'\n  | 'VELO'\n  | 'SDK'\n  | 'REST'\n  | 'WDS'\n  | 'BUILD_APPS'\n  | 'WIX_HEADLESS'\n  | 'CLI'\n  | 'BUSINESS_SOLUTIONS';\n\n/** The result of a SearchDocuments call. */\nexport interface SearchDocumentsResponse {\n  /**\n   * The ranked list of matching documentation entries, ordered by relevance score descending.\n   * @maxSize 100\n   */\n  results?: DocumentEntry[];\n}\n\n/** The parameters for a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The result of a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownResponse {\n  /**\n   * The search results as a single markdown document. Method results are interleaved\n   * with article results. Results are separated by a line of equal signs.\n   * @maxLength 500000\n   */\n  content?: string;\n}\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n * @param searchTerm - The search term to look up in the documentation.\n * @public\n * @documentationMaturity preview\n * @requiredField searchTerm\n * @permissionId igor:v1:document_entry:search_documents\n * @returns The result of a SearchDocuments call.\n * @fqn wix.igor.v1.DocumentSearchService.SearchDocuments\n */\nexport async function searchDocuments(\n  searchTerm: string,\n  options?: SearchDocumentsOptions\n): Promise<\n  NonNullablePaths<\n    SearchDocumentsResponse,\n    | `results`\n    | `results.${number}._id`\n    | `results.${number}.title`\n    | `results.${number}.content`\n    | `results.${number}.url`\n    | `results.${number}.relevanceScore`\n    | `results.${number}.kbName`,\n    4\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    searchTerm: searchTerm,\n    maximumResults: options?.maximumResults,\n    documentType: options?.documentType,\n    linesInEachResult: options?.linesInEachResult,\n  });\n\n  const reqOpts = ambassadorWixIgorV1DocumentEntry.searchDocuments(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          searchTerm: '$[0]',\n          maximumResults: '$[1].maximumResults',\n          documentType: '$[1].documentType',\n          linesInEachResult: '$[1].linesInEachResult',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['searchTerm', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface SearchDocumentsOptions {\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n * @param searchTerm - The search term to look up in the documentation.\n * @public\n * @documentationMaturity preview\n * @requiredField searchTerm\n * @permissionId igor:v1:document_entry:search_documents_markdown\n * @returns The result of a SearchDocumentsMarkdown call.\n * @fqn wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown\n */\nexport async function searchDocumentsMarkdown(\n  searchTerm: string,\n  options?: SearchDocumentsMarkdownOptions\n): Promise<NonNullablePaths<SearchDocumentsMarkdownResponse, `content`, 2>> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    searchTerm: searchTerm,\n    documentType: options?.documentType,\n    maximumResults: options?.maximumResults,\n    linesInEachResult: options?.linesInEachResult,\n  });\n\n  const reqOpts =\n    ambassadorWixIgorV1DocumentEntry.searchDocumentsMarkdown(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          searchTerm: '$[0]',\n          documentType: '$[1].documentType',\n          maximumResults: '$[1].maximumResults',\n          linesInEachResult: '$[1].linesInEachResult',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['searchTerm', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface SearchDocumentsMarkdownOptions {\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n","import { transformRESTFloatToSDKFloat } from '@wix/sdk-runtime/transformations/float';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixIgorV1DocumentSearchServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'www.wixapis.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'bo._base_domain_': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_igor_document-search';\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n */\nexport function searchDocuments(payload: object): RequestOptionsFactory<any> {\n  function __searchDocuments({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocuments',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search',\n        data: payload,\n        host,\n      }),\n      data: payload,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'results.updatedDate' }],\n          },\n          {\n            transformFn: transformRESTFloatToSDKFloat,\n            paths: [{ path: 'results.relevanceScore' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __searchDocuments;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n */\nexport function searchDocumentsMarkdown(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __searchDocumentsMarkdown({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search/markdown',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __searchDocumentsMarkdown;\n}\n","import { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport {\n  SearchDocumentsMarkdownOptions,\n  SearchDocumentsMarkdownResponse,\n  SearchDocumentsOptions,\n  SearchDocumentsResponse,\n  searchDocuments as universalSearchDocuments,\n  searchDocumentsMarkdown as universalSearchDocumentsMarkdown,\n} from './igor-v1-document-entry-document-search.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/igor' };\n\nexport function searchDocuments(\n  httpClient: HttpClient\n): SearchDocumentsSignature {\n  return (searchTerm: string, options?: SearchDocumentsOptions) =>\n    universalSearchDocuments(\n      searchTerm,\n      options,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface SearchDocumentsSignature {\n  /**\n   * Searches Wix documentation entries by a search term and document type.\n   *\n   * Returns a ranked list of matching documentation entries ordered by relevance\n   * score descending. Method results include kb_name to identify the source\n   * knowledge base. Each result is truncated to lines_in_each_result lines\n   * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n   * for more content per result.\n   * @param - The search term to look up in the documentation.\n   * @returns The result of a SearchDocuments call.\n   */\n  (searchTerm: string, options?: SearchDocumentsOptions): Promise<\n    NonNullablePaths<\n      SearchDocumentsResponse,\n      | `results`\n      | `results.${number}._id`\n      | `results.${number}.title`\n      | `results.${number}.content`\n      | `results.${number}.url`\n      | `results.${number}.relevanceScore`\n      | `results.${number}.kbName`,\n      4\n    >\n  >;\n}\n\nexport function searchDocumentsMarkdown(\n  httpClient: HttpClient\n): SearchDocumentsMarkdownSignature {\n  return (searchTerm: string, options?: SearchDocumentsMarkdownOptions) =>\n    universalSearchDocumentsMarkdown(\n      searchTerm,\n      options,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface SearchDocumentsMarkdownSignature {\n  /**\n   * Searches Wix documentation and returns results as a single markdown string\n   * ready to be passed directly to an LLM.\n   *\n   * Method results are interleaved 2-by-2 with article results so both types\n   * always appear. Each result is truncated to lines_in_each_result lines\n   * (defaults to 20) with a contextual hint (method results get a schema read\n   * hint; article results get a \"read the full article\" hint). Results are\n   * separated by a line of equal signs.\n   * @param - The search term to look up in the documentation.\n   * @returns The result of a SearchDocumentsMarkdown call.\n   */\n  (searchTerm: string, options?: SearchDocumentsMarkdownOptions): Promise<\n    NonNullablePaths<SearchDocumentsMarkdownResponse, `content`, 2>\n  >;\n}\n\nexport {\n  DocumentEntry,\n  DocumentType,\n  SearchDocumentsMarkdownOptions,\n  SearchDocumentsMarkdownRequest,\n  SearchDocumentsMarkdownResponse,\n  SearchDocumentsOptions,\n  SearchDocumentsRequest,\n  SearchDocumentsResponse,\n} from './igor-v1-document-entry-document-search.universal.js';\n","import {\n  searchDocuments as publicSearchDocuments,\n  searchDocumentsMarkdown as publicSearchDocumentsMarkdown,\n} from './igor-v1-document-entry-document-search.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';\n\nexport const searchDocuments: MaybeContext<\n  BuildRESTFunction<typeof publicSearchDocuments> & typeof publicSearchDocuments\n> = /*#__PURE__*/ createRESTModule(publicSearchDocuments);\nexport const searchDocumentsMarkdown: MaybeContext<\n  BuildRESTFunction<typeof publicSearchDocumentsMarkdown> &\n    typeof publicSearchDocumentsMarkdown\n> = /*#__PURE__*/ createRESTModule(publicSearchDocumentsMarkdown);\n\nexport { DocumentType } from './igor-v1-document-entry-document-search.universal.js';\nexport {\n  DocumentEntry,\n  SearchDocumentsRequest,\n  SearchDocumentsResponse,\n  SearchDocumentsMarkdownRequest,\n  SearchDocumentsMarkdownResponse,\n  SearchDocumentsOptions,\n  SearchDocumentsMarkdownOptions,\n} from './igor-v1-document-entry-document-search.universal.js';\nexport { DocumentTypeWithLiterals } from './igor-v1-document-entry-document-search.universal.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA,yBAAAA;AAAA,EAAA,+BAAAC;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,oCAGO;;;ACJP,mBAA6C;AAC7C,uBAAqD;AACrD,6BAA+B;AAC/B,0BAA2B;AAI3B,SAAS,yCACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,gCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAWd,SAAS,gBAAgB,SAA6C;AAC3E,WAAS,kBAAkB,EAAE,KAAK,GAAQ;AACxC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAAA,QACzC;AAAA,QACA;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,yBAAyB,CAAC;AAAA,QAC5C;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAYO,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADnDO,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,+BAA4B;AAE5B,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,gBAAa;AAEb,EAAAA,cAAA,kBAAe;AAEf,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,wBAAqB;AAlBX,SAAAA;AAAA,GAAA;AAgGZ,eAAsBC,iBACpB,YACA,SAaA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA,gBAAgB,SAAS;AAAA,IACzB,cAAc,SAAS;AAAA,IACvB,mBAAmB,SAAS;AAAA,EAC9B,CAAC;AAED,QAAM,UAA2C,gBAAgB,OAAO;AAExE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,YAAY;AAAA,UACZ,gBAAgB;AAAA,UAChB,cAAc;AAAA,UACd,mBAAmB;AAAA,QACrB;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,cAAc,SAAS;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAuCA,eAAsBC,yBACpB,YACA,SAC0E;AAE1E,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA,cAAc,SAAS;AAAA,IACvB,gBAAgB,SAAS;AAAA,IACzB,mBAAmB,SAAS;AAAA,EAC9B,CAAC;AAED,QAAM,UAC6B,wBAAwB,OAAO;AAElE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAD;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,YAAY;AAAA,UACZ,cAAc;AAAA,UACd,gBAAgB;AAAA,UAChB,mBAAmB;AAAA,QACrB;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,cAAc,SAAS;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AErSO,SAASE,iBACd,YAC0B;AAC1B,SAAO,CAAC,YAAoB,YAC1BA;AAAA,IACE;AAAA,IACA;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AA6BO,SAASC,yBACd,YACkC;AAClC,SAAO,CAAC,YAAoB,YAC1BA;AAAA,IACE;AAAA,IACA;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;;;ACzDA,IAAAC,uBAAiC;AAG1B,IAAMC,mBAEK,2DAAiBA,gBAAqB;AACjD,IAAMC,2BAGK,2DAAiBA,wBAA6B;","names":["searchDocuments","searchDocumentsMarkdown","payload","DocumentType","searchDocuments","sdkTransformError","searchDocumentsMarkdown","searchDocuments","searchDocumentsMarkdown","import_rest_modules","searchDocuments","searchDocumentsMarkdown"]}
+{"version":3,"sources":["../../index.ts","../../src/igor-v1-document-entry-document-search.universal.ts","../../src/igor-v1-document-entry-document-search.http.ts","../../src/igor-v1-document-entry-document-search.public.ts","../../src/igor-v1-document-entry-document-search.context.ts"],"sourcesContent":["export * from './src/igor-v1-document-entry-document-search.context.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixIgorV1DocumentEntry from './igor-v1-document-entry-document-search.http.js';\n\n/** A Wix documentation entry returned as a search result. */\nexport interface DocumentEntry {\n  /**\n   * The unique identifier for this documentation entry.\n   * @maxLength 500\n   */\n  _id?: string;\n  /** The date the document was last updated. */\n  _updatedDate?: Date | null;\n  /**\n   * The title of the documentation entry.\n   * @maxLength 1000\n   */\n  title?: string;\n  /**\n   * The full text content of the documentation entry.\n   * @maxLength 100000\n   */\n  content?: string;\n  /**\n   * The direct URL to the documentation page for this entry.\n   * @maxLength 2000\n   */\n  url?: string;\n  /** The relevance score in the range [0, 1]. Higher means more relevant. */\n  relevanceScore?: number;\n  /**\n   * The knowledge base this entry was retrieved from (e.g. \"REST_METHODS_KB_ID\").\n   * @maxLength 100\n   */\n  kbName?: string;\n}\n\n/** The parameters for a SearchDocuments call. */\nexport interface SearchDocumentsRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The type of Wix documentation to search. */\nexport enum DocumentType {\n  /** Default value. Must not be used. */\n  DOCUMENT_TYPE_UNSPECIFIED = 'DOCUMENT_TYPE_UNSPECIFIED',\n  /** Velo JavaScript APIs for Wix sites. */\n  VELO = 'VELO',\n  /** Wix JavaScript SDK for headless and external applications. */\n  SDK = 'SDK',\n  /** Wix REST APIs. */\n  REST = 'REST',\n  /** Wix Design System documentation. */\n  WDS = 'WDS',\n  /** Documentation for building Wix apps. */\n  BUILD_APPS = 'BUILD_APPS',\n  /** Wix Headless documentation for external and headless applications. */\n  WIX_HEADLESS = 'WIX_HEADLESS',\n  /** Wix CLI documentation. */\n  CLI = 'CLI',\n  /** Wix business solutions and workflow documentation. */\n  BUSINESS_SOLUTIONS = 'BUSINESS_SOLUTIONS',\n  /** High-level Wix platform and business overview documentation. */\n  OVERVIEW = 'OVERVIEW',\n}\n\n/** @enumType */\nexport type DocumentTypeWithLiterals =\n  | DocumentType\n  | 'DOCUMENT_TYPE_UNSPECIFIED'\n  | 'VELO'\n  | 'SDK'\n  | 'REST'\n  | 'WDS'\n  | 'BUILD_APPS'\n  | 'WIX_HEADLESS'\n  | 'CLI'\n  | 'BUSINESS_SOLUTIONS'\n  | 'OVERVIEW';\n\n/** The result of a SearchDocuments call. */\nexport interface SearchDocumentsResponse {\n  /**\n   * The ranked list of matching documentation entries, ordered by relevance score descending.\n   * @maxSize 100\n   */\n  results?: DocumentEntry[];\n}\n\n/** The parameters for a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The result of a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownResponse {\n  /**\n   * The search results as a single markdown document. Method results are interleaved\n   * with article results. Results are separated by a line of equal signs.\n   * @maxLength 500000\n   */\n  content?: string;\n}\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n * @param searchTerm - The search term to look up in the documentation.\n * @public\n * @documentationMaturity preview\n * @requiredField searchTerm\n * @permissionId igor:v1:document_entry:search_documents\n * @returns The result of a SearchDocuments call.\n * @fqn wix.igor.v1.DocumentSearchService.SearchDocuments\n */\nexport async function searchDocuments(\n  searchTerm: string,\n  options?: SearchDocumentsOptions\n): Promise<\n  NonNullablePaths<\n    SearchDocumentsResponse,\n    | `results`\n    | `results.${number}._id`\n    | `results.${number}.title`\n    | `results.${number}.content`\n    | `results.${number}.url`\n    | `results.${number}.relevanceScore`\n    | `results.${number}.kbName`,\n    4\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    searchTerm: searchTerm,\n    maximumResults: options?.maximumResults,\n    documentType: options?.documentType,\n    linesInEachResult: options?.linesInEachResult,\n  });\n\n  const reqOpts = ambassadorWixIgorV1DocumentEntry.searchDocuments(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          searchTerm: '$[0]',\n          maximumResults: '$[1].maximumResults',\n          documentType: '$[1].documentType',\n          linesInEachResult: '$[1].linesInEachResult',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['searchTerm', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface SearchDocumentsOptions {\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n * @param searchTerm - The search term to look up in the documentation.\n * @public\n * @documentationMaturity preview\n * @requiredField searchTerm\n * @permissionId igor:v1:document_entry:search_documents_markdown\n * @returns The result of a SearchDocumentsMarkdown call.\n * @fqn wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown\n */\nexport async function searchDocumentsMarkdown(\n  searchTerm: string,\n  options?: SearchDocumentsMarkdownOptions\n): Promise<NonNullablePaths<SearchDocumentsMarkdownResponse, `content`, 2>> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    searchTerm: searchTerm,\n    documentType: options?.documentType,\n    maximumResults: options?.maximumResults,\n    linesInEachResult: options?.linesInEachResult,\n  });\n\n  const reqOpts =\n    ambassadorWixIgorV1DocumentEntry.searchDocumentsMarkdown(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          searchTerm: '$[0]',\n          documentType: '$[1].documentType',\n          maximumResults: '$[1].maximumResults',\n          linesInEachResult: '$[1].linesInEachResult',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['searchTerm', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface SearchDocumentsMarkdownOptions {\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n","import { transformRESTFloatToSDKFloat } from '@wix/sdk-runtime/transformations/float';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixIgorV1DocumentSearchServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'www.wixapis.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'bo._base_domain_': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_igor_document-search';\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n */\nexport function searchDocuments(payload: object): RequestOptionsFactory<any> {\n  function __searchDocuments({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocuments',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search',\n        data: payload,\n        host,\n      }),\n      data: payload,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'results.updatedDate' }],\n          },\n          {\n            transformFn: transformRESTFloatToSDKFloat,\n            paths: [{ path: 'results.relevanceScore' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __searchDocuments;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n */\nexport function searchDocumentsMarkdown(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __searchDocumentsMarkdown({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search/markdown',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __searchDocumentsMarkdown;\n}\n","import { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport {\n  SearchDocumentsMarkdownOptions,\n  SearchDocumentsMarkdownResponse,\n  SearchDocumentsOptions,\n  SearchDocumentsResponse,\n  searchDocuments as universalSearchDocuments,\n  searchDocumentsMarkdown as universalSearchDocumentsMarkdown,\n} from './igor-v1-document-entry-document-search.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/igor' };\n\nexport function searchDocuments(\n  httpClient: HttpClient\n): SearchDocumentsSignature {\n  return (searchTerm: string, options?: SearchDocumentsOptions) =>\n    universalSearchDocuments(\n      searchTerm,\n      options,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface SearchDocumentsSignature {\n  /**\n   * Searches Wix documentation entries by a search term and document type.\n   *\n   * Returns a ranked list of matching documentation entries ordered by relevance\n   * score descending. Method results include kb_name to identify the source\n   * knowledge base. Each result is truncated to lines_in_each_result lines\n   * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n   * for more content per result.\n   * @param - The search term to look up in the documentation.\n   * @returns The result of a SearchDocuments call.\n   */\n  (searchTerm: string, options?: SearchDocumentsOptions): Promise<\n    NonNullablePaths<\n      SearchDocumentsResponse,\n      | `results`\n      | `results.${number}._id`\n      | `results.${number}.title`\n      | `results.${number}.content`\n      | `results.${number}.url`\n      | `results.${number}.relevanceScore`\n      | `results.${number}.kbName`,\n      4\n    >\n  >;\n}\n\nexport function searchDocumentsMarkdown(\n  httpClient: HttpClient\n): SearchDocumentsMarkdownSignature {\n  return (searchTerm: string, options?: SearchDocumentsMarkdownOptions) =>\n    universalSearchDocumentsMarkdown(\n      searchTerm,\n      options,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface SearchDocumentsMarkdownSignature {\n  /**\n   * Searches Wix documentation and returns results as a single markdown string\n   * ready to be passed directly to an LLM.\n   *\n   * Method results are interleaved 2-by-2 with article results so both types\n   * always appear. Each result is truncated to lines_in_each_result lines\n   * (defaults to 20) with a contextual hint (method results get a schema read\n   * hint; article results get a \"read the full article\" hint). Results are\n   * separated by a line of equal signs.\n   * @param - The search term to look up in the documentation.\n   * @returns The result of a SearchDocumentsMarkdown call.\n   */\n  (searchTerm: string, options?: SearchDocumentsMarkdownOptions): Promise<\n    NonNullablePaths<SearchDocumentsMarkdownResponse, `content`, 2>\n  >;\n}\n\nexport {\n  DocumentEntry,\n  DocumentType,\n  SearchDocumentsMarkdownOptions,\n  SearchDocumentsMarkdownRequest,\n  SearchDocumentsMarkdownResponse,\n  SearchDocumentsOptions,\n  SearchDocumentsRequest,\n  SearchDocumentsResponse,\n} from './igor-v1-document-entry-document-search.universal.js';\n","import {\n  searchDocuments as publicSearchDocuments,\n  searchDocumentsMarkdown as publicSearchDocumentsMarkdown,\n} from './igor-v1-document-entry-document-search.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';\n\nexport const searchDocuments: MaybeContext<\n  BuildRESTFunction<typeof publicSearchDocuments> & typeof publicSearchDocuments\n> = /*#__PURE__*/ createRESTModule(publicSearchDocuments);\nexport const searchDocumentsMarkdown: MaybeContext<\n  BuildRESTFunction<typeof publicSearchDocumentsMarkdown> &\n    typeof publicSearchDocumentsMarkdown\n> = /*#__PURE__*/ createRESTModule(publicSearchDocumentsMarkdown);\n\nexport { DocumentType } from './igor-v1-document-entry-document-search.universal.js';\nexport {\n  DocumentEntry,\n  SearchDocumentsRequest,\n  SearchDocumentsResponse,\n  SearchDocumentsMarkdownRequest,\n  SearchDocumentsMarkdownResponse,\n  SearchDocumentsOptions,\n  SearchDocumentsMarkdownOptions,\n} from './igor-v1-document-entry-document-search.universal.js';\nexport { DocumentTypeWithLiterals } from './igor-v1-document-entry-document-search.universal.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA,yBAAAA;AAAA,EAAA,+BAAAC;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,oCAGO;;;ACJP,mBAA6C;AAC7C,uBAAqD;AACrD,6BAA+B;AAC/B,0BAA2B;AAI3B,SAAS,yCACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,gCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAWd,SAAS,gBAAgB,SAA6C;AAC3E,WAAS,kBAAkB,EAAE,KAAK,GAAQ;AACxC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAAA,QACzC;AAAA,QACA;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,yBAAyB,CAAC;AAAA,QAC5C;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAYO,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADnDO,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,+BAA4B;AAE5B,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,gBAAa;AAEb,EAAAA,cAAA,kBAAe;AAEf,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,wBAAqB;AAErB,EAAAA,cAAA,cAAW;AApBD,SAAAA;AAAA,GAAA;AAmGZ,eAAsBC,iBACpB,YACA,SAaA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA,gBAAgB,SAAS;AAAA,IACzB,cAAc,SAAS;AAAA,IACvB,mBAAmB,SAAS;AAAA,EAC9B,CAAC;AAED,QAAM,UAA2C,gBAAgB,OAAO;AAExE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,YAAY;AAAA,UACZ,gBAAgB;AAAA,UAChB,cAAc;AAAA,UACd,mBAAmB;AAAA,QACrB;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,cAAc,SAAS;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAuCA,eAAsBC,yBACpB,YACA,SAC0E;AAE1E,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA,cAAc,SAAS;AAAA,IACvB,gBAAgB,SAAS;AAAA,IACzB,mBAAmB,SAAS;AAAA,EAC9B,CAAC;AAED,QAAM,UAC6B,wBAAwB,OAAO;AAElE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAD;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,YAAY;AAAA,UACZ,cAAc;AAAA,UACd,gBAAgB;AAAA,UAChB,mBAAmB;AAAA,QACrB;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,cAAc,SAAS;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AExSO,SAASE,iBACd,YAC0B;AAC1B,SAAO,CAAC,YAAoB,YAC1BA;AAAA,IACE;AAAA,IACA;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AA6BO,SAASC,yBACd,YACkC;AAClC,SAAO,CAAC,YAAoB,YAC1BA;AAAA,IACE;AAAA,IACA;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;;;ACzDA,IAAAC,uBAAiC;AAG1B,IAAMC,mBAEK,2DAAiBA,gBAAqB;AACjD,IAAMC,2BAGK,2DAAiBA,wBAA6B;","names":["searchDocuments","searchDocumentsMarkdown","payload","DocumentType","searchDocuments","sdkTransformError","searchDocumentsMarkdown","searchDocuments","searchDocumentsMarkdown","import_rest_modules","searchDocuments","searchDocumentsMarkdown"]}

package/build/cjs/index.typings.d.ts

@@ -77,10 +77,12 @@ declare enum DocumentType {
     /** Wix CLI documentation. */
     CLI = "CLI",
     /** Wix business solutions and workflow documentation. */
-    BUSINESS_SOLUTIONS = "BUSINESS_SOLUTIONS"
+    BUSINESS_SOLUTIONS = "BUSINESS_SOLUTIONS",
+    /** High-level Wix platform and business overview documentation. */
+    OVERVIEW = "OVERVIEW"
 }
 /** @enumType */
-type DocumentTypeWithLiterals = DocumentType | 'DOCUMENT_TYPE_UNSPECIFIED' | 'VELO' | 'SDK' | 'REST' | 'WDS' | 'BUILD_APPS' | 'WIX_HEADLESS' | 'CLI' | 'BUSINESS_SOLUTIONS';
+type DocumentTypeWithLiterals = DocumentType | 'DOCUMENT_TYPE_UNSPECIFIED' | 'VELO' | 'SDK' | 'REST' | 'WDS' | 'BUILD_APPS' | 'WIX_HEADLESS' | 'CLI' | 'BUSINESS_SOLUTIONS' | 'OVERVIEW';
 /** The result of a SearchDocuments call. */
 interface SearchDocumentsResponse {
     /**

package/build/cjs/index.typings.js

@@ -129,6 +129,7 @@ var DocumentType = /* @__PURE__ */ ((DocumentType2) => {
   DocumentType2["WIX_HEADLESS"] = "WIX_HEADLESS";
   DocumentType2["CLI"] = "CLI";
   DocumentType2["BUSINESS_SOLUTIONS"] = "BUSINESS_SOLUTIONS";
+  DocumentType2["OVERVIEW"] = "OVERVIEW";
   return DocumentType2;
 })(DocumentType || {});
 async function searchDocuments2(searchTerm, options) {

package/build/cjs/index.typings.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../index.typings.ts","../../src/igor-v1-document-entry-document-search.universal.ts","../../src/igor-v1-document-entry-document-search.http.ts"],"sourcesContent":["export * from './src/igor-v1-document-entry-document-search.universal.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixIgorV1DocumentEntry from './igor-v1-document-entry-document-search.http.js';\n\n/** A Wix documentation entry returned as a search result. */\nexport interface DocumentEntry {\n  /**\n   * The unique identifier for this documentation entry.\n   * @maxLength 500\n   */\n  _id?: string;\n  /** The date the document was last updated. */\n  _updatedDate?: Date | null;\n  /**\n   * The title of the documentation entry.\n   * @maxLength 1000\n   */\n  title?: string;\n  /**\n   * The full text content of the documentation entry.\n   * @maxLength 100000\n   */\n  content?: string;\n  /**\n   * The direct URL to the documentation page for this entry.\n   * @maxLength 2000\n   */\n  url?: string;\n  /** The relevance score in the range [0, 1]. Higher means more relevant. */\n  relevanceScore?: number;\n  /**\n   * The knowledge base this entry was retrieved from (e.g. \"REST_METHODS_KB_ID\").\n   * @maxLength 100\n   */\n  kbName?: string;\n}\n\n/** The parameters for a SearchDocuments call. */\nexport interface SearchDocumentsRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The type of Wix documentation to search. */\nexport enum DocumentType {\n  /** Default value. Must not be used. */\n  DOCUMENT_TYPE_UNSPECIFIED = 'DOCUMENT_TYPE_UNSPECIFIED',\n  /** Velo JavaScript APIs for Wix sites. */\n  VELO = 'VELO',\n  /** Wix JavaScript SDK for headless and external applications. */\n  SDK = 'SDK',\n  /** Wix REST APIs. */\n  REST = 'REST',\n  /** Wix Design System documentation. */\n  WDS = 'WDS',\n  /** Documentation for building Wix apps. */\n  BUILD_APPS = 'BUILD_APPS',\n  /** Wix Headless documentation for external and headless applications. */\n  WIX_HEADLESS = 'WIX_HEADLESS',\n  /** Wix CLI documentation. */\n  CLI = 'CLI',\n  /** Wix business solutions and workflow documentation. */\n  BUSINESS_SOLUTIONS = 'BUSINESS_SOLUTIONS',\n}\n\n/** @enumType */\nexport type DocumentTypeWithLiterals =\n  | DocumentType\n  | 'DOCUMENT_TYPE_UNSPECIFIED'\n  | 'VELO'\n  | 'SDK'\n  | 'REST'\n  | 'WDS'\n  | 'BUILD_APPS'\n  | 'WIX_HEADLESS'\n  | 'CLI'\n  | 'BUSINESS_SOLUTIONS';\n\n/** The result of a SearchDocuments call. */\nexport interface SearchDocumentsResponse {\n  /**\n   * The ranked list of matching documentation entries, ordered by relevance score descending.\n   * @maxSize 100\n   */\n  results?: DocumentEntry[];\n}\n\n/** The parameters for a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The result of a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownResponse {\n  /**\n   * The search results as a single markdown document. Method results are interleaved\n   * with article results. Results are separated by a line of equal signs.\n   * @maxLength 500000\n   */\n  content?: string;\n}\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n * @param searchTerm - The search term to look up in the documentation.\n * @public\n * @documentationMaturity preview\n * @requiredField searchTerm\n * @permissionId igor:v1:document_entry:search_documents\n * @returns The result of a SearchDocuments call.\n * @fqn wix.igor.v1.DocumentSearchService.SearchDocuments\n */\nexport async function searchDocuments(\n  searchTerm: string,\n  options?: SearchDocumentsOptions\n): Promise<\n  NonNullablePaths<\n    SearchDocumentsResponse,\n    | `results`\n    | `results.${number}._id`\n    | `results.${number}.title`\n    | `results.${number}.content`\n    | `results.${number}.url`\n    | `results.${number}.relevanceScore`\n    | `results.${number}.kbName`,\n    4\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    searchTerm: searchTerm,\n    maximumResults: options?.maximumResults,\n    documentType: options?.documentType,\n    linesInEachResult: options?.linesInEachResult,\n  });\n\n  const reqOpts = ambassadorWixIgorV1DocumentEntry.searchDocuments(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          searchTerm: '$[0]',\n          maximumResults: '$[1].maximumResults',\n          documentType: '$[1].documentType',\n          linesInEachResult: '$[1].linesInEachResult',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['searchTerm', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface SearchDocumentsOptions {\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n * @param searchTerm - The search term to look up in the documentation.\n * @public\n * @documentationMaturity preview\n * @requiredField searchTerm\n * @permissionId igor:v1:document_entry:search_documents_markdown\n * @returns The result of a SearchDocumentsMarkdown call.\n * @fqn wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown\n */\nexport async function searchDocumentsMarkdown(\n  searchTerm: string,\n  options?: SearchDocumentsMarkdownOptions\n): Promise<NonNullablePaths<SearchDocumentsMarkdownResponse, `content`, 2>> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    searchTerm: searchTerm,\n    documentType: options?.documentType,\n    maximumResults: options?.maximumResults,\n    linesInEachResult: options?.linesInEachResult,\n  });\n\n  const reqOpts =\n    ambassadorWixIgorV1DocumentEntry.searchDocumentsMarkdown(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          searchTerm: '$[0]',\n          documentType: '$[1].documentType',\n          maximumResults: '$[1].maximumResults',\n          linesInEachResult: '$[1].linesInEachResult',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['searchTerm', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface SearchDocumentsMarkdownOptions {\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n","import { transformRESTFloatToSDKFloat } from '@wix/sdk-runtime/transformations/float';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixIgorV1DocumentSearchServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'www.wixapis.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'bo._base_domain_': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_igor_document-search';\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n */\nexport function searchDocuments(payload: object): RequestOptionsFactory<any> {\n  function __searchDocuments({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocuments',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search',\n        data: payload,\n        host,\n      }),\n      data: payload,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'results.updatedDate' }],\n          },\n          {\n            transformFn: transformRESTFloatToSDKFloat,\n            paths: [{ path: 'results.relevanceScore' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __searchDocuments;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n */\nexport function searchDocumentsMarkdown(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __searchDocumentsMarkdown({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search/markdown',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __searchDocumentsMarkdown;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA,yBAAAA;AAAA,EAAA,+BAAAC;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,oCAGO;;;ACJP,mBAA6C;AAC7C,uBAAqD;AACrD,6BAA+B;AAC/B,0BAA2B;AAI3B,SAAS,yCACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,gCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAWd,SAAS,gBAAgB,SAA6C;AAC3E,WAAS,kBAAkB,EAAE,KAAK,GAAQ;AACxC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAAA,QACzC;AAAA,QACA;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,yBAAyB,CAAC;AAAA,QAC5C;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAYO,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADnDO,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,+BAA4B;AAE5B,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,gBAAa;AAEb,EAAAA,cAAA,kBAAe;AAEf,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,wBAAqB;AAlBX,SAAAA;AAAA,GAAA;AAgGZ,eAAsBC,iBACpB,YACA,SAaA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA,gBAAgB,SAAS;AAAA,IACzB,cAAc,SAAS;AAAA,IACvB,mBAAmB,SAAS;AAAA,EAC9B,CAAC;AAED,QAAM,UAA2C,gBAAgB,OAAO;AAExE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,YAAY;AAAA,UACZ,gBAAgB;AAAA,UAChB,cAAc;AAAA,UACd,mBAAmB;AAAA,QACrB;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,cAAc,SAAS;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAuCA,eAAsBC,yBACpB,YACA,SAC0E;AAE1E,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA,cAAc,SAAS;AAAA,IACvB,gBAAgB,SAAS;AAAA,IACzB,mBAAmB,SAAS;AAAA,EAC9B,CAAC;AAED,QAAM,UAC6B,wBAAwB,OAAO;AAElE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAD;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,YAAY;AAAA,UACZ,cAAc;AAAA,UACd,gBAAgB;AAAA,UAChB,mBAAmB;AAAA,QACrB;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,cAAc,SAAS;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;","names":["searchDocuments","searchDocumentsMarkdown","payload","DocumentType","searchDocuments","sdkTransformError","searchDocumentsMarkdown"]}
+{"version":3,"sources":["../../index.typings.ts","../../src/igor-v1-document-entry-document-search.universal.ts","../../src/igor-v1-document-entry-document-search.http.ts"],"sourcesContent":["export * from './src/igor-v1-document-entry-document-search.universal.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixIgorV1DocumentEntry from './igor-v1-document-entry-document-search.http.js';\n\n/** A Wix documentation entry returned as a search result. */\nexport interface DocumentEntry {\n  /**\n   * The unique identifier for this documentation entry.\n   * @maxLength 500\n   */\n  _id?: string;\n  /** The date the document was last updated. */\n  _updatedDate?: Date | null;\n  /**\n   * The title of the documentation entry.\n   * @maxLength 1000\n   */\n  title?: string;\n  /**\n   * The full text content of the documentation entry.\n   * @maxLength 100000\n   */\n  content?: string;\n  /**\n   * The direct URL to the documentation page for this entry.\n   * @maxLength 2000\n   */\n  url?: string;\n  /** The relevance score in the range [0, 1]. Higher means more relevant. */\n  relevanceScore?: number;\n  /**\n   * The knowledge base this entry was retrieved from (e.g. \"REST_METHODS_KB_ID\").\n   * @maxLength 100\n   */\n  kbName?: string;\n}\n\n/** The parameters for a SearchDocuments call. */\nexport interface SearchDocumentsRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The type of Wix documentation to search. */\nexport enum DocumentType {\n  /** Default value. Must not be used. */\n  DOCUMENT_TYPE_UNSPECIFIED = 'DOCUMENT_TYPE_UNSPECIFIED',\n  /** Velo JavaScript APIs for Wix sites. */\n  VELO = 'VELO',\n  /** Wix JavaScript SDK for headless and external applications. */\n  SDK = 'SDK',\n  /** Wix REST APIs. */\n  REST = 'REST',\n  /** Wix Design System documentation. */\n  WDS = 'WDS',\n  /** Documentation for building Wix apps. */\n  BUILD_APPS = 'BUILD_APPS',\n  /** Wix Headless documentation for external and headless applications. */\n  WIX_HEADLESS = 'WIX_HEADLESS',\n  /** Wix CLI documentation. */\n  CLI = 'CLI',\n  /** Wix business solutions and workflow documentation. */\n  BUSINESS_SOLUTIONS = 'BUSINESS_SOLUTIONS',\n  /** High-level Wix platform and business overview documentation. */\n  OVERVIEW = 'OVERVIEW',\n}\n\n/** @enumType */\nexport type DocumentTypeWithLiterals =\n  | DocumentType\n  | 'DOCUMENT_TYPE_UNSPECIFIED'\n  | 'VELO'\n  | 'SDK'\n  | 'REST'\n  | 'WDS'\n  | 'BUILD_APPS'\n  | 'WIX_HEADLESS'\n  | 'CLI'\n  | 'BUSINESS_SOLUTIONS'\n  | 'OVERVIEW';\n\n/** The result of a SearchDocuments call. */\nexport interface SearchDocumentsResponse {\n  /**\n   * The ranked list of matching documentation entries, ordered by relevance score descending.\n   * @maxSize 100\n   */\n  results?: DocumentEntry[];\n}\n\n/** The parameters for a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The result of a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownResponse {\n  /**\n   * The search results as a single markdown document. Method results are interleaved\n   * with article results. Results are separated by a line of equal signs.\n   * @maxLength 500000\n   */\n  content?: string;\n}\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n * @param searchTerm - The search term to look up in the documentation.\n * @public\n * @documentationMaturity preview\n * @requiredField searchTerm\n * @permissionId igor:v1:document_entry:search_documents\n * @returns The result of a SearchDocuments call.\n * @fqn wix.igor.v1.DocumentSearchService.SearchDocuments\n */\nexport async function searchDocuments(\n  searchTerm: string,\n  options?: SearchDocumentsOptions\n): Promise<\n  NonNullablePaths<\n    SearchDocumentsResponse,\n    | `results`\n    | `results.${number}._id`\n    | `results.${number}.title`\n    | `results.${number}.content`\n    | `results.${number}.url`\n    | `results.${number}.relevanceScore`\n    | `results.${number}.kbName`,\n    4\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    searchTerm: searchTerm,\n    maximumResults: options?.maximumResults,\n    documentType: options?.documentType,\n    linesInEachResult: options?.linesInEachResult,\n  });\n\n  const reqOpts = ambassadorWixIgorV1DocumentEntry.searchDocuments(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          searchTerm: '$[0]',\n          maximumResults: '$[1].maximumResults',\n          documentType: '$[1].documentType',\n          linesInEachResult: '$[1].linesInEachResult',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['searchTerm', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface SearchDocumentsOptions {\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n * @param searchTerm - The search term to look up in the documentation.\n * @public\n * @documentationMaturity preview\n * @requiredField searchTerm\n * @permissionId igor:v1:document_entry:search_documents_markdown\n * @returns The result of a SearchDocumentsMarkdown call.\n * @fqn wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown\n */\nexport async function searchDocumentsMarkdown(\n  searchTerm: string,\n  options?: SearchDocumentsMarkdownOptions\n): Promise<NonNullablePaths<SearchDocumentsMarkdownResponse, `content`, 2>> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    searchTerm: searchTerm,\n    documentType: options?.documentType,\n    maximumResults: options?.maximumResults,\n    linesInEachResult: options?.linesInEachResult,\n  });\n\n  const reqOpts =\n    ambassadorWixIgorV1DocumentEntry.searchDocumentsMarkdown(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          searchTerm: '$[0]',\n          documentType: '$[1].documentType',\n          maximumResults: '$[1].maximumResults',\n          linesInEachResult: '$[1].linesInEachResult',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['searchTerm', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface SearchDocumentsMarkdownOptions {\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n","import { transformRESTFloatToSDKFloat } from '@wix/sdk-runtime/transformations/float';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixIgorV1DocumentSearchServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'www.wixapis.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'bo._base_domain_': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_igor_document-search';\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n */\nexport function searchDocuments(payload: object): RequestOptionsFactory<any> {\n  function __searchDocuments({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocuments',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search',\n        data: payload,\n        host,\n      }),\n      data: payload,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'results.updatedDate' }],\n          },\n          {\n            transformFn: transformRESTFloatToSDKFloat,\n            paths: [{ path: 'results.relevanceScore' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __searchDocuments;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n */\nexport function searchDocumentsMarkdown(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __searchDocumentsMarkdown({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search/markdown',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __searchDocumentsMarkdown;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA,yBAAAA;AAAA,EAAA,+BAAAC;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,oCAGO;;;ACJP,mBAA6C;AAC7C,uBAAqD;AACrD,6BAA+B;AAC/B,0BAA2B;AAI3B,SAAS,yCACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,gCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAWd,SAAS,gBAAgB,SAA6C;AAC3E,WAAS,kBAAkB,EAAE,KAAK,GAAQ;AACxC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAAA,QACzC;AAAA,QACA;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,yBAAyB,CAAC;AAAA,QAC5C;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAYO,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADnDO,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,+BAA4B;AAE5B,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,gBAAa;AAEb,EAAAA,cAAA,kBAAe;AAEf,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,wBAAqB;AAErB,EAAAA,cAAA,cAAW;AApBD,SAAAA;AAAA,GAAA;AAmGZ,eAAsBC,iBACpB,YACA,SAaA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA,gBAAgB,SAAS;AAAA,IACzB,cAAc,SAAS;AAAA,IACvB,mBAAmB,SAAS;AAAA,EAC9B,CAAC;AAED,QAAM,UAA2C,gBAAgB,OAAO;AAExE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,YAAY;AAAA,UACZ,gBAAgB;AAAA,UAChB,cAAc;AAAA,UACd,mBAAmB;AAAA,QACrB;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,cAAc,SAAS;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAuCA,eAAsBC,yBACpB,YACA,SAC0E;AAE1E,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA,cAAc,SAAS;AAAA,IACvB,gBAAgB,SAAS;AAAA,IACzB,mBAAmB,SAAS;AAAA,EAC9B,CAAC;AAED,QAAM,UAC6B,wBAAwB,OAAO;AAElE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAD;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,YAAY;AAAA,UACZ,cAAc;AAAA,UACd,gBAAgB;AAAA,UAChB,mBAAmB;AAAA,QACrB;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,cAAc,SAAS;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;","names":["searchDocuments","searchDocumentsMarkdown","payload","DocumentType","searchDocuments","sdkTransformError","searchDocumentsMarkdown"]}

package/build/cjs/meta.d.ts

@@ -78,10 +78,12 @@ declare enum DocumentType {
     /** Wix CLI documentation. */
     CLI = "CLI",
     /** Wix business solutions and workflow documentation. */
-    BUSINESS_SOLUTIONS = "BUSINESS_SOLUTIONS"
+    BUSINESS_SOLUTIONS = "BUSINESS_SOLUTIONS",
+    /** High-level Wix platform and business overview documentation. */
+    OVERVIEW = "OVERVIEW"
 }
 /** @enumType */
-type DocumentTypeWithLiterals = DocumentType | 'DOCUMENT_TYPE_UNSPECIFIED' | 'VELO' | 'SDK' | 'REST' | 'WDS' | 'BUILD_APPS' | 'WIX_HEADLESS' | 'CLI' | 'BUSINESS_SOLUTIONS';
+type DocumentTypeWithLiterals = DocumentType | 'DOCUMENT_TYPE_UNSPECIFIED' | 'VELO' | 'SDK' | 'REST' | 'WDS' | 'BUILD_APPS' | 'WIX_HEADLESS' | 'CLI' | 'BUSINESS_SOLUTIONS' | 'OVERVIEW';
 /** The result of a SearchDocuments call. */
 interface SearchDocumentsResponse {
     /**

package/build/cjs/meta.js

@@ -125,6 +125,7 @@ var DocumentType = /* @__PURE__ */ ((DocumentType2) => {
   DocumentType2["WIX_HEADLESS"] = "WIX_HEADLESS";
   DocumentType2["CLI"] = "CLI";
   DocumentType2["BUSINESS_SOLUTIONS"] = "BUSINESS_SOLUTIONS";
+  DocumentType2["OVERVIEW"] = "OVERVIEW";
   return DocumentType2;
 })(DocumentType || {});
 

package/build/cjs/meta.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../meta.ts","../../src/igor-v1-document-entry-document-search.http.ts","../../src/igor-v1-document-entry-document-search.types.ts","../../src/igor-v1-document-entry-document-search.meta.ts"],"sourcesContent":["export * from './src/igor-v1-document-entry-document-search.meta.js';\n","import { transformRESTFloatToSDKFloat } from '@wix/sdk-runtime/transformations/float';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixIgorV1DocumentSearchServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'www.wixapis.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'bo._base_domain_': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_igor_document-search';\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n */\nexport function searchDocuments(payload: object): RequestOptionsFactory<any> {\n  function __searchDocuments({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocuments',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search',\n        data: payload,\n        host,\n      }),\n      data: payload,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'results.updatedDate' }],\n          },\n          {\n            transformFn: transformRESTFloatToSDKFloat,\n            paths: [{ path: 'results.relevanceScore' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __searchDocuments;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n */\nexport function searchDocumentsMarkdown(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __searchDocumentsMarkdown({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search/markdown',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __searchDocumentsMarkdown;\n}\n","/** A Wix documentation entry returned as a search result. */\nexport interface DocumentEntry {\n  /**\n   * The unique identifier for this documentation entry.\n   * @maxLength 500\n   */\n  id?: string;\n  /** The date the document was last updated. */\n  updatedDate?: Date | null;\n  /**\n   * The title of the documentation entry.\n   * @maxLength 1000\n   */\n  title?: string;\n  /**\n   * The full text content of the documentation entry.\n   * @maxLength 100000\n   */\n  content?: string;\n  /**\n   * The direct URL to the documentation page for this entry.\n   * @maxLength 2000\n   */\n  url?: string;\n  /** The relevance score in the range [0, 1]. Higher means more relevant. */\n  relevanceScore?: number;\n  /**\n   * The knowledge base this entry was retrieved from (e.g. \"REST_METHODS_KB_ID\").\n   * @maxLength 100\n   */\n  kbName?: string;\n}\n\n/** The parameters for a SearchDocuments call. */\nexport interface SearchDocumentsRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The type of Wix documentation to search. */\nexport enum DocumentType {\n  /** Default value. Must not be used. */\n  DOCUMENT_TYPE_UNSPECIFIED = 'DOCUMENT_TYPE_UNSPECIFIED',\n  /** Velo JavaScript APIs for Wix sites. */\n  VELO = 'VELO',\n  /** Wix JavaScript SDK for headless and external applications. */\n  SDK = 'SDK',\n  /** Wix REST APIs. */\n  REST = 'REST',\n  /** Wix Design System documentation. */\n  WDS = 'WDS',\n  /** Documentation for building Wix apps. */\n  BUILD_APPS = 'BUILD_APPS',\n  /** Wix Headless documentation for external and headless applications. */\n  WIX_HEADLESS = 'WIX_HEADLESS',\n  /** Wix CLI documentation. */\n  CLI = 'CLI',\n  /** Wix business solutions and workflow documentation. */\n  BUSINESS_SOLUTIONS = 'BUSINESS_SOLUTIONS',\n}\n\n/** @enumType */\nexport type DocumentTypeWithLiterals =\n  | DocumentType\n  | 'DOCUMENT_TYPE_UNSPECIFIED'\n  | 'VELO'\n  | 'SDK'\n  | 'REST'\n  | 'WDS'\n  | 'BUILD_APPS'\n  | 'WIX_HEADLESS'\n  | 'CLI'\n  | 'BUSINESS_SOLUTIONS';\n\n/** The result of a SearchDocuments call. */\nexport interface SearchDocumentsResponse {\n  /**\n   * The ranked list of matching documentation entries, ordered by relevance score descending.\n   * @maxSize 100\n   */\n  results?: DocumentEntry[];\n}\n\n/** The parameters for a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The result of a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownResponse {\n  /**\n   * The search results as a single markdown document. Method results are interleaved\n   * with article results. Results are separated by a line of equal signs.\n   * @maxLength 500000\n   */\n  content?: string;\n}\n","import * as ambassadorWixIgorV1DocumentEntry from './igor-v1-document-entry-document-search.http.js';\nimport * as ambassadorWixIgorV1DocumentEntryTypes from './igor-v1-document-entry-document-search.types.js';\nimport * as ambassadorWixIgorV1DocumentEntryUniversalTypes from './igor-v1-document-entry-document-search.universal.js';\n\nexport type __PublicMethodMetaInfo<\n  K = string,\n  M = unknown,\n  T = unknown,\n  S = unknown,\n  Q = unknown,\n  R = unknown\n> = {\n  getUrl: (context: any) => string;\n  httpMethod: K;\n  path: string;\n  pathParams: M;\n  __requestType: T;\n  __originalRequestType: S;\n  __responseType: Q;\n  __originalResponseType: R;\n};\n\nexport function searchDocuments(): __PublicMethodMetaInfo<\n  'POST',\n  {},\n  ambassadorWixIgorV1DocumentEntryUniversalTypes.SearchDocumentsRequest,\n  ambassadorWixIgorV1DocumentEntryTypes.SearchDocumentsRequest,\n  ambassadorWixIgorV1DocumentEntryUniversalTypes.SearchDocumentsResponse,\n  ambassadorWixIgorV1DocumentEntryTypes.SearchDocumentsResponse\n> {\n  const payload = {} as any;\n\n  const getRequestOptions =\n    ambassadorWixIgorV1DocumentEntry.searchDocuments(payload);\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'POST',\n    path: '/v1/docs/search',\n    pathParams: {},\n    __requestType: null as any,\n    __originalRequestType: null as any,\n    __responseType: null as any,\n    __originalResponseType: null as any,\n  };\n}\n\nexport function searchDocumentsMarkdown(): __PublicMethodMetaInfo<\n  'POST',\n  {},\n  ambassadorWixIgorV1DocumentEntryUniversalTypes.SearchDocumentsMarkdownRequest,\n  ambassadorWixIgorV1DocumentEntryTypes.SearchDocumentsMarkdownRequest,\n  ambassadorWixIgorV1DocumentEntryUniversalTypes.SearchDocumentsMarkdownResponse,\n  ambassadorWixIgorV1DocumentEntryTypes.SearchDocumentsMarkdownResponse\n> {\n  const payload = {} as any;\n\n  const getRequestOptions =\n    ambassadorWixIgorV1DocumentEntry.searchDocumentsMarkdown(payload);\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'POST',\n    path: '/v1/docs/search/markdown',\n    pathParams: {},\n    __requestType: null as any,\n    __originalRequestType: null as any,\n    __responseType: null as any,\n    __originalResponseType: null as any,\n  };\n}\n\nexport {\n  DocumentEntry as DocumentEntryOriginal,\n  SearchDocumentsRequest as SearchDocumentsRequestOriginal,\n  DocumentType as DocumentTypeOriginal,\n  DocumentTypeWithLiterals as DocumentTypeWithLiteralsOriginal,\n  SearchDocumentsResponse as SearchDocumentsResponseOriginal,\n  SearchDocumentsMarkdownRequest as SearchDocumentsMarkdownRequestOriginal,\n  SearchDocumentsMarkdownResponse as SearchDocumentsMarkdownResponseOriginal,\n} from './igor-v1-document-entry-document-search.types.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA,yBAAAA;AAAA,EAAA,+BAAAC;AAAA;AAAA;;;ACAA,mBAA6C;AAC7C,uBAAqD;AACrD,6BAA+B;AAC/B,0BAA2B;AAI3B,SAAS,yCACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,gCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAWd,SAAS,gBAAgB,SAA6C;AAC3E,WAAS,kBAAkB,EAAE,KAAK,GAAQ;AACxC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAAA,QACzC;AAAA,QACA;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,yBAAyB,CAAC;AAAA,QAC5C;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAYO,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;AC3DO,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,+BAA4B;AAE5B,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,gBAAa;AAEb,EAAAA,cAAA,kBAAe;AAEf,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,wBAAqB;AAlBX,SAAAA;AAAA,GAAA;;;ACvCL,SAASC,mBAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBAC6B,gBAAgB,OAAO;AAE1D,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,CAAC;AAAA,IACb,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;AAEO,SAASC,2BAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBAC6B,wBAAwB,OAAO;AAElE,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,CAAC;AAAA,IACb,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;","names":["searchDocuments","searchDocumentsMarkdown","payload","DocumentType","searchDocuments","searchDocumentsMarkdown"]}
+{"version":3,"sources":["../../meta.ts","../../src/igor-v1-document-entry-document-search.http.ts","../../src/igor-v1-document-entry-document-search.types.ts","../../src/igor-v1-document-entry-document-search.meta.ts"],"sourcesContent":["export * from './src/igor-v1-document-entry-document-search.meta.js';\n","import { transformRESTFloatToSDKFloat } from '@wix/sdk-runtime/transformations/float';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixIgorV1DocumentSearchServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'www.wixapis.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'bo._base_domain_': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_igor_document-search';\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n */\nexport function searchDocuments(payload: object): RequestOptionsFactory<any> {\n  function __searchDocuments({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocuments',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search',\n        data: payload,\n        host,\n      }),\n      data: payload,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'results.updatedDate' }],\n          },\n          {\n            transformFn: transformRESTFloatToSDKFloat,\n            paths: [{ path: 'results.relevanceScore' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __searchDocuments;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n */\nexport function searchDocumentsMarkdown(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __searchDocumentsMarkdown({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search/markdown',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __searchDocumentsMarkdown;\n}\n","/** A Wix documentation entry returned as a search result. */\nexport interface DocumentEntry {\n  /**\n   * The unique identifier for this documentation entry.\n   * @maxLength 500\n   */\n  id?: string;\n  /** The date the document was last updated. */\n  updatedDate?: Date | null;\n  /**\n   * The title of the documentation entry.\n   * @maxLength 1000\n   */\n  title?: string;\n  /**\n   * The full text content of the documentation entry.\n   * @maxLength 100000\n   */\n  content?: string;\n  /**\n   * The direct URL to the documentation page for this entry.\n   * @maxLength 2000\n   */\n  url?: string;\n  /** The relevance score in the range [0, 1]. Higher means more relevant. */\n  relevanceScore?: number;\n  /**\n   * The knowledge base this entry was retrieved from (e.g. \"REST_METHODS_KB_ID\").\n   * @maxLength 100\n   */\n  kbName?: string;\n}\n\n/** The parameters for a SearchDocuments call. */\nexport interface SearchDocumentsRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The type of Wix documentation to search. */\nexport enum DocumentType {\n  /** Default value. Must not be used. */\n  DOCUMENT_TYPE_UNSPECIFIED = 'DOCUMENT_TYPE_UNSPECIFIED',\n  /** Velo JavaScript APIs for Wix sites. */\n  VELO = 'VELO',\n  /** Wix JavaScript SDK for headless and external applications. */\n  SDK = 'SDK',\n  /** Wix REST APIs. */\n  REST = 'REST',\n  /** Wix Design System documentation. */\n  WDS = 'WDS',\n  /** Documentation for building Wix apps. */\n  BUILD_APPS = 'BUILD_APPS',\n  /** Wix Headless documentation for external and headless applications. */\n  WIX_HEADLESS = 'WIX_HEADLESS',\n  /** Wix CLI documentation. */\n  CLI = 'CLI',\n  /** Wix business solutions and workflow documentation. */\n  BUSINESS_SOLUTIONS = 'BUSINESS_SOLUTIONS',\n  /** High-level Wix platform and business overview documentation. */\n  OVERVIEW = 'OVERVIEW',\n}\n\n/** @enumType */\nexport type DocumentTypeWithLiterals =\n  | DocumentType\n  | 'DOCUMENT_TYPE_UNSPECIFIED'\n  | 'VELO'\n  | 'SDK'\n  | 'REST'\n  | 'WDS'\n  | 'BUILD_APPS'\n  | 'WIX_HEADLESS'\n  | 'CLI'\n  | 'BUSINESS_SOLUTIONS'\n  | 'OVERVIEW';\n\n/** The result of a SearchDocuments call. */\nexport interface SearchDocumentsResponse {\n  /**\n   * The ranked list of matching documentation entries, ordered by relevance score descending.\n   * @maxSize 100\n   */\n  results?: DocumentEntry[];\n}\n\n/** The parameters for a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The result of a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownResponse {\n  /**\n   * The search results as a single markdown document. Method results are interleaved\n   * with article results. Results are separated by a line of equal signs.\n   * @maxLength 500000\n   */\n  content?: string;\n}\n","import * as ambassadorWixIgorV1DocumentEntry from './igor-v1-document-entry-document-search.http.js';\nimport * as ambassadorWixIgorV1DocumentEntryTypes from './igor-v1-document-entry-document-search.types.js';\nimport * as ambassadorWixIgorV1DocumentEntryUniversalTypes from './igor-v1-document-entry-document-search.universal.js';\n\nexport type __PublicMethodMetaInfo<\n  K = string,\n  M = unknown,\n  T = unknown,\n  S = unknown,\n  Q = unknown,\n  R = unknown\n> = {\n  getUrl: (context: any) => string;\n  httpMethod: K;\n  path: string;\n  pathParams: M;\n  __requestType: T;\n  __originalRequestType: S;\n  __responseType: Q;\n  __originalResponseType: R;\n};\n\nexport function searchDocuments(): __PublicMethodMetaInfo<\n  'POST',\n  {},\n  ambassadorWixIgorV1DocumentEntryUniversalTypes.SearchDocumentsRequest,\n  ambassadorWixIgorV1DocumentEntryTypes.SearchDocumentsRequest,\n  ambassadorWixIgorV1DocumentEntryUniversalTypes.SearchDocumentsResponse,\n  ambassadorWixIgorV1DocumentEntryTypes.SearchDocumentsResponse\n> {\n  const payload = {} as any;\n\n  const getRequestOptions =\n    ambassadorWixIgorV1DocumentEntry.searchDocuments(payload);\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'POST',\n    path: '/v1/docs/search',\n    pathParams: {},\n    __requestType: null as any,\n    __originalRequestType: null as any,\n    __responseType: null as any,\n    __originalResponseType: null as any,\n  };\n}\n\nexport function searchDocumentsMarkdown(): __PublicMethodMetaInfo<\n  'POST',\n  {},\n  ambassadorWixIgorV1DocumentEntryUniversalTypes.SearchDocumentsMarkdownRequest,\n  ambassadorWixIgorV1DocumentEntryTypes.SearchDocumentsMarkdownRequest,\n  ambassadorWixIgorV1DocumentEntryUniversalTypes.SearchDocumentsMarkdownResponse,\n  ambassadorWixIgorV1DocumentEntryTypes.SearchDocumentsMarkdownResponse\n> {\n  const payload = {} as any;\n\n  const getRequestOptions =\n    ambassadorWixIgorV1DocumentEntry.searchDocumentsMarkdown(payload);\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'POST',\n    path: '/v1/docs/search/markdown',\n    pathParams: {},\n    __requestType: null as any,\n    __originalRequestType: null as any,\n    __responseType: null as any,\n    __originalResponseType: null as any,\n  };\n}\n\nexport {\n  DocumentEntry as DocumentEntryOriginal,\n  SearchDocumentsRequest as SearchDocumentsRequestOriginal,\n  DocumentType as DocumentTypeOriginal,\n  DocumentTypeWithLiterals as DocumentTypeWithLiteralsOriginal,\n  SearchDocumentsResponse as SearchDocumentsResponseOriginal,\n  SearchDocumentsMarkdownRequest as SearchDocumentsMarkdownRequestOriginal,\n  SearchDocumentsMarkdownResponse as SearchDocumentsMarkdownResponseOriginal,\n} from './igor-v1-document-entry-document-search.types.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA,yBAAAA;AAAA,EAAA,+BAAAC;AAAA;AAAA;;;ACAA,mBAA6C;AAC7C,uBAAqD;AACrD,6BAA+B;AAC/B,0BAA2B;AAI3B,SAAS,yCACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,gCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAWd,SAAS,gBAAgB,SAA6C;AAC3E,WAAS,kBAAkB,EAAE,KAAK,GAAQ;AACxC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAAA,QACzC;AAAA,QACA;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,yBAAyB,CAAC;AAAA,QAC5C;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAYO,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;AC3DO,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,+BAA4B;AAE5B,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,gBAAa;AAEb,EAAAA,cAAA,kBAAe;AAEf,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,wBAAqB;AAErB,EAAAA,cAAA,cAAW;AApBD,SAAAA;AAAA,GAAA;;;ACvCL,SAASC,mBAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBAC6B,gBAAgB,OAAO;AAE1D,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,CAAC;AAAA,IACb,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;AAEO,SAASC,2BAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBAC6B,wBAAwB,OAAO;AAElE,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,CAAC;AAAA,IACb,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;","names":["searchDocuments","searchDocumentsMarkdown","payload","DocumentType","searchDocuments","searchDocumentsMarkdown"]}

package/build/cjs/schemas.d.ts

@@ -14,6 +14,7 @@ declare const SearchDocumentsRequest: z.ZodObject<{
             WIX_HEADLESS: "WIX_HEADLESS";
             CLI: "CLI";
             BUSINESS_SOLUTIONS: "BUSINESS_SOLUTIONS";
+            OVERVIEW: "OVERVIEW";
         }>>;
         linesInEachResult: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
     }, z.core.$strip>>;
@@ -42,6 +43,7 @@ declare const SearchDocumentsMarkdownRequest: z.ZodObject<{
             WIX_HEADLESS: "WIX_HEADLESS";
             CLI: "CLI";
             BUSINESS_SOLUTIONS: "BUSINESS_SOLUTIONS";
+            OVERVIEW: "OVERVIEW";
         }>>;
         maximumResults: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
         linesInEachResult: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;

package/build/cjs/schemas.js

@@ -39,7 +39,7 @@ module.exports = __toCommonJS(schemas_exports);
 
 // src/igor-v1-document-entry-document-search.schemas.ts
 var z = __toESM(require("zod"));
-var SearchDocumentsRequest = z.object({
+var SearchDocumentsRequest = /* @__PURE__ */ z.object({
   searchTerm: z.string().describe("The search term to look up in the documentation.").min(1).max(500),
   options: z.object({
     maximumResults: z.number().int().describe(
@@ -54,14 +54,15 @@ var SearchDocumentsRequest = z.object({
       "BUILD_APPS",
       "WIX_HEADLESS",
       "CLI",
-      "BUSINESS_SOLUTIONS"
+      "BUSINESS_SOLUTIONS",
+      "OVERVIEW"
     ]).optional(),
     linesInEachResult: z.number().int().describe(
       'Maximum number of lines to include per result content. Defaults to 20.\nMethod results use section-aware truncation; article results are truncated\nat this line count. A "Read more here: <url>" hint is appended when content\nis truncated.'
     ).min(1).max(200).optional().nullable()
   }).optional()
 });
-var SearchDocumentsResponse = z.object({
+var SearchDocumentsResponse = /* @__PURE__ */ z.object({
   results: z.array(
     z.object({
       _id: z.string().describe("The unique identifier for this documentation entry.").max(500).optional(),
@@ -78,7 +79,7 @@ var SearchDocumentsResponse = z.object({
     })
   ).max(100).optional()
 });
-var SearchDocumentsMarkdownRequest = z.object({
+var SearchDocumentsMarkdownRequest = /* @__PURE__ */ z.object({
   searchTerm: z.string().describe("The search term to look up in the documentation.").min(1).max(500),
   options: z.object({
     documentType: z.enum([
@@ -90,7 +91,8 @@ var SearchDocumentsMarkdownRequest = z.object({
       "BUILD_APPS",
       "WIX_HEADLESS",
       "CLI",
-      "BUSINESS_SOLUTIONS"
+      "BUSINESS_SOLUTIONS",
+      "OVERVIEW"
     ]).optional(),
     maximumResults: z.number().int().describe(
       "The maximum number of results to return. Defaults to 15. Valid range: [1, 20]."
@@ -100,7 +102,7 @@ var SearchDocumentsMarkdownRequest = z.object({
     ).min(1).max(200).optional().nullable()
   }).optional()
 });
-var SearchDocumentsMarkdownResponse = z.object({
+var SearchDocumentsMarkdownResponse = /* @__PURE__ */ z.object({
   content: z.string().describe(
     "The search results as a single markdown document. Method results are interleaved\nwith article results. Results are separated by a line of equal signs."
   ).max(5e5).optional()

package/build/cjs/schemas.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../schemas.ts","../../src/igor-v1-document-entry-document-search.schemas.ts"],"sourcesContent":["export * from './src/igor-v1-document-entry-document-search.schemas.js';\n","import * as z from 'zod';\n\nexport const SearchDocumentsRequest = z.object({\n  searchTerm: z\n    .string()\n    .describe('The search term to look up in the documentation.')\n    .min(1)\n    .max(500),\n  options: z\n    .object({\n      maximumResults: z\n        .number()\n        .int()\n        .describe(\n          'The maximum number of results to return. Defaults to 15. Valid range: [1, 20].'\n        )\n        .min(1)\n        .max(20)\n        .optional()\n        .nullable(),\n      documentType: z\n        .enum([\n          'DOCUMENT_TYPE_UNSPECIFIED',\n          'VELO',\n          'SDK',\n          'REST',\n          'WDS',\n          'BUILD_APPS',\n          'WIX_HEADLESS',\n          'CLI',\n          'BUSINESS_SOLUTIONS',\n        ])\n        .optional(),\n      linesInEachResult: z\n        .number()\n        .int()\n        .describe(\n          'Maximum number of lines to include per result content. Defaults to 20.\\nMethod results use section-aware truncation; article results are truncated\\nat this line count. A \"Read more here: <url>\" hint is appended when content\\nis truncated.'\n        )\n        .min(1)\n        .max(200)\n        .optional()\n        .nullable(),\n    })\n    .optional(),\n});\nexport const SearchDocumentsResponse = z.object({\n  results: z\n    .array(\n      z.object({\n        _id: z\n          .string()\n          .describe('The unique identifier for this documentation entry.')\n          .max(500)\n          .optional(),\n        _updatedDate: z\n          .date()\n          .describe('The date the document was last updated.')\n          .optional()\n          .nullable(),\n        title: z\n          .string()\n          .describe('The title of the documentation entry.')\n          .max(1000)\n          .optional(),\n        content: z\n          .string()\n          .describe('The full text content of the documentation entry.')\n          .max(100000)\n          .optional(),\n        url: z\n          .string()\n          .describe('The direct URL to the documentation page for this entry.')\n          .max(2000)\n          .optional(),\n        relevanceScore: z\n          .number()\n          .describe(\n            'The relevance score in the range [0, 1]. Higher means more relevant.'\n          )\n          .optional(),\n        kbName: z\n          .string()\n          .describe(\n            'The knowledge base this entry was retrieved from (e.g. \"REST_METHODS_KB_ID\").'\n          )\n          .max(100)\n          .optional(),\n      })\n    )\n    .max(100)\n    .optional(),\n});\nexport const SearchDocumentsMarkdownRequest = z.object({\n  searchTerm: z\n    .string()\n    .describe('The search term to look up in the documentation.')\n    .min(1)\n    .max(500),\n  options: z\n    .object({\n      documentType: z\n        .enum([\n          'DOCUMENT_TYPE_UNSPECIFIED',\n          'VELO',\n          'SDK',\n          'REST',\n          'WDS',\n          'BUILD_APPS',\n          'WIX_HEADLESS',\n          'CLI',\n          'BUSINESS_SOLUTIONS',\n        ])\n        .optional(),\n      maximumResults: z\n        .number()\n        .int()\n        .describe(\n          'The maximum number of results to return. Defaults to 15. Valid range: [1, 20].'\n        )\n        .min(1)\n        .max(20)\n        .optional()\n        .nullable(),\n      linesInEachResult: z\n        .number()\n        .int()\n        .describe(\n          'Maximum number of lines to include per result. Defaults to 20. Method\\nresults use section-aware truncation; article results are truncated at this\\nline count. A \"Read more here: <url>\" hint is appended when content is\\ntruncated.'\n        )\n        .min(1)\n        .max(200)\n        .optional()\n        .nullable(),\n    })\n    .optional(),\n});\nexport const SearchDocumentsMarkdownResponse = z.object({\n  content: z\n    .string()\n    .describe(\n      'The search results as a single markdown document. Method results are interleaved\\nwith article results. Results are separated by a line of equal signs.'\n    )\n    .max(500000)\n    .optional(),\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,QAAmB;AAEZ,IAAM,yBAA2B,SAAO;AAAA,EAC7C,YACG,SAAO,EACP,SAAS,kDAAkD,EAC3D,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,EACV,SACG,SAAO;AAAA,IACN,gBACG,SAAO,EACP,IAAI,EACJ;AAAA,MACC;AAAA,IACF,EACC,IAAI,CAAC,EACL,IAAI,EAAE,EACN,SAAS,EACT,SAAS;AAAA,IACZ,cACG,OAAK;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC,EACA,SAAS;AAAA,IACZ,mBACG,SAAO,EACP,IAAI,EACJ;AAAA,MACC;AAAA,IACF,EACC,IAAI,CAAC,EACL,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;AACM,IAAM,0BAA4B,SAAO;AAAA,EAC9C,SACG;AAAA,IACG,SAAO;AAAA,MACP,KACG,SAAO,EACP,SAAS,qDAAqD,EAC9D,IAAI,GAAG,EACP,SAAS;AAAA,MACZ,cACG,OAAK,EACL,SAAS,yCAAyC,EAClD,SAAS,EACT,SAAS;AAAA,MACZ,OACG,SAAO,EACP,SAAS,uCAAuC,EAChD,IAAI,GAAI,EACR,SAAS;AAAA,MACZ,SACG,SAAO,EACP,SAAS,mDAAmD,EAC5D,IAAI,GAAM,EACV,SAAS;AAAA,MACZ,KACG,SAAO,EACP,SAAS,0DAA0D,EACnE,IAAI,GAAI,EACR,SAAS;AAAA,MACZ,gBACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,QACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,GAAG,EACP,SAAS;AAAA,IACd,CAAC;AAAA,EACH,EACC,IAAI,GAAG,EACP,SAAS;AACd,CAAC;AACM,IAAM,iCAAmC,SAAO;AAAA,EACrD,YACG,SAAO,EACP,SAAS,kDAAkD,EAC3D,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,EACV,SACG,SAAO;AAAA,IACN,cACG,OAAK;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC,EACA,SAAS;AAAA,IACZ,gBACG,SAAO,EACP,IAAI,EACJ;AAAA,MACC;AAAA,IACF,EACC,IAAI,CAAC,EACL,IAAI,EAAE,EACN,SAAS,EACT,SAAS;AAAA,IACZ,mBACG,SAAO,EACP,IAAI,EACJ;AAAA,MACC;AAAA,IACF,EACC,IAAI,CAAC,EACL,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;AACM,IAAM,kCAAoC,SAAO;AAAA,EACtD,SACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,IAAI,GAAM,EACV,SAAS;AACd,CAAC;","names":[]}
+{"version":3,"sources":["../../schemas.ts","../../src/igor-v1-document-entry-document-search.schemas.ts"],"sourcesContent":["export * from './src/igor-v1-document-entry-document-search.schemas.js';\n","import * as z from 'zod';\n\nexport const SearchDocumentsRequest = /*#__PURE__*/ z.object({\n  searchTerm: z\n    .string()\n    .describe('The search term to look up in the documentation.')\n    .min(1)\n    .max(500),\n  options: z\n    .object({\n      maximumResults: z\n        .number()\n        .int()\n        .describe(\n          'The maximum number of results to return. Defaults to 15. Valid range: [1, 20].'\n        )\n        .min(1)\n        .max(20)\n        .optional()\n        .nullable(),\n      documentType: z\n        .enum([\n          'DOCUMENT_TYPE_UNSPECIFIED',\n          'VELO',\n          'SDK',\n          'REST',\n          'WDS',\n          'BUILD_APPS',\n          'WIX_HEADLESS',\n          'CLI',\n          'BUSINESS_SOLUTIONS',\n          'OVERVIEW',\n        ])\n        .optional(),\n      linesInEachResult: z\n        .number()\n        .int()\n        .describe(\n          'Maximum number of lines to include per result content. Defaults to 20.\\nMethod results use section-aware truncation; article results are truncated\\nat this line count. A \"Read more here: <url>\" hint is appended when content\\nis truncated.'\n        )\n        .min(1)\n        .max(200)\n        .optional()\n        .nullable(),\n    })\n    .optional(),\n});\nexport const SearchDocumentsResponse = /*#__PURE__*/ z.object({\n  results: z\n    .array(\n      z.object({\n        _id: z\n          .string()\n          .describe('The unique identifier for this documentation entry.')\n          .max(500)\n          .optional(),\n        _updatedDate: z\n          .date()\n          .describe('The date the document was last updated.')\n          .optional()\n          .nullable(),\n        title: z\n          .string()\n          .describe('The title of the documentation entry.')\n          .max(1000)\n          .optional(),\n        content: z\n          .string()\n          .describe('The full text content of the documentation entry.')\n          .max(100000)\n          .optional(),\n        url: z\n          .string()\n          .describe('The direct URL to the documentation page for this entry.')\n          .max(2000)\n          .optional(),\n        relevanceScore: z\n          .number()\n          .describe(\n            'The relevance score in the range [0, 1]. Higher means more relevant.'\n          )\n          .optional(),\n        kbName: z\n          .string()\n          .describe(\n            'The knowledge base this entry was retrieved from (e.g. \"REST_METHODS_KB_ID\").'\n          )\n          .max(100)\n          .optional(),\n      })\n    )\n    .max(100)\n    .optional(),\n});\nexport const SearchDocumentsMarkdownRequest = /*#__PURE__*/ z.object({\n  searchTerm: z\n    .string()\n    .describe('The search term to look up in the documentation.')\n    .min(1)\n    .max(500),\n  options: z\n    .object({\n      documentType: z\n        .enum([\n          'DOCUMENT_TYPE_UNSPECIFIED',\n          'VELO',\n          'SDK',\n          'REST',\n          'WDS',\n          'BUILD_APPS',\n          'WIX_HEADLESS',\n          'CLI',\n          'BUSINESS_SOLUTIONS',\n          'OVERVIEW',\n        ])\n        .optional(),\n      maximumResults: z\n        .number()\n        .int()\n        .describe(\n          'The maximum number of results to return. Defaults to 15. Valid range: [1, 20].'\n        )\n        .min(1)\n        .max(20)\n        .optional()\n        .nullable(),\n      linesInEachResult: z\n        .number()\n        .int()\n        .describe(\n          'Maximum number of lines to include per result. Defaults to 20. Method\\nresults use section-aware truncation; article results are truncated at this\\nline count. A \"Read more here: <url>\" hint is appended when content is\\ntruncated.'\n        )\n        .min(1)\n        .max(200)\n        .optional()\n        .nullable(),\n    })\n    .optional(),\n});\nexport const SearchDocumentsMarkdownResponse = /*#__PURE__*/ z.object({\n  content: z\n    .string()\n    .describe(\n      'The search results as a single markdown document. Method results are interleaved\\nwith article results. Results are separated by a line of equal signs.'\n    )\n    .max(500000)\n    .optional(),\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,QAAmB;AAEZ,IAAM,yBAAuC,gBAAE,SAAO;AAAA,EAC3D,YACG,SAAO,EACP,SAAS,kDAAkD,EAC3D,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,EACV,SACG,SAAO;AAAA,IACN,gBACG,SAAO,EACP,IAAI,EACJ;AAAA,MACC;AAAA,IACF,EACC,IAAI,CAAC,EACL,IAAI,EAAE,EACN,SAAS,EACT,SAAS;AAAA,IACZ,cACG,OAAK;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC,EACA,SAAS;AAAA,IACZ,mBACG,SAAO,EACP,IAAI,EACJ;AAAA,MACC;AAAA,IACF,EACC,IAAI,CAAC,EACL,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;AACM,IAAM,0BAAwC,gBAAE,SAAO;AAAA,EAC5D,SACG;AAAA,IACG,SAAO;AAAA,MACP,KACG,SAAO,EACP,SAAS,qDAAqD,EAC9D,IAAI,GAAG,EACP,SAAS;AAAA,MACZ,cACG,OAAK,EACL,SAAS,yCAAyC,EAClD,SAAS,EACT,SAAS;AAAA,MACZ,OACG,SAAO,EACP,SAAS,uCAAuC,EAChD,IAAI,GAAI,EACR,SAAS;AAAA,MACZ,SACG,SAAO,EACP,SAAS,mDAAmD,EAC5D,IAAI,GAAM,EACV,SAAS;AAAA,MACZ,KACG,SAAO,EACP,SAAS,0DAA0D,EACnE,IAAI,GAAI,EACR,SAAS;AAAA,MACZ,gBACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,QACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,GAAG,EACP,SAAS;AAAA,IACd,CAAC;AAAA,EACH,EACC,IAAI,GAAG,EACP,SAAS;AACd,CAAC;AACM,IAAM,iCAA+C,gBAAE,SAAO;AAAA,EACnE,YACG,SAAO,EACP,SAAS,kDAAkD,EAC3D,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,EACV,SACG,SAAO;AAAA,IACN,cACG,OAAK;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC,EACA,SAAS;AAAA,IACZ,gBACG,SAAO,EACP,IAAI,EACJ;AAAA,MACC;AAAA,IACF,EACC,IAAI,CAAC,EACL,IAAI,EAAE,EACN,SAAS,EACT,SAAS;AAAA,IACZ,mBACG,SAAO,EACP,IAAI,EACJ;AAAA,MACC;AAAA,IACF,EACC,IAAI,CAAC,EACL,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;AACM,IAAM,kCAAgD,gBAAE,SAAO;AAAA,EACpE,SACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,IAAI,GAAM,EACV,SAAS;AACd,CAAC;","names":[]}

package/build/es/index.mjs

@@ -104,6 +104,7 @@ var DocumentType = /* @__PURE__ */ ((DocumentType2) => {
   DocumentType2["WIX_HEADLESS"] = "WIX_HEADLESS";
   DocumentType2["CLI"] = "CLI";
   DocumentType2["BUSINESS_SOLUTIONS"] = "BUSINESS_SOLUTIONS";
+  DocumentType2["OVERVIEW"] = "OVERVIEW";
   return DocumentType2;
 })(DocumentType || {});
 async function searchDocuments2(searchTerm, options) {

package/build/es/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/igor-v1-document-entry-document-search.universal.ts","../../src/igor-v1-document-entry-document-search.http.ts","../../src/igor-v1-document-entry-document-search.public.ts","../../src/igor-v1-document-entry-document-search.context.ts"],"sourcesContent":["import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixIgorV1DocumentEntry from './igor-v1-document-entry-document-search.http.js';\n\n/** A Wix documentation entry returned as a search result. */\nexport interface DocumentEntry {\n  /**\n   * The unique identifier for this documentation entry.\n   * @maxLength 500\n   */\n  _id?: string;\n  /** The date the document was last updated. */\n  _updatedDate?: Date | null;\n  /**\n   * The title of the documentation entry.\n   * @maxLength 1000\n   */\n  title?: string;\n  /**\n   * The full text content of the documentation entry.\n   * @maxLength 100000\n   */\n  content?: string;\n  /**\n   * The direct URL to the documentation page for this entry.\n   * @maxLength 2000\n   */\n  url?: string;\n  /** The relevance score in the range [0, 1]. Higher means more relevant. */\n  relevanceScore?: number;\n  /**\n   * The knowledge base this entry was retrieved from (e.g. \"REST_METHODS_KB_ID\").\n   * @maxLength 100\n   */\n  kbName?: string;\n}\n\n/** The parameters for a SearchDocuments call. */\nexport interface SearchDocumentsRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The type of Wix documentation to search. */\nexport enum DocumentType {\n  /** Default value. Must not be used. */\n  DOCUMENT_TYPE_UNSPECIFIED = 'DOCUMENT_TYPE_UNSPECIFIED',\n  /** Velo JavaScript APIs for Wix sites. */\n  VELO = 'VELO',\n  /** Wix JavaScript SDK for headless and external applications. */\n  SDK = 'SDK',\n  /** Wix REST APIs. */\n  REST = 'REST',\n  /** Wix Design System documentation. */\n  WDS = 'WDS',\n  /** Documentation for building Wix apps. */\n  BUILD_APPS = 'BUILD_APPS',\n  /** Wix Headless documentation for external and headless applications. */\n  WIX_HEADLESS = 'WIX_HEADLESS',\n  /** Wix CLI documentation. */\n  CLI = 'CLI',\n  /** Wix business solutions and workflow documentation. */\n  BUSINESS_SOLUTIONS = 'BUSINESS_SOLUTIONS',\n}\n\n/** @enumType */\nexport type DocumentTypeWithLiterals =\n  | DocumentType\n  | 'DOCUMENT_TYPE_UNSPECIFIED'\n  | 'VELO'\n  | 'SDK'\n  | 'REST'\n  | 'WDS'\n  | 'BUILD_APPS'\n  | 'WIX_HEADLESS'\n  | 'CLI'\n  | 'BUSINESS_SOLUTIONS';\n\n/** The result of a SearchDocuments call. */\nexport interface SearchDocumentsResponse {\n  /**\n   * The ranked list of matching documentation entries, ordered by relevance score descending.\n   * @maxSize 100\n   */\n  results?: DocumentEntry[];\n}\n\n/** The parameters for a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The result of a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownResponse {\n  /**\n   * The search results as a single markdown document. Method results are interleaved\n   * with article results. Results are separated by a line of equal signs.\n   * @maxLength 500000\n   */\n  content?: string;\n}\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n * @param searchTerm - The search term to look up in the documentation.\n * @public\n * @documentationMaturity preview\n * @requiredField searchTerm\n * @permissionId igor:v1:document_entry:search_documents\n * @returns The result of a SearchDocuments call.\n * @fqn wix.igor.v1.DocumentSearchService.SearchDocuments\n */\nexport async function searchDocuments(\n  searchTerm: string,\n  options?: SearchDocumentsOptions\n): Promise<\n  NonNullablePaths<\n    SearchDocumentsResponse,\n    | `results`\n    | `results.${number}._id`\n    | `results.${number}.title`\n    | `results.${number}.content`\n    | `results.${number}.url`\n    | `results.${number}.relevanceScore`\n    | `results.${number}.kbName`,\n    4\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    searchTerm: searchTerm,\n    maximumResults: options?.maximumResults,\n    documentType: options?.documentType,\n    linesInEachResult: options?.linesInEachResult,\n  });\n\n  const reqOpts = ambassadorWixIgorV1DocumentEntry.searchDocuments(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          searchTerm: '$[0]',\n          maximumResults: '$[1].maximumResults',\n          documentType: '$[1].documentType',\n          linesInEachResult: '$[1].linesInEachResult',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['searchTerm', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface SearchDocumentsOptions {\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n * @param searchTerm - The search term to look up in the documentation.\n * @public\n * @documentationMaturity preview\n * @requiredField searchTerm\n * @permissionId igor:v1:document_entry:search_documents_markdown\n * @returns The result of a SearchDocumentsMarkdown call.\n * @fqn wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown\n */\nexport async function searchDocumentsMarkdown(\n  searchTerm: string,\n  options?: SearchDocumentsMarkdownOptions\n): Promise<NonNullablePaths<SearchDocumentsMarkdownResponse, `content`, 2>> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    searchTerm: searchTerm,\n    documentType: options?.documentType,\n    maximumResults: options?.maximumResults,\n    linesInEachResult: options?.linesInEachResult,\n  });\n\n  const reqOpts =\n    ambassadorWixIgorV1DocumentEntry.searchDocumentsMarkdown(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          searchTerm: '$[0]',\n          documentType: '$[1].documentType',\n          maximumResults: '$[1].maximumResults',\n          linesInEachResult: '$[1].linesInEachResult',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['searchTerm', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface SearchDocumentsMarkdownOptions {\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n","import { transformRESTFloatToSDKFloat } from '@wix/sdk-runtime/transformations/float';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixIgorV1DocumentSearchServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'www.wixapis.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'bo._base_domain_': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_igor_document-search';\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n */\nexport function searchDocuments(payload: object): RequestOptionsFactory<any> {\n  function __searchDocuments({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocuments',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search',\n        data: payload,\n        host,\n      }),\n      data: payload,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'results.updatedDate' }],\n          },\n          {\n            transformFn: transformRESTFloatToSDKFloat,\n            paths: [{ path: 'results.relevanceScore' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __searchDocuments;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n */\nexport function searchDocumentsMarkdown(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __searchDocumentsMarkdown({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search/markdown',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __searchDocumentsMarkdown;\n}\n","import { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport {\n  SearchDocumentsMarkdownOptions,\n  SearchDocumentsMarkdownResponse,\n  SearchDocumentsOptions,\n  SearchDocumentsResponse,\n  searchDocuments as universalSearchDocuments,\n  searchDocumentsMarkdown as universalSearchDocumentsMarkdown,\n} from './igor-v1-document-entry-document-search.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/igor' };\n\nexport function searchDocuments(\n  httpClient: HttpClient\n): SearchDocumentsSignature {\n  return (searchTerm: string, options?: SearchDocumentsOptions) =>\n    universalSearchDocuments(\n      searchTerm,\n      options,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface SearchDocumentsSignature {\n  /**\n   * Searches Wix documentation entries by a search term and document type.\n   *\n   * Returns a ranked list of matching documentation entries ordered by relevance\n   * score descending. Method results include kb_name to identify the source\n   * knowledge base. Each result is truncated to lines_in_each_result lines\n   * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n   * for more content per result.\n   * @param - The search term to look up in the documentation.\n   * @returns The result of a SearchDocuments call.\n   */\n  (searchTerm: string, options?: SearchDocumentsOptions): Promise<\n    NonNullablePaths<\n      SearchDocumentsResponse,\n      | `results`\n      | `results.${number}._id`\n      | `results.${number}.title`\n      | `results.${number}.content`\n      | `results.${number}.url`\n      | `results.${number}.relevanceScore`\n      | `results.${number}.kbName`,\n      4\n    >\n  >;\n}\n\nexport function searchDocumentsMarkdown(\n  httpClient: HttpClient\n): SearchDocumentsMarkdownSignature {\n  return (searchTerm: string, options?: SearchDocumentsMarkdownOptions) =>\n    universalSearchDocumentsMarkdown(\n      searchTerm,\n      options,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface SearchDocumentsMarkdownSignature {\n  /**\n   * Searches Wix documentation and returns results as a single markdown string\n   * ready to be passed directly to an LLM.\n   *\n   * Method results are interleaved 2-by-2 with article results so both types\n   * always appear. Each result is truncated to lines_in_each_result lines\n   * (defaults to 20) with a contextual hint (method results get a schema read\n   * hint; article results get a \"read the full article\" hint). Results are\n   * separated by a line of equal signs.\n   * @param - The search term to look up in the documentation.\n   * @returns The result of a SearchDocumentsMarkdown call.\n   */\n  (searchTerm: string, options?: SearchDocumentsMarkdownOptions): Promise<\n    NonNullablePaths<SearchDocumentsMarkdownResponse, `content`, 2>\n  >;\n}\n\nexport {\n  DocumentEntry,\n  DocumentType,\n  SearchDocumentsMarkdownOptions,\n  SearchDocumentsMarkdownRequest,\n  SearchDocumentsMarkdownResponse,\n  SearchDocumentsOptions,\n  SearchDocumentsRequest,\n  SearchDocumentsResponse,\n} from './igor-v1-document-entry-document-search.universal.js';\n","import {\n  searchDocuments as publicSearchDocuments,\n  searchDocumentsMarkdown as publicSearchDocumentsMarkdown,\n} from './igor-v1-document-entry-document-search.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';\n\nexport const searchDocuments: MaybeContext<\n  BuildRESTFunction<typeof publicSearchDocuments> & typeof publicSearchDocuments\n> = /*#__PURE__*/ createRESTModule(publicSearchDocuments);\nexport const searchDocumentsMarkdown: MaybeContext<\n  BuildRESTFunction<typeof publicSearchDocumentsMarkdown> &\n    typeof publicSearchDocumentsMarkdown\n> = /*#__PURE__*/ createRESTModule(publicSearchDocumentsMarkdown);\n\nexport { DocumentType } from './igor-v1-document-entry-document-search.universal.js';\nexport {\n  DocumentEntry,\n  SearchDocumentsRequest,\n  SearchDocumentsResponse,\n  SearchDocumentsMarkdownRequest,\n  SearchDocumentsMarkdownResponse,\n  SearchDocumentsOptions,\n  SearchDocumentsMarkdownOptions,\n} from './igor-v1-document-entry-document-search.universal.js';\nexport { DocumentTypeWithLiterals } from './igor-v1-document-entry-document-search.universal.js';\n"],"mappings":";AAAA,SAAS,kBAAkB,yBAAyB;AACpD;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACJP,SAAS,oCAAoC;AAC7C,SAAS,4CAA4C;AACrD,SAAS,sBAAsB;AAC/B,SAAS,kBAAkB;AAI3B,SAAS,yCACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,SAAO,WAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAWd,SAAS,gBAAgB,SAA6C;AAC3E,WAAS,kBAAkB,EAAE,KAAK,GAAQ;AACxC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAAA,QACzC;AAAA,QACA;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,yBAAyB,CAAC;AAAA,QAC5C;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAYO,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADnDO,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,+BAA4B;AAE5B,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,gBAAa;AAEb,EAAAA,cAAA,kBAAe;AAEf,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,wBAAqB;AAlBX,SAAAA;AAAA,GAAA;AAgGZ,eAAsBC,iBACpB,YACA,SAaA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,IACA,gBAAgB,SAAS;AAAA,IACzB,cAAc,SAAS;AAAA,IACvB,mBAAmB,SAAS;AAAA,EAC9B,CAAC;AAED,QAAM,UAA2C,gBAAgB,OAAO;AAExE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,YAAY;AAAA,UACZ,gBAAgB;AAAA,UAChB,cAAc;AAAA,UACd,mBAAmB;AAAA,QACrB;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,cAAc,SAAS;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAuCA,eAAsBC,yBACpB,YACA,SAC0E;AAE1E,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,IACA,cAAc,SAAS;AAAA,IACvB,gBAAgB,SAAS;AAAA,IACzB,mBAAmB,SAAS;AAAA,EAC9B,CAAC;AAED,QAAM,UAC6B,wBAAwB,OAAO;AAElE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,YAAY;AAAA,UACZ,cAAc;AAAA,UACd,gBAAgB;AAAA,UAChB,mBAAmB;AAAA,QACrB;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,cAAc,SAAS;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AErSO,SAASC,iBACd,YAC0B;AAC1B,SAAO,CAAC,YAAoB,YAC1BA;AAAA,IACE;AAAA,IACA;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AA6BO,SAASC,yBACd,YACkC;AAClC,SAAO,CAAC,YAAoB,YAC1BA;AAAA,IACE;AAAA,IACA;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;;;ACzDA,SAAS,wBAAwB;AAG1B,IAAMC,mBAEK,iCAAiBA,gBAAqB;AACjD,IAAMC,2BAGK,iCAAiBA,wBAA6B;","names":["payload","DocumentType","searchDocuments","searchDocumentsMarkdown","searchDocuments","searchDocumentsMarkdown","searchDocuments","searchDocumentsMarkdown"]}
+{"version":3,"sources":["../../src/igor-v1-document-entry-document-search.universal.ts","../../src/igor-v1-document-entry-document-search.http.ts","../../src/igor-v1-document-entry-document-search.public.ts","../../src/igor-v1-document-entry-document-search.context.ts"],"sourcesContent":["import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixIgorV1DocumentEntry from './igor-v1-document-entry-document-search.http.js';\n\n/** A Wix documentation entry returned as a search result. */\nexport interface DocumentEntry {\n  /**\n   * The unique identifier for this documentation entry.\n   * @maxLength 500\n   */\n  _id?: string;\n  /** The date the document was last updated. */\n  _updatedDate?: Date | null;\n  /**\n   * The title of the documentation entry.\n   * @maxLength 1000\n   */\n  title?: string;\n  /**\n   * The full text content of the documentation entry.\n   * @maxLength 100000\n   */\n  content?: string;\n  /**\n   * The direct URL to the documentation page for this entry.\n   * @maxLength 2000\n   */\n  url?: string;\n  /** The relevance score in the range [0, 1]. Higher means more relevant. */\n  relevanceScore?: number;\n  /**\n   * The knowledge base this entry was retrieved from (e.g. \"REST_METHODS_KB_ID\").\n   * @maxLength 100\n   */\n  kbName?: string;\n}\n\n/** The parameters for a SearchDocuments call. */\nexport interface SearchDocumentsRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The type of Wix documentation to search. */\nexport enum DocumentType {\n  /** Default value. Must not be used. */\n  DOCUMENT_TYPE_UNSPECIFIED = 'DOCUMENT_TYPE_UNSPECIFIED',\n  /** Velo JavaScript APIs for Wix sites. */\n  VELO = 'VELO',\n  /** Wix JavaScript SDK for headless and external applications. */\n  SDK = 'SDK',\n  /** Wix REST APIs. */\n  REST = 'REST',\n  /** Wix Design System documentation. */\n  WDS = 'WDS',\n  /** Documentation for building Wix apps. */\n  BUILD_APPS = 'BUILD_APPS',\n  /** Wix Headless documentation for external and headless applications. */\n  WIX_HEADLESS = 'WIX_HEADLESS',\n  /** Wix CLI documentation. */\n  CLI = 'CLI',\n  /** Wix business solutions and workflow documentation. */\n  BUSINESS_SOLUTIONS = 'BUSINESS_SOLUTIONS',\n  /** High-level Wix platform and business overview documentation. */\n  OVERVIEW = 'OVERVIEW',\n}\n\n/** @enumType */\nexport type DocumentTypeWithLiterals =\n  | DocumentType\n  | 'DOCUMENT_TYPE_UNSPECIFIED'\n  | 'VELO'\n  | 'SDK'\n  | 'REST'\n  | 'WDS'\n  | 'BUILD_APPS'\n  | 'WIX_HEADLESS'\n  | 'CLI'\n  | 'BUSINESS_SOLUTIONS'\n  | 'OVERVIEW';\n\n/** The result of a SearchDocuments call. */\nexport interface SearchDocumentsResponse {\n  /**\n   * The ranked list of matching documentation entries, ordered by relevance score descending.\n   * @maxSize 100\n   */\n  results?: DocumentEntry[];\n}\n\n/** The parameters for a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownRequest {\n  /**\n   * The search term to look up in the documentation.\n   * @minLength 1\n   * @maxLength 500\n   */\n  searchTerm: string;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/** The result of a SearchDocumentsMarkdown call. */\nexport interface SearchDocumentsMarkdownResponse {\n  /**\n   * The search results as a single markdown document. Method results are interleaved\n   * with article results. Results are separated by a line of equal signs.\n   * @maxLength 500000\n   */\n  content?: string;\n}\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n * @param searchTerm - The search term to look up in the documentation.\n * @public\n * @documentationMaturity preview\n * @requiredField searchTerm\n * @permissionId igor:v1:document_entry:search_documents\n * @returns The result of a SearchDocuments call.\n * @fqn wix.igor.v1.DocumentSearchService.SearchDocuments\n */\nexport async function searchDocuments(\n  searchTerm: string,\n  options?: SearchDocumentsOptions\n): Promise<\n  NonNullablePaths<\n    SearchDocumentsResponse,\n    | `results`\n    | `results.${number}._id`\n    | `results.${number}.title`\n    | `results.${number}.content`\n    | `results.${number}.url`\n    | `results.${number}.relevanceScore`\n    | `results.${number}.kbName`,\n    4\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    searchTerm: searchTerm,\n    maximumResults: options?.maximumResults,\n    documentType: options?.documentType,\n    linesInEachResult: options?.linesInEachResult,\n  });\n\n  const reqOpts = ambassadorWixIgorV1DocumentEntry.searchDocuments(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          searchTerm: '$[0]',\n          maximumResults: '$[1].maximumResults',\n          documentType: '$[1].documentType',\n          linesInEachResult: '$[1].linesInEachResult',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['searchTerm', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface SearchDocumentsOptions {\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * Maximum number of lines to include per result content. Defaults to 20.\n   * Method results use section-aware truncation; article results are truncated\n   * at this line count. A \"Read more here: <url>\" hint is appended when content\n   * is truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n * @param searchTerm - The search term to look up in the documentation.\n * @public\n * @documentationMaturity preview\n * @requiredField searchTerm\n * @permissionId igor:v1:document_entry:search_documents_markdown\n * @returns The result of a SearchDocumentsMarkdown call.\n * @fqn wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown\n */\nexport async function searchDocumentsMarkdown(\n  searchTerm: string,\n  options?: SearchDocumentsMarkdownOptions\n): Promise<NonNullablePaths<SearchDocumentsMarkdownResponse, `content`, 2>> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    searchTerm: searchTerm,\n    documentType: options?.documentType,\n    maximumResults: options?.maximumResults,\n    linesInEachResult: options?.linesInEachResult,\n  });\n\n  const reqOpts =\n    ambassadorWixIgorV1DocumentEntry.searchDocumentsMarkdown(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          searchTerm: '$[0]',\n          documentType: '$[1].documentType',\n          maximumResults: '$[1].maximumResults',\n          linesInEachResult: '$[1].linesInEachResult',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['searchTerm', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface SearchDocumentsMarkdownOptions {\n  /** The type of documentation to search. Defaults to REST if not provided. */\n  documentType?: DocumentTypeWithLiterals;\n  /**\n   * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].\n   * @min 1\n   * @max 20\n   */\n  maximumResults?: number | null;\n  /**\n   * Maximum number of lines to include per result. Defaults to 20. Method\n   * results use section-aware truncation; article results are truncated at this\n   * line count. A \"Read more here: <url>\" hint is appended when content is\n   * truncated.\n   * @min 1\n   * @max 200\n   */\n  linesInEachResult?: number | null;\n}\n","import { transformRESTFloatToSDKFloat } from '@wix/sdk-runtime/transformations/float';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixIgorV1DocumentSearchServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'www.wixapis.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'bo._base_domain_': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/mcp-docs-search/v1',\n        destPath: '',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_igor_document-search';\n\n/**\n * Searches Wix documentation entries by a search term and document type.\n *\n * Returns a ranked list of matching documentation entries ordered by relevance\n * score descending. Method results include kb_name to identify the source\n * knowledge base. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n * for more content per result.\n */\nexport function searchDocuments(payload: object): RequestOptionsFactory<any> {\n  function __searchDocuments({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocuments',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search',\n        data: payload,\n        host,\n      }),\n      data: payload,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'results.updatedDate' }],\n          },\n          {\n            transformFn: transformRESTFloatToSDKFloat,\n            paths: [{ path: 'results.relevanceScore' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __searchDocuments;\n}\n\n/**\n * Searches Wix documentation and returns results as a single markdown string\n * ready to be passed directly to an LLM.\n *\n * Method results are interleaved 2-by-2 with article results so both types\n * always appear. Each result is truncated to lines_in_each_result lines\n * (defaults to 20) with a contextual hint (method results get a schema read\n * hint; article results get a \"read the full article\" hint). Results are\n * separated by a line of equal signs.\n */\nexport function searchDocumentsMarkdown(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __searchDocumentsMarkdown({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.igor.v1.document_entry',\n      method: 'POST' as any,\n      methodFqn: 'wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixIgorV1DocumentSearchServiceUrl({\n        protoPath: '/v1/docs/search/markdown',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __searchDocumentsMarkdown;\n}\n","import { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport {\n  SearchDocumentsMarkdownOptions,\n  SearchDocumentsMarkdownResponse,\n  SearchDocumentsOptions,\n  SearchDocumentsResponse,\n  searchDocuments as universalSearchDocuments,\n  searchDocumentsMarkdown as universalSearchDocumentsMarkdown,\n} from './igor-v1-document-entry-document-search.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/igor' };\n\nexport function searchDocuments(\n  httpClient: HttpClient\n): SearchDocumentsSignature {\n  return (searchTerm: string, options?: SearchDocumentsOptions) =>\n    universalSearchDocuments(\n      searchTerm,\n      options,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface SearchDocumentsSignature {\n  /**\n   * Searches Wix documentation entries by a search term and document type.\n   *\n   * Returns a ranked list of matching documentation entries ordered by relevance\n   * score descending. Method results include kb_name to identify the source\n   * knowledge base. Each result is truncated to lines_in_each_result lines\n   * (defaults to 20) with contextual \"read more\" hints; pass a larger value\n   * for more content per result.\n   * @param - The search term to look up in the documentation.\n   * @returns The result of a SearchDocuments call.\n   */\n  (searchTerm: string, options?: SearchDocumentsOptions): Promise<\n    NonNullablePaths<\n      SearchDocumentsResponse,\n      | `results`\n      | `results.${number}._id`\n      | `results.${number}.title`\n      | `results.${number}.content`\n      | `results.${number}.url`\n      | `results.${number}.relevanceScore`\n      | `results.${number}.kbName`,\n      4\n    >\n  >;\n}\n\nexport function searchDocumentsMarkdown(\n  httpClient: HttpClient\n): SearchDocumentsMarkdownSignature {\n  return (searchTerm: string, options?: SearchDocumentsMarkdownOptions) =>\n    universalSearchDocumentsMarkdown(\n      searchTerm,\n      options,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface SearchDocumentsMarkdownSignature {\n  /**\n   * Searches Wix documentation and returns results as a single markdown string\n   * ready to be passed directly to an LLM.\n   *\n   * Method results are interleaved 2-by-2 with article results so both types\n   * always appear. Each result is truncated to lines_in_each_result lines\n   * (defaults to 20) with a contextual hint (method results get a schema read\n   * hint; article results get a \"read the full article\" hint). Results are\n   * separated by a line of equal signs.\n   * @param - The search term to look up in the documentation.\n   * @returns The result of a SearchDocumentsMarkdown call.\n   */\n  (searchTerm: string, options?: SearchDocumentsMarkdownOptions): Promise<\n    NonNullablePaths<SearchDocumentsMarkdownResponse, `content`, 2>\n  >;\n}\n\nexport {\n  DocumentEntry,\n  DocumentType,\n  SearchDocumentsMarkdownOptions,\n  SearchDocumentsMarkdownRequest,\n  SearchDocumentsMarkdownResponse,\n  SearchDocumentsOptions,\n  SearchDocumentsRequest,\n  SearchDocumentsResponse,\n} from './igor-v1-document-entry-document-search.universal.js';\n","import {\n  searchDocuments as publicSearchDocuments,\n  searchDocumentsMarkdown as publicSearchDocumentsMarkdown,\n} from './igor-v1-document-entry-document-search.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';\n\nexport const searchDocuments: MaybeContext<\n  BuildRESTFunction<typeof publicSearchDocuments> & typeof publicSearchDocuments\n> = /*#__PURE__*/ createRESTModule(publicSearchDocuments);\nexport const searchDocumentsMarkdown: MaybeContext<\n  BuildRESTFunction<typeof publicSearchDocumentsMarkdown> &\n    typeof publicSearchDocumentsMarkdown\n> = /*#__PURE__*/ createRESTModule(publicSearchDocumentsMarkdown);\n\nexport { DocumentType } from './igor-v1-document-entry-document-search.universal.js';\nexport {\n  DocumentEntry,\n  SearchDocumentsRequest,\n  SearchDocumentsResponse,\n  SearchDocumentsMarkdownRequest,\n  SearchDocumentsMarkdownResponse,\n  SearchDocumentsOptions,\n  SearchDocumentsMarkdownOptions,\n} from './igor-v1-document-entry-document-search.universal.js';\nexport { DocumentTypeWithLiterals } from './igor-v1-document-entry-document-search.universal.js';\n"],"mappings":";AAAA,SAAS,kBAAkB,yBAAyB;AACpD;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACJP,SAAS,oCAAoC;AAC7C,SAAS,4CAA4C;AACrD,SAAS,sBAAsB;AAC/B,SAAS,kBAAkB;AAI3B,SAAS,yCACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,SAAO,WAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAWd,SAAS,gBAAgB,SAA6C;AAC3E,WAAS,kBAAkB,EAAE,KAAK,GAAQ;AACxC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAAA,QACzC;AAAA,QACA;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,yBAAyB,CAAC;AAAA,QAC5C;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAYO,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,yCAAyC;AAAA,QAC5C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADnDO,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,+BAA4B;AAE5B,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,UAAO;AAEP,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,gBAAa;AAEb,EAAAA,cAAA,kBAAe;AAEf,EAAAA,cAAA,SAAM;AAEN,EAAAA,cAAA,wBAAqB;AAErB,EAAAA,cAAA,cAAW;AApBD,SAAAA;AAAA,GAAA;AAmGZ,eAAsBC,iBACpB,YACA,SAaA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,IACA,gBAAgB,SAAS;AAAA,IACzB,cAAc,SAAS;AAAA,IACvB,mBAAmB,SAAS;AAAA,EAC9B,CAAC;AAED,QAAM,UAA2C,gBAAgB,OAAO;AAExE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,YAAY;AAAA,UACZ,gBAAgB;AAAA,UAChB,cAAc;AAAA,UACd,mBAAmB;AAAA,QACrB;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,cAAc,SAAS;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAuCA,eAAsBC,yBACpB,YACA,SAC0E;AAE1E,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,IACA,cAAc,SAAS;AAAA,IACvB,gBAAgB,SAAS;AAAA,IACzB,mBAAmB,SAAS;AAAA,EAC9B,CAAC;AAED,QAAM,UAC6B,wBAAwB,OAAO;AAElE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,YAAY;AAAA,UACZ,cAAc;AAAA,UACd,gBAAgB;AAAA,UAChB,mBAAmB;AAAA,QACrB;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,cAAc,SAAS;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AExSO,SAASC,iBACd,YAC0B;AAC1B,SAAO,CAAC,YAAoB,YAC1BA;AAAA,IACE;AAAA,IACA;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AA6BO,SAASC,yBACd,YACkC;AAClC,SAAO,CAAC,YAAoB,YAC1BA;AAAA,IACE;AAAA,IACA;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;;;ACzDA,SAAS,wBAAwB;AAG1B,IAAMC,mBAEK,iCAAiBA,gBAAqB;AACjD,IAAMC,2BAGK,iCAAiBA,wBAA6B;","names":["payload","DocumentType","searchDocuments","searchDocumentsMarkdown","searchDocuments","searchDocumentsMarkdown","searchDocuments","searchDocumentsMarkdown"]}

package/build/es/index.typings.d.mts

@@ -77,10 +77,12 @@ declare enum DocumentType {
     /** Wix CLI documentation. */
     CLI = "CLI",
     /** Wix business solutions and workflow documentation. */
-    BUSINESS_SOLUTIONS = "BUSINESS_SOLUTIONS"
+    BUSINESS_SOLUTIONS = "BUSINESS_SOLUTIONS",
+    /** High-level Wix platform and business overview documentation. */
+    OVERVIEW = "OVERVIEW"
 }
 /** @enumType */
-type DocumentTypeWithLiterals = DocumentType | 'DOCUMENT_TYPE_UNSPECIFIED' | 'VELO' | 'SDK' | 'REST' | 'WDS' | 'BUILD_APPS' | 'WIX_HEADLESS' | 'CLI' | 'BUSINESS_SOLUTIONS';
+type DocumentTypeWithLiterals = DocumentType | 'DOCUMENT_TYPE_UNSPECIFIED' | 'VELO' | 'SDK' | 'REST' | 'WDS' | 'BUILD_APPS' | 'WIX_HEADLESS' | 'CLI' | 'BUSINESS_SOLUTIONS' | 'OVERVIEW';
 /** The result of a SearchDocuments call. */
 interface SearchDocumentsResponse {
     /**

package/build/es/index.typings.mjs

@@ -104,6 +104,7 @@ var DocumentType = /* @__PURE__ */ ((DocumentType2) => {
   DocumentType2["WIX_HEADLESS"] = "WIX_HEADLESS";
   DocumentType2["CLI"] = "CLI";
   DocumentType2["BUSINESS_SOLUTIONS"] = "BUSINESS_SOLUTIONS";
+  DocumentType2["OVERVIEW"] = "OVERVIEW";
   return DocumentType2;
 })(DocumentType || {});
 async function searchDocuments2(searchTerm, options) {