[refactor] Chore to update to v1 of TypeBox

Author: sroussey

bun.lock

@@ -25,7 +25,6 @@
     "@podley/task-graph": "0.0.43",
     "@podley/tasks": "0.0.43",
     "@podley/util": "0.0.43",
-    "@sinclair/typebox": "^0.34.41",
     "@sroussey/parse-address": "^2.4.2",
     "@sroussey/parse-full-name": "^2.0.0",
     "awesome-phonenumber": "^7.6.0",
@@ -38,6 +37,7 @@
     "fast-xml-parser": "^5.3.2",
     "html-entities": "^2.6.0",
     "pdf2json": "^3.2.2",
+    "typebox": "1.0.55",
     "words-to-numbers": "^1.5.1",
     "xml2js": "^0.6.2"
   },

package.json

@@ -6,12 +6,12 @@
 
 // data.sec.gov/api/xbrl/companyfacts/CIK{cik}.json
 
-import { Static, Type } from "@sinclair/typebox";
-import { TypeDate, TypeNullable } from "../../util/TypeBoxUtil";
-import { YYYYdMMdDD } from "../../util/parseDate";
+import { Static, Type } from "typebox";
 import { Frame } from "../../util/BaseTypes";
-import { TypeSECForm } from "../submissions/EnititySubmissionSchema";
+import { TypeDate, TypeNullable, TypeStringEnum } from "../../util/TypeBoxUtil";
+import { YYYYdMMdDD } from "../../util/parseDate";
 import { AllForms } from "../forms/all-forms";
+import { TypeSECForm } from "../submissions/EnititySubmissionSchema";
 
 export interface CompanyFacts {
   cik: number;
@@ -59,7 +59,7 @@ export const FactoidSchema = Type.Object({
   start_date: TypeNullable(TypeDate()),
   end_date: TypeDate(),
   fy: Type.Number({ format: "year" }),
-  fp: Type.Union(FP.map((fp) => Type.Literal(fp))),
+  fp: TypeStringEnum(FP),
 });
 
 export type Factoid = Static<typeof FactoidSchema>;

src/sec/facts/CompanyFacts.ts

@@ -6,7 +6,7 @@
 
 // See https://www.sec.gov/files/edgar/filermanual/edgarfilermmanual-vol2-c3.pdf
 
-import type { TObject } from "@sinclair/typebox";
+import type { TObject } from "typebox";
 import { Readable } from "node:stream";
 import { extractArrayPaths } from "./parse_util";
 import { X2jOptions } from "fast-xml-parser";

src/sec/forms/Form.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { Type } from "@sinclair/typebox";
+import { Type } from "typebox";
 
 export const STRING_50_TYPE = Type.String({ minLength: 0, maxLength: 50 });
 export const STRING_150_TYPE = Type.String({ minLength: 1, maxLength: 150 });

src/sec/forms/FormSchemaUtil.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { Type, Static } from "@sinclair/typebox";
+import { Type, Static } from "typebox";
 import {
   TRUE_FALSE_LIST,
   RELATIONSHIP_LIST,
@@ -304,22 +304,24 @@ const NAMES_LIST_TYPE = Type.Union([
   Type.Object({ previousName: Type.Optional(Type.Array(ENTITY_NAME_TYPE, { maxItems: 3 })) }),
 ]);
 
-const YEAR_INC_TYPE = Type.Object({
-  ...Type.Union([
+const YEAR_INC_TYPE = Type.Intersect([
+  Type.Union([
     Type.Object({ withinFiveYears: IS_TRUE_TYPE }),
     Type.Object({ yetToBeFormed: IS_TRUE_TYPE }),
     Type.Object({ overFiveYears: IS_TRUE_TYPE }),
-  ]).properties!,
-  value: Type.Optional(YEAR_VALUE_TYPE),
-});
+  ]),
+  Type.Object({
+    value: Type.Optional(YEAR_VALUE_TYPE),
+  }),
+]);
 
 const FILED_BY_COMPANY_FORMD_TYPE = Type.Object({
   cik: CIK_TYPE,
   ccc: Type.Optional(Type.String({ minLength: 8, maxLength: 8 })),
   entityName: Type.Optional(ENTITY_NAME_TYPE),
 });
 
-const ISSUER_TYPE = Type.Composite([
+const ISSUER_TYPE = Type.Intersect([
   FILED_BY_COMPANY_FORMD_TYPE,
   Type.Object({
     issuerAddress: FORMD_ADDRESS_TYPE,

src/sec/forms/exempt-offerings/Form_D.schema.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { Value } from "@sinclair/typebox/value";
+import { Value } from "typebox/value";
 import { Form } from "../Form";
 import { FormD, FormDSchema, FormDSubmission, FormDSubmissionSchema } from "./Form_D.schema";
 

src/sec/forms/exempt-offerings/Form_D.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { TSchema, Kind } from "@sinclair/typebox";
+import { TSchema, Type } from "typebox";
 import { Readable } from "node:stream";
 
 /** Read a Node.js Readable stream completely into a UTF-8 string */
@@ -20,30 +20,25 @@ export function extractArrayPaths(schema: TSchema, basePath: string = ""): strin
   const arrayPaths: string[] = [];
 
   function walk(currentSchema: TSchema, currentPath: string) {
-    if (currentSchema[Kind] === "Array") {
+    if (Type.IsArray(currentSchema)) {
       arrayPaths.push(currentPath);
       // Also walk the array items to find nested arrays
-      if (currentSchema.items) {
-        walk(currentSchema.items as TSchema, currentPath);
-      }
-    } else if (currentSchema[Kind] === "Object" && currentSchema.properties) {
+      walk(currentSchema.items, currentPath);
+    } else if (Type.IsObject(currentSchema)) {
       for (const [key, value] of Object.entries(currentSchema.properties)) {
         const newPath = currentPath ? `${currentPath}.${key}` : key;
-        walk(value as TSchema, newPath);
+        walk(value, newPath);
       }
-    } else if (currentSchema[Kind] === "Union" && currentSchema.anyOf) {
+    } else if (Type.IsUnion(currentSchema)) {
       // Handle unions by checking each variant
       for (const variant of currentSchema.anyOf) {
-        walk(variant as TSchema, currentPath);
+        walk(variant, currentPath);
       }
-    } else if (currentSchema[Kind] === "Composite" && currentSchema.allOf) {
+    } else if (Type.IsIntersect(currentSchema)) {
       // Handle composite types
       for (const part of currentSchema.allOf) {
-        walk(part as TSchema, currentPath);
+        walk(part, currentPath);
       }
-    } else if (currentSchema[Kind] === "Optional" && currentSchema.type) {
-      // Handle optional types
-      walk(currentSchema.type as TSchema, currentPath);
     }
   }
 

src/sec/forms/parse_util.ts

@@ -4,21 +4,22 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { Static, Type, FormatRegistry } from "@sinclair/typebox";
+import { Static, Type } from "typebox";
+import { Format } from "typebox/format";
 import { ArrayToObject } from "@podley/util";
 import { TypeNullable } from "../../util/TypeBoxUtil";
 import { ALL_FORM_NAMES } from "../forms/all-forms";
 
 // const TypeSECForm = () => Type.Union(ALL_FORM_NAMES.map((f) => Type.Literal(f)));
 
-FormatRegistry.Set("sec-form", (value: string) => {
+Format.Set("sec-form", (value: string) => {
   if (!ALL_FORM_NAMES.includes(value as any)) console.warn(`Unknown SEC form: ${value}`);
   return true;
 });
 export const TypeSECForm = (annotations: Record<string, unknown> = {}) =>
   Type.String({ format: "sec-form", maxLength: 20, ...annotations });
 export const TypeSECBoolean = (annotations: Record<string, unknown> = {}) =>
-  Type.Transform(Type.Boolean(annotations))
+  Type.Codec(Type.Boolean(annotations))
     .Decode((value) => (value ? "1" : "0"))
     .Encode((value) => value === "1");
 export const TypeAddress = (annotations: Record<string, unknown> = {}) =>
@@ -38,7 +39,7 @@ export const TypeAddress = (annotations: Record<string, unknown> = {}) =>
     annotations
   );
 export const TypeSecCik = (annotations: Record<string, unknown> = {}) =>
-  Type.Transform(
+  Type.Codec(
     Type.Number({ format: "cik", minimum: 0, maximum: 9999999999, title: "CIK", ...annotations })
   )
     .Decode((value) => value.toString())

src/sec/submissions/EnititySubmissionSchema.ts

@@ -5,21 +5,21 @@
  */
 
 import { AddressParser } from "@sroussey/parse-address";
-import { Address } from "./AddressSchema";
-import { COUNTRY_STATE_CODE_ARRAY, KEYWORD_STATE_OR_COUNTRY_MAP } from "./AddressSchemaCodes";
 import { hasCompanyEnding } from "../company/CompanyNormalization";
+import { Address, type CountryCode, type StateOrCountryCode } from "./AddressSchema";
+import { COUNTRY_STATE_CODE_ARRAY, KEYWORD_STATE_OR_COUNTRY_MAP } from "./AddressSchemaCodes";
 
 export type AddressImport = {
   // required fields
   city?: string | null;
-  stateOrCountry?: string | null;
+  stateOrCountry?: StateOrCountryCode | string | null;
+  countryCode?: CountryCode | string | null;
   // optional fields
   stateOrCountryDescription?: string | null;
   street1?: string | null; // if street 1 is null, street 2 or 3 must have a value
   street2?: string | null;
   street3?: string | null;
   country?: string | null;
-  countryCode?: string | null;
   zipCode?: string | null;
   isForeignLocation?: boolean | null;
   foreignStateTerritory?: string | null;
@@ -245,18 +245,26 @@ export function normalizeAddress(importAddress: AddressImport | null): Address |
   let street3 = cleanStreet(importAddress.street3);
   let zip = importAddress.zipCode?.trim() || null;
   let city = importAddress.city?.trim() || null;
-  let state_or_country = importAddress.stateOrCountry?.trim() || null;
+  let state_or_country: StateOrCountryCode | null =
+    (importAddress.stateOrCountry?.trim() as StateOrCountryCode | null) || null;
 
   [street1, street2, street3] = consolidateStreetAddresses(street1, street2, street3);
 
   state_or_country =
-    state_or_country || findCountryByKeyword([street1, street2, street3, city, state_or_country]);
+    state_or_country ||
+    (findCountryByKeyword([
+      street1,
+      street2,
+      street3,
+      city,
+      state_or_country,
+    ]) as StateOrCountryCode | null);
 
   let country_code = findCountryCode(
     state_or_country,
     importAddress.country,
     importAddress.countryCode
-  );
+  ) as CountryCode | null;
 
   city = normalizeCity(city ?? "");
 
@@ -278,8 +286,9 @@ export function normalizeAddress(importAddress: AddressImport | null): Address |
     street2 = importAddress.street2 || null;
     street3 = importAddress.street3 || null;
     city = city || importAddress.city || null;
-    state_or_country = state_or_country || importAddress.stateOrCountry || null;
-    country_code = country_code || importAddress.countryCode || null;
+    state_or_country =
+      state_or_country || (importAddress.stateOrCountry as StateOrCountryCode) || null;
+    country_code = country_code || (importAddress.countryCode as CountryCode) || null;
     zip = zip || importAddress.zipCode || null;
   }