@wix/auto_sdk_containers_projects 1.0.9 → 1.0.11

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

@@ -1269,16 +1269,40 @@ interface StartMobileBuildRequest {
      * @maxLength 200
      */
     canonicalApp?: string;
+    /**
+     * Android only. Kind of file to build. Default: `APK`.
+     *
+     * `AAB` builds the file to upload to Google Play, under the package name saved for the app in
+     * Himalaya. With `AAB`, `platforms` must be only `ANDROID`, and `owner_authorization` is required.
+     */
+    androidFormat?: AndroidFormatWithLiterals;
+    /**
+     * The site owner's dashboard authorization: the signed `Authorization` header of this request.
+     * Required with `android_format: AAB`: Himalaya checks that whoever starts a Google Play file owns the site.
+     *
+     * Used for this call only. It isn't stored or returned.
+     * @maxLength 4096
+     */
+    ownerAuthorization?: string;
 }
 /** Platform that an app-file build targets. */
 declare enum Platform {
     /** iOS. The build makes an `.ipa` file and an install page. */
     IOS = "IOS",
-    /** Android. The build makes an `.apk` file. */
+    /** Android. The build makes an `.apk` file, or an `.aab` file for Google Play (see `androidFormat`). */
     ANDROID = "ANDROID"
 }
 /** @enumType */
 type PlatformWithLiterals = Platform | 'IOS' | 'ANDROID';
+/** Kind of file an Android build makes. */
+declare enum AndroidFormat {
+    /** An `.apk` file, to install on a phone and test. */
+    APK = "APK",
+    /** An `.aab` file (Android App Bundle), the file to upload to Google Play. It can't be installed on a phone. */
+    AAB = "AAB"
+}
+/** @enumType */
+type AndroidFormatWithLiterals = AndroidFormat | 'APK' | 'AAB';
 interface StartMobileBuildResponse {
     /**
      * Started builds, one for each platform that was accepted.
@@ -1325,7 +1349,7 @@ interface MobileBuild {
      */
     errorMessage?: string;
     /**
-     * URL of the built file: an `.ipa` file for iOS, or an `.apk` file for Android.
+     * URL of the built file: an `.ipa` file for iOS, or an `.apk` or `.aab` file for Android.
      * Returned only when `status` is `SUCCEEDED`. Can be empty for iOS.
      * @format WEB_URL
      */
@@ -1346,6 +1370,14 @@ interface MobileBuild {
     builtDate?: Date | null;
     /** Date and time the build last changed. */
     _updatedDate?: Date | null;
+    /** Android only. Kind of file the build made: an `.apk` to install and test, or an `.aab` to upload to Google Play. */
+    androidFormat?: AndroidFormatWithLiterals;
+    /**
+     * Android `AAB` builds only. URL of an `.apk` file of the same build, to install on a phone and test.
+     * Returned only when `status` is `SUCCEEDED`. Can be empty. Expires with `download_url`.
+     * @format WEB_URL
+     */
+    apkDownloadUrl?: string;
 }
 /** Status of an app-file build. */
 declare enum Status {
@@ -1417,6 +1449,32 @@ interface PlatformMobileBuilds {
     /** The last build that succeeded. Its links can be expired. Not returned when no build succeeded. */
     lastSuccessfulBuild?: MobileBuild;
 }
+interface ClaimHimalayaAppRequest {
+    /**
+     * Site-tenanted Containers project to claim a Himalaya app for.
+     * @format GUID
+     */
+    projectId: string;
+}
+interface ClaimHimalayaAppResponse {
+    /** Version of the authorization capability contract. Matches GetHimalayaAuthorizationResponse. */
+    authorizationVersion?: number;
+    /**
+     * Trusted MetaSite selected from request identity context, never from the request body.
+     * @format GUID
+     */
+    metaSiteId?: string;
+    /**
+     * Site-tenanted Containers project the app is bound to.
+     * @format GUID
+     */
+    projectId?: string;
+    /**
+     * Canonical Himalaya app slug, newly claimed or already bound.
+     * @maxLength 200
+     */
+    canonicalApp?: string;
+}
 /**
  * Retrieves a project.
  * @param projectId - ID of the project to retrieve.
@@ -1683,7 +1741,7 @@ declare function getHimalayaAuthorization(projectId: string): Promise<NonNullabl
  * @permissionId containers:projects:v1:project:start_mobile_build
  * @fqn wix.containers.projects.v1.ContainersProjects.StartMobileBuild
  */
-declare function startMobileBuild(projectId: string, platforms: PlatformWithLiterals[], options?: NonNullablePaths<StartMobileBuildOptions, `himalayaControlToken`, 0>): Promise<NonNullablePaths<StartMobileBuildResponse, `builds` | `builds.${number}.jobId` | `builds.${number}.platform` | `builds.${number}.releaseId` | `builds.${number}.appVersion` | `builds.${number}.status` | `builds.${number}.failureKind` | `builds.${number}.himalayaStatus` | `builds.${number}.errorMessage` | `builds.${number}.downloadUrl` | `builds.${number}.installPageUrl` | `builds.${number}.downloadExpired` | `failedPlatforms` | `failedPlatforms.${number}.platform` | `failedPlatforms.${number}.errorCode` | `failedPlatforms.${number}.errorMessage`, 2>>;
+declare function startMobileBuild(projectId: string, platforms: PlatformWithLiterals[], options?: NonNullablePaths<StartMobileBuildOptions, `himalayaControlToken`, 0>): Promise<NonNullablePaths<StartMobileBuildResponse, `builds` | `builds.${number}.jobId` | `builds.${number}.platform` | `builds.${number}.releaseId` | `builds.${number}.appVersion` | `builds.${number}.status` | `builds.${number}.failureKind` | `builds.${number}.himalayaStatus` | `builds.${number}.errorMessage` | `builds.${number}.downloadUrl` | `builds.${number}.installPageUrl` | `builds.${number}.downloadExpired` | `builds.${number}.androidFormat` | `builds.${number}.apkDownloadUrl` | `failedPlatforms` | `failedPlatforms.${number}.platform` | `failedPlatforms.${number}.errorCode` | `failedPlatforms.${number}.errorMessage`, 2>>;
 interface StartMobileBuildOptions {
     /**
      * ID of the app release to build. When not specified, the app's live release is built.
@@ -1711,6 +1769,21 @@ interface StartMobileBuildOptions {
      * @maxLength 200
      */
     canonicalApp?: string;
+    /**
+     * Android only. Kind of file to build. Default: `APK`.
+     *
+     * `AAB` builds the file to upload to Google Play, under the package name saved for the app in
+     * Himalaya. With `AAB`, `platforms` must be only `ANDROID`, and `owner_authorization` is required.
+     */
+    androidFormat?: AndroidFormatWithLiterals;
+    /**
+     * The site owner's dashboard authorization: the signed `Authorization` header of this request.
+     * Required with `android_format: AAB`: Himalaya checks that whoever starts a Google Play file owns the site.
+     *
+     * Used for this call only. It isn't stored or returned.
+     * @maxLength 4096
+     */
+    ownerAuthorization?: string;
 }
 /**
  * Retrieves the latest app-file builds of a project: for each platform, the last build that was
@@ -1728,7 +1801,7 @@ interface StartMobileBuildOptions {
  * @permissionId containers:projects:v1:project:get_latest_mobile_builds
  * @fqn wix.containers.projects.v1.ContainersProjects.GetLatestMobileBuilds
  */
-declare function getLatestMobileBuilds(projectId: string, options?: GetLatestMobileBuildsOptions): Promise<NonNullablePaths<GetLatestMobileBuildsResponse, `platforms` | `platforms.${number}.platform` | `platforms.${number}.lastAttempt.jobId` | `platforms.${number}.lastAttempt.platform` | `platforms.${number}.lastAttempt.releaseId` | `platforms.${number}.lastAttempt.appVersion` | `platforms.${number}.lastAttempt.status` | `platforms.${number}.lastAttempt.failureKind` | `platforms.${number}.lastAttempt.himalayaStatus` | `platforms.${number}.lastAttempt.errorMessage` | `platforms.${number}.lastAttempt.downloadUrl` | `platforms.${number}.lastAttempt.installPageUrl` | `platforms.${number}.lastAttempt.downloadExpired` | `refreshFailed`, 3>>;
+declare function getLatestMobileBuilds(projectId: string, options?: GetLatestMobileBuildsOptions): Promise<NonNullablePaths<GetLatestMobileBuildsResponse, `platforms` | `platforms.${number}.platform` | `platforms.${number}.lastAttempt.jobId` | `platforms.${number}.lastAttempt.platform` | `platforms.${number}.lastAttempt.releaseId` | `platforms.${number}.lastAttempt.appVersion` | `platforms.${number}.lastAttempt.status` | `platforms.${number}.lastAttempt.failureKind` | `platforms.${number}.lastAttempt.himalayaStatus` | `platforms.${number}.lastAttempt.errorMessage` | `platforms.${number}.lastAttempt.downloadUrl` | `platforms.${number}.lastAttempt.installPageUrl` | `platforms.${number}.lastAttempt.downloadExpired` | `platforms.${number}.lastAttempt.androidFormat` | `platforms.${number}.lastAttempt.apkDownloadUrl` | `refreshFailed`, 3>>;
 interface GetLatestMobileBuildsOptions {
     /**
      * Short-lived control credential for the project's app.
@@ -1739,5 +1812,25 @@ interface GetLatestMobileBuildsOptions {
      */
     himalayaControlToken?: string;
 }
+/**
+ * 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 projectId - Site-tenanted Containers project to claim a Himalaya app for.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField projectId
+ * @permissionId containers:projects:v1:project:claim_himalaya_app
+ * @fqn wix.containers.projects.v1.ContainersProjects.ClaimHimalayaApp
+ */
+declare function claimHimalayaApp(projectId: string): Promise<NonNullablePaths<ClaimHimalayaAppResponse, `authorizationVersion` | `metaSiteId` | `projectId` | `canonicalApp`, 0>>;
 
-export { type AccountInfo, type ActionEvent, type AdditionalDataFilterMismatchType, type AdditionalDataFilterMissingKey, type AdditionalDataFilterMustHaveKey, type AdditionalDataMissingValue, type AdditionalFilterCantBeEmpty, type ConductByScopeResponse, type ConductByScopesResponse, type ConductResponse, type ConductionException, type ConductionResult, type ConductionStatus, type ConductionStatusStatusOneOf, type CreateAgentSessionRequest, type CreateAgentSessionResponse, type CreateProjectRequest, type CreateProjectResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type DeleteProjectRequest, type DeleteProjectResponse, type DidNotFindEligibleFilter, type DomainEvent, type DomainEventBodyOneOf, type DynamicConfigConductionResult, type DynamicConfigStatus, type DynamicConfigStatusStatusOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FailedMobileBuildPlatform, type FailedToFetchExperiment, type FailedToRunToss, FailureKind, type FailureKindWithLiterals, type FilterNotImplemented, type FilterNotSupported, type FilterOperandEmpty, type GeneralError, type GetAgentConfigRequest, type GetAgentConfigResponse, type GetAgentExperimentsRequest, type GetAgentExperimentsResponse, type GetHimalayaAuthorizationRequest, type GetHimalayaAuthorizationResponse, type GetLatestMobileBuildsOptions, type GetLatestMobileBuildsRequest, type GetLatestMobileBuildsResponse, type GetProjectRequest, type GetProjectResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidLibraryConfiguration, type IsEnabledFieldNotFound, type IsEnabledFieldNotOfTypeBoolean, type ListProjectsForCurrentUserRequest, type ListProjectsForCurrentUserResponse, type ListProjectsOptions, type ListProjectsRequest, type ListProjectsResponse, type MessageEnvelope, type MissingElementInContextForBiProfileError, type MissingExperimentId, type MissingFilterTarget, type MissingPlugins, type MissingSeed, type MissingSeedKeyType, type MissingSeedType, type MobileBuild, type NoResultForConduction, type NotImplemented, Platform, type PlatformMobileBuilds, type PlatformWithLiterals, type PopulationError, type Project, type ProjectPlanReady, type ProjectResumeRequested, type ProjectStartRequested, ProjectStatus, type ProjectStatusWithLiterals, type RefreshAgentSiteTokenRequest, type RefreshAgentSiteTokenResponse, type RegenerateProjectIconRequest, type RegenerateProjectIconResponse, type RegenerateProjectNameRequest, type RegenerateProjectNameResponse, type RestoreInfo, type RestoreReleaseOptions, type RestoreReleaseRequest, type RestoreReleaseResponse, type ResumeProjectRequest, type ResumeProjectResponse, SandboxStatus, type SandboxStatusWithLiterals, type SaveProjectDesignOptions, type SaveProjectDesignRequest, type SaveProjectDesignResponse, type StartMobileBuildOptions, type StartMobileBuildRequest, type StartMobileBuildResponse, type StartProjectRequest, type StartProjectResponse, Status, type StatusWithLiterals, type SuccessfulResult, type UpdateProject, type UpdateProjectRequest, type UpdateProjectResponse, type V1AdditionalDataFilterMismatchType, type V1AdditionalDataFilterMissingKey, type V1AdditionalDataFilterMustHaveKey, type V1AdditionalDataMissingValue, type V1AdditionalFilterCantBeEmpty, type V1ConductionException, type V1DidNotFindEligibleFilter, type V1FailedToFetchExperiment, type V1FailedToRunToss, type V1FilterNotImplemented, type V1FilterNotSupported, type V1FilterOperandEmpty, type V1GeneralError, type V1MissingElementInContextForBiProfileError, type V1MissingExperimentId, type V1MissingFilterTarget, type V1MissingPlugins, type V1MissingSeed, type V1MissingSeedKeyType, type V1MissingSeedType, type V1NoResultForConduction, V1Platform, type V1PlatformWithLiterals, type V1PopulationError, type V1SuccessfulResult, Variant, type VariantValue, type VariantValueValueOneOf, type VariantWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, getHimalayaAuthorization, getLatestMobileBuilds, getProject, restoreRelease, resumeProject, saveProjectDesign, startMobileBuild };
+export { type AccountInfo, type ActionEvent, type AdditionalDataFilterMismatchType, type AdditionalDataFilterMissingKey, type AdditionalDataFilterMustHaveKey, type AdditionalDataMissingValue, type AdditionalFilterCantBeEmpty, AndroidFormat, type AndroidFormatWithLiterals, type ClaimHimalayaAppRequest, type ClaimHimalayaAppResponse, type ConductByScopeResponse, type ConductByScopesResponse, type ConductResponse, type ConductionException, type ConductionResult, type ConductionStatus, type ConductionStatusStatusOneOf, type CreateAgentSessionRequest, type CreateAgentSessionResponse, type CreateProjectRequest, type CreateProjectResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type DeleteProjectRequest, type DeleteProjectResponse, type DidNotFindEligibleFilter, type DomainEvent, type DomainEventBodyOneOf, type DynamicConfigConductionResult, type DynamicConfigStatus, type DynamicConfigStatusStatusOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FailedMobileBuildPlatform, type FailedToFetchExperiment, type FailedToRunToss, FailureKind, type FailureKindWithLiterals, type FilterNotImplemented, type FilterNotSupported, type FilterOperandEmpty, type GeneralError, type GetAgentConfigRequest, type GetAgentConfigResponse, type GetAgentExperimentsRequest, type GetAgentExperimentsResponse, type GetHimalayaAuthorizationRequest, type GetHimalayaAuthorizationResponse, type GetLatestMobileBuildsOptions, type GetLatestMobileBuildsRequest, type GetLatestMobileBuildsResponse, type GetProjectRequest, type GetProjectResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidLibraryConfiguration, type IsEnabledFieldNotFound, type IsEnabledFieldNotOfTypeBoolean, type ListProjectsForCurrentUserRequest, type ListProjectsForCurrentUserResponse, type ListProjectsOptions, type ListProjectsRequest, type ListProjectsResponse, type MessageEnvelope, type MissingElementInContextForBiProfileError, type MissingExperimentId, type MissingFilterTarget, type MissingPlugins, type MissingSeed, type MissingSeedKeyType, type MissingSeedType, type MobileBuild, type NoResultForConduction, type NotImplemented, Platform, type PlatformMobileBuilds, type PlatformWithLiterals, type PopulationError, type Project, type ProjectPlanReady, type ProjectResumeRequested, type ProjectStartRequested, ProjectStatus, type ProjectStatusWithLiterals, type RefreshAgentSiteTokenRequest, type RefreshAgentSiteTokenResponse, type RegenerateProjectIconRequest, type RegenerateProjectIconResponse, type RegenerateProjectNameRequest, type RegenerateProjectNameResponse, type RestoreInfo, type RestoreReleaseOptions, type RestoreReleaseRequest, type RestoreReleaseResponse, type ResumeProjectRequest, type ResumeProjectResponse, SandboxStatus, type SandboxStatusWithLiterals, type SaveProjectDesignOptions, type SaveProjectDesignRequest, type SaveProjectDesignResponse, type StartMobileBuildOptions, type StartMobileBuildRequest, type StartMobileBuildResponse, type StartProjectRequest, type StartProjectResponse, Status, type StatusWithLiterals, type SuccessfulResult, type UpdateProject, type UpdateProjectRequest, type UpdateProjectResponse, type V1AdditionalDataFilterMismatchType, type V1AdditionalDataFilterMissingKey, type V1AdditionalDataFilterMustHaveKey, type V1AdditionalDataMissingValue, type V1AdditionalFilterCantBeEmpty, type V1ConductionException, type V1DidNotFindEligibleFilter, type V1FailedToFetchExperiment, type V1FailedToRunToss, type V1FilterNotImplemented, type V1FilterNotSupported, type V1FilterOperandEmpty, type V1GeneralError, type V1MissingElementInContextForBiProfileError, type V1MissingExperimentId, type V1MissingFilterTarget, type V1MissingPlugins, type V1MissingSeed, type V1MissingSeedKeyType, type V1MissingSeedType, type V1NoResultForConduction, V1Platform, type V1PlatformWithLiterals, type V1PopulationError, type V1SuccessfulResult, Variant, type VariantValue, type VariantValueValueOneOf, type VariantWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, claimHimalayaApp, getHimalayaAuthorization, getLatestMobileBuilds, getProject, restoreRelease, resumeProject, saveProjectDesign, startMobileBuild };

package/build/es/index.typings.mjs

@@ -399,6 +399,27 @@ function getLatestMobileBuilds(payload) {
   }
   return __getLatestMobileBuilds;
 }
+function claimHimalayaApp(payload) {
+  function __claimHimalayaApp({ host }) {
+    const metadata = {
+      entityFqdn: "wix.containers.projects.v1.project",
+      method: "POST",
+      methodFqn: "wix.containers.projects.v1.ContainersProjects.ClaimHimalayaApp",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixContainersProjectsV1ContainersProjectsUrl({
+        protoPath: "/v1/projects/{projectId}/himalaya-app-claim",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __claimHimalayaApp;
+}
 
 // src/containers-projects-v1-project-projects.universal.ts
 var ProjectStatus = /* @__PURE__ */ ((ProjectStatus2) => {
@@ -461,6 +482,11 @@ var Platform = /* @__PURE__ */ ((Platform2) => {
   Platform2["ANDROID"] = "ANDROID";
   return Platform2;
 })(Platform || {});
+var AndroidFormat = /* @__PURE__ */ ((AndroidFormat2) => {
+  AndroidFormat2["APK"] = "APK";
+  AndroidFormat2["AAB"] = "AAB";
+  return AndroidFormat2;
+})(AndroidFormat || {});
 var Status = /* @__PURE__ */ ((Status2) => {
   Status2["IN_PROGRESS"] = "IN_PROGRESS";
   Status2["SUCCEEDED"] = "SUCCEEDED";
@@ -775,7 +801,9 @@ async function startMobileBuild2(projectId, platforms, options) {
     releaseId: options?.releaseId,
     appVersion: options?.appVersion,
     himalayaControlToken: options?.himalayaControlToken,
-    canonicalApp: options?.canonicalApp
+    canonicalApp: options?.canonicalApp,
+    androidFormat: options?.androidFormat,
+    ownerAuthorization: options?.ownerAuthorization
   });
   const reqOpts = startMobileBuild(payload);
   sideEffects?.onSiteCall?.();
@@ -794,7 +822,9 @@ async function startMobileBuild2(projectId, platforms, options) {
           releaseId: "$[2].releaseId",
           appVersion: "$[2].appVersion",
           himalayaControlToken: "$[2].himalayaControlToken",
-          canonicalApp: "$[2].canonicalApp"
+          canonicalApp: "$[2].canonicalApp",
+          androidFormat: "$[2].androidFormat",
+          ownerAuthorization: "$[2].ownerAuthorization"
         },
         singleArgumentUnchanged: false
       },
@@ -833,7 +863,33 @@ async function getLatestMobileBuilds2(projectId, options) {
     throw transformedError;
   }
 }
+async function claimHimalayaApp2(projectId) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    projectId
+  });
+  const reqOpts = claimHimalayaApp(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { projectId: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["projectId"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 export {
+  AndroidFormat,
   FailureKind,
   Platform,
   ProjectStatus,
@@ -842,6 +898,7 @@ export {
   V1Platform,
   Variant,
   WebhookIdentityType,
+  claimHimalayaApp2 as claimHimalayaApp,
   createProject2 as createProject,
   deleteProject2 as deleteProject,
   getHimalayaAuthorization2 as getHimalayaAuthorization,