@teambit/pubsub 0.0.554 → 0.0.555

package/dist/pubsub-context.d.ts

@@ -1,5 +1,9 @@
 import React, { RefObject, ReactNode } from 'react';
 export interface PubSubRegistry {
+    /**
+     * starts a connection to an iframe child.
+     * Returns a destroy() function that will break the connection.
+     */
     connect(ref: HTMLIFrameElement): () => void;
 }
 export declare const pubsubRegistry: React.Context<PubSubRegistry | undefined>;

package/dist/pubsub.preview.runtime.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Please Notice: This file will run in the preview iframe.
+ */
 import { BitBaseEvent } from './bit-base-event';
 import { Callback } from './types';
 export declare class PubsubPreview {

package/dist/pubsub.ui.runtime.d.ts

@@ -2,15 +2,28 @@ import { UiUI } from '@teambit/ui';
 import { BitBaseEvent } from './bit-base-event';
 import { Callback } from './types';
 declare type PubOptions = {
+    /** forward the event to adjacent windows (including the preview iframe)  */
     propagate?: boolean;
 };
 export declare class PubsubUI {
     private childApi?;
     private events;
+    /**
+     * subscribe to events
+     */
     sub: (topic: string, callback: Callback) => () => void;
+    /**
+     * publish event to all subscribers, including nested iframes.
+     */
     pub: (topic: string, event: BitBaseEvent<any>, { propagate }?: PubOptions) => void;
     private connectToIframe;
+    /**
+     * publish event to all subscribers in this window
+     */
     private emitEvent;
+    /**
+     * publish event to nested iframes
+     */
     private pubToChild;
     static runtime: import("@teambit/harmony").RuntimeDefinition;
     static dependencies: import("@teambit/harmony").Aspect[];

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/pubsub",
-  "version": "0.0.554",
+  "version": "0.0.555",
   "homepage": "https://bit.dev/teambit/harmony/pubsub",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "pubsub",
-    "version": "0.0.554"
+    "version": "0.0.555"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -14,10 +14,10 @@
     "penpal": "5.3.0",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/cli": "0.0.385",
-    "@teambit/preview": "0.0.554",
-    "@teambit/ui-foundation.ui.is-browser": "0.0.462",
-    "@teambit/ui": "0.0.554"
+    "@teambit/cli": "0.0.386",
+    "@teambit/preview": "0.0.555",
+    "@teambit/ui-foundation.ui.is-browser": "0.0.463",
+    "@teambit/ui": "0.0.555"
   },
   "devDependencies": {
     "@types/react": "^17.0.8",
@@ -28,7 +28,7 @@
     "@types/node": "12.20.4"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.171",
+    "@teambit/legacy": "1.0.172",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -56,7 +56,7 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.171",
+        "@teambit/legacy": "1.0.172",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }

package/tsconfig.json

@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },