@webex/jsdoctrinetest 3.0.0-beta.8 → 3.0.0-bnr.0

package/dist/types/@webex/internal-plugin-conversation/test/unit/spec/encryption-transforms.d.ts

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

package/dist/types/@webex/internal-plugin-conversation/test/unit/spec/share-activity.d.ts

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

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

@@ -0,0 +1,10 @@
+declare namespace _default {
+    namespace device {
+        const canRegisterWaitDuration: number;
+        const defaults: any;
+        const enableInactivityEnforcement: boolean;
+        const ephemeral: boolean;
+        const ephemeralDeviceTTL: boolean;
+    }
+}
+export default _default;

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

@@ -0,0 +1,12 @@
+export const FEATURE_COLLECTION_DEVELOPER: "developer";
+export const FEATURE_COLLECTION_ENTITLEMENT: "entitlement";
+export const FEATURE_COLLECTION_USER: "user";
+export const CISCO_DEVICE_URL: "cisco-device-url";
+export const FEATURE_COLLECTION_NAMES: string[];
+export namespace FEATURE_TYPES {
+    const BOOLEAN: string;
+    const NUMBER: string;
+    const STRING: string;
+}
+export const DEVICE_EVENT_REGISTRATION_SUCCESS: "registration:success";
+export const DEVICE_EVENTS: string[];

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

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

package/dist/types/@webex/internal-plugin-device/src/features/feature-collection.d.ts

@@ -0,0 +1,9 @@
+export default FeatureCollection;
+/**
+ * Feature collection model.
+ *
+ * @description
+ * This model contains a collection of features under a specific collection
+ * group.
+ */
+declare const FeatureCollection: any;

package/dist/types/@webex/internal-plugin-device/src/features/feature-model.d.ts

@@ -0,0 +1,29 @@
+export default FeatureModel;
+/**
+ * The model returned from the {@link FeatureModelparse } method.
+ */
+export type ParsedFeatureModel = {
+    /**
+     * - The parsed val.
+     */
+    value: boolean | number | string;
+    /**
+     * - The type of the parsed val.
+     */
+    type: string;
+};
+/**
+ * The model returned from the {@link FeatureModel#parse} method.
+ *
+ * @typedef {Object} ParsedFeatureModel
+ * @property {boolean|number|string} ParsedFeatureModel.value - The parsed val.
+ * @property {string} ParsedFeatureModel.type - The type of the parsed val.
+ */
+/**
+ * Feature model.
+ *
+ * @description
+ * This model contains details on a single feature and is received from the
+ * **WDM** service upon registration.
+ */
+declare const FeatureModel: any;

package/dist/types/@webex/internal-plugin-device/src/features/features-model.d.ts

@@ -0,0 +1,9 @@
+export default FeaturesModel;
+/**
+ * Feature collection parent container.
+ *
+ * @description
+ * This class contains all of the feature collection class objects to help
+ * organize the data retrieved from the **wdm** service on device registration.
+ */
+declare const FeaturesModel: any;

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

@@ -0,0 +1,4 @@
+import FeatureCollection from "./feature-collection";
+import FeatureModel from "./feature-model";
+import FeaturesModel from "./features-model";
+export { FeatureCollection, FeatureModel, FeaturesModel };

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

@@ -0,0 +1,8 @@
+export { default } from "./device";
+import config from "./config";
+import * as constants from "./constants";
+import DeviceUrlInterceptor from "./interceptors/device-url";
+import { FeatureCollection } from "./features/index";
+import { FeatureModel } from "./features/index";
+import { FeaturesModel } from "./features/index";
+export { config, constants, DeviceUrlInterceptor, FeatureCollection, FeatureModel, FeaturesModel };

package/dist/types/@webex/internal-plugin-device/src/interceptors/device-url.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Adds 'cisco-device-url' header, as appropriate, to requests
+ */
+export default class DeviceUrlInterceptor {
+    /**
+     * @returns {DeviceUrlInterceptor}
+     */
+    static create(): DeviceUrlInterceptor;
+    /**
+     * @see Interceptor#onRequest
+     * @param {Object} options
+     * @returns {Object}
+     */
+    onRequest(options: any): any;
+}

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

@@ -0,0 +1,5 @@
+declare namespace _default {
+    const JS_SDK_WDM_REGISTRATION_SUCCESSFUL: string;
+    const JS_SDK_WDM_REGISTRATION_FAILED: string;
+}
+export default _default;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,14 @@
+export declare const DSS_REGISTERED = "dss:registered";
+export declare const DSS_UNREGISTERED = "dss:unregistered";
+export declare const DSS_LOOKUP_MERCURY_EVENT = "event:directory.lookup";
+export declare const DSS_SEARCH_MERCURY_EVENT = "event:directory.search";
+export declare const DSS_LOOKUP_RESULT = "dss:lookup.result";
+export declare const DSS_RESULT = "dss:result";
+export declare const DSS_SERVICE_NAME = "directorySearch";
+export declare const SEARCH_TYPES: {
+    PERSON: string;
+    CALLING_SERVICE: string;
+    EXTERNAL_CALLING: string;
+    ROOM: string;
+    ROBOT: string;
+};

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

@@ -0,0 +1,3 @@
+import '@webex/internal-plugin-mercury';
+declare const DSS: any;
+export default DSS;

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

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

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

@@ -0,0 +1,28 @@
+export interface LookupDetailOptions {
+    id: string;
+}
+export declare enum EntityProviderType {
+    CI_USER = "CI_USER",
+    CI_MACHINE = "CI_MACHINE",
+    CONTACTS = "CONTACTS",
+    CSDM = "CSDM"
+}
+export interface LookupOptions {
+    ids: string[];
+    entityProviderType?: EntityProviderType;
+}
+export interface LookupByEmailOptions {
+    emails: string[];
+}
+export declare enum SearchType {
+    PERSON = "PERSON",
+    CALLING_SERVICE = "CALLING_SERVICE",
+    EXTERNAL_CALLING = "EXTERNAL_CALLING",
+    ROOM = "ROOM",
+    ROBOT = "ROBOT"
+}
+export interface SearchOptions {
+    requestedTypes: SearchType[];
+    resultSize: number;
+    queryString: string;
+}

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

@@ -0,0 +1,4 @@
+/*!
+ * Copyright (c) 2015-2022 Cisco Systems, Inc. See LICENSE file.
+ */
+export {};

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

@@ -0,0 +1,11 @@
+declare namespace _default {
+    namespace ediscovery {
+        namespace defaultOptions {
+            const offset: number;
+            const size: number;
+            const timeoutMs: number;
+            const types: any[];
+        }
+    }
+}
+export default _default;

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

@@ -0,0 +1,11 @@
+/**
+ * General ediscovery error
+ */
+export class EdiscoveryError {
+}
+/**
+ * InvalidEmailAddressError is thrown when an email address has been supplied as a parameter and cannot be found in CI
+ */
+export class InvalidEmailAddressError extends EdiscoveryError {
+    static getErrorCode(): number;
+}

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

@@ -0,0 +1,6 @@
+export default EDiscovery;
+/**
+ * @class EDiscovery is used by compliance officers to run compliance reports
+ *
+ */
+declare const EDiscovery: any;

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

@@ -0,0 +1,4 @@
+export default EDiscovery;
+export { default as ReportRequest } from "./report-request";
+import EDiscovery from "./ediscovery";
+export { EdiscoveryError, InvalidEmailAddressError } from "./ediscovery-error";

package/dist/types/@webex/internal-plugin-ediscovery/src/report-request.d.ts

@@ -0,0 +1,29 @@
+export default ReportRequest;
+/**
+ * Creates a report request object with a specific set of search parameters
+ * @param {String} name - A label to identify the report
+ * @param {String} description - A textual summary of the reports purpose
+ * @param {Array<String>} emails - A list of user emails relevant to the report
+ * @param {Array<String>} userIds - A list of UUIDs relevant to the report
+ * @param {Array<String>} keywords - A list of search terms relevant to the report
+ * @param {Array<String>} spaceNames - A list of space names relevant to the report
+ * @param {Object} range - Contains the start time and end time defining the search period
+ * @returns {Object} ReportRequest - Contains all search parameters
+ */
+declare class ReportRequest {
+    constructor(name?: string, description?: string, emails?: any[], userIds?: any[], keywords?: any[], encryptionKeyUrl?: string, spaceNames?: any[], range?: {
+        startTime: string;
+        endTime: string;
+    });
+    name: string;
+    description: string;
+    emails: any[];
+    userIds: any[];
+    keywords: any[];
+    encryptionKeyUrl: string;
+    spaceNames: any[];
+    range: {
+        startTime: string;
+        endTime: string;
+    };
+}

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

@@ -0,0 +1,2 @@
+export function requestWithRetries(ctx: any, func: any, args: any, retryCount?: number, retryIntervalInSeconds?: number, maxRetries?: number): Promise<any>;
+export function timeout(sec: any): Promise<any>;

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

@@ -0,0 +1,35 @@
+export default Transforms;
+/**
+ * This class is used to encrypt/decrypt various properties on ReportRequests, Activities and Spaces as they are sent/returned to/from the eDiscovery Service
+ */
+declare class Transforms {
+    /**
+     * This function is used to encrypt sensitive properties on the ReportRequest before it is sent to the eDiscovery Service createReport API
+     * @param {Object} ctx - An object containing a webex instance and a transform
+     * @param {Object} object - Generic object that you want to encrypt some property on based on the type
+     * @returns {Promise} - Returns a transform promise
+     */
+    static encryptReportRequest(ctx: any, object: any): Promise<any>;
+    /**
+     * This function is used to decrypt encrypted properties on the ReportRequest that is returned from the eDiscovery Service getReport(s) API
+     * @param {Object} ctx - An object containing a webex instance and a transform
+     * @param {Object} object - Generic object that you want to decrypt some property on based on the type
+     * @returns {Promise} - Returns a transform promise
+     */
+    static decryptReportRequest(ctx: any, object: any): Promise<any>;
+    /**
+     * This function is used to decrypt encrypted properties on the activities that are returned from the eDiscovery Service getContent API
+     * @param {Object} ctx - An object containing a webex instance and a transform
+     * @param {Object} object - Generic object that you want to decrypt some property on based on the type
+     * @param {String} reportId - Id of the report for which content is being retrieved
+     * @returns {Promise} - Returns a transform promise
+     */
+    static decryptReportContent(ctx: any, object: any, reportId: string): Promise<any>;
+    /**
+     * This function is used to decrypt encrypted properties on the containers that are returned from the eDiscovery Service getContentContainer API
+     * @param {Object} ctx - An object containing a webex instance and a transform
+     * @param {Object} object - Generic object that you want to decrypt some property on based on the type
+     * @returns {Promise} - Returns a transform promise
+     */
+    static decryptReportContentContainer(ctx: any, object: any): Promise<any>;
+}

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,16 @@
+declare namespace _default {
+    namespace encryption {
+        namespace joseOptions {
+            const compact: boolean;
+            const contentAlg: string;
+            const protect: string;
+        }
+        const kmsInitialTimeout: number;
+        const kmsMaxTimeout: number;
+        const ecdhMaxTimeout: number;
+        const batcherWait: number;
+        const batcherMaxCalls: number;
+        const batcherMaxWait: number;
+    }
+}
+export default _default;

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

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

package/dist/types/@webex/internal-plugin-encryption/src/ensure-buffer.browser.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+/**
+ * Ensures the provider buffer is, indeed, an ArrayBuffer; converts File and
+ * Blob objects to ArrayBuffers.
+ * @param {mixed} buffer
+ * @returns {Promise<ArrayBuffer>}
+ */
+export default function ensureBuffer(buffer: mixed): Promise<ArrayBuffer>;

package/dist/types/@webex/internal-plugin-encryption/src/ensure-buffer.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Ensures the provider Buffer is, indeed, a Buffer; sometimes, they seem to be
+ * byte-arrays instead of proper Buffer objects.
+ * @param {mixed} buffer
+ * @returns {Promise<Buffer>}
+ */
+export default function ensureBuffer(buffer: mixed): Promise<Buffer>;

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

@@ -0,0 +1,3 @@
+export { default } from "./encryption";
+export { default as KMS } from "./kms";
+export { KmsError, DryError } from "./kms-errors";

package/dist/types/@webex/internal-plugin-encryption/src/kms-batcher.d.ts

@@ -0,0 +1,6 @@
+export const TIMEOUT_SYMBOL: unique symbol;
+export default KmsBatcher;
+/**
+ * @class
+ */
+declare const KmsBatcher: any;

package/dist/types/@webex/internal-plugin-encryption/src/kms-certificate-validation.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Customize Error so the SDK knows to quit retrying and notify
+ * the user
+ */
+export class KMSError extends Error {
+    /**
+     * add kmsError field to notify
+     * @param {string} message
+     */
+    constructor(message: string);
+    kmsError: boolean;
+}
+export default validateKMS;
+/**
+ * Validates the information provided by the KMS. This is a curried function.
+ * The first function takes the caroots param and returns a second function.
+ * The second function takes the credentials of the KMS and validates it
+ * @param {string[]} caroots PEM encoded certificates that will be used
+ *   as Certificate Authorities
+ * @param {Object} jwt Object containing the fields necessary to
+ *   validate the KMS
+ * @returns {Promise} when resolved will return the jwt
+ */
+declare function validateKMS(caroots: string[]): Promise<any>;

package/dist/types/@webex/internal-plugin-encryption/src/kms-dry-error-interceptor.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Interceptor (only to be used in test mode) intended to replay requests that
+ * fail as a result of the test-user incompatibility in KMS.
+ * @class
+ */
+export default class KmsDryErrorInterceptor {
+    /**
+     * @returns {KmsDryErrorInterceptor}
+     */
+    static create(): KmsDryErrorInterceptor;
+    /**
+     * @param {Object} options
+     * @param {Exception} reason
+     * @returns {Promise}
+     */
+    onResponseError(options: any, reason: Exception): Promise<any>;
+    /**
+     * Replays the request
+     * @param {Object} options
+     * @param {DryError} reason
+     * @returns {Object}
+     */
+    replay(options: any, reason: DryError): any;
+}
+import { DryError } from "./kms-errors";

package/dist/types/@webex/internal-plugin-encryption/src/kms-errors.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Error class for KMS errors
+ */
+export class KmsError {
+    static defaultMessage: string;
+    /**
+     * @param {HttpResponse} body
+     * @returns {string}
+     */
+    parse(body: HttpResponse): string;
+}
+/**
+ * Thrown when an expected KMSResponse is not received in a timely manner
+ */
+export class KmsTimeoutError extends KmsError {
+    /**
+     * @param {KmsRequest} options.request
+     * @param {KmsRequest} options.timeout
+     * @returns {string}
+     */
+    parse({ request, timeout }?: KmsRequest): string;
+}
+/**
+ * Emitted when a REST request includes an encrypter error
+ */
+export class DryError {
+    static defaultMessage: string;
+    /**
+     * @param {WebexHttpError} reason
+     * @returns {string}
+     */
+    parse(reason: WebexHttpError): string;
+}

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

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

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

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

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

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

package/dist/types/@webex/internal-plugin-encryption/test/integration/spec/payload-transfom.d.ts

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

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

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

package/dist/types/@webex/internal-plugin-encryption/test/unit/spec/kms-certificate-validation.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1 @@
+export declare const LLM = "llm";

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

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

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

@@ -0,0 +1,88 @@
+import { ILLMChannel } from './llm.types';
+export declare const config: {
+    llm: {
+        /**
+         * Milliseconds between pings sent up the socket
+         * @type {number}
+         */
+        pingInterval: string | number;
+        /**
+         * Milliseconds to wait for a pong before declaring the connection dead
+         * @type {number}
+         */
+        pongTimeout: string | number;
+        /**
+         * Maximum milliseconds between connection attempts
+         * @type {Number}
+         */
+        backoffTimeMax: string | number;
+        /**
+         * Initial milliseconds between connection attempts
+         * @type {Number}
+         */
+        backoffTimeReset: string | number;
+        /**
+         * Milliseconds to wait for a close frame before declaring the socket dead and
+         * discarding it
+         * @type {[type]}
+         */
+        forceCloseDelay: string | number;
+    };
+};
+declare const LLMChannel_base: any;
+/**
+ * LLMChannel to provide socket connections
+ */
+export default class LLMChannel extends LLMChannel_base implements ILLMChannel {
+    namespace: string;
+    /**
+     * If the LLM plugin has been registered and listening
+     * @instance
+     * @type {Boolean}
+     * @public
+     */
+    private registered;
+    private webSocketUrl?;
+    private binding?;
+    private locusUrl?;
+    /**
+     * Initializes the LLM Plugin
+     * @constructor
+     * @public
+     */
+    constructor(...args: any[]);
+    /**
+     * Register to the websocket
+     * @param {string} llmSocketUrl
+     * @returns {Promise<void>}
+     */
+    private register;
+    /**
+     * Register and connect to the websocket
+     * @param {string} locusUrl
+     * @param {string} datachannelUrl
+     * @returns {Promise<void>}
+     */
+    registerAndConnect: (locusUrl: string, datachannelUrl: string) => Promise<void>;
+    /**
+     * Tells if LLM socket is connected
+     * @returns {boolean} isRegistered
+     */
+    isConnected: () => boolean;
+    /**
+     * Tells if LLM socket is connected
+     * @returns {bool} isRegistered
+     */
+    getBinding: () => string;
+    /**
+     * Get Locus URL for the connection
+     * @returns {string} locus Url
+     */
+    getLocusUrl: () => string;
+    /**
+     * Disconnects websocket connection
+     * @returns {Promise<void>}
+     */
+    disconnectLLM: () => Promise<void>;
+}
+export {};

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

@@ -0,0 +1,8 @@
+interface ILLMChannel {
+    registerAndConnect: (locusUrl: string, datachannelUrl: string) => Promise<void>;
+    isConnected: () => boolean;
+    getBinding: () => string;
+    getLocusUrl: () => string;
+    disconnectLLM: () => Promise<void>;
+}
+export type { ILLMChannel };