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

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

@@ -0,0 +1,17 @@
+/**
+ * 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

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

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

@@ -0,0 +1,8 @@
+/*!
+ * 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

@@ -0,0 +1,41 @@
+/**
+ * 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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,17 @@
+/**
+ * @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

@@ -0,0 +1,6 @@
+/**
+ * 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

@@ -0,0 +1,51 @@
+/**
+ * @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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,18 @@
+/**
+ * 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

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

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

@@ -0,0 +1,6 @@
+/**
+ * @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

@@ -0,0 +1,6 @@
+/**
+ * @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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,50 @@
+/**
+ * @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

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

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

@@ -0,0 +1,13 @@
+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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,11 @@
+declare namespace _default {
+    namespace board {
+        const numberContentsPerPageForAdd: number;
+        const numberContentsPerPageForGet: number;
+        const pingInterval: number;
+        const pongTimeout: number;
+        const forceCloseDelay: [type];
+        const mercuryBindingPrefix: string;
+    }
+}
+export default _default;

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

@@ -0,0 +1,4 @@
+export { default } from "./board";
+import config from "./config";
+import RealtimeChannel from "./realtime-channel";
+export { config, RealtimeChannel };

package/dist/types/@webex/internal-plugin-board/src/realtime-channel-collection.d.ts

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

package/dist/types/@webex/internal-plugin-board/src/realtime-channel.d.ts

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

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

@@ -0,0 +1,7 @@
+export default RealtimeService;
+/**
+ * @class
+ * @extends {Mercury}
+ * @memberof Board
+ */
+declare const RealtimeService: any;

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

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

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

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

package/dist/types/@webex/internal-plugin-board/test/integration/spec/sharing-mercury.d.ts

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,58 @@
+export default CalendarCollection;
+declare namespace CalendarCollection {
+    export { CALENDAR as namespace };
+    export const items: {};
+    /**
+     * @param {String} id calendar ID
+     * @returns {Any} Calendar Item specifc to that id
+     * @private
+     * @memberof CalendarCollection
+     */
+    export function get(id: string): Any;
+    /**
+     * @param {String} key any key and the corresponding calendar Item
+     * @param {String} value any values corresponding to calendar item
+     * @returns {Any} returns whatever is being stuffed into the collection
+     * @private
+     * @memberof CalendarCollection
+     */
+    export function getBy(key: string, value: string): Any;
+    /**
+     * @param {Object} item CalendarObject passed to the collection
+     * @returns {Any} returns calender id whats get set
+     * @private
+     * @memberof CalendarCollection
+     */
+    export function set(item: any): Any;
+    /**
+     * resets all the values in the calendarcollection
+     * @returns {undefined}
+     * @private
+     * @memberof CalendarCollection
+     */
+    export function reset(): undefined;
+    /**
+     * @param {Id} id is the id for the calendar item to be removed
+     * @returns {Any} calendar item which got removed
+     * @private
+     * @memberof CalendarCollection
+     */
+    export function remove(id: Id): Any;
+    /**
+     * sets all the item passed to the collection
+     * @param {Array} items array of calendar items
+     * @private
+     * @returns {undefined}
+     * @memberof CalendarCollection
+     */
+    export function setAll(items: any[]): undefined;
+    /**
+     * gets all the calendar stored in the collection
+     * @param {Array} items array of calendar items
+     * @private
+     * @returns {Array} returns an array of calendar items
+     * @memberof CalendarCollection
+     */
+    export function getAll(): any[];
+}
+import { CALENDAR } from "./constants";

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

@@ -0,0 +1,7 @@
+declare namespace _default {
+    namespace calendar {
+        const fromDate: Date;
+        const toDate: Date;
+    }
+}
+export default _default;

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

@@ -0,0 +1,6 @@
+export const CALENDAR_REGISTERED: "calendar:registered";
+export const CALENDAR_UNREGISTERED: "calendar:unregistered";
+export const CALENDAR_UPDATED: "calendar:update";
+export const CALENDAR_DELETE: "calendar:delete";
+export const CALENDAR_CREATE: "calendar:create";
+export const CALENDAR: "CALENDAR";

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

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

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

@@ -0,0 +1,15 @@
+export default CalendarUtil;
+declare namespace CalendarUtil {
+    /**
+     * calculates the end time for meeting
+     * @param {Object} item the locus.host property
+     * @param {Object} item.start start time of the meeting
+     * @param {Object} item.duration duration of the meeting
+     * @returns {Object} end time of the meeting
+     * @memberof CalendarUtil
+     */
+    function calculateEndTime(item: {
+        start: any;
+        duration: any;
+    }): any;
+}

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

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

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

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

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

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

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

@@ -0,0 +1,32 @@
+export const OLDER: "older";
+export const NEWER: "newer";
+export const MID: "mid";
+export const INITIAL: "initial";
+export namespace ACTIVITY_TYPES {
+    const REPLY: string;
+    const EDIT: string;
+    const REACTION: string;
+    const REACTION_SELF: string;
+    const ROOT: string;
+    const CREATE: string;
+    const TOMBSTONE: string;
+    const DELETE: string;
+    const REPLY_EDIT: string;
+}
+export function getActivityType(activity: any): string;
+export function getPublishedDate(activity?: {}): number;
+export function isNewer(activity1: any, activity2: any): boolean;
+export function sortActivitiesByPublishedDate(activities: any): any[];
+export function getParentId(activity: any): any;
+export function isRootActivity(act: any): boolean;
+export function isReplyActivity(act: any): boolean;
+export function isEditActivity(act: any): boolean;
+export function isCreateActivity(act: any): boolean;
+export function isDeleteActivity(act: any): boolean;
+export function sanitizeActivity(activity: any): any;
+export function getIsActivityOrphaned(activity: any, activities: any): boolean;
+export function determineActivityType(activity: any, activities: any): string;
+export function createRootActivity(activity: any): any;
+export function createReplyActivity(activity: any): any;
+export function createEditActivity(editActivity: any, activities: any): any;
+export function createReplyEditActivity(editActivity: any, activities: any): any;

package/dist/types/@webex/internal-plugin-conversation/src/activity-thread-ordering.d.ts

@@ -0,0 +1,18 @@
+export const defaultMinDisplayableActivities: 20;
+export const minBatchSize: 10;
+export const fetchLoopCountMax: 100;
+export const batchSizeIncrementCount: 10;
+export function setValue(destination: Map<any, any>, key: string, value: any): Map<any, any>;
+export function getValue(source: Map<any, any>, key: string): Map<any, any>;
+export function getActivityObjectsFromMap(hashMap: any): any[];
+export function activityManager(): object;
+export function bookendManager(): object;
+export function noMoreActivitiesManager(): object;
+export function rootActivityManager(): object;
+export function getLoopCounterFailsafe(): () => void;
+export function getQuery(type: string, queryOptions: {
+    newestPublishedDate?: string;
+    oldestPublishedDate?: string;
+    batchSize?: number;
+    activityToSearch?: object;
+}): object;

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

@@ -0,0 +1,19 @@
+declare namespace _default {
+    namespace conversation {
+        const allowedInboundTags: {
+            'webex-mention': string[];
+        };
+        const allowedOutboundTags: {
+            'webex-mention': string[];
+        };
+        function inboundProcessFunc(): void;
+        function outboundProcessFunc(): void;
+        const allowedInboundStyles: any[];
+        const allowedOutboundStyles: any[];
+        const thumbnailMaxHeight: number;
+        const thumbnailMaxWidth: number;
+        const keepEncryptedProperties: boolean;
+        const decryptionFailureMessage: string;
+    }
+}
+export default _default;

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

@@ -0,0 +1,5 @@
+export const KEY_ROTATION_REQUIRED: 1400087;
+export const KEY_ALREADY_ROTATED: 1409004;
+export const ENCRYPTION_KEY_URL_MISMATCH: 1400049;
+export const DEFAULT_CLUSTER: "urn:TEAM:us-east-2_a";
+export const DEFAULT_CLUSTER_SERVICE: "identityLookup";

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

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

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

@@ -0,0 +1,10 @@
+/**
+ * General conversation error
+ */
+export class ConversationError {
+}
+/**
+ * InvalidUserCreation thrown when failed to create conversation with invalid user
+ */
+export class InvalidUserCreation extends ConversationError {
+}

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

@@ -0,0 +1 @@
+export const transforms: any[];

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

@@ -0,0 +1 @@
+export const transforms: any[];

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

@@ -0,0 +1,3 @@
+export { default } from "./conversation";
+export { default as ShareActivity } from "./share-activity";
+export { ConversationError, InvalidUserCreation } from "./convo-error";

package/dist/types/@webex/internal-plugin-conversation/src/share-activity.d.ts

@@ -0,0 +1,7 @@
+export const EMITTER_SYMBOL: unique symbol;
+export const FILE_SYMBOL: unique symbol;
+export default ShareActivity;
+/**
+ * @class
+ */
+declare const ShareActivity: any;

package/dist/types/@webex/internal-plugin-conversation/src/to-array.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Helper to convert objects into arrays of transforms. probably belongs in
+ * webex-core
+ * @param {string} direction "inbound"|"outbound"
+ * @param {Object} obj
+ * @private
+ * @returns {Array}
+ */
+export default function toArray(direction: string, obj: any): any[];

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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