@wix/auto_sdk_seo_page-optimization 1.0.3 → 1.0.4

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

@@ -7,7 +7,8 @@ import { NonNullablePaths } from '@wix/sdk-types';
  * 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.
+ * its `before` text. Suggestions are stored per page, so a later generation
+ * for the same page replaces this set.
  */
 interface PageOptimization {
     /**
@@ -32,12 +33,12 @@ interface PageOptimization {
      */
     h1?: TextSuggestion;
     /**
-     * Suggested H2 or H3 heading.
+     * Suggested subheading, for an H2 or H3 element of the page.
      * @readonly
      */
     h2OrH3?: TextSuggestion;
     /**
-     * Suggested body text rewrites.
+     * Suggested rewrites of the page's body text, one per text element.
      * @readonly
      * @maxSize 100
      */
@@ -61,7 +62,7 @@ interface TextSuggestion {
 }
 interface TriggerPageOptimizationRequest {
     /**
-     * ID of the site page to optimize.
+     * ID of the site page to optimize. The page's focus keyword must be set.
      * @maxLength 1000
      * @minLength 1
      */
@@ -106,7 +107,8 @@ interface TriggerHomePageOptimizationResponse {
 }
 interface GetPageOptimizationResultsRequest {
     /**
-     * ID of the generation job, from the trigger call.
+     * ID of the generation job, from the trigger call. Can be looked up for 2
+     * hours after the trigger call.
      * @maxLength 200
      */
     predictionId?: string | null;
@@ -128,6 +130,7 @@ interface GetPageOptimizationResultsResponse {
 }
 /** Status of a page optimization generation job. */
 declare enum OptimizationStatus {
+    /** Unknown status. */
     UNKNOWN_OPTIMIZATION_STATUS = "UNKNOWN_OPTIMIZATION_STATUS",
     /**
      * No generation job matches the lookup. It never existed, or a later
@@ -217,7 +220,9 @@ type GetPageOptimizationResultsApplicationErrors = {
  * 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 pageId - ID of the site page to optimize.
+ *
+ * Must be called with a [Wix user identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities). Calls made with an API key fail.
+ * @param pageId - ID of the site page to optimize. The page's focus keyword must be set.
  * @public
  * @documentationMaturity preview
  * @requiredField options
@@ -247,6 +252,8 @@ interface TriggerPageOptimizationOptions {
  * 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.
+ *
+ * Must be called with a [Wix user identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities). Calls made with an API key fail.
  * @param pageId - ID of the site's homepage.
  * @public
  * @documentationMaturity preview
@@ -279,7 +286,9 @@ interface TriggerHomePageOptimizationOptions {
  * are stored per page, so 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`.
+ * Look up by `predictionId` (from the trigger call), or by `pageId`. A
+ * `predictionId` can be looked up for 2 hours after the trigger call; after
+ * that, look up by `pageId`, which returns the page's latest generation.
  * @public
  * @documentationMaturity preview
  * @permissionId seo:suggestions:v1:page_optimization:get_page_optimization_results
@@ -291,7 +300,8 @@ declare function getPageOptimizationResults(options?: GetPageOptimizationResults
 }>;
 interface GetPageOptimizationResultsOptions {
     /**
-     * ID of the generation job, from the trigger call.
+     * ID of the generation job, from the trigger call. Can be looked up for 2
+     * hours after the trigger call.
      * @maxLength 200
      */
     predictionId?: string | null;

package/build/internal/cjs/meta.d.ts

@@ -8,7 +8,8 @@ import '@wix/sdk-types';
  * 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.
+ * its `before` text. Suggestions are stored per page, so a later generation
+ * for the same page replaces this set.
  */
 interface PageOptimization {
     /**
@@ -33,12 +34,12 @@ interface PageOptimization {
      */
     h1?: TextSuggestion;
     /**
-     * Suggested H2 or H3 heading.
+     * Suggested subheading, for an H2 or H3 element of the page.
      * @readonly
      */
     h2OrH3?: TextSuggestion;
     /**
-     * Suggested body text rewrites.
+     * Suggested rewrites of the page's body text, one per text element.
      * @readonly
      * @maxSize 100
      */
@@ -62,7 +63,7 @@ interface TextSuggestion {
 }
 interface TriggerPageOptimizationRequest {
     /**
-     * ID of the site page to optimize.
+     * ID of the site page to optimize. The page's focus keyword must be set.
      * @maxLength 1000
      * @minLength 1
      */
@@ -107,7 +108,8 @@ interface TriggerHomePageOptimizationResponse {
 }
 interface GetPageOptimizationResultsRequest {
     /**
-     * ID of the generation job, from the trigger call.
+     * ID of the generation job, from the trigger call. Can be looked up for 2
+     * hours after the trigger call.
      * @maxLength 200
      */
     predictionId?: string | null;
@@ -129,6 +131,7 @@ interface GetPageOptimizationResultsResponse {
 }
 /** Status of a page optimization generation job. */
 declare enum OptimizationStatus {
+    /** Unknown status. */
     UNKNOWN_OPTIMIZATION_STATUS = "UNKNOWN_OPTIMIZATION_STATUS",
     /**
      * No generation job matches the lookup. It never existed, or a later

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

@@ -16,7 +16,9 @@ interface TriggerPageOptimizationSignature {
      * 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.
+     *
+     * Must be called with a [Wix user identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities). Calls made with an API key fail.
+     * @param - ID of the site page to optimize. The page's focus keyword must be set.
      */
     (pageId: string, options: NonNullablePaths<TriggerPageOptimizationOptions, `pagePath`, 2>): Promise<NonNullablePaths<TriggerPageOptimizationResponse, `predictionId`, 2> & {
         __applicationErrorsType?: TriggerPageOptimizationApplicationErrors;
@@ -32,6 +34,8 @@ interface TriggerHomePageOptimizationSignature {
      * 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.
+     *
+     * Must be called with a [Wix user identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities). Calls made with an API key fail.
      * @param - ID of the site's homepage.
      */
     (pageId: string, options: NonNullablePaths<TriggerHomePageOptimizationOptions, `pagePath`, 2>): Promise<NonNullablePaths<TriggerHomePageOptimizationResponse, `predictionId`, 2> & {
@@ -51,7 +55,9 @@ interface GetPageOptimizationResultsSignature {
      * are stored per page, so 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`.
+     * Look up by `predictionId` (from the trigger call), or by `pageId`. A
+     * `predictionId` can be looked up for 2 hours after the trigger call; after
+     * that, look up by `pageId`, which returns the page's latest generation.
      */
     (options?: GetPageOptimizationResultsOptions): Promise<NonNullablePaths<GetPageOptimizationResultsResponse, `pageOptimization.metaTitle.after` | `pageOptimization.content` | `status`, 4> & {
         __applicationErrorsType?: GetPageOptimizationResultsApplicationErrors;

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

@@ -7,7 +7,8 @@ import { NonNullablePaths } from '@wix/sdk-types';
  * 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.
+ * its `before` text. Suggestions are stored per page, so a later generation
+ * for the same page replaces this set.
  */
 interface PageOptimization {
     /**
@@ -32,12 +33,12 @@ interface PageOptimization {
      */
     h1?: TextSuggestion;
     /**
-     * Suggested H2 or H3 heading.
+     * Suggested subheading, for an H2 or H3 element of the page.
      * @readonly
      */
     h2OrH3?: TextSuggestion;
     /**
-     * Suggested body text rewrites.
+     * Suggested rewrites of the page's body text, one per text element.
      * @readonly
      * @maxSize 100
      */
@@ -61,7 +62,7 @@ interface TextSuggestion {
 }
 interface TriggerPageOptimizationRequest {
     /**
-     * ID of the site page to optimize.
+     * ID of the site page to optimize. The page's focus keyword must be set.
      * @maxLength 1000
      * @minLength 1
      */
@@ -106,7 +107,8 @@ interface TriggerHomePageOptimizationResponse {
 }
 interface GetPageOptimizationResultsRequest {
     /**
-     * ID of the generation job, from the trigger call.
+     * ID of the generation job, from the trigger call. Can be looked up for 2
+     * hours after the trigger call.
      * @maxLength 200
      */
     predictionId?: string | null;
@@ -128,6 +130,7 @@ interface GetPageOptimizationResultsResponse {
 }
 /** Status of a page optimization generation job. */
 declare enum OptimizationStatus {
+    /** Unknown status. */
     UNKNOWN_OPTIMIZATION_STATUS = "UNKNOWN_OPTIMIZATION_STATUS",
     /**
      * No generation job matches the lookup. It never existed, or a later
@@ -217,7 +220,9 @@ type GetPageOptimizationResultsApplicationErrors = {
  * 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 pageId - ID of the site page to optimize.
+ *
+ * Must be called with a [Wix user identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities). Calls made with an API key fail.
+ * @param pageId - ID of the site page to optimize. The page's focus keyword must be set.
  * @public
  * @documentationMaturity preview
  * @requiredField options
@@ -247,6 +252,8 @@ interface TriggerPageOptimizationOptions {
  * 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.
+ *
+ * Must be called with a [Wix user identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities). Calls made with an API key fail.
  * @param pageId - ID of the site's homepage.
  * @public
  * @documentationMaturity preview
@@ -279,7 +286,9 @@ interface TriggerHomePageOptimizationOptions {
  * are stored per page, so 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`.
+ * Look up by `predictionId` (from the trigger call), or by `pageId`. A
+ * `predictionId` can be looked up for 2 hours after the trigger call; after
+ * that, look up by `pageId`, which returns the page's latest generation.
  * @public
  * @documentationMaturity preview
  * @permissionId seo:suggestions:v1:page_optimization:get_page_optimization_results
@@ -291,7 +300,8 @@ declare function getPageOptimizationResults(options?: GetPageOptimizationResults
 }>;
 interface GetPageOptimizationResultsOptions {
     /**
-     * ID of the generation job, from the trigger call.
+     * ID of the generation job, from the trigger call. Can be looked up for 2
+     * hours after the trigger call.
      * @maxLength 200
      */
     predictionId?: string | null;

package/build/internal/es/meta.d.mts

@@ -8,7 +8,8 @@ import '@wix/sdk-types';
  * 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.
+ * its `before` text. Suggestions are stored per page, so a later generation
+ * for the same page replaces this set.
  */
 interface PageOptimization {
     /**
@@ -33,12 +34,12 @@ interface PageOptimization {
      */
     h1?: TextSuggestion;
     /**
-     * Suggested H2 or H3 heading.
+     * Suggested subheading, for an H2 or H3 element of the page.
      * @readonly
      */
     h2OrH3?: TextSuggestion;
     /**
-     * Suggested body text rewrites.
+     * Suggested rewrites of the page's body text, one per text element.
      * @readonly
      * @maxSize 100
      */
@@ -62,7 +63,7 @@ interface TextSuggestion {
 }
 interface TriggerPageOptimizationRequest {
     /**
-     * ID of the site page to optimize.
+     * ID of the site page to optimize. The page's focus keyword must be set.
      * @maxLength 1000
      * @minLength 1
      */
@@ -107,7 +108,8 @@ interface TriggerHomePageOptimizationResponse {
 }
 interface GetPageOptimizationResultsRequest {
     /**
-     * ID of the generation job, from the trigger call.
+     * ID of the generation job, from the trigger call. Can be looked up for 2
+     * hours after the trigger call.
      * @maxLength 200
      */
     predictionId?: string | null;
@@ -129,6 +131,7 @@ interface GetPageOptimizationResultsResponse {
 }
 /** Status of a page optimization generation job. */
 declare enum OptimizationStatus {
+    /** Unknown status. */
     UNKNOWN_OPTIMIZATION_STATUS = "UNKNOWN_OPTIMIZATION_STATUS",
     /**
      * No generation job matches the lookup. It never existed, or a later

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_seo_page-optimization",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
       "fqdn": "wix.seo.suggestions.v1.page_optimization"
     }
   },
-  "falconPackageHash": "e4c887bdd8286555d510f6f1f09abe13e26e50969ff133de91a6cf6c"
+  "falconPackageHash": "77368f80a624ff04509ce5ff9f80ec4e013ee158bcb3b07bf616dd7e"
 }