@novasamatech/host-api 0.5.4 → 0.6.0

package/README.md

@@ -90,7 +90,7 @@ const hostApi = createHostApi(transport);
 
 // requesting data
 
-const storageValue = hostApi.storage_read(payload);
+const storageValue = hostApi.localStorageRead(payload);
 
 storageValue.match(
   (data) => console.log('success:', data),
@@ -99,7 +99,7 @@ storageValue.match(
 
 // subscribing to events
 
-const subscription = hostApi.chat_action_subscribe(params, (action) => {
+const subscription = hostApi.chatActionSubscribe(params, (action) => {
   console.log('action received:', action);
 });
 
@@ -109,3 +109,28 @@ subscription.onInterrupt(() => {
 
 subscription.unsubscribe();
 ```
+
+### Custom Renderer
+
+The protocol includes a custom renderer system for building UI component trees that can be serialized and sent across the transport. This is used for rendering custom chat messages.
+
+Available components: `Box`, `Column`, `Row`, `Spacer`, `Text`, `Button`, `TextField`. Each component supports optional `Modifiers` (margin, padding, background, border, dimensions) and can contain children.
+
+```typescript
+import { CustomRendererNode } from '@novasamatech/host-api';
+```
+
+### Account Connection Status
+
+Products can subscribe to account connection status changes:
+
+```typescript
+const subscription = hostApi.accountConnectionStatusSubscribe(undefined, (status) => {
+  // status: 'connected' | 'disconnected'
+  console.log('connection status:', status);
+});
+```
+
+### Custom Chat Messages
+
+Chat messages now support a `Custom` content type that carries an arbitrary payload identified by `messageType`. Products can handle rendering of custom messages via the `productChatCustomMessageRenderSubscribe` subscription, which receives the message type and payload and expects a `CustomRendererNode` tree in response.

package/dist/hostApi.d.ts

@@ -3,6 +3,7 @@ import type { Codec, CodecType } from 'scale-ts';
 import type { HostApiProtocol, VersionedProtocolRequest, VersionedProtocolSubscription } from './protocol/impl.js';
 import type { Subscription, Transport } from './types.js';
 type SnakeToCamelCase<S extends string> = S extends `${infer T}_${infer U}` ? `${T}${Capitalize<SnakeToCamelCase<U>>}` : S;
+type StripNamespace<S extends string> = S extends `host_${infer Rest}` ? Rest : S extends `remote_${infer Rest}` ? Rest : S;
 type Value<T extends Codec<any> | Codec<never>> = T extends Codec<any> ? CodecType<T> : unknown;
 type UnwrapVersionedResult<T> = T extends {
     tag: infer Tag;
@@ -26,7 +27,7 @@ type InferRequestMethod<Method extends VersionedProtocolRequest> = (args: Value<
 type InferSubscribeMethod<Method extends VersionedProtocolSubscription> = (args: Value<Method['start']>, callback: (payload: Value<Method['receive']>) => void) => Subscription;
 type InferMethod<Method extends VersionedProtocolRequest | VersionedProtocolSubscription> = Method extends VersionedProtocolRequest ? InferRequestMethod<Method> : Method extends VersionedProtocolSubscription ? InferSubscribeMethod<Method> : never;
 export type HostApi = {
-    [K in keyof HostApiProtocol as SnakeToCamelCase<K>]: InferMethod<HostApiProtocol[K]>;
+    [K in keyof HostApiProtocol as SnakeToCamelCase<StripNamespace<K>>]: InferMethod<HostApiProtocol[K]>;
 };
 export declare function createHostApi(transport: Transport): HostApi;
 export {};

package/dist/hostApi.js

@@ -5,13 +5,15 @@ import { CreateProofErr, RequestCredentialsErr } from './protocol/v1/accounts.js
 import { ChatBotRegistrationErr, ChatMessagePostingErr, ChatRoomRegistrationErr } from './protocol/v1/chat.js';
 import { CreateTransactionErr } from './protocol/v1/createTransaction.js';
 import { HandshakeErr } from './protocol/v1/handshake.js';
+import { StorageErr } from './protocol/v1/localStorage.js';
+import { NavigateToErr } from './protocol/v1/navigation.js';
+import { PreimageSubmitErr } from './protocol/v1/preimage.js';
 import { SigningErr } from './protocol/v1/sign.js';
 import { StatementProofErr } from './protocol/v1/statementStore.js';
-import { StorageErr } from './protocol/v1/storage.js';
 export function createHostApi(transport) {
     return {
         handshake(payload) {
-            const response = fromPromise(transport.request('handshake', payload), e => ({
+            const response = fromPromise(transport.request('host_handshake', payload), e => ({
                 tag: payload.tag,
                 value: new HandshakeErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -28,8 +30,8 @@ export function createHostApi(transport) {
                 });
             });
         },
-        feature(payload) {
-            const response = fromPromise(transport.request('feature', payload), e => ({
+        featureSupported(payload) {
+            const response = fromPromise(transport.request('host_feature_supported', payload), e => ({
                 tag: payload.tag,
                 value: new GenericError({ reason: extractErrorMessage(e) }),
             }));
@@ -46,8 +48,80 @@ export function createHostApi(transport) {
                 });
             });
         },
+        devicePermission(payload) {
+            const response = fromPromise(transport.request('host_device_permission', payload), e => ({
+                tag: payload.tag,
+                value: new GenericError({ reason: extractErrorMessage(e) }),
+            }));
+            return response.andThen(response => {
+                if (response.value.success) {
+                    return okAsync({
+                        tag: response.tag,
+                        value: response.value.value,
+                    });
+                }
+                return errAsync({
+                    tag: response.tag,
+                    value: response.value.value,
+                });
+            });
+        },
+        permission(payload) {
+            const response = fromPromise(transport.request('remote_permission', payload), e => ({
+                tag: payload.tag,
+                value: new GenericError({ reason: extractErrorMessage(e) }),
+            }));
+            return response.andThen(response => {
+                if (response.value.success) {
+                    return okAsync({
+                        tag: response.tag,
+                        value: response.value.value,
+                    });
+                }
+                return errAsync({
+                    tag: response.tag,
+                    value: response.value.value,
+                });
+            });
+        },
+        pushNotification(payload) {
+            const response = fromPromise(transport.request('host_push_notification', payload), e => ({
+                tag: payload.tag,
+                value: new GenericError({ reason: extractErrorMessage(e) }),
+            }));
+            return response.andThen(response => {
+                if (response.value.success) {
+                    return okAsync({
+                        tag: response.tag,
+                        value: response.value.value,
+                    });
+                }
+                return errAsync({
+                    tag: response.tag,
+                    value: response.value.value,
+                });
+            });
+        },
+        navigateTo(payload) {
+            const response = fromPromise(transport.request('host_navigate_to', payload), e => ({
+                tag: payload.tag,
+                value: new NavigateToErr.Unknown({ reason: extractErrorMessage(e) }),
+            }));
+            return response.andThen(response => {
+                if (response.value.success) {
+                    return okAsync({
+                        tag: response.tag,
+                        value: response.value.value,
+                    });
+                }
+                return errAsync({
+                    tag: response.tag,
+                    value: response.value.value,
+                });
+            });
+        },
         localStorageRead(payload) {
-            const response = fromPromise(transport.request('local_storage_read', payload), e => ({
+            const response = fromPromise(transport.request('host_local_storage_read', payload), e => ({
                 tag: payload.tag,
                 value: new StorageErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -65,7 +139,7 @@ export function createHostApi(transport) {
             });
         },
         localStorageWrite(payload) {
-            const response = fromPromise(transport.request('local_storage_write', payload), e => ({
+            const response = fromPromise(transport.request('host_local_storage_write', payload), e => ({
                 tag: payload.tag,
                 value: new StorageErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -83,7 +157,7 @@ export function createHostApi(transport) {
             });
         },
         localStorageClear(payload) {
-            const response = fromPromise(transport.request('local_storage_clear', payload), e => ({
+            const response = fromPromise(transport.request('host_local_storage_clear', payload), e => ({
                 tag: payload.tag,
                 value: new StorageErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -100,8 +174,11 @@ export function createHostApi(transport) {
                 });
             });
         },
+        accountConnectionStatusSubscribe(args, callback) {
+            return transport.subscribe('host_account_connection_status_subscribe', args, callback);
+        },
         accountGet(payload) {
-            const response = fromPromise(transport.request('account_get', payload), e => ({
+            const response = fromPromise(transport.request('host_account_get', payload), e => ({
                 tag: payload.tag,
                 value: new RequestCredentialsErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -119,7 +196,7 @@ export function createHostApi(transport) {
             });
         },
         accountGetAlias(payload) {
-            const response = fromPromise(transport.request('account_get_alias', payload), e => ({
+            const response = fromPromise(transport.request('host_account_get_alias', payload), e => ({
                 tag: payload.tag,
                 value: new RequestCredentialsErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -137,7 +214,7 @@ export function createHostApi(transport) {
             });
         },
         accountCreateProof(payload) {
-            const response = fromPromise(transport.request('account_create_proof', payload), e => ({
+            const response = fromPromise(transport.request('host_account_create_proof', payload), e => ({
                 tag: payload.tag,
                 value: new CreateProofErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -155,7 +232,7 @@ export function createHostApi(transport) {
             });
         },
         getNonProductAccounts(payload) {
-            const response = fromPromise(transport.request('get_non_product_accounts', payload), e => ({
+            const response = fromPromise(transport.request('host_get_non_product_accounts', payload), e => ({
                 tag: payload.tag,
                 value: new RequestCredentialsErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -173,7 +250,7 @@ export function createHostApi(transport) {
             });
         },
         createTransaction(payload) {
-            const response = fromPromise(transport.request('create_transaction', payload), e => ({
+            const response = fromPromise(transport.request('host_create_transaction', payload), e => ({
                 tag: payload.tag,
                 value: new CreateTransactionErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -191,7 +268,7 @@ export function createHostApi(transport) {
             });
         },
         createTransactionWithNonProductAccount(payload) {
-            const response = fromPromise(transport.request('create_transaction_with_non_product_account', payload), e => ({
+            const response = fromPromise(transport.request('host_create_transaction_with_non_product_account', payload), e => ({
                 tag: payload.tag,
                 value: new CreateTransactionErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -209,7 +286,7 @@ export function createHostApi(transport) {
             });
         },
         signRaw(payload) {
-            const response = fromPromise(transport.request('sign_raw', payload), e => ({
+            const response = fromPromise(transport.request('host_sign_raw', payload), e => ({
                 tag: payload.tag,
                 value: new SigningErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -227,7 +304,7 @@ export function createHostApi(transport) {
             });
         },
         signPayload(payload) {
-            const response = fromPromise(transport.request('sign_payload', payload), e => ({
+            const response = fromPromise(transport.request('host_sign_payload', payload), e => ({
                 tag: payload.tag,
                 value: new SigningErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -245,10 +322,10 @@ export function createHostApi(transport) {
             });
         },
         chatListSubscribe(args, callback) {
-            return transport.subscribe('chat_list_subscribe', args, callback);
+            return transport.subscribe('host_chat_list_subscribe', args, callback);
         },
         chatCreateRoom(payload) {
-            const response = fromPromise(transport.request('chat_create_room', payload), e => ({
+            const response = fromPromise(transport.request('host_chat_create_room', payload), e => ({
                 tag: payload.tag,
                 value: new ChatRoomRegistrationErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -266,7 +343,7 @@ export function createHostApi(transport) {
             });
         },
         chatRegisterBot(payload) {
-            const response = fromPromise(transport.request('chat_register_bot', payload), e => ({
+            const response = fromPromise(transport.request('host_chat_register_bot', payload), e => ({
                 tag: payload.tag,
                 value: new ChatBotRegistrationErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -284,7 +361,7 @@ export function createHostApi(transport) {
             });
         },
         chatPostMessage(payload) {
-            const response = fromPromise(transport.request('chat_post_message', payload), e => ({
+            const response = fromPromise(transport.request('host_chat_post_message', payload), e => ({
                 tag: payload.tag,
                 value: new ChatMessagePostingErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
@@ -302,12 +379,18 @@ export function createHostApi(transport) {
             });
         },
         chatActionSubscribe(args, callback) {
-            return transport.subscribe('chat_action_subscribe', args, callback);
+            return transport.subscribe('host_chat_action_subscribe', args, callback);
+        },
+        productChatCustomMessageRenderSubscribe(args, callback) {
+            return transport.subscribe('product_chat_custom_message_render_subscribe', args, callback);
         },
-        statementStoreQuery(payload) {
-            const response = fromPromise(transport.request('statement_store_query', payload), e => ({
+        statementStoreSubscribe(args, callback) {
+            return transport.subscribe('remote_statement_store_subscribe', args, callback);
+        },
+        statementStoreCreateProof(payload) {
+            const response = fromPromise(transport.request('remote_statement_store_create_proof', payload), e => ({
                 tag: payload.tag,
-                value: new GenericError({ reason: extractErrorMessage(e) }),
+                value: new StatementProofErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
             return response.andThen(response => {
                 if (response.value.success) {
@@ -322,13 +405,10 @@ export function createHostApi(transport) {
                 });
             });
         },
-        statementStoreSubscribe(args, callback) {
-            return transport.subscribe('statement_store_subscribe', args, callback);
-        },
-        statementStoreCreateProof(payload) {
-            const response = fromPromise(transport.request('statement_store_create_proof', payload), e => ({
+        statementStoreSubmit(payload) {
+            const response = fromPromise(transport.request('remote_statement_store_submit', payload), e => ({
                 tag: payload.tag,
-                value: new StatementProofErr.Unknown({ reason: extractErrorMessage(e) }),
+                value: new GenericError({ reason: extractErrorMessage(e) }),
             }));
             return response.andThen(response => {
                 if (response.value.success) {
@@ -343,10 +423,13 @@ export function createHostApi(transport) {
                 });
             });
         },
-        statementStoreSubmit(payload) {
-            const response = fromPromise(transport.request('statement_store_submit', payload), e => ({
+        preimageLookupSubscribe(args, callback) {
+            return transport.subscribe('remote_preimage_lookup_subscribe', args, callback);
+        },
+        preimageSubmit(payload) {
+            const response = fromPromise(transport.request('remote_preimage_submit', payload), e => ({
                 tag: payload.tag,
-                value: new GenericError({ reason: extractErrorMessage(e) }),
+                value: new PreimageSubmitErr.Unknown({ reason: extractErrorMessage(e) }),
             }));
             return response.andThen(response => {
                 if (response.value.success) {
@@ -362,7 +445,7 @@ export function createHostApi(transport) {
             });
         },
         jsonrpcMessageSend(payload) {
-            const response = fromPromise(transport.request('jsonrpc_message_send', payload), e => ({
+            const response = fromPromise(transport.request('host_jsonrpc_message_send', payload), e => ({
                 tag: payload.tag,
                 value: new GenericError({ reason: extractErrorMessage(e) }),
             }));
@@ -380,7 +463,7 @@ export function createHostApi(transport) {
             });
         },
         jsonrpcMessageSubscribe(args, callback) {
-            return transport.subscribe('jsonrpc_message_subscribe', args, callback);
+            return transport.subscribe('host_jsonrpc_message_subscribe', args, callback);
         },
     };
 }

package/dist/index.d.ts

@@ -12,9 +12,15 @@ export type { HexString } from '@novasamatech/scale';
 export { assertEnumVariant, enumValue, fromHex, isEnumVariant, resultErr, resultOk, toHex, unwrapResultOrThrow, } from '@novasamatech/scale';
 export { GenericError } from './protocol/commonCodecs.js';
 export { CreateTransactionErr, VersionedPublicTxPayload } from './protocol/v1/createTransaction.js';
-export { Account, AccountId, CreateProofErr, ProductAccountId, RequestCredentialsErr, RingLocation, } from './protocol/v1/accounts.js';
+export { Account, AccountConnectionStatus, AccountId, CreateProofErr, ProductAccountId, RequestCredentialsErr, RingLocation, } from './protocol/v1/accounts.js';
 export { ChatActionPayload, ChatBotRegistrationErr, ChatBotRegistrationStatus, ChatMessageContent, ChatMessagePostingErr, ChatRoom, ChatRoomRegistrationErr, ChatRoomRegistrationResult, ChatRoomRegistrationStatus, ReceivedChatAction, } from './protocol/v1/chat.js';
 export { HandshakeErr } from './protocol/v1/handshake.js';
 export { SigningErr } from './protocol/v1/sign.js';
 export { SignedStatement, Statement, StatementProofErr, Topic } from './protocol/v1/statementStore.js';
-export { StorageErr } from './protocol/v1/storage.js';
+export { StorageErr } from './protocol/v1/localStorage.js';
+export { DevicePermissionRequest } from './protocol/v1/devicePermission.js';
+export { RemotePermissionRequest } from './protocol/v1/remotePermission.js';
+export { PushNotification } from './protocol/v1/notification.js';
+export { NavigateToErr } from './protocol/v1/navigation.js';
+export { PreimageKey, PreimageSubmitErr, PreimageValue } from './protocol/v1/preimage.js';
+export { CustomRendererNode } from './protocol/v1/customRenderer.js';

package/dist/index.js

@@ -7,9 +7,15 @@ export { assertEnumVariant, enumValue, fromHex, isEnumVariant, resultErr, result
 // Codecs
 export { GenericError } from './protocol/commonCodecs.js';
 export { CreateTransactionErr, VersionedPublicTxPayload } from './protocol/v1/createTransaction.js';
-export { Account, AccountId, CreateProofErr, ProductAccountId, RequestCredentialsErr, RingLocation, } from './protocol/v1/accounts.js';
+export { Account, AccountConnectionStatus, AccountId, CreateProofErr, ProductAccountId, RequestCredentialsErr, RingLocation, } from './protocol/v1/accounts.js';
 export { ChatActionPayload, ChatBotRegistrationErr, ChatBotRegistrationStatus, ChatMessageContent, ChatMessagePostingErr, ChatRoom, ChatRoomRegistrationErr, ChatRoomRegistrationResult, ChatRoomRegistrationStatus, ReceivedChatAction, } from './protocol/v1/chat.js';
 export { HandshakeErr } from './protocol/v1/handshake.js';
 export { SigningErr } from './protocol/v1/sign.js';
 export { SignedStatement, Statement, StatementProofErr, Topic } from './protocol/v1/statementStore.js';
-export { StorageErr } from './protocol/v1/storage.js';
+export { StorageErr } from './protocol/v1/localStorage.js';
+export { DevicePermissionRequest } from './protocol/v1/devicePermission.js';
+export { RemotePermissionRequest } from './protocol/v1/remotePermission.js';
+export { PushNotification } from './protocol/v1/notification.js';
+export { NavigateToErr } from './protocol/v1/navigation.js';
+export { PreimageKey, PreimageSubmitErr, PreimageValue } from './protocol/v1/preimage.js';
+export { CustomRendererNode } from './protocol/v1/customRenderer.js';