@jtl-software/cloud-apps-core 0.0.0-dev.dce09c1 → 0.0.0-dev.eef23f5

package/README.md

@@ -1,4 +1,4 @@
-# ![JTL logo](https://avatars.githubusercontent.com/u/31404730?s=25&v=4) JTL-Platform Plugins Core SDK
+# ![JTL logo](https://avatars.githubusercontent.com/u/31404730?s=25&v=4) JTL-Platform Apps Core SDK
 
 A lightweight, type-safe communication bridge for JTL Platform apps.
 
@@ -16,7 +16,7 @@ yarn add @jtl-software/cloud-apps-core
 
 ## 🔍 Overview
 
-The JTL Platform Plugins Core SDK provides a robust communication bridge between apps and the JTL Platform host application. It enables:
+The JTL Platform Apps Core SDK provides a robust communication bridge between apps and the JTL Platform host application. It enables:
 
 - Bidirectional method calling between apps and host
 - Event-based publish/subscribe communication
@@ -27,25 +27,25 @@ This package is the foundation for building apps that integrate seamlessly with
 
 ## 🚀 Usage
 
-### Creating a Plugin Bridge
+### Creating a App Bridge
 
-To use the PluginBridge in your React components, you'll need to initialize it and maintain its instance in your component's state. Typically, this is done within a useEffect hook:
+To use the AppBridge in your React components, you'll need to initialize it and maintain its instance in your component's state. Typically, this is done within a useEffect hook:
 
 ```typescript
-import { createPluginBridge, PluginBridge } from '@jtl-software/cloud-apps-core';
+import { createAppBridge, AppBridge } from '@jtl-software/cloud-apps-core';
 import { useState, useEffect } from 'react';
 
-function YourPluginComponent() {
-  // Store the PluginBridge instance in component state
-  const [appBridge, setPluginBridge] = useState<PluginBridge | undefined>(undefined);
+function YourAppComponent() {
+  // Store the AppBridge instance in component state
+  const [appBridge, setAppBridge] = useState<AppBridge | undefined>(undefined);
 
   useEffect((): void => {
     console.info('Creating bridge...');
-    createPluginBridge().then(bridge => {
+    createAppBridge().then(bridge => {
       console.log('Bridge created!');
 
       // Store the bridge instance in state for use throughout your component
-      setPluginBridge(bridge);
+      setAppBridge(bridge);
     });
   }, []);
 
@@ -59,10 +59,12 @@ The `subscribe` method allows your app to listen for specific events emitted by
 
 ```typescript
 // Listen for inventory updates
-appBridge.subscribe('inventory:updated', async data => {
+const unsubscribe = appBridge.event.subscribe('inventory:updated', async data => {
   console.info('Inventory updated:', data);
-  return { status: 'processed' };
 });
+
+// Later, you can unsubscribe
+unsubscribe();
 ```
 
 When the host system triggers an "inventory:updated" event, your callback function will execute with the provided data.
@@ -73,7 +75,7 @@ The `publish` method sends data to the host environment under a specific topic.
 
 ```typescript
 // Notify the host about completed action
-await appBridge.publish('order:verification:complete', {
+await appBridge.event.publish('order:verification:complete', {
   orderId: 'ORD-12345',
   verifiedBy: 'app-user',
 });
@@ -83,51 +85,75 @@ This is useful for informing the host about state changes or actions completed w
 
 ### Exposing Methods to the Host
 
-The `exposeMethod` function makes your app's functions callable by the host environment.
+The `expose` function makes your app's functions callable by the host environment.
 
 ```typescript
 // Make a function available to the host
-appBridge.exposeMethod('calculateShippingCost', (weight, destination) => {
+const disposer = appBridge.method.expose('calculateShippingCost', (weight, destination) => {
   const baseCost = 5.99;
   const zoneRate = destination === 'international' ? 2.5 : 1;
   return baseCost + 0.1 * weight * zoneRate;
 });
 
 // Check if a method is exposed
-const isExposed = bridge.isMethodExposed('calculateShippingCost'); // true
+const isExposed = appBridge.method.isExposed('calculateShippingCost'); // true
+
+// Later, you can remove the exposed method
+disposer();
 ```
 
 This allows the host environment to directly use functionality implemented in your app.
 
 ### Calling Host Methods
 
-The `callMethod` function allows your app to invoke functions provided by the host environment.
+The `call` function allows your app to invoke functions provided by the host environment.
 
 ```typescript
 // Get user information
-const userProfile = await appBridge.callMethod('getUserProfile');
+const userProfile = await appBridge.method.call('getUserProfile');
 
 // Call a method with parameters
-const orderDetails = await appBridge.callMethod('getOrderDetails', 'ORD-5678');
+const orderDetails = await appBridge.method.call('getOrderDetails', 'ORD-5678');
 ```
 
 ## 📚 API Reference
 
-### PluginBridge
+### AppBridge
+
+The main class that handles communication between the app and host. It provides access to different capabilities through the following properties:
 
-The main class that handles communication between the app and host, it provides the following methods.
+- `method`: AppBridgeMethodCapability - Handles method calling functionality
+- `event`: AppBridgeEventCapability - Handles event publish/subscribe functionality
 
 ---
 
-#### `subscribe(event: string, callback: (data: unknown) => Promise<unknown>): void`
+### AppBridgeEventCapability
+
+Handles event-based communication between the app and host.
+
+#### `subscribe<TPayload>(topic: string, callback: EventListener<TPayload>): () => void`
 
 **Description:**  
 Registers a listener for a specific event emitted by the host environment. When the event is triggered, the callback is executed with the event data.
 
 **Parameters:**
 
-- `event` (string): The name of the event to listen for.
-- `callback` (function): A function that handles the event data.
+- `topic` (string): The name of the event to listen for.
+- `callback` (function): A function that handles the event data. Can be sync or async.
+
+**Returns:** `() => void` - A function that, when called, unsubscribes the listener.
+
+---
+
+#### `unsubscribe<TPayload>(topic: string, callback: EventListener<TPayload>): void`
+
+**Description:**  
+Removes a specific callback from the event listeners for a topic.
+
+**Parameters:**
+
+- `topic` (string): The topic name to unsubscribe from.
+- `callback` (function): The specific callback function to remove.
 
 **Returns:** `void`
 
@@ -147,7 +173,11 @@ Sends data to the host under a specific topic, typically to notify about an acti
 
 ---
 
-#### `exposeMethod<TMethod>(methodName: string, method: TMethod): void`
+### AppBridgeMethodCapability
+
+Handles method calling functionality between the app and host.
+
+#### `expose<TMethod>(methodName: string, method: TMethod): () => void`
 
 **Description:**  
 Makes a app method available for the host to call directly.
@@ -157,11 +187,11 @@ Makes a app method available for the host to call directly.
 - `methodName` (string): The name under which the method should be exposed.
 - `method` (`TMethod`): The actual method implementation.
 
-**Returns:** `void`
+**Returns:** `() => void` - A disposer function that removes the exposed method when called.
 
 ---
 
-#### `isMethodExposed(methodName: string): boolean`
+#### `isExposed(methodName: string): boolean`
 
 **Description:**  
 Checks whether a method with the given name has already been exposed to the host.
@@ -174,7 +204,7 @@ Checks whether a method with the given name has already been exposed to the host
 
 ---
 
-#### `callMethod<TResponse>(methodName: string, ...args: unknown[]): Promise<TResponse>`
+#### `call<TResponse>(methodName: string, ...args: unknown[]): Promise<TResponse>`
 
 **Description:**  
 Calls a method provided by the host environment and returns the result.
@@ -188,7 +218,7 @@ Calls a method provided by the host environment and returns the result.
 
 ### Factories
 
-- `createPluginBridge()`: Creates and initializes a PluginBridge instance
+- `createAppBridge()`: Creates and initializes a AppBridge instance
 
 ## 📦 Dependencies
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jtl-software/cloud-apps-core",
   "private": false,
-  "version": "0.0.0-dev.dce09c1",
+  "version": "0.0.0-dev.eef23f5",
   "type": "module",
   "files": [
     "dist"