@iot-app-kit/core - npm Package Compare versions

Comparing version 9.7.0 to 9.8.0

dist/cjs/index.d.ts

@@ -18,4 +18,5 @@ export * from './data-module/data-cache/requestTypes';
 export declare const DAY_IN_MS: number;
-export type { Logger } from './logger/logger.interface';
-export type { MetricsRecorder } from './metric-recorder/metricsRecorder.interface';
+export type { Log, Logger } from './logger/logger.interface';
+export type { Metric, MetricsRecorder } from './metricRecorder/metricsRecorder.interface';
+export { registerPlugin, getPlugin } from './plugins/pluginsRegistry';
 //# sourceMappingURL=index.d.ts.map

dist/cjs/index.js

@@ -17,3 +17,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DAY_IN_MS = exports.HOUR_IN_MS = exports.MINUTE_IN_MS = exports.SECOND_IN_MS = exports.NANO_SECOND_IN_MS = exports.STATUS_ICON_TYPE = exports.COMPARISON_OPERATOR = exports.STREAM_TYPE = exports.DATA_TYPE = exports.TimeSeriesDataModule = exports.viewportStartDate = exports.viewportEndDate = exports.isHistoricalViewport = exports.viewportManager = exports.parseDuration = exports.pointBisector = exports.getDataBeforeDate = exports.getVisibleData = exports.round = exports.combineProviders = void 0;
+exports.getPlugin = exports.registerPlugin = exports.DAY_IN_MS = exports.HOUR_IN_MS = exports.MINUTE_IN_MS = exports.SECOND_IN_MS = exports.NANO_SECOND_IN_MS = exports.STATUS_ICON_TYPE = exports.COMPARISON_OPERATOR = exports.STREAM_TYPE = exports.DATA_TYPE = exports.TimeSeriesDataModule = exports.viewportStartDate = exports.viewportEndDate = exports.isHistoricalViewport = exports.viewportManager = exports.parseDuration = exports.pointBisector = exports.getDataBeforeDate = exports.getVisibleData = exports.round = exports.combineProviders = void 0;
 __exportStar(require("./data-module/data-cache/requestTypes"), exports);
@@ -54,1 +54,4 @@ __exportStar(require("./data-module/types"), exports);
 exports.DAY_IN_MS = 24 * exports.HOUR_IN_MS;
+var pluginsRegistry_1 = require("./plugins/pluginsRegistry");
+Object.defineProperty(exports, "registerPlugin", { enumerable: true, get: function () { return pluginsRegistry_1.registerPlugin; } });
+Object.defineProperty(exports, "getPlugin", { enumerable: true, get: function () { return pluginsRegistry_1.getPlugin; } });

dist/cjs/logger/logger.interface.d.ts

 /**
  * Log represents a single event message to record.
  */
-type Log = {
+export type Log = {
     /**
@@ -32,3 +32,2 @@ * Additional contexts to include.
 }
-export {};
 //# sourceMappingURL=logger.interface.d.ts.map

dist/cjs/plugins/loggerSettings.d.ts

 import type { Logger } from '../logger/logger.interface';
 export type LoggerSettings = {
-    provider: () => Logger;
+    provider: () => Logger | undefined;
 };
 //# sourceMappingURL=loggerSettings.d.ts.map

dist/cjs/plugins/metricsRecorderSettings.d.ts

@@ -1,5 +0,5 @@
-import type { MetricsRecorder } from '../metric-recorder/metricsRecorder.interface';
+import type { MetricsRecorder } from '../metricRecorder/metricsRecorder.interface';
 export type MetricsRecorderSettings = {
-    provider: () => MetricsRecorder;
+    provider: () => MetricsRecorder | undefined;
 };
 //# sourceMappingURL=metricsRecorderSettings.d.ts.map

dist/cjs/plugins/pluginsRegistry.d.ts

 import type { LoggerSettings } from './loggerSettings';
 import type { MetricsRecorderSettings } from './metricsRecorderSettings';
+interface PluginsRegistry {
+    logger: LoggerSettings;
+    metricsRecorder: MetricsRecorderSettings;
+}
 /**
- * Register a Logger for logging AppKit logs.
- * @param param0 settings for Logger
- * @alpha
+ * Registers a plugin under a namespace.
+ * @param namespace the namespace to register the plugin
+ * @param pluginSetting the setting object of the plugin to register
+ *
+ * @example
+ * // example of a registration and usage of metricsRecorder plugin
+ * registerPlugin('metricsRecorder', {
+ *   provider: () => ({
+ *     // record and console log all metrics
+ *     record: (metric) => {
+ *       console.log(metric);
+ *     },
+ *   }),
+ * });
  */
-export declare const registerLogger: (settings: LoggerSettings) => void;
+export declare function registerPlugin<Namespace extends keyof PluginsRegistry, PluginSetting extends PluginsRegistry[Namespace]>(namespace: Namespace, pluginSetting: PluginSetting): void;
 /**
- * Return the registered Logger.
- * @returns the registered Logger.
- * @alpha
+ * Returns the plugin of the given namespace.
+ * @param namespace the namespace of the plugin to retrieve
+ * @returns the plugin matching the given namespace
+ *
+ * @example
+ * // example of getting metricsRecorder plugin
+ * const metricsRecorder = getPlugin('metricsRecorder');
+ *
+ * metricsRecorder?.record({
+ *   metricName: 'test',
+ *   metricValue: 123
+ * });
  */
-export declare const getLogger: () => import("..").Logger | undefined;
-/**
- * Register a MetricsRecorder for recording AppKit metrics.
- * @param param0 settings for MetricsRecorder
- * @alpha
- */
-export declare const registerMetricsRecorder: (settings: MetricsRecorderSettings) => void;
-/**
- * Return the registered MetricsRecorder.
- * @returns the registered MetricsRecorder.
- * @alpha
- */
-export declare const getMetricsRecorder: () => import("..").MetricsRecorder | undefined;
+export declare function getPlugin<Namespace extends keyof PluginsRegistry>(namespace: Namespace): ReturnType<PluginsRegistry[Namespace]['provider']>;
+export {};
 //# sourceMappingURL=pluginsRegistry.d.ts.map

dist/cjs/plugins/pluginsRegistry.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMetricsRecorder = exports.registerMetricsRecorder = exports.getLogger = exports.registerLogger = void 0;
+exports.getPlugin = exports.registerPlugin = void 0;
 /**
@@ -9,34 +9,48 @@ * Internal object to hold all of the plugins.
  */
-const pluginsRegistry = {};
-/**
- * Register a Logger for logging AppKit logs.
- * @param param0 settings for Logger
- * @alpha
- */
-const registerLogger = (settings) => {
-    pluginsRegistry.loggerSettings = settings;
+const pluginsRegistry = {
+    logger: {
+        provider: () => undefined,
+    },
+    metricsRecorder: {
+        provider: () => undefined,
+    },
 };
-exports.registerLogger = registerLogger;
 /**
- * Return the registered Logger.
- * @returns the registered Logger.
- * @alpha
+ * Registers a plugin under a namespace.
+ * @param namespace the namespace to register the plugin
+ * @param pluginSetting the setting object of the plugin to register
+ *
+ * @example
+ * // example of a registration and usage of metricsRecorder plugin
+ * registerPlugin('metricsRecorder', {
+ *   provider: () => ({
+ *     // record and console log all metrics
+ *     record: (metric) => {
+ *       console.log(metric);
+ *     },
+ *   }),
+ * });
  */
-const getLogger = () => { var _a; return (_a = pluginsRegistry.loggerSettings) === null || _a === void 0 ? void 0 : _a.provider(); };
-exports.getLogger = getLogger;
+function registerPlugin(namespace, pluginSetting) {
+    pluginsRegistry[namespace] = pluginSetting;
+}
+exports.registerPlugin = registerPlugin;
 /**
- * Register a MetricsRecorder for recording AppKit metrics.
- * @param param0 settings for MetricsRecorder
- * @alpha
+ * Returns the plugin of the given namespace.
+ * @param namespace the namespace of the plugin to retrieve
+ * @returns the plugin matching the given namespace
+ *
+ * @example
+ * // example of getting metricsRecorder plugin
+ * const metricsRecorder = getPlugin('metricsRecorder');
+ *
+ * metricsRecorder?.record({
+ *   metricName: 'test',
+ *   metricValue: 123
+ * });
  */
-const registerMetricsRecorder = (settings) => {
-    pluginsRegistry.metricsRecorderSettings = settings;
-};
-exports.registerMetricsRecorder = registerMetricsRecorder;
-/**
- * Return the registered MetricsRecorder.
- * @returns the registered MetricsRecorder.
- * @alpha
- */
-const getMetricsRecorder = () => { var _a; return (_a = pluginsRegistry.metricsRecorderSettings) === null || _a === void 0 ? void 0 : _a.provider(); };
-exports.getMetricsRecorder = getMetricsRecorder;
+function getPlugin(namespace) {
+    const plugin = pluginsRegistry[namespace].provider();
+    return plugin;
+}
+exports.getPlugin = getPlugin;

dist/es/index.d.ts

@@ -18,4 +18,5 @@ export * from './data-module/data-cache/requestTypes';
 export declare const DAY_IN_MS: number;
-export type { Logger } from './logger/logger.interface';
-export type { MetricsRecorder } from './metric-recorder/metricsRecorder.interface';
+export type { Log, Logger } from './logger/logger.interface';
+export type { Metric, MetricsRecorder } from './metricRecorder/metricsRecorder.interface';
+export { registerPlugin, getPlugin } from './plugins/pluginsRegistry';
 //# sourceMappingURL=index.d.ts.map

dist/es/index.js

@@ -21,1 +21,2 @@ export * from './data-module/data-cache/requestTypes';
 export const DAY_IN_MS = 24 * HOUR_IN_MS;
+export { registerPlugin, getPlugin } from './plugins/pluginsRegistry';

dist/es/logger/logger.interface.d.ts

 /**
  * Log represents a single event message to record.
  */
-type Log = {
+export type Log = {
     /**
@@ -32,3 +32,2 @@ * Additional contexts to include.
 }
-export {};
 //# sourceMappingURL=logger.interface.d.ts.map

dist/es/plugins/loggerSettings.d.ts

 import type { Logger } from '../logger/logger.interface';
 export type LoggerSettings = {
-    provider: () => Logger;
+    provider: () => Logger | undefined;
 };
 //# sourceMappingURL=loggerSettings.d.ts.map

dist/es/plugins/metricsRecorderSettings.d.ts

@@ -1,5 +0,5 @@
-import type { MetricsRecorder } from '../metric-recorder/metricsRecorder.interface';
+import type { MetricsRecorder } from '../metricRecorder/metricsRecorder.interface';
 export type MetricsRecorderSettings = {
-    provider: () => MetricsRecorder;
+    provider: () => MetricsRecorder | undefined;
 };
 //# sourceMappingURL=metricsRecorderSettings.d.ts.map

dist/es/plugins/pluginsRegistry.d.ts

 import type { LoggerSettings } from './loggerSettings';
 import type { MetricsRecorderSettings } from './metricsRecorderSettings';
+interface PluginsRegistry {
+    logger: LoggerSettings;
+    metricsRecorder: MetricsRecorderSettings;
+}
 /**
- * Register a Logger for logging AppKit logs.
- * @param param0 settings for Logger
- * @alpha
+ * Registers a plugin under a namespace.
+ * @param namespace the namespace to register the plugin
+ * @param pluginSetting the setting object of the plugin to register
+ *
+ * @example
+ * // example of a registration and usage of metricsRecorder plugin
+ * registerPlugin('metricsRecorder', {
+ *   provider: () => ({
+ *     // record and console log all metrics
+ *     record: (metric) => {
+ *       console.log(metric);
+ *     },
+ *   }),
+ * });
  */
-export declare const registerLogger: (settings: LoggerSettings) => void;
+export declare function registerPlugin<Namespace extends keyof PluginsRegistry, PluginSetting extends PluginsRegistry[Namespace]>(namespace: Namespace, pluginSetting: PluginSetting): void;
 /**
- * Return the registered Logger.
- * @returns the registered Logger.
- * @alpha
+ * Returns the plugin of the given namespace.
+ * @param namespace the namespace of the plugin to retrieve
+ * @returns the plugin matching the given namespace
+ *
+ * @example
+ * // example of getting metricsRecorder plugin
+ * const metricsRecorder = getPlugin('metricsRecorder');
+ *
+ * metricsRecorder?.record({
+ *   metricName: 'test',
+ *   metricValue: 123
+ * });
  */
-export declare const getLogger: () => import("..").Logger | undefined;
-/**
- * Register a MetricsRecorder for recording AppKit metrics.
- * @param param0 settings for MetricsRecorder
- * @alpha
- */
-export declare const registerMetricsRecorder: (settings: MetricsRecorderSettings) => void;
-/**
- * Return the registered MetricsRecorder.
- * @returns the registered MetricsRecorder.
- * @alpha
- */
-export declare const getMetricsRecorder: () => import("..").MetricsRecorder | undefined;
+export declare function getPlugin<Namespace extends keyof PluginsRegistry>(namespace: Namespace): ReturnType<PluginsRegistry[Namespace]['provider']>;
+export {};
 //# sourceMappingURL=pluginsRegistry.d.ts.map

dist/es/plugins/pluginsRegistry.js

@@ -6,30 +6,46 @@ /**
  */
-const pluginsRegistry = {};
-/**
- * Register a Logger for logging AppKit logs.
- * @param param0 settings for Logger
- * @alpha
- */
-export const registerLogger = (settings) => {
-    pluginsRegistry.loggerSettings = settings;
+const pluginsRegistry = {
+    logger: {
+        provider: () => undefined,
+    },
+    metricsRecorder: {
+        provider: () => undefined,
+    },
 };
 /**
- * Return the registered Logger.
- * @returns the registered Logger.
- * @alpha
+ * Registers a plugin under a namespace.
+ * @param namespace the namespace to register the plugin
+ * @param pluginSetting the setting object of the plugin to register
+ *
+ * @example
+ * // example of a registration and usage of metricsRecorder plugin
+ * registerPlugin('metricsRecorder', {
+ *   provider: () => ({
+ *     // record and console log all metrics
+ *     record: (metric) => {
+ *       console.log(metric);
+ *     },
+ *   }),
+ * });
  */
-export const getLogger = () => { var _a; return (_a = pluginsRegistry.loggerSettings) === null || _a === void 0 ? void 0 : _a.provider(); };
+export function registerPlugin(namespace, pluginSetting) {
+    pluginsRegistry[namespace] = pluginSetting;
+}
 /**
- * Register a MetricsRecorder for recording AppKit metrics.
- * @param param0 settings for MetricsRecorder
- * @alpha
+ * Returns the plugin of the given namespace.
+ * @param namespace the namespace of the plugin to retrieve
+ * @returns the plugin matching the given namespace
+ *
+ * @example
+ * // example of getting metricsRecorder plugin
+ * const metricsRecorder = getPlugin('metricsRecorder');
+ *
+ * metricsRecorder?.record({
+ *   metricName: 'test',
+ *   metricValue: 123
+ * });
  */
-export const registerMetricsRecorder = (settings) => {
-    pluginsRegistry.metricsRecorderSettings = settings;
-};
-/**
- * Return the registered MetricsRecorder.
- * @returns the registered MetricsRecorder.
- * @alpha
- */
-export const getMetricsRecorder = () => { var _a; return (_a = pluginsRegistry.metricsRecorderSettings) === null || _a === void 0 ? void 0 : _a.provider(); };
+export function getPlugin(namespace) {
+    const plugin = pluginsRegistry[namespace].provider();
+    return plugin;
+}

package.json

@@ -7,3 +7,3 @@ {
   },
-  "version": "9.7.0",
+  "version": "9.8.0",
   "description": "IoT Application Kit core",
@@ -54,3 +54,3 @@ "main": "./dist/cjs/index.js",
   "dependencies": {
-    "@aws-sdk/client-iotsitewise": "3.391.0",
+    "@aws-sdk/client-iotsitewise": "3.456.0",
     "d3-array": "^3.2.4",
@@ -64,8 +64,8 @@ "intervals-fn": "^3.0.3",
   "devDependencies": {
-    "@iot-app-kit/jest-config": "9.7.0",
-    "@iot-app-kit/ts-config": "9.7.0",
+    "@iot-app-kit/jest-config": "9.8.0",
+    "@iot-app-kit/ts-config": "9.8.0",
     "@types/d3-array": "^3.0.5",
     "@types/jest": "^29.4.0",
     "@types/uuid": "^9.0.2",
-    "eslint-config-iot-app-kit": "9.7.0",
+    "eslint-config-iot-app-kit": "9.8.0",
     "flush-promises": "^1.0.2",
@@ -82,2 +82,2 @@ "jest": "^29.5.0",
   "homepage": "https://github.com/awslabs/iot-app-kit#readme"
-}
+}

No alert changes

Improved metrics

Total package byte prevSize

367655

increased by0.91%

Lines of code

5517

increased by1.06%

Dependency changes

• + Added@aws-sdk/client-iotsitewise@3.456.0(transitive)

• + Added@aws-sdk/client-sso@3.451.0(transitive)

• + Added@aws-sdk/client-sts@3.454.0(transitive)

• + Added@aws-sdk/core@3.451.0(transitive)

• + Added@aws-sdk/credential-provider-env@3.451.0(transitive)

• + Added@aws-sdk/credential-provider-ini@3.451.0(transitive)

• + Added@aws-sdk/credential-provider-node@3.451.0(transitive)

• + Added@aws-sdk/credential-provider-process@3.451.0(transitive)

• + Added@aws-sdk/credential-provider-sso@3.451.0(transitive)

• + Added@aws-sdk/credential-provider-web-identity@3.451.0(transitive)

• + Added@aws-sdk/middleware-host-header@3.451.0(transitive)

• + Added@aws-sdk/middleware-logger@3.451.0(transitive)

• + Added@aws-sdk/middleware-recursion-detection@3.451.0(transitive)

• + Added@aws-sdk/middleware-sdk-sts@3.451.0(transitive)

• + Added@aws-sdk/middleware-signing@3.451.0(transitive)

• + Added@aws-sdk/middleware-user-agent@3.451.0(transitive)

• + Added@aws-sdk/region-config-resolver@3.451.0(transitive)

• + Added@aws-sdk/token-providers@3.451.0(transitive)

• + Added@aws-sdk/types@3.451.0(transitive)

• + Added@aws-sdk/util-endpoints@3.451.0(transitive)

• + Added@aws-sdk/util-user-agent-browser@3.451.0(transitive)

• + Added@aws-sdk/util-user-agent-node@3.451.0(transitive)

• + Added@smithy/util-endpoints@1.2.0(transitive)

• - Removed@aws-sdk/client-iotsitewise@3.391.0(transitive)

• - Removed@aws-sdk/client-sso@3.391.0(transitive)

• - Removed@aws-sdk/client-sts@3.391.0(transitive)

• - Removed@aws-sdk/credential-provider-env@3.391.0(transitive)

• - Removed@aws-sdk/credential-provider-ini@3.391.0(transitive)

• - Removed@aws-sdk/credential-provider-node@3.391.0(transitive)

• - Removed@aws-sdk/credential-provider-process@3.391.0(transitive)

• - Removed@aws-sdk/credential-provider-sso@3.391.0(transitive)

• - Removed@aws-sdk/credential-provider-web-identity@3.391.0(transitive)

• - Removed@aws-sdk/middleware-host-header@3.391.0(transitive)

• - Removed@aws-sdk/middleware-logger@3.391.0(transitive)

• - Removed@aws-sdk/middleware-recursion-detection@3.391.0(transitive)

• - Removed@aws-sdk/middleware-sdk-sts@3.391.0(transitive)

• - Removed@aws-sdk/middleware-signing@3.391.0(transitive)

• - Removed@aws-sdk/middleware-user-agent@3.391.0(transitive)

• - Removed@aws-sdk/token-providers@3.391.0(transitive)

• - Removed@aws-sdk/types@3.391.0(transitive)

• - Removed@aws-sdk/util-endpoints@3.391.0(transitive)

• - Removed@aws-sdk/util-user-agent-browser@3.391.0(transitive)

• - Removed@aws-sdk/util-user-agent-node@3.391.0(transitive)

• - Removed@smithy/protocol-http@2.0.5(transitive)

• Updated@aws-sdk/client-iotsitewise@3.456.0