@wix/auto_sdk_containers_projects 1.0.0

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

@@ -0,0 +1,129 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { Project, UpdateProject, ResumeProjectResponse, RegenerateProjectNameResponse, RegenerateProjectIconResponse, SaveProjectDesignOptions, SaveProjectDesignResponse, ListProjectsOptions, ListProjectsResponse } from './index.typings.mjs';
+export { AccountInfo, ActionEvent, CreateAgentSessionRequest, CreateAgentSessionResponse, CreateProjectRequest, CreateProjectResponse, CursorPaging, CursorPagingMetadata, Cursors, DeleteProjectRequest, DeleteProjectResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GetProjectRequest, GetProjectResponse, IdentificationData, IdentificationDataIdOneOf, ListProjectsForCurrentUserRequest, ListProjectsForCurrentUserResponse, ListProjectsRequest, MessageEnvelope, Platform, PlatformWithLiterals, ProjectPlanReady, ProjectResumeRequested, ProjectStartRequested, ProjectStatus, ProjectStatusWithLiterals, RefreshAgentSiteTokenRequest, RefreshAgentSiteTokenResponse, RegenerateProjectIconRequest, RegenerateProjectNameRequest, RestoreInfo, ResumeProjectRequest, SandboxStatus, SandboxStatusWithLiterals, SaveProjectDesignRequest, StartProjectRequest, StartProjectResponse, UpdateProjectRequest, UpdateProjectResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
+
+/** @internal */
+declare function createProject$1(httpClient: HttpClient): CreateProjectSignature;
+interface CreateProjectSignature {
+    /**
+     * Creates a new Project from a template.
+     * Looks up the template to find its backing source code, creates a dev-center app,
+     * registers an AppProject, clones the template's git repository into a new
+     * code-store project, and persists the Project.
+     * @param - Project to be created.
+     * @returns The created Project.
+     */
+    (project: NonNullablePaths<Project, `platform` | `templateId`, 0>): Promise<NonNullablePaths<Project, `name` | `status` | `sandboxStatus` | `metaSiteIds` | `platform`, 0>>;
+}
+/** @internal */
+declare function getProject$1(httpClient: HttpClient): GetProjectSignature;
+interface GetProjectSignature {
+    /**
+     * Retrieves a Project by ID.
+     * @param - ID of the Project to retrieve.
+     * @returns The requested Project.
+     */
+    (projectId: string): Promise<NonNullablePaths<Project, `name` | `status` | `sandboxStatus` | `metaSiteIds` | `platform`, 0>>;
+}
+/** @internal */
+declare function updateProject$1(httpClient: HttpClient): UpdateProjectSignature;
+interface UpdateProjectSignature {
+    /**
+     * Updates an existing Project.
+     * @param - Project ID.
+     * @returns Updated Project.
+     */
+    (_id: string, project: NonNullablePaths<UpdateProject, `revision`, 0>): Promise<NonNullablePaths<Project, `name` | `status` | `sandboxStatus` | `metaSiteIds` | `platform`, 0>>;
+}
+/** @internal */
+declare function deleteProject$1(httpClient: HttpClient): DeleteProjectSignature;
+interface DeleteProjectSignature {
+    /**
+     * Deletes a Project.
+     * @param - Id of the Project to delete.
+     */
+    (projectId: string): Promise<void>;
+}
+/** @internal */
+declare function resumeProject$1(httpClient: HttpClient): ResumeProjectSignature;
+interface ResumeProjectSignature {
+    /**
+     * Requests Project resume by starting or reusing its configured remote machine asynchronously.
+     * @param - ID of the Project to resume.
+     */
+    (projectId: string): Promise<NonNullablePaths<ResumeProjectResponse, `project.name` | `project.status` | `project.sandboxStatus` | `project.metaSiteIds` | `project.platform`, 1>>;
+}
+/** @internal */
+declare function regenerateProjectName$1(httpClient: HttpClient): RegenerateProjectNameSignature;
+interface RegenerateProjectNameSignature {
+    /**
+     * Generates a candidate display name for a Project from a user instruction, via the published
+     * "Regenerate app name" Prompt Hub prompt. The current name and the project's description are
+     * resolved server-side; the caller supplies only the instruction. Does not persist the result —
+     * the caller saves an accepted name with UpdateProject.
+     * @param - ID of the Project to generate a new name for.
+     * @param - The user's free-text renaming instruction, passed to the name-generation prompt.
+     */
+    (projectId: string, prompt: string): Promise<NonNullablePaths<RegenerateProjectNameResponse, `name`, 0>>;
+}
+/** @internal */
+declare function regenerateProjectIcon$1(httpClient: HttpClient): RegenerateProjectIconSignature;
+interface RegenerateProjectIconSignature {
+    /**
+     * Generates a candidate icon for a Project from a user instruction. The current project name,
+     * icon, app description, and brand colors are resolved server-side. Does not persist the result —
+     * the caller saves an accepted icon with UpdateProject.
+     * @param - ID of the Project to generate a new icon for.
+     * @param - The user's free-text icon instruction, passed to the icon-generation prompt.
+     */
+    (projectId: string, prompt: string): Promise<NonNullablePaths<RegenerateProjectIconResponse, `iconUrl`, 0>>;
+}
+/** @internal */
+declare function saveProjectDesign$1(httpClient: HttpClient): SaveProjectDesignSignature;
+interface SaveProjectDesignSignature {
+    /**
+     * Persists a complete design-token document as a new Himalaya draft release, branched from the
+     * release the client currently has displayed.
+     *
+     * Synchronous: the Himalaya write completes before this call returns. Never touches the project's
+     * sandbox, runs a build, or activates the app — the saved release stays a draft, so what the live
+     * app serves is unaffected. Persists nothing on our side: this creates no entity and posts no
+     * chat checkpoint.
+     * @param - Project whose design is being saved. The caller must own it.
+     * @param - The Himalaya release ID currently displayed by the client. The saved draft branches from
+     * exactly this release, even when a newer release exists for the app.
+     */
+    (projectId: string, baseReleaseId: string, options: NonNullablePaths<SaveProjectDesignOptions, `himalayaControlToken` | `tokensJson`, 0>): Promise<NonNullablePaths<SaveProjectDesignResponse, `himalayaReleaseId` | `previewToken`, 0>>;
+}
+/** @internal */
+declare function listProjects$1(httpClient: HttpClient): ListProjectsSignature;
+interface ListProjectsSignature {
+    /**
+     * Lists the Projects of the current site — the MetaSite in the call scope — regardless of who owns
+     * them. Anyone with access to the site sees the site's projects; other sites in the same account are
+     * separate tenants and never appear here. The dashboard uses this; ListProjectsForCurrentUser stays
+     * owner-scoped for callers that still depend on it.
+     */
+    (options?: ListProjectsOptions): Promise<NonNullablePaths<ListProjectsResponse, `projects` | `projects.${number}.name` | `projects.${number}.status` | `projects.${number}.sandboxStatus` | `projects.${number}.platform`, 2>>;
+}
+
+/** @internal */
+declare const createProject: MaybeContext<BuildRESTFunction<typeof createProject$1> & typeof createProject$1>;
+/** @internal */
+declare const getProject: MaybeContext<BuildRESTFunction<typeof getProject$1> & typeof getProject$1>;
+/** @internal */
+declare const updateProject: MaybeContext<BuildRESTFunction<typeof updateProject$1> & typeof updateProject$1>;
+/** @internal */
+declare const deleteProject: MaybeContext<BuildRESTFunction<typeof deleteProject$1> & typeof deleteProject$1>;
+/** @internal */
+declare const resumeProject: MaybeContext<BuildRESTFunction<typeof resumeProject$1> & typeof resumeProject$1>;
+/** @internal */
+declare const regenerateProjectName: MaybeContext<BuildRESTFunction<typeof regenerateProjectName$1> & typeof regenerateProjectName$1>;
+/** @internal */
+declare const regenerateProjectIcon: MaybeContext<BuildRESTFunction<typeof regenerateProjectIcon$1> & typeof regenerateProjectIcon$1>;
+/** @internal */
+declare const saveProjectDesign: MaybeContext<BuildRESTFunction<typeof saveProjectDesign$1> & typeof saveProjectDesign$1>;
+/** @internal */
+declare const listProjects: MaybeContext<BuildRESTFunction<typeof listProjects$1> & typeof listProjects$1>;
+
+export { ListProjectsOptions, ListProjectsResponse, Project, RegenerateProjectIconResponse, RegenerateProjectNameResponse, ResumeProjectResponse, SaveProjectDesignOptions, SaveProjectDesignResponse, UpdateProject, createProject, deleteProject, getProject, listProjects, regenerateProjectIcon, regenerateProjectName, resumeProject, saveProjectDesign, updateProject };