@salesforce/mrt-utilities 0.0.1 → 0.1.1

package/README.md

@@ -1,45 +1,49 @@
-# @salesforce/mrt-utilities
-
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@salesforce/mrt-utilities`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+# mrt-utilities
+
+Middleware and utilities to simulate a deployed MRT environment.
+
+## Usage
+
+```
+import {
+    createMRTProxyMiddlewares,
+    createMRTRequestProcessorMiddleware,
+    createMRTStaticAssetServingMiddleware,
+    createMRTCommonMiddleware,
+    createMRTCleanUpMiddleware,
+    isLocal,
+} from '@salesforce/mrt-utilities';
+
+
+export const createApp = (): Express => {
+    const app = express();
+    app.disable('x-powered-by');
+
+    // Top most middleware to set up headers
+    app.use(createMRTCommonMiddleware());
+
+    if (isLocal()) {
+        const requestProcessorPath = 'path/to/request-processor.js';
+        const proxyConfigs = [
+            {
+                host: 'https://example.com',
+                path: 'api',
+            },
+        ];
+        app.use(createMRTRequestProcessorMiddleware(requestProcessorPath, proxyConfigs));
+
+        const mrtProxies = createMRTProxyMiddlewares(proxyConfigs);
+        mrtProxies.forEach(({ path, fn }) => {
+            app.use(path, fn);
+        });
+
+        const staticAssetDir = 'path/to/static';
+        app.use(
+            `/mobify/bundle/${process.env.BUNDLE_ID || '1'}/static/`,
+            createMRTStaticAssetServingMiddleware(staticAssetDir)
+        );
+    }
+
+    // Cleans up any remaining headers and sets any remaining values
+    app.use(createMRTCleanUpMiddleware());
+```

package/dist/cjs/index.d.ts

@@ -0,0 +1,4 @@
+export * from './middleware/index.js';
+export * from './metrics/index.js';
+export * from './streaming/index.js';
+export { isLocal } from './utils/utils.js';

package/dist/cjs/index.js

@@ -0,0 +1,10 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+export * from './middleware/index.js';
+export * from './metrics/index.js';
+export * from './streaming/index.js';
+export { isLocal } from './utils/utils.js';
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAC,OAAO,EAAC,MAAM,kBAAkB,CAAC"}

package/dist/cjs/metrics/index.d.ts

@@ -0,0 +1 @@
+export * from './metrics-sender.js';

package/dist/cjs/metrics/index.js

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+export * from './metrics-sender.js';
+//# sourceMappingURL=index.js.map

package/dist/cjs/metrics/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/metrics/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,qBAAqB,CAAC"}

package/dist/cjs/metrics/metrics-sender.d.ts

@@ -0,0 +1,136 @@
+import { CloudWatchClient } from '@aws-sdk/client-cloudwatch';
+export declare const DEFAULT_NAMESPACE = "ssr";
+export declare const getDimensions: () => Record<string, string>;
+/**
+ * Input metric for sending to CloudWatch.
+ *
+ * @property name - The name of the metric (required)
+ * @property value - The numeric value of the metric (optional, defaults to 0)
+ * @property timestamp - The timestamp for the metric (optional, defaults to current time)
+ * @property unit - The unit for the metric (optional, defaults to 'Count')
+ * @property dimensions - Key-value pairs for metric dimensions (optional)
+ */
+interface InputMetric {
+    name: string;
+    value?: number;
+    timestamp?: Date;
+    unit?: string;
+    dimensions?: Record<string, string>;
+}
+/**
+ * A class that handles asynchronous sending of CloudWatch metrics.
+ *
+ * This class uses a singleton pattern. Use MetricsSender.getSender()
+ * to get the singleton instance. Metrics can be queued and sent in
+ * batches, or sent immediately. The class automatically batches metrics
+ * into groups of 20 (CloudWatch's limit per request).
+ *
+ * In local development environments, metrics are queued but not sent
+ * unless the SEND_CW_METRICS environment variable is set.
+ */
+export declare class MetricsSender {
+    private _CW;
+    private _queue;
+    static _override: boolean;
+    private static _instance;
+    /** @internal Test hook: inject a CloudWatch client for unit tests */
+    static _testClient: CloudWatchClient | null;
+    private constructor();
+    /**
+     * Return the number of metrics waiting to be sent
+     * @returns {number}
+     */
+    get queueLength(): number;
+    /**
+     * Create a CloudWatch AWS SDK client, or return a falsy value
+     * if this MetricsSender is not actually sending metrics.
+     *
+     * The client is only created when running in a remote environment
+     * (AWS Lambda) or when SEND_CW_METRICS environment variable is set.
+     * The client is configured with maxAttempts: 1 to prevent retries
+     * and reduce latency under high load.
+     *
+     * @private
+     * @returns {CloudWatchClient|null} The CloudWatch client, or null if not sending metrics
+     */
+    private _setup;
+    /**
+     * Convert InputMetric to MetricDatum format
+     *
+     * @private
+     * @param metric - Input metric to convert
+     * @param defaultTimestamp - Default timestamp to use if not provided
+     * @returns Converted metric datum
+     */
+    private _convertToMetricDatum;
+    /**
+     * Send metrics to CloudWatch using putMetricData.
+     *
+     * Errors are caught and logged but not re-thrown. If the client
+     * is null (local environment without SEND_CW_METRICS), this method
+     * returns immediately without sending.
+     *
+     * @private
+     * @param cw - CloudWatch client (may be null)
+     * @param metrics - Array of MetricDatum to send
+     * @returns Promise that resolves when the send operation completes (or immediately if client is null)
+     */
+    private _putMetricData;
+    /**
+     * Batch and send metrics. Handles batching into groups of 20 (CloudWatch limit)
+     * and sends them asynchronously (fire and forget). Errors are logged but not raised.
+     *
+     * @private
+     * @param metrics - Array of metrics to send
+     */
+    private _sendBatchedMetrics;
+    /**
+     * Send any queued metrics. Returns a Promise that resolves immediately
+     * after starting the send operations (fire and forget). Errors are logged
+     * but not raised. The queue is cleared before sending begins.
+     *
+     * @returns Promise that resolves immediately after starting send operations
+     */
+    flush(): Promise<void>;
+    /**
+     * Add one or more custom metric values to the queue of those waiting
+     * to be sent, or send them immediately. This function supports simple
+     * name-and-value metrics. It doesn't support more complex CloudWatch types.
+     *
+     * A metric is an object with at least 'name' (string) and optionally 'value'
+     * (number, defaults to 0). It may also optionally include 'timestamp'
+     * (defaults to the time of the call to send()), and 'unit', which
+     * must be one of Seconds, Microseconds, Milliseconds, Bytes, Kilobytes,
+     * Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits,
+     * Terabits, Percent, Count, Bytes/Second, Kilobytes/Second,
+     * Megabytes/Second, Gigabytes/Second, Terabytes/Second,
+     * Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second,
+     * Terabits/Second, Count/Second or None (defaults to 'Count').
+     * There may also be a 'dimensions'
+     * object, which has dimension names as keys and dimension
+     * values as values. Empty or falsy dimension values are filtered out.
+     *
+     * In a local development environment, metrics are queued but not sent
+     * unless the SEND_CW_METRICS environment variable is set. This allows
+     * for testing metric sending behavior locally.
+     *
+     * The metrics are added to an internal queue so that they can be
+     * batched up to send more efficiently. They are only sent when
+     * flush() is called, unless immediate is true.
+     *
+     * @private
+     * @param metrics - Array of InputMetric objects to send
+     * @param immediate - If true, send metrics immediately instead of queuing (default: false)
+     */
+    send(metrics: InputMetric[], immediate?: boolean): void;
+    /**
+     * Get the singleton MetricsSender instance.
+     *
+     * Creates a new instance if one doesn't exist, otherwise returns
+     * the existing instance.
+     *
+     * @returns The singleton MetricsSender instance
+     */
+    static getSender(): MetricsSender;
+}
+export {};

package/dist/cjs/metrics/metrics-sender.js

@@ -0,0 +1,240 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+import { CloudWatchClient, PutMetricDataCommand } from '@aws-sdk/client-cloudwatch';
+import { isLocal } from '../utils/utils.js';
+const isRemote = () => !isLocal();
+export const DEFAULT_NAMESPACE = 'ssr';
+export const getDimensions = () => {
+    return {
+        Project: process.env.MOBIFY_PROPERTY_ID || 'UNKNOWN',
+        Target: process.env.DEPLOY_TARGET || 'UNKNOWN',
+    };
+};
+/**
+ * A class that handles asynchronous sending of CloudWatch metrics.
+ *
+ * This class uses a singleton pattern. Use MetricsSender.getSender()
+ * to get the singleton instance. Metrics can be queued and sent in
+ * batches, or sent immediately. The class automatically batches metrics
+ * into groups of 20 (CloudWatch's limit per request).
+ *
+ * In local development environments, metrics are queued but not sent
+ * unless the SEND_CW_METRICS environment variable is set.
+ */
+export class MetricsSender {
+    _CW = null;
+    _queue = [];
+    static _override = false;
+    static _instance = null;
+    /** @internal Test hook: inject a CloudWatch client for unit tests */
+    static _testClient = null;
+    constructor() {
+        // CloudWatch client used to send metrics. For a local dev server,
+        // this will remain falsy, since a local dev server doesn't actually
+        // send metrics (unless SEND_CW_METRICS is defined for testing).
+        this._CW = null;
+        // A queue of metrics waiting to be sent. Each is a single
+        // name/value metric, and they accumulate on this queue
+        // until batched up into a putMetricData call.
+        this._queue = [];
+    }
+    /**
+     * Return the number of metrics waiting to be sent
+     * @returns {number}
+     */
+    get queueLength() {
+        return this._queue.length;
+    }
+    /**
+     * Create a CloudWatch AWS SDK client, or return a falsy value
+     * if this MetricsSender is not actually sending metrics.
+     *
+     * The client is only created when running in a remote environment
+     * (AWS Lambda) or when SEND_CW_METRICS environment variable is set.
+     * The client is configured with maxAttempts: 1 to prevent retries
+     * and reduce latency under high load.
+     *
+     * @private
+     * @returns {CloudWatchClient|null} The CloudWatch client, or null if not sending metrics
+     */
+    _setup() {
+        if (MetricsSender._testClient) {
+            this._CW = MetricsSender._testClient;
+            return this._CW;
+        }
+        /* istanbul ignore next */
+        if (!this._CW && (isRemote() || MetricsSender._override)) {
+            // The AWS_REGION variable is defined by the Lambda
+            // environment.
+            // Setting maxAttempts to 1 will prevent the SDK from retrying.
+            // This is necessary because under high load, there will be backpressure
+            // on the Lambda function, and causing severe performance issues (400-500ms latency)
+            this._CW = new CloudWatchClient({
+                region: process.env.AWS_REGION || 'us-east-1',
+                maxAttempts: 1,
+            });
+        }
+        return this._CW;
+    }
+    /**
+     * Convert InputMetric to MetricDatum format
+     *
+     * @private
+     * @param metric - Input metric to convert
+     * @param defaultTimestamp - Default timestamp to use if not provided
+     * @returns Converted metric datum
+     */
+    _convertToMetricDatum(metric, defaultTimestamp) {
+        const metricData = {
+            MetricName: metric.name,
+            Value: metric.value || 0,
+            Timestamp: metric.timestamp instanceof Date ? metric.timestamp : defaultTimestamp,
+            Unit: (metric.unit || 'Count'),
+        };
+        if (metric.dimensions) {
+            const dimensions = [];
+            Object.entries(metric.dimensions).forEach(([key, value]) => {
+                if (value) {
+                    dimensions.push({
+                        Name: key,
+                        Value: value,
+                    });
+                }
+            });
+            if (dimensions.length > 0) {
+                metricData.Dimensions = dimensions;
+            }
+        }
+        return metricData;
+    }
+    /**
+     * Send metrics to CloudWatch using putMetricData.
+     *
+     * Errors are caught and logged but not re-thrown. If the client
+     * is null (local environment without SEND_CW_METRICS), this method
+     * returns immediately without sending.
+     *
+     * @private
+     * @param cw - CloudWatch client (may be null)
+     * @param metrics - Array of MetricDatum to send
+     * @returns Promise that resolves when the send operation completes (or immediately if client is null)
+     */
+    async _putMetricData(cw, metrics) {
+        /* istanbul ignore next */
+        if (!cw) {
+            return Promise.resolve();
+        }
+        try {
+            const command = new PutMetricDataCommand({
+                MetricData: metrics,
+                Namespace: DEFAULT_NAMESPACE,
+            });
+            await cw.send(command);
+        }
+        catch (err) {
+            console.warn(`Metrics: error sending data: ${err}`);
+        }
+    }
+    /**
+     * Batch and send metrics. Handles batching into groups of 20 (CloudWatch limit)
+     * and sends them asynchronously (fire and forget). Errors are logged but not raised.
+     *
+     * @private
+     * @param metrics - Array of metrics to send
+     */
+    _sendBatchedMetrics(metrics) {
+        if (metrics.length === 0) {
+            return;
+        }
+        const cw = this._setup();
+        const promises = [];
+        const batchSize = 20;
+        for (let i = 0; i < metrics.length; i += batchSize) {
+            const batch = metrics.slice(i, i + batchSize);
+            promises.push(this._putMetricData(cw, batch));
+        }
+        // Wait for all promises to complete, log any errors but don't raise them
+        Promise.all(promises).catch(
+        /* istanbul ignore next */
+        (err) => {
+            console.warn(`Metrics: error during batch send: ${err}`);
+        });
+    }
+    /**
+     * Send any queued metrics. Returns a Promise that resolves immediately
+     * after starting the send operations (fire and forget). Errors are logged
+     * but not raised. The queue is cleared before sending begins.
+     *
+     * @returns Promise that resolves immediately after starting send operations
+     */
+    flush() {
+        const metricsToSend = [...this._queue];
+        this._queue = [];
+        this._sendBatchedMetrics(metricsToSend);
+        return Promise.resolve();
+    }
+    /**
+     * Add one or more custom metric values to the queue of those waiting
+     * to be sent, or send them immediately. This function supports simple
+     * name-and-value metrics. It doesn't support more complex CloudWatch types.
+     *
+     * A metric is an object with at least 'name' (string) and optionally 'value'
+     * (number, defaults to 0). It may also optionally include 'timestamp'
+     * (defaults to the time of the call to send()), and 'unit', which
+     * must be one of Seconds, Microseconds, Milliseconds, Bytes, Kilobytes,
+     * Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits,
+     * Terabits, Percent, Count, Bytes/Second, Kilobytes/Second,
+     * Megabytes/Second, Gigabytes/Second, Terabytes/Second,
+     * Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second,
+     * Terabits/Second, Count/Second or None (defaults to 'Count').
+     * There may also be a 'dimensions'
+     * object, which has dimension names as keys and dimension
+     * values as values. Empty or falsy dimension values are filtered out.
+     *
+     * In a local development environment, metrics are queued but not sent
+     * unless the SEND_CW_METRICS environment variable is set. This allows
+     * for testing metric sending behavior locally.
+     *
+     * The metrics are added to an internal queue so that they can be
+     * batched up to send more efficiently. They are only sent when
+     * flush() is called, unless immediate is true.
+     *
+     * @private
+     * @param metrics - Array of InputMetric objects to send
+     * @param immediate - If true, send metrics immediately instead of queuing (default: false)
+     */
+    send(metrics, immediate = false) {
+        const now = new Date();
+        const metricDataArray = metrics.map((metric) => this._convertToMetricDatum(metric, now));
+        if (immediate) {
+            // Send immediately without waiting (fire and forget)
+            this._sendBatchedMetrics(metricDataArray);
+        }
+        else {
+            // Add to queue
+            this._queue.push(...metricDataArray);
+        }
+    }
+    /**
+     * Get the singleton MetricsSender instance.
+     *
+     * Creates a new instance if one doesn't exist, otherwise returns
+     * the existing instance.
+     *
+     * @returns The singleton MetricsSender instance
+     */
+    static getSender() {
+        if (!MetricsSender._instance) {
+            MetricsSender._instance = new MetricsSender();
+        }
+        return MetricsSender._instance;
+    }
+}
+// Allow the presence of an environment variable to
+// enable sending of CloudWatch metrics (for local
+// integration testing)
+MetricsSender._override = !!process.env.SEND_CW_METRICS;
+//# sourceMappingURL=metrics-sender.js.map

package/dist/cjs/metrics/metrics-sender.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics-sender.js","sourceRoot":"","sources":["../../../src/metrics/metrics-sender.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAC,gBAAgB,EAAE,oBAAoB,EAAsC,MAAM,4BAA4B,CAAC;AACvH,OAAO,EAAC,OAAO,EAAC,MAAM,mBAAmB,CAAC;AAE1C,MAAM,QAAQ,GAAG,GAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;AAE3C,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,CAAC;AAEvC,MAAM,CAAC,MAAM,aAAa,GAAG,GAA2B,EAAE;IACxD,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,SAAS;QACpD,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,SAAS;KAC/C,CAAC;AACJ,CAAC,CAAC;AAmBF;;;;;;;;;;GAUG;AACH,MAAM,OAAO,aAAa;IAChB,GAAG,GAA4B,IAAI,CAAC;IACpC,MAAM,GAAkB,EAAE,CAAC;IACnC,MAAM,CAAC,SAAS,GAAY,KAAK,CAAC;IAC1B,MAAM,CAAC,SAAS,GAAyB,IAAI,CAAC;IAEtD,qEAAqE;IACrE,MAAM,CAAC,WAAW,GAA4B,IAAI,CAAC;IAEnD;QACE,kEAAkE;QAClE,oEAAoE;QACpE,gEAAgE;QAChE,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;QAEhB,0DAA0D;QAC1D,uDAAuD;QACvD,8CAA8C;QAC9C,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED;;;;;;;;;;;OAWG;IACK,MAAM;QACZ,IAAI,aAAa,CAAC,WAAW,EAAE,CAAC;YAC9B,IAAI,CAAC,GAAG,GAAG,aAAa,CAAC,WAAW,CAAC;YACrC,OAAO,IAAI,CAAC,GAAG,CAAC;QAClB,CAAC;QACD,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;YACzD,mDAAmD;YACnD,eAAe;YACf,+DAA+D;YAC/D,wEAAwE;YACxE,oFAAoF;YACpF,IAAI,CAAC,GAAG,GAAG,IAAI,gBAAgB,CAAC;gBAC9B,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;gBAC7C,WAAW,EAAE,CAAC;aACf,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACK,qBAAqB,CAAC,MAAmB,EAAE,gBAAsB;QACvE,MAAM,UAAU,GAAgB;YAC9B,UAAU,EAAE,MAAM,CAAC,IAAI;YACvB,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;YACxB,SAAS,EAAE,MAAM,CAAC,SAAS,YAAY,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,gBAAgB;YACjF,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,CAAiB;SAC/C,CAAC;QAEF,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACtB,MAAM,UAAU,GAAyC,EAAE,CAAC;YAC5D,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gBACzD,IAAI,KAAK,EAAE,CAAC;oBACV,UAAU,CAAC,IAAI,CAAC;wBACd,IAAI,EAAE,GAAG;wBACT,KAAK,EAAE,KAAK;qBACb,CAAC,CAAC;gBACL,CAAC;YACH,CAAC,CAAC,CAAC;YACH,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC;YACrC,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;OAWG;IACK,KAAK,CAAC,cAAc,CAAC,EAA2B,EAAE,OAAsB;QAC9E,0BAA0B;QAC1B,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;QAED,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,oBAAoB,CAAC;gBACvC,UAAU,EAAE,OAAO;gBACnB,SAAS,EAAE,iBAAiB;aAC7B,CAAC,CAAC;YACH,MAAM,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,CAAC,IAAI,CAAC,gCAAgC,GAAG,EAAE,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,mBAAmB,CAAC,OAAsB;QAChD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO;QACT,CAAC;QAED,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,MAAM,SAAS,GAAG,EAAE,CAAC;QAErB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,IAAI,SAAS,EAAE,CAAC;YACnD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC;YAC9C,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QAChD,CAAC;QAED,yEAAyE;QACzE,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK;QACzB,0BAA0B;QAC1B,CAAC,GAAG,EAAE,EAAE;YACN,OAAO,CAAC,IAAI,CAAC,qCAAqC,GAAG,EAAE,CAAC,CAAC;QAC3D,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK;QACH,MAAM,aAAa,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QACxC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,IAAI,CAAC,OAAsB,EAAE,YAAqB,KAAK;QACrD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,eAAe,GAAkB,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;QAExG,IAAI,SAAS,EAAE,CAAC;YACd,qDAAqD;YACrD,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,eAAe;YACf,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS;QACd,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC;YAC7B,aAAa,CAAC,SAAS,GAAG,IAAI,aAAa,EAAE,CAAC;QAChD,CAAC;QACD,OAAO,aAAa,CAAC,SAAS,CAAC;IACjC,CAAC;;AAGH,mDAAmD;AACnD,kDAAkD;AAClD,uBAAuB;AACvB,aAAa,CAAC,SAAS,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC"}

package/dist/cjs/middleware/data-store.d.ts

@@ -0,0 +1,56 @@
+import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
+export declare class DataStoreNotFoundError extends Error {
+    constructor(message: string);
+}
+export declare class DataStoreServiceError extends Error {
+    constructor(message: string);
+}
+export declare class DataStoreUnavailableError extends Error {
+    constructor(message: string);
+}
+/**
+ * A class for reading entries from the data store.
+ *
+ * This class uses a singleton pattern.
+ * Use DataStore.getDataStore() to get the singleton instance.
+ */
+export declare class DataStore {
+    private _tableName;
+    private _ddb;
+    private static _instance;
+    /** @internal Test hook: inject a document client for unit tests */
+    static _testDocumentClient: DynamoDBDocumentClient | null;
+    /** @internal Test hook: inject logMRTError for unit tests */
+    static _testLogMRTError: ((namespace: string, err: unknown, context?: Record<string, unknown>) => void) | null;
+    private constructor();
+    /**
+     * Get or create a DynamoDB document client (for abstraction of attribute values).
+     *
+     * @private
+     * @returns The DynamoDB document client
+     * @throws {DataStoreUnavailableError} The data store is unavailable
+     */
+    private getClient;
+    /**
+     * Get or create the singleton DataStore instance.
+     *
+     * @returns The singleton DataStore instance
+     */
+    static getDataStore(): DataStore;
+    /**
+     * Whether the data store can be used in the current environment.
+     *
+     * @returns true if the data store is available, false otherwise
+     */
+    isDataStoreAvailable(): boolean;
+    /**
+     * Fetch an entry from the data store.
+     *
+     * @param key The data store entry's key
+     * @returns An object containing the entry's key and value
+     * @throws {DataStoreUnavailableError} The data store is unavailable
+     * @throws {DataStoreNotFoundError} An entry with the given key cannot be found
+     * @throws {DataStoreServiceError} An internal error occurred
+     */
+    getEntry(key: string): Promise<Record<string, unknown> | undefined>;
+}