@wix/auto_sdk_containers_projects 1.0.5 → 1.0.7

package/build/cjs/meta.d.ts

@@ -1,6 +1,11 @@
 import { CreateProjectRequest as CreateProjectRequest$1, CreateProjectResponse as CreateProjectResponse$1, GetProjectRequest as GetProjectRequest$1, GetProjectResponse as GetProjectResponse$1, UpdateProjectRequest as UpdateProjectRequest$1, UpdateProjectResponse as UpdateProjectResponse$1, DeleteProjectRequest as DeleteProjectRequest$1, DeleteProjectResponse as DeleteProjectResponse$1, ResumeProjectRequest as ResumeProjectRequest$1, ResumeProjectResponse as ResumeProjectResponse$1, RegenerateProjectNameRequest as RegenerateProjectNameRequest$1, RegenerateProjectNameResponse as RegenerateProjectNameResponse$1, RegenerateProjectIconRequest as RegenerateProjectIconRequest$1, RegenerateProjectIconResponse as RegenerateProjectIconResponse$1, SaveProjectDesignRequest as SaveProjectDesignRequest$1, SaveProjectDesignResponse as SaveProjectDesignResponse$1, RestoreReleaseRequest as RestoreReleaseRequest$1, RestoreReleaseResponse as RestoreReleaseResponse$1, ListProjectsRequest as ListProjectsRequest$1, ListProjectsResponse as ListProjectsResponse$1, GetHimalayaAuthorizationRequest as GetHimalayaAuthorizationRequest$1, GetHimalayaAuthorizationResponse as GetHimalayaAuthorizationResponse$1 } from './index.typings.js';
 import '@wix/sdk-types';
 
+/**
+ * A project represents an app that a user builds with the Wix AI coding agent.
+ * A project belongs to the Wix site it's created on. The user's chat with the coding agent about a
+ * project is held in [conversations](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-chat/introduction).
+ */
 interface Project {
     /**
      * Project ID.
@@ -9,137 +14,144 @@ interface Project {
      */
     id?: string | null;
     /**
-     * Display name for the project.
+     * Project name, shown to the user.
      * @maxLength 200
      */
     name?: string;
-    /** Current status of the project. */
+    /** Project status. */
     status?: ProjectStatusWithLiterals;
     /**
-     * ID of the template used to create this project.
+     * ID of the template that the project was created from.
      * @format GUID
      * @immutable
      */
     templateId?: string | null;
     /**
-     * ID of the git-code-store project (and backing dev-center app) for this project. Set on creation.
+     * ID of the project's source code project. Set automatically when the project is created.
      * @format GUID
      * @readonly
      */
     codeStoreProjectId?: string | null;
     /**
-     * The user id of the owner of this project
+     * ID of the user who created the project.
      * @format GUID
      * @readonly
      */
     ownerUserId?: string | null;
     /**
-     * Revision number, which increments by 1 each time the Project is updated.
+     * Revision number, which increments by 1 each time the project is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the project.
+     *
+     * Ignored when creating a project.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Date and time the Project was created.
+     * Date and time the project was created.
      * @readonly
      */
     createdDate?: Date | null;
     /**
-     * Date and time the Project was last updated.
+     * Date and time the project was last updated.
      * @readonly
      */
     updatedDate?: Date | null;
     /**
-     * Transient lock marking that a sandbox is currently being created for this project.
-     * Used to serialize concurrent dev-machine creation; liveness of the sandbox itself is resolved via ListSandboxes.
+     * Whether a remote development environment is being created for the project.
      * @readonly
      */
     sandboxStatus?: SandboxStatusWithLiterals;
     /**
-     * Meta site IDs (MSIDs) of the Wix sites this project is related to.
-     * Optional — a project is not required to be tied to a site; may relate to many sites.
-     * Preserve the deployed input contract; see containers-projects/SDK_COMPATIBILITY.md.
+     * IDs of the Wix sites that the project relates to.
+     *
+     * A project can relate to any number of sites, including none.
      * @format GUID
      */
     metaSiteIds?: string[];
     /**
-     * Platform this project targets (iOS/Android). Supplied by the client at creation; immutable after.
+     * Platform that the project's app targets. Set when the project is created and can't be changed.
      * @immutable
      */
     platform?: PlatformWithLiterals;
     /**
-     * Optional app icon URL supplied by the client from Wix Media Manager.
+     * URL of the app's icon.
      * @maxLength 2000
      */
     appIconUrl?: string | null;
     /**
-     * The Himalaya release the editor is currently on — the "head" the client previews and the next
-     * edit (design save or AI edit) branches from. Server-managed: set to the new draft after each
-     * edit, and to the chosen release by RestoreRelease. Unset means "newest release by date" (the
-     * pre-head default), so existing projects keep working until their first edit/restore sets it.
-     * Not a GUID — a Himalaya release id (e.g. `rel-<hash>` / `<sha>-<hash>`).
+     * ID of the release that the project is currently on.
+     *
+     * Your app previews this release, and the next design save or edit by the coding agent branches
+     * from it. Set automatically after each design save or edit, and by
+     * [Restore Release](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/restore-release).
+     * When empty, the project is on its newest release.
      * @maxLength 200
      * @readonly
      */
     headReleaseId?: string | null;
 }
+/**
+ * Project status. The status changes in one direction only: `PLANNING`, then `PLAN_READY`, then
+ * `BUILDING`.
+ */
 declare enum ProjectStatus {
-    /** Project created; client (via containers-plans) is doing most of the work. */
+    /** The user and the coding agent are planning the app. New projects start with this status. */
     PLANNING = "PLANNING",
-    /** Generation job created; project moves onward to machine startup. */
+    /** The coding agent is building the app, or has built it. The user can continue to request changes. */
     BUILDING = "BUILDING",
-    /** Plan finalized; project is about to create the initial generation job. */
+    /** The plan is finalized, and the first build of the app is about to start. */
     PLAN_READY = "PLAN_READY"
 }
 /** @enumType */
 type ProjectStatusWithLiterals = ProjectStatus | 'PLANNING' | 'BUILDING' | 'PLAN_READY';
 declare enum SandboxStatus {
-    /** No sandbox creation in progress. */
+    /** No remote development environment is being created. */
     NONE = "NONE",
-    /** A caller is currently creating a sandbox for this project (creation lock held). */
+    /** A remote development environment is being created. */
     CREATING = "CREATING"
 }
 /** @enumType */
 type SandboxStatusWithLiterals = SandboxStatus | 'NONE' | 'CREATING';
 declare enum Platform {
+    /** Native iOS app. Used by older projects. */
     IOS = "IOS",
+    /** Native Android app. Used by older projects. */
     ANDROID = "ANDROID",
     /**
-     * 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.
+     * Mobile app built from content that's updated over the air, instead of native iOS or Android
+     * code. Most new projects use this platform.
      */
     HIMALAYA_MOBILE = "HIMALAYA_MOBILE"
 }
 /** @enumType */
 type PlatformWithLiterals = Platform | 'IOS' | 'ANDROID' | 'HIMALAYA_MOBILE';
+/** Details of a request to start a project's remote development environment. */
 interface ProjectStartRequested {
     /**
-     * ID of the Project to start.
+     * ID of the project to start.
      * @format GUID
      */
     projectId?: string;
 }
+/** Details of a request to resume a project. */
 interface ProjectResumeRequested {
     /**
-     * ID of the Project to resume.
+     * ID of the project to resume.
      * @format GUID
      */
     projectId?: string;
 }
-/**
- * Emitted when the project transitions PLANNING -> PLAN_READY (on plan finalization). The project
- * self-consumes this event to start the app generation: mint the agent session, attach it to the
- * finalized conversation, create the initial generation job, and move to BUILDING. The finalized
- * plan is read back from containers-plans by project id when the job is built.
- */
+/** Details of a project whose plan is finalized. */
 interface ProjectPlanReady {
     /**
-     * ID of the Project whose plan is ready.
+     * ID of the project whose plan is finalized.
      * @format GUID
      */
     projectId?: string;
     /**
-     * ID of the conversation that led to this plan being finalized. The minted agent session id is
-     * attached to this conversation so the build can --resume it. Propagated from PlanFinalized.
+     * ID of the conversation in which the plan was finalized. The coding agent continues the build in
+     * this conversation.
      * @format GUID
      */
     conversationId?: string;
@@ -360,35 +372,35 @@ interface AccountInfo {
     siteId?: string | null;
 }
 interface CreateProjectRequest {
-    /** Project to be created. */
+    /** Project to create. */
     project: Project;
 }
 interface CreateProjectResponse {
-    /** The created Project. */
+    /** Created project. */
     project?: Project;
 }
 interface GetProjectRequest {
     /**
-     * ID of the Project to retrieve.
+     * ID of the project to retrieve.
      * @format GUID
      */
     projectId: string;
 }
 interface GetProjectResponse {
-    /** The requested Project. */
+    /** Retrieved project. */
     project?: Project;
 }
 interface UpdateProjectRequest {
-    /** Project to be updated, may be partial. */
+    /** Project to update. */
     project: Project;
 }
 interface UpdateProjectResponse {
-    /** Updated Project. */
+    /** Updated project. */
     project?: Project;
 }
 interface DeleteProjectRequest {
     /**
-     * Id of the Project to delete.
+     * ID of the project to delete.
      * @format GUID
      */
     projectId: string;
@@ -397,60 +409,60 @@ interface DeleteProjectResponse {
 }
 interface StartProjectRequest {
     /**
-     * ID of the Project to start.
+     * ID of the project to start.
      * @format GUID
      */
     projectId?: string;
 }
 interface StartProjectResponse {
-    /** The Project for which start was requested. */
+    /** Project whose environment is starting. */
     project?: Project;
 }
 interface ResumeProjectRequest {
     /**
-     * ID of the Project to resume.
+     * ID of the project to resume.
      * @format GUID
      */
     projectId: string;
 }
 interface ResumeProjectResponse {
-    /** The Project for which resume was requested. */
+    /** Resumed project. The project is returned unchanged; its environment starts in the background. */
     project?: Project;
 }
 interface RegenerateProjectNameRequest {
     /**
-     * ID of the Project to generate a new name for.
+     * ID of the project to generate a name for.
      * @format GUID
      */
     projectId: string;
     /**
-     * The user's free-text renaming instruction, passed to the name-generation prompt.
+     * User's instruction for the new name. For example, `Make it shorter and more playful`.
      * @maxLength 4000
      */
     prompt: string;
 }
 interface RegenerateProjectNameResponse {
     /**
-     * The generated display name, at most 30 characters. Not persisted.
+     * Suggested project name. Not saved.
      * @maxLength 30
      */
     name?: string;
 }
 interface RegenerateProjectIconRequest {
     /**
-     * ID of the Project to generate a new icon for.
+     * ID of the project to generate an icon for.
      * @format GUID
      */
     projectId: string;
     /**
-     * The user's free-text icon instruction, passed to the icon-generation prompt.
+     * User's instruction for the new icon. For example, `Use a minimal coffee cup`.
      * @maxLength 4000
      */
     prompt: string;
 }
 interface RegenerateProjectIconResponse {
     /**
-     * The generated icon URL. Not persisted.
+     * URL of the suggested icon. Not saved.
      * @format WEB_URL
      */
     iconUrl?: string;
@@ -475,9 +487,9 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface ListProjectsForCurrentUserResponse {
-    /** Projects owned by the current user. */
+    /** Projects that the current user owns. */
     projects?: Project[];
-    /** Paging metadata for cursor-based pagination. */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -507,101 +519,94 @@ interface Cursors {
 }
 interface SaveProjectDesignRequest {
     /**
-     * Project whose design is being saved. The caller must own it.
+     * ID of the project whose design to save.
      * @format GUID
      */
     projectId: string;
     /**
-     * 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.
+     * ID of the release that the user is currently viewing.
+     *
+     * The new draft release branches from this release, even if a newer release exists.
      * @maxLength 100
      */
     baseReleaseId: string;
     /**
-     * The complete edited design-token document, as a JSON object string — not a flattened set of
-     * preview overrides. The caller is responsible for preserving unknown groups and light/dark
-     * values it did not change.
+     * Complete design-token document, as a string that contains a single JSON object.
+     *
+     * Specify the whole document, not only the values that changed. Keep any token groups and light or
+     * dark mode values that you didn't change.
      * @maxLength 65536
      */
     tokensJson: string;
     /**
-     * Short-lived, app-scoped Himalaya control credential the client obtained from Himalaya's owner
-     * embed-token endpoint. Forwarded to Himalaya for this call only — never logged, persisted, or
-     * echoed back in any response, error, or event.
+     * Short-lived control credential for the project's app releases.
      *
-     * The app this call writes to is NOT taken from this request. It is composed from the owner
-     * prefix this credential carries plus project_id; see HimalayaAppSlug.
+     * Used for this call only. It isn't stored or returned.
      * @maxLength 4096
      */
     himalayaControlToken: string;
     /**
-     * Client assertion of the canonical app returned by authenticated Himalaya lookup. Catalyst
-     * resolves and validates the same value; it is never used as an unchecked write target.
+     * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
+     * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
+     * This isn't the app's ID.
+     *
+     * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
      * @maxLength 200
      */
     canonicalApp?: string;
     /**
-     * Conversation this design is saved from. When set, a CHECKPOINT message marking the saved
-     * version is posted into it (best-effort). Optional — an older client that omits it still saves
-     * the design; it just produces no checkpoint. Verified to belong to this project server-side.
+     * ID of the [conversation](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-chat/introduction) that the design is saved from.
      *
-     * Deliberately NOT (.wix.api.format) = GUID: posting the checkpoint is best-effort and must never
-     * fail the save. A malformed/unexpected id is handled downstream (the ownership lookup rejects it
-     * and the checkpoint is skipped) rather than hard-failing SaveProjectDesign at the request boundary.
+     * When specified, a `CHECKPOINT` message that marks the saved version is added to the conversation.
+     * The conversation must belong to the project.
      * @maxLength 100
      */
     conversationId?: string;
 }
 interface SaveProjectDesignResponse {
     /**
-     * The saved draft release. Always a draft, so the app's live release is untouched.
+     * ID of the saved draft release.
      * @maxLength 100
      */
     himalayaReleaseId?: string;
     /**
-     * Short-lived credential for previewing the saved draft release. Response-only: never persisted
-     * or placed in a preview URL by this service.
+     * Short-lived token for previewing the saved draft release.
      * @maxLength 4096
      */
     previewToken?: string;
-    /** When preview_token expires. */
+    /** Date and time the preview token expires. */
     previewTokenExpiresAt?: Date | null;
 }
 interface RestoreReleaseRequest {
     /**
-     * Project whose head is being moved. The caller must own it.
+     * ID of the project to restore a release for.
      * @format GUID
      */
     projectId: string;
     /**
-     * The Himalaya release to make the project's editable head. Not a GUID — a Himalaya release id
-     * (e.g. `rel-<hash>` / `<sha>-<hash>`), taken from the project's own release ledger.
+     * ID of the release to restore. For example, `rel-4f9c2a1b7d3e`.
      * @maxLength 200
      */
     releaseId: string;
     /**
-     * Short-lived, app-scoped Himalaya control credential (the same the client obtains from Himalaya's
-     * owner embed-token endpoint and sends on SaveProjectDesign). When present, the server verifies
-     * release_id belongs to this project's Himalaya app before moving head. Optional for back-compat:
-     * an older client that omits it skips that check (the release still comes from the project's own
-     * ledger). Forwarded to Himalaya for the ledger read only — never logged, persisted, or echoed.
+     * Short-lived control credential for the project's app releases.
+     *
+     * When specified, the release is checked to belong to the project before it's restored. Used for
+     * this call only. It isn't stored or returned.
      * @maxLength 4096
      */
     himalayaControlToken?: string;
     /**
-     * Conversation this restore is made from. When set, a CHECKPOINT message marking the restored
-     * version is posted into it (best-effort). Optional — a client that omits it still restores; it
-     * just produces no checkpoint. Verified to belong to this project server-side.
+     * ID of the [conversation](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-chat/introduction) that the release is restored from.
      *
-     * Deliberately NOT (.wix.api.format) = GUID: posting the checkpoint is best-effort and must never
-     * fail the restore. A malformed id is handled downstream (the ownership lookup rejects it and the
-     * checkpoint is skipped) rather than hard-failing RestoreRelease at the request boundary.
+     * When specified, a `CHECKPOINT` message that marks the restored version is added to the
+     * conversation. The conversation must belong to the project.
      * @maxLength 100
      */
     conversationId?: string;
 }
 interface RestoreReleaseResponse {
-    /** The project after the restore, with head_release_id set to the restored release. */
+    /** Updated project. `headReleaseId` is set to the restored release. */
     project?: Project;
 }
 interface ListProjectsRequest {
@@ -609,39 +614,42 @@ interface ListProjectsRequest {
     paging?: CursorPaging;
 }
 interface ListProjectsResponse {
-    /** Projects in the current site. */
+    /** Projects of the current site. */
     projects?: Project[];
-    /** Paging metadata for cursor-based pagination. */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface GetHimalayaAuthorizationRequest {
     /**
-     * Site-tenanted Containers project being authorized.
+     * ID of the project to check.
      * @format GUID
      */
     projectId: string;
 }
 interface GetHimalayaAuthorizationResponse {
-    /** Version of the authorization capability contract. */
+    /** Version of the response format. Currently always `1`. */
     authorizationVersion?: number;
     /**
-     * Trusted MetaSite selected from request identity context.
+     * ID of the Wix site that the check was made for.
      * @format GUID
      */
     metaSiteId?: string;
     /**
-     * Site-tenanted Containers project authorized by the lookup.
+     * Project ID.
      * @format GUID
      */
     projectId?: string;
     /**
-     * Verified canonical Himalaya app slug.
+     * Canonical slug of the project's app.
+     *
+     * Specify this value in `canonicalApp` when you call
+     * [Save Project Design](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/save-project-design).
      * @maxLength 200
      */
     canonicalApp?: string;
-    /** Whether a fresh worker launch is currently authorized. */
+    /** Whether the current user can start new work by the coding agent on the project. */
     workerLaunch?: boolean;
-    /** Whether a fresh design save is currently authorized. */
+    /** Whether the current user can save the project's design. */
     saveDesign?: boolean;
 }
 

package/build/cjs/meta.js

@@ -62,6 +62,12 @@ function resolveWixContainersProjectsV1ContainersProjectsUrl(opts) {
         srcPath: "/_api/containers-projects",
         destPath: ""
       }
+    ],
+    "www.wixapis.com": [
+      {
+        srcPath: "/containers/projects",
+        destPath: ""
+      }
     ]
   };
   return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));