luistak/windowed-observable

Messaging lib using a pub/sub observable scoped by namespaces.

windowed-observable

The home for all windowed-observable projects

---

Introduction

Problem

In a micro frontends setup, one of the main problems is cross application communication and this library aims to solve it by providing a simple and framework agnostic API with zero configuration

Solution

Exposing an observable that behaves like scoped a pub/sub topic passing events per namespaces.

This Observable is exported by the core package windowed-observable with the following features:

✨ Features

• 📦 Scoped events by namespaces
• 🎣 Events history retrieval with SubscriptionOptions
• 🛡 100% Written in TypeScript with static types

Packages

• windowed-observable is a library for messaging using Observables, making it easier to communicate multiple apps or parts of an app using the window. It exposes an Observable that behaves like a scoped pub/sub topic using namespaces.

• react-windowed-observable is a react abstraction over windowed-observable exposing a helper that creates a scoped Context to handle events in a specific namespace

windowed-observable's Issues

Add [Docussaurus](https://docusaurus.io/) or any other static documentation

Add [Semantic Release](https://semantic-release.gitbook.io/semantic-release/)

Update docs and examples with latest APIs

Describe the feature you'd like:

It would be nice to update both packages documentation and examples to reflects the newest changes made in this PR #164

Suggested implementation:

Update README.md files along with examples, following the existent ones.

Please clarify using `DataType` for code completion

Hey, I'm having some trouble with code completion when I do this in my code:

export const loginObservable = createReactObservable<{ user: User | null }>(...)

The code that uses the above:

import { loginObservable } from "user"; // some imported workspace module

const {
  ObservableProvider: LoginProvider,
  useObservable: useLoginObservable,
} = loginObservable;

function App() {
  const { data } = useLoginObservable();
  ///...

Now, in VS Code, when I type data. I don't get any suggestions for 'user' whatsoever. I dug into the library's types and found:

export type DataType<T> = T | T[] | undefined;

Which is a bit unclear to me. Values in the 'event bus' can be either arrays or singular values? If so how would I use this with proper type checking? Thanks.

Why does package.json includes react and react-dom?

Hello. I want to add the ability to provide the global object that will be used as the communication foundation as opposed to have the code assume it is the window object. This because I have been unable to fiddle around with this code in NodeJS, and window mocks and replacements haven't proved fruitful for me.

Anyway, back to my question: If there's a specialized package for React, why does this one (the generic version) has React in its dependencies? Can those packages be removed?

Improve Contribution

• Create a contribution guide
• Add github issue templates

Add async pipe support

Describe the feature you'd like:

I would like to have a possibility to use windowed-observable directly in a html-template via async pipe.

Add interactive examples using [single-spa](https://single-spa.js.org/) or any other microfrontend tool