@karmaniverous/entity-manager 6.12.0 → 6.13.1

package/dist/cjs/EntityManager.js

@@ -3,6 +3,7 @@
 var tslib = require('tslib');
 var radash = require('radash');
 var addKeys = require('./addKeys.js');
+var encodeGeneratedProperty = require('./encodeGeneratedProperty.js');
 var findIndexToken = require('./findIndexToken.js');
 var ParsedConfig = require('./ParsedConfig.js');
 var query = require('./query.js');
@@ -48,6 +49,19 @@ class EntityManager {
     set config(value) {
         tslib.__classPrivateFieldSet(this, _EntityManager_config, ParsedConfig.configSchema.parse(value), "f");
     }
+    /**
+     * Encode a generated property value. Returns a string or undefined if atomicity requirement of sharded properties not met.
+     *
+     * @param property - {@link Config.generatedProperties | Generated property} key.
+     * @param item - Partial {@link ItemMap | `ItemMap`} object.
+     *
+     * @returns Encoded generated property value.
+     *
+     * @throws `Error` if `property` is not a {@link Config.generatedProperties | generated property}.
+     */
+    encodeGeneratedProperty(property, item) {
+        return encodeGeneratedProperty.encodeGeneratedProperty(this, property, item);
+    }
     /**
      * Update generated properties, hash key, and range key on an {@link EntityItem | `EntityItem`} object.
      *
@@ -97,11 +111,14 @@ class EntityManager {
      *
      * @param hashKeyToken - Index hash key.
      * @param rangeKeyToken - Index range key.
+     * @param suppressError - Suppress error if no match found.
      *
      * @returns  Index token if found.
+     *
+     * @throws `Error` if no match found and `suppressError` is not `true`.
      */
-    findIndexToken(hashKeyToken, rangeKeyToken) {
-        return findIndexToken.findIndexToken(this, hashKeyToken, rangeKeyToken);
+    findIndexToken(hashKeyToken, rangeKeyToken, suppressError) {
+        return findIndexToken.findIndexToken(this, hashKeyToken, rangeKeyToken, suppressError);
     }
     /**
      * Query a database entity across shards in a provider-generic fashion.

package/dist/cjs/findIndexToken.js

@@ -6,11 +6,17 @@
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
  * @param hashKeyToken - Index hash key.
  * @param rangeKeyToken - Index range key.
+ * @param suppressError - Suppress error if no match found.
  *
  * @returns  Index token if found.
+ *
+ * @throws `Error` if no match found and `suppressError` is not `true`.
  */
-function findIndexToken(entityManager, hashKeyToken, rangeKeyToken) {
-    return Object.entries(entityManager.config.indexes).find(([, index]) => index.hashKey === hashKeyToken && index.rangeKey === rangeKeyToken)?.[0];
+function findIndexToken(entityManager, hashKeyToken, rangeKeyToken, suppressError) {
+    const indexToken = Object.entries(entityManager.config.indexes).find(([, index]) => index.hashKey === hashKeyToken && index.rangeKey === rangeKeyToken)?.[0];
+    if (!indexToken && !suppressError)
+        throw new Error(`No index token found for hashKey '${hashKeyToken}' & rangeKey '${rangeKeyToken}'.`);
+    return indexToken;
 }
 
 exports.findIndexToken = findIndexToken;

package/dist/index.d.ts

@@ -541,6 +541,17 @@ declare class EntityManager<C extends BaseConfigMap> {
      * @param value - {@link Config | `Config`} object.
      */
     set config(value: ParsedConfig);
+    /**
+     * Encode a generated property value. Returns a string or undefined if atomicity requirement of sharded properties not met.
+     *
+     * @param property - {@link Config.generatedProperties | Generated property} key.
+     * @param item - Partial {@link ItemMap | `ItemMap`} object.
+     *
+     * @returns Encoded generated property value.
+     *
+     * @throws `Error` if `property` is not a {@link Config.generatedProperties | generated property}.
+     */
+    encodeGeneratedProperty<C extends BaseConfigMap>(property: C['ShardedKeys'] | C['UnshardedKeys'], item: EntityItem<C>): string | undefined;
     /**
      * Update generated properties, hash key, and range key on an {@link EntityItem | `EntityItem`} object.
      *
@@ -581,10 +592,13 @@ declare class EntityManager<C extends BaseConfigMap> {
      *
      * @param hashKeyToken - Index hash key.
      * @param rangeKeyToken - Index range key.
+     * @param suppressError - Suppress error if no match found.
      *
      * @returns  Index token if found.
+     *
+     * @throws `Error` if no match found and `suppressError` is not `true`.
      */
-    findIndexToken(hashKeyToken: C['HashKey'] | C['ShardedKeys'], rangeKeyToken: C['RangeKey'] | C['UnshardedKeys'] | C['TranscodedProperties']): string | undefined;
+    findIndexToken(hashKeyToken: string, rangeKeyToken: string, suppressError?: boolean): string | undefined;
     /**
      * Query a database entity across shards in a provider-generic fashion.
      *

package/dist/mjs/EntityManager.js

@@ -1,6 +1,7 @@
 import { __classPrivateFieldSet, __classPrivateFieldGet } from 'tslib';
 import { pick } from 'radash';
 import { addKeys } from './addKeys.js';
+import { encodeGeneratedProperty } from './encodeGeneratedProperty.js';
 import { findIndexToken } from './findIndexToken.js';
 import { configSchema } from './ParsedConfig.js';
 import { query } from './query.js';
@@ -46,6 +47,19 @@ class EntityManager {
     set config(value) {
         __classPrivateFieldSet(this, _EntityManager_config, configSchema.parse(value), "f");
     }
+    /**
+     * Encode a generated property value. Returns a string or undefined if atomicity requirement of sharded properties not met.
+     *
+     * @param property - {@link Config.generatedProperties | Generated property} key.
+     * @param item - Partial {@link ItemMap | `ItemMap`} object.
+     *
+     * @returns Encoded generated property value.
+     *
+     * @throws `Error` if `property` is not a {@link Config.generatedProperties | generated property}.
+     */
+    encodeGeneratedProperty(property, item) {
+        return encodeGeneratedProperty(this, property, item);
+    }
     /**
      * Update generated properties, hash key, and range key on an {@link EntityItem | `EntityItem`} object.
      *
@@ -95,11 +109,14 @@ class EntityManager {
      *
      * @param hashKeyToken - Index hash key.
      * @param rangeKeyToken - Index range key.
+     * @param suppressError - Suppress error if no match found.
      *
      * @returns  Index token if found.
+     *
+     * @throws `Error` if no match found and `suppressError` is not `true`.
      */
-    findIndexToken(hashKeyToken, rangeKeyToken) {
-        return findIndexToken(this, hashKeyToken, rangeKeyToken);
+    findIndexToken(hashKeyToken, rangeKeyToken, suppressError) {
+        return findIndexToken(this, hashKeyToken, rangeKeyToken, suppressError);
     }
     /**
      * Query a database entity across shards in a provider-generic fashion.

package/dist/mjs/findIndexToken.js

@@ -4,11 +4,17 @@
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
  * @param hashKeyToken - Index hash key.
  * @param rangeKeyToken - Index range key.
+ * @param suppressError - Suppress error if no match found.
  *
  * @returns  Index token if found.
+ *
+ * @throws `Error` if no match found and `suppressError` is not `true`.
  */
-function findIndexToken(entityManager, hashKeyToken, rangeKeyToken) {
-    return Object.entries(entityManager.config.indexes).find(([, index]) => index.hashKey === hashKeyToken && index.rangeKey === rangeKeyToken)?.[0];
+function findIndexToken(entityManager, hashKeyToken, rangeKeyToken, suppressError) {
+    const indexToken = Object.entries(entityManager.config.indexes).find(([, index]) => index.hashKey === hashKeyToken && index.rangeKey === rangeKeyToken)?.[0];
+    if (!indexToken && !suppressError)
+        throw new Error(`No index token found for hashKey '${hashKeyToken}' & rangeKey '${rangeKeyToken}'.`);
+    return indexToken;
 }
 
 export { findIndexToken };

package/package.json

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