@karmaniverous/entity-manager - npm Package Compare versions

Comparing version 6.11.4 to 6.12.0

dist/cjs/EntityManager.js

@@ -6,2 +6,3 @@ 'use strict';
 var addKeys = require('./addKeys.js');
+var findIndexToken = require('./findIndexToken.js');
 var ParsedConfig = require('./ParsedConfig.js');
@@ -96,2 +97,13 @@ var query = require('./query.js');
     /**
+     * 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.
@@ -98,0 +110,0 @@ *

dist/cjs/ParsedConfig.js

@@ -239,2 +239,3 @@ 'use strict';
     // Validate indexes.
+    // TODO: Vaidate no two indexes have the same hashKey & rangeKey.
     for (const [indexKey, { hashKey, rangeKey, projections }] of Object.entries(data.indexes)) {
@@ -241,0 +242,0 @@ // Validate hash key is sharded.

dist/index.d.ts

@@ -580,2 +580,11 @@ import { EntityMap, TranscodeMap, ConditionalProperty, Exactify, PropertiesOfType, TranscodableProperties, FlattenEntityMap, Transcodes, SortOrder, MutuallyExclusive, NotNever, DefaultTranscodeMap } from '@karmaniverous/entity-tools';
     /**
+     * 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.
@@ -582,0 +591,0 @@ *

dist/mjs/EntityManager.js

 import { __classPrivateFieldSet, __classPrivateFieldGet } from 'tslib';
 import { pick } from 'radash';
 import { addKeys } from './addKeys.js';
+import { findIndexToken } from './findIndexToken.js';
 import { configSchema } from './ParsedConfig.js';
@@ -93,2 +94,13 @@ import { query } from './query.js';
     /**
+     * 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.
@@ -95,0 +107,0 @@ *

dist/mjs/ParsedConfig.js

@@ -237,2 +237,3 @@ import { defaultTranscodes } from '@karmaniverous/entity-tools';
     // Validate indexes.
+    // TODO: Vaidate no two indexes have the same hashKey & rangeKey.
     for (const [indexKey, { hashKey, rangeKey, projections }] of Object.entries(data.indexes)) {
@@ -239,0 +240,0 @@ // Validate hash key is sharded.

package.json

@@ -135,3 +135,3 @@ {
   "types": "dist/index.d.ts",
-  "version": "6.11.4"
+  "version": "6.12.0"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

177005

increased by1.52%

Number of package files

57

increased by3.64%

Lines of code

3845

increased by1.64%

No dependency changes