@arkeytyp/valu-api 1.0.2 → 1.0.3

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@arkeytyp/valu-api",
-  "version": "1.0.2",
+  "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

@@ -37,7 +37,7 @@ export class APIPointer {
   /**
    * @private
    * @description Stores the version of the API.
-   * @type {string}
+   * @type {number}
    */
   get version ()  {
     return this.#version;

package/src/ValuApi.js

@@ -34,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:
@@ -75,7 +75,7 @@ export class ValuApi {
   #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);
   }
 
@@ -133,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': {

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>;
+    }
+}