@orq-ai/node 4.15.0-rc.2 → 4.15.0-rc.21

package/src/lib/encodings.ts

@@ -12,10 +12,41 @@ export class EncodingError extends Error {
   }
 }
 
+export type CharEncoding = "percent" | "percentExceptReserved" | "none";
+
+const reservedEscapes = /%(2[346bcf]|3[abdf]|40|5[bd])/gi;
+
+function encodeKeyChars(
+  v: string,
+  charEncoding: CharEncoding | undefined,
+): string {
+  return encodeChars(
+    v,
+    charEncoding === "percentExceptReserved" ? "percent" : charEncoding,
+  );
+}
+
+function encodeChars(
+  v: string,
+  charEncoding: CharEncoding | undefined,
+): string {
+  switch (charEncoding) {
+    case "percent":
+      return encodeURIComponent(v);
+    case "percentExceptReserved":
+      return encodeURIComponent(v).replace(
+        reservedEscapes,
+        (m) => decodeURIComponent(m),
+      );
+    default:
+      return v;
+  }
+}
+
 export function encodeMatrix(
   key: string,
   value: unknown,
-  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+  options?: { explode?: boolean; charEncoding?: CharEncoding },
 ): string | undefined {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
@@ -27,7 +58,7 @@ export function encodeMatrix(
   }
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    return encodeChars(v, options?.charEncoding);
   };
   const encodeValue = (v: unknown) => encodeString(serializeValue(v));
 
@@ -52,7 +83,7 @@ export function encodeMatrix(
       return;
     }
 
-    const keyPrefix = encodeString(pk);
+    const keyPrefix = encodeKeyChars(pk, options?.charEncoding);
     tmp = `${keyPrefix}=${encValue}`;
     // trim trailing '=' if value was empty
     if (tmp === `${keyPrefix}=`) {
@@ -73,7 +104,7 @@ export function encodeMatrix(
 export function encodeLabel(
   key: string,
   value: unknown,
-  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+  options?: { explode?: boolean; charEncoding?: CharEncoding },
 ): string | undefined {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
@@ -85,7 +116,7 @@ export function encodeLabel(
   }
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    return encodeChars(v, options?.charEncoding);
   };
   const encodeValue = (v: unknown) => encodeString(serializeValue(v));
 
@@ -103,7 +134,7 @@ export function encodeLabel(
       encValue = mapped?.join("").slice(1);
     } else {
       const k = options?.explode && isPlainObject(value)
-        ? `${encodeString(pk)}=`
+        ? `${encodeKeyChars(pk, options?.charEncoding)}=`
         : "";
       encValue = `${k}${encodeValue(pv)}`;
     }
@@ -117,14 +148,14 @@ export function encodeLabel(
 type FormEncoder = (
   key: string,
   value: unknown,
-  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+  options?: { explode?: boolean; charEncoding?: CharEncoding },
 ) => string | undefined;
 
 function formEncoder(sep: string): FormEncoder {
   return (
     key: string,
     value: unknown,
-    options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+    options?: { explode?: boolean; charEncoding?: CharEncoding },
   ) => {
     let out = "";
     const pairs: [string, unknown][] = options?.explode
@@ -136,7 +167,7 @@ function formEncoder(sep: string): FormEncoder {
     }
 
     const encodeString = (v: string) => {
-      return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+      return encodeChars(v, options?.charEncoding);
     };
 
     const encodeValue = (v: unknown) => encodeString(serializeValue(v));
@@ -163,7 +194,7 @@ function formEncoder(sep: string): FormEncoder {
         return;
       }
 
-      tmp = `${encodeString(pk)}=${encValue}`;
+      tmp = `${encodeKeyChars(pk, options?.charEncoding)}=${encValue}`;
 
       // If we end up with the nothing then skip forward
       if (!tmp || tmp === "=") {
@@ -184,7 +215,7 @@ export const encodePipeDelimited = formEncoder("|");
 export function encodeBodyForm(
   key: string,
   value: unknown,
-  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+  options?: { explode?: boolean; charEncoding?: CharEncoding },
 ): string {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
@@ -192,7 +223,7 @@ export function encodeBodyForm(
     : [[key, value]];
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    return encodeChars(v, options?.charEncoding);
   };
 
   const encodeValue = (v: unknown) => encodeString(serializeValue(v));
@@ -211,7 +242,7 @@ export function encodeBodyForm(
       encValue = `${encodeValue(pv)}`;
     }
 
-    tmp = `${encodeString(pk)}=${encValue}`;
+    tmp = `${encodeKeyChars(pk, options?.charEncoding)}=${encValue}`;
 
     // If we end up with the nothing then skip forward
     if (!tmp || tmp === "=") {
@@ -227,7 +258,7 @@ export function encodeBodyForm(
 export function encodeDeepObject(
   key: string,
   value: unknown,
-  options?: { charEncoding?: "percent" | "none" },
+  options?: { charEncoding?: CharEncoding },
 ): string | undefined {
   if (value == null) {
     return;
@@ -245,7 +276,7 @@ export function encodeDeepObject(
 export function encodeDeepObjectObject(
   key: string,
   value: unknown,
-  options?: { charEncoding?: "percent" | "none" },
+  options?: { charEncoding?: CharEncoding },
 ): string | undefined {
   if (value == null) {
     return;
@@ -254,7 +285,7 @@ export function encodeDeepObjectObject(
   let out = "";
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    return encodeChars(v, options?.charEncoding);
   };
 
   if (!isPlainObject(value)) {
@@ -278,7 +309,9 @@ export function encodeDeepObjectObject(
 
     const pairs: unknown[] = Array.isArray(cv) ? cv : [cv];
     const encoded = mapDefined(pairs, (v) => {
-      return `${encodeString(pk)}=${encodeString(serializeValue(v))}`;
+      return `${encodeKeyChars(pk, options?.charEncoding)}=${
+        encodeString(serializeValue(v))
+      }`;
     })?.join("&");
 
     out += encoded == null ? "" : `&${encoded}`;
@@ -290,25 +323,27 @@ export function encodeDeepObjectObject(
 export function encodeJSON(
   key: string,
   value: unknown,
-  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+  options?: { explode?: boolean; charEncoding?: CharEncoding },
 ): string | undefined {
   if (typeof value === "undefined") {
     return;
   }
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    return encodeChars(v, options?.charEncoding);
   };
 
   const encVal = encodeString(JSON.stringify(value, jsonReplacer));
 
-  return options?.explode ? encVal : `${encodeString(key)}=${encVal}`;
+  return options?.explode
+    ? encVal
+    : `${encodeKeyChars(key, options?.charEncoding)}=${encVal}`;
 }
 
 export const encodeSimple = (
   key: string,
   value: unknown,
-  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+  options?: { explode?: boolean; charEncoding?: CharEncoding },
 ): string | undefined => {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
@@ -320,7 +355,7 @@ export const encodeSimple = (
   }
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    return encodeChars(v, options?.charEncoding);
   };
   const encodeValue = (v: unknown) => encodeString(serializeValue(v));
 
@@ -426,7 +461,7 @@ export function queryJoin(...args: (string | undefined)[]): string {
 
 type QueryEncoderOptions = {
   explode?: boolean;
-  charEncoding?: "percent" | "none";
+  charEncoding?: CharEncoding;
   allowEmptyValue?: string[];
 };
 

package/src/models/components/addannotationqueueitemsrequest.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  AnnotationQueueItemRef,
+  AnnotationQueueItemRef$Outbound,
+  AnnotationQueueItemRef$outboundSchema,
+} from "./annotationqueueitemref.js";
+
+export type AddAnnotationQueueItemsRequest = {
+  /**
+   * The spans to add to the annotation queue.
+   */
+  items: Array<AnnotationQueueItemRef>;
+};
+
+/** @internal */
+export type AddAnnotationQueueItemsRequest$Outbound = {
+  items: Array<AnnotationQueueItemRef$Outbound>;
+};
+
+/** @internal */
+export const AddAnnotationQueueItemsRequest$outboundSchema: z.ZodType<
+  AddAnnotationQueueItemsRequest$Outbound,
+  z.ZodTypeDef,
+  AddAnnotationQueueItemsRequest
+> = z.object({
+  items: z.array(AnnotationQueueItemRef$outboundSchema),
+});
+
+export function addAnnotationQueueItemsRequestToJSON(
+  addAnnotationQueueItemsRequest: AddAnnotationQueueItemsRequest,
+): string {
+  return JSON.stringify(
+    AddAnnotationQueueItemsRequest$outboundSchema.parse(
+      addAnnotationQueueItemsRequest,
+    ),
+  );
+}

package/src/models/components/addannotationqueueitemsresponse.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AnnotationQueueItem,
+  AnnotationQueueItem$inboundSchema,
+} from "./annotationqueueitem.js";
+
+export type AddAnnotationQueueItemsResponse = {
+  /**
+   * Items created by this call. Spans already present in the queue are omitted.
+   */
+  items: Array<AnnotationQueueItem>;
+};
+
+/** @internal */
+export const AddAnnotationQueueItemsResponse$inboundSchema: z.ZodType<
+  AddAnnotationQueueItemsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(AnnotationQueueItem$inboundSchema),
+});
+
+export function addAnnotationQueueItemsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AddAnnotationQueueItemsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AddAnnotationQueueItemsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AddAnnotationQueueItemsResponse' from JSON`,
+  );
+}

package/src/models/components/agentresponserequest.ts

@@ -29,29 +29,29 @@ import {
 /**
  * Message containing tool execution results
  */
-export const RoleToolMessage = {
+export const ToolMessage = {
   Tool: "tool",
 } as const;
 /**
  * Message containing tool execution results
  */
-export type RoleToolMessage = ClosedEnum<typeof RoleToolMessage>;
+export type ToolMessage = ClosedEnum<typeof ToolMessage>;
 
 /**
  * Message from the end user
  */
-export const RoleUserMessage = {
+export const UserMessage = {
   User: "user",
 } as const;
 /**
  * Message from the end user
  */
-export type RoleUserMessage = ClosedEnum<typeof RoleUserMessage>;
+export type UserMessage = ClosedEnum<typeof UserMessage>;
 
 /**
  * Message role (user or tool for continuing executions)
  */
-export type AgentResponseRequestRole = RoleUserMessage | RoleToolMessage;
+export type AgentResponseRequestRole = UserMessage | ToolMessage;
 
 /**
  * Message part that can be provided by users. Use "text" for regular messages, "file" for attachments, or "tool_result" when responding to tool call requests.
@@ -73,7 +73,7 @@ export type A2AMessage = {
   /**
    * Message role (user or tool for continuing executions)
    */
-  role: RoleUserMessage | RoleToolMessage;
+  role: UserMessage | ToolMessage;
   /**
    * A2A message parts (text, file, or tool_result only). Note: Tool role messages must only contain tool_result parts.
    */
@@ -145,7 +145,7 @@ export type Contact = {
 /**
  * Thread information to group related requests
  */
-export type AgentResponseRequestThread = {
+export type Thread = {
   /**
    * Unique thread identifier to group related invocations.
    */
@@ -182,7 +182,7 @@ export type Engine = ClosedEnum<typeof Engine>;
 /**
  * Configuration options for the agent invocation
  */
-export type Configuration = {
+export type AgentResponseRequestConfiguration = {
   /**
    * Whether to block until the agent task completes. When true, the response will include the full task with messages. When false (default), returns immediately with task ID and status.
    */
@@ -228,7 +228,7 @@ export type AgentResponseRequest = {
   /**
    * Thread information to group related requests
    */
-  thread?: AgentResponseRequestThread | undefined;
+  thread?: Thread | undefined;
   /**
    * Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions.
    */
@@ -244,7 +244,7 @@ export type AgentResponseRequest = {
   /**
    * Configuration options for the agent invocation
    */
-  configuration?: Configuration | undefined;
+  configuration?: AgentResponseRequestConfiguration | undefined;
   /**
    * If true, returns immediately without waiting for completion. If false (default), waits until the agent becomes inactive or errors.
    */
@@ -260,14 +260,12 @@ export type AgentResponseRequest = {
 };
 
 /** @internal */
-export const RoleToolMessage$outboundSchema: z.ZodNativeEnum<
-  typeof RoleToolMessage
-> = z.nativeEnum(RoleToolMessage);
+export const ToolMessage$outboundSchema: z.ZodNativeEnum<typeof ToolMessage> = z
+  .nativeEnum(ToolMessage);
 
 /** @internal */
-export const RoleUserMessage$outboundSchema: z.ZodNativeEnum<
-  typeof RoleUserMessage
-> = z.nativeEnum(RoleUserMessage);
+export const UserMessage$outboundSchema: z.ZodNativeEnum<typeof UserMessage> = z
+  .nativeEnum(UserMessage);
 
 /** @internal */
 export type AgentResponseRequestRole$Outbound = string | string;
@@ -277,7 +275,7 @@ export const AgentResponseRequestRole$outboundSchema: z.ZodType<
   AgentResponseRequestRole$Outbound,
   z.ZodTypeDef,
   AgentResponseRequestRole
-> = z.union([RoleUserMessage$outboundSchema, RoleToolMessage$outboundSchema]);
+> = z.union([UserMessage$outboundSchema, ToolMessage$outboundSchema]);
 
 export function agentResponseRequestRoleToJSON(
   agentResponseRequestRole: AgentResponseRequestRole,
@@ -333,10 +331,7 @@ export const A2AMessage$outboundSchema: z.ZodType<
   A2AMessage
 > = z.object({
   messageId: z.string().optional(),
-  role: z.union([
-    RoleUserMessage$outboundSchema,
-    RoleToolMessage$outboundSchema,
-  ]),
+  role: z.union([UserMessage$outboundSchema, ToolMessage$outboundSchema]),
   parts: z.array(
     z.union([
       TextPart$outboundSchema,
@@ -424,27 +419,23 @@ export function contactToJSON(contact: Contact): string {
 }
 
 /** @internal */
-export type AgentResponseRequestThread$Outbound = {
+export type Thread$Outbound = {
   id: string;
   tags?: Array<string> | undefined;
 };
 
 /** @internal */
-export const AgentResponseRequestThread$outboundSchema: z.ZodType<
-  AgentResponseRequestThread$Outbound,
+export const Thread$outboundSchema: z.ZodType<
+  Thread$Outbound,
   z.ZodTypeDef,
-  AgentResponseRequestThread
+  Thread
 > = z.object({
   id: z.string(),
   tags: z.array(z.string()).optional(),
 });
 
-export function agentResponseRequestThreadToJSON(
-  agentResponseRequestThread: AgentResponseRequestThread,
-): string {
-  return JSON.stringify(
-    AgentResponseRequestThread$outboundSchema.parse(agentResponseRequestThread),
-  );
+export function threadToJSON(thread: Thread): string {
+  return JSON.stringify(Thread$outboundSchema.parse(thread));
 }
 
 /** @internal */
@@ -478,21 +469,27 @@ export const Engine$outboundSchema: z.ZodNativeEnum<typeof Engine> = z
   .nativeEnum(Engine);
 
 /** @internal */
-export type Configuration$Outbound = {
+export type AgentResponseRequestConfiguration$Outbound = {
   blocking: boolean;
 };
 
 /** @internal */
-export const Configuration$outboundSchema: z.ZodType<
-  Configuration$Outbound,
+export const AgentResponseRequestConfiguration$outboundSchema: z.ZodType<
+  AgentResponseRequestConfiguration$Outbound,
   z.ZodTypeDef,
-  Configuration
+  AgentResponseRequestConfiguration
 > = z.object({
   blocking: z.boolean().default(false),
 });
 
-export function configurationToJSON(configuration: Configuration): string {
-  return JSON.stringify(Configuration$outboundSchema.parse(configuration));
+export function agentResponseRequestConfigurationToJSON(
+  agentResponseRequestConfiguration: AgentResponseRequestConfiguration,
+): string {
+  return JSON.stringify(
+    AgentResponseRequestConfiguration$outboundSchema.parse(
+      agentResponseRequestConfiguration,
+    ),
+  );
 }
 
 /** @internal */
@@ -524,11 +521,11 @@ export type AgentResponseRequest$Outbound = {
   variables?: { [k: string]: any } | undefined;
   identity?: AgentResponseRequestIdentity$Outbound | undefined;
   contact?: Contact$Outbound | undefined;
-  thread?: AgentResponseRequestThread$Outbound | undefined;
+  thread?: Thread$Outbound | undefined;
   memory?: AgentResponseRequestMemory$Outbound | undefined;
   metadata?: { [k: string]: any } | undefined;
   engine?: string | undefined;
-  configuration?: Configuration$Outbound | undefined;
+  configuration?: AgentResponseRequestConfiguration$Outbound | undefined;
   background: boolean;
   stream: boolean;
   conversation?: Conversation$Outbound | undefined;
@@ -546,11 +543,12 @@ export const AgentResponseRequest$outboundSchema: z.ZodType<
   identity: z.lazy(() => AgentResponseRequestIdentity$outboundSchema)
     .optional(),
   contact: z.lazy(() => Contact$outboundSchema).optional(),
-  thread: z.lazy(() => AgentResponseRequestThread$outboundSchema).optional(),
+  thread: z.lazy(() => Thread$outboundSchema).optional(),
   memory: z.lazy(() => AgentResponseRequestMemory$outboundSchema).optional(),
   metadata: z.record(z.any()).optional(),
   engine: Engine$outboundSchema.optional(),
-  configuration: z.lazy(() => Configuration$outboundSchema).optional(),
+  configuration: z.lazy(() => AgentResponseRequestConfiguration$outboundSchema)
+    .optional(),
   background: z.boolean().default(false),
   stream: z.boolean().default(false),
   conversation: z.lazy(() => Conversation$outboundSchema).optional(),