@steamsets/client-ts 0.32.7 → 0.33.0

package/src/funcs/cmsList.ts

@@ -0,0 +1,193 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SteamSetsCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { SteamSetsError } from "../models/errors/steamsetserror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List published CMS documents of a given type
+ */
+export function cmsList(
+  client: SteamSetsCore,
+  request: operations.ListRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SteamSetsCore,
+  request: operations.ListRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.ListResponse,
+      | errors.ErrorModel
+      | SteamSetsError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ListRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v1/cms.list")();
+
+  const query = encodeFormQuery({
+    "locale": payload.locale,
+    "preview": payload.preview,
+    "type": payload.type,
+  }, { explode: false });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.token);
+  const securityInput = secConfig == null ? {} : { token: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "list",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.token,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 5000,
+          exponent: 1.5,
+          maxElapsedTime: 60000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["501", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    uaHeader: "x-speakeasy-user-agent",
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.ListResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListResponse$inboundSchema, {
+      hdrs: true,
+      key: "V1CmsListResponseBody",
+    }),
+    M.jsonErr([400, 404, 422], errors.ErrorModel$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    M.jsonErr(500, errors.ErrorModel$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -59,8 +59,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.32.7",
-  genVersion: "2.881.0",
+  sdkVersion: "0.33.0",
+  genVersion: "2.881.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.32.7 2.881.0 1.0.0 @steamsets/client-ts",
+    "speakeasy-sdk/typescript 0.33.0 2.881.4 1.0.0 @steamsets/client-ts",
 } as const;

package/src/lib/event-streams.ts

@@ -0,0 +1,165 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+// Ensure ReadableStream always declares [Symbol.asyncIterator] so the
+// override keyword works consistently regardless of installed type
+// definitions (e.g. bun-types omits it from its ReadableStream).
+declare global {
+  interface ReadableStream<R = any> {
+    [Symbol.asyncIterator](): AsyncIterableIterator<R>;
+  }
+}
+
+export type SseMessage<T> = {
+  data?: T | undefined;
+  event?: string | null | undefined;
+  id?: string | null | undefined;
+  retry?: number | null | undefined;
+};
+export class EventStream<T extends SseMessage<unknown>>
+  extends ReadableStream<T>
+{
+  constructor(
+    responseBody: ReadableStream<Uint8Array>,
+    parse: (x: SseMessage<string>) => IteratorResult<T, undefined>,
+    opts?: { dataRequired?: boolean },
+  ) {
+    const upstream = responseBody.getReader();
+    let buffer: Uint8Array = new Uint8Array();
+    const state = { eventId: undefined as string | undefined };
+    const dataRequired = opts?.dataRequired ?? true;
+    super({
+      async pull(downstream) {
+        try {
+          while (true) {
+            const match = findBoundary(buffer);
+            if (!match) {
+              const chunk = await upstream.read();
+              if (chunk.done) return downstream.close();
+              buffer = concatBuffer(buffer, chunk.value);
+              continue;
+            }
+            const message = buffer.slice(0, match.index);
+            buffer = buffer.slice(match.index + match.length);
+            const item = parseMessage(message, parse, state, dataRequired);
+            if (item && !item.done) return downstream.enqueue(item.value);
+            if (item?.done) {
+              await upstream.cancel("done");
+              return downstream.close();
+            }
+          }
+        } catch (e) {
+          downstream.error(e);
+          await upstream.cancel(e);
+        }
+      },
+      cancel: reason => upstream.cancel(reason),
+    });
+  }
+
+  // Polyfill for older browsers
+  override [Symbol.asyncIterator](): AsyncIterableIterator<T> {
+    const fn = (ReadableStream.prototype as any)[Symbol.asyncIterator];
+    if (typeof fn === "function") return fn.call(this);
+    const reader = this.getReader();
+    return {
+      next: async () => {
+        const r = await reader.read();
+        if (r.done) {
+          reader.releaseLock();
+          return { done: true, value: undefined };
+        }
+        return { done: false, value: r.value };
+      },
+      throw: async (e) => {
+        await reader.cancel(e);
+        reader.releaseLock();
+        return { done: true, value: undefined };
+      },
+      return: async () => {
+        await reader.cancel("done");
+        reader.releaseLock();
+        return { done: true, value: undefined };
+      },
+      [Symbol.asyncIterator]() {
+        return this;
+      },
+    };
+  }
+}
+
+function concatBuffer(a: Uint8Array, b: Uint8Array): Uint8Array {
+  const c = new Uint8Array(a.length + b.length);
+  c.set(a, 0);
+  c.set(b, a.length);
+  return c;
+}
+
+const CR = 13;
+const LF = 10;
+const BOUNDARIES = [
+  [CR, LF, CR, LF], // \r\n\r\n
+  [CR, LF, CR], // \r\n\r
+  [CR, LF, LF], // \r\n\n
+  [CR, CR, LF], // \r\r\n
+  [LF, CR, LF], // \n\r\n
+  [CR, CR], // \r\r
+  [LF, CR], // \n\r
+  [LF, LF], // \n\n
+];
+
+function findBoundary(
+  buf: Uint8Array,
+): { index: number; length: number } | null {
+  const len = buf.length;
+  for (let i = 0; i < len; i++) {
+    if (buf[i] !== CR && buf[i] !== LF) continue;
+    for (const boundary of BOUNDARIES) {
+      if (i + boundary.length > len) continue;
+      let match = true;
+      for (let j = 0; j < boundary.length; j++) {
+        if (buf[i + j] !== boundary[j]) {
+          match = false;
+          break;
+        }
+      }
+      if (match) return { index: i, length: boundary.length };
+    }
+  }
+  return null;
+}
+function parseMessage<T extends SseMessage<unknown>>(
+  chunk: Uint8Array,
+  parse: (x: SseMessage<string>) => IteratorResult<T, undefined>,
+  state: { eventId: string | undefined },
+  dataRequired: boolean,
+) {
+  const text = new TextDecoder().decode(chunk);
+  const lines = text.split(/\r\n|\r|\n/);
+  const dataLines: string[] = [];
+  const ret: SseMessage<string> = {};
+  let ignore = true;
+  for (const line of lines) {
+    if (!line || line.startsWith(":")) continue;
+    ignore = false;
+    const i = line.indexOf(":");
+    let field = line;
+    let value = "";
+    if (i > 0) {
+      field = line.slice(0, i);
+      value = line[i + 1] === " " ? line.slice(i + 2) : line.slice(i + 1);
+    }
+    if (field === "data") dataLines.push(value);
+    else if (field === "event") ret.event = value;
+    else if (field === "id" && !value.includes("\0")) state.eventId = value;
+    else if (field === "retry" && /^\d+$/.test(value)) {
+      ret.retry = Number(value);
+    }
+  }
+  if (ignore) return;
+  ret.id = state.eventId;
+  if (dataLines.length) ret.data = dataLines.join("\n");
+  else if (dataRequired) return; // skip data-less events when data is required
+  return parse(ret);
+}

package/src/lib/sdks.ts

@@ -378,8 +378,6 @@ async function logResponse(
       break;
     case matchContentType(res, "application/jsonl")
       || jsonlLikeContentTypeRE.test(ct):
-      logger.log(await res.clone().text());
-      break;
     case matchContentType(res, "text/event-stream"):
       logger.log(`<${contentType}>`);
       break;

package/src/models/components/admincmsitem.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AdminCmsItem = {
+  docKey: string;
+  latestVersionUid?: string | undefined;
+  parentUid?: string | undefined;
+  payload?: any | undefined;
+  publishedVersionUid?: string | undefined;
+  sortOrder: number;
+  status: string;
+  type: string;
+  uid: string;
+  updatedAt: Date;
+};
+
+/** @internal */
+export const AdminCmsItem$inboundSchema: z.ZodType<
+  AdminCmsItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  doc_key: z.string(),
+  latest_version_uid: z.string().optional(),
+  parent_uid: z.string().optional(),
+  payload: z.any().optional(),
+  published_version_uid: z.string().optional(),
+  sort_order: z.number().int(),
+  status: z.string(),
+  type: z.string(),
+  uid: z.string(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "doc_key": "docKey",
+    "latest_version_uid": "latestVersionUid",
+    "parent_uid": "parentUid",
+    "published_version_uid": "publishedVersionUid",
+    "sort_order": "sortOrder",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function adminCmsItemFromJSON(
+  jsonString: string,
+): SafeParseResult<AdminCmsItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdminCmsItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdminCmsItem' from JSON`,
+  );
+}

package/src/models/components/cmslistitem.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CmsListItem = {
+  docKey: string;
+  parentUid?: string | undefined;
+  payload?: any | undefined;
+  sortOrder: number;
+  uid: string;
+};
+
+/** @internal */
+export const CmsListItem$inboundSchema: z.ZodType<
+  CmsListItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  doc_key: z.string(),
+  parent_uid: z.string().optional(),
+  payload: z.any().optional(),
+  sort_order: z.number().int(),
+  uid: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "doc_key": "docKey",
+    "parent_uid": "parentUid",
+    "sort_order": "sortOrder",
+  });
+});
+
+export function cmsListItemFromJSON(
+  jsonString: string,
+): SafeParseResult<CmsListItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CmsListItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CmsListItem' from JSON`,
+  );
+}

package/src/models/components/cmsversionitem.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CmsVersionItem = {
+  createdAt: Date;
+  createdBy: number;
+  documentUid: string;
+  note?: string | undefined;
+  payload?: any | undefined;
+  uid: string;
+  versionNumber: number;
+};
+
+/** @internal */
+export const CmsVersionItem$inboundSchema: z.ZodType<
+  CmsVersionItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  created_by: z.number().int(),
+  document_uid: z.string(),
+  note: z.string().optional(),
+  payload: z.any().optional(),
+  uid: z.string(),
+  version_number: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "created_by": "createdBy",
+    "document_uid": "documentUid",
+    "version_number": "versionNumber",
+  });
+});
+
+export function cmsVersionItemFromJSON(
+  jsonString: string,
+): SafeParseResult<CmsVersionItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CmsVersionItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CmsVersionItem' from JSON`,
+  );
+}

package/src/models/components/errormodel.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { ErrorDetail, ErrorDetail$inboundSchema } from "./errordetail.js";
+
+export type ErrorModel = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * Optional list of individual error details
+   */
+  errors?: Array<ErrorDetail> | null | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.
+   */
+  instance?: string | undefined;
+  /**
+   * HTTP status code
+   */
+  status?: number | undefined;
+  /**
+   * A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
+   */
+  title?: string | undefined;
+  /**
+   * A URI reference to human-readable documentation for the error.
+   */
+  type: string;
+};
+
+/** @internal */
+export const ErrorModel$inboundSchema: z.ZodType<
+  ErrorModel,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  detail: z.string().optional(),
+  errors: z.nullable(z.array(ErrorDetail$inboundSchema)).optional(),
+  instance: z.string().optional(),
+  status: z.number().int().optional(),
+  title: z.string().optional(),
+  type: z.string().default("about:blank"),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function errorModelFromJSON(
+  jsonString: string,
+): SafeParseResult<ErrorModel, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ErrorModel$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ErrorModel' from JSON`,
+  );
+}

package/src/models/components/image.ts

@@ -16,7 +16,7 @@ export const ImageType = {
   Avatar: "avatar",
   Background: "background",
   AvatarFrame: "avatar_frame",
-  AniamtedAvatar: "aniamted_avatar",
+  AnimatedAvatar: "animated_avatar",
   MiniBackground: "mini_background",
 } as const;
 /**

package/src/models/components/index.ts

@@ -5,6 +5,7 @@
 export * from "./accountbadgeinfo.js";
 export * from "./accountleaderboardhistory.js";
 export * from "./accountsearch.js";
+export * from "./admincmsitem.js";
 export * from "./badge.js";
 export * from "./badgesuggesttags.js";
 export * from "./badgevaluefilter.js";
@@ -12,6 +13,8 @@ export * from "./bestleaderboardrank.js";
 export * from "./card.js";
 export * from "./chosenrole.js";
 export * from "./city.js";
+export * from "./cmslistitem.js";
+export * from "./cmsversionitem.js";
 export * from "./colortag.js";
 export * from "./connection.js";
 export * from "./country.js";
@@ -24,6 +27,7 @@ export * from "./developerappanalyticsoutcome.js";
 export * from "./developerappanalyticstimeseries.js";
 export * from "./developerappanalyticstimeseriespoint.js";
 export * from "./errordetail.js";
+export * from "./errormodel.js";
 export * from "./friendpath.js";
 export * from "./historyvalue.js";
 export * from "./httpmetadata.js";
@@ -39,6 +43,7 @@ export * from "./loginrequestbody.js";
 export * from "./previewaccount.js";
 export * from "./range.js";
 export * from "./region.js";
+export * from "./reorderitemreq.js";
 export * from "./requestbody.js";
 export * from "./resource.js";
 export * from "./responsebody.js";
@@ -118,6 +123,26 @@ export * from "./v1accountvanityupdate.js";
 export * from "./v1accountverifyconnectionrequestbody.js";
 export * from "./v1accountverifyconnectionresponsebody.js";
 export * from "./v1accountverifyemailrequestbody.js";
+export * from "./v1activityaccountfeedevent.js";
+export * from "./v1activityglobalfeedevent.js";
+export * from "./v1activitylistaccountfeedrequestbody.js";
+export * from "./v1activitylistaccountfeedresponsebody.js";
+export * from "./v1activitylistglobalfeedrequestbody.js";
+export * from "./v1activitylistglobalfeedresponsebody.js";
+export * from "./v1activitystreamfeedevent.js";
+export * from "./v1admincmsarchiverequestbody.js";
+export * from "./v1admincmscreaterequestbody.js";
+export * from "./v1admincmscreateresponsebody.js";
+export * from "./v1admincmslistresponsebody.js";
+export * from "./v1admincmspreviewtokenrequestbody.js";
+export * from "./v1admincmspreviewtokenresponsebody.js";
+export * from "./v1admincmspublishrequestbody.js";
+export * from "./v1admincmsreorderrequestbody.js";
+export * from "./v1admincmsupdatedraftrequestbody.js";
+export * from "./v1admincmsupdatedraftresponsebody.js";
+export * from "./v1admincmsuploadimagerequestbody.js";
+export * from "./v1admincmsuploadimageresponsebody.js";
+export * from "./v1admincmsversionsresponsebody.js";
 export * from "./v1admingetaccountresponsebody.js";
 export * from "./v1adminremovevanityresponsebody.js";
 export * from "./v1adminupdateresourcesrequestbody.js";
@@ -135,6 +160,7 @@ export * from "./v1badgesearchbadgesresponsebody.js";
 export * from "./v1badgesuggesttagsrequestbody.js";
 export * from "./v1badgetagbadgerequestbody.js";
 export * from "./v1badgetagbadgeresponsebody.js";
+export * from "./v1cmslistresponsebody.js";
 export * from "./v1groupleaderboardgroup.js";
 export * from "./v1leaderboardappinfo.js";
 export * from "./v1leaderboardbadge.js";