@webex/jsdoctrinetest 3.0.0-beta.9 → 3.0.0-bnr.2

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

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

package/dist/types/@webex/internal-plugin-locus/src/event-keys.d.ts

@@ -0,0 +1,5 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+export const locusEventKeys: string[];
+export default locusEventKeys;

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

@@ -0,0 +1,4 @@
+export default Locus;
+export { locusEventKeys as eventKeys } from "./event-keys";
+import Locus from "./locus";
+export { USE_INCOMING, USE_CURRENT, EQUAL, FETCH, GREATER_THAN, LESS_THAN, DESYNC } from "./locus";

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

@@ -0,0 +1,12 @@
+export const USE_INCOMING: "USE_INCOMING";
+export const USE_CURRENT: "USE_CURRENT";
+export const EQUAL: "EQUAL";
+export const FETCH: "FETCH";
+export const GREATER_THAN: "GREATER_THAN";
+export const LESS_THAN: "LESS_THAN";
+export const DESYNC: "DESYNC";
+export default Locus;
+/**
+ * @class
+ */
+declare const Locus: any;

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

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

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

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

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

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

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

@@ -0,0 +1,3 @@
+export { default } from "./lyra";
+export { config };
+import config from "./config";

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,10 @@
+declare namespace _default {
+    namespace mercury {
+        const pingInterval: number;
+        const pongTimeout: number;
+        const backoffTimeMax: number;
+        const backoffTimeReset: number;
+        const forceCloseDelay: [type];
+    }
+}
+export default _default;

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

@@ -0,0 +1,31 @@
+/**
+ * Exception thrown when a websocket gets closed
+ */
+export class ConnectionError {
+    static defaultMessage: string;
+    /**
+     * @param {CloseEvent} event
+     * @returns {string}
+     */
+    parse(event?: CloseEvent): string;
+}
+/**
+ * thrown for CloseCode 4400
+ */
+export class UnknownResponse extends ConnectionError {
+}
+/**
+ * thrown for CloseCode 4400
+ */
+export class BadRequest extends ConnectionError {
+}
+/**
+ * thrown for CloseCode 4401
+ */
+export class NotAuthorized extends ConnectionError {
+}
+/**
+ * thrown for CloseCode 4403
+ */
+export class Forbidden extends ConnectionError {
+}

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

@@ -0,0 +1,4 @@
+export { default as Socket } from "./socket";
+export { default as config } from "./config";
+export { default, default as Mercury } from "./mercury";
+export { BadRequest, ConnectionError, Forbidden, NotAuthorized, UnknownResponse } from "./errors";

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

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

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

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

package/dist/types/@webex/internal-plugin-mercury/src/socket/socket-base.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Generalized socket abstraction
+ */
+export default class Socket extends EventEmitter {
+    /**
+     * Provides the environmentally appropriate constructor (ws in NodeJS,
+     * WebSocket in browsers)
+     * @returns {WebSocket}
+     */
+    static getWebSocketConstructor(): WebSocket;
+    /**
+     * constructor
+     * @returns {Socket}
+     */
+    constructor();
+    /**
+     * Handles incoming message events
+     * @param {MessageEvent} event
+     * @returns {undefined}
+     */
+    onmessage(event: MessageEvent): undefined;
+    /**
+     * Handles incoming CloseEvents
+     * @param {CloseEvent} event
+     * @returns {undefined}
+     */
+    onclose(event: CloseEvent): undefined;
+    /**
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
+     * @returns {string}
+     */
+    get binaryType(): string;
+    /**
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
+     * @returns {number}
+     */
+    get bufferedAmount(): number;
+    /**
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
+     * @returns {string}
+     */
+    get extensions(): string;
+    /**
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
+     * @returns {string}
+     */
+    get protocol(): string;
+    /**
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
+     * @returns {number}
+     */
+    get readyState(): number;
+    /**
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
+     * @returns {string}
+     */
+    get url(): string;
+    /**
+     * Closes the socket
+     * @param {Object} options
+     * @param {string} options.reason
+     * @param {number} options.code
+     * @returns {Promise}
+     */
+    close(options: {
+        reason: string;
+        code: number;
+    }): Promise<any>;
+    /**
+     * Opens a WebSocket
+     * @param {string} url
+     * @param {options} options
+     * @param {number} options.forceCloseDelay (required)
+     * @param {number} options.pingInterval (required)
+     * @param {number} options.pongTimeout (required)
+     * @param {string} options.token (required)
+     * @param {string} options.trackingId (required)
+     * @param {Logger} options.logger (required)
+     * @param {string} options.logLevelToken
+     * @returns {Promise}
+     */
+    open(url: string, options: any): Promise<any>;
+    expectedSequenceNumber: any;
+    /**
+     * Sends a message up the socket
+     * @param {mixed} data
+     * @returns {Promise}
+     */
+    send(data: mixed): Promise<any>;
+    /**
+     * Sends an acknowledgment for a specific event
+     * @param {MessageEvent} event
+     * @returns {Promise}
+     */
+    _acknowledge(event: MessageEvent): Promise<any>;
+    /**
+     * Sends an auth message up the socket
+     * @private
+     * @returns {Promise}
+     */
+    private _authorize;
+    /**
+     * Deals with the fact that some browsers drop some close codes (but not
+     * close reasons).
+     * @param {CloseEvent} event
+     * @private
+     * @returns {CloseEvent}
+     */
+    private _fixCloseCode;
+    /**
+     * Sends a ping up the socket and confirms we get it back
+     * @param {[type]} id
+     * @private
+     * @returns {[type]}
+     */
+    private _ping;
+    pingTimer: any;
+    pongTimer: any;
+}
+import { EventEmitter } from "events";

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

@@ -0,0 +1,2 @@
+export default Socket;
+import Socket from "./socket-base";

package/dist/types/@webex/internal-plugin-mercury/src/socket/socket.shim.d.ts

@@ -0,0 +1,2 @@
+export default Socket;
+import Socket from "./socket-base";

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

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

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

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

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

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

package/dist/types/@webex/internal-plugin-mercury/test/unit/lib/promise-tick.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+/**
+ * Uses Promise#then to run some number of ticks
+ * @param {number} count
+ * @returns {Promise}
+ */
+export default function promiseTick(count: number): Promise<any>;

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

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

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

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

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

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

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

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

package/dist/types/@webex/internal-plugin-metrics/src/call-diagnostic-events-batcher.d.ts

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

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

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

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

@@ -0,0 +1,18 @@
+export const CLIENT_NAME: "webex-js-sdk";
+declare namespace _default {
+    export namespace device {
+        namespace preDiscoveryServices {
+            const metricsServiceUrl: string;
+            const metrics: string;
+        }
+    }
+    export namespace metrics_1 {
+        const appType: string;
+        const batcherWait: number;
+        const batcherMaxCalls: number;
+        const batcherMaxWait: number;
+        const batcherRetryPlateau: number;
+    }
+    export { metrics_1 as metrics };
+}
+export default _default;

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

@@ -0,0 +1,3 @@
+export { default } from "./metrics";
+export { config };
+import config from "./config";

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

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

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

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

package/dist/types/@webex/internal-plugin-metrics/test/unit/spec/call-diagnostic-events-batcher.d.ts

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

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

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

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

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

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

@@ -0,0 +1,8 @@
+declare namespace _default {
+    namespace presence {
+        const batcherWait: number;
+        const batcherMaxCalls: number;
+        const batcherMaxWait: number;
+    }
+}
+export default _default;

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

@@ -0,0 +1,14 @@
+export const GROUNDSKEEPER_INTERVAL: number;
+export const FETCH_DELAY: 300;
+export const UPDATE_PRESENCE_DELAY: number;
+export const EXPIRED_PRESENCE_TIME: number;
+export const SUBSCRIPTION_DELAY: number;
+export const PREMATURE_EXPIRATION_SUBSCRIPTION_TIME: number;
+export const DEFAULT_SUBSCRIPTION_TTL: number;
+export const APHELEIA_SUBSCRIPTION_UPDATE: "event:apheleia.subscription_update";
+export const PRESENCE_UPDATE: "updated";
+export namespace ENVELOPE_TYPE {
+    const SUBSCRIPTION: string;
+    const PRESENCE: string;
+    const DELETE: string;
+}

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

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

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

@@ -0,0 +1,6 @@
+export default PresenceBatcher;
+/**
+ * @class
+ * @ignore
+ */
+declare const PresenceBatcher: any;

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

@@ -0,0 +1,68 @@
+/**
+ * Presence Worker
+ * Manages fetches and subscriptions for presence
+ * @class
+ */
+export default class PresenceWorker {
+    presences: {};
+    watchers: {};
+    fetchers: {};
+    flights: {};
+    campers: {};
+    subscribers: {};
+    /**
+     * Connect to the mercury for presence and starts worker.
+     * @param {object} webex
+     * @returns {undefined}
+     */
+    initialize(webex: object): undefined;
+    webex: any;
+    /**
+     * Trigger a subscription update event.
+     * @param {string} event
+     * @returns {undefined}
+     */
+    subscriptionUpdate(event: string): undefined;
+    /**
+     * Retrieves and subscribes to a user's presence.
+     * @param {string} id
+     * @returns {undefined}
+     */
+    enqueue(id: string): undefined;
+    /**
+     * Retract from subscribing to a user's presence.
+     * @param {string} id
+     * @returns {undefined}
+     */
+    dequeue(id: string): undefined;
+    /**
+     * Retrieve users' presences.
+     * @returns {undefined}
+     */
+    checkFetchers(): undefined;
+    debouncedFetch: import("lodash").DebouncedFunc<() => undefined>;
+    /**
+     * Determine if we should subscribe to users' presences.
+     * @returns {Array}: User ids to subscribe.
+     */
+    checkCampers(): any[];
+    /**
+     * Determine if we should re-subscribe or remove users' subscriptions.
+     * @returns {Array}: User ids to re-subscribe.
+     */
+    checkSubscriptions(): any[];
+    /**
+     * Remove expired presence objects.
+     * @returns {undefined}
+     */
+    cleanPresences(): undefined;
+    /**
+     * Execute chores on an interval.
+     * Checks if we should make new subscribe,
+     * checks if we should re-subscribe,
+     * removes expired subscriptions,
+     * removes expired presence objects.
+     * @returns {undefined}
+     */
+    groundskeeper(): undefined;
+}

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

@@ -0,0 +1,6 @@
+export default Presence;
+/**
+ * @class
+ * @extends WebexPlugin
+ */
+declare const Presence: any;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,16 @@
+declare namespace _default {
+    namespace device {
+        namespace preDiscoveryServices {
+            const atlasServiceUrl: string;
+            const atlas: string;
+            const clientLogs: string;
+            const clientLogsServiceUrl: string;
+        }
+    }
+    namespace support {
+        const appType: string;
+        const appVersion: string;
+        const languageCode: string;
+    }
+}
+export default _default;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,17 @@
+declare namespace _default {
+    namespace device {
+        namespace preDiscoveryServices {
+            const atlasServiceUrl: string;
+            const atlas: string;
+        }
+    }
+    namespace user {
+        const batcherWait: number;
+        const batcherMaxCalls: number;
+        const batcherMaxWait: number;
+        namespace verifyDefaults {
+            const reqId: string;
+        }
+    }
+}
+export default _default;

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

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

package/dist/types/@webex/internal-plugin-user/src/user-uuid-batcher.d.ts

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

package/dist/types/@webex/internal-plugin-user/src/user-uuid-store.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @class
+ */
+export default class UserUUIDStore {
+    /**
+     * Adds a user object to the store
+     * @param {Object} user
+     * @param {string} user.id
+     * @param {string} user.emailAddress
+     * @returns {Promise}
+     */
+    add(user: {
+        id: string;
+        emailAddress: string;
+    }): Promise<any>;
+    /**
+     * Retrieves the specified user object from the store
+     * @param {string} id
+     * @returns {Promise<Object>}
+     */
+    get(id: string): Promise<any>;
+    /**
+     * Retrieves the specified user object by id from the store
+     * @param {Object} id
+     * @returns {Promise<Object>}
+     */
+    getById(id: any): Promise<any>;
+    /**
+     * Retrieves the specified user object by id from the store
+     * @param {Object} email
+     * @returns {Promise<Object>}
+     */
+    getByEmail(email: any): Promise<any>;
+}

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

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

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

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

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

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

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

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