@chipmobilesdk/rn-payment 0.4.0 → 0.5.0

package/src/diagnostics/messageKeys.ts

@@ -1,95 +1,93 @@
-/**
- * Stable, localizable message keys with English default copy (FR-084, FR-085).
- *
- * The package takes no i18n runtime dependency: consuming apps map these keys to
- * localized strings through whatever i18n system they already run. This is plain
- * data, and the package never resolves or renders it.
- *
- * Message keys are **public API**: renaming one is a breaking change, on the
- * same footing as an error code (FR-078).
- *
- * User-actionable copy and developer/configuration copy are kept in separate
- * maps so an app cannot accidentally show "Payment catalog is invalid" to a
- * customer — a configuration fault is a developer's problem, not a user's.
- */
-
-/** Copy an end user may reasonably be shown. */
-export interface PaymentUserMessageMap {
-	'payment.state.pending': string;
-	'payment.state.alreadyOwned': string;
-	'payment.action.restore': string;
-	'payment.restore.succeeded': string;
-	'payment.restore.nothingFound': string;
-	'payment.error.cancelled': string;
-	'payment.error.network': string;
-	'payment.error.unavailable': string;
-	'payment.error.disabled': string;
-	'payment.subscription.grace': string;
-	'payment.subscription.hold': string;
-}
-
-/** Copy for developers and operators. **Never** surfaced to an end user. */
-export interface PaymentDeveloperMessageMap {
-	'payment.config.invalidCatalog': string;
-	'payment.config.missingStoreId': string;
-	'payment.config.productionInNonProductionBuild': string;
-	'payment.config.storageUnavailable': string;
-	'payment.config.environmentBlocked': string;
-}
-
-export type PaymentMessageMap = PaymentUserMessageMap &
-	PaymentDeveloperMessageMap;
-
-export type PaymentUserMessageKey = keyof PaymentUserMessageMap;
-export type PaymentDeveloperMessageKey = keyof PaymentDeveloperMessageMap;
-export type PaymentMessageKey = keyof PaymentMessageMap;
-
-export const DEFAULT_USER_MESSAGES: PaymentUserMessageMap = {
-	'payment.state.pending': 'Waiting for your payment to complete',
-	'payment.state.alreadyOwned': 'You already own this',
-	'payment.action.restore': 'Restore purchases',
-	'payment.restore.succeeded': 'Your purchases have been restored',
-	'payment.restore.nothingFound': 'No previous purchases found',
-	'payment.error.cancelled': 'Purchase cancelled',
-	'payment.error.network':
-		"Couldn't reach the store. Check your connection and try again.",
-	'payment.error.unavailable': "Purchases aren't available on this device",
-	'payment.error.disabled': 'Purchases are currently unavailable',
-	'payment.subscription.grace': "There's a problem with your payment method",
-	'payment.subscription.hold':
-		'Your subscription is paused until payment is updated',
-};
-
-export const DEFAULT_DEVELOPER_MESSAGES: PaymentDeveloperMessageMap = {
-	'payment.config.invalidCatalog': 'Payment catalog is invalid',
-	'payment.config.missingStoreId':
-		'Product is missing a store identifier for this platform',
-	'payment.config.productionInNonProductionBuild':
-		'Production payment configuration in a non-production build',
-	'payment.config.storageUnavailable':
-		'Local storage unavailable; entitlements will not survive restart',
-	'payment.config.environmentBlocked':
-		'Purchase blocked: this environment may not create a real transaction',
-};
-
-export const DEFAULT_MESSAGES: PaymentMessageMap = {
-	...DEFAULT_USER_MESSAGES,
-	...DEFAULT_DEVELOPER_MESSAGES,
-};
-
-/** Every user-actionable key, for an app building its translation resource. */
-export const USER_MESSAGE_KEYS = Object.keys(
-	DEFAULT_USER_MESSAGES,
-) as PaymentUserMessageKey[];
-
-/** Every developer-facing key, so an app can exclude them from user-visible bundles. */
-export const DEVELOPER_MESSAGE_KEYS = Object.keys(
-	DEFAULT_DEVELOPER_MESSAGES,
-) as PaymentDeveloperMessageKey[];
-
-/** True for keys safe to show an end user. Lets an app assert that at its boundary. */
-export function isUserMessageKey(
-	key: PaymentMessageKey,
-): key is PaymentUserMessageKey {
-	return key in DEFAULT_USER_MESSAGES;
-}
+/**
+ * Stable, localizable message keys with English default copy (FR-084, FR-085).
+ *
+ * The package takes no i18n runtime dependency: consuming apps map these keys to
+ * localized strings through whatever i18n system they already run. This is plain
+ * data, and the package never resolves or renders it.
+ *
+ * Message keys are **public API**: renaming one is a breaking change, on the
+ * same footing as an error code (FR-078).
+ *
+ * User-actionable copy and developer/configuration copy are kept in separate
+ * maps so an app cannot accidentally show "Payment catalog is invalid" to a
+ * customer — a configuration fault is a developer's problem, not a user's.
+ */
+
+/** Copy an end user may reasonably be shown. */
+import { defineMessages } from '@chipmobilesdk/rn-core';
+
+export interface PaymentUserMessageMap {
+	'payment.state.pending': string;
+	'payment.state.alreadyOwned': string;
+	'payment.action.restore': string;
+	'payment.restore.succeeded': string;
+	'payment.restore.nothingFound': string;
+	'payment.error.cancelled': string;
+	'payment.error.network': string;
+	'payment.error.unavailable': string;
+	'payment.error.disabled': string;
+	'payment.subscription.grace': string;
+	'payment.subscription.hold': string;
+}
+
+/** Copy for developers and operators. **Never** surfaced to an end user. */
+export interface PaymentDeveloperMessageMap {
+	'payment.config.invalidCatalog': string;
+	'payment.config.missingStoreId': string;
+	'payment.config.productionInNonProductionBuild': string;
+	'payment.config.storageUnavailable': string;
+	'payment.config.environmentBlocked': string;
+}
+
+export type PaymentMessageMap = PaymentUserMessageMap & PaymentDeveloperMessageMap;
+
+export type PaymentUserMessageKey = keyof PaymentUserMessageMap;
+export type PaymentDeveloperMessageKey = keyof PaymentDeveloperMessageMap;
+export type PaymentMessageKey = keyof PaymentMessageMap;
+
+export const DEFAULT_USER_MESSAGES: PaymentUserMessageMap = {
+	'payment.state.pending': 'Waiting for your payment to complete',
+	'payment.state.alreadyOwned': 'You already own this',
+	'payment.action.restore': 'Restore purchases',
+	'payment.restore.succeeded': 'Your purchases have been restored',
+	'payment.restore.nothingFound': 'No previous purchases found',
+	'payment.error.cancelled': 'Purchase cancelled',
+	'payment.error.network': "Couldn't reach the store. Check your connection and try again.",
+	'payment.error.unavailable': "Purchases aren't available on this device",
+	'payment.error.disabled': 'Purchases are currently unavailable',
+	'payment.subscription.grace': "There's a problem with your payment method",
+	'payment.subscription.hold': 'Your subscription is paused until payment is updated',
+};
+
+export const DEFAULT_DEVELOPER_MESSAGES: PaymentDeveloperMessageMap = {
+	'payment.config.invalidCatalog': 'Payment catalog is invalid',
+	'payment.config.missingStoreId': 'Product is missing a store identifier for this platform',
+	'payment.config.productionInNonProductionBuild':
+		'Production payment configuration in a non-production build',
+	'payment.config.storageUnavailable':
+		'Local storage unavailable; entitlements will not survive restart',
+	'payment.config.environmentBlocked':
+		'Purchase blocked: this environment may not create a real transaction',
+};
+
+/**
+ * The catalog as an rn-core message set. Register `paymentMessages.user` with
+ * rn-i18n to translate it like app copy; the developer copy stays out of bundles.
+ */
+export const paymentMessages = defineMessages({
+	user: DEFAULT_USER_MESSAGES,
+	developer: DEFAULT_DEVELOPER_MESSAGES,
+});
+
+export const DEFAULT_MESSAGES: PaymentMessageMap = paymentMessages.defaults;
+
+/** Every user-actionable key, for an app building its translation resource. */
+export const USER_MESSAGE_KEYS = paymentMessages.userKeys as PaymentUserMessageKey[];
+
+/** Every developer-facing key, so an app can exclude them from user-visible bundles. */
+export const DEVELOPER_MESSAGE_KEYS = paymentMessages.developerKeys as PaymentDeveloperMessageKey[];
+
+/** True for keys safe to show an end user. Lets an app assert that at its boundary. */
+export function isUserMessageKey(key: PaymentMessageKey): key is PaymentUserMessageKey {
+	return paymentMessages.audienceOf(key) === 'user';
+}