@karmaniverous/entity-manager 5.0.8 → 5.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/FUNDING.yml +3 -0
- package/README.md +1 -2
- package/dist/cjs/BaseEntityClient/BaseEntityClient.js +28 -0
- package/dist/cjs/BaseQueryBuilder/BaseQueryBuilder.js +62 -0
- package/dist/cjs/EntityManager/EntityManager.js +131 -0
- package/dist/cjs/EntityManager/ParsedConfig.js +385 -0
- package/dist/cjs/EntityManager/addKeys.js +60 -0
- package/dist/cjs/EntityManager/createEntityManager.js +46 -0
- package/dist/cjs/EntityManager/decodeElement.js +46 -0
- package/dist/cjs/EntityManager/decodeGeneratedProperty.js +53 -0
- package/dist/cjs/EntityManager/dehydrateIndexItem.js +68 -0
- package/dist/cjs/EntityManager/dehydratePageKeyMap.js +93 -0
- package/dist/cjs/EntityManager/encodeElement.js +40 -0
- package/dist/cjs/EntityManager/encodeGeneratedProperty.js +55 -0
- package/dist/cjs/EntityManager/findIndexToken.js +10 -0
- package/dist/cjs/EntityManager/getHashKeySpace.js +89 -0
- package/dist/cjs/EntityManager/getIndexComponents.js +23 -0
- package/dist/cjs/EntityManager/getPrimaryKey.js +76 -0
- package/dist/cjs/EntityManager/getShardBump.js +24 -0
- package/dist/cjs/EntityManager/query.js +130 -0
- package/dist/cjs/EntityManager/rehydrateIndexItem.js +65 -0
- package/dist/cjs/EntityManager/rehydratePageKeyMap.js +103 -0
- package/dist/cjs/EntityManager/removeKeys.js +51 -0
- package/dist/cjs/EntityManager/unwrapIndex.js +59 -0
- package/dist/cjs/EntityManager/updateItemHashKey.js +79 -0
- package/dist/cjs/EntityManager/updateItemRangeKey.js +65 -0
- package/dist/cjs/EntityManager/validateEntityToken.js +17 -0
- package/dist/cjs/EntityManager/validateGeneratedProperty.js +23 -0
- package/dist/cjs/EntityManager/validateIndexToken.js +16 -0
- package/dist/cjs/EntityManager/validateTranscodedProperty.js +16 -0
- package/dist/cjs/index.js +15 -0
- package/dist/default/lib/EntityManager/EntityManager.js +46 -69
- package/dist/default/lib/EntityManager/PrivateEntityManager.js +44 -51
- package/dist/index.d.ts +1163 -0
- package/dist/mjs/BaseEntityClient/BaseEntityClient.js +26 -0
- package/dist/mjs/BaseQueryBuilder/BaseQueryBuilder.js +60 -0
- package/dist/mjs/EntityManager/EntityManager.js +129 -0
- package/dist/mjs/EntityManager/ParsedConfig.js +383 -0
- package/dist/mjs/EntityManager/addKeys.js +58 -0
- package/dist/mjs/EntityManager/createEntityManager.js +44 -0
- package/dist/mjs/EntityManager/decodeElement.js +44 -0
- package/dist/mjs/EntityManager/decodeGeneratedProperty.js +51 -0
- package/dist/mjs/EntityManager/dehydrateIndexItem.js +66 -0
- package/dist/mjs/EntityManager/dehydratePageKeyMap.js +91 -0
- package/dist/mjs/EntityManager/encodeElement.js +38 -0
- package/dist/mjs/EntityManager/encodeGeneratedProperty.js +53 -0
- package/dist/mjs/EntityManager/findIndexToken.js +8 -0
- package/dist/mjs/EntityManager/getHashKeySpace.js +87 -0
- package/dist/mjs/EntityManager/getIndexComponents.js +21 -0
- package/dist/mjs/EntityManager/getPrimaryKey.js +74 -0
- package/dist/mjs/EntityManager/getShardBump.js +22 -0
- package/dist/mjs/EntityManager/query.js +128 -0
- package/dist/mjs/EntityManager/rehydrateIndexItem.js +63 -0
- package/dist/mjs/EntityManager/rehydratePageKeyMap.js +101 -0
- package/dist/mjs/EntityManager/removeKeys.js +49 -0
- package/dist/mjs/EntityManager/unwrapIndex.js +57 -0
- package/dist/mjs/EntityManager/updateItemHashKey.js +77 -0
- package/dist/mjs/EntityManager/updateItemRangeKey.js +63 -0
- package/dist/mjs/EntityManager/validateEntityToken.js +15 -0
- package/dist/mjs/EntityManager/validateGeneratedProperty.js +21 -0
- package/dist/mjs/EntityManager/validateIndexToken.js +14 -0
- package/dist/mjs/EntityManager/validateTranscodedProperty.js +14 -0
- package/dist/mjs/index.js +5 -0
- package/docs/.nojekyll +1 -0
- package/docs/assets/hierarchy.js +1 -0
- package/docs/assets/highlight.css +99 -0
- package/docs/assets/icons.js +18 -0
- package/docs/assets/icons.svg +1 -0
- package/docs/assets/main.js +60 -0
- package/docs/assets/navigation.js +1 -0
- package/docs/assets/search.js +1 -0
- package/docs/assets/style.css +1648 -0
- package/docs/classes/index.BaseEntityClient.html +124 -0
- package/docs/classes/index.BaseQueryBuilder.html +229 -0
- package/docs/classes/index.EntityManager.html +510 -0
- package/docs/documents/CHANGELOG.html +1432 -0
- package/docs/documents/guides_stan-assistant-guide.html +431 -0
- package/docs/functions/index.createEntityManager.html +60 -0
- package/docs/hierarchy.html +31 -0
- package/docs/index.html +212 -0
- package/docs/interfaces/index.BaseConfigMap.html +113 -0
- package/docs/interfaces/index.BaseEntityClientOptions.html +82 -0
- package/docs/interfaces/index.BaseQueryBuilderOptions.html +92 -0
- package/docs/interfaces/index.CapturedConfigMapFrom.html +126 -0
- package/docs/interfaces/index.ConfigInput.html +189 -0
- package/docs/interfaces/index.ParsedConfig.html +144 -0
- package/docs/interfaces/index.ParsedEntityConfig.html +91 -0
- package/docs/interfaces/index.ParsedGeneratedPropertiesConfig.html +67 -0
- package/docs/interfaces/index.ParsedIndexConfig.html +79 -0
- package/docs/interfaces/index.ParsedTranscoder.html +71 -0
- package/docs/interfaces/index.QueryOptions.html +180 -0
- package/docs/interfaces/index.QueryResult.html +91 -0
- package/docs/interfaces/index.ShardBump.html +79 -0
- package/docs/interfaces/index.ShardQueryResult.html +93 -0
- package/docs/modules/index.html +47 -0
- package/docs/modules.html +38 -0
- package/docs/sitemap.xml +263 -0
- package/docs/types/index.BaseKeyTokens.html +39 -0
- package/docs/types/index.Config.html +75 -0
- package/docs/types/index.ConfigMap.html +41 -0
- package/docs/types/index.ConfigOfClient.html +45 -0
- package/docs/types/index.EntitiesFromSchema.html +39 -0
- package/docs/types/index.EntityClientItemByToken.html +45 -0
- package/docs/types/index.EntityClientRecordByToken.html +43 -0
- package/docs/types/index.EntityItem.html +41 -0
- package/docs/types/index.EntityItemPartial.html +44 -0
- package/docs/types/index.EntityKey.html +40 -0
- package/docs/types/index.EntityOfToken.html +39 -0
- package/docs/types/index.EntityRecord.html +39 -0
- package/docs/types/index.EntityRecordPartial.html +40 -0
- package/docs/types/index.EntityToken.html +40 -0
- package/docs/types/index.FallbackIndexTokenSet.html +40 -0
- package/docs/types/index.HasIndexFor.html +43 -0
- package/docs/types/index.HashKeyFrom.html +38 -0
- package/docs/types/index.IndexComponentTokens.html +45 -0
- package/docs/types/index.IndexHashKeyOf.html +42 -0
- package/docs/types/index.IndexRangeKeyOf.html +41 -0
- package/docs/types/index.IndexTokensFrom.html +41 -0
- package/docs/types/index.IndexTokensOf.html +40 -0
- package/docs/types/index.KeysFrom.html +38 -0
- package/docs/types/index.PageKey.html +40 -0
- package/docs/types/index.PageKeyByIndex.html +46 -0
- package/docs/types/index.PresentIndexTokenSet.html +45 -0
- package/docs/types/index.Projected.html +39 -0
- package/docs/types/index.QueryBuilderQueryOptions.html +45 -0
- package/docs/types/index.QueryOptionsByCC.html +49 -0
- package/docs/types/index.QueryOptionsByCF.html +47 -0
- package/docs/types/index.RangeKeyFrom.html +38 -0
- package/docs/types/index.ShardQueryFunction.html +63 -0
- package/docs/types/index.ShardQueryMap.html +56 -0
- package/docs/types/index.ShardQueryMapByCC.html +49 -0
- package/docs/types/index.ShardQueryMapByCF.html +47 -0
- package/docs/types/index.ShardedKeysFrom.html +38 -0
- package/docs/types/index.StorageItem.html +42 -0
- package/docs/types/index.StorageRecord.html +40 -0
- package/docs/types/index.TranscodedPropertiesFrom.html +38 -0
- package/docs/types/index.UnshardedKeysFrom.html +38 -0
- package/docs/types/index.ValidateConfigMap.html +40 -0
- package/lib/EntityManager/PrivateEntityManager.js +4 -0
- package/package.json +6 -6
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UnshardedKeysFrom | @karmaniverous/entity-manager</title><meta name="description" content="Documentation for @karmaniverous/entity-manager"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="https://github.com/karmaniverous/entity-manager" class="title">@karmaniverous/entity-manager</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="../modules/index.html">index</a></li>
|
|
12
|
+
<li><a href="" aria-current="page">UnshardedKeysFrom</a></li></ul>
|
|
13
|
+
<h1>Type Alias UnshardedKeysFrom<CC></h1></div>
|
|
14
|
+
<div class="tsd-signature"><span class="tsd-kind-type-alias">UnshardedKeysFrom</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">generatedProperties</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">infer</span> <span class="tsd-kind-type-parameter">GP</span> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">?</span> <span class="tsd-signature-type tsd-kind-type-parameter">GP</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">unsharded</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">infer</span> <span class="tsd-kind-type-parameter">U</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">?</span> <span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type tsd-kind-type-parameter">U</span> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span><br/> <span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span></div>
|
|
15
|
+
<div class="tsd-comment tsd-typography"><p>Extract the union of unsharded generated key tokens from a values-first config input type.</p>
|
|
16
|
+
</div>
|
|
17
|
+
<section class="tsd-panel">
|
|
18
|
+
<h4>Type Parameters</h4>
|
|
19
|
+
<ul class="tsd-type-parameter-list">
|
|
20
|
+
<li><span id="cc"><span class="tsd-kind-type-parameter">CC</span></span></li></ul></section><aside class="tsd-sources">
|
|
21
|
+
<ul>
|
|
22
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L134">EntityManager/createEntityManager.ts:134</a></li></ul></aside></div>
|
|
23
|
+
<div class="col-sidebar">
|
|
24
|
+
<div class="page-menu">
|
|
25
|
+
<div class="tsd-navigation settings">
|
|
26
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
27
|
+
<h3>Settings</h3></summary>
|
|
28
|
+
<div class="tsd-accordion-details">
|
|
29
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
30
|
+
<ul id="tsd-filter-options">
|
|
31
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li></ul></div>
|
|
32
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
|
|
33
|
+
<div class="site-menu">
|
|
34
|
+
<nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
|
|
35
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
36
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
37
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
38
|
+
<div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ValidateConfigMap | @karmaniverous/entity-manager</title><meta name="description" content="Documentation for @karmaniverous/entity-manager"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="https://github.com/karmaniverous/entity-manager" class="title">@karmaniverous/entity-manager</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="../modules/index.html">index</a></li>
|
|
12
|
+
<li><a href="" aria-current="page">ValidateConfigMap</a></li></ul>
|
|
13
|
+
<h1>Type Alias ValidateConfigMap<CC><code class="tsd-tag">Protected</code></h1></div>
|
|
14
|
+
<div class="tsd-signature"><span class="tsd-kind-type-alias">ValidateConfigMap</span><span class="tsd-signature-symbol">:</span> <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.MutuallyExclusive.html" class="tsd-signature-type external" target="_blank">MutuallyExclusive</a><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-symbol">[</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"HashKey"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"RangeKey"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"ShardedKeys"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"UnshardedKeys"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-keyword">keyof</span> <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.FlattenEntityMap.html" class="tsd-signature-type external" target="_blank">FlattenEntityMap</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"EntityMap"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">true</span><br/> <span class="tsd-signature-symbol">?</span> <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.NotNever.html" class="tsd-signature-type external" target="_blank">NotNever</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"HashKey"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"RangeKey"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">true</span><br/> <span class="tsd-signature-symbol">?</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><br/> <span class="tsd-signature-symbol">:</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#excludeuniontype-excludedmembers" class="tsd-signature-type external" target="_blank">Exclude</a><span class="tsd-signature-symbol"><</span><a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.NotNever.html" class="tsd-signature-type external" target="_blank">NotNever</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"HashKey"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"RangeKey"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">:</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#excludeuniontype-excludedmembers" class="tsd-signature-type external" target="_blank">Exclude</a><span class="tsd-signature-symbol"><</span><br/> <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.MutuallyExclusive.html" class="tsd-signature-type external" target="_blank">MutuallyExclusive</a><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-symbol">[</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"HashKey"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"RangeKey"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"ShardedKeys"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"UnshardedKeys"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-keyword">keyof</span> <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.FlattenEntityMap.html" class="tsd-signature-type external" target="_blank">FlattenEntityMap</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"EntityMap"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span></div>
|
|
15
|
+
<div class="tsd-comment tsd-typography"><p>Validates a type derived from <a href="../interfaces/index.BaseConfigMap.html" class="tsd-kind-interface"><code>BaseConfigMap</code></a> to ensure HashKey and RangeKey are both defined and that all sets of special keys are mutually exclusive.</p>
|
|
16
|
+
</div>
|
|
17
|
+
<section class="tsd-panel">
|
|
18
|
+
<h4>Type Parameters</h4>
|
|
19
|
+
<ul class="tsd-type-parameter-list">
|
|
20
|
+
<li><span id="cc"><span class="tsd-kind-type-parameter">CC</span> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/index.BaseConfigMap.html" class="tsd-signature-type tsd-kind-interface">BaseConfigMap</a></span>
|
|
21
|
+
<div class="tsd-comment tsd-typography"><p><a href="index.ConfigMap.html" class="tsd-kind-type-alias"><code>ConfigMap</code></a> that defines an <a href="index.Config.html" class="tsd-kind-type-alias"><code>EntityManager configuration</code></a>'s <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.EntityMap.html"><code>EntityMap</code></a>, key properties, and <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.TranscodeRegistry.html"><code>TranscodeRegistry</code></a>. If omitted, defaults to <a href="../interfaces/index.BaseConfigMap.html" class="tsd-kind-interface"><code>BaseConfigMap</code></a>.</p>
|
|
22
|
+
</div></li></ul></section><aside class="tsd-sources">
|
|
23
|
+
<ul>
|
|
24
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ValidateConfigMap.ts#L21">EntityManager/ValidateConfigMap.ts:21</a></li></ul></aside></div>
|
|
25
|
+
<div class="col-sidebar">
|
|
26
|
+
<div class="page-menu">
|
|
27
|
+
<div class="tsd-navigation settings">
|
|
28
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
29
|
+
<h3>Settings</h3></summary>
|
|
30
|
+
<div class="tsd-accordion-details">
|
|
31
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
32
|
+
<ul id="tsd-filter-options">
|
|
33
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li></ul></div>
|
|
34
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
|
|
35
|
+
<div class="site-menu">
|
|
36
|
+
<nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
|
|
37
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
38
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
39
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
40
|
+
<div class="overlay"></div></body></html>
|
|
@@ -287,6 +287,10 @@ export class PrivateEntityManager {
|
|
|
287
287
|
}
|
|
288
288
|
|
|
289
289
|
getIndexComponents(entityToken, indexToken) {
|
|
290
|
+
// When indexToken is undefined/null, return the base table primary key
|
|
291
|
+
// components. This supports queries against the main table (no GSI).
|
|
292
|
+
if (indexToken == null) return ['entityPK', 'entitySK'];
|
|
293
|
+
|
|
290
294
|
const { indexes } = this.getEntityConfig(entityToken);
|
|
291
295
|
|
|
292
296
|
if (!_.has(indexes, indexToken))
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@karmaniverous/entity-manager",
|
|
3
|
-
"version": "5.0.
|
|
3
|
+
"version": "5.0.10",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -30,21 +30,21 @@
|
|
|
30
30
|
"@babel/core": "^7.25.2",
|
|
31
31
|
"@babel/eslint-parser": "^7.25.1",
|
|
32
32
|
"@babel/plugin-syntax-import-assertions": "^7.24.7",
|
|
33
|
-
"@babel/preset-env": "^7.25.
|
|
33
|
+
"@babel/preset-env": "^7.25.3",
|
|
34
34
|
"@babel/register": "^7.24.6",
|
|
35
35
|
"@karmaniverous/edge-logger": "^1.3.12",
|
|
36
36
|
"@karmaniverous/tagged-templates": "^0.1.2",
|
|
37
|
-
"@types/node": "^20.
|
|
37
|
+
"@types/node": "^20.16.1",
|
|
38
38
|
"babel-plugin-lodash": "^3.3.4",
|
|
39
39
|
"chai": "^5.1.1",
|
|
40
40
|
"concat-md": "^0.5.1",
|
|
41
41
|
"eslint": "=8",
|
|
42
|
-
"eslint-plugin-jsdoc": "^48.
|
|
42
|
+
"eslint-plugin-jsdoc": "^48.11.0",
|
|
43
43
|
"eslint-plugin-mocha": "^10.5.0",
|
|
44
44
|
"eslint-plugin-promise": "^6.6.0",
|
|
45
45
|
"jsdoc-to-markdown": "^8.0.3",
|
|
46
|
-
"knip": "^5.27.
|
|
47
|
-
"mocha": "^10.7.
|
|
46
|
+
"knip": "^5.27.2",
|
|
47
|
+
"mocha": "^10.7.3",
|
|
48
48
|
"release-it": "^17.6.0"
|
|
49
49
|
},
|
|
50
50
|
"exports": {
|