@wix/auto_sdk_seo_content-plan-flows 1.0.1 → 1.0.3

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

@@ -7,8 +7,11 @@ import { NonNullablePaths } from '@wix/sdk-types';
  * business category, and real search volume data. Generating one takes several
  * minutes, so the flow runs asynchronously and reports its progress in `status`.
  *
- * A flow doesn't run to completion on its own. It stops at `KEYWORD_RESEARCH`
- * and waits for a call to Create Content Plan before it continues.
+ * A flow reaches `KEYWORD_RESEARCH` when keyword research starts, not when it
+ * finishes. Some flows advance automatically. For a flow still waiting here,
+ * check its matching research with Get Site Keyword Research, then re-read the
+ * flow before calling Create Content Plan once. Skip Create if the flow has
+ * already advanced to `CONTENT_PLAN` or `SUCCESS`.
  */
 interface ContentPlanFlow {
     /**
@@ -30,9 +33,10 @@ interface ContentPlanFlow {
     /**
      * Current status of the content plan flow.
      *
-     * The status advances on its own as generation progresses, except at
-     * `KEYWORD_RESEARCH`, where the flow waits for a call to Create Content
-     * Plan.
+     * `KEYWORD_RESEARCH` can mean research is running or the flow is waiting
+     * for Create Content Plan. Get Site Keyword Research reports research's
+     * own status. A flow already at `CONTENT_PLAN` or `SUCCESS` needs no
+     * release call.
      */
     status?: StatusWithLiterals;
     /**
@@ -53,9 +57,10 @@ interface ContentPlanFlow {
      */
     statusAdditionalData?: Record<string, any> | null;
     /**
-     * ID of the keyword research the flow produced.
+     * ID of the keyword research the flow started.
      *
-     * Available once `status` is `KEYWORD_RESEARCH` or later.
+     * Available once `status` is `KEYWORD_RESEARCH` or later. Pass it to Get
+     * Site Keyword Research to check whether the research finished.
      * @format GUID
      */
     keywordResearchId?: string | null;
@@ -77,8 +82,10 @@ declare enum Status {
     /** The site's existing content is being summarized. */
     SITE_SUMMARY = "SITE_SUMMARY",
     /**
-     * Keyword research is complete and the flow is waiting. Call Create
-     * Content Plan to generate the blog post briefs and continue the flow.
+     * Keyword research has started. This does not prove research is ready.
+     * Check the matching research with Get Site Keyword Research. After
+     * research succeeds, re-read the flow before calling Create Content
+     * Plan once if it still waits here.
      */
     KEYWORD_RESEARCH = "KEYWORD_RESEARCH",
     /** Blog post briefs are being generated from the keyword research. */
@@ -524,8 +531,11 @@ declare function getContentPlanFlow(contentPlanFlowId: string): Promise<NonNulla
  * A successful response means the flow was created, not that generation
  * succeeded. Check `status` rather than relying on the response alone.
  *
- * The flow stops at `KEYWORD_RESEARCH` and waits. Call Create Content Plan
- * to generate the blog post briefs and let the flow continue to `SUCCESS`.
+ * Some flows advance automatically. For a flow at `KEYWORD_RESEARCH`,
+ * use Get Site Keyword Research to check its matching research. After
+ * research `SUCCESS`, re-read the flow and call Create Content Plan once
+ * only if it still waits at `KEYWORD_RESEARCH` with the same research ID.
+ * Skip Create if the flow is already at `CONTENT_PLAN` or `SUCCESS`.
  *
  * A failed flow is retried automatically, and each retry creates a separate
  * flow with its own ID. The original flow keeps its `FAIL` status, so call

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

@@ -8,8 +8,11 @@ import '@wix/sdk-types';
  * business category, and real search volume data. Generating one takes several
  * minutes, so the flow runs asynchronously and reports its progress in `status`.
  *
- * A flow doesn't run to completion on its own. It stops at `KEYWORD_RESEARCH`
- * and waits for a call to Create Content Plan before it continues.
+ * A flow reaches `KEYWORD_RESEARCH` when keyword research starts, not when it
+ * finishes. Some flows advance automatically. For a flow still waiting here,
+ * check its matching research with Get Site Keyword Research, then re-read the
+ * flow before calling Create Content Plan once. Skip Create if the flow has
+ * already advanced to `CONTENT_PLAN` or `SUCCESS`.
  */
 interface ContentPlanFlow {
     /**
@@ -31,9 +34,10 @@ interface ContentPlanFlow {
     /**
      * Current status of the content plan flow.
      *
-     * The status advances on its own as generation progresses, except at
-     * `KEYWORD_RESEARCH`, where the flow waits for a call to Create Content
-     * Plan.
+     * `KEYWORD_RESEARCH` can mean research is running or the flow is waiting
+     * for Create Content Plan. Get Site Keyword Research reports research's
+     * own status. A flow already at `CONTENT_PLAN` or `SUCCESS` needs no
+     * release call.
      */
     status?: StatusWithLiterals;
     /**
@@ -54,9 +58,10 @@ interface ContentPlanFlow {
      */
     statusAdditionalData?: Record<string, any> | null;
     /**
-     * ID of the keyword research the flow produced.
+     * ID of the keyword research the flow started.
      *
-     * Available once `status` is `KEYWORD_RESEARCH` or later.
+     * Available once `status` is `KEYWORD_RESEARCH` or later. Pass it to Get
+     * Site Keyword Research to check whether the research finished.
      * @format GUID
      */
     keywordResearchId?: string | null;
@@ -78,8 +83,10 @@ declare enum Status {
     /** The site's existing content is being summarized. */
     SITE_SUMMARY = "SITE_SUMMARY",
     /**
-     * Keyword research is complete and the flow is waiting. Call Create
-     * Content Plan to generate the blog post briefs and continue the flow.
+     * Keyword research has started. This does not prove research is ready.
+     * Check the matching research with Get Site Keyword Research. After
+     * research succeeds, re-read the flow before calling Create Content
+     * Plan once if it still waits here.
      */
     KEYWORD_RESEARCH = "KEYWORD_RESEARCH",
     /** Blog post briefs are being generated from the keyword research. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_seo_content-plan-flows",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
       "fqdn": "wix.promote.seo.v1.content_plan_content_plan_flow"
     }
   },
-  "falconPackageHash": "490b33e3e78c717027c88faed34b5238a1596ba353de0f22c89fb286"
+  "falconPackageHash": "aaff608a400d6ddab632b1a026a1c41efc9797f50e3ad00c1604fc87"
 }