refactor: simplify util types, add attest unit/bench examples

.gitignore

@@ -9,6 +9,8 @@ node_modules
 tsconfig*.tsbuildinfo
 bench
 playgrounds/performance/out
+# temporary type-testing cache
+.attest
 
 # local env files
 .env

package.json

@@ -30,6 +30,7 @@
     "version:update": "bun .scripts/updateVersion.ts"
   },
   "devDependencies": {
+    "@arktype/attest": "0.0.4",
     "@biomejs/biome": "1.2.2",
     "@changesets/changelog-github": "^0.4.8",
     "@changesets/cli": "^2.26.0",

packages/abitype/package.json

@@ -10,7 +10,8 @@
     "build:esm+types": "tsc --project tsconfig.build.json --module es2020 --outDir ./dist/esm --declaration --declarationMap --declarationDir ./dist/types && echo > ./dist/esm/package.json '{\"type\":\"module\",\"sideEffects\":false}'",
     "clean": "rm -rf dist tsconfig.tsbuildinfo abis zod",
     "test:build": "publint --strict",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "typeperf": "tsc --noEmit --extendedDiagnostics --composite false --incremental false"
   },
   "files": [
     "dist",
@@ -48,12 +49,8 @@
   },
   "typesVersions": {
     "*": {
-      "abis": [
-        "./dist/types/exports/abis.d.ts"
-      ],
-      "zod": [
-        "./dist/types/exports/zod.d.ts"
-      ]
+      "abis": ["./dist/types/exports/abis.d.ts"],
+      "zod": ["./dist/types/exports/zod.d.ts"]
     }
   },
   "peerDependencies": {

packages/abitype/src/types.ts

@@ -141,6 +141,18 @@ type KeyofUnion<T> = T extends T ? keyof T : never
  */
 export type Pretty<T> = { [K in keyof T]: T[K] } & unknown
 
+/**
+ * Check that a type is a subtype of another.
+ *
+ * Useful for ensuring more complex types conform to a base pattern, e.g. by
+ * defining a set of keys.
+ *
+ * @param Base - The type that T must extend.
+ * @param T - The type to check.
+ * @returns T
+ */
+export type Satisfy<Base, T extends Base> = T
+
 /**
  * Creates range between two positive numbers using [tail recursion](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#tail-recursion-elimination-on-conditional-types).
  *

packages/abitype/src/utils.bench.ts

@@ -0,0 +1,34 @@
+import { bench } from '@arktype/attest'
+import type { TypedDataToPrimitiveTypes } from './utils.js'
+
+bench('recursive', () => {
+  const types3 = {
+    Foo: [{ name: 'bar', type: 'Bar[]' }],
+    Bar: [{ name: 'foo', type: 'Foo[]' }],
+  } as const
+  return {} as TypedDataToPrimitiveTypes<typeof types3>
+}).types([12, 'instantiations'])
+
+bench('deep', () => {
+  const types = {
+    Contributor: [
+      { name: 'name', type: 'string' },
+      { name: 'address', type: 'address' },
+    ],
+    Website: [
+      { name: 'domain', type: 'string' },
+      { name: 'webmaster', type: 'Contributor' },
+    ],
+    Project: [
+      { name: 'name', type: 'string' },
+      { name: 'contributors', type: 'Contributor[2]' },
+      { name: 'website', type: 'Website' },
+    ],
+    Organization: [
+      { name: 'name', type: 'string' },
+      { name: 'projects', type: 'Project[]' },
+      { name: 'website', type: 'Website' },
+    ],
+  } as const
+  return {} as TypedDataToPrimitiveTypes<typeof types>
+}).types([44, 'instantiations'])

packages/abitype/src/utils.test.ts

@@ -0,0 +1,20 @@
+import { attest } from '@arktype/attest'
+import { test } from 'vitest'
+import type { TypedDataToPrimitiveTypes } from './utils.js'
+
+test('self-referencing', () => {
+  type Result = TypedDataToPrimitiveTypes<{
+    Name: [{ name: 'first'; type: 'Name' }, { name: 'last'; type: 'string' }]
+  }>
+  attest<
+    {
+      Name: {
+        first: [
+          "Error: Cannot convert self-referencing struct 'Name' to primitive type.",
+        ]
+        last: string
+      }
+    },
+    Result
+  >()
+})