joist-orm 1.210.0 → 1.211.0

package/build/typeMap.d.ts

@@ -0,0 +1,66 @@
+import { Entity } from "./Entity";
+import { EntityManager } from "./EntityManager";
+/**
+ * Provides a container for entities to attach their application-specific types.
+ *
+ * Downstream applications inject their types into this map, so we can look them up
+ * via types like `OptsOf<Author>` or `FilterOf<Author>`, by including a `declare module`
+ * snippet in each entity's `...Codegen` file.
+ *
+ * ```ts
+ * declare module "joist-orm" {
+ *   interface TypeMap {
+ *     Author: { optsType: AuthorOpts; fieldsType: AuthorFields; filterType: AuthorFilter };
+ *   }
+ * }
+ * ```
+ *
+ * Inspired by Tanstack Router, which uses a similar `declare module` approach.
+ */
+export interface TypeMap {
+}
+/**
+ * Returns a key like `"Author"` or `"SmallPublisher"` for looking up types in the `TypeMap`.
+ *
+ * This is currently hard-coded to look for two levels of inheritance: we probe for the subtype
+ * key (1) first, and then fallback on the base type key (0) that all entities will have.
+ */
+type TypeMapKey<T> = T extends {
+    __type: {
+        1: infer K;
+    };
+} ? K : T extends {
+    __type: {
+        0: infer K;
+    };
+} ? K : never;
+/** A helper type to look up `U` in the `TypeMap` for a given entity type `T`. */
+export type TypeMapEntry<T, U extends string> = TypeMapKey<T> extends infer K ? (K extends keyof TypeMap ? TypeMap[K][U] : unknown) : unknown;
+/** Return the `FooOpts` type for the given `Foo` entity. */
+export type OptsOf<T> = TypeMapEntry<T, "optsType">;
+/** Return the `FooFields` type for the given `Foo` entity. */
+export type FieldsOf<T> = TypeMapEntry<T, "fieldsType">;
+export type OptIdsOf<T> = TypeMapEntry<T, "optIdsType">;
+/** Pulls the entity query type out of a given entity type T. */
+export type FilterOf<T> = TypeMapEntry<T, "filterType">;
+/** Pulls the entity GraphQL query type out of a given entity type T. */
+export type GraphQLFilterOf<T> = TypeMapEntry<T, "gqlFilterType">;
+/** Pulls the entity order type out of a given entity type T. */
+export type OrderOf<T> = TypeMapEntry<T, "orderType">;
+/**
+ * Returns the opts of the entity's `newEntity` factory method, as exists in the actual file.
+ *
+ * This is because `FactoryOpts` is a set of defaults, but the user can customize it if they want.
+ */
+export type ActualFactoryOpts<T> = TypeMapEntry<T, "factoryOptsType">;
+/** Return the `Foo` type for a given `Foo` entity constructor. */
+export type EntityOf<C> = C extends new (em: EntityManager, opts: any) => infer T ? T : never;
+type RelationsKeysOf<T> = {
+    [K in keyof OptsOf<T>]: OptsOf<T>[K] extends Entity[] | undefined ? K : never;
+}[keyof OptsOf<T>];
+/** Return the Relation keys from `FooOpt` type, given a `Foo` entity */
+export type RelationsOf<T extends Entity> = {
+    [K in RelationsKeysOf<T>]: NonNullable<OptsOf<T>[K]>;
+};
+export {};
+//# sourceMappingURL=typeMap.d.ts.map

package/build/typeMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeMap.d.ts","sourceRoot":"","sources":["../src/typeMap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,OAAO;CAAG;AAE3B;;;;;GAKG;AACH,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,CAAC,SAAS;IAAE,MAAM,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAEjH,iFAAiF;AACjF,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,IAC1C,UAAU,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,GAAG,OAAO,CAAC;AAEhG,4DAA4D;AAC5D,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;AAEpD,8DAA8D;AAC9D,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;AAExD,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;AAExD,gEAAgE;AAChE,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;AAExD,wEAAwE;AACxE,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;AAElE,gEAAgE;AAChE,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;AAEtD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;AAEtE,kEAAkE;AAClE,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,GAAG,KAAK,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAE9F,KAAK,eAAe,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,SAAS,GAAG,CAAC,GAAG,KAAK;CAC9E,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAEnB,wEAAwE;AACxE,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,IAAI;KACzC,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACrD,CAAC"}

package/build/typeMap.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=typeMap.js.map

package/build/typeMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeMap.js","sourceRoot":"","sources":["../src/typeMap.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joist-orm",
-  "version": "1.210.0",
+  "version": "1.211.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -22,7 +22,7 @@
     "@types/object-hash": "^3.0.6",
     "ansis": "^3.3.2",
     "dataloader": "^2.2.2",
-    "joist-utils": "1.210.0",
+    "joist-utils": "1.211.0",
     "knex": "^3.1.0",
     "object-hash": "^3.0.0",
     "pg": "^8.13.0",
@@ -39,6 +39,6 @@
     "temporal-polyfill": "^0.2.5",
     "ts-node-dev": "^2.0.0",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "5.5.4"
+    "typescript": "5.6.3"
   }
 }