@webex/jsdoctrinetest 3.0.0-beta.9 → 3.0.0-bnr.2

package/dist/types/@webex/internal-plugin-voicea/src/constants.d.ts

@@ -0,0 +1,28 @@
+export declare const EVENT_TRIGGERS: {
+    VOICEA_ANNOUNCEMENT: string;
+    CAPTION_LANGUAGE_UPDATE: string;
+    SPOKEN_LANGUAGE_UPDATE: string;
+    CAPTIONS_TURNED_ON: string;
+    TRANSCRIBING_ON: string;
+    TRANSCRIBING_OFF: string;
+    NEW_CAPTION: string;
+    EVA_COMMAND: string;
+    HIGHLIGHT_CREATED: string;
+};
+export declare const VOICEA_RELAY_TYPES: {
+    ANNOUNCEMENT: string;
+    CLIENT_ANNOUNCEMENT: string;
+    TRANSLATION_REQUEST: string;
+    TRANSLATION_RESPONSE: string;
+    TRANSCRIPTION: string;
+};
+export declare const TRANSCRIPTION_TYPE: {
+    UNKNOWN: string;
+    EVA_WAKE: string;
+    EVA_THANKS: string;
+    EVA_CANCEL: string;
+    HIGHLIGHT_CREATED: string;
+    TRANSCRIPT_INTERIM_RESULTS: string;
+    TRANSCRIPT_FINAL_RESULT: string;
+};
+export declare const VOICEA = "voicea";

package/dist/types/@webex/internal-plugin-voicea/src/index.d.ts

@@ -0,0 +1 @@
+export { default } from './voicea';

package/dist/types/@webex/internal-plugin-voicea/src/utils.d.ts

@@ -0,0 +1 @@
+export declare const millisToMinutesAndSeconds: (millis: number) => string;

package/dist/types/@webex/internal-plugin-voicea/src/voicea.d.ts

@@ -0,0 +1,78 @@
+import { WebexPlugin } from '@webex/webex-core';
+import { IVoiceaChannel } from './voicea.types';
+/**
+ * @description VoiceaChannel to hold single instance of LLM
+ * @export
+ * @class VoiceaChannel
+ */
+export declare class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
+    namespace: string;
+    private seqNum;
+    private hasVoiceaJoined;
+    private areCaptionsEnabled;
+    private hasSubscribedToEvents;
+    private vmcDeviceId?;
+    /**
+     * @param {Object} e
+     * @returns {undefined}
+     */
+    private eventProcessor;
+    /**
+     * Listen to websocket messages
+     * @returns {undefined}
+     */
+    private listenToEvents;
+    deregisterEvents(): void;
+    /**
+     * Initializes Voicea plugin
+     * @param {any} args
+     */
+    constructor(...args: any[]);
+    /**
+     * Process Transcript and send alert
+     * @param {TranscriptionResponse} voiceaPayload
+     * @returns {void}
+     */
+    private processTranscription;
+    /**
+     * Processes Caption Language Response
+     * @param {CaptionLanguageResponse} voiceaPayload
+     * @returns {void}
+     */
+    private processCaptionLanguageResponse;
+    /**
+     * processes voicea announcement response and triggers event
+     * @param {Object} voiceaPayload
+     * @returns {void}
+     */
+    private processAnnouncementMessage;
+    /**
+     * Sends Announcement to add voicea to the meeting
+     * @returns {void}
+     */
+    private sendAnnouncement;
+    /**
+     * Set Spoken Language for the meeting
+     * @param {string} languageCode
+     * @returns {Promise}
+     */
+    setSpokenLanguage: (languageCode: string) => Promise<void>;
+    /**
+     * Request Language translation
+     * @param {string} languageCode
+     * @returns {void}
+     */
+    requestLanguage: (languageCode: string) => void;
+    /**
+     * Turn on Captions
+     * @returns {Promise}
+     */
+    turnOnCaptions: () => undefined | Promise<void>;
+    /**
+     * Toggle transcribing for highlights
+     * @param {bool} activate if true transcribing is turned on
+     * @returns {Promise}
+     */
+    toggleTranscribing: (activate: boolean) => undefined | Promise<void>;
+}
+export default VoiceaChannel;

package/dist/types/@webex/internal-plugin-voicea/src/voicea.types.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Type for payload
+ */
+interface AnnouncementPayload {
+    translation: {
+        max_languages: number;
+        allowed_languages: string[];
+    };
+    ASR: {
+        spoken_languages: string[];
+    };
+}
+type TRANSCRIPTION_TYPES = 'unknown' | 'eva_wake' | 'eva_thanks' | 'eva_cancel' | 'highlight_created' | 'transcript_interim_results' | 'transcript_final_result';
+/**
+ * Class for an Transcription Object
+ */
+interface Transcription {
+    start_millis: number;
+    end_millis: number;
+    text: string;
+    transcript_language_code: string;
+    translations: {
+        [x: string]: string;
+    };
+    csis: number[];
+    last_packet_timestamp_ms: number;
+}
+/**
+ * Highlights
+ */
+interface Highlight {
+    highlight_id: string;
+    transcript: string;
+    highlight_label: string;
+    highlight_source: string;
+    start_millis: number;
+    end_millis: number;
+    csis: number[];
+}
+/**
+ * Type for Transcription message
+ */
+interface TranscriptionResponse {
+    type: TRANSCRIPTION_TYPES;
+    transcript_id: string;
+    translations?: {
+        [x: string]: string;
+    };
+    transcripts?: Transcription[];
+    transcript?: Transcription;
+    highlight?: Highlight;
+    csis: number[];
+    data: string;
+    command_response: string;
+}
+/**
+ * Type for CaptionLanguageResponse
+ */
+interface CaptionLanguageResponse {
+    requestId: string;
+    statusCode: number;
+    errorCode: number;
+    message: string;
+}
+interface IVoiceaChannel {
+    setSpokenLanguage: (languageCode: string) => Promise<void>;
+    requestLanguage: (languageCode: string) => void;
+    turnOnCaptions: () => undefined | Promise<void>;
+    toggleTranscribing: (activate: boolean) => undefined | Promise<void>;
+    deregisterEvents: () => undefined | Promise<void>;
+}
+export type { AnnouncementPayload, CaptionLanguageResponse, TranscriptionResponse, Transcription, Highlight, IVoiceaChannel, };

package/dist/types/@webex/internal-plugin-voicea/test/unit/spec/utils.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/internal-plugin-voicea/test/unit/spec/voicea.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/internal-plugin-wdm/src/index.d.ts

@@ -0,0 +1,2 @@
+export default Device;
+export { config, constants, DeviceUrlInterceptor, FeatureCollection, FeatureModel, FeaturesModel };

package/dist/types/@webex/internal-plugin-wdm/test/integration/spec/webex.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/internal-plugin-wdm/test/unit/spec/device.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/jsdoctrinetest/src/assertions/literal.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Indicates whether the specified value defines a literal assertion
+ * @param {string} value
+ * @returns {Boolean}
+ */
+export function test(value: string): boolean;
+/**
+ * Builds a literal assertion
+ * @param {string} value
+ * @returns {ast}
+ */
+export function build(value: string): ast;

package/dist/types/@webex/jsdoctrinetest/src/extract.d.ts

@@ -0,0 +1,20 @@
+/**
+ * transform function which operates on each discovered example block
+ * @callback transformCallback
+ * @param {Object} options
+ * @param {ast} options.comment
+ * @param {string} options.name
+ * @param {string} options.filename
+ * @param {string} options.type
+ */
+/**
+ * Extracts comment blocks from the source code in the specified file
+ * @param {transformCallback} transform
+ * @param {string} filename
+ * @returns {Array<ast>}
+ */
+export default function extract(transform: transformCallback, filename: string): Array<ast>;
+/**
+ * transform function which operates on each discovered example block
+ */
+export type transformCallback = (options: any, comment: ast, name: string, filename: string, type: string) => any;

package/dist/types/@webex/jsdoctrinetest/src/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/jsdoctrinetest/src/mocha-template.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Wraps a test case in a Mocha it-block
+ * @param {Object} a
+ * @param {string} a.name
+ * @param {Object} a.testCase
+ * @returns {[type]}
+ */
+export default function generateSpec(a: {
+    name: string;
+    testCase: any;
+}): [type];

package/dist/types/@webex/jsdoctrinetest/src/parse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Wrapper around babylon's parse with defaults set
+ * @param {string} code
+ * @param {object} options
+ * @returns {ast}
+ */
+export default function parse(code: string, options: object): ast;

package/dist/types/@webex/jsdoctrinetest/src/transform.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @param {Object} options
+ * @param {ast} options.comment
+ * @param {string} options.name
+ * @param {string} options.filename
+ * @param {string} options.type
+ * @returns {ast}
+ */
+export default function transform({ comment, name, filename, type }: {
+    comment: ast;
+    name: string;
+    filename: string;
+    type: string;
+}): ast;

package/dist/types/@webex/jsdoctrinetest/test/unit/spec/default.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-attachment-actions/src/attachmentActions.d.ts

@@ -0,0 +1,51 @@
+export default AttachmentActions;
+export type AttachmentActionObject = {
+    /**
+     * - (server generated) Unique identifier for the attachment action
+     */
+    id: string;
+    /**
+     * - The ID of the message in which attachment action is to be performed
+     */
+    messageId: string;
+    /**
+     * - The type of attachment action eg., submit
+     */
+    type: string;
+    /**
+     * - The inputs for form fields in attachment message
+     */
+    inputs: any;
+    /**
+     * - (server generated) The ID for the author of the attachment action
+     */
+    personId: string;
+    /**
+     * - (server generated) The ID for the room of the message
+     */
+    roomId: string;
+    /**
+     * - (server generated) The date and time that the message was created
+     */
+    created: isoDate;
+};
+/**
+ * @typedef {Object} AttachmentActionObject
+ * @property {string} id - (server generated) Unique identifier for the attachment action
+ * @property {string} messageId - The ID of the message in which attachment action is to be performed
+ * @property {string} type - The type of attachment action eg., submit
+ * @property {Object} inputs - The inputs for form fields in attachment message
+ * @property {string} personId - (server generated) The ID for the author of the attachment action
+ * @property {string} roomId - (server generated) The ID for the room of the message
+ * @property {isoDate} created - (server generated) The date and time that the message was created
+ */
+/**
+ * AttachmentActions are events that communicate information when a user clicks on an
+ * Action.Submit button in a card displayed in Webex
+ * Information conveyed in an AttachmentAction includes details about the user that
+ * clicked the button along with any card specific inputs. See the
+ * {@link https://developer.webex.com/docs/api/v1/attachment-actions|Attachments Actions API Documentation}
+ * for more details
+ * @class
+ */
+declare const AttachmentActions: any;

package/dist/types/@webex/plugin-attachment-actions/src/index.d.ts

@@ -0,0 +1,2 @@
+export default AttachmentActions;
+import AttachmentActions from "./attachmentActions";

package/dist/types/@webex/plugin-attachment-actions/test/integration/spec/attachmentActions.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-authorization/src/index.browser.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-authorization/src/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-authorization-browser/src/authorization.d.ts

@@ -0,0 +1,8 @@
+export default Authorization;
+/**
+ * Browser support for OAuth2. Automatically parses the URL hash for an access
+ * token
+ * @class
+ * @name AuthorizationBrowser
+ */
+declare const Authorization: any;

package/dist/types/@webex/plugin-authorization-browser/src/config.d.ts

@@ -0,0 +1,6 @@
+declare namespace _default {
+    namespace credentials {
+        const clientType: string;
+    }
+}
+export default _default;

package/dist/types/@webex/plugin-authorization-browser/src/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from "./authorization";
+export { default as config } from "./config";

package/dist/types/@webex/plugin-authorization-browser/test/automation/fixtures/app.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-authorization-browser/test/automation/spec/authorization-code-grant.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-authorization-browser/test/automation/spec/implicit-grant.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-authorization-browser/test/integration/spec/authorization.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-authorization-browser/test/unit/spec/authorization.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-authorization-browser-first-party/src/authorization.d.ts

@@ -0,0 +1,12 @@
+export default Authorization;
+/**
+ * Browser support for OAuth2. Automatically parses the URL query for an
+ * authorization code
+ *
+ * Use of this plugin for anything other than the Webex Web Client is strongly
+ * discouraged and may be broken at any time
+ * @class
+ * @name AuthorizationBrowserFirstParty
+ * @private
+ */
+declare const Authorization: any;

package/dist/types/@webex/plugin-authorization-browser-first-party/src/config.d.ts

@@ -0,0 +1,7 @@
+declare namespace _default {
+    namespace credentials {
+        const clientType: string;
+        function refreshCallback(webex: any, token: any): any;
+    }
+}
+export default _default;

package/dist/types/@webex/plugin-authorization-browser-first-party/src/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from "./authorization";
+export { default as config } from "./config";

package/dist/types/@webex/plugin-authorization-browser-first-party/test/automation/fixtures/app.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-authorization-browser-first-party/test/automation/spec/authorization-code-grant.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-authorization-browser-first-party/test/unit/spec/authorization.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-authorization-node/src/authorization.d.ts

@@ -0,0 +1,7 @@
+export default Authorization;
+/**
+ * NodeJS support for OAuth2
+ * @class
+ * @name AuthorizationNode
+ */
+declare const Authorization: any;

package/dist/types/@webex/plugin-authorization-node/src/config.d.ts

@@ -0,0 +1,4 @@
+declare namespace _default {
+    const credentials: {};
+}
+export default _default;

package/dist/types/@webex/plugin-authorization-node/src/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from "./authorization";
+export { default as config } from "./config";

package/dist/types/@webex/plugin-authorization-node/test/integration/spec/authorization.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-authorization-node/test/unit/spec/authorization.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-device-manager/sample/app.d.ts

@@ -0,0 +1,15 @@
+declare function notify(message: any): void;
+declare function notify(message: any): void;
+declare function populateDeviceDropdown(devices: any): void;
+declare function populateDeviceDropdown(devices: any): void;
+declare function toggleDisplay(elementId: any, status: any): void;
+declare function toggleDisplay(elementId: any, status: any): void;
+declare function populateDeviceAudioState(audioState: any): void;
+declare function populateDeviceAudioState(audioState: any): void;
+declare function populateDeviceSearchResults(response: any): void;
+declare function populateDeviceSearchResults(response: any): void;
+declare function connect(): void;
+declare function connect(): void;
+declare function requestPinChallenge(deviceId: any): any;
+declare function requestPinChallenge(deviceId: any): any;
+declare let webex: any;

package/dist/types/@webex/plugin-device-manager/src/collection.d.ts

@@ -0,0 +1,8 @@
+export default DeviceCollection;
+declare namespace DeviceCollection {
+    const devices: {};
+    function get(deviceId: any): any;
+    function set(device: any): void;
+    function reset(): void;
+    function getAll(): any[];
+}

package/dist/types/@webex/plugin-device-manager/src/config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/dist/types/@webex/plugin-device-manager/src/constants.d.ts

@@ -0,0 +1,3 @@
+export const LYRA_SPACE: "LYRA_SPACE";
+export const UC_CLOUD: "uc-cloud";
+export const DEFAULT_PRODUCT_NAME: "default";

package/dist/types/@webex/plugin-device-manager/src/device-manager.d.ts

@@ -0,0 +1,2 @@
+export default DeviceManager;
+declare const DeviceManager: any;

package/dist/types/@webex/plugin-device-manager/src/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from "./device-manager";
+export { default as config } from "./config";

package/dist/types/@webex/plugin-device-manager/test/unit/spec/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-device-manager/webex.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-logger/src/config.d.ts

@@ -0,0 +1,19 @@
+declare namespace _default {
+    namespace logger {
+        const level: string;
+        const historyLength: number;
+    }
+}
+export default _default;
+export type LoggerConfig = {
+    /**
+     * - Maximum log level that
+     * should be printed to the console. One of
+     * silent|error|warn|log|info|debug|trace
+     */
+    level?: string;
+    /**
+     * - Maximum number of entries to store in the log buffer.
+     */
+    historyLength?: number;
+};

package/dist/types/@webex/plugin-logger/src/index.d.ts

@@ -0,0 +1 @@
+export { default, levels } from "./logger";

package/dist/types/@webex/plugin-logger/src/logger.d.ts

@@ -0,0 +1,7 @@
+export const levels: string[];
+export default Logger;
+declare class Logger {
+    private constructor();
+    client_logToBuffer: Function;
+    logToBuffer: Function;
+}

package/dist/types/@webex/plugin-logger/test/unit/spec/logger.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/browsers.d.ts

@@ -0,0 +1,75 @@
+declare function _exports(): {
+    sl_chrome_latest_macOS_Catalina: {
+        base: string;
+        platform: string;
+        browserName: string;
+        version: string;
+        extendedDebugging: boolean;
+        'goog:chromeOptions': {
+            args: string[];
+        };
+        flags: string[];
+    };
+    sl_edge_latest_Win_10: {
+        base: string;
+        platform: string;
+        browserName: string;
+        version: string;
+        extendedDebugging: boolean;
+        'ms:edgeOptions': {
+            args: string[];
+        };
+    };
+    sl_safari_latest_macOS_Catalina: {
+        base: string;
+        platform: string;
+        browserName: string;
+        version: string;
+        'webkit:WebRTC': {
+            DisableInsecureMediaCapture: boolean;
+        };
+    };
+    sl_firefox_macOS_Catalina: {
+        base: string;
+        platform: string;
+        browserName: string;
+        extendedDebugging: boolean;
+        'moz:firefoxOptions': {
+            args: string[];
+            prefs: {
+                'devtools.chrome.enabled': boolean;
+                'devtools.debugger.prompt-connection': boolean;
+                'devtools.debugger.remote-enabled': boolean;
+                'dom.webnotifications.enabled': boolean;
+                'media.webrtc.hw.h264.enabled': boolean;
+                'media.getusermedia.screensharing.enabled': boolean;
+                'media.navigator.permission.disabled': boolean;
+                'media.navigator.streams.fake': boolean;
+                'media.peerconnection.video.h264_enabled': boolean;
+            };
+        };
+    };
+    firefox_h264?: undefined;
+    ChromeH264?: undefined;
+} | {
+    firefox_h264: {
+        base: string;
+        prefs: {
+            'dom.webnotifications.enabled': boolean;
+            'media.webrtc.hw.h264.enabled': boolean;
+            'media.getusermedia.screensharing.enabled': boolean;
+            'media.navigator.permission.disabled': boolean;
+            'media.navigator.streams.fake': boolean;
+            'media.peerconnection.video.h264_enabled': boolean;
+        };
+    };
+    ChromeH264: {
+        base: string;
+        flags: string[];
+    };
+    sl_chrome_latest_macOS_Catalina?: undefined;
+    sl_edge_latest_Win_10?: undefined;
+    sl_safari_latest_macOS_Catalina?: undefined;
+    sl_firefox_macOS_Catalina?: undefined;
+};
+export = _exports;

package/dist/types/@webex/plugin-meetings/src/breakouts/breakout.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.
+ */
+/**
+ * @class
+ */
+declare const Breakout: any;
+export default Breakout;

package/dist/types/@webex/plugin-meetings/src/breakouts/collection.d.ts

@@ -0,0 +1,5 @@
+/*!
+ * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.
+ */
+declare const BreakoutCollection: any;
+export default BreakoutCollection;

package/dist/types/@webex/plugin-meetings/src/breakouts/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @class Breakouts
+ */
+declare const Breakouts: any;
+export default Breakouts;