@karmaniverous/entity-manager 6.4.1 → 6.4.3

package/dist/index.d.ts

@@ -645,6 +645,11 @@ interface ShardQueryResult<Item extends ItemMap<M, HashKey, RangeKey>[EntityToke
     /** The page key for the next query on this shard. */
     pageKey?: PartialTranscodable<Item, T>;
 }
+interface ClientShardQueryResult {
+    count: number;
+    items: Entity[];
+    pageKey?: Entity;
+}
 
 /**
  * A query function that returns a single page of results from an individual
@@ -663,8 +668,10 @@ interface ShardQueryResult<Item extends ItemMap<M, HashKey, RangeKey>[EntityToke
  * @category Query
  */
 type ShardQueryFunction<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string = 'hashKey', RangeKey extends string = 'rangeKey', T extends TranscodeMap = DefaultTranscodeMap> = (hashKey: string, pageKey?: PartialTranscodable<Item, T>, pageSize?: number) => Promise<ShardQueryResult<Item, EntityToken, M, HashKey, RangeKey, T>>;
+type ClientShardQueryFunction = (hashKey: string, pageKey?: Entity, pageSize?: number) => Promise<ClientShardQueryResult>;
 
 type ShardQueryMap<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string, RangeKey extends string, T extends TranscodeMap> = Record<string, ShardQueryFunction<Item, EntityToken, M, HashKey, RangeKey, T>>;
+type ClientShardQueryMap = Record<string, ClientShardQueryFunction>;
 
 /**
  * Options passed to the {@link EntityManager.query | `EntityManager.query`} method.
@@ -917,15 +924,13 @@ declare abstract class EntityManagerClient<Options extends EntityManagerClientOp
  *
  * @category Query
  */
-interface ShardQueryMapBuilderOptions<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string, RangeKey extends string, T extends TranscodeMap> {
-    /** {@link EntityManager | `EntityManager`} instance. */
-    entityManager: EntityManager<M, HashKey, RangeKey, T>;
+interface ShardQueryMapBuilderOptions {
     /** `entityManager.config.entities` key. */
-    entityToken: EntityToken;
+    entityToken: string;
     /** Either the designated entity hash key or a generated property with `sharded === true`. */
-    hashKeyToken: HashKey | (PropertiesOfType<M[EntityToken], void> & string);
+    hashKeyToken: string;
     /** A partial `Item` sufficiently populated to generate the query hash key & index values. */
-    item: Partial<Item>;
+    item: Entity;
     /** Dehydrated page key from the previous query data page. */
     pageKey?: string;
 }
@@ -935,10 +940,10 @@ interface ShardQueryMapBuilderOptions<Item extends ItemMap<M, HashKey, RangeKey>
  *
  * @category Query
  */
-declare abstract class ShardQueryMapBuilder<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string, RangeKey extends string, T extends TranscodeMap, Options extends ShardQueryMapBuilderOptions<Item, EntityToken, M, HashKey, RangeKey, T>> {
+declare abstract class ShardQueryMapBuilder<Options extends ShardQueryMapBuilderOptions> {
     readonly options: Options;
     constructor(options: Options);
-    abstract getShardQueryMap(): ShardQueryMap<Item, EntityToken, M, HashKey, RangeKey, T>;
+    abstract getShardQueryMap(): ClientShardQueryMap;
 }
 
 /**
@@ -951,4 +956,4 @@ type WithRequiredAndNonNullable<T, K extends keyof T> = T & {
     [P in K]-?: NonNullable<T[P]>;
 };
 
-export { type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigKeys, type ConfigTranscodes, EntityManager, EntityManagerClient, type EntityManagerClientBatchOptions, type EntityManagerClientOptions, type EntityMap, type ExclusiveKey, type ItemMap, type Logger, type LoggerEndpoint, type LoggerOptions, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryMap, ShardQueryMapBuilder, type ShardQueryMapBuilderOptions, type ShardQueryResult, type Unwrap, type WithRequiredAndNonNullable, conditionalize };
+export { type ClientShardQueryFunction, type ClientShardQueryMap, type ClientShardQueryResult, type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigKeys, type ConfigTranscodes, EntityManager, EntityManagerClient, type EntityManagerClientBatchOptions, type EntityManagerClientOptions, type EntityMap, type ExclusiveKey, type ItemMap, type Logger, type LoggerEndpoint, type LoggerOptions, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryMap, ShardQueryMapBuilder, type ShardQueryMapBuilderOptions, type ShardQueryResult, type Unwrap, type WithRequiredAndNonNullable, conditionalize };

package/package.json

@@ -132,5 +132,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "6.4.1"
+  "version": "6.4.3"
 }