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

package/dist/types/events.d.ts

@@ -1,15 +0,0 @@
-/**
- * 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/exception.d.ts

@@ -1,23 +0,0 @@
-/*!
- * 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/in-browser/browser.d.ts

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

package/dist/types/in-browser/index.d.ts

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

package/dist/types/in-browser/node.d.ts

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

package/dist/types/index.d.ts

@@ -1,21 +0,0 @@
-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/isBuffer.d.ts

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

package/dist/types/make-state-datatype.d.ts

@@ -1,11 +0,0 @@
-/*!
- * 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/one-flight.d.ts

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

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

package/dist/types/resolve-with.d.ts

@@ -1,22 +0,0 @@
-/*!
- * 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/retry.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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/tap.d.ts

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