@wix/auto_sdk_seo_content-plan-flows 1.0.0 → 1.0.2

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

@@ -8,7 +8,10 @@ import { NonNullablePaths } from '@wix/sdk-types';
  * 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.
+ * and waits for a call to Create Content Plan before it continues. The flow
+ * reaches `KEYWORD_RESEARCH` when keyword research starts, so check that the
+ * research finished with Get Site Keyword Research before you call Create
+ * Content Plan.
  */
 interface ContentPlanFlow {
     /**
@@ -32,7 +35,8 @@ interface ContentPlanFlow {
      *
      * The status advances on its own as generation progresses, except at
      * `KEYWORD_RESEARCH`, where the flow waits for a call to Create Content
-     * Plan.
+     * Plan. Keyword research may still be running at that point; its own
+     * status is on Get Site Keyword Research.
      */
     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, and the flow waits here until Create
+     * Content Plan is called. This status doesn't change when the research
+     * succeeds. Poll Get Site Keyword Research with `keywordResearchId`
+     * until its status is `SUCCESS`, then call Create Content Plan.
      */
     KEYWORD_RESEARCH = "KEYWORD_RESEARCH",
     /** Blog post briefs are being generated from the keyword research. */
@@ -512,7 +519,7 @@ interface AccountInfo {
  * @applicableIdentity APP
  * @fqn wix.promote.seo.content.plan.v1.ContentPlanFlowServiceV1.GetContentPlanFlow
  */
-declare function getContentPlanFlow(contentPlanFlowId: string): Promise<NonNullablePaths<GetContentPlanFlowResponse, `contentPlanFlow.status`, 3>>;
+declare function getContentPlanFlow(contentPlanFlowId: string): Promise<NonNullablePaths<GetContentPlanFlowResponse, `contentPlanFlow.status`, 1>>;
 /**
  * Creates and starts a content plan flow for a site.
  *
@@ -524,8 +531,10 @@ 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`.
+ * The flow stops at `KEYWORD_RESEARCH` and waits. Once Get Site Keyword
+ * Research reports the flow's research as `SUCCESS`, call Create Content
+ * Plan to generate the blog post briefs and let the flow continue to
+ * `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

@@ -9,7 +9,10 @@ import '@wix/sdk-types';
  * 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.
+ * and waits for a call to Create Content Plan before it continues. The flow
+ * reaches `KEYWORD_RESEARCH` when keyword research starts, so check that the
+ * research finished with Get Site Keyword Research before you call Create
+ * Content Plan.
  */
 interface ContentPlanFlow {
     /**
@@ -33,7 +36,8 @@ interface ContentPlanFlow {
      *
      * The status advances on its own as generation progresses, except at
      * `KEYWORD_RESEARCH`, where the flow waits for a call to Create Content
-     * Plan.
+     * Plan. Keyword research may still be running at that point; its own
+     * status is on Get Site Keyword Research.
      */
     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, and the flow waits here until Create
+     * Content Plan is called. This status doesn't change when the research
+     * succeeds. Poll Get Site Keyword Research with `keywordResearchId`
+     * until its status is `SUCCESS`, then call Create Content Plan.
      */
     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.0",
+  "version": "1.0.2",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
       "fqdn": "wix.promote.seo.v1.content_plan_content_plan_flow"
     }
   },
-  "falconPackageHash": "6f75d59857cb073be364092dacd6f348824e42b6bc7c76d3b72db6c9"
+  "falconPackageHash": "f28294f4d08da94d5234b6b37321ce1164c78c2ed38e66c280b67d2f"
 }