@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.
Files changed (140) hide show
  1. package/.github/FUNDING.yml +3 -0
  2. package/README.md +1 -2
  3. package/dist/cjs/BaseEntityClient/BaseEntityClient.js +28 -0
  4. package/dist/cjs/BaseQueryBuilder/BaseQueryBuilder.js +62 -0
  5. package/dist/cjs/EntityManager/EntityManager.js +131 -0
  6. package/dist/cjs/EntityManager/ParsedConfig.js +385 -0
  7. package/dist/cjs/EntityManager/addKeys.js +60 -0
  8. package/dist/cjs/EntityManager/createEntityManager.js +46 -0
  9. package/dist/cjs/EntityManager/decodeElement.js +46 -0
  10. package/dist/cjs/EntityManager/decodeGeneratedProperty.js +53 -0
  11. package/dist/cjs/EntityManager/dehydrateIndexItem.js +68 -0
  12. package/dist/cjs/EntityManager/dehydratePageKeyMap.js +93 -0
  13. package/dist/cjs/EntityManager/encodeElement.js +40 -0
  14. package/dist/cjs/EntityManager/encodeGeneratedProperty.js +55 -0
  15. package/dist/cjs/EntityManager/findIndexToken.js +10 -0
  16. package/dist/cjs/EntityManager/getHashKeySpace.js +89 -0
  17. package/dist/cjs/EntityManager/getIndexComponents.js +23 -0
  18. package/dist/cjs/EntityManager/getPrimaryKey.js +76 -0
  19. package/dist/cjs/EntityManager/getShardBump.js +24 -0
  20. package/dist/cjs/EntityManager/query.js +130 -0
  21. package/dist/cjs/EntityManager/rehydrateIndexItem.js +65 -0
  22. package/dist/cjs/EntityManager/rehydratePageKeyMap.js +103 -0
  23. package/dist/cjs/EntityManager/removeKeys.js +51 -0
  24. package/dist/cjs/EntityManager/unwrapIndex.js +59 -0
  25. package/dist/cjs/EntityManager/updateItemHashKey.js +79 -0
  26. package/dist/cjs/EntityManager/updateItemRangeKey.js +65 -0
  27. package/dist/cjs/EntityManager/validateEntityToken.js +17 -0
  28. package/dist/cjs/EntityManager/validateGeneratedProperty.js +23 -0
  29. package/dist/cjs/EntityManager/validateIndexToken.js +16 -0
  30. package/dist/cjs/EntityManager/validateTranscodedProperty.js +16 -0
  31. package/dist/cjs/index.js +15 -0
  32. package/dist/default/lib/EntityManager/EntityManager.js +46 -69
  33. package/dist/default/lib/EntityManager/PrivateEntityManager.js +44 -51
  34. package/dist/index.d.ts +1163 -0
  35. package/dist/mjs/BaseEntityClient/BaseEntityClient.js +26 -0
  36. package/dist/mjs/BaseQueryBuilder/BaseQueryBuilder.js +60 -0
  37. package/dist/mjs/EntityManager/EntityManager.js +129 -0
  38. package/dist/mjs/EntityManager/ParsedConfig.js +383 -0
  39. package/dist/mjs/EntityManager/addKeys.js +58 -0
  40. package/dist/mjs/EntityManager/createEntityManager.js +44 -0
  41. package/dist/mjs/EntityManager/decodeElement.js +44 -0
  42. package/dist/mjs/EntityManager/decodeGeneratedProperty.js +51 -0
  43. package/dist/mjs/EntityManager/dehydrateIndexItem.js +66 -0
  44. package/dist/mjs/EntityManager/dehydratePageKeyMap.js +91 -0
  45. package/dist/mjs/EntityManager/encodeElement.js +38 -0
  46. package/dist/mjs/EntityManager/encodeGeneratedProperty.js +53 -0
  47. package/dist/mjs/EntityManager/findIndexToken.js +8 -0
  48. package/dist/mjs/EntityManager/getHashKeySpace.js +87 -0
  49. package/dist/mjs/EntityManager/getIndexComponents.js +21 -0
  50. package/dist/mjs/EntityManager/getPrimaryKey.js +74 -0
  51. package/dist/mjs/EntityManager/getShardBump.js +22 -0
  52. package/dist/mjs/EntityManager/query.js +128 -0
  53. package/dist/mjs/EntityManager/rehydrateIndexItem.js +63 -0
  54. package/dist/mjs/EntityManager/rehydratePageKeyMap.js +101 -0
  55. package/dist/mjs/EntityManager/removeKeys.js +49 -0
  56. package/dist/mjs/EntityManager/unwrapIndex.js +57 -0
  57. package/dist/mjs/EntityManager/updateItemHashKey.js +77 -0
  58. package/dist/mjs/EntityManager/updateItemRangeKey.js +63 -0
  59. package/dist/mjs/EntityManager/validateEntityToken.js +15 -0
  60. package/dist/mjs/EntityManager/validateGeneratedProperty.js +21 -0
  61. package/dist/mjs/EntityManager/validateIndexToken.js +14 -0
  62. package/dist/mjs/EntityManager/validateTranscodedProperty.js +14 -0
  63. package/dist/mjs/index.js +5 -0
  64. package/docs/.nojekyll +1 -0
  65. package/docs/assets/hierarchy.js +1 -0
  66. package/docs/assets/highlight.css +99 -0
  67. package/docs/assets/icons.js +18 -0
  68. package/docs/assets/icons.svg +1 -0
  69. package/docs/assets/main.js +60 -0
  70. package/docs/assets/navigation.js +1 -0
  71. package/docs/assets/search.js +1 -0
  72. package/docs/assets/style.css +1648 -0
  73. package/docs/classes/index.BaseEntityClient.html +124 -0
  74. package/docs/classes/index.BaseQueryBuilder.html +229 -0
  75. package/docs/classes/index.EntityManager.html +510 -0
  76. package/docs/documents/CHANGELOG.html +1432 -0
  77. package/docs/documents/guides_stan-assistant-guide.html +431 -0
  78. package/docs/functions/index.createEntityManager.html +60 -0
  79. package/docs/hierarchy.html +31 -0
  80. package/docs/index.html +212 -0
  81. package/docs/interfaces/index.BaseConfigMap.html +113 -0
  82. package/docs/interfaces/index.BaseEntityClientOptions.html +82 -0
  83. package/docs/interfaces/index.BaseQueryBuilderOptions.html +92 -0
  84. package/docs/interfaces/index.CapturedConfigMapFrom.html +126 -0
  85. package/docs/interfaces/index.ConfigInput.html +189 -0
  86. package/docs/interfaces/index.ParsedConfig.html +144 -0
  87. package/docs/interfaces/index.ParsedEntityConfig.html +91 -0
  88. package/docs/interfaces/index.ParsedGeneratedPropertiesConfig.html +67 -0
  89. package/docs/interfaces/index.ParsedIndexConfig.html +79 -0
  90. package/docs/interfaces/index.ParsedTranscoder.html +71 -0
  91. package/docs/interfaces/index.QueryOptions.html +180 -0
  92. package/docs/interfaces/index.QueryResult.html +91 -0
  93. package/docs/interfaces/index.ShardBump.html +79 -0
  94. package/docs/interfaces/index.ShardQueryResult.html +93 -0
  95. package/docs/modules/index.html +47 -0
  96. package/docs/modules.html +38 -0
  97. package/docs/sitemap.xml +263 -0
  98. package/docs/types/index.BaseKeyTokens.html +39 -0
  99. package/docs/types/index.Config.html +75 -0
  100. package/docs/types/index.ConfigMap.html +41 -0
  101. package/docs/types/index.ConfigOfClient.html +45 -0
  102. package/docs/types/index.EntitiesFromSchema.html +39 -0
  103. package/docs/types/index.EntityClientItemByToken.html +45 -0
  104. package/docs/types/index.EntityClientRecordByToken.html +43 -0
  105. package/docs/types/index.EntityItem.html +41 -0
  106. package/docs/types/index.EntityItemPartial.html +44 -0
  107. package/docs/types/index.EntityKey.html +40 -0
  108. package/docs/types/index.EntityOfToken.html +39 -0
  109. package/docs/types/index.EntityRecord.html +39 -0
  110. package/docs/types/index.EntityRecordPartial.html +40 -0
  111. package/docs/types/index.EntityToken.html +40 -0
  112. package/docs/types/index.FallbackIndexTokenSet.html +40 -0
  113. package/docs/types/index.HasIndexFor.html +43 -0
  114. package/docs/types/index.HashKeyFrom.html +38 -0
  115. package/docs/types/index.IndexComponentTokens.html +45 -0
  116. package/docs/types/index.IndexHashKeyOf.html +42 -0
  117. package/docs/types/index.IndexRangeKeyOf.html +41 -0
  118. package/docs/types/index.IndexTokensFrom.html +41 -0
  119. package/docs/types/index.IndexTokensOf.html +40 -0
  120. package/docs/types/index.KeysFrom.html +38 -0
  121. package/docs/types/index.PageKey.html +40 -0
  122. package/docs/types/index.PageKeyByIndex.html +46 -0
  123. package/docs/types/index.PresentIndexTokenSet.html +45 -0
  124. package/docs/types/index.Projected.html +39 -0
  125. package/docs/types/index.QueryBuilderQueryOptions.html +45 -0
  126. package/docs/types/index.QueryOptionsByCC.html +49 -0
  127. package/docs/types/index.QueryOptionsByCF.html +47 -0
  128. package/docs/types/index.RangeKeyFrom.html +38 -0
  129. package/docs/types/index.ShardQueryFunction.html +63 -0
  130. package/docs/types/index.ShardQueryMap.html +56 -0
  131. package/docs/types/index.ShardQueryMapByCC.html +49 -0
  132. package/docs/types/index.ShardQueryMapByCF.html +47 -0
  133. package/docs/types/index.ShardedKeysFrom.html +38 -0
  134. package/docs/types/index.StorageItem.html +42 -0
  135. package/docs/types/index.StorageRecord.html +40 -0
  136. package/docs/types/index.TranscodedPropertiesFrom.html +38 -0
  137. package/docs/types/index.UnshardedKeysFrom.html +38 -0
  138. package/docs/types/index.ValidateConfigMap.html +40 -0
  139. package/lib/EntityManager/PrivateEntityManager.js +4 -0
  140. package/package.json +6 -6
package/docs/types/index.ShardQueryFunction.html ADDED
@@ -0,0 +1,63 @@
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>ShardQueryFunction | @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">ShardQueryFunction</a></li></ul>
13
+ <h1>Type Alias ShardQueryFunction&lt;CC, ET, IT, CF, K&gt;<code class="tsd-tag">Protected</code></h1></div>
14
+ <div class="tsd-signature"><span class="tsd-kind-type-alias">ShardQueryFunction</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">indexes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">infer</span> <span class="tsd-kind-type-parameter">I</span> <span class="tsd-signature-symbol">}</span><br/>    <span class="tsd-signature-symbol">?</span> <span class="tsd-signature-type tsd-kind-type-parameter">I</span> <span class="tsd-signature-keyword">extends</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" class="tsd-signature-type external" target="_blank">Record</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><br/>        <span class="tsd-signature-symbol">?</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#it">IT</a> <span class="tsd-signature-keyword">extends</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union" class="tsd-signature-type external" target="_blank">Extract</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type tsd-kind-type-parameter">I</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><br/>            <span class="tsd-signature-symbol">?</span> <span class="tsd-signature-symbol">(</span><br/>                <span class="tsd-kind-parameter">hashKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>                <span class="tsd-kind-parameter">pageKey</span><span class="tsd-signature-symbol">?:</span> <a href="index.PageKeyByIndex.html" class="tsd-signature-type tsd-kind-type-alias">PageKeyByIndex</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#it">IT</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>                <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>            <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/index.ShardQueryResult.html" class="tsd-signature-type tsd-kind-interface">ShardQueryResult</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#it">IT</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><br/>            <span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span><br/>        <span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>            <span class="tsd-kind-parameter">hashKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>            <span class="tsd-kind-parameter">pageKey</span><span class="tsd-signature-symbol">?:</span> <a href="index.PageKeyByIndex.html" class="tsd-signature-type tsd-kind-type-alias">PageKeyByIndex</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#it">IT</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>            <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/index.ShardQueryResult.html" class="tsd-signature-type tsd-kind-interface">ShardQueryResult</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#it">IT</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><br/>    <span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">hashKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">pageKey</span><span class="tsd-signature-symbol">?:</span> <a href="index.PageKeyByIndex.html" class="tsd-signature-type tsd-kind-type-alias">PageKeyByIndex</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#it">IT</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/index.ShardQueryResult.html" class="tsd-signature-type tsd-kind-interface">ShardQueryResult</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#it">IT</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div>
15
+ <div class="tsd-comment tsd-typography"><p>A query function that returns a single page of results from an individual shard.</p>
16
+ <p>This function will typically be composed dynamically to express a specific query index &amp; logic. The arguments to this function will be provided by the <a href="../classes/index.EntityManager.html#query" class="tsd-kind-method"><code>EntityManager.query</code></a> method, which assembles many returned pages queried across multiple shards into a single query result.</p>
17
+ </div>
18
+ <section class="tsd-panel">
19
+ <h4>Type Parameters</h4>
20
+ <ul class="tsd-type-parameter-list">
21
+ <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>
22
+ <div class="tsd-comment tsd-typography"><p><a href="index.ConfigMap.html" class="tsd-kind-type-alias"><code>ConfigMap</code></a>.</p>
23
+ </div></li>
24
+ <li><span id="et"><span class="tsd-kind-type-parameter">ET</span> <span class="tsd-signature-keyword">extends</span> <a href="index.EntityToken.html" class="tsd-signature-type tsd-kind-type-alias">EntityToken</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">&gt;</span></span>
25
+ <div class="tsd-comment tsd-typography"><p>Entity token narrowing the item/record types.</p>
26
+ </div></li>
27
+ <li><span id="it"><span class="tsd-kind-type-parameter">IT</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span></span>
28
+ <div class="tsd-comment tsd-typography"><p>Index token (inferred from shardQueryMap keys).</p>
29
+ </div></li>
30
+ <li><span id="cf"><span class="tsd-kind-type-parameter">CF</span> = <span class="tsd-signature-type">unknown</span></span>
31
+ <div class="tsd-comment tsd-typography"><p>Optional values-first config literal type for narrowing.</p>
32
+ </div></li>
33
+ <li><span id="k"><span class="tsd-kind-type-parameter">K</span> = <span class="tsd-signature-type">unknown</span></span>
34
+ <div class="tsd-comment tsd-typography"><p>Optional projection keys; narrows item shape when provided.</p>
35
+ </div></li></ul></section>
36
+ <div class="tsd-comment tsd-typography">
37
+ <div class="tsd-tag-param">
38
+ <h4 class="tsd-anchor-link" id="param-hashkey">Param: hashKey<a href="#param-hashkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The hash key value of the shard being queried.</p>
39
+ </div>
40
+ <div class="tsd-tag-param">
41
+ <h4 class="tsd-anchor-link" id="param-pagekey">Param: pageKey<a href="#param-pagekey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The typed page key for the index being queried.</p>
42
+ </div>
43
+ <div class="tsd-tag-param">
44
+ <h4 class="tsd-anchor-link" id="param-pagesize">Param: pageSize<a href="#param-pagesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The maximum number of items to return from this query.</p>
45
+ </div></div><aside class="tsd-sources">
46
+ <ul>
47
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ShardQueryFunction.ts#L29">EntityManager/ShardQueryFunction.ts:29</a></li></ul></aside></div>
48
+ <div class="col-sidebar">
49
+ <div class="page-menu">
50
+ <div class="tsd-navigation settings">
51
+ <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>
52
+ <h3>Settings</h3></summary>
53
+ <div class="tsd-accordion-details">
54
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
55
+ <ul id="tsd-filter-options">
56
+ <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>
57
+ <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>
58
+ <div class="site-menu">
59
+ <nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
60
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
61
+ <li>Loading...</li></ul></nav></div></div></div><footer>
62
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
63
+ <div class="overlay"></div></body></html>
package/docs/types/index.ShardQueryMap.html ADDED
@@ -0,0 +1,56 @@
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>ShardQueryMap | @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">ShardQueryMap</a></li></ul>
13
+ <h1>Type Alias ShardQueryMap&lt;CC, ET, ITS, CF, K&gt;<code class="tsd-tag">Protected</code></h1></div>
14
+ <div class="tsd-signature"><span class="tsd-kind-type-alias">ShardQueryMap</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">indexes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">infer</span> <span class="tsd-kind-type-parameter">I</span> <span class="tsd-signature-symbol">}</span><br/>    <span class="tsd-signature-symbol">?</span> <span class="tsd-signature-type tsd-kind-type-parameter">I</span> <span class="tsd-signature-keyword">extends</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" class="tsd-signature-type external" target="_blank">Record</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><br/>        <span class="tsd-signature-symbol">?</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" class="tsd-signature-type external" target="_blank">Record</a><span class="tsd-signature-symbol">&lt;</span><br/>            <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union" class="tsd-signature-type external" target="_blank">Extract</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#its">ITS</a><span class="tsd-signature-symbol">,</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union" class="tsd-signature-type external" target="_blank">Extract</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type tsd-kind-type-parameter">I</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>            <a href="index.ShardQueryFunction.html" class="tsd-signature-type tsd-kind-type-alias">ShardQueryFunction</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union" class="tsd-signature-type external" target="_blank">Extract</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#its">ITS</a><span class="tsd-signature-symbol">,</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union" class="tsd-signature-type external" target="_blank">Extract</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type tsd-kind-type-parameter">I</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-signature-symbol">&gt;</span><br/>        <span class="tsd-signature-symbol">:</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" class="tsd-signature-type external" target="_blank">Record</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#its">ITS</a><span class="tsd-signature-symbol">,</span> <a href="index.ShardQueryFunction.html" class="tsd-signature-type tsd-kind-type-alias">ShardQueryFunction</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#its">ITS</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><br/>    <span class="tsd-signature-symbol">:</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" class="tsd-signature-type external" target="_blank">Record</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#its">ITS</a><span class="tsd-signature-symbol">,</span> <a href="index.ShardQueryFunction.html" class="tsd-signature-type tsd-kind-type-alias">ShardQueryFunction</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#its">ITS</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div>
15
+ <div class="tsd-comment tsd-typography"><p>Relates a specific index token to a <a href="index.ShardQueryFunction.html" class="tsd-kind-type-alias"><code>ShardQueryFunction</code></a> to be performed on that index.</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>.</p>
22
+ </div></li>
23
+ <li><span id="et"><span class="tsd-kind-type-parameter">ET</span> <span class="tsd-signature-keyword">extends</span> <a href="index.EntityToken.html" class="tsd-signature-type tsd-kind-type-alias">EntityToken</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">&gt;</span></span>
24
+ <div class="tsd-comment tsd-typography"><p>Entity token narrowing the function item types.</p>
25
+ </div></li>
26
+ <li><span id="its"><span class="tsd-kind-type-parameter">ITS</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span></span>
27
+ <div class="tsd-comment tsd-typography"><p>Index token subset (inferred from object keys).</p>
28
+ </div></li>
29
+ <li><span id="cf"><span class="tsd-kind-type-parameter">CF</span> = <span class="tsd-signature-type">unknown</span></span>
30
+ <div class="tsd-comment tsd-typography"><p>Optional values-first config literal type for narrowing. When
31
+ provided and it carries an <code>indexes</code> object with preserved
32
+ literal keys (prefer <code>as const</code> at call sites), the map keys
33
+ are constrained to that set. Excess keys are rejected by
34
+ excess property checks on object literals.</p>
35
+ </div></li>
36
+ <li><span id="k"><span class="tsd-kind-type-parameter">K</span> = <span class="tsd-signature-type">unknown</span></span>
37
+ <div class="tsd-comment tsd-typography"><p>Optional projection keys; narrows item shape when provided.</p>
38
+ </div></li></ul></section><aside class="tsd-sources">
39
+ <ul>
40
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ShardQueryMap.ts#L26">EntityManager/ShardQueryMap.ts:26</a></li></ul></aside></div>
41
+ <div class="col-sidebar">
42
+ <div class="page-menu">
43
+ <div class="tsd-navigation settings">
44
+ <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>
45
+ <h3>Settings</h3></summary>
46
+ <div class="tsd-accordion-details">
47
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
48
+ <ul id="tsd-filter-options">
49
+ <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>
50
+ <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>
51
+ <div class="site-menu">
52
+ <nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
53
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
54
+ <li>Loading...</li></ul></nav></div></div></div><footer>
55
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
56
+ <div class="overlay"></div></body></html>
package/docs/types/index.ShardQueryMapByCC.html ADDED
@@ -0,0 +1,49 @@
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>ShardQueryMapByCC | @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">ShardQueryMapByCC</a></li></ul>
13
+ <h1>Type Alias ShardQueryMapByCC&lt;CC, ET, CCLit, K&gt;</h1></div>
14
+ <div class="tsd-signature"><span class="tsd-kind-type-alias">ShardQueryMapByCC</span><span class="tsd-signature-symbol">:</span> <a href="index.ShardQueryMap.html" class="tsd-signature-type tsd-kind-type-alias">ShardQueryMap</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a href="index.IndexTokensFrom.html" class="tsd-signature-type tsd-kind-type-alias">IndexTokensFrom</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cclit">CCLit</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cclit">CCLit</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span></div>
15
+ <div class="tsd-comment tsd-typography"><p>Convenience alias for ShardQueryMap that derives ITS (index token subset)
16
+ from a values-first captured config CC (e.g., your config literal type).</p>
17
+ <ul>
18
+ <li>If CC has <code>indexes</code>, ITS becomes the union of its keys.</li>
19
+ <li>Otherwise, ITS defaults to <code>string</code>.</li>
20
+ </ul>
21
+ <p>It also passes CC through the CF channel so per-index page-key narrowing
22
+ applies consistently.</p>
23
+ <p>This is optional DX sugar; it does not change runtime behavior.</p>
24
+ </div>
25
+ <section class="tsd-panel">
26
+ <h4>Type Parameters</h4>
27
+ <ul class="tsd-type-parameter-list">
28
+ <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></li>
29
+ <li><span id="et"><span class="tsd-kind-type-parameter">ET</span> <span class="tsd-signature-keyword">extends</span> <a href="index.EntityToken.html" class="tsd-signature-type tsd-kind-type-alias">EntityToken</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">&gt;</span></span></li>
30
+ <li><span id="cclit"><span class="tsd-kind-type-parameter">CCLit</span> = <span class="tsd-signature-type">unknown</span></span></li>
31
+ <li><span id="k"><span class="tsd-kind-type-parameter">K</span> = <span class="tsd-signature-type">unknown</span></span></li></ul></section><aside class="tsd-sources">
32
+ <ul>
33
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ShardQueryMap.ts#L64">EntityManager/ShardQueryMap.ts:64</a></li></ul></aside></div>
34
+ <div class="col-sidebar">
35
+ <div class="page-menu">
36
+ <div class="tsd-navigation settings">
37
+ <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>
38
+ <h3>Settings</h3></summary>
39
+ <div class="tsd-accordion-details">
40
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
41
+ <ul id="tsd-filter-options">
42
+ <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>
43
+ <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>
44
+ <div class="site-menu">
45
+ <nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
46
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
47
+ <li>Loading...</li></ul></nav></div></div></div><footer>
48
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
49
+ <div class="overlay"></div></body></html>
package/docs/types/index.ShardQueryMapByCF.html ADDED
@@ -0,0 +1,47 @@
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>ShardQueryMapByCF | @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">ShardQueryMapByCF</a></li></ul>
13
+ <h1>Type Alias ShardQueryMapByCF&lt;CC, ET, CF, K&gt;</h1></div>
14
+ <div class="tsd-signature"><span class="tsd-kind-type-alias">ShardQueryMapByCF</span><span class="tsd-signature-symbol">:</span> <a href="index.ShardQueryMap.html" class="tsd-signature-type tsd-kind-type-alias">ShardQueryMap</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a href="index.IndexTokensOf.html" class="tsd-signature-type tsd-kind-type-alias">IndexTokensOf</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span></div>
15
+ <div class="tsd-comment tsd-typography"><p>Convenience alias for ShardQueryMap that derives ITS (index token subset)
16
+ directly from a values-first config literal CF when it carries <code>indexes</code>.</p>
17
+ <ul>
18
+ <li>If CF has <code>indexes</code>, ITS becomes the union of its keys.</li>
19
+ <li>Otherwise, ITS defaults to <code>string</code>.</li>
20
+ </ul>
21
+ <p>This is optional DX sugar; it does not change runtime behavior.</p>
22
+ </div>
23
+ <section class="tsd-panel">
24
+ <h4>Type Parameters</h4>
25
+ <ul class="tsd-type-parameter-list">
26
+ <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></li>
27
+ <li><span id="et"><span class="tsd-kind-type-parameter">ET</span> <span class="tsd-signature-keyword">extends</span> <a href="index.EntityToken.html" class="tsd-signature-type tsd-kind-type-alias">EntityToken</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">&gt;</span></span></li>
28
+ <li><span id="cf"><span class="tsd-kind-type-parameter">CF</span> = <span class="tsd-signature-type">unknown</span></span></li>
29
+ <li><span id="k"><span class="tsd-kind-type-parameter">K</span> = <span class="tsd-signature-type">unknown</span></span></li></ul></section><aside class="tsd-sources">
30
+ <ul>
31
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ShardQueryMap.ts#L79">EntityManager/ShardQueryMap.ts:79</a></li></ul></aside></div>
32
+ <div class="col-sidebar">
33
+ <div class="page-menu">
34
+ <div class="tsd-navigation settings">
35
+ <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>
36
+ <h3>Settings</h3></summary>
37
+ <div class="tsd-accordion-details">
38
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
39
+ <ul id="tsd-filter-options">
40
+ <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>
41
+ <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>
42
+ <div class="site-menu">
43
+ <nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
44
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
45
+ <li>Loading...</li></ul></nav></div></div></div><footer>
46
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
47
+ <div class="overlay"></div></body></html>
package/docs/types/index.ShardedKeysFrom.html ADDED
@@ -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>ShardedKeysFrom | @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">ShardedKeysFrom</a></li></ul>
13
+ <h1>Type Alias ShardedKeysFrom&lt;CC&gt;</h1></div>
14
+ <div class="tsd-signature"><span class="tsd-kind-type-alias">ShardedKeysFrom</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">sharded</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">infer</span> <span class="tsd-kind-type-parameter">S</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">S</span> <span class="tsd-signature-symbol">&amp;</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 sharded 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#L121">EntityManager/createEntityManager.ts:121</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>
package/docs/types/index.StorageItem.html ADDED
@@ -0,0 +1,42 @@
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>StorageItem | @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">StorageItem</a></li></ul>
13
+ <h1>Type Alias StorageItem&lt;CC&gt;</h1></div>
14
+ <div class="tsd-signature"><span class="tsd-kind-type-alias">StorageItem</span><span class="tsd-signature-symbol">:</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" class="tsd-signature-type external" target="_blank">Partial</a><span class="tsd-signature-symbol">&lt;</span><br/>    <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">&lt;</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">&quot;EntityMap&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">&amp;</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" class="tsd-signature-type external" target="_blank">Record</a><span class="tsd-signature-symbol">&lt;</span><br/>        <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">&quot;HashKey&quot;</span><span class="tsd-signature-symbol">]</span><br/>        <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">&quot;RangeKey&quot;</span><span class="tsd-signature-symbol">]</span><br/>        <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">&quot;ShardedKeys&quot;</span><span class="tsd-signature-symbol">]</span><br/>        <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">&quot;UnshardedKeys&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">&amp;</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" class="tsd-signature-type external" target="_blank">Record</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></div>
15
+ <div class="tsd-comment tsd-typography"><p>Storage-facing partial item type from a <a href="../interfaces/index.BaseConfigMap.html" class="tsd-kind-interface"><code>ConfigMap</code></a>.</p>
16
+ <p>Token-agnostic shape used by encoding/decoding, key updates, and
17
+ (de)hydration services.</p>
18
+ </div>
19
+ <section class="tsd-panel">
20
+ <h4>Type Parameters</h4>
21
+ <ul class="tsd-type-parameter-list">
22
+ <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>
23
+ <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>
24
+ </div></li></ul></section><aside class="tsd-sources">
25
+ <ul>
26
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/StorageItem.ts#L21">EntityManager/StorageItem.ts:21</a></li></ul></aside></div>
27
+ <div class="col-sidebar">
28
+ <div class="page-menu">
29
+ <div class="tsd-navigation settings">
30
+ <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>
31
+ <h3>Settings</h3></summary>
32
+ <div class="tsd-accordion-details">
33
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
34
+ <ul id="tsd-filter-options">
35
+ <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>
36
+ <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>
37
+ <div class="site-menu">
38
+ <nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
39
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
40
+ <li>Loading...</li></ul></nav></div></div></div><footer>
41
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
42
+ <div class="overlay"></div></body></html>
package/docs/types/index.StorageRecord.html ADDED
@@ -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>StorageRecord | @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">StorageRecord</a></li></ul>
13
+ <h1>Type Alias StorageRecord&lt;CC&gt;</h1></div>
14
+ <div class="tsd-signature"><span class="tsd-kind-type-alias">StorageRecord</span><span class="tsd-signature-symbol">:</span> <a href="index.StorageItem.html" class="tsd-signature-type tsd-kind-type-alias">StorageItem</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">&amp;</span> <a href="index.EntityKey.html" class="tsd-signature-type tsd-kind-type-alias">EntityKey</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">&gt;</span></div>
15
+ <div class="tsd-comment tsd-typography"><p>Storage-facing record type with required keys.</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/StorageRecord.ts#L15">EntityManager/StorageRecord.ts:15</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>
package/docs/types/index.TranscodedPropertiesFrom.html ADDED
@@ -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>TranscodedPropertiesFrom | @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">TranscodedPropertiesFrom</a></li></ul>
13
+ <h1>Type Alias TranscodedPropertiesFrom&lt;CC&gt;</h1></div>
14
+ <div class="tsd-signature"><span class="tsd-kind-type-alias">TranscodedPropertiesFrom</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">propertyTranscodes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">infer</span> <span class="tsd-kind-type-parameter">PT</span> <span class="tsd-signature-symbol">}</span><br/>    <span class="tsd-signature-symbol">?</span> <span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-type tsd-kind-type-parameter">PT</span> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">string</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 transcoded property 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#L147">EntityManager/createEntityManager.ts:147</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>