cribl-control-plane 0.0.1

package/src/models/errors/healthstatuserror.ts

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import * as models from "../index.js";
+import { CriblControlPlaneError } from "./criblcontrolplaneerror.js";
+
+export type HealthStatusErrorData = {
+  role?: models.Role | undefined;
+  status: models.Status;
+  startTime: number;
+};
+
+export class HealthStatusError extends CriblControlPlaneError {
+  role?: models.Role | undefined;
+  status: models.Status;
+  startTime: number;
+
+  /** The original data that was passed to this error instance. */
+  data$: HealthStatusErrorData;
+
+  constructor(
+    err: HealthStatusErrorData,
+    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, httpMeta);
+    this.data$ = err;
+    if (err.role != null) this.role = err.role;
+    this.status = err.status;
+    this.startTime = err.startTime;
+
+    this.name = "HealthStatusError";
+  }
+}
+
+/** @internal */
+export const HealthStatusError$inboundSchema: z.ZodType<
+  HealthStatusError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  role: models.Role$inboundSchema.optional(),
+  status: models.Status$inboundSchema,
+  startTime: z.number(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new HealthStatusError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type HealthStatusError$Outbound = {
+  role?: string | undefined;
+  status: string;
+  startTime: number;
+};
+
+/** @internal */
+export const HealthStatusError$outboundSchema: z.ZodType<
+  HealthStatusError$Outbound,
+  z.ZodTypeDef,
+  HealthStatusError
+> = z.instanceof(HealthStatusError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    role: models.Role$outboundSchema.optional(),
+    status: models.Status$outboundSchema,
+    startTime: z.number(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace HealthStatusError$ {
+  /** @deprecated use `HealthStatusError$inboundSchema` instead. */
+  export const inboundSchema = HealthStatusError$inboundSchema;
+  /** @deprecated use `HealthStatusError$outboundSchema` instead. */
+  export const outboundSchema = HealthStatusError$outboundSchema;
+  /** @deprecated use `HealthStatusError$Outbound` instead. */
+  export type Outbound = HealthStatusError$Outbound;
+}

package/src/models/errors/httpclienterrors.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * Base class for all HTTP errors.
+ */
+export class HTTPClientError extends Error {
+  /** The underlying cause of the error. */
+  override readonly cause: unknown;
+  override name = "HTTPClientError";
+  constructor(message: string, opts?: { cause?: unknown }) {
+    let msg = message;
+    if (opts?.cause) {
+      msg += `: ${opts.cause}`;
+    }
+
+    super(msg, opts);
+    // In older runtimes, the cause field would not have been assigned through
+    // the super() call.
+    if (typeof this.cause === "undefined") {
+      this.cause = opts?.cause;
+    }
+  }
+}
+
+/**
+ * An error to capture unrecognised or unexpected errors when making HTTP calls.
+ */
+export class UnexpectedClientError extends HTTPClientError {
+  override name = "UnexpectedClientError";
+}
+
+/**
+ * An error that is raised when any inputs used to create a request are invalid.
+ */
+export class InvalidRequestError extends HTTPClientError {
+  override name = "InvalidRequestError";
+}
+
+/**
+ * An error that is raised when a HTTP request was aborted by the client error.
+ */
+export class RequestAbortedError extends HTTPClientError {
+  override readonly name = "RequestAbortedError";
+}
+
+/**
+ * An error that is raised when a HTTP request timed out due to an AbortSignal
+ * signal timeout.
+ */
+export class RequestTimeoutError extends HTTPClientError {
+  override readonly name = "RequestTimeoutError";
+}
+
+/**
+ * An error that is raised when a HTTP client is unable to make a request to
+ * a server.
+ */
+export class ConnectionError extends HTTPClientError {
+  override readonly name = "ConnectionError";
+}

package/src/models/errors/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./criblcontrolplanedefaulterror.js";
+export * from "./healthstatuserror.js";
+export * from "./httpclienterrors.js";
+export * from "./responsevalidationerror.js";
+export * from "./sdkvalidationerror.js";

package/src/models/errors/responsevalidationerror.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { CriblControlPlaneError } from "./criblcontrolplaneerror.js";
+import { formatZodError } from "./sdkvalidationerror.js";
+
+export class ResponseValidationError extends CriblControlPlaneError {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(
+    message: string,
+    extra: {
+      response: Response;
+      request: Request;
+      body: string;
+      cause: unknown;
+      rawValue: unknown;
+      rawMessage: unknown;
+    },
+  ) {
+    super(message, extra);
+    this.name = "ResponseValidationError";
+    this.cause = extra.cause;
+    this.rawValue = extra.rawValue;
+    this.rawMessage = extra.rawMessage;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}

package/src/models/errors/sdkvalidationerror.ts

@@ -0,0 +1,109 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export class SDKValidationError extends Error {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  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";
+    this.cause = cause;
+    this.rawValue = rawValue;
+    this.rawMessage = message;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}
+
+export function formatZodError(err: z.ZodError, level = 0): string {
+  let pre = "  ".repeat(level);
+  pre = level > 0 ? `│${pre}` : pre;
+  pre += " ".repeat(level);
+
+  let message = "";
+  const append = (str: string) => (message += `\n${pre}${str}`);
+
+  const len = err.issues.length;
+  const headline = len === 1 ? `${len} issue found` : `${len} issues found`;
+
+  if (len) {
+    append(`┌ ${headline}:`);
+  }
+
+  for (const issue of err.issues) {
+    let path = issue.path.join(".");
+    path = path ? `<root>.${path}` : "<root>";
+    append(`│ • [${path}]: ${issue.message} (${issue.code})`);
+    switch (issue.code) {
+      case "invalid_literal":
+      case "invalid_type": {
+        append(`│     Want: ${issue.expected}`);
+        append(`│      Got: ${issue.received}`);
+        break;
+      }
+      case "unrecognized_keys": {
+        append(`│     Keys: ${issue.keys.join(", ")}`);
+        break;
+      }
+      case "invalid_enum_value": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        append(`│         Got: ${issue.received}`);
+        break;
+      }
+      case "invalid_union_discriminator": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        break;
+      }
+      case "invalid_union": {
+        const len = issue.unionErrors.length;
+        append(
+          `│   ✖︎ Attemped to deserialize into one of ${len} union members:`,
+        );
+        issue.unionErrors.forEach((err, i) => {
+          append(`│   ✖︎ Member ${i + 1} of ${len}`);
+          append(`${formatZodError(err, level + 1)}`);
+        });
+      }
+    }
+  }
+
+  if (err.issues.length) {
+    append(`└─*`);
+  }
+
+  return message.slice(1);
+}

package/src/models/healthstatus.ts

@@ -0,0 +1,123 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export const Role = {
+  Primary: "primary",
+  Standby: "standby",
+} as const;
+export type Role = ClosedEnum<typeof Role>;
+
+export const Status = {
+  Healthy: "healthy",
+  ShuttingDown: "shutting down",
+  Standby: "standby",
+} as const;
+export type Status = ClosedEnum<typeof Status>;
+
+export type HealthStatus = {
+  role?: Role | undefined;
+  status: Status;
+  startTime: number;
+};
+
+/** @internal */
+export const Role$inboundSchema: z.ZodNativeEnum<typeof Role> = z.nativeEnum(
+  Role,
+);
+
+/** @internal */
+export const Role$outboundSchema: z.ZodNativeEnum<typeof Role> =
+  Role$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Role$ {
+  /** @deprecated use `Role$inboundSchema` instead. */
+  export const inboundSchema = Role$inboundSchema;
+  /** @deprecated use `Role$outboundSchema` instead. */
+  export const outboundSchema = Role$outboundSchema;
+}
+
+/** @internal */
+export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
+  .nativeEnum(Status);
+
+/** @internal */
+export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> =
+  Status$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Status$ {
+  /** @deprecated use `Status$inboundSchema` instead. */
+  export const inboundSchema = Status$inboundSchema;
+  /** @deprecated use `Status$outboundSchema` instead. */
+  export const outboundSchema = Status$outboundSchema;
+}
+
+/** @internal */
+export const HealthStatus$inboundSchema: z.ZodType<
+  HealthStatus,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  role: Role$inboundSchema.optional(),
+  status: Status$inboundSchema,
+  startTime: z.number(),
+});
+
+/** @internal */
+export type HealthStatus$Outbound = {
+  role?: string | undefined;
+  status: string;
+  startTime: number;
+};
+
+/** @internal */
+export const HealthStatus$outboundSchema: z.ZodType<
+  HealthStatus$Outbound,
+  z.ZodTypeDef,
+  HealthStatus
+> = z.object({
+  role: Role$outboundSchema.optional(),
+  status: Status$outboundSchema,
+  startTime: z.number(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace HealthStatus$ {
+  /** @deprecated use `HealthStatus$inboundSchema` instead. */
+  export const inboundSchema = HealthStatus$inboundSchema;
+  /** @deprecated use `HealthStatus$outboundSchema` instead. */
+  export const outboundSchema = HealthStatus$outboundSchema;
+  /** @deprecated use `HealthStatus$Outbound` instead. */
+  export type Outbound = HealthStatus$Outbound;
+}
+
+export function healthStatusToJSON(healthStatus: HealthStatus): string {
+  return JSON.stringify(HealthStatus$outboundSchema.parse(healthStatus));
+}
+
+export function healthStatusFromJSON(
+  jsonString: string,
+): SafeParseResult<HealthStatus, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HealthStatus$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HealthStatus' from JSON`,
+  );
+}

package/src/models/index.ts

@@ -0,0 +1,6 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./healthstatus.js";
+export * from "./security.js";

package/src/models/security.ts

@@ -0,0 +1,62 @@
+/*
+ * 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 Security = {
+  bearerAuth?: string | undefined;
+};
+
+/** @internal */
+export const Security$inboundSchema: z.ZodType<
+  Security,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bearerAuth: z.string().optional(),
+});
+
+/** @internal */
+export type Security$Outbound = {
+  bearerAuth?: string | undefined;
+};
+
+/** @internal */
+export const Security$outboundSchema: z.ZodType<
+  Security$Outbound,
+  z.ZodTypeDef,
+  Security
+> = z.object({
+  bearerAuth: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Security$ {
+  /** @deprecated use `Security$inboundSchema` instead. */
+  export const inboundSchema = Security$inboundSchema;
+  /** @deprecated use `Security$outboundSchema` instead. */
+  export const outboundSchema = Security$outboundSchema;
+  /** @deprecated use `Security$Outbound` instead. */
+  export type Outbound = Security$Outbound;
+}
+
+export function securityToJSON(security: Security): string {
+  return JSON.stringify(Security$outboundSchema.parse(security));
+}
+
+export function securityFromJSON(
+  jsonString: string,
+): SafeParseResult<Security, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Security$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Security' from JSON`,
+  );
+}

package/src/sdk/diag.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { diagGetHealthInfo } from "../funcs/diagGetHealthInfo.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Diag extends ClientSDK {
+  /**
+   * Provides health info for REST server
+   */
+  async getHealthInfo(
+    options?: RequestOptions,
+  ): Promise<models.HealthStatus> {
+    return unwrapAsync(diagGetHealthInfo(
+      this,
+      options,
+    ));
+  }
+}

package/src/sdk/health.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { diagGetHealthInfo } from "../funcs/diagGetHealthInfo.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Health extends ClientSDK {
+  /**
+   * Provides health info for REST server
+   */
+  async getHealthInfo(
+    options?: RequestOptions,
+  ): Promise<models.HealthStatus> {
+    return unwrapAsync(diagGetHealthInfo(
+      this,
+      options,
+    ));
+  }
+}

package/src/sdk/index.ts

@@ -0,0 +1,5 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./sdk.js";

package/src/sdk/sdk.ts

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "../lib/sdks.js";
+import { Diag } from "./diag.js";
+import { Health } from "./health.js";
+
+export class CriblControlPlane extends ClientSDK {
+  private _diag?: Diag;
+  get diag(): Diag {
+    return (this._diag ??= new Diag(this._options));
+  }
+
+  private _health?: Health;
+  get health(): Health {
+    return (this._health ??= new Health(this._options));
+  }
+}

package/src/types/async.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export type APICall =
+  | {
+      status: "complete";
+      request: Request;
+      response: Response;
+    }
+  | {
+      status: "request-error";
+      request: Request;
+      response?: undefined;
+    }
+  | {
+      status: "invalid";
+      request?: undefined;
+      response?: undefined;
+    };
+
+export class APIPromise<T> implements Promise<T> {
+  readonly #promise: Promise<[T, APICall]>;
+  readonly #unwrapped: Promise<T>;
+
+  readonly [Symbol.toStringTag] = "APIPromise";
+
+  constructor(p: [T, APICall] | Promise<[T, APICall]>) {
+    this.#promise = p instanceof Promise ? p : Promise.resolve(p);
+    this.#unwrapped =
+      p instanceof Promise
+        ? this.#promise.then(([value]) => value)
+        : Promise.resolve(p[0]);
+  }
+
+  then<TResult1 = T, TResult2 = never>(
+    onfulfilled?:
+      | ((value: T) => TResult1 | PromiseLike<TResult1>)
+      | null
+      | undefined,
+    onrejected?:
+      | ((reason: any) => TResult2 | PromiseLike<TResult2>)
+      | null
+      | undefined,
+  ): Promise<TResult1 | TResult2> {
+    return this.#promise.then(
+      onfulfilled ? ([value]) => onfulfilled(value) : void 0,
+      onrejected,
+    );
+  }
+
+  catch<TResult = never>(
+    onrejected?:
+      | ((reason: any) => TResult | PromiseLike<TResult>)
+      | null
+      | undefined,
+  ): Promise<T | TResult> {
+    return this.#unwrapped.catch(onrejected);
+  }
+
+  finally(onfinally?: (() => void) | null | undefined): Promise<T> {
+    return this.#unwrapped.finally(onfinally);
+  }
+
+  $inspect(): Promise<[T, APICall]> {
+    return this.#promise;
+  }
+}

package/src/types/blobs.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> =
+  z.custom<Blob>(isBlobLike, {
+    message: "expected a Blob, File or Blob-like object",
+    fatal: true,
+  });
+
+export function isBlobLike(val: unknown): val is Blob {
+  if (val instanceof Blob) {
+    return true;
+  }
+
+  if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) {
+    return false;
+  }
+
+  const name = val[Symbol.toStringTag];
+  if (typeof name !== "string") {
+    return false;
+  }
+  if (name !== "Blob" && name !== "File") {
+    return false;
+  }
+
+  return "stream" in val && typeof val.stream === "function";
+}