smbcloud_ascapi_aso/

app_store_version.rs

//! An `AppStoreVersion` is App Store Connect's per-platform record for an
//! app: `platform` is one of `IOS` / `MAC_OS` / `TV_OS` / `VISION_OS`.
//! Since there is no direct "create app for platform X" endpoint (see
//! [`crate::app`]), creating an `AppStoreVersion` for a platform an app
//! doesn't have one for yet — e.g. adding visionOS to an app that so far
//! only ships on iOS/macOS — *is* how you add that platform.

use async_trait::async_trait;
use reqwest::Method;
use serde::{Deserialize, Serialize};
use smbcloud_ascapi_core::jsonapi::{
    CreateBody, CreateData, Document, OptionalDocument, Resource, ResourceId, ToOne, UpdateBody,
    UpdateData, UpdateRelationshipsBody, UpdateRelationshipsData,
};
use smbcloud_ascapi_core::Client;
use smbcloud_ascapi_core::Result;

use crate::build::{Build, BuildAttributes};

pub const RESOURCE_TYPE: &str = "appStoreVersions";

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum Platform {
    #[serde(rename = "IOS")]
    Ios,
    #[serde(rename = "MAC_OS")]
    MacOs,
    #[serde(rename = "TV_OS")]
    TvOs,
    #[serde(rename = "VISION_OS")]
    VisionOs,
}

impl Platform {
    pub(crate) fn as_query_value(self) -> &'static str {
        match self {
            Platform::Ios => "IOS",
            Platform::MacOs => "MAC_OS",
            Platform::TvOs => "TV_OS",
            Platform::VisionOs => "VISION_OS",
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AppStoreVersionAttributes {
    pub platform: Platform,
    pub version_string: Option<String>,
    pub app_version_state: Option<String>,
    pub copyright: Option<String>,
    pub created_date: Option<String>,
    pub downloadable: Option<bool>,
}

pub type AppStoreVersion = Resource<AppStoreVersionAttributes>;

#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AppStoreVersionCreateAttributes {
    pub platform: Platform,
    pub version_string: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub copyright: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AppStoreVersionRelationships {
    pub app: ToOne,
}

/// Editable attributes for a `PATCH /v1/appStoreVersions/{id}`. App Store
/// Connect has no "rename a version" action: changing `version_string` on
/// the platform's editable version (e.g. a staged `1.0.9` to `1.1.0`) is a
/// plain attribute update. Only the fields set here are sent, so passing
/// just `version_string` leaves `copyright` untouched. The version must be
/// in an editable state (`PREPARE_FOR_SUBMISSION`, `DEVELOPER_REJECTED`).
#[derive(Debug, Clone, Default, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AppStoreVersionUpdateFields {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version_string: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub copyright: Option<String>,
}

/// Per-platform version records, the unit the store reviews.
///
/// An extension trait rather than inherent methods, because `Client`
/// lives in the core crate and Rust only allows inherent impls in the
/// crate that defines the type. Import it, or the crate's `prelude`,
/// to call these on a `Client`.
#[async_trait]
pub trait AppStoreVersionsApi {
    /// `GET /v1/apps/{app_id}/appStoreVersions`, optionally narrowed to one
    /// platform.
    async fn list_app_store_versions(
        &self,
        app_id: &str,
        filter_platform: Option<Platform>,
    ) -> Result<Vec<AppStoreVersion>>;

    async fn get_app_store_version(&self, id: &str) -> Result<AppStoreVersion>;

    /// `POST /v1/appStoreVersions`.
    async fn create_app_store_version(
        &self,
        app_id: &str,
        attributes: AppStoreVersionCreateAttributes,
    ) -> Result<AppStoreVersion>;

    /// `PATCH /v1/appStoreVersions/{id}` with attributes — e.g. change the
    /// version string of the platform's editable version. Apple exposes no
    /// separate rename action; this is how `1.0.9` becomes `1.1.0`.
    async fn update_app_store_version(
        &self,
        id: &str,
        fields: AppStoreVersionUpdateFields,
    ) -> Result<AppStoreVersion>;

    /// `DELETE /v1/appStoreVersions/{id}` — only allowed while the version
    /// hasn't been submitted for review.
    async fn delete_app_store_version(&self, id: &str) -> Result<()>;

    /// `PATCH /v1/appStoreVersions/{id}` with a `build` relationship —
    /// attaches (or replaces) the `Build` this version will submit. Needed
    /// after a re-upload fixes an `INVALID_BINARY` version: the fixed
    /// build must be attached here before the version can be resubmitted
    /// for review (resubmission itself is outside this crate's scope — see
    /// [`crate::build`]'s module doc).
    async fn set_app_store_version_build(
        &self,
        id: &str,
        build_id: &str,
    ) -> Result<AppStoreVersion>;

    /// `GET /v1/appStoreVersions/{id}/build` — the build currently attached
    /// to this version, or `None` when there isn't one. The version resource
    /// itself only carries a link to it, so this is how to confirm what a
    /// submission would send.
    async fn get_app_store_version_build(&self, id: &str) -> Result<Option<Build>>;
}

#[async_trait]
impl AppStoreVersionsApi for Client {
    async fn list_app_store_versions(
        &self,
        app_id: &str,
        filter_platform: Option<Platform>,
    ) -> Result<Vec<AppStoreVersion>> {
        let path = format!("/v1/apps/{app_id}/appStoreVersions");
        let mut query = Vec::new();
        if let Some(platform) = filter_platform {
            query.push(("filter[platform]", platform.as_query_value()));
        }
        self.list_all::<AppStoreVersionAttributes>(&path, &query)
            .await
    }

    async fn get_app_store_version(&self, id: &str) -> Result<AppStoreVersion> {
        let path = format!("/v1/appStoreVersions/{id}");
        let doc: Document<AppStoreVersionAttributes> =
            self.request(Method::GET, &path, &[], None::<&()>).await?;
        Ok(doc.data)
    }

    async fn create_app_store_version(
        &self,
        app_id: &str,
        attributes: AppStoreVersionCreateAttributes,
    ) -> Result<AppStoreVersion> {
        let body = CreateBody {
            data: CreateData {
                resource_type: RESOURCE_TYPE,
                attributes,
                relationships: Some(AppStoreVersionRelationships {
                    app: ToOne {
                        data: ResourceId {
                            resource_type: crate::app::RESOURCE_TYPE,
                            id: app_id.to_string(),
                        },
                    },
                }),
            },
        };
        let doc: Document<AppStoreVersionAttributes> = self
            .request(Method::POST, "/v1/appStoreVersions", &[], Some(&body))
            .await?;
        Ok(doc.data)
    }

    async fn update_app_store_version(
        &self,
        id: &str,
        fields: AppStoreVersionUpdateFields,
    ) -> Result<AppStoreVersion> {
        let path = format!("/v1/appStoreVersions/{id}");
        let body = UpdateBody {
            data: UpdateData {
                resource_type: RESOURCE_TYPE,
                id: id.to_string(),
                attributes: fields,
            },
        };
        let doc: Document<AppStoreVersionAttributes> =
            self.request(Method::PATCH, &path, &[], Some(&body)).await?;
        Ok(doc.data)
    }

    async fn delete_app_store_version(&self, id: &str) -> Result<()> {
        let path = format!("/v1/appStoreVersions/{id}");
        self.request_no_content::<()>(Method::DELETE, &path, &[], None)
            .await
    }

    async fn set_app_store_version_build(
        &self,
        id: &str,
        build_id: &str,
    ) -> Result<AppStoreVersion> {
        let path = format!("/v1/appStoreVersions/{id}");
        let body = UpdateRelationshipsBody {
            data: UpdateRelationshipsData {
                resource_type: RESOURCE_TYPE,
                id: id.to_string(),
                relationships: AppStoreVersionBuildRelationship {
                    build: ToOne {
                        data: ResourceId {
                            resource_type: crate::build::RESOURCE_TYPE,
                            id: build_id.to_string(),
                        },
                    },
                },
            },
        };
        let doc: Document<AppStoreVersionAttributes> =
            self.request(Method::PATCH, &path, &[], Some(&body)).await?;
        Ok(doc.data)
    }

    async fn get_app_store_version_build(&self, id: &str) -> Result<Option<Build>> {
        let path = format!("/v1/appStoreVersions/{id}/build");
        let doc: OptionalDocument<BuildAttributes> =
            self.request(Method::GET, &path, &[], None::<&()>).await?;
        Ok(doc.data)
    }
}

/// The `relationships` payload for pointing an App Store Version at a
/// build. Its own type because App Store Connect wants a PATCH body that
/// carries relationships and no attributes.
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AppStoreVersionBuildRelationship {
    pub build: ToOne,
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    /// `PATCH` responses are deserialized as a whole
    /// [`AppStoreVersionAttributes`], so every attribute except `platform`
    /// has to stay optional — otherwise a response that carries only the
    /// platform (as a rename does) fails to parse after App Store Connect
    /// has already applied the update. Making one of these required turns
    /// this into a failure.
    #[test]
    fn a_version_response_omitting_every_optional_attribute_still_parses() {
        let doc: Document<AppStoreVersionAttributes> = serde_json::from_value(json!({
            "data": {
                "id": "b1f9f3a2-6f9a-4a4e-8a4f-3f5b0a9c0d11",
                "type": "appStoreVersions",
                "attributes": { "platform": "IOS" }
            }
        }))
        .unwrap();

        assert_eq!(doc.data.attributes.platform, Platform::Ios);
        assert!(doc.data.attributes.version_string.is_none());
        assert!(doc.data.attributes.copyright.is_none());
    }

    /// The other half of that contract: a response that does carry the
    /// attributes round-trips, so `versionString` is read back from the
    /// rename request's own reply.
    #[test]
    fn a_version_response_reads_back_the_renamed_string() {
        let doc: Document<AppStoreVersionAttributes> = serde_json::from_value(json!({
            "data": {
                "id": "b1f9f3a2-6f9a-4a4e-8a4f-3f5b0a9c0d11",
                "type": "appStoreVersions",
                "attributes": {
                    "platform": "MAC_OS",
                    "versionString": "1.1.0",
                    "appVersionState": "PREPARE_FOR_SUBMISSION",
                    "copyright": "2026 SplitFire AB"
                }
            }
        }))
        .unwrap();

        assert_eq!(doc.data.attributes.platform, Platform::MacOs);
        assert_eq!(doc.data.attributes.version_string.as_deref(), Some("1.1.0"));
        assert_eq!(
            doc.data.attributes.app_version_state.as_deref(),
            Some("PREPARE_FOR_SUBMISSION")
        );
    }

    /// Apple answers `{"data": null}` for a version with no build attached;
    /// that has to parse as "none", not as an error.
    #[test]
    fn a_null_build_body_parses_to_none() {
        let doc: OptionalDocument<BuildAttributes> =
            serde_json::from_value(json!({ "data": null })).unwrap();
        assert!(doc.data.is_none());
    }

    #[test]
    fn a_populated_build_body_parses_with_its_version() {
        let doc: OptionalDocument<BuildAttributes> = serde_json::from_value(json!({
            "data": {
                "id": "build-1",
                "type": "builds",
                "attributes": {
                    "version": "42",
                    "processingState": "VALID",
                    "usesNonExemptEncryption": false
                }
            }
        }))
        .unwrap();

        let build = doc.data.unwrap();
        assert_eq!(build.id, "build-1");
        assert_eq!(build.attributes.version.as_deref(), Some("42"));
        assert_eq!(build.attributes.uses_non_exempt_encryption, Some(false));
    }
}