@vonage/media-processor 1.2.7 → 2.0.1

package/package.json

@@ -1,65 +1,75 @@
 {
-  "name": "@vonage/media-processor",
-  "version": "1.2.7",
-  "author": "Guy Mininberg <guy.mininberg@vonage.com>",
-  "contributors": [
-    "Guy Mininberg <guy.mininberg@vonage.com>",
-    "Jose Olivera <joseantonio.oliveraortega@vonage.com>"
-  ],
-  "keywords": [
-    "vonage",
-    "vonage api",
-    "client",
-    "media processing",
-    "insertable streams",
-    "opentok",
-    "nexmo"
-  ],
-  "scripts": {
-    "build": "npm-run-all build:js doc",
-    "build:js": "node ./scripts/package-json.js && tsc && vite build && tsc --declaration --emitDeclarationOnly --outDir dist/types",
-    "build:dev": "node ./scripts/package-json.js && tsc && vite build --mode development && tsc --declaration --emitDeclarationOnly --outDir dist/types",
-    "doc": "typedoc --excludePrivate --excludeProtected --disableSources --out dist/docs lib/main.ts",
-    "dev": "node ./scripts/package-json.js && vite",
-    "preview": "vite preview",
-    "cypress:open": "cypress open",
-    "cy:run": "cypress run"
-  },
-  "dependencies": {
-    "@types/dom-mediacapture-transform": "^0.1.2",
-    "@types/emscripten": "^1.39.6",
-    "@types/node": "^17.0.10",
-    "@types/offscreencanvas": "^2019.6.4",
-    "@types/uuid": "^8.3.4",
-    "axios": "^0.25.0",
-    "emittery": "^0.10.1",
-    "typescript-optional": "3.0.0-alpha.3",
-    "uuid": "~8.3.2"
-  },
-  "files": [
-    "dist"
-  ],
-  "types": "./dist/types/main.d.ts",
-  "main": "./dist/media-processor.umd.js",
-  "module": "./dist/media-processor.es.js",
-  "exports": {
-    ".": {
-      "import": "./dist/media-processor.es.js",
-      "require": "./dist/media-processor.umd.js"
+    "name": "@vonage/media-processor",
+    "version": "2.0.1",
+    "author": "Guy Mininberg <guy.mininberg@vonage.com>",
+    "contributors": [
+        "Guy Mininberg <guy.mininberg@vonage.com>",
+        "Jose Olivera <joseantonio.oliveraortega@vonage.com>"
+    ],
+    "keywords": [
+        "vonage",
+        "vonage api",
+        "client",
+        "media processing",
+        "insertable streams",
+        "opentok",
+        "nexmo"
+    ],
+    "scripts": {
+        "build": "npm-run-all build:js build:static doc",
+        "build:js": "vite build && tsc --declaration --emitDeclarationOnly --outDir dist/types",
+        "build:dev": "vite build --mode development && tsc --declaration --emitDeclarationOnly --outDir dist/types",
+        "build:static": "node ./scripts/build-static.js && minify ./dist/media-processor.static.js > ./dist/media-processor.min.js ",
+        "doc": "typedoc --excludePrivate --excludeProtected --disableSources --out dist/docs lib/main.ts",
+        "dev": "vite",
+        "preview": "vite preview",
+        "test": "vitest --run --threads false"
+    },
+    "dependencies": {
+        "@types/dom-mediacapture-transform": "^0.1.2",
+        "@types/emscripten": "^1.39.6",
+        "@types/node": "^17.0.10",
+        "@types/offscreencanvas": "^2019.6.4",
+        "@types/uuid": "^8.3.4",
+        "@vonage/js-onewebrtc-telemetry": "1.1.0",
+        "axios": "^0.25.0",
+        "emittery": "^0.10.1",
+        "typescript-optional": "3.0.0-alpha.3",
+        "uuid": "~8.3.2"
+    },
+    "files": [
+        "dist"
+    ],
+    "types": "./dist/types/main.d.ts",
+    "main": "./dist/media-processor.umd.js",
+    "module": "./dist/media-processor.es.js",
+    "exports": {
+        ".": {
+            "import": "./dist/media-processor.es.js",
+            "require": "./dist/media-processor.umd.js"
+        }
+    },
+    "devDependencies": {
+        "@tsconfig/node12": "^1.0.1",
+        "@types/chai": "^4.3.3",
+        "@types/mocha": "^10.0.0",
+        "@types/puppeteer": "^5.4.7",
+        "@types/rimraf": "^3.0.2",
+        "@vitest/ui": "^0.24.3",
+        "chai": "^4.3.6",
+        "chai-image": "file:./lib/libs/chai-image-3.0.0.tgz",
+        "minify": "^9.1.0",
+        "mocha": "^10.1.0",
+        "npm-run-all": "^4.1.5",
+        "puppeteer": "^19.0.0",
+        "rimraf": "^3.0.2",
+        "typedoc": "^0.22.12",
+        "typescript": "^4.6.2",
+        "vite": "^3.1.8",
+        "vitest": "^0.24.3"
+    },
+    "repository": "https://github.com/Vonage/vonage-media-transformers-samples",
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org"
     }
-  },
-  "devDependencies": {
-    "@tsconfig/node12": "^1.0.1",
-    "@types/cypress-image-snapshot": "3.1.6",
-    "cypress": "9.5.2",
-    "cypress-image-snapshot": "4.0.1",
-    "npm-run-all": "^4.1.5",
-    "typedoc": "^0.22.12",
-    "typescript": "^4.6.2",
-    "vite": "^2.7.2"
-  },
-  "repository": "https://github.com/Vonage/vonage-media-transformers-samples",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org"
-  }
 }

package/dist/types/main.d.ts

@@ -1,9 +0,0 @@
-import { isSupported } from './src/utils/utils';
-import MediaProcessor from './src/core/MediaProcessor';
-import MediaProcessorConnector from './src/core/MediaProcessorConnector';
-import { getVonageMetadata, setVonageMetadata } from './src/telemetry/Reporter';
-export type { MediaProcessorConnectorInterface } from './src/core/MediaProcessorConnectorInterface';
-export type { MediaProcessorInterface } from './src/core/MediaProcessorInterface';
-export type { VonageMetadata, VonageSourceType } from './src/telemetry/Reporter';
-export type { EventDataMap, WarnData, ErrorData, ErrorFunction, EventMetaData, PipelineInfoData } from './src/core/pipeline';
-export { isSupported, MediaProcessor, MediaProcessorConnector, getVonageMetadata, setVonageMetadata };

package/dist/types/src/core/MediaProcessorConnector.d.ts

@@ -1,79 +0,0 @@
-import InsertableStreamHelper from './InsertableStreamHelper';
-import { MediaProcessorConnectorInterface } from './MediaProcessorConnectorInterface';
-import { MediaProcessorInterface } from './MediaProcessorInterface';
-/**
- * Helper class implementing the media processor connector interface.
- *
- * @example
- *
- * ```ts
- *  let mediaProcessor: MediaProcessor = new MediaProcessor();
- *   let transformers: Array<Transformer> = [];
- *   transformers.push(new CanvasTransform());
- *   mediaProcessor.setTransformers(transformers);
- *
- *   let connector: MediaProcessorConnector = new MediaProcessorConnector(mediaProcessor);
- *   source_.setMediaProcessorConnector(connector);
- *
- *   // ...
- *
- *   setMediaProcessorConnector(mediaProcessorConnector: MediaProcessorConnectorInterface): Promise<void> {
- *     return new Promise<void>(async (resolve, reject) => {
- *       this.mediaProcessorConnector_ = mediaProcessorConnector;
- *       if (!this.stream_)
- *       {
- *         console.log('[CameraSource] Requesting camera.');
- *         reject("no stream")
- *       }
- *       this.mediaProcessorConnector_.setTrack(this.videoTrack_).then(newTrack => {
- *         let processedStream = new MediaStream();
- *         processedStream.addTrack(newTrack);
- *         this.sink_.setMediaStream(processedStream);
- *         resolve();
- *       })
- *       .catch(e => {
- *         reject(e)
- *       })
- *     });
- *   }
- *
- *   // ...
- *
- *   async stopMediaProcessorConnector() {
- *     if(this.mediaProcessorConnector_){
- *       this.mediaProcessorConnector_.destroy().then(() => {
- *         let processedStream = new MediaStream();
- *         processedStream.addTrack(this.videoTrack_);
- *         this.sink_.setMediaStream(processedStream);
- *       })
- *       .catch(e => {
- *         console.error(e);
- *       });
- *     }
- *   }
- * ```
- */
-declare class MediaProcessorConnector implements MediaProcessorConnectorInterface {
-    /**
-     * @private
-     */
-    insertableStreamHelper_: InsertableStreamHelper;
-    /**
-     * @private
-     */
-    mediaProcessor_: MediaProcessorInterface;
-    constructor(vonageMediaProcessor: MediaProcessorInterface);
-    /**
-     * Sets the media stream track instance to be processed.
-     *
-     * @param track MeadiaStreamTrack (audio or video) to be processed.
-     *
-     * @returns Promise<MediaStreamTrack> MeadiaStreamTrack instance already processed.
-     */
-    setTrack(track: MediaStreamTrack): Promise<MediaStreamTrack>;
-    /**
-     * Stops the media processing being performed.
-     */
-    destroy(): Promise<void>;
-}
-export default MediaProcessorConnector;

package/dist/types/src/core/MediaProcessorInterface.d.ts

@@ -1,16 +0,0 @@
-/**
- * Interface definition for media processor instances.
- */
-export interface MediaProcessorInterface {
-    /**
-     * Starts running the tranformation logic performed by the media processor instance.
-     *
-     * @param readable Readable stream associated to the media source being processed.
-     * @param writable Writable stream associated to the resulting media once processed.
-     */
-    transform(readable: ReadableStream, writable: WritableStream): Promise<void>;
-    /**
-     * Stops running the tranformation logic performed by the media processor instance.
-     */
-    destroy(): Promise<void>;
-}

package/dist/types/src/core/pipeline.d.ts

@@ -1,116 +0,0 @@
-/// <reference types="dom-webcodecs" />
-import Emittery from 'emittery';
-/**
- * WarningType specifies the type of warning from the transformer
- */
-export declare enum WarningType {
-    /**
-     * Warning about change in process rate
-     */
-    FPS_DROP = "fps_drop"
-}
-/**
- * DropInfo gives info about the frame rate of the transformer
- */
-export declare type DropInfo = {
-    /**
-     * The rate predicted rate of the track
-     */
-    requested: number;
-    /**
-     * The actual rate of the track
-     */
-    current: number;
-};
-/**
- * ErrorFunction specifies the function which the error (exception) happened
- */
-export declare type ErrorFunction = 'start' | 'transform' | 'flush';
-/**
- * EventMetaData the meta data of the event.
- */
-export declare type EventMetaData = {
-    /**
-     * The transformer index in the array of transformers.
-     */
-    transformerIndex: number;
-};
-/**
- * WarnData the warning data type
- * ```ts
- *  {
- *    eventMetaData: { transformerIndex: 0},
- *    warningType: WarningType.FPS_DROP
- *    dropInfo: {requested: 30, current:20}
- *  }
- * ```
- */
-export declare type WarnData = {
-    eventMetaData: EventMetaData;
-    warningType: WarningType;
-    dropInfo: DropInfo;
-};
-/**
- * ErrorData the error data type
- * ```ts
- *  {
- *    eventMetaData: { transformerIndex: 0},
- *    ErrorData: 'start',
- *    error: e (the exception in the catch)
- *  }
- * ```
- */
-export declare type ErrorData = {
-    eventMetaData: EventMetaData;
-    function: ErrorFunction;
-    error: unknown;
-};
-/**
- * PipelineInfolData - life cycle information of pipeline
- */
-export declare type PipelineInfoData = {
-    message: 'pipeline_ended' | 'pipeline_ended_with_error' | 'pipeline_started' | 'pipeline_started_with_error' | 'pipeline_restarted' | 'pipeline_restarted_with_error';
-};
-/**
- * EventDataMap the options of event data
- * @warn - see `WarnData`
- * @error - see `ErrorData`
- * @pipelineInfo - see `pipelineInfo`
- */
-export declare type EventDataMap = {
-    warn: WarnData;
-    error: ErrorData;
-    pipelineInfo: PipelineInfoData;
-};
-declare class InternalTransformer extends Emittery<EventDataMap> implements Transformer {
-    uuid_: string;
-    transformerType_: string;
-    fps_: number;
-    framesTransformed_: number;
-    transformer_: Transformer;
-    shouldStop_: boolean;
-    isFlashed_: boolean;
-    framesFromSource_: number;
-    mediaTransformerQosReportStartTimestamp_: number;
-    videoHeight_: number;
-    videoWidth_: number;
-    trackExpectedRate_: number;
-    index_: number;
-    controller_?: TransformStreamDefaultController;
-    constructor(transformer: Transformer, index: number);
-    setTrackExpectedRate(trackExpectedRate: number): void;
-    start(controller: TransformStreamDefaultController): Promise<void>;
-    transform(data: VideoFrame | AudioData, controller: TransformStreamDefaultController): Promise<void>;
-    flush(controller: TransformStreamDefaultController): Promise<void>;
-    stop(): void;
-    mediaTransformerQosReport(): void;
-}
-declare class Pipeline extends Emittery<EventDataMap> {
-    transformers_: Array<InternalTransformer>;
-    trackExpectedRate_: number;
-    constructor(transformers: Array<Transformer>);
-    setTrackExpectedRate(trackExpectedRate: number): void;
-    start(readable: ReadableStream, writeable: WritableStream): Promise<void>;
-    destroy(): Promise<void>;
-}
-export default Pipeline;

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

@@ -1,80 +0,0 @@
-import { Optional } from 'typescript-optional';
-export declare type VonageSourceType = 'automation' | 'test' | 'vbc' | 'video' | 'voice';
-/**
- * Specifies the addional information being sent with the telemetry collected by the library.
- */
-export declare type VonageMetadata = {
-    /**
-     * Type of source using the library.
-     */
-    sourceType: VonageSourceType;
-    /**
-     * Some string identifier identifying the application using the library.
-     */
-    appId: string;
-    /**
-     * The proxy URL to route all internet traffic generated by this library.
-     */
-    proxyUrl?: string;
-};
-declare global {
-    var _vonageMediaProcessorMetadata: VonageMetadata;
-}
-/**
- * Sets some metadata for telemetry.
- *
- * @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;
-export declare function getVonageMetadata(): VonageMetadata;
-interface Report {
-    action: Optional<string>;
-    applicationId: Optional<string>;
-    timestamp: number;
-    fps: Optional<number>;
-    framesTransformed: Optional<number>;
-    guid: Optional<string>;
-    highestFrameTransformCpu: Optional<number>;
-    message: Optional<string>;
-    source: Optional<string>;
-    transformedFps: Optional<number>;
-    transformerType: Optional<string>;
-    variation: Optional<string>;
-    videoHeight: Optional<number>;
-    videoWidth: Optional<number>;
-    version: string;
-    error: Optional<string>;
-    proxyUrl: Optional<string>;
-}
-declare class ReportBuilder {
-    private readonly _report;
-    constructor();
-    action(action: string): this;
-    framesTransformed(framesTransformed: number): this;
-    fps(fps: number): this;
-    guid(guid: string): this;
-    message(message: string): this;
-    transformedFps(transformedFps: number): this;
-    transformerType(transformerType: string): this;
-    variation(variation: string): this;
-    videoHeight(videoHeight: number): this;
-    videoWidth(videoWidth: number): this;
-    error(error: string): this;
-    build(): Report;
-}
-declare class Reporter {
-    static report(report: Report): Promise<any>;
-}
-export { Report, ReportBuilder, Reporter };