@wix/auto_sdk_containers_plans 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,708 @@
+interface Plan {
+    /**
+     * Plan ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the Plan is updated.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Plan was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Plan was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * The user's initial free-text prompt that started the plan.
+     * @maxLength 10000
+     */
+    initialPrompt?: string;
+    /** Generation platform for the app. */
+    platform?: PlatformWithLiterals;
+    /** Lifecycle status of the Plan. */
+    status?: PlanStatusWithLiterals;
+    /**
+     * Template chosen for generation. A Code Store `containers-templates` catalog GUID, or (for
+     * HIMALAYA_MOBILE) a himi starter template name (e.g. "branded-lite") that does not resolve to
+     * a catalog entry — see `PlansService.resolveTemplate`/`validateTemplatePlatform`, which treat a
+     * non-GUID value as an opaque template name rather than a catalog reference.
+     * @maxLength 200
+     */
+    selectedTemplateId?: string | null;
+    /**
+     * The project this plan belongs to. Supplied by the client at creation.
+     * @format GUID
+     */
+    projectId?: string | null;
+    /**
+     * Facts extracted from the existing business/site. Derived server-side and read-only to clients.
+     * @readonly
+     */
+    businessContext?: BusinessContext;
+    /** Visual identity extracted from the user's website. A starting point the user can edit. */
+    brandIdentity?: BrandIdentity;
+    /** The specification of the app to generate, produced from the plan prompt. */
+    appSpec?: AppSpec;
+}
+declare enum Platform {
+    /**
+     * Himalaya Mobile (Wix SDUI/OTA content package): mobile apps built headlessly on the
+     * on-demand remote machine via the himi CLI, instead of native iOS/Android pods.
+     */
+    HIMALAYA_MOBILE = "HIMALAYA_MOBILE"
+}
+/** @enumType */
+type PlatformWithLiterals = Platform | 'HIMALAYA_MOBILE';
+declare enum PlanStatus {
+    /** Plan is being assembled by the planning agent and the user. */
+    DRAFT = "DRAFT",
+    /** Plan is complete and approved; ready for the generation pipeline. */
+    FINALIZED = "FINALIZED"
+}
+/** @enumType */
+type PlanStatusWithLiterals = PlanStatus | 'DRAFT' | 'FINALIZED';
+/**
+ * Facts the server extracts about the existing business/site. The client reads these
+ * to inform the app spec, but does not write them.
+ */
+interface BusinessContext {
+    /**
+     * Business name as configured on the site.
+     * @maxLength 200
+     */
+    businessName?: string;
+    /**
+     * Business logo image URL, extracted from the site (empty if it has none). Used as a reference
+     * image when generating the app icon (see AppSpec.app_icon_url).
+     * @maxLength 2000
+     */
+    businessLogoUrl?: string;
+    /**
+     * Business description as configured on the site.
+     * @maxLength 5000
+     */
+    businessDescription?: string;
+    /**
+     * Primary language code of the site (for example "en").
+     * @maxLength 20
+     */
+    language?: string;
+    /**
+     * Country code of the site (for example "IE").
+     * @maxLength 20
+     */
+    country?: string;
+    /**
+     * App definition IDs of Wix apps installed on the site (for example Bookings, eCommerce).
+     * @maxSize 100
+     * @maxLength 200
+     */
+    wixIntegrations?: string[];
+}
+/**
+ * Visual identity extracted from the user's existing website. Serves as an editable
+ * starting point for the generated app.
+ */
+interface BrandIdentity {
+    /**
+     * Primary brand color.
+     * @maxLength 100
+     */
+    primaryColor?: string;
+    /**
+     * Background color.
+     * @maxLength 100
+     */
+    backgroundColor?: string;
+    /**
+     * Content (foreground) color.
+     * @maxLength 100
+     */
+    contentColor?: string;
+    /**
+     * Heading typography / font.
+     * @maxLength 100
+     */
+    headingFont?: string;
+    /**
+     * Body typography / font.
+     * @maxLength 100
+     */
+    bodyFont?: string;
+}
+/**
+ * The specification of the app to generate, produced from the plan prompt and confirmed
+ * by the user.
+ */
+interface AppSpec {
+    /**
+     * Display name of the app to generate.
+     * @maxLength 200
+     */
+    appName?: string;
+    /**
+     * Description of the app to generate.
+     * @maxLength 5000
+     */
+    appDescription?: string;
+    /**
+     * The business goal the app should serve.
+     * @maxLength 2000
+     */
+    businessGoal?: string;
+    /**
+     * The target audience for the app.
+     * @maxLength 2000
+     */
+    audience?: string;
+    /**
+     * Wix integrations to include, each with a display name, description, and capability tags.
+     * @maxSize 100
+     */
+    wixIntegrations?: Integration[];
+    /**
+     * Third-party integrations to include, each with a display name, description, and capability tags.
+     * @maxSize 100
+     */
+    thirdPartyIntegrations?: Integration[];
+    /**
+     * Features the app should provide, each with a title and description.
+     * @maxSize 200
+     */
+    features?: Feature[];
+    /**
+     * Navigation screens for the app.
+     * @maxSize 100
+     * @maxLength 200
+     */
+    navigation?: string[];
+    /**
+     * Icon URL for the app to generate. Seeded at plan creation from the business's real logo, or
+     * a best-effort generated placeholder if it has none. The client can replace it later with a
+     * RegenerateIcon result they've accepted, via UpdatePlan.
+     * @format WEB_URL
+     * @maxLength 2000
+     */
+    appIconUrl?: string;
+}
+/**
+ * An integration (Wix or third-party) the generated app should include, produced by the
+ * planning agent from the prompt.
+ */
+interface Integration {
+    /**
+     * Display name, for example "Wix Stores".
+     * @maxLength 200
+     */
+    displayName?: string;
+    /**
+     * What the integration provides / why it is included.
+     * @maxLength 2000
+     */
+    description?: string;
+    /**
+     * Sub-capabilities the integration includes, rendered as tags (for example "Storefront",
+     * "Cart & Checkout").
+     * @maxSize 50
+     * @maxLength 100
+     */
+    tags?: string[];
+    /**
+     * Stable integration id / slug (for example "wix-stores"). For Wix integrations this is chosen
+     * by the planning agent from the server-provided catalog of supported Wix integrations; empty
+     * for free-form third-party integrations. The client keys the integration's icon off this id.
+     * @maxLength 200
+     */
+    _id?: string;
+}
+/** A capability the app should provide, produced by the planning agent from the prompt. */
+interface Feature {
+    /**
+     * Short feature title.
+     * @maxLength 200
+     */
+    title?: string;
+    /**
+     * What the feature does, shown under the title.
+     * @maxLength 2000
+     */
+    description?: string;
+}
+interface PlanFinalized {
+    /**
+     * ID of the Plan that was finalized.
+     * @format GUID
+     */
+    planId?: string;
+    /**
+     * ID of the Project this plan belongs to. containers-projects reads the finalized plan back by
+     * this id (one plan per project) when creating the initial generation job.
+     * @format GUID
+     */
+    projectId?: string;
+    /**
+     * ID of the conversation that led to this plan being finalized.
+     * @format GUID
+     */
+    conversationId?: string;
+}
+interface CreatePlanRequest {
+    /** Plan to be created. */
+    plan: Plan;
+}
+interface CreatePlanResponse {
+    /** The created Plan. */
+    plan?: Plan;
+}
+interface CreateAndGeneratePlanRequest {
+    /** Plan to be created and generated. */
+    plan: Plan;
+}
+interface CreateAndGeneratePlanResponse {
+    /** The generated Plan. */
+    plan?: Plan;
+    /**
+     * Follow-up questions from the planning agent to further build the plan.
+     * @maxSize 50
+     * @maxLength 4000
+     */
+    followUpQuestions?: string[];
+    /**
+     * Structured follow-up questions with selectable answer options. Superseding follow_up_questions;
+     * that field is kept and populated in parallel for callers that have not migrated to this one.
+     * @maxSize 4
+     */
+    followUpQuestionOptions?: FollowUpQuestion[];
+}
+/** A follow-up question paired with selectable answer options, shown as quick-reply choices. */
+interface FollowUpQuestion {
+    /**
+     * The question text.
+     * @maxLength 4000
+     */
+    question?: string;
+    /**
+     * Selectable answer options for this question.
+     * @maxSize 10
+     * @maxLength 200
+     */
+    options?: string[];
+}
+interface GetPlanRequest {
+    /**
+     * ID of the Plan to retrieve.
+     * @format GUID
+     */
+    planId: string;
+}
+interface GetPlanResponse {
+    /** The requested Plan. */
+    plan?: Plan;
+}
+interface GetPlanByProjectIdRequest {
+    /**
+     * ID of the project whose Plan to retrieve.
+     * @format GUID
+     */
+    projectId: string;
+}
+interface GetPlanByProjectIdResponse {
+    /** The project's Plan. */
+    plan?: Plan;
+}
+interface UpdatePlanRequest {
+    /** Plan to be updated, may be partial. */
+    plan: Plan;
+}
+interface UpdatePlanResponse {
+    /** The updated Plan. */
+    plan?: Plan;
+}
+interface DeletePlanRequest {
+    /**
+     * ID of the Plan to delete.
+     * @format GUID
+     */
+    planId: string;
+}
+interface DeletePlanResponse {
+}
+interface GeneratePlanRequest {
+    /**
+     * ID of the Plan to generate.
+     * @format GUID
+     */
+    planId: string;
+}
+interface GeneratePlanResponse {
+    /** The generated Plan. */
+    plan?: Plan;
+    /**
+     * Follow-up questions from the planning agent to further build the plan.
+     * @maxSize 50
+     * @maxLength 4000
+     */
+    followUpQuestions?: string[];
+    /**
+     * Structured follow-up questions with selectable answer options. Superseding follow_up_questions;
+     * that field is kept and populated in parallel for callers that have not migrated to this one.
+     * @maxSize 4
+     */
+    followUpQuestionOptions?: FollowUpQuestion[];
+}
+interface ModifyPlanRequest {
+    /**
+     * ID of the Plan to modify.
+     * @format GUID
+     */
+    planId: string;
+    /**
+     * The user's answers to the previous iteration's follow-up questions.
+     * @maxSize 50
+     */
+    answeredQuestions?: AnsweredQuestion[];
+    /**
+     * Optional additional request from the user to further shape the plan.
+     * @maxLength 10000
+     */
+    userPrompt?: string | null;
+    /**
+     * Optional selected plan part. When present, only this boundary may change.
+     * When absent, ModifyPlan keeps its existing whole-plan behavior.
+     */
+    planEditContext?: PlanEditContext;
+}
+/** A follow-up question from a previous iteration paired with the user's answer. */
+interface AnsweredQuestion {
+    /**
+     * The follow-up question that was asked.
+     * @maxLength 4000
+     */
+    question?: string;
+    /**
+     * The user's answer to the question.
+     * @maxLength 10000
+     */
+    answer?: string;
+}
+/**
+ * Identifies one editable part of a plan. Optional on chat and plan-edit requests; when absent,
+ * plan editing keeps its existing whole-plan behavior.
+ */
+interface PlanEditContext {
+    /** Kind of plan part selected by the user. */
+    type?: PlanPartTypeWithLiterals;
+    /**
+     * Zero-based item index. Set only for repeated parts such as features, screens, or integrations.
+     * @max 199
+     */
+    index?: number | null;
+    /**
+     * Plan revision shown when the user selected the part. Used to reject stale edits.
+     * @min 1
+     */
+    planRevision?: string | null;
+}
+declare enum PlanPartType {
+    APP_NAME = "APP_NAME",
+    APP_DESCRIPTION = "APP_DESCRIPTION",
+    BUSINESS_GOAL = "BUSINESS_GOAL",
+    AUDIENCE = "AUDIENCE",
+    FEATURE = "FEATURE",
+    SCREEN = "SCREEN",
+    WIX_INTEGRATION = "WIX_INTEGRATION",
+    THIRD_PARTY_INTEGRATION = "THIRD_PARTY_INTEGRATION",
+    BRAND_IDENTITY = "BRAND_IDENTITY",
+    /** Color fields within brand_identity; fonts are preserved by the service. */
+    COLOR_THEME = "COLOR_THEME",
+    /** Font fields within brand_identity; colors are preserved by the service. */
+    TEXT_THEME = "TEXT_THEME"
+}
+/** @enumType */
+type PlanPartTypeWithLiterals = PlanPartType | 'APP_NAME' | 'APP_DESCRIPTION' | 'BUSINESS_GOAL' | 'AUDIENCE' | 'FEATURE' | 'SCREEN' | 'WIX_INTEGRATION' | 'THIRD_PARTY_INTEGRATION' | 'BRAND_IDENTITY' | 'COLOR_THEME' | 'TEXT_THEME';
+interface ModifyPlanResponse {
+    /** The modified Plan. */
+    plan?: Plan;
+    /**
+     * Follow-up questions the agent wants to ask to further refine the plan.
+     * @maxSize 50
+     * @maxLength 4000
+     */
+    followUpQuestions?: string[];
+    /**
+     * Structured follow-up questions with selectable answer options. Superseding follow_up_questions;
+     * that field is kept and populated in parallel for callers that have not migrated to this one.
+     * @maxSize 4
+     */
+    followUpQuestionOptions?: FollowUpQuestion[];
+}
+interface RegenerateIconRequest {
+    /**
+     * ID of the Plan whose icon to regenerate.
+     * @format GUID
+     */
+    planId: string;
+    /**
+     * Free-text description of the desired icon, passed to the icon-generation prompt.
+     * @maxLength 4000
+     */
+    prompt: string;
+}
+interface RegenerateIconResponse {
+    /**
+     * The generated icon URL. Not persisted — apply via UpdatePlan (app_spec.app_icon_url).
+     * @maxLength 2000
+     */
+    iconUrl?: string;
+}
+interface FinalizePlanRequest {
+    /**
+     * ID of the Plan to finalize. Its project_id and selected_template_id (set at creation)
+     * are used to drive generation.
+     * @format GUID
+     */
+    planId: string;
+    /**
+     * ID of the conversation that led to this plan being finalized.
+     * @format GUID
+     */
+    conversationId: string;
+}
+interface FinalizePlanResponse {
+    /** The finalized Plan. */
+    plan?: Plan;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+interface UpdatePlan {
+    /**
+     * Plan ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the Plan is updated.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Plan was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Plan was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * The user's initial free-text prompt that started the plan.
+     * @maxLength 10000
+     */
+    initialPrompt?: string;
+    /** Generation platform for the app. */
+    platform?: PlatformWithLiterals;
+    /** Lifecycle status of the Plan. */
+    status?: PlanStatusWithLiterals;
+    /**
+     * Template chosen for generation. A Code Store `containers-templates` catalog GUID, or (for
+     * HIMALAYA_MOBILE) a himi starter template name (e.g. "branded-lite") that does not resolve to
+     * a catalog entry — see `PlansService.resolveTemplate`/`validateTemplatePlatform`, which treat a
+     * non-GUID value as an opaque template name rather than a catalog reference.
+     * @maxLength 200
+     */
+    selectedTemplateId?: string | null;
+    /**
+     * The project this plan belongs to. Supplied by the client at creation.
+     * @format GUID
+     */
+    projectId?: string | null;
+    /**
+     * Facts extracted from the existing business/site. Derived server-side and read-only to clients.
+     * @readonly
+     */
+    businessContext?: BusinessContext;
+    /** Visual identity extracted from the user's website. A starting point the user can edit. */
+    brandIdentity?: BrandIdentity;
+    /** The specification of the app to generate, produced from the plan prompt. */
+    appSpec?: AppSpec;
+}
+interface ModifyPlanOptions {
+    /**
+     * The user's answers to the previous iteration's follow-up questions.
+     * @maxSize 50
+     */
+    answeredQuestions?: AnsweredQuestion[];
+    /**
+     * Optional additional request from the user to further shape the plan.
+     * @maxLength 10000
+     */
+    userPrompt?: string | null;
+    /**
+     * Optional selected plan part. When present, only this boundary may change.
+     * When absent, ModifyPlan keeps its existing whole-plan behavior.
+     */
+    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 };