WEB-2063 readTextFromClipboard/writeTextToClipboard (#151)

README.md

@@ -1237,6 +1237,26 @@ getBatteryInfo: () => Promise<{
     information is unavailable.
 -   `isPowerSafeMode`: true if the device is in power saving mode.
 
+### readTextFromClipboard
+
+<kbd>App version >=24.10</kbd>
+
+Reads the current text in the clipboard
+
+```ts
+readTextFromClipboard: () => Promise<string>;
+```
+
+### writeTextToClipboard
+
+<kbd>App version >=24.10</kbd>
+
+Writes the given text to the clipboard
+
+```ts
+writeTextToClipboard: (text: string) => Promise<void>;
+```
+
 ## Error handling
 
 If an uncontrolled error occurs, promise will be rejected with an error object:

index.ts

@@ -95,3 +95,4 @@ export type {
 export {openOnboarding} from './src/open-onboarding';
 
 export {getProfileImage, startProfileImageFlow} from './src/profile';
+export {readTextFromClipboard, writeTextToClipboard} from './src/clipboard';

src/__tests__/clipboard-test.ts

@@ -0,0 +1,34 @@
+import {readTextFromClipboard, writeTextToClipboard} from '../../index';
+import {createFakeWebKitPostMessage} from './fake-post-message';
+
+test('read from clipboard', async () => {
+    createFakeWebKitPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('CLIPBOARD_READ_TEXT');
+        },
+        getResponse: (msg) => ({
+            type: 'CLIPBOARD_READ_TEXT',
+            payload: 'some text',
+            id: msg.id,
+        }),
+    });
+
+    const res = await readTextFromClipboard();
+
+    expect(res).toEqual('some text');
+});
+
+test('write to clipboard', async () => {
+    createFakeWebKitPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('CLIPBOARD_WRITE_TEXT');
+            expect(msg.payload).toBe('some text');
+        },
+        getResponse: (msg) => ({
+            type: 'CLIPBOARD_WRITE_TEXT',
+            id: msg.id,
+        }),
+    });
+
+    await writeTextToClipboard('some text');
+});

src/clipboard.ts

@@ -0,0 +1,7 @@
+import {postMessageToNativeApp} from './post-message';
+
+export const readTextFromClipboard = (): Promise<string> =>
+    postMessageToNativeApp({type: 'CLIPBOARD_READ_TEXT'});
+
+export const writeTextToClipboard = (text: string): Promise<void> =>
+    postMessageToNativeApp({type: 'CLIPBOARD_WRITE_TEXT', payload: text});

src/post-message.ts

@@ -351,6 +351,16 @@ export type ResponsesFromNativeApp = {
             isPowerSafeMode: boolean;
         };
     };
+    CLIPBOARD_READ_TEXT: {
+        type: 'CLIPBOARD_READ_TEXT';
+        id: string;
+        payload: string;
+    };
+    CLIPBOARD_WRITE_TEXT: {
+        type: 'CLIPBOARD_WRITE_TEXT';
+        id: string;
+        payload: void;
+    };
 };
 
 export type NativeAppResponsePayload<