@karmaniverous/entity-manager 6.11.4 → 6.13.0

package/dist/cjs/EntityManager.js

@@ -3,6 +3,8 @@
 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');
 var removeKeys = require('./removeKeys.js');
@@ -47,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.
      *
@@ -91,6 +106,17 @@ class EntityManager {
     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/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/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.
      *
@@ -576,6 +587,15 @@ declare class EntityManager<C extends BaseConfigMap> {
      * @throws `Error` if `entityToken` is invalid.
      */
     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: string, rangeKeyToken: string): string | undefined;
     /**
      * Query a database entity across shards in a provider-generic fashion.
      *

package/dist/mjs/EntityManager.js

@@ -1,6 +1,8 @@
 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';
 import { removeKeys } from './removeKeys.js';
@@ -45,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.
      *
@@ -89,6 +104,17 @@ class EntityManager {
     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/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/package.json

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