@wix/auto_sdk_containers_plans 1.0.4 → 1.0.5

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

@@ -115,7 +115,116 @@ interface BusinessContext {
      * @format WEB_URL
      */
     publicSiteUrl?: string | null;
+    /**
+     * What the server learned from the site's content before the first plan was generated: the
+     * business, its goal and the content an app can show. Absent for older plans, when the analysis
+     * is off for the site, or when it did not finish.
+     * @readonly
+     */
+    analysis?: BusinessAnalysis;
 }
+/** A short analysis of the business, made from the site's content for the planning agent. */
+interface BusinessAnalysis {
+    /**
+     * Industry of the business, for example "yoga studio".
+     * @maxLength 200
+     */
+    industry?: string;
+    /**
+     * Short factual summary of the business and what its site offers.
+     * @maxLength 2000
+     */
+    summary?: string;
+    /**
+     * The main outcome the business wants from its customers, for example "Get more class bookings".
+     * @maxLength 500
+     */
+    businessGoal?: string;
+    /** How strongly the site's content supports business_goal. */
+    businessGoalConfidence?: BusinessGoalConfidenceWithLiterals;
+    /**
+     * Who the business's customers are.
+     * @maxLength 500
+     */
+    audience?: string;
+    /**
+     * Main products or services the business offers, as named on the site.
+     * @maxSize 6
+     * @maxLength 200
+     */
+    keyOfferings?: string[];
+    /**
+     * Site content of each kind that the generated app can show.
+     * @maxSize 10
+     */
+    usableContent?: UsableContent[];
+    /**
+     * Names of the Wix business apps installed on the site, for example "Wix Bookings".
+     * @maxSize 30
+     * @maxLength 100
+     */
+    installedVerticals?: string[];
+    /**
+     * Short points the app should focus on to serve business_goal.
+     * @maxSize 3
+     * @maxLength 300
+     */
+    appFocus?: string[];
+    /**
+     * How the site's own text sounds to its customers, so the app's text can sound the same, for
+     * example "Warm and homely; short sentences; speaks to the customer as 'you'".
+     * @maxLength 500
+     */
+    toneOfVoice?: string;
+    /**
+     * Up to three short phrases quoted from the site that show its tone of voice.
+     * @maxSize 3
+     * @maxLength 200
+     */
+    toneExamples?: string[];
+}
+declare enum BusinessGoalConfidence {
+    /** The site gives little or conflicting evidence for the goal. */
+    LOW = "LOW",
+    /** The goal is a reasonable inference from the site. */
+    MEDIUM = "MEDIUM",
+    /** The goal follows directly from strong evidence, such as a booking app with services. */
+    HIGH = "HIGH"
+}
+/** @enumType */
+type BusinessGoalConfidenceWithLiterals = BusinessGoalConfidence | 'LOW' | 'MEDIUM' | 'HIGH';
+/** Site content of one kind that the generated app can show. */
+interface UsableContent {
+    /** Where the content comes from. */
+    source?: ContentSourceWithLiterals;
+    /**
+     * What the content is, for example "12 yoga and pilates classes with prices".
+     * @maxLength 500
+     */
+    description?: string;
+    /** Number of items found, when known. */
+    itemCount?: number | null;
+}
+declare enum ContentSource {
+    /** Wix Stores products. */
+    STORES = "STORES",
+    /** Wix Bookings services. */
+    BOOKINGS = "BOOKINGS",
+    /** Wix Events events. */
+    EVENTS = "EVENTS",
+    /** Wix Blog posts. */
+    BLOG = "BLOG",
+    /** Wix Pricing Plans plans. */
+    PRICING_PLANS = "PRICING_PLANS",
+    /** Wix Restaurants menu items. */
+    RESTAURANTS = "RESTAURANTS",
+    /** Wix CMS (Wix Data) collections. */
+    CMS = "CMS",
+    /** Text of the published site's home page. */
+    SITE_TEXT = "SITE_TEXT"
+}
+/** @enumType */
+type ContentSourceWithLiterals = ContentSource | 'STORES' | 'BOOKINGS' | 'EVENTS' | 'BLOG' | 'PRICING_PLANS' | 'RESTAURANTS' | 'CMS' | 'SITE_TEXT';
 /**
  * Visual identity extracted from the user's existing website. Serves as an editable
  * starting point for the generated app.
@@ -669,7 +778,7 @@ interface AccountInfo {
  * @returns The created Plan.
  * @fqn wix.containers.plans.v1.ContainersPlans.CreatePlan
  */
-declare function createPlan(plan: NonNullablePaths<Plan, `initialPrompt` | `platform` | `projectId` | `selectedTemplateId`, 0>): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`, 3>>;
+declare function createPlan(plan: NonNullablePaths<Plan, `initialPrompt` | `platform` | `projectId` | `selectedTemplateId`, 0>): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `businessContext.analysis.industry` | `businessContext.analysis.summary` | `businessContext.analysis.businessGoal` | `businessContext.analysis.businessGoalConfidence` | `businessContext.analysis.audience` | `businessContext.analysis.keyOfferings` | `businessContext.analysis.usableContent` | `businessContext.analysis.usableContent.${number}.source` | `businessContext.analysis.usableContent.${number}.description` | `businessContext.analysis.installedVerticals` | `businessContext.analysis.appFocus` | `businessContext.analysis.toneOfVoice` | `businessContext.analysis.toneExamples` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`, 4>>;
 /**
  * Creates a new Plan and immediately generates it using the planning agent.
  * @param plan - Plan to be created and generated.
@@ -683,7 +792,7 @@ declare function createPlan(plan: NonNullablePaths<Plan, `initialPrompt` | `plat
  * @permissionId containers:plans:v1:plan:create_and_generate_plan
  * @fqn wix.containers.plans.v1.ContainersPlans.CreateAndGeneratePlan
  */
-declare function createAndGeneratePlan(plan: NonNullablePaths<Plan, `initialPrompt` | `platform` | `projectId` | `selectedTemplateId`, 0>): Promise<NonNullablePaths<CreateAndGeneratePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`, 4>>;
+declare function createAndGeneratePlan(plan: NonNullablePaths<Plan, `initialPrompt` | `platform` | `projectId` | `selectedTemplateId`, 0>): Promise<NonNullablePaths<CreateAndGeneratePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`, 5>>;
 /**
  * Retrieves a Plan by its ID.
  * @param planId - ID of the Plan to retrieve.
@@ -694,7 +803,7 @@ declare function createAndGeneratePlan(plan: NonNullablePaths<Plan, `initialProm
  * @returns The requested Plan.
  * @fqn wix.containers.plans.v1.ContainersPlans.GetPlan
  */
-declare function getPlan(planId: string): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`, 3>>;
+declare function getPlan(planId: string): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `businessContext.analysis.industry` | `businessContext.analysis.summary` | `businessContext.analysis.businessGoal` | `businessContext.analysis.businessGoalConfidence` | `businessContext.analysis.audience` | `businessContext.analysis.keyOfferings` | `businessContext.analysis.usableContent` | `businessContext.analysis.usableContent.${number}.source` | `businessContext.analysis.usableContent.${number}.description` | `businessContext.analysis.installedVerticals` | `businessContext.analysis.appFocus` | `businessContext.analysis.toneOfVoice` | `businessContext.analysis.toneExamples` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`, 4>>;
 /**
  * Retrieves the (single) Plan for a project. Server-to-server: containers-projects uses this to
  * read the finalized plan when creating the initial generation job.
@@ -705,7 +814,7 @@ declare function getPlan(planId: string): Promise<NonNullablePaths<Plan, `initia
  * @permissionId containers:plans:v1:plan:get_plan_by_project_id
  * @fqn wix.containers.plans.v1.ContainersPlans.GetPlanByProjectId
  */
-declare function getPlanByProjectId(projectId: string): Promise<NonNullablePaths<GetPlanByProjectIdResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl`, 4>>;
+declare function getPlanByProjectId(projectId: string): Promise<NonNullablePaths<GetPlanByProjectIdResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl`, 5>>;
 /**
  * Updates a Plan. The current revision must be passed for optimistic locking.
  * @param _id - Plan ID.
@@ -718,7 +827,7 @@ declare function getPlanByProjectId(projectId: string): Promise<NonNullablePaths
  * @returns The updated Plan.
  * @fqn wix.containers.plans.v1.ContainersPlans.UpdatePlan
  */
-declare function updatePlan(_id: string, plan: NonNullablePaths<UpdatePlan, `revision`, 0>): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`, 3>>;
+declare function updatePlan(_id: string, plan: NonNullablePaths<UpdatePlan, `revision`, 0>): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `businessContext.analysis.industry` | `businessContext.analysis.summary` | `businessContext.analysis.businessGoal` | `businessContext.analysis.businessGoalConfidence` | `businessContext.analysis.audience` | `businessContext.analysis.keyOfferings` | `businessContext.analysis.usableContent` | `businessContext.analysis.usableContent.${number}.source` | `businessContext.analysis.usableContent.${number}.description` | `businessContext.analysis.installedVerticals` | `businessContext.analysis.appFocus` | `businessContext.analysis.toneOfVoice` | `businessContext.analysis.toneExamples` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`, 4>>;
 interface UpdatePlan {
     /**
      * Plan ID.
@@ -794,7 +903,7 @@ declare function deletePlan(planId: string): Promise<void>;
  * @permissionId containers:plans:v1:plan:generate_plan
  * @fqn wix.containers.plans.v1.ContainersPlans.GeneratePlan
  */
-declare function generatePlan(planId: string): Promise<NonNullablePaths<GeneratePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`, 4>>;
+declare function generatePlan(planId: string): Promise<NonNullablePaths<GeneratePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`, 5>>;
 /**
  * Modifies an existing Plan based on the user's answers to the previous iteration's
  * follow-up questions plus an optional additional prompt. Returns the updated plan and
@@ -806,7 +915,7 @@ declare function generatePlan(planId: string): Promise<NonNullablePaths<Generate
  * @permissionId containers:plans:v1:plan:modify_plan
  * @fqn wix.containers.plans.v1.ContainersPlans.ModifyPlan
  */
-declare function modifyPlan(planId: string, options?: ModifyPlanOptions): Promise<NonNullablePaths<ModifyPlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`, 4>>;
+declare function modifyPlan(planId: string, options?: ModifyPlanOptions): Promise<NonNullablePaths<ModifyPlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`, 5>>;
 interface ModifyPlanOptions {
     /**
      * The user's answers to the previous iteration's follow-up questions.
@@ -854,6 +963,6 @@ declare function regenerateIcon(planId: string, prompt: string): Promise<NonNull
  * @permissionId containers:plans:v1:plan:finalize_plan
  * @fqn wix.containers.plans.v1.ContainersPlans.FinalizePlan
  */
-declare function finalizePlan(planId: string, conversationId: string): Promise<NonNullablePaths<FinalizePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl`, 4>>;
+declare function finalizePlan(planId: string, conversationId: string): Promise<NonNullablePaths<FinalizePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl`, 5>>;
 
-export { type AccountInfo, type ActionEvent, type AnsweredQuestion, type AppSpec, type BrandIdentity, type BusinessContext, type CreateAndGeneratePlanRequest, type CreateAndGeneratePlanResponse, type CreatePlanRequest, type CreatePlanResponse, type DeletePlanRequest, type DeletePlanResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Feature, type FinalizePlanRequest, type FinalizePlanResponse, type FollowUpQuestion, type GeneratePlanRequest, type GeneratePlanResponse, type GetPlanByProjectIdRequest, type GetPlanByProjectIdResponse, type GetPlanRequest, type GetPlanResponse, type IdentificationData, type IdentificationDataIdOneOf, type Integration, type MessageEnvelope, type ModifyPlanOptions, type ModifyPlanRequest, type ModifyPlanResponse, type Plan, type PlanEditContext, type PlanFinalized, PlanPartType, type PlanPartTypeWithLiterals, PlanStatus, type PlanStatusWithLiterals, Platform, type PlatformWithLiterals, type RegenerateIconRequest, type RegenerateIconResponse, type RestoreInfo, type UpdatePlan, type UpdatePlanRequest, type UpdatePlanResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createAndGeneratePlan, createPlan, deletePlan, finalizePlan, generatePlan, getPlan, getPlanByProjectId, modifyPlan, regenerateIcon, updatePlan };
+export { type AccountInfo, type ActionEvent, type AnsweredQuestion, type AppSpec, type BrandIdentity, type BusinessAnalysis, type BusinessContext, BusinessGoalConfidence, type BusinessGoalConfidenceWithLiterals, ContentSource, type ContentSourceWithLiterals, type CreateAndGeneratePlanRequest, type CreateAndGeneratePlanResponse, type CreatePlanRequest, type CreatePlanResponse, type DeletePlanRequest, type DeletePlanResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Feature, type FinalizePlanRequest, type FinalizePlanResponse, type FollowUpQuestion, type GeneratePlanRequest, type GeneratePlanResponse, type GetPlanByProjectIdRequest, type GetPlanByProjectIdResponse, type GetPlanRequest, type GetPlanResponse, type IdentificationData, type IdentificationDataIdOneOf, type Integration, type MessageEnvelope, type ModifyPlanOptions, type ModifyPlanRequest, type ModifyPlanResponse, type Plan, type PlanEditContext, type PlanFinalized, PlanPartType, type PlanPartTypeWithLiterals, PlanStatus, type PlanStatusWithLiterals, Platform, type PlatformWithLiterals, type RegenerateIconRequest, type RegenerateIconResponse, type RestoreInfo, type UpdatePlan, type UpdatePlanRequest, type UpdatePlanResponse, type UsableContent, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createAndGeneratePlan, createPlan, deletePlan, finalizePlan, generatePlan, getPlan, getPlanByProjectId, modifyPlan, regenerateIcon, updatePlan };

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

@@ -116,7 +116,116 @@ interface BusinessContext {
      * @format WEB_URL
      */
     publicSiteUrl?: string | null;
+    /**
+     * What the server learned from the site's content before the first plan was generated: the
+     * business, its goal and the content an app can show. Absent for older plans, when the analysis
+     * is off for the site, or when it did not finish.
+     * @readonly
+     */
+    analysis?: BusinessAnalysis;
 }
+/** A short analysis of the business, made from the site's content for the planning agent. */
+interface BusinessAnalysis {
+    /**
+     * Industry of the business, for example "yoga studio".
+     * @maxLength 200
+     */
+    industry?: string;
+    /**
+     * Short factual summary of the business and what its site offers.
+     * @maxLength 2000
+     */
+    summary?: string;
+    /**
+     * The main outcome the business wants from its customers, for example "Get more class bookings".
+     * @maxLength 500
+     */
+    businessGoal?: string;
+    /** How strongly the site's content supports business_goal. */
+    businessGoalConfidence?: BusinessGoalConfidenceWithLiterals;
+    /**
+     * Who the business's customers are.
+     * @maxLength 500
+     */
+    audience?: string;
+    /**
+     * Main products or services the business offers, as named on the site.
+     * @maxSize 6
+     * @maxLength 200
+     */
+    keyOfferings?: string[];
+    /**
+     * Site content of each kind that the generated app can show.
+     * @maxSize 10
+     */
+    usableContent?: UsableContent[];
+    /**
+     * Names of the Wix business apps installed on the site, for example "Wix Bookings".
+     * @maxSize 30
+     * @maxLength 100
+     */
+    installedVerticals?: string[];
+    /**
+     * Short points the app should focus on to serve business_goal.
+     * @maxSize 3
+     * @maxLength 300
+     */
+    appFocus?: string[];
+    /**
+     * How the site's own text sounds to its customers, so the app's text can sound the same, for
+     * example "Warm and homely; short sentences; speaks to the customer as 'you'".
+     * @maxLength 500
+     */
+    toneOfVoice?: string;
+    /**
+     * Up to three short phrases quoted from the site that show its tone of voice.
+     * @maxSize 3
+     * @maxLength 200
+     */
+    toneExamples?: string[];
+}
+declare enum BusinessGoalConfidence {
+    /** The site gives little or conflicting evidence for the goal. */
+    LOW = "LOW",
+    /** The goal is a reasonable inference from the site. */
+    MEDIUM = "MEDIUM",
+    /** The goal follows directly from strong evidence, such as a booking app with services. */
+    HIGH = "HIGH"
+}
+/** @enumType */
+type BusinessGoalConfidenceWithLiterals = BusinessGoalConfidence | 'LOW' | 'MEDIUM' | 'HIGH';
+/** Site content of one kind that the generated app can show. */
+interface UsableContent {
+    /** Where the content comes from. */
+    source?: ContentSourceWithLiterals;
+    /**
+     * What the content is, for example "12 yoga and pilates classes with prices".
+     * @maxLength 500
+     */
+    description?: string;
+    /** Number of items found, when known. */
+    itemCount?: number | null;
+}
+declare enum ContentSource {
+    /** Wix Stores products. */
+    STORES = "STORES",
+    /** Wix Bookings services. */
+    BOOKINGS = "BOOKINGS",
+    /** Wix Events events. */
+    EVENTS = "EVENTS",
+    /** Wix Blog posts. */
+    BLOG = "BLOG",
+    /** Wix Pricing Plans plans. */
+    PRICING_PLANS = "PRICING_PLANS",
+    /** Wix Restaurants menu items. */
+    RESTAURANTS = "RESTAURANTS",
+    /** Wix CMS (Wix Data) collections. */
+    CMS = "CMS",
+    /** Text of the published site's home page. */
+    SITE_TEXT = "SITE_TEXT"
+}
+/** @enumType */
+type ContentSourceWithLiterals = ContentSource | 'STORES' | 'BOOKINGS' | 'EVENTS' | 'BLOG' | 'PRICING_PLANS' | 'RESTAURANTS' | 'CMS' | 'SITE_TEXT';
 /**
  * Visual identity extracted from the user's existing website. Serves as an editable
  * starting point for the generated app.
@@ -738,4 +847,4 @@ declare function finalizePlan(): __PublicMethodMetaInfo<'POST', {
     planId: string;
 }, FinalizePlanRequest$1, FinalizePlanRequest, FinalizePlanResponse$1, FinalizePlanResponse>;
 
-export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AnsweredQuestion as AnsweredQuestionOriginal, type AppSpec as AppSpecOriginal, type BrandIdentity as BrandIdentityOriginal, type BusinessContext as BusinessContextOriginal, type CreateAndGeneratePlanRequest as CreateAndGeneratePlanRequestOriginal, type CreateAndGeneratePlanResponse as CreateAndGeneratePlanResponseOriginal, type CreatePlanRequest as CreatePlanRequestOriginal, type CreatePlanResponse as CreatePlanResponseOriginal, type DeletePlanRequest as DeletePlanRequestOriginal, type DeletePlanResponse as DeletePlanResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type Feature as FeatureOriginal, type FinalizePlanRequest as FinalizePlanRequestOriginal, type FinalizePlanResponse as FinalizePlanResponseOriginal, type FollowUpQuestion as FollowUpQuestionOriginal, type GeneratePlanRequest as GeneratePlanRequestOriginal, type GeneratePlanResponse as GeneratePlanResponseOriginal, type GetPlanByProjectIdRequest as GetPlanByProjectIdRequestOriginal, type GetPlanByProjectIdResponse as GetPlanByProjectIdResponseOriginal, type GetPlanRequest as GetPlanRequestOriginal, type GetPlanResponse as GetPlanResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Integration as IntegrationOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type ModifyPlanRequest as ModifyPlanRequestOriginal, type ModifyPlanResponse as ModifyPlanResponseOriginal, type PlanEditContext as PlanEditContextOriginal, type PlanFinalized as PlanFinalizedOriginal, type Plan as PlanOriginal, PlanPartType as PlanPartTypeOriginal, type PlanPartTypeWithLiterals as PlanPartTypeWithLiteralsOriginal, PlanStatus as PlanStatusOriginal, type PlanStatusWithLiterals as PlanStatusWithLiteralsOriginal, Platform as PlatformOriginal, type PlatformWithLiterals as PlatformWithLiteralsOriginal, type RegenerateIconRequest as RegenerateIconRequestOriginal, type RegenerateIconResponse as RegenerateIconResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type UpdatePlanRequest as UpdatePlanRequestOriginal, type UpdatePlanResponse as UpdatePlanResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, createAndGeneratePlan, createPlan, deletePlan, finalizePlan, generatePlan, getPlan, getPlanByProjectId, modifyPlan, regenerateIcon, updatePlan };
+export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AnsweredQuestion as AnsweredQuestionOriginal, type AppSpec as AppSpecOriginal, type BrandIdentity as BrandIdentityOriginal, type BusinessAnalysis as BusinessAnalysisOriginal, type BusinessContext as BusinessContextOriginal, BusinessGoalConfidence as BusinessGoalConfidenceOriginal, type BusinessGoalConfidenceWithLiterals as BusinessGoalConfidenceWithLiteralsOriginal, ContentSource as ContentSourceOriginal, type ContentSourceWithLiterals as ContentSourceWithLiteralsOriginal, type CreateAndGeneratePlanRequest as CreateAndGeneratePlanRequestOriginal, type CreateAndGeneratePlanResponse as CreateAndGeneratePlanResponseOriginal, type CreatePlanRequest as CreatePlanRequestOriginal, type CreatePlanResponse as CreatePlanResponseOriginal, type DeletePlanRequest as DeletePlanRequestOriginal, type DeletePlanResponse as DeletePlanResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type Feature as FeatureOriginal, type FinalizePlanRequest as FinalizePlanRequestOriginal, type FinalizePlanResponse as FinalizePlanResponseOriginal, type FollowUpQuestion as FollowUpQuestionOriginal, type GeneratePlanRequest as GeneratePlanRequestOriginal, type GeneratePlanResponse as GeneratePlanResponseOriginal, type GetPlanByProjectIdRequest as GetPlanByProjectIdRequestOriginal, type GetPlanByProjectIdResponse as GetPlanByProjectIdResponseOriginal, type GetPlanRequest as GetPlanRequestOriginal, type GetPlanResponse as GetPlanResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Integration as IntegrationOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type ModifyPlanRequest as ModifyPlanRequestOriginal, type ModifyPlanResponse as ModifyPlanResponseOriginal, type PlanEditContext as PlanEditContextOriginal, type PlanFinalized as PlanFinalizedOriginal, type Plan as PlanOriginal, PlanPartType as PlanPartTypeOriginal, type PlanPartTypeWithLiterals as PlanPartTypeWithLiteralsOriginal, PlanStatus as PlanStatusOriginal, type PlanStatusWithLiterals as PlanStatusWithLiteralsOriginal, Platform as PlatformOriginal, type PlatformWithLiterals as PlatformWithLiteralsOriginal, type RegenerateIconRequest as RegenerateIconRequestOriginal, type RegenerateIconResponse as RegenerateIconResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type UpdatePlanRequest as UpdatePlanRequestOriginal, type UpdatePlanResponse as UpdatePlanResponseOriginal, type UsableContent as UsableContentOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, createAndGeneratePlan, createPlan, deletePlan, finalizePlan, generatePlan, getPlan, getPlanByProjectId, modifyPlan, regenerateIcon, updatePlan };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_containers_plans",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
       "fqdn": "wix.containers.plans.v1.plan"
     }
   },
-  "falconPackageHash": "b6af52024e348051f8e1a2da4f7f551a72c20034f69146f2310059e4"
+  "falconPackageHash": "193197c88d73c003c0dbae8947adc1d8b377012ffc7df2e2974a863c"
 }