@wix/auto_sdk_containers_plans 1.0.0

package/build/internal/cjs/index.d.ts

@@ -0,0 +1,132 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { Plan, CreateAndGeneratePlanResponse, GetPlanByProjectIdResponse, UpdatePlan, GeneratePlanResponse, ModifyPlanOptions, ModifyPlanResponse, RegenerateIconResponse, FinalizePlanResponse } from './index.typings.js';
+export { AccountInfo, ActionEvent, AnsweredQuestion, AppSpec, BrandIdentity, BusinessContext, CreateAndGeneratePlanRequest, CreatePlanRequest, CreatePlanResponse, DeletePlanRequest, DeletePlanResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Feature, FinalizePlanRequest, FollowUpQuestion, GeneratePlanRequest, GetPlanByProjectIdRequest, GetPlanRequest, GetPlanResponse, IdentificationData, IdentificationDataIdOneOf, Integration, MessageEnvelope, ModifyPlanRequest, PlanEditContext, PlanFinalized, PlanPartType, PlanPartTypeWithLiterals, PlanStatus, PlanStatusWithLiterals, Platform, PlatformWithLiterals, RegenerateIconRequest, RestoreInfo, UpdatePlanRequest, UpdatePlanResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
+
+/** @internal */
+declare function createPlan$1(httpClient: HttpClient): CreatePlanSignature;
+interface CreatePlanSignature {
+    /**
+     * Creates a new Plan.
+     * @param - Plan to be created.
+     * @returns The created Plan.
+     */
+    (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>>;
+}
+/** @internal */
+declare function createAndGeneratePlan$1(httpClient: HttpClient): CreateAndGeneratePlanSignature;
+interface CreateAndGeneratePlanSignature {
+    /**
+     * Creates a new Plan and immediately generates it using the planning agent.
+     * @param - Plan to be created and generated.
+     */
+    (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>>;
+}
+/** @internal */
+declare function getPlan$1(httpClient: HttpClient): GetPlanSignature;
+interface GetPlanSignature {
+    /**
+     * Retrieves a Plan by its ID.
+     * @param - ID of the Plan to retrieve.
+     * @returns The requested Plan.
+     */
+    (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>>;
+}
+/** @internal */
+declare function getPlanByProjectId$1(httpClient: HttpClient): GetPlanByProjectIdSignature;
+interface GetPlanByProjectIdSignature {
+    /**
+     * 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.
+     * @param - ID of the project whose Plan to retrieve.
+     */
+    (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>>;
+}
+/** @internal */
+declare function updatePlan$1(httpClient: HttpClient): UpdatePlanSignature;
+interface UpdatePlanSignature {
+    /**
+     * Updates a Plan. The current revision must be passed for optimistic locking.
+     * @param - Plan ID.
+     * @returns The updated Plan.
+     */
+    (_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>>;
+}
+/** @internal */
+declare function deletePlan$1(httpClient: HttpClient): DeletePlanSignature;
+interface DeletePlanSignature {
+    /**
+     * Deletes a Plan.
+     * @param - ID of the Plan to delete.
+     */
+    (planId: string): Promise<void>;
+}
+/** @internal */
+declare function generatePlan$1(httpClient: HttpClient): GeneratePlanSignature;
+interface GeneratePlanSignature {
+    /**
+     * Generates the plan for an already-created Plan using the planning agent, from the plan's
+     * extracted business context + brand identity, the initial prompt, the platform, and the
+     * selected template. Populates app_spec (and brand_identity) and returns follow-up questions.
+     * @param - ID of the Plan to generate.
+     */
+    (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>>;
+}
+/** @internal */
+declare function modifyPlan$1(httpClient: HttpClient): ModifyPlanSignature;
+interface ModifyPlanSignature {
+    /**
+     * 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
+     * any new follow-up questions.
+     * @param - ID of the Plan to modify.
+     */
+    (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>>;
+}
+/** @internal */
+declare function regenerateIcon$1(httpClient: HttpClient): RegenerateIconSignature;
+interface RegenerateIconSignature {
+    /**
+     * Generates a candidate icon for a Plan from user-provided text via PromptHub. The current
+     * business_context (including any existing icon, sent as a reference image) is resolved
+     * server-side; the caller supplies only the prompt. Does not persist the result — the caller
+     * saves an accepted icon with UpdatePlan (app_spec.app_icon_url).
+     * @param - ID of the Plan whose icon to regenerate.
+     * @param - Free-text description of the desired icon, passed to the icon-generation prompt.
+     */
+    (planId: string, prompt: string): Promise<NonNullablePaths<RegenerateIconResponse, `iconUrl`, 0>>;
+}
+/** @internal */
+declare function finalizePlan$1(httpClient: HttpClient): FinalizePlanSignature;
+interface FinalizePlanSignature {
+    /**
+     * Finalizes a Plan for generation, transitioning it to FINALIZED and emitting a PlanFinalized
+     * action event that drives the linked Project into BUILDING.
+     * @param - ID of the Plan to finalize. Its project_id and selected_template_id (set at creation)
+     * are used to drive generation.
+     * @param - ID of the conversation that led to this plan being finalized.
+     */
+    (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>>;
+}
+
+/** @internal */
+declare const createPlan: MaybeContext<BuildRESTFunction<typeof createPlan$1> & typeof createPlan$1>;
+/** @internal */
+declare const createAndGeneratePlan: MaybeContext<BuildRESTFunction<typeof createAndGeneratePlan$1> & typeof createAndGeneratePlan$1>;
+/** @internal */
+declare const getPlan: MaybeContext<BuildRESTFunction<typeof getPlan$1> & typeof getPlan$1>;
+/** @internal */
+declare const getPlanByProjectId: MaybeContext<BuildRESTFunction<typeof getPlanByProjectId$1> & typeof getPlanByProjectId$1>;
+/** @internal */
+declare const updatePlan: MaybeContext<BuildRESTFunction<typeof updatePlan$1> & typeof updatePlan$1>;
+/** @internal */
+declare const deletePlan: MaybeContext<BuildRESTFunction<typeof deletePlan$1> & typeof deletePlan$1>;
+/** @internal */
+declare const generatePlan: MaybeContext<BuildRESTFunction<typeof generatePlan$1> & typeof generatePlan$1>;
+/** @internal */
+declare const modifyPlan: MaybeContext<BuildRESTFunction<typeof modifyPlan$1> & typeof modifyPlan$1>;
+/** @internal */
+declare const regenerateIcon: MaybeContext<BuildRESTFunction<typeof regenerateIcon$1> & typeof regenerateIcon$1>;
+/** @internal */
+declare const finalizePlan: MaybeContext<BuildRESTFunction<typeof finalizePlan$1> & typeof finalizePlan$1>;
+
+export { CreateAndGeneratePlanResponse, FinalizePlanResponse, GeneratePlanResponse, GetPlanByProjectIdResponse, ModifyPlanOptions, ModifyPlanResponse, Plan, RegenerateIconResponse, UpdatePlan, createAndGeneratePlan, createPlan, deletePlan, finalizePlan, generatePlan, getPlan, getPlanByProjectId, modifyPlan, regenerateIcon, updatePlan };