@mpgd/platform 0.25.0 → 0.27.0

package/dist/notifications.d.ts

@@ -11,7 +11,7 @@ import { type NotificationConsentRecord, type NotificationDeliveryProviderEntry,
 export declare const notificationsProtocolVersion: '2.0.0-draft.1';
 export declare const notificationsProtocol: 'mpgd.notifications.v2';
 export type { CancelLocalNotificationsInput, LocalNotificationEntry, LocalNotificationRequest, LocalScheduleResult, NotificationCapabilities, NotificationChannel, NotificationEndpointAddress, NotificationEndpointRegistration, NotificationEvent, NotificationLocalCapabilities, NotificationOpenPath, NotificationPermissionAllowance, NotificationPermissionCapabilities, NotificationPermissionOutcome, NotificationPermissionPrompt, NotificationPermissionResult, NotificationPermissionScope, NotificationPermissionSnapshot, NotificationPermissionState, NotificationProvider, NotificationProviderId, NotificationPurpose, NotificationRemoteAddressing, NotificationRemoteCapabilities, NotificationRemoteContent, NotificationRequiredAction, NotificationSettingsResult, NotificationTopicId, NotificationTopicsInput, } from './notifications-contract.js';
-export { applyNotificationAdvertisingLabel, checkNotificationNightWindow, checkNotificationQuietHours, createNotificationNoticeIdempotencyKey, createNotificationReminderIdempotencyKey, evaluateLocalNotificationReminder, evaluateNotificationDelivery, evaluateNotificationReminderConsent, fillNotificationTemplate, findNotificationCopy, isNotificationCalendarDate, isNotificationTimestamp, isRecordableNotificationPermissionState, isRootRelativeNotificationRoute, isSameNotificationNotice, isValidNotificationTimeZone, latestNotificationConsent, listNotificationNotices, normalizeNotificationTimestamp, notificationAdvertisingOptOutActionId, notificationAdvertisingPrefix, notificationConsentResultDueBy, notificationDefaultDeploymentTimeZone, notificationDefaultOptOutLine, notificationInputBounds, notificationKeyIssue, notificationNightWindow, notificationNoticeCopyIssues, notificationNoticeLeadDays, notificationNoticeSendFrom, notificationNoticeTopic, notificationNoticeVariantCopy, notificationNoticeVariantFallbacks, notificationNoticeVariants, notificationPermissionConsentKind, notificationPermissionStateOf, notificationProviderCarriesNotices, notificationReconfirmationDueBy, notificationReconfirmationListDays, notificationRegistryMismatch, notificationReservedKeyPrefix, notificationReservedKeyPrefixes, notificationSendFingerprint, notificationSuppressionReasons, notificationTemplateDataIssue, notificationTopicDefinitionIssues, notificationTopicNeedsNoAgreement, readNotificationTemplate, recordableNotificationPermissionStates, referenceNotificationProviders, referenceNotificationTargetProviders, renderNotificationAdvertisement, resolveNotificationAdvertisingSettings, resolveNotificationContent, routeNotificationReminder, toSeoulCalendarDate, type EvaluateLocalNotificationReminderInput, type EvaluateNotificationDeliveryInput, type EvaluateNotificationReminderConsentInput, type LocalNotificationReminderDecision, type NotificationAction, type NotificationAdvertisingRules, type NotificationAdvertisingSender, type NotificationAdvertisingSettings, type NotificationClockTime, type NotificationConsentKind, type NotificationConsentRecord, type NotificationConsentSource, type NotificationConsentState, type NotificationDeferralReason, type NotificationDeliveryContent, type NotificationDeliveryDecision, type NotificationDeliveryHistoryEntry, type NotificationDeliveryOutcome, type NotificationDeliveryProviderEntry, type NotificationDeliveryRefusal, type NotificationDeliveryStatus, type NotificationDeployment, type NotificationMappingField, type NotificationNotice, type NotificationNoticeCopy, type NotificationNoticeIdentity, type NotificationNoticeKind, type NotificationNoticeLocaleCopy, type NotificationNoticeSettings, type NotificationNoticeVariant, type NotificationProviderLimit, type NotificationProviderRegistryEntry, type NotificationQuietHours, type NotificationRecordablePermissionState, type NotificationReminderRoute, type NotificationReminderStatus, type NotificationSendRequest, type NotificationSuppressionReason, type NotificationTemplateData, type NotificationTopicCopy, type NotificationTopicDeclaration, type NotificationTopicDefinition, type NotificationTopicFrequency, type NotificationTopicIssue, type NotificationTopicMapping, type NotificationUnavailableReason, type NotificationWindowCheck, type ReminderResult, type ResolveNotificationContentInput, } from './notifications-policy.js';
+export { applyNotificationAdvertisingLabel, checkNotificationNightWindow, checkNotificationQuietHours, createNotificationNoticeIdempotencyKey, createNotificationReminderIdempotencyKey, evaluateLocalNotificationReminder, evaluateNotificationDelivery, evaluateNotificationReminderConsent, fillNotificationTemplate, findNotificationCopy, isNotificationCalendarDate, isNotificationPlaceholderText, isNotificationTimestamp, isRecordableNotificationPermissionState, isRootRelativeNotificationRoute, isSameNotificationNotice, isValidNotificationTimeZone, latestNotificationConsent, listNotificationNotices, normalizeNotificationTimestamp, notificationAdvertisingOptOutActionId, notificationAdvertisingPrefix, notificationConsentResultDueBy, notificationDefaultDeploymentTimeZone, notificationDefaultOptOutLine, notificationInputBounds, notificationKeyIssue, notificationNightWindow, notificationNoticeCopyIssues, notificationNoticeLeadDays, notificationNoticeSendFrom, notificationNoticeTopic, notificationNoticeVariantCopy, notificationNoticeVariantFallbacks, notificationNoticeVariants, notificationPermissionConsentKind, notificationPermissionStateOf, notificationProviderCarriesNotices, notificationReconfirmationDueBy, notificationReconfirmationListDays, notificationRegistryMismatch, notificationReservedKeyPrefix, notificationReservedKeyPrefixes, notificationSendFingerprint, notificationSuppressionReasons, notificationTemplateDataIssue, notificationTopicDefinitionIssues, notificationTopicNeedsNoAgreement, readNotificationTemplate, recordableNotificationPermissionStates, referenceNotificationProviders, referenceNotificationTargetProviders, renderNotificationAdvertisement, resolveNotificationAdvertisingSettings, resolveNotificationContent, routeNotificationReminder, toSeoulCalendarDate, type EvaluateLocalNotificationReminderInput, type EvaluateNotificationDeliveryInput, type EvaluateNotificationReminderConsentInput, type LocalNotificationReminderDecision, type NotificationAction, type NotificationAdvertisingRules, type NotificationAdvertisingSender, type NotificationAdvertisingSettings, type NotificationClockTime, type NotificationConsentKind, type NotificationConsentRecord, type NotificationConsentSource, type NotificationConsentState, type NotificationDeferralReason, type NotificationDeliveryContent, type NotificationDeliveryDecision, type NotificationDeliveryHistoryEntry, type NotificationDeliveryOutcome, type NotificationDeliveryProviderEntry, type NotificationDeliveryRefusal, type NotificationDeliveryStatus, type NotificationDeployment, type NotificationMappingField, type NotificationNotice, type NotificationNoticeCopy, type NotificationNoticeIdentity, type NotificationNoticeKind, type NotificationNoticeLocaleCopy, type NotificationNoticeSettings, type NotificationNoticeVariant, type NotificationProviderLimit, type NotificationProviderRegistryEntry, type NotificationQuietHours, type NotificationRecordablePermissionState, type NotificationReminderRoute, type NotificationReminderStatus, type NotificationSendRequest, type NotificationSuppressionReason, type NotificationTemplateData, type NotificationTopicCopy, type NotificationTopicDeclaration, type NotificationTopicDefinition, type NotificationTopicFrequency, type NotificationTopicIssue, type NotificationTopicMapping, type NotificationUnavailableReason, type NotificationWindowCheck, type ReminderResult, type ResolveNotificationContentInput, } from './notifications-policy.js';
 type NonEmptyString = string & tags.MinLength<1>;
 type NonNegativeInteger = number & tags.Type<'uint32'>;
 export type NotificationErrorCode = 
@@ -214,8 +214,32 @@ export declare const assertNotificationNotice: (input: unknown) => NotificationN
 */
 export declare const assertRecordNotificationNoticeInput: (input: unknown) => RecordNotificationNoticeInput;
 export declare const assertNotificationDeliveryProviderEntry: (input: unknown) => NotificationDeliveryProviderEntry;
-/** Validates deployment settings, including a `timeZone` that `Intl` knows, which quiet hours read. */
-export declare function assertNotificationDeployment(input: unknown): NotificationDeployment;
+/** Options of `assertNotificationDeployment`. */
+export interface AssertNotificationDeploymentOptions {
+  /**
+  * Accept placeholders, for a validator that reports them itself
+  * (`notificationDeploymentPlaceholders`) next to the catalog's issues. A
+  * backend never sets it.
+  */
+  readonly allowPlaceholders?: boolean;
+}
+/**
+* The fields of a deployment under the Korean rules that still hold a
+* template placeholder (`isNotificationPlaceholderText`): the advertising
+* sender's name and contact and the opt-out line, which every advertising
+* push carries there. Under `none`, or without `advertisingRules`, no push
+* carries them, so none is reported.
+*/
+export declare function notificationDeploymentPlaceholders(deployment: NotificationDeployment): readonly ('advertisingSender.name' | 'advertisingSender.contact' | 'advertisingOptOutLine')[];
+/**
+* Validates deployment settings: a `timeZone` that `Intl` knows, which quiet
+* hours read, and under the Korean rules an advertising sender and opt-out
+* line that are not template placeholders
+* (`notificationDeploymentPlaceholders`). A backend built from a refused
+* deployment does not start, so a starter's placeholder contact never
+* reaches an advertising push.
+*/
+export declare function assertNotificationDeployment(input: unknown, options?: AssertNotificationDeploymentOptions): NotificationDeployment;
 /** Validates a topic definition's shape and the rules of `notificationTopicDefinitionIssues`. */
 export declare function assertNotificationTopicDefinition(input: unknown): NotificationTopicDefinition;
 export declare const assertNotificationBridgeGetCapabilitiesPayload: (input: unknown) => NotificationBridgeProtocolPayload;

package/dist/notifications.js

@@ -6,7 +6,7 @@ import * as _accessExpressionAsString_1 from "typia/lib/internal/_accessExpressi
 const __typia_transform__accessExpressionAsString = _accessExpressionAsString_1._accessExpressionAsString;
 import typia from 'typia';
 import { PlatformOperationError, } from './index.js';
-import { isValidNotificationTimeZone, notificationPermissionStateOf, notificationRouteError, notificationTimeFieldIssue, notificationTimeFields, notificationTopicDefinitionIssues, } from './notifications-policy.js';
+import { isNotificationPlaceholderText, isValidNotificationTimeZone, notificationPermissionStateOf, notificationRouteError, notificationTimeFieldIssue, notificationTimeFields, notificationTopicDefinitionIssues, } from './notifications-policy.js';
 /**
  * Notifications v2 contract module (docs/specs/notifications/notifications-v2-rfc.md).
  * Pure types, validators, and helpers only: no provider lives here, and
@@ -15,7 +15,7 @@ import { isValidNotificationTimeZone, notificationPermissionStateOf, notificatio
  */
 export const notificationsProtocolVersion = '2.0.0-draft.1';
 export const notificationsProtocol = 'mpgd.notifications.v2';
-export { applyNotificationAdvertisingLabel, checkNotificationNightWindow, checkNotificationQuietHours, createNotificationNoticeIdempotencyKey, createNotificationReminderIdempotencyKey, evaluateLocalNotificationReminder, evaluateNotificationDelivery, evaluateNotificationReminderConsent, fillNotificationTemplate, findNotificationCopy, isNotificationCalendarDate, isNotificationTimestamp, isRecordableNotificationPermissionState, isRootRelativeNotificationRoute, isSameNotificationNotice, isValidNotificationTimeZone, latestNotificationConsent, listNotificationNotices, normalizeNotificationTimestamp, notificationAdvertisingOptOutActionId, notificationAdvertisingPrefix, notificationConsentResultDueBy, notificationDefaultDeploymentTimeZone, notificationDefaultOptOutLine, notificationInputBounds, notificationKeyIssue, notificationNightWindow, notificationNoticeCopyIssues, notificationNoticeLeadDays, notificationNoticeSendFrom, notificationNoticeTopic, notificationNoticeVariantCopy, notificationNoticeVariantFallbacks, notificationNoticeVariants, notificationPermissionConsentKind, notificationPermissionStateOf, notificationProviderCarriesNotices, notificationReconfirmationDueBy, notificationReconfirmationListDays, notificationRegistryMismatch, notificationReservedKeyPrefix, notificationReservedKeyPrefixes, notificationSendFingerprint, notificationSuppressionReasons, notificationTemplateDataIssue, notificationTopicDefinitionIssues, notificationTopicNeedsNoAgreement, readNotificationTemplate, recordableNotificationPermissionStates, referenceNotificationProviders, referenceNotificationTargetProviders, renderNotificationAdvertisement, resolveNotificationAdvertisingSettings, resolveNotificationContent, routeNotificationReminder, toSeoulCalendarDate, } from './notifications-policy.js';
+export { applyNotificationAdvertisingLabel, checkNotificationNightWindow, checkNotificationQuietHours, createNotificationNoticeIdempotencyKey, createNotificationReminderIdempotencyKey, evaluateLocalNotificationReminder, evaluateNotificationDelivery, evaluateNotificationReminderConsent, fillNotificationTemplate, findNotificationCopy, isNotificationCalendarDate, isNotificationPlaceholderText, isNotificationTimestamp, isRecordableNotificationPermissionState, isRootRelativeNotificationRoute, isSameNotificationNotice, isValidNotificationTimeZone, latestNotificationConsent, listNotificationNotices, normalizeNotificationTimestamp, notificationAdvertisingOptOutActionId, notificationAdvertisingPrefix, notificationConsentResultDueBy, notificationDefaultDeploymentTimeZone, notificationDefaultOptOutLine, notificationInputBounds, notificationKeyIssue, notificationNightWindow, notificationNoticeCopyIssues, notificationNoticeLeadDays, notificationNoticeSendFrom, notificationNoticeTopic, notificationNoticeVariantCopy, notificationNoticeVariantFallbacks, notificationNoticeVariants, notificationPermissionConsentKind, notificationPermissionStateOf, notificationProviderCarriesNotices, notificationReconfirmationDueBy, notificationReconfirmationListDays, notificationRegistryMismatch, notificationReservedKeyPrefix, notificationReservedKeyPrefixes, notificationSendFingerprint, notificationSuppressionReasons, notificationTemplateDataIssue, notificationTopicDefinitionIssues, notificationTopicNeedsNoAgreement, readNotificationTemplate, recordableNotificationPermissionStates, referenceNotificationProviders, referenceNotificationTargetProviders, renderNotificationAdvertisement, resolveNotificationAdvertisingSettings, resolveNotificationContent, routeNotificationReminder, toSeoulCalendarDate, } from './notifications-policy.js';
 export const notificationErrorCodes = Object.freeze([
     'NOTIFICATIONS_UNSUPPORTED',
     'NOTIFICATIONS_CONFIGURATION_REQUIRED',
@@ -3459,12 +3459,46 @@ const assertNotificationDeploymentShape = (() => {
         return input;
     };
 })();
-/** Validates deployment settings, including a `timeZone` that `Intl` knows, which quiet hours read. */
-export function assertNotificationDeployment(input) {
+/**
+ * The fields of a deployment under the Korean rules that still hold a
+ * template placeholder (`isNotificationPlaceholderText`): the advertising
+ * sender's name and contact and the opt-out line, which every advertising
+ * push carries there. Under `none`, or without `advertisingRules`, no push
+ * carries them, so none is reported.
+ */
+export function notificationDeploymentPlaceholders(deployment) {
+    if (deployment.advertisingRules !== 'kr') {
+        return [];
+    }
+    const texts = [
+        ['advertisingSender.name', deployment.advertisingSender?.name],
+        ['advertisingSender.contact', deployment.advertisingSender?.contact],
+        ['advertisingOptOutLine', deployment.advertisingOptOutLine],
+    ];
+    return texts
+        .filter(([, value]) => value !== undefined && isNotificationPlaceholderText(value))
+        .map(([field]) => field);
+}
+/**
+ * Validates deployment settings: a `timeZone` that `Intl` knows, which quiet
+ * hours read, and under the Korean rules an advertising sender and opt-out
+ * line that are not template placeholders
+ * (`notificationDeploymentPlaceholders`). A backend built from a refused
+ * deployment does not start, so a starter's placeholder contact never
+ * reaches an advertising push.
+ */
+export function assertNotificationDeployment(input, options = {}) {
     const deployment = assertNotificationDeploymentShape(input);
     if (deployment.timeZone !== undefined && !isValidNotificationTimeZone(deployment.timeZone)) {
         throw new TypeError(`Unknown time zone in the deployment: ${deployment.timeZone}`);
     }
+    const placeholders = options.allowPlaceholders === true
+        ? []
+        : notificationDeploymentPlaceholders(deployment);
+    if (placeholders.length > 0) {
+        throw new TypeError(`The deployment still has a placeholder in ${placeholders.join(', ')}: `
+            + 'replace it with the real value before the backend starts.');
+    }
     return deployment;
 }
 const assertNotificationTopicDefinitionShape = (() => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mpgd/platform",
-  "version": "0.25.0",
+  "version": "0.27.0",
   "description": "Shared platform gateway, monetization, ads, leaderboard, identity, lifecycle, and storage contracts for mpgd games.",
   "license": "MIT",
   "repository": {
@@ -73,6 +73,10 @@
       "types": "./dist/notifications-conformance.d.ts",
       "default": "./dist/notifications-conformance.js"
     },
+    "./notifications-runtime": {
+      "types": "./dist/notifications-runtime.d.ts",
+      "default": "./dist/notifications-runtime.js"
+    },
     "./routes": {
       "types": "./dist/routes.d.ts",
       "default": "./dist/routes.js"