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

package/dist/types/@webex/common/src/constants.d.ts

@@ -0,0 +1,76 @@
+export namespace SDK_EVENT {
+    namespace INTERNAL {
+        const WEBEX_ACTIVITY: string;
+        namespace ACTIVITY_FIELD {
+            const ACTOR: string;
+            const OBJECT: string;
+            const TARGET: string;
+        }
+        namespace ACTIVITY_VERB {
+            const ACKNOWLEDGE: string;
+            const CARD_ACTION: string;
+            const CREATE: string;
+            const POST: string;
+            const SHARE: string;
+            const DELETE: string;
+            const ADD: string;
+            const LEAVE: string;
+            const ADD_MODERATOR: string;
+            const REMOVE_MODERATOR: string;
+            const LOCK: string;
+            const UNLOCK: string;
+            const HIDE: string;
+            const UPDATE: string;
+        }
+        namespace ACTIVITY_TAG {
+            const HIDDEN: string;
+            const ONE_ON_ONE: string;
+            const LOCKED: string;
+        }
+    }
+    namespace EXTERNAL {
+        namespace EVENT_TYPE {
+            const CREATED: string;
+            const DELETED: string;
+            const UPDATED: string;
+            const SEEN: string;
+        }
+        namespace OWNER {
+            const CREATOR: string;
+            const ORG: string;
+        }
+        namespace STATUS {
+            const ACTIVE: string;
+            const DISABLED: string;
+        }
+        namespace SPACE_TYPE {
+            const DIRECT: string;
+            const GROUP: string;
+        }
+        namespace RESOURCE {
+            const ATTACHMENT_ACTIONS: string;
+            const MEMBERSHIPS: string;
+            const MESSAGES: string;
+            const ROOMS: string;
+        }
+        namespace ATTACHMENTS {
+            const CARD_CONTENT_TYPE: string;
+        }
+    }
+}
+export namespace hydraTypes {
+    const ATTACHMENT_ACTION: string;
+    const CONTENT: string;
+    const MEMBERSHIP: string;
+    const MESSAGE: string;
+    const ORGANIZATION: string;
+    const PEOPLE: string;
+    const ROOM: string;
+    const TEAM: string;
+}
+export namespace deviceType {
+    const PROVISIONAL: string;
+    const WEB: string;
+}
+export const INTERNAL_US_CLUSTER_NAME: "urn:TEAM:us-east-2_a";
+export const INTERNAL_US_INTEGRATION_CLUSTER_NAME: "urn:TEAM:us-east-1_int13";

package/dist/types/@webex/common/src/defer.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+/**
+ * Creates a new `Defer`red object,
+ * @returns {Defer}
+ */
+export default function Defer(): Defer;
+export default class Defer {
+    promise: Promise<any>;
+    /**
+     * @instance
+     * @memberof Defer
+     * @type {function}
+     */
+    resolve: Function;
+    /**
+     * @instance
+     * @memberof Defer
+     * @type {function}
+     */
+    reject: Function;
+}

package/dist/types/@webex/common/src/deprecated.d.ts

@@ -0,0 +1,7 @@
+export default exportedDeprecated;
+declare const exportedDeprecated: import("core-decorators").Deprecate | typeof emptyDecorator;
+/**
+ * @private
+ * @returns {function}
+ */
+declare function emptyDecorator(): Function;

package/dist/types/@webex/common/src/event-envelope.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Creates a 'webhook' envelope to wrap Webex events in
+ * @param {object} webex - sdk object
+ * @param {string} resource - resource to create an envelope for
+ * @returns {object} - Returns a promise of an event envelope object
+ */
+export function createEventEnvelope(webex: object, resource: string): object;
+/**
+ * Stores SDK users info in the sdk object if it doesn't already exist
+ * @param {object} webex - sdk object
+ * @returns {Promise} - Returns a promise that user info will be available
+ */
+export function ensureMyIdIsAvailable(webex: object): Promise<any>;

package/dist/types/@webex/common/src/events.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Proxies the event binding methods of emitter onto proxy
+ * @param {EventEmitter|EventEmitterProxy} emitter
+ * @param {mixed} proxy (probably a promise)
+ * @returns {EventEmitter} Returns the source emitter to ease use in promise chains
+ */
+export function proxyEvents(emitter: EventEmitter | EventEmitterProxy, proxy: mixed): EventEmitter;
+/**
+ * Given a list of events, fires them on drain when they're emitted from source
+ * @param {Array|string} events
+ * @param {EventEmitter} source
+ * @param {EventEmitter} drain
+ * @returns {undefined}
+ */
+export function transferEvents(events: any[] | string, source: EventEmitter, drain: EventEmitter): undefined;

package/dist/types/@webex/common/src/exception.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+/**
+ * Base Exception class
+ */
+export default class Exception extends Error {
+    static defaultMessage: string;
+    /**
+     * Generates the value assigned to `this.message`. You'll probably want to
+     * override this in your custom Exception
+     * @param {mixed} args
+     * @returns {string}
+     */
+    static parse(...args: mixed): string;
+    /**
+     * constructor
+     * @param {mixed} args
+     * @returns {Exception}
+     */
+    constructor(...args: mixed);
+    message: any;
+}

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

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

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

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

package/dist/types/@webex/common/src/in-browser/node.d.ts

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

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

@@ -0,0 +1,21 @@
+export { default as base64 } from "./base64";
+export { default as isBuffer } from "./isBuffer";
+export { default as cappedDebounce } from "./capped-debounce";
+export { default as checkRequired } from "./check-required";
+export { default as Defer } from "./defer";
+export { default as makeStateDataType } from "./make-state-datatype";
+export { default as make } from "./template-container";
+export { default as oneFlight } from "./one-flight";
+export { default as patterns } from "./patterns";
+export { default as resolveWith } from "./resolve-with";
+export { default as retry } from "./retry";
+export { default as tap } from "./tap";
+export { default as whileInFlight } from "./while-in-flight";
+export { default as Exception } from "./exception";
+export { default as deprecated } from "./deprecated";
+export { default as inBrowser } from "./in-browser";
+export { default as BrowserDetection } from "./browser-detection";
+export { proxyEvents, transferEvents } from "./events";
+export { createEventEnvelope, ensureMyIdIsAvailable } from "./event-envelope";
+export { deviceType, hydraTypes, SDK_EVENT, INTERNAL_US_CLUSTER_NAME, INTERNAL_US_INTEGRATION_CLUSTER_NAME } from "./constants";
+export { buildHydraMembershipId, buildHydraMessageId, buildHydraOrgId, buildHydraPersonId, buildHydraRoomId, getHydraRoomType, getHydraClusterString, getHydraFiles, constructHydraId, deconstructHydraId } from "./uuid-utils";

package/dist/types/@webex/common/src/isBuffer.d.ts

@@ -0,0 +1,2 @@
+declare function _default(buffer: buffer): boolean;
+export default _default;

package/dist/types/@webex/common/src/make-state-datatype.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+/**
+ * Creates an ampersand state object that wires its event handlers like a an
+ * ampersand child
+ * @param {Function} Constructor
+ * @param {string} name
+ * @returns {Object}
+ */
+export default function makeStateDataType(Constructor: Function, name: string): any;

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

@@ -0,0 +1,9 @@
+/**
+ * @memberof Util
+ * @param {Object} options
+ * @param {Function} options.keyFactory
+ * @param {boolean} options.cacheFailures
+ * @param {boolean} options.cacheSuccesses
+ * @returns {Function}
+ */
+export default function oneFlight(...params: any[]): Function;

package/dist/types/@webex/common/src/patterns.d.ts

@@ -0,0 +1,8 @@
+declare namespace _default {
+    const email: RegExp;
+    const containsEmails: RegExp;
+    const uuid: RegExp;
+    const execEmail: RegExp;
+    const execUuid: RegExp;
+}
+export default _default;

package/dist/types/@webex/common/src/resolve-with.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+/**
+ * Sugar method for returning the desired object at the end of a promise chain
+ * @param {any} object the item with which to resolve the promise chain
+ * @returns {function}
+ * @example
+ * var item = {
+ *   prop: 2
+ * };
+ * Promise
+ *  .resolve(item.prop)
+ *  .then(resolveWith(item))
+ *  .then(function(res) {
+ *    require('assert').deepEqual(res, {prop:2});
+ *    return 'success'
+ *  })
+ *  // => success
+ *
+ */
+export default function resolveWith(object: any): Function;

package/dist/types/@webex/common/src/retry.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Makes a promise-returning method retryable according to the specified backoff
+ * pattern
+ * @param {Object} options
+ * @param {boolean} options.backoff
+ * @param {number} options.delay
+ * @param {number} options.initialDelay
+ * @param {number} options.maxAttempts
+ * @param {number} options.maxDelay
+ *
+ * @returns {Function}
+ */
+export default function retry(...params: any[]): Function;

package/dist/types/@webex/common/src/tap.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+/**
+ * Injects code into a promise chain without modifying the promise chain's result
+ * @param {Function} fn
+ * @returns {Promise}
+ * @example
+ * function f() {
+ *   return Promise.resolve(5);
+ * }
+ *
+ * f()
+ *   .then(tap(() => 12))
+ *   // => 5
+ */
+export default function tap(fn: Function): Promise<any>;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,19 @@
+/**
+ * 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[]>;