@wix/auto_sdk_containers_projects 1.0.22 → 1.0.23

package/build/cjs/index.d.ts

@@ -43,9 +43,12 @@ interface SaveProjectDesignSignature {
      * A `CHECKPOINT` message is then added to the conversation. If the checkpoint can't be added, the
      * design is still saved.
      *
-     * For projects whose `platform` is `HIMALAYA_MOBILE`, call
+     * For a new `HIMALAYA_MOBILE` project, call
+     * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
+     * and specify its returned `canonicalApp` when saving the design. For an already claimed project,
+     * call
      * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
-     * first, and specify the returned `canonicalApp`.
+     * and specify the returned `canonicalApp`.
      * @param - ID of the project whose design to save.
      * @param - ID of the release that the user is currently viewing.
      *
@@ -97,9 +100,14 @@ interface StartMobileBuildSignature {
      * [Get Latest Mobile Builds](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-latest-mobile-builds)
      * with `himalayaControlToken`.
      *
-     * For projects whose `platform` is `HIMALAYA_MOBILE`, call
+     * For a new `HIMALAYA_MOBILE` project, call
+     * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
+     * before starting a build. For an existing project, call
      * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
-     * first, and specify the returned `canonicalApp`.
+     * and specify the returned `canonicalApp`.
+     *
+     * If a build can't start for a platform, the response lists that platform in
+     * `failedPlatforms` while returning any builds that did start in `builds`.
      * @param - ID of the project to build.
      * @param - Platforms to build. One build is started for each platform.
      */
@@ -125,18 +133,11 @@ interface GetLatestMobileBuildsSignature {
 declare function claimHimalayaApp$1(httpClient: HttpClient): ClaimHimalayaAppSignature;
 interface ClaimHimalayaAppSignature {
     /**
-     * Claims the canonical Himalaya app for a NEW site-tenanted project, or returns the one already
-     * bound to it.
-     *
-     * This exists so the BROWSER never asserts the (MetaSite, project) pair to Himalaya. Containers
-     * is the authority on project -> MetaSite: it reads the project from its own store with a
-     * consistent read and takes the MetaSite from this call's identity context, then claims
-     * server-to-server with a site USER token minted for the initiating collaborator. Himalaya
-     * recognises that token as minted by THIS service and trusts the pair on that basis. A dashboard
-     * calling Himalaya directly could name another site's project UUID and reserve its global slug.
-     *
-     * Idempotent per pair: an already-claimed project returns its existing canonical app.
-     * @param - Site-tenanted Containers project to claim a Himalaya app for.
+     * Claims the app associated with a project, or retrieves its existing claim.
+     *
+     * An authorized site collaborator can call this method for a new `HIMALAYA_MOBILE` project
+     * before using its app. Repeating the call for the same project returns the same `canonicalApp`.
+     * @param - ID of the site project whose app to claim or retrieve.
      */
     (projectId: string): Promise<NonNullablePaths<ClaimHimalayaAppResponse, `authorizationVersion` | `metaSiteId` | `projectId` | `canonicalApp`, 0>>;
 }