@orq-ai/node 4.5.0-rc.9 → 4.5.3

package/packages/orq-rc/src/lib/encodings.ts

@@ -0,0 +1,497 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { bytesToBase64 } from "./base64.js";
+import { isPlainObject } from "./is-plain-object.js";
+
+export class EncodingError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = "EncodingError";
+  }
+}
+
+export function encodeMatrix(
+  key: string,
+  value: unknown,
+  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+): string | undefined {
+  let out = "";
+  const pairs: [string, unknown][] = options?.explode
+    ? explode(key, value)
+    : [[key, value]];
+
+  if (pairs.every(([_, v]) => v == null)) {
+    return;
+  }
+
+  const encodeString = (v: string) => {
+    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+  };
+  const encodeValue = (v: unknown) => encodeString(serializeValue(v));
+
+  pairs.forEach(([pk, pv]) => {
+    let tmp = "";
+    let encValue: string | null | undefined = null;
+
+    if (pv == null) {
+      return;
+    } else if (Array.isArray(pv)) {
+      encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(",");
+    } else if (isPlainObject(pv)) {
+      const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+        return `,${encodeString(k)},${encodeValue(v)}`;
+      });
+      encValue = mapped?.join("").slice(1);
+    } else {
+      encValue = `${encodeValue(pv)}`;
+    }
+
+    if (encValue == null) {
+      return;
+    }
+
+    const keyPrefix = encodeString(pk);
+    tmp = `${keyPrefix}=${encValue}`;
+    // trim trailing '=' if value was empty
+    if (tmp === `${keyPrefix}=`) {
+      tmp = tmp.slice(0, -1);
+    }
+
+    // If we end up with the nothing then skip forward
+    if (!tmp) {
+      return;
+    }
+
+    out += `;${tmp}`;
+  });
+
+  return out;
+}
+
+export function encodeLabel(
+  key: string,
+  value: unknown,
+  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+): string | undefined {
+  let out = "";
+  const pairs: [string, unknown][] = options?.explode
+    ? explode(key, value)
+    : [[key, value]];
+
+  if (pairs.every(([_, v]) => v == null)) {
+    return;
+  }
+
+  const encodeString = (v: string) => {
+    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+  };
+  const encodeValue = (v: unknown) => encodeString(serializeValue(v));
+
+  pairs.forEach(([pk, pv]) => {
+    let encValue: string | null | undefined = "";
+
+    if (pv == null) {
+      return;
+    } else if (Array.isArray(pv)) {
+      encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(".");
+    } else if (isPlainObject(pv)) {
+      const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+        return `.${encodeString(k)}.${encodeValue(v)}`;
+      });
+      encValue = mapped?.join("").slice(1);
+    } else {
+      const k = options?.explode && isPlainObject(value)
+        ? `${encodeString(pk)}=`
+        : "";
+      encValue = `${k}${encodeValue(pv)}`;
+    }
+
+    out += encValue == null ? "" : `.${encValue}`;
+  });
+
+  return out;
+}
+
+type FormEncoder = (
+  key: string,
+  value: unknown,
+  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+) => string | undefined;
+
+function formEncoder(sep: string): FormEncoder {
+  return (
+    key: string,
+    value: unknown,
+    options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+  ) => {
+    let out = "";
+    const pairs: [string, unknown][] = options?.explode
+      ? explode(key, value)
+      : [[key, value]];
+
+    if (pairs.every(([_, v]) => v == null)) {
+      return;
+    }
+
+    const encodeString = (v: string) => {
+      return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    };
+
+    const encodeValue = (v: unknown) => encodeString(serializeValue(v));
+
+    const encodedSep = encodeString(sep);
+
+    pairs.forEach(([pk, pv]) => {
+      let tmp = "";
+      let encValue: string | null | undefined = null;
+
+      if (pv == null) {
+        return;
+      } else if (Array.isArray(pv)) {
+        encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(encodedSep);
+      } else if (isPlainObject(pv)) {
+        encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+          return `${encodeString(k)}${encodedSep}${encodeValue(v)}`;
+        })?.join(encodedSep);
+      } else {
+        encValue = `${encodeValue(pv)}`;
+      }
+
+      if (encValue == null) {
+        return;
+      }
+
+      tmp = `${encodeString(pk)}=${encValue}`;
+
+      // If we end up with the nothing then skip forward
+      if (!tmp || tmp === "=") {
+        return;
+      }
+
+      out += `&${tmp}`;
+    });
+
+    return out.slice(1);
+  };
+}
+
+export const encodeForm = formEncoder(",");
+export const encodeSpaceDelimited = formEncoder(" ");
+export const encodePipeDelimited = formEncoder("|");
+
+export function encodeBodyForm(
+  key: string,
+  value: unknown,
+  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+): string {
+  let out = "";
+  const pairs: [string, unknown][] = options?.explode
+    ? explode(key, value)
+    : [[key, value]];
+
+  const encodeString = (v: string) => {
+    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+  };
+
+  const encodeValue = (v: unknown) => encodeString(serializeValue(v));
+
+  pairs.forEach(([pk, pv]) => {
+    let tmp = "";
+    let encValue = "";
+
+    if (pv == null) {
+      return;
+    } else if (Array.isArray(pv)) {
+      encValue = JSON.stringify(pv, jsonReplacer);
+    } else if (isPlainObject(pv)) {
+      encValue = JSON.stringify(pv, jsonReplacer);
+    } else {
+      encValue = `${encodeValue(pv)}`;
+    }
+
+    tmp = `${encodeString(pk)}=${encValue}`;
+
+    // If we end up with the nothing then skip forward
+    if (!tmp || tmp === "=") {
+      return;
+    }
+
+    out += `&${tmp}`;
+  });
+
+  return out.slice(1);
+}
+
+export function encodeDeepObject(
+  key: string,
+  value: unknown,
+  options?: { charEncoding?: "percent" | "none" },
+): string | undefined {
+  if (value == null) {
+    return;
+  }
+
+  if (!isPlainObject(value)) {
+    throw new EncodingError(
+      `Value of parameter '${key}' which uses deepObject encoding must be an object or null`,
+    );
+  }
+
+  return encodeDeepObjectObject(key, value, options);
+}
+
+export function encodeDeepObjectObject(
+  key: string,
+  value: unknown,
+  options?: { charEncoding?: "percent" | "none" },
+): string | undefined {
+  if (value == null) {
+    return;
+  }
+
+  let out = "";
+
+  const encodeString = (v: string) => {
+    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+  };
+
+  if (!isPlainObject(value)) {
+    throw new EncodingError(`Expected parameter '${key}' to be an object.`);
+  }
+
+  Object.entries(value).forEach(([ck, cv]) => {
+    if (cv == null) {
+      return;
+    }
+
+    const pk = `${key}[${ck}]`;
+
+    if (isPlainObject(cv)) {
+      const objOut = encodeDeepObjectObject(pk, cv, options);
+
+      out += objOut == null ? "" : `&${objOut}`;
+
+      return;
+    }
+
+    const pairs: unknown[] = Array.isArray(cv) ? cv : [cv];
+    const encoded = mapDefined(pairs, (v) => {
+      return `${encodeString(pk)}=${encodeString(serializeValue(v))}`;
+    })?.join("&");
+
+    out += encoded == null ? "" : `&${encoded}`;
+  });
+
+  return out.slice(1);
+}
+
+export function encodeJSON(
+  key: string,
+  value: unknown,
+  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+): string | undefined {
+  if (typeof value === "undefined") {
+    return;
+  }
+
+  const encodeString = (v: string) => {
+    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+  };
+
+  const encVal = encodeString(JSON.stringify(value, jsonReplacer));
+
+  return options?.explode ? encVal : `${encodeString(key)}=${encVal}`;
+}
+
+export const encodeSimple = (
+  key: string,
+  value: unknown,
+  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+): string | undefined => {
+  let out = "";
+  const pairs: [string, unknown][] = options?.explode
+    ? explode(key, value)
+    : [[key, value]];
+
+  if (pairs.every(([_, v]) => v == null)) {
+    return;
+  }
+
+  const encodeString = (v: string) => {
+    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+  };
+  const encodeValue = (v: unknown) => encodeString(serializeValue(v));
+
+  pairs.forEach(([pk, pv]) => {
+    let tmp: string | null | undefined = "";
+
+    if (pv == null) {
+      return;
+    } else if (Array.isArray(pv)) {
+      tmp = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(",");
+    } else if (isPlainObject(pv)) {
+      const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+        return `,${encodeString(k)},${encodeValue(v)}`;
+      });
+      tmp = mapped?.join("").slice(1);
+    } else {
+      const k = options?.explode && isPlainObject(value) ? `${pk}=` : "";
+      tmp = `${k}${encodeValue(pv)}`;
+    }
+
+    out += tmp ? `,${tmp}` : "";
+  });
+
+  return out.slice(1);
+};
+
+function explode(key: string, value: unknown): [string, unknown][] {
+  if (Array.isArray(value)) {
+    return value.map((v) => [key, v]);
+  } else if (isPlainObject(value)) {
+    const o = value ?? {};
+    return Object.entries(o).map(([k, v]) => [k, v]);
+  } else {
+    return [[key, value]];
+  }
+}
+
+function serializeValue(value: unknown): string {
+  if (value == null) {
+    return "";
+  } else if (value instanceof Date) {
+    return value.toISOString();
+  } else if (value instanceof Uint8Array) {
+    return bytesToBase64(value);
+  } else if (typeof value === "object") {
+    return JSON.stringify(value, jsonReplacer);
+  }
+
+  return `${value}`;
+}
+
+function jsonReplacer(_: string, value: unknown): unknown {
+  if (value instanceof Uint8Array) {
+    return bytesToBase64(value);
+  } else {
+    return value;
+  }
+}
+
+function mapDefined<T, R>(inp: T[], mapper: (v: T) => R): R[] | null {
+  const res = inp.reduce<R[]>((acc, v) => {
+    if (v == null) {
+      return acc;
+    }
+
+    const m = mapper(v);
+    if (m == null) {
+      return acc;
+    }
+
+    acc.push(m);
+
+    return acc;
+  }, []);
+
+  return res.length ? res : null;
+}
+
+function mapDefinedEntries<K, V, R>(
+  inp: Iterable<[K, V]>,
+  mapper: (v: [K, V]) => R,
+): R[] | null {
+  const acc: R[] = [];
+  for (const [k, v] of inp) {
+    if (v == null) {
+      continue;
+    }
+
+    const m = mapper([k, v]);
+    if (m == null) {
+      continue;
+    }
+
+    acc.push(m);
+  }
+
+  return acc.length ? acc : null;
+}
+
+export function queryJoin(...args: (string | undefined)[]): string {
+  return args.filter(Boolean).join("&");
+}
+
+type QueryEncoderOptions = {
+  explode?: boolean;
+  charEncoding?: "percent" | "none";
+  allowEmptyValue?: string[];
+};
+
+type QueryEncoder = (
+  key: string,
+  value: unknown,
+  options?: QueryEncoderOptions,
+) => string | undefined;
+
+type BulkQueryEncoder = (
+  values: Record<string, unknown>,
+  options?: QueryEncoderOptions,
+) => string;
+
+export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
+  const bulkEncode = function(
+    values: Record<string, unknown>,
+    options?: QueryEncoderOptions,
+  ): string {
+    const opts: QueryEncoderOptions = {
+      ...options,
+      explode: options?.explode ?? true,
+      charEncoding: options?.charEncoding ?? "percent",
+    };
+
+    const allowEmptySet = new Set(options?.allowEmptyValue ?? []);
+
+    const encoded = Object.entries(values).map(([key, value]) => {
+      if (allowEmptySet.has(key)) {
+        if (
+          value === undefined
+          || value === null
+          || value === ""
+          || (Array.isArray(value) && value.length === 0)
+        ) {
+          return `${encodeURIComponent(key)}=`;
+        }
+      }
+      return f(key, value, opts);
+    });
+    return queryJoin(...encoded);
+  };
+
+  return bulkEncode;
+}
+
+export const encodeJSONQuery = queryEncoder(encodeJSON);
+export const encodeFormQuery = queryEncoder(encodeForm);
+export const encodeSpaceDelimitedQuery = queryEncoder(encodeSpaceDelimited);
+export const encodePipeDelimitedQuery = queryEncoder(encodePipeDelimited);
+export const encodeDeepObjectQuery = queryEncoder(encodeDeepObject);
+
+export function appendForm(
+  fd: FormData,
+  key: string,
+  value: unknown,
+  fileName?: string,
+): void {
+  if (value == null) {
+    return;
+  } else if (value instanceof Blob && fileName) {
+    fd.append(key, value, fileName);
+  } else if (value instanceof Blob) {
+    fd.append(key, value);
+  } else {
+    fd.append(key, String(value));
+  }
+}

package/packages/orq-rc/src/lib/env.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { SDKOptions } from "./config.js";
+import { dlv } from "./dlv.js";
+
+export interface Env {
+  ORQ_API_KEY?: string | undefined;
+
+  /**
+   * Sets the contactId parameter for all supported operations
+   */
+  ORQ_CONTACT_ID?: string | undefined;
+
+  /**
+   * Sets the environment parameter for all supported operations
+   */
+  ORQ_ENVIRONMENT?: string | undefined;
+
+  ORQ_DEBUG?: boolean | undefined;
+}
+
+export const envSchema: z.ZodType<Env, z.ZodTypeDef, unknown> = z.object({
+  ORQ_API_KEY: z.string().optional(),
+
+  ORQ_CONTACT_ID: z.string().optional(),
+  ORQ_ENVIRONMENT: z.string().optional(),
+
+  ORQ_DEBUG: z.coerce.boolean().optional(),
+});
+
+/**
+ * Checks for the existence of the Deno global object to determine the environment.
+ * @returns {boolean} True if the runtime is Deno, false otherwise.
+ */
+function isDeno() {
+  if ("Deno" in globalThis) {
+    return true;
+  }
+
+  return false;
+}
+
+let envMemo: Env | undefined = undefined;
+/**
+ * Reads and validates environment variables.
+ */
+export function env(): Env {
+  if (envMemo) {
+    return envMemo;
+  }
+
+  let envObject: Record<string, unknown> = {};
+  if (isDeno()) {
+    envObject = (globalThis as any).Deno?.env?.toObject?.() ?? {};
+  } else {
+    envObject = dlv(globalThis, "process.env") ?? {};
+  }
+
+  envMemo = envSchema.parse(envObject);
+  return envMemo;
+}
+
+/**
+ * Clears the cached env object. Useful for testing with a fresh environment.
+ */
+export function resetEnv() {
+  envMemo = undefined;
+}
+
+/**
+ * Populates global parameters with environment variables.
+ */
+export function fillGlobals(options: SDKOptions): SDKOptions {
+  const clone = { ...options };
+
+  const envVars = env();
+
+  if (typeof envVars.ORQ_CONTACT_ID !== "undefined") {
+    clone.contactId ??= envVars.ORQ_CONTACT_ID;
+  }
+  if (typeof envVars.ORQ_ENVIRONMENT !== "undefined") {
+    clone.environment ??= envVars.ORQ_ENVIRONMENT;
+  }
+
+  return clone;
+}