@wix/auto_sdk_containers_plans 1.0.4 → 1.0.6

package/build/cjs/index.d.ts

@@ -113,7 +113,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.
@@ -495,6 +604,48 @@ interface FinalizePlanResponse {
     /** The finalized Plan. */
     plan?: Plan;
 }
+interface GetPromptSuggestionsRequest {
+}
+interface GetPromptSuggestionsResponse {
+    /**
+     * Name of the business the suggestions are for. Empty when unknown.
+     * @maxLength 200
+     */
+    businessName?: string;
+    /**
+     * The owner's first request, ready to send or to edit. Empty when there are no suggestions.
+     * @maxLength 500
+     */
+    defaultPrompt?: string;
+    /**
+     * App ideas for this business, strongest first: none, or 3 to 5.
+     * @maxSize 5
+     */
+    suggestions?: PromptSuggestion[];
+    /** Where the suggestions come from. */
+    source?: PromptSuggestionsSourceWithLiterals;
+}
+/** One suggestion chip. */
+interface PromptSuggestion {
+    /**
+     * Short chip text, one line on a phone, for example "Workshop booking app".
+     * @maxLength 42
+     */
+    label?: string;
+    /**
+     * The owner's full request that the chip puts in the prompt box.
+     * @maxLength 400
+     */
+    prompt?: string;
+}
+declare enum PromptSuggestionsSource {
+    /** Made from the site's business profile. */
+    BUSINESS_PROFILE = "BUSINESS_PROFILE",
+    /** No suggestions: show the static first prompt. */
+    NO_SUGGESTIONS = "NO_SUGGESTIONS"
+}
+/** @enumType */
+type PromptSuggestionsSourceWithLiterals = PromptSuggestionsSource | 'BUSINESS_PROFILE' | 'NO_SUGGESTIONS';
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
@@ -720,4 +871,4 @@ interface ModifyPlanOptions {
     planEditContext?: PlanEditContext;
 }
 
-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 };
+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 GetPromptSuggestionsRequest, type GetPromptSuggestionsResponse, 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 PromptSuggestion, PromptSuggestionsSource, type PromptSuggestionsSourceWithLiterals, type RegenerateIconRequest, type RegenerateIconResponse, type RestoreInfo, type UpdatePlan, type UpdatePlanRequest, type UpdatePlanResponse, type UsableContent, WebhookIdentityType, type WebhookIdentityTypeWithLiterals };

package/build/cjs/index.js

@@ -20,9 +20,12 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // index.ts
 var index_exports = {};
 __export(index_exports, {
+  BusinessGoalConfidence: () => BusinessGoalConfidence,
+  ContentSource: () => ContentSource,
   PlanPartType: () => PlanPartType,
   PlanStatus: () => PlanStatus,
   Platform: () => Platform,
+  PromptSuggestionsSource: () => PromptSuggestionsSource,
   WebhookIdentityType: () => WebhookIdentityType,
   createAndGeneratePlan: () => createAndGeneratePlan4,
   createPlan: () => createPlan4,
@@ -31,6 +34,7 @@ __export(index_exports, {
   generatePlan: () => generatePlan4,
   getPlan: () => getPlan4,
   getPlanByProjectId: () => getPlanByProjectId4,
+  getPromptSuggestions: () => getPromptSuggestions4,
   modifyPlan: () => modifyPlan4,
   regenerateIcon: () => regenerateIcon4,
   updatePlan: () => updatePlan4
@@ -345,6 +349,27 @@ function finalizePlan(payload) {
   }
   return __finalizePlan;
 }
+function getPromptSuggestions(payload) {
+  function __getPromptSuggestions({ host }) {
+    const metadata = {
+      entityFqdn: "wix.containers.plans.v1.plan",
+      method: "GET",
+      methodFqn: "wix.containers.plans.v1.ContainersPlans.GetPromptSuggestions",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixContainersPlansV1ContainersPlansUrl({
+        protoPath: "/v1/prompt-suggestions",
+        data: payload,
+        host
+      }),
+      params: (0, import_rest_modules.toURLSearchParams)(payload)
+    };
+    return metadata;
+  }
+  return __getPromptSuggestions;
+}
 
 // src/containers-plans-v1-plan-plans.universal.ts
 var Platform = /* @__PURE__ */ ((Platform2) => {
@@ -356,6 +381,23 @@ var PlanStatus = /* @__PURE__ */ ((PlanStatus2) => {
   PlanStatus2["FINALIZED"] = "FINALIZED";
   return PlanStatus2;
 })(PlanStatus || {});
+var BusinessGoalConfidence = /* @__PURE__ */ ((BusinessGoalConfidence2) => {
+  BusinessGoalConfidence2["LOW"] = "LOW";
+  BusinessGoalConfidence2["MEDIUM"] = "MEDIUM";
+  BusinessGoalConfidence2["HIGH"] = "HIGH";
+  return BusinessGoalConfidence2;
+})(BusinessGoalConfidence || {});
+var ContentSource = /* @__PURE__ */ ((ContentSource2) => {
+  ContentSource2["STORES"] = "STORES";
+  ContentSource2["BOOKINGS"] = "BOOKINGS";
+  ContentSource2["EVENTS"] = "EVENTS";
+  ContentSource2["BLOG"] = "BLOG";
+  ContentSource2["PRICING_PLANS"] = "PRICING_PLANS";
+  ContentSource2["RESTAURANTS"] = "RESTAURANTS";
+  ContentSource2["CMS"] = "CMS";
+  ContentSource2["SITE_TEXT"] = "SITE_TEXT";
+  return ContentSource2;
+})(ContentSource || {});
 var PlanPartType = /* @__PURE__ */ ((PlanPartType2) => {
   PlanPartType2["APP_NAME"] = "APP_NAME";
   PlanPartType2["APP_DESCRIPTION"] = "APP_DESCRIPTION";
@@ -370,6 +412,11 @@ var PlanPartType = /* @__PURE__ */ ((PlanPartType2) => {
   PlanPartType2["TEXT_THEME"] = "TEXT_THEME";
   return PlanPartType2;
 })(PlanPartType || {});
+var PromptSuggestionsSource = /* @__PURE__ */ ((PromptSuggestionsSource2) => {
+  PromptSuggestionsSource2["BUSINESS_PROFILE"] = "BUSINESS_PROFILE";
+  PromptSuggestionsSource2["NO_SUGGESTIONS"] = "NO_SUGGESTIONS";
+  return PromptSuggestionsSource2;
+})(PromptSuggestionsSource || {});
 var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
   WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
   WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
@@ -627,6 +674,29 @@ async function finalizePlan2(planId, conversationId) {
     throw transformedError;
   }
 }
+async function getPromptSuggestions2() {
+  const { httpClient, sideEffects } = arguments[0];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({});
+  const reqOpts = getPromptSuggestions(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {},
+        singleArgumentUnchanged: false
+      },
+      []
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 
 // src/containers-plans-v1-plan-plans.public.ts
 function createPlan3(httpClient) {
@@ -703,6 +773,12 @@ function finalizePlan3(httpClient) {
     { httpClient }
   );
 }
+function getPromptSuggestions3(httpClient) {
+  return () => getPromptSuggestions2(
+    // @ts-ignore
+    { httpClient }
+  );
+}
 
 // src/containers-plans-v1-plan-plans.context.ts
 var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
@@ -716,11 +792,15 @@ var generatePlan4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(g
 var modifyPlan4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(modifyPlan3);
 var regenerateIcon4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(regenerateIcon3);
 var finalizePlan4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(finalizePlan3);
+var getPromptSuggestions4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getPromptSuggestions3);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  BusinessGoalConfidence,
+  ContentSource,
   PlanPartType,
   PlanStatus,
   Platform,
+  PromptSuggestionsSource,
   WebhookIdentityType,
   createAndGeneratePlan,
   createPlan,
@@ -729,6 +809,7 @@ var finalizePlan4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(f
   generatePlan,
   getPlan,
   getPlanByProjectId,
+  getPromptSuggestions,
   modifyPlan,
   regenerateIcon,
   updatePlan