@mpgd/cli 0.52.0 → 0.53.0

package/dist/native-build-info.json

@@ -1,5 +1,5 @@
 {
-  "kitGitSha": "48bd874fd96f6dbca38c4ff5f0783088b61fab58",
+  "kitGitSha": "78bcaad6a3e53131be44f749c27b9377a2fd96dc",
   "kitDirty": false,
-  "packageVersion": "0.52.0"
+  "packageVersion": "0.53.0"
 }

package/dist/native-build-target.js

@@ -13338,6 +13338,22 @@ function resolveConfiguredBaseDir(baseEnv, fallbackBaseDir, productCatalogFile,
 function configuredFileExists(baseDir, file) {
   return existsSync13(isAbsolute10(file) ? file : resolve16(baseDir, file));
 }
+function normalizeNotificationTopicsEnv(baseEnv, fallbackBaseDir = process.cwd()) {
+  const file = readConfiguredPath(baseEnv.MPGD_NOTIFICATION_TOPICS_FILE);
+  if (file === void 0) {
+    return {};
+  }
+  if (isAbsolute10(file)) {
+    return { MPGD_NOTIFICATION_TOPICS_FILE: file };
+  }
+  const base = [
+    fallbackBaseDir,
+    readConfiguredPath(baseEnv.INIT_CWD),
+    readConfiguredPath(baseEnv.PWD),
+    process.cwd()
+  ].find((candidate) => candidate !== void 0 && existsSync13(resolve16(candidate, file)));
+  return { MPGD_NOTIFICATION_TOPICS_FILE: resolve16(base ?? fallbackBaseDir, file) };
+}
 
 // node_modules/.cache/mpgd-native-build/tools/target/native-build-attempt.js
 import { randomUUID as randomUUID3 } from "node:crypto";
@@ -14390,7 +14406,349 @@ import { dirname as dirname9, isAbsolute as isAbsolute11, join as join13, relati
 import { chmodSync as chmodSync2, existsSync as existsSync21, lstatSync as lstatSync12, mkdirSync as mkdirSync11, readdirSync as readdirSync6, readFileSync as readFileSync21, realpathSync as realpathSync9, renameSync as renameSync5, unlinkSync as unlinkSync2, writeFileSync as writeFileSync15 } from "node:fs";
 import path9 from "node:path";
 import { DOMParser as DOMParser2 } from "@xmldom/xmldom";
-import { satisfies, valid } from "semver";
+import { satisfies, valid, validRange } from "semver";
+
+// node_modules/.cache/mpgd-native-build/packages/cli/src/notifications-starter.js
+var notificationsMessagingPlugin = "@capacitor-firebase/messaging";
+var notificationsGameDependencies = Object.freeze({
+  [notificationsMessagingPlugin]: "8.5.2",
+  "@capacitor/local-notifications": "8.3.1",
+  firebase: "12.19.0"
+});
+var notificationsShellPlugins = Object.freeze([
+  notificationsMessagingPlugin,
+  "@capacitor/local-notifications"
+]);
+var gatewayImport = {
+  anchor: "import type { RuntimeConfig } from '../runtimeDetector';\n",
+  replacement: [
+    "import { createStarterCapacitorNotifications } from '../capacitorNotifications';",
+    "import type { RuntimeConfig } from '../runtimeDetector';",
+    ""
+  ].join("\n")
+};
+var gatewayProviders = (platform) => ({
+  anchor: "  const providers = createStoreProviders(runtime, () => gateway);\n",
+  replacement: [
+    "  const providers = [",
+    "    ...createStoreProviders(runtime, () => gateway),",
+    "    // Notifications v2 (FCM and local reminders); `notifications/topics.json`",
+    "    // maps the topics, and the shell needs the two plugins",
+    "    // (`mpgd target init capacitor --providers notifications`).",
+    `    ...(await createStarterCapacitorNotifications('${platform}', runtime.configTarget)),`,
+    "  ];",
+    ""
+  ].join("\n")
+});
+var commonEdits = {
+  "src/platform/buildGateways/capacitorAndroid.ts": [gatewayImport, gatewayProviders("android")],
+  "src/platform/buildGateways/capacitorIos.ts": [gatewayImport, gatewayProviders("ios")],
+  "src/platform/buildGateways/reddit.ts": [
+    {
+      anchor: "import { createDevvitWebPaymentsClient } from '@mpgd/adapter-devvit/web';\n",
+      replacement: [
+        "import {",
+        "  createDevvitWebLoginPrompt,",
+        "  createDevvitWebPaymentsClient,",
+        "} from '@mpgd/adapter-devvit/web';",
+        ""
+      ].join("\n")
+    },
+    {
+      anchor: "import type { RuntimeConfig } from '../runtimeDetector';\n",
+      replacement: [
+        "import { starterNotificationTopics } from '../notifications';",
+        "import type { RuntimeConfig } from '../runtimeDetector';",
+        ""
+      ].join("\n")
+    },
+    {
+      anchor: "    ...(commerce === undefined ? {} : { commerce }),\n",
+      replacement: [
+        "    ...(commerce === undefined ? {} : { commerce }),",
+        "    // Notifications v2: the game-rendered opt-in the server bridge serves",
+        "    // (a gated beta: `integrations.notifications` stays approval-required",
+        "    // until Reddit approves the app), and Reddit login for a logged-out",
+        "    // player, who must log in before opting in.",
+        "    ...notificationOptions(runtime),",
+        "    loginPrompt: createDevvitWebLoginPrompt(),",
+        ""
+      ].join("\n")
+    },
+    {
+      anchor: "function createCommerceOptions(): DevvitGatewayCommerceOptions | undefined {\n",
+      replacement: [
+        "function notificationOptions(",
+        "  runtime: RuntimeConfig,",
+        "): Pick<Parameters<typeof createDevvitPlatformGateway>[0], 'notifications'> {",
+        "  const topics = starterNotificationTopics(runtime.configTarget).map((topic) => topic.id);",
+        "  return topics.length === 0 ? {} : { notifications: { topics } };",
+        "}",
+        "",
+        "function createCommerceOptions(): DevvitGatewayCommerceOptions | undefined {",
+        ""
+      ].join("\n")
+    }
+  ],
+  "apps/target-devvit/src/server/index.ts": [
+    {
+      anchor: "import { context, createServer, getServerPort, payments, reddit, redis } from '@devvit/web/server';\n",
+      replacement: [
+        "import {",
+        "  context,",
+        "  createServer,",
+        "  getServerPort,",
+        "  notifications,",
+        "  payments,",
+        "  reddit,",
+        "  redis,",
+        "} from '@devvit/web/server';",
+        ""
+      ].join("\n")
+    },
+    {
+      anchor: [
+        "import {",
+        "  createDevvitCommerceBridgeProducts,",
+        "  createDevvitCommerceV2BridgeHandler,",
+        "} from '@mpgd/adapter-devvit/server';",
+        ""
+      ].join("\n"),
+      replacement: [
+        "import {",
+        "  createDevvitCommerceBridgeProducts,",
+        "  createDevvitCommerceV2BridgeHandler,",
+        "  createDevvitNotificationService,",
+        "  createDevvitNotificationsV2BridgeHandler,",
+        "} from '@mpgd/adapter-devvit/server';",
+        ""
+      ].join("\n")
+    },
+    {
+      anchor: "import type { ProductCatalog } from '@mpgd/catalog';\n",
+      replacement: [
+        "import { resolveNotificationTopicsForTarget, type NotificationTopicCatalog, type ProductCatalog } from '@mpgd/catalog';",
+        "import { assertNotificationDeployment } from '@mpgd/platform/notifications';",
+        ""
+      ].join("\n")
+    },
+    {
+      anchor: "import devvitManifest from '../../devvit.json';\n",
+      replacement: [
+        "import notificationDeploymentJson from '../../../../notifications/deployment.json';",
+        "import notificationTopicsJson from '../../../../notifications/topics.json';",
+        "import devvitManifest from '../../devvit.json';",
+        ""
+      ].join("\n")
+    },
+    {
+      anchor: [
+        "const handleBridgeRequest = createDevvitBridgeHandler({",
+        "  redis,",
+        "  currentPlayerId,",
+        "  currentDisplayName,",
+        "  storageKeyNamespace: gameName,",
+        "  ...(commerce === undefined ? {} : { commerce }),",
+        "});",
+        ""
+      ].join("\n"),
+      replacement: [
+        "/**",
+        " * Notifications v2 (`notifications/topics.json`, mapped for the `reddit`",
+        " * target): the game-rendered opt-in for the logged-in requester, and the",
+        " * service that records consent and sends server reminders over the Devvit",
+        " * notifications plugin. Devvit notifications are a gated beta: the game",
+        " * shows them only once `integrations.notifications` is `available`.",
+        " */",
+        "const notificationTopicCatalog = notificationTopicsJson as NotificationTopicCatalog;",
+        "const redditNotificationTopics = readRedditNotificationTopics();",
+        "const notificationService: Parameters<typeof handleNotificationTask>[0]['notifications'] =",
+        "  redditNotificationTopics.length === 0 ? undefined : createNotificationService();",
+        "// The opt-in is served only with the service that sends; a refused catalog turns both off.",
+        "const notificationsBridge = notificationService === undefined",
+        "  ? undefined",
+        "  : createDevvitNotificationsV2BridgeHandler({",
+        "      notifications,",
+        "      currentUserId: currentPlayerId,",
+        "      topics: redditNotificationTopics,",
+        "    });",
+        "const handleBridgeRequest = createDevvitBridgeHandler({",
+        "  redis,",
+        "  currentPlayerId,",
+        "  currentDisplayName,",
+        "  storageKeyNamespace: gameName,",
+        "  ...(commerce === undefined ? {} : { commerce }),",
+        "  ...(notificationsBridge === undefined ? {} : { notifications: notificationsBridge }),",
+        "});",
+        ""
+      ].join("\n")
+    },
+    {
+      anchor: [
+        "/**",
+        " * The notifications v2 service (`createDevvitNotificationService` from",
+        " * `@mpgd/adapter-devvit/server`). None until the game declares a topic",
+        " * catalog, so the scheduler tasks below do no work.",
+        " */",
+        "const notificationService: Parameters<typeof handleNotificationTask>[0]['notifications'] = undefined;",
+        ""
+      ].join("\n"),
+      replacement: [
+        "/** The topic ids the catalog maps for Reddit; none when the catalog cannot be read. */",
+        "function readRedditNotificationTopics(): readonly string[] {",
+        "  try {",
+        "    return resolveNotificationTopicsForTarget(notificationTopicCatalog, 'reddit').map((topic) => topic.id);",
+        "  } catch (error) {",
+        "    console.error(`devvit notifications disabled: ${errorMessage(error)}`);",
+        "    return [];",
+        "  }",
+        "}",
+        "",
+        "/**",
+        " * The notifications v2 service over Redis and the Devvit plugin; the",
+        " * scheduler tasks below run its reminders and purges. A catalog or",
+        " * deployment the service refuses turns notifications off, never the game",
+        " * server.",
+        " */",
+        "function createNotificationService(): Parameters<typeof handleNotificationTask>[0]['notifications'] {",
+        "  try {",
+        "    return createDevvitNotificationService({",
+        "      redis,",
+        "      notifications,",
+        "      catalog: notificationTopicCatalog,",
+        "      deployment: assertNotificationDeployment(notificationDeploymentJson),",
+        "    }).service;",
+        "  } catch (error) {",
+        "    console.error(`devvit notifications disabled: ${errorMessage(error)}`);",
+        "    return undefined;",
+        "  }",
+        "}",
+        ""
+      ].join("\n")
+    }
+  ]
+};
+var phaserEdits = {
+  "src/runtime/createGame.ts": [
+    {
+      anchor: "import { LobbyScene } from '../scenes/LobbyScene';\n",
+      replacement: [
+        "import { LobbyScene } from '../scenes/LobbyScene';",
+        "import {",
+        "  NotificationSettingsScene,",
+        "  routeNotificationSettingsOpens,",
+        "} from '../scenes/NotificationSettingsScene';",
+        ""
+      ].join("\n")
+    },
+    {
+      anchor: "    scene: [BootScene, LobbyScene, PlayScene],\n",
+      replacement: "    scene: [BootScene, LobbyScene, PlayScene, NotificationSettingsScene],\n"
+    },
+    {
+      anchor: "        ownGameAudio(game, input.context);\n",
+      replacement: [
+        "        ownGameAudio(game, input.context);",
+        "        // The advertising opt-out action and consent notices open the settings screen.",
+        "        routeNotificationSettingsOpens(game, input.context);",
+        ""
+      ].join("\n")
+    }
+  ],
+  "src/scenes/LobbyScene.ts": [
+    {
+      anchor: "import { starterContextKey, type StarterContext } from '../runtime/gameContext';\n",
+      replacement: [
+        "import { starterContextKey, type StarterContext } from '../runtime/gameContext';",
+        "import { notificationSettingsSceneKey } from './NotificationSettingsScene';",
+        ""
+      ].join("\n")
+    },
+    {
+      anchor: "    this.input.once('pointerdown', () => this.scene.start('PlayScene'));\n",
+      replacement: [
+        "    // The settings button shows only where this target has notifications.",
+        "    const notificationsButton = context.platform.notificationsV2 === undefined",
+        "      ? undefined",
+        "      : this.add",
+        "          .text(940, 16, locale === 'ko' ? '\uC54C\uB9BC \uC124\uC815' : 'Notifications', {",
+        "            color: '#5eead4',",
+        "            fontFamily: 'Arial, sans-serif',",
+        "            fontSize: '22px',",
+        "          })",
+        "          .setOrigin(1, 0)",
+        "          .setPadding(16, 12, 16, 12)",
+        "          .setInteractive({ useHandCursor: true });",
+        "    notificationsButton?.on('pointerup', () => this.scene.start(notificationSettingsSceneKey));",
+        "    // A tap anywhere else starts the game; the scene drops this listener on shutdown.",
+        "    this.input.on('pointerdown', (_pointer: Phaser.Input.Pointer, over: Phaser.GameObjects.GameObject[]) => {",
+        "      if (notificationsButton === undefined || !over.includes(notificationsButton)) {",
+        "        this.scene.start('PlayScene');",
+        "      }",
+        "    });",
+        ""
+      ].join("\n")
+    }
+  ]
+};
+var liteEdits = {
+  "src/runtime/createGame.ts": [
+    {
+      anchor: "import { createTapGame } from '../lite/tapGame';\n",
+      replacement: [
+        "import { mountNotificationSettingsPanel } from '../lite/notificationSettingsPanel';",
+        "import { createTapGame } from '../lite/tapGame';",
+        ""
+      ].join("\n")
+    },
+    {
+      anchor: "  const shell = createTapGame({ mount, title: '__GAME_TITLE__' });\n",
+      replacement: [
+        "  const shell = createTapGame({ mount, title: '__GAME_TITLE__' });",
+        "  const disposeNotificationSettings = mountNotificationSettingsPanel(mount, input.context);",
+        ""
+      ].join("\n")
+    },
+    {
+      anchor: "    audio.dispose();\n",
+      replacement: ["    audio.dispose();", "    disposeNotificationSettings();", ""].join("\n")
+    }
+  ]
+};
+var readmeSection = [
+  "",
+  "## Notifications",
+  "",
+  "This game was created with `--providers notifications`. Its topics live in",
+  "`notifications/topics.json` and the backend settings (`advertisingRules`,",
+  "the advertising sender) in `notifications/deployment.json`; run",
+  "`pnpm validate:notifications` after every change and before every release.",
+  "Replace the sender contact placeholder in `notifications/deployment.json`",
+  "before any advertising is sent. The notification settings screen asks for the",
+  "OS or host permission and records reminder, advertising (\uAD11\uACE0\uC131 \uC815\uBCF4",
+  "\uC218\uC2E0\uB3D9\uC758), and night consent through the notifications runtime. See",
+  "`docs/NOTIFICATIONS.md` and, for Android and iOS, the mpgd-kit Firebase setup",
+  "guide; `mpgd target init capacitor --providers notifications` installs the two",
+  "Capacitor plugins into a game-owned shell.",
+  ""
+].join("\n");
+var notificationsCapacitorGateways = Object.freeze({
+  android: "src/platform/buildGateways/capacitorAndroid.ts",
+  ios: "src/platform/buildGateways/capacitorIos.ts"
+});
+var notificationsCapacitorGatewayModules = Object.freeze([
+  "src/platform/capacitorNotifications.ts",
+  "src/platform/notifications.ts",
+  "src/platform/notificationSettings.ts",
+  "src/platform/notificationOpens.ts"
+]);
+var notificationsCapacitorSupportFiles = Object.freeze([
+  ...notificationsCapacitorGatewayModules,
+  "notifications/topics.json",
+  "notifications/deployment.json",
+  "tools/validate-notifications.ts",
+  "docs/NOTIFICATIONS.md"
+]);
 
 // node_modules/.cache/mpgd-native-build/packages/cli/src/native-shell-identity.js
 function assertAndroidSettingsAppProject(source) {
@@ -16633,7 +16991,10 @@ assertDisjointMiniGameTargetOutputs(config.targets, targetPath, [
   }
 ]);
 var runtimeTargetConfigMatrix = loadTargetConfigMatrix();
-var monetizationCatalogEnv = normalizeMonetizationCatalogEnv(process.env, configBaseDir);
+var monetizationCatalogEnv = {
+  ...normalizeMonetizationCatalogEnv(process.env, configBaseDir),
+  ...normalizeNotificationTopicsEnv(process.env, configBaseDir)
+};
 var targetScopedEnv = {
   ...process.env,
   ...monetizationCatalogEnv,

package/dist/notifications-starter.d.ts

@@ -0,0 +1,69 @@
+/**
+* The notifications starter (`mpgd game create --providers notifications`):
+* the files `templates/notifications-overlay` adds to a generated game, and the
+* anchored edits it makes to the base template, so a game without
+* notifications ships none of it (notifications v2 RFC, PR C1).
+*
+* Every edit names an anchor that must occur exactly once in the base file,
+* so a template change that moves an anchor fails the CLI's tests instead of
+* generating a half-wired game.
+*/
+/** The provider id that selects the notifications starter. */
+export declare const notificationsProviderId = "notifications";
+/** The push plugin the notifications starter adds (FCM on Android and iOS). */
+export declare const notificationsMessagingPlugin = "@capacitor-firebase/messaging";
+/**
+* The npm packages a game with notifications declares. The two Capacitor
+* plugins are the optional peers `@mpgd/adapter-capacitor/notifications`
+* loads, at the versions the adapter is tested with; `firebase` is the
+* package the messaging plugin's web fallback imports, which the bundler
+* must resolve even though a native shell never loads it.
+*/
+export declare const notificationsGameDependencies: Readonly<Record<string, string>>;
+/**
+* The `firebase` range the starter's `@capacitor-firebase/messaging` version
+* declares as its peer (its web fallback imports the SDK). A game that keeps
+* its own `firebase` must be in it before the starter adds the plugin; the
+* starter test pins it to the plugin's published metadata.
+*/
+export declare const notificationsMessagingFirebaseRange = "^12.6.0";
+/** The plugins `mpgd target init capacitor --providers notifications` installs into the shell. */
+export declare const notificationsShellPlugins: readonly string[];
+/** Never installed next to the messaging plugin: on iOS both claim Capacitor's one push handler. */
+export declare const conflictingPushPlugin = "@capacitor/push-notifications";
+export type NotificationsStarterTemplate = 'phaser' | 'lite';
+export interface NotificationsStarterFile {
+  readonly relativePath: string;
+  readonly content: string;
+}
+/**
+* Applies the notifications starter to a generated game's template files:
+* adds the overlay's files (`common` and the template's own) and edits the
+* base files at their anchors. Throws when an anchor is missing, so a
+* template change cannot silently drop the wiring.
+*/
+export declare function applyNotificationsStarter<File extends NotificationsStarterFile>(baseFiles: readonly File[], overlay: {
+  readonly template: NotificationsStarterTemplate;
+  readonly common: readonly File[];
+  readonly phaser: readonly File[];
+  readonly lite: readonly File[];
+}): readonly File[];
+/** The Capacitor gateways the notifications starter wires, by native platform. */
+export declare const notificationsCapacitorGateways: Readonly<Record<'android' | 'ios', string>>;
+/** The starter modules a wired Capacitor gateway imports, directly or through one another. */
+export declare const notificationsCapacitorGatewayModules: readonly string[];
+/**
+* The files `mpgd target init capacitor --providers notifications` writes
+* with a wired gateway when the game has none: the modules it imports, the
+* catalog files they read, the validator, and the game's notifications doc.
+*/
+export declare const notificationsCapacitorSupportFiles: readonly string[];
+/** Whether a Capacitor gateway already registers a notifications provider. */
+export declare function capacitorGatewayRegistersNotifications(source: string): boolean;
+/**
+* The template's Capacitor gateway with the notifications provider wired in:
+* the same anchored edits `--providers notifications` makes at generation.
+*/
+export declare function wireCapacitorGatewayNotifications(relativePath: string, source: string): string;
+/** Reads `--providers` for `mpgd game create`: only `notifications` is a game-level provider today. */
+export declare function readGameCreateProviders(value: string | undefined): readonly string[];