@vonage/media-processor 1.2.5 → 2.0.0

package/dist/types/src/telemetry/Reporter.d.ts

@@ -1,5 +1,29 @@
 import { Optional } from 'typescript-optional';
-export declare type VonageSourceType = 'automation' | 'test' | 'vbc' | 'video' | 'voice';
+/**
+ * Enumeration listing all possible users or consumers of this library.
+ */
+export declare enum VonageSourceType {
+    /**
+     * @private
+     */
+    automation = "automation",
+    /**
+     * @private
+     */
+    test = "test",
+    /**
+     * @private
+     */
+    vbc = "vbc",
+    /**
+     * For Vonage Video SDK users.
+     */
+    video = "video",
+    /**
+     * For Vonage Voice SDK users.
+     */
+    voice = "voice"
+}
 /**
  * Specifies the addional information being sent with the telemetry collected by the library.
  */
@@ -13,7 +37,7 @@ export declare type VonageMetadata = {
      */
     appId: string;
     /**
-     * The proxy URL to route all internet traffic generated by this library.
+     * The proxy URL to route all internet traffic generated by this library. This field is optional.
      */
     proxyUrl?: string;
 };
@@ -22,22 +46,15 @@ declare global {
 }
 /**
  * Sets some metadata for telemetry.
+ * An example can be found [here](/docs/intro.md#statistics).
  *
  * @param metadata  Specifies the addional information being sent with the telemetry collected by the library.
  *                  If metadata is either undefined or not set the library will not collect/send any telemetry.
- *
- * @example
- *
- * ```ts
- *   const metadata: VonageMetadata = {
- *     appId: 'vonage-media-processor-example',
- *     sourceType: 'test'
- *   };
- *   setVonageMetadata(metadata);
- *   let metadataGet: VonageMetadata = getVonageMetadata();
- * ```
  */
 export declare function setVonageMetadata(metadata: VonageMetadata): void;
+/**
+ * @private
+ */
 export declare function getVonageMetadata(): VonageMetadata;
 interface Report {
     action: Optional<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vonage/media-processor",
-  "version": "1.2.5",
+  "version": "2.0.0",
   "author": "Guy Mininberg <guy.mininberg@vonage.com>",
   "contributors": [
     "Guy Mininberg <guy.mininberg@vonage.com>",
@@ -58,7 +58,7 @@
     "typescript": "^4.6.2",
     "vite": "^2.7.2"
   },
-  "repository": "https://github.com/vonage/media-processor",
+  "repository": "https://github.com/Vonage/vonage-media-transformers-samples",
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   }