@wix/auto_sdk_seo_page-optimization 1.0.5 → 1.0.7

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

@@ -1,5 +1,5 @@
 import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { TriggerPageOptimizationOptions, TriggerPageOptimizationResponse, TriggerPageOptimizationApplicationErrors, TriggerHomePageOptimizationOptions, TriggerHomePageOptimizationResponse, TriggerHomePageOptimizationApplicationErrors, GetPageOptimizationResultsOptions, GetPageOptimizationResultsResponse, GetPageOptimizationResultsApplicationErrors } from './index.typings.js';
+import { TriggerPageOptimizationOptions, TriggerPageOptimizationResponse, TriggerPageOptimizationApplicationErrors, TriggerHomePageOptimizationResponse, TriggerHomePageOptimizationApplicationErrors, GetPageOptimizationResultsOptions, GetPageOptimizationResultsResponse, GetPageOptimizationResultsApplicationErrors } from './index.typings.js';
 export { GetPageOptimizationResultsRequest, OptimizationStatus, OptimizationStatusWithLiterals, PageOptimization, TextSuggestion, TriggerHomePageOptimizationRequest, TriggerPageOptimizationRequest } from './index.typings.js';
 
 declare function triggerPageOptimization$1(httpClient: HttpClient): TriggerPageOptimizationSignature;
@@ -32,9 +32,12 @@ 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.
-     * @param - ID of the site's homepage.
+     *
+     * The method takes no parameters. Wix resolves which page is the site's
+     * homepage, so callers don't have to identify it. The response returns the
+     * resolved `pageId`, for later lookups with Get Page Optimization Results.
      */
-    (pageId: string, options: NonNullablePaths<TriggerHomePageOptimizationOptions, `pagePath`, 0>): Promise<NonNullablePaths<TriggerHomePageOptimizationResponse, `predictionId`, 0> & {
+    (): Promise<NonNullablePaths<TriggerHomePageOptimizationResponse, `predictionId` | `pageId`, 0> & {
         __applicationErrorsType?: TriggerHomePageOptimizationApplicationErrors;
     }>;
 }
@@ -64,4 +67,4 @@ declare const triggerPageOptimization: MaybeContext<BuildRESTFunction<typeof tri
 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 };
+export { GetPageOptimizationResultsApplicationErrors, GetPageOptimizationResultsOptions, GetPageOptimizationResultsResponse, TriggerHomePageOptimizationApplicationErrors, TriggerHomePageOptimizationResponse, TriggerPageOptimizationApplicationErrors, TriggerPageOptimizationOptions, TriggerPageOptimizationResponse, getPageOptimizationResults, triggerHomePageOptimization, triggerPageOptimization };

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

@@ -84,18 +84,6 @@ interface TriggerPageOptimizationResponse {
     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 {
     /**
@@ -104,6 +92,14 @@ interface TriggerHomePageOptimizationResponse {
      * @maxLength 200
      */
     predictionId?: string;
+    /**
+     * ID of the page the service resolved as the site's homepage. Pass to Get
+     * Page Optimization Results to retrieve the homepage's latest generation
+     * after the `predictionId` expires.
+     * @readonly
+     * @maxLength 1000
+     */
+    pageId?: string;
 }
 interface GetPageOptimizationResultsRequest {
     /**
@@ -250,27 +246,19 @@ 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.
- * @param pageId - ID of the site's homepage.
+ *
+ * The method takes no parameters. Wix resolves which page is the site's
+ * homepage, so callers don't have to identify it. The response returns the
+ * resolved `pageId`, for later lookups with Get Page Optimization Results.
  * @public
  * @documentationMaturity preview
- * @requiredField options
- * @requiredField options.pagePath
- * @requiredField pageId
  * @permissionId seo:suggestions:v1:page_optimization:trigger_home_page_optimization
  * @applicableIdentity APP
  * @fqn wix.seo.suggestions.v1.PageOptimizationService.TriggerHomePageOptimization
  */
-declare function triggerHomePageOptimization(pageId: string, options: NonNullablePaths<TriggerHomePageOptimizationOptions, `pagePath`, 0>): Promise<NonNullablePaths<TriggerHomePageOptimizationResponse, `predictionId`, 0> & {
+declare function triggerHomePageOptimization(): Promise<NonNullablePaths<TriggerHomePageOptimizationResponse, `predictionId` | `pageId`, 0> & {
     __applicationErrorsType?: TriggerHomePageOptimizationApplicationErrors;
 }>;
-interface TriggerHomePageOptimizationOptions {
-    /**
-     * URL path of the homepage. Usually `/`.
-     * @maxLength 1000
-     * @minLength 1
-     */
-    pagePath: string;
-}
 /**
  * Retrieves the optimization suggestions generated for a page.
  *
@@ -309,4 +297,4 @@ interface GetPageOptimizationResultsOptions {
     pageId?: string | null;
 }
 
-export { type GetPageOptimizationResultsApplicationErrors, type GetPageOptimizationResultsOptions, type GetPageOptimizationResultsRequest, type GetPageOptimizationResultsResponse, OptimizationStatus, type OptimizationStatusWithLiterals, type PageOptimization, type TextSuggestion, type TriggerHomePageOptimizationApplicationErrors, type TriggerHomePageOptimizationOptions, type TriggerHomePageOptimizationRequest, type TriggerHomePageOptimizationResponse, type TriggerPageOptimizationApplicationErrors, type TriggerPageOptimizationOptions, type TriggerPageOptimizationRequest, type TriggerPageOptimizationResponse, getPageOptimizationResults, triggerHomePageOptimization, triggerPageOptimization };
+export { type GetPageOptimizationResultsApplicationErrors, type GetPageOptimizationResultsOptions, type GetPageOptimizationResultsRequest, type GetPageOptimizationResultsResponse, OptimizationStatus, type OptimizationStatusWithLiterals, type PageOptimization, type TextSuggestion, type TriggerHomePageOptimizationApplicationErrors, type TriggerHomePageOptimizationRequest, type TriggerHomePageOptimizationResponse, type TriggerPageOptimizationApplicationErrors, type TriggerPageOptimizationOptions, type TriggerPageOptimizationRequest, type TriggerPageOptimizationResponse, getPageOptimizationResults, triggerHomePageOptimization, triggerPageOptimization };

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

@@ -85,18 +85,6 @@ interface TriggerPageOptimizationResponse {
     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 {
     /**
@@ -105,6 +93,14 @@ interface TriggerHomePageOptimizationResponse {
      * @maxLength 200
      */
     predictionId?: string;
+    /**
+     * ID of the page the service resolved as the site's homepage. Pass to Get
+     * Page Optimization Results to retrieve the homepage's latest generation
+     * after the `predictionId` expires.
+     * @readonly
+     * @maxLength 1000
+     */
+    pageId?: string;
 }
 interface GetPageOptimizationResultsRequest {
     /**

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

@@ -1,5 +1,5 @@
 import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { TriggerPageOptimizationOptions, TriggerPageOptimizationResponse, TriggerPageOptimizationApplicationErrors, TriggerHomePageOptimizationOptions, TriggerHomePageOptimizationResponse, TriggerHomePageOptimizationApplicationErrors, GetPageOptimizationResultsOptions, GetPageOptimizationResultsResponse, GetPageOptimizationResultsApplicationErrors } from './index.typings.mjs';
+import { TriggerPageOptimizationOptions, TriggerPageOptimizationResponse, TriggerPageOptimizationApplicationErrors, 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;
@@ -32,9 +32,12 @@ 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.
-     * @param - ID of the site's homepage.
+     *
+     * The method takes no parameters. Wix resolves which page is the site's
+     * homepage, so callers don't have to identify it. The response returns the
+     * resolved `pageId`, for later lookups with Get Page Optimization Results.
      */
-    (pageId: string, options: NonNullablePaths<TriggerHomePageOptimizationOptions, `pagePath`, 0>): Promise<NonNullablePaths<TriggerHomePageOptimizationResponse, `predictionId`, 0> & {
+    (): Promise<NonNullablePaths<TriggerHomePageOptimizationResponse, `predictionId` | `pageId`, 0> & {
         __applicationErrorsType?: TriggerHomePageOptimizationApplicationErrors;
     }>;
 }
@@ -64,4 +67,4 @@ declare const triggerPageOptimization: MaybeContext<BuildRESTFunction<typeof tri
 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 };
+export { GetPageOptimizationResultsApplicationErrors, GetPageOptimizationResultsOptions, GetPageOptimizationResultsResponse, TriggerHomePageOptimizationApplicationErrors, TriggerHomePageOptimizationResponse, TriggerPageOptimizationApplicationErrors, TriggerPageOptimizationOptions, TriggerPageOptimizationResponse, getPageOptimizationResults, triggerHomePageOptimization, triggerPageOptimization };

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

@@ -84,18 +84,6 @@ interface TriggerPageOptimizationResponse {
     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 {
     /**
@@ -104,6 +92,14 @@ interface TriggerHomePageOptimizationResponse {
      * @maxLength 200
      */
     predictionId?: string;
+    /**
+     * ID of the page the service resolved as the site's homepage. Pass to Get
+     * Page Optimization Results to retrieve the homepage's latest generation
+     * after the `predictionId` expires.
+     * @readonly
+     * @maxLength 1000
+     */
+    pageId?: string;
 }
 interface GetPageOptimizationResultsRequest {
     /**
@@ -250,27 +246,19 @@ 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.
- * @param pageId - ID of the site's homepage.
+ *
+ * The method takes no parameters. Wix resolves which page is the site's
+ * homepage, so callers don't have to identify it. The response returns the
+ * resolved `pageId`, for later lookups with Get Page Optimization Results.
  * @public
  * @documentationMaturity preview
- * @requiredField options
- * @requiredField options.pagePath
- * @requiredField pageId
  * @permissionId seo:suggestions:v1:page_optimization:trigger_home_page_optimization
  * @applicableIdentity APP
  * @fqn wix.seo.suggestions.v1.PageOptimizationService.TriggerHomePageOptimization
  */
-declare function triggerHomePageOptimization(pageId: string, options: NonNullablePaths<TriggerHomePageOptimizationOptions, `pagePath`, 0>): Promise<NonNullablePaths<TriggerHomePageOptimizationResponse, `predictionId`, 0> & {
+declare function triggerHomePageOptimization(): Promise<NonNullablePaths<TriggerHomePageOptimizationResponse, `predictionId` | `pageId`, 0> & {
     __applicationErrorsType?: TriggerHomePageOptimizationApplicationErrors;
 }>;
-interface TriggerHomePageOptimizationOptions {
-    /**
-     * URL path of the homepage. Usually `/`.
-     * @maxLength 1000
-     * @minLength 1
-     */
-    pagePath: string;
-}
 /**
  * Retrieves the optimization suggestions generated for a page.
  *
@@ -309,4 +297,4 @@ interface GetPageOptimizationResultsOptions {
     pageId?: string | null;
 }
 
-export { type GetPageOptimizationResultsApplicationErrors, type GetPageOptimizationResultsOptions, type GetPageOptimizationResultsRequest, type GetPageOptimizationResultsResponse, OptimizationStatus, type OptimizationStatusWithLiterals, type PageOptimization, type TextSuggestion, type TriggerHomePageOptimizationApplicationErrors, type TriggerHomePageOptimizationOptions, type TriggerHomePageOptimizationRequest, type TriggerHomePageOptimizationResponse, type TriggerPageOptimizationApplicationErrors, type TriggerPageOptimizationOptions, type TriggerPageOptimizationRequest, type TriggerPageOptimizationResponse, getPageOptimizationResults, triggerHomePageOptimization, triggerPageOptimization };
+export { type GetPageOptimizationResultsApplicationErrors, type GetPageOptimizationResultsOptions, type GetPageOptimizationResultsRequest, type GetPageOptimizationResultsResponse, OptimizationStatus, type OptimizationStatusWithLiterals, type PageOptimization, type TextSuggestion, type TriggerHomePageOptimizationApplicationErrors, type TriggerHomePageOptimizationRequest, type TriggerHomePageOptimizationResponse, type TriggerPageOptimizationApplicationErrors, type TriggerPageOptimizationOptions, type TriggerPageOptimizationRequest, type TriggerPageOptimizationResponse, getPageOptimizationResults, triggerHomePageOptimization, triggerPageOptimization };

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

@@ -85,18 +85,6 @@ interface TriggerPageOptimizationResponse {
     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 {
     /**
@@ -105,6 +93,14 @@ interface TriggerHomePageOptimizationResponse {
      * @maxLength 200
      */
     predictionId?: string;
+    /**
+     * ID of the page the service resolved as the site's homepage. Pass to Get
+     * Page Optimization Results to retrieve the homepage's latest generation
+     * after the `predictionId` expires.
+     * @readonly
+     * @maxLength 1000
+     */
+    pageId?: string;
 }
 interface GetPageOptimizationResultsRequest {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_seo_page-optimization",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -29,7 +29,7 @@
     "service-plugins"
   ],
   "dependencies": {
-    "@wix/sdk-runtime": "^1.0.24",
+    "@wix/sdk-runtime": "^1.0.28",
     "@wix/sdk-types": "^1.17.11"
   },
   "devDependencies": {
@@ -50,5 +50,5 @@
       "fqdn": "wix.seo.suggestions.v1.page_optimization"
     }
   },
-  "falconPackageHash": "0413a5094b1c80cd227354c4736ebb2981d8fd867782d969f95878c7"
+  "falconPackageHash": "3144ec51e9a9eaacd8a3149b3226f692784704781a09e172710b0896"
 }