@teambit/pubsub 1.0.108 → 1.0.109

package/artifacts/preview/teambit_harmony_pubsub-preview.js

@@ -0,0 +1 @@
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports["teambit.harmony/pubsub-preview"]=t():e["teambit.harmony/pubsub-preview"]=t()}(self,(()=>(()=>{"use strict";var e={98622:(e,t,o)=>{var r={id:"teambit.harmony/pubsub@1.0.109",homepage:"https://bit.cloud/teambit/harmony/pubsub",exported:!0};function n(){const e=i(o(87363));return n=function(){return e},e}function i(e){return e&&e.__esModule?e:{default:e}}Object.defineProperty(t,"__esModule",{value:!0}),t.Logo=void 0,n.__bit_component=r,i.__bit_component=r;const p=()=>n().default.createElement("div",{style:{height:"100%",display:"flex",justifyContent:"center"}},n().default.createElement("img",{style:{width:70},src:"https://static.bit.dev/extensions-icons/pubsub.svg"}));p.__bit_component=r,t.Logo=p},87363:e=>{e.exports=React}},t={};function o(r){var n=t[r];if(void 0!==n)return n.exports;var i=t[r]={exports:{}};return e[r](i,i.exports,o),i.exports}o.d=(e,t)=>{for(var r in t)o.o(t,r)&&!o.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},o.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var r={};return(()=>{o.r(r),o.d(r,{compositions:()=>d,compositions_metadata:()=>f,overview:()=>b});var e={};o.r(e),o.d(e,{default:()=>u});var t=o(98622);o(87363);const n=MdxJsReact,i=TeambitMdxUiMdxScopeContext;var p=["components"];function a(){return a=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var o=arguments[t];for(var r in o)Object.prototype.hasOwnProperty.call(o,r)&&(e[r]=o[r])}return e},a.apply(this,arguments)}var s={},c="wrapper";function u(e){var t=e.components,o=function(e,t){if(null==e)return{};var o,r,n=function(e,t){if(null==e)return{};var o,r,n={},i=Object.keys(e);for(r=0;r<i.length;r++)o=i[r],t.indexOf(o)>=0||(n[o]=e[o]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)o=i[r],t.indexOf(o)>=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(n[o]=e[o])}return n}(e,p);return(0,n.mdx)(c,a({},s,o,{components:t,mdxType:"MDXLayout"}),(0,n.mdx)(i.MDXScopeProvider,{components:{},mdxType:"MDXScopeProvider"}))}u.isMDXComponent=!0;const d=[t],b=[e],f={compositions:[{displayName:"Logo",identifier:"Logo"}]}})(),r})()));

package/dist/{preview-1703647408454.js → preview-1703698405864.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_pubsub@1.0.108/dist/pubsub.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_pubsub@1.0.108/dist/pubsub.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_pubsub@1.0.109/dist/pubsub.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_pubsub@1.0.109/dist/pubsub.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/package.json

@@ -1,27 +1,27 @@
 {
   "name": "@teambit/pubsub",
-  "version": "1.0.108",
+  "version": "1.0.109",
   "homepage": "https://bit.cloud/teambit/harmony/pubsub",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "pubsub",
-    "version": "1.0.108"
+    "version": "1.0.109"
   },
   "dependencies": {
     "eventemitter2": "6.4.4",
     "penpal": "6.2.2",
     "@teambit/harmony": "0.4.6",
-    "@teambit/cli": "0.0.840",
-    "@teambit/ui": "1.0.108"
+    "@teambit/cli": "0.0.841",
+    "@teambit/ui": "1.0.109"
   },
   "devDependencies": {
     "@types/mocha": "9.1.0",
     "@types/jest": "^29.2.2",
     "@types/testing-library__jest-dom": "^5.9.5",
     "@teambit/ui-foundation.ui.is-browser": "0.0.500",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.13",
-    "@teambit/preview": "1.0.108"
+    "@teambit/harmony.envs.core-aspect-env": "0.0.14",
+    "@teambit/preview": "1.0.109"
   },
   "peerDependencies": {
     "react": "^17.0.0 || ^18.0.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,8 +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 type { PubSubRegistry } from './pubsub-context';
-export { usePubSub, 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.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,103 +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,
-      },
-    });
-
-    connection.promise
-      .then((childConnection) => (this.childApi = childConnection))
-      .catch((err) => {
-        // eslint-disable-next-line no-console
-        console.error('[Pubsub.ui]', 'failed connecting to child iframe:', err);
-      });
-
-    const destroy = () => {
-      connection && connection.destroy();
-    };
-    return destroy;
-  };
-
-  getPubSubContext() {
-    return createProvider({
-      connect: this.connectToIframe,
-    });
-  }
-
-  /**
-   * 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 = pubsubUI.getPubSubContext();
-
-    if (uiUI) uiUI.registerRenderHooks({ reactContext });
-
-    return pubsubUI;
-  }
-}
-
-PubsubAspect.addRuntime(PubsubUI);

package/types.ts

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