@karmaniverous/entity-manager 6.8.0 → 6.9.0

package/README.md

@@ -8,7 +8,7 @@
 
 **EntityManager implements rational indexing & cross-shard querying at scale in your NoSQL database so you can focus on your application logic.**
 
-I've just released a full Typescript refactor. Everything works beautifully, but I'm still fleshing out [the documentation](https://karmanivero.us/projects/entity-manager/intro/).
+> The Typescript refactor is still in flux, but stabilizing! Still fleshing out the [demo](https://github.com/karmaniverous/entity-manager-demo) & [documentation](https://karmanivero.us/projects/entity-manager/intro/).
 
 If you have any questions, please [start a discussion](https://github.com/karmaniverous/entity-manager/discussions). Otherwise stay tuned!
 

package/dist/cjs/BaseQueryBuilder.js

@@ -5,6 +5,10 @@ var radash = require('radash');
 /**
  * Abstract base class supporting a fluent API for building a {@link ShardQueryMap | `ShardQueryMap`} using a database client.
  *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ * @typeParam EntityClient - {@link BaseEntityClient | `BaseEntityClient`} derived class instance.
+ * @typeParam IndexParams - Database platform-specific, index-specific query parameters.
+ *
  * @category QueryBuilder
  */
 class BaseQueryBuilder {

package/dist/cjs/EntityManager.js

@@ -11,7 +11,12 @@ var _EntityManager_config;
  * The EntityManager class applies a configuration-driven sharded data model &
  * query strategy to NoSql data.
  *
- * @category Entity Manager
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines the configuration's {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @remarks
+ * While the {@link EntityManager.query | `query`} method is `public`, normally it should not be called directly. The `query` method is used by a platform-specific {@link BaseQueryBuilder.query | `QueryBuilder.query`} method to provide a fluent query API.
+ *
+ * @category EntityManager
  */
 class EntityManager {
     /**
@@ -80,11 +85,15 @@ class EntityManager {
      *
      * Unsharded query results should sort & page as expected.
      *
+     * **Normally this method should not be called directly!** It is used by a platform-specific {@link BaseQueryBuilder.query | `QueryBuilder.query`} method to provide a fluent query API.
+     *
      * @param options - {@link QueryOptions | `QueryOptions`} object.
      *
      * @returns {@link QueryResult} object.
      *
      * @throws Error if `options` {@link QueryOptions.pageKeyMap | `pageKeyMap`} `pageKeyMap` keys do not match {@link QueryOptions.shardQueryMap | `shardQueryMap`} keys.
+     *
+     * @protected
      */
     async query(options) {
         return await query.query(this, options);

package/dist/cjs/encodeGeneratedProperty.js

@@ -21,10 +21,7 @@ function encodeGeneratedProperty(entityManager, property, item) {
         const sharded = property in entityManager.config.generatedProperties.sharded;
         const elements = entityManager.config.generatedProperties[sharded ? 'sharded' : 'unsharded'][property];
         // Map elements to [element, value] pairs.
-        const elementMap = elements.map((element) => [
-            element,
-            item[element],
-        ]);
+        const elementMap = elements.map((element) => [element, item[element]]);
         // Return undefined if sharded & atomicity requirement fails.
         if (sharded && elementMap.some(([, value]) => entityTools.isNil(value)))
             return;

package/dist/cjs/index.js

@@ -2,12 +2,10 @@
 
 var BaseEntityClient = require('./BaseEntityClient.js');
 var BaseQueryBuilder = require('./BaseQueryBuilder.js');
-var conditionalize = require('./conditionalize.js');
 var EntityManager = require('./EntityManager.js');
 
 
 
 exports.BaseEntityClient = BaseEntityClient.BaseEntityClient;
 exports.BaseQueryBuilder = BaseQueryBuilder.BaseQueryBuilder;
-exports.conditionalize = conditionalize.conditionalize;
 exports.EntityManager = EntityManager.EntityManager;

package/dist/index.d.ts

@@ -1,7 +1,12 @@
-import { EntityMap, TranscodeMap, FlattenEntityMap, Exactify, PropertiesOfType, TranscodableProperties, Transcodes, SortOrder } from '@karmaniverous/entity-tools';
+import { EntityMap, TranscodeMap, FlattenEntityMap, ConditionalProperty, Exactify, PropertiesOfType, TranscodableProperties, Transcodes, SortOrder, MutuallyExclusive, NotNever, DefaultTranscodeMap } from '@karmaniverous/entity-tools';
 import { BatchProcessOptions } from '@karmaniverous/batch-process';
 import { z } from 'zod';
 
+/**
+ * Default type parameter for {@link ConfigMap | `ConfigMap`}.
+ *
+ * @category EntityManager
+ */
 interface BaseConfigMap {
     EntityMap: EntityMap;
     HashKey: string;
@@ -43,15 +48,20 @@ declare abstract class BaseEntityClient {
 /**
  * Extracts a database-facing partial item type from a {@link BaseConfigMap | `ConfigMap`}.
  *
- * @category Entities
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category EntityManager
+ * @protected
  */
 type EntityItem<C extends BaseConfigMap> = Partial<FlattenEntityMap<C['EntityMap']> & Record<C['HashKey'] | C['RangeKey'] | C['ShardedKeys'] | C['UnshardedKeys'], string>> & Record<string, unknown>;
 
 /**
- * A result returned by a query across multiple shards, where each shard may
- * receive multiple page queries via a dynamically-generated {@link ShardQueryFunction | `ShardQueryFunction`}.
+ * A result returned by a query across multiple shards, where each shard may receive multiple page queries via a dynamically-generated {@link ShardQueryFunction | `ShardQueryFunction`}.
  *
- * @category Query
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category EntityManager
+ * @protected
  */
 interface QueryResult<C extends BaseConfigMap> {
     /** Total number of records returned across all shards. */
@@ -65,21 +75,10 @@ interface QueryResult<C extends BaseConfigMap> {
     pageKeyMap: string;
 }
 
-/**
- * Return a type with required property K of type O if C is not `never`, otherwise return a type where K is optional or accepts an empty object.
- *
- * @typeParam K - The property key.
- * @typeParam C - The condition to check.
- * @typeParam O - The type of the property.
- */
-type ConditionalProperty<K extends PropertyKey, C, O extends object> = [
-    C
-] extends [never] ? Record<K, never> | Partial<Record<K, Record<PropertyKey, never>>> : Record<K, O>;
-
 /**
  * Defines a single time period in an entity sharding strategy.
  *
- * @category Config
+ * @category EntityManager
  * @protected
  */
 interface ShardBump {
@@ -104,7 +103,14 @@ interface ShardBump {
     chars: number;
 }
 
-type Config<C extends BaseConfigMap> = ConditionalProperty<'entities', keyof Exactify<C['EntityMap']>, {
+/**
+ * Configuration object for an {@link EntityManager | `EntityManager`} instance.
+ *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines the configuration's {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category EntityManager
+ */
+type Config<C extends BaseConfigMap = BaseConfigMap> = ConditionalProperty<'entities', keyof Exactify<C['EntityMap']>, {
     [E in keyof Exactify<C['EntityMap']>]: {
         defaultLimit?: number;
         defaultPageSize?: number;
@@ -128,6 +134,14 @@ type Config<C extends BaseConfigMap> = ConditionalProperty<'entities', keyof Exa
     throttle?: number;
 };
 
+/**
+ * Extracts entity tokens from a {@link ConfigMap | `ConfigMap`}.
+ *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category EntityManager
+ * @protected
+ */
 type EntityToken<C extends BaseConfigMap> = keyof Exactify<C['EntityMap']> & string;
 
 declare const configSchema: z.ZodEffects<z.ZodObject<{
@@ -235,6 +249,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         decode: (args_0: string, ...args: unknown[]) => any;
     }>>>>;
 }, "strict", z.ZodTypeAny, {
+    hashKey: string;
+    rangeKey: string;
     throttle: number;
     entities: Record<string, {
         defaultLimit: number;
@@ -251,8 +267,6 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         sharded: Record<string, [string, ...string[]]>;
         unsharded: Record<string, [string, ...string[]]>;
     };
-    hashKey: string;
-    rangeKey: string;
     indexes: Record<string, {
         hashKey: string;
         rangeKey: string;
@@ -299,6 +313,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         decode: (args_0: string, ...args: unknown[]) => any;
     }> | undefined;
 }>, {
+    hashKey: string;
+    rangeKey: string;
     throttle: number;
     entities: Record<string, {
         defaultLimit: number;
@@ -315,8 +331,6 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         sharded: Record<string, [string, ...string[]]>;
         unsharded: Record<string, [string, ...string[]]>;
     };
-    hashKey: string;
-    rangeKey: string;
     indexes: Record<string, {
         hashKey: string;
         rangeKey: string;
@@ -366,14 +380,17 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
 /**
  * Simplified type taken on by a {@link Config | `Config`} object after parsing in the {@link EntityManager | `EntityManager`} constructor.
  *
- * @category Config
+ * @category EntityManager
  */
 type ParsedConfig = z.infer<typeof configSchema>;
 
 /**
  * A result returned by a {@link ShardQueryFunction | `ShardQueryFunction`} querying an individual shard.
  *
- * @category Query
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category EntityManager
+ * @protected
  */
 interface ShardQueryResult<C extends BaseConfigMap> {
     /** The number of records returned. */
@@ -385,28 +402,38 @@ interface ShardQueryResult<C extends BaseConfigMap> {
 }
 
 /**
- * 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.
+ * 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
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category EntityManager
+ * @protected
  */
 type ShardQueryFunction<C extends BaseConfigMap> = (hashKey: string, pageKey?: EntityItem<C>, pageSize?: number) => Promise<ShardQueryResult<C>>;
 
+/**
+ * Relates a specific index token to a {@link ShardQueryFunction | `ShardQueryFunction`} to be performed on that index.
+ *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category EntityManager
+ * @protected
+ */
 type ShardQueryMap<C extends BaseConfigMap> = Record<string, ShardQueryFunction<C>>;
 
 /**
  * Options passed to the {@link EntityManager.query | `EntityManager.query`} method.
  *
- * @category Query
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category EntityManager
+ * @protected
  */
 interface QueryOptions<C extends BaseConfigMap> {
     /** Identifies the entity to be queried. Key of {@link Config | `Config`} `entities`. */
@@ -483,9 +510,14 @@ interface QueryOptions<C extends BaseConfigMap> {
  * The EntityManager class applies a configuration-driven sharded data model &
  * query strategy to NoSql data.
  *
- * @category Entity Manager
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines the configuration's {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @remarks
+ * While the {@link EntityManager.query | `query`} method is `public`, normally it should not be called directly. The `query` method is used by a platform-specific {@link BaseQueryBuilder.query | `QueryBuilder.query`} method to provide a fluent query API.
+ *
+ * @category EntityManager
  */
-declare class EntityManager<C extends BaseConfigMap> {
+declare class EntityManager<C extends BaseConfigMap = BaseConfigMap> {
     #private;
     readonly logger: Pick<Console, 'debug' | 'error'>;
     /**
@@ -542,11 +574,15 @@ declare class EntityManager<C extends BaseConfigMap> {
      *
      * Unsharded query results should sort & page as expected.
      *
+     * **Normally this method should not be called directly!** It is used by a platform-specific {@link BaseQueryBuilder.query | `QueryBuilder.query`} method to provide a fluent query API.
+     *
      * @param options - {@link QueryOptions | `QueryOptions`} object.
      *
      * @returns {@link QueryResult} object.
      *
      * @throws Error if `options` {@link QueryOptions.pageKeyMap | `pageKeyMap`} `pageKeyMap` keys do not match {@link QueryOptions.shardQueryMap | `shardQueryMap`} keys.
+     *
+     * @protected
      */
     query(options: QueryOptions<C>): Promise<QueryResult<C>>;
 }
@@ -554,6 +590,9 @@ declare class EntityManager<C extends BaseConfigMap> {
 /**
  * Constructor options for {@link BaseQueryBuilder | `BaseQueryBuilder`}.
  *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ * @typeParam EntityClient - {@link BaseEntityClient | `BaseEntityClient`} derived class instance.
+ *
  * @category QueryBuilder
  */
 interface BaseQueryBuilderOptions<C extends BaseConfigMap, EntityClient extends BaseEntityClient> {
@@ -569,11 +608,24 @@ interface BaseQueryBuilderOptions<C extends BaseConfigMap, EntityClient extends
     pageKeyMap?: string;
 }
 
+/**
+ * Options for {@link BaseQueryBuilder.query | `query`} method on all derived classes.
+ *
+ * Same as {@link QueryOptions | `QueryOptions`} for {@link EntityManager.query | `EntityManager.query`}, excluding `entityToken`, `pageKeyMap`, and `shardQueryMap`.
+ *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category QueryBuilder
+ */
 type QueryBuilderQueryOptions<C extends BaseConfigMap> = Omit<QueryOptions<C>, 'entityToken' | 'pageKeyMap' | 'shardQueryMap'>;
 
 /**
  * Abstract base class supporting a fluent API for building a {@link ShardQueryMap | `ShardQueryMap`} using a database client.
  *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ * @typeParam EntityClient - {@link BaseEntityClient | `BaseEntityClient`} derived class instance.
+ * @typeParam IndexParams - Database platform-specific, index-specific query parameters.
+ *
  * @category QueryBuilder
  */
 declare abstract class BaseQueryBuilder<C extends BaseConfigMap, EntityClient extends BaseEntityClient, IndexParams> {
@@ -606,16 +658,54 @@ declare abstract class BaseQueryBuilder<C extends BaseConfigMap, EntityClient ex
 }
 
 /**
- * Transforms a function such that it only executes when `condition` is truthy.
+ * Validates a type derived from {@link BaseConfigMap | `BaseConfigMap`} to ensure HashKey and RangeKey are both defined and that all sets of special keys are mutually exclusive.
+ *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category EntityManager
+ * @protected
+ */
+type ValidateConfigMap<C extends BaseConfigMap> = MutuallyExclusive<[
+    C['HashKey'],
+    C['RangeKey'],
+    C['ShardedKeys'],
+    C['UnshardedKeys'],
+    keyof FlattenEntityMap<C['EntityMap']>
+]> extends true ? NotNever<C, ['HashKey' | 'RangeKey']> extends true ? C : Exclude<NotNever<C, ['HashKey' | 'RangeKey']>, true> : Exclude<MutuallyExclusive<[
+    C['HashKey'],
+    C['RangeKey'],
+    C['ShardedKeys'],
+    C['UnshardedKeys'],
+    keyof FlattenEntityMap<C['EntityMap']>
+]>, true>;
+
+/**
+ * Generates & validates the map defining defines an {@link EntityManager | `EntityManager`} configuration's {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}.
+ *
+ * Unspecified properties will default to those defined in {@link BaseConfigMap | `BaseConfigMap`}.
  *
- * @param fn - The function to conditionally execute.
- * @param condition - The condition to check before executing `fn`.
+ * @typeParam M - {@link BaseConfigMap | `BaseConfigMap`} extension. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
  *
- * @typeParam F - The type of the function to conditionally execute.
+ * @category EntityManager
+ */
+type ConfigMap<M extends Partial<BaseConfigMap> = Partial<BaseConfigMap>> = ValidateConfigMap<{
+    EntityMap: 'EntityMap' extends keyof M ? NonNullable<M['EntityMap']> : Record<string, never>;
+    HashKey: 'HashKey' extends keyof M ? NonNullable<M['HashKey']> : 'hashKey';
+    RangeKey: 'RangeKey' extends keyof M ? NonNullable<M['RangeKey']> : 'rangeKey';
+    ShardedKeys: 'ShardedKeys' extends keyof M ? NonNullable<M['ShardedKeys']> : never;
+    UnshardedKeys: 'UnshardedKeys' extends keyof M ? NonNullable<M['UnshardedKeys']> : never;
+    TranscodedProperties: 'TranscodedProperties' extends keyof M ? NonNullable<M['TranscodedProperties']> : never;
+    TranscodeMap: 'TranscodeMap' extends keyof M ? NonNullable<M['TranscodeMap']> : DefaultTranscodeMap;
+}>;
+
+/**
+ * A partial {@link EntityItem | `EntityItem`} restricted to keys defined in `C`.
  *
- * @returns The conditionalized function with the same signature as `fn`.
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
  *
+ * @category QueryBuilder
+ * @protected
  */
-declare function conditionalize<F extends (...args: Parameters<F>) => ReturnType<F>>(fn: F, condition?: unknown): (...args: Parameters<F>) => ReturnType<F> | undefined;
+type PageKey<C extends BaseConfigMap> = Pick<EntityItem<C>, C['HashKey'] | C['RangeKey'] | C['ShardedKeys'] | C['UnshardedKeys'] | C['TranscodedProperties']>;
 
-export { type BaseConfigMap, BaseEntityClient, type BaseEntityClientOptions, BaseQueryBuilder, type BaseQueryBuilderOptions, type ConditionalProperty, type Config, type EntityItem, EntityManager, type EntityToken, type ParsedConfig, type QueryBuilderQueryOptions, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryMap, type ShardQueryResult, conditionalize };
+export { type BaseConfigMap, BaseEntityClient, type BaseEntityClientOptions, BaseQueryBuilder, type BaseQueryBuilderOptions, type Config, type ConfigMap, type EntityItem, EntityManager, type EntityToken, type PageKey, type ParsedConfig, type QueryBuilderQueryOptions, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryMap, type ShardQueryResult, type ValidateConfigMap };

package/dist/mjs/BaseQueryBuilder.js

@@ -3,6 +3,10 @@ import { mapValues } from 'radash';
 /**
  * Abstract base class supporting a fluent API for building a {@link ShardQueryMap | `ShardQueryMap`} using a database client.
  *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ * @typeParam EntityClient - {@link BaseEntityClient | `BaseEntityClient`} derived class instance.
+ * @typeParam IndexParams - Database platform-specific, index-specific query parameters.
+ *
  * @category QueryBuilder
  */
 class BaseQueryBuilder {

package/dist/mjs/EntityManager.js

@@ -9,7 +9,12 @@ var _EntityManager_config;
  * The EntityManager class applies a configuration-driven sharded data model &
  * query strategy to NoSql data.
  *
- * @category Entity Manager
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines the configuration's {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @remarks
+ * While the {@link EntityManager.query | `query`} method is `public`, normally it should not be called directly. The `query` method is used by a platform-specific {@link BaseQueryBuilder.query | `QueryBuilder.query`} method to provide a fluent query API.
+ *
+ * @category EntityManager
  */
 class EntityManager {
     /**
@@ -78,11 +83,15 @@ class EntityManager {
      *
      * Unsharded query results should sort & page as expected.
      *
+     * **Normally this method should not be called directly!** It is used by a platform-specific {@link BaseQueryBuilder.query | `QueryBuilder.query`} method to provide a fluent query API.
+     *
      * @param options - {@link QueryOptions | `QueryOptions`} object.
      *
      * @returns {@link QueryResult} object.
      *
      * @throws Error if `options` {@link QueryOptions.pageKeyMap | `pageKeyMap`} `pageKeyMap` keys do not match {@link QueryOptions.shardQueryMap | `shardQueryMap`} keys.
+     *
+     * @protected
      */
     async query(options) {
         return await query(this, options);

package/dist/mjs/encodeGeneratedProperty.js

@@ -19,10 +19,7 @@ function encodeGeneratedProperty(entityManager, property, item) {
         const sharded = property in entityManager.config.generatedProperties.sharded;
         const elements = entityManager.config.generatedProperties[sharded ? 'sharded' : 'unsharded'][property];
         // Map elements to [element, value] pairs.
-        const elementMap = elements.map((element) => [
-            element,
-            item[element],
-        ]);
+        const elementMap = elements.map((element) => [element, item[element]]);
         // Return undefined if sharded & atomicity requirement fails.
         if (sharded && elementMap.some(([, value]) => isNil(value)))
             return;

package/dist/mjs/index.js

@@ -1,4 +1,3 @@
 export { BaseEntityClient } from './BaseEntityClient.js';
 export { BaseQueryBuilder } from './BaseQueryBuilder.js';
-export { conditionalize } from './conditionalize.js';
 export { EntityManager } from './EntityManager.js';

package/package.json

@@ -5,7 +5,7 @@
   },
   "dependencies": {
     "@karmaniverous/batch-process": "^0.1.0",
-    "@karmaniverous/entity-tools": "^0.5.0",
+    "@karmaniverous/entity-tools": "^0.6.1",
     "@karmaniverous/string-utilities": "^0.2.1",
     "lz-string": "^1.5.0",
     "radash": "^12.1.0",
@@ -39,7 +39,7 @@
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-tsdoc": "^0.3.0",
     "jsdom-global": "^3.0.2",
-    "knip": "^5.36.3",
+    "knip": "^5.36.5",
     "lefthook": "^1.8.2",
     "mocha": "^10.8.2",
     "nyc": "^17.1.0",
@@ -132,5 +132,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "6.8.0"
+  "version": "6.9.0"
 }

package/dist/cjs/conditionalize.js

@@ -1,25 +0,0 @@
-'use strict';
-
-/**
- * Transforms a function such that it only executes when `condition` is truthy.
- *
- * @param fn - The function to conditionally execute.
- * @param condition - The condition to check before executing `fn`.
- *
- * @typeParam F - The type of the function to conditionally execute.
- *
- * @returns The conditionalized function with the same signature as `fn`.
- *
- */
-function conditionalize(fn, condition) {
-    return (...args) => {
-        if (condition) {
-            return fn(...args);
-        }
-        else {
-            return undefined;
-        }
-    };
-}
-
-exports.conditionalize = conditionalize;

package/dist/mjs/conditionalize.js

@@ -1,23 +0,0 @@
-/**
- * Transforms a function such that it only executes when `condition` is truthy.
- *
- * @param fn - The function to conditionally execute.
- * @param condition - The condition to check before executing `fn`.
- *
- * @typeParam F - The type of the function to conditionally execute.
- *
- * @returns The conditionalized function with the same signature as `fn`.
- *
- */
-function conditionalize(fn, condition) {
-    return (...args) => {
-        if (condition) {
-            return fn(...args);
-        }
-        else {
-            return undefined;
-        }
-    };
-}
-
-export { conditionalize };