diff --git a/packages/extension-sdk/README.md b/packages/extension-sdk/README.md index 09f64a614..17b6550d4 100644 --- a/packages/extension-sdk/README.md +++ b/packages/extension-sdk/README.md @@ -162,6 +162,15 @@ const myDataObj = JSON.parse(value) await extensionSDK.localStorageRemoveItem('data') ``` +### Clipboard + +** Looker >=21.8 **. Extensions may write to the system clipboard. For security reasons, the extension +is not given read access to the clipboard. + +```ts +extensionSDK.clipboardWrite('Hello Clipboard') +``` + ### User Attributes Extensions can read Looker provided user attributes, and can define, read and modify their own user attributes. For extension scoped user attributes the key should be namespaced as follows: diff --git a/packages/extension-sdk/src/connect/extension_host_api.spec.ts b/packages/extension-sdk/src/connect/extension_host_api.spec.ts index 56c0cca49..f61cda269 100644 --- a/packages/extension-sdk/src/connect/extension_host_api.spec.ts +++ b/packages/extension-sdk/src/connect/extension_host_api.spec.ts @@ -63,7 +63,7 @@ describe('extension_host_api tests', () => { console.error = originalConsoleError }) - const createHostApi = (initMessage = {}) => { + const createHostApi = (initMessage = {}, lookerVersion = '6.25.0') => { const initializedCallback = jest.fn() const hostApi = new ExtensionHostApiImpl({ chattyHost, @@ -73,7 +73,7 @@ describe('extension_host_api tests', () => { const resp = hostApi.handleNotification({ type: ExtensionNotificationType.INITIALIZE, payload: { - lookerVersion: '6.25.0', + lookerVersion, extensionId: 'ks::ks', route: '/sandbox', hostUrl: 'https://self-signed.looker.com:9999', @@ -354,6 +354,16 @@ describe('extension_host_api tests', () => { done() }) + it('writes to clipboard', async (done) => { + const hostApi = createHostApi({}, '21.7.0') + await hostApi.clipboardWrite('ABCD') + expect(sendAndReceiveSpy).toHaveBeenCalledWith('EXTENSION_API_REQUEST', { + payload: { type: 'write', value: 'ABCD' }, + type: 'CLIPBOARD', + }) + done() + }) + it('tracks an action', () => { const hostApi = createHostApi() hostApi.track('MY_TRACK_NAME', 'MY_TRACK_ACTION', { a: 'a', b: 'bb' }) diff --git a/packages/extension-sdk/src/connect/extension_host_api.ts b/packages/extension-sdk/src/connect/extension_host_api.ts index 43f129a12..99843953d 100644 --- a/packages/extension-sdk/src/connect/extension_host_api.ts +++ b/packages/extension-sdk/src/connect/extension_host_api.ts @@ -244,6 +244,17 @@ export class ExtensionHostApiImpl implements ExtensionHostApi { }) } + async clipboardWrite(value: string): Promise { + const errorMessage = this.verifyLookerVersion('>=21.7') + if (errorMessage) { + return Promise.reject(new Error(errorMessage)) + } + return this.sendAndReceive(ExtensionRequestType.CLIPBOARD, { + type: 'write', + value, + }) + } + async userAttributeSetItem(name: string, value = ''): Promise { // User attributes added in Looker version 7.13, updated in 7.15 const errorMessage = this.verifyLookerVersion('>=7.15') diff --git a/packages/extension-sdk/src/connect/types.ts b/packages/extension-sdk/src/connect/types.ts index 09a63c133..7999b8813 100644 --- a/packages/extension-sdk/src/connect/types.ts +++ b/packages/extension-sdk/src/connect/types.ts @@ -78,6 +78,10 @@ export enum ExtensionRequestType { * Close popovers in the looker host */ CLOSE_HOST_POPOVERS = 'CLOSE_HOST_POPOVERS', + /** + * Clipboard request + */ + CLIPBOARD = 'CLIPBOARD', /** * Local storage request */ @@ -185,6 +189,11 @@ export interface RouteChangeRequest { route: string } +export interface ClipboardRequest { + type: 'write' + value: string +} + export interface LocalStorageRequest { type: 'get' | 'set' | 'remove' name: string @@ -481,6 +490,12 @@ export interface ExtensionSDK { */ localStorageGetItem(name: string): Promise + /** + * Write string to clipboard. + * @param value to write to clipboard. + */ + clipboardWrite(value: string): Promise + /** * Set a user attribute value. * @param name of item