@janssenproject/cedarling_wasm 0.0.473 → 0.0.475

package/dist/types/cjs/generated.d.ts

@@ -330,6 +330,23 @@ export class Cedarling {
      * ```
      */
     clearDataCtx(): void;
+    /**
+     * Destructive read: returns the telemetry metrics snapshot and resets
+     * the counters for the next interval.
+     *
+     * Fails when `CEDARLING_METRICS_COLLECTION` is disabled or whenever
+     * `CEDARLING_LOCK_TELEMETRY_INTERVAL` is set (even if the Lock server
+     * has no telemetry endpoint). `interval_secs` is fractional seconds,
+     * so sub-second intervals are reported exactly.
+     *
+     * # Example
+     *
+     * ```javascript
+     * const snapshot = cedarling.drainMetrics();
+     * console.log(`Requests: ${snapshot.operational_stats.get("authz.requests_total")}`);
+     * ```
+     */
+    drainMetrics(): MetricsSnapshot;
     /**
      * Get trusted issuer identifiers that failed to load.
      *
@@ -817,6 +834,42 @@ declare class IntoUnderlyingSource {
 }
 export type { IntoUnderlyingSource };
 
+/**
+ * A WASM wrapper for the Rust `cedarling::MetricsSnapshot` struct.
+ * Represents a snapshot of the collected telemetry metrics for the current
+ * interval. Destructive read: taking a snapshot resets the collected
+ * metrics, so use a single consumer.
+ */
+export class MetricsSnapshot {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Convert `MetricsSnapshot` to json string value.
+     *
+     * `policy_stats`, `error_counters` and `operational_stats` are converted
+     * from `Map` to plain objects so `JSON.stringify` emits their entries.
+     */
+    jsonString(): string;
+    /**
+     * Classified error counters keyed by error metric key.
+     */
+    error_counters: Map<any, any>;
+    /**
+     * Duration of the snapshot interval in fractional seconds.
+     * Exposed as `Number` (not `BigInt`) so plain JS arithmetic works.
+     */
+    interval_secs: number;
+    /**
+     * Operational counters and gauges (authorization, cache, JWT, data, lock).
+     */
+    operational_stats: Map<any, any>;
+    /**
+     * Per-policy evaluation counts (`policy_id`, `policy_id.allow`, `policy_id.deny`).
+     */
+    policy_stats: Map<any, any>;
+}
+
 /**
  * A WASM wrapper for the Rust `cedarling::MultiIssuerAuthorizeResult` struct.
  * Represents the result of a multi-issuer authorization request.
@@ -948,12 +1001,17 @@ export interface InitOutput {
     readonly __wbg_get_datastorestats_memory_alert_triggered: (a: number) => number;
     readonly __wbg_get_datastorestats_metrics_enabled: (a: number) => number;
     readonly __wbg_get_datastorestats_total_size_bytes: (a: number) => number;
+    readonly __wbg_get_metricssnapshot_error_counters: (a: number) => number;
+    readonly __wbg_get_metricssnapshot_interval_secs: (a: number) => number;
+    readonly __wbg_get_metricssnapshot_operational_stats: (a: number) => number;
+    readonly __wbg_get_metricssnapshot_policy_stats: (a: number) => number;
     readonly __wbg_get_multiissuerauthorizeresult_decision: (a: number) => number;
     readonly __wbg_get_multiissuerauthorizeresult_request_id: (a: number, b: number) => void;
     readonly __wbg_get_multiissuerauthorizeresult_response: (a: number) => number;
     readonly __wbg_intounderlyingbytesource_free: (a: number, b: number) => void;
     readonly __wbg_intounderlyingsink_free: (a: number, b: number) => void;
     readonly __wbg_intounderlyingsource_free: (a: number, b: number) => void;
+    readonly __wbg_metricssnapshot_free: (a: number, b: number) => void;
     readonly __wbg_multiissuerauthorizeresult_free: (a: number, b: number) => void;
     readonly __wbg_policyevaluationerror_free: (a: number, b: number) => void;
     readonly __wbg_set_authorizeresult_decision: (a: number, b: number) => void;
@@ -973,6 +1031,10 @@ export interface InitOutput {
     readonly __wbg_set_datastorestats_memory_alert_triggered: (a: number, b: number) => void;
     readonly __wbg_set_datastorestats_metrics_enabled: (a: number, b: number) => void;
     readonly __wbg_set_datastorestats_total_size_bytes: (a: number, b: number) => void;
+    readonly __wbg_set_metricssnapshot_error_counters: (a: number, b: number) => void;
+    readonly __wbg_set_metricssnapshot_interval_secs: (a: number, b: number) => void;
+    readonly __wbg_set_metricssnapshot_operational_stats: (a: number, b: number) => void;
+    readonly __wbg_set_metricssnapshot_policy_stats: (a: number, b: number) => void;
     readonly __wbg_set_multiissuerauthorizeresult_decision: (a: number, b: number) => void;
     readonly __wbg_set_multiissuerauthorizeresult_request_id: (a: number, b: number, c: number) => void;
     readonly __wbg_set_multiissuerauthorizeresult_response: (a: number, b: number) => void;
@@ -1000,6 +1062,7 @@ export interface InitOutput {
     readonly cedarling_authorizeUnsigned: (a: number, b: number, c: number) => number;
     readonly cedarling_authorizeUnsignedBatch: (a: number, b: number, c: number) => number;
     readonly cedarling_clearDataCtx: (a: number, b: number) => void;
+    readonly cedarling_drainMetrics: (a: number, b: number) => void;
     readonly cedarling_failedTrustedIssuerIds: (a: number) => number;
     readonly cedarling_getDataCtx: (a: number, b: number, c: number, d: number) => void;
     readonly cedarling_getDataEntryCtx: (a: number, b: number, c: number, d: number) => void;
@@ -1027,7 +1090,6 @@ export interface InitOutput {
     readonly diagnostics_errors: (a: number, b: number) => void;
     readonly diagnostics_reason: (a: number, b: number) => void;
     readonly init: (a: number) => number;
-    readonly initFromArchiveBytes: (a: number, b: number) => number;
     readonly rust_zstd_wasm_shim_calloc: (a: number, b: number) => number;
     readonly rust_zstd_wasm_shim_free: (a: number) => void;
     readonly rust_zstd_wasm_shim_malloc: (a: number) => number;
@@ -1036,6 +1098,7 @@ export interface InitOutput {
     readonly rust_zstd_wasm_shim_memmove: (a: number, b: number, c: number) => number;
     readonly rust_zstd_wasm_shim_memset: (a: number, b: number, c: number) => number;
     readonly rust_zstd_wasm_shim_qsort: (a: number, b: number, c: number, d: number) => void;
+    readonly initFromArchiveBytes: (a: number, b: number) => number;
     readonly intounderlyingbytesource_autoAllocateChunkSize: (a: number) => number;
     readonly intounderlyingbytesource_cancel: (a: number) => void;
     readonly intounderlyingbytesource_pull: (a: number, b: number) => number;
@@ -1046,13 +1109,14 @@ export interface InitOutput {
     readonly intounderlyingsink_write: (a: number, b: number) => number;
     readonly intounderlyingsource_cancel: (a: number) => void;
     readonly intounderlyingsource_pull: (a: number, b: number) => number;
+    readonly metricssnapshot_jsonString: (a: number, b: number) => void;
     readonly multiissuerauthorizeresult_jsonString: (a: number, b: number) => void;
     readonly policyevaluationerror_error: (a: number, b: number) => void;
     readonly policyevaluationerror_id: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_8907: (a: number, b: number, c: number, d: number) => void;
-    readonly __wasm_bindgen_func_elem_8962: (a: number, b: number, c: number, d: number) => void;
-    readonly __wasm_bindgen_func_elem_12467: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_8741: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_8927: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_8982: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_12488: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_8761: (a: number, b: number) => void;
     readonly __wbindgen_export: (a: number, b: number) => number;
     readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
     readonly __wbindgen_export3: (a: number) => void;

package/dist/types/esm/generated.d.ts

@@ -330,6 +330,23 @@ export class Cedarling {
      * ```
      */
     clearDataCtx(): void;
+    /**
+     * Destructive read: returns the telemetry metrics snapshot and resets
+     * the counters for the next interval.
+     *
+     * Fails when `CEDARLING_METRICS_COLLECTION` is disabled or whenever
+     * `CEDARLING_LOCK_TELEMETRY_INTERVAL` is set (even if the Lock server
+     * has no telemetry endpoint). `interval_secs` is fractional seconds,
+     * so sub-second intervals are reported exactly.
+     *
+     * # Example
+     *
+     * ```javascript
+     * const snapshot = cedarling.drainMetrics();
+     * console.log(`Requests: ${snapshot.operational_stats.get("authz.requests_total")}`);
+     * ```
+     */
+    drainMetrics(): MetricsSnapshot;
     /**
      * Get trusted issuer identifiers that failed to load.
      *
@@ -817,6 +834,42 @@ declare class IntoUnderlyingSource {
 }
 export type { IntoUnderlyingSource };
 
+/**
+ * A WASM wrapper for the Rust `cedarling::MetricsSnapshot` struct.
+ * Represents a snapshot of the collected telemetry metrics for the current
+ * interval. Destructive read: taking a snapshot resets the collected
+ * metrics, so use a single consumer.
+ */
+export class MetricsSnapshot {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Convert `MetricsSnapshot` to json string value.
+     *
+     * `policy_stats`, `error_counters` and `operational_stats` are converted
+     * from `Map` to plain objects so `JSON.stringify` emits their entries.
+     */
+    jsonString(): string;
+    /**
+     * Classified error counters keyed by error metric key.
+     */
+    error_counters: Map<any, any>;
+    /**
+     * Duration of the snapshot interval in fractional seconds.
+     * Exposed as `Number` (not `BigInt`) so plain JS arithmetic works.
+     */
+    interval_secs: number;
+    /**
+     * Operational counters and gauges (authorization, cache, JWT, data, lock).
+     */
+    operational_stats: Map<any, any>;
+    /**
+     * Per-policy evaluation counts (`policy_id`, `policy_id.allow`, `policy_id.deny`).
+     */
+    policy_stats: Map<any, any>;
+}
+
 /**
  * A WASM wrapper for the Rust `cedarling::MultiIssuerAuthorizeResult` struct.
  * Represents the result of a multi-issuer authorization request.
@@ -948,12 +1001,17 @@ export interface InitOutput {
     readonly __wbg_get_datastorestats_memory_alert_triggered: (a: number) => number;
     readonly __wbg_get_datastorestats_metrics_enabled: (a: number) => number;
     readonly __wbg_get_datastorestats_total_size_bytes: (a: number) => number;
+    readonly __wbg_get_metricssnapshot_error_counters: (a: number) => number;
+    readonly __wbg_get_metricssnapshot_interval_secs: (a: number) => number;
+    readonly __wbg_get_metricssnapshot_operational_stats: (a: number) => number;
+    readonly __wbg_get_metricssnapshot_policy_stats: (a: number) => number;
     readonly __wbg_get_multiissuerauthorizeresult_decision: (a: number) => number;
     readonly __wbg_get_multiissuerauthorizeresult_request_id: (a: number, b: number) => void;
     readonly __wbg_get_multiissuerauthorizeresult_response: (a: number) => number;
     readonly __wbg_intounderlyingbytesource_free: (a: number, b: number) => void;
     readonly __wbg_intounderlyingsink_free: (a: number, b: number) => void;
     readonly __wbg_intounderlyingsource_free: (a: number, b: number) => void;
+    readonly __wbg_metricssnapshot_free: (a: number, b: number) => void;
     readonly __wbg_multiissuerauthorizeresult_free: (a: number, b: number) => void;
     readonly __wbg_policyevaluationerror_free: (a: number, b: number) => void;
     readonly __wbg_set_authorizeresult_decision: (a: number, b: number) => void;
@@ -973,6 +1031,10 @@ export interface InitOutput {
     readonly __wbg_set_datastorestats_memory_alert_triggered: (a: number, b: number) => void;
     readonly __wbg_set_datastorestats_metrics_enabled: (a: number, b: number) => void;
     readonly __wbg_set_datastorestats_total_size_bytes: (a: number, b: number) => void;
+    readonly __wbg_set_metricssnapshot_error_counters: (a: number, b: number) => void;
+    readonly __wbg_set_metricssnapshot_interval_secs: (a: number, b: number) => void;
+    readonly __wbg_set_metricssnapshot_operational_stats: (a: number, b: number) => void;
+    readonly __wbg_set_metricssnapshot_policy_stats: (a: number, b: number) => void;
     readonly __wbg_set_multiissuerauthorizeresult_decision: (a: number, b: number) => void;
     readonly __wbg_set_multiissuerauthorizeresult_request_id: (a: number, b: number, c: number) => void;
     readonly __wbg_set_multiissuerauthorizeresult_response: (a: number, b: number) => void;
@@ -1000,6 +1062,7 @@ export interface InitOutput {
     readonly cedarling_authorizeUnsigned: (a: number, b: number, c: number) => number;
     readonly cedarling_authorizeUnsignedBatch: (a: number, b: number, c: number) => number;
     readonly cedarling_clearDataCtx: (a: number, b: number) => void;
+    readonly cedarling_drainMetrics: (a: number, b: number) => void;
     readonly cedarling_failedTrustedIssuerIds: (a: number) => number;
     readonly cedarling_getDataCtx: (a: number, b: number, c: number, d: number) => void;
     readonly cedarling_getDataEntryCtx: (a: number, b: number, c: number, d: number) => void;
@@ -1027,7 +1090,6 @@ export interface InitOutput {
     readonly diagnostics_errors: (a: number, b: number) => void;
     readonly diagnostics_reason: (a: number, b: number) => void;
     readonly init: (a: number) => number;
-    readonly initFromArchiveBytes: (a: number, b: number) => number;
     readonly rust_zstd_wasm_shim_calloc: (a: number, b: number) => number;
     readonly rust_zstd_wasm_shim_free: (a: number) => void;
     readonly rust_zstd_wasm_shim_malloc: (a: number) => number;
@@ -1036,6 +1098,7 @@ export interface InitOutput {
     readonly rust_zstd_wasm_shim_memmove: (a: number, b: number, c: number) => number;
     readonly rust_zstd_wasm_shim_memset: (a: number, b: number, c: number) => number;
     readonly rust_zstd_wasm_shim_qsort: (a: number, b: number, c: number, d: number) => void;
+    readonly initFromArchiveBytes: (a: number, b: number) => number;
     readonly intounderlyingbytesource_autoAllocateChunkSize: (a: number) => number;
     readonly intounderlyingbytesource_cancel: (a: number) => void;
     readonly intounderlyingbytesource_pull: (a: number, b: number) => number;
@@ -1046,13 +1109,14 @@ export interface InitOutput {
     readonly intounderlyingsink_write: (a: number, b: number) => number;
     readonly intounderlyingsource_cancel: (a: number) => void;
     readonly intounderlyingsource_pull: (a: number, b: number) => number;
+    readonly metricssnapshot_jsonString: (a: number, b: number) => void;
     readonly multiissuerauthorizeresult_jsonString: (a: number, b: number) => void;
     readonly policyevaluationerror_error: (a: number, b: number) => void;
     readonly policyevaluationerror_id: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_8907: (a: number, b: number, c: number, d: number) => void;
-    readonly __wasm_bindgen_func_elem_8962: (a: number, b: number, c: number, d: number) => void;
-    readonly __wasm_bindgen_func_elem_12467: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_8741: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_8927: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_8982: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_12488: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_8761: (a: number, b: number) => void;
     readonly __wbindgen_export: (a: number, b: number) => number;
     readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
     readonly __wbindgen_export3: (a: number) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@janssenproject/cedarling_wasm",
-  "version": "0.0.473",
+  "version": "0.0.475",
   "description": "Cedarling authorization for JavaScript, TypeScript, Node.js, browsers, and edge runtimes.",
   "type": "module",
   "license": "Apache-2.0",