{"id":19972600,"url":"https://github.com/jpb06/sdk-test-java-app","last_synced_at":"2026-06-09T11:31:39.278Z","repository":{"id":249140080,"uuid":"830592716","full_name":"jpb06/sdk-test-java-app","owner":"jpb06","description":null,"archived":false,"fork":false,"pushed_at":"2024-07-19T14:13:38.000Z","size":291,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-01T18:25:51.331Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jpb06.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-18T15:08:58.000Z","updated_at":"2024-07-19T14:13:41.000Z","dependencies_parsed_at":"2025-01-12T09:28:00.220Z","dependency_job_id":"12cfaaa4-9d13-468a-941b-a90d2fd94c91","html_url":"https://github.com/jpb06/sdk-test-java-app","commit_stats":null,"previous_names":["jpb06/sdk-test-java-app"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jpb06/sdk-test-java-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpb06%2Fsdk-test-java-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpb06%2Fsdk-test-java-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpb06%2Fsdk-test-java-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpb06%2Fsdk-test-java-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jpb06","download_url":"https://codeload.github.com/jpb06/sdk-test-java-app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpb06%2Fsdk-test-java-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34105565,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T03:08:39.210Z","updated_at":"2026-06-09T11:31:39.264Z","avatar_url":"https://github.com/jpb06.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sdk-test-java-app\n\nThis is a POC showcasing communication between a Java heavy client and a next web app. The web app can be found [Here](https://github.com/jpb06/sdk-test).\n\n## Next app \u003c-\u003e Heavy client Communication\n\n![Worfklow](./assets/framebus.png).\n\nWe need two way communication:\n- Java heavy client -\u003e Next app.\n- Next app -\u003e Java heavy client.\n\nTo do so, [fseglard](https://github.com/fseglard) has written a sdk based on [post message api](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage).\n\n## Sdk API\n\n### `init`\n\n```tsx\nWidgetSdk.init(elementId: string): void\n```\n\nThe `init` function replaces an element in the DOM with an iframe that will target one of our next app widget pages.\nTypical usage looks like this:\n\n```tsx\n\u003cdiv id=\"my-widget\" /\u003e\n\u003cscript src=\"/libs/sdk.min.js\" /\u003e\n\u003cscript\u003e\n  const widget = new window.WidgetSdk({\n    baseUrl: 'http://localhost:3000',\n    frameHeight: 600,\n    frameWidth: 900,\n    theme: 'neutral',\n    token: 'my-token',\n    type: 'user',\n  });\n\n  widget.init('my-widget');\n\u003c/script\u003e\n```\n\n### `emit`\n\n```typescript\nWidgetSdk.emit\u003cTEventName extends FramebusEventName\u003e(\n    eventName: TEventName, \n    payload: FramebusEventPayload\u003cTEventName\u003e\n): void\n```\n\nThe `emit` function sends an event.\nTypical usage looks like this:\n\n```typescript\nwidget.emit('user.actions.doStuff', {\n  bro: 'cool', \n  struff: 25,\n});\n```\n\n### `on`\n\n```typescript\nWidgetSdk.on\u003cTEventName extends FramebusEventName\u003e(\n    eventName: TEventName, \n    listener: FramebusEventListener\u003cTEventName\u003e\n): void\n```\n\nThe `on` function creates a listener for an event type.\nTypical usage looks like this:\n\n```typescript\nwidget.on('user.get', ({ id }) =\u003e {\n  console.info(`user.get event fired with id ${id}`);\n  // Do something cool\n});\n```\n\n\n## Java app\n\n![Worfklow](./assets/java-app-workflow.png).\n\nIn order to do so, the strategy is to create a javascript sdk that will generate an iframe, and to rely on [post messages](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) to communicate between the java webview and our web app.\n\n## Key code snippets\n\n### Java -\u003e Javascript communication\n\nThis part is easy enough. All we need to do is have a js script defined and execute a script via the `webEngine`:\n\n```javascript\nfunction getUser (id) {\n    console.log(`trigger getUser ${id}`);\n    window.sdk.emit('user.get', { id });\n}\n```\n\n```java\nwebEngine.executeScript(\"getUser('128')\");\n```\n\n### Javascript -\u003e Java communication\n\nWe first need to create a bridge between our js and java. To do so, we will inject a class on `global.window`:\n\n```java\npublic class JavascriptBridge {\n    public void userAction(Object data) {\n        System.out.println(\"Javascript -\u003e Java - userAction(data) invoked\");\n        Gson gson = new GsonBuilder().serializeSpecialFloatingPointValues().serializeNulls().create();\n        System.out.println(\"Java - userAction event payload: \" + gson.toJson(data));\n    }\n}\n\nwebEngine.getLoadWorker().stateProperty().addListener(new ChangeListener\u003cWorker.State\u003e()\n{ \n  @Override\n  public void changed(ObservableValue ov, Worker.State oldState, Worker.State newState)\n  {\n    if (newState == Worker.State.SUCCEEDED)\n    {\n      JSObject jsGlobalWindow = (JSObject) webEngine.executeScript(\"window\");\n      jsGlobalWindow.setMember(\"javaApp\", new JavascriptBridge());\n    }\n  }\n});\n```\n\nIn our js, we will setup a listener that will call `javaApp.userAction`:\n\n```javascript\nwindow.sdk.on(\"user.action\", (data) =\u003e {\n  console.info(\"Javascript - User.action listener\");\n  \n  if(data.payload) {\n    window.javaApp.userAction(data.payload);\n  }\n})\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpb06%2Fsdk-test-java-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjpb06%2Fsdk-test-java-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpb06%2Fsdk-test-java-app/lists"}