@s2-dev/streamstore 0.14.0 → 0.15.1

package/src/models/errors/s2error.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/** The base class for all HTTP error responses */
+export class S2Error extends Error {
+  /** HTTP status code */
+  public readonly statusCode: number;
+  /** HTTP body */
+  public readonly body: string;
+  /** HTTP headers */
+  public readonly headers: Headers;
+  /** HTTP content type */
+  public readonly contentType: string;
+  /** Raw response */
+  public readonly rawResponse: Response;
+
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(message);
+    this.statusCode = httpMeta.response.status;
+    this.body = httpMeta.body;
+    this.headers = httpMeta.response.headers;
+    this.contentType = httpMeta.response.headers.get("content-type") || "";
+    this.rawResponse = httpMeta.response;
+
+    this.name = "S2Error";
+  }
+}

package/src/models/errors/sdkvalidationerror.ts

@@ -15,6 +15,18 @@ export class SDKValidationError extends Error {
    */
   public readonly rawMessage: unknown;
 
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
   constructor(message: string, cause: unknown, rawValue: unknown) {
     super(`${message}: ${cause}`);
     this.name = "SDKValidationError";

package/src/models/errors/tailresponse.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod";
 import * as components from "../components/index.js";
+import { S2Error } from "./s2error.js";
 
 export type TailResponseData = {
   /**
@@ -12,7 +13,7 @@ export type TailResponseData = {
   tail: components.StreamPosition;
 };
 
-export class TailResponse extends Error {
+export class TailResponse extends S2Error {
   /**
    * Position of a record in a stream.
    */
@@ -21,13 +22,15 @@ export class TailResponse extends Error {
   /** The original data that was passed to this error instance. */
   data$: TailResponseData;
 
-  constructor(err: TailResponseData) {
+  constructor(
+    err: TailResponseData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = "message" in err && typeof err.message === "string"
       ? err.message
       : `API error occurred: ${JSON.stringify(err)}`;
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
     this.tail = err.tail;
 
     this.name = "TailResponse";
@@ -41,9 +44,16 @@ export const TailResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   tail: components.StreamPosition$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new TailResponse(v);
+    return new TailResponse(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/operations/accountmetrics.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 AccountMetricsRequest = {
+  /**
+   * Metric type to return.
+   */
+  set: components.AccountMetricSet;
+  /**
+   * Start timestamp, in Unix epoch seconds, if applicable for metric set.
+   */
+  start?: number | undefined;
+  /**
+   * End timestamp, in Unix epoch seconds, if applicable for metric set.
+   */
+  end?: number | undefined;
+  /**
+   * For timeseries metric sets, the interval to aggregate over.
+   */
+  interval?: components.TimeseriesInterval | undefined;
+};
+
+/** @internal */
+export const AccountMetricsRequest$inboundSchema: z.ZodType<
+  AccountMetricsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  set: components.AccountMetricSet$inboundSchema,
+  start: z.number().int().optional(),
+  end: z.number().int().optional(),
+  interval: components.TimeseriesInterval$inboundSchema.optional(),
+});
+
+/** @internal */
+export type AccountMetricsRequest$Outbound = {
+  set: string;
+  start?: number | undefined;
+  end?: number | undefined;
+  interval?: string | undefined;
+};
+
+/** @internal */
+export const AccountMetricsRequest$outboundSchema: z.ZodType<
+  AccountMetricsRequest$Outbound,
+  z.ZodTypeDef,
+  AccountMetricsRequest
+> = z.object({
+  set: components.AccountMetricSet$outboundSchema,
+  start: z.number().int().optional(),
+  end: z.number().int().optional(),
+  interval: components.TimeseriesInterval$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AccountMetricsRequest$ {
+  /** @deprecated use `AccountMetricsRequest$inboundSchema` instead. */
+  export const inboundSchema = AccountMetricsRequest$inboundSchema;
+  /** @deprecated use `AccountMetricsRequest$outboundSchema` instead. */
+  export const outboundSchema = AccountMetricsRequest$outboundSchema;
+  /** @deprecated use `AccountMetricsRequest$Outbound` instead. */
+  export type Outbound = AccountMetricsRequest$Outbound;
+}
+
+export function accountMetricsRequestToJSON(
+  accountMetricsRequest: AccountMetricsRequest,
+): string {
+  return JSON.stringify(
+    AccountMetricsRequest$outboundSchema.parse(accountMetricsRequest),
+  );
+}
+
+export function accountMetricsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AccountMetricsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AccountMetricsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AccountMetricsRequest' from JSON`,
+  );
+}

package/src/models/operations/basinmetrics.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 BasinMetricsRequest = {
+  /**
+   * Metric type to return.
+   */
+  set: components.BasinMetricSet;
+  /**
+   * Start timestamp, in Unix epoch seconds, if applicable for metric set.
+   */
+  start?: number | undefined;
+  /**
+   * End timestamp, in Unix epoch seconds, if applicable for metric set.
+   */
+  end?: number | undefined;
+  /**
+   * For timeseries metric sets, the interval to aggregate over.
+   */
+  interval?: components.TimeseriesInterval | undefined;
+  /**
+   * Basin name.
+   */
+  basin: string;
+};
+
+/** @internal */
+export const BasinMetricsRequest$inboundSchema: z.ZodType<
+  BasinMetricsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  set: components.BasinMetricSet$inboundSchema,
+  start: z.number().int().optional(),
+  end: z.number().int().optional(),
+  interval: components.TimeseriesInterval$inboundSchema.optional(),
+  basin: z.string(),
+});
+
+/** @internal */
+export type BasinMetricsRequest$Outbound = {
+  set: string;
+  start?: number | undefined;
+  end?: number | undefined;
+  interval?: string | undefined;
+  basin: string;
+};
+
+/** @internal */
+export const BasinMetricsRequest$outboundSchema: z.ZodType<
+  BasinMetricsRequest$Outbound,
+  z.ZodTypeDef,
+  BasinMetricsRequest
+> = z.object({
+  set: components.BasinMetricSet$outboundSchema,
+  start: z.number().int().optional(),
+  end: z.number().int().optional(),
+  interval: components.TimeseriesInterval$outboundSchema.optional(),
+  basin: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BasinMetricsRequest$ {
+  /** @deprecated use `BasinMetricsRequest$inboundSchema` instead. */
+  export const inboundSchema = BasinMetricsRequest$inboundSchema;
+  /** @deprecated use `BasinMetricsRequest$outboundSchema` instead. */
+  export const outboundSchema = BasinMetricsRequest$outboundSchema;
+  /** @deprecated use `BasinMetricsRequest$Outbound` instead. */
+  export type Outbound = BasinMetricsRequest$Outbound;
+}
+
+export function basinMetricsRequestToJSON(
+  basinMetricsRequest: BasinMetricsRequest,
+): string {
+  return JSON.stringify(
+    BasinMetricsRequest$outboundSchema.parse(basinMetricsRequest),
+  );
+}
+
+export function basinMetricsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<BasinMetricsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BasinMetricsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BasinMetricsRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -2,7 +2,9 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./accountmetrics.js";
 export * from "./append.js";
+export * from "./basinmetrics.js";
 export * from "./checktail.js";
 export * from "./createorreconfigurebasin.js";
 export * from "./createorreconfigurestream.js";
@@ -18,3 +20,4 @@ export * from "./read.js";
 export * from "./reconfigurebasin.js";
 export * from "./reconfigurestream.js";
 export * from "./revokeaccesstoken.js";
+export * from "./streammetrics.js";

package/src/models/operations/read.ts

@@ -43,12 +43,25 @@ export type ReadRequest = {
   tailOffset?: number | undefined;
   /**
    * Limit total records to return.
+   *
+   * @remarks
+   * If this is provided, tailing will be disabled.
    */
   count?: number | undefined;
   /**
    * Limit total metered bytes to return.
+   *
+   * @remarks
+   * If this is provided, tailing will be disabled.
    */
   bytes?: number | undefined;
+  /**
+   * Exclusive timestamp to read until.
+   *
+   * @remarks
+   * If this is provided, tailing will be disabled.
+   */
+  until?: number | undefined;
   /**
    * Basin name for basin-specific endpoints
    */
@@ -72,6 +85,7 @@ export const ReadRequest$inboundSchema: z.ZodType<
   tail_offset: z.number().int().optional(),
   count: z.number().int().optional(),
   bytes: z.number().int().optional(),
+  until: z.number().int().optional(),
   "s2-basin": z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -91,6 +105,7 @@ export type ReadRequest$Outbound = {
   tail_offset?: number | undefined;
   count?: number | undefined;
   bytes?: number | undefined;
+  until?: number | undefined;
   "s2-basin": string;
 };
 
@@ -107,6 +122,7 @@ export const ReadRequest$outboundSchema: z.ZodType<
   tailOffset: z.number().int().optional(),
   count: z.number().int().optional(),
   bytes: z.number().int().optional(),
+  until: z.number().int().optional(),
   s2Basin: z.string(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/operations/streammetrics.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type StreamMetricsRequest = {
+  /**
+   * Basin name.
+   */
+  basin: string;
+  /**
+   * Stream name.
+   */
+  stream: string;
+};
+
+/** @internal */
+export const StreamMetricsRequest$inboundSchema: z.ZodType<
+  StreamMetricsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  basin: z.string(),
+  stream: z.string(),
+});
+
+/** @internal */
+export type StreamMetricsRequest$Outbound = {
+  basin: string;
+  stream: string;
+};
+
+/** @internal */
+export const StreamMetricsRequest$outboundSchema: z.ZodType<
+  StreamMetricsRequest$Outbound,
+  z.ZodTypeDef,
+  StreamMetricsRequest
+> = z.object({
+  basin: z.string(),
+  stream: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace StreamMetricsRequest$ {
+  /** @deprecated use `StreamMetricsRequest$inboundSchema` instead. */
+  export const inboundSchema = StreamMetricsRequest$inboundSchema;
+  /** @deprecated use `StreamMetricsRequest$outboundSchema` instead. */
+  export const outboundSchema = StreamMetricsRequest$outboundSchema;
+  /** @deprecated use `StreamMetricsRequest$Outbound` instead. */
+  export type Outbound = StreamMetricsRequest$Outbound;
+}
+
+export function streamMetricsRequestToJSON(
+  streamMetricsRequest: StreamMetricsRequest,
+): string {
+  return JSON.stringify(
+    StreamMetricsRequest$outboundSchema.parse(streamMetricsRequest),
+  );
+}
+
+export function streamMetricsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<StreamMetricsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreamMetricsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreamMetricsRequest' from JSON`,
+  );
+}

package/src/sdk/metrics.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { metricsAccountMetrics } from "../funcs/metricsAccountMetrics.js";
+import { metricsBasinMetrics } from "../funcs/metricsBasinMetrics.js";
+import { metricsStreamMetrics } from "../funcs/metricsStreamMetrics.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Metrics extends ClientSDK {
+  /**
+   * Get account level metrics.
+   */
+  async accountMetrics(
+    request: operations.AccountMetricsRequest,
+    options?: RequestOptions,
+  ): Promise<components.MetricSetResponse> {
+    return unwrapAsync(metricsAccountMetrics(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get metrics for a basin.
+   */
+  async basinMetrics(
+    request: operations.BasinMetricsRequest,
+    options?: RequestOptions,
+  ): Promise<components.MetricSetResponse> {
+    return unwrapAsync(metricsBasinMetrics(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get metrics for a stream.
+   */
+  async streamMetrics(
+    request: operations.StreamMetricsRequest,
+    options?: RequestOptions,
+  ): Promise<components.MetricSetResponse> {
+    return unwrapAsync(metricsStreamMetrics(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -5,6 +5,7 @@
 import { ClientSDK } from "../lib/sdks.js";
 import { AccessTokens } from "./accesstokens.js";
 import { Basins } from "./basins.js";
+import { Metrics } from "./metrics.js";
 import { Records } from "./records.js";
 import { Streams } from "./streams.js";
 
@@ -19,6 +20,11 @@ export class S2 extends ClientSDK {
     return (this._basins ??= new Basins(this._options));
   }
 
+  private _metrics?: Metrics;
+  get metrics(): Metrics {
+    return (this._metrics ??= new Metrics(this._options));
+  }
+
   private _streams?: Streams;
   get streams(): Streams {
     return (this._streams ??= new Streams(this._options));