@webex/webex-core 3.8.1-next.1 → 3.8.1-next.2

package/README.md

@@ -1,16 +1,6 @@
 # @webex/webex-core
 
-[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
-
-> Core library for the Cisco Webex JS SDK.
-
-Defines the plugin system, storage system, common http behaviors, credentials, services, and basic logging.
-
-- [Install](#install)
-- [Usage](#usage)
-- [Contribute](#contribute)
-- [Maintainers](#maintainers)
-- [License](#license)
+Core library for the Cisco Webex JS SDK.
 
 ## Install
 
@@ -18,11 +8,43 @@ Defines the plugin system, storage system, common http behaviors, credentials, s
 npm install --save @webex/webex-core
 ```
 
-## Usage
+## What it Does
+
+The webex-core package provides the foundational architecture for the Webex JavaScript SDK, including:
+
+- Plugin system for loading and managing SDK plugins
+- Storage system for data persistence across environments
+- HTTP core for common request handling
+- Credentials management for token handling
+- Service discovery for dynamic endpoint resolution
+- Logging framework for debugging
+
+## Basic Usage
+
+```js
+import WebexCore from '@webex/webex-core';
+
+// Create a basic Webex instance
+const webex = new WebexCore({
+  credentials: {
+    access_token: 'your-access-token'
+  }
+});
+
+// Use core functionality
+webex.request({
+  method: 'GET',
+  uri: 'https://webexapis.com/v1/people/me'
+}).then(response => {
+  console.log('User info:', response.body);
+});
+```
+
+## Configuration
 
 ### Client Scope Requirements
 
-To utilize the basic functionality of the `services` plugin that is bound to the `webex-core` plugin upon initialization, the following scopes must be present in the provided client's scopes:
+To utilize the basic functionality of the services plugin, the following scopes must be present in the client's scopes:
 
 - `spark:all`
 
@@ -30,44 +52,82 @@ To utilize the basic functionality of the `services` plugin that is bound to the
 
 The following environment variables are used by this plugin:
 
-- `HYDRA_SERVICE_URL` - Stores the public hydra api url for managing Webex resources.
-- `U2C_SERVICE_URL` - Stores the service catalog collecting url, typically the **U2C** service.
+- `HYDRA_SERVICE_URL` - Stores the public hydra api url for managing Webex resources
+- `U2C_SERVICE_URL` - Stores the service catalog collecting url, typically the U2C service
 - `SQDISCOVERY_SERVICE_URL` - Stores the URL for client region information, such as country code and timezone
 
-### Configuration
+### Advanced Configuration
 
-The `services` plugin that is bound to the `webex-core` plugin upon initialization supports the ability to inject discovery urls via the constructor:
+The services plugin supports the ability to inject discovery urls via the constructor:
 
 ```js
-const webex = new Webex({
+const webex = new WebexCore({
   config: {
     services: {
-      // Services that are available before catalog retrieval.
+      // Services that are available before catalog retrieval
       discovery: {
         hydra: 'https://api.ciscospark.com/v1',
         sqdiscovery: 'https://ds.ciscospark.com/v1/region'
       },
 
-      // Services that have a persistant host, typically for testing.
+      // Services that have a persistent host, typically for testing
       override: {
         serviceName: 'https://api.service.com/v1'
-      }
+      },
 
-      // Validate domains against the allowed domains.
+      // Validate domains against the allowed domains
       validateDomains: true,
 
-      // The allowed domains to validate domains against.
+      // The allowed domains to validate domains against
       allowedDomains: ['allowed-domain']
     }
   }
 });
 ```
 
+### Default Service URLs
+
 The default configuration includes the following service urls:
 
-- `U2C_SERVICE_URL` [ **U2C** ] - `https://u2c.wbx2.com/u2c/api/v1`
-- `HYDRA_SERVICE_URL` [ **Hydra** ] - `https://api.ciscospark.com/v1`
-- `SQDISCOVERY_SERVICE_URL` [ **SQDISCOVERY** ] - `https://ds.ciscospark.com/v1/region`
+- `U2C_SERVICE_URL` [U2C] - `https://u2c.wbx2.com/u2c/api/v1`
+- `HYDRA_SERVICE_URL` [Hydra] - `https://webexapis.com/v1`
+- `SQDISCOVERY_SERVICE_URL` [SQDISCOVERY] - `https://ds.ciscospark.com/v1/region`
+
+## Plugin System
+
+WebexCore provides a plugin architecture that allows extending functionality:
+
+```js
+import WebexCore from '@webex/webex-core';
+import MyPlugin from './my-plugin';
+
+// Register a plugin
+WebexCore.registerPlugin('myPlugin', MyPlugin);
+
+const webex = new WebexCore();
+// Plugin is now available at webex.myPlugin
+```
+
+## Storage System
+
+WebexCore includes a unified storage interface:
+
+```js
+// Configure storage adapter
+const webex = new WebexCore({
+  config: {
+    storage: {
+      adapter: 'localStorage' // or 'memory', 'indexedDB', etc.
+    }
+  }
+});
+
+// Use storage
+webex.storage.put('key', 'value');
+webex.storage.get('key').then(value => console.log(value));
+```
+
+This package is the foundation for all Webex SDK functionality and is required for most other Webex SDK packages.
 
 ## Maintainers
 
@@ -79,4 +139,4 @@ Pull requests welcome. Please see [CONTRIBUTING.md](https://github.com/webex/web
 
 ## License
 
-© 2016-2020 Cisco and/or its affiliates. All Rights Reserved.
+© 2016-2025 Cisco and/or its affiliates. All Rights Reserved.

package/dist/lib/batcher.js

@@ -286,7 +286,7 @@ var Batcher = _webexPlugin.default.extend({
   fingerprintResponse: function fingerprintResponse(item) {
     throw new Error('fingerprintResponse() must be implemented');
   },
-  version: "3.8.1-next.1"
+  version: "3.8.1-next.2"
 });
 var _default2 = exports.default = Batcher;
 //# sourceMappingURL=batcher.js.map

package/dist/lib/credentials/credentials.js

@@ -558,7 +558,7 @@ var Credentials = _webexPlugin.default.extend((_dec = (0, _common.oneFlight)({
       this.refresh();
     }
   },
-  version: "3.8.1-next.1"
+  version: "3.8.1-next.2"
 }, ((0, _applyDecoratedDescriptor2.default)(_obj, "getUserToken", [_dec, _dec2], (0, _getOwnPropertyDescriptor.default)(_obj, "getUserToken"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "initialize", [_dec3], (0, _getOwnPropertyDescriptor.default)(_obj, "initialize"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "invalidate", [_common.oneFlight, _dec4], (0, _getOwnPropertyDescriptor.default)(_obj, "invalidate"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "refresh", [_common.oneFlight, _dec5, _dec6], (0, _getOwnPropertyDescriptor.default)(_obj, "refresh"), _obj)), _obj)));
 var _default = exports.default = Credentials;
 //# sourceMappingURL=credentials.js.map

package/dist/lib/credentials/token.js

@@ -532,7 +532,7 @@ var Token = _webexPlugin.default.extend((_dec = (0, _common.oneFlight)({
       return res.body;
     });
   },
-  version: "3.8.1-next.1"
+  version: "3.8.1-next.2"
 }, ((0, _applyDecoratedDescriptor2.default)(_obj, "downscope", [_dec], (0, _getOwnPropertyDescriptor.default)(_obj, "downscope"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "refresh", [_common.oneFlight], (0, _getOwnPropertyDescriptor.default)(_obj, "refresh"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "revoke", [_common.oneFlight], (0, _getOwnPropertyDescriptor.default)(_obj, "revoke"), _obj)), _obj)));
 var _default = exports.default = Token;
 //# sourceMappingURL=token.js.map

package/dist/lib/services/services.js

@@ -1067,7 +1067,7 @@ var Services = _webexPlugin.default.extend({
       }
     });
   },
-  version: "3.8.1-next.1"
+  version: "3.8.1-next.2"
 });
 /* eslint-enable no-underscore-dangle */
 var _default = exports.default = Services;

package/dist/lib/services-v2/services-v2.js

@@ -978,7 +978,7 @@ var Services = _webexPlugin.default.extend({
       }
     });
   },
-  version: "3.8.1-next.1"
+  version: "3.8.1-next.2"
 });
 /* eslint-enable no-underscore-dangle */
 var _default = exports.default = Services;

package/dist/plugins/logger.js

@@ -57,7 +57,7 @@ var Logger = _webexPlugin.default.extend({
   info: wrapConsoleMethod('info'),
   debug: wrapConsoleMethod('debug'),
   trace: wrapConsoleMethod('trace'),
-  version: "3.8.1-next.1"
+  version: "3.8.1-next.2"
 });
 (0, _webexCore.registerPlugin)('logger', Logger);
 var _default = exports.default = Logger;

package/dist/webex-core.js

@@ -96,7 +96,7 @@ var MAX_FILE_SIZE_IN_MB = 2048;
  * @class
  */
 var WebexCore = _ampersandState.default.extend((_obj = {
-  version: "3.8.1-next.1",
+  version: "3.8.1-next.2",
   children: {
     internal: _webexInternalCore.default
   },
@@ -642,7 +642,7 @@ var WebexCore = _ampersandState.default.extend((_obj = {
     });
   }
 }, ((0, _applyDecoratedDescriptor2.default)(_obj, "_uploadPhaseUpload", [_common.retry], (0, _getOwnPropertyDescriptor.default)(_obj, "_uploadPhaseUpload"), _obj)), _obj));
-WebexCore.version = "3.8.1-next.1";
+WebexCore.version = "3.8.1-next.2";
 (0, _webexInternalCorePluginMixin.default)(_webexInternalCore.default, _config.default, interceptors);
 (0, _webexCorePluginMixin.default)(WebexCore, _config.default, interceptors);
 var _default = exports.default = WebexCore;

package/package.json

@@ -35,12 +35,12 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.8.1-next.1",
-    "@webex/test-helper-make-local-url": "3.8.1-next.1",
-    "@webex/test-helper-mocha": "3.8.1-next.1",
-    "@webex/test-helper-mock-webex": "3.8.1-next.1",
-    "@webex/test-helper-refresh-callback": "3.8.1-next.1",
-    "@webex/test-helper-test-users": "3.8.1-next.1",
+    "@webex/test-helper-chai": "3.8.1-next.2",
+    "@webex/test-helper-make-local-url": "3.8.1-next.2",
+    "@webex/test-helper-mocha": "3.8.1-next.2",
+    "@webex/test-helper-mock-webex": "3.8.1-next.2",
+    "@webex/test-helper-refresh-callback": "3.8.1-next.2",
+    "@webex/test-helper-test-users": "3.8.1-next.2",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.24.0",
@@ -48,12 +48,12 @@
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.8.1-next.1",
-    "@webex/common-timers": "3.8.1-next.1",
-    "@webex/http-core": "3.8.1-next.1",
-    "@webex/internal-plugin-device": "3.8.1-next.1",
-    "@webex/plugin-logger": "3.8.1-next.1",
-    "@webex/storage-adapter-spec": "3.8.1-next.1",
+    "@webex/common": "3.8.1-next.2",
+    "@webex/common-timers": "3.8.1-next.2",
+    "@webex/http-core": "3.8.1-next.2",
+    "@webex/internal-plugin-device": "3.8.1-next.2",
+    "@webex/plugin-logger": "3.8.1-next.2",
+    "@webex/storage-adapter-spec": "3.8.1-next.2",
     "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-next.1"
+  "version": "3.8.1-next.2"
 }