@apideck/unify 0.13.6 → 0.14.0

package/src/lib/encodings.ts

@@ -16,12 +16,16 @@ export function encodeMatrix(
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-): string {
+): 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;
   };
@@ -29,21 +33,25 @@ export function encodeMatrix(
 
   pairs.forEach(([pk, pv]) => {
     let tmp = "";
-    let encValue = "";
+    let encValue: string | null | undefined = null;
 
-    if (pv === undefined) {
+    if (pv == null) {
       return;
     } else if (Array.isArray(pv)) {
-      encValue = mapDefined(pv, (v) => `${encodeValue(v)}`).join(",");
+      encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(",");
     } else if (isPlainObject(pv)) {
-      encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+      const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
         return `,${encodeString(k)},${encodeValue(v)}`;
-      }).join("");
-      encValue = encValue.slice(1);
+      });
+      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
@@ -66,36 +74,40 @@ export function encodeLabel(
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-): string {
+): 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 = "";
+    let encValue: string | null | undefined = "";
 
-    if (pv === undefined) {
+    if (pv == null) {
       return;
     } else if (Array.isArray(pv)) {
-      encValue = mapDefined(pv, (v) => `${encodeValue(v)}`).join(".");
+      encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(".");
     } else if (isPlainObject(pv)) {
-      encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+      const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
         return `.${encodeString(k)}.${encodeValue(v)}`;
-      }).join("");
-      encValue = encValue.slice(1);
+      });
+      encValue = mapped?.join("").slice(1);
     } else {
       const k =
         options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : "";
       encValue = `${k}${encodeValue(pv)}`;
     }
 
-    out += `.${encValue}`;
+    out += encValue == null ? "" : `.${encValue}`;
   });
 
   return out;
@@ -105,7 +117,7 @@ type FormEncoder = (
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-) => string;
+) => string | undefined;
 
 function formEncoder(sep: string): FormEncoder {
   return (
@@ -118,6 +130,10 @@ function formEncoder(sep: string): FormEncoder {
       ? explode(key, value)
       : [[key, value]];
 
+    if (pairs.every(([_, v]) => v == null)) {
+      return;
+    }
+
     const encodeString = (v: string) => {
       return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
     };
@@ -128,20 +144,24 @@ function formEncoder(sep: string): FormEncoder {
 
     pairs.forEach(([pk, pv]) => {
       let tmp = "";
-      let encValue = "";
+      let encValue: string | null | undefined = null;
 
-      if (pv === undefined) {
+      if (pv == null) {
         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);
+        })?.join(encodedSep);
       } else {
         encValue = `${encodeValue(pv)}`;
       }
 
+      if (encValue == null) {
+        return;
+      }
+
       tmp = `${encodeString(pk)}=${encValue}`;
 
       // If we end up with the nothing then skip forward
@@ -180,7 +200,7 @@ export function encodeBodyForm(
     let tmp = "";
     let encValue = "";
 
-    if (pv === undefined) {
+    if (pv == null) {
       return;
     } else if (Array.isArray(pv)) {
       encValue = JSON.stringify(pv, jsonReplacer);
@@ -207,14 +227,14 @@ export function encodeDeepObject(
   key: string,
   value: unknown,
   options?: { charEncoding?: "percent" | "none" },
-): string {
+): 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`,
+      `Value of parameter '${key}' which uses deepObject encoding must be an object or null`,
     );
   }
 
@@ -225,9 +245,9 @@ export function encodeDeepObjectObject(
   key: string,
   value: unknown,
   options?: { charEncoding?: "percent" | "none" },
-): string {
+): string | undefined {
   if (value == null) {
-    return "";
+    return;
   }
 
   let out = "";
@@ -241,7 +261,7 @@ export function encodeDeepObjectObject(
   }
 
   Object.entries(value).forEach(([ck, cv]) => {
-    if (cv === undefined) {
+    if (cv == null) {
       return;
     }
 
@@ -250,19 +270,17 @@ export function encodeDeepObjectObject(
     if (isPlainObject(cv)) {
       const objOut = encodeDeepObjectObject(pk, cv, options);
 
-      out += `&${objOut}`;
+      out += objOut == null ? "" : `&${objOut}`;
 
       return;
     }
 
     const pairs: unknown[] = Array.isArray(cv) ? cv : [cv];
-    let encoded = "";
-
-    encoded = mapDefined(pairs, (v) => {
+    const encoded = mapDefined(pairs, (v) => {
       return `${encodeString(pk)}=${encodeString(serializeValue(v))}`;
-    }).join("&");
+    })?.join("&");
 
-    out += `&${encoded}`;
+    out += encoded == null ? "" : `&${encoded}`;
   });
 
   return out.slice(1);
@@ -272,9 +290,9 @@ export function encodeJSON(
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-): string {
+): string | undefined {
   if (typeof value === "undefined") {
-    return "";
+    return;
   }
 
   const encodeString = (v: string) => {
@@ -290,40 +308,39 @@ export const encodeSimple = (
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-): string => {
+): 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 tmp: string | null | undefined = "";
 
-    if (pv === undefined) {
+    if (pv == null) {
       return;
     } else if (Array.isArray(pv)) {
-      tmp = mapDefined(pv, (v) => `${encodeValue(v)}`).join(",");
+      tmp = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(",");
     } else if (isPlainObject(pv)) {
-      tmp = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+      const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
         return `,${encodeString(k)},${encodeValue(v)}`;
-      }).join("");
-      tmp = tmp.slice(1);
+      });
+      tmp = mapped?.join("").slice(1);
     } else {
       const k = options?.explode && isPlainObject(value) ? `${pk}=` : "";
       tmp = `${k}${encodeValue(pv)}`;
     }
 
-    // If we end up with the nothing then skip forward
-    if (!tmp) {
-      return;
-    }
-
-    out += `,${tmp}`;
+    out += tmp ? `,${tmp}` : "";
   });
 
   return out.slice(1);
@@ -341,9 +358,7 @@ function explode(key: string, value: unknown): [string, unknown][] {
 }
 
 function serializeValue(value: unknown): string {
-  if (value === null) {
-    return "null";
-  } else if (typeof value === "undefined") {
+  if (value == null) {
     return "";
   } else if (value instanceof Date) {
     return value.toISOString();
@@ -364,14 +379,14 @@ function jsonReplacer(_: string, value: unknown): unknown {
   }
 }
 
-function mapDefined<T, R>(inp: T[], mapper: (v: T) => R): R[] {
-  return inp.reduce<R[]>((acc, v) => {
-    if (v === undefined) {
+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 === undefined) {
+    if (m == null) {
       return acc;
     }
 
@@ -379,30 +394,32 @@ function mapDefined<T, R>(inp: T[], mapper: (v: T) => R): R[] {
 
     return acc;
   }, []);
+
+  return res.length ? res : null;
 }
 
 function mapDefinedEntries<K, V, R>(
   inp: Iterable<[K, V]>,
   mapper: (v: [K, V]) => R,
-): R[] {
+): R[] | null {
   const acc: R[] = [];
   for (const [k, v] of inp) {
-    if (v === undefined) {
+    if (v == null) {
       continue;
     }
 
     const m = mapper([k, v]);
-    if (m === undefined) {
+    if (m == null) {
       continue;
     }
 
     acc.push(m);
   }
 
-  return acc;
+  return acc.length ? acc : null;
 }
 
-export function queryJoin(...args: string[]): string {
+export function queryJoin(...args: (string | undefined)[]): string {
   return args.filter(Boolean).join("&");
 }
 
@@ -415,7 +432,7 @@ type QueryEncoder = (
   key: string,
   value: unknown,
   options?: QueryEncoderOptions,
-) => string;
+) => string | undefined;
 
 type BulkQueryEncoder = (
   values: Record<string, unknown>,
@@ -447,3 +464,20 @@ 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/src/lib/primitives.ts

@@ -120,3 +120,17 @@ export function abortSignalAny(signals: AbortSignal[]): AbortSignal {
 
   return result;
 }
+
+export function compactMap<T>(
+  values: Record<string, T | undefined>,
+): Record<string, T> {
+  const out: Record<string, T> = {};
+
+  for (const [k, v] of Object.entries(values)) {
+    if (typeof v !== "undefined") {
+      out[k] = v;
+    }
+  }
+
+  return out;
+}

package/src/lib/schemas.ts

@@ -57,6 +57,7 @@ export function collectExtraKeys<
 >(
   obj: ZodObject<Shape, "strip", Catchall>,
   extrasKey: K,
+  optional: boolean,
 ): ZodEffects<
   typeof obj,
   & output<ZodObject<Shape, "strict">>
@@ -81,6 +82,10 @@ export function collectExtraKeys<
       delete val[key];
     }
 
+    if (optional && Object.keys(extras).length === 0) {
+      return val;
+    }
+
     return { ...val, [extrasKey]: extras };
   });
 }

package/src/lib/sdks.ts

@@ -135,7 +135,10 @@ export class ClientSDK {
 
     const secQuery: string[] = [];
     for (const [k, v] of Object.entries(security?.queryParams || {})) {
-      secQuery.push(encodeForm(k, v, { charEncoding: "percent" }));
+      const q = encodeForm(k, v, { charEncoding: "percent" });
+      if (typeof q !== "undefined") {
+        secQuery.push(q);
+      }
     }
     if (secQuery.length) {
       finalQuery += `&${secQuery.join("&")}`;

package/src/models/components/bill.ts

@@ -133,11 +133,11 @@ export type Bill = {
   /**
    * Date bill was issued - YYYY-MM-DD.
    */
-  billDate?: RFCDate | undefined;
+  billDate?: RFCDate | null | undefined;
   /**
    * The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD.
    */
-  dueDate?: RFCDate | undefined;
+  dueDate?: RFCDate | null | undefined;
   /**
    * The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD.
    */
@@ -273,11 +273,11 @@ export type BillInput = {
   /**
    * Date bill was issued - YYYY-MM-DD.
    */
-  billDate?: RFCDate | undefined;
+  billDate?: RFCDate | null | undefined;
   /**
    * The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD.
    */
-  dueDate?: RFCDate | undefined;
+  dueDate?: RFCDate | null | undefined;
   /**
    * The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD.
    */
@@ -395,8 +395,8 @@ export const Bill$inboundSchema: z.ZodType<Bill, z.ZodTypeDef, unknown> = z
     currency: z.nullable(Currency$inboundSchema).optional(),
     currency_rate: z.nullable(z.number()).optional(),
     tax_inclusive: z.nullable(z.boolean()).optional(),
-    bill_date: z.string().transform(v => new RFCDate(v)).optional(),
-    due_date: z.string().transform(v => new RFCDate(v)).optional(),
+    bill_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(),
+    due_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(),
     paid_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(),
     po_number: z.nullable(z.string()).optional(),
     reference: z.nullable(z.string()).optional(),
@@ -476,8 +476,8 @@ export type Bill$Outbound = {
   currency?: string | null | undefined;
   currency_rate?: number | null | undefined;
   tax_inclusive?: boolean | null | undefined;
-  bill_date?: string | undefined;
-  due_date?: string | undefined;
+  bill_date?: string | null | undefined;
+  due_date?: string | null | undefined;
   paid_date?: string | null | undefined;
   po_number?: string | null | undefined;
   reference?: string | null | undefined;
@@ -524,8 +524,10 @@ export const Bill$outboundSchema: z.ZodType<Bill$Outbound, z.ZodTypeDef, Bill> =
     currency: z.nullable(Currency$outboundSchema).optional(),
     currencyRate: z.nullable(z.number()).optional(),
     taxInclusive: z.nullable(z.boolean()).optional(),
-    billDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
-    dueDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
+    billDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString()))
+      .optional(),
+    dueDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString()))
+      .optional(),
     paidDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString()))
       .optional(),
     poNumber: z.nullable(z.string()).optional(),
@@ -631,8 +633,8 @@ export const BillInput$inboundSchema: z.ZodType<
   currency: z.nullable(Currency$inboundSchema).optional(),
   currency_rate: z.nullable(z.number()).optional(),
   tax_inclusive: z.nullable(z.boolean()).optional(),
-  bill_date: z.string().transform(v => new RFCDate(v)).optional(),
-  due_date: z.string().transform(v => new RFCDate(v)).optional(),
+  bill_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(),
+  due_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(),
   paid_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(),
   po_number: z.nullable(z.string()).optional(),
   reference: z.nullable(z.string()).optional(),
@@ -694,8 +696,8 @@ export type BillInput$Outbound = {
   currency?: string | null | undefined;
   currency_rate?: number | null | undefined;
   tax_inclusive?: boolean | null | undefined;
-  bill_date?: string | undefined;
-  due_date?: string | undefined;
+  bill_date?: string | null | undefined;
+  due_date?: string | null | undefined;
   paid_date?: string | null | undefined;
   po_number?: string | null | undefined;
   reference?: string | null | undefined;
@@ -738,8 +740,10 @@ export const BillInput$outboundSchema: z.ZodType<
   currency: z.nullable(Currency$outboundSchema).optional(),
   currencyRate: z.nullable(z.number()).optional(),
   taxInclusive: z.nullable(z.boolean()).optional(),
-  billDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
-  dueDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
+  billDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString()))
+    .optional(),
+  dueDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString()))
+    .optional(),
   paidDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString()))
     .optional(),
   poNumber: z.nullable(z.string()).optional(),

package/src/models/components/purchaseorder.ts

@@ -170,7 +170,7 @@ export type PurchaseOrder = {
   /**
    * The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD.
    */
-  dueDate?: RFCDate | undefined;
+  dueDate?: RFCDate | null | undefined;
   /**
    * Payment method used for the transaction, such as cash, credit card, bank transfer, or check
    */
@@ -294,7 +294,7 @@ export type PurchaseOrderInput = {
   /**
    * The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD.
    */
-  dueDate?: RFCDate | undefined;
+  dueDate?: RFCDate | null | undefined;
   /**
    * Payment method used for the transaction, such as cash, credit card, bank transfer, or check
    */
@@ -377,7 +377,7 @@ export const PurchaseOrder$inboundSchema: z.ZodType<
   discount_percentage: z.nullable(z.number()).optional(),
   bank_account: BankAccount$inboundSchema.optional(),
   accounting_by_row: z.nullable(z.boolean()).optional(),
-  due_date: z.string().transform(v => new RFCDate(v)).optional(),
+  due_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(),
   payment_method: z.nullable(z.string()).optional(),
   tax_code: z.nullable(z.string()).optional(),
   channel: z.nullable(z.string()).optional(),
@@ -453,7 +453,7 @@ export type PurchaseOrder$Outbound = {
   discount_percentage?: number | null | undefined;
   bank_account?: BankAccount$Outbound | undefined;
   accounting_by_row?: boolean | null | undefined;
-  due_date?: string | undefined;
+  due_date?: string | null | undefined;
   payment_method?: string | null | undefined;
   tax_code?: string | null | undefined;
   channel?: string | null | undefined;
@@ -504,7 +504,8 @@ export const PurchaseOrder$outboundSchema: z.ZodType<
   discountPercentage: z.nullable(z.number()).optional(),
   bankAccount: BankAccount$outboundSchema.optional(),
   accountingByRow: z.nullable(z.boolean()).optional(),
-  dueDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
+  dueDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString()))
+    .optional(),
   paymentMethod: z.nullable(z.string()).optional(),
   taxCode: z.nullable(z.string()).optional(),
   channel: z.nullable(z.string()).optional(),
@@ -607,7 +608,7 @@ export const PurchaseOrderInput$inboundSchema: z.ZodType<
   discount_percentage: z.nullable(z.number()).optional(),
   bank_account: BankAccount$inboundSchema.optional(),
   accounting_by_row: z.nullable(z.boolean()).optional(),
-  due_date: z.string().transform(v => new RFCDate(v)).optional(),
+  due_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(),
   payment_method: z.nullable(z.string()).optional(),
   tax_code: z.nullable(z.string()).optional(),
   channel: z.nullable(z.string()).optional(),
@@ -666,7 +667,7 @@ export type PurchaseOrderInput$Outbound = {
   discount_percentage?: number | null | undefined;
   bank_account?: BankAccount$Outbound | undefined;
   accounting_by_row?: boolean | null | undefined;
-  due_date?: string | undefined;
+  due_date?: string | null | undefined;
   payment_method?: string | null | undefined;
   tax_code?: string | null | undefined;
   channel?: string | null | undefined;
@@ -710,7 +711,8 @@ export const PurchaseOrderInput$outboundSchema: z.ZodType<
   discountPercentage: z.nullable(z.number()).optional(),
   bankAccount: BankAccount$outboundSchema.optional(),
   accountingByRow: z.nullable(z.boolean()).optional(),
-  dueDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
+  dueDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString()))
+    .optional(),
   paymentMethod: z.nullable(z.string()).optional(),
   taxCode: z.nullable(z.string()).optional(),
   channel: z.nullable(z.string()).optional(),

package/tsconfig.json

@@ -0,0 +1,41 @@
+{
+  "compilerOptions": {
+    "incremental": true,
+    "tsBuildInfoFile": ".tsbuildinfo",
+    "target": "ES2020",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "jsx": "react-jsx",
+
+    "module": "Node16",
+    "moduleResolution": "Node16",
+
+    "allowJs": true,
+
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": ".",
+    
+
+    // https://github.com/tsconfig/bases/blob/a1bf7c0fa2e094b068ca3e1448ca2ece4157977e/bases/strictest.json
+    "strict": true,
+    "allowUnusedLabels": false,
+    "allowUnreachableCode": false,
+    "exactOptionalPropertyTypes": true,
+    "useUnknownInCatchVariables": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "isolatedModules": true,
+    "checkJs": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules"]
+}