Implement model registry declarations

src/models/index.test.ts

@@ -0,0 +1,38 @@
+import { tt } from '@noeldemartin/utils';
+import type { Equals, Expect } from '@noeldemartin/utils';
+
+import User from '@/testing/stubs/User';
+import Post from '@/testing/stubs/Post';
+import City from '@/testing/stubs/City';
+import type { ModelConstructor } from '@/models/inference';
+
+import { bootModels, requireBootedModel } from './index';
+
+declare module './index' {
+    interface ModelsRegistry {
+        User: typeof User;
+    }
+}
+
+describe('Models helpers', () => {
+
+    it('registers booted models', () => {
+        bootModels({ User, Post, City });
+
+        const user = requireBootedModel('User');
+        const post = requireBootedModel('Post');
+        const city = requireBootedModel<typeof City>('City');
+
+        expect(user).toBe(User);
+        expect(post).toBe(Post);
+        expect(city).toBe(City);
+
+        tt<
+            Expect<Equals<typeof user, typeof User>> |
+            Expect<Equals<typeof post, ModelConstructor>> |
+            Expect<Equals<typeof city, typeof City>> |
+            true
+        >();
+    });
+
+});

src/models/index.ts

@@ -34,8 +34,12 @@ export type { TimestampFieldValue, TimestampsDefinition } from './timestamps';
 
 const bootedModels: Map<string, typeof Model> = new Map;
 
-export function requireBootedModel<T extends ModelConstructor<Model> = ModelConstructor<Model>>(name: string): T {
-    return bootedModels.get(name) as T
+export interface ModelsRegistry {}
+
+export function requireBootedModel<T extends keyof ModelsRegistry>(name: T): ModelsRegistry[T];
+export function requireBootedModel<T extends ModelConstructor<Model> = ModelConstructor<Model>>(name: string): T;
+export function requireBootedModel(name: string): typeof Model {
+    return bootedModels.get(name)
         ?? fail(SoukaiError, `Could not find Model with name '${name}', are you sure it's booted?`);
 }