@vonage/client-sdk 1.1.0-alpha.10 → 1.1.0-alpha.12

package/dist/vonageClientSDK.mjs

@@ -75479,7 +75479,24 @@ class SocketClient {
 }
 
 const ConfigRegion = clientsdkClientcore_jsExports.vonage.CoreClientConfigRegionJS;
+/**
+ * Represents the configuration object for the client.
+ *
+ * The `ClientConfig` class provides a convenient way to configure the client by specifying various properties.
+ * These properties control different aspects of the client's behavior, such as API URLs, media reoffer, and WebSocket settings.
+ *
+ * @example
+ * [[include:set_client_config.txt]]
+ */
 class ClientConfig extends clientsdkClientcore_jsExports.vonage.CoreClientConfigJS {
+    /**
+     * Constructs a new instance of the class.
+     *
+     * @param {string} region The region where the API and WebSocket URLs should be configured.
+     *                        Valid values are "EU" (Europe), "US" (United States), or "AP" (Asia Pacific).
+     *                        The URLs will be automatically set based on the selected region.
+     *                        Defaults to "US" if no region is specified.
+     */
     constructor(region = ConfigRegion.US) {
         super(region);
     }
@@ -75523,6 +75540,36 @@ const setVonageClientLoggingLevel = setDefaultLoggingLevel;
  * DO NOT ADD CODE HERE UNLESS REALLY NEEDEED!!111!
  */
 class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS {
+    /**
+     * @internal
+     */
+    get core() {
+        return super.core;
+    }
+    /**
+     * @internal
+     */
+    get media() {
+        return super.media;
+    }
+    /**
+     * @internal
+     */
+    get emitter() {
+        return super.emitter;
+    }
+    /**
+     * @internal
+     */
+    set emitter(value) {
+        super.emitter = value;
+    }
+    /**
+     * @internal
+     */
+    hangupWithReason(callId, reasonText, reasonCode) {
+        return super.hangupWithReason(callId, reasonText, reasonCode);
+    }
     constructor() {
         super(new HttpClient(), new SocketClient(), new MediaClient());
         /**
@@ -75530,6 +75577,10 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
          * @internal
          */
         this.callbacks = new Map();
+        /**
+         * @internal
+         */
+        this.__doNotUseIt = super.__doNotUseIt;
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         const _this = this;
         this.emitter = new Proxy(Object(), {
@@ -75558,6 +75609,9 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Register a callback for an event.
      *
+     * @example
+     * [[include:register_listener.txt]]
+     *
      * @param event - the event to register for (e.g. 'legStatusUpdate')
      * @param callback - the callback to register for the event
      * @returns a symbol that can be used to unregister the callback
@@ -75575,6 +75629,9 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Unregister a callback for an event.
      *
+     * @example
+     * [[include:unregister_listener.txt]]
+     *
      * @param event - the event to register for (e.g. 'legStatusUpdate')
      * @param callbackSymbol - the callback symbol to unregister
      * @returns true if the callback was unregistered, false otherwise
@@ -75590,16 +75647,15 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Clear all callbacks for an event.
      *
-     * @param event - the event to register for (e.g. 'legStatusUpdate')
+     * @example
+     * [[include: clear_callbacks.txt]]
+     *
+     * @param event - the event to unregister from (e.g. 'legStatusUpdate')
      * @returns void
      *
      * @remarks
      * This is useful for cleaning up callbacks when you no longer need them.
      *
-     * @example
-     * ```ts
-     *    client.clearCallbacks('legStatusUpdate');
-     * ```
      */
     clearCallbacks(event) {
         const callbacks = this.callbacks.get(event);
@@ -75613,6 +75669,9 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
      * and returned. If a sessionId is provided, it will be used
      * to resume an existing session.
      *
+     * @example
+     * [[include:create_session.txt]]
+     *
      * @param token
      * @param sessionId - optional sessionId to use
      * @returns the `sessionId` of the session
@@ -75625,10 +75684,33 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
             return _super.createSession.call(this, token, sessionId || null);
         });
     }
+    /**
+     * Get the Peer Connection for a call
+     *
+     * @experimental
+     * @group Voice
+     * @param id - The Call Id
+     */
+    getPeerConnection(id) {
+        return super.getPeerConnection(id);
+    }
+    /**
+     * Get the Leg for a call
+     *
+     * @group Voice
+     * @param legId - The Leg Id
+     */
+    getLeg(legId) {
+        return super.getLeg(legId);
+    }
     /**
      * Make a server call to the Vonage API.
      * This is used to initiate a call using the Voice API and NCCO.
      *
+     * @example
+     * [[include:outbound_call.txt]]
+     *
+     * @group Voice
      * @param context - the context to send to the server passed as Custom data to the voice answer webhook
      * @returns the `callId` of the call
      */
@@ -75643,9 +75725,10 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Hangup a call.
      *
-     * @remarks
-     * this is a convenience method that calls `hangupWithReason` with
+     * @example
+     * [[include:call_hangup.txt]]
      *
+     * @group Voice
      * @param callId - the `callId` of the call to hangup
      * @param reasonText - optional reason text to send to the other party
      * @param reasonCode - optional reason code to send to the other party
@@ -75678,6 +75761,11 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Get a list of Conversations for the user.
      *
+     * @example
+     * [[include:get_conversations.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param order - the order to return the conversations in (default: 'asc')
      * @param pageSize - the number of conversations to return per page (default: 100)
      * @param cursor - the cursor to use for pagination (default: null)
@@ -75694,6 +75782,11 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Get a Conversation's Events
      *
+     * @example
+     * [[include:get_conversation_events.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param order - the order to return the events in (default: 'asc')
      * @param pageSize - the number of events to return per page (default: 100)
@@ -75710,6 +75803,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Get a Conversation's Members
+     *
+     * @example
+     * [[include:get_conversation_members.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param order - the order to return the members in (default: 'asc')
      * @param pageSize - the number of members to return per page (default: 100)
@@ -75726,6 +75825,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Create a conversation
+     *
+     * @example
+     * [[include:create_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param name - the name of the conversation
      * @param displayName - the display name of the conversation
      * @returns the `cid` of the conversation
@@ -75740,6 +75845,10 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Get a Conversation
+     *
+     * @example
+     * [[include:get_conversation.txt]]
+     *
      * @param id - the Conversation's id
      * @returns the `Conversation`
      */
@@ -75753,6 +75862,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Leave a Conversation
+     *
+     * @example
+     * [[include:leave_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @returns void
      */
@@ -75766,6 +75881,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Join a Conversation
+     *
+     * @example
+     * [[include:join_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @returns the `memberId` of the member
      */
@@ -75779,6 +75900,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Delete a Conversation
+     *
+     * @example
+     * [[include:delete_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @returns void
      */
@@ -75792,6 +75919,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Invite a user to a Conversation by user's `name`
+     *
+     * @example
+     * [[include:invite_to_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param name - the namne of the user to invite
      * @returns the `memberId` of the member
@@ -75806,6 +75939,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Send a text message to a Conversation
+     *
+     * @example
+     * [[include:send_text_message.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param text - the Body of the message
      * @returns the `timestamp` of the message
@@ -75820,6 +75959,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Send a custom message to a Conversation
+     *
+     * @example
+     * [[include:send_custom_message.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param customData - the body of the message
      * @returns the `timestamp` of the message
@@ -75837,6 +75982,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Get a Member of a Conversation
+     *
+     * @example
+     * [[include:get_conversation_member.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param cid - the Conversation's id
      * @param mid - the Member's id
      * @returns the `Member`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vonage/client-sdk",
-  "version": "1.1.0-alpha.10",
+  "version": "1.1.0-alpha.12",
   "description": "",
   "type": "module",
   "module": "dist/client/index.mjs",
@@ -21,9 +21,11 @@
     "copy_core_dist": "mkdir dist/kotlin; cp ./src/kotlin/**.d.ts ./dist/kotlin/",
     "build": "npm run copy_core; rollup -c; npm run copy_core_dist",
     "build:rollup": "rollup -c",
+    "build:readme": "chmod +x ./docs/generate_readme.sh; ./docs/generate_readme.sh",
+    "snippets": "node snippet.js $PWD",
     "start": "node dist/Client.js",
     "build:watch": "tsc -w",
-    "check": "tsc ./examples/* --noEmit --skipLibCheck --strictNullChecks true",
+    "check": "tsc ./examples/*.ts --noEmit --skipLibCheck --strictNullChecks true",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
     "clean": "rm -Rf node_modules/*; rm -Rf dist/"

package/snippet.js

@@ -0,0 +1,98 @@
+console.log('============== EXAMPLE SNIPPETS EXTRACTOR ==============');
+
+// the project root used for relative IO paths (set by commandline)
+const project_root = process.argv[2];
+const input_dir = process.argv[3] || 'examples';
+const output_dir = process.argv[4] || 'examples/snippets';
+
+if (!project_root) {
+  console.error('Error: project_root not provided. Exiting...');
+  process.exit(1);
+}
+
+console.log('args: ', process.argv.slice(2));
+console.log('project_root: ', project_root);
+console.log('input_dir: ', input_dir);
+console.log('output_dir: ', output_dir);
+
+//output_file_name_template = '{{name}}.txt'  # a mustache template for the output file name
+
+// Code block indicators
+const start_flag = 'example:';
+const end_flag = 'endExample';
+
+// straightforward replacements
+//[snippet.replacements]
+// "self." = ""
+
+const comments_by_format = {
+  html: ['<!--', '-->'],
+  js: ['//', ''],
+  ts: ['//', '']
+};
+
+import {
+  readdirSync,
+  readFileSync,
+  existsSync,
+  mkdirSync,
+  writeFileSync
+} from 'fs';
+
+const input_path = `${project_root}/${input_dir}`;
+const examples = [];
+let current_example = 0;
+const files = readdirSync(input_path);
+console.log('Input files: ', files);
+
+files.forEach((file) => {
+  const format = file.split('.').pop();
+  const comments = comments_by_format[format];
+  if (!comments) return;
+  const comment_prefix = comments[0];
+  const comment_suffix = comments[1];
+  let isExampleCode = false;
+  let indentationLevel = 0;
+  const allFileContents = readFileSync(`${input_path}/${file}`, 'utf-8');
+  allFileContents.split(/\r?\n/).forEach((line) => {
+    const lineTrim = line.trim();
+    const isComment =
+      lineTrim.startsWith(comment_prefix) && lineTrim.endsWith(comment_suffix);
+    const isExampleStart = isComment && lineTrim.includes(start_flag);
+    const isExampleFinished = isComment && lineTrim.includes(end_flag);
+
+    if (isExampleStart) {
+      isExampleCode = true;
+      let title = lineTrim.split(start_flag)[1];
+      if (comment_suffix) {
+        title = title.split(comment_suffix)[0];
+      }
+      examples[current_example] = {
+        title: title.trim(),
+        format: format,
+        file_name: title.trim().replace(/ /g, '_').toLowerCase() + `.txt`,
+        content: ``
+      };
+      indentationLevel = line.search(comment_prefix);
+    } else if (isExampleFinished) {
+      isExampleCode = false;
+      current_example = current_example + 1;
+      indentationLevel = 0;
+    } else if (isExampleCode) {
+      const adjustedLine = line.slice(indentationLevel);
+      examples[current_example].content += adjustedLine + `\n`;
+    }
+  });
+});
+
+const output_path = `${project_root}/${output_dir}`;
+if (!existsSync(output_path)) {
+  mkdirSync(output_path, { recursive: true });
+}
+
+console.log(`${examples.length} example snippets found`);
+examples.forEach((res) => {
+  const { title, file_name, content, format } = res;
+  writeFileSync(`${output_path}/${file_name}`, content.trim(), 'utf-8');
+  console.log(`${title} (${format.toUpperCase()})`, ' -> ', file_name);
+});