electrodb 3.5.3 → 3.6.0

package/index.d.ts

@@ -258,8 +258,8 @@ export interface CollectionWhereOperations {
 export type CollectionWhereCallback<
   E extends { [name: string]: Entity<any, any, any, any> },
   I extends Partial<AllEntityAttributes<E>>,
-> = <W extends { [A in keyof I]: WhereAttributeSymbol<I[A]> }>(
-  attributes: W,
+> = (
+  attributes: { [A in keyof I]: WhereAttributeSymbol<I[A]> },
   operations: CollectionWhereOperations,
 ) => string;
 
@@ -270,8 +270,20 @@ export type CollectionWhereClause<
   C extends string,
   S extends Schema<A, F, C>,
   I extends Partial<AllEntityAttributes<E>>,
+  Collections extends CollectionAssociations<E>,
+  Collection extends keyof Collections,
   T,
-> = (where: CollectionWhereCallback<E, I>) => T;
+> = (
+  where: Pick<
+    I,
+    CollectionProjectedAttributeNames<E, Collections, Collection>
+  > extends Partial<AllEntityAttributes<E>>
+    ? CollectionWhereCallback<
+        E,
+        Pick<I, CollectionProjectedAttributeNames<E, Collections, Collection>>
+      >
+    : never,
+) => T;
 
 export interface ServiceWhereRecordsActionOptions<
   E extends { [name: string]: Entity<any, any, any, any> },
@@ -280,10 +292,11 @@ export interface ServiceWhereRecordsActionOptions<
   C extends string,
   S extends Schema<A, F, C>,
   I extends Partial<AllEntityAttributes<E>>,
-  Items,
+  Collections extends CollectionAssociations<E>,
+  Collection extends keyof Collections,
   IndexCompositeAttributes,
 > {
-  go: ServiceQueryRecordsGo<Items>;
+  go: ServiceQueryRecordsGo<E, Collections, Collection, keyof I>;
   params: ParamRecord;
   where: CollectionWhereClause<
     E,
@@ -292,6 +305,8 @@ export interface ServiceWhereRecordsActionOptions<
     C,
     S,
     I,
+    Collections,
+    Collection,
     ServiceWhereRecordsActionOptions<
       E,
       A,
@@ -299,7 +314,8 @@ export interface ServiceWhereRecordsActionOptions<
       C,
       S,
       I,
-      Items,
+      Collections,
+      Collection,
       IndexCompositeAttributes
     >
   >;
@@ -574,32 +590,144 @@ export type CollectionQueries<
             >[0]
           >,
         ) => {
-          go: ServiceQueryRecordsGo<{
-            [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
-              ? E[EntityResultName] extends Entity<
-                  infer A,
-                  infer F,
-                  infer C,
-                  infer S
-                >
-                ? ResponseItem<A, F, C, S>[]
-                : never
-              : never;
-          }>;
+          go: ServiceQueryRecordsGo<
+            E,
+            Collections,
+            Collection,
+            keyof Pick<
+              AllEntityAttributes<E>,
+              Extract<
+                AllEntityAttributeNames<E>,
+                CollectionAttributes<E, Collections>[Collection]
+              >
+            >
+          >;
           params: ParamRecord;
           where: {
             [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
-              ? E[EntityResultName] extends Entity<
-                  infer A,
-                  infer F,
-                  infer C,
-                  infer S
+              ? E[EntityResultName] extends Entity<any, any, any, any>
+                ? E[EntityResultName]["schema"] extends Schema<
+                    infer A,
+                    infer F,
+                    infer C
+                  >
+                  ? Collection extends keyof EntityCollections<
+                      A,
+                      F,
+                      C,
+                      E[EntityResultName]["schema"]
+                    >
+                    ? Pick<
+                        AllEntityAttributes<E>,
+                        Extract<
+                          AllEntityAttributeNames<E>,
+                          CollectionAttributes<E, Collections>[Collection]
+                        >
+                      > extends Partial<AllEntityAttributes<E>>
+                      ? CollectionWhereClause<
+                          E,
+                          A,
+                          F,
+                          C,
+                          E[EntityResultName]["schema"],
+                          Pick<
+                            AllEntityAttributes<E>,
+                            Extract<
+                              AllEntityAttributeNames<E>,
+                              CollectionAttributes<E, Collections>[Collection]
+                            >
+                          >,
+                          Collections,
+                          Collection,
+                          ServiceWhereRecordsActionOptions<
+                            E,
+                            A,
+                            F,
+                            C,
+                            E[EntityResultName]["schema"],
+                            Pick<
+                              AllEntityAttributes<E>,
+                              Extract<
+                                AllEntityAttributeNames<E>,
+                                CollectionAttributes<E, Collections>[Collection]
+                              >
+                            >,
+                            Collections,
+                            Collection,
+                            Partial<
+                              Spread<
+                                Collection extends keyof CollectionPageAttributes<
+                                  E,
+                                  Collections
+                                >
+                                  ? CollectionPageAttributes<
+                                      E,
+                                      Collections
+                                    >[Collection]
+                                  : {},
+                                Collection extends keyof CollectionIndexAttributes<
+                                  E,
+                                  Collections
+                                >
+                                  ? CollectionIndexAttributes<
+                                      E,
+                                      Collections
+                                    >[Collection]
+                                  : {}
+                              >
+                            >
+                          >
+                        >
+                      : never
+                    : never
+                  : never
+                : never
+              : never;
+          }[Collections[Collection]];
+        }
+      : never;
+  }[keyof E];
+};
+
+type ClusteredCollectionOperations<
+  E extends { [name: string]: Entity<any, any, any, any> },
+  Collections extends ClusteredCollectionAssociations<E>,
+  Collection extends keyof Collections,
+  EntityName extends keyof E,
+> = EntityName extends Collections[Collection]
+  ? {
+      go: ServiceQueryRecordsGo<
+        E,
+        Collections,
+        Collection,
+        keyof Pick<
+          AllEntityAttributes<E>,
+          Extract<
+            AllEntityAttributeNames<E>,
+            ClusteredCollectionAttributes<E, Collections>[Collection]
+          >
+        >
+      >;
+      params: ParamRecord;
+      where: {
+        [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
+          ? E[EntityResultName] extends Entity<any, any, any, any>
+            ? E[EntityResultName]["schema"] extends Schema<
+                infer A,
+                infer F,
+                infer C
+              >
+              ? Collection extends keyof ClusteredEntityCollections<
+                  A,
+                  F,
+                  C,
+                  E[EntityResultName]["schema"]
                 >
                 ? Pick<
                     AllEntityAttributes<E>,
                     Extract<
                       AllEntityAttributeNames<E>,
-                      CollectionAttributes<E, Collections>[Collection]
+                      ClusteredCollectionAttributes<E, Collections>[Collection]
                     >
                   > extends Partial<AllEntityAttributes<E>>
                   ? CollectionWhereClause<
@@ -607,55 +735,53 @@ export type CollectionQueries<
                       A,
                       F,
                       C,
-                      S,
+                      E[EntityResultName]["schema"],
                       Pick<
                         AllEntityAttributes<E>,
                         Extract<
                           AllEntityAttributeNames<E>,
-                          CollectionAttributes<E, Collections>[Collection]
+                          ClusteredCollectionAttributes<
+                            E,
+                            Collections
+                          >[Collection]
                         >
                       >,
+                      Collections,
+                      Collection,
                       ServiceWhereRecordsActionOptions<
                         E,
                         A,
                         F,
                         C,
-                        S,
+                        E[EntityResultName]["schema"],
                         Pick<
                           AllEntityAttributes<E>,
                           Extract<
                             AllEntityAttributeNames<E>,
-                            CollectionAttributes<E, Collections>[Collection]
+                            ClusteredCollectionAttributes<
+                              E,
+                              Collections
+                            >[Collection]
                           >
                         >,
-                        {
-                          [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
-                            ? E[EntityResultName] extends Entity<
-                                infer A,
-                                infer F,
-                                infer C,
-                                infer S
-                              >
-                              ? ResponseItem<A, F, C, S>[]
-                              : never
-                            : never;
-                        },
+                        Collections,
+                        Collection,
                         Partial<
                           Spread<
-                            Collection extends keyof CollectionPageAttributes<
+                            Collection extends keyof ClusteredCollectionPageAttributes<
                               E,
                               Collections
                             >
-                              ? CollectionPageAttributes<
+                              ? ClusteredCollectionPageAttributes<
                                   E,
                                   Collections
                                 >[Collection]
                               : {},
-                            Collection extends keyof CollectionIndexAttributes<
+                            Collection extends keyof ClusteredCollectionIndexAttributes<
                               E,
                               Collections
                             >
-                              ? CollectionIndexAttributes<
+                              ? ClusteredCollectionIndexAttributes<
                                   E,
                                   Collections
                                 >[Collection]
@@ -666,113 +792,6 @@ export type CollectionQueries<
                     >
                   : never
                 : never
-              : never;
-          }[Collections[Collection]];
-        }
-      : never;
-  }[keyof E];
-};
-
-type ClusteredCollectionOperations<
-  E extends { [name: string]: Entity<any, any, any, any> },
-  Collections extends ClusteredCollectionAssociations<E>,
-  Collection extends keyof Collections,
-  EntityName extends keyof E,
-> = EntityName extends Collections[Collection]
-  ? {
-      go: ServiceQueryRecordsGo<{
-        [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
-          ? E[EntityResultName] extends Entity<
-              infer A,
-              infer F,
-              infer C,
-              infer S
-            >
-            ? ResponseItem<A, F, C, S>[]
-            : never
-          : never;
-      }>;
-      params: ParamRecord;
-      where: {
-        [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
-          ? E[EntityResultName] extends Entity<
-              infer A,
-              infer F,
-              infer C,
-              infer S
-            >
-            ? Pick<
-                AllEntityAttributes<E>,
-                Extract<
-                  AllEntityAttributeNames<E>,
-                  ClusteredCollectionAttributes<E, Collections>[Collection]
-                >
-              > extends Partial<AllEntityAttributes<E>>
-              ? CollectionWhereClause<
-                  E,
-                  A,
-                  F,
-                  C,
-                  S,
-                  Pick<
-                    AllEntityAttributes<E>,
-                    Extract<
-                      AllEntityAttributeNames<E>,
-                      ClusteredCollectionAttributes<E, Collections>[Collection]
-                    >
-                  >,
-                  ServiceWhereRecordsActionOptions<
-                    E,
-                    A,
-                    F,
-                    C,
-                    S,
-                    Pick<
-                      AllEntityAttributes<E>,
-                      Extract<
-                        AllEntityAttributeNames<E>,
-                        ClusteredCollectionAttributes<
-                          E,
-                          Collections
-                        >[Collection]
-                      >
-                    >,
-                    {
-                      [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
-                        ? E[EntityResultName] extends Entity<
-                            infer A,
-                            infer F,
-                            infer C,
-                            infer S
-                          >
-                          ? ResponseItem<A, F, C, S>[]
-                          : never
-                        : never;
-                    },
-                    Partial<
-                      Spread<
-                        Collection extends keyof ClusteredCollectionPageAttributes<
-                          E,
-                          Collections
-                        >
-                          ? ClusteredCollectionPageAttributes<
-                              E,
-                              Collections
-                            >[Collection]
-                          : {},
-                        Collection extends keyof ClusteredCollectionIndexAttributes<
-                          E,
-                          Collections
-                        >
-                          ? ClusteredCollectionIndexAttributes<
-                              E,
-                              Collections
-                            >[Collection]
-                          : {}
-                      >
-                    >
-                  >
-                >
               : never
             : never
           : never;
@@ -903,41 +922,34 @@ export type IsolatedCollectionQueries<
             >[0]
           >,
         ) => {
-          go: ServiceQueryRecordsGo<{
-            [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
-              ? E[EntityResultName] extends Entity<
-                  infer A,
-                  infer F,
-                  infer C,
-                  infer S
-                >
-                ? ResponseItem<A, F, C, S>[]
-                : never
-              : never;
-          }>;
+          go: ServiceQueryRecordsGo<
+            E,
+            Collections,
+            Collection,
+            keyof Pick<
+              AllEntityAttributes<E>,
+              Extract<
+                AllEntityAttributeNames<E>,
+                IsolatedCollectionAttributes<E, Collections>[Collection]
+              >
+            >
+          >;
           params: ParamRecord;
           where: {
             [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
-              ? E[EntityResultName] extends Entity<
-                  infer A,
-                  infer F,
-                  infer C,
-                  infer S
-                >
-                ? Pick<
-                    AllEntityAttributes<E>,
-                    Extract<
-                      AllEntityAttributeNames<E>,
-                      IsolatedCollectionAttributes<E, Collections>[Collection]
-                    >
-                  > extends Partial<AllEntityAttributes<E>>
-                  ? CollectionWhereClause<
-                      E,
+              ? E[EntityResultName] extends Entity<any, any, any, any>
+                ? E[EntityResultName]["schema"] extends Schema<
+                    infer A,
+                    infer F,
+                    infer C
+                  >
+                  ? Collection extends keyof IsolatedEntityCollections<
                       A,
                       F,
                       C,
-                      S,
-                      Pick<
+                      E[EntityResultName]["schema"]
+                    >
+                    ? Pick<
                         AllEntityAttributes<E>,
                         Extract<
                           AllEntityAttributeNames<E>,
@@ -946,59 +958,69 @@ export type IsolatedCollectionQueries<
                             Collections
                           >[Collection]
                         >
-                      >,
-                      ServiceWhereRecordsActionOptions<
-                        E,
-                        A,
-                        F,
-                        C,
-                        S,
-                        Pick<
-                          AllEntityAttributes<E>,
-                          Extract<
-                            AllEntityAttributeNames<E>,
-                            IsolatedCollectionAttributes<
-                              E,
-                              Collections
-                            >[Collection]
-                          >
-                        >,
-                        {
-                          [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
-                            ? E[EntityResultName] extends Entity<
-                                infer A,
-                                infer F,
-                                infer C,
-                                infer S
-                              >
-                              ? ResponseItem<A, F, C, S>[]
-                              : never
-                            : never;
-                        },
-                        Partial<
-                          Spread<
-                            Collection extends keyof IsolatedCollectionPageAttributes<
-                              E,
-                              Collections
+                      > extends Partial<AllEntityAttributes<E>>
+                      ? CollectionWhereClause<
+                          E,
+                          A,
+                          F,
+                          C,
+                          E[EntityResultName]["schema"],
+                          Pick<
+                            AllEntityAttributes<E>,
+                            Extract<
+                              AllEntityAttributeNames<E>,
+                              IsolatedCollectionAttributes<
+                                E,
+                                Collections
+                              >[Collection]
                             >
-                              ? IsolatedCollectionPageAttributes<
+                          >,
+                          Collections,
+                          Collection,
+                          ServiceWhereRecordsActionOptions<
+                            E,
+                            A,
+                            F,
+                            C,
+                            E[EntityResultName]["schema"],
+                            Pick<
+                              AllEntityAttributes<E>,
+                              Extract<
+                                AllEntityAttributeNames<E>,
+                                IsolatedCollectionAttributes<
                                   E,
                                   Collections
                                 >[Collection]
-                              : {},
-                            Collection extends keyof IsolatedCollectionIndexAttributes<
-                              E,
-                              Collections
-                            >
-                              ? IsolatedCollectionIndexAttributes<
+                              >
+                            >,
+                            Collections,
+                            Collection,
+                            Partial<
+                              Spread<
+                                Collection extends keyof IsolatedCollectionPageAttributes<
                                   E,
                                   Collections
-                                >[Collection]
-                              : {}
+                                >
+                                  ? IsolatedCollectionPageAttributes<
+                                      E,
+                                      Collections
+                                    >[Collection]
+                                  : {},
+                                Collection extends keyof IsolatedCollectionIndexAttributes<
+                                  E,
+                                  Collections
+                                >
+                                  ? IsolatedCollectionIndexAttributes<
+                                      E,
+                                      Collections
+                                    >[Collection]
+                                  : {}
+                              >
+                            >
                           >
                         >
-                      >
-                    >
+                      : never
+                    : never
                   : never
                 : never
               : never;
@@ -1065,6 +1087,13 @@ export type ElectroEventListener = (event: ElectroEvent) => void;
 //     details: any;
 // };
 
+export declare const EntityIdentifiers: {
+  name: "__edb_e__";
+  version: "__edb_v__";
+};
+
+export declare const EntityIdentifierFields: string[];
+
 export type EntityIdentifiers<E extends Entity<any, any, any, any>> =
   E extends Entity<infer A, infer F, infer C, infer S>
     ? AllTableIndexCompositeAttributes<A, F, C, S>
@@ -1211,6 +1240,29 @@ export type CollectionResponse<
   cursor: string | null;
 };
 
+export type IndexSpecificSchema<
+  A extends string,
+  F extends string,
+  C extends string,
+  S extends Schema<A, F, C>,
+  I extends keyof S["indexes"],
+> = Omit<S, "attributes" | "indexes"> & {
+  attributes: {
+    [a in keyof S["attributes"] as a extends IndexProjectedAttributeNames<
+      A,
+      F,
+      C,
+      S,
+      I
+    >
+      ? a
+      : never]: S["attributes"][a];
+  };
+  indexes: {
+    [i in keyof S["indexes"] as i extends I ? i : never]: S["indexes"][i];
+  };
+};
+
 export interface QueryBranches<
   A extends string,
   F extends string,
@@ -1218,17 +1270,37 @@ export interface QueryBranches<
   S extends Schema<A, F, C>,
   ResponseItem,
   IndexCompositeAttributes,
+  I extends keyof S["indexes"],
 > {
-  go: GoQueryTerminal<A, F, C, S, ResponseItem>;
+  go: GoQueryTerminal<A, F, C, S, ResponseItem, I>;
   params: ParamTerminal<A, F, C, S, ResponseItem>;
-  where: WhereClause<
-    A,
-    F,
-    C,
-    S,
-    Item<A, F, C, S, S["attributes"]>,
-    QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes>
-  >;
+  where: IndexSpecificSchema<A, F, C, S, I> extends Schema<
+    infer A2,
+    infer F2,
+    infer C2
+  >
+    ? WhereClause<
+        A2,
+        F2,
+        C2,
+        IndexSpecificSchema<A, F, C, S, I>,
+        Item<
+          A2,
+          F2,
+          C2,
+          IndexSpecificSchema<A, F, C, S, I>,
+          IndexSpecificSchema<A, F, C, S, I>["attributes"]
+        >,
+        QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes, I>
+      >
+    : WhereClause<
+        A,
+        F,
+        C,
+        S,
+        Item<A, F, C, S, S["attributes"]>,
+        QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes, I>
+      >;
 }
 
 export interface RecordsActionOptions<
@@ -1239,7 +1311,7 @@ export interface RecordsActionOptions<
   ResponseItem,
   IndexCompositeAttributes,
 > {
-  go: QueryRecordsGo<ResponseItem>;
+  go: QueryRecordsGo<ResponseItem, S>;
   params: ParamRecord;
   where: WhereClause<
     A,
@@ -1299,7 +1371,7 @@ type GoGetTerminalTransaction<
   Params,
 > = <Options extends TransactGetQueryOptions<keyof ResponseItem>>(
   options?: Options,
-) => Options extends GoQueryTerminalOptions<infer Attr>
+) => Options extends GoQueryTerminalOptions<infer Attr, S>
   ? CommittedTransactionResult<
       {
         [Name in keyof ResponseItem as Name extends Attr
@@ -2300,27 +2372,28 @@ interface QueryOperations<
   CompositeAttributes,
   ResponseItem,
   IndexCompositeAttributes,
+  I extends keyof S["indexes"],
 > {
   between: (
     skCompositeAttributesStart: CompositeAttributes,
     skCompositeAttributesEnd: CompositeAttributes,
-  ) => QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes>;
+  ) => QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes, I>;
   gt: (
     skCompositeAttributes: CompositeAttributes,
-  ) => QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes>;
+  ) => QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes, I>;
   gte: (
     skCompositeAttributes: CompositeAttributes,
-  ) => QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes>;
+  ) => QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes, I>;
   lt: (
     skCompositeAttributes: CompositeAttributes,
-  ) => QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes>;
+  ) => QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes, I>;
   lte: (
     skCompositeAttributes: CompositeAttributes,
-  ) => QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes>;
+  ) => QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes, I>;
   begins: (
     skCompositeAttributes: CompositeAttributes,
-  ) => QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes>;
-  go: GoQueryTerminal<A, F, C, S, ResponseItem>;
+  ) => QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes, I>;
+  go: GoQueryTerminal<A, F, C, S, ResponseItem, I>;
   params: ParamTerminal<A, F, C, S, ResponseItem>;
   where: WhereClause<
     A,
@@ -2328,7 +2401,7 @@ interface QueryOperations<
     C,
     S,
     Item<A, F, C, S, S["attributes"]>,
-    QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes>
+    QueryBranches<A, F, C, S, ResponseItem, IndexCompositeAttributes, I>
   >;
 }
 
@@ -2451,6 +2524,23 @@ export type Conversions<
   };
 };
 
+export type IndexScans<
+  A extends string,
+  F extends string,
+  C extends string,
+  S extends Schema<A, F, C>,
+> = {
+  [I in keyof S["indexes"]]: QueryBranches<
+    A,
+    F,
+    C,
+    S,
+    ResponseItem<A, F, C, S>,
+    AllTableIndexCompositeAttributes<A, F, C, S>,
+    I
+  >;
+};
+
 export type Queries<
   A extends string,
   F extends string,
@@ -2471,7 +2561,8 @@ export type Queries<
           S,
           ResponseItem<A, F, C, S>,
           AllTableIndexCompositeAttributes<A, F, C, S> &
-            Required<CompositeAttributes>
+            Required<CompositeAttributes>,
+          I
         >
       : // If there is no SK, dont show query operations (When no PK is specified)
       S["indexes"][I] extends IndexWithSortKey
@@ -2488,7 +2579,8 @@ export type Queries<
           ResponseItem<A, F, C, S>,
           AllTableIndexCompositeAttributes<A, F, C, S> &
             Required<CompositeAttributes> &
-            SK
+            SK,
+            I
         >
       : QueryBranches<
           A,
@@ -2498,7 +2590,8 @@ export type Queries<
           ResponseItem<A, F, C, S>,
           AllTableIndexCompositeAttributes<A, F, C, S> &
             Required<CompositeAttributes> &
-            SK
+            SK,
+          I
         >
     : never;
 };
@@ -2640,7 +2733,12 @@ export type QueryExecutionComparisonParts = {
   compare?: "v2"
 }
 
-type ServiceQueryGoTerminalOptions = {
+type ServiceQueryGoTerminalOptions<
+  E extends { [entity: string]: Entity<any, any, any, any> },
+  Collections extends { [collection: string]: keyof E },
+  Collection extends keyof Collections,
+  Attributes,
+> = {
   cursor?: string | null;
   data?: "raw" | "includeKeys" | "attributes";
   table?: string;
@@ -2652,11 +2750,61 @@ type ServiceQueryGoTerminalOptions = {
   listeners?: Array<ElectroEventListener>;
   logger?: ElectroEventListener;
   order?: "asc" | "desc";
-  hydrate?: boolean;
   consistent?: boolean;
-} & QueryExecutionComparisonParts;
+} & QueryExecutionComparisonParts &
+  (
+    | {
+        // if should hydrate, all attributes will be available from the main table
+        hydrate: true;
+        attributes?: ReadonlyArray<Attributes>;
+      }
+    | {
+        // if should not hydrate, the only available attributes are the ones that are projected to the index
+        hydrate?: false | undefined;
+        attributes?: ReadonlyArray<
+          {
+            [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
+              ? E[EntityResultName] extends Entity<any, any, any, any>
+                ? E[EntityResultName]["schema"] extends Schema<
+                    infer A,
+                    infer F,
+                    infer C
+                  >
+                  ? Collection extends keyof EntityCollections<
+                      A,
+                      F,
+                      C,
+                      E[EntityResultName]["schema"]
+                    >
+                    ? Extract<
+                        IndexProjectedAttributeNames<
+                          A,
+                          F,
+                          C,
+                          E[EntityResultName]["schema"],
+                          EntityCollections<
+                            A,
+                            F,
+                            C,
+                            E[EntityResultName]["schema"]
+                          >[Collection]
+                        >,
+                        Attributes
+                      >
+                    : never
+                  : never
+                : never
+              : never;
+          }[Collections[Collection]]
+        >;
+      }
+  );
 
-type GoQueryTerminalOptions<Attributes> = {
+type GoQueryTerminalOptions<
+  Attributes,
+  S extends Schema<any, any, any>,
+  I extends keyof S["indexes"] | undefined = undefined,
+> = {
   cursor?: string | null;
   data?: "raw" | "includeKeys" | "attributes";
   table?: string;
@@ -2666,13 +2814,28 @@ type GoQueryTerminalOptions<Attributes> = {
   originalErr?: boolean;
   ignoreOwnership?: boolean;
   pages?: number | "all";
-  attributes?: ReadonlyArray<Attributes>;
   listeners?: Array<ElectroEventListener>;
   logger?: ElectroEventListener;
   order?: "asc" | "desc";
   hydrate?: boolean;
   consistent?: boolean;
-} & QueryExecutionComparisonParts;
+} & QueryExecutionComparisonParts &
+  (
+    | {
+        // if should hydrate, all attributes will be available from the main table
+        hydrate: true;
+        attributes?: ReadonlyArray<Attributes>;
+      }
+    | {
+        // if should not hydrate, the only available attributes are the ones that are projected to the index
+        hydrate?: false | undefined;
+        attributes?: S extends Schema<infer A, infer F, infer C>
+          ? ReadonlyArray<
+              Extract<IndexProjectedAttributeNames<A, F, C, S, I>, Attributes>
+            >
+          : ReadonlyArray<Attributes>;
+      }
+  );
 
 interface TransactWriteQueryOptions {
   data?: "raw" | "includeKeys" | "attributes";
@@ -2789,9 +2952,9 @@ type GoGetTerminal<
   C extends string,
   S extends Schema<A, F, C>,
   ResponseItem,
-> = <Options extends GoQueryTerminalOptions<keyof ResponseItem>>(
+> = <Options extends GoQueryTerminalOptions<keyof ResponseItem, S>>(
   options?: Options,
-) => Options extends GoQueryTerminalOptions<infer Attr>
+) => Options extends GoQueryTerminalOptions<infer Attr, S>
   ? Promise<{
       data:
         | {
@@ -2809,16 +2972,13 @@ export type GoQueryTerminal<
   C extends string,
   S extends Schema<A, F, C>,
   Item,
-> = <Options extends GoQueryTerminalOptions<keyof Item>>(
-  options?: Options,
-) => Options extends GoQueryTerminalOptions<infer Attr>
-  ? Promise<{
-      data: Array<{
-        [Name in keyof Item as Name extends Attr ? Name : never]: Item[Name];
-      }>;
-      cursor: string | null;
-    }>
-  : Promise<{ data: Array<Item>; cursor: string | null }>;
+  I extends keyof S["indexes"] | undefined = undefined,
+> = {
+  <Options extends GoQueryTerminalOptions<keyof Item, S, I>>(
+    options: Options,
+  ): Promise<IndexResponse<Options, Item, S, I>>;
+  (): Promise<IndexResponse<{}, Item, S, I>>;
+}
 
 export type EntityParseMultipleItems<
   A extends string,
@@ -2855,16 +3015,157 @@ export type ParamTerminal<
   options?: Options,
 ) => P;
 
+export type EntityCollectionResponse<
+  S extends Schema<string, string, string>,
+  ResponseItem,
+  Attr,
+  Index extends keyof S["indexes"],
+  Options extends ServiceQueryGoTerminalOptions<any, any, any, Attr>,
+> = Array<{
+  [Name in keyof ResponseItem as Name extends Attr
+    ? Options["hydrate"] extends true
+      ? Name
+      : Index extends keyof S["indexes"]
+      ? "projection" extends keyof S["indexes"][Index]
+        ? S["indexes"][Index]["projection"] extends ReadonlyArray<infer P>
+          ? Name extends P
+            ? Name
+            : never
+          : S["indexes"][Index]["projection"] extends "keys_only"
+          ? never
+          : Name
+        : Name
+      : Name
+    : never]: ResponseItem[Name];
+}>;
+
 export type ServiceQueryRecordsGo<
-  ResponseType,
-  Options = ServiceQueryGoTerminalOptions,
-> = <T = ResponseType>(
-  options?: Options,
-) => Promise<{ data: T; cursor: string | null }>;
+  E extends { [name: string]: Entity<any, any, any, any> },
+  Collections extends CollectionAssociations<E>,
+  Collection extends keyof Collections,
+  Attributes,
+> = {
+  <
+    Options extends ServiceQueryGoTerminalOptions<
+      E,
+      Collections,
+      Collection,
+      Attributes
+    >,
+  >(
+    options: Options,
+  ): Promise<
+    Options extends ServiceQueryGoTerminalOptions<
+      E,
+      Collections,
+      Collection,
+      infer Attr
+    >
+      ? {
+          data: {
+            [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
+              ? E[EntityResultName] extends Entity<
+                  infer A,
+                  infer F,
+                  infer C,
+                  infer S
+                >
+                ? Collection extends keyof EntityCollections<A, F, C, S>
+                  ? EntityCollectionResponse<
+                      S,
+                      ResponseItem<A, F, C, S>,
+                      Attr,
+                      EntityCollections<A, F, C, S>[Collection],
+                      Options
+                    >
+                  : never
+                : never
+              : never;
+          };
+          cursor: string | null;
+        }
+      : {
+          data: {
+            [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
+              ? E[EntityResultName] extends Entity<
+                  infer A,
+                  infer F,
+                  infer C,
+                  infer S
+                >
+                ? Collection extends keyof EntityCollections<A, F, C, S>
+                  ? EntityCollectionResponse<
+                      S,
+                      ResponseItem<A, F, C, S>,
+                      Attributes,
+                      EntityCollections<A, F, C, S>[Collection],
+                      {}
+                    >
+                  : never
+                : never
+              : never;
+          };
+          cursor: string | null;
+        }
+  >;
+  (): Promise<{
+    data: {
+      [EntityResultName in Collections[Collection]]: EntityResultName extends keyof E
+        ? E[EntityResultName] extends Entity<infer A, infer F, infer C, infer S>
+          ? Collection extends keyof EntityCollections<A, F, C, S>
+            ? EntityCollectionResponse<
+                S,
+                ResponseItem<A, F, C, S>,
+                Attributes,
+                EntityCollections<A, F, C, S>[Collection],
+                {}
+              >
+            : never
+          : never
+        : never;
+    };
+    cursor: string | null;
+  }>;
+};
+
+export type IndexResponse<
+  Options extends GoQueryTerminalOptions<keyof Item, S, any>,
+  Item,
+  S extends Schema<string, string, string>,
+  I extends keyof S["indexes"] | undefined = undefined,
+> = Options extends GoQueryTerminalOptions<infer Attr, S>
+  ? {
+      data: Array<{
+        [Name in keyof Item as Name extends Attr
+          ? Options["hydrate"] extends true
+            ? Name
+            : I extends keyof S["indexes"]
+            ? "projection" extends keyof S["indexes"][I]
+              ? S["indexes"][I]["projection"] extends ReadonlyArray<
+                  infer P
+                >
+                ? Name extends P
+                  ? Name
+                  : never
+                : S["indexes"][I]["projection"] extends 'keys_only'
+                  ? never
+                  : Name
+              : Name
+            : Name
+          : never]: Item[Name];
+      }>;
+      cursor: string | null;
+    }
+  : {
+      data: Array<Item>;
+      cursor: string | null;
+    };
 
-export type QueryRecordsGo<Item> = <Options extends GoQueryTerminalOptions<keyof Item>>(
+export type QueryRecordsGo<Item, S extends Schema<string, string, string>> = <
+  Options extends GoQueryTerminalOptions<keyof Item, S>,
+>(
   options?: Options,
-) => Options extends GoQueryTerminalOptions<infer Attr>
+) => Options extends GoQueryTerminalOptions<infer Attr, any>
   ? Promise<{
       data: Array<{
         [Name in keyof Item as Name extends Attr ? Name : never]: Item[Name];
@@ -3668,7 +3969,7 @@ export type KeyCastOption = "string" | "number";
 
 export type KeyCasingOption = "upper" | "lower" | "none" | "default";
 
-export interface Schema<A extends string, F extends string, C extends string> {
+export interface Schema<A extends string, F extends string, C extends string, P extends string = string> {
   readonly model: {
     readonly entity: string;
     readonly service: string;
@@ -3679,7 +3980,12 @@ export interface Schema<A extends string, F extends string, C extends string> {
   };
   readonly indexes: {
     [accessPattern: string]: {
+      /**
+       *  @deprecated use "projection" instead
+       */
       readonly project?: "keys_only";
+
+      readonly projection?: "all" | "keys_only" | ReadonlyArray<P>;
       readonly index?: string;
       readonly scope?: string;
       readonly type?: "clustered" | "isolated";
@@ -3705,6 +4011,47 @@ export interface Schema<A extends string, F extends string, C extends string> {
 
 export type Attributes<A extends string> = Record<A, Attribute>;
 
+export type IndexProjectedAttributeNames<
+  A extends string,
+  F extends string,
+  C extends string,
+  S extends Schema<A, F, C>,
+  I extends keyof S["indexes"] | undefined,
+> = I extends keyof S["indexes"]
+  ? S["indexes"][I]["projection"] extends ReadonlyArray<infer R extends A>
+    ? R
+    : S["indexes"][I]["projection"] extends "keys_only"
+      ? never
+      : A
+  : A;
+
+export type CollectionProjectedAttributeNames<
+  E extends { [entityName: string]: Entity<any, any, any, any> },
+  Collections extends CollectionAssociations<E>,
+  Collection extends keyof Collections,
+> = {
+  [EntityName in keyof E]: EntityName extends Collections[Collection]
+    ? E[EntityName] extends Entity<any, any, any, any>
+      ? E[EntityName]["schema"] extends Schema<infer A, infer F, infer C>
+        ? Collection extends keyof EntityCollections<
+            A,
+            F,
+            C,
+            E[EntityName]["schema"]
+          >
+          ? IndexProjectedAttributeNames<
+              A,
+              F,
+              C,
+              E[EntityName]["schema"],
+              EntityCollections<A, F, C, E[EntityName]["schema"]>[Collection]
+            >
+          : never
+        : never
+      : never
+    : never;
+}[keyof E];
+
 export type IndexCollections<
   A extends string,
   F extends string,
@@ -5022,7 +5369,8 @@ export class Entity<
   A extends string,
   F extends string,
   C extends string,
-  S extends Schema<A, F, C>,
+  S extends Schema<A, F, C, P>,
+  P extends string = string,
 > {
   readonly schema: S;
   private config?: EntityConfiguration;
@@ -5290,7 +5638,9 @@ export class Entity<
     S,
     ResponseItem<A, F, C, S>,
     TableIndexCompositeAttributes<A, F, C, S>
-  >;
+  > &
+    IndexScans<A, F, C, S>;
+
   query: Queries<A, F, C, S>;
 
   parse<Options extends ParseOptions<keyof ResponseItem<A, F, C, S>>>(
@@ -5738,5 +6088,6 @@ declare function createSchema<
   A extends string,
   F extends string,
   C extends string,
-  S extends Schema<A, F, C>,
+  S extends Schema<A, F, C, P>,
+  P extends string,
 >(schema: S): S;