@wix/auto_sdk_seo_page-optimization 1.0.0

package/build/cjs/meta.d.ts

@@ -0,0 +1,224 @@
+import { TriggerPageOptimizationRequest as TriggerPageOptimizationRequest$1, TriggerPageOptimizationResponse as TriggerPageOptimizationResponse$1, TriggerHomePageOptimizationRequest as TriggerHomePageOptimizationRequest$1, TriggerHomePageOptimizationResponse as TriggerHomePageOptimizationResponse$1, GetPageOptimizationResultsRequest as GetPageOptimizationResultsRequest$1, GetPageOptimizationResultsResponse as GetPageOptimizationResultsResponse$1 } from './index.typings.js';
+import '@wix/sdk-types';
+
+/**
+ * A whole-page set of SEO optimization suggestions, generated for one page
+ * and focus keyword.
+ *
+ * Each suggestion is a before/after pair: `before` is the page's current
+ * text (empty when the page has none, such as a missing meta description),
+ * and `after` is the suggested replacement. Locate the element to change by
+ * its `before` text.
+ */
+interface PageOptimization {
+    /**
+     * ID of this suggestion set.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Suggested title tag.
+     * @readonly
+     */
+    metaTitle?: TextSuggestion;
+    /**
+     * Suggested description tag.
+     * @readonly
+     */
+    metaDescription?: TextSuggestion;
+    /**
+     * Suggested H1 heading.
+     * @readonly
+     */
+    h1?: TextSuggestion;
+    /**
+     * Suggested H2 or H3 heading.
+     * @readonly
+     */
+    h2OrH3?: TextSuggestion;
+    /**
+     * Suggested body text rewrites.
+     * @readonly
+     * @maxSize 100
+     */
+    content?: TextSuggestion[];
+}
+/** One suggested text change. */
+interface TextSuggestion {
+    /**
+     * The page's current text. Empty when the page has no text in this slot —
+     * for example, a missing meta description.
+     * @readonly
+     * @maxLength 1000
+     */
+    before?: string | null;
+    /**
+     * The suggested text.
+     * @readonly
+     * @maxLength 1000
+     */
+    after?: string;
+}
+interface TriggerPageOptimizationRequest {
+    /**
+     * ID of the site page to optimize.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pageId: string;
+    /**
+     * URL path of the page, relative to the site's domain. For example,
+     * `/about`.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pagePath: string;
+}
+interface TriggerPageOptimizationResponse {
+    /**
+     * ID of the generation job. Pass to Get Page Optimization Results.
+     * @readonly
+     * @maxLength 200
+     */
+    predictionId?: string;
+}
+interface TriggerHomePageOptimizationRequest {
+    /**
+     * ID of the site's homepage.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pageId: string;
+    /**
+     * URL path of the homepage. Usually `/`.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pagePath: string;
+}
+interface TriggerHomePageOptimizationResponse {
+    /**
+     * ID of the generation job. Pass to Get Page Optimization Results.
+     * @readonly
+     * @maxLength 200
+     */
+    predictionId?: string;
+}
+interface GetPageOptimizationResultsRequest {
+    /**
+     * ID of the generation job, from the trigger call.
+     * @maxLength 200
+     */
+    predictionId?: string | null;
+    /**
+     * ID of the page to retrieve suggestions for. An alternative to
+     * `predictionId` — returns the page's latest generation.
+     * @maxLength 1000
+     */
+    pageId?: string | null;
+}
+interface GetPageOptimizationResultsResponse {
+    /** The generated suggestions. Returned only when `status` is `COMPLETED`. */
+    pageOptimization?: PageOptimization;
+    /**
+     * Status of the generation job the lookup matched.
+     * @readonly
+     */
+    status?: OptimizationStatusWithLiterals;
+}
+/** Status of a page optimization generation job. */
+declare enum OptimizationStatus {
+    UNKNOWN_OPTIMIZATION_STATUS = "UNKNOWN_OPTIMIZATION_STATUS",
+    /**
+     * No generation job matches the lookup — it never existed, or a later
+     * trigger for the same page replaced it.
+     */
+    NOT_FOUND = "NOT_FOUND",
+    /** Generation is still running. Poll again. */
+    IN_PROGRESS = "IN_PROGRESS",
+    /** Generation finished; the response carries the suggestions. */
+    COMPLETED = "COMPLETED",
+    /** Generation failed. Trigger again to retry. */
+    FAILED = "FAILED"
+}
+/** @enumType */
+type OptimizationStatusWithLiterals = OptimizationStatus | 'UNKNOWN_OPTIMIZATION_STATUS' | 'NOT_FOUND' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
+/** @docsIgnore */
+type TriggerPageOptimizationApplicationErrors = {
+    code?: 'SITE_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'FOCUS_KEYWORD_NOT_SET';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CONTENT_TOO_SHORT';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'SUGGESTIONS_ALREADY_IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'GENERATION_FAILED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUOTA_LIMIT_REACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type TriggerHomePageOptimizationApplicationErrors = {
+    code?: 'SITE_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'FOCUS_KEYWORD_NOT_SET';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CONTENT_TOO_SHORT';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'SUGGESTIONS_ALREADY_IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'GENERATION_FAILED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUOTA_LIMIT_REACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type GetPageOptimizationResultsApplicationErrors = {
+    code?: 'GENERATION_FAILED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUOTA_LIMIT_REACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function triggerPageOptimization(): __PublicMethodMetaInfo<'POST', {}, TriggerPageOptimizationRequest$1, TriggerPageOptimizationRequest, TriggerPageOptimizationResponse$1, TriggerPageOptimizationResponse>;
+declare function triggerHomePageOptimization(): __PublicMethodMetaInfo<'POST', {}, TriggerHomePageOptimizationRequest$1, TriggerHomePageOptimizationRequest, TriggerHomePageOptimizationResponse$1, TriggerHomePageOptimizationResponse>;
+declare function getPageOptimizationResults(): __PublicMethodMetaInfo<'GET', {}, GetPageOptimizationResultsRequest$1, GetPageOptimizationResultsRequest, GetPageOptimizationResultsResponse$1, GetPageOptimizationResultsResponse>;
+
+export { type GetPageOptimizationResultsApplicationErrors as GetPageOptimizationResultsApplicationErrorsOriginal, type GetPageOptimizationResultsRequest as GetPageOptimizationResultsRequestOriginal, type GetPageOptimizationResultsResponse as GetPageOptimizationResultsResponseOriginal, OptimizationStatus as OptimizationStatusOriginal, type OptimizationStatusWithLiterals as OptimizationStatusWithLiteralsOriginal, type PageOptimization as PageOptimizationOriginal, type TextSuggestion as TextSuggestionOriginal, type TriggerHomePageOptimizationApplicationErrors as TriggerHomePageOptimizationApplicationErrorsOriginal, type TriggerHomePageOptimizationRequest as TriggerHomePageOptimizationRequestOriginal, type TriggerHomePageOptimizationResponse as TriggerHomePageOptimizationResponseOriginal, type TriggerPageOptimizationApplicationErrors as TriggerPageOptimizationApplicationErrorsOriginal, type TriggerPageOptimizationRequest as TriggerPageOptimizationRequestOriginal, type TriggerPageOptimizationResponse as TriggerPageOptimizationResponseOriginal, type __PublicMethodMetaInfo, getPageOptimizationResults, triggerHomePageOptimization, triggerPageOptimization };

package/build/cjs/meta.js

@@ -0,0 +1,229 @@
+"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);
+
+// meta.ts
+var meta_exports = {};
+__export(meta_exports, {
+  OptimizationStatusOriginal: () => OptimizationStatus,
+  getPageOptimizationResults: () => getPageOptimizationResults2,
+  triggerHomePageOptimization: () => triggerHomePageOptimization2,
+  triggerPageOptimization: () => triggerPageOptimization2
+});
+module.exports = __toCommonJS(meta_exports);
+
+// src/seo-suggestions-v1-page-optimization-page-optimization.http.ts
+var import_rest_modules = require("@wix/sdk-runtime/rest-modules");
+var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
+function resolveWixSeoSuggestionsV1PageOptimizationServiceUrl(opts) {
+  const domainToMappings = {
+    "bo._base_domain_": [
+      {
+        srcPath: "/_serverless/seo-tags-suggestions-service",
+        destPath: ""
+      }
+    ],
+    "wixbo.ai": [
+      {
+        srcPath: "/_serverless/seo-tags-suggestions-service",
+        destPath: ""
+      }
+    ],
+    "wix-bo.com": [
+      {
+        srcPath: "/_serverless/seo-tags-suggestions-service",
+        destPath: ""
+      }
+    ],
+    "manage._base_domain_": [
+      {
+        srcPath: "/_serverless/seo-tags-suggestions-service",
+        destPath: ""
+      }
+    ],
+    "editor._base_domain_": [
+      {
+        srcPath: "/_api/seo-tags-suggestions-service",
+        destPath: ""
+      }
+    ],
+    "blocks._base_domain_": [
+      {
+        srcPath: "/_api/seo-tags-suggestions-service",
+        destPath: ""
+      }
+    ],
+    "create.editorx": [
+      {
+        srcPath: "/_api/seo-tags-suggestions-service",
+        destPath: ""
+      }
+    ],
+    "www.wixapis.com": [
+      {
+        srcPath: "/seo-suggestions/v1",
+        destPath: "/v1"
+      }
+    ]
+  };
+  return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_seo_page-optimization";
+function triggerPageOptimization(payload) {
+  function __triggerPageOptimization({ host }) {
+    const metadata = {
+      entityFqdn: "wix.seo.suggestions.v1.page_optimization",
+      method: "POST",
+      methodFqn: "wix.seo.suggestions.v1.PageOptimizationService.TriggerPageOptimization",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixSeoSuggestionsV1PageOptimizationServiceUrl({
+        protoPath: "/v1/page-optimization/trigger",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __triggerPageOptimization;
+}
+function triggerHomePageOptimization(payload) {
+  function __triggerHomePageOptimization({ host }) {
+    const metadata = {
+      entityFqdn: "wix.seo.suggestions.v1.page_optimization",
+      method: "POST",
+      methodFqn: "wix.seo.suggestions.v1.PageOptimizationService.TriggerHomePageOptimization",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixSeoSuggestionsV1PageOptimizationServiceUrl({
+        protoPath: "/v1/page-optimization/trigger-home",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __triggerHomePageOptimization;
+}
+function getPageOptimizationResults(payload) {
+  function __getPageOptimizationResults({ host }) {
+    const metadata = {
+      entityFqdn: "wix.seo.suggestions.v1.page_optimization",
+      method: "GET",
+      methodFqn: "wix.seo.suggestions.v1.PageOptimizationService.GetPageOptimizationResults",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixSeoSuggestionsV1PageOptimizationServiceUrl({
+        protoPath: "/v1/page-optimization/results",
+        data: payload,
+        host
+      }),
+      params: (0, import_rest_modules.toURLSearchParams)(payload)
+    };
+    return metadata;
+  }
+  return __getPageOptimizationResults;
+}
+
+// src/seo-suggestions-v1-page-optimization-page-optimization.types.ts
+var OptimizationStatus = /* @__PURE__ */ ((OptimizationStatus2) => {
+  OptimizationStatus2["UNKNOWN_OPTIMIZATION_STATUS"] = "UNKNOWN_OPTIMIZATION_STATUS";
+  OptimizationStatus2["NOT_FOUND"] = "NOT_FOUND";
+  OptimizationStatus2["IN_PROGRESS"] = "IN_PROGRESS";
+  OptimizationStatus2["COMPLETED"] = "COMPLETED";
+  OptimizationStatus2["FAILED"] = "FAILED";
+  return OptimizationStatus2;
+})(OptimizationStatus || {});
+
+// src/seo-suggestions-v1-page-optimization-page-optimization.meta.ts
+function triggerPageOptimization2() {
+  const payload = {};
+  const getRequestOptions = triggerPageOptimization(
+    payload
+  );
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "POST",
+    path: "/v1/page-optimization/trigger",
+    pathParams: {},
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function triggerHomePageOptimization2() {
+  const payload = {};
+  const getRequestOptions = triggerHomePageOptimization(
+    payload
+  );
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "POST",
+    path: "/v1/page-optimization/trigger-home",
+    pathParams: {},
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function getPageOptimizationResults2() {
+  const payload = {};
+  const getRequestOptions = getPageOptimizationResults(
+    payload
+  );
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "GET",
+    path: "/v1/page-optimization/results",
+    pathParams: {},
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  OptimizationStatusOriginal,
+  getPageOptimizationResults,
+  triggerHomePageOptimization,
+  triggerPageOptimization
+});
+//# sourceMappingURL=meta.js.map

package/build/cjs/meta.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../meta.ts","../../src/seo-suggestions-v1-page-optimization-page-optimization.http.ts","../../src/seo-suggestions-v1-page-optimization-page-optimization.types.ts","../../src/seo-suggestions-v1-page-optimization-page-optimization.meta.ts"],"sourcesContent":["export * from './src/seo-suggestions-v1-page-optimization-page-optimization.meta.js';\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixSeoSuggestionsV1PageOptimizationServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'bo._base_domain_': [\n      {\n        srcPath: '/_serverless/seo-tags-suggestions-service',\n        destPath: '',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/_serverless/seo-tags-suggestions-service',\n        destPath: '',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/_serverless/seo-tags-suggestions-service',\n        destPath: '',\n      },\n    ],\n    'manage._base_domain_': [\n      {\n        srcPath: '/_serverless/seo-tags-suggestions-service',\n        destPath: '',\n      },\n    ],\n    'editor._base_domain_': [\n      {\n        srcPath: '/_api/seo-tags-suggestions-service',\n        destPath: '',\n      },\n    ],\n    'blocks._base_domain_': [\n      {\n        srcPath: '/_api/seo-tags-suggestions-service',\n        destPath: '',\n      },\n    ],\n    'create.editorx': [\n      {\n        srcPath: '/_api/seo-tags-suggestions-service',\n        destPath: '',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/seo-suggestions/v1',\n        destPath: '/v1',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_seo_page-optimization';\n\n/**\n * Starts generating optimization suggestions for a site page.\n *\n * The suggestions target the page's focus keyword, so set it first: run\n * keyword research, set the chosen keyword as the page's focus keyword,\n * then trigger. Returns a `predictionId` to poll Get Page Optimization\n * Results with.\n *\n * Triggering is idempotent per page: while a generation for the page is in\n * progress, calling again returns the same `predictionId` instead of\n * starting a new job — unless the page's focus keyword changed since the\n * job started, which returns a `SUGGESTIONS_ALREADY_IN_PROGRESS` error.\n */\nexport function triggerPageOptimization(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __triggerPageOptimization({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.seo.suggestions.v1.page_optimization',\n      method: 'POST' as any,\n      methodFqn:\n        'wix.seo.suggestions.v1.PageOptimizationService.TriggerPageOptimization',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixSeoSuggestionsV1PageOptimizationServiceUrl({\n        protoPath: '/v1/page-optimization/trigger',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __triggerPageOptimization;\n}\n\n/**\n * Starts generating optimization suggestions for the site's homepage.\n *\n * The homepage gets its own method because its suggestions are generated\n * with homepage-specific guidance — representing the whole site, not one\n * topic. Same contract as Trigger Page Optimization: the homepage's focus\n * keyword must be set first, the call returns a `predictionId` to poll,\n * and triggering is idempotent per page while a job is in progress.\n */\nexport function triggerHomePageOptimization(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __triggerHomePageOptimization({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.seo.suggestions.v1.page_optimization',\n      method: 'POST' as any,\n      methodFqn:\n        'wix.seo.suggestions.v1.PageOptimizationService.TriggerHomePageOptimization',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixSeoSuggestionsV1PageOptimizationServiceUrl({\n        protoPath: '/v1/page-optimization/trigger-home',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __triggerHomePageOptimization;\n}\n\n/**\n * Retrieves the optimization suggestions generated for a page.\n *\n * Poll this method after a trigger call. The response's `status` reports\n * where the job stands: while generation is still in progress the\n * suggestions are empty and `status` is `IN_PROGRESS`; when it completes,\n * the response carries the full suggestion set with `status` `COMPLETED`.\n * A job that failed reports `FAILED` — trigger again to retry. Suggestions\n * are stored per page — a later trigger for the same page replaces them,\n * and a replaced job's lookup reports `NOT_FOUND`.\n *\n * Look up by `predictionId` (from the trigger call), or by `pageId`.\n */\nexport function getPageOptimizationResults(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __getPageOptimizationResults({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.seo.suggestions.v1.page_optimization',\n      method: 'GET' as any,\n      methodFqn:\n        'wix.seo.suggestions.v1.PageOptimizationService.GetPageOptimizationResults',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixSeoSuggestionsV1PageOptimizationServiceUrl({\n        protoPath: '/v1/page-optimization/results',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n    };\n\n    return metadata;\n  }\n\n  return __getPageOptimizationResults;\n}\n","/**\n * A whole-page set of SEO optimization suggestions, generated for one page\n * and focus keyword.\n *\n * Each suggestion is a before/after pair: `before` is the page's current\n * text (empty when the page has none, such as a missing meta description),\n * and `after` is the suggested replacement. Locate the element to change by\n * its `before` text.\n */\nexport interface PageOptimization {\n  /**\n   * ID of this suggestion set.\n   * @format GUID\n   * @readonly\n   */\n  id?: string | null;\n  /**\n   * Suggested title tag.\n   * @readonly\n   */\n  metaTitle?: TextSuggestion;\n  /**\n   * Suggested description tag.\n   * @readonly\n   */\n  metaDescription?: TextSuggestion;\n  /**\n   * Suggested H1 heading.\n   * @readonly\n   */\n  h1?: TextSuggestion;\n  /**\n   * Suggested H2 or H3 heading.\n   * @readonly\n   */\n  h2OrH3?: TextSuggestion;\n  /**\n   * Suggested body text rewrites.\n   * @readonly\n   * @maxSize 100\n   */\n  content?: TextSuggestion[];\n}\n\n/** One suggested text change. */\nexport interface TextSuggestion {\n  /**\n   * The page's current text. Empty when the page has no text in this slot —\n   * for example, a missing meta description.\n   * @readonly\n   * @maxLength 1000\n   */\n  before?: string | null;\n  /**\n   * The suggested text.\n   * @readonly\n   * @maxLength 1000\n   */\n  after?: string;\n}\n\nexport interface TriggerPageOptimizationRequest {\n  /**\n   * ID of the site page to optimize.\n   * @maxLength 1000\n   * @minLength 1\n   */\n  pageId: string;\n  /**\n   * URL path of the page, relative to the site's domain. For example,\n   * `/about`.\n   * @maxLength 1000\n   * @minLength 1\n   */\n  pagePath: string;\n}\n\nexport interface TriggerPageOptimizationResponse {\n  /**\n   * ID of the generation job. Pass to Get Page Optimization Results.\n   * @readonly\n   * @maxLength 200\n   */\n  predictionId?: string;\n}\n\nexport interface TriggerHomePageOptimizationRequest {\n  /**\n   * ID of the site's homepage.\n   * @maxLength 1000\n   * @minLength 1\n   */\n  pageId: string;\n  /**\n   * URL path of the homepage. Usually `/`.\n   * @maxLength 1000\n   * @minLength 1\n   */\n  pagePath: string;\n}\n\nexport interface TriggerHomePageOptimizationResponse {\n  /**\n   * ID of the generation job. Pass to Get Page Optimization Results.\n   * @readonly\n   * @maxLength 200\n   */\n  predictionId?: string;\n}\n\nexport interface GetPageOptimizationResultsRequest {\n  /**\n   * ID of the generation job, from the trigger call.\n   * @maxLength 200\n   */\n  predictionId?: string | null;\n  /**\n   * ID of the page to retrieve suggestions for. An alternative to\n   * `predictionId` — returns the page's latest generation.\n   * @maxLength 1000\n   */\n  pageId?: string | null;\n}\n\nexport interface GetPageOptimizationResultsResponse {\n  /** The generated suggestions. Returned only when `status` is `COMPLETED`. */\n  pageOptimization?: PageOptimization;\n  /**\n   * Status of the generation job the lookup matched.\n   * @readonly\n   */\n  status?: OptimizationStatusWithLiterals;\n}\n\n/** Status of a page optimization generation job. */\nexport enum OptimizationStatus {\n  UNKNOWN_OPTIMIZATION_STATUS = 'UNKNOWN_OPTIMIZATION_STATUS',\n  /**\n   * No generation job matches the lookup — it never existed, or a later\n   * trigger for the same page replaced it.\n   */\n  NOT_FOUND = 'NOT_FOUND',\n  /** Generation is still running. Poll again. */\n  IN_PROGRESS = 'IN_PROGRESS',\n  /** Generation finished; the response carries the suggestions. */\n  COMPLETED = 'COMPLETED',\n  /** Generation failed. Trigger again to retry. */\n  FAILED = 'FAILED',\n}\n\n/** @enumType */\nexport type OptimizationStatusWithLiterals =\n  | OptimizationStatus\n  | 'UNKNOWN_OPTIMIZATION_STATUS'\n  | 'NOT_FOUND'\n  | 'IN_PROGRESS'\n  | 'COMPLETED'\n  | 'FAILED';\n/** @docsIgnore */\nexport type TriggerPageOptimizationApplicationErrors =\n  | {\n      code?: 'SITE_NOT_SUPPORTED';\n      description?: string;\n      data?: Record<string, any>;\n    }\n  | {\n      code?: 'FOCUS_KEYWORD_NOT_SET';\n      description?: string;\n      data?: Record<string, any>;\n    }\n  | {\n      code?: 'CONTENT_TOO_SHORT';\n      description?: string;\n      data?: Record<string, any>;\n    }\n  | {\n      code?: 'SUGGESTIONS_ALREADY_IN_PROGRESS';\n      description?: string;\n      data?: Record<string, any>;\n    }\n  | {\n      code?: 'GENERATION_FAILED';\n      description?: string;\n      data?: Record<string, any>;\n    }\n  | {\n      code?: 'QUOTA_LIMIT_REACHED';\n      description?: string;\n      data?: Record<string, any>;\n    };\n/** @docsIgnore */\nexport type TriggerHomePageOptimizationApplicationErrors =\n  | {\n      code?: 'SITE_NOT_SUPPORTED';\n      description?: string;\n      data?: Record<string, any>;\n    }\n  | {\n      code?: 'FOCUS_KEYWORD_NOT_SET';\n      description?: string;\n      data?: Record<string, any>;\n    }\n  | {\n      code?: 'CONTENT_TOO_SHORT';\n      description?: string;\n      data?: Record<string, any>;\n    }\n  | {\n      code?: 'SUGGESTIONS_ALREADY_IN_PROGRESS';\n      description?: string;\n      data?: Record<string, any>;\n    }\n  | {\n      code?: 'GENERATION_FAILED';\n      description?: string;\n      data?: Record<string, any>;\n    }\n  | {\n      code?: 'QUOTA_LIMIT_REACHED';\n      description?: string;\n      data?: Record<string, any>;\n    };\n/** @docsIgnore */\nexport type GetPageOptimizationResultsApplicationErrors =\n  | {\n      code?: 'GENERATION_FAILED';\n      description?: string;\n      data?: Record<string, any>;\n    }\n  | {\n      code?: 'QUOTA_LIMIT_REACHED';\n      description?: string;\n      data?: Record<string, any>;\n    };\n","import * as ambassadorWixSeoSuggestionsV1PageOptimization from './seo-suggestions-v1-page-optimization-page-optimization.http.js';\nimport * as ambassadorWixSeoSuggestionsV1PageOptimizationTypes from './seo-suggestions-v1-page-optimization-page-optimization.types.js';\nimport * as ambassadorWixSeoSuggestionsV1PageOptimizationUniversalTypes from './seo-suggestions-v1-page-optimization-page-optimization.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 triggerPageOptimization(): __PublicMethodMetaInfo<\n  'POST',\n  {},\n  ambassadorWixSeoSuggestionsV1PageOptimizationUniversalTypes.TriggerPageOptimizationRequest,\n  ambassadorWixSeoSuggestionsV1PageOptimizationTypes.TriggerPageOptimizationRequest,\n  ambassadorWixSeoSuggestionsV1PageOptimizationUniversalTypes.TriggerPageOptimizationResponse,\n  ambassadorWixSeoSuggestionsV1PageOptimizationTypes.TriggerPageOptimizationResponse\n> {\n  const payload = {} as any;\n\n  const getRequestOptions =\n    ambassadorWixSeoSuggestionsV1PageOptimization.triggerPageOptimization(\n      payload\n    );\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/page-optimization/trigger',\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 triggerHomePageOptimization(): __PublicMethodMetaInfo<\n  'POST',\n  {},\n  ambassadorWixSeoSuggestionsV1PageOptimizationUniversalTypes.TriggerHomePageOptimizationRequest,\n  ambassadorWixSeoSuggestionsV1PageOptimizationTypes.TriggerHomePageOptimizationRequest,\n  ambassadorWixSeoSuggestionsV1PageOptimizationUniversalTypes.TriggerHomePageOptimizationResponse,\n  ambassadorWixSeoSuggestionsV1PageOptimizationTypes.TriggerHomePageOptimizationResponse\n> {\n  const payload = {} as any;\n\n  const getRequestOptions =\n    ambassadorWixSeoSuggestionsV1PageOptimization.triggerHomePageOptimization(\n      payload\n    );\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/page-optimization/trigger-home',\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 getPageOptimizationResults(): __PublicMethodMetaInfo<\n  'GET',\n  {},\n  ambassadorWixSeoSuggestionsV1PageOptimizationUniversalTypes.GetPageOptimizationResultsRequest,\n  ambassadorWixSeoSuggestionsV1PageOptimizationTypes.GetPageOptimizationResultsRequest,\n  ambassadorWixSeoSuggestionsV1PageOptimizationUniversalTypes.GetPageOptimizationResultsResponse,\n  ambassadorWixSeoSuggestionsV1PageOptimizationTypes.GetPageOptimizationResultsResponse\n> {\n  const payload = {} as any;\n\n  const getRequestOptions =\n    ambassadorWixSeoSuggestionsV1PageOptimization.getPageOptimizationResults(\n      payload\n    );\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'GET',\n    path: '/v1/page-optimization/results',\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  PageOptimization as PageOptimizationOriginal,\n  TextSuggestion as TextSuggestionOriginal,\n  TriggerPageOptimizationRequest as TriggerPageOptimizationRequestOriginal,\n  TriggerPageOptimizationResponse as TriggerPageOptimizationResponseOriginal,\n  TriggerHomePageOptimizationRequest as TriggerHomePageOptimizationRequestOriginal,\n  TriggerHomePageOptimizationResponse as TriggerHomePageOptimizationResponseOriginal,\n  GetPageOptimizationResultsRequest as GetPageOptimizationResultsRequestOriginal,\n  GetPageOptimizationResultsResponse as GetPageOptimizationResultsResponseOriginal,\n  OptimizationStatus as OptimizationStatusOriginal,\n  OptimizationStatusWithLiterals as OptimizationStatusWithLiteralsOriginal,\n  TriggerPageOptimizationApplicationErrors as TriggerPageOptimizationApplicationErrorsOriginal,\n  TriggerHomePageOptimizationApplicationErrors as TriggerHomePageOptimizationApplicationErrorsOriginal,\n  GetPageOptimizationResultsApplicationErrors as GetPageOptimizationResultsApplicationErrorsOriginal,\n} from './seo-suggestions-v1-page-optimization-page-optimization.types.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA,oCAAAA;AAAA,EAAA,mCAAAC;AAAA,EAAA,+BAAAC;AAAA;AAAA;;;ACAA,0BAAkC;AAClC,IAAAC,uBAA2B;AAI3B,SAAS,qDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,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,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,kBAAkB;AAAA,MAChB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAed,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,qDAAqD;AAAA,QACxD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAWO,SAAS,4BACd,SAC4B;AAC5B,WAAS,8BAA8B,EAAE,KAAK,GAAQ;AACpD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,qDAAqD;AAAA,QACxD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAeO,SAAS,2BACd,SAC4B;AAC5B,WAAS,6BAA6B,EAAE,KAAK,GAAQ;AACnD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,qDAAqD;AAAA,QACxD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,IACnC;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;AC3CO,IAAK,qBAAL,kBAAKC,wBAAL;AACL,EAAAA,oBAAA,iCAA8B;AAK9B,EAAAA,oBAAA,eAAY;AAEZ,EAAAA,oBAAA,iBAAc;AAEd,EAAAA,oBAAA,eAAY;AAEZ,EAAAA,oBAAA,YAAS;AAZC,SAAAA;AAAA,GAAA;;;ACjHL,SAASC,2BAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBAC0C;AAAA,IAC5C;AAAA,EACF;AAEF,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,+BAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBAC0C;AAAA,IAC5C;AAAA,EACF;AAEF,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,8BAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBAC0C;AAAA,IAC5C;AAAA,EACF;AAEF,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":["getPageOptimizationResults","triggerHomePageOptimization","triggerPageOptimization","import_rest_modules","OptimizationStatus","triggerPageOptimization","triggerHomePageOptimization","getPageOptimizationResults"]}

package/build/es/index.d.mts

@@ -0,0 +1,65 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { TriggerPageOptimizationOptions, TriggerPageOptimizationResponse, TriggerPageOptimizationApplicationErrors, TriggerHomePageOptimizationOptions, TriggerHomePageOptimizationResponse, TriggerHomePageOptimizationApplicationErrors, GetPageOptimizationResultsOptions, GetPageOptimizationResultsResponse, GetPageOptimizationResultsApplicationErrors } from './index.typings.mjs';
+export { GetPageOptimizationResultsRequest, OptimizationStatus, OptimizationStatusWithLiterals, PageOptimization, TextSuggestion, TriggerHomePageOptimizationRequest, TriggerPageOptimizationRequest } from './index.typings.mjs';
+
+declare function triggerPageOptimization$1(httpClient: HttpClient): TriggerPageOptimizationSignature;
+interface TriggerPageOptimizationSignature {
+    /**
+     * Starts generating optimization suggestions for a site page.
+     *
+     * The suggestions target the page's focus keyword, so set it first: run
+     * keyword research, set the chosen keyword as the page's focus keyword,
+     * then trigger. Returns a `predictionId` to poll Get Page Optimization
+     * Results with.
+     *
+     * Triggering is idempotent per page: while a generation for the page is in
+     * progress, calling again returns the same `predictionId` instead of
+     * starting a new job — unless the page's focus keyword changed since the
+     * job started, which returns a `SUGGESTIONS_ALREADY_IN_PROGRESS` error.
+     * @param - ID of the site page to optimize.
+     */
+    (pageId: string, options: NonNullablePaths<TriggerPageOptimizationOptions, `pagePath`, 2>): Promise<NonNullablePaths<TriggerPageOptimizationResponse, `predictionId`, 2> & {
+        __applicationErrorsType?: TriggerPageOptimizationApplicationErrors;
+    }>;
+}
+declare function triggerHomePageOptimization$1(httpClient: HttpClient): TriggerHomePageOptimizationSignature;
+interface TriggerHomePageOptimizationSignature {
+    /**
+     * Starts generating optimization suggestions for the site's homepage.
+     *
+     * The homepage gets its own method because its suggestions are generated
+     * with homepage-specific guidance — representing the whole site, not one
+     * topic. Same contract as Trigger Page Optimization: the homepage's focus
+     * keyword must be set first, the call returns a `predictionId` to poll,
+     * and triggering is idempotent per page while a job is in progress.
+     * @param - ID of the site's homepage.
+     */
+    (pageId: string, options: NonNullablePaths<TriggerHomePageOptimizationOptions, `pagePath`, 2>): Promise<NonNullablePaths<TriggerHomePageOptimizationResponse, `predictionId`, 2> & {
+        __applicationErrorsType?: TriggerHomePageOptimizationApplicationErrors;
+    }>;
+}
+declare function getPageOptimizationResults$1(httpClient: HttpClient): GetPageOptimizationResultsSignature;
+interface GetPageOptimizationResultsSignature {
+    /**
+     * Retrieves the optimization suggestions generated for a page.
+     *
+     * Poll this method after a trigger call. The response's `status` reports
+     * where the job stands: while generation is still in progress the
+     * suggestions are empty and `status` is `IN_PROGRESS`; when it completes,
+     * the response carries the full suggestion set with `status` `COMPLETED`.
+     * A job that failed reports `FAILED` — trigger again to retry. Suggestions
+     * are stored per page — a later trigger for the same page replaces them,
+     * and a replaced job's lookup reports `NOT_FOUND`.
+     *
+     * Look up by `predictionId` (from the trigger call), or by `pageId`.
+     */
+    (options?: GetPageOptimizationResultsOptions): Promise<NonNullablePaths<GetPageOptimizationResultsResponse, `pageOptimization.metaTitle.after` | `pageOptimization.content` | `status`, 4> & {
+        __applicationErrorsType?: GetPageOptimizationResultsApplicationErrors;
+    }>;
+}
+
+declare const triggerPageOptimization: MaybeContext<BuildRESTFunction<typeof triggerPageOptimization$1> & typeof triggerPageOptimization$1>;
+declare const triggerHomePageOptimization: MaybeContext<BuildRESTFunction<typeof triggerHomePageOptimization$1> & typeof triggerHomePageOptimization$1>;
+declare const getPageOptimizationResults: MaybeContext<BuildRESTFunction<typeof getPageOptimizationResults$1> & typeof getPageOptimizationResults$1>;
+
+export { GetPageOptimizationResultsApplicationErrors, GetPageOptimizationResultsOptions, GetPageOptimizationResultsResponse, TriggerHomePageOptimizationApplicationErrors, TriggerHomePageOptimizationOptions, TriggerHomePageOptimizationResponse, TriggerPageOptimizationApplicationErrors, TriggerPageOptimizationOptions, TriggerPageOptimizationResponse, getPageOptimizationResults, triggerHomePageOptimization, triggerPageOptimization };