@arkeytyp/valu-api 1.0.1 → 1.0.3

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@arkeytyp/valu-api",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "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": "src/ValuApi.js",
   "scripts": {
     "test": "echo \"No test specified\" && exit 1"
   },
+  "types": "./types/valu-api.d.ts",
   "keywords": ["valu", "api", "iframe", "valu social", "multiverse"],
   "author": "Stanislav Osipov",
   "license": "MIT",

package/src/APIPointer.js

@@ -34,21 +34,20 @@ export class APIPointer {
   get apiName ()  {
     return this.#apiName;
   }
-
   /**
    * @private
    * @description Stores the version of the API.
-   * @type {string}
+   * @type {number}
    */
   get version ()  {
     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

@@ -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) => {
@@ -32,7 +34,7 @@ export class ValuApi {
   /**
    * Retrieves an APIPointer object for a specific API module.
    * @param {string} apiName The name of the API module to retrieve.
-   * @param {string} [version] The optional version of the API module. If not provided, the APIPointer will be bound to the latest available version.
+   * @param {number} [version] The optional version of the API module. If not provided, the APIPointer will be bound to the latest available version.
    * @returns {APIPointer} An APIPointer object bound to the specified API version (or the latest version if no version is specified).
    *
    * The APIPointer object provides the ability to:
@@ -41,33 +43,45 @@ 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) {
      const data = { name: name, message: message};
 
-     console.log('Posting to Valu: ', name, ' ', message, ' source: ', this.#valuApplication.source);
+    // console.log('Posting to Valu: ', name, ' ', message, ' source: ', this.#valuApplication.source);
      this.#valuApplication.source.postMessage(data, this.#valuApplication.origin);
   }
 
   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,
@@ -119,7 +133,7 @@ export class ValuApi {
     }
 
     const message = event.data.message;
-    console.log('Message From Valu: ', event.data.name, ' ', message);
+   // console.log('Message From Valu: ', event.data.name, ' ', message);
 
     switch (event.data.name) {
       case 'api:ready': {
@@ -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;
       }
     }

package/types/valu-api.d.ts

@@ -0,0 +1,22 @@
+declare module '@arkeytyp/valu-api' {
+    export class ValuApi {
+        static API_READY: string;
+
+        get connected(): boolean;
+
+        addEventListener(event: string, callback: (data: any) => void): void;
+        removeEventListener(event: string, callback: (data: any) => void): void;
+        getApi(apiName: string, version?: number): Promise<APIPointer>;
+        runConsoleCommand(command: string): Promise<any | string>;
+    }
+
+    export class APIPointer {
+        get guid(): string;
+        get apiName(): string;
+        get version(): number;
+
+        addEventListener(event: string, callback: (data: any) => void): void;
+        removeEventListener(event: string, callback: (data: any) => void): void;
+        run(functionName: string, params?: any): Promise<any>;
+    }
+}