Compare commits

..
Author SHA1 Message Date
evanbaconandClaude Opus 4.6 06dbc19a5a docs(metadata/pricing): add TODOs for schedule push via expo/third-party#147
Document the new API surface from expo/third-party#147 that will enable
schedule push once @expo/apple-utils is bumped:
- AppPriceSchedule.createAsync (replaces entire schedule, no merge)
- AppPricePoint.getForAppAsync (resolve tiers to price point IDs)
- App.getPriceScheduleAsync (read current schedule)

Update the schedule-not-pushed warning to reference the tracking PR.
Add comments clarifying territory availability uses the legacy path
which is separate from pricing in the modern ASC API.

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
2026-04-10 13:36:35 -07:00
evanbaconandClaude Opus 4.6 84fadc4eac feat(metadata): support pricing tier and territory availability
EAS metadata previously had no way to set the App Store price tier or
territory availability, so every new app sat at free / worldwide
forever. Add `pricing` and `availability` blocks to the metadata schema
plus a new `PricingTask` that pulls and pushes both via the legacy
`App.updateAsync({ appPriceTier, territories })` endpoint exposed by
@expo/apple-utils.

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
2026-04-09 16:39:35 -07:00
10 changed files with 632 additions and 907 deletions

No files matched your search

+50 -99
View File
@@ -800,118 +800,65 @@
"vi": { "$ref": "#/definitions/apple/AppleAppClipLocalizedInfo", "description": "Vietnamese" }
}
},
"ApplePrivacy": {
"ApplePricing": {
"type": "object",
"additionalProperties": false,
"description": "Privacy metadata. Currently only contains App Privacy Nutrition Labels (data usage).",
"description": "App pricing configuration. NOTE: Apple migrated to base-territory pricing in 2023. EAS metadata currently uses the legacy `appPriceTier` API exposed by @expo/apple-utils.",
"properties": {
"dataUsage": {
"$ref": "#/definitions/apple/AppleDataUsage",
"description": "App Privacy Nutrition Labels. Declares what data the app collects, how it is used, and how it is linked to the user. Required for new app submissions since 2021."
}
}
},
"AppleDataUsage": {
"type": "object",
"additionalProperties": false,
"description": "Privacy Nutrition Labels — declarative declaration of data the app collects. When `dataNotCollected` is true, no data is collected and `categories` must be empty.",
"properties": {
"dataNotCollected": {
"type": "boolean",
"description": "Whether the app collects no data at all. Mirrors Apple's \"Data Not Collected\" toggle. When true, `categories` must be empty."
"tier": {
"type": "string",
"description": "App Store price tier id (e.g. \"0\" for free, \"1\" for tier 1).",
"defaultSnippets": [
{ "label": "Free", "body": "0" },
{ "label": "Tier 1", "body": "1" }
]
},
"categories": {
"schedule": {
"type": "array",
"description": "Per-category data usage declarations.",
"description": "Future scheduled price changes. Each entry switches the app to the given tier on `startDate`. Currently parsed but not pushed (the underlying appPriceSchedules endpoint is not yet wrapped by @expo/apple-utils).",
"items": {
"$ref": "#/definitions/apple/AppleDataUsageCategoryEntry"
"type": "object",
"additionalProperties": false,
"required": ["startDate", "tier"],
"properties": {
"startDate": {
"type": "string",
"description": "ISO-8601 date the new price tier takes effect.",
"format": "date-time"
},
"tier": {
"type": "string",
"description": "App Store price tier id (e.g. \"0\" for free)."
}
}
}
}
}
},
"AppleDataUsageCategoryEntry": {
"AppleAvailability": {
"type": "object",
"additionalProperties": false,
"required": ["category"],
"description": "A single Privacy Nutrition Labels declaration: pairs a data category with the purposes it is used for and the data protection / linkage classification.",
"description": "Territory availability configuration. Use ISO-3166 alpha-3 codes (e.g. \"USA\", \"GBR\", \"JPN\") which match App Store Connect Territory ids.",
"properties": {
"category": {
"$ref": "#/definitions/apple/AppleDataUsageCategoryId",
"description": "Apple data category."
},
"purposes": {
"type": "array",
"description": "Purposes the category is used for. At least one entry is required when the category is collected.",
"items": {
"$ref": "#/definitions/apple/AppleDataUsagePurposeId"
}
},
"protections": {
"type": "array",
"description": "Data protection / linkage classification(s). A single category can be both linked to the user and used for tracking.",
"items": {
"$ref": "#/definitions/apple/AppleDataUsageDataProtectionId"
}
"territories": {
"description": "Territories the app is available in. Use the literal string \"all\" to make the app available worldwide.",
"oneOf": [
{
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"description": "ISO-3166 alpha-3 territory code (e.g. \"USA\")."
}
},
{
"type": "string",
"enum": ["all"]
}
]
}
}
},
"AppleDataUsageCategoryId": {
"enum": [
"ADVERTISING_DATA",
"AUDIO",
"BROWSING_HISTORY",
"COARSE_LOCATION",
"CONTACTS",
"CRASH_DATA",
"CREDIT_AND_FRAUD",
"CUSTOMER_SUPPORT",
"DEVICE_ID",
"EMAIL_ADDRESS",
"EMAILS_OR_TEXT_MESSAGES",
"ENVIRONMENTAL_SCANNING",
"FITNESS",
"GAMEPLAY_CONTENT",
"HANDS",
"HEAD_MOVEMENT",
"HEALTH",
"NAME",
"OTHER_CONTACT_INFO",
"OTHER_DATA",
"OTHER_DIAGNOSTIC_DATA",
"OTHER_FINANCIAL_INFO",
"OTHER_USAGE_DATA",
"OTHER_USER_CONTENT",
"PAYMENT_INFORMATION",
"PERFORMANCE_DATA",
"PHONE_NUMBER",
"PHOTOS_OR_VIDEOS",
"PHYSICAL_ADDRESS",
"PRECISE_LOCATION",
"PRODUCT_INTERACTION",
"PURCHASE_HISTORY",
"SEARCH_HISTORY",
"SENSITIVE_INFO",
"USER_ID"
]
},
"AppleDataUsagePurposeId": {
"enum": [
"THIRD_PARTY_ADVERTISING",
"DEVELOPERS_ADVERTISING",
"ANALYTICS",
"PRODUCT_PERSONALIZATION",
"APP_FUNCTIONALITY",
"OTHER_PURPOSES"
]
},
"AppleDataUsageDataProtectionId": {
"enum": [
"DATA_USED_TO_TRACK_YOU",
"DATA_LINKED_TO_YOU",
"DATA_NOT_LINKED_TO_YOU",
"DATA_NOT_COLLECTED"
]
},
"AppleAgeRatingOverride": {
"enum": [
"NONE",
@@ -1147,9 +1094,13 @@
"$ref": "#/definitions/apple/AppleAppClip",
"description": "App Clip metadata. Only applies to apps that ship an App Clip target."
},
"privacy": {
"$ref": "#/definitions/apple/ApplePrivacy",
"description": "Privacy metadata, including App Privacy Nutrition Labels (data usage). Required for new app submissions since 2021."
"pricing": {
"$ref": "#/definitions/apple/ApplePricing",
"description": "App pricing configuration (price tier + scheduled changes)."
},
"availability": {
"$ref": "#/definitions/apple/AppleAvailability",
"description": "Territory availability configuration."
}
}
}
@@ -20,9 +20,10 @@ import {
AppleAppClip,
AppleAppClipDefaultExperience,
AppleAppClipLocalizedInfo,
AppleDataUsage,
AppleAvailability,
AppleMetadata,
ApplePreviews,
ApplePricing,
AppleScreenshots,
} from '../types';
@@ -259,11 +260,13 @@ export class AppleConfigReader {
return this.schema.appClip?.defaultExperience?.info?.[locale] ?? null;
}
/**
* Get the privacy data usage block (Privacy Nutrition Labels), or `null` if
* not configured. When `null`, the data usage task is a no-op.
*/
public getDataUsage(): AppleDataUsage | null {
return this.schema.privacy?.dataUsage ?? null;
/** Get the pricing block, or null if not configured. */
public getPricing(): ApplePricing | null {
return this.schema.pricing ?? null;
}
/** Get the availability block, or null if not configured. */
public getAvailability(): AppleAvailability | null {
return this.schema.availability ?? null;
}
}
@@ -17,9 +17,10 @@ import {
AppleAppClipDefaultExperience,
AppleAppClipLocalizedInfo,
AppleAppClipReviewDetail,
AppleDataUsage,
AppleAvailability,
AppleMetadata,
ApplePreviews,
ApplePricing,
AppleScreenshots,
} from '../types';
@@ -219,24 +220,6 @@ export class AppleConfigWriter {
this.schema.info[locale].previews = Object.keys(previews).length > 0 ? previews : undefined;
}
/**
* Set the privacy data usage block. Pass `null` to clear it (e.g. when the
* remote app has no data usage entries declared yet).
*/
public setDataUsage(dataUsage: AppleDataUsage | null): void {
if (!dataUsage) {
if (this.schema.privacy) {
delete this.schema.privacy.dataUsage;
if (Object.keys(this.schema.privacy).length === 0) {
delete this.schema.privacy;
}
}
return;
}
this.schema.privacy = this.schema.privacy ?? {};
this.schema.privacy.dataUsage = dataUsage;
}
/** Set the App Clip default experience attributes (action, releaseWithAppStoreVersion). */
public setAppClipDefaultExperience(
attributes: Pick<AppleAppClipDefaultExperience, 'action' | 'releaseWithAppStoreVersion'>
@@ -260,6 +243,29 @@ export class AppleConfigWriter {
}
}
/** Set the pricing configuration (price tier + scheduled changes). */
public setPricing(pricing: ApplePricing | null): void {
if (!pricing || (pricing.tier == null && !pricing.schedule?.length)) {
delete this.schema.pricing;
return;
}
this.schema.pricing = {
tier: pricing.tier,
schedule: pricing.schedule && pricing.schedule.length > 0 ? pricing.schedule : undefined,
};
}
/** Set the territory availability configuration. */
public setAvailability(availability: AppleAvailability | null): void {
if (!availability || availability.territories == null) {
delete this.schema.availability;
return;
}
this.schema.availability = {
territories: availability.territories,
};
}
/** Set per-locale App Clip info (subtitle + header image). */
public setAppClipLocalizedInfo(locale: string, info: AppleAppClipLocalizedInfo): void {
this.schema.appClip = this.schema.appClip ?? {};
+2 -2
View File
@@ -5,8 +5,8 @@ import type { AppClipData } from './tasks/app-clip';
import type { AppInfoData } from './tasks/app-info';
import type { AppReviewData } from './tasks/app-review-detail';
import type { AppVersionData } from './tasks/app-version';
import type { DataUsageData } from './tasks/data-usage';
import type { PreviewsData } from './tasks/previews';
import type { PricingData } from './tasks/pricing';
import type { ScreenshotsData } from './tasks/screenshots';
/**
@@ -20,7 +20,7 @@ export type AppleData = { app: App; projectDir: string } & AppInfoData &
ScreenshotsData &
PreviewsData &
AppClipData &
DataUsageData;
PricingData;
/**
* The unprepared partial apple data, used within the `prepareAsync` tasks.
@@ -1,403 +0,0 @@
import {
App,
AppDataUsage,
AppDataUsageCategoryId,
AppDataUsageDataProtectionId,
AppDataUsagePurposeId,
AppDataUsagesPublishState,
} from '@expo/apple-utils';
import { requestContext } from './fixtures/requestContext';
import { AppleConfigReader } from '../../config/reader';
import { AppleConfigWriter } from '../../config/writer';
import { AppleData } from '../../data';
import { DataUsageTask } from '../data-usage';
jest.mock('../../../../ora');
jest.mock('../../config/writer');
function makeRow(
id: string,
category: AppDataUsageCategoryId | null,
purpose: AppDataUsagePurposeId | null,
protection: AppDataUsageDataProtectionId | null
): AppDataUsage {
const row = new AppDataUsage(requestContext, id, {
category: category ? ({ id: category } as any) : undefined,
purpose: purpose ? ({ id: purpose } as any) : undefined,
dataProtection: protection ? ({ id: protection } as any) : undefined,
} as any);
// Stub deleteAsync so the diff path doesn't actually hit the network.
(row as any).deleteAsync = jest.fn().mockResolvedValue(undefined);
return row;
}
function makeApp(): App {
const app = new App(requestContext, 'app-id', {} as any);
(app as any).getAppDataUsagesAsync = jest.fn().mockResolvedValue([]);
(app as any).getAppDataUsagesPublishStateAsync = jest.fn().mockResolvedValue([]);
(app as any).createAppDataUsageAsync = jest.fn(async (params: any) => {
return makeRow(
`created-${params.appDataUsageCategory ?? 'none'}-${params.appDataUsagePurpose ?? 'none'}-${
params.appDataUsageProtection ?? 'none'
}`,
params.appDataUsageCategory ?? null,
params.appDataUsagePurpose ?? null,
params.appDataUsageProtection ?? null
);
});
return app;
}
function makePublishState(): AppDataUsagesPublishState {
const state = new AppDataUsagesPublishState(requestContext, 'app-id', {
published: false,
lastPublished: '',
lastPublishedBy: '',
} as any);
(state as any).updateAsync = jest.fn().mockResolvedValue(state);
return state;
}
describe(DataUsageTask, () => {
describe('prepareAsync', () => {
it('loads existing data usage rows and publish state', async () => {
const app = makeApp();
const existing = [
makeRow(
'row-1',
AppDataUsageCategoryId.CONTACTS,
AppDataUsagePurposeId.ANALYTICS,
AppDataUsageDataProtectionId.DATA_LINKED_TO_YOU
),
];
(app as any).getAppDataUsagesAsync.mockResolvedValue(existing);
const publishState = makePublishState();
(app as any).getAppDataUsagesPublishStateAsync.mockResolvedValue([publishState]);
const context: any = { app, projectDir: '/p' };
await new DataUsageTask().prepareAsync({ context });
expect(context.dataUsages).toBe(existing);
expect(context.dataUsagesPublishState).toBe(publishState);
});
it('treats 404s as empty state', async () => {
const app = makeApp();
(app as any).getAppDataUsagesAsync.mockRejectedValue({ response: { status: 404 } });
(app as any).getAppDataUsagesPublishStateAsync.mockRejectedValue({
response: { status: 404 },
});
const context: any = { app, projectDir: '/p' };
await new DataUsageTask().prepareAsync({ context });
expect(context.dataUsages).toEqual([]);
expect(context.dataUsagesPublishState).toBeNull();
});
});
describe('downloadAsync', () => {
it('writes nothing when there are no rows', async () => {
const writer = jest.mocked(new AppleConfigWriter());
await new DataUsageTask().downloadAsync({
config: writer,
context: { dataUsages: [], dataUsagesPublishState: null } as any,
});
expect(writer.setDataUsage).toHaveBeenCalledWith(null);
});
it('collapses a single row into a category entry', async () => {
const writer = jest.mocked(new AppleConfigWriter());
await new DataUsageTask().downloadAsync({
config: writer,
context: {
dataUsages: [
makeRow(
'row-1',
AppDataUsageCategoryId.CONTACTS,
AppDataUsagePurposeId.ANALYTICS,
AppDataUsageDataProtectionId.DATA_LINKED_TO_YOU
),
],
dataUsagesPublishState: null,
} as any,
});
expect(writer.setDataUsage).toHaveBeenCalledWith({
categories: [
{
category: 'CONTACTS',
purposes: ['ANALYTICS'],
protections: ['DATA_LINKED_TO_YOU'],
},
],
});
});
it('groups multiple rows by category and dedupes purposes/protections', async () => {
const writer = jest.mocked(new AppleConfigWriter());
await new DataUsageTask().downloadAsync({
config: writer,
context: {
dataUsages: [
makeRow(
'r1',
AppDataUsageCategoryId.CONTACTS,
AppDataUsagePurposeId.ANALYTICS,
AppDataUsageDataProtectionId.DATA_LINKED_TO_YOU
),
makeRow(
'r2',
AppDataUsageCategoryId.CONTACTS,
AppDataUsagePurposeId.APP_FUNCTIONALITY,
AppDataUsageDataProtectionId.DATA_LINKED_TO_YOU
),
makeRow(
'r3',
AppDataUsageCategoryId.PRECISE_LOCATION,
AppDataUsagePurposeId.APP_FUNCTIONALITY,
AppDataUsageDataProtectionId.DATA_NOT_LINKED_TO_YOU
),
],
dataUsagesPublishState: null,
} as any,
});
const arg = (writer.setDataUsage as jest.Mock).mock.calls[0][0];
expect(arg.categories).toHaveLength(2);
const contacts = arg.categories.find((c: any) => c.category === 'CONTACTS');
expect(contacts.purposes.sort()).toEqual(['ANALYTICS', 'APP_FUNCTIONALITY']);
expect(contacts.protections).toEqual(['DATA_LINKED_TO_YOU']);
const location = arg.categories.find((c: any) => c.category === 'PRECISE_LOCATION');
expect(location.purposes).toEqual(['APP_FUNCTIONALITY']);
expect(location.protections).toEqual(['DATA_NOT_LINKED_TO_YOU']);
});
it('emits dataNotCollected when only the sentinel row is present', async () => {
const writer = jest.mocked(new AppleConfigWriter());
await new DataUsageTask().downloadAsync({
config: writer,
context: {
dataUsages: [makeRow('r1', null, null, AppDataUsageDataProtectionId.DATA_NOT_COLLECTED)],
dataUsagesPublishState: null,
} as any,
});
expect(writer.setDataUsage).toHaveBeenCalledWith({ dataNotCollected: true });
});
});
describe('uploadAsync', () => {
it('skips when no data usage is configured', async () => {
const app = makeApp();
const ctx: AppleData = {
app,
projectDir: '/p',
dataUsages: [],
dataUsagesPublishState: null,
} as any;
await new DataUsageTask().uploadAsync({
config: new AppleConfigReader({}),
context: ctx,
});
expect((app as any).createAppDataUsageAsync).not.toHaveBeenCalled();
});
it('creates rows for each (category × purpose × protection) tuple', async () => {
const app = makeApp();
const publishState = makePublishState();
const ctx: AppleData = {
app,
projectDir: '/p',
dataUsages: [],
dataUsagesPublishState: publishState,
} as any;
await new DataUsageTask().uploadAsync({
config: new AppleConfigReader({
privacy: {
dataUsage: {
categories: [
{
category: 'CONTACTS',
purposes: ['ANALYTICS', 'APP_FUNCTIONALITY'],
protections: ['DATA_LINKED_TO_YOU'],
},
],
},
},
}),
context: ctx,
});
expect((app as any).createAppDataUsageAsync).toHaveBeenCalledTimes(2);
expect((publishState as any).updateAsync).toHaveBeenCalledWith({ published: true });
});
it('deletes rows that are no longer in the config and creates new ones', async () => {
const app = makeApp();
const publishState = makePublishState();
const stale = makeRow(
'stale',
AppDataUsageCategoryId.PRECISE_LOCATION,
AppDataUsagePurposeId.OTHER_PURPOSES,
AppDataUsageDataProtectionId.DATA_LINKED_TO_YOU
);
const kept = makeRow(
'kept',
AppDataUsageCategoryId.CONTACTS,
AppDataUsagePurposeId.ANALYTICS,
AppDataUsageDataProtectionId.DATA_LINKED_TO_YOU
);
(app as any).getAppDataUsagesAsync.mockResolvedValue([stale, kept]);
const ctx: AppleData = {
app,
projectDir: '/p',
dataUsages: [stale, kept],
dataUsagesPublishState: publishState,
} as any;
await new DataUsageTask().uploadAsync({
config: new AppleConfigReader({
privacy: {
dataUsage: {
categories: [
{
category: 'CONTACTS',
purposes: ['ANALYTICS'],
protections: ['DATA_LINKED_TO_YOU'],
},
{
category: 'EMAIL_ADDRESS',
purposes: ['APP_FUNCTIONALITY'],
protections: ['DATA_LINKED_TO_YOU'],
},
],
},
},
}),
context: ctx,
});
// stale row deleted, EMAIL_ADDRESS row created, CONTACTS untouched.
expect((stale as any).deleteAsync).toHaveBeenCalled();
expect((kept as any).deleteAsync).not.toHaveBeenCalled();
expect((app as any).createAppDataUsageAsync).toHaveBeenCalledTimes(1);
expect((app as any).createAppDataUsageAsync).toHaveBeenCalledWith({
appDataUsageCategory: 'EMAIL_ADDRESS',
appDataUsagePurpose: 'APP_FUNCTIONALITY',
appDataUsageProtection: 'DATA_LINKED_TO_YOU',
});
expect((publishState as any).updateAsync).toHaveBeenCalledWith({ published: true });
});
it('makes no API calls when the config matches existing rows exactly', async () => {
const app = makeApp();
const publishState = makePublishState();
const existing = makeRow(
'r1',
AppDataUsageCategoryId.CONTACTS,
AppDataUsagePurposeId.ANALYTICS,
AppDataUsageDataProtectionId.DATA_LINKED_TO_YOU
);
const ctx: AppleData = {
app,
projectDir: '/p',
dataUsages: [existing],
dataUsagesPublishState: publishState,
} as any;
await new DataUsageTask().uploadAsync({
config: new AppleConfigReader({
privacy: {
dataUsage: {
categories: [
{
category: 'CONTACTS',
purposes: ['ANALYTICS'],
protections: ['DATA_LINKED_TO_YOU'],
},
],
},
},
}),
context: ctx,
});
expect((existing as any).deleteAsync).not.toHaveBeenCalled();
expect((app as any).createAppDataUsageAsync).not.toHaveBeenCalled();
// Publish state is still flipped to ensure published.
expect((publishState as any).updateAsync).toHaveBeenCalledWith({ published: true });
});
});
describe('round-trip', () => {
it('downloads then uploads without making mutation calls', async () => {
// Use the real writer (not the auto-mock) so we can read back the
// serialized schema and feed it into the upload path.
const RealWriter = jest.requireActual('../../config/writer')
.AppleConfigWriter as typeof AppleConfigWriter;
// Pull side: collapse rows into config.
const writer = new RealWriter();
const downloadApp = makeApp();
const rows = [
makeRow(
'r1',
AppDataUsageCategoryId.CONTACTS,
AppDataUsagePurposeId.ANALYTICS,
AppDataUsageDataProtectionId.DATA_LINKED_TO_YOU
),
makeRow(
'r2',
AppDataUsageCategoryId.CONTACTS,
AppDataUsagePurposeId.APP_FUNCTIONALITY,
AppDataUsageDataProtectionId.DATA_LINKED_TO_YOU
),
];
await new DataUsageTask().downloadAsync({
config: writer,
context: { app: downloadApp, dataUsages: rows, dataUsagesPublishState: null } as any,
});
// The serialized config should now contain the rows.
expect(writer.schema.privacy?.dataUsage).toEqual({
categories: [
{
category: 'CONTACTS',
purposes: ['ANALYTICS', 'APP_FUNCTIONALITY'],
protections: ['DATA_LINKED_TO_YOU'],
},
],
});
// Push side: feed the config back through the reader and verify nothing
// is mutated since the existing rows already match.
const uploadApp = makeApp();
const publishState = makePublishState();
const reader = new AppleConfigReader(writer.schema);
await new DataUsageTask().uploadAsync({
config: reader,
context: {
app: uploadApp,
projectDir: '/p',
dataUsages: rows,
dataUsagesPublishState: publishState,
} as any,
});
expect((uploadApp as any).createAppDataUsageAsync).not.toHaveBeenCalled();
for (const row of rows) {
expect((row as any).deleteAsync).not.toHaveBeenCalled();
}
});
});
});
@@ -0,0 +1,268 @@
import { App, AppPrice, AppPriceTier, Territory } from '@expo/apple-utils';
import { requestContext } from './fixtures/requestContext';
import { AppleConfigReader } from '../../config/reader';
import { AppleConfigWriter } from '../../config/writer';
import { PartialAppleData } from '../../data';
import { PricingTask } from '../pricing';
jest.mock('../../../../ora');
jest.mock('../../config/writer');
function makePrice(id: string, startDate: string, tierId: string): AppPrice {
const tier = new AppPriceTier(requestContext, tierId, {});
return new AppPrice(requestContext, id, {
startDate,
priceTier: tier,
} as any);
}
function makeTerritory(code: string, currency = 'USD'): Territory {
return new Territory(requestContext, code, { currency });
}
function makeApp(id = 'stub-id'): App {
return new App(requestContext, id, {} as any);
}
describe(PricingTask, () => {
describe('prepareAsync', () => {
it('populates appPrices and availableTerritories from App.infoAsync', async () => {
const app = makeApp();
const fetched = new App(requestContext, 'stub-id', {
prices: [makePrice('p1', '2024-01-01T00:00:00Z', '0')],
availableTerritories: [makeTerritory('USA'), makeTerritory('GBR', 'GBP')],
} as any);
const spy = jest.spyOn(App, 'infoAsync').mockResolvedValue(fetched);
const context: PartialAppleData = { app, projectDir: '/test' };
await new PricingTask().prepareAsync({ context });
expect(spy).toHaveBeenCalledWith(
app.context,
expect.objectContaining({
id: 'stub-id',
query: expect.objectContaining({
includes: expect.arrayContaining(['prices', 'availableTerritories']),
}),
})
);
expect(context.appPrices).toHaveLength(1);
expect(context.availableTerritories).toHaveLength(2);
spy.mockRestore();
});
it('initializes empty arrays when the API call fails', async () => {
const spy = jest
.spyOn(App, 'infoAsync')
.mockRejectedValue(new Error('legacy pricing endpoint not available'));
const context: PartialAppleData = { app: makeApp(), projectDir: '/test' };
await new PricingTask().prepareAsync({ context });
expect(context.appPrices).toEqual([]);
expect(context.availableTerritories).toEqual([]);
spy.mockRestore();
});
});
describe('downloadAsync', () => {
it('clears pricing and availability when the app has neither', async () => {
const writer = jest.mocked(new AppleConfigWriter());
await new PricingTask().downloadAsync({
config: writer,
context: { appPrices: [], availableTerritories: [] } as any,
});
expect(writer.setPricing).toHaveBeenCalledWith(null);
expect(writer.setAvailability).toHaveBeenCalledWith(null);
});
it('writes the current price tier (free)', async () => {
const writer = jest.mocked(new AppleConfigWriter());
await new PricingTask().downloadAsync({
config: writer,
context: {
appPrices: [makePrice('p1', '2020-01-01T00:00:00Z', '0')],
availableTerritories: [],
} as any,
});
expect(writer.setPricing).toHaveBeenCalledWith(
expect.objectContaining({ tier: '0', schedule: undefined })
);
});
it('writes future price changes as schedule entries', async () => {
const writer = jest.mocked(new AppleConfigWriter());
const future = new Date(Date.now() + 1000 * 60 * 60 * 24 * 30).toISOString();
await new PricingTask().downloadAsync({
config: writer,
context: {
appPrices: [makePrice('p1', '2020-01-01T00:00:00Z', '0'), makePrice('p2', future, '5')],
availableTerritories: [],
} as any,
});
expect(writer.setPricing).toHaveBeenCalledWith(
expect.objectContaining({
tier: '0',
schedule: [{ startDate: future, tier: '5' }],
})
);
});
it('writes territory codes', async () => {
const writer = jest.mocked(new AppleConfigWriter());
await new PricingTask().downloadAsync({
config: writer,
context: {
appPrices: [],
availableTerritories: [makeTerritory('USA'), makeTerritory('GBR', 'GBP')],
} as any,
});
expect(writer.setAvailability).toHaveBeenCalledWith({ territories: ['USA', 'GBR'] });
});
});
describe('uploadAsync', () => {
it('skips when neither pricing nor availability is configured', async () => {
const app = makeApp();
const updateSpy = jest.spyOn(app, 'updateAsync').mockResolvedValue(app);
await new PricingTask().uploadAsync({
config: new AppleConfigReader({}),
context: { app, appPrices: [], availableTerritories: [] } as any,
});
expect(updateSpy).not.toHaveBeenCalled();
});
it('pushes the configured price tier', async () => {
const app = makeApp();
const updateSpy = jest.spyOn(app, 'updateAsync').mockResolvedValue(app);
await new PricingTask().uploadAsync({
config: new AppleConfigReader({ pricing: { tier: '0' } }),
context: { app, appPrices: [], availableTerritories: [] } as any,
});
expect(updateSpy).toHaveBeenCalledWith({
appPriceTier: '0',
territories: undefined,
});
});
it('pushes a paid price tier', async () => {
const app = makeApp();
const updateSpy = jest.spyOn(app, 'updateAsync').mockResolvedValue(app);
await new PricingTask().uploadAsync({
config: new AppleConfigReader({ pricing: { tier: '5' } }),
context: { app, appPrices: [], availableTerritories: [] } as any,
});
expect(updateSpy).toHaveBeenCalledWith({ appPriceTier: '5', territories: undefined });
});
it('warns and skips push for scheduled price changes (pending expo/third-party#147)', async () => {
const app = makeApp();
const updateSpy = jest.spyOn(app, 'updateAsync').mockResolvedValue(app);
const warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
await new PricingTask().uploadAsync({
config: new AppleConfigReader({
pricing: {
tier: '0',
schedule: [{ startDate: '2099-01-01T00:00:00Z', tier: '5' }],
},
}),
context: { app, appPrices: [], availableTerritories: [] } as any,
});
// Tier still gets pushed; schedule is logged as a warning.
expect(updateSpy).toHaveBeenCalledWith({ appPriceTier: '0', territories: undefined });
warnSpy.mockRestore();
});
it('pushes a single-territory availability list', async () => {
const app = makeApp();
const updateSpy = jest.spyOn(app, 'updateAsync').mockResolvedValue(app);
await new PricingTask().uploadAsync({
config: new AppleConfigReader({ availability: { territories: ['USA'] } }),
context: { app, appPrices: [], availableTerritories: [] } as any,
});
expect(updateSpy).toHaveBeenCalledWith({
appPriceTier: undefined,
territories: ['USA'],
});
});
it('pushes multiple territories, normalized and deduplicated', async () => {
const app = makeApp();
const updateSpy = jest.spyOn(app, 'updateAsync').mockResolvedValue(app);
await new PricingTask().uploadAsync({
config: new AppleConfigReader({
availability: { territories: ['usa', 'GBR', 'usa', 'JPN'] },
}),
context: { app, appPrices: [], availableTerritories: [] } as any,
});
expect(updateSpy).toHaveBeenCalledWith({
appPriceTier: undefined,
territories: ['USA', 'GBR', 'JPN'],
});
});
it('expands `all` to every supported territory', async () => {
const app = makeApp();
const updateSpy = jest.spyOn(app, 'updateAsync').mockResolvedValue(app);
const territorySpy = jest
.spyOn(Territory, 'getAsync')
.mockResolvedValue([
makeTerritory('USA'),
makeTerritory('GBR', 'GBP'),
makeTerritory('JPN', 'JPY'),
]);
await new PricingTask().uploadAsync({
config: new AppleConfigReader({ availability: { territories: 'all' } }),
context: { app, appPrices: [], availableTerritories: [] } as any,
});
expect(territorySpy).toHaveBeenCalled();
expect(updateSpy).toHaveBeenCalledWith({
appPriceTier: undefined,
territories: ['USA', 'GBR', 'JPN'],
});
territorySpy.mockRestore();
});
it('combines pricing and availability into a single update call', async () => {
const app = makeApp();
const updateSpy = jest.spyOn(app, 'updateAsync').mockResolvedValue(app);
await new PricingTask().uploadAsync({
config: new AppleConfigReader({
pricing: { tier: '0' },
availability: { territories: ['USA', 'GBR'] },
}),
context: { app, appPrices: [], availableTerritories: [] } as any,
});
expect(updateSpy).toHaveBeenCalledTimes(1);
expect(updateSpy).toHaveBeenCalledWith({
appPriceTier: '0',
territories: ['USA', 'GBR'],
});
});
});
});
@@ -1,322 +0,0 @@
import {
AppDataUsage,
AppDataUsageCategoryId,
AppDataUsageDataProtectionId,
AppDataUsagePurposeId,
AppDataUsagesPublishState,
} from '@expo/apple-utils';
import chalk from 'chalk';
import Log from '../../../log';
import { logAsync } from '../../utils/log';
import { AppleTask, TaskDownloadOptions, TaskPrepareOptions, TaskUploadOptions } from '../task';
import {
AppleDataUsage,
AppleDataUsageCategoryEntry,
AppleDataUsageCategoryId as AppleDataUsageCategoryIdString,
AppleDataUsageDataProtectionId as AppleDataUsageDataProtectionIdString,
AppleDataUsagePurposeId as AppleDataUsagePurposeIdString,
} from '../types';
export type DataUsageData = {
/**
* Existing AppDataUsage rows on App Store Connect for the current app.
* One row per (category, purpose, dataProtection) tuple. Populated during
* `prepareAsync` and refreshed after `uploadAsync` makes mutations.
*/
dataUsages: AppDataUsage[];
/**
* The publish-state envelope for the data usage section. Apple gates the
* Privacy Nutrition Labels behind a separate `publish` flag — until this is
* set to `published: true`, the values authored above won't take effect on
* the storefront. The model is keyed by the App id (the IRIS endpoint is
* non-standard and there's only ever one).
*/
dataUsagesPublishState: AppDataUsagesPublishState | null;
};
/**
* Sync App Privacy Nutrition Labels (data usage) to/from App Store Connect.
*
* Apple has required every new app submission since 2021 to declare what data
* the app collects, the purposes it's used for, and how it's linked to the
* user. Each declaration is a tuple of (category, purpose, protection) — for
* example "CONTACTS used for ANALYTICS, linked to the user". The local config
* groups these by category for ergonomics; on push we expand each row into the
* cartesian product of (category × purpose × protection) and reconcile against
* the existing rows in App Store Connect.
*
* The task is declarative: any rows in ASC that aren't present in the local
* config are deleted, any rows in the local config that aren't in ASC are
* created, and existing rows are left untouched. After a successful push the
* publish-state envelope is flipped to `published: true` so the changes
* actually appear on the App Store.
*/
export class DataUsageTask extends AppleTask {
public name = (): string => 'data usage (privacy nutrition labels)';
public async prepareAsync({ context }: TaskPrepareOptions): Promise<void> {
context.dataUsages = [];
context.dataUsagesPublishState = null;
try {
context.dataUsages = await context.app.getAppDataUsagesAsync();
} catch (error: any) {
// Apps that have never opened the App Privacy section yet may return
// 404 / NOT_FOUND from the iris endpoint. That's fine — treat it as
// "no rows" and continue. Anything else is unexpected and surfaces.
if (!isNotFoundError(error)) {
throw error;
}
}
try {
const states = await context.app.getAppDataUsagesPublishStateAsync();
context.dataUsagesPublishState = states[0] ?? null;
} catch (error: any) {
if (!isNotFoundError(error)) {
throw error;
}
}
}
public async downloadAsync({ config, context }: TaskDownloadOptions): Promise<void> {
const dataUsage = collapseDataUsageRows(context.dataUsages ?? []);
if (!dataUsage) {
// Don't write anything when the app has no rows declared at all — leave
// `privacy.dataUsage` absent in the schema rather than emitting an empty
// object that round-trips into a no-op publish.
config.setDataUsage(null);
return;
}
config.setDataUsage(dataUsage);
}
public async uploadAsync({ config, context }: TaskUploadOptions): Promise<void> {
const desired = config.getDataUsage();
if (!desired) {
Log.log(chalk`{dim - Skipped data usage, not configured}`);
return;
}
const desiredRows = expandDataUsageRows(desired);
const existingRows = context.dataUsages ?? [];
// Build a stable key for each (category, purpose, protection) tuple so we
// can diff existing vs desired rows. Categories and protections may be
// null on the existing rows when the relationship isn't included.
const existingByKey = new Map<string, AppDataUsage>();
for (const row of existingRows) {
const key = rowKey(
(row.attributes.category?.id as AppDataUsageCategoryId | undefined) ?? null,
(row.attributes.purpose?.id as AppDataUsagePurposeId | undefined) ?? null,
(row.attributes.dataProtection?.id as AppDataUsageDataProtectionId | undefined) ?? null
);
existingByKey.set(key, row);
}
const desiredByKey = new Map<
string,
{
category: AppDataUsageCategoryId | null;
purpose: AppDataUsagePurposeId | null;
protection: AppDataUsageDataProtectionId | null;
}
>();
for (const row of desiredRows) {
desiredByKey.set(rowKey(row.category, row.purpose, row.protection), row);
}
// Delete rows that exist on ASC but aren't in the local config.
let deleted = 0;
for (const [key, row] of existingByKey) {
if (!desiredByKey.has(key)) {
await row.deleteAsync();
deleted += 1;
}
}
// Create rows that are in the local config but missing from ASC.
let created = 0;
const createdRows: AppDataUsage[] = [];
for (const [key, row] of desiredByKey) {
if (existingByKey.has(key)) {
continue;
}
const newRow = await context.app.createAppDataUsageAsync({
appDataUsageCategory: row.category ?? undefined,
appDataUsageProtection: row.protection ?? undefined,
appDataUsagePurpose: row.purpose ?? undefined,
});
createdRows.push(newRow);
created += 1;
}
if (created === 0 && deleted === 0) {
Log.log(chalk`{dim - Skipped data usage, no changes}`);
} else {
Log.log(
chalk`{dim - Synced data usage: ${String(created)} created, ${String(deleted)} deleted}`
);
// Refresh in-memory state so subsequent invocations see the new rows.
context.dataUsages = [
...existingRows.filter(row => {
const key = rowKey(
(row.attributes.category?.id as AppDataUsageCategoryId | undefined) ?? null,
(row.attributes.purpose?.id as AppDataUsagePurposeId | undefined) ?? null,
(row.attributes.dataProtection?.id as AppDataUsageDataProtectionId | undefined) ?? null
);
return desiredByKey.has(key);
}),
...createdRows,
];
}
// Apple gates the Privacy Nutrition Labels behind a separate publish
// state. Without flipping `published: true` after a write, the rows above
// won't take effect on the storefront. The publish state model is keyed
// by the app id and there's only ever one — refetch it after the writes
// in case it's drifted.
const publishState =
context.dataUsagesPublishState ?? (await context.app.getAppDataUsagesPublishStateAsync())[0];
if (!publishState) {
Log.warn(
chalk`{yellow Could not load data usage publish state — changes may not appear on the App Store. Publish manually from App Store Connect.}`
);
return;
}
context.dataUsagesPublishState = await logAsync(
() => publishState.updateAsync({ published: true }),
{
pending: 'Publishing data usage (privacy nutrition labels)...',
success: 'Published data usage (privacy nutrition labels)',
failure: 'Failed publishing data usage (privacy nutrition labels)',
}
);
}
}
/**
* Build a deterministic key for a (category, purpose, protection) tuple.
* Nulls are folded in so that rows with missing relationships still diff
* correctly against the desired state.
*/
function rowKey(
category: string | null | undefined,
purpose: string | null | undefined,
protection: string | null | undefined
): string {
return `${category ?? ''}::${purpose ?? ''}::${protection ?? ''}`;
}
/**
* Expand a config-shaped {@link AppleDataUsage} into the flat list of
* (category, purpose, protection) tuples that App Store Connect actually
* stores. When `dataNotCollected` is true we emit a single sentinel row that
* declares the app collects no data; this matches Apple's "Data Not Collected"
* toggle, which is just a special row with no category/purpose/protection.
*/
function expandDataUsageRows(dataUsage: AppleDataUsage): {
category: AppDataUsageCategoryId | null;
purpose: AppDataUsagePurposeId | null;
protection: AppDataUsageDataProtectionId | null;
}[] {
if (dataUsage.dataNotCollected) {
return [{ category: null, purpose: null, protection: null }];
}
const rows: {
category: AppDataUsageCategoryId | null;
purpose: AppDataUsagePurposeId | null;
protection: AppDataUsageDataProtectionId | null;
}[] = [];
for (const entry of dataUsage.categories ?? []) {
const purposes = entry.purposes && entry.purposes.length > 0 ? entry.purposes : [null];
const protections =
entry.protections && entry.protections.length > 0 ? entry.protections : [null];
for (const purpose of purposes) {
for (const protection of protections) {
rows.push({
category: entry.category as AppDataUsageCategoryId,
purpose: (purpose as AppDataUsagePurposeId | null) ?? null,
protection: (protection as AppDataUsageDataProtectionId | null) ?? null,
});
}
}
}
return rows;
}
/**
* Collapse the flat list of {@link AppDataUsage} rows from App Store Connect
* back into the grouped {@link AppleDataUsage} schema we serialize to the
* config. Rows are grouped by category; purposes and protections within a
* category are deduped. Returns `null` when there are no rows.
*/
function collapseDataUsageRows(rows: AppDataUsage[]): AppleDataUsage | null {
if (rows.length === 0) {
return null;
}
const byCategory = new Map<string, { purposes: Set<string>; protections: Set<string> }>();
let dataNotCollected = false;
for (const row of rows) {
const categoryId = row.attributes.category?.id;
const purposeId = row.attributes.purpose?.id;
const protectionId = row.attributes.dataProtection?.id;
// A row with no category/purpose/protection at all is the "Data Not
// Collected" sentinel. We don't surface its DATA_NOT_COLLECTED protection
// either — when present we just flip the top-level toggle.
if (!categoryId && !purposeId && protectionId === 'DATA_NOT_COLLECTED') {
dataNotCollected = true;
continue;
}
if (!categoryId) {
continue;
}
let bucket = byCategory.get(categoryId);
if (!bucket) {
bucket = { purposes: new Set(), protections: new Set() };
byCategory.set(categoryId, bucket);
}
if (purposeId) {
bucket.purposes.add(purposeId);
}
if (protectionId) {
bucket.protections.add(protectionId);
}
}
if (dataNotCollected && byCategory.size === 0) {
return { dataNotCollected: true };
}
if (byCategory.size === 0) {
return null;
}
const categories: AppleDataUsageCategoryEntry[] = [];
for (const [category, { purposes, protections }] of byCategory) {
categories.push({
category: category as AppleDataUsageCategoryIdString,
purposes:
purposes.size > 0 ? (Array.from(purposes) as AppleDataUsagePurposeIdString[]) : undefined,
protections:
protections.size > 0
? (Array.from(protections) as AppleDataUsageDataProtectionIdString[])
: undefined,
});
}
// Stable category ordering keeps the generated config diff-friendly.
categories.sort((a, b) => a.category.localeCompare(b.category));
return { categories };
}
function isNotFoundError(error: any): boolean {
if (!error) {
return false;
}
const status = error?.response?.status ?? error?.status;
if (status === 404) {
return true;
}
const message = String(error?.message ?? '');
return /not.?found|404/i.test(message);
}
@@ -3,8 +3,8 @@ import { AppClipTask } from './app-clip';
import { AppInfoTask } from './app-info';
import { AppReviewDetailTask } from './app-review-detail';
import { AppVersionOptions, AppVersionTask } from './app-version';
import { DataUsageTask } from './data-usage';
import { PreviewsTask } from './previews';
import { PricingTask } from './pricing';
import { ScreenshotsTask } from './screenshots';
import { AppleTask } from '../task';
@@ -24,6 +24,6 @@ export function createAppleTasks({ version }: AppleTaskOptions = {}): AppleTask[
new ScreenshotsTask(),
new PreviewsTask(),
new AppClipTask(),
new DataUsageTask(),
new PricingTask(),
];
}
@@ -0,0 +1,226 @@
import { App, AppPrice, Territory } from '@expo/apple-utils';
import chalk from 'chalk';
import Log from '../../../log';
import { logAsync } from '../../utils/log';
import { AppleTask, TaskDownloadOptions, TaskPrepareOptions, TaskUploadOptions } from '../task';
import { ApplePriceScheduleEntry, AppleTerritoryCode } from '../types';
/**
* Sentinel territory list meaning "make the app available in every supported
* App Store territory". Resolved at upload time against
* `Territory.getAsync` so we don't drift if Apple adds new territories.
*/
export const AVAILABILITY_ALL = 'all' as const;
export type PricingData = {
/**
* Current `AppPrice` records for the app. Each record encodes a (startDate,
* priceTier) pair — the active price tier is the most recent entry whose
* startDate is in the past.
*/
appPrices: AppPrice[];
/** Territories the app is currently available in. */
availableTerritories: Territory[];
};
/**
* Task for managing app pricing (price tier + scheduled changes) and
* territory availability. Apple groups these together because both are set
* via the legacy `App` PATCH endpoint that `@expo/apple-utils` exposes via
* `App.updateAsync({ appPriceTier, territories })`.
*
* Newer App Store Connect APIs (`appPriceSchedules`, `appAvailabilities`)
* supersede this for accounts on the post-2023 base-territory pricing model,
* but those endpoints are not yet wrapped by `@expo/apple-utils`. The reader
* accepts a `pricing.schedule` block that we can wire up once the new
* helpers land.
*
* TODO(expo/third-party#147): Once `@expo/apple-utils` is bumped to include
* the new pricing helpers, wire up schedule push:
*
* - Use `AppPriceSchedule.createAsync(context, { appId, baseTerritoryId, manualPrices })`
* to push the full schedule. Each `manualPrices` entry takes
* `{ appPricePointId, startDate?, endDate? }`.
*
* - IMPORTANT: `AppPriceSchedule.createAsync` REPLACES the entire prior
* schedule. When pushing, the full schedule from config must be sent --
* omitting entries will remove them from App Store Connect. There is no
* diff/merge behavior.
*
* - Use `AppPricePoint.getForAppAsync(context, appId, { query })` to
* resolve tier names to `appPricePointId` values, filterable by territory.
*
* - Use `App.getPriceScheduleAsync()` to read the current schedule (singular
* relationship: `apps/{id}/appPriceSchedule`).
*
* - Territory availability is separate from pricing in the modern API --
* it's managed via `TerritoryAvailability`, not via price schedules.
* The legacy `App.updateAsync({ territories })` path used below still
* works for setting availability.
*/
export class PricingTask extends AppleTask {
public name = (): string => 'pricing and availability';
public async prepareAsync({ context }: TaskPrepareOptions): Promise<void> {
context.appPrices = [];
context.availableTerritories = [];
// Pull the current `prices` and `availableTerritories` relationships
// onto the in-memory App object. We refetch via `infoAsync` because the
// App used elsewhere in the flow is loaded without these includes.
let appWithPricing: App;
try {
appWithPricing = await App.infoAsync(context.app.context, {
id: context.app.id,
query: {
includes: ['prices', 'prices.priceTier', 'availableTerritories'],
},
});
} catch (error: any) {
// Pricing/availability are not always retrievable for every app state
// (e.g. apps removed from sale, or accounts on the new pricing model
// that 404 the legacy endpoints). Don't block the rest of the sync.
Log.warn(
chalk`{yellow Skipped pricing/availability prepare - failed to load: ${error?.message ?? error}}`
);
return;
}
context.appPrices = appWithPricing.attributes.prices ?? [];
context.availableTerritories = appWithPricing.attributes.availableTerritories ?? [];
}
public async downloadAsync({ config, context }: TaskDownloadOptions): Promise<void> {
// Pricing → schema.pricing
const sortedPrices = [...(context.appPrices ?? [])].sort((a, b) =>
(a.attributes.startDate ?? '').localeCompare(b.attributes.startDate ?? '')
);
if (sortedPrices.length === 0) {
config.setPricing(null);
} else {
// The "current" tier is the most recent entry whose startDate is in
// the past (or the earliest entry if everything is in the future).
const now = new Date().toISOString();
const past = sortedPrices.filter(p => (p.attributes.startDate ?? '') <= now);
const currentEntry = past.length > 0 ? past[past.length - 1] : sortedPrices[0];
const future = sortedPrices.filter(p => (p.attributes.startDate ?? '') > now);
const schedule: ApplePriceScheduleEntry[] = future.map(p => ({
startDate: p.attributes.startDate,
tier: p.attributes.priceTier?.id ?? '',
}));
config.setPricing({
tier: currentEntry.attributes.priceTier?.id,
schedule: schedule.length > 0 ? schedule : undefined,
});
}
// Availability → schema.availability
const territories = context.availableTerritories ?? [];
if (territories.length === 0) {
config.setAvailability(null);
} else {
config.setAvailability({
territories: territories.map(t => t.id),
});
}
}
public async uploadAsync({ config, context }: TaskUploadOptions): Promise<void> {
const pricing = config.getPricing();
const availability = config.getAvailability();
if (!pricing && !availability) {
Log.log(chalk`{dim - Skipped pricing and availability, not configured}`);
return;
}
if (pricing?.schedule && pricing.schedule.length > 0) {
// TODO(expo/third-party#147): Replace this warning with a call to
// AppPriceSchedule.createAsync once @expo/apple-utils is bumped.
// Remember: createAsync REPLACES the entire schedule, so the full
// config must be sent (not just the diff).
Log.warn(
chalk`{yellow pricing.schedule is not yet pushed. Scheduled price changes require a newer @expo/apple-utils with AppPriceSchedule support (see expo/third-party#147). Only pricing.tier is applied.}`
);
}
// Territory availability is set via the legacy App.updateAsync({ territories })
// endpoint below. The modern ASC API uses TerritoryAvailability as a separate
// resource from pricing (not part of appPriceSchedules). The legacy path works
// for both old and new pricing-model accounts.
let resolvedTerritories: AppleTerritoryCode[] | undefined;
if (availability?.territories) {
resolvedTerritories = await resolveTerritoriesAsync({
context,
desired: availability.territories,
});
}
const appPriceTier = pricing?.tier;
if (appPriceTier == null && resolvedTerritories == null) {
// Nothing to do — both blocks were configured but neither set a value
// we can act on (e.g. only `pricing.schedule` was provided).
return;
}
const summary: string[] = [];
if (appPriceTier != null) {
summary.push(`tier ${chalk.bold(appPriceTier)}`);
}
if (resolvedTerritories != null) {
summary.push(`${chalk.bold(resolvedTerritories.length)} territories`);
}
context.app = await logAsync(
() =>
context.app.updateAsync({
appPriceTier,
territories: resolvedTerritories,
}),
{
pending: `Updating pricing and availability (${summary.join(', ')})...`,
success: `Updated pricing and availability (${summary.join(', ')})`,
failure: 'Failed to update pricing and availability',
}
);
}
}
/**
* Resolve a desired territory list (either an explicit code list or the
* `'all'` sentinel) into an array of ISO territory codes the App Store
* Connect API will accept.
*/
async function resolveTerritoriesAsync({
context,
desired,
}: {
context: { app: App };
desired: AppleTerritoryCode[] | typeof AVAILABILITY_ALL;
}): Promise<AppleTerritoryCode[]> {
if (desired === AVAILABILITY_ALL) {
const territories = await Territory.getAsync(context.app.context, {
query: { limit: 200 },
});
return territories.map(t => t.id);
}
// Deduplicate, drop empties, and uppercase to match ASC's canonical form.
const seen = new Set<string>();
const out: string[] = [];
for (const code of desired) {
if (!code) {
continue;
}
const normalized = code.toUpperCase();
if (seen.has(normalized)) {
continue;
}
seen.add(normalized);
out.push(normalized);
}
return out;
}
+49 -53
View File
@@ -1,9 +1,6 @@
import type {
AgeRatingDeclarationProps,
AppClipAction,
AppDataUsageCategoryId,
AppDataUsageDataProtectionId,
AppDataUsagePurposeId,
PreviewType,
ScreenshotDisplayType,
} from '@expo/apple-utils';
@@ -57,66 +54,65 @@ export interface AppleMetadata {
review?: AppleReview;
/** App Clip metadata. Only applies to apps that ship an App Clip target. */
appClip?: AppleAppClip;
/** Privacy metadata, including App Privacy Nutrition Labels (data usage). */
privacy?: ApplePrivacy;
}
/** Top-level privacy block. Currently only contains data usage (Privacy Nutrition Labels). */
export interface ApplePrivacy {
/**
* Privacy Nutrition Labels (App Privacy details). Required for new app
* submissions since 2021. When set, the local config is treated as the
* source of truth: existing data usage entries on App Store Connect are
* replaced to match, then published.
*/
dataUsage?: AppleDataUsage;
}
/** Data usage category enum (e.g. CONTACTS, PRECISE_LOCATION). */
export type AppleDataUsageCategoryId = `${AppDataUsageCategoryId}`;
/** Data usage purpose enum (e.g. ANALYTICS, APP_FUNCTIONALITY). */
export type AppleDataUsagePurposeId = `${AppDataUsagePurposeId}`;
/** Data protection / linkage enum (e.g. DATA_LINKED_TO_YOU). */
export type AppleDataUsageDataProtectionId = `${AppDataUsageDataProtectionId}`;
/**
* Privacy Nutrition Labels — declarative declaration of data collected by the
* app. When `dataNotCollected` is true, no data is collected and `categories`
* must be omitted (or empty).
*/
export interface AppleDataUsage {
/**
* Whether the app collects no data at all. When set, `categories` must be
* empty. Mirrors Apple's "Data Not Collected" toggle in App Store Connect.
*/
dataNotCollected?: boolean;
/** Per-category declarations. Order is not significant. */
categories?: AppleDataUsageCategoryEntry[];
/** Pricing configuration for the app (price tier, scheduled changes). */
pricing?: ApplePricing;
/** Territory availability configuration for the app. */
availability?: AppleAvailability;
}
/**
* One declaration row in the App Privacy details. Each row pairs a data
* category with the purposes it's used for and the protection / linkage
* applied to it.
* Pricing configuration for an app.
*
* NOTE: Apple migrated to "base territory" pricing in 2023, replacing the
* legacy global price tier model. The App Store Connect API still exposes a
* `priceTier` concept on the legacy `appPrices`/`appPriceTiers` resources,
* which is what `@expo/apple-utils` currently exposes via
* `App.updateAsync({ appPriceTier })`. Newer apps may need to use
* `appPriceSchedules` + `appPricePoints` (which require selecting a base
* territory and a price point id), but those endpoints are not yet wrapped by
* `@expo/apple-utils`. We use the legacy field for now and document this in
* the PR. The schema is intentionally forward-compatible.
*/
export interface AppleDataUsageCategoryEntry {
/** Apple data category, e.g. `CONTACTS`, `PRECISE_LOCATION`. */
category: AppleDataUsageCategoryId;
export interface ApplePricing {
/**
* Purposes the category is used for, e.g. `ANALYTICS`, `APP_FUNCTIONALITY`.
* At least one entry is required when the category is collected.
* App Store price tier (e.g. `'0'` for free, `'1'` for tier 1). When
* unset on a brand new app, the App Store defaults to free (tier 0).
*/
purposes?: AppleDataUsagePurposeId[];
tier?: string;
/**
* Data protection / linkage classification, e.g. `DATA_LINKED_TO_YOU`,
* `DATA_USED_TO_TRACK_YOU`. Multiple values are allowed: a single category
* can be both linked to the user and used for tracking.
* Future scheduled price changes. Each entry switches the app to the
* given tier on `startDate`. The first entry that matches "now" or earlier
* is treated as the current price. This block is currently parsed but not
* pushed (the legacy `App.updateAsync` endpoint exposed by
* `@expo/apple-utils` only sets the active tier).
*/
protections?: AppleDataUsageDataProtectionId[];
schedule?: ApplePriceScheduleEntry[];
}
export interface ApplePriceScheduleEntry {
/** ISO-8601 date the new price tier takes effect. */
startDate: string;
/** App Store price tier id (e.g. `'0'` for free). */
tier: string;
}
/**
* Territory availability configuration. Use ISO-3166 alpha-3 codes (e.g.
* `"USA"`, `"GBR"`, `"JPN"`) — these match the App Store Connect Territory
* resource ids.
*/
export interface AppleAvailability {
/**
* The territories the app is available in. Use the literal string `'all'`
* to make the app available worldwide (every territory currently supported
* by App Store Connect). Omitting this field leaves availability untouched.
*/
territories?: AppleTerritoryCode[] | 'all';
}
/** ISO-3166 alpha-3 territory code (e.g. `"USA"`, `"GBR"`). */
export type AppleTerritoryCode = string;
/** App Clip action enum values from App Store Connect API */
export type AppleAppClipAction = `${AppClipAction}`;