@karmaniverous/entity-manager 6.11.2 → 6.12.0

package/dist/cjs/EntityManager.js

@@ -3,6 +3,7 @@
 var tslib = require('tslib');
 var radash = require('radash');
 var addKeys = require('./addKeys.js');
+var findIndexToken = require('./findIndexToken.js');
 var ParsedConfig = require('./ParsedConfig.js');
 var query = require('./query.js');
 var removeKeys = require('./removeKeys.js');
@@ -54,7 +55,7 @@ class EntityManager {
      * @param item - {@link EntityItem | `EntityItem`} object.
      * @param overwrite - Overwrite existing properties (default `false`).
      *
-     * @returns Shallow clone of `item` with updated properties.
+     * @returns {@link EntityRecord | `EntityRecord`} object with updated properties.
      *
      * @throws `Error` if `entityToken` is invalid.
      */
@@ -79,18 +80,29 @@ class EntityManager {
             : addKeys.addKeys(this, entityToken, item, overwrite), [this.config.hashKey, this.config.rangeKey]);
     }
     /**
-     * Strips generated properties, hash key, and range key from an {@link EntityItem | `EntityItem`} object.
+     * Strips generated properties, hash key, and range key from an {@link EntityRecord | `EntityRecord`} object.
      *
      * @param entityToken - {@link Config | `Config`} `entities` key.
-     * @param item - {@link EntityItem | `EntityItem`} object.
+     * @param item - {@link EntityRecord | `EntityRecord`} object.
      *
-     * @returns Shallow clone of `item` without generated properties, hash key or range key.
+     * @returns {@link EntityItem | `EntityItem`} with generated properties, hash key & range key removed.
      *
      * @throws `Error` if `entityToken` is invalid.
      */
     removeKeys(entityToken, item) {
         return removeKeys.removeKeys(this, entityToken, item);
     }
+    /**
+     * Find an index token in a {@link Config | `Config`} object based on the index `hashKey` and `rangeKey`.
+     *
+     * @param hashKeyToken - Index hash key.
+     * @param rangeKeyToken - Index range key.
+     *
+     * @returns  Index token if found.
+     */
+    findIndexToken(hashKeyToken, rangeKeyToken) {
+        return findIndexToken.findIndexToken(this, hashKeyToken, rangeKeyToken);
+    }
     /**
      * Query a database entity across shards in a provider-generic fashion.
      *

package/dist/cjs/ParsedConfig.js

@@ -236,6 +236,7 @@ const configSchema = zod.z
                     path: ['generatedProperties', 'unsharded', property],
                 });
     // Validate indexes.
+    // TODO: Vaidate no two indexes have the same hashKey & rangeKey.
     for (const [indexKey, { hashKey, rangeKey, projections }] of Object.entries(data.indexes)) {
         // Validate hash key is sharded.
         if (![data.hashKey, ...shardedKeys].includes(hashKey)) {

package/dist/cjs/addKeys.js

@@ -14,7 +14,7 @@ var validateEntityToken = require('./validateEntityToken.js');
  * @param item - {@link EntityItem | `EntityItem`} object.
  * @param overwrite - Overwrite existing properties (default `false`).
  *
- * @returns Shallow clone of `item` with updated properties.
+ * @returns {@link EntityRecord | `EntityRecord`} object with updated properties.
  *
  * @throws `Error` if `entityToken` is invalid.
  */

package/dist/cjs/findIndexToken.js

@@ -0,0 +1,16 @@
+'use strict';
+
+/**
+ * Find an index token in a {@link Config | `Config`} object based on the index `hashKey` and `rangeKey`.
+ *
+ * @param entityManager - {@link EntityManager | `EntityManager`} instance.
+ * @param hashKeyToken - Index hash key.
+ * @param rangeKeyToken - Index range key.
+ *
+ * @returns  Index token if found.
+ */
+function findIndexToken(entityManager, hashKeyToken, rangeKeyToken) {
+    return Object.entries(entityManager.config.indexes).find(([, index]) => index.hashKey === hashKeyToken && index.rangeKey === rangeKeyToken)?.[0];
+}
+
+exports.findIndexToken = findIndexToken;

package/dist/cjs/removeKeys.js

@@ -3,13 +3,13 @@
 var validateEntityToken = require('./validateEntityToken.js');
 
 /**
- * Strips generated properties, hash key, and range key from an {@link ItemMap | `ItemMap`} object.
+ * Strips generated properties, hash key, and range key from an {@link EntityRecord | `EntityRecord`} object.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
  * @param entityToken - {@link Config.entities | `entityManager.config.entities`} key.
- * @param item - {@link ItemMap | `ItemMap`} object.
+ * @param item - {@link EntityRecord | `EntityRecord`} object.
  *
- * @returns Shallow clone of `item` without generated properties, hash key or range key.
+ * @returns {@link EntityItem | `EntityItem`} with generated properties, hash key & range key removed.
  *
  * @throws `Error` if `entityToken` is invalid.
  */

package/dist/index.d.ts

@@ -96,6 +96,16 @@ type EntityItem<C extends BaseConfigMap> = Partial<FlattenEntityMap<C['EntityMap
  */
 type EntityKey<C extends BaseConfigMap> = Record<C['HashKey'] | C['RangeKey'], string>;
 
+/**
+ * Database-facing record type from a {@link BaseConfigMap | `ConfigMap`} with required hash & range keys.
+ *
+ * @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 EntityRecord<C extends BaseConfigMap> = EntityItem<C> & EntityKey<C>;
+
 /**
  * Extracts entity tokens from a {@link ConfigMap | `ConfigMap`}.
  *
@@ -538,11 +548,11 @@ declare class EntityManager<C extends BaseConfigMap> {
      * @param item - {@link EntityItem | `EntityItem`} object.
      * @param overwrite - Overwrite existing properties (default `false`).
      *
-     * @returns Shallow clone of `item` with updated properties.
+     * @returns {@link EntityRecord | `EntityRecord`} object with updated properties.
      *
      * @throws `Error` if `entityToken` is invalid.
      */
-    addKeys(entityToken: EntityToken<C>, item: EntityItem<C>, overwrite?: boolean): EntityItem<C>;
+    addKeys(entityToken: EntityToken<C>, item: EntityItem<C>, overwrite?: boolean): EntityRecord<C>;
     /**
      * Convert an {@link EntityItem | `EntityItem`} into an {@link EntityKey | `EntityKey`}.
      *
@@ -556,16 +566,25 @@ declare class EntityManager<C extends BaseConfigMap> {
      */
     getPrimaryKey(entityToken: EntityToken<C>, item: EntityItem<C>, overwrite?: boolean): EntityKey<C>;
     /**
-     * Strips generated properties, hash key, and range key from an {@link EntityItem | `EntityItem`} object.
+     * Strips generated properties, hash key, and range key from an {@link EntityRecord | `EntityRecord`} object.
      *
      * @param entityToken - {@link Config | `Config`} `entities` key.
-     * @param item - {@link EntityItem | `EntityItem`} object.
+     * @param item - {@link EntityRecord | `EntityRecord`} object.
      *
-     * @returns Shallow clone of `item` without generated properties, hash key or range key.
+     * @returns {@link EntityItem | `EntityItem`} with generated properties, hash key & range key removed.
      *
      * @throws `Error` if `entityToken` is invalid.
      */
-    removeKeys(entityToken: EntityToken<C>, item: EntityItem<C>): EntityItem<C>;
+    removeKeys(entityToken: EntityToken<C>, item: EntityRecord<C>): EntityItem<C>;
+    /**
+     * Find an index token in a {@link Config | `Config`} object based on the index `hashKey` and `rangeKey`.
+     *
+     * @param hashKeyToken - Index hash key.
+     * @param rangeKeyToken - Index range key.
+     *
+     * @returns  Index token if found.
+     */
+    findIndexToken(hashKeyToken: C['HashKey'] | C['ShardedKeys'], rangeKeyToken: C['RangeKey'] | C['UnshardedKeys'] | C['TranscodedProperties']): string | undefined;
     /**
      * Query a database entity across shards in a provider-generic fashion.
      *
@@ -736,14 +755,4 @@ type ConfigMap<M extends Partial<BaseConfigMap> = Partial<BaseConfigMap>> = Vali
     TranscodeMap: 'TranscodeMap' extends keyof M ? NonNullable<M['TranscodeMap']> : DefaultTranscodeMap;
 }>;
 
-/**
- * Database-facing record type from a {@link BaseConfigMap | `ConfigMap`} with required hash & range keys.
- *
- * @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 EntityRecord<C extends BaseConfigMap> = EntityItem<C> & EntityKey<C>;
-
 export { type BaseConfigMap, BaseEntityClient, type BaseEntityClientOptions, BaseQueryBuilder, type BaseQueryBuilderOptions, type Config, type ConfigMap, type EntityItem, type EntityKey, EntityManager, type EntityRecord, 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/EntityManager.js

@@ -1,6 +1,7 @@
 import { __classPrivateFieldSet, __classPrivateFieldGet } from 'tslib';
 import { pick } from 'radash';
 import { addKeys } from './addKeys.js';
+import { findIndexToken } from './findIndexToken.js';
 import { configSchema } from './ParsedConfig.js';
 import { query } from './query.js';
 import { removeKeys } from './removeKeys.js';
@@ -52,7 +53,7 @@ class EntityManager {
      * @param item - {@link EntityItem | `EntityItem`} object.
      * @param overwrite - Overwrite existing properties (default `false`).
      *
-     * @returns Shallow clone of `item` with updated properties.
+     * @returns {@link EntityRecord | `EntityRecord`} object with updated properties.
      *
      * @throws `Error` if `entityToken` is invalid.
      */
@@ -77,18 +78,29 @@ class EntityManager {
             : addKeys(this, entityToken, item, overwrite), [this.config.hashKey, this.config.rangeKey]);
     }
     /**
-     * Strips generated properties, hash key, and range key from an {@link EntityItem | `EntityItem`} object.
+     * Strips generated properties, hash key, and range key from an {@link EntityRecord | `EntityRecord`} object.
      *
      * @param entityToken - {@link Config | `Config`} `entities` key.
-     * @param item - {@link EntityItem | `EntityItem`} object.
+     * @param item - {@link EntityRecord | `EntityRecord`} object.
      *
-     * @returns Shallow clone of `item` without generated properties, hash key or range key.
+     * @returns {@link EntityItem | `EntityItem`} with generated properties, hash key & range key removed.
      *
      * @throws `Error` if `entityToken` is invalid.
      */
     removeKeys(entityToken, item) {
         return removeKeys(this, entityToken, item);
     }
+    /**
+     * Find an index token in a {@link Config | `Config`} object based on the index `hashKey` and `rangeKey`.
+     *
+     * @param hashKeyToken - Index hash key.
+     * @param rangeKeyToken - Index range key.
+     *
+     * @returns  Index token if found.
+     */
+    findIndexToken(hashKeyToken, rangeKeyToken) {
+        return findIndexToken(this, hashKeyToken, rangeKeyToken);
+    }
     /**
      * Query a database entity across shards in a provider-generic fashion.
      *

package/dist/mjs/ParsedConfig.js

@@ -234,6 +234,7 @@ const configSchema = z
                     path: ['generatedProperties', 'unsharded', property],
                 });
     // Validate indexes.
+    // TODO: Vaidate no two indexes have the same hashKey & rangeKey.
     for (const [indexKey, { hashKey, rangeKey, projections }] of Object.entries(data.indexes)) {
         // Validate hash key is sharded.
         if (![data.hashKey, ...shardedKeys].includes(hashKey)) {

package/dist/mjs/addKeys.js

@@ -12,7 +12,7 @@ import { validateEntityToken } from './validateEntityToken.js';
  * @param item - {@link EntityItem | `EntityItem`} object.
  * @param overwrite - Overwrite existing properties (default `false`).
  *
- * @returns Shallow clone of `item` with updated properties.
+ * @returns {@link EntityRecord | `EntityRecord`} object with updated properties.
  *
  * @throws `Error` if `entityToken` is invalid.
  */

package/dist/mjs/findIndexToken.js

@@ -0,0 +1,14 @@
+/**
+ * Find an index token in a {@link Config | `Config`} object based on the index `hashKey` and `rangeKey`.
+ *
+ * @param entityManager - {@link EntityManager | `EntityManager`} instance.
+ * @param hashKeyToken - Index hash key.
+ * @param rangeKeyToken - Index range key.
+ *
+ * @returns  Index token if found.
+ */
+function findIndexToken(entityManager, hashKeyToken, rangeKeyToken) {
+    return Object.entries(entityManager.config.indexes).find(([, index]) => index.hashKey === hashKeyToken && index.rangeKey === rangeKeyToken)?.[0];
+}
+
+export { findIndexToken };

package/dist/mjs/removeKeys.js

@@ -1,13 +1,13 @@
 import { validateEntityToken } from './validateEntityToken.js';
 
 /**
- * Strips generated properties, hash key, and range key from an {@link ItemMap | `ItemMap`} object.
+ * Strips generated properties, hash key, and range key from an {@link EntityRecord | `EntityRecord`} object.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
  * @param entityToken - {@link Config.entities | `entityManager.config.entities`} key.
- * @param item - {@link ItemMap | `ItemMap`} object.
+ * @param item - {@link EntityRecord | `EntityRecord`} object.
  *
- * @returns Shallow clone of `item` without generated properties, hash key or range key.
+ * @returns {@link EntityItem | `EntityItem`} with generated properties, hash key & range key removed.
  *
  * @throws `Error` if `entityToken` is invalid.
  */

package/package.json

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