@vepler/sdk 5.28.1 → 6.0.0

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/sdk/geography.ts

@@ -0,0 +1,115 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { geographyGetGeographyAncestors } from "../funcs/geographyGetGeographyAncestors.js";
+import { geographyGetGeographyAreas } from "../funcs/geographyGetGeographyAreas.js";
+import { geographyGetGeographyChildren } from "../funcs/geographyGetGeographyChildren.js";
+import { geographyGetGeographyDescendants } from "../funcs/geographyGetGeographyDescendants.js";
+import { geographyGetGeographyProvenance } from "../funcs/geographyGetGeographyProvenance.js";
+import { geographyGetGeographyRelease } from "../funcs/geographyGetGeographyRelease.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Geography extends ClientSDK {
+  /**
+   * Everything containing this area
+   *
+   * @remarks
+   * Walks the whole way up in one read: the containing area at every tier, with how many hops away it is and the worst fit along that path. Check `minFit` before aggregating — an LSOA reaches its local authority by best fit in the current release, because the exact-fit spine exists only at the 2022 boundaries.
+   */
+  async getGeographyAncestors(
+    request: operations.GetGeographyAncestorsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetGeographyAncestorsResponseBody> {
+    return unwrapAsync(geographyGetGeographyAncestors(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Look up areas by code
+   *
+   * @remarks
+   * Resolves up to 100 comma-separated GSS codes to their name, type, vintage, nation and tier. A code can legitimately exist at more than one layer or edition, so every match is returned — narrow with `areaType` when a single answer is wanted.
+   */
+  async getGeographyAreas(
+    request: operations.GetGeographyAreasRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetGeographyAreasResponseBody> {
+    return unwrapAsync(geographyGetGeographyAreas(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * The immediate children of this area
+   *
+   * @remarks
+   * One hop down the curated tree, with the fit of each link and the source that won it. Where publishers disagreed about a parent, `sourceId` names the one whose claim was kept.
+   */
+  async getGeographyChildren(
+    request: operations.GetGeographyChildrenRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetGeographyChildrenResponseBody> {
+    return unwrapAsync(geographyGetGeographyChildren(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Everything inside this area
+   *
+   * @remarks
+   * Paged, because the honest answer can be very large — England and Wales hold 188,880 Output Areas. `total_count` reports the full size of the set being paged through. Note that every unitary authority is both a district and a county under one code, so narrow with `areaType` or each descendant is returned once per matching type.
+   */
+  async getGeographyDescendants(
+    request: operations.GetGeographyDescendantsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetGeographyDescendantsResponseBody> {
+    return unwrapAsync(geographyGetGeographyDescendants(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Where this area's record came from
+   *
+   * @remarks
+   * The publisher, the pinned file, its licence, and the acknowledgement line that licence requires — verbatim, because the wording differs per custodian and anyone redistributing this data has to reproduce it. `sha256` identifies the exact file the record was parsed from; `fromArchive` is true when the publisher was unreachable and the bytes came from our own archive.
+   */
+  async getGeographyProvenance(
+    request: operations.GetGeographyProvenanceRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetGeographyProvenanceResponseBody> {
+    return unwrapAsync(geographyGetGeographyProvenance(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get the current geography release
+   *
+   * @remarks
+   * Returns the release every other geography endpoint answers from unless one is pinned. A release is a named set of publisher vintages that compose into one consistent tree — the nations publish on their own cycles, so a UK-wide release is a composition rather than a date.
+   */
+  async getGeographyRelease(
+    options?: RequestOptions,
+  ): Promise<operations.GetGeographyReleaseResponseBody> {
+    return unwrapAsync(geographyGetGeographyRelease(
+      this,
+      options,
+    ));
+  }
+}