🤖 Merge PR DefinitelyTyped#72579 [itemsjs] Rename generics and fix extends by @MysteryBlokHed

Author: MysteryBlokHed

types/itemsjs/index.d.ts

@@ -9,11 +9,11 @@ declare namespace itemsjs {
 
     type Buckets<K> = Array<Bucket<K>>;
 
-    interface SearchAggregation<I extends {}, A extends keyof I & string> {
-        name: A;
+    interface SearchAggregation<Items extends Record<string, any>, Aggregations extends keyof Items & string> {
+        name: Aggregations;
         title: string;
         position: number;
-        buckets: Buckets<I[A]>;
+        buckets: Buckets<Items[Aggregations]>;
     }
 
     interface Pagination {
@@ -23,21 +23,21 @@ declare namespace itemsjs {
     }
 
     interface SearchOptions<
-        I extends {},
-        S extends string,
-        A extends keyof I & string,
-        IdField extends keyof I & string,
+        Items extends Record<string, any>,
+        Sortings extends string,
+        Aggregations extends keyof Items & string,
+        IdField extends keyof Items & string,
     > {
         query?: string | undefined;
         /** @default 1 */
         page?: number | undefined;
         /** @default 12 */
         per_page?: number | undefined;
         /** The name of a sort defined in the configuration's sortings, or a new custom one */
-        sort?: S | Sorting<I> | undefined;
-        filters?: Partial<Record<A, string[]>> | undefined;
+        sort?: Sortings | Sorting<Items> | undefined;
+        filters?: Partial<Record<Aggregations, string[]>> | undefined;
         /** A custom function to filter values */
-        filter?: ((item: I) => boolean) | undefined;
+        filter?: ((item: Items) => boolean) | undefined;
         /** @default false */
         isExactSearch?: boolean | undefined;
         /** @default false */
@@ -46,11 +46,11 @@ declare namespace itemsjs {
         is_all_filtered_items?: boolean | undefined;
 
         /** Restricts results to items whose values match the ID field (`id` by default or as defined in `custom_id_field`). */
-        ids?: I[IdField][];
+        ids?: Items[IdField][];
     }
 
-    interface AggregationOptions<A extends string> {
-        name: A;
+    interface AggregationOptions<Aggregations extends string> {
+        name: Aggregations;
         /** @default 1 */
         page?: number | undefined;
         /** @default 10 */
@@ -59,8 +59,8 @@ declare namespace itemsjs {
         conjunction?: boolean | undefined;
     }
 
-    interface SimilarOptions<I extends {}> {
-        field: keyof I & string;
+    interface SimilarOptions<Items extends Record<string, any>> {
+        field: keyof Items & string;
         /** @default 0 */
         minimum?: number | undefined;
         /** @default 1 */
@@ -70,17 +70,17 @@ declare namespace itemsjs {
     }
 
     interface ItemsJs<
-        I extends {},
-        S extends string,
-        A extends keyof I & string,
-        IdField extends keyof I & string,
+        Items extends Record<string, any>,
+        Sortings extends string,
+        Aggregations extends keyof Items & string,
+        IdField extends keyof Items & string,
     > {
         /** Search items */
-        search(options?: SearchOptions<I, S, A, IdField>): {
+        search(options?: SearchOptions<Items, Sortings, Aggregations, IdField>): {
             data: {
-                items: I[];
-                allFilteredItems: I[] | null;
-                aggregations: Record<A, SearchAggregation<I, A>>;
+                items: Items[];
+                allFilteredItems: Items[] | null;
+                aggregations: Record<Aggregations, SearchAggregation<Items, Aggregations>>;
             };
             pagination: Pagination;
             timings: {
@@ -92,8 +92,8 @@ declare namespace itemsjs {
         };
 
         /** Get data for aggregation */
-        aggregation(options: AggregationOptions<A>): {
-            data: { buckets: Buckets<I[A]> };
+        aggregation(options: AggregationOptions<Aggregations>): {
+            data: { buckets: Buckets<Items[Aggregations]> };
             pagination: Pagination;
         };
 
@@ -102,21 +102,21 @@ declare namespace itemsjs {
          * Uses the `id` key or the one set via `custom_id_field` to check for uniqueness..
          */
         similar(
-            id: I[IdField],
-            options: SimilarOptions<I>,
+            id: Items[IdField],
+            options: SimilarOptions<Items>,
         ): {
-            data: { items: Array<I & { _id: number; intersection_length: number }> };
+            data: { items: Array<Items & { _id: number; intersection_length: number }> };
             pagination: Pagination;
         };
 
         /** Reindex with an entirely new list of items */
-        reindex(data: I[]): void;
+        reindex(data: Items[]): void;
     }
 
     type Order = "asc" | "desc";
 
-    interface Sorting<I extends {}> {
-        field: keyof I | Array<keyof I>;
+    interface Sorting<Items extends Record<string, any>> {
+        field: keyof Items | Array<keyof Items>;
         order?: Order | Order[] | undefined;
     }
 
@@ -139,15 +139,15 @@ declare namespace itemsjs {
 
     /** Configuration for itemsjs */
     interface Configuration<
-        I extends {},
-        S extends string,
-        A extends keyof I & string,
+        Items extends Record<string, any>,
+        Sortings extends string,
+        Aggregations extends keyof Items & string,
         IdField extends string = "id",
     > {
-        sortings?: Record<S, Sorting<I>> | undefined;
-        aggregations?: Record<A, Aggregation> | undefined;
+        sortings?: Record<Sortings, Sorting<Items>> | undefined;
+        aggregations?: Record<Aggregations, Aggregation> | undefined;
         /** @default [] */
-        searchableFields?: Array<keyof I> | undefined;
+        searchableFields?: Array<keyof Items> | undefined;
         /** @default true */
         native_search_enabled?: boolean | undefined;
         /** @default 'id' — defines which field represents the unique ID */
@@ -159,19 +159,19 @@ declare namespace itemsjs {
  * Main itemsjs function
  * @param items The items to index
  * @param configuration Configuration options including sortings, aggregations, and optionally a custom ID field.
- * @template I The type of items being indexed
- * @template S The keys of sortings defined in the configuration.
- * @template A The keys of aggregations defined in the configuration.
+ * @template Items The type of items being indexed
+ * @template Sortings The keys of sortings defined in the configuration.
+ * @template Aggregations The keys of aggregations defined in the configuration.
  * @template IdField The field used as the unique identifier for items (defaults to "id").
  */
 declare function itemsjs<
-    I extends Record<string, any> = Record<string, any>,
-    S extends string = string,
-    A extends keyof I & string = keyof I & string,
-    IdField extends keyof I & string = "id",
+    Items extends Record<string, any> = Record<string, unknown>,
+    Sortings extends string = string,
+    Aggregations extends keyof Items & string = keyof Items & string,
+    IdField extends keyof Items & string = "id",
 >(
-    items: I[],
-    configuration?: itemsjs.Configuration<I, S, A, IdField>,
-): itemsjs.ItemsJs<I, S, A, IdField>;
+    items: Items[],
+    configuration?: itemsjs.Configuration<Items, Sortings, Aggregations, IdField>,
+): itemsjs.ItemsJs<Items, Sortings, Aggregations, IdField>;
 
 export = itemsjs;

types/itemsjs/itemsjs-tests.ts

@@ -133,3 +133,8 @@ itemsCustomId.search({
 itemsCustomId.search({
     ids: ["a"],
 });
+
+// @ts-expect-error Can only pass objects
+itemsjs("foo");
+// @ts-expect-error Can only pass objects
+itemsjs(123);