@karmaniverous/entity-manager 0.0.9 → 0.0.11

package/README.md

@@ -38,8 +38,8 @@ The `entity-manager` configuration object describes each entity's structured key
 
 // These tagged templates are used below to simplify template literals.
 // sn2e - Template literal returns empty string if any expression is nil.
-// sn2u - Template literal returns undefined if any expression is nil.
-import { sn2e, sn2u } from '@karmaniverous/tagged-templates';
+// sn2n - Template literal returns undefined if any expression is nil.
+import { sn2e, sn2n } from '@karmaniverous/tagged-templates';
 
 // Entity config object named export.
 export const config = {
@@ -57,31 +57,31 @@ export const config = {
 
         // Table RANGE key.
         entitySK: ({ timestamp, transactionId }) =>
-          sn2u`timestamp#${timestamp}|transactionId#${transactionId}`,
+          sn2n`timestamp#${timestamp}|transactionId#${transactionId}`,
 
         // merchants GSI HASH key. Note the optional shardId.
         merchantPK: ({ merchantId, shardId }) =>
-          sn2u`merchantId#${merchantId}|transaction${sn2e`!${shardId}`}`,
+          sn2n`merchantId#${merchantId}|transaction${sn2e`!${shardId}`}`,
 
         // merchants GSI RANGE key.
         merchantSK: ({ methodId, timestamp, transactionId }) =>
-          sn2u`timestamp#${timestamp}|methodId#${methodId}|transactionId#${transactionId}`,
+          sn2n`timestamp#${timestamp}|methodId#${methodId}|transactionId#${transactionId}`,
 
         // methods GSI HASH key. Note the optional shardId.
         methodPK: ({ methodId, shardId }) =>
-          sn2u`method#${methodId}|transaction${sn2e`!${shardId}`}`,
+          sn2n`method#${methodId}|transaction${sn2e`!${shardId}`}`,
 
         // methods GSI RANGE key.
         methodSK: ({ merchantId, timestamp, transactionId }) =>
-          sn2u`timestamp#${timestamp}|merchantId#${merchantId}|transactionId#${transactionId}`,
+          sn2n`timestamp#${timestamp}|merchantId#${merchantId}|transactionId#${transactionId}`,
 
         // users GSI HASH key. Note the optional shardId.
         userPK: ({ shardId, userId }) =>
-          sn2u`user#${userId}|transaction${sn2e`!${shardId}`}`,
+          sn2n`user#${userId}|transaction${sn2e`!${shardId}`}`,
 
         // users GSI RANGE key.
         userSK: ({ merchantId, timestamp, transactionId }) =>
-          sn2u`timestamp#${timestamp}|merchantId#${merchantId}|transactionId#${transactionId}`,
+          sn2n`timestamp#${timestamp}|merchantId#${merchantId}|transactionId#${transactionId}`,
       },
 
       // The sharding configuration for this entity.
@@ -89,10 +89,11 @@ export const config = {
         // Default number of shard key characters (0 means no shard key).
         nibbles: 0,
 
-        // Bits represented by each shard key character. 3 bits means an octal
-        // shard key, so the first character yields 8 shards and the second
-        // yields 64.
-        nibbleBits: 4,
+        // Bits represented by each shard key character, so 3 bits means an
+        // octal shard key. Running with no shard key produces a single shard.
+        // The first shard key character yields another 8 shards, and the second
+        // yields an additional 64, for an eventual total of 73.
+        nibbleBits: 3,
 
         // Scheduled increases in shard key length. Keys are expressed as
         // millisecond UTC timestamps. In production, these should not be
@@ -110,8 +111,8 @@ export const config = {
       },
     },
   },
-  // Will be added to every entity object. Pick a value that won't collide with
-  // entity data!
+  // Will be added to every entity object as appropriate. Pick a value that
+  // won't collide with entity data!
   shardKeyToken: 'shardId',
 };
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@karmaniverous/entity-manager",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "publishConfig": {
     "access": "public"
   },
@@ -33,7 +33,7 @@
     "@babel/register": "^7.18.9",
     "@karmaniverous/edge-logger": "^1.0.2",
     "@karmaniverous/get-dotenv": "^0.1.0",
-    "@karmaniverous/tagged-templates": "^0.0.2",
+    "@karmaniverous/tagged-templates": "^0.0.4",
     "@types/node": "^18.11.18",
     "babel-plugin-lodash": "^3.3.4",
     "chai": "^4.3.7",