@alienplatform/platform-api 1.0.68 → 1.3.4

package/src/lib/encodings.ts

@@ -2,13 +2,13 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { bytesToBase64 } from "./base64.js"
-import { isPlainObject } from "./is-plain-object.js"
+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"
+    super(message);
+    this.name = "EncodingError";
   }
 }
 
@@ -17,55 +17,57 @@ export function encodeMatrix(
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
 ): string | undefined {
-  let out = ""
-  const pairs: [string, unknown][] = options?.explode ? explode(key, value) : [[key, value]]
+  let out = "";
+  const pairs: [string, unknown][] = options?.explode
+    ? explode(key, value)
+    : [[key, value]];
 
   if (pairs.every(([_, v]) => v == null)) {
-    return
+    return;
   }
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v
-  }
-  const encodeValue = (v: unknown) => encodeString(serializeValue(v))
+    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
+    let tmp = "";
+    let encValue: string | null | undefined = null;
 
     if (pv == null) {
-      return
+      return;
     } else if (Array.isArray(pv)) {
-      encValue = mapDefined(pv, v => `${encodeValue(v)}`)?.join(",")
+      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)
+        return `,${encodeString(k)},${encodeValue(v)}`;
+      });
+      encValue = mapped?.join("").slice(1);
     } else {
-      encValue = `${encodeValue(pv)}`
+      encValue = `${encodeValue(pv)}`;
     }
 
     if (encValue == null) {
-      return
+      return;
     }
 
-    const keyPrefix = encodeString(pk)
-    tmp = `${keyPrefix}=${encValue}`
+    const keyPrefix = encodeString(pk);
+    tmp = `${keyPrefix}=${encValue}`;
     // trim trailing '=' if value was empty
     if (tmp === `${keyPrefix}=`) {
-      tmp = tmp.slice(0, -1)
+      tmp = tmp.slice(0, -1);
     }
 
     // If we end up with the nothing then skip forward
     if (!tmp) {
-      return
+      return;
     }
 
-    out += `;${tmp}`
-  })
+    out += `;${tmp}`;
+  });
 
-  return out
+  return out;
 }
 
 export function encodeLabel(
@@ -73,46 +75,50 @@ export function encodeLabel(
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
 ): string | undefined {
-  let out = ""
-  const pairs: [string, unknown][] = options?.explode ? explode(key, value) : [[key, value]]
+  let out = "";
+  const pairs: [string, unknown][] = options?.explode
+    ? explode(key, value)
+    : [[key, value]];
 
   if (pairs.every(([_, v]) => v == null)) {
-    return
+    return;
   }
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v
-  }
-  const encodeValue = (v: unknown) => encodeString(serializeValue(v))
+    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+  };
+  const encodeValue = (v: unknown) => encodeString(serializeValue(v));
 
   pairs.forEach(([pk, pv]) => {
-    let encValue: string | null | undefined = ""
+    let encValue: string | null | undefined = "";
 
     if (pv == null) {
-      return
+      return;
     } else if (Array.isArray(pv)) {
-      encValue = mapDefined(pv, v => `${encodeValue(v)}`)?.join(".")
+      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)
+        return `.${encodeString(k)}.${encodeValue(v)}`;
+      });
+      encValue = mapped?.join("").slice(1);
     } else {
-      const k = options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : ""
-      encValue = `${k}${encodeValue(pv)}`
+      const k = options?.explode && isPlainObject(value)
+        ? `${encodeString(pk)}=`
+        : "";
+      encValue = `${k}${encodeValue(pv)}`;
     }
 
-    out += encValue == null ? "" : `.${encValue}`
-  })
+    out += encValue == null ? "" : `.${encValue}`;
+  });
 
-  return out
+  return out;
 }
 
 type FormEncoder = (
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-) => string | undefined
+) => string | undefined;
 
 function formEncoder(sep: string): FormEncoder {
   return (
@@ -120,98 +126,102 @@ function formEncoder(sep: string): FormEncoder {
     value: unknown,
     options?: { explode?: boolean; charEncoding?: "percent" | "none" },
   ) => {
-    let out = ""
-    const pairs: [string, unknown][] = options?.explode ? explode(key, value) : [[key, value]]
+    let out = "";
+    const pairs: [string, unknown][] = options?.explode
+      ? explode(key, value)
+      : [[key, value]];
 
     if (pairs.every(([_, v]) => v == null)) {
-      return
+      return;
     }
 
     const encodeString = (v: string) => {
-      return options?.charEncoding === "percent" ? encodeURIComponent(v) : v
-    }
+      return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    };
 
-    const encodeValue = (v: unknown) => encodeString(serializeValue(v))
+    const encodeValue = (v: unknown) => encodeString(serializeValue(v));
 
-    const encodedSep = encodeString(sep)
+    const encodedSep = encodeString(sep);
 
     pairs.forEach(([pk, pv]) => {
-      let tmp = ""
-      let encValue: string | null | undefined = null
+      let tmp = "";
+      let encValue: string | null | undefined = null;
 
       if (pv == null) {
-        return
+        return;
       } else if (Array.isArray(pv)) {
-        encValue = mapDefined(pv, v => `${encodeValue(v)}`)?.join(encodedSep)
+        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)
+          return `${encodeString(k)}${encodedSep}${encodeValue(v)}`;
+        })?.join(encodedSep);
       } else {
-        encValue = `${encodeValue(pv)}`
+        encValue = `${encodeValue(pv)}`;
       }
 
       if (encValue == null) {
-        return
+        return;
       }
 
-      tmp = `${encodeString(pk)}=${encValue}`
+      tmp = `${encodeString(pk)}=${encValue}`;
 
       // If we end up with the nothing then skip forward
       if (!tmp || tmp === "=") {
-        return
+        return;
       }
 
-      out += `&${tmp}`
-    })
+      out += `&${tmp}`;
+    });
 
-    return out.slice(1)
-  }
+    return out.slice(1);
+  };
 }
 
-export const encodeForm = formEncoder(",")
-export const encodeSpaceDelimited = formEncoder(" ")
-export const encodePipeDelimited = formEncoder("|")
+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]]
+  let out = "";
+  const pairs: [string, unknown][] = options?.explode
+    ? explode(key, value)
+    : [[key, value]];
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v
-  }
+    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+  };
 
-  const encodeValue = (v: unknown) => encodeString(serializeValue(v))
+  const encodeValue = (v: unknown) => encodeString(serializeValue(v));
 
   pairs.forEach(([pk, pv]) => {
-    let tmp = ""
-    let encValue = ""
+    let tmp = "";
+    let encValue = "";
 
     if (pv == null) {
-      return
+      return;
     } else if (Array.isArray(pv)) {
-      encValue = JSON.stringify(pv, jsonReplacer)
+      encValue = JSON.stringify(pv, jsonReplacer);
     } else if (isPlainObject(pv)) {
-      encValue = JSON.stringify(pv, jsonReplacer)
+      encValue = JSON.stringify(pv, jsonReplacer);
     } else {
-      encValue = `${encodeValue(pv)}`
+      encValue = `${encodeValue(pv)}`;
     }
 
-    tmp = `${encodeString(pk)}=${encValue}`
+    tmp = `${encodeString(pk)}=${encValue}`;
 
     // If we end up with the nothing then skip forward
     if (!tmp || tmp === "=") {
-      return
+      return;
     }
 
-    out += `&${tmp}`
-  })
+    out += `&${tmp}`;
+  });
 
-  return out.slice(1)
+  return out.slice(1);
 }
 
 export function encodeDeepObject(
@@ -220,16 +230,16 @@ export function encodeDeepObject(
   options?: { charEncoding?: "percent" | "none" },
 ): string | undefined {
   if (value == null) {
-    return
+    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)
+  return encodeDeepObjectObject(key, value, options);
 }
 
 export function encodeDeepObjectObject(
@@ -238,43 +248,43 @@ export function encodeDeepObjectObject(
   options?: { charEncoding?: "percent" | "none" },
 ): string | undefined {
   if (value == null) {
-    return
+    return;
   }
 
-  let out = ""
+  let out = "";
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v
-  }
+    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+  };
 
   if (!isPlainObject(value)) {
-    throw new EncodingError(`Expected parameter '${key}' to be an object.`)
+    throw new EncodingError(`Expected parameter '${key}' to be an object.`);
   }
 
   Object.entries(value).forEach(([ck, cv]) => {
     if (cv == null) {
-      return
+      return;
     }
 
-    const pk = `${key}[${ck}]`
+    const pk = `${key}[${ck}]`;
 
     if (isPlainObject(cv)) {
-      const objOut = encodeDeepObjectObject(pk, cv, options)
+      const objOut = encodeDeepObjectObject(pk, cv, options);
 
-      out += objOut == null ? "" : `&${objOut}`
+      out += objOut == null ? "" : `&${objOut}`;
 
-      return
+      return;
     }
 
-    const pairs: unknown[] = Array.isArray(cv) ? cv : [cv]
-    const encoded = mapDefined(pairs, v => {
-      return `${encodeString(pk)}=${encodeString(serializeValue(v))}`
-    })?.join("&")
+    const pairs: unknown[] = Array.isArray(cv) ? cv : [cv];
+    const encoded = mapDefined(pairs, (v) => {
+      return `${encodeString(pk)}=${encodeString(serializeValue(v))}`;
+    })?.join("&");
 
-    out += encoded == null ? "" : `&${encoded}`
-  })
+    out += encoded == null ? "" : `&${encoded}`;
+  });
 
-  return out.slice(1)
+  return out.slice(1);
 }
 
 export function encodeJSON(
@@ -283,16 +293,16 @@ export function encodeJSON(
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
 ): string | undefined {
   if (typeof value === "undefined") {
-    return
+    return;
   }
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v
-  }
+    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+  };
 
-  const encVal = encodeString(JSON.stringify(value, jsonReplacer))
+  const encVal = encodeString(JSON.stringify(value, jsonReplacer));
 
-  return options?.explode ? encVal : `${encodeString(key)}=${encVal}`
+  return options?.explode ? encVal : `${encodeString(key)}=${encVal}`;
 }
 
 export const encodeSimple = (
@@ -300,172 +310,188 @@ export const encodeSimple = (
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
 ): string | undefined => {
-  let out = ""
-  const pairs: [string, unknown][] = options?.explode ? explode(key, value) : [[key, value]]
+  let out = "";
+  const pairs: [string, unknown][] = options?.explode
+    ? explode(key, value)
+    : [[key, value]];
 
   if (pairs.every(([_, v]) => v == null)) {
-    return
+    return;
   }
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v
-  }
-  const encodeValue = (v: unknown) => encodeString(serializeValue(v))
+    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+  };
+  const encodeValue = (v: unknown) => encodeString(serializeValue(v));
 
   pairs.forEach(([pk, pv]) => {
-    let tmp: string | null | undefined = ""
+    let tmp: string | null | undefined = "";
 
     if (pv == null) {
-      return
+      return;
     } else if (Array.isArray(pv)) {
-      tmp = mapDefined(pv, v => `${encodeValue(v)}`)?.join(",")
+      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)
+        return `,${encodeString(k)},${encodeValue(v)}`;
+      });
+      tmp = mapped?.join("").slice(1);
     } else {
-      const k = options?.explode && isPlainObject(value) ? `${pk}=` : ""
-      tmp = `${k}${encodeValue(pv)}`
+      const k = options?.explode && isPlainObject(value) ? `${pk}=` : "";
+      tmp = `${k}${encodeValue(pv)}`;
     }
 
-    out += tmp ? `,${tmp}` : ""
-  })
+    out += tmp ? `,${tmp}` : "";
+  });
 
-  return out.slice(1)
-}
+  return out.slice(1);
+};
 
 function explode(key: string, value: unknown): [string, unknown][] {
   if (Array.isArray(value)) {
-    return value.map(v => [key, v])
+    return value.map((v) => [key, v]);
   } else if (isPlainObject(value)) {
-    const o = value ?? {}
-    return Object.entries(o).map(([k, v]) => [k, v])
+    const o = value ?? {};
+    return Object.entries(o).map(([k, v]) => [k, v]);
   } else {
-    return [[key, value]]
+    return [[key, value]];
   }
 }
 
 function serializeValue(value: unknown): string {
   if (value == null) {
-    return ""
+    return "";
   } else if (value instanceof Date) {
-    return value.toISOString()
+    return value.toISOString();
   } else if (value instanceof Uint8Array) {
-    return bytesToBase64(value)
+    return bytesToBase64(value);
   } else if (typeof value === "object") {
-    return JSON.stringify(value, jsonReplacer)
+    return JSON.stringify(value, jsonReplacer);
   }
 
-  return `${value}`
+  return `${value}`;
 }
 
 function jsonReplacer(_: string, value: unknown): unknown {
   if (value instanceof Uint8Array) {
-    return bytesToBase64(value)
+    return bytesToBase64(value);
   } else {
-    return value
+    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
+      return acc;
     }
 
-    const m = mapper(v)
+    const m = mapper(v);
     if (m == null) {
-      return acc
+      return acc;
     }
 
-    acc.push(m)
+    acc.push(m);
 
-    return acc
-  }, [])
+    return acc;
+  }, []);
 
-  return res.length ? res : null
+  return res.length ? res : null;
 }
 
-function mapDefinedEntries<K, V, R>(inp: Iterable<[K, V]>, mapper: (v: [K, V]) => R): R[] | null {
-  const acc: R[] = []
+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
+      continue;
     }
 
-    const m = mapper([k, v])
+    const m = mapper([k, v]);
     if (m == null) {
-      continue
+      continue;
     }
 
-    acc.push(m)
+    acc.push(m);
   }
 
-  return acc.length ? acc : null
+  return acc.length ? acc : null;
 }
 
 export function queryJoin(...args: (string | undefined)[]): string {
-  return args.filter(Boolean).join("&")
+  return args.filter(Boolean).join("&");
 }
 
 type QueryEncoderOptions = {
-  explode?: boolean
-  charEncoding?: "percent" | "none"
-  allowEmptyValue?: string[]
-}
+  explode?: boolean;
+  charEncoding?: "percent" | "none";
+  allowEmptyValue?: string[];
+};
 
 type QueryEncoder = (
   key: string,
   value: unknown,
   options?: QueryEncoderOptions,
-) => string | undefined
+) => string | undefined;
 
-type BulkQueryEncoder = (values: Record<string, unknown>, options?: QueryEncoderOptions) => string
+type BulkQueryEncoder = (
+  values: Record<string, unknown>,
+  options?: QueryEncoderOptions,
+) => string;
 
 export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
-  const bulkEncode = (values: Record<string, unknown>, options?: QueryEncoderOptions): string => {
+  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 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)
+          value === undefined
+          || value === null
+          || value === ""
+          || (Array.isArray(value) && value.length === 0)
         ) {
-          return `${encodeURIComponent(key)}=`
+          return `${encodeURIComponent(key)}=`;
         }
       }
-      return f(key, value, opts)
-    })
-    return queryJoin(...encoded)
-  }
+      return f(key, value, opts);
+    });
+    return queryJoin(...encoded);
+  };
 
-  return bulkEncode
+  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 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 {
+export function appendForm(
+  fd: FormData,
+  key: string,
+  value: unknown,
+  fileName?: string,
+): void {
   if (value == null) {
-    return
+    return;
   } else if (value instanceof Blob && fileName) {
-    fd.append(key, value, fileName)
+    fd.append(key, value, fileName);
   } else if (value instanceof Blob) {
-    fd.append(key, value)
+    fd.append(key, value);
   } else {
-    fd.append(key, String(value))
+    fd.append(key, String(value));
   }
 }