@wix/auto_sdk_containers_projects 1.0.22 → 1.0.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -103,9 +103,12 @@ interface SaveProjectDesignSignature {
103
103
  * A `CHECKPOINT` message is then added to the conversation. If the checkpoint can't be added, the
104
104
  * design is still saved.
105
105
  *
106
- * For projects whose `platform` is `HIMALAYA_MOBILE`, call
106
+ * For a new `HIMALAYA_MOBILE` project, call
107
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
108
+ * and specify its returned `canonicalApp` when saving the design. For an already claimed project,
109
+ * call
107
110
  * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
108
- * first, and specify the returned `canonicalApp`.
111
+ * and specify the returned `canonicalApp`.
109
112
  * @param - ID of the project whose design to save.
110
113
  * @param - ID of the release that the user is currently viewing.
111
114
  *
@@ -167,9 +170,14 @@ interface StartMobileBuildSignature {
167
170
  * [Get Latest Mobile Builds](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-latest-mobile-builds)
168
171
  * with `himalayaControlToken`.
169
172
  *
170
- * For projects whose `platform` is `HIMALAYA_MOBILE`, call
173
+ * For a new `HIMALAYA_MOBILE` project, call
174
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
175
+ * before starting a build. For an existing project, call
171
176
  * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
172
- * first, and specify the returned `canonicalApp`.
177
+ * and specify the returned `canonicalApp`.
178
+ *
179
+ * If a build can't start for a platform, the response lists that platform in
180
+ * `failedPlatforms` while returning any builds that did start in `builds`.
173
181
  * @param - ID of the project to build.
174
182
  * @param - Platforms to build. One build is started for each platform.
175
183
  */
@@ -195,18 +203,11 @@ interface GetLatestMobileBuildsSignature {
195
203
  declare function claimHimalayaApp$1(httpClient: HttpClient): ClaimHimalayaAppSignature;
196
204
  interface ClaimHimalayaAppSignature {
197
205
  /**
198
- * Claims the canonical Himalaya app for a NEW site-tenanted project, or returns the one already
199
- * bound to it.
200
- *
201
- * This exists so the BROWSER never asserts the (MetaSite, project) pair to Himalaya. Containers
202
- * is the authority on project -> MetaSite: it reads the project from its own store with a
203
- * consistent read and takes the MetaSite from this call's identity context, then claims
204
- * server-to-server with a site USER token minted for the initiating collaborator. Himalaya
205
- * recognises that token as minted by THIS service and trusts the pair on that basis. A dashboard
206
- * calling Himalaya directly could name another site's project UUID and reserve its global slug.
207
- *
208
- * Idempotent per pair: an already-claimed project returns its existing canonical app.
209
- * @param - Site-tenanted Containers project to claim a Himalaya app for.
206
+ * Claims the app associated with a project, or retrieves its existing claim.
207
+ *
208
+ * An authorized site collaborator can call this method for a new `HIMALAYA_MOBILE` project
209
+ * before using its app. Repeating the call for the same project returns the same `canonicalApp`.
210
+ * @param - ID of the site project whose app to claim or retrieve.
210
211
  */
211
212
  (projectId: string): Promise<NonNullablePaths<ClaimHimalayaAppResponse, `authorizationVersion` | `metaSiteId` | `projectId` | `canonicalApp`, 0>>;
212
213
  }
@@ -2363,7 +2363,9 @@ interface SaveProjectDesignRequest {
2363
2363
  himalayaControlToken: string;
2364
2364
  /**
2365
2365
  * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
2366
- * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
2366
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
2367
+ * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
2368
+ * for an already claimed project.
2367
2369
  * This isn't the app's ID.
2368
2370
  *
2369
2371
  * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
@@ -2558,7 +2560,9 @@ interface StartMobileBuildRequest {
2558
2560
  himalayaControlToken: string;
2559
2561
  /**
2560
2562
  * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
2561
- * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
2563
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
2564
+ * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
2565
+ * for an already claimed project.
2562
2566
  *
2563
2567
  * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
2564
2568
  * @maxLength 200
@@ -2771,26 +2775,26 @@ interface PlatformMobileBuilds {
2771
2775
  }
2772
2776
  interface ClaimHimalayaAppRequest {
2773
2777
  /**
2774
- * Site-tenanted Containers project to claim a Himalaya app for.
2778
+ * ID of the site project whose app to claim or retrieve.
2775
2779
  * @format GUID
2776
2780
  */
2777
2781
  projectId: string;
2778
2782
  }
2779
2783
  interface ClaimHimalayaAppResponse {
2780
- /** Version of the authorization capability contract. Matches GetHimalayaAuthorizationResponse. */
2784
+ /** Version of the response format. Currently always `1`. */
2781
2785
  authorizationVersion?: number;
2782
2786
  /**
2783
- * Trusted MetaSite selected from request identity context, never from the request body.
2787
+ * ID of the Wix site that owns the project.
2784
2788
  * @format GUID
2785
2789
  */
2786
2790
  metaSiteId?: string;
2787
2791
  /**
2788
- * Site-tenanted Containers project the app is bound to.
2792
+ * ID of the project the app is associated with.
2789
2793
  * @format GUID
2790
2794
  */
2791
2795
  projectId?: string;
2792
2796
  /**
2793
- * Canonical Himalaya app slug, newly claimed or already bound.
2797
+ * Canonical app slug, newly claimed or already associated with the project.
2794
2798
  * @maxLength 200
2795
2799
  */
2796
2800
  canonicalApp?: string;
@@ -3008,9 +3012,12 @@ declare function regenerateProjectIcon(projectId: string, prompt: string): Promi
3008
3012
  * A `CHECKPOINT` message is then added to the conversation. If the checkpoint can't be added, the
3009
3013
  * design is still saved.
3010
3014
  *
3011
- * For projects whose `platform` is `HIMALAYA_MOBILE`, call
3015
+ * For a new `HIMALAYA_MOBILE` project, call
3016
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
3017
+ * and specify its returned `canonicalApp` when saving the design. For an already claimed project,
3018
+ * call
3012
3019
  * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
3013
- * first, and specify the returned `canonicalApp`.
3020
+ * and specify the returned `canonicalApp`.
3014
3021
  * @param projectId - ID of the project whose design to save.
3015
3022
  * @param baseReleaseId - ID of the release that the user is currently viewing.
3016
3023
  *
@@ -3044,7 +3051,9 @@ interface SaveProjectDesignOptions {
3044
3051
  himalayaControlToken: string;
3045
3052
  /**
3046
3053
  * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
3047
- * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
3054
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
3055
+ * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
3056
+ * for an already claimed project.
3048
3057
  * This isn't the app's ID.
3049
3058
  *
3050
3059
  * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
@@ -3140,9 +3149,14 @@ declare function getHimalayaAuthorization(projectId: string): Promise<NonNullabl
3140
3149
  * [Get Latest Mobile Builds](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-latest-mobile-builds)
3141
3150
  * with `himalayaControlToken`.
3142
3151
  *
3143
- * For projects whose `platform` is `HIMALAYA_MOBILE`, call
3152
+ * For a new `HIMALAYA_MOBILE` project, call
3153
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
3154
+ * before starting a build. For an existing project, call
3144
3155
  * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
3145
- * first, and specify the returned `canonicalApp`.
3156
+ * and specify the returned `canonicalApp`.
3157
+ *
3158
+ * If a build can't start for a platform, the response lists that platform in
3159
+ * `failedPlatforms` while returning any builds that did start in `builds`.
3146
3160
  * @param projectId - ID of the project to build.
3147
3161
  * @param platforms - Platforms to build. One build is started for each platform.
3148
3162
  * @public
@@ -3178,7 +3192,9 @@ interface StartMobileBuildOptions {
3178
3192
  himalayaControlToken: string;
3179
3193
  /**
3180
3194
  * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
3181
- * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
3195
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
3196
+ * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
3197
+ * for an already claimed project.
3182
3198
  *
3183
3199
  * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
3184
3200
  * @maxLength 200
@@ -3235,18 +3251,11 @@ interface GetLatestMobileBuildsOptions {
3235
3251
  himalayaControlToken?: string;
3236
3252
  }
3237
3253
  /**
3238
- * Claims the canonical Himalaya app for a NEW site-tenanted project, or returns the one already
3239
- * bound to it.
3240
- *
3241
- * This exists so the BROWSER never asserts the (MetaSite, project) pair to Himalaya. Containers
3242
- * is the authority on project -> MetaSite: it reads the project from its own store with a
3243
- * consistent read and takes the MetaSite from this call's identity context, then claims
3244
- * server-to-server with a site USER token minted for the initiating collaborator. Himalaya
3245
- * recognises that token as minted by THIS service and trusts the pair on that basis. A dashboard
3246
- * calling Himalaya directly could name another site's project UUID and reserve its global slug.
3254
+ * Claims the app associated with a project, or retrieves its existing claim.
3247
3255
  *
3248
- * Idempotent per pair: an already-claimed project returns its existing canonical app.
3249
- * @param projectId - Site-tenanted Containers project to claim a Himalaya app for.
3256
+ * An authorized site collaborator can call this method for a new `HIMALAYA_MOBILE` project
3257
+ * before using its app. Repeating the call for the same project returns the same `canonicalApp`.
3258
+ * @param projectId - ID of the site project whose app to claim or retrieve.
3250
3259
  * @public
3251
3260
  * @documentationMaturity preview
3252
3261
  * @requiredField projectId
@@ -2408,7 +2408,9 @@ interface SaveProjectDesignRequest {
2408
2408
  himalayaControlToken: string;
2409
2409
  /**
2410
2410
  * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
2411
- * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
2411
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
2412
+ * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
2413
+ * for an already claimed project.
2412
2414
  * This isn't the app's ID.
2413
2415
  *
2414
2416
  * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
@@ -2603,7 +2605,9 @@ interface StartMobileBuildRequest {
2603
2605
  himalayaControlToken: string;
2604
2606
  /**
2605
2607
  * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
2606
- * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
2608
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
2609
+ * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
2610
+ * for an already claimed project.
2607
2611
  *
2608
2612
  * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
2609
2613
  * @maxLength 200
@@ -2816,26 +2820,26 @@ interface PlatformMobileBuilds {
2816
2820
  }
2817
2821
  interface ClaimHimalayaAppRequest {
2818
2822
  /**
2819
- * Site-tenanted Containers project to claim a Himalaya app for.
2823
+ * ID of the site project whose app to claim or retrieve.
2820
2824
  * @format GUID
2821
2825
  */
2822
2826
  projectId: string;
2823
2827
  }
2824
2828
  interface ClaimHimalayaAppResponse {
2825
- /** Version of the authorization capability contract. Matches GetHimalayaAuthorizationResponse. */
2829
+ /** Version of the response format. Currently always `1`. */
2826
2830
  authorizationVersion?: number;
2827
2831
  /**
2828
- * Trusted MetaSite selected from request identity context, never from the request body.
2832
+ * ID of the Wix site that owns the project.
2829
2833
  * @format GUID
2830
2834
  */
2831
2835
  metaSiteId?: string;
2832
2836
  /**
2833
- * Site-tenanted Containers project the app is bound to.
2837
+ * ID of the project the app is associated with.
2834
2838
  * @format GUID
2835
2839
  */
2836
2840
  projectId?: string;
2837
2841
  /**
2838
- * Canonical Himalaya app slug, newly claimed or already bound.
2842
+ * Canonical app slug, newly claimed or already associated with the project.
2839
2843
  * @maxLength 200
2840
2844
  */
2841
2845
  canonicalApp?: string;
@@ -103,9 +103,12 @@ interface SaveProjectDesignSignature {
103
103
  * A `CHECKPOINT` message is then added to the conversation. If the checkpoint can't be added, the
104
104
  * design is still saved.
105
105
  *
106
- * For projects whose `platform` is `HIMALAYA_MOBILE`, call
106
+ * For a new `HIMALAYA_MOBILE` project, call
107
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
108
+ * and specify its returned `canonicalApp` when saving the design. For an already claimed project,
109
+ * call
107
110
  * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
108
- * first, and specify the returned `canonicalApp`.
111
+ * and specify the returned `canonicalApp`.
109
112
  * @param - ID of the project whose design to save.
110
113
  * @param - ID of the release that the user is currently viewing.
111
114
  *
@@ -167,9 +170,14 @@ interface StartMobileBuildSignature {
167
170
  * [Get Latest Mobile Builds](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-latest-mobile-builds)
168
171
  * with `himalayaControlToken`.
169
172
  *
170
- * For projects whose `platform` is `HIMALAYA_MOBILE`, call
173
+ * For a new `HIMALAYA_MOBILE` project, call
174
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
175
+ * before starting a build. For an existing project, call
171
176
  * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
172
- * first, and specify the returned `canonicalApp`.
177
+ * and specify the returned `canonicalApp`.
178
+ *
179
+ * If a build can't start for a platform, the response lists that platform in
180
+ * `failedPlatforms` while returning any builds that did start in `builds`.
173
181
  * @param - ID of the project to build.
174
182
  * @param - Platforms to build. One build is started for each platform.
175
183
  */
@@ -195,18 +203,11 @@ interface GetLatestMobileBuildsSignature {
195
203
  declare function claimHimalayaApp$1(httpClient: HttpClient): ClaimHimalayaAppSignature;
196
204
  interface ClaimHimalayaAppSignature {
197
205
  /**
198
- * Claims the canonical Himalaya app for a NEW site-tenanted project, or returns the one already
199
- * bound to it.
200
- *
201
- * This exists so the BROWSER never asserts the (MetaSite, project) pair to Himalaya. Containers
202
- * is the authority on project -> MetaSite: it reads the project from its own store with a
203
- * consistent read and takes the MetaSite from this call's identity context, then claims
204
- * server-to-server with a site USER token minted for the initiating collaborator. Himalaya
205
- * recognises that token as minted by THIS service and trusts the pair on that basis. A dashboard
206
- * calling Himalaya directly could name another site's project UUID and reserve its global slug.
207
- *
208
- * Idempotent per pair: an already-claimed project returns its existing canonical app.
209
- * @param - Site-tenanted Containers project to claim a Himalaya app for.
206
+ * Claims the app associated with a project, or retrieves its existing claim.
207
+ *
208
+ * An authorized site collaborator can call this method for a new `HIMALAYA_MOBILE` project
209
+ * before using its app. Repeating the call for the same project returns the same `canonicalApp`.
210
+ * @param - ID of the site project whose app to claim or retrieve.
210
211
  */
211
212
  (projectId: string): Promise<NonNullablePaths<ClaimHimalayaAppResponse, `authorizationVersion` | `metaSiteId` | `projectId` | `canonicalApp`, 0>>;
212
213
  }
@@ -2363,7 +2363,9 @@ interface SaveProjectDesignRequest {
2363
2363
  himalayaControlToken: string;
2364
2364
  /**
2365
2365
  * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
2366
- * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
2366
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
2367
+ * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
2368
+ * for an already claimed project.
2367
2369
  * This isn't the app's ID.
2368
2370
  *
2369
2371
  * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
@@ -2558,7 +2560,9 @@ interface StartMobileBuildRequest {
2558
2560
  himalayaControlToken: string;
2559
2561
  /**
2560
2562
  * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
2561
- * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
2563
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
2564
+ * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
2565
+ * for an already claimed project.
2562
2566
  *
2563
2567
  * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
2564
2568
  * @maxLength 200
@@ -2771,26 +2775,26 @@ interface PlatformMobileBuilds {
2771
2775
  }
2772
2776
  interface ClaimHimalayaAppRequest {
2773
2777
  /**
2774
- * Site-tenanted Containers project to claim a Himalaya app for.
2778
+ * ID of the site project whose app to claim or retrieve.
2775
2779
  * @format GUID
2776
2780
  */
2777
2781
  projectId: string;
2778
2782
  }
2779
2783
  interface ClaimHimalayaAppResponse {
2780
- /** Version of the authorization capability contract. Matches GetHimalayaAuthorizationResponse. */
2784
+ /** Version of the response format. Currently always `1`. */
2781
2785
  authorizationVersion?: number;
2782
2786
  /**
2783
- * Trusted MetaSite selected from request identity context, never from the request body.
2787
+ * ID of the Wix site that owns the project.
2784
2788
  * @format GUID
2785
2789
  */
2786
2790
  metaSiteId?: string;
2787
2791
  /**
2788
- * Site-tenanted Containers project the app is bound to.
2792
+ * ID of the project the app is associated with.
2789
2793
  * @format GUID
2790
2794
  */
2791
2795
  projectId?: string;
2792
2796
  /**
2793
- * Canonical Himalaya app slug, newly claimed or already bound.
2797
+ * Canonical app slug, newly claimed or already associated with the project.
2794
2798
  * @maxLength 200
2795
2799
  */
2796
2800
  canonicalApp?: string;
@@ -3008,9 +3012,12 @@ declare function regenerateProjectIcon(projectId: string, prompt: string): Promi
3008
3012
  * A `CHECKPOINT` message is then added to the conversation. If the checkpoint can't be added, the
3009
3013
  * design is still saved.
3010
3014
  *
3011
- * For projects whose `platform` is `HIMALAYA_MOBILE`, call
3015
+ * For a new `HIMALAYA_MOBILE` project, call
3016
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
3017
+ * and specify its returned `canonicalApp` when saving the design. For an already claimed project,
3018
+ * call
3012
3019
  * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
3013
- * first, and specify the returned `canonicalApp`.
3020
+ * and specify the returned `canonicalApp`.
3014
3021
  * @param projectId - ID of the project whose design to save.
3015
3022
  * @param baseReleaseId - ID of the release that the user is currently viewing.
3016
3023
  *
@@ -3044,7 +3051,9 @@ interface SaveProjectDesignOptions {
3044
3051
  himalayaControlToken: string;
3045
3052
  /**
3046
3053
  * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
3047
- * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
3054
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
3055
+ * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
3056
+ * for an already claimed project.
3048
3057
  * This isn't the app's ID.
3049
3058
  *
3050
3059
  * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
@@ -3140,9 +3149,14 @@ declare function getHimalayaAuthorization(projectId: string): Promise<NonNullabl
3140
3149
  * [Get Latest Mobile Builds](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-latest-mobile-builds)
3141
3150
  * with `himalayaControlToken`.
3142
3151
  *
3143
- * For projects whose `platform` is `HIMALAYA_MOBILE`, call
3152
+ * For a new `HIMALAYA_MOBILE` project, call
3153
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
3154
+ * before starting a build. For an existing project, call
3144
3155
  * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
3145
- * first, and specify the returned `canonicalApp`.
3156
+ * and specify the returned `canonicalApp`.
3157
+ *
3158
+ * If a build can't start for a platform, the response lists that platform in
3159
+ * `failedPlatforms` while returning any builds that did start in `builds`.
3146
3160
  * @param projectId - ID of the project to build.
3147
3161
  * @param platforms - Platforms to build. One build is started for each platform.
3148
3162
  * @public
@@ -3178,7 +3192,9 @@ interface StartMobileBuildOptions {
3178
3192
  himalayaControlToken: string;
3179
3193
  /**
3180
3194
  * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
3181
- * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
3195
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
3196
+ * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
3197
+ * for an already claimed project.
3182
3198
  *
3183
3199
  * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
3184
3200
  * @maxLength 200
@@ -3235,18 +3251,11 @@ interface GetLatestMobileBuildsOptions {
3235
3251
  himalayaControlToken?: string;
3236
3252
  }
3237
3253
  /**
3238
- * Claims the canonical Himalaya app for a NEW site-tenanted project, or returns the one already
3239
- * bound to it.
3240
- *
3241
- * This exists so the BROWSER never asserts the (MetaSite, project) pair to Himalaya. Containers
3242
- * is the authority on project -> MetaSite: it reads the project from its own store with a
3243
- * consistent read and takes the MetaSite from this call's identity context, then claims
3244
- * server-to-server with a site USER token minted for the initiating collaborator. Himalaya
3245
- * recognises that token as minted by THIS service and trusts the pair on that basis. A dashboard
3246
- * calling Himalaya directly could name another site's project UUID and reserve its global slug.
3254
+ * Claims the app associated with a project, or retrieves its existing claim.
3247
3255
  *
3248
- * Idempotent per pair: an already-claimed project returns its existing canonical app.
3249
- * @param projectId - Site-tenanted Containers project to claim a Himalaya app for.
3256
+ * An authorized site collaborator can call this method for a new `HIMALAYA_MOBILE` project
3257
+ * before using its app. Repeating the call for the same project returns the same `canonicalApp`.
3258
+ * @param projectId - ID of the site project whose app to claim or retrieve.
3250
3259
  * @public
3251
3260
  * @documentationMaturity preview
3252
3261
  * @requiredField projectId
@@ -2408,7 +2408,9 @@ interface SaveProjectDesignRequest {
2408
2408
  himalayaControlToken: string;
2409
2409
  /**
2410
2410
  * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
2411
- * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
2411
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
2412
+ * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
2413
+ * for an already claimed project.
2412
2414
  * This isn't the app's ID.
2413
2415
  *
2414
2416
  * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
@@ -2603,7 +2605,9 @@ interface StartMobileBuildRequest {
2603
2605
  himalayaControlToken: string;
2604
2606
  /**
2605
2607
  * Canonical slug of the project's app, exactly as returned in `canonicalApp` by
2606
- * [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization).
2608
+ * [Claim Himalaya App](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/claim-himalaya-app)
2609
+ * for a new project or [Get Himalaya Authorization](https://dev.wix.com/docs/api-reference/mobile/containers-app/containers-projects/project-v1/get-himalaya-authorization)
2610
+ * for an already claimed project.
2607
2611
  *
2608
2612
  * Required when the project's `platform` is `HIMALAYA_MOBILE`. The value is verified on the server.
2609
2613
  * @maxLength 200
@@ -2816,26 +2820,26 @@ interface PlatformMobileBuilds {
2816
2820
  }
2817
2821
  interface ClaimHimalayaAppRequest {
2818
2822
  /**
2819
- * Site-tenanted Containers project to claim a Himalaya app for.
2823
+ * ID of the site project whose app to claim or retrieve.
2820
2824
  * @format GUID
2821
2825
  */
2822
2826
  projectId: string;
2823
2827
  }
2824
2828
  interface ClaimHimalayaAppResponse {
2825
- /** Version of the authorization capability contract. Matches GetHimalayaAuthorizationResponse. */
2829
+ /** Version of the response format. Currently always `1`. */
2826
2830
  authorizationVersion?: number;
2827
2831
  /**
2828
- * Trusted MetaSite selected from request identity context, never from the request body.
2832
+ * ID of the Wix site that owns the project.
2829
2833
  * @format GUID
2830
2834
  */
2831
2835
  metaSiteId?: string;
2832
2836
  /**
2833
- * Site-tenanted Containers project the app is bound to.
2837
+ * ID of the project the app is associated with.
2834
2838
  * @format GUID
2835
2839
  */
2836
2840
  projectId?: string;
2837
2841
  /**
2838
- * Canonical Himalaya app slug, newly claimed or already bound.
2842
+ * Canonical app slug, newly claimed or already associated with the project.
2839
2843
  * @maxLength 200
2840
2844
  */
2841
2845
  canonicalApp?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_containers_projects",
3
- "version": "1.0.22",
3
+ "version": "1.0.23",
4
4
  "license": "MIT",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
50
50
  "fqdn": "wix.containers.projects.v1.project"
51
51
  }
52
52
  },
53
- "falconPackageHash": "355bf4836af856b9442409f249277646ed83c39fe98aa7ee6585ca72"
53
+ "falconPackageHash": "1d9ecc6e61d758dfec953c8cd425fb869e5b14973bbaa1405ac208a7"
54
54
  }