@parity/product-sdk-host 0.18.0 → 0.19.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { JsonRpcProvider, PolkadotSigner } from 'polkadot-api';
-import { Topic, RemoteStatementStoreSubscribeItem, Statement, StatementProof, SignedStatement, HexString, scale, TrUApiClient, AllocatableResource, AllocationOutcome, VersionedHostGetUserIdError, HostRequestLoginResponse, VersionedHostRequestLoginError, ProductAccountId, ProductAccount as ProductAccount$1, VersionedHostAccountGetError, RingLocation, VersionedHostAccountRegisterRingVrfKeyError, RingVrfKeyDisclosure, RegisteredRingVrfKey as RegisteredRingVrfKey$1, VersionedHostAccountListRingVrfKeysError, ProductProofContext, ContextualAlias as ContextualAlias$1, VersionedHostAccountGetAliasError, LegacyAccount, VersionedHostGetLegacyAccountsError, HostAccountCreateProofResponse, VersionedHostAccountCreateProofError, VersionedHostAccountRingVrfSignError, VrfTranscriptItem as VrfTranscriptItem$1, VrfSignature as VrfSignature$1, VersionedHostAccountSignVrfError, HostAccountConnectionStatusSubscribeItem, HostDevicePermissionRequest, RemotePermission, HostThemeSubscribeItem, ChatBotRegistrationStatus, HostChatCreateRoomRequest, ChatRoomRegistrationStatus, HostChatRegisterBotRequest, ChatMessageContent, ChatRoom, HostChatActionSubscribeItem, HostPaymentBalanceSubscribeItem, CoinPaymentPurseId, Balance, PaymentTopUpSource, HostPaymentStatusSubscribeItem, HostPushNotificationRequest, NotificationId } from '@parity/truapi';
+import { Topic, RemoteStatementStoreSubscribeItem, Statement, StatementProof, SignedStatement, HexString, scale, TrUApiClient, AllocatableResource, AllocationOutcome, VersionedHostGetUserIdError, HostRequestLoginResponse, VersionedHostRequestLoginError, ProductAccountId, ProductAccount as ProductAccount$1, VersionedHostAccountGetError, RingLocation, VersionedHostAccountRegisterRingVrfKeyError, RingVrfKeyDisclosure, RegisteredRingVrfKey as RegisteredRingVrfKey$1, VersionedHostAccountListRingVrfKeysError, ProductProofContext, ContextualAlias as ContextualAlias$1, VersionedHostAccountGetAliasError, LegacyAccount, VersionedHostGetLegacyAccountsError, HostAccountCreateProofResponse, VersionedHostAccountCreateProofError, VersionedHostAccountRingVrfSignError, VrfTranscriptItem as VrfTranscriptItem$1, VrfSignature as VrfSignature$1, VersionedHostAccountSignVrfError, HostAccountConnectionStatusSubscribeItem, HostDevicePermissionRequest, RemotePermission, HostThemeSubscribeItem, HostLocaleSubscribeItem, ChatBotRegistrationStatus, HostChatCreateRoomRequest, ChatRoomRegistrationStatus, HostChatRegisterBotRequest, ChatMessageContent, ChatRoom, HostChatActionSubscribeItem, HostPaymentBalanceSubscribeItem, CoinPaymentPurseId, Balance, PaymentTopUpSource, HostPaymentStatusSubscribeItem, HostPushNotificationRequest, NotificationId } from '@parity/truapi';
 export { AllocatableResource, AllocationOutcome, ChatMessageContent, ChatRoom, DerivationIndex, HexString, HostPaymentBalanceSubscribeItem, HostPaymentStatusSubscribeItem, NotificationId, PaymentTopUpSource, ProductAccountId, ProductProofContext, HostPushNotificationError as PushNotificationError, RemotePermission, RingLocation, RingVrfKeyDisclosure, SignedStatement, Statement, StatementProof, ThemeName, ThemeVariant, Topic } from '@parity/truapi';
 import { SdkError } from '@parity/product-sdk-errors';
 export { SdkError, isSdkError } from '@parity/product-sdk-errors';
@@ -729,6 +729,54 @@ interface ThemeProvider {
  */
 declare function getThemeProvider(): Promise<ThemeProvider | null>;
 
+/**
+ * Higher-level wrapper for the host's locale subscription, backed by
+ * `truApi.locale.subscribe`.
+ *
+ * `getLocaleProvider` returns a handle whose `subscribeLocale(cb)` delivers a
+ * typed {@link LocaleInfo} — a `{ languageTag }` struct carrying a BCP 47 tag
+ * such as `"en"`, `"pt-BR"` or `"zh-Hans"` — and yields a
+ * {@link HostSubscription} (`unsubscribe` + `onInterrupt`).
+ *
+ * @module
+ */
+
+/**
+ * Host locale value. A `{ languageTag }` struct re-exported from
+ * `@parity/truapi`.
+ */
+type LocaleInfo = HostLocaleSubscribeItem;
+/**
+ * Host locale provider handle. `subscribeLocale(callback)` receives a typed
+ * {@link LocaleInfo} on every change and returns a {@link HostSubscription}.
+ */
+interface LocaleProvider {
+    subscribeLocale(callback: (locale: LocaleInfo) => void): HostSubscription;
+}
+/**
+ * Get the host locale provider, backed by `truApi.locale.*`. Returns `null`
+ * when running outside a host container.
+ *
+ * The tag is whatever the host reports; a product that ships no catalog entry
+ * for it chooses its own fallback.
+ *
+ * @returns The locale provider, or `null` if unavailable.
+ *
+ * @example
+ * ```ts
+ * import { getLocaleProvider } from "@parity/product-sdk-host";
+ *
+ * const provider = await getLocaleProvider();
+ * if (provider) {
+ *   const sub = provider.subscribeLocale((locale) => {
+ *     i18n.activate(SUPPORTED.has(locale.languageTag) ? locale.languageTag : "en");
+ *   });
+ *   // sub.unsubscribe() to stop listening
+ * }
+ * ```
+ */
+declare function getLocaleProvider(): Promise<LocaleProvider | null>;
+
 /**
  * Higher-level wrapper for the host's entropy derivation (RFC-0007).
  *
@@ -1143,4 +1191,4 @@ declare function broadcastTransaction(genesisHash: HexString, transaction: HexSt
  */
 declare function stopTransaction(genesisHash: HexString, operationId: string): Promise<Result<void, HostError>>;
 
-export { type AccountsProvider, BULLETIN_RPCS, ChainNotSupportedError, type ChainProperties, type ChainSpec, type ChatBotRegistrationResult, type ChatManager, type ChatReceivedAction, type ChatRoomRegistrationResult, type ContextualAlias, DEFAULT_BULLETIN_ENDPOINT, type DevicePermissionKind, type Feature, type HostAccount, HostCallFailedError, HostError, type HostErrorPayload, type HostLocalStorage, HostResponseDecodeError, type HostStatementStore, type HostSubscription, HostUnavailableError, type NotificationManager, type PaymentManager, type PreimageManager, type ProductAccount, type ProductAccountLookup, type PushNotificationInput, type RegisteredRingVrfKey, type RemotePermissionItem, type ResultAsync, type RingVRFProof, type RingVrfKeyHandle, type RingVrfPublicKey, type StatementTopicFilter, type StatementsPage, type ThemeMode, type ThemeProvider, type TruApi, type VrfSignature, type VrfTranscriptItem, type WithDecodeError, broadcastTransaction, createHostLocalStorage, createHostPreimageManager, createProofAuthorized, deriveEntropy, featureSupported, findRingVrfKeyHandle, formatHostError, fromHex, getAccountsProvider, getChainSpec, getChatManager, getHostLocalStorage, getHostProvider, getNotificationManager, getPaymentManager, getPreimageManager, getStatementStore, getThemeProvider, getTruApi, isChainSupported, isHostError, isInsideContainer, navigateTo, requestDevicePermission, requestPermission, requestResourceAllocation, stopTransaction, toHex };
+export { type AccountsProvider, BULLETIN_RPCS, ChainNotSupportedError, type ChainProperties, type ChainSpec, type ChatBotRegistrationResult, type ChatManager, type ChatReceivedAction, type ChatRoomRegistrationResult, type ContextualAlias, DEFAULT_BULLETIN_ENDPOINT, type DevicePermissionKind, type Feature, type HostAccount, HostCallFailedError, HostError, type HostErrorPayload, type HostLocalStorage, HostResponseDecodeError, type HostStatementStore, type HostSubscription, HostUnavailableError, type LocaleInfo, type LocaleProvider, type NotificationManager, type PaymentManager, type PreimageManager, type ProductAccount, type ProductAccountLookup, type PushNotificationInput, type RegisteredRingVrfKey, type RemotePermissionItem, type ResultAsync, type RingVRFProof, type RingVrfKeyHandle, type RingVrfPublicKey, type StatementTopicFilter, type StatementsPage, type ThemeMode, type ThemeProvider, type TruApi, type VrfSignature, type VrfTranscriptItem, type WithDecodeError, broadcastTransaction, createHostLocalStorage, createHostPreimageManager, createProofAuthorized, deriveEntropy, featureSupported, findRingVrfKeyHandle, formatHostError, fromHex, getAccountsProvider, getChainSpec, getChatManager, getHostLocalStorage, getHostProvider, getLocaleProvider, getNotificationManager, getPaymentManager, getPreimageManager, getStatementStore, getThemeProvider, getTruApi, isChainSupported, isHostError, isInsideContainer, navigateTo, requestDevicePermission, requestPermission, requestResourceAllocation, stopTransaction, toHex };

package/dist/index.js

@@ -803,25 +803,23 @@ function sameRingLocation(a, b) {
 function findRingVrfKeyHandle(keys, ring) {
   return keys.find((key) => key.rings.some((candidate) => sameRingLocation(candidate, ring)))?.handle;
 }
-var GENERAL_TX_EXT_VERSION = 5;
-function selectHostTxExtVersion(formatVersions, txExtVersions) {
+var V5_FORMAT_SELECTOR = 5;
+function selectHostTxExtVersion(formatVersions) {
   if (formatVersions.length === 0) {
     throw new Error("No extrinsic version found in metadata");
   }
   if (formatVersions.includes(4)) {
     return 0;
   }
-  if (txExtVersions.includes(GENERAL_TX_EXT_VERSION)) {
-    return GENERAL_TX_EXT_VERSION;
+  if (formatVersions.includes(5)) {
+    return V5_FORMAT_SELECTOR;
   }
   throw new Error(
-    `Runtime offers no V4 extrinsic and no transaction-extension version ${GENERAL_TX_EXT_VERSION} (supported: ${txExtVersions.join(", ") || "none"}); cannot select a txExtVersion the host can assemble.`
+    `Runtime offers no extrinsic format 4 or 5 (offers: ${formatVersions.join(", ")}); the host protocol has no txExtVersion for it.`
   );
 }
 function deriveTxExtVersion(metadata) {
-  const extrinsic = unifyMetadata(decAnyMetadata(metadata)).extrinsic;
-  const txExtVersions = Object.keys(extrinsic.signedExtensions).map(Number);
-  return selectHostTxExtVersion(extrinsic.version, txExtVersions);
+  return selectHostTxExtVersion(unifyMetadata(decAnyMetadata(metadata)).extrinsic.version);
 }
 var deps = { deriveTxExtVersion };
 function toHostExtensions(signedExtensions) {
@@ -1073,6 +1071,19 @@ async function getThemeProvider() {
   const client = await getClient();
   return client ? adaptThemeProvider(client) : null;
 }
+
+// src/locale.ts
+function adaptLocaleProvider(client) {
+  return {
+    subscribeLocale(callback) {
+      return subscribeWithInterrupt(client.locale.subscribe(), callback);
+    }
+  };
+}
+async function getLocaleProvider() {
+  const client = await getClient();
+  return client ? adaptLocaleProvider(client) : null;
+}
 var log5 = createLogger("host:entropy");
 async function deriveEntropy(key) {
   const truApi = await getTruApi();
@@ -1286,6 +1297,6 @@ async function stopTransaction(genesisHash, operationId) {
   );
 }
 
-export { BULLETIN_RPCS, ChainNotSupportedError, DEFAULT_BULLETIN_ENDPOINT, HostCallFailedError, HostError, HostResponseDecodeError, HostUnavailableError, broadcastTransaction, createHostLocalStorage, createHostPreimageManager, createProofAuthorized, deriveEntropy, featureSupported, findRingVrfKeyHandle, formatHostError, fromHex, getAccountsProvider, getChainSpec, getChatManager, getHostChainInfo, getHostLocalStorage, getHostProvider, getNotificationManager, getPaymentManager, getPreimageManager, getStatementStore, getThemeProvider, getTruApi, isChainSupported, isHostError, isInsideContainer, navigateTo, requestDevicePermission, requestPermission, requestResourceAllocation, stopTransaction, toHex };
+export { BULLETIN_RPCS, ChainNotSupportedError, DEFAULT_BULLETIN_ENDPOINT, HostCallFailedError, HostError, HostResponseDecodeError, HostUnavailableError, broadcastTransaction, createHostLocalStorage, createHostPreimageManager, createProofAuthorized, deriveEntropy, featureSupported, findRingVrfKeyHandle, formatHostError, fromHex, getAccountsProvider, getChainSpec, getChatManager, getHostChainInfo, getHostLocalStorage, getHostProvider, getLocaleProvider, getNotificationManager, getPaymentManager, getPreimageManager, getStatementStore, getThemeProvider, getTruApi, isChainSupported, isHostError, isInsideContainer, navigateTo, requestDevicePermission, requestPermission, requestResourceAllocation, stopTransaction, toHex };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map