@webex/jsdoctrinetest 3.0.0-bnr.5 → 3.0.0-next.2

package/dist/types/@webex/common/src/template-container.d.ts

@@ -1,59 +0,0 @@
-export { make as default };
-/**
- * Factory which produces a multi-keyed container based on the provided set of
- * constructors
- * @param {mixed} containers
- * @returns {Container}
- */
-declare function make(...containers: mixed): {
-    /**
-     * getter for .size
-     * @returns {number}
-     */
-    readonly size: number;
-    /**
-     * Identical to Container#set() but leads slightly more intuitive code when
-     * the container is based on a Set rather than a Map.
-     * @returns {Container}
-     */
-    add(...args: any[]): any;
-    /**
-     * Removes all items from the container
-     * @returns {undefined}
-     */
-    clear(): undefined;
-    /**
-     * Removes the specified item to the container
-     * @param {mixed} key
-     * @param {Array<mixed>} keys
-     * @returns {boolean}
-     */
-    delete(key: mixed, ...keys: Array<mixed>): boolean;
-    /**
-     * Retrieves the specified item from the container
-     * @param {mixed} key
-     * @param {Array<mixed>} keys
-     * @returns {mixed}
-     */
-    get(key: mixed, ...keys: Array<mixed>): mixed;
-    /**
-     * Indicates whether the container holds the specified item
-     * @param {mixed} key
-     * @param {Array<mixed>} keys
-     * @returns {Boolean}
-     */
-    has(...args: any[]): boolean;
-    /**
-     * Stores the specified item in the container
-     * @param {mixed} key
-     * @param {Array<mixed>} args
-     * @param {mixed} value
-     * @returns {Container}
-     */
-    set(...args: Array<mixed>): any;
-    /**
-     * @private
-     * @returns {string}
-     */
-    inspect(): string;
-};

package/dist/types/@webex/common/src/uuid-utils.d.ts

@@ -1,112 +0,0 @@
-/**
- * Constructs a Hydra ID for a given UUID and type.
- *
- * @export
- * @param {string} type one of PEOPLE, TEAM, ROOM
- * @param {any} id identifying the "TYPE" object
- * @param {string} cluster containing the "TYPE" object
- * @returns {string}
- */
-export function constructHydraId(type?: string, id?: any, cluster?: string): string;
-/**
- * @typedef {Object} DeconstructedHydraId
- * @property {UUID} id identifying the object
- * @property {String} type of the object
- * @property {String} cluster containing the object
- */
-/**
- * Deconstructs a Hydra ID.
- *
- * @export
- * @param {String} id Hydra style id
- * @returns {DeconstructedHydraId} deconstructed id
- */
-export function deconstructHydraId(id: string): DeconstructedHydraId;
-/**
- * Constructs a Hydra ID for a message based on internal UUID
- *
- * @export
- * @param {any} uuid
- * @param {string} cluster containing the message
- * @returns {string}
- */
-export function buildHydraMessageId(uuid: any, cluster: string): string;
-/**
- * Constructs a Hydra ID for a person based on internal UUID
- *
- * @export
- * @param {any} uuid
- * @param {string} cluster containing the person
- * @returns {string}
- */
-export function buildHydraPersonId(uuid: any, cluster: string): string;
-/**
- * Constructs a Hydra ID for a room based on internal UUID
- *
- * @export
- * @param {any} uuid
- * @param {string} cluster containing the room
- * @returns {string}
- */
-export function buildHydraRoomId(uuid: any, cluster: string): string;
-/**
- * Constructs a Hydra ID for an organization based on internal UUID
- *
- * @export
- * @param {any} uuid
- * @param {string} cluster containing the organization
- * @returns {string}
- */
-export function buildHydraOrgId(uuid: any, cluster: string): string;
-/**
- * Constructs a Hydra ID for an membership based on an
- * internal UUID for the person, and the space
- *
- * @export
- * @param {any} personUUID
- * @param {any} spaceUUID
- * @param {string} cluster containing the membership
- * @returns {string}
- */
-export function buildHydraMembershipId(personUUID: any, spaceUUID: any, cluster: string): string;
-/**
- * Returns a hydra cluster string based on a conversation url
- * @private
- * @memberof Messages
- * @param {Object} webex sdk instance
- * @param {String} conversationUrl url of space where activity took place
- * @returns {String} string suitable for UUID -> public ID encoding
- */
-export function getHydraClusterString(webex: any, conversationUrl: string): string;
-/**
- * Returns a Hydra roomType based on conversation tags
- *
- * @export
- * @param {arra} tags
- * @param {any} spaceUUID
- * @returns {string}
- */
-export function getHydraRoomType(tags: arra): string;
-/**
- * Returns file URLs for the activity, adhering to Hydra details,
- * e.g., https://api.ciscospark.com/v1/contents/Y2lzY29zcGF...
- * @see https://developer.webex.com/docs/api/v1/messages/get-message-details
- * @param {Object} activity from mercury
- * @param {string} cluster containing the files
- * @returns {Array} file URLs
- */
-export function getHydraFiles(activity: any, cluster: string): any[];
-export type DeconstructedHydraId = {
-    /**
-     * identifying the object
-     */
-    id: UUID;
-    /**
-     * of the object
-     */
-    type: string;
-    /**
-     * containing the object
-     */
-    cluster: string;
-};

package/dist/types/@webex/common/src/while-in-flight.d.ts

@@ -1,7 +0,0 @@
-/**
- * While the promise returned by the decorated is unfullfilled, sets, the
- * specified boolean on the target class to `true`
- * @param {string} param
- * @returns {Function}
- */
-export default function whileInFlight(param: string): Function;

package/dist/types/@webex/common/test/unit/spec/capped-debounce.d.ts

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

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

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

package/dist/types/@webex/common/test/unit/spec/exception.d.ts

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

package/dist/types/@webex/common/test/unit/spec/one-flight.d.ts

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

package/dist/types/@webex/common/test/unit/spec/template-container.d.ts

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

package/dist/types/@webex/common/test/unit/spec/while-in-flight.d.ts

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

package/dist/types/@webex/common-evented/src/index.d.ts

@@ -1,9 +0,0 @@
-/**
- * Given a class property, this decorator changes it into a setter/getter pair;
- * the setter will trigger `change:${prop}` when invoked
- * @param {Object} target
- * @param {string} prop
- * @param {Object} descriptor
- * @returns {undefined}
- */
-export default function evented(target: any, prop: string, descriptor: any): undefined;

package/dist/types/@webex/common-evented/test/unit/spec/evented.d.ts

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

package/dist/types/@webex/common-timers/src/index.d.ts

@@ -1,19 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-/**
- * Wrapper around setTimout which (in node) unrefs the returned timer to avoid
- * wedging the process open unexpectedly.
- * @param {Mixed} args
- * @protected
- * @returns {Timer|Number}
- */
-export function safeSetTimeout(...args: Mixed): Timer | number;
-/**
- * Wrapper around setTimout which (in node) unrefs the returned timer to avoid
- * wedging the process open unexpectedly.
- * @param {Mixed} args
- * @protected
- * @returns {Timer|Number}
- */
-export function safeSetInterval(...args: Mixed): Timer | number;

package/dist/types/@webex/helper-html/browsers.d.ts

@@ -1,2 +0,0 @@
-declare function _exports(browsers: any): any;
-export = _exports;

package/dist/types/@webex/helper-html/src/html-base.d.ts

@@ -1,12 +0,0 @@
-/**
- * Escapes HTML
- * @param {[type]} html
- * @returns {[type]}
- */
-export function escape(html: [type]): [type];
-/**
- * Synchronously escape HTML
- * @param {[type]} html
- * @returns {[type]}
- */
-export function escapeSync(html: [type]): [type];

package/dist/types/@webex/helper-html/src/html.d.ts

@@ -1,5 +0,0 @@
-export const filter: import("lodash").CurriedFunction1<any, string>;
-export const filterSync: import("lodash").CurriedFunction4<Function, any, string[], string, string>;
-export const filterEscape: import("lodash").CurriedFunction1<any, string>;
-export const filterEscapeSync: import("lodash").CurriedFunction4<Function, any, string[], string, string>;
-export { escape, escapeSync } from "./html-base";

package/dist/types/@webex/helper-html/src/html.shim.d.ts

@@ -1,33 +0,0 @@
-/**
- * Curried async HTML filter.
- * @param {Object} allowedTags Map of tagName -> array of allowed attributes
- * @param {Array<string>} allowedStyles Array of allowed styles
- * @param {string} html html to filter
- * @returns {string}
- */
-export const filter: import("lodash").CurriedFunction1<any, string>;
-/**
- * Curried HTML filter.
- * @param {Object} allowedTags Map of tagName -> array of allowed attributes
- * @param {Array<string>} allowedStyles Array of allowed styles
- * @param {string} html html to filter
- * @returns {string}
- */
-export const filterSync: import("lodash").CurriedFunction4<Function, any, string[], string, string>;
-/**
- * Curried HTML filter that escapes rather than removes disallowed tags
- * @param {Object} allowedTags Map of tagName -> array of allowed attributes
- * @param {Array<string>} allowedStyles Array of allowed styles
- * @param {string} html html to filter
- * @returns {Promise<string>}
- */
-export const filterEscape: import("lodash").CurriedFunction1<any, Promise<string>>;
-/**
- * Curried HTML filter that escapes rather than removes disallowed tags
- * @param {Object} allowedTags Map of tagName -> array of allowed attributes
- * @param {Array<string>} allowedStyles Array of allowed styles
- * @param {string} html html to filter
- * @returns {string}
- */
-export const filterEscapeSync: import("lodash").CurriedFunction4<Function, any, string[], string, string>;
-export { escape, escapeSync } from "./html-base";

package/dist/types/@webex/helper-html/src/index.d.ts

@@ -1 +0,0 @@
-export { escape, escapeSync, filter, filterSync, filterEscape, filterEscapeSync } from "./html";

package/dist/types/@webex/helper-html/test/unit/spec/html.d.ts

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

package/dist/types/@webex/helper-image/src/detect-filetype.d.ts

@@ -1,7 +0,0 @@
-/**
- * Determines the file type of the specified file
- * @param {FileLike} file
- * @param {Object} logger
- * @returns {Promise<string>}
- */
-export default function detectFileType(file: FileLike, logger: any): Promise<string>;

package/dist/types/@webex/helper-image/src/index.d.ts

@@ -1,26 +0,0 @@
-/**
- * Updates the image file with exif information, required to correctly rotate the image activity
- * @param {Object} file
- * @param {Object} options
- * @param {boolean} options.shouldNotAddExifData
- * @returns {Promise<Object>}
- */
-export function updateImageOrientation(file: any, options?: {
-    shouldNotAddExifData: boolean;
-}): Promise<any>;
-/**
- * Adds exif orientation information on the image file
- * @param {Object} file
- * @param {Object} buf
- * @returns {Promise<ExifImage>}
- */
-export function readExifData(file: any, buf: any): Promise<ExifImage>;
-/**
- * Rotates/flips the image on the canvas as per exif information
- * @param {Object} options(orientation: image exif orientation range from 1-8, img: Image object, x: start x-axis, y: start y-axis, width: width of the thumbnail, height: height of the thumbnail, ctx: canvas context)
- * @param {Object} file
- * @returns {Object}
- */
-export function orient(options: any, file: any): any;
-export { default as processImage } from "./process-image";
-export { default as detectFileType } from "./detect-filetype";

package/dist/types/@webex/helper-image/src/process-image.browser.d.ts

@@ -1,19 +0,0 @@
-/**
- * Measures an image file and produces a thumbnail for it
- * @param {Object} options
- * @param {Blob|ArrayBuffer} options.file
- * @param {Number} options.thumbnailMaxWidth
- * @param {Number} options.thumbnailMaxHeight
- * @param {Boolean} options.enableThumbnails
- * @param {Object} options.logger
- * @param {Boolean} options.isAvatar
- * @returns {Promise<Array>} Buffer, Dimensions, thumbnailDimensions
- */
-export default function processImage({ file, type, thumbnailMaxWidth, thumbnailMaxHeight, enableThumbnails, logger, isAvatar, }: {
-    file: Blob | ArrayBuffer;
-    thumbnailMaxWidth: number;
-    thumbnailMaxHeight: number;
-    enableThumbnails: boolean;
-    logger: any;
-    isAvatar: boolean;
-}): Promise<any[]>;

package/dist/types/@webex/helper-image/src/process-image.d.ts

@@ -1,17 +0,0 @@
-/**
- * Measures an image file and produces a thumbnail for it
- * @param {Object} options
- * @param {Blob|ArrayBuffer} options.file
- * @param {Number} options.thumbnailMaxWidth
- * @param {Number} options.thumbnailMaxHeight
- * @param {Boolean} options.enableThumbnails
- * @param {Object} options.logger
- * @returns {Promise<Array>} Buffer, Dimensions, thumbnailDimensions
- */
-export default function processImage({ file, type, thumbnailMaxWidth, thumbnailMaxHeight, enableThumbnails, logger, }: {
-    file: Blob | ArrayBuffer;
-    thumbnailMaxWidth: number;
-    thumbnailMaxHeight: number;
-    enableThumbnails: boolean;
-    logger: any;
-}): Promise<any[]>;

package/dist/types/@webex/helper-image/test/unit/spec/index.d.ts

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

package/dist/types/@webex/http-core/src/http-error-subtypes.d.ts

@@ -1,8 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-/**
- * @param {Error} Base
- * @returns {undefined}
- */
-export default function makeSubTypes(Base: Error): undefined;

package/dist/types/@webex/http-core/src/http-error.d.ts

@@ -1,41 +0,0 @@
-/**
- * Base HttpError class. Unlikely to be thrown directly, but handy for general
- * type comparison.
- */
-declare class HttpError {
-    /**
-     * @example Extend via
-     * MyError extends HttpError {
-     *  static errorKeys = HttpError.errorKeys.concat([
-     *    `key1`,
-     *    `key2`
-     *  ])
-     * }
-     *
-     * @type {Array}
-     */
-    static errorKeys: any[];
-    /**
-     * Default error string if no error can be extracted from the http response
-     * @type {string}
-     */
-    static defaultMessage: string;
-    /**
-     * Parses HttpResponse objects for useful information (status, headers, etc)
-     * as well as attempting to extract a useful error message.
-     * @param {HttpResponse} res
-     * @returns {string}
-     */
-    parse(res: HttpResponse): string;
-    /**
-     * Recursively parses an error body looking for a likely error candidate
-     * @param {object} body
-     * @returns {string}
-     */
-    parseObject(body: object): string;
-}
-declare namespace HttpError {
-    export { makeSubTypes };
-}
-export default HttpError;
-import makeSubTypes from "./http-error-subtypes";

package/dist/types/@webex/http-core/src/index.d.ts

@@ -1,7 +0,0 @@
-export const defaults: import("lodash").CurriedFunction1<any, Promise<any>>;
-export const request: Promise<any>;
-export { default as ProgressEvent } from "./progress-event";
-export { default as Interceptor } from "./lib/interceptor";
-export { default as HttpError } from "./http-error";
-export { default as HttpStatusInterceptor } from "./interceptors/http-status";
-export { default as detect } from "./lib/detect";

package/dist/types/@webex/http-core/src/interceptors/http-status.d.ts

@@ -1,17 +0,0 @@
-/**
- * @class
- */
-export default class HttpStatusInterceptor extends Interceptor {
-    /**
-     * @param {Object} options
-     * @returns {HttpStatusInterceptor}
-     */
-    static create(options: any): HttpStatusInterceptor;
-    /**
-     * @param {Object} webex
-     * @param {Object} options
-     * @returns {HttpStatusInterceptor}
-     */
-    constructor(webex: any, options: any);
-}
-import Interceptor from "../lib/interceptor";

package/dist/types/@webex/http-core/src/lib/detect.d.ts

@@ -1,6 +0,0 @@
-/**
- * Determine mimeType for the specified buffer;
- * @param {Buffer|Uint8Array|ArrayBuffer} buffer
- * @returns {Promise<string>}
- */
-export default function detect(buffer: Buffer | Uint8Array | ArrayBuffer): Promise<string>;

package/dist/types/@webex/http-core/src/lib/interceptor.d.ts

@@ -1,51 +0,0 @@
-/**
- * @class
- */
-export default class Interceptor {
-    /**
-     * @abstract
-     * @returns {Interceptor}
-     */
-    static create(): Interceptor;
-    /**
-     * @constructor
-     * @param {Object} attrs
-     * @returns {UrlInterceptor}
-     */
-    constructor(attrs: any);
-    /**
-     * Logs the options of a request. This should be utilized
-     * during the intercepting process, but can be used at any
-     * time otherwise.
-     * @param {object} options
-     * @returns {void}
-     */
-    logOptions(options?: object): void;
-    /**
-     * Transform request options before sending them
-     * @param {Object} options
-     * @returns {Promise<Object>}
-     */
-    onRequest(options: any): Promise<any>;
-    /**
-     * Handle request failures
-     * @param {Object} options
-     * @param {Error} reason
-     * @returns {RejectedPromise<Error>}
-     */
-    onRequestError(options: any, reason: Error): RejectedPromise<Error>;
-    /**
-     * Transform response before returning it
-     * @param {Object} options
-     * @param {HttpResponse} response
-     * @returns {Promise<HttpResponse>}
-     */
-    onResponse(options: any, response: HttpResponse): Promise<HttpResponse>;
-    /**
-     * Handle response errors
-     * @param {Object} options
-     * @param {WebexHttpError} reason
-     * @returns {Promise<WebexHttpError>}
-     */
-    onResponseError(options: any, reason: WebexHttpError): Promise<WebexHttpError>;
-}

package/dist/types/@webex/http-core/src/lib/xhr.d.ts

@@ -1,6 +0,0 @@
-export default createXHR;
-declare function createXHR(uri: any, options: any, callback: any): any;
-declare namespace createXHR {
-    const XMLHttpRequest: any;
-    const XDomainRequest: any;
-}

package/dist/types/@webex/http-core/src/progress-event.d.ts

@@ -1,18 +0,0 @@
-/**
- * Object of the same shape as web browser ProgressEvents
- * @class ProgressEvent
- * @param {integer} loaded
- * @param {integer} total
- * @returns {ProgressEvent}
- */
-export default function ProgressEvent(loaded: integer, total: integer): ProgressEvent;
-export default class ProgressEvent {
-    /**
-     * Object of the same shape as web browser ProgressEvents
-     * @class ProgressEvent
-     * @param {integer} loaded
-     * @param {integer} total
-     * @returns {ProgressEvent}
-     */
-    constructor(loaded: integer, total: integer);
-}

package/dist/types/@webex/http-core/src/request/index.d.ts

@@ -1,5 +0,0 @@
-/**
- * @param {Object} options
- * @returns {Promise}
- */
-export default function request(options: any): Promise<any>;

package/dist/types/@webex/http-core/src/request/request.d.ts

@@ -1,6 +0,0 @@
-/**
- * @name request
- * @param {Object} options
- * @returns {Promise}
- */
-export default function _request(options: any): Promise<any>;

package/dist/types/@webex/http-core/src/request/request.shim.d.ts

@@ -1,6 +0,0 @@
-/**
- * @name request
- * @param {Object} options
- * @returns {Promise}
- */
-export default function _request(options: any): Promise<any>;

package/dist/types/@webex/http-core/test/integration/spec/http-error.d.ts

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

package/dist/types/@webex/http-core/test/integration/spec/interceptor.d.ts

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

package/dist/types/@webex/http-core/test/integration/spec/progress-event.d.ts

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

package/dist/types/@webex/http-core/test/integration/spec/request.d.ts

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

package/dist/types/@webex/http-core/test/unit/spec/interceptors/http-status.d.ts

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

package/dist/types/@webex/internal-plugin-avatar/src/avatar-url-batcher.d.ts

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

package/dist/types/@webex/internal-plugin-avatar/src/avatar-url-store.d.ts

@@ -1,50 +0,0 @@
-/**
- * @class AvatarUrlStore
- */
-export default class AvatarUrlStore {
-    /**
-     * Get the URL associated with the given uuid and size.
-     *
-     * @param {object} item
-     * @param {string} item.uuid A user uuid
-     * @param {integer}item.size the requested size
-     * @returns {Promise<object>} Resolves to the avatar item {uuid, url, size, cacheControl}
-     *                           or Rejects on bad param, not in store
-     *
-     * @memberOf AvatarUrlStore
-     */
-    get(item: {
-        uuid: string;
-        size: integer;
-    }): Promise<object>;
-    /**
-     * Adds the given item to the store
-     * @param {Object} item
-     * @param {integer} item.cacheControl
-     * @param {integer} item.hasDefaultAvatar
-     * @param {integer} item.size
-     * @param {string} item.url
-     * @param {string} item.uuid
-     * @returns {Promise<object>} Resolves to the added avatar item or rejects on bad params
-     */
-    add(item: {
-        cacheControl: integer;
-        hasDefaultAvatar: integer;
-        size: integer;
-        url: string;
-        uuid: string;
-    }): Promise<object>;
-    /**
-     * Remove the URL associated with the uuid and size
-     * Remove urls of all sizes if size is not given
-     *
-     * @param {object} item
-     * @param {string} item.uuid The user unique id
-     * @param {integer} item.size The size of the avatar to remove
-     * @returns {Promise<true>}
-     */
-    remove(item: {
-        uuid: string;
-        size: integer;
-    }): Promise<true>;
-}

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

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

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

@@ -1,13 +0,0 @@
-declare namespace _default {
-    namespace avatar {
-        const batcherWait: number;
-        const batcherMaxCalls: number;
-        const batcherMaxWait: number;
-        const cacheControl: number;
-        const defaultAvatarSize: number;
-        const sizes: number[];
-        const thumbnailMaxHeight: number;
-        const thumbnailMaxWidth: number;
-    }
-}
-export default _default;

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

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