@steamsets/client-ts 0.34.1 → 0.34.3

package/src/models/operations/statssubscribe.ts

@@ -0,0 +1,228 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { EventStream } from "../../lib/event-streams.js";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EventStatsUpdated = {
+  data: components.EventStatsUpdatedData;
+  /**
+   * The event name.
+   */
+  event: "stats-updated";
+  /**
+   * The event ID.
+   */
+  id?: string | undefined;
+  /**
+   * The retry time in milliseconds.
+   */
+  retry?: number | undefined;
+};
+
+export type EventStatsSnapshot = {
+  data: components.V1Stats;
+  /**
+   * The event name.
+   */
+  event: "stats-snapshot";
+  /**
+   * The event ID.
+   */
+  id?: string | undefined;
+  /**
+   * The retry time in milliseconds.
+   */
+  retry?: number | undefined;
+};
+
+export type EventStatsHeartbeat = {
+  data: components.EventStatsHeartbeatData;
+  /**
+   * The event name.
+   */
+  event: "stats-heartbeat";
+  /**
+   * The event ID.
+   */
+  id?: string | undefined;
+  /**
+   * The retry time in milliseconds.
+   */
+  retry?: number | undefined;
+};
+
+/**
+ * Each oneOf object in the array represents one possible Server Sent Events (SSE) message, serialized as UTF-8 text according to the SSE specification.
+ */
+export type StatsSubscribeServerSentEvents =
+  | EventStatsHeartbeat
+  | EventStatsSnapshot
+  | EventStatsUpdated;
+
+export type StatsSubscribeResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  serverSentEvents?:
+    | EventStream<EventStatsHeartbeat | EventStatsSnapshot | EventStatsUpdated>
+    | undefined;
+  /**
+   * Error
+   */
+  errorModel?: components.ErrorModel | undefined;
+};
+
+/** @internal */
+export const EventStatsUpdated$inboundSchema: z.ZodType<
+  EventStatsUpdated,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.string().transform((v, ctx) => {
+    try {
+      return JSON.parse(v);
+    } catch (err) {
+      ctx.addIssue({ code: "custom", message: `malformed json: ${err}` });
+      return z.NEVER;
+    }
+  }).pipe(components.EventStatsUpdatedData$inboundSchema),
+  event: z.literal("stats-updated"),
+  id: z.string().optional(),
+  retry: z.number().int().optional(),
+});
+
+export function eventStatsUpdatedFromJSON(
+  jsonString: string,
+): SafeParseResult<EventStatsUpdated, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventStatsUpdated$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventStatsUpdated' from JSON`,
+  );
+}
+
+/** @internal */
+export const EventStatsSnapshot$inboundSchema: z.ZodType<
+  EventStatsSnapshot,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.string().transform((v, ctx) => {
+    try {
+      return JSON.parse(v);
+    } catch (err) {
+      ctx.addIssue({ code: "custom", message: `malformed json: ${err}` });
+      return z.NEVER;
+    }
+  }).pipe(components.V1Stats$inboundSchema),
+  event: z.literal("stats-snapshot"),
+  id: z.string().optional(),
+  retry: z.number().int().optional(),
+});
+
+export function eventStatsSnapshotFromJSON(
+  jsonString: string,
+): SafeParseResult<EventStatsSnapshot, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventStatsSnapshot$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventStatsSnapshot' from JSON`,
+  );
+}
+
+/** @internal */
+export const EventStatsHeartbeat$inboundSchema: z.ZodType<
+  EventStatsHeartbeat,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.string().transform((v, ctx) => {
+    try {
+      return JSON.parse(v);
+    } catch (err) {
+      ctx.addIssue({ code: "custom", message: `malformed json: ${err}` });
+      return z.NEVER;
+    }
+  }).pipe(components.EventStatsHeartbeatData$inboundSchema),
+  event: z.literal("stats-heartbeat"),
+  id: z.string().optional(),
+  retry: z.number().int().optional(),
+});
+
+export function eventStatsHeartbeatFromJSON(
+  jsonString: string,
+): SafeParseResult<EventStatsHeartbeat, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventStatsHeartbeat$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventStatsHeartbeat' from JSON`,
+  );
+}
+
+/** @internal */
+export const StatsSubscribeServerSentEvents$inboundSchema: z.ZodType<
+  StatsSubscribeServerSentEvents,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => EventStatsHeartbeat$inboundSchema),
+  z.lazy(() => EventStatsSnapshot$inboundSchema),
+  z.lazy(() => EventStatsUpdated$inboundSchema),
+]);
+
+export function statsSubscribeServerSentEventsFromJSON(
+  jsonString: string,
+): SafeParseResult<StatsSubscribeServerSentEvents, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StatsSubscribeServerSentEvents$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StatsSubscribeServerSentEvents' from JSON`,
+  );
+}
+
+/** @internal */
+export const StatsSubscribeResponse$inboundSchema: z.ZodType<
+  StatsSubscribeResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  HttpMeta: components.HTTPMetadata$inboundSchema,
+  "Server Sent Events": z.instanceof(ReadableStream<Uint8Array>)
+    .transform(stream => {
+      return new EventStream(stream, rawEvent => {
+        return {
+          done: false,
+          value: z.union([
+            z.lazy(() => EventStatsHeartbeat$inboundSchema),
+            z.lazy(() => EventStatsSnapshot$inboundSchema),
+            z.lazy(() => EventStatsUpdated$inboundSchema),
+          ]).parse(rawEvent),
+        };
+      });
+    }).optional(),
+  ErrorModel: components.ErrorModel$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "Server Sent Events": "serverSentEvents",
+    "ErrorModel": "errorModel",
+  });
+});
+
+export function statsSubscribeResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<StatsSubscribeResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StatsSubscribeResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StatsSubscribeResponse' from JSON`,
+  );
+}

package/src/sdk/stats.ts

@@ -3,10 +3,16 @@
  */
 
 import { statsGet } from "../funcs/statsGet.js";
+import {
+  statsSubscribe,
+  SubscribeAcceptEnum,
+} from "../funcs/statsSubscribe.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
+export { SubscribeAcceptEnum } from "../funcs/statsSubscribe.js";
+
 export class Stats extends ClientSDK {
   /**
    * Get platform statistics
@@ -19,4 +25,16 @@ export class Stats extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Server-sent-events stream of platform stats. Emits a snapshot, then deltas as the queues commit them.
+   */
+  async subscribe(
+    options?: RequestOptions & { acceptHeaderOverride?: SubscribeAcceptEnum },
+  ): Promise<operations.StatsSubscribeResponse> {
+    return unwrapAsync(statsSubscribe(
+      this,
+      options,
+    ));
+  }
 }