@mpgd/cli 0.63.0 → 0.65.0

package/dist/play-listing-port.d.ts

@@ -0,0 +1,88 @@
+/**
+* Google Play store listing port (Android Publisher v3 edits: `edits.details`,
+* `edits.listings`, `edits.images`). The Google SDK lives under
+* adapters/play-publisher; the CLI sees only these shapes.
+*
+* - Edits: https://developers.google.com/android-publisher/edits
+* - Listings: https://developers.google.com/android-publisher/api-ref/rest/v3/edits.listings
+* - Images: https://developers.google.com/android-publisher/api-ref/rest/v3/edits.images
+* - Details: https://developers.google.com/android-publisher/api-ref/rest/v3/edits.details
+* - Commit: https://developers.google.com/android-publisher/api-ref/rest/v3/edits/commit
+*/
+/** `AppDetails`. */
+export interface PlayAppDetails {
+  readonly defaultLanguage?: string | null | undefined;
+  readonly contactEmail?: string | null | undefined;
+  readonly contactPhone?: string | null | undefined;
+  readonly contactWebsite?: string | null | undefined;
+}
+/** `Listing`: one language of the main store listing. */
+export interface PlayListing {
+  readonly language?: string | null | undefined;
+  readonly title?: string | null | undefined;
+  readonly shortDescription?: string | null | undefined;
+  readonly fullDescription?: string | null | undefined;
+  /** YouTube URL of the promo video. */
+  readonly video?: string | null | undefined;
+}
+/** `Image`. */
+export interface PlayImage {
+  readonly id?: string | null | undefined;
+  readonly url?: string | null | undefined;
+  readonly sha1?: string | null | undefined;
+  readonly sha256?: string | null | undefined;
+}
+/** The `AppImageType` values the store presence sync manages. */
+export type PlayImageType = 'icon' | 'featureGraphic' | 'phoneScreenshots' | 'sevenInchScreenshots' | 'tenInchScreenshots';
+export interface PlayImageTarget {
+  readonly packageName: string;
+  readonly editId: string;
+  readonly language: string;
+  readonly imageType: PlayImageType;
+  readonly signal?: AbortSignal;
+}
+export interface PlayStoreListingPort {
+  /** `edits.insert`. A new edit invalidates the caller's other open edit. */
+  insertEdit(packageName: string, signal?: AbortSignal): Promise<string>;
+  /** `edits.delete`: discards an uncommitted edit. */
+  deleteEdit(packageName: string, editId: string, signal?: AbortSignal): Promise<void>;
+  /**
+  * `edits.commit` with `changesInReviewBehavior=ERROR_IF_IN_REVIEW`, and
+  * `changesNotSentForReview` when asked.
+  */
+  commitEdit(input: {
+    readonly packageName: string;
+    readonly editId: string;
+    readonly changesNotSentForReview: boolean;
+    readonly signal?: AbortSignal;
+  }): Promise<void>;
+  getDetails(packageName: string, editId: string, signal?: AbortSignal): Promise<PlayAppDetails>;
+  /** `edits.details.update` with the whole object. */
+  updateDetails(input: {
+    readonly packageName: string;
+    readonly editId: string;
+    readonly details: PlayAppDetails;
+    readonly signal?: AbortSignal;
+  }): Promise<void>;
+  /** `edits.listings.list`: every language. */
+  listListings(packageName: string, editId: string, signal?: AbortSignal): Promise<PlayListing[]>;
+  /** `edits.listings.update`: creates or replaces one language. */
+  updateListing(input: {
+    readonly packageName: string;
+    readonly editId: string;
+    readonly listing: PlayListing & {
+      readonly language: string;
+    };
+    readonly signal?: AbortSignal;
+  }): Promise<void>;
+  /** `edits.images.list`, in the order Play shows them. */
+  listImages(input: PlayImageTarget): Promise<PlayImage[]>;
+  /** `edits.images.upload`: adds one image after the ones the slot holds. */
+  uploadImage(input: PlayImageTarget & {
+    readonly file: string;
+    readonly mimeType: 'image/png' | 'image/jpeg';
+    readonly timeoutMs: number;
+  }): Promise<PlayImage>;
+  /** `edits.images.deleteall`. */
+  deleteAllImages(input: PlayImageTarget): Promise<void>;
+}

package/dist/play-listing-port.js

@@ -0,0 +1,12 @@
+/**
+ * Google Play store listing port (Android Publisher v3 edits: `edits.details`,
+ * `edits.listings`, `edits.images`). The Google SDK lives under
+ * adapters/play-publisher; the CLI sees only these shapes.
+ *
+ * - Edits: https://developers.google.com/android-publisher/edits
+ * - Listings: https://developers.google.com/android-publisher/api-ref/rest/v3/edits.listings
+ * - Images: https://developers.google.com/android-publisher/api-ref/rest/v3/edits.images
+ * - Details: https://developers.google.com/android-publisher/api-ref/rest/v3/edits.details
+ * - Commit: https://developers.google.com/android-publisher/api-ref/rest/v3/edits/commit
+ */
+export {};

package/dist/play-sdk-adapter.js

@@ -11,18 +11,22 @@ function createMockPublisher(accessToken, rootUrl) {
   oauth.setCredentials({ access_token: accessToken });
   return wrapPublisher(androidpublisher({ version: "v3", auth: oauth, rootUrl }));
 }
+async function insertEdit(publisher, packageName, signal) {
+  const response = await publisher.edits.insert(
+    { packageName },
+    { retry: false, signal }
+  );
+  if (typeof response.data.id !== "string" || response.data.id.trim() === "") {
+    throw new Error("Google Play did not return an edit ID.");
+  }
+  return response.data.id;
+}
+async function deleteEdit(publisher, packageName, editId, signal) {
+  await publisher.edits.delete({ packageName, editId }, { retry: false, signal });
+}
 function wrapPublisher(publisher) {
   return {
-    async insertEdit(packageName, signal) {
-      const response = await publisher.edits.insert(
-        { packageName },
-        { retry: false, signal }
-      );
-      if (typeof response.data.id !== "string" || response.data.id.trim() === "") {
-        throw new Error("Google Play did not return an edit ID.");
-      }
-      return response.data.id;
-    },
+    insertEdit: (packageName, signal) => insertEdit(publisher, packageName, signal),
     async listBundles(packageName, editId, signal) {
       return (await publisher.edits.bundles.list(
         { packageName, editId },
@@ -87,12 +91,7 @@ function wrapPublisher(publisher) {
         changesInReviewBehavior: "ERROR_IF_IN_REVIEW"
       }, { retry: false, signal });
     },
-    async deleteEdit(packageName, editId, signal) {
-      await publisher.edits.delete(
-        { packageName, editId },
-        { retry: false, signal }
-      );
-    }
+    deleteEdit: (packageName, editId, signal) => deleteEdit(publisher, packageName, editId, signal)
   };
 }
 function createServiceAccountProductCatalog(serviceAccountFile) {
@@ -160,9 +159,96 @@ function wrapProductCatalog(publisher) {
     }
   };
 }
+function createServiceAccountStoreListing(serviceAccountFile) {
+  const googleAuth = new auth.GoogleAuth({ keyFile: serviceAccountFile, scopes: [scope] });
+  return wrapStoreListing(androidpublisher({ version: "v3", auth: googleAuth }));
+}
+function createMockStoreListing(accessToken, rootUrl, requestRootUrl) {
+  const oauth = new auth.OAuth2();
+  oauth.setCredentials({ access_token: accessToken });
+  return wrapStoreListing(
+    androidpublisher({ version: "v3", auth: oauth, rootUrl }),
+    requestRootUrl
+  );
+}
+function wrapStoreListing(publisher, requestRootUrl) {
+  const mediaRoot = requestRootUrl === void 0 ? {} : { rootUrl: requestRootUrl };
+  return {
+    insertEdit: (packageName, signal) => insertEdit(publisher, packageName, signal),
+    deleteEdit: (packageName, editId, signal) => deleteEdit(publisher, packageName, editId, signal),
+    async commitEdit(input) {
+      await publisher.edits.commit({
+        packageName: input.packageName,
+        editId: input.editId,
+        changesInReviewBehavior: "ERROR_IF_IN_REVIEW",
+        ...input.changesNotSentForReview ? { changesNotSentForReview: true } : {}
+      }, { retry: false, signal: input.signal });
+    },
+    async getDetails(packageName, editId, signal) {
+      return (await publisher.edits.details.get(
+        { packageName, editId },
+        { signal }
+      )).data;
+    },
+    async updateDetails(input) {
+      await publisher.edits.details.update({
+        packageName: input.packageName,
+        editId: input.editId,
+        requestBody: input.details
+      }, { retry: false, signal: input.signal });
+    },
+    async listListings(packageName, editId, signal) {
+      return (await publisher.edits.listings.list(
+        { packageName, editId },
+        { signal }
+      )).data.listings ?? [];
+    },
+    async updateListing(input) {
+      await publisher.edits.listings.update({
+        packageName: input.packageName,
+        editId: input.editId,
+        language: input.listing.language,
+        requestBody: input.listing
+      }, { retry: false, signal: input.signal });
+    },
+    async listImages(input) {
+      return (await publisher.edits.images.list({
+        packageName: input.packageName,
+        editId: input.editId,
+        language: input.language,
+        imageType: input.imageType
+      }, { signal: input.signal })).data.images ?? [];
+    },
+    async uploadImage(input) {
+      const response = await publisher.edits.images.upload({
+        packageName: input.packageName,
+        editId: input.editId,
+        language: input.language,
+        imageType: input.imageType,
+        media: { mimeType: input.mimeType, body: createReadStream(input.file) }
+      }, {
+        timeout: input.timeoutMs,
+        retry: false,
+        signal: input.signal,
+        ...mediaRoot
+      });
+      return response.data.image ?? {};
+    },
+    async deleteAllImages(input) {
+      await publisher.edits.images.deleteall({
+        packageName: input.packageName,
+        editId: input.editId,
+        language: input.language,
+        imageType: input.imageType
+      }, { retry: false, signal: input.signal });
+    }
+  };
+}
 export {
   createMockProductCatalog,
   createMockPublisher,
+  createMockStoreListing,
   createServiceAccountProductCatalog,
-  createServiceAccountPublisher
+  createServiceAccountPublisher,
+  createServiceAccountStoreListing
 };

package/dist/store-presence-app-store.d.ts

@@ -0,0 +1,139 @@
+import { type AppStorePresenceDisplay, type StorePresence } from '@mpgd/catalog';
+import type { AscStorePresencePort, AscVersionLocalizationFields } from './app-store-presence-port.js';
+import { type StorePresenceTextChange } from './store-presence.js';
+/**
+* App Store Connect store page sync: compare the store presence file with
+* the app information localizations (name, subtitle, privacy policy URL),
+* the editable App Store version's localizations (description, keywords,
+* promotional text, what's new, URLs) and its screenshot sets, and plan the
+* writes.
+*
+* The sync writes only to an editable app information record and an
+* editable iOS version (`PREPARE_FOR_SUBMISSION` or rejected). It never
+* creates a version, never submits for review, and never touches pricing,
+* availability or release settings. App Store Connect has no transaction:
+* apply writes step by step and, on a failure, names the steps already
+* written; `plan` then shows what is left.
+*/
+export type AppStorePresenceAction = 'create' | 'update' | 'unchanged' | 'blocked';
+export interface PlannedAscScreenshotSet {
+  readonly display: AppStorePresenceDisplay;
+  readonly displayType: string;
+  readonly action: 'unchanged' | 'add' | 'replace';
+  readonly complete: boolean;
+  /** Uploads, in order, by path relative to the file and MD5. */
+  readonly upload: readonly {
+    readonly path: string;
+    readonly md5: string;
+  }[];
+  /** MD5 of App Store Connect's screenshots that stay. */
+  readonly keep: readonly string[];
+  /** App Store Connect's screenshots the write removes and does not upload again. */
+  readonly remove: readonly {
+    readonly id: string;
+    readonly md5: string;
+  }[];
+  /** `replace`: every screenshot of the set, deleted before the uploads. */
+  readonly deleteIds: readonly string[];
+  /** The set cannot be planned now (App Store Connect is still processing it). */
+  readonly blocked?: true;
+  readonly notes: readonly string[];
+}
+export interface PlannedAppStoreLocale {
+  /** The locale as App Store Connect spells it (BCP-47 casing for a new one). */
+  readonly locale: string;
+  readonly appInfo: {
+    readonly action: AppStorePresenceAction;
+    readonly text: readonly StorePresenceTextChange[];
+    readonly write?: {
+      readonly name: string;
+      readonly subtitle?: string;
+      readonly privacyPolicyUrl?: string;
+    };
+  };
+  readonly version: {
+    readonly action: AppStorePresenceAction;
+    readonly localizationId?: string;
+    readonly text: readonly StorePresenceTextChange[];
+    readonly write?: AscVersionLocalizationFields;
+  };
+  readonly screenshots: readonly PlannedAscScreenshotSet[];
+}
+export interface AppStorePresencePlan {
+  readonly schemaVersion: 1;
+  readonly store: 'app-store';
+  /** Numeric App Store Connect app ID. */
+  readonly appId: string;
+  readonly bundleId: string;
+  /** The editable app information record, when there is one. */
+  readonly appInfo?: {
+    readonly id: string;
+    readonly state: string;
+  };
+  /** The editable iOS version, when there is one. */
+  readonly version?: {
+    readonly id: string;
+    readonly versionString?: string;
+    readonly state: string;
+    /** The app's first version: App Store Connect takes no what's new text. */
+    readonly first: boolean;
+  };
+  readonly locales: readonly PlannedAppStoreLocale[];
+  /** Locales on App Store Connect that the file does not name. Never deleted. */
+  readonly remoteOnlyLocales: readonly string[];
+  /**
+  * Screenshots apply deletes: the ones a complete set drops, and every one
+  * of a set it replaces (re-uploaded after). Apply needs --confirm-image-removal.
+  */
+  readonly imageRemovals: number;
+  readonly changed: boolean;
+  /** Parts that differ but cannot be written now (nothing editable, still processing). */
+  readonly blocked: number;
+  readonly notes: readonly string[];
+  /** What the sync cannot do; the reviewer does it in App Store Connect. */
+  readonly manual: readonly string[];
+  readonly remoteSha256: string;
+  readonly desiredSha256: string;
+}
+export interface AppStorePresencePlanInput {
+  readonly appId: string;
+  readonly bundleId: string;
+  readonly presence: StorePresence;
+  /** Directory of the store presence file; screenshots resolve against it. */
+  readonly directory: string;
+}
+/** Read App Store Connect and plan; never writes. */
+export declare function planAppStorePresence(input: AppStorePresencePlanInput, port: AscStorePresencePort): Promise<AppStorePresencePlan>;
+export interface AppStorePresenceApplyResult {
+  readonly appId: string;
+  readonly status: 'updated' | 'unchanged';
+  /** The writes, in order. */
+  readonly steps: readonly string[];
+  readonly manual: readonly string[];
+}
+export declare class AppStorePresenceApplyError extends Error {
+  readonly stage: string;
+  /** The writes that landed before the failure. */
+  readonly written: readonly string[];
+  /** App Store Connect refused the step (asc exited with a 4xx-class code): nothing from it landed. */
+  readonly definitive: boolean;
+  constructor(stage: string, 
+  /** The writes that landed before the failure. */
+  written: readonly string[], cause: unknown, detail?: string, 
+  /** App Store Connect refused the step (asc exited with a 4xx-class code): nothing from it landed. */
+  definitive?: boolean);
+}
+/**
+* Apply a reviewed plan: re-plan, refuse when App Store Connect or the files
+* moved past the reviewed plan, then write step by step. A plan whose
+* changes already landed is a no-op, so a re-run is safe.
+*/
+export declare function applyAppStorePresence(input: {
+  readonly saved: AppStorePresencePlan;
+  readonly plan: AppStorePresencePlanInput;
+  readonly port: AscStorePresencePort;
+  readonly approved: boolean;
+  readonly confirmImageRemoval?: boolean;
+}): Promise<AppStorePresenceApplyResult>;
+/** The plan for the terminal: per locale, the text and screenshot changes. */
+export declare function formatAppStorePresencePlan(plan: AppStorePresencePlan): string;