@mpgd/game-services 0.28.1 → 0.30.0

package/dist/types.d.ts

@@ -38,7 +38,18 @@ export interface VerifyPurchaseRequest {
   readonly idempotencyKey: PurchaseIdempotencyKey;
   readonly purchasedAt: string;
   readonly evidence?: PlatformEvidenceEnvelope;
+  /**
+  * Why the client sends the purchase. `restore` is a purchase the store
+  * reported without this client starting it (a reinstall, a new device, or
+  * Restore Purchases): the backend may then grant this player a verified
+  * non-consumable the store binds to an earlier player (`restoreSharing`,
+  * RFC "Restore sharing"). Absent means `purchase`; the intent is a request
+  * for that policy, never proof of ownership.
+  */
+  readonly intent?: VerifyPurchaseIntent;
 }
+/** `VerifyPurchaseRequest.intent`. */
+export type VerifyPurchaseIntent = 'purchase' | 'restore';
 export interface ClaimAdRewardRequest {
   readonly target: GameServicesAdRewardTarget;
   /** Versioned provider identity, independent of build target; checked by server registration. */
@@ -98,6 +109,25 @@ export interface EntitlementLedgerRevocation {
   /** The notification's own authority identity, when the handler has one. */
   readonly evidenceVerificationId?: string;
 }
+/**
+* A ledger note: a store event about a grant that changes nothing by itself
+* and grants nothing (today an App Store `REFUND_REVERSED` after the grant
+* was revoked). It is kept so support can act on it; a re-grant is a new,
+* game-owned grant entry.
+*/
+export interface EntitlementLedgerNote {
+  /** Unique per store event, for example `app-store:notification:<notificationUUID>`. */
+  readonly noteId: string;
+  readonly kind: 'refund_reversed';
+  readonly playerId: string;
+  /** The grant the event is about. */
+  readonly ledgerEntryId: string;
+  /** The `revoke` entry the store reversed, when there is one. */
+  readonly revocationLedgerEntryId?: string;
+  readonly recordedAt: string;
+  readonly payload: EntitlementLedgerPayload;
+}
+export declare function assertEntitlementLedgerNote(input: EntitlementLedgerNote): EntitlementLedgerNote;
 export interface EntitlementRevocationTransaction extends EntitlementLedgerRevocation {
   readonly ledgerEntryId: string;
 }

package/dist/types.js

@@ -1,4 +1,17 @@
 import { assertOwnEnumerablePropertyLimit, gameServicesRequestLimits, toGameServicesRequestValidationError, } from './validation.js';
+export function assertEntitlementLedgerNote(input) {
+    assertRecord(input, 'EntitlementLedgerNote');
+    assertNonEmptyString(input.noteId, 'noteId');
+    if (input.kind !== 'refund_reversed') {
+        throw new Error('kind must be refund_reversed.');
+    }
+    assertNonEmptyString(input.playerId, 'playerId');
+    assertNonEmptyString(input.ledgerEntryId, 'ledgerEntryId');
+    assertOptionalNonEmptyString(input.revocationLedgerEntryId, 'revocationLedgerEntryId');
+    assertNonEmptyString(input.recordedAt, 'recordedAt');
+    assertPayload(input.payload);
+    return input;
+}
 /**
  * Validates an untrusted purchase verification request. Failures throw
  * `GameServicesRequestValidationError` so transports can answer with a stable 400.
@@ -17,6 +30,9 @@ export function assertVerifyPurchaseRequest(input) {
         assertRequestString(input.idempotencyKey, 'idempotencyKey');
         assertRequestString(input.purchasedAt, 'purchasedAt');
         assertOptionalEvidenceEnvelope(input.evidence);
+        if (input.intent !== undefined && input.intent !== 'purchase' && input.intent !== 'restore') {
+            throw new Error('intent must be purchase or restore.');
+        }
         return input;
     });
 }
@@ -30,6 +46,12 @@ export function assertVerifyPurchaseResponse(input) {
     if (input.finalization !== undefined) {
         assertPurchaseGrantFinalization(input.finalization);
     }
+    if (input.restoredAcrossPlayers !== undefined && input.restoredAcrossPlayers !== true) {
+        throw new Error('restoredAcrossPlayers must be true when present.');
+    }
+    if (input.restoredAcrossPlayers === true && input.verified !== true) {
+        throw new Error('restoredAcrossPlayers requires a verified response.');
+    }
     return input;
 }
 /** Bounds one ledger status read; a client asks for the grants of one journal window. */

package/dist/verified-leaderboard.d.ts

@@ -98,6 +98,19 @@ export declare class InMemoryVerifiedLeaderboardService implements VerifiedLeade
   private readonly attemptsById;
   private readonly retainedByLeaderboard;
   constructor(now?: () => string);
+  /**
+  * Account deletion (a `PlayerDataEraser` of `@mpgd/game-services`):
+  * removes every attempt and board entry whose participant id is the
+  * player id (the id the reference recorder uses). This module stays
+  * import-free, so the erasure input is typed structurally.
+  */
+  erasePlayerData(input: {
+    readonly playerId: string;
+    readonly retainedPlayerId: string;
+  }): Promise<{
+    readonly deleted: number;
+    readonly retained: number;
+  }>;
   recordVerifiedAttempt(input: RecordVerifiedLeaderboardAttemptRequest): Promise<RecordVerifiedLeaderboardAttemptResponse>;
   getSnapshot(input: GetVerifiedLeaderboardSnapshotRequest): Promise<VerifiedLeaderboardSnapshot | undefined>;
   private createRecordResponse;

package/dist/verified-leaderboard.js

@@ -1,6 +1,8 @@
 export const verifiedLeaderboardIdentifierMaximumLength = 512;
 export const verifiedLeaderboardMetricsMaximumCount = 16;
 export const verifiedLeaderboardMetricKeyMaximumLength = 64;
+/** `retainedPlayerIdPrefix` of `./account-deletion`; this module stays import-free. */
+const retainedPlayerIdPrefix = 'deleted:';
 const verifiedLeaderboardMetricKeyPattern = /^[A-Za-z][A-Za-z0-9._-]{0,63}$/;
 const timestampPattern = new RegExp('^(\\d{4})-(\\d{2})-(\\d{2})'
     + 'T(\\d{2}):(\\d{2}):(\\d{2})'
@@ -25,6 +27,35 @@ export class InMemoryVerifiedLeaderboardService {
     constructor(now = () => new Date().toISOString()) {
         this.now = now;
     }
+    /**
+     * Account deletion (a `PlayerDataEraser` of `@mpgd/game-services`):
+     * removes every attempt and board entry whose participant id is the
+     * player id (the id the reference recorder uses). This module stays
+     * import-free, so the erasure input is typed structurally.
+     */
+    async erasePlayerData(input) {
+        const participantId = input.playerId;
+        if (typeof participantId !== 'string' || participantId.length === 0
+            || participantId.startsWith(retainedPlayerIdPrefix)
+            || typeof input.retainedPlayerId !== 'string'
+            || !input.retainedPlayerId.startsWith(retainedPlayerIdPrefix)
+            || input.retainedPlayerId.length <= retainedPlayerIdPrefix.length) {
+            throw new Error('Player data erasure needs a player id and a deleted:<id> retained player id.');
+        }
+        let removed = 0;
+        for (const [key, stored] of [...this.attemptsById]) {
+            if (stored.attempt.participantId === participantId) {
+                this.attemptsById.delete(key);
+                removed += 1;
+            }
+        }
+        for (const retained of this.retainedByLeaderboard.values()) {
+            if (retained.delete(participantId)) {
+                removed += 1;
+            }
+        }
+        return { deleted: removed, retained: 0 };
+    }
     async recordVerifiedAttempt(input) {
         assertRecordVerifiedLeaderboardAttemptRequest(input);
         const definition = this.ensureDefinition(input.definition);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mpgd/game-services",
-  "version": "0.28.1",
+  "version": "0.30.0",
   "description": "Client, contract, server, store, and test helpers for authoritative mpgd game services.",
   "license": "MIT",
   "repository": {
@@ -37,6 +37,10 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./account-deletion": {
+      "types": "./dist/account-deletion.d.ts",
+      "default": "./dist/account-deletion.js"
+    },
     "./admob-client-reward": {
       "types": "./dist/admob-client-reward.d.ts",
       "default": "./dist/admob-client-reward.js"
@@ -57,6 +61,10 @@
       "types": "./dist/app-store-recovery.d.ts",
       "default": "./dist/app-store-recovery.js"
     },
+    "./app-store-server-notifications": {
+      "types": "./dist/app-store-server-notifications.d.ts",
+      "default": "./dist/app-store-server-notifications.js"
+    },
     "./app-store-server": {
       "types": "./dist/app-store-server.d.ts",
       "default": "./dist/app-store-server.js"
@@ -105,6 +113,10 @@
       "types": "./dist/google-play-purchase.d.ts",
       "default": "./dist/google-play-purchase.js"
     },
+    "./google-play-store-server": {
+      "types": "./dist/google-play-store-server.d.ts",
+      "default": "./dist/google-play-store-server.js"
+    },
     "./google-play-publisher-client": {
       "types": "./dist/google-play-publisher-client.d.ts",
       "default": "./dist/google-play-publisher-client.js"
@@ -219,9 +231,9 @@
     "@orpc/client": "2.0.0-beta.14",
     "@orpc/contract": "2.0.0-beta.14",
     "@orpc/server": "2.0.0-beta.14",
-    "@mpgd/analytics": "0.5.1",
-    "@mpgd/catalog": "0.10.8",
-    "@mpgd/platform": "0.28.0"
+    "@mpgd/catalog": "0.11.1",
+    "@mpgd/platform": "0.30.0",
+    "@mpgd/analytics": "0.5.3"
   },
   "peerDependencies": {
     "@apple/app-store-server-library": "^3.1.0"
@@ -250,7 +262,7 @@
     "fix": "ttsc fix",
     "build": "cd ../.. && node tools/run-ttsx.mjs tools/package/build-packages.ts @mpgd/game-services",
     "test:packed-transport": "pnpm build && node test/runtime-transport-package-import.mjs && node test/reward-evidence-import.mjs",
-    "test:unit": "cd ../.. && node tools/run-ttsx.mjs packages/game-services/src/client.test.ts && node tools/run-ttsx.mjs packages/game-services/src/client-progress.test.ts && node tools/run-ttsx.mjs packages/game-services/src/runtime.test.ts && node tools/run-ttsx.mjs packages/game-services/src/types.test.ts && node tools/run-ttsx.mjs packages/game-services/src/server.test.ts && node tools/run-ttsx.mjs packages/game-services/src/google-play-purchase.test.ts && node tools/run-ttsx.mjs packages/game-services/src/google-play-publisher-client.test.ts && node tools/run-ttsx.mjs packages/game-services/src/microsoft-store-purchase.test.ts && node tools/run-ttsx.mjs packages/game-services/src/microsoft-store-identity.test.ts && node tools/run-ttsx.mjs packages/game-services/src/platform-order.test.ts && node tools/run-ttsx.mjs packages/game-services/src/progress-link.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notification-delivery.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/service.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/service-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/client.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/client-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/scheduler.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/fcm.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/store-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/ait-functional-delivery.test.ts && node tools/run-ttsx.mjs packages/game-services/src/admob-ssv.test.ts && node tools/run-ttsx.mjs packages/game-services/src/app-store-verifier.test.ts && node tools/run-ttsx.mjs packages/game-services/src/apps-in-toss-evidence-verification-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/apps-in-toss-partner-api.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard-durability-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard-transport.test.ts && node tools/run-ttsx.mjs packages/game-services/src/guest-session.test.ts && node tools/run-ttsx.mjs packages/game-services/src/development-session.test.ts && node tools/run-ttsx.mjs packages/game-services/src/client-reward-evidence.test.ts && node tools/run-ttsx.mjs packages/game-services/src/ad-reward-verifier-registry.test.ts && node tools/run-ttsx.mjs packages/game-services/src/oneplay-reward.test.ts && node tools/run-ttsx.mjs packages/game-services/src/oneplay-purchase.test.ts && node tools/run-ttsx.mjs packages/game-services/src/commerce-registry-routing.test.ts && node tools/run-ttsx.mjs packages/game-services/src/commerce-registry-server.test.ts && node tools/run-ttsx.mjs packages/game-services/src/commerce-ledger-revocation.test.ts && node tools/run-ttsx.mjs packages/game-services/src/apps-in-toss-anonymous-auth.test.ts",
+    "test:unit": "cd ../.. && node tools/run-ttsx.mjs packages/game-services/src/client.test.ts && node tools/run-ttsx.mjs packages/game-services/src/client-progress.test.ts && node tools/run-ttsx.mjs packages/game-services/src/runtime.test.ts && node tools/run-ttsx.mjs packages/game-services/src/types.test.ts && node tools/run-ttsx.mjs packages/game-services/src/server.test.ts && node tools/run-ttsx.mjs packages/game-services/src/google-play-purchase.test.ts && node tools/run-ttsx.mjs packages/game-services/src/google-play-publisher-client.test.ts && node tools/run-ttsx.mjs packages/game-services/src/google-play-store-server.test.ts && node tools/run-ttsx.mjs packages/game-services/src/microsoft-store-purchase.test.ts && node tools/run-ttsx.mjs packages/game-services/src/microsoft-store-identity.test.ts && node tools/run-ttsx.mjs packages/game-services/src/platform-order.test.ts && node tools/run-ttsx.mjs packages/game-services/src/progress-link.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notification-delivery.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/service.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/service-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/client.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/client-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/scheduler.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/fcm.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/store-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notifications/ait-functional-delivery.test.ts && node tools/run-ttsx.mjs packages/game-services/src/admob-ssv.test.ts && node tools/run-ttsx.mjs packages/game-services/src/app-store-verifier.test.ts && node tools/run-ttsx.mjs packages/game-services/src/app-store-server-notifications.test.ts && node tools/run-ttsx.mjs packages/game-services/src/apps-in-toss-evidence-verification-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/apps-in-toss-partner-api.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard-durability-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard-transport.test.ts && node tools/run-ttsx.mjs packages/game-services/src/guest-session.test.ts && node tools/run-ttsx.mjs packages/game-services/src/development-session.test.ts && node tools/run-ttsx.mjs packages/game-services/src/client-reward-evidence.test.ts && node tools/run-ttsx.mjs packages/game-services/src/ad-reward-verifier-registry.test.ts && node tools/run-ttsx.mjs packages/game-services/src/oneplay-reward.test.ts && node tools/run-ttsx.mjs packages/game-services/src/oneplay-purchase.test.ts && node tools/run-ttsx.mjs packages/game-services/src/commerce-registry-routing.test.ts && node tools/run-ttsx.mjs packages/game-services/src/commerce-registry-server.test.ts && node tools/run-ttsx.mjs packages/game-services/src/commerce-ledger-revocation.test.ts && node tools/run-ttsx.mjs packages/game-services/src/purchase-sharing.test.ts && node tools/run-ttsx.mjs packages/game-services/src/apps-in-toss-anonymous-auth.test.ts && node tools/run-ttsx.mjs packages/game-services/src/account-deletion.test.ts",
     "test:recovery": "cd ../.. && node tools/run-ttsx.mjs packages/game-services/src/monetization-recovery.test.ts && node tools/run-ttsx.mjs packages/game-services/src/app-store-recovery.test.ts && node tools/run-ttsx.mjs packages/game-services/src/commerce-reconciler.test.ts && node tools/run-ttsx.mjs packages/game-services/src/commerce-reconciler-conformance.test.ts",
     "test": "pnpm test:unit && pnpm test:app-store-server && pnpm test:recovery && pnpm test:packed-transport",
     "test:app-store-server": "vitest run"