@arkeytyp/valu-api 1.0.0 → 1.0.2

package/README.md

@@ -1,5 +1,10 @@
 The `valu-api` package enables developers to create custom iframe applications for Valu Social. It provides tools to invoke functions of registered Valu applications and subscribe to their events. With features like API versioning, event handling, and console command testing, developers can seamlessly integrate and extend functionality within the Valu Social ecosystem.
 
+# install
+```
+npm install @arkeytyp/valu-api
+```
+
 # Usage
 
 ## 1. Initialize ValuApi

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@arkeytyp/valu-api",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A package for developing iframe applications for Valu Social. Allows invoking functions of registered Valu applications and subscribing to events, as well as other features that enable developers creating own ifram apps for the value social",
-  "main": "ValuApi.js",
+  "main": "src/ValuApi.js",
   "scripts": {
     "test": "echo \"No test specified\" && exit 1"
   },
@@ -13,4 +13,4 @@
     "type": "git",
     "url": "https://github.com/arkeytyp/valu-api.git"
   }
-}
+}

package/src/APIPointer.js

@@ -34,7 +34,6 @@ export class APIPointer {
   get apiName ()  {
     return this.#apiName;
   }
-
   /**
    * @private
    * @description Stores the version of the API.
@@ -44,11 +43,11 @@ export class APIPointer {
     return this.#version;
   }
 
-  constructor(apiName, version, runRequest) {
+  constructor(apiName, version, guid, runRequest) {
     this.#apiName = apiName
     this.#version = version;
     this.#eventEmitter = new EventEmitter();
-    this.#guid = guid4();
+    this.#guid = guid;
     this.#runRequest = runRequest;
   }
 
@@ -77,7 +76,6 @@ export class APIPointer {
     return deferredPromise.promise;
   }
 
-
   postRunResult(requestId, result) {
     let deferred = this.#apiCalls[requestId];
     if(!deferred) {

package/src/ValuApi.js

@@ -1,6 +1,6 @@
 import {EventEmitter} from "./EventEmitter.js";
 import {APIPointer} from "./APIPointer.js";
-import {guid4, nextId} from "@/valu-api/Utils.js";
+import {guid4, nextId} from "./Utils.js";
 
 
 /**
@@ -15,9 +15,11 @@ export class ValuApi {
 
   #eventEmitter;
   #valuApplication = {};
-  #apiRequests = {};
-  #consoleCommands = new Map();
+  #requests = new Map();
 
+  get connected() {
+    return this.#valuApplication.origin !== undefined;
+  }
 
   constructor() {
     globalThis.addEventListener('message', (event) => {
@@ -41,20 +43,33 @@ export class ValuApi {
    *
    * This method enables interaction with a specific version of an API module, allowing users to access its functionality and listen to events.
    */
-  getApi(apiName, version) {
-    const apiPointer = new APIPointer(apiName, version, (functionName, params, requestId, apiPointer) => {
+  async getApi(apiName, version) {
+    const guid = guid4();
+    const result = await this.#registerApiPointer(apiName, version, guid);
+
+    if(result.error) {
+      throw new Error(result.error);
+    }
+
+    const apiPointer = new APIPointer(apiName, result.version, guid,(functionName, params, requestId, apiPointer) => {
       this.#onApiRunRequest(functionName, params, requestId, apiPointer);
     });
-    this.#registerApiPointer(apiPointer);
+
     return apiPointer;
   }
 
-  #registerApiPointer(apiPointer) {
+  async #registerApiPointer(apiName, version, guid) {
+    let deferredPromise = this.#createDeferred();
+
     this.#postToValuApp('api:create-pointer', {
-      guid: apiPointer.guid,
-      api: apiPointer.apiName,
-      version: apiPointer.version,
+      guid: guid,
+      api: apiName,
+      version: version,
+      requestId: deferredPromise.id,
     });
+
+    this.#requests[deferredPromise.id] = deferredPromise;
+    return deferredPromise.promise;
   }
 
   #postToValuApp(name, message) {
@@ -65,9 +80,8 @@ export class ValuApi {
   }
 
   async #onApiRunRequest(functionName, params, requestId, apiPointer) {
-    console.log('onApiRunRequest', this);
 
-    this.#apiRequests[requestId] = apiPointer;
+    this.#requests[requestId] = apiPointer;
 
     this.#postToValuApp('api:run', {
       apiPointerId: apiPointer.guid,
@@ -92,7 +106,7 @@ export class ValuApi {
    */
   async runConsoleCommand(command) {
     let deferredPromise = this.#createDeferred();
-    this.#consoleCommands[deferredPromise.id] = deferredPromise;
+    this.#requests[deferredPromise.id] = deferredPromise;
 
     this.#postToValuApp('api:run-console', {
       requestId: deferredPromise.id,
@@ -135,27 +149,40 @@ export class ValuApi {
 
       case 'api:run-console-completed': {
         const requestId = event.data.requestId;
-        const deferred = this.#consoleCommands[requestId];
+        const deferred = this.#requests[requestId];
         if(deferred) {
           deferred.resolve(message);
         } else {
           console.log('Failed to locate console request with Id: ', requestId);
         }
 
-        delete this.#consoleCommands[requestId];
+        delete this.#requests[requestId];
         break;
       }
 
       case 'api:run-completed': {
         const requestId = event.data.requestId;
-        const apiPointer = this.#apiRequests[requestId];
+        const apiPointer = this.#requests[requestId];
         if(!apiPointer)  {
           console.error(`Failed to find Api Pointer for requestId: ${requestId}`);
           break
         }
 
         apiPointer.postRunResult(requestId, message);
-        delete this.#apiRequests[requestId];
+        delete this.#requests[requestId];
+        break;
+      }
+
+      case 'api:pointer-created': {
+        const requestId = event.data.requestId;
+        const deferred = this.#requests[requestId];
+        if(deferred) {
+          deferred.resolve(message);
+          delete this.#requests[requestId];
+        } else {
+          console.log('Failed to locate pointer create request with Id: ', requestId);
+        }
+
         break;
       }
     }