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

package/dist/types/@webex/test-helper-server/src/json.d.ts

@@ -0,0 +1,2 @@
+export = router;
+declare const router: import("express-serve-static-core").Router;

package/dist/types/@webex/test-helper-server/src/reflect.d.ts

@@ -0,0 +1,10 @@
+export = reflect;
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+/**
+ * @param {http.IncomingMessage} req
+ * @param {http.ServerResponse} res
+ * @returns {undefined}
+ */
+declare function reflect(req: http.IncomingMessage, res: http.ServerResponse): undefined;

package/dist/types/@webex/test-helper-test-users/src/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Helper
+ * @param {Array<User>} users
+ * @returns {Promise}
+ */
+declare function _remove(users: Array<User>): Promise<any>;
+export declare function create(options: any): Promise<User[]>;
+export { _remove as remove };

package/dist/types/@webex/test-users/src/index.d.ts

@@ -0,0 +1,115 @@
+/**
+ * @typedef {Object} AccessTokenObject
+ * @property {string} token.access_token
+ * @property {Number} token.expires_in
+ * @property {string} token.token_type
+ * @property {string} token.refresh_token
+ * @property {Number} token.refresh_token_expires_in
+ * @property {string} token.expires
+ * @property {string} token.refresh_token_expires
+ */
+/**
+ * @typedef {Object} CreateUserOptions
+ * @property {boolean} [authCodeOnly] generates auth_code
+ * @param {string} [clientId] defaults to WEBEX_CLIENT_ID
+ * @param {string} [clientSecret] defaults to WEBEX_CLIENT_SECRET
+ * @param {string} [cigServiceUrl] defaults to WEBEX_TEST_USERS_CI_GATEWAY_SERVICE_URL
+ * @property {string} [displayName]
+ * @property {string} [emailAddress]
+ * @property {Array.<string>} [entitlements]
+ * @param {string} [idbrokerUrl] defaults to IDBROKER_BASE_URL
+ * @property {string} [machineType] used when creating a machine user/device
+ * @property {string} [orgId] organization ID to create the user under
+ * @property {string} [password] defaults to a random password
+ * @property {string} [roles] defaults to []
+ * @property {string} [scope] defaults to WEBEX_SCOPE
+ * @property {string} [type] used to create a machine
+ */
+/**
+ * @typedef {Object} TestUserObject
+ * @property {string} password
+ * @property {string} emailAddress
+ * @property {string} displayName
+ * @property {string} id
+ * @property {string} userName
+ * @property {string} email
+ * @property {string} name
+ * @property {string} givenName
+ * @property {string} type
+ * @property {Array.<string>} entitlements
+ * @property {string} orgId
+ * @property {AccessTokenObject} token
+ */
+/**
+ * Creates a test user
+ * @param {CreateUserOptions} options
+ * @returns {Promise.<TestUserObject>}
+ */
+export function createTestUser(options?: CreateUserOptions): Promise<TestUserObject>;
+/**
+ * Exchanges a user name/password for an access token
+ * @param {Object} options
+ * @param {string} options.id
+ * @param {string} options.email
+ * @param {string} options.password
+ * @param {string} options.clientId
+ * @param {string} options.clientSecret
+ * @param {string} options.cigServiceUrl
+ * @returns {Promise.<AccessTokenObject>}
+ */
+export function loginTestUser(options: {
+    id: string;
+    email: string;
+    password: string;
+    clientId: string;
+    clientSecret: string;
+    cigServiceUrl: string;
+}): Promise<AccessTokenObject>;
+/**
+ * Removes a test user
+ * @param {Object} options
+ * @param {string} options.id user id to remove
+ * @param {string} options.cigServiceUrl
+ * @param {Object} options.token
+ * @param {string} options.token.authorization
+ * @param {string} [options.token.refresh_token]
+ * @returns {Promise}
+ */
+export function removeTestUser(options?: {
+    id: string;
+    cigServiceUrl: string;
+    token: {
+        authorization: string;
+        refresh_token?: string;
+    };
+}): Promise<any>;
+export type AccessTokenObject = {
+    access_token: string;
+    expires_in: number;
+    token_type: string;
+    refresh_token: string;
+    refresh_token_expires_in: number;
+    expires: string;
+    refresh_token_expires: string;
+};
+export type CreateUserOptions = {
+    /**
+     * generates auth_code
+     */
+    authCodeOnly?: boolean;
+};
+export type TestUserObject = {
+    password: string;
+    emailAddress: string;
+    displayName: string;
+    id: string;
+    userName: string;
+    email: string;
+    name: string;
+    givenName: string;
+    type: string;
+    entitlements: Array<string>;
+    orgId: string;
+    token: AccessTokenObject;
+};
+export { default as createWhistlerTestUser, removeTestUser as removeWhistlerTestUser } from "./whistler";

package/dist/types/@webex/test-users/src/whistler.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @typedef {Object} TestUserObject
+ * @property {string} password
+ * @property {string} emailAddress
+ * @property {string} displayName
+ * @property {string} token
+ * @property {string} reservationUrl
+ * @property {object} responseMetaData - whistler given properties
+ */
+/**
+ * @typedef {Object} CreateUserOptions
+ * @param {Object} [options]
+ * @param {string} [whistlerServiceUrl] defaults to WHISTLER_API_SERVICE_URL
+ * @param {string} [options.clientId] defaults to WEBEX_CLIENT_ID
+ * @param {string} [options.clientSecret] defaults to WEBEX_CLIENT_SECRET
+ * @param {string} [options.idbrokerUrl] defaults to IDBROKER_BASE_URL
+ * @param {string} [options.orgId] organization ID to create the user under
+ * @param {string} [options.machineAccount] defaults to WHISTLER_MACHINE_ACCOUNT
+ * @param {string} [options.machinePassword] defaults to WHISTLER_MACHINE_PASSWORD
+ */
+/**
+ * Creates a test user
+ * @param {CreateUserOptions} options
+ * @returns {Promise.<TestUserObject>}
+ */
+export default function createTestUser(options?: CreateUserOptions): Promise<TestUserObject>;
+/**
+ *
+ * @param {Object} options
+ * @returns {Promise}
+ */
+export function removeTestUser(options?: any): Promise<any>;
+export type TestUserObject = {
+    password: string;
+    emailAddress: string;
+    displayName: string;
+    token: string;
+    reservationUrl: string;
+    /**
+     * - whistler given properties
+     */
+    responseMetaData: object;
+};
+export type CreateUserOptions = any;

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

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

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

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

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

@@ -0,0 +1,39 @@
+declare namespace _default {
+    const maxAppLevelRedirects: number;
+    const maxLocusRedirects: number;
+    const maxAuthenticationReplays: number;
+    const maxReconnectAttempts: number;
+    const onBeforeLogout: any[];
+    const trackingIdPrefix: string;
+    const trackingIdSuffix: string;
+    const AlternateLogger: any;
+    const credentials: any;
+    const fedramp: string | boolean;
+    namespace services {
+        const discovery: any;
+        const validateDomains: boolean;
+        const servicesNotNeedValidation: string[];
+        const allowedDomains: Array<string>;
+    }
+    namespace device {
+        export namespace preDiscoveryServices {
+            const hydra: string;
+            const hydraServiceUrl: string;
+        }
+        const validateDomains_1: boolean;
+        export { validateDomains_1 as validateDomains };
+    }
+    namespace metrics {
+        const type: string[];
+    }
+    namespace payloadTransformer {
+        const predicates: any[];
+        const transforms: any[];
+    }
+    namespace storage {
+        export { MemoryStoreAdapter as boundedAdapter };
+        export { MemoryStoreAdapter as unboundedAdapter };
+    }
+}
+export default _default;
+import { MemoryStoreAdapter } from "./lib/storage";

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

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

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

@@ -0,0 +1,24 @@
+export { default as WebexHttpError } from "./lib/webex-http-error";
+export { default as StatelessWebexPlugin } from "./lib/stateless-webex-plugin";
+export { default as WebexPlugin } from "./lib/webex-plugin";
+export { default as AuthInterceptor } from "./interceptors/auth";
+export { default as NetworkTimingInterceptor } from "./interceptors/network-timing";
+export { default as PayloadTransformerInterceptor } from "./interceptors/payload-transformer";
+export { default as RedirectInterceptor } from "./interceptors/redirect";
+export { default as ResponseLoggerInterceptor } from "./interceptors/response-logger";
+export { default as RequestEventInterceptor } from "./interceptors/request-event";
+export { default as RequestLoggerInterceptor } from "./interceptors/request-logger";
+export { default as RequestTimingInterceptor } from "./interceptors/request-timing";
+export { default as UserAgentInterceptor } from "./interceptors/user-agent";
+export { default as WebexTrackingIdInterceptor } from "./interceptors/webex-tracking-id";
+export { default as WebexUserAgentInterceptor } from "./interceptors/webex-user-agent";
+export { default as RateLimitInterceptor } from "./interceptors/rate-limit";
+export { default as EmbargoInterceptor } from "./interceptors/embargo";
+export { default as DefaultOptionsInterceptor } from "./interceptors/default-options";
+export { default as Batcher } from "./lib/batcher";
+export { default as Page } from "./lib/page";
+export { default as config } from "./config";
+export { Credentials, filterScope, grantErrors, sortScope, Token } from "./lib/credentials";
+export { constants as serviceConstants, ServiceCatalog, ServiceRegistry, ServiceState, ServiceInterceptor, ServerErrorInterceptor, Services, ServiceHost, ServiceUrl } from "./lib/services";
+export { makeWebexStore, makeWebexPluginStore, MemoryStoreAdapter, NotFoundError, persist, StorageError, waitForValue } from "./lib/storage";
+export { default, registerPlugin, registerInternalPlugin } from "./webex-core";

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

@@ -0,0 +1,43 @@
+/**
+ * @class
+ */
+export default class AuthInterceptor {
+    /**
+     * @returns {AuthInterceptor}
+     */
+    static create(): AuthInterceptor;
+    /**
+     * @see {@link Interceptor#onRequest}
+     * @param {Object} options
+     * @returns {Object}
+     */
+    onRequest(options: any): any;
+    /**
+     * Determines if the provided options object needs an authorization header.
+     *
+     * @param {Object} options
+     * @returns {Promise<boolean>}
+     */
+    requiresCredentials(options: any): Promise<boolean>;
+    /**
+     * @see {@link Interceptor#onResponseError}
+     * @param {Object} options
+     * @param {Error} reason
+     * @returns {Object}
+     */
+    onResponseError(options: any, reason: Error): any;
+    /**
+     * Replays the request
+     * @param {Object} options
+     * @returns {Object}
+     */
+    replay(options: any): any;
+    /**
+     * Indicates whether or not the current request should refresh its access
+     * token in event of a 401
+     * @param {Error} reason
+     * @param {Object} options
+     * @returns {Promise<boolean>}
+     */
+    shouldAttemptReauth(reason: Error, options: any): Promise<boolean>;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * Allows the user of the SDK to set default options that apply every http request made by the SDK
+ * For example a default timeout could be set for all requests like this :
+ *
+ *   webex = WebexSdk.init({
+ *     credentials: {
+ *       supertoken: superToken
+ *     },
+ *     config: {
+ *       credentials: {
+ *         client_id,
+ *         client_secret
+ *       },
+ *       defaultRequestOptions: {
+ *         timeout: 15000
+ *       }
+ *     }
+ *   });
+ */
+export default class DefaultOptionsInterceptor {
+    /**
+     * @returns {DefaultOptionsInterceptor}
+     */
+    static create(): DefaultOptionsInterceptor;
+    /**
+     * @see Interceptor#onRequest
+     * @param {Object} options
+     * @returns {Object}
+     */
+    onRequest(options: any): any;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * @class
+ */
+export default class EmbargoInterceptor {
+    /**
+     * @returns {EmbargoInterceptor}
+     */
+    static create(): EmbargoInterceptor;
+    /**
+     * @see Interceptor#onResponseError
+     * @param {Object} options
+     * @param {Error} reason
+     * @returns {Promise}
+     */
+    onResponseError(options: any, reason: Error): Promise<any>;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * @class
+ */
+export default class NetworkTimingInterceptor {
+    /**
+     * @param {Object} options
+     * @returns {NetworkTimingInterceptor}
+     */
+    static create(options: any): NetworkTimingInterceptor;
+    /**
+     * @see Interceptor#onRequest
+     * @param {Object} options
+     * @returns {Object}
+     */
+    onRequest(options: any): any;
+    /**
+     * @see Interceptor#onResponse
+     * @param {Object} options
+     * @param {HttpResponse} response
+     * @returns {Object}
+     */
+    onResponse(options: any, response: HttpResponse): any;
+    /**
+     * @see Interceptor#onResponseError
+     * @param {Object} options
+     * @param {Error} reason
+     * @returns {Object}
+     */
+    onResponseError(options: any, reason: Error): any;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * @class
+ */
+export default class PayloadTransformerInterceptor {
+    /**
+     * @param {Object} options
+     * @returns {PayloadTransformerInterceptor}
+     */
+    static create(): PayloadTransformerInterceptor;
+    /**
+     * @see Interceptor#onRequest
+     * @param {Object} options
+     * @returns {Object}
+     */
+    onRequest(options: any): any;
+    /**
+     * @see Interceptor#onResponse
+     * @param {Object} options
+     * @param {HttpResponse} response
+     * @returns {Object}
+     */
+    onResponse(options: any, response: HttpResponse): any;
+    /**
+     * @see Interceptor#onResponseError
+     * @param {Object} options
+     * @param {Error} reason
+     * @returns {Object}
+     */
+    onResponseError(options: any, reason: Error): any;
+}

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

@@ -0,0 +1,61 @@
+/**
+ * @class
+ */
+export default class RateLimitInterceptor {
+    /**
+     * @returns {RateLimitInterceptor}
+     */
+    static create(): RateLimitInterceptor;
+    /**
+     * constructor
+     * @param {mixed} args
+     * @returns {Exception}
+     */
+    constructor(...args: mixed);
+    /**
+     * @see {@link Interceptor#onRequest}
+     * @param {Object} options
+     * @returns {Object}
+     */
+    onRequest(options: any): any;
+    /**
+     * @see {@link Interceptor#onResponseError}
+     * @param {Object} options
+     * @param {Error} reason
+     * @returns {Object}
+     */
+    onResponseError(options: any, reason: Error): any;
+    /**
+     * @param {object} options associated with the request
+     * @returns {number} retry after time in milliseconds
+     */
+    extractRetryAfterTime(options: object): number;
+    /**
+     * Set the system time at which the rate limiting
+     * will expire in the rateLimitExpiryTime map.
+     * Assumes retryAfter is in milliseconds
+     * @param {string} uri API issuing the rate limiting
+     * @param {number} retryAfter milliseconds until rate limiting expires
+     * @returns {bool} true is value was successfully set
+     */
+    setRateLimitExpiry(uri: string, retryAfter: number): bool;
+    /**
+     * returns true if the API is currently rate limited
+     * @param {string} uri
+     * @returns {Boolean} indicates whether or not the API is rate currently rate limited
+     */
+    getRateLimitStatus(uri: string): boolean;
+    /**
+     * split the URI and returns the API name of idBroker
+     * @param {string} uri
+     * @returns {string}
+     */
+    getApiName(uri: string): string;
+    /**
+     * check URI against list of currently rate limited
+     * URIs, and determines if retry-after
+     * @param {String} uri pattern to check
+     * @returns {bool}
+     */
+    isRateLimited(uri: string): bool;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * @class
+ */
+export default class RedirectInterceptor {
+    /**
+     * @returns {RedirectInterceptor}
+     */
+    static create(): RedirectInterceptor;
+    /**
+     * @see Interceptor#onRequest
+     * @param {Object} options
+     * @returns {Object}
+     */
+    onRequest(options: any): any;
+    /**
+     * @see Interceptor#onResponse
+     * @param {Object} options
+     * @param {HttpResponse} response
+     * @returns {Object}
+     */
+    onResponse(options: any, response: HttpResponse): any;
+}

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

@@ -0,0 +1,36 @@
+/**
+ * @class
+ */
+export default class RequestEventInterceptor {
+    /**
+     * @returns {RequestEventInterceptor}
+     */
+    static create(): RequestEventInterceptor;
+    /**
+     * @see Interceptor#onRequest
+     * @param {Object} options
+     * @returns {Object}
+     */
+    onRequest(options: any): any;
+    /**
+     * @see Interceptor#onRequest
+     * @param {Object} options
+     * @param {Error} reason
+     * @returns {Object}
+     */
+    onRequestError(options: any, reason: Error): any;
+    /**
+     * @see Interceptor#onResponse
+     * @param {Object} options
+     * @param {HttpResponse} response
+     * @returns {Object}
+     */
+    onResponse(options: any, response: HttpResponse): any;
+    /**
+     * @see Interceptor#onResponseError
+     * @param {Object} options
+     * @param {Error} reason
+     * @returns {Object}
+     */
+    onResponseError(options: any, reason: Error): any;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * @class
+ */
+export default class RequestLoggerInterceptor {
+    /**
+     * @returns {RequestLoggerInterceptor}
+     */
+    static create(): RequestLoggerInterceptor;
+    /**
+     * @see Interceptor#onRequest
+     * @param {Object} options
+     * @returns {Object}
+     */
+    onRequest(options: any): any;
+    /**
+     * @see Interceptor#onRequest
+     * @param {Object} options
+     * @param {Error} reason
+     * @returns {Object}
+     */
+    onRequestError(options: any, reason: Error): any;
+}

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

@@ -0,0 +1,36 @@
+/**
+ * @class
+ */
+export default class RequestTimingInterceptor {
+    /**
+     * @param {Object} options
+     * @returns {RequestTimingInterceptor}
+     */
+    static create(options: any): RequestTimingInterceptor;
+    /**
+     * @see Interceptor#onRequest
+     * @param {Object} options
+     * @returns {Object}
+     */
+    onRequest(options: any): any;
+    /**
+     * @see Interceptor#onRequestError
+     * @param {Object} options
+     * @returns {Object}
+     */
+    onRequestError(options: any): any;
+    /**
+     * @see Interceptor#onResponse
+     * @param {Object} options
+     * @param {HttpResponse} response
+     * @returns {Object}
+     */
+    onResponse(options: any, response: HttpResponse): any;
+    /**
+     * @see Interceptor#onResponseError
+     * @param {Object} options
+     * @param {Error} reason
+     * @returns {Object}
+     */
+    onResponseError(options: any, reason: Error): any;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * @class
+ */
+export default class ResponseLoggerInterceptor {
+    /**
+     * @returns {ResponseLoggerInterceptor}
+     */
+    static create(): ResponseLoggerInterceptor;
+    /**
+     * @see Interceptor#onRequest
+     * @param {Object} options
+     * @param {HttpResponse} response
+     * @returns {Object}
+     */
+    onResponse(options: any, response: HttpResponse): any;
+    /**
+     * @see Interceptor#onRequest
+     * @param {Object} options
+     * @param {Object} reason
+     * @returns {Object}
+     */
+    onResponseError(options: any, reason: any): any;
+    /**
+     * Prints the basic header
+     * @param {Object} options
+     * @param {HttpResponse|WebexHttpError} response
+     * @returns {undefined}
+     */
+    printResponseHeader(options: any, response: HttpResponse | WebexHttpError): undefined;
+}

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

@@ -0,0 +1,38 @@
+/**
+ * Sets a 'user-agent' header on all requests if one is not present.
+ * Defaults to '@webex/http-core' though a custom user-agent can be set
+ * using the appName and appVersion configuration. e.g.
+ *
+ *   webex = WebexSdk.init({
+ *     credentials: {
+ *       supertoken: superToken
+ *     },
+ *     config: {
+ *       credentials: {
+ *         client_id,
+ *         client_secret
+ *       },
+ *       appName: 'custom-user-agent',
+ *       appVersion: '1.0',
+ *     }
+ *   });
+ */
+export default class UserAgentInterceptor {
+    /**
+     * @returns {UserAgentInterceptor}
+     */
+    static create(): UserAgentInterceptor;
+    /**
+     * @param {Object} [options={}]
+     * @param {WebexCore} [options.webex]
+     * @private
+     * @returns {UserAgentInterceptor}
+     */
+    private constructor();
+    /**
+     * @see Interceptor#onRequest
+     * @param {Object} options
+     * @returns {Object}
+     */
+    onRequest(options: any): any;
+}