@redis-iris/agent-playbook 0.0.0-stage → 0.1.0-alpha.3

package/src/models/errors/response-validation-error.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: fa710486d48b
+ */
+
+import * as z from "zod/v3";
+import { PlaybookError } from "./playbook-error.js";
+import { formatZodError } from "./sdk-validation-error.js";
+
+export class ResponseValidationError extends PlaybookError {
+  /**
+   * 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/sdk-validation-error.ts

@@ -0,0 +1,110 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3a56c5bc0665
+ */
+
+import * as z from "zod/v3";
+
+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/errors/timeout-error-response-content.ts

@@ -0,0 +1,114 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f80e5e2511b9
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+import { PlaybookError } from "./playbook-error.js";
+
+/**
+ * The request timed out before the service could complete it.
+ */
+export type TimeoutErrorResponseContentData = {
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * Problem type URI for timeout errors.
+   */
+  type: models.TimeoutErrorType;
+};
+
+/**
+ * The request timed out before the service could complete it.
+ */
+export class TimeoutErrorResponseContent extends PlaybookError {
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * Problem type URI for timeout errors.
+   */
+  type: models.TimeoutErrorType;
+
+  /** The original data that was passed to this error instance. */
+  data$: TimeoutErrorResponseContentData;
+
+  constructor(
+    err: TimeoutErrorResponseContentData,
+    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;
+    this.title = err.title;
+    if (err.status != null) this.status = err.status;
+    if (err.detail != null) this.detail = err.detail;
+    if (err.instance != null) this.instance = err.instance;
+    this.type = err.type;
+
+    this.name = "TimeoutErrorResponseContent";
+  }
+}
+
+/** @internal */
+export const TimeoutErrorResponseContent$inboundSchema: z.ZodType<
+  TimeoutErrorResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  status: z.number().int().default(408),
+  detail: z.string().optional(),
+  instance: z.string().optional(),
+  type: models.TimeoutErrorType$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new TimeoutErrorResponseContent(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/models/errors/too-many-requests-error-response-content.ts

@@ -0,0 +1,114 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 997add020a78
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+import { PlaybookError } from "./playbook-error.js";
+
+/**
+ * The service rejected the request because rate limits were exceeded.
+ */
+export type TooManyRequestsErrorResponseContentData = {
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * Problem type URI for rate-limit errors.
+   */
+  type: models.TooManyRequestsErrorType;
+};
+
+/**
+ * The service rejected the request because rate limits were exceeded.
+ */
+export class TooManyRequestsErrorResponseContent extends PlaybookError {
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * Problem type URI for rate-limit errors.
+   */
+  type: models.TooManyRequestsErrorType;
+
+  /** The original data that was passed to this error instance. */
+  data$: TooManyRequestsErrorResponseContentData;
+
+  constructor(
+    err: TooManyRequestsErrorResponseContentData,
+    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;
+    this.title = err.title;
+    if (err.status != null) this.status = err.status;
+    if (err.detail != null) this.detail = err.detail;
+    if (err.instance != null) this.instance = err.instance;
+    this.type = err.type;
+
+    this.name = "TooManyRequestsErrorResponseContent";
+  }
+}
+
+/** @internal */
+export const TooManyRequestsErrorResponseContent$inboundSchema: z.ZodType<
+  TooManyRequestsErrorResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  status: z.number().int().default(429),
+  detail: z.string().optional(),
+  instance: z.string().optional(),
+  type: models.TooManyRequestsErrorType$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new TooManyRequestsErrorResponseContent(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/models/evidence-producer.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 21ae410e7f56
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+/**
+ * Caller-declared producing component, prompt, and source-code build revision.
+ *
+ * @remarks
+ * These fields describe the original observation and are not authenticated attribution.
+ */
+export type EvidenceProducer = {
+  name: string;
+  promptVersion?: string | undefined;
+  commitSHA?: string | undefined;
+};
+
+/** @internal */
+export const EvidenceProducer$inboundSchema: z.ZodType<
+  EvidenceProducer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  promptVersion: z.string().optional(),
+  commitSHA: z.string().optional(),
+});
+/** @internal */
+export type EvidenceProducer$Outbound = {
+  name: string;
+  promptVersion?: string | undefined;
+  commitSHA?: string | undefined;
+};
+
+/** @internal */
+export const EvidenceProducer$outboundSchema: z.ZodType<
+  EvidenceProducer$Outbound,
+  z.ZodTypeDef,
+  EvidenceProducer
+> = z.object({
+  name: z.string(),
+  promptVersion: z.string().optional(),
+  commitSHA: z.string().optional(),
+});
+
+export function evidenceProducerToJSON(
+  evidenceProducer: EvidenceProducer,
+): string {
+  return JSON.stringify(
+    EvidenceProducer$outboundSchema.parse(evidenceProducer),
+  );
+}
+export function evidenceProducerFromJSON(
+  jsonString: string,
+): SafeParseResult<EvidenceProducer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvidenceProducer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvidenceProducer' from JSON`,
+  );
+}

package/src/models/failed-dependency-error-type.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 6b3e9eaeec53
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+/**
+ * Problem type URI for failed-dependency errors.
+ */
+export const FailedDependencyErrorType = {
+  RootErrorsResourceUnavailable: "/errors/resource-unavailable",
+  RootErrorsDatabaseOutOfMemory: "/errors/database-out-of-memory",
+} as const;
+/**
+ * Problem type URI for failed-dependency errors.
+ */
+export type FailedDependencyErrorType = OpenEnum<
+  typeof FailedDependencyErrorType
+>;
+
+/** @internal */
+export const FailedDependencyErrorType$inboundSchema: z.ZodType<
+  FailedDependencyErrorType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FailedDependencyErrorType);

package/src/models/faq-authored-content.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: cef7c1b7f395
+ */
+
+import * as z from "zod/v3";
+import {
+  FaqPayload,
+  FaqPayload$Outbound,
+  FaqPayload$outboundSchema,
+} from "./faq-payload.js";
+
+/**
+ * Author-provided context shared by FAQ, Skill and proposal authoring.
+ */
+export type FaqAuthoredContent = {
+  intents?: Array<string> | undefined;
+  /**
+   * Exact-match attributes. Values are typed scalars or nonempty lists of typed scalars.
+   */
+  attributes?: { [k: string]: any } | undefined;
+  /**
+   * Author-provided JSON metadata. Its normalized JSON encoding must not exceed 65,536 bytes or nesting depth 16; deployments may enforce lower limits. Exceeding the byte limit returns payload-too-large, while excessive nesting returns invalid-data.
+   */
+  metadata?: any | undefined;
+  /**
+   * FAQ writes accept only a FAQ payload; complete Skill payloads are archive-derived.
+   */
+  payload: FaqPayload;
+};
+
+/** @internal */
+export type FaqAuthoredContent$Outbound = {
+  intents?: Array<string> | undefined;
+  attributes?: { [k: string]: any } | undefined;
+  metadata?: any | undefined;
+  payload: FaqPayload$Outbound;
+};
+
+/** @internal */
+export const FaqAuthoredContent$outboundSchema: z.ZodType<
+  FaqAuthoredContent$Outbound,
+  z.ZodTypeDef,
+  FaqAuthoredContent
+> = z.object({
+  intents: z.array(z.string()).optional(),
+  attributes: z.record(z.any()).optional(),
+  metadata: z.any().optional(),
+  payload: FaqPayload$outboundSchema,
+});
+
+export function faqAuthoredContentToJSON(
+  faqAuthoredContent: FaqAuthoredContent,
+): string {
+  return JSON.stringify(
+    FaqAuthoredContent$outboundSchema.parse(faqAuthoredContent),
+  );
+}

package/src/models/faq-candidate-preview.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4fcafd9d8064
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export type FaqCandidatePreview = {
+  question: string;
+};
+
+/** @internal */
+export const FaqCandidatePreview$inboundSchema: z.ZodType<
+  FaqCandidatePreview,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  question: z.string(),
+});
+
+export function faqCandidatePreviewFromJSON(
+  jsonString: string,
+): SafeParseResult<FaqCandidatePreview, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FaqCandidatePreview$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FaqCandidatePreview' from JSON`,
+  );
+}

package/src/models/faq-content.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 84cba76539a4
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export type FaqContent = {
+  question: string;
+  answer: string;
+};
+
+/** @internal */
+export const FaqContent$inboundSchema: z.ZodType<
+  FaqContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  question: z.string(),
+  answer: z.string(),
+});
+/** @internal */
+export type FaqContent$Outbound = {
+  question: string;
+  answer: string;
+};
+
+/** @internal */
+export const FaqContent$outboundSchema: z.ZodType<
+  FaqContent$Outbound,
+  z.ZodTypeDef,
+  FaqContent
+> = z.object({
+  question: z.string(),
+  answer: z.string(),
+});
+
+export function faqContentToJSON(faqContent: FaqContent): string {
+  return JSON.stringify(FaqContent$outboundSchema.parse(faqContent));
+}
+export function faqContentFromJSON(
+  jsonString: string,
+): SafeParseResult<FaqContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FaqContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FaqContent' from JSON`,
+  );
+}

package/src/models/faq-payload.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a98b8ac2816f
+ */
+
+import * as z from "zod/v3";
+import {
+  FaqContent,
+  FaqContent$Outbound,
+  FaqContent$outboundSchema,
+} from "./faq-content.js";
+
+export type FaqPayloadFaq = {
+  faq: FaqContent;
+};
+
+/**
+ * FAQ writes accept only a FAQ payload; complete Skill payloads are archive-derived.
+ */
+export type FaqPayload = FaqPayloadFaq;
+
+/** @internal */
+export type FaqPayloadFaq$Outbound = {
+  faq: FaqContent$Outbound;
+};
+
+/** @internal */
+export const FaqPayloadFaq$outboundSchema: z.ZodType<
+  FaqPayloadFaq$Outbound,
+  z.ZodTypeDef,
+  FaqPayloadFaq
+> = z.object({
+  faq: FaqContent$outboundSchema,
+});
+
+export function faqPayloadFaqToJSON(faqPayloadFaq: FaqPayloadFaq): string {
+  return JSON.stringify(FaqPayloadFaq$outboundSchema.parse(faqPayloadFaq));
+}
+
+/** @internal */
+export type FaqPayload$Outbound = FaqPayloadFaq$Outbound;
+
+/** @internal */
+export const FaqPayload$outboundSchema: z.ZodType<
+  FaqPayload$Outbound,
+  z.ZodTypeDef,
+  FaqPayload
+> = z.lazy(() => FaqPayloadFaq$outboundSchema);
+
+export function faqPayloadToJSON(faqPayload: FaqPayload): string {
+  return JSON.stringify(FaqPayload$outboundSchema.parse(faqPayload));
+}