@s2-dev/streamstore 0.15.0 → 0.15.2

package/src/funcs/streamsReconfigureStream.ts

@@ -11,7 +11,6 @@ import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
 import * as components from "../models/components/index.js";
-import { APIError } from "../models/errors/apierror.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -20,6 +19,8 @@ import {
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
 import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { S2Error } from "../models/errors/s2error.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
 import { ReconfigureStreamServerList } from "../models/operations/reconfigurestream.js";
@@ -37,13 +38,14 @@ export function streamsReconfigureStream(
   Result<
     components.StreamConfig,
     | errors.ErrorResponse
-    | APIError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | S2Error
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >
 > {
   return new APIPromise($do(
@@ -62,13 +64,14 @@ async function $do(
     Result<
       components.StreamConfig,
       | errors.ErrorResponse
-      | APIError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
+      | S2Error
+      | ResponseValidationError
+      | ConnectionError
       | RequestAbortedError
       | RequestTimeoutError
-      | ConnectionError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
     >,
     APICall,
   ]
@@ -161,19 +164,20 @@ async function $do(
   const [result] = await M.match<
     components.StreamConfig,
     | errors.ErrorResponse
-    | APIError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | S2Error
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >(
     M.json(200, components.StreamConfig$inboundSchema),
     M.jsonErr([400, 403, 404, 409], errors.ErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
-  )(response, { extraFields: responseFields });
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/lib/config.ts

@@ -58,8 +58,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.15.0",
-  genVersion: "2.618.0",
+  sdkVersion: "0.15.2",
+  genVersion: "2.632.2",
   userAgent:
-    "speakeasy-sdk/typescript 0.15.0 2.618.0 1.0.0 @s2-dev/streamstore",
+    "speakeasy-sdk/typescript 0.15.2 2.632.2 1.0.0 @s2-dev/streamstore",
 } as const;

package/src/lib/files.ts

@@ -38,3 +38,45 @@ export async function readableStreamToArrayBuffer(
 
   return concatenatedChunks.buffer as ArrayBuffer;
 }
+
+/**
+ * Determines the MIME content type based on a file's extension.
+ * Returns null if the extension is not recognized.
+ */
+export function getContentTypeFromFileName(fileName: string): string | null {
+  if (!fileName) return null;
+
+  const ext = fileName.toLowerCase().split(".").pop();
+  if (!ext) return null;
+
+  const mimeTypes: Record<string, string> = {
+    json: "application/json",
+    xml: "application/xml",
+    html: "text/html",
+    htm: "text/html",
+    txt: "text/plain",
+    csv: "text/csv",
+    pdf: "application/pdf",
+    png: "image/png",
+    jpg: "image/jpeg",
+    jpeg: "image/jpeg",
+    gif: "image/gif",
+    svg: "image/svg+xml",
+    js: "application/javascript",
+    css: "text/css",
+    zip: "application/zip",
+    tar: "application/x-tar",
+    gz: "application/gzip",
+    mp4: "video/mp4",
+    mp3: "audio/mpeg",
+    wav: "audio/wav",
+    webp: "image/webp",
+    ico: "image/x-icon",
+    woff: "font/woff",
+    woff2: "font/woff2",
+    ttf: "font/ttf",
+    otf: "font/otf",
+  };
+
+  return mimeTypes[ext] || null;
+}

package/src/lib/matchers.ts

@@ -3,12 +3,11 @@
  */
 
 import { APIError } from "../models/errors/apierror.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import { Result } from "../types/fp.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { ERR, OK, Result } from "../types/fp.js";
 import { discardSentinel } from "./event-streams.js";
 import { matchResponse, matchStatusCode, StatusCodePredicate } from "./http.js";
 import { isPlainObject } from "./is-plain-object.js";
-import { safeParse } from "./schemas.js";
 
 export type Encoding =
   | "jsonl"
@@ -177,17 +176,19 @@ export type MatchedError<Matchers> = Matchers extends Matcher<any, infer E>[]
   : never;
 export type MatchFunc<T, E> = (
   response: Response,
+  request: Request,
   options?: { resultKey?: string; extraFields?: Record<string, unknown> },
 ) => Promise<[result: Result<T, E>, raw: unknown]>;
 
 export function match<T, E>(
   ...matchers: Array<Matcher<T, E>>
-): MatchFunc<T, E | APIError | SDKValidationError> {
+): MatchFunc<T, E | APIError | ResponseValidationError> {
   return async function matchFunc(
     response: Response,
+    request: Request,
     options?: { resultKey?: string; extraFields?: Record<string, unknown> },
   ): Promise<
-    [result: Result<T, E | APIError | SDKValidationError>, raw: unknown]
+    [result: Result<T, E | APIError | ResponseValidationError>, raw: unknown]
   > {
     let raw: unknown;
     let matcher: Matcher<T, E> | undefined;
@@ -206,21 +207,22 @@ export function match<T, E>(
     }
 
     if (!matcher) {
-      const responseBody = await response.text();
       return [{
         ok: false,
-        error: new APIError(
-          "Unexpected API response status or content-type",
+        error: new APIError("Unexpected Status or Content-Type", {
           response,
-          responseBody,
-        ),
-      }, responseBody];
+          request,
+          body: await response.text().catch(() => ""),
+        }),
+      }, raw];
     }
 
     const encoding = matcher.enc;
+    let body = "";
     switch (encoding) {
       case "json":
-        raw = await response.json();
+        body = await response.text();
+        raw = JSON.parse(body);
         break;
       case "jsonl":
         raw = response.body;
@@ -232,7 +234,8 @@ export function match<T, E>(
         raw = response.body;
         break;
       case "text":
-        raw = await response.text();
+        body = await response.text();
+        raw = body;
         break;
       case "sse":
         raw = response.body && matcher.sseSentinel
@@ -240,10 +243,12 @@ export function match<T, E>(
           : response.body;
         break;
       case "nil":
-        raw = await discardResponseBody(response);
+        body = await response.text();
+        raw = undefined;
         break;
       case "fail":
-        raw = await response.text();
+        body = await response.text();
+        raw = body;
         break;
       default:
         encoding satisfies never;
@@ -253,11 +258,7 @@ export function match<T, E>(
     if (matcher.enc === "fail") {
       return [{
         ok: false,
-        error: new APIError(
-          "API error occurred",
-          response,
-          typeof raw === "string" ? raw : "",
-        ),
+        error: new APIError("API error occurred", { request, response, body }),
       }, raw];
     }
 
@@ -269,6 +270,9 @@ export function match<T, E>(
         ...options?.extraFields,
         ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null),
         ...(isPlainObject(raw) ? raw : null),
+        request$: request,
+        response$: response,
+        body$: body,
       };
     } else if (resultKey) {
       data = {
@@ -287,18 +291,20 @@ export function match<T, E>(
     }
 
     if ("err" in matcher) {
-      const result = safeParse(
+      const result = safeParseResponse(
         data,
         (v: unknown) => matcher.schema.parse(v),
         "Response validation failed",
+        { request, response, body },
       );
       return [result.ok ? { ok: false, error: result.value } : result, raw];
     } else {
       return [
-        safeParse(
+        safeParseResponse(
           data,
           (v: unknown) => matcher.schema.parse(v),
           "Response validation failed",
+          { request, response, body },
         ),
         raw,
       ];
@@ -321,25 +327,22 @@ export function unpackHeaders(headers: Headers): Record<string, string[]> {
   return out;
 }
 
-/**
- * Discards the response body to free up resources.
- *
- * To learn why this is need, see the undici docs:
- * https://undici.nodejs.org/#/?id=garbage-collection
- */
-export async function discardResponseBody(res: Response) {
-  const reader = res.body?.getReader();
-  if (reader == null) {
-    return;
-  }
-
+function safeParseResponse<Inp, Out>(
+  rawValue: Inp,
+  fn: (value: Inp) => Out,
+  errorMessage: string,
+  httpMeta: { response: Response; request: Request; body: string },
+): Result<Out, ResponseValidationError> {
   try {
-    let done = false;
-    while (!done) {
-      const res = await reader.read();
-      done = res.done;
-    }
-  } finally {
-    reader.releaseLock();
+    return OK(fn(rawValue));
+  } catch (err) {
+    return ERR(
+      new ResponseValidationError(errorMessage, {
+        cause: err,
+        rawValue,
+        rawMessage: errorMessage,
+        ...httpMeta,
+      }),
+    );
   }
 }

package/src/lib/security.ts

@@ -7,8 +7,8 @@ import { env } from "./env.js";
 
 type OAuth2PasswordFlow = {
   username: string;
-  password?: string | undefined;
-  clientID: string;
+  password: string;
+  clientID?: string | undefined;
   clientSecret?: string | undefined;
   tokenURL: string;
 };

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "0.15.0",
+    currentVersion: "0.15.2",
   },
 });
 

package/src/mcp-server/server.ts

@@ -45,7 +45,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "S2",
-    version: "0.15.0",
+    version: "0.15.2",
   });
 
   const client = new S2Core({

package/src/mcp-server/tools/basinsGetBasinConfig.ts

@@ -12,7 +12,7 @@ const args = {
 
 export const tool$basinsGetBasinConfig: ToolDefinition<typeof args> = {
   name: "basins-get-basin-config",
-  description: `Get basin config.`,
+  description: `Get basin configuration.`,
   scopes: ["read", "read", "read"],
   args,
   tool: async (client, args, ctx) => {

package/src/mcp-server/tools/metricsAccountMetrics.ts

@@ -12,7 +12,7 @@ const args = {
 
 export const tool$metricsAccountMetrics: ToolDefinition<typeof args> = {
   name: "metrics-account-metrics",
-  description: `Get account level metrics.`,
+  description: `Account-level metrics.`,
   scopes: ["read", "read", "read"],
   args,
   tool: async (client, args, ctx) => {

package/src/mcp-server/tools/metricsBasinMetrics.ts

@@ -12,7 +12,7 @@ const args = {
 
 export const tool$metricsBasinMetrics: ToolDefinition<typeof args> = {
   name: "metrics-basin-metrics",
-  description: `Get metrics for a basin.`,
+  description: `Basin-level metrics.`,
   scopes: ["read", "read", "read"],
   args,
   tool: async (client, args, ctx) => {

package/src/mcp-server/tools/metricsStreamMetrics.ts

@@ -12,7 +12,7 @@ const args = {
 
 export const tool$metricsStreamMetrics: ToolDefinition<typeof args> = {
   name: "metrics-stream-metrics",
-  description: `Get metrics for a stream.`,
+  description: `Stream-level metrics.`,
   scopes: ["read", "read", "read"],
   args,
   tool: async (client, args, ctx) => {

package/src/mcp-server/tools/recordsAppend.ts

@@ -12,9 +12,7 @@ const args = {
 
 export const tool$recordsAppend: ToolDefinition<typeof args> = {
   name: "records-append",
-  description: `Append records.
-
-Append a batch of records to a stream.`,
+  description: `Append records.`,
   scopes: ["write", "write", "write"],
   args,
   tool: async (client, args, ctx) => {

package/src/mcp-server/tools/recordsCheckTail.ts

@@ -12,9 +12,7 @@ const args = {
 
 export const tool$recordsCheckTail: ToolDefinition<typeof args> = {
   name: "records-check-tail",
-  description: `Check the tail.
-
-Check the tail of a stream.`,
+  description: `Check the tail.`,
   scopes: ["read", "read", "read"],
   args,
   tool: async (client, args, ctx) => {

package/src/mcp-server/tools/recordsRead.ts

@@ -12,9 +12,7 @@ const args = {
 
 export const tool$recordsRead: ToolDefinition<typeof args> = {
   name: "records-read",
-  description: `Retrieve records.
-
-Retrieve a batch of records, or set \`Accept: text/event-stream\` to stream using server-sent events.`,
+  description: `Read records.`,
   scopes: ["read", "read", "read"],
   args,
   tool: async (client, args, ctx) => {

package/src/models/components/accesstokeninfo.ts

@@ -19,8 +19,7 @@ export type AccessTokenInfo = {
    * Namespace streams based on the configured stream-level scope, which must be a prefix.
    *
    * @remarks
-   * Stream name arguments will be automatically prefixed, and the prefix will be stripped
-   * when listing streams.
+   * Stream name arguments will be automatically prefixed, and the prefix will be stripped when listing streams.
    */
   autoPrefixStreams?: boolean | undefined;
   /**

package/src/models/components/accountmetricset.ts

@@ -6,8 +6,8 @@ import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
 export const AccountMetricSet = {
-  ActiveBasins: "active_basins",
-  AccountOps: "account_ops",
+  ActiveBasins: "active-basins",
+  AccountOps: "account-ops",
 } as const;
 export type AccountMetricSet = ClosedEnum<typeof AccountMetricSet>;
 

package/src/models/components/accumulation.ts

@@ -31,12 +31,8 @@ export type Accumulation = {
    * Timeseries values.
    *
    * @remarks
-   *
-   * Each element is a tuple containing the seconds since Unix epoch, followed by the data
-   * point.
-   *
-   * The data point represented the accumulated value for a bucket of time, starting
-   * at the provided epoch, lasting for the duration of the `bucket_length` parameter above.
+   * Each element is a tuple of a timestamp in Unix epoch seconds and a data point.
+   * The data point represents the accumulated value for a bucket of time starting at the provided timestamp, lasting for the duration of the `bucket_length` parameter.
    */
   values: Array<Array<number | number>>;
 };

package/src/models/components/appendack.ts

@@ -14,7 +14,7 @@ import {
 } from "./streamposition.js";
 
 /**
- * Success response message to an Append request.
+ * Success response to an `append` request.
  */
 export type AppendAck = {
   /**

package/src/models/components/appendinput.ts

@@ -15,19 +15,19 @@ import {
 } from "./appendrecord.js";
 
 /**
- * Payload of an Append request message.
+ * Payload of an `append` request.
  */
 export type AppendInput = {
   /**
-   * Enforce a fencing token which must have been previously set by a `fence` command record.
+   * Enforce a fencing token, which starts out as an empty string that can be overridden by a `fence` command record.
    */
   fencingToken?: string | null | undefined;
   matchSeqNum?: number | null | undefined;
   /**
-   * Batch of records to append atomically, which must contain at least one record, and no more
+   * Batch of records to append atomically, which must contain at least one record, and no more than 1000.
    *
    * @remarks
-   * than 1000. The total size of a batch of records may not exceed 1MiB of metered bytes.
+   * The total size of a batch of records may not exceed 1 MiB of metered bytes.
    */
   records: Array<AppendRecord>;
 };

package/src/models/components/basinconfig.ts

@@ -16,17 +16,11 @@ import {
 
 export type BasinConfig = {
   /**
-   * Create stream on append if it doesn't exist,
-   *
-   * @remarks
-   * using the default stream configuration.
+   * Create stream on append if it doesn't exist, using the default stream configuration.
    */
   createStreamOnAppend?: boolean | undefined;
   /**
-   * Create stream on read if it doesn't exist,
-   *
-   * @remarks
-   * using the default stream configuration.
+   * Create stream on read if it doesn't exist, using the default stream configuration.
    */
   createStreamOnRead?: boolean | undefined;
   defaultStreamConfig?: StreamConfig | null | undefined;

package/src/models/components/basinmetricset.ts

@@ -7,11 +7,11 @@ import { ClosedEnum } from "../../types/enums.js";
 
 export const BasinMetricSet = {
   Storage: "storage",
-  AppendOps: "append_ops",
-  ReadOps: "read_ops",
-  ReadThroughput: "read_throughput",
-  AppendThroughput: "append_throughput",
-  BasinOps: "basin_ops",
+  AppendOps: "append-ops",
+  ReadOps: "read-ops",
+  ReadThroughput: "read-throughput",
+  AppendThroughput: "append-throughput",
+  BasinOps: "basin-ops",
 } as const;
 export type BasinMetricSet = ClosedEnum<typeof BasinMetricSet>;
 

package/src/models/components/createbasinrequest.ts

@@ -25,8 +25,7 @@ export type CreateBasinRequest = {
    * Basin name which must be globally unique.
    *
    * @remarks
-   * It can be between 8 and 48 characters in length,
-   * and comprise lowercase letters, numbers and hyphens.
+   * It can be between 8 and 48 characters in length, and comprise lowercase letters, numbers and hyphens.
    * It cannot begin or end with a hyphen.
    */
   basin: string;

package/src/models/components/gauge.ts

@@ -24,11 +24,8 @@ export type Gauge = {
    * Timeseries values.
    *
    * @remarks
-   *
-   * Each element is a tuple containing the seconds since Unix epoch, followed by the data
-   * point.
-   *
-   * The data point represents the value at the instant of the epoch.
+   * Each element is a tuple of a timestamp in Unix epoch seconds and a data point.
+   * The data point represents the value at the instant of the timestamp.
    */
   values: Array<Array<number | number>>;
 };

package/src/models/components/listaccesstokensresponse.ts

@@ -16,11 +16,11 @@ import {
 
 export type ListAccessTokensResponse = {
   /**
-   * Access tokens information.
+   * Matching access tokens.
    */
   accessTokens: Array<AccessTokenInfo>;
   /**
-   * Indicates that there are more results that can be listed with `start_after`.
+   * Indicates that there are more access tokens that match the criteria.
    */
   hasMore: boolean;
 };

package/src/models/components/listbasinsresponse.ts

@@ -20,7 +20,7 @@ export type ListBasinsResponse = {
    */
   basins: Array<BasinInfo>;
   /**
-   * Indicates that there are more results that can be listed with `start_after`.
+   * Indicates that there are more basins that match the criteria.
    */
   hasMore: boolean;
 };

package/src/models/components/liststreamsresponse.ts

@@ -16,7 +16,7 @@ import {
 
 export type ListStreamsResponse = {
   /**
-   * Indicates that there are more results that can be listed with `start_after`.
+   * Indicates that there are more results that match the criteria.
    */
   hasMore: boolean;
   /**

package/src/models/components/metric.ts

@@ -32,21 +32,21 @@ import {
 } from "./scalar.js";
 
 /**
- * A set of string labels.
+ * Set of string labels.
  */
 export type Four = {
   label: Label;
 };
 
 /**
- * A named series of (timestamp, value) points each representing an instantaneous value.
+ * Named series of `(timestamp, value)` points each representing an instantaneous value.
  */
 export type Three = {
   gauge: Gauge;
 };
 
 /**
- * A named series of (timestamp, value) points representing an accumulation over a specified
+ * Named series of `(timestamp, value)` points representing an accumulation over a specified
  *
  * @remarks
  * bucket.
@@ -56,7 +56,7 @@ export type Two = {
 };
 
 /**
- * A single named value.
+ * Single named value.
  */
 export type Metric1 = {
   scalar: Scalar;