chore: Re-export types and update release docker with build, docs steps

.github/workflows/release.yml

@@ -27,6 +27,12 @@ jobs:
       - name: Install dependencies
         run: npm install
 
+      - name: Build project
+        run: npm run build
+
+      - name: Generate docs
+        run: npm run docs
+
       - name: Run semantic-release
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

.gitignore

@@ -8,6 +8,7 @@ pnpm-debug.log*
 lerna-debug.log*
 
 node_modules
+dist
 dist-ssr
 *.local
 

CHANGELOG.md

@@ -0,0 +1,9 @@
+# 1.0.0 (2024-06-10)
+
+
+### Features
+
+* Implement v1 of AppBridge, appBridgeService and useAppBridge ([0750c8c](https://github.com/rob-long/app-bridge/commit/0750c8c2095dbe3aa2c850f90d0d4dbfd14ad7da))
+* initialize rollup config ([e009baa](https://github.com/rob-long/app-bridge/commit/e009baa1282d569b037bf6119c0eb38694575406))
+* Setup rollup repo ([39880dd](https://github.com/rob-long/app-bridge/commit/39880dd3adc4d45c6e92cd3a5413cbf4e892f476))
+* Typed generics for SubjectNames and SubjectEntries ([fe580e1](https://github.com/rob-long/app-bridge/commit/fe580e1b5c851ea727e330f05182da2a241ffad6))

README.md

@@ -1,6 +1,5 @@
 # @rob-long/app-bridge
 
-**Version**: 0.0.4  
 **Description**: App bridge for Angular and React
 
 ## Overview
@@ -16,7 +15,7 @@ npm install @rob-long/app-bridge
 ## Features
 
 - **State Management**: Utilize RxJS `BehaviorSubject` for managing state.
-- **Framework Integration**: Seamless integration with Angular and React.
+- **Framework Integration**: Seamless integration with Angular and React; additional framework support can be added.
 - **TypeScript Support**: Fully typed with TypeScript for better developer experience.
 
 ## Usage

dist/index.d.ts

@@ -1,6 +1,22 @@
 import { BehaviorSubject, Subscription } from 'rxjs';
 import angular from 'angular';
 
+/**
+ * Interface representing a collection of BehaviorSubject instances.
+ *
+ * @template T - The type of the values managed by the BehaviorSubjects.
+ */
+type SubjectEntries<T> = {
+    [K in SubjectKey<T>]: BehaviorSubject<T[K] | null>;
+};
+/**
+ * Interface extending the Window object to include a subject manager.
+ *
+ * @template T - The type of the values managed by the subject manager.
+ */
+interface WindowWithSubjectManager<T> extends Window {
+    _subjectManager: SubjectEntries<T>;
+}
 /**
  * Options for configuring the AppBridge instance.
  */
@@ -14,6 +30,7 @@ interface AppBridgeOptions {
  * Type alias for the keys of a given type T.
  */
 type SubjectKey<T> = keyof T & string;
+
 /**
  * AppBridge class provides a bridge for state management using RxJS BehaviorSubjects.
  * It manages a collection of BehaviorSubject instances, allowing for state updates,
@@ -164,4 +181,4 @@ declare function createAppBridgeService<T>(applicationName: string): angular.IMo
  */
 declare const useAppBridge: <T>(subjectName: SubjectKey<T>) => readonly [T[SubjectKey<T>] | null, (newState: T[SubjectKey<T>]) => void];
 
-export { createAppBridgeService as appBridgeService, createAppBridge, useAppBridge };
+export { type AppBridgeOptions, type SubjectEntries, type SubjectKey, type WindowWithSubjectManager, createAppBridgeService as appBridgeService, createAppBridge, useAppBridge };