@mpgd/cli 0.52.0 → 0.54.0

package/dist/index.js

@@ -24,6 +24,7 @@ import { cloudflarePagesDeploymentProfiles, hostedPwaDeploymentHosts, verifyHost
 import { createMicrosoftStorePackageAcceptanceRuntime, runMicrosoftStorePackageAcceptance, } from './microsoft-store-package-acceptance.js';
 import { runMicrosoftStorePackageGeneration } from './microsoft-store-package-generation.js';
 import { defaultMpgdKitPath, initializeMicrosoftStoreStarter, listMicrosoftStoreInitializerTemplateFiles, prepareBaseGameTemplateFile, resolveMicrosoftStoreAdapterDependencyVersion, } from './microsoft-store-starter.js';
+import { applyNotificationsStarter, notificationsProviderId, readGameCreateProviders, } from './notifications-starter.js';
 import { applyKitUpgrade, planKitUpgrade } from './kit-upgrade.js';
 import { applyToolingMigration, planToolingMigration } from './tooling-migration.js';
 import { runMicrosoftStoreSubmissionPreflight } from './microsoft-store-submission.js';
@@ -58,6 +59,7 @@ const packageRoot = resolvePackageRoot(sourceDir);
 const detectedKitRoot = resolveDefaultKitRoot();
 const gameTemplateDir = path.resolve(packageRoot, 'templates/phaser-game');
 const liteTemplateOverlayDir = path.resolve(packageRoot, 'templates/lite-overlay');
+const notificationsTemplateDir = path.resolve(packageRoot, 'templates/notifications-overlay');
 const supportedGameTemplates = ['phaser', 'lite'];
 /** Lite renderers implemented today. dom/svg are reserved extension points in @mpgd/lite-shell. */
 const supportedLiteRenderers = ['canvas'];
@@ -575,6 +577,10 @@ const gameCommand = defineI18n({
                     en: 'Lite template renderer. Only canvas is implemented today.',
                     ko: 'lite 템플릿 렌더러. 현재는 canvas만 지원합니다.',
                 },
+                providers: {
+                    en: 'Comma-separated game providers. notifications adds the notifications v2 starter: the topic catalog, the backend settings, the Android, iOS, Apps in Toss, and Devvit wiring, and a notification settings screen.',
+                    ko: '쉼표로 구분한 게임 provider. notifications는 알림 v2 스타터(토픽 카탈로그, 백엔드 설정, Android·iOS·앱인토스·Devvit 연결, 알림 설정 화면)를 추가합니다.',
+                },
             }),
             args: {
                 template: {
@@ -627,6 +633,11 @@ const gameCommand = defineI18n({
                     required: false,
                     description: 'Include the Microsoft Store PWA target and release workflow.',
                 },
+                providers: {
+                    type: 'string',
+                    required: false,
+                    description: 'Comma-separated game providers. notifications adds the notifications v2 starter.',
+                },
             },
             run: (ctx) => {
                 const positionals = readLocalPositionals(ctx.positionals, ['game', 'create']);
@@ -649,6 +660,7 @@ const gameCommand = defineI18n({
                     ...(kitPath === undefined ? {} : { kitPath }),
                     dryRun: ctx.values['dry-run'] === true,
                     microsoftStore: ctx.values['microsoft-store'] === true,
+                    providers: readGameCreateProviders(readOptionalString(ctx.values.providers)),
                 });
             },
         }),
@@ -1597,8 +1609,8 @@ const targetCommand = defineI18n({
                     ko: '프로덕션 HTTPS Game Services 기본 URL.',
                 },
                 providers: {
-                    en: 'Comma-separated provider IDs. play-billing (Android) and storekit (iOS) install the kit store plugin into the shell and the game, register it with cap sync, and wire an unwired template gateway; other IDs are recorded only.',
-                    ko: '쉼표로 구분한 provider ID. play-billing(Android)과 storekit(iOS)은 키트 스토어 플러그인을 셸과 게임에 설치하고 cap sync로 등록하며, 연결되지 않은 템플릿 게이트웨이를 연결합니다. 다른 ID는 기록만 합니다.',
+                    en: 'Comma-separated provider IDs. play-billing (Android) and storekit (iOS) install the kit store plugin into the shell and the game, register it with cap sync, and wire an unwired template gateway; notifications installs the Firebase messaging and local notifications plugins for Android and iOS and wires a template gateway; other IDs are recorded only.',
+                    ko: '쉼표로 구분한 provider ID. play-billing(Android)과 storekit(iOS)은 키트 스토어 플러그인을 셸과 게임에 설치하고 cap sync로 등록하며, 연결되지 않은 템플릿 게이트웨이를 연결합니다. notifications는 Android·iOS용 Firebase 메시징과 로컬 알림 플러그인을 설치하고 템플릿 게이트웨이를 연결합니다. 다른 ID는 기록만 합니다.',
                 },
             }),
             args: {
@@ -1646,7 +1658,7 @@ const targetCommand = defineI18n({
                 providers: {
                     type: 'string',
                     required: false,
-                    description: 'Comma-separated provider IDs. play-billing (Android) and storekit (iOS) install the kit store plugin into the shell and the game, register it with cap sync, and wire an unwired template gateway; other IDs are recorded only.',
+                    description: 'Comma-separated provider IDs. play-billing (Android) and storekit (iOS) install the kit store plugin into the shell and the game, register it with cap sync, and wire an unwired template gateway; notifications installs the Firebase messaging and local notifications plugins for Android and iOS and wires a template gateway; other IDs are recorded only.',
                 },
             },
             run: (ctx) => {
@@ -1693,6 +1705,11 @@ const targetCommand = defineI18n({
                             + `${plugin.versionSource === 'kit' ? ' and the game' : ''}`
                             + `${dryRun ? '; cap add or cap sync registers it' : ''}.`);
                     }
+                    if (plan.notificationPlugins.length > 0) {
+                        console.info(`${dryRun ? 'Would install' : 'Installed'} notifications plugins `
+                            + plan.notificationPlugins.map((plugin) => `${plugin.packageName}@${plugin.version}`).join(', ')
+                            + ` into the shell for android and ios${dryRun ? '; cap add or cap sync registers them' : ''}.`);
+                    }
                     for (const warning of plan.warnings) {
                         console.warn(`Warning: ${warning}`);
                     }
@@ -2943,15 +2960,30 @@ function createGameApp(input) {
         microsoftStore: input.microsoftStore,
     });
     const baseTemplateFiles = collectTemplateFiles(gameTemplateDir);
-    const selectedTemplateFiles = input.template === 'lite'
+    const templateFiles = input.template === 'lite'
         ? applyLiteTemplateOverlay(baseTemplateFiles, collectTemplateFiles(liteTemplateOverlayDir))
         : baseTemplateFiles;
+    const selectedTemplateFiles = input.providers?.includes(notificationsProviderId) === true
+        ? applyNotificationsStarter(templateFiles, {
+            template: input.template === 'lite' ? 'lite' : 'phaser',
+            common: collectTemplateFiles(path.join(notificationsTemplateDir, 'common')),
+            phaser: collectTemplateFiles(path.join(notificationsTemplateDir, 'phaser')),
+            lite: collectTemplateFiles(path.join(notificationsTemplateDir, 'lite')),
+        })
+        : templateFiles;
     const files = selectedTemplateFiles.flatMap((file) => {
         const prepared = prepareBaseGameTemplateFile({
             relativePath: file.relativePath,
             content: file.content,
         });
-        return prepared === undefined ? [] : [{ ...file, content: renderTemplate(prepared, context) }];
+        return prepared === undefined
+            ? []
+            : [
+                {
+                    ...file,
+                    content: renderTemplate(prepared, context, file.relativePath),
+                },
+            ];
     });
     if (input.dryRun) {
         console.info(`Would create ${path.relative(process.cwd(), appDir) || appDir}:`);
@@ -3162,8 +3194,10 @@ function assertValidGameTitle(title) {
     if (title.trim().length === 0) {
         throw new Error('Game title cannot be empty.');
     }
-    if (/[\u0000-\u001f<>"'\\]/u.test(title)) {
-        throw new Error('Game title cannot contain control characters, quotes, backslashes, or angle brackets.');
+    // Quotes, backslashes, and `$` are allowed: JSON files and JS string literals
+    // escape them. `<` would break the generated HTML title.
+    if (/[\u0000-\u001f<>]/u.test(title)) {
+        throw new Error('Game title cannot contain control characters or angle brackets.');
     }
 }
 function collectTemplateFiles(templateDir) {
@@ -3185,28 +3219,79 @@ function walkTemplateDir(templateDir, relativeDir, files) {
         });
     }
 }
-function renderTemplate(content, context) {
-    let rendered = content
-        .replaceAll("from '@mpgd/cli/devvit'", `from ${context.devvitOutputPluginImport}`)
-        .replaceAll('__GAME_NAME__', context.gameName)
-        .replaceAll('__DEVVIT_APP_NAME__', context.devvitAppName)
-        .replaceAll('__GAME_TITLE_TS_LITERAL__', context.gameTitleTsLiteral)
-        .replaceAll('__GAME_TITLE__', context.gameTitle)
-        .replaceAll('__LEGAL_LAST_UPDATED__', context.legalLastUpdated)
-        .replaceAll('__PACKAGE_NAME__', context.packageName)
-        .replaceAll('__MPGD_DEPENDENCY_VERSION__', context.defaultDependencyVersion)
-        .replaceAll('__TSCONFIG_EXTENDS_LINE__', context.tsconfigExtendsLine)
-        .replaceAll('__TSCONFIG_ROOT_DIR__', context.tsconfigRootDir)
-        .replaceAll('__TSCONFIG_WORKSPACE_INCLUDES__', context.tsconfigWorkspaceIncludes)
-        .replaceAll('__TSCONFIG_WORKSPACE_EXCLUDES__', context.tsconfigWorkspaceExcludes)
-        .replaceAll('__WORKSPACE_I18N_BUILD_PREFIX__', context.workspaceI18nBuildPrefix)
-        .replaceAll('__DEFAULT_KIT_PATH__', context.defaultKitPath)
-        .replaceAll('__RECOMMENDED_MATRIX_TARGETS__', context.recommendedMatrixTargets)
-        .replaceAll('__PNPM_WORKSPACE_KIT_PACKAGES__', context.pnpmWorkspaceKitPackages)
-        .replaceAll('__PASCAL_NAME__', context.pascalName)
-        .replaceAll('__CAMEL_NAME__', context.camelName);
+/**
+ * String replacements treat `$&`, `$'`, `` $` ``, and `$$` as patterns.
+ * A function replacer inserts `value` literally.
+ */
+function replaceLiteral(content, placeholder, value) {
+    return content.replaceAll(placeholder, () => value);
+}
+/** Interior of a JSON string, without the surrounding quotes. */
+function jsonStringContents(value) {
+    return JSON.stringify(value).slice(1, -1);
+}
+/**
+ * Placeholders substituted inside an existing JSON string. Structural
+ * fragments (`__TSCONFIG_EXTENDS_LINE__` and the workspace include/exclude
+ * lists) stay raw so their quotes remain JSON syntax.
+ */
+function jsonEscapedPlaceholder(placeholder) {
+    return placeholder === '__GAME_TITLE__'
+        || placeholder === '__GAME_NAME__'
+        || placeholder === '__PACKAGE_NAME__'
+        || placeholder === '__DEVVIT_APP_NAME__'
+        || placeholder === '__DEFAULT_KIT_PATH__'
+        || placeholder === '__WORKSPACE_I18N_BUILD_PREFIX__'
+        || placeholder === '__TSCONFIG_ROOT_DIR__'
+        || placeholder === '__LEGAL_LAST_UPDATED__'
+        || placeholder === '__MPGD_DEPENDENCY_VERSION__'
+        || placeholder.startsWith('__MPGD_DEPENDENCY_VERSION_');
+}
+/** Interior of a single-quoted JS string. Backslash first, then quote. */
+function singleQuotedContents(value) {
+    return value.replaceAll('\\', () => '\\\\').replaceAll("'", () => "\\'");
+}
+function renderTemplate(content, context, relativePath) {
+    // `.webmanifest` is JSON. Hosted PWA deploy and Microsoft Store submission parse it.
+    const jsonFile = relativePath.endsWith('.json') || relativePath.endsWith('.webmanifest');
+    const typescriptFile = relativePath.endsWith('.ts');
+    const insert = (placeholder, value) => {
+        if (jsonFile && jsonEscapedPlaceholder(placeholder)) {
+            return jsonStringContents(value);
+        }
+        // Template titles sit in single quotes (`title: '__GAME_TITLE__'`).
+        if (typescriptFile && placeholder === '__GAME_TITLE__') {
+            return singleQuotedContents(value);
+        }
+        return value;
+    };
+    const pairs = [
+        [`from '@mpgd/cli/devvit'`, `from ${context.devvitOutputPluginImport}`],
+        ['__GAME_NAME__', context.gameName],
+        ['__DEVVIT_APP_NAME__', context.devvitAppName],
+        // Longer than `__GAME_TITLE__`, so a title is not written into the literal name.
+        ['__GAME_TITLE_TS_LITERAL__', context.gameTitleTsLiteral],
+        ['__GAME_TITLE__', context.gameTitle],
+        ['__LEGAL_LAST_UPDATED__', context.legalLastUpdated],
+        ['__PACKAGE_NAME__', context.packageName],
+        ['__MPGD_DEPENDENCY_VERSION__', context.defaultDependencyVersion],
+        ['__TSCONFIG_EXTENDS_LINE__', context.tsconfigExtendsLine],
+        ['__TSCONFIG_ROOT_DIR__', context.tsconfigRootDir],
+        ['__TSCONFIG_WORKSPACE_INCLUDES__', context.tsconfigWorkspaceIncludes],
+        ['__TSCONFIG_WORKSPACE_EXCLUDES__', context.tsconfigWorkspaceExcludes],
+        ['__WORKSPACE_I18N_BUILD_PREFIX__', context.workspaceI18nBuildPrefix],
+        ['__DEFAULT_KIT_PATH__', context.defaultKitPath],
+        ['__RECOMMENDED_MATRIX_TARGETS__', context.recommendedMatrixTargets],
+        ['__PNPM_WORKSPACE_KIT_PACKAGES__', context.pnpmWorkspaceKitPackages],
+        ['__PASCAL_NAME__', context.pascalName],
+        ['__CAMEL_NAME__', context.camelName],
+    ];
+    let rendered = content;
+    for (const [placeholder, value] of pairs) {
+        rendered = replaceLiteral(rendered, placeholder, insert(placeholder, value));
+    }
     for (const replacement of context.mpgdDependencyVersionReplacements) {
-        rendered = rendered.replaceAll(replacement.placeholder, replacement.version);
+        rendered = replaceLiteral(rendered, replacement.placeholder, insert(replacement.placeholder, replacement.version));
     }
     return rendered;
 }
@@ -3311,8 +3396,8 @@ function resolveStandaloneNativeBuild(targetsFile, requestedTarget, values) {
             return undefined;
         }
         const candidate = path.resolve(gameRoot, configuredPath
-            .replaceAll('${MPGD_GAME_ROOT}', gameRoot)
-            .replaceAll('${MPGD_GAME_APP_ROOT}', gameRoot));
+            .replaceAll('${MPGD_GAME_ROOT}', () => gameRoot)
+            .replaceAll('${MPGD_GAME_APP_ROOT}', () => gameRoot));
         let existingAncestor = candidate;
         while (!existsSync(existingAncestor)) {
             const parent = path.dirname(existingAncestor);
@@ -3371,8 +3456,14 @@ function createGameOwnedReleaseEnv(gameRoot, baseEnv) {
         ?? readSourceGitSha(gameRoot);
     const appVersion = readOptionalString(baseEnv.APP_VERSION)
         ?? readGamePackageVersion(gameRoot);
+    const notificationTopicsFile = readConfiguredPath(baseEnv.MPGD_NOTIFICATION_TOPICS_FILE);
     return {
         ...monetizationFiles,
+        // The Apps in Toss wrapper builds in its own directory; a relative path
+        // names a file of the game, as `pnpm validate:notifications` reads it.
+        ...(notificationTopicsFile === undefined
+            ? {}
+            : { MPGD_NOTIFICATION_TOPICS_FILE: path.resolve(gameRoot, notificationTopicsFile) }),
         MPGD_SOURCE_GIT_SHA: sourceGitSha,
         ...(appVersion === undefined ? {} : { APP_VERSION: appVersion }),
     };
@@ -3464,10 +3555,7 @@ function formatError(error) {
 }
 function replaceTargetTokens(value, context) {
     if (typeof value === 'string') {
-        return value
-            .replaceAll('${MPGD_KIT_PATH}', context.kitPath)
-            .replaceAll('${MPGD_GAME_ROOT}', context.gameRoot)
-            .replaceAll('${MPGD_GAME_APP_ROOT}', context.gameRoot);
+        return replaceLiteral(replaceLiteral(replaceLiteral(value, '${MPGD_KIT_PATH}', context.kitPath), '${MPGD_GAME_ROOT}', context.gameRoot), '${MPGD_GAME_APP_ROOT}', context.gameRoot);
     }
     if (Array.isArray(value)) {
         return value.map((entry) => replaceTargetTokens(entry, context));

package/dist/kit-upgrade.js

@@ -278,8 +278,8 @@ function discoverGameManifests(gameRoot, notes, blockers, targetsFileName) {
                 continue;
             }
             const resolvedLocation = location
-                .replaceAll('${MPGD_GAME_ROOT}', targetsDirectory)
-                .replaceAll('${MPGD_GAME_APP_ROOT}', targetsDirectory);
+                .replaceAll('${MPGD_GAME_ROOT}', () => targetsDirectory)
+                .replaceAll('${MPGD_GAME_APP_ROOT}', () => targetsDirectory);
             if (resolvedLocation.includes('$' + '{')) {
                 notes.push('Skipped target with unresolved path token: ' + location);
                 continue;

package/dist/native-build-info.json

@@ -1,5 +1,5 @@
 {
-  "kitGitSha": "48bd874fd96f6dbca38c4ff5f0783088b61fab58",
+  "kitGitSha": "95ea69d3e9755256b27a3b0ea230812a632ed03b",
   "kitDirty": false,
-  "packageVersion": "0.52.0"
+  "packageVersion": "0.54.0"
 }