@wix/auto_sdk_igor_document-search 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,160 @@
+/** A Wix documentation entry returned as a search result. */
+interface DocumentEntry {
+    /**
+     * The unique identifier for this documentation entry.
+     * @maxLength 500
+     */
+    _id?: string;
+    /** The date the document was last updated. */
+    _updatedDate?: Date | null;
+    /**
+     * The title of the documentation entry.
+     * @maxLength 1000
+     */
+    title?: string;
+    /**
+     * The full text content of the documentation entry.
+     * @maxLength 100000
+     */
+    content?: string;
+    /**
+     * The direct URL to the documentation page for this entry.
+     * @maxLength 2000
+     */
+    url?: string;
+    /** The relevance score in the range [0, 1]. Higher means more relevant. */
+    relevanceScore?: number;
+    /**
+     * The knowledge base this entry was retrieved from (e.g. "REST_METHODS_KB_ID").
+     * @maxLength 100
+     */
+    kbName?: string;
+}
+/** The parameters for a SearchDocuments call. */
+interface SearchDocumentsRequest {
+    /**
+     * The search term to look up in the documentation.
+     * @minLength 1
+     * @maxLength 500
+     */
+    searchTerm: string;
+    /**
+     * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].
+     * @min 1
+     * @max 20
+     */
+    maximumResults?: number | null;
+    /** The type of documentation to search. Defaults to REST if not provided. */
+    documentType?: DocumentTypeWithLiterals;
+    /**
+     * Maximum number of lines to include per result content. When set, method results use
+     * section-aware truncation; article results are truncated at this line count.
+     * A "Read more here: <url>" hint is appended when content is truncated.
+     * @min 1
+     * @max 200
+     */
+    linesInEachResult?: number | null;
+}
+/** The type of Wix documentation to search. */
+declare enum DocumentType {
+    /** Default value. Must not be used. */
+    DOCUMENT_TYPE_UNSPECIFIED = "DOCUMENT_TYPE_UNSPECIFIED",
+    /** Velo JavaScript APIs for Wix sites. */
+    VELO = "VELO",
+    /** Wix JavaScript SDK for headless and external applications. */
+    SDK = "SDK",
+    /** Wix REST APIs. */
+    REST = "REST",
+    /** Wix Design System documentation. */
+    WDS = "WDS",
+    /** Documentation for building Wix apps. */
+    BUILD_APPS = "BUILD_APPS",
+    /** Wix Headless documentation for external and headless applications. */
+    WIX_HEADLESS = "WIX_HEADLESS",
+    /** Wix CLI documentation. */
+    CLI = "CLI",
+    /** Wix business solutions and workflow documentation. */
+    BUSINESS_SOLUTIONS = "BUSINESS_SOLUTIONS"
+}
+/** @enumType */
+type DocumentTypeWithLiterals = DocumentType | 'DOCUMENT_TYPE_UNSPECIFIED' | 'VELO' | 'SDK' | 'REST' | 'WDS' | 'BUILD_APPS' | 'WIX_HEADLESS' | 'CLI' | 'BUSINESS_SOLUTIONS';
+/** The result of a SearchDocuments call. */
+interface SearchDocumentsResponse {
+    /**
+     * The ranked list of matching documentation entries, ordered by relevance score descending.
+     * @maxSize 100
+     */
+    results?: DocumentEntry[];
+}
+/** The parameters for a SearchDocumentsMarkdown call. */
+interface SearchDocumentsMarkdownRequest {
+    /**
+     * The search term to look up in the documentation.
+     * @minLength 1
+     * @maxLength 500
+     */
+    searchTerm: string;
+    /** The type of documentation to search. Defaults to REST if not provided. */
+    documentType?: DocumentTypeWithLiterals;
+    /**
+     * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].
+     * @min 1
+     * @max 20
+     */
+    maximumResults?: number | null;
+    /**
+     * Maximum number of lines to include per result. When set, method results use
+     * section-aware truncation; article results are truncated at this line count.
+     * A "Read more here: <url>" hint is appended when content is truncated.
+     * @min 1
+     * @max 200
+     */
+    linesInEachResult?: number | null;
+}
+/** The result of a SearchDocumentsMarkdown call. */
+interface SearchDocumentsMarkdownResponse {
+    /**
+     * The search results as a single markdown document. Method results are interleaved
+     * with article results. Results are separated by a line of equal signs.
+     * @maxLength 500000
+     */
+    content?: string;
+}
+interface SearchDocumentsOptions {
+    /**
+     * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].
+     * @min 1
+     * @max 20
+     */
+    maximumResults?: number | null;
+    /** The type of documentation to search. Defaults to REST if not provided. */
+    documentType?: DocumentTypeWithLiterals;
+    /**
+     * Maximum number of lines to include per result content. When set, method results use
+     * section-aware truncation; article results are truncated at this line count.
+     * A "Read more here: <url>" hint is appended when content is truncated.
+     * @min 1
+     * @max 200
+     */
+    linesInEachResult?: number | null;
+}
+interface SearchDocumentsMarkdownOptions {
+    /** The type of documentation to search. Defaults to REST if not provided. */
+    documentType?: DocumentTypeWithLiterals;
+    /**
+     * The maximum number of results to return. Defaults to 15. Valid range: [1, 20].
+     * @min 1
+     * @max 20
+     */
+    maximumResults?: number | null;
+    /**
+     * Maximum number of lines to include per result. When set, method results use
+     * section-aware truncation; article results are truncated at this line count.
+     * A "Read more here: <url>" hint is appended when content is truncated.
+     * @min 1
+     * @max 200
+     */
+    linesInEachResult?: number | null;
+}
+
+export { type DocumentEntry, DocumentType, type DocumentTypeWithLiterals, type SearchDocumentsMarkdownOptions, type SearchDocumentsMarkdownRequest, type SearchDocumentsMarkdownResponse, type SearchDocumentsOptions, type SearchDocumentsRequest, type SearchDocumentsResponse };

package/build/cjs/index.js

@@ -0,0 +1,211 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  DocumentType: () => DocumentType,
+  searchDocuments: () => searchDocuments4,
+  searchDocumentsMarkdown: () => searchDocumentsMarkdown4
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/igor-v1-document-entry-document-search.universal.ts
+var import_transform_error = require("@wix/sdk-runtime/transform-error");
+var import_rename_all_nested_keys = require("@wix/sdk-runtime/rename-all-nested-keys");
+
+// src/igor-v1-document-entry-document-search.http.ts
+var import_float = require("@wix/sdk-runtime/transformations/float");
+var import_timestamp = require("@wix/sdk-runtime/transformations/timestamp");
+var import_transform_paths = require("@wix/sdk-runtime/transformations/transform-paths");
+var import_rest_modules = require("@wix/sdk-runtime/rest-modules");
+function resolveWixIgorV1DocumentSearchServiceUrl(opts) {
+  const domainToMappings = {
+    "www.wixapis.com": [
+      {
+        srcPath: "/mcp-docs-search/v1",
+        destPath: ""
+      }
+    ]
+  };
+  return (0, import_rest_modules.resolveUrl)(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_igor_document-search";
+function searchDocuments(payload) {
+  function __searchDocuments({ host }) {
+    const metadata = {
+      entityFqdn: "wix.igor.v1.document_entry",
+      method: "POST",
+      methodFqn: "wix.igor.v1.DocumentSearchService.SearchDocuments",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixIgorV1DocumentSearchServiceUrl({
+        protoPath: "/v1/docs/search",
+        data: payload,
+        host
+      }),
+      data: payload,
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp.transformRESTTimestampToSDKTimestamp,
+          paths: [{ path: "results.updatedDate" }]
+        },
+        {
+          transformFn: import_float.transformRESTFloatToSDKFloat,
+          paths: [{ path: "results.relevanceScore" }]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __searchDocuments;
+}
+function searchDocumentsMarkdown(payload) {
+  function __searchDocumentsMarkdown({ host }) {
+    const metadata = {
+      entityFqdn: "wix.igor.v1.document_entry",
+      method: "POST",
+      methodFqn: "wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixIgorV1DocumentSearchServiceUrl({
+        protoPath: "/v1/docs/search/markdown",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __searchDocumentsMarkdown;
+}
+
+// src/igor-v1-document-entry-document-search.universal.ts
+var DocumentType = /* @__PURE__ */ ((DocumentType2) => {
+  DocumentType2["DOCUMENT_TYPE_UNSPECIFIED"] = "DOCUMENT_TYPE_UNSPECIFIED";
+  DocumentType2["VELO"] = "VELO";
+  DocumentType2["SDK"] = "SDK";
+  DocumentType2["REST"] = "REST";
+  DocumentType2["WDS"] = "WDS";
+  DocumentType2["BUILD_APPS"] = "BUILD_APPS";
+  DocumentType2["WIX_HEADLESS"] = "WIX_HEADLESS";
+  DocumentType2["CLI"] = "CLI";
+  DocumentType2["BUSINESS_SOLUTIONS"] = "BUSINESS_SOLUTIONS";
+  return DocumentType2;
+})(DocumentType || {});
+async function searchDocuments2(searchTerm, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    searchTerm,
+    maximumResults: options?.maximumResults,
+    documentType: options?.documentType,
+    linesInEachResult: options?.linesInEachResult
+  });
+  const reqOpts = searchDocuments(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          searchTerm: "$[0]",
+          maximumResults: "$[1].maximumResults",
+          documentType: "$[1].documentType",
+          linesInEachResult: "$[1].linesInEachResult"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["searchTerm", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function searchDocumentsMarkdown2(searchTerm, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    searchTerm,
+    documentType: options?.documentType,
+    maximumResults: options?.maximumResults,
+    linesInEachResult: options?.linesInEachResult
+  });
+  const reqOpts = searchDocumentsMarkdown(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          searchTerm: "$[0]",
+          documentType: "$[1].documentType",
+          maximumResults: "$[1].maximumResults",
+          linesInEachResult: "$[1].linesInEachResult"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["searchTerm", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+
+// src/igor-v1-document-entry-document-search.public.ts
+function searchDocuments3(httpClient) {
+  return (searchTerm, options) => searchDocuments2(
+    searchTerm,
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
+function searchDocumentsMarkdown3(httpClient) {
+  return (searchTerm, options) => searchDocumentsMarkdown2(
+    searchTerm,
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
+
+// src/igor-v1-document-entry-document-search.context.ts
+var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
+var searchDocuments4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModule)(searchDocuments3);
+var searchDocumentsMarkdown4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModule)(searchDocumentsMarkdown3);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DocumentType,
+  searchDocuments,
+  searchDocumentsMarkdown
+});
+//# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -0,0 +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. When set, method results use\n   * section-aware truncation; article results are truncated at this line count.\n   * A \"Read more here: <url>\" hint is appended when content 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. When set, method results use\n   * section-aware truncation; article results are truncated at this line count.\n   * A \"Read more here: <url>\" hint is appended when content is 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. Use lines_in_each_result to get truncated snippets with\n * contextual \"read more\" hints instead of full content.\n * @param searchTerm - The search term to look up in the documentation.\n * @internal\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. When set, method results use\n   * section-aware truncation; article results are truncated at this line count.\n   * A \"Read more here: <url>\" hint is appended when content 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. When lines_in_each_result is set, each result is truncated\n * with a contextual hint (method results get a schema read hint; article\n * results get a \"read the full article\" hint). Results are separated by a\n * line of equal signs.\n * @param searchTerm - The search term to look up in the documentation.\n * @internal\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. When set, method results use\n   * section-aware truncation; article results are truncated at this line count.\n   * A \"Read more here: <url>\" hint is appended when content is 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  };\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. Use lines_in_each_result to get truncated snippets with\n * contextual \"read more\" hints instead of full content.\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. When lines_in_each_result is set, each result is truncated\n * with a contextual hint (method results get a schema read hint; article\n * results get a \"read the full article\" hint). Results are separated by a\n * 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\n/** @internal */\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. Use lines_in_each_result to get truncated snippets with\n   * contextual \"read more\" hints instead of full content.\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\n/** @internal */\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. When lines_in_each_result is set, each result is truncated\n   * with a contextual hint (method results get a schema read hint; article\n   * results get a \"read the full article\" hint). Results are separated by a\n   * 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\n/** @internal */\nexport const searchDocuments: MaybeContext<\n  BuildRESTFunction<typeof publicSearchDocuments> & typeof publicSearchDocuments\n> = /*#__PURE__*/ createRESTModule(publicSearchDocuments);\n/** @internal */\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,EACF;AAEA,aAAO,gCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAUd,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;;;ADjCO,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;AA8FZ,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;AAsCA,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;;;AEhSO,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;;;AC1DA,IAAAC,uBAAiC;AAI1B,IAAMC,mBAEK,2DAAiBA,gBAAqB;AAEjD,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

@@ -0,0 +1 @@
+export { DocumentEntry, DocumentType, DocumentTypeWithLiterals, SearchDocumentsMarkdownOptions, SearchDocumentsMarkdownRequest, SearchDocumentsMarkdownResponse, SearchDocumentsOptions, SearchDocumentsRequest, SearchDocumentsResponse } from './index.js';

package/build/cjs/index.typings.js

@@ -0,0 +1,188 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.typings.ts
+var index_typings_exports = {};
+__export(index_typings_exports, {
+  DocumentType: () => DocumentType,
+  searchDocuments: () => searchDocuments2,
+  searchDocumentsMarkdown: () => searchDocumentsMarkdown2
+});
+module.exports = __toCommonJS(index_typings_exports);
+
+// src/igor-v1-document-entry-document-search.universal.ts
+var import_transform_error = require("@wix/sdk-runtime/transform-error");
+var import_rename_all_nested_keys = require("@wix/sdk-runtime/rename-all-nested-keys");
+
+// src/igor-v1-document-entry-document-search.http.ts
+var import_float = require("@wix/sdk-runtime/transformations/float");
+var import_timestamp = require("@wix/sdk-runtime/transformations/timestamp");
+var import_transform_paths = require("@wix/sdk-runtime/transformations/transform-paths");
+var import_rest_modules = require("@wix/sdk-runtime/rest-modules");
+function resolveWixIgorV1DocumentSearchServiceUrl(opts) {
+  const domainToMappings = {
+    "www.wixapis.com": [
+      {
+        srcPath: "/mcp-docs-search/v1",
+        destPath: ""
+      }
+    ]
+  };
+  return (0, import_rest_modules.resolveUrl)(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_igor_document-search";
+function searchDocuments(payload) {
+  function __searchDocuments({ host }) {
+    const metadata = {
+      entityFqdn: "wix.igor.v1.document_entry",
+      method: "POST",
+      methodFqn: "wix.igor.v1.DocumentSearchService.SearchDocuments",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixIgorV1DocumentSearchServiceUrl({
+        protoPath: "/v1/docs/search",
+        data: payload,
+        host
+      }),
+      data: payload,
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp.transformRESTTimestampToSDKTimestamp,
+          paths: [{ path: "results.updatedDate" }]
+        },
+        {
+          transformFn: import_float.transformRESTFloatToSDKFloat,
+          paths: [{ path: "results.relevanceScore" }]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __searchDocuments;
+}
+function searchDocumentsMarkdown(payload) {
+  function __searchDocumentsMarkdown({ host }) {
+    const metadata = {
+      entityFqdn: "wix.igor.v1.document_entry",
+      method: "POST",
+      methodFqn: "wix.igor.v1.DocumentSearchService.SearchDocumentsMarkdown",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixIgorV1DocumentSearchServiceUrl({
+        protoPath: "/v1/docs/search/markdown",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __searchDocumentsMarkdown;
+}
+
+// src/igor-v1-document-entry-document-search.universal.ts
+var DocumentType = /* @__PURE__ */ ((DocumentType2) => {
+  DocumentType2["DOCUMENT_TYPE_UNSPECIFIED"] = "DOCUMENT_TYPE_UNSPECIFIED";
+  DocumentType2["VELO"] = "VELO";
+  DocumentType2["SDK"] = "SDK";
+  DocumentType2["REST"] = "REST";
+  DocumentType2["WDS"] = "WDS";
+  DocumentType2["BUILD_APPS"] = "BUILD_APPS";
+  DocumentType2["WIX_HEADLESS"] = "WIX_HEADLESS";
+  DocumentType2["CLI"] = "CLI";
+  DocumentType2["BUSINESS_SOLUTIONS"] = "BUSINESS_SOLUTIONS";
+  return DocumentType2;
+})(DocumentType || {});
+async function searchDocuments2(searchTerm, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    searchTerm,
+    maximumResults: options?.maximumResults,
+    documentType: options?.documentType,
+    linesInEachResult: options?.linesInEachResult
+  });
+  const reqOpts = searchDocuments(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          searchTerm: "$[0]",
+          maximumResults: "$[1].maximumResults",
+          documentType: "$[1].documentType",
+          linesInEachResult: "$[1].linesInEachResult"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["searchTerm", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function searchDocumentsMarkdown2(searchTerm, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    searchTerm,
+    documentType: options?.documentType,
+    maximumResults: options?.maximumResults,
+    linesInEachResult: options?.linesInEachResult
+  });
+  const reqOpts = searchDocumentsMarkdown(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          searchTerm: "$[0]",
+          documentType: "$[1].documentType",
+          maximumResults: "$[1].maximumResults",
+          linesInEachResult: "$[1].linesInEachResult"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["searchTerm", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DocumentType,
+  searchDocuments,
+  searchDocumentsMarkdown
+});
+//# sourceMappingURL=index.typings.js.map

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

@@ -0,0 +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. When set, method results use\n   * section-aware truncation; article results are truncated at this line count.\n   * A \"Read more here: <url>\" hint is appended when content 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. When set, method results use\n   * section-aware truncation; article results are truncated at this line count.\n   * A \"Read more here: <url>\" hint is appended when content is 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. Use lines_in_each_result to get truncated snippets with\n * contextual \"read more\" hints instead of full content.\n * @param searchTerm - The search term to look up in the documentation.\n * @internal\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. When set, method results use\n   * section-aware truncation; article results are truncated at this line count.\n   * A \"Read more here: <url>\" hint is appended when content 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. When lines_in_each_result is set, each result is truncated\n * with a contextual hint (method results get a schema read hint; article\n * results get a \"read the full article\" hint). Results are separated by a\n * line of equal signs.\n * @param searchTerm - The search term to look up in the documentation.\n * @internal\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. When set, method results use\n   * section-aware truncation; article results are truncated at this line count.\n   * A \"Read more here: <url>\" hint is appended when content is 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  };\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. Use lines_in_each_result to get truncated snippets with\n * contextual \"read more\" hints instead of full content.\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. When lines_in_each_result is set, each result is truncated\n * with a contextual hint (method results get a schema read hint; article\n * results get a \"read the full article\" hint). Results are separated by a\n * 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,EACF;AAEA,aAAO,gCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAUd,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;;;ADjCO,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;AA8FZ,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;AAsCA,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"]}