@webex/webex-core 3.8.1 → 3.9.0

package/package.json

@@ -33,14 +33,16 @@
     "@sinonjs/fake-timers": "^6.0.1",
     "@webex/babel-config-legacy": "0.0.0",
     "@webex/eslint-config-legacy": "0.0.0",
+    "@webex/internal-plugin-device": "3.9.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.8.1",
-    "@webex/test-helper-make-local-url": "3.8.1",
-    "@webex/test-helper-mocha": "3.8.1",
-    "@webex/test-helper-mock-webex": "3.8.1",
-    "@webex/test-helper-refresh-callback": "3.8.1",
-    "@webex/test-helper-test-users": "3.8.1",
+    "@webex/plugin-logger": "3.9.0",
+    "@webex/test-helper-chai": "3.9.0",
+    "@webex/test-helper-make-local-url": "3.9.0",
+    "@webex/test-helper-mocha": "3.9.0",
+    "@webex/test-helper-mock-webex": "3.9.0",
+    "@webex/test-helper-refresh-callback": "3.9.0",
+    "@webex/test-helper-test-users": "3.9.0",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.24.0",
@@ -48,12 +50,10 @@
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.8.1",
-    "@webex/common-timers": "3.8.1",
-    "@webex/http-core": "3.8.1",
-    "@webex/internal-plugin-device": "3.8.1",
-    "@webex/plugin-logger": "3.8.1",
-    "@webex/storage-adapter-spec": "3.8.1",
+    "@webex/common": "3.9.0",
+    "@webex/common-timers": "3.9.0",
+    "@webex/http-core": "3.9.0",
+    "@webex/storage-adapter-spec": "3.9.0",
     "ampersand-collection": "^2.0.2",
     "ampersand-events": "^2.0.2",
     "ampersand-state": "^5.0.3",
@@ -73,5 +73,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner jest"
   },
-  "version": "3.8.1"
+  "version": "3.9.0"
 }

package/src/index.js

@@ -16,28 +16,16 @@ import './lib/services';
 export {Credentials, filterScope, grantErrors, sortScope, Token} from './lib/credentials';
 
 export {
-  constants as serviceConstants,
   ServiceCatalog,
   ServiceRegistry,
   ServiceState,
-  ServiceInterceptor,
-  ServerErrorInterceptor,
   Services,
   ServiceHost,
   ServiceUrl,
-  HostMapInterceptor,
 } from './lib/services';
 
-export {
-  constants as serviceConstantsV2,
-  ServiceCatalogV2,
-  ServiceInterceptorV2,
-  ServerErrorInterceptorV2,
-  ServicesV2,
-  ServiceDetail,
-  HostMapInterceptorV2,
-} from './lib/services-v2';
-
+export {ServiceCatalogV2, ServicesV2, ServiceDetail} from './lib/services-v2';
+export * as serviceConstants from './lib/constants';
 export {
   makeWebexStore,
   makeWebexPluginStore,
@@ -68,6 +56,9 @@ export {default as WebexUserAgentInterceptor} from './interceptors/webex-user-ag
 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 HostMapInterceptor} from './lib/interceptors/hostmap';
+export {default as ServiceInterceptor} from './lib/interceptors/service';
+export {default as ServerErrorInterceptor} from './lib/interceptors/server-error';
 
 export {default as Batcher} from './lib/batcher';
 export {default as Page} from './lib/page';

package/src/lib/constants.js

@@ -1,6 +1,34 @@
 // Metric to do with WDM registration
-export const METRICS = {
+const METRICS = {
   JS_SDK_CREDENTIALS_DOWNSCOPE_FAILED: 'JS_SDK_CREDENTIALS_DOWNSCOPE_FAILED',
   JS_SDK_CREDENTIALS_TOKEN_REFRESH_SCOPE_MISMATCH:
     'JS_SDK_CREDENTIALS_TOKEN_REFRESH_SCOPE_MISMATCH',
 };
+
+const NAMESPACE = 'services';
+const SERVICE_CATALOGS = ['discovery', 'limited', 'signin', 'postauth', 'custom'];
+
+const SERVICE_CATALOGS_ENUM_TYPES = {
+  STRING: 'SERVICE_CATALOGS_ENUM_TYPES_STRING',
+  NUMBER: 'SERVICE_CATALOGS_ENUM_TYPES_NUMBER',
+};
+
+// The default allowed domains that SDK can make requests to outside of service catalog
+const COMMERCIAL_ALLOWED_DOMAINS = [
+  'wbx2.com',
+  'ciscospark.com',
+  'webex.com',
+  'webexapis.com',
+  'broadcloudpbx.com',
+  'broadcloud.eu',
+  'broadcloud.com.au',
+  'broadcloudpbx.net',
+];
+
+export {
+  SERVICE_CATALOGS_ENUM_TYPES,
+  NAMESPACE,
+  SERVICE_CATALOGS,
+  COMMERCIAL_ALLOWED_DOMAINS,
+  METRICS,
+};

package/src/lib/{services/interceptors → interceptors}/server-error.js

@@ -3,7 +3,7 @@
  */
 
 import {Interceptor} from '@webex/http-core';
-import WebexHttpError from '../../webex-http-error';
+import WebexHttpError from '../webex-http-error';
 /**
  * Changes server url when it fails
  */

package/src/lib/services/index.js

@@ -3,10 +3,9 @@
  */
 import {registerInternalPlugin} from '../../webex-core';
 
-import * as constants from './constants';
 import Services from './services';
-import ServerErrorInterceptor from './interceptors/server-error';
-import ServiceInterceptor from './interceptors/service';
+import ServerErrorInterceptor from '../interceptors/server-error';
+import ServiceInterceptor from '../interceptors/service';
 
 registerInternalPlugin('services', Services, {
   interceptors: {
@@ -15,10 +14,6 @@ registerInternalPlugin('services', Services, {
   },
 });
 
-export {constants};
-export {default as ServiceInterceptor} from './interceptors/service';
-export {default as ServerErrorInterceptor} from './interceptors/server-error';
-export {default as HostMapInterceptor} from './interceptors/hostmap';
 export {default as Services} from './services';
 export {default as ServiceCatalog} from './service-catalog';
 export {default as ServiceRegistry} from './service-registry';

package/src/lib/services/service-host.js

@@ -1,6 +1,6 @@
 import Url from 'url';
 
-import {SERVICE_CATALOGS} from './constants';
+import {SERVICE_CATALOGS} from '../constants';
 
 /**
  * The parameter transfer object for {@link ServiceHost#constructor}.

package/src/lib/services/service-registry.js

@@ -1,4 +1,4 @@
-import {SERVICE_CATALOGS, SERVICE_CATALOGS_ENUM_TYPES} from './constants';
+import {SERVICE_CATALOGS, SERVICE_CATALOGS_ENUM_TYPES} from '../constants';
 import ServiceHost from './service-host';
 
 /**

package/src/lib/services/service-state.js

@@ -1,4 +1,4 @@
-import {SERVICE_CATALOGS} from './constants';
+import {SERVICE_CATALOGS} from '../constants';
 
 /**
  * The state of a specific catalog to be used by {@link ServiceState}.

package/src/lib/services/services.js

@@ -3,12 +3,12 @@ import sha256 from 'crypto-js/sha256';
 import {union, forEach} from 'lodash';
 import WebexPlugin from '../webex-plugin';
 
-import METRICS from './metrics';
+import METRICS from '../metrics';
 import ServiceCatalog from './service-catalog';
 import ServiceRegistry from './service-registry';
 import ServiceState from './service-state';
 import fedRampServices from './service-fed-ramp';
-import {COMMERCIAL_ALLOWED_DOMAINS} from './constants';
+import {COMMERCIAL_ALLOWED_DOMAINS} from '../constants';
 
 const trailingSlashes = /(?:^\/)|(?:\/$)/;
 

package/src/lib/services-v2/index.ts

@@ -1,23 +1,7 @@
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
-// import {registerInternalPlugin} from '../../webex-core';
 
-import * as constants from './constants';
-// import ServerErrorInterceptor from './interceptors/server-error';
-// import ServiceInterceptor from './interceptors/service';
 export {default as ServicesV2} from './services-v2';
-
-// registerInternalPlugin('services', ServicesV2, {
-//   interceptors: {
-//     ServiceInterceptor: ServiceInterceptor.create,
-//     ServerErrorInterceptor: ServerErrorInterceptor.create,
-//   },
-// });
-
-export {constants};
-export {default as ServiceInterceptorV2} from './interceptors/service';
-export {default as ServerErrorInterceptorV2} from './interceptors/server-error';
-export {default as HostMapInterceptorV2} from './interceptors/hostmap';
 export {default as ServiceCatalogV2} from './service-catalog';
 export {default as ServiceDetail} from './service-detail';

package/src/lib/services-v2/service-catalog.ts

@@ -2,7 +2,7 @@ import AmpState from 'ampersand-state';
 
 import {union} from 'lodash';
 import ServiceDetail from './service-detail';
-import {IServiceDetail} from './types';
+import {IServiceDetail, ServiceGroup} from './types';
 
 /**
  * @class
@@ -55,10 +55,10 @@ const ServiceCatalog = AmpState.extend({
   /**
    * @private
    * Get all service details for a given service group or return all details if no group is specified.
-   * @param {string} serviceGroup - The name of the service group to retrieve details for.
+   * @param {ServiceGroup} serviceGroup - The name of the service group to retrieve details for.
    * @returns {Array<IServiceDetail>} - An array of service details.
    */
-  _getAllServiceDetails(serviceGroup: string): Array<IServiceDetail> {
+  _getAllServiceDetails(serviceGroup?: ServiceGroup): Array<IServiceDetail> {
     const serviceDetails =
       typeof serviceGroup === 'string'
         ? this.serviceGroups[serviceGroup] || []
@@ -78,10 +78,10 @@ const ServiceCatalog = AmpState.extend({
    * Search the service details array to locate a `ServiceDetails`
    * class object based on its id.
    * @param {string} clusterId
-   * @param {string} [serviceGroup]
+   * @param {ServiceGroup} [serviceGroup]
    * @returns {IServiceDetail}
    */
-  _getServiceDetail(clusterId: string, serviceGroup: string): IServiceDetail | undefined {
+  _getServiceDetail(clusterId: string, serviceGroup?: ServiceGroup): IServiceDetail | undefined {
     const serviceDetails = this._getAllServiceDetails(serviceGroup);
 
     return serviceDetails.find((serviceDetail: IServiceDetail) => serviceDetail.id === clusterId);
@@ -90,11 +90,11 @@ const ServiceCatalog = AmpState.extend({
   /**
    * @private
    * Safely load one or more `ServiceDetail`s into this `ServiceCatalog` instance.
-   * @param {string} serviceGroup
+   * @param {ServiceGroup} serviceGroup
    * @param  {Array<ServiceDetail>} serviceDetails
    * @returns {void}
    */
-  _loadServiceDetails(serviceGroup: string, serviceDetails: Array<IServiceDetail>): void {
+  _loadServiceDetails(serviceGroup: ServiceGroup, serviceDetails: Array<IServiceDetail>): void {
     // declare namespaces outside of loop
     let existingService: IServiceDetail | undefined;
 
@@ -110,11 +110,11 @@ const ServiceCatalog = AmpState.extend({
   /**
    * @private
    * Safely unload one or more `ServiceDetail`s into this `Services` instance
-   * @param {string} serviceGroup
+   * @param {ServiceGroup} serviceGroup
    * @param  {Array<ServiceDetail>} serviceDetails
    * @returns {void}
    */
-  _unloadServiceDetails(serviceGroup: string, serviceDetails: Array<IServiceDetail>): void {
+  _unloadServiceDetails(serviceGroup: ServiceGroup, serviceDetails: Array<IServiceDetail>): void {
     // declare namespaces outside of loop
     let existingService: IServiceDetail | undefined;
 
@@ -169,13 +169,13 @@ const ServiceCatalog = AmpState.extend({
    * clusterId.
    * @param {object} params
    * @param {string} params.clusterId - clusterId of found service
-   * @param {string} [params.serviceGroup] - specify service group
+   * @param {ServiceGroup} [params.serviceGroup] - specify service group
    * @returns {object} service
    * @returns {string} service.name
    * @returns {string} service.url
    */
   findServiceFromClusterId(
-    {clusterId, serviceGroup} = {} as {clusterId: string; serviceGroup: string}
+    {clusterId, serviceGroup} = {} as {clusterId: string; serviceGroup?: ServiceGroup}
   ): {name: string; url: string} | undefined {
     const serviceDetails = this._getServiceDetail(clusterId, serviceGroup);
 
@@ -226,12 +226,13 @@ const ServiceCatalog = AmpState.extend({
   },
 
   /**
-   * Get a service url from the current services list by name.
+   * Get a service url from the current services list by name. Return undefined
+   * if the service is not found.
    * @param {string} clusterId
-   * @param {string} serviceGroup
-   * @returns {string}
+   * @param {ServiceGroup} serviceGroup
+   * @returns {string | undefined}
    */
-  get(clusterId: string, serviceGroup: string): string | undefined {
+  get(clusterId: string, serviceGroup?: ServiceGroup): string | undefined {
     const serviceDetail = this._getServiceDetail(clusterId, serviceGroup);
 
     return serviceDetail ? serviceDetail.get() : undefined;
@@ -297,11 +298,11 @@ const ServiceCatalog = AmpState.extend({
    * service hostmap.
    * @emits ServiceCatalog#preauthorized
    * @emits ServiceCatalog#postauthorized
-   * @param {string} serviceGroup
+   * @param {ServiceGroup} serviceGroup
    * @param {Array<IServiceDetail>} serviceDetails
    * @returns {void}
    */
-  updateServiceGroups(serviceGroup: string, serviceDetails: Array<IServiceDetail>) {
+  updateServiceGroups(serviceGroup: ServiceGroup, serviceDetails: Array<IServiceDetail>) {
     const currentServiceDetails = this.serviceGroups[serviceGroup];
 
     const unusedServicesDetails = currentServiceDetails.filter((serviceDetail) =>
@@ -327,11 +328,11 @@ const ServiceCatalog = AmpState.extend({
   /**
    * Wait until the service catalog is available,
    * or reject after a timeout of 60 seconds.
-   * @param {string} serviceGroup
+   * @param {ServiceGroup} serviceGroup
    * @param {number} [timeout] - in seconds
    * @returns {Promise<void>}
    */
-  waitForCatalog(serviceGroup: string, timeout: number): Promise<void> {
+  waitForCatalog(serviceGroup: ServiceGroup, timeout?: number): Promise<void> {
     return new Promise<void>((resolve, reject) => {
       if (this.status[serviceGroup].ready) {
         resolve();