@karmaniverous/entity-manager 6.4.6 → 6.4.7

package/dist/cjs/{ShardQueryMapBuilder.js → BaseShardQueryMapBuilder.js}

@@ -5,10 +5,10 @@
  *
  * @category Query
  */
-class ShardQueryMapBuilder {
+class BaseShardQueryMapBuilder {
     constructor(options) {
         this.options = options;
     }
 }
 
-exports.ShardQueryMapBuilder = ShardQueryMapBuilder;
+exports.BaseShardQueryMapBuilder = BaseShardQueryMapBuilder;

package/dist/cjs/index.js

@@ -1,11 +1,11 @@
 'use strict';
 
+var BaseShardQueryMapBuilder = require('./BaseShardQueryMapBuilder.js');
 var conditionalize = require('./conditionalize.js');
 var EntityManager = require('./EntityManager.js');
-var ShardQueryMapBuilder = require('./ShardQueryMapBuilder.js');
 
 
 
+exports.BaseShardQueryMapBuilder = BaseShardQueryMapBuilder.BaseShardQueryMapBuilder;
 exports.conditionalize = conditionalize.conditionalize;
 exports.EntityManager = EntityManager.EntityManager;
-exports.ShardQueryMapBuilder = ShardQueryMapBuilder.ShardQueryMapBuilder;

package/dist/index.d.ts

@@ -2,6 +2,66 @@ import { Entity, Exactify, TranscodeMap, PropertiesOfType, TranscodablePropertie
 export { DefaultTranscodeMap, Entity, Exactify, PartialTranscodable, PropertiesNotOfType, PropertiesOfType, SortOrder, TranscodableProperties, TranscodeMap, Transcodes, defaultTranscodes } from '@karmaniverous/entity-tools';
 import { z } from 'zod';
 
+/**
+ * {@link BaseShardQueryMapBuilder | `BaseShardQueryMapBuilder`} options.
+ *
+ * @category Query
+ */
+interface BaseShardQueryMapBuilderOptions {
+    /** `entityManager.config.entities` key. */
+    entityToken: string;
+    /** Either the designated entity hash key or a generated property with `sharded === true`. */
+    hashKeyToken: string;
+    /** Dehydrated page key from the previous query data page. */
+    pageKey?: string;
+}
+
+/**
+ * A result returned by a {@link ShardQueryFunction | `ShardQueryFunction`} querying an individual shard.
+ *
+ * @typeParam Item - The {@link Item | `Item`} type being queried.
+
+* @category Query
+ */
+interface ShardQueryResult<Item extends Entity> {
+    /** The number of records returned. */
+    count: number;
+    /** The returned records. */
+    items: Item[];
+    /** The page key for the next query on this shard. */
+    pageKey?: Partial<Item>;
+}
+
+/**
+ * A query function that returns a single page of results from an individual
+ * shard. This function will typically be composed dynamically to express a
+ * specific query index & logic. The arguments to this function will be
+ * provided by the {@link EntityManager.query | `EntityManager.query`} method, which assembles many returned
+ * pages queried across multiple shards into a single query result.
+ *
+ * @typeParam Item - The {@link Item | `Item`} type being queried.
+
+ * @param hashKey - The hash key value of the shard being queried.
+ * @param pageKey - The page key returned by the previous query on this shard.
+ * @param pageSize - The maximum number of items to return from this query.
+ *
+ * @category Query
+ */
+type ShardQueryFunction<Item extends Entity> = (hashKey: string, pageKey?: Partial<Item>, pageSize?: number) => Promise<ShardQueryResult<Item>>;
+
+type ShardQueryMap<Item extends Entity> = Record<string, ShardQueryFunction<Item>>;
+
+/**
+ * Entity Manager shard query builder base class.
+ *
+ * @category Query
+ */
+declare abstract class BaseShardQueryMapBuilder<Item extends Entity, Options extends BaseShardQueryMapBuilderOptions> {
+    readonly options: Options;
+    constructor(options: Options);
+    abstract getShardQueryMap(): ShardQueryMap<Item>;
+}
+
 /**
  * Transforms a function such that it only executes when `condition` is truthy.
  *
@@ -629,41 +689,6 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
  */
 type ParsedConfig = z.infer<typeof configSchema>;
 
-/**
- * A result returned by a {@link ShardQueryFunction | `ShardQueryFunction`} querying an individual shard.
- *
- * @typeParam Item - The {@link Item | `Item`} type being queried.
-
-* @category Query
- */
-interface ShardQueryResult<Item extends Entity> {
-    /** The number of records returned. */
-    count: number;
-    /** The returned records. */
-    items: Item[];
-    /** The page key for the next query on this shard. */
-    pageKey?: Partial<Item>;
-}
-
-/**
- * A query function that returns a single page of results from an individual
- * shard. This function will typically be composed dynamically to express a
- * specific query index & logic. The arguments to this function will be
- * provided by the {@link EntityManager.query | `EntityManager.query`} method, which assembles many returned
- * pages queried across multiple shards into a single query result.
- *
- * @typeParam Item - The {@link Item | `Item`} type being queried.
-
- * @param hashKey - The hash key value of the shard being queried.
- * @param pageKey - The page key returned by the previous query on this shard.
- * @param pageSize - The maximum number of items to return from this query.
- *
- * @category Query
- */
-type ShardQueryFunction<Item extends Entity> = (hashKey: string, pageKey?: Partial<Item>, pageSize?: number) => Promise<ShardQueryResult<Item>>;
-
-type ShardQueryMap<Item extends Entity> = Record<string, ShardQueryFunction<Item>>;
-
 /**
  * Options passed to the {@link EntityManager.query | `EntityManager.query`} method.
  *
@@ -858,31 +883,6 @@ interface LoggerOptions {
     logInternals?: boolean;
 }
 
-/**
- * {@link ShardQueryMapBuilder | `ShardQueryMapBuilder`} options.
- *
- * @category Query
- */
-interface ShardQueryMapBuilderOptions {
-    /** `entityManager.config.entities` key. */
-    entityToken: string;
-    /** Either the designated entity hash key or a generated property with `sharded === true`. */
-    hashKeyToken: string;
-    /** Dehydrated page key from the previous query data page. */
-    pageKey?: string;
-}
-
-/**
- * Entity Manager shard query builder base class.
- *
- * @category Query
- */
-declare abstract class ShardQueryMapBuilder<Item extends Entity, Options extends ShardQueryMapBuilderOptions> {
-    readonly options: Options;
-    constructor(options: Options);
-    abstract getShardQueryMap(): ShardQueryMap<Item>;
-}
-
 /**
  * Returns an object type with specific properties rendered required and non-nullable.
  *
@@ -893,4 +893,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, 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 { BaseShardQueryMapBuilder, type BaseShardQueryMapBuilderOptions, type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigKeys, type ConfigTranscodes, EntityManager, type EntityMap, type ExclusiveKey, type ItemMap, type Logger, type LoggerEndpoint, type LoggerOptions, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryMap, type ShardQueryResult, type Unwrap, type WithRequiredAndNonNullable, conditionalize };

package/dist/mjs/{ShardQueryMapBuilder.js → BaseShardQueryMapBuilder.js}

@@ -3,10 +3,10 @@
  *
  * @category Query
  */
-class ShardQueryMapBuilder {
+class BaseShardQueryMapBuilder {
     constructor(options) {
         this.options = options;
     }
 }
 
-export { ShardQueryMapBuilder };
+export { BaseShardQueryMapBuilder };

package/dist/mjs/index.js

@@ -1,3 +1,3 @@
+export { BaseShardQueryMapBuilder } from './BaseShardQueryMapBuilder.js';
 export { conditionalize } from './conditionalize.js';
 export { EntityManager } from './EntityManager.js';
-export { ShardQueryMapBuilder } from './ShardQueryMapBuilder.js';

package/package.json

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