@teambit/pubsub 0.0.551 → 0.0.556

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.551",
+  "version": "0.0.556",
   "homepage": "https://bit.dev/teambit/harmony/pubsub",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "pubsub",
-    "version": "0.0.551"
+    "version": "0.0.556"
   },
   "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.382",
-    "@teambit/preview": "0.0.551",
-    "@teambit/ui-foundation.ui.is-browser": "0.0.459",
-    "@teambit/ui": "0.0.551"
+    "@teambit/cli": "0.0.387",
+    "@teambit/preview": "0.0.556",
+    "@teambit/ui-foundation.ui.is-browser": "0.0.464",
+    "@teambit/ui": "0.0.556"
   },
   "devDependencies": {
     "@types/react": "^17.0.8",
@@ -28,7 +28,7 @@
     "@types/node": "12.20.4"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.169",
+    "@teambit/legacy": "1.0.173",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -56,12 +56,18 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.169",
+        "@teambit/legacy": "1.0.173",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "README.md",
+    "README.mdx"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/bit-base-event.ts

@@ -1,3 +0,0 @@
-export class BitBaseEvent<T> {
-  constructor(readonly type: string, readonly version: string, readonly timestamp: number, readonly data: T) {}
-}

package/index.ts

@@ -1,7 +0,0 @@
-export { PubsubAspect, PubsubAspect as default } from './pubsub.aspect';
-
-export type { PubsubMain } from './pubsub.main.runtime';
-export type { PubsubPreview } from './pubsub.preview.runtime';
-export type { PubsubUI } from './pubsub.ui.runtime';
-export { BitBaseEvent } from './bit-base-event';
-export { usePubSub, PubSubRegistry, usePubSubIframe } from './pubsub-context';

package/no-parent-error.ts

@@ -1,6 +0,0 @@
-export class PubSubNoParentError extends Error {
-  constructor() {
-    super('could not connect to parent window');
-    this.name = 'PubSubNoParentError';
-  }
-}

package/pubsub-context.tsx

@@ -1,34 +0,0 @@
-import React, { createContext, useContext, useEffect, 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 const pubsubRegistry = createContext<PubSubRegistry | undefined>(undefined);
-
-export function createProvider(pubSubContext: PubSubRegistry) {
-  const PubSubProvider = ({ children }: { children: ReactNode }) => (
-    <pubsubRegistry.Provider value={pubSubContext}>{children}</pubsubRegistry.Provider>
-  );
-
-  return PubSubProvider;
-}
-
-export function usePubSub() {
-  return useContext(pubsubRegistry);
-}
-
-export function usePubSubIframe(ref: RefObject<HTMLIFrameElement>) {
-  const pubSub = usePubSub();
-
-  useEffect(() => {
-    if (!ref.current || !pubSub) return () => {};
-
-    const destroyConnection = pubSub.connect(ref.current);
-    return () => destroyConnection();
-  }, [ref.current, pubSub]);
-}

package/pubsub.aspect.ts

@@ -1,8 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const PubsubAspect = Aspect.create({
-  id: 'teambit.harmony/pubsub',
-  dependencies: [],
-});
-
-export default PubsubAspect;

package/pubsub.main.runtime.ts

@@ -1,34 +0,0 @@
-import { MainRuntime } from '@teambit/cli';
-
-import { BitBaseEvent } from './bit-base-event';
-import { PubsubAspect } from './pubsub.aspect';
-
-export class PubsubMain {
-  private topicMap = {};
-
-  private createOrGetTopic = (topicUUID) => {
-    this.topicMap[topicUUID] = this.topicMap[topicUUID] || [];
-  };
-
-  public sub(topicUUID, callback) {
-    this.createOrGetTopic(topicUUID);
-    this.topicMap[topicUUID].push(callback);
-  }
-
-  public pub(topicUUID, event: BitBaseEvent<any>) {
-    this.createOrGetTopic(topicUUID);
-    this.topicMap[topicUUID].forEach((callback) => callback(event));
-  }
-
-  unsubscribeAll(topicId: string) {
-    delete this.topicMap[topicId];
-  }
-
-  static runtime = MainRuntime;
-
-  static async provider() {
-    return new PubsubMain();
-  }
-}
-
-PubsubAspect.addRuntime(PubsubMain);

package/pubsub.preview.runtime.ts

@@ -1,90 +0,0 @@
-/**
- * Please Notice: This file will run in the preview iframe.
- */
-
-import { PreviewRuntime } from '@teambit/preview';
-import { isBrowser } from '@teambit/ui-foundation.ui.is-browser';
-
-import { EventEmitter2 } from 'eventemitter2';
-import { connectToParent, ErrorCode } from 'penpal';
-
-import { BitBaseEvent } from './bit-base-event';
-import { PubSubNoParentError } from './no-parent-error';
-import { PubsubAspect } from './pubsub.aspect';
-import { Callback } from './types';
-
-type ParentMethods = {
-  pub: (topic: string, event: BitBaseEvent<any>) => Promise<any>;
-};
-
-export class PubsubPreview {
-  private _parentPubsub?: ParentMethods;
-  private events = new EventEmitter2();
-
-  public sub(topic: string, callback: Callback) {
-    const emitter = this.events;
-    emitter.on(topic, callback);
-
-    const unSub = () => {
-      emitter.off(topic, callback);
-    };
-    return unSub;
-  }
-
-  public pub(topic: string, event: BitBaseEvent<any>) {
-    this.events.emit(topic, event);
-    this._parentPubsub?.pub(topic, event).catch((err) => {
-      // eslint-disable-next-line no-console
-      console.error('[Pubsub.preview]', err);
-    });
-  }
-
-  private inIframe() {
-    try {
-      return isBrowser && window.self !== window.top;
-    } catch (e: any) {
-      return false;
-    }
-  }
-
-  private connectToParentPubSub = (retries = 10): Promise<ParentMethods | undefined> => {
-    if (retries <= 0) throw new PubSubNoParentError();
-
-    return connectToParent<ParentMethods>({
-      timeout: 300,
-      methods: {
-        pub: this.handleMessageFromParent,
-      },
-    })
-      .promise.then((parentPubsub) => (this._parentPubsub = parentPubsub))
-      .catch((e: any) => {
-        if (e.code !== ErrorCode.ConnectionTimeout) throw e;
-
-        return this.connectToParentPubSub(retries - 1);
-      });
-  };
-
-  private handleMessageFromParent = (topic: string, message: BitBaseEvent<any>) => {
-    this.events.emit(topic, message);
-  };
-
-  static runtime = PreviewRuntime;
-
-  static async provider(): Promise<PubsubPreview> {
-    const pubsubPreview = new PubsubPreview();
-
-    if (pubsubPreview.inIframe()) {
-      pubsubPreview.connectToParentPubSub().catch((err) => {
-        // parent window is not required to accept connections
-        if (err instanceof PubSubNoParentError) return;
-
-        // eslint-disable-next-line no-console
-        console.error('[Pubsub.preview]', err);
-      });
-    }
-
-    return pubsubPreview;
-  }
-}
-
-PubsubAspect.addRuntime(PubsubPreview);

package/pubsub.ui.runtime.ts

@@ -1,100 +0,0 @@
-import { UIRuntime, UIAspect, UiUI } from '@teambit/ui';
-import { EventEmitter2 } from 'eventemitter2';
-import { connectToChild } from 'penpal';
-import type { AsyncMethodReturns } from 'penpal/lib/types';
-import { BitBaseEvent } from './bit-base-event';
-import { PubsubAspect } from './pubsub.aspect';
-import { createProvider } from './pubsub-context';
-import { Callback } from './types';
-
-type PubOptions = {
-  /** forward the event to adjacent windows (including the preview iframe)  */
-  propagate?: boolean;
-};
-
-type ChildMethods = {
-  pub: (topic: string, event: BitBaseEvent<any>) => any;
-};
-export class PubsubUI {
-  private childApi?: AsyncMethodReturns<ChildMethods>;
-  private events = new EventEmitter2();
-
-  /**
-   * subscribe to events
-   */
-  public sub = (topic: string, callback: Callback) => {
-    const events = this.events;
-    events.on(topic, callback);
-
-    const unSub = () => {
-      events.off(topic, callback);
-    };
-
-    return unSub;
-  };
-
-  /**
-   * publish event to all subscribers, including nested iframes.
-   */
-  public pub = (topic: string, event: BitBaseEvent<any>, { propagate }: PubOptions = {}) => {
-    this.emitEvent(topic, event);
-
-    // opt-in to forward to iframe, as we would not want 'private' messages automatically passing to iframe
-    if (propagate) {
-      this.pubToChild(topic, event);
-    }
-  };
-
-  private connectToIframe = (iframe: HTMLIFrameElement) => {
-    const connection = connectToChild<ChildMethods>({
-      iframe,
-      methods: {
-        pub: this.emitEvent,
-      },
-    });
-
-    // absorb valid errors like 'connection destroyed'
-    connection.promise
-      .then((childConnection) => (this.childApi = childConnection))
-      .catch(() => {
-        // eslint-disable-next-line no-console
-        console.error('[Pubsub.ui]', 'failed connecting to child iframe');
-      });
-
-    const destroy = () => {
-      connection && connection.destroy();
-    };
-    return destroy;
-  };
-
-  /**
-   * publish event to all subscribers in this window
-   */
-  private emitEvent = (topic: string, event: BitBaseEvent<any>) => {
-    this.events.emit(topic, event);
-  };
-
-  /**
-   * publish event to nested iframes
-   */
-  private pubToChild = (topic: string, event: BitBaseEvent<any>) => {
-    return this.childApi?.pub(topic, event);
-  };
-
-  static runtime = UIRuntime;
-  static dependencies = [UIAspect];
-
-  static async provider([uiUI]: [UiUI]) {
-    const pubsubUI = new PubsubUI();
-
-    const reactContext = createProvider({
-      connect: pubsubUI.connectToIframe,
-    });
-
-    uiUI.registerRenderHooks({ reactContext });
-
-    return pubsubUI;
-  }
-}
-
-PubsubAspect.addRuntime(PubsubUI);

package/tsconfig.json

@@ -1,35 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": [
-      "es2019",
-      "DOM",
-      "ES6",
-      "DOM.Iterable",
-      "ScriptHost"
-    ],
-    "target": "es2015",
-    "module": "commonjs",
-    "jsx": "react",
-    "declaration": true,
-    "sourceMap": true,
-    "skipLibCheck": true,
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "outDir": "dist",
-    "composite": true,
-    "emitDeclarationOnly": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "allowSyntheticDefaultImports": true,
-    "strictPropertyInitialization": false,
-    "strict": true,
-    "noImplicitAny": false,
-    "rootDir": ".",
-    "removeComments": true,
-    "preserveConstEnums": true,
-    "resolveJsonModule": true
-  },
-  "exclude": [
-    "dist"
-  ]
-}

package/types/asset.d.ts

@@ -1,29 +0,0 @@
-declare module '*.png' {
-  const value: any;
-  export = value;
-}
-declare module '*.svg' {
-  import type { FunctionComponent, SVGProps } from 'react';
-
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
-  const src: string;
-  export default src;
-}
-
-// @TODO Gilad
-declare module '*.jpg' {
-  const value: any;
-  export = value;
-}
-declare module '*.jpeg' {
-  const value: any;
-  export = value;
-}
-declare module '*.gif' {
-  const value: any;
-  export = value;
-}
-declare module '*.bmp' {
-  const value: any;
-  export = value;
-}

package/types/style.d.ts

@@ -1,42 +0,0 @@
-declare module '*.module.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.module.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.mdx' {
-  const component: any;
-  export default component;
-}

package/types.ts

@@ -1,3 +0,0 @@
-import { BitBaseEvent } from './bit-base-event';
-
-export type Callback = (event: BitBaseEvent<any>) => void;