@deadair/sdk 0.69.1 → 0.70.1

package/dist/metrics/metrics.client.d.ts

@@ -0,0 +1,17 @@
+import type { SdkFetch } from '../sdk-options.js';
+import type { MetricNames, MetricSeriesPage, MetricSeriesQuery } from './types/metrics.types.js';
+export declare class MetricsClient {
+    private fetch;
+    constructor(fetch: SdkFetch);
+    /**
+     * @name Read metric series
+     * @description Trends over a range, at minute resolution for two days or less and hourly beyond
+     */
+    readMetricSeries(query?: MetricSeriesQuery): Promise<MetricSeriesPage>;
+    /**
+     * @name Read metric names
+     * @description Every metric the station holds, with its labels and when it was last measured
+     */
+    readMetricNames(): Promise<MetricNames>;
+}
+//# sourceMappingURL=metrics.client.d.ts.map

package/dist/metrics/metrics.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.client.d.ts","sourceRoot":"","sources":["../../src/metrics/metrics.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAGjG,qBAAa,aAAa;IACV,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,gBAAgB,CAAC,KAAK,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAQ5E;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,WAAW,CAAC;CAIhD"}

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

@@ -0,0 +1,2 @@
+export * from './metrics.types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/metrics/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/metrics/types/index.ts"],"names":[],"mappings":"AACA,cAAc,oBAAoB,CAAC"}

package/dist/metrics/types/metrics.types.d.ts

@@ -0,0 +1,115 @@
+import { DateTime } from 'luxon';
+/**
+ * How wide one point is. Chosen by the station from the range asked for: minutes for two days or less, hours beyond
+ * generated from [MetricResolution](../../../../../apps/api/data/contracts/metrics/metrics.types.ck)
+ */
+export type MetricResolution = 'minute' | 'hour';
+/**
+ * The trends to read, over one range
+ * generated from [MetricSeriesQuery](../../../../../apps/api/data/contracts/metrics/metrics.types.ck)
+ */
+export interface MetricSeriesQuery {
+    /** Comma-separated metric names, at most twenty: `station.listeners,work.job.ms` */
+    names: string;
+    /** The start of the range, inclusive */
+    from: DateTime;
+    /** The end of the range, exclusive. At most four hundred days after `from` */
+    to: DateTime;
+}
+/** Rehydrates every wire-encoded scalar in a MetricSeriesQuery into its runtime type. Mutates and returns `raw`. */
+export declare function reviveMetricSeriesQuery(raw: MetricSeriesQuery): MetricSeriesQuery;
+/**
+ * One series over one minute or hour
+ * generated from [MetricPoint](../../../../../apps/api/data/contracts/metrics/metrics.types.ck)
+ */
+export interface MetricPoint {
+    /** The start of the minute or hour */
+    at: DateTime;
+    /** How many observations were folded in */
+    count: number;
+    /** Their total: a counter's value, or with `count` a duration's mean */
+    sum: number;
+    /** The smallest observation */
+    min: number;
+    /** The largest observation: a duration's worst */
+    max: number;
+    /** The latest observation: a gauge's value */
+    last: number;
+}
+/** Rehydrates every wire-encoded scalar in a MetricPoint into its runtime type. Mutates and returns `raw`. */
+export declare function reviveMetricPoint(raw: MetricPoint): MetricPoint;
+/**
+ * A metric the station holds, for a picker
+ * generated from [MetricName](../../../../../apps/api/data/contracts/metrics/metrics.types.ck)
+ */
+export interface MetricName {
+    name: string;
+    source: string;
+    /** Every label any of its series carries, sorted */
+    labelKeys: string[];
+    /** The newest point held for it, at either resolution */
+    lastSeen: DateTime;
+}
+/** Rehydrates every wire-encoded scalar in a MetricName into its runtime type. Mutates and returns `raw`. */
+export declare function reviveMetricName(raw: MetricName): MetricName;
+/**
+ * An OTLP/HTTP metrics export, sent as JSON. Only the top level is checked here; the station reads the rest itself and counts what it cannot use rather than refusing the whole request
+ * generated from [OtlpMetricsExport](../../../../../apps/api/data/contracts/metrics/metrics.types.ck)
+ */
+export interface OtlpMetricsExport {
+    resourceMetrics: Record<string, unknown>[];
+}
+/**
+ * OTLP's answer when some points were not taken
+ * generated from [OtlpPartialSuccess](../../../../../apps/api/data/contracts/metrics/metrics.types.ck)
+ */
+export interface OtlpPartialSuccess {
+    /** How many, as OTLP writes a 64-bit count: a digit string */
+    rejectedDataPoints: string;
+    errorMessage: string;
+}
+/**
+ * One metric and one set of labels, its points oldest first
+ * generated from [MetricSeries](../../../../../apps/api/data/contracts/metrics/metrics.types.ck)
+ */
+export interface MetricSeries {
+    name: string;
+    /** What tells this series from the metric's others: `{ "queue": "catalog.sync" }`. Empty for a metric with one series */
+    labels: Record<string, string>;
+    /** `station` for what the station measured itself, `otlp` for what another service sent it */
+    source: string;
+    /** Only the buckets that hold something. A gap is a stretch nothing was measured, which a chart should draw as a gap */
+    points: MetricPoint[];
+}
+/** Rehydrates every wire-encoded scalar in a MetricSeries into its runtime type. Mutates and returns `raw`. */
+export declare function reviveMetricSeries(raw: MetricSeries): MetricSeries;
+/**
+ * generated from [MetricNames](../../../../../apps/api/data/contracts/metrics/metrics.types.ck)
+ */
+export interface MetricNames {
+    /** Sorted by name */
+    names: MetricName[];
+}
+/** Rehydrates every wire-encoded scalar in a MetricNames into its runtime type. Mutates and returns `raw`. */
+export declare function reviveMetricNames(raw: MetricNames): MetricNames;
+/**
+ * OTLP's answer to an export. Empty when every point was taken
+ * generated from [OtlpExportResponse](../../../../../apps/api/data/contracts/metrics/metrics.types.ck)
+ */
+export interface OtlpExportResponse {
+    partialSuccess?: OtlpPartialSuccess;
+}
+/**
+ * generated from [MetricSeriesPage](../../../../../apps/api/data/contracts/metrics/metrics.types.ck)
+ */
+export interface MetricSeriesPage {
+    /** The width the points were read at */
+    resolution: MetricResolution;
+    from: DateTime;
+    to: DateTime;
+    /** Empty when nothing was measured in the range, which is not an error */
+    series: MetricSeries[];
+}
+/** Rehydrates every wire-encoded scalar in a MetricSeriesPage into its runtime type. Mutates and returns `raw`. */
+export declare function reviveMetricSeriesPage(raw: MetricSeriesPage): MetricSeriesPage;
+//# sourceMappingURL=metrics.types.d.ts.map

package/dist/metrics/types/metrics.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.types.d.ts","sourceRoot":"","sources":["../../../src/metrics/types/metrics.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAUjC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,oFAAoF;IACpF,KAAK,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,IAAI,EAAE,QAAQ,CAAC;IACf,8EAA8E;IAC9E,EAAE,EAAE,QAAQ,CAAC;CAChB;AAED,oHAAoH;AACpH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,iBAAiB,GAAG,iBAAiB,CAKjF;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,sCAAsC;IACtC,EAAE,EAAE,QAAQ,CAAC;IACb,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,wEAAwE;IACxE,GAAG,EAAE,MAAM,CAAC;IACZ,+BAA+B;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,kDAAkD;IAClD,GAAG,EAAE,MAAM,CAAC;IACZ,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,8GAA8G;AAC9G,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,WAAW,GAAG,WAAW,CAI/D;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,yDAAyD;IACzD,QAAQ,EAAE,QAAQ,CAAC;CACtB;AAED,6GAA6G;AAC7G,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,UAAU,GAAG,UAAU,CAI5D;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,8DAA8D;IAC9D,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,yHAAyH;IACzH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,8FAA8F;IAC9F,MAAM,EAAE,MAAM,CAAC;IACf,wHAAwH;IACxH,MAAM,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,+GAA+G;AAC/G,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,YAAY,GAAG,YAAY,CASlE;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,qBAAqB;IACrB,KAAK,EAAE,UAAU,EAAE,CAAC;CACvB;AAED,8GAA8G;AAC9G,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,WAAW,GAAG,WAAW,CAS/D;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,cAAc,CAAC,EAAE,kBAAkB,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,wCAAwC;IACxC,UAAU,EAAE,gBAAgB,CAAC;IAC7B,IAAI,EAAE,QAAQ,CAAC;IACf,EAAE,EAAE,QAAQ,CAAC;IACb,0EAA0E;IAC1E,MAAM,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED,mHAAmH;AACnH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,gBAAgB,GAAG,gBAAgB,CAW9E"}

package/dist/settings/types/settings.types.d.ts

@@ -3,7 +3,7 @@ import type { ConfigFieldDescriptor } from '../../plugins/types/plugins.types.js
  * Which part of the console owns a setting. Every one of these but `schedule`, `personas`, `phrasings` and `providers` is a section of the settings page; `schedule` is edited on the schedule page, beside the timetable it describes, `personas` on the characters page, beside the names it stands behind, `phrasings` on the Voice page's Phrasings tab, beside everything else about what the station says, and `providers` on the Providers section, which draws each capability beside the plugins that answer it rather than as a form of text fields.
  * generated from [SettingGroup](../../../../../apps/api/data/contracts/settings/settings.types.ck)
  */
-export type SettingGroup = 'station' | 'stream' | 'housekeeping' | 'mail' | 'signin' | 'rotation' | 'breaks' | 'bulletins' | 'playout' | 'render' | 'llm' | 'analysis' | 'schedule' | 'personas' | 'phrasings' | 'providers';
+export type SettingGroup = 'station' | 'stream' | 'housekeeping' | 'mail' | 'signin' | 'telemetry' | 'rotation' | 'breaks' | 'bulletins' | 'playout' | 'render' | 'llm' | 'analysis' | 'schedule' | 'personas' | 'phrasings' | 'providers';
 /**
  * A submitted settings form. Partial: a key that is present is written, a key that is absent is left
  * alone, so a console may send one field. A secret submitted blank clears it

package/dist/settings/types/settings.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"settings.types.d.ts","sourceRoot":"","sources":["../../../src/settings/types/settings.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAElF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAClB,SAAS,GACT,QAAQ,GACR,cAAc,GACd,MAAM,GACN,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,WAAW,GACX,SAAS,GACT,QAAQ,GACR,KAAK,GACL,UAAU,GACV,UAAU,GACV,UAAU,GACV,WAAW,GACX,WAAW,CAAC;AAElB;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,EAAE,EAAE,OAAO,CAAC;IACZ,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,6HAA6H;IAC7H,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,8KAA8K;IAC9K,UAAU,EAAE,OAAO,CAAC;IACpB,wGAAwG;IACxG,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,qBAAqB;IACnE,KAAK,EAAE,YAAY,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC,uCAAuC;IACvC,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjC,gJAAgJ;IAChJ,QAAQ,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,WAAW,EAAE,wBAAwB,EAAE,CAAC;IACxC,mFAAmF;IACnF,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,kGAAkG;IAClG,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,6wBAA6wB;IAC7wB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC"}
+{"version":3,"file":"settings.types.d.ts","sourceRoot":"","sources":["../../../src/settings/types/settings.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAElF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAClB,SAAS,GACT,QAAQ,GACR,cAAc,GACd,MAAM,GACN,QAAQ,GACR,WAAW,GACX,UAAU,GACV,QAAQ,GACR,WAAW,GACX,SAAS,GACT,QAAQ,GACR,KAAK,GACL,UAAU,GACV,UAAU,GACV,UAAU,GACV,WAAW,GACX,WAAW,CAAC;AAElB;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,EAAE,EAAE,OAAO,CAAC;IACZ,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,6HAA6H;IAC7H,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,8KAA8K;IAC9K,UAAU,EAAE,OAAO,CAAC;IACpB,wGAAwG;IACxG,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,qBAAqB;IACnE,KAAK,EAAE,YAAY,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC,uCAAuC;IACvC,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjC,gJAAgJ;IAChJ,QAAQ,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,WAAW,EAAE,wBAAwB,EAAE,CAAC;IACxC,mFAAmF;IACnF,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,kGAAkG;IAClG,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,6wBAA6wB;IAC7wB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deadair/sdk",
-  "version": "0.69.1",
+  "version": "0.70.1",
   "description": "A typed client for the deadair station's HTTP API, generated from the same contracts the station serves.",
   "keywords": [
     "deadair",