@jeongsu816/matrix-bot-sdk 0.0.0-stage → 0.8.1

package/lib/metrics/Metrics.d.ts

@@ -0,0 +1,66 @@
+import { IMetricListener } from "./IMetricListener";
+import { IMetricContext } from "./contexts";
+/**
+ * Tracks metrics.
+ * @category Metrics
+ */
+export declare class Metrics {
+    private listeners;
+    private requestStartTimes;
+    private uid;
+    /**
+     * Creates a new Metrics handler with optional parent handler. When
+     * a parent handler is defined, metrics will be automatically published
+     * upwards to the parent.
+     * @param {Metrics} parent Optional parent for upstream metrics.
+     */
+    constructor(parent?: Metrics);
+    /**
+     * Registers a metric listener.
+     * @param {IMetricListener} listener The listener.
+     */
+    registerListener(listener: IMetricListener): void;
+    /**
+     * De-registers a metric listener.
+     * @param {IMetricListener} listener The listener.
+     */
+    unregisterListener(listener: IMetricListener): void;
+    /**
+     * Starts a timer on a metric.
+     * @param {string} metricName The metric name.
+     * @param {IMetricContext} context The metric context. Expected to have a unique ID.
+     */
+    start(metricName: string, context: IMetricContext): void;
+    /**
+     * Ends a timer on a metric.
+     * @param {string} metricName The metric name.
+     * @param {IMetricContext} context The metric context. Expected to have a unique ID.
+     */
+    end(metricName: string, context: IMetricContext): void;
+    /**
+     * Increments a metric.
+     * @param {string} metricName The metric name.
+     * @param {IMetricContext} context The metric context. Expected to have a unique ID.
+     * @param {number} amount The amount.
+     */
+    increment(metricName: string, context: IMetricContext, amount: number): void;
+    /**
+     * Decrements a metric.
+     * @param {string} metricName The metric name.
+     * @param {IMetricContext} context The metric context. Expected to have a unique ID.
+     * @param {number} amount The amount.
+     */
+    decrement(metricName: string, context: IMetricContext, amount: number): void;
+    /**
+     * Resets a metric.
+     * @param {string} metricName The metric name.
+     * @param {IMetricContext} context The metric context. Expected to have a unique ID.
+     */
+    reset(metricName: string, context: IMetricContext): void;
+    /**
+     * Assigns a unique ID to the context object, returning it back.
+     * @param {IMetricContext} context The context to modify.
+     * @returns {IMetricContext} The provided context.
+     */
+    assignUniqueContextId(context: IMetricContext): IMetricContext;
+}

package/lib/metrics/Metrics.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Metrics = void 0;
+const __1 = require("..");
+/**
+ * Tracks metrics.
+ * @category Metrics
+ */
+class Metrics {
+    /**
+     * Creates a new Metrics handler with optional parent handler. When
+     * a parent handler is defined, metrics will be automatically published
+     * upwards to the parent.
+     * @param {Metrics} parent Optional parent for upstream metrics.
+     */
+    constructor(parent = null) {
+        this.listeners = [];
+        this.requestStartTimes = {};
+        this.uid = 0;
+        if (parent !== null) {
+            this.registerListener({
+                onIncrement(metricName, context, amount) {
+                    parent.listeners.forEach(h => h.onIncrement(metricName, context, amount));
+                },
+                onDecrement(metricName, context, amount) {
+                    parent.listeners.forEach(h => h.onDecrement(metricName, context, amount));
+                },
+                onReset(metricName, context) {
+                    parent.listeners.forEach(h => h.onReset(metricName, context));
+                },
+                onStartMetric(metricName, context) {
+                    parent.listeners.forEach(h => h.onStartMetric(metricName, context));
+                },
+                onEndMetric(metricName, context, timeMs) {
+                    parent.listeners.forEach(h => h.onEndMetric(metricName, context, timeMs));
+                },
+            });
+        }
+    }
+    /**
+     * Registers a metric listener.
+     * @param {IMetricListener} listener The listener.
+     */
+    registerListener(listener) {
+        this.listeners.push(listener);
+    }
+    /**
+     * De-registers a metric listener.
+     * @param {IMetricListener} listener The listener.
+     */
+    unregisterListener(listener) {
+        const idx = this.listeners.indexOf(listener);
+        if (idx !== -1)
+            this.listeners.splice(idx, 1);
+    }
+    /**
+     * Starts a timer on a metric.
+     * @param {string} metricName The metric name.
+     * @param {IMetricContext} context The metric context. Expected to have a unique ID.
+     */
+    start(metricName, context) {
+        this.requestStartTimes[context.uniqueId] = new Date().getTime();
+        this.listeners.forEach(h => h.onStartMetric(metricName, context));
+    }
+    /**
+     * Ends a timer on a metric.
+     * @param {string} metricName The metric name.
+     * @param {IMetricContext} context The metric context. Expected to have a unique ID.
+     */
+    end(metricName, context) {
+        const timeMs = (new Date().getTime()) - this.requestStartTimes[context.uniqueId];
+        delete this.requestStartTimes[context.uniqueId];
+        this.listeners.forEach(h => h.onEndMetric(metricName, context, timeMs));
+        // Trim the context for logging
+        const trimmedContext = {};
+        for (const key of Object.keys(context)) {
+            if (key === 'client') {
+                const client = context[key];
+                trimmedContext[key] = `<MatrixClient ${client['userId'] || 'NoCachedUserID'}>`;
+            }
+            else if (key === 'intent') {
+                const intent = context[key];
+                trimmedContext[key] = `<Intent ${intent['userId'] || 'NoImpersonatedUserID'}>`;
+            }
+            else {
+                trimmedContext[key] = context[key];
+            }
+        }
+        __1.LogService.trace("Metrics", metricName, trimmedContext, timeMs);
+    }
+    /**
+     * Increments a metric.
+     * @param {string} metricName The metric name.
+     * @param {IMetricContext} context The metric context. Expected to have a unique ID.
+     * @param {number} amount The amount.
+     */
+    increment(metricName, context, amount) {
+        this.listeners.forEach(h => h.onIncrement(metricName, context, amount));
+    }
+    /**
+     * Decrements a metric.
+     * @param {string} metricName The metric name.
+     * @param {IMetricContext} context The metric context. Expected to have a unique ID.
+     * @param {number} amount The amount.
+     */
+    decrement(metricName, context, amount) {
+        this.listeners.forEach(h => h.onDecrement(metricName, context, amount));
+    }
+    /**
+     * Resets a metric.
+     * @param {string} metricName The metric name.
+     * @param {IMetricContext} context The metric context. Expected to have a unique ID.
+     */
+    reset(metricName, context) {
+        this.listeners.forEach(h => h.onReset(metricName, context));
+    }
+    /**
+     * Assigns a unique ID to the context object, returning it back.
+     * @param {IMetricContext} context The context to modify.
+     * @returns {IMetricContext} The provided context.
+     */
+    assignUniqueContextId(context) {
+        context.uniqueId = `${new Date().getTime()}-${this.uid++}`;
+        return context;
+    }
+}
+exports.Metrics = Metrics;
+//# sourceMappingURL=Metrics.js.map

package/lib/metrics/Metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metrics.js","sourceRoot":"","sources":["../../src/metrics/Metrics.ts"],"names":[],"mappings":";;;AAEA,0BAAgC;AAEhC;;;GAGG;AACH,MAAa,OAAO;IAKhB;;;;;OAKG;IACH,YAAY,SAAkB,IAAI;QAV1B,cAAS,GAAsB,EAAE,CAAC;QAClC,sBAAiB,GAAoC,EAAE,CAAC;QACxD,QAAG,GAAG,CAAC,CAAC;QASZ,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAClB,IAAI,CAAC,gBAAgB,CAAC;gBAClB,WAAW,CAAC,UAAkB,EAAE,OAAuB,EAAE,MAAc;oBACnE,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;gBAC9E,CAAC;gBACD,WAAW,CAAC,UAAkB,EAAE,OAAuB,EAAE,MAAc;oBACnE,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;gBAC9E,CAAC;gBACD,OAAO,CAAC,UAAkB,EAAE,OAAuB;oBAC/C,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;gBAClE,CAAC;gBACD,aAAa,CAAC,UAAkB,EAAE,OAAuB;oBACrD,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;gBACxE,CAAC;gBACD,WAAW,CAAC,UAAkB,EAAE,OAAuB,EAAE,MAAc;oBACnE,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;gBAC9E,CAAC;aACJ,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,QAAyB;QAC7C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,QAAyB;QAC/C,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7C,IAAI,GAAG,KAAK,CAAC,CAAC;YAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAkB,EAAE,OAAuB;QACpD,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAChE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,UAAkB,EAAE,OAAuB;QAClD,MAAM,MAAM,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACjF,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;QAExE,+BAA+B;QAC/B,MAAM,cAAc,GAAG,EAAE,CAAC;QAC1B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;gBACnB,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;gBAC5B,cAAc,CAAC,GAAG,CAAC,GAAG,iBAAiB,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,GAAG,CAAC;YACnF,CAAC;iBAAM,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC1B,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;gBAC5B,cAAc,CAAC,GAAG,CAAC,GAAG,WAAW,MAAM,CAAC,QAAQ,CAAC,IAAI,sBAAsB,GAAG,CAAC;YACnF,CAAC;iBAAM,CAAC;gBACJ,cAAc,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YACvC,CAAC;QACL,CAAC;QAED,cAAU,CAAC,KAAK,CAAC,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,UAAkB,EAAE,OAAuB,EAAE,MAAc;QACxE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,UAAkB,EAAE,OAAuB,EAAE,MAAc;QACxE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAkB,EAAE,OAAuB;QACpD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,OAAuB;QAChD,OAAO,CAAC,QAAQ,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QAC3D,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ;AA7HD,0BA6HC"}

package/lib/metrics/contexts.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Default context for all metrics.
+ * @category Metrics
+ */
+import { MatrixClient } from "../MatrixClient";
+import { Intent } from "../appservice/Intent";
+import { IdentityClient } from "../identity/IdentityClient";
+export interface IMetricContext {
+    /**
+     * Unique identifier for the context object. Used to differentiate
+     * contexts over a start/end event.
+     */
+    uniqueId: string;
+}
+/**
+ * Metric context for function call metrics.
+ * @category Metrics
+ */
+export interface FunctionCallContext extends IMetricContext {
+    /**
+     * The function name being called
+     */
+    functionName: string;
+}
+/**
+ * Metric context for metrics from a MatrixClient
+ * @category Metrics
+ */
+export interface MatrixClientCallContext extends FunctionCallContext {
+    /**
+     * The client that raised the metric.
+     */
+    client: MatrixClient;
+}
+/**
+ * Metric context for metrics from an IdentityClient
+ * @category Metrics
+ */
+export interface IdentityClientCallContext extends FunctionCallContext {
+    client: IdentityClient;
+}
+/**
+ * Metric context for metrics from an Intent
+ * @category Metrics
+ */
+export interface IntentCallContext extends MatrixClientCallContext {
+    /**
+     * The intent that is raising the metric.
+     */
+    intent: Intent;
+}

package/lib/metrics/contexts.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=contexts.js.map

package/lib/metrics/contexts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contexts.js","sourceRoot":"","sources":["../../src/metrics/contexts.ts"],"names":[],"mappings":""}

package/lib/metrics/decorators.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Times a MatrixClient function call for metrics.
+ * @category Metrics
+ */
+export declare function timedMatrixClientFunctionCall(): (_target: unknown, functionName: string, descriptor: PropertyDescriptor) => void;
+/**
+ * Times an IdentityClient function call for metrics.
+ * @category Metrics
+ */
+export declare function timedIdentityClientFunctionCall(): (_target: unknown, functionName: string, descriptor: PropertyDescriptor) => void;
+/**
+ * Times an Intent function call for metrics.
+ * @category Metrics
+ */
+export declare function timedIntentFunctionCall(): (_target: unknown, functionName: string, descriptor: PropertyDescriptor) => void;

package/lib/metrics/decorators.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.timedMatrixClientFunctionCall = timedMatrixClientFunctionCall;
+exports.timedIdentityClientFunctionCall = timedIdentityClientFunctionCall;
+exports.timedIntentFunctionCall = timedIntentFunctionCall;
+const names_1 = require("./names");
+/**
+ * Times a MatrixClient function call for metrics.
+ * @category Metrics
+ */
+function timedMatrixClientFunctionCall() {
+    return function (_target, functionName, descriptor) {
+        const originalMethod = descriptor.value;
+        descriptor.value = async function (...args) {
+            const context = this.metrics.assignUniqueContextId({
+                functionName,
+                client: this,
+            });
+            this.metrics.start(names_1.METRIC_MATRIX_CLIENT_FUNCTION_CALL, context);
+            try {
+                const result = await originalMethod.apply(this, args);
+                this.metrics.increment(names_1.METRIC_MATRIX_CLIENT_SUCCESSFUL_FUNCTION_CALL, context, 1);
+                return result;
+            }
+            catch (e) {
+                this.metrics.increment(names_1.METRIC_MATRIX_CLIENT_FAILED_FUNCTION_CALL, context, 1);
+                throw e;
+            }
+            finally {
+                this.metrics.end(names_1.METRIC_MATRIX_CLIENT_FUNCTION_CALL, context);
+            }
+        };
+    };
+}
+/**
+ * Times an IdentityClient function call for metrics.
+ * @category Metrics
+ */
+function timedIdentityClientFunctionCall() {
+    return function (_target, functionName, descriptor) {
+        const originalMethod = descriptor.value;
+        descriptor.value = async function (...args) {
+            const context = this.metrics.assignUniqueContextId({
+                functionName,
+                client: this,
+            });
+            this.metrics.start(names_1.METRIC_IDENTITY_CLIENT_FUNCTION_CALL, context);
+            try {
+                const result = await originalMethod.apply(this, args);
+                this.metrics.increment(names_1.METRIC_IDENTITY_CLIENT_SUCCESSFUL_FUNCTION_CALL, context, 1);
+                return result;
+            }
+            catch (e) {
+                this.metrics.increment(names_1.METRIC_IDENTITY_CLIENT_FAILED_FUNCTION_CALL, context, 1);
+                throw e;
+            }
+            finally {
+                this.metrics.end(names_1.METRIC_IDENTITY_CLIENT_FUNCTION_CALL, context);
+            }
+        };
+    };
+}
+/**
+ * Times an Intent function call for metrics.
+ * @category Metrics
+ */
+function timedIntentFunctionCall() {
+    return function (_target, functionName, descriptor) {
+        const originalMethod = descriptor.value;
+        descriptor.value = async function (...args) {
+            const context = this.metrics.assignUniqueContextId({
+                functionName,
+                client: this.client,
+                intent: this,
+            });
+            this.metrics.start(names_1.METRIC_INTENT_FUNCTION_CALL, context);
+            try {
+                const result = await originalMethod.apply(this, args);
+                this.metrics.increment(names_1.METRIC_INTENT_SUCCESSFUL_FUNCTION_CALL, context, 1);
+                return result;
+            }
+            catch (e) {
+                this.metrics.increment(names_1.METRIC_INTENT_FAILED_FUNCTION_CALL, context, 1);
+                throw e;
+            }
+            finally {
+                this.metrics.end(names_1.METRIC_INTENT_FUNCTION_CALL, context);
+            }
+        };
+    };
+}
+//# sourceMappingURL=decorators.js.map

package/lib/metrics/decorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/metrics/decorators.ts"],"names":[],"mappings":";;AAiBA,sEAqBC;AAMD,0EAqBC;AAMD,0DAsBC;AA7FD,mCAUiB;AAGjB;;;GAGG;AACH,SAAgB,6BAA6B;IACzC,OAAO,UAAS,OAAgB,EAAE,YAAoB,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QACxC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAU,GAAG,IAAI;YACrC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAA0B;gBACxE,YAAY;gBACZ,MAAM,EAAE,IAAI;aACf,CAAC,CAAC;YACH,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,0CAAkC,EAAE,OAAO,CAAC,CAAC;YAChE,IAAI,CAAC;gBACD,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACtD,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,qDAA6C,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;gBAClF,OAAO,MAAM,CAAC;YAClB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,iDAAyC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;gBAC9E,MAAM,CAAC,CAAC;YACZ,CAAC;oBAAS,CAAC;gBACP,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0CAAkC,EAAE,OAAO,CAAC,CAAC;YAClE,CAAC;QACL,CAAC,CAAC;IACN,CAAC,CAAC;AACN,CAAC;AAED;;;GAGG;AACH,SAAgB,+BAA+B;IAC3C,OAAO,UAAS,OAAgB,EAAE,YAAoB,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QACxC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAU,GAAG,IAAW;YAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAA4B;gBAC1E,YAAY;gBACZ,MAAM,EAAE,IAAI;aACf,CAAC,CAAC;YACH,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,4CAAoC,EAAE,OAAO,CAAC,CAAC;YAClE,IAAI,CAAC;gBACD,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACtD,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,uDAA+C,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;gBACpF,OAAO,MAAM,CAAC;YAClB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,mDAA2C,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;gBAChF,MAAM,CAAC,CAAC;YACZ,CAAC;oBAAS,CAAC;gBACP,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAAoC,EAAE,OAAO,CAAC,CAAC;YACpE,CAAC;QACL,CAAC,CAAC;IACN,CAAC,CAAC;AACN,CAAC;AAED;;;GAGG;AACH,SAAgB,uBAAuB;IACnC,OAAO,UAAS,OAAgB,EAAE,YAAoB,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QACxC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAU,GAAG,IAAW;YAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAoB;gBAClE,YAAY;gBACZ,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,MAAM,EAAE,IAAI;aACf,CAAC,CAAC;YACH,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,mCAA2B,EAAE,OAAO,CAAC,CAAC;YACzD,IAAI,CAAC;gBACD,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACtD,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,8CAAsC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;gBAC3E,OAAO,MAAM,CAAC;YAClB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,0CAAkC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;gBACvE,MAAM,CAAC,CAAC;YACZ,CAAC;oBAAS,CAAC;gBACP,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAA2B,EAAE,OAAO,CAAC,CAAC;YAC3D,CAAC;QACL,CAAC,CAAC;IACN,CAAC,CAAC;AACN,CAAC"}

package/lib/metrics/names.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Time-series metric for how long a function call takes on MatrixClient. Uses a MatrixClientCallContext.
+ * @category Metrics
+ */
+export declare const METRIC_MATRIX_CLIENT_FUNCTION_CALL = "matrix_client_function_call";
+/**
+ * Counter metric for failed function calls on a MatrixClient. Uses a MatrixClientCallContext.
+ * @category Metrics
+ */
+export declare const METRIC_MATRIX_CLIENT_FAILED_FUNCTION_CALL = "matrix_client_failed_function_call";
+/**
+ * Counter metric for successful function calls on a MatrixClient. Uses a MatrixClientCallContext.
+ * @category Metrics
+ */
+export declare const METRIC_MATRIX_CLIENT_SUCCESSFUL_FUNCTION_CALL = "matrix_client_successful_function_call";
+/**
+ * Time-series metric for how long a function call takes on an IdentityClient. Uses an IdentityClientCallContext.
+ * @category Metrics
+ */
+export declare const METRIC_IDENTITY_CLIENT_FUNCTION_CALL = "identity_client_function_call";
+/**
+ * Counter metric for failed function calls on an IdentityClient. Uses an IdentityClientCallContext.
+ * @category Metrics
+ */
+export declare const METRIC_IDENTITY_CLIENT_FAILED_FUNCTION_CALL = "identity_client_failed_function_call";
+/**
+ * Counter metric for successful function calls on an IdentityClient. Uses an IdentityClientCallContext.
+ * @category Metrics
+ */
+export declare const METRIC_IDENTITY_CLIENT_SUCCESSFUL_FUNCTION_CALL = "identity_client_successful_function_call";
+/**
+ * Time-series metric for how long a function call takes on an Intent. Uses a IntentCallContext.
+ * @category Metrics
+ */
+export declare const METRIC_INTENT_FUNCTION_CALL = "intent_function_call";
+/**
+ * Counter metric for failed function calls on an Intent. Uses a IntentCallContext.
+ * @category Metrics
+ */
+export declare const METRIC_INTENT_FAILED_FUNCTION_CALL = "intent_failed_function_call";
+/**
+ * Counter metric for successful function calls on an Intent. Uses a IntentCallContext.
+ * @category Metrics
+ */
+export declare const METRIC_INTENT_SUCCESSFUL_FUNCTION_CALL = "intent_successful_function_call";

package/lib/metrics/names.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.METRIC_INTENT_SUCCESSFUL_FUNCTION_CALL = exports.METRIC_INTENT_FAILED_FUNCTION_CALL = exports.METRIC_INTENT_FUNCTION_CALL = exports.METRIC_IDENTITY_CLIENT_SUCCESSFUL_FUNCTION_CALL = exports.METRIC_IDENTITY_CLIENT_FAILED_FUNCTION_CALL = exports.METRIC_IDENTITY_CLIENT_FUNCTION_CALL = exports.METRIC_MATRIX_CLIENT_SUCCESSFUL_FUNCTION_CALL = exports.METRIC_MATRIX_CLIENT_FAILED_FUNCTION_CALL = exports.METRIC_MATRIX_CLIENT_FUNCTION_CALL = void 0;
+/**
+ * Time-series metric for how long a function call takes on MatrixClient. Uses a MatrixClientCallContext.
+ * @category Metrics
+ */
+exports.METRIC_MATRIX_CLIENT_FUNCTION_CALL = "matrix_client_function_call";
+/**
+ * Counter metric for failed function calls on a MatrixClient. Uses a MatrixClientCallContext.
+ * @category Metrics
+ */
+exports.METRIC_MATRIX_CLIENT_FAILED_FUNCTION_CALL = "matrix_client_failed_function_call";
+/**
+ * Counter metric for successful function calls on a MatrixClient. Uses a MatrixClientCallContext.
+ * @category Metrics
+ */
+exports.METRIC_MATRIX_CLIENT_SUCCESSFUL_FUNCTION_CALL = "matrix_client_successful_function_call";
+/**
+ * Time-series metric for how long a function call takes on an IdentityClient. Uses an IdentityClientCallContext.
+ * @category Metrics
+ */
+exports.METRIC_IDENTITY_CLIENT_FUNCTION_CALL = "identity_client_function_call";
+/**
+ * Counter metric for failed function calls on an IdentityClient. Uses an IdentityClientCallContext.
+ * @category Metrics
+ */
+exports.METRIC_IDENTITY_CLIENT_FAILED_FUNCTION_CALL = "identity_client_failed_function_call";
+/**
+ * Counter metric for successful function calls on an IdentityClient. Uses an IdentityClientCallContext.
+ * @category Metrics
+ */
+exports.METRIC_IDENTITY_CLIENT_SUCCESSFUL_FUNCTION_CALL = "identity_client_successful_function_call";
+/**
+ * Time-series metric for how long a function call takes on an Intent. Uses a IntentCallContext.
+ * @category Metrics
+ */
+exports.METRIC_INTENT_FUNCTION_CALL = "intent_function_call";
+/**
+ * Counter metric for failed function calls on an Intent. Uses a IntentCallContext.
+ * @category Metrics
+ */
+exports.METRIC_INTENT_FAILED_FUNCTION_CALL = "intent_failed_function_call";
+/**
+ * Counter metric for successful function calls on an Intent. Uses a IntentCallContext.
+ * @category Metrics
+ */
+exports.METRIC_INTENT_SUCCESSFUL_FUNCTION_CALL = "intent_successful_function_call";
+//# sourceMappingURL=names.js.map

package/lib/metrics/names.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"names.js","sourceRoot":"","sources":["../../src/metrics/names.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACU,QAAA,kCAAkC,GAAG,6BAA6B,CAAC;AAEhF;;;GAGG;AACU,QAAA,yCAAyC,GAAG,oCAAoC,CAAC;AAE9F;;;GAGG;AACU,QAAA,6CAA6C,GAAG,wCAAwC,CAAC;AAEtG;;;GAGG;AACU,QAAA,oCAAoC,GAAG,+BAA+B,CAAC;AAEpF;;;GAGG;AACU,QAAA,2CAA2C,GAAG,sCAAsC,CAAC;AAElG;;;GAGG;AACU,QAAA,+CAA+C,GAAG,0CAA0C,CAAC;AAE1G;;;GAGG;AACU,QAAA,2BAA2B,GAAG,sBAAsB,CAAC;AAElE;;;GAGG;AACU,QAAA,kCAAkC,GAAG,6BAA6B,CAAC;AAEhF;;;GAGG;AACU,QAAA,sCAAsC,GAAG,iCAAiC,CAAC"}

package/lib/mixins/AutojoinRoomsMixin.d.ts

@@ -0,0 +1,10 @@
+import { MatrixClient } from "../MatrixClient";
+import { Appservice } from "../appservice/Appservice";
+/**
+ * Automatically accepts invites for rooms
+ * @category Mixins
+ */
+export declare class AutojoinRoomsMixin {
+    static setupOnClient(client: MatrixClient): void;
+    static setupOnAppservice(appservice: Appservice, conditional?: (inviteEvent: any) => boolean): void;
+}

package/lib/mixins/AutojoinRoomsMixin.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutojoinRoomsMixin = void 0;
+/**
+ * Automatically accepts invites for rooms
+ * @category Mixins
+ */
+class AutojoinRoomsMixin {
+    static setupOnClient(client) {
+        client.on("room.invite", (roomId, inviteEvent) => {
+            return client.joinRoom(roomId);
+        });
+    }
+    static setupOnAppservice(appservice, conditional = null) {
+        appservice.on("room.invite", (roomId, inviteEvent) => {
+            const isFromBot = appservice.botUserId === inviteEvent["sender"];
+            if (!isFromBot && conditional && !conditional(inviteEvent))
+                return;
+            const intent = appservice.getIntentForUserId(inviteEvent["state_key"]);
+            return intent.joinRoom(roomId);
+        });
+    }
+}
+exports.AutojoinRoomsMixin = AutojoinRoomsMixin;
+//# sourceMappingURL=AutojoinRoomsMixin.js.map

package/lib/mixins/AutojoinRoomsMixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AutojoinRoomsMixin.js","sourceRoot":"","sources":["../../src/mixins/AutojoinRoomsMixin.ts"],"names":[],"mappings":";;;AAGA;;;GAGG;AACH,MAAa,kBAAkB;IACpB,MAAM,CAAC,aAAa,CAAC,MAAoB;QAC5C,MAAM,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,MAAc,EAAE,WAAgB,EAAE,EAAE;YAC1D,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,UAAsB,EAAE,cAA6C,IAAI;QACrG,UAAU,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,MAAc,EAAE,WAAgB,EAAE,EAAE;YAC9D,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,KAAK,WAAW,CAAC,QAAQ,CAAC,CAAC;YACjE,IAAI,CAAC,SAAS,IAAI,WAAW,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;gBAAE,OAAO;YAEnE,MAAM,MAAM,GAAG,UAAU,CAAC,kBAAkB,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;YACvE,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAhBD,gDAgBC"}

package/lib/mixins/AutojoinUpgradedRoomsMixin.d.ts

@@ -0,0 +1,10 @@
+import { MatrixClient } from "../MatrixClient";
+import { Appservice } from "../appservice/Appservice";
+/**
+ * Automatically tries to join upgraded rooms
+ * @category Mixins
+ */
+export declare class AutojoinUpgradedRoomsMixin {
+    static setupOnClient(client: MatrixClient): void;
+    static setupOnAppservice(appservice: Appservice): void;
+}

package/lib/mixins/AutojoinUpgradedRoomsMixin.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutojoinUpgradedRoomsMixin = void 0;
+/**
+ * Automatically tries to join upgraded rooms
+ * @category Mixins
+ */
+class AutojoinUpgradedRoomsMixin {
+    static setupOnClient(client) {
+        client.on("room.archived", (roomId, tombstoneEvent) => {
+            if (!tombstoneEvent['content'])
+                return;
+            if (!tombstoneEvent['sender'])
+                return;
+            if (!tombstoneEvent['content']['replacement_room'])
+                return;
+            const serverName = tombstoneEvent['sender'].split(':').splice(1).join(':');
+            return client.joinRoom(tombstoneEvent['content']['replacement_room'], [serverName]);
+        });
+    }
+    static setupOnAppservice(appservice) {
+        appservice.on("room.archived", async (roomId, tombstoneEvent) => {
+            if (!tombstoneEvent['content'])
+                return;
+            if (!tombstoneEvent['sender'])
+                return;
+            if (!tombstoneEvent['content']['replacement_room'])
+                return;
+            const newRoomId = tombstoneEvent['content']['replacement_room'];
+            const serverName = tombstoneEvent['sender'].split(':').splice(1).join(':');
+            const botClient = appservice.botIntent.underlyingClient;
+            await botClient.joinRoom(newRoomId, [serverName]);
+            const userIds = await botClient.getJoinedRoomMembers(roomId);
+            const joinUserIds = userIds.filter(u => u !== appservice.botUserId && appservice.isNamespacedUser(u));
+            return await Promise.all(joinUserIds.map(u => appservice.getIntentForUserId(u).joinRoom(newRoomId)));
+        });
+    }
+}
+exports.AutojoinUpgradedRoomsMixin = AutojoinUpgradedRoomsMixin;
+//# sourceMappingURL=AutojoinUpgradedRoomsMixin.js.map

package/lib/mixins/AutojoinUpgradedRoomsMixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AutojoinUpgradedRoomsMixin.js","sourceRoot":"","sources":["../../src/mixins/AutojoinUpgradedRoomsMixin.ts"],"names":[],"mappings":";;;AAGA;;;GAGG;AACH,MAAa,0BAA0B;IAC5B,MAAM,CAAC,aAAa,CAAC,MAAoB;QAC5C,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,MAAc,EAAE,cAAmB,EAAE,EAAE;YAC/D,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC;gBAAE,OAAO;YACvC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;gBAAE,OAAO;YACtC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC;gBAAE,OAAO;YAE3D,MAAM,UAAU,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC3E,OAAO,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;QACxF,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,UAAsB;QAClD,UAAU,CAAC,EAAE,CAAC,eAAe,EAAE,KAAK,EAAE,MAAc,EAAE,cAAmB,EAAE,EAAE;YACzE,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC;gBAAE,OAAO;YACvC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;gBAAE,OAAO;YACtC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC;gBAAE,OAAO;YAE3D,MAAM,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;YAChE,MAAM,UAAU,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC3E,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,gBAAgB,CAAC;YAExD,MAAM,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;YAClD,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;YAC7D,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,SAAS,IAAI,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;YAEtG,OAAO,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QACzG,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AA7BD,gEA6BC"}

package/lib/models/Account.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Response to a `/whoami` request.
+ * @category Models
+ */
+export interface IWhoAmI {
+    user_id: string;
+    device_id?: string;
+}

package/lib/models/Account.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Account.js.map

package/lib/models/Account.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Account.js","sourceRoot":"","sources":["../../src/models/Account.ts"],"names":[],"mappings":""}