@wix/auto_sdk_seo_page-optimization 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -14,7 +14,7 @@ interface TriggerPageOptimizationSignature {
14
14
  *
15
15
  * Triggering is idempotent per page: while a generation for the page is in
16
16
  * progress, calling again returns the same `predictionId` instead of
17
- * starting a new job unless the page's focus keyword changed since the
17
+ * starting a new job, unless the page's focus keyword changed since the
18
18
  * job started, which returns a `SUGGESTIONS_ALREADY_IN_PROGRESS` error.
19
19
  * @param - ID of the site page to optimize.
20
20
  */
@@ -28,7 +28,7 @@ interface TriggerHomePageOptimizationSignature {
28
28
  * Starts generating optimization suggestions for the site's homepage.
29
29
  *
30
30
  * The homepage gets its own method because its suggestions are generated
31
- * with homepage-specific guidance representing the whole site, not one
31
+ * with homepage-specific guidance, representing the whole site, not one
32
32
  * topic. Same contract as Trigger Page Optimization: the homepage's focus
33
33
  * keyword must be set first, the call returns a `predictionId` to poll,
34
34
  * and triggering is idempotent per page while a job is in progress.
@@ -47,8 +47,8 @@ interface GetPageOptimizationResultsSignature {
47
47
  * where the job stands: while generation is still in progress the
48
48
  * suggestions are empty and `status` is `IN_PROGRESS`; when it completes,
49
49
  * the response carries the full suggestion set with `status` `COMPLETED`.
50
- * A job that failed reports `FAILED` trigger again to retry. Suggestions
51
- * are stored per page a later trigger for the same page replaces them,
50
+ * A job that failed reports `FAILED`. Trigger again to retry. Suggestions
51
+ * are stored per page, so a later trigger for the same page replaces them,
52
52
  * and a replaced job's lookup reports `NOT_FOUND`.
53
53
  *
54
54
  * Look up by `predictionId` (from the trigger call), or by `pageId`.
@@ -46,7 +46,7 @@ interface PageOptimization {
46
46
  /** One suggested text change. */
47
47
  interface TextSuggestion {
48
48
  /**
49
- * The page's current text. Empty when the page has no text in this slot
49
+ * The page's current text. Empty when the page has no text in this slot,
50
50
  * for example, a missing meta description.
51
51
  * @readonly
52
52
  * @maxLength 1000
@@ -112,7 +112,7 @@ interface GetPageOptimizationResultsRequest {
112
112
  predictionId?: string | null;
113
113
  /**
114
114
  * ID of the page to retrieve suggestions for. An alternative to
115
- * `predictionId` returns the page's latest generation.
115
+ * `predictionId` that returns the page's latest generation.
116
116
  * @maxLength 1000
117
117
  */
118
118
  pageId?: string | null;
@@ -130,7 +130,7 @@ interface GetPageOptimizationResultsResponse {
130
130
  declare enum OptimizationStatus {
131
131
  UNKNOWN_OPTIMIZATION_STATUS = "UNKNOWN_OPTIMIZATION_STATUS",
132
132
  /**
133
- * No generation job matches the lookup it never existed, or a later
133
+ * No generation job matches the lookup. It never existed, or a later
134
134
  * trigger for the same page replaced it.
135
135
  */
136
136
  NOT_FOUND = "NOT_FOUND",
@@ -215,7 +215,7 @@ type GetPageOptimizationResultsApplicationErrors = {
215
215
  *
216
216
  * Triggering is idempotent per page: while a generation for the page is in
217
217
  * progress, calling again returns the same `predictionId` instead of
218
- * starting a new job unless the page's focus keyword changed since the
218
+ * starting a new job, unless the page's focus keyword changed since the
219
219
  * job started, which returns a `SUGGESTIONS_ALREADY_IN_PROGRESS` error.
220
220
  * @param pageId - ID of the site page to optimize.
221
221
  * @public
@@ -243,7 +243,7 @@ interface TriggerPageOptimizationOptions {
243
243
  * Starts generating optimization suggestions for the site's homepage.
244
244
  *
245
245
  * The homepage gets its own method because its suggestions are generated
246
- * with homepage-specific guidance representing the whole site, not one
246
+ * with homepage-specific guidance, representing the whole site, not one
247
247
  * topic. Same contract as Trigger Page Optimization: the homepage's focus
248
248
  * keyword must be set first, the call returns a `predictionId` to poll,
249
249
  * and triggering is idempotent per page while a job is in progress.
@@ -275,8 +275,8 @@ interface TriggerHomePageOptimizationOptions {
275
275
  * where the job stands: while generation is still in progress the
276
276
  * suggestions are empty and `status` is `IN_PROGRESS`; when it completes,
277
277
  * the response carries the full suggestion set with `status` `COMPLETED`.
278
- * A job that failed reports `FAILED` trigger again to retry. Suggestions
279
- * are stored per page a later trigger for the same page replaces them,
278
+ * A job that failed reports `FAILED`. Trigger again to retry. Suggestions
279
+ * are stored per page, so a later trigger for the same page replaces them,
280
280
  * and a replaced job's lookup reports `NOT_FOUND`.
281
281
  *
282
282
  * Look up by `predictionId` (from the trigger call), or by `pageId`.
@@ -297,7 +297,7 @@ interface GetPageOptimizationResultsOptions {
297
297
  predictionId?: string | null;
298
298
  /**
299
299
  * ID of the page to retrieve suggestions for. An alternative to
300
- * `predictionId` returns the page's latest generation.
300
+ * `predictionId` that returns the page's latest generation.
301
301
  * @maxLength 1000
302
302
  */
303
303
  pageId?: string | null;
@@ -47,7 +47,7 @@ interface PageOptimization {
47
47
  /** One suggested text change. */
48
48
  interface TextSuggestion {
49
49
  /**
50
- * The page's current text. Empty when the page has no text in this slot
50
+ * The page's current text. Empty when the page has no text in this slot,
51
51
  * for example, a missing meta description.
52
52
  * @readonly
53
53
  * @maxLength 1000
@@ -113,7 +113,7 @@ interface GetPageOptimizationResultsRequest {
113
113
  predictionId?: string | null;
114
114
  /**
115
115
  * ID of the page to retrieve suggestions for. An alternative to
116
- * `predictionId` returns the page's latest generation.
116
+ * `predictionId` that returns the page's latest generation.
117
117
  * @maxLength 1000
118
118
  */
119
119
  pageId?: string | null;
@@ -131,7 +131,7 @@ interface GetPageOptimizationResultsResponse {
131
131
  declare enum OptimizationStatus {
132
132
  UNKNOWN_OPTIMIZATION_STATUS = "UNKNOWN_OPTIMIZATION_STATUS",
133
133
  /**
134
- * No generation job matches the lookup it never existed, or a later
134
+ * No generation job matches the lookup. It never existed, or a later
135
135
  * trigger for the same page replaced it.
136
136
  */
137
137
  NOT_FOUND = "NOT_FOUND",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_seo_page-optimization",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "license": "MIT",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
50
50
  "fqdn": "wix.seo.suggestions.v1.page_optimization"
51
51
  }
52
52
  },
53
- "falconPackageHash": "1111cf88f4c87271e3e5af766a0e1f258249ff74ca9014705b3435d3"
53
+ "falconPackageHash": "c2bf9f1bda55989020c7342b56b2f69443cac8ec12a441b244b59cb9"
54
54
  }