@devvit/metrics 0.11.11-next-2025-03-20-2debaee6b.0

package/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2023 Reddit Inc.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

package/README.md

@@ -0,0 +1,5 @@
+# @devvit/metrics
+
+Intended for internal use only.
+
+Sign up for Reddit's Developer Platform [here!](https://developers.reddit.com)

package/index.d.ts

@@ -0,0 +1,55 @@
+export type Metric = Counter | Gauge | Histogram;
+/**
+ * Devvit looks for a MetricsProvider assigned to globalThis.devvitMetricsProvider.
+ * Metrics created by Devvit.addCounterMetric, etc., are provided by this instance.
+ * If none is registered, Devvit falls back to a noop provider.
+ */
+export type MetricsProvider = {
+    counter(def: CounterDefinition): Counter;
+    gauge(def: GaugeDefinition): Gauge;
+    histogram(def: HistogramDefinition): Histogram;
+};
+type BaseDefinition = {
+    name: string;
+    labels: string[];
+};
+export type CounterDefinition = BaseDefinition;
+export type GaugeDefinition = BaseDefinition;
+export type HistogramDefinition = BaseDefinition & {
+    buckets: number[];
+};
+export type LabelMap = Record<string, string>;
+export type Counter = {
+    inc(labels: LabelMap, by?: number): void;
+    labels(...values: string[]): CounterInternal;
+};
+export type CounterInternal = {
+    inc(by?: number): void;
+};
+export type Gauge = {
+    set(labels: LabelMap, value: number): void;
+    inc(labels: LabelMap, value: number): void;
+    dec(labels: LabelMap, value: number): void;
+    setToCurrentTime(labels: LabelMap): void;
+    labels(...values: string[]): GaugeInternal;
+};
+export type GaugeInternal = {
+    set(value: number): void;
+    inc(value: number): void;
+    dec(value: number): void;
+    setToCurrentTime(): void;
+};
+export type Histogram = {
+    observe(labels: LabelMap, value: number): void;
+    labels(...values: string[]): HistogramInternal;
+};
+export type HistogramInternal = {
+    observe(value: number): void;
+};
+export declare function counter(def: CounterDefinition): Counter;
+export declare function gauge(def: GaugeDefinition): Gauge;
+export declare function histogram(def: HistogramDefinition): Histogram;
+export declare function setMetricsProvider(provider: MetricsProvider): void;
+export declare function getMetricsProvider(): MetricsProvider;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC;AAEjD;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,CAAC,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC;IACzC,KAAK,CAAC,GAAG,EAAE,eAAe,GAAG,KAAK,CAAC;IACnC,SAAS,CAAC,GAAG,EAAE,mBAAmB,GAAG,SAAS,CAAC;CAChD,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,cAAc,CAAC;AAC/C,MAAM,MAAM,eAAe,GAAG,cAAc,CAAC;AAC7C,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG;IACjD,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE9C,MAAM,MAAM,OAAO,GAAG;IACpB,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,MAAM,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,gBAAgB,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAAC;IACzC,MAAM,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,gBAAgB,IAAI,IAAI,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/C,MAAM,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,iBAAiB,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B,CAAC;AAEF,wBAAgB,OAAO,CAAC,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAEvD;AAED,wBAAgB,KAAK,CAAC,GAAG,EAAE,eAAe,GAAG,KAAK,CAEjD;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,mBAAmB,GAAG,SAAS,CAE7D;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,CAElE;AAED,wBAAgB,kBAAkB,IAAI,eAAe,CAKpD"}

package/index.js

@@ -0,0 +1,60 @@
+export function counter(def) {
+    return getMetricsProvider().counter(def);
+}
+export function gauge(def) {
+    return getMetricsProvider().gauge(def);
+}
+export function histogram(def) {
+    return getMetricsProvider().histogram(def);
+}
+export function setMetricsProvider(provider) {
+    Object.assign(globalThis, { devvitMetricsProvider: provider });
+}
+export function getMetricsProvider() {
+    return (globalThis.devvitMetricsProvider ??
+        new NullMetrics());
+}
+class NullMetrics {
+    counter(_def) {
+        return new NullCounter();
+    }
+    gauge(_def) {
+        return new NullGauge();
+    }
+    histogram(_def) {
+        return new NullHistogram();
+    }
+}
+class NullCounter {
+    inc(_labels, _by) { }
+    labels(..._values) {
+        return new NullCounterInternal();
+    }
+}
+class NullCounterInternal {
+    inc(_by) { }
+}
+class NullGauge {
+    set(_labels, _value) { }
+    inc(_labels, _by) { }
+    dec(_labels, _by) { }
+    setToCurrentTime(_labels) { }
+    labels(..._values) {
+        return new NullGaugeInternal();
+    }
+}
+class NullGaugeInternal {
+    set(_value) { }
+    inc(_by) { }
+    dec(_by) { }
+    setToCurrentTime() { }
+}
+class NullHistogram {
+    observe(_labels, _value) { }
+    labels(..._values) {
+        return new NullHistogramInternal();
+    }
+}
+class NullHistogramInternal {
+    observe(_value) { }
+}

package/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@devvit/metrics",
+  "version": "0.11.11-next-2025-03-20-2debaee6b.0",
+  "license": "BSD-3-Clause",
+  "repository": {
+    "type": "git",
+    "url": "https://developers.reddit.com/"
+  },
+  "type": "module",
+  "main": "./index.js",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf .turbo coverage dist",
+    "clobber": "yarn clean && rm -rf node_modules",
+    "dev": "tsc -w",
+    "lint": "redlint .",
+    "lint:fix": "yarn lint --fix",
+    "prepublishOnly": "publish-package-json",
+    "test": "yarn test:unit && yarn test:types && yarn lint",
+    "test:types": "tsc --noEmit",
+    "test:unit": "vitest run",
+    "test:unit-with-coverage": "vitest run --coverage"
+  },
+  "types": "./index.d.ts",
+  "dependencies": {
+    "@devvit/protos": "0.11.11-next-2025-03-20-2debaee6b.0"
+  },
+  "devDependencies": {
+    "@devvit/repo-tools": "0.11.11-next-2025-03-20-2debaee6b.0",
+    "@devvit/tsconfig": "0.11.11-next-2025-03-20-2debaee6b.0",
+    "eslint": "9.11.1",
+    "typescript": "5.3.2",
+    "vitest": "1.6.0"
+  },
+  "publishConfig": {
+    "directory": "dist"
+  },
+  "source": "./src/index.ts",
+  "gitHead": "830bd77dca876101350373ff7d84e924663cb5b7"
+}