@mpgd/adapter-capacitor 0.7.4 → 0.8.0

package/README.md

@@ -66,15 +66,19 @@ SDK works on a physical device or that a store/ad setup is release-ready.
 
 ## App Store server-side transaction signatures
 
-For an iOS game backend, install the optional
-`@apple/app-store-server-library@3.1.0` peer and import
-`createAppleSignedTransactionVerifier` from
-`@mpgd/adapter-capacitor/app-store-server`. Supply DER-encoded Apple root
-certificates from the [Apple PKI](https://www.apple.com/certificateauthority/),
-the game's bundle ID, environment, and production App Apple ID. Use the
-result as `signedTransactionVerifier` in
-`createAppStoreGameServicesEvidenceVerifier`. Keep App Store API credentials,
-trust roots, and this verifier on the backend, not in the Capacitor game.
+The server-side verifier moved to `@mpgd/game-services/app-store-server`
+(see the [game-services README](../../packages/game-services/README.md)):
+install the optional `@apple/app-store-server-library@3.1.0` peer next to
+`@mpgd/game-services` and import `createAppleSignedTransactionVerifier` from
+there. `@mpgd/adapter-capacitor/app-store-server` is deprecated: it re-exports
+the same function and options type for one release and is removed in the next
+major version. Supply DER-encoded Apple root certificates from the
+[Apple PKI](https://www.apple.com/certificateauthority/), the game's bundle
+ID, environment, and production App Apple ID. Use the result as
+`signedTransactionVerifier` in `createAppStoreGameServicesEvidenceVerifier`.
+Keep App Store API credentials, trust roots, and this verifier on the backend,
+not in the Capacitor game; the adapter itself no longer peers on Apple's
+library.
 
 The server fetches the transaction from Apple's API, verifies its JWS, checks
 the product, bundle, environment, account token and transaction ID, then

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

@@ -1,12 +1,12 @@
-import { type AppStoreEnvironment, type AppStoreSignedTransactionVerifier } from '@mpgd/game-services/app-store-verifier';
-export interface CreateAppleSignedTransactionVerifierOptions {
-  /** DER-encoded Apple root certificates, supplied by the server operator. */
-  readonly rootCertificates: readonly Uint8Array[];
-  readonly environment: AppStoreEnvironment;
-  readonly bundleId: string;
-  /** Required by Apple's verifier in production. */
-  readonly appAppleId?: number;
-  readonly enableOnlineChecks?: boolean;
-}
-/** Verify the App Store JWS before exposing any decoded purchase fields. */
-export declare function createAppleSignedTransactionVerifier(options: CreateAppleSignedTransactionVerifierOptions): AppStoreSignedTransactionVerifier;
+/**
+* @deprecated Moved to `@mpgd/game-services/app-store-server` in A4 of the
+* commerce v2 plan: server-side App Store verification does not belong in the
+* client adapter. This subpath re-exports the same symbols for one release and
+* will be removed in the next major version. Install
+* `@apple/app-store-server-library` next to `@mpgd/game-services`.
+*/
+import { createAppleSignedTransactionVerifier as createAppleSignedTransactionVerifierFromGameServices, type CreateAppleSignedTransactionVerifierOptions as GameServicesAppleVerifierOptions } from '@mpgd/game-services/app-store-server';
+/** @deprecated Import `createAppleSignedTransactionVerifier` from `@mpgd/game-services/app-store-server`. */
+export declare const createAppleSignedTransactionVerifier: typeof createAppleSignedTransactionVerifierFromGameServices;
+/** @deprecated Import `CreateAppleSignedTransactionVerifierOptions` from `@mpgd/game-services/app-store-server`. */
+export type CreateAppleSignedTransactionVerifierOptions = GameServicesAppleVerifierOptions;

package/dist/app-store-server.js

@@ -1,119 +1,10 @@
-import { Environment, SignedDataVerifier, VerificationException, VerificationStatus, } from '@apple/app-store-server-library';
-import { AppStoreDependencyUnavailableError, } from '@mpgd/game-services/app-store-verifier';
-/** Verify the App Store JWS before exposing any decoded purchase fields. */
-export function createAppleSignedTransactionVerifier(options) {
-    if (!Array.isArray(options.rootCertificates)
-        || options.rootCertificates.length === 0
-        || options.rootCertificates.some((certificate) => !(certificate instanceof Uint8Array)
-            || certificate.length === 0)) {
-        throw new TypeError('Apple root certificates are required.');
-    }
-    if (options.environment !== 'Production' && options.environment !== 'Sandbox') {
-        throw new TypeError('App Store environment must be Production or Sandbox.');
-    }
-    if (options.bundleId.trim() === '') {
-        throw new TypeError('App Store bundle ID is required.');
-    }
-    if (options.environment === 'Production'
-        && (!Number.isSafeInteger(options.appAppleId) || (options.appAppleId ?? 0) <= 0)) {
-        throw new TypeError('Production App Store verification requires appAppleId.');
-    }
-    if (options.environment === 'Production' && options.enableOnlineChecks === false) {
-        throw new TypeError('Production App Store verification requires online certificate checks.');
-    }
-    const verifier = new SignedDataVerifier(options.rootCertificates.map((certificate) => Buffer.from(certificate)), options.enableOnlineChecks ?? true, options.environment === 'Production' ? Environment.PRODUCTION : Environment.SANDBOX, options.bundleId, options.appAppleId);
-    return {
-        async verifyAndDecode(input) {
-            if (input.environment !== options.environment || input.bundleId !== options.bundleId) {
-                return { status: 'rejected', reason: 'APP_STORE_VERIFIER_SCOPE_MISMATCH' };
-            }
-            if (typeof input.signedTransaction !== 'string'
-                || input.signedTransaction.length === 0
-                || input.signedTransaction.length > 512 * 1024) {
-                return { status: 'rejected', reason: 'APP_STORE_SIGNED_TRANSACTION_INVALID' };
-            }
-            input.signal.throwIfAborted();
-            let decoded;
-            try {
-                decoded = await waitForVerification(verifier.verifyAndDecodeTransaction(input.signedTransaction), input.signal);
-                input.signal.throwIfAborted();
-            }
-            catch (error) {
-                if (input.signal.aborted) {
-                    throw input.signal.reason;
-                }
-                if (error instanceof VerificationException) {
-                    if (error.status === VerificationStatus.RETRYABLE_VERIFICATION_FAILURE) {
-                        throw new AppStoreDependencyUnavailableError('Apple signature checks are temporarily unavailable.', error);
-                    }
-                    return { status: 'rejected', reason: 'APP_STORE_SIGNATURE_INVALID' };
-                }
-                // Only Apple's explicit retryable status is a transient dependency
-                // failure. Unexpected adapter/library faults must reach the caller.
-                throw error;
-            }
-            const payload = decodeOneTimeTransaction(decoded);
-            return payload === undefined
-                ? { status: 'rejected', reason: 'APP_STORE_SIGNED_TRANSACTION_INVALID' }
-                : { status: 'verified', payload };
-        },
-    };
-}
-async function waitForVerification(operation, signal) {
-    signal.throwIfAborted();
-    let onAbort;
-    const aborted = new Promise((_resolve, reject) => {
-        onAbort = () => reject(signal.reason ?? new Error('Verification was aborted.'));
-        signal.addEventListener('abort', onAbort, { once: true });
-        if (signal.aborted) {
-            onAbort();
-        }
-    });
-    try {
-        return await Promise.race([operation, aborted]);
-    }
-    finally {
-        if (onAbort !== undefined) {
-            signal.removeEventListener('abort', onAbort);
-        }
-    }
-}
-function decodeOneTimeTransaction(decoded) {
-    if (!nonEmpty(decoded.transactionId)
-        || !nonEmpty(decoded.originalTransactionId)
-        || !nonEmpty(decoded.bundleId)
-        || !nonEmpty(decoded.productId)
-        || !validTimestamp(decoded.purchaseDate)
-        || !validTimestamp(decoded.signedDate)
-        || (decoded.environment !== 'Production' && decoded.environment !== 'Sandbox')
-        || (decoded.type !== 'Consumable' && decoded.type !== 'Non-Consumable')
-        || (decoded.quantity !== undefined
-            && (!Number.isSafeInteger(decoded.quantity) || decoded.quantity <= 0))
-        || (decoded.appAccountToken !== undefined && !nonEmpty(decoded.appAccountToken))
-        || (decoded.revocationDate !== undefined && !validTimestamp(decoded.revocationDate))
-        || (decoded.expiresDate !== undefined && !validTimestamp(decoded.expiresDate))
-        || (decoded.isUpgraded !== undefined && typeof decoded.isUpgraded !== 'boolean')) {
-        return undefined;
-    }
-    return {
-        transactionId: decoded.transactionId,
-        originalTransactionId: decoded.originalTransactionId,
-        bundleId: decoded.bundleId,
-        productId: decoded.productId,
-        purchaseDate: decoded.purchaseDate,
-        signedDate: decoded.signedDate,
-        environment: decoded.environment,
-        type: decoded.type,
-        ...(decoded.quantity === undefined ? {} : { quantity: decoded.quantity }),
-        ...(decoded.appAccountToken === undefined ? {} : { appAccountToken: decoded.appAccountToken }),
-        ...(decoded.revocationDate === undefined ? {} : { revocationDate: decoded.revocationDate }),
-        ...(decoded.expiresDate === undefined ? {} : { expiresDate: decoded.expiresDate }),
-        ...(decoded.isUpgraded === undefined ? {} : { isUpgraded: decoded.isUpgraded }),
-    };
-}
-function nonEmpty(value) {
-    return typeof value === 'string' && value.trim() !== '';
-}
-function validTimestamp(value) {
-    return typeof value === 'number' && Number.isSafeInteger(value) && value > 0;
-}
+/**
+ * @deprecated Moved to `@mpgd/game-services/app-store-server` in A4 of the
+ * commerce v2 plan: server-side App Store verification does not belong in the
+ * client adapter. This subpath re-exports the same symbols for one release and
+ * will be removed in the next major version. Install
+ * `@apple/app-store-server-library` next to `@mpgd/game-services`.
+ */
+import { createAppleSignedTransactionVerifier as createAppleSignedTransactionVerifierFromGameServices, } from '@mpgd/game-services/app-store-server';
+/** @deprecated Import `createAppleSignedTransactionVerifier` from `@mpgd/game-services/app-store-server`. */
+export const createAppleSignedTransactionVerifier = createAppleSignedTransactionVerifierFromGameServices;

package/dist/providers.d.ts

@@ -1,8 +1,13 @@
-import type { BridgeMethod, BridgeRequest, BridgeResponse } from '@mpgd/bridge';
+import { type BridgeEvent, type BridgeMethod, type BridgeRequest, type BridgeResponse } from '@mpgd/bridge';
 import type { AdProvider } from '@mpgd/platform/ads';
 import { type PlatformProviderAvailability, type PlatformProviderFeature, type ProductType } from '@mpgd/platform';
 export interface NativeBridge {
   request(input: BridgeRequest): Promise<BridgeResponse>;
+  /**
+  * Optional commerce v2 event delivery (`{ protocol: 'mpgd.commerce.v2', sequence, event }`).
+  * B1 wires it for store providers; the base gateway works without it.
+  */
+  subscribe?(listener: (event: BridgeEvent) => void): () => void;
 }
 /**
 * An optional, separately installed provider handles only its declared bridge

package/dist/providers.js

@@ -1,3 +1,4 @@
+import { isBridgeCommerceV2Method, } from '@mpgd/bridge';
 import { isAdMobClientRewardEvidence } from '@mpgd/game-services/admob-client-reward';
 import { PlatformOperationError, } from '@mpgd/platform';
 const featureMethods = {
@@ -53,6 +54,12 @@ export function createCapacitorProviderRegistry(input) {
             throw new Error(`Capacitor provider ${provider.id} repeats a bridge method.`);
         }
         for (const method of methods) {
+            if (isBridgeCommerceV2Method(method)) {
+                // v1 providers own the v1 commerce methods only; a v2 provider arrives
+                // with B1 and is registered through its own surface.
+                throw new Error(`Capacitor provider ${provider.id} cannot declare commerce v2 method ${method}; `
+                    + 'commerce v2 is unavailable through the provider registry.');
+            }
             if (!providerMethodSet.has(method)) {
                 throw new Error(`Capacitor provider ${provider.id} cannot replace base method ${method}.`);
             }
@@ -233,7 +240,8 @@ function isValidProviderData(method, value) {
                     && value.authoritativeGrant.ledgerEntryId.length > 0
                     && (value.authoritativeGrant.alreadyProcessed === undefined
                         || typeof value.authoritativeGrant.alreadyProcessed === 'boolean')))
-                && (value.evidence === undefined || isEvidence(value.evidence));
+                && (value.evidence === undefined || isEvidence(value.evidence))
+                && (value.diagnostic === undefined || isCommerceDiagnostic(value.diagnostic));
         case 'commerce.restore':
             return isRecord(value)
                 && Array.isArray(value.restoredEntitlements)
@@ -245,7 +253,10 @@ function isValidProviderData(method, value) {
                         && ['granted', 'refunded'].includes(settlement.status)
                         && (settlement.ledgerEntryId === undefined || isString(settlement.ledgerEntryId))
                         && (settlement.alreadyProcessed === undefined
-                            || typeof settlement.alreadyProcessed === 'boolean'))));
+                            || typeof settlement.alreadyProcessed === 'boolean')
+                        && (settlement.idempotencyKey === undefined
+                            || isIdempotencyKey(settlement.idempotencyKey)))))
+                && (value.diagnostic === undefined || isCommerceDiagnostic(value.diagnostic));
         case 'commerce.getEntitlements':
             return Array.isArray(value) && value.every(isEntitlement);
         case 'ads.preload':
@@ -304,6 +315,22 @@ function isEntitlement(value) {
         && isString(value.grantedAt)
         && (value.expiresAt === undefined || isString(value.expiresAt));
 }
+/** Mirrors the stable, non-sensitive code format of `PlatformOperationError`. */
+function isDiagnosticCode(value) {
+    return isString(value) && value.length <= 128 && /^[A-Z][A-Z0-9_:-]*$/u.test(value);
+}
+function isCommerceDiagnostic(value) {
+    return isRecord(value)
+        && isDiagnosticCode(value.code)
+        && typeof value.retryable === 'boolean'
+        && (value.providerCode === undefined || isDiagnosticCode(value.providerCode));
+}
+function isIdempotencyKey(value) {
+    return isString(value)
+        && value.length > 0
+        && value.length <= 256
+        && !/[\p{Cc}\p{Cf}]/u.test(value);
+}
 function isEvidence(value) {
     return isRecord(value)
         && isString(value.schema)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mpgd/adapter-capacitor",
-  "version": "0.7.4",
+  "version": "0.8.0",
   "description": "Capacitor platform adapter for mpgd Android and iOS shells.",
   "license": "MIT",
   "repository": {
@@ -43,33 +43,28 @@
   ],
   "dependencies": {
     "@capacitor/app": "8.1.1",
-    "@mpgd/bridge": "0.11.0",
-    "@mpgd/capacitor-game-services": "0.6.1",
-    "@mpgd/game-services": "0.19.0",
-    "@mpgd/target-config": "0.21.0",
-    "@mpgd/platform": "0.17.0"
+    "@mpgd/capacitor-game-services": "0.6.2",
+    "@mpgd/bridge": "0.12.0",
+    "@mpgd/platform": "0.19.0",
+    "@mpgd/game-services": "0.20.0",
+    "@mpgd/target-config": "0.21.2"
   },
   "peerDependencies": {
-    "@apple/app-store-server-library": "^3.1.0",
     "@capacitor-community/admob": "^8.1.0",
     "@capacitor/core": "^8.5.1"
   },
   "peerDependenciesMeta": {
-    "@apple/app-store-server-library": {
-      "optional": true
-    },
     "@capacitor-community/admob": {
       "optional": true
     }
   },
   "devDependencies": {
-    "@apple/app-store-server-library": "3.1.0",
     "@capacitor-community/admob": "8.1.0",
     "@capacitor/core": "8.5.2",
     "ttsc": "0.30.4",
     "typescript": "7.0.2",
     "vitest": "^4.0.0",
-    "@mpgd/game-runtime": "0.6.0"
+    "@mpgd/game-runtime": "0.6.2"
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",