@mpgd/platform 0.23.0 → 0.24.0

package/dist/notifications-conformance.d.ts

@@ -126,8 +126,13 @@ export interface NotificationConformanceSession {
   readonly player: string;
   readonly installationId: string;
 }
-/** What setting a server reminder answers: stored, or the gate step 3 to 5 refusal. */
-export type NotificationConformanceReminderSetStatus = 'scheduled' | 'replaced' | 'permission-required' | 'request-missing' | 'preference-off' | 'advertising-consent-missing';
+/**
+* What setting a server reminder answers: stored, the gate step 3 to 5
+* refusal, `capacity-exceeded` past a backend's cap on a player's pending
+* reminders, or `unavailable` when no provider the player can be reached on
+* maps the topic. The fake backend answers only the first six.
+*/
+export type NotificationConformanceReminderSetStatus = 'scheduled' | 'replaced' | 'permission-required' | 'request-missing' | 'preference-off' | 'advertising-consent-missing' | 'capacity-exceeded' | 'unavailable';
 export type NotificationConformanceNoticeChannel = 'in-game' | 'push' | 'other';
 /** The backend surface the runtime calls for the authenticated session. */
 export interface NotificationConformanceBackendClient {
@@ -244,10 +249,13 @@ export type NotificationConformanceProviderResult = {
 export interface NotificationConformanceBackend extends NotificationConformanceBackendClient {
   /** Starts a new session for `player` on the fake installation and tells the listeners. */
   authenticate(player: string): NotificationConformanceSession;
-  /** Ends the current session; the endpoints it registered are unbound. */
-  revokeSession(): void;
+  /**
+  * Ends the current session; the endpoints it registered are unbound. A
+  * backend under test may finish asynchronously; the runner awaits it.
+  */
+  revokeSession(): void | Promise<void>;
   /** Binds another installation of the default player (the `backend.registerEndpoint` action). */
-  registerInstallation(input: NotificationConformanceInstallationFixture): void;
+  registerInstallation(input: NotificationConformanceInstallationFixture): void | Promise<void>;
   /** One send through the idempotency ledger, the policy gate, and the delivery provider. */
   deliver(input: NotificationConformanceDeliverInput): Promise<NotificationDeliveryOutcome>;
   queueProviderResult(result: NotificationConformanceProviderResult): void;
@@ -266,6 +274,15 @@ export interface NotificationConformanceBackend extends NotificationConformanceB
   })[];
   readonly noticesGiven: readonly NotificationConformanceNoticeRecord[];
 }
+/**
+* The fake backend. Its `revokeSession` and `registerInstallation` finish
+* synchronously, so its callers need not await them. `deliver`,
+* `runScheduler`, and the async client methods still return promises.
+*/
+export interface NotificationConformanceFakeBackend extends NotificationConformanceBackend {
+  revokeSession(): void;
+  registerInstallation(input: NotificationConformanceInstallationFixture): void;
+}
 export interface CreateNotificationConformanceBackendInput {
   /** The delivery provider's registry entry; `undefined` for a provider without remote delivery. */
   readonly entry: NotificationDeliveryProviderEntry | undefined;
@@ -350,7 +367,7 @@ export interface CreateNotificationConformanceBackendInput {
 *   once when scheduled; any other failure, such as a host read that throws,
 *   is retried on the next run, and one failing item never stops the others.
 */
-export declare function createNotificationConformanceBackend(input: CreateNotificationConformanceBackendInput): NotificationConformanceBackend;
+export declare function createNotificationConformanceBackend(input: CreateNotificationConformanceBackendInput): NotificationConformanceFakeBackend;
 export interface NotificationConformanceRuntime extends NotificationRuntime {
   /**
   * Subscribes to the provider and to authentication, compares the provider
@@ -485,6 +502,16 @@ export interface NotificationConformanceRunOptions {
   /** Supplies a provider over the caller's fake SDK; defaults to the fake host's fixture provider. */
   readonly createProvider?: (context: NotificationConformanceContext) => NotificationConformanceHarness | Promise<NotificationConformanceHarness>;
   /**
+  * Supplies the backend under test, such as a production notifications
+  * service over an in-memory store, in place of the fake backend
+  * (`createNotificationConformanceBackend`). It receives the inputs the fake
+  * would: the registry entry derived from the provider's capabilities, the
+  * vector's catalog, deployment, and notices, the clock, and the host's
+  * send-time permission read. A failure to create it fails the vector at
+  * `backend`.
+  */
+  readonly createBackend?: (input: CreateNotificationConformanceBackendInput, context: NotificationConformanceContext) => NotificationConformanceBackend | Promise<NotificationConformanceBackend>;
+  /**
   * The backend's and the runtime's default locale;
   * `notificationConformanceDefaultLocale` when absent. A vector's
   * `notices.copy` must include it, or the vector fails at `backend`.

package/dist/notifications-conformance.js

@@ -3088,7 +3088,7 @@ export async function runNotificationConformanceVector(vector, options = {}) {
     });
     let backend;
     try {
-        backend = createNotificationConformanceBackend({
+        const backendInput = {
             entry,
             catalog: vector.catalog,
             clock,
@@ -3099,13 +3099,18 @@ export async function runNotificationConformanceVector(vector, options = {}) {
             ...(host === undefined || readServerPermission === undefined
                 ? {}
                 : { readServerPermission: (request) => readServerPermission.call(host, request) }),
-        });
+        };
+        backend = options.createBackend === undefined
+            ? createNotificationConformanceBackend(backendInput)
+            : await options.createBackend(backendInput, context);
     }
     catch (error) {
         return failed([
             {
                 path: 'backend',
-                expected: 'the deployment and the notices are valid',
+                expected: options.createBackend === undefined
+                    ? 'the deployment and the notices are valid'
+                    : 'createBackend resolves',
                 actual: describeError(error),
             },
         ]);
@@ -3240,10 +3245,10 @@ async function runBackendStep(step, path, execution) {
             backend.queueProviderResult(providerResultOf(step));
             return;
         case 'registerEndpoint':
-            backend.registerInstallation(step.input);
+            await backend.registerInstallation(step.input);
             return;
         case 'revokeSession':
-            backend.revokeSession();
+            await backend.revokeSession();
             return;
         case 'runScheduler':
             await backend.runScheduler();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mpgd/platform",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Shared platform gateway, monetization, ads, leaderboard, identity, lifecycle, and storage contracts for mpgd games.",
   "license": "MIT",
   "repository": {
@@ -93,8 +93,8 @@
     "typia": "13.0.2"
   },
   "devDependencies": {
-    "@ttsc/unplugin": "0.30.4",
-    "ttsc": "0.30.4",
+    "@ttsc/unplugin": "0.32.1",
+    "ttsc": "0.32.1",
     "typescript": "7.0.2",
     "vitest": "^4.0.0"
   },