@dotbase/safe-frame-sync 1.0.0

package/README.md

@@ -0,0 +1,79 @@
+# safe-frame-sync
+
+Typesafe iframe and parent communication between Dotstudio and Dotclinic.
+
+This library provides a **Pub/Sub** system for secure, typesafe communication between a parent host and an iframe, abstracting `window.top.postMessage` and `window.onmessage`. Events and corresponding payloads are typed to ensure error-free communication and improve developer experience.
+
+## Collaboration
+
+### Setup
+
+Install dependencies with:
+
+```bash
+npm install
+```
+
+### Build
+
+To build the package, run:
+
+```bash
+npm run build
+```
+
+### Publish
+
+The package is published on npmjs.
+
+```bash
+npm publish
+```
+
+## Usage
+
+First, add the dependency to the project:
+
+```bash
+npm add @dotbase/safe-frame-sync
+```
+
+The package provides two essential functions:
+
+* `publishMessage` for sending typed messages
+* `subscribeMessage` for listening to specific typed messages
+
+Currently there are three message types and each of them specifies a data interface:
+
+* `editResource`
+* `createResource`
+* `closeBuilder`
+
+### Message Types
+
+### In Parent
+
+```ts
+import { subscribeMessage } from "@dotbase/safe-frame-sync"
+
+// Somewhere in your code
+subscribeMessage("createResource", (data) => {
+    // Your callback implementation with type-safe data
+    console.log(data)
+})
+
+```
+
+### In Iframe
+
+```ts
+import { publishMessage } from "@dotbase/safe-frame-sync"
+
+// Somewhere in your code
+publishMessage({
+    type: "createResource";
+    resourceId: "some-uuid";
+    resourceName: "Some Name";
+    workflowType: "document";
+})
+```

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+export type MessageType = "editResource" | "createResource" | "closeBuilder";
+export type WorkflowType = "document" | "patient-report";
+export interface EditResourceType {
+    type: "editResource";
+    resourceId: string;
+    resourceName: string;
+    workflowType: WorkflowType;
+}
+export interface CreateResourceType {
+    type: "createResource";
+    resourceId: string;
+    resourceName: string;
+    workflowType: WorkflowType;
+}
+export interface CloseBuilderType {
+    type: "closeBuilder";
+}
+export type MesssageDataType = EditResourceType | CreateResourceType | CloseBuilderType;
+export interface MessageDataMapType {
+    editResource: EditResourceType;
+    createResource: CreateResourceType;
+    closeBuilder: CloseBuilderType;
+}
+export declare const publishMessage: (data: MesssageDataType) => void;
+declare function subscribeMessage(type: "closeBuilder", callback: (data: MessageDataMapType["closeBuilder"]) => void): void;
+declare function subscribeMessage(type: "editResource", callback: (data: MessageDataMapType["editResource"]) => void): void;
+declare function subscribeMessage(type: "createResource", callback: (data: MessageDataMapType["createResource"]) => void): void;
+export { subscribeMessage };

package/dist/index.es.js

@@ -0,0 +1,13 @@
+const t = (e) => {
+  var s;
+  (s = window.top) == null || s.postMessage(e, "*");
+};
+function a(e, s) {
+  window.onmessage = function(o) {
+    o.data.type === e && s(o.data);
+  };
+}
+export {
+  t as publishMessage,
+  a as subscribeMessage
+};

package/dist/index.umd.js

@@ -0,0 +1 @@
+(function(e,s){typeof exports=="object"&&typeof module<"u"?s(exports):typeof define=="function"&&define.amd?define(["exports"],s):(e=typeof globalThis<"u"?globalThis:e||self,s(e["safe-frame-sync"]={}))})(this,function(e){"use strict";const s=i=>{var n;(n=window.top)==null||n.postMessage(i,"*")};function o(i,n){window.onmessage=function(t){t.data.type===i&&n(t.data)}}e.publishMessage=s,e.subscribeMessage=o,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@dotbase/safe-frame-sync",
+  "version": "1.0.0",
+  "description": "Typesafe iframe and parent communication between Dotstudio and Dotclinic",
+  "homepage": "https://github.com/dot-base/safe-frame-sync",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.umd.js",
+  "module": "./dist/index.es.js",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-standard-with-typescript": "^43.0.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-promise": "^6.2.0",
+    "globals": "^15.3.0",
+    "prettier": "3.2.5",
+    "typescript": "^5.4.5",
+    "vite": "^5.2.0",
+    "vite-plugin-dts": "^3.9.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dot-base/safe-frame-sync.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/dot-base/safe-frame-sync/issues"
+  }
+}