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

package/dist/types/@webex/webex-core/src/lib/services/service-registry.d.ts

@@ -0,0 +1,271 @@
+/**
+ * The parameter transfer object for {@link ServiceRegistry#mapRemoteCatalog}.
+ * This object is shaped to match the object returned from the **U2C** service.
+ *
+ * @typedef {Record<string, string>} RSL
+ * @typedef {Record<string, Array<Record<string, number | string>>>} RHC
+ *
+ * @typedef {Object} MapRemoteCatalogPTO
+ * @property {string} MapRemoteCatalogPTO.catalog - Service catalog name.
+ * @property {RSL} MapRemoteCatalogPTO.serviceLinks - Service links.
+ * @property {RHC} MapRemoteCatalogPTO.hostCatalog - Service host catalog.
+ */
+/**
+ * Service manipulation filter object for retrieving services within the
+ * {@link ServiceRegistry} class.
+ *
+ * @typedef {Object} HostFilter
+ * @property {boolean} [HostFilter.active] - Active state to filter.
+ * @property {Array<string> | string} [HostFilter.catalog] - Catalogs to filter.
+ * @property {Array<string> | string} [HostFilter.cluster] - Clusters to filter.
+ * @property {boolean} [HostFilter.local] - Filter to the user's home cluster.
+ * @property {boolean} [HostFilter.priority] - Filter for the highest priority.
+ * @property {Array<string> | string} [HostFilter.service] - Services to filter.
+ * @property {Array<string> | string} [HostFilter.url] - URL to filter.
+ */
+/**
+ * @class
+ * @classdesc - Manages a collection of {@link ServiceHost} class objects.
+ */
+export default class ServiceRegistry {
+    /**
+     * Convert a {@link SERVICE_CATALOGS} identifier or value to its associated
+     * idenfier or value.
+     *
+     * @public
+     * @static
+     * @memberof ServiceRegistry
+     * @param {Object} pto - The parameter transfer object.
+     * @property {string | number} pto.id - The identifier to convert in the enum.
+     * @property {SERVICE_CATALOGS_ENUM_TYPES} pto.type - The desired output.
+     * @returns {string|number} - The matching enum value or index.
+     */
+    public static mapCatalogName({ id, type }: any): string | number;
+    /**
+     * Generate a formatted array based on the object received from the **U2C**
+     * service for usage in the {@link ServiceRegistry#load} method.
+     *
+     * @public
+     * @static
+     * @memberof ServiceRegistry
+     * @param {MapRemoteCatalogPTO} pto - The parameter transfer object.
+     * @throws - If the target catalog does not exist.
+     * @returns {Array<ServiceHost#ServiceHostConstructorPTO>}
+     */
+    public static mapRemoteCatalog({ catalog, hostCatalog, serviceLinks }: MapRemoteCatalogPTO): Array<ServiceHost>;
+    /**
+     * The collection of managed {@link ServiceHost}s.
+     *
+     * @instance
+     * @type {Array<ServiceHost>}
+     * @private
+     * @memberof ServiceRegistry
+     */
+    private hosts;
+    /**
+     * An active, local, and priority mapped record of the current
+     * {@link ServiceCatalog#hosts}.
+     *
+     * @public
+     * @memberof ServiceCatalog
+     * @type {Record<string, string>}
+     */
+    public get map(): Record<string, string>;
+    /**
+     * Removes a collection of {@link ServiceHost} class objects from the
+     * {@link ServiceRegistry#hosts} array based on the provided
+     * {@link HostFilter}.
+     *
+     * @public
+     * @memberof ServiceRegistry
+     * @param {HostFilter} filter - The inclusive filter for hosts to remove.
+     * @returns {Array<ServiceHost>} - The removed {@link ServiceHost}s.
+     */
+    public clear(filter: HostFilter): Array<ServiceHost>;
+    /**
+     * Mark a collection of {@link ServiceHost} class objects from the
+     * {@link ServiceRegistry#hosts} array as failed based on the provided
+     * {@link HostFilter}.
+     *
+     * @public
+     * @memberof ServiceRegistry
+     * @param {HostFilter} filter - The inclusive filter for hosts to mark failed.
+     * @returns {Array<ServiceHost>} - The {@link ServiceHost}s marked failed.
+     */
+    public failed(filter: HostFilter): Array<ServiceHost>;
+    /**
+     * Filter the {@link ServiceRegistry#hosts} array against their active states.
+     *
+     * @private
+     * @memberof ServiceRegistry
+     * @param {boolean} [active] - Filter for the host state.
+     * @returns {Array<ServiceHost>} - The filtered host array.
+     */
+    private filterActive;
+    /**
+     * Filter the {@link ServiceRegistry#hosts} array against their assigned
+     * catalog values.
+     *
+     * @private
+     * @memberof ServiceRegistry
+     * @param {Array<string> | string} [catalog] - Catalogs to filter.
+     * @returns {Array<ServiceHost>} - The filtered host array.
+     */
+    private filterCatalog;
+    /**
+     * Filter the {@link ServiceRegistry#hosts} array against their assigned
+     * cluster values.
+     *
+     * @private
+     * @memberof ServiceRegistry
+     * @param {Array<string> | string} [cluster] - Clusters to filter for.
+     * @returns {Array<ServiceHost>} - The filtered host array.
+     */
+    private filterCluster;
+    /**
+     * Filter the {@link ServiceRegistry#hosts} array against their location in
+     * reference to the authenticated user.
+     *
+     * @private
+     * @memberof ServiceRegistry
+     * @param {boolean} [local] - Filter for the host location.
+     * @returns {Array<ServiceHost>} - The filtered host array.
+     */
+    private filterLocal;
+    /**
+     * Filter the {@link ServiceRegistry#hosts} array for the highest priority
+     * hosts for each specific service.
+     *
+     * @private
+     * @memberof ServiceRegistry
+     * @param {boolean} [priority] - Filter for the highest priority
+     * @returns {Array<ServiceHost>} - The filtered host array.
+     */
+    private filterPriority;
+    /**
+     * Filter the {@link ServiceRegistry#hosts} array for hosts with a specified
+     * set of service names.
+     *
+     * @private
+     * @memberof ServiceRegistry
+     * @param {Array<string> | string} [service] - Services to filter.
+     * @returns {Array<ServiceHost>} - The filtered host array.
+     */
+    private filterService;
+    /**
+     * Filter the {@link ServiceRegistry#hosts} array for hosts with a specified
+     * set of URLs.
+     *
+     * @private
+     * @memberof ServiceRegistry
+     * @param {Array<string> | string} [url] - URL to filter.
+     * @returns {Array<ServiceHost>} - The filter host array.
+     */
+    private filterUrl;
+    /**
+     * Get an array of {@link ServiceHost}s based on a provided
+     * {@link HostFilter} from the {@link ServiceRegistry#hosts} array.
+     *
+     * @public
+     * @memberof ServiceRegistry
+     * @param {HostFilter} [filter] - The inclusive filter for hosts to find.
+     * @returns {Array<ServiceHost>} - The filtered hosts.
+     */
+    public find({ active, catalog, cluster, local, priority, service, url }?: HostFilter): Array<ServiceHost>;
+    /**
+     * Load a formatted array of {@link ServiceHost} constructor parameter
+     * transfer objects as instances of {@link ServiceHost} class objects to the
+     * {@link ServiceRegistry#hosts} array.
+     *
+     * @public
+     * @memberof ServiceRegistry
+     * @param {Array<ServiceHost.ConstructorPTO>} hosts
+     * @returns {this}
+     */
+    public load(hosts?: Array<ServiceHost.ConstructorPTO>): this;
+    /**
+     * Mark a collection of {@link ServiceHost} class objects from the
+     * {@link ServiceRegistry#hosts} array as replaced based on the provided
+     * {@link HostFilter}.
+     *
+     * @public
+     * @memberof ServiceRegistry
+     * @param {HostFilter} filter - The inclusive filter to mark replaced.
+     * @returns {Array<ServiceHost>} - The {@link ServiceHost}s marked replaced.
+     */
+    public replaced(filter: HostFilter): Array<ServiceHost>;
+    /**
+     * Reset the failed status of a collection of {@link ServiceHost} class
+     * objects from the {@link ServiceRegistry#hosts} array based on the provided
+     * {@link HostFilter}.
+     *
+     * @public
+     * @memberof ServiceRegistry
+     * @param {HostFilter} filter - The inclusive filter of hosts to reset.
+     * @returns {Array<ServiceHost>} - The {@link ServiceHost}s that reset.
+     */
+    public reset(filter: HostFilter): Array<ServiceHost>;
+}
+/**
+ * The parameter transfer object for {@link ServiceRegistrymapRemoteCatalog }.
+ * This object is shaped to match the object returned from the **U2C** service.
+ */
+export type RSL = Record<string, string>;
+/**
+ * The parameter transfer object for {@link ServiceRegistrymapRemoteCatalog }.
+ * This object is shaped to match the object returned from the **U2C** service.
+ */
+export type RHC = Record<string, Array<Record<string, number | string>>>;
+/**
+ * The parameter transfer object for {@link ServiceRegistrymapRemoteCatalog }.
+ * This object is shaped to match the object returned from the **U2C** service.
+ */
+export type MapRemoteCatalogPTO = {
+    /**
+     * - Service catalog name.
+     */
+    catalog: string;
+    /**
+     * - Service links.
+     */
+    serviceLinks: RSL;
+    /**
+     * - Service host catalog.
+     */
+    hostCatalog: RHC;
+};
+/**
+ * Service manipulation filter object for retrieving services within the
+ * {@link ServiceRegistry } class.
+ */
+export type HostFilter = {
+    /**
+     * - Active state to filter.
+     */
+    active?: boolean;
+    /**
+     * - Catalogs to filter.
+     */
+    catalog?: Array<string> | string;
+    /**
+     * - Clusters to filter.
+     */
+    cluster?: Array<string> | string;
+    /**
+     * - Filter to the user's home cluster.
+     */
+    local?: boolean;
+    /**
+     * - Filter for the highest priority.
+     */
+    priority?: boolean;
+    /**
+     * - Services to filter.
+     */
+    service?: Array<string> | string;
+    /**
+     * - URL to filter.
+     */
+    url?: Array<string> | string;
+};
+import ServiceHost from "./service-host";

package/dist/types/@webex/webex-core/src/lib/services/service-state.d.ts

@@ -0,0 +1,46 @@
+/**
+ * The state of a specific catalog to be used by {@link ServiceState}.
+ *
+ * @typedef {Record<string, boolean>} CatalogState
+ * @property {boolean} CatalogState.collecting - If the catalog is collecting.
+ * @property {boolean} CatalogState.ready - If the catalog is ready.
+ */
+/**
+ * @class
+ * @classdesc - Manages the state of the service catalogs for a webex instance.
+ */
+export default class ServiceState {
+    /**
+     * Generate a {@link CatalogState}.
+     *
+     * @public
+     * @static
+     * @memberof ServiceState
+     * @returns {CatalogState} - The generated {@link CatalogState}.
+     */
+    public static generateCatalogState(): CatalogState;
+    /**
+     * Set a catalog to be collecting or not.
+     *
+     * @public
+     * @memberof ServiceState
+     * @param {string} catalog - Catalog to target.
+     * @param {boolean} collecting - If the target is collecting or not.
+     * @returns {undefined}
+     */
+    public setCollecting(catalog: string, collecting: boolean): undefined;
+    /**
+     * Set a catalog to be ready or not.
+     *
+     * @public
+     * @memberof ServiceState
+     * @param {string} catalog - Catalog to target.
+     * @param {boolean} ready - If the target is ready or not.
+     * @returns {undefined}
+     */
+    public setReady(catalog: string, ready: boolean): undefined;
+}
+/**
+ * The state of a specific catalog to be used by {@link ServiceState }.
+ */
+export type CatalogState = Record<string, boolean>;

package/dist/types/@webex/webex-core/src/lib/services/service-url.d.ts

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

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

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

package/dist/types/@webex/webex-core/src/lib/stateless-webex-plugin.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Base plugin class. Doesn't depend on Ampersand State
+ */
+export default class StatelessWebexPlugin {
+    /**
+     * Constructor. One of attrs.webex or options.parent is required
+     * @param {Object} attrs
+     * @param {WebexCore} [attrs.webex]
+     * @param {Object} options
+     * @param {WebexCore} [options.parent]
+     */
+    constructor(attrs?: {
+        webex?: WebexCore;
+    }, options?: {
+        parent?: WebexCore;
+    });
+    /**
+     * The config for this plugin's namespace. If no namespace has been set
+     * returns all of webex's config.
+     * @type {Object}
+     */
+    get config(): any;
+    /**
+     * A reference to the webex logger.
+     * @type {Logger}
+     */
+    get logger(): Logger;
+    /**
+     * A reference to the main sdk instance
+     * @type {WebexCore}
+     */
+    get webex(): WebexCore;
+    ready: boolean;
+    /**
+     * Proxies to {@link WebexPlugin#webex}'s `request()` method.
+     * @see WebexCore#request
+     * @param {Array<mixed>} args
+     * @returns {Promise}
+     */
+    request(...args: Array<mixed>): Promise<any>;
+    /**
+     * Proxies to {@link WebexPlugin#webex}'s `upload()` method.
+     * @see WebexCore#upload
+     * @param {Array<mixed>} args
+     * @returns {Promise}
+     */
+    upload(...args: Array<mixed>): Promise<any>;
+}

package/dist/types/@webex/webex-core/src/lib/storage/decorators.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Stores the result of fn before returning it
+ * @param  {string} key
+ * @private
+ * @returns {Promise} resolves with the result of fn
+ */
+export function persist(...args: any[]): Promise<any>;
+/**
+ * Prevents fn from executing until key has been (attempted to be) loaded
+ * @param {string} key
+ * @param {Function} fn
+ * @private
+ * @returns {Promise} result of fn
+ */
+export function waitForValue(key: string): Promise<any>;

package/dist/types/@webex/webex-core/src/lib/storage/errors.d.ts

@@ -0,0 +1,10 @@
+/**
+ * General storage layer error
+ */
+export class StorageError {
+}
+/**
+ * StorageError thrown when the storage layer does not contain the request key
+ */
+export class NotFoundError extends StorageError {
+}

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

@@ -0,0 +1,5 @@
+export { default as makeWebexStore } from "./make-webex-store";
+export { default as makeWebexPluginStore } from "./make-webex-plugin-store";
+export { default as MemoryStoreAdapter } from "./memory-store-adapter";
+export { persist, waitForValue } from "./decorators";
+export { StorageError, NotFoundError } from "./errors";

package/dist/types/@webex/webex-core/src/lib/storage/make-webex-plugin-store.d.ts

@@ -0,0 +1,8 @@
+/**
+ * [makeWebexPluginStorage description]
+ * @param {[type]} type
+ * @param {[type]} context
+ * @private
+ * @returns {[type]}
+ */
+export default function makeWebexPluginStorage(type: any, context: [any]): [any];

package/dist/types/@webex/webex-core/src/lib/storage/make-webex-store.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Makes a WebexStore for the specified type bound to the specified webex instance
+ * @param {string} type
+ * @param {ProxyWebex} webex
+ * @private
+ * @returns {WebexStore}
+ */
+export default function makeWebexStore(type: string, webex: ProxyWebex): {
+    /**
+     * Provides easy access to the storage adapter identified in config.
+     * @returns {Object}
+     */
+    readonly adapter: any;
+    /**
+     * @returns {WeakMap}
+     */
+    readonly bindings: WeakMap<any, any>;
+    /**
+     * Clears the store
+     * @returns {Promise}
+     */
+    clear(): Promise<any>;
+    /**
+     * Deletes the specified key from the store
+     * @param {string} namespace
+     * @param {string} key
+     * @returns {[type]}
+     */
+    del(namespace: string, key: string): [string];
+    /**
+     * Retrieves the value specified by key from the store. Rejects with
+     * NotFoundError if no value can be found
+     * @param {string} namespace
+     * @param {string} key
+     * @returns {Promise}
+     */
+    get(namespace: string, key: string): Promise<any>;
+    /**
+     * Writes a value to the store. Deletes the specified key from the store
+     * if passed `undefined`
+     * @param {string} namespace
+     * @param {string} key
+     * @param {any} value
+     * @returns {Promise} Resolves with value (to simplify write-through caching)
+     */
+    put(namespace: string, key: string, value: any): Promise<any>;
+    _getBinding(namespace: any): Promise<any>;
+};

package/dist/types/@webex/webex-core/src/lib/storage/memory-store-adapter.d.ts

@@ -0,0 +1,18 @@
+declare namespace _default {
+    export { _bind as bind };
+    export function preload(data: any): {
+        bind(namespace: any, options?: {}): Promise<any>;
+    };
+}
+export default _default;
+/**
+ * Binds a namespace
+ * @param {string} namespace
+ * @param {Object} options
+ * @param {Object} options.data
+ * @private
+ * @returns {Promise<Object>}
+ */
+declare function _bind(namespace: string, options?: {
+    data: any;
+}): Promise<any>;

package/dist/types/@webex/webex-core/src/lib/webex-core-plugin-mixin.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Mixes a plugin system into an AmpState object (specifically, into WebexCore)
+ * @param {AmpState} State
+ * @param {Object} config
+ * @param {Object} interceptors
+ * @returns {AmpState}
+ */
+export default function mixinWebexCorePlugins(State: AmpState, config: any, interceptors: any): AmpState;

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

@@ -0,0 +1,12 @@
+/**
+ * Webex-specific http error class
+ */
+export default class WebexHttpError {
+    /**
+     * Very similar to {@link HttpError#parse()}, but additionally adds some
+     * useful headers to the message string
+     * @param {HttpResponse} res
+     * @returns {string}
+     */
+    parse(res: HttpResponse): string;
+}

package/dist/types/@webex/webex-core/src/lib/webex-internal-core-plugin-mixin.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Mixes a plugin system into an AmpState object (specifically, into WebexCore)
+ * @param {AmpState} State
+ * @param {Object} config
+ * @param {Object} interceptors
+ * @returns {AmpState}
+ */
+export default function mixinWebexInternalCorePlugins(State: AmpState, config: any, interceptors: any): AmpState;

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

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

package/dist/types/@webex/webex-core/src/plugins/logger.d.ts

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

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

@@ -0,0 +1,31 @@
+/**
+ * @method registerPlugin
+ * @param {string} name
+ * @param {function} constructor
+ * @param {Object} options
+ * @param {Array<string>} options.proxies
+ * @param {Object} options.interceptors
+ * @returns {null}
+ */
+export function registerPlugin(name: string, constructor: Function, options?: {
+    proxies: Array<string>;
+    interceptors: any;
+}): null;
+/**
+ * Registers plugins used by internal products that do not talk to public APIs.
+ * @method registerInternalPlugin
+ * @param {string} name
+ * @param {function} constructor
+ * @param {Object} options
+ * @param {Object} options.interceptors
+ * @private
+ * @returns {null}
+ */
+export function registerInternalPlugin(name: string, constructor: Function, options: {
+    interceptors: any;
+}): null;
+export default WebexCore;
+/**
+ * @class
+ */
+declare const WebexCore: any;

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

@@ -0,0 +1,7 @@
+export default WebexInternalCore;
+/**
+ * WebexInternalCore is an extra layer of nesting to make it blatantly clear that
+ * private plugins are, in fact, private.
+ * @class
+ */
+declare const WebexInternalCore: any;

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

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

package/dist/types/@webex/webex-core/test/integration/spec/credentials/token.d.ts

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

package/dist/types/@webex/webex-core/test/integration/spec/services/service-catalog.d.ts

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

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

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

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

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

package/dist/types/@webex/webex-core/test/unit/spec/_setup.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/credentials/credentials.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/credentials/token.d.ts

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

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

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

package/dist/types/@webex/webex-core/test/unit/spec/interceptors/default-options.d.ts

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

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

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

package/dist/types/@webex/webex-core/test/unit/spec/interceptors/network-timing.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/interceptors/payload-transformer.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/interceptors/rate-limit.d.ts

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

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

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

package/dist/types/@webex/webex-core/test/unit/spec/interceptors/request-timing.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/interceptors/user-agent.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/interceptors/webex-tracking-id.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/interceptors/webex-user-agent.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/lib/batcher.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/lib/page.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/lib/webex-plugin.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/services/interceptors/server-error.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/services/interceptors/service.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/services/service-catalog.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/services/service-host.d.ts

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

package/dist/types/@webex/webex-core/test/unit/spec/services/service-registry.d.ts

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