quidproquo-actionprocessor-awslambda 0.1.11 → 0.1.13

package/lib/esm/logic/dynamo/putItem.js

@@ -1,26 +1,9 @@
 import { DynamoDBClient, PutItemCommand } from '@aws-sdk/client-dynamodb';
 import { createAwsClient } from '../createAwsClient';
 import { buildAttributeValue } from './qpqDynamoOrm';
-// We currently only support objects as root items in dynamo
-// Storing a list (array) as the root of your DynamoDB record is indeed possible,
-// but there are some caveats. One of the main challenges is that DynamoDB doesn't support
-// complex operations on list items. For instance, you can't perform a conditional update or
-// delete on a specific item in the list based on its value. However, you can read and write
-// entire lists, and you can append items to a list with an update operation.
-//
-// TODO?: support lists as root items in dynamo ~ Probably not worth it
-// a root list probably should be a table!
-// Something like this:
-// const convertObjectOrListToDynamoMap = (value: KvsObjectDataType | KvsListDataType): AttributeValue => {
-//   const attributeValue = buildAttributeValue(value);
-//   if ('M' in attributeValue) {
-//     return attributeValue.M!;
-//   }
-//   if ('L' in attributeValue) {
-//     return attributeValue.L!;
-//   }
-//   throw new Error("Value must be an object or a list");
-// }
+// Root items must be objects. A root-level list is technically storable, but
+// DynamoDB cannot conditionally update or delete individual list elements,
+// and a root list is usually better modelled as its own table.
 const convertObjectToDynamoItem = (obj) => {
     return buildAttributeValue(obj).M;
 };

package/lib/esm/logic/dynamo/putItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"putItem.js","sourceRoot":"","sources":["../../../../src/logic/dynamo/putItem.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,cAAc,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1F,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAarD,4DAA4D;AAC5D,iFAAiF;AACjF,0FAA0F;AAC1F,4FAA4F;AAC5F,4FAA4F;AAC5F,6EAA6E;AAC7E,EAAE;AACF,uEAAuE;AACvE,0CAA0C;AAC1C,uBAAuB;AACvB,2GAA2G;AAC3G,uDAAuD;AACvD,iCAAiC;AACjC,gCAAgC;AAChC,MAAM;AACN,iCAAiC;AACjC,gCAAgC;AAChC,MAAM;AACN,0DAA0D;AAC1D,IAAI;AAEJ,MAAM,yBAAyB,GAAG,CAAC,GAAsB,EAAkC,EAAE;IAC3F,OAAO,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAE,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,SAAiB,EACjB,IAAU,EACV,UAAoB,EACpB,OAAuB,EACvB,MAAc;IAEd,MAAM,cAAc,GAAG,eAAe,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAEnE,MAAM,cAAc,CAAC,IAAI,CACvB,IAAI,cAAc,CAAC;QACjB,SAAS,EAAE,SAAS;QACpB,IAAI,EAAE,yBAAyB,CAAC,IAAyB,CAAC;QAC1D,GAAG,CAAC,OAAO,CAAC,oBAAoB;YAC9B,CAAC,CAAC;gBACE,mBAAmB,EAAE,gCAAgC;gBACrD,wBAAwB,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,oBAAoB,EAAE;aACvE;YACH,CAAC,CAAC,EAAE,CAAC;KACR,CAAC,CACH,CAAC;AACJ,CAAC","sourcesContent":["import { KvsKey, KvsObjectDataType } from 'quidproquo-core';\n\nimport { AttributeValue, DynamoDBClient, PutItemCommand } from '@aws-sdk/client-dynamodb';\n\nimport { createAwsClient } from '../createAwsClient';\nimport { buildAttributeValue } from './qpqDynamoOrm';\n\nexport interface PutItemOptions {\n  expires?: number;\n\n  // When set, the put becomes a conditional insert: it fails with\n  // ConditionalCheckFailedException if an item with the same primary key\n  // already exists. The value is the attribute name to condition on (any\n  // key attribute works — the condition evaluates against the item at the\n  // full primary key).\n  ifNotExistsAttribute?: string;\n}\n\n// We currently only support objects as root items in dynamo\n// Storing a list (array) as the root of your DynamoDB record is indeed possible,\n// but there are some caveats. One of the main challenges is that DynamoDB doesn't support\n// complex operations on list items. For instance, you can't perform a conditional update or\n// delete on a specific item in the list based on its value. However, you can read and write\n// entire lists, and you can append items to a list with an update operation.\n//\n// TODO?: support lists as root items in dynamo ~ Probably not worth it\n// a root list probably should be a table!\n// Something like this:\n// const convertObjectOrListToDynamoMap = (value: KvsObjectDataType | KvsListDataType): AttributeValue => {\n//   const attributeValue = buildAttributeValue(value);\n//   if ('M' in attributeValue) {\n//     return attributeValue.M!;\n//   }\n//   if ('L' in attributeValue) {\n//     return attributeValue.L!;\n//   }\n//   throw new Error(\"Value must be an object or a list\");\n// }\n\nconst convertObjectToDynamoItem = (obj: KvsObjectDataType): Record<string, AttributeValue> => {\n  return buildAttributeValue(obj).M!;\n};\n\nexport async function putItem<Item, T extends object = any>(\n  tableName: string,\n  item: Item,\n  attributes: KvsKey[],\n  options: PutItemOptions,\n  region: string,\n): Promise<void> {\n  const dynamoDBClient = createAwsClient(DynamoDBClient, { region });\n\n  await dynamoDBClient.send(\n    new PutItemCommand({\n      TableName: tableName,\n      Item: convertObjectToDynamoItem(item as KvsObjectDataType),\n      ...(options.ifNotExistsAttribute\n        ? {\n            ConditionExpression: 'attribute_not_exists(#ineAttr)',\n            ExpressionAttributeNames: { '#ineAttr': options.ifNotExistsAttribute },\n          }\n        : {}),\n    }),\n  );\n}\n"]}
+{"version":3,"file":"putItem.js","sourceRoot":"","sources":["../../../../src/logic/dynamo/putItem.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,cAAc,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1F,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAiBrD,6EAA6E;AAC7E,2EAA2E;AAC3E,+DAA+D;AAC/D,MAAM,yBAAyB,GAAG,CAAC,GAAsB,EAAkC,EAAE;IAC3F,OAAO,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAE,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,SAAiB,EACjB,IAAuB,EACvB,UAAoB,EACpB,OAAuB,EACvB,MAAc;IAEd,MAAM,cAAc,GAAG,eAAe,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAEnE,MAAM,cAAc,CAAC,IAAI,CACvB,IAAI,cAAc,CAAC;QACjB,SAAS,EAAE,SAAS;QACpB,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;QACrC,GAAG,CAAC,OAAO,CAAC,oBAAoB;YAC9B,CAAC,CAAC;gBACE,mBAAmB,EAAE,gCAAgC;gBACrD,wBAAwB,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,oBAAoB,EAAE;aACvE;YACH,CAAC,CAAC,EAAE,CAAC;KACR,CAAC,CACH,CAAC;AACJ,CAAC","sourcesContent":["import { KvsKey, KvsObjectDataType } from 'quidproquo-core';\n\nimport { AttributeValue, DynamoDBClient, PutItemCommand } from '@aws-sdk/client-dynamodb';\n\nimport { createAwsClient } from '../createAwsClient';\nimport { buildAttributeValue } from './qpqDynamoOrm';\n\nexport type PutItemOptions = {\n  // Requested TTL in seconds. Not currently applied: the table's ttlAttribute\n  // name is not plumbed through to this call, so the value is silently\n  // dropped. Wire storeConfig.ttlAttribute through and write the epoch expiry\n  // before relying on it.\n  expires?: number;\n\n  // When set, the put becomes a conditional insert: it fails with\n  // ConditionalCheckFailedException if an item with the same primary key\n  // already exists. The value is the attribute name to condition on (any\n  // key attribute works: the condition evaluates against the item at the\n  // full primary key).\n  ifNotExistsAttribute?: string;\n};\n\n// Root items must be objects. A root-level list is technically storable, but\n// DynamoDB cannot conditionally update or delete individual list elements,\n// and a root list is usually better modelled as its own table.\nconst convertObjectToDynamoItem = (obj: KvsObjectDataType): Record<string, AttributeValue> => {\n  return buildAttributeValue(obj).M!;\n};\n\nexport async function putItem(\n  tableName: string,\n  item: KvsObjectDataType,\n  attributes: KvsKey[],\n  options: PutItemOptions,\n  region: string,\n): Promise<void> {\n  const dynamoDBClient = createAwsClient(DynamoDBClient, { region });\n\n  await dynamoDBClient.send(\n    new PutItemCommand({\n      TableName: tableName,\n      Item: convertObjectToDynamoItem(item),\n      ...(options.ifNotExistsAttribute\n        ? {\n            ConditionExpression: 'attribute_not_exists(#ineAttr)',\n            ExpressionAttributeNames: { '#ineAttr': options.ifNotExistsAttribute },\n          }\n        : {}),\n    }),\n  );\n}\n"]}

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildAttributeValue.d.ts

@@ -0,0 +1,8 @@
+import { KvsAdvancedDataType } from 'quidproquo-core';
+import { AttributeValue } from '@aws-sdk/client-dynamodb';
+/**
+ * Convert a kvs value to its DynamoDB AttributeValue form. Recurses into
+ * arrays and objects; object members with an undefined value are dropped
+ * (DynamoDB has no representation for undefined).
+ */
+export declare const buildAttributeValue: (value: KvsAdvancedDataType) => AttributeValue;

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildAttributeValue.js

@@ -0,0 +1,36 @@
+/**
+ * Convert a kvs value to its DynamoDB AttributeValue form. Recurses into
+ * arrays and objects; object members with an undefined value are dropped
+ * (DynamoDB has no representation for undefined).
+ */
+export const buildAttributeValue = (value) => {
+    const valueType = typeof value;
+    switch (valueType) {
+        case 'string':
+            return { S: value };
+        case 'number':
+            return { N: value.toString() };
+        case 'boolean':
+            return { BOOL: value };
+        case 'object':
+            if (Array.isArray(value)) {
+                return {
+                    L: value.map((item) => buildAttributeValue(item)),
+                };
+            }
+            else if (value !== null) {
+                const objectKeyValuePairs = Object.entries(value)
+                    .filter(([, memberValue]) => memberValue !== undefined)
+                    .map(([memberKey, memberValue]) => [memberKey, buildAttributeValue(memberValue)]);
+                return {
+                    M: Object.fromEntries(objectKeyValuePairs),
+                };
+            }
+            else {
+                return { NULL: true };
+            }
+        default:
+            throw new Error(`Unsupported data type in kvs expression: ${valueType}`);
+    }
+};
+//# sourceMappingURL=buildAttributeValue.js.map

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildAttributeValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildAttributeValue.js","sourceRoot":"","sources":["../../../../../src/logic/dynamo/qpqDynamoOrm/buildAttributeValue.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,KAA0B,EAAkB,EAAE;IAChF,MAAM,SAAS,GAAG,OAAO,KAAK,CAAC;IAC/B,QAAQ,SAAS,EAAE,CAAC;QAClB,KAAK,QAAQ;YACX,OAAO,EAAE,CAAC,EAAE,KAAe,EAAE,CAAC;QAEhC,KAAK,QAAQ;YACX,OAAO,EAAE,CAAC,EAAG,KAAgB,CAAC,QAAQ,EAAE,EAAE,CAAC;QAE7C,KAAK,SAAS;YACZ,OAAO,EAAE,IAAI,EAAE,KAAgB,EAAE,CAAC;QAEpC,KAAK,QAAQ;YACX,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO;oBACL,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;iBAClD,CAAC;YACJ,CAAC;iBAAM,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC1B,MAAM,mBAAmB,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;qBAC9C,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,WAAW,KAAK,SAAS,CAAC;qBACtD,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC,SAAS,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;gBAEpF,OAAO;oBACL,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC;iBAC3C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YACxB,CAAC;QACH;YACE,MAAM,IAAI,KAAK,CAAC,4CAA4C,SAAS,EAAE,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC,CAAC","sourcesContent":["import { KvsAdvancedDataType } from 'quidproquo-core';\n\nimport { AttributeValue } from '@aws-sdk/client-dynamodb';\n\n/**\n * Convert a kvs value to its DynamoDB AttributeValue form. Recurses into\n * arrays and objects; object members with an undefined value are dropped\n * (DynamoDB has no representation for undefined).\n */\nexport const buildAttributeValue = (value: KvsAdvancedDataType): AttributeValue => {\n  const valueType = typeof value;\n  switch (valueType) {\n    case 'string':\n      return { S: value as string };\n\n    case 'number':\n      return { N: (value as number).toString() };\n\n    case 'boolean':\n      return { BOOL: value as boolean };\n\n    case 'object':\n      if (Array.isArray(value)) {\n        return {\n          L: value.map((item) => buildAttributeValue(item)),\n        };\n      } else if (value !== null) {\n        const objectKeyValuePairs = Object.entries(value)\n          .filter(([, memberValue]) => memberValue !== undefined)\n          .map(([memberKey, memberValue]) => [memberKey, buildAttributeValue(memberValue)]);\n\n        return {\n          M: Object.fromEntries(objectKeyValuePairs),\n        };\n      } else {\n        return { NULL: true };\n      }\n    default:\n      throw new Error(`Unsupported data type in kvs expression: ${valueType}`);\n  }\n};\n"]}

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildDynamoQueryExpression.d.ts

@@ -0,0 +1,9 @@
+import { KvsQueryOperation } from 'quidproquo-core';
+/**
+ * Render a kvs query tree as a DynamoDB expression string. Attribute names and
+ * values are replaced with hashed placeholders; pair the result with
+ * buildExpressionAttributeNames / buildExpressionAttributeValues over the same
+ * queries. Returns undefined (not null) when there is no query so the result
+ * can feed optional SDK command fields (FilterExpression and friends) directly.
+ */
+export declare const buildDynamoQueryExpression: (query?: KvsQueryOperation) => string | undefined;

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildDynamoQueryExpression.js

@@ -0,0 +1,80 @@
+import { KvsLogicalOperatorType, KvsQueryOperationType, } from 'quidproquo-core';
+import { getItemName } from './getItemName';
+import { getValueName } from './getValueName';
+import { isKvsLogicalOperator } from './isKvsLogicalOperator';
+import { isKvsQueryCondition } from './isKvsQueryCondition';
+// Fail fast on a missing value: rendering a placeholder for undefined would
+// build an expression whose placeholder never appears in
+// ExpressionAttributeValues, which DynamoDB rejects with a confusing error.
+const getRequiredValueName = (query, value) => {
+    if (value === undefined) {
+        throw new Error(`Invalid query condition ${query.operation}: missing value for key [${query.key}]`);
+    }
+    return getValueName(value);
+};
+const comparisonOperators = {
+    [KvsQueryOperationType.Equal]: '=',
+    [KvsQueryOperationType.NotEqual]: '<>',
+    [KvsQueryOperationType.LessThan]: '<',
+    [KvsQueryOperationType.LessThanOrEqual]: '<=',
+    [KvsQueryOperationType.GreaterThan]: '>',
+    [KvsQueryOperationType.GreaterThanOrEqual]: '>=',
+};
+const buildConditionExpression = (query) => {
+    const itemName = getItemName(query.key);
+    switch (query.operation) {
+        case KvsQueryOperationType.Equal:
+        case KvsQueryOperationType.NotEqual:
+        case KvsQueryOperationType.LessThan:
+        case KvsQueryOperationType.LessThanOrEqual:
+        case KvsQueryOperationType.GreaterThan:
+        case KvsQueryOperationType.GreaterThanOrEqual:
+            return `${itemName} ${comparisonOperators[query.operation]} ${getRequiredValueName(query, query.valueA)}`;
+        case KvsQueryOperationType.Between:
+            return `${itemName} BETWEEN ${getRequiredValueName(query, query.valueA)} AND ${getRequiredValueName(query, query.valueB)}`;
+        case KvsQueryOperationType.In:
+            if (!Array.isArray(query.valueA)) {
+                throw new Error(`Invalid query condition ${query.operation}: expected an array of values for key [${query.key}]`);
+            }
+            return `${itemName} IN (${query.valueA.map((value) => getValueName(value)).join(', ')})`;
+        case KvsQueryOperationType.Exists:
+            return `attribute_exists(${itemName})`;
+        case KvsQueryOperationType.NotExists:
+            return `attribute_not_exists(${itemName})`;
+        case KvsQueryOperationType.BeginsWith:
+            return `begins_with(${itemName}, ${getRequiredValueName(query, query.valueA)})`;
+        case KvsQueryOperationType.Contains:
+            return `contains(${itemName}, ${getRequiredValueName(query, query.valueA)})`;
+        case KvsQueryOperationType.NotContains:
+            return `NOT contains(${itemName}, ${getRequiredValueName(query, query.valueA)})`;
+        default:
+            throw new Error(`Invalid query operation: ${JSON.stringify(query)}`);
+    }
+};
+const buildLogicalExpression = (query) => {
+    const joiner = query.operation === KvsLogicalOperatorType.And ? ' AND ' : ' OR ';
+    return query.conditions.map((condition) => `(${buildQueryOperationExpression(condition)})`).join(joiner);
+};
+const buildQueryOperationExpression = (query) => {
+    if (isKvsQueryCondition(query)) {
+        return buildConditionExpression(query);
+    }
+    if (isKvsLogicalOperator(query)) {
+        return buildLogicalExpression(query);
+    }
+    throw new Error(`Invalid query operation: ${JSON.stringify(query)}`);
+};
+/**
+ * Render a kvs query tree as a DynamoDB expression string. Attribute names and
+ * values are replaced with hashed placeholders; pair the result with
+ * buildExpressionAttributeNames / buildExpressionAttributeValues over the same
+ * queries. Returns undefined (not null) when there is no query so the result
+ * can feed optional SDK command fields (FilterExpression and friends) directly.
+ */
+export const buildDynamoQueryExpression = (query) => {
+    if (!query) {
+        return undefined;
+    }
+    return buildQueryOperationExpression(query);
+};
+//# sourceMappingURL=buildDynamoQueryExpression.js.map

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildDynamoQueryExpression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildDynamoQueryExpression.js","sourceRoot":"","sources":["../../../../../src/logic/dynamo/qpqDynamoOrm/buildDynamoQueryExpression.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,sBAAsB,EAGtB,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,4EAA4E;AAC5E,yDAAyD;AACzD,4EAA4E;AAC5E,MAAM,oBAAoB,GAAG,CAAC,KAAwB,EAAE,KAA2B,EAAU,EAAE;IAC7F,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,2BAA2B,KAAK,CAAC,SAAS,4BAA4B,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC;IACtG,CAAC;IAED,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAmD;IAC1E,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,GAAG;IAClC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EAAE,IAAI;IACtC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EAAE,GAAG;IACrC,CAAC,qBAAqB,CAAC,eAAe,CAAC,EAAE,IAAI;IAC7C,CAAC,qBAAqB,CAAC,WAAW,CAAC,EAAE,GAAG;IACxC,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,EAAE,IAAI;CACjD,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,KAAwB,EAAU,EAAE;IACpE,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAExC,QAAQ,KAAK,CAAC,SAAS,EAAE,CAAC;QACxB,KAAK,qBAAqB,CAAC,KAAK,CAAC;QACjC,KAAK,qBAAqB,CAAC,QAAQ,CAAC;QACpC,KAAK,qBAAqB,CAAC,QAAQ,CAAC;QACpC,KAAK,qBAAqB,CAAC,eAAe,CAAC;QAC3C,KAAK,qBAAqB,CAAC,WAAW,CAAC;QACvC,KAAK,qBAAqB,CAAC,kBAAkB;YAC3C,OAAO,GAAG,QAAQ,IAAI,mBAAmB,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,oBAAoB,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAE5G,KAAK,qBAAqB,CAAC,OAAO;YAChC,OAAO,GAAG,QAAQ,YAAY,oBAAoB,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,oBAAoB,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAE7H,KAAK,qBAAqB,CAAC,EAAE;YAC3B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CAAC,2BAA2B,KAAK,CAAC,SAAS,0CAA0C,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC;YACpH,CAAC;YACD,OAAO,GAAG,QAAQ,QAAQ,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;QAE3F,KAAK,qBAAqB,CAAC,MAAM;YAC/B,OAAO,oBAAoB,QAAQ,GAAG,CAAC;QAEzC,KAAK,qBAAqB,CAAC,SAAS;YAClC,OAAO,wBAAwB,QAAQ,GAAG,CAAC;QAE7C,KAAK,qBAAqB,CAAC,UAAU;YACnC,OAAO,eAAe,QAAQ,KAAK,oBAAoB,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC;QAElF,KAAK,qBAAqB,CAAC,QAAQ;YACjC,OAAO,YAAY,QAAQ,KAAK,oBAAoB,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC;QAE/E,KAAK,qBAAqB,CAAC,WAAW;YACpC,OAAO,gBAAgB,QAAQ,KAAK,oBAAoB,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC;QAEnF;YACE,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,KAAyB,EAAU,EAAE;IACnE,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,KAAK,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;IAEjF,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,6BAA6B,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC3G,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,CAAC,KAAwB,EAAU,EAAE;IACzE,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,wBAAwB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,oBAAoB,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,sBAAsB,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AACvE,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,KAAyB,EAAsB,EAAE;IAC1F,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,6BAA6B,CAAC,KAAK,CAAC,CAAC;AAC9C,CAAC,CAAC","sourcesContent":["import {\n  KvsAdvancedDataType,\n  KvsLogicalOperator,\n  KvsLogicalOperatorType,\n  KvsQueryCondition,\n  KvsQueryOperation,\n  KvsQueryOperationType,\n} from 'quidproquo-core';\n\nimport { getItemName } from './getItemName';\nimport { getValueName } from './getValueName';\nimport { isKvsLogicalOperator } from './isKvsLogicalOperator';\nimport { isKvsQueryCondition } from './isKvsQueryCondition';\n\n// Fail fast on a missing value: rendering a placeholder for undefined would\n// build an expression whose placeholder never appears in\n// ExpressionAttributeValues, which DynamoDB rejects with a confusing error.\nconst getRequiredValueName = (query: KvsQueryCondition, value?: KvsAdvancedDataType): string => {\n  if (value === undefined) {\n    throw new Error(`Invalid query condition ${query.operation}: missing value for key [${query.key}]`);\n  }\n\n  return getValueName(value);\n};\n\nconst comparisonOperators: Partial<Record<KvsQueryOperationType, string>> = {\n  [KvsQueryOperationType.Equal]: '=',\n  [KvsQueryOperationType.NotEqual]: '<>',\n  [KvsQueryOperationType.LessThan]: '<',\n  [KvsQueryOperationType.LessThanOrEqual]: '<=',\n  [KvsQueryOperationType.GreaterThan]: '>',\n  [KvsQueryOperationType.GreaterThanOrEqual]: '>=',\n};\n\nconst buildConditionExpression = (query: KvsQueryCondition): string => {\n  const itemName = getItemName(query.key);\n\n  switch (query.operation) {\n    case KvsQueryOperationType.Equal:\n    case KvsQueryOperationType.NotEqual:\n    case KvsQueryOperationType.LessThan:\n    case KvsQueryOperationType.LessThanOrEqual:\n    case KvsQueryOperationType.GreaterThan:\n    case KvsQueryOperationType.GreaterThanOrEqual:\n      return `${itemName} ${comparisonOperators[query.operation]} ${getRequiredValueName(query, query.valueA)}`;\n\n    case KvsQueryOperationType.Between:\n      return `${itemName} BETWEEN ${getRequiredValueName(query, query.valueA)} AND ${getRequiredValueName(query, query.valueB)}`;\n\n    case KvsQueryOperationType.In:\n      if (!Array.isArray(query.valueA)) {\n        throw new Error(`Invalid query condition ${query.operation}: expected an array of values for key [${query.key}]`);\n      }\n      return `${itemName} IN (${query.valueA.map((value) => getValueName(value)).join(', ')})`;\n\n    case KvsQueryOperationType.Exists:\n      return `attribute_exists(${itemName})`;\n\n    case KvsQueryOperationType.NotExists:\n      return `attribute_not_exists(${itemName})`;\n\n    case KvsQueryOperationType.BeginsWith:\n      return `begins_with(${itemName}, ${getRequiredValueName(query, query.valueA)})`;\n\n    case KvsQueryOperationType.Contains:\n      return `contains(${itemName}, ${getRequiredValueName(query, query.valueA)})`;\n\n    case KvsQueryOperationType.NotContains:\n      return `NOT contains(${itemName}, ${getRequiredValueName(query, query.valueA)})`;\n\n    default:\n      throw new Error(`Invalid query operation: ${JSON.stringify(query)}`);\n  }\n};\n\nconst buildLogicalExpression = (query: KvsLogicalOperator): string => {\n  const joiner = query.operation === KvsLogicalOperatorType.And ? ' AND ' : ' OR ';\n\n  return query.conditions.map((condition) => `(${buildQueryOperationExpression(condition)})`).join(joiner);\n};\n\nconst buildQueryOperationExpression = (query: KvsQueryOperation): string => {\n  if (isKvsQueryCondition(query)) {\n    return buildConditionExpression(query);\n  }\n\n  if (isKvsLogicalOperator(query)) {\n    return buildLogicalExpression(query);\n  }\n\n  throw new Error(`Invalid query operation: ${JSON.stringify(query)}`);\n};\n\n/**\n * Render a kvs query tree as a DynamoDB expression string. Attribute names and\n * values are replaced with hashed placeholders; pair the result with\n * buildExpressionAttributeNames / buildExpressionAttributeValues over the same\n * queries. Returns undefined (not null) when there is no query so the result\n * can feed optional SDK command fields (FilterExpression and friends) directly.\n */\nexport const buildDynamoQueryExpression = (query?: KvsQueryOperation): string | undefined => {\n  if (!query) {\n    return undefined;\n  }\n\n  return buildQueryOperationExpression(query);\n};\n"]}

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildDynamoUpdateExpression.d.ts

@@ -0,0 +1,9 @@
+import { KvsUpdate } from 'quidproquo-core';
+/**
+ * Render a kvs update as a DynamoDB UpdateExpression, grouping actions into
+ * SET / REMOVE / ADD / DELETE clauses. Attribute names and values are replaced
+ * with hashed placeholders; pair the result with
+ * buildUpdateExpressionAttributeNames / buildUpdateExpressionAttributeValues
+ * over the same updates.
+ */
+export declare const buildDynamoUpdateExpression: (updates: KvsUpdate) => string;

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildDynamoUpdateExpression.js

@@ -0,0 +1,103 @@
+import { KvsUpdateActionType } from 'quidproquo-core';
+import { getItemName } from './getItemName';
+import { getValueName } from './getValueName';
+const getNestedItemName = (attributePath) => {
+    if (!Array.isArray(attributePath)) {
+        return getItemName(attributePath);
+    }
+    const parts = attributePath.map((segment) => {
+        if (typeof segment === 'string') {
+            return `.${getItemName(segment)}`;
+        }
+        // Only non-negative integers may be interpolated raw: anything else that
+        // sneaks past the types (via JSON payloads) would be stringified straight
+        // into the update expression, which is expression injection.
+        if (typeof segment === 'number' && Number.isInteger(segment) && segment >= 0) {
+            return `[${segment}]`;
+        }
+        throw new Error(`Invalid attribute path segment: ${JSON.stringify(segment)}`);
+    });
+    return parts.join('').replace(/^\./, '');
+};
+const buildSetPart = (update) => {
+    if (update.value === undefined || update.value === null) {
+        throw new Error("Value must be provided for 'SET' action");
+    }
+    return `${getNestedItemName(update.attributePath)} = ${getValueName(update.value)}`;
+};
+const buildRemovePart = (update) => {
+    return getNestedItemName(update.attributePath);
+};
+const buildAddPart = (update) => {
+    if (update.value === undefined || update.value === null) {
+        throw new Error("Value must be provided for 'ADD' action");
+    }
+    return `${getNestedItemName(update.attributePath)} ${getValueName(update.value)}`;
+};
+const buildDeletePart = (update) => {
+    if (update.value !== undefined && update.value !== null) {
+        return `${getNestedItemName(update.attributePath)} ${getValueName(update.value)}`;
+    }
+    return getNestedItemName(update.attributePath);
+};
+const buildSetIfNotExistsPart = (update) => {
+    if (update.value === undefined || update.value === null) {
+        throw new Error("Value must be provided for 'SetIfNotExists' action");
+    }
+    const attrPath = getNestedItemName(update.attributePath);
+    return `${attrPath} = if_not_exists(${attrPath}, ${getValueName(update.value)})`;
+};
+const buildIncrementPart = (update) => {
+    if (update.value === undefined || update.value === null) {
+        throw new Error("Increment value must be provided for 'Increment' action");
+    }
+    if (update.defaultValue === undefined || update.defaultValue === null) {
+        throw new Error("Default value must be provided for 'Increment' action");
+    }
+    const attrPath = getNestedItemName(update.attributePath);
+    return `${attrPath} = if_not_exists(${attrPath}, ${getValueName(update.defaultValue)}) + ${getValueName(update.value)}`;
+};
+const buildUpdateExpressionPart = (update) => {
+    switch (update.action) {
+        case KvsUpdateActionType.Set:
+            return buildSetPart(update);
+        case KvsUpdateActionType.Remove:
+            return buildRemovePart(update);
+        case KvsUpdateActionType.Add:
+            return buildAddPart(update);
+        case KvsUpdateActionType.Delete:
+            return buildDeletePart(update);
+        case KvsUpdateActionType.SetIfNotExists:
+            return buildSetIfNotExistsPart(update);
+        case KvsUpdateActionType.Increment:
+            return buildIncrementPart(update);
+        default:
+            throw new Error(`Invalid update action type: ${update.action}`);
+    }
+};
+// SetIfNotExists and Increment render as SET clauses too.
+const setActionTypes = [KvsUpdateActionType.Set, KvsUpdateActionType.SetIfNotExists, KvsUpdateActionType.Increment];
+const buildClause = (clause, actionTypes, kvsUpdate) => {
+    const actions = kvsUpdate.filter((update) => actionTypes.includes(update.action));
+    if (actions.length === 0) {
+        return '';
+    }
+    return `${clause} ${actions.map((update) => buildUpdateExpressionPart(update)).join(', ')}`;
+};
+/**
+ * Render a kvs update as a DynamoDB UpdateExpression, grouping actions into
+ * SET / REMOVE / ADD / DELETE clauses. Attribute names and values are replaced
+ * with hashed placeholders; pair the result with
+ * buildUpdateExpressionAttributeNames / buildUpdateExpressionAttributeValues
+ * over the same updates.
+ */
+export const buildDynamoUpdateExpression = (updates) => {
+    const clauses = [
+        buildClause('SET', setActionTypes, updates),
+        buildClause('REMOVE', [KvsUpdateActionType.Remove], updates),
+        buildClause('ADD', [KvsUpdateActionType.Add], updates),
+        buildClause('DELETE', [KvsUpdateActionType.Delete], updates),
+    ].filter((expression) => !!expression);
+    return clauses.join(' ');
+};
+//# sourceMappingURL=buildDynamoUpdateExpression.js.map

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildDynamoUpdateExpression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildDynamoUpdateExpression.js","sourceRoot":"","sources":["../../../../../src/logic/dynamo/qpqDynamoOrm/buildDynamoUpdateExpression.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgD,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEpG,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,MAAM,iBAAiB,GAAG,CAAC,aAA+B,EAAU,EAAE;IACpE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;QAClC,OAAO,WAAW,CAAC,aAAa,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,KAAK,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QAC1C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChC,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;QACpC,CAAC;QAED,yEAAyE;QACzE,0EAA0E;QAC1E,6DAA6D;QAC7D,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,IAAI,CAAC,EAAE,CAAC;YAC7E,OAAO,IAAI,OAAO,GAAG,CAAC;QACxB,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,mCAAmC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,MAAuB,EAAU,EAAE;IACvD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AACtF,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,MAAuB,EAAU,EAAE;IAC1D,OAAO,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,MAAuB,EAAU,EAAE;IACvD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AACpF,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,MAAuB,EAAU,EAAE;IAC1D,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;QACxD,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IACpF,CAAC;IAED,OAAO,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,MAAuB,EAAU,EAAE;IAClE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,QAAQ,GAAG,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IACzD,OAAO,GAAG,QAAQ,oBAAoB,QAAQ,KAAK,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;AACnF,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,MAAuB,EAAU,EAAE;IAC7D,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;IAC7E,CAAC;IACD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,IAAI,MAAM,CAAC,YAAY,KAAK,IAAI,EAAE,CAAC;QACtE,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC3E,CAAC;IAED,MAAM,QAAQ,GAAG,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IACzD,OAAO,GAAG,QAAQ,oBAAoB,QAAQ,KAAK,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AAC1H,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAAC,MAAuB,EAAU,EAAE;IACpE,QAAQ,MAAM,CAAC,MAAM,EAAE,CAAC;QACtB,KAAK,mBAAmB,CAAC,GAAG;YAC1B,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;QAC9B,KAAK,mBAAmB,CAAC,MAAM;YAC7B,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;QACjC,KAAK,mBAAmB,CAAC,GAAG;YAC1B,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;QAC9B,KAAK,mBAAmB,CAAC,MAAM;YAC7B,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;QACjC,KAAK,mBAAmB,CAAC,cAAc;YACrC,OAAO,uBAAuB,CAAC,MAAM,CAAC,CAAC;QACzC,KAAK,mBAAmB,CAAC,SAAS;YAChC,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACpC;YACE,MAAM,IAAI,KAAK,CAAC,+BAA+B,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACpE,CAAC;AACH,CAAC,CAAC;AAEF,0DAA0D;AAC1D,MAAM,cAAc,GAAG,CAAC,mBAAmB,CAAC,GAAG,EAAE,mBAAmB,CAAC,cAAc,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC;AAEpH,MAAM,WAAW,GAAG,CAAC,MAA2C,EAAE,WAAkC,EAAE,SAAoB,EAAU,EAAE;IACpI,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAElF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,GAAG,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AAC9F,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,OAAkB,EAAU,EAAE;IACxE,MAAM,OAAO,GAAG;QACd,WAAW,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,CAAC;QAC3C,WAAW,CAAC,QAAQ,EAAE,CAAC,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;QAC5D,WAAW,CAAC,KAAK,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;QACtD,WAAW,CAAC,QAAQ,EAAE,CAAC,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;KAC7D,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAEvC,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3B,CAAC,CAAC","sourcesContent":["import { KvsAttributePath, KvsUpdate, KvsUpdateAction, KvsUpdateActionType } from 'quidproquo-core';\n\nimport { getItemName } from './getItemName';\nimport { getValueName } from './getValueName';\n\nconst getNestedItemName = (attributePath: KvsAttributePath): string => {\n  if (!Array.isArray(attributePath)) {\n    return getItemName(attributePath);\n  }\n\n  const parts = attributePath.map((segment) => {\n    if (typeof segment === 'string') {\n      return `.${getItemName(segment)}`;\n    }\n\n    // Only non-negative integers may be interpolated raw: anything else that\n    // sneaks past the types (via JSON payloads) would be stringified straight\n    // into the update expression, which is expression injection.\n    if (typeof segment === 'number' && Number.isInteger(segment) && segment >= 0) {\n      return `[${segment}]`;\n    }\n\n    throw new Error(`Invalid attribute path segment: ${JSON.stringify(segment)}`);\n  });\n\n  return parts.join('').replace(/^\\./, '');\n};\n\nconst buildSetPart = (update: KvsUpdateAction): string => {\n  if (update.value === undefined || update.value === null) {\n    throw new Error(\"Value must be provided for 'SET' action\");\n  }\n\n  return `${getNestedItemName(update.attributePath)} = ${getValueName(update.value)}`;\n};\n\nconst buildRemovePart = (update: KvsUpdateAction): string => {\n  return getNestedItemName(update.attributePath);\n};\n\nconst buildAddPart = (update: KvsUpdateAction): string => {\n  if (update.value === undefined || update.value === null) {\n    throw new Error(\"Value must be provided for 'ADD' action\");\n  }\n\n  return `${getNestedItemName(update.attributePath)} ${getValueName(update.value)}`;\n};\n\nconst buildDeletePart = (update: KvsUpdateAction): string => {\n  if (update.value !== undefined && update.value !== null) {\n    return `${getNestedItemName(update.attributePath)} ${getValueName(update.value)}`;\n  }\n\n  return getNestedItemName(update.attributePath);\n};\n\nconst buildSetIfNotExistsPart = (update: KvsUpdateAction): string => {\n  if (update.value === undefined || update.value === null) {\n    throw new Error(\"Value must be provided for 'SetIfNotExists' action\");\n  }\n\n  const attrPath = getNestedItemName(update.attributePath);\n  return `${attrPath} = if_not_exists(${attrPath}, ${getValueName(update.value)})`;\n};\n\nconst buildIncrementPart = (update: KvsUpdateAction): string => {\n  if (update.value === undefined || update.value === null) {\n    throw new Error(\"Increment value must be provided for 'Increment' action\");\n  }\n  if (update.defaultValue === undefined || update.defaultValue === null) {\n    throw new Error(\"Default value must be provided for 'Increment' action\");\n  }\n\n  const attrPath = getNestedItemName(update.attributePath);\n  return `${attrPath} = if_not_exists(${attrPath}, ${getValueName(update.defaultValue)}) + ${getValueName(update.value)}`;\n};\n\nconst buildUpdateExpressionPart = (update: KvsUpdateAction): string => {\n  switch (update.action) {\n    case KvsUpdateActionType.Set:\n      return buildSetPart(update);\n    case KvsUpdateActionType.Remove:\n      return buildRemovePart(update);\n    case KvsUpdateActionType.Add:\n      return buildAddPart(update);\n    case KvsUpdateActionType.Delete:\n      return buildDeletePart(update);\n    case KvsUpdateActionType.SetIfNotExists:\n      return buildSetIfNotExistsPart(update);\n    case KvsUpdateActionType.Increment:\n      return buildIncrementPart(update);\n    default:\n      throw new Error(`Invalid update action type: ${update.action}`);\n  }\n};\n\n// SetIfNotExists and Increment render as SET clauses too.\nconst setActionTypes = [KvsUpdateActionType.Set, KvsUpdateActionType.SetIfNotExists, KvsUpdateActionType.Increment];\n\nconst buildClause = (clause: 'SET' | 'REMOVE' | 'ADD' | 'DELETE', actionTypes: KvsUpdateActionType[], kvsUpdate: KvsUpdate): string => {\n  const actions = kvsUpdate.filter((update) => actionTypes.includes(update.action));\n\n  if (actions.length === 0) {\n    return '';\n  }\n\n  return `${clause} ${actions.map((update) => buildUpdateExpressionPart(update)).join(', ')}`;\n};\n\n/**\n * Render a kvs update as a DynamoDB UpdateExpression, grouping actions into\n * SET / REMOVE / ADD / DELETE clauses. Attribute names and values are replaced\n * with hashed placeholders; pair the result with\n * buildUpdateExpressionAttributeNames / buildUpdateExpressionAttributeValues\n * over the same updates.\n */\nexport const buildDynamoUpdateExpression = (updates: KvsUpdate): string => {\n  const clauses = [\n    buildClause('SET', setActionTypes, updates),\n    buildClause('REMOVE', [KvsUpdateActionType.Remove], updates),\n    buildClause('ADD', [KvsUpdateActionType.Add], updates),\n    buildClause('DELETE', [KvsUpdateActionType.Delete], updates),\n  ].filter((expression) => !!expression);\n\n  return clauses.join(' ');\n};\n"]}

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildExpressionAttributeNames.d.ts

@@ -0,0 +1,7 @@
+import { KvsQueryOperation } from 'quidproquo-core';
+/**
+ * Collect the #placeholder -> attribute-name map for every key referenced by
+ * the given query expressions. Returns undefined (not null) when empty so it
+ * can feed the optional ExpressionAttributeNames SDK field directly.
+ */
+export declare const buildExpressionAttributeNames: (queries: (KvsQueryOperation | undefined)[]) => Record<string, string> | undefined;

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildExpressionAttributeNames.js

@@ -0,0 +1,20 @@
+import { flattenKvsQueryConditions } from './flattenKvsQueryConditions';
+import { getItemName } from './getItemName';
+/**
+ * Collect the #placeholder -> attribute-name map for every key referenced by
+ * the given query expressions. Returns undefined (not null) when empty so it
+ * can feed the optional ExpressionAttributeNames SDK field directly.
+ */
+export const buildExpressionAttributeNames = (queries) => {
+    const names = {};
+    for (const query of queries) {
+        if (!query) {
+            continue;
+        }
+        for (const condition of flattenKvsQueryConditions(query)) {
+            names[getItemName(condition.key)] = condition.key;
+        }
+    }
+    return Object.keys(names).length > 0 ? names : undefined;
+};
+//# sourceMappingURL=buildExpressionAttributeNames.js.map

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildExpressionAttributeNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildExpressionAttributeNames.js","sourceRoot":"","sources":["../../../../../src/logic/dynamo/qpqDynamoOrm/buildExpressionAttributeNames.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,OAA0C,EAAsC,EAAE;IAC9H,MAAM,KAAK,GAA2B,EAAE,CAAC;IAEzC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,SAAS;QACX,CAAC;QAED,KAAK,MAAM,SAAS,IAAI,yBAAyB,CAAC,KAAK,CAAC,EAAE,CAAC;YACzD,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC;QACpD,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3D,CAAC,CAAC","sourcesContent":["import { KvsQueryOperation } from 'quidproquo-core';\n\nimport { flattenKvsQueryConditions } from './flattenKvsQueryConditions';\nimport { getItemName } from './getItemName';\n\n/**\n * Collect the #placeholder -> attribute-name map for every key referenced by\n * the given query expressions. Returns undefined (not null) when empty so it\n * can feed the optional ExpressionAttributeNames SDK field directly.\n */\nexport const buildExpressionAttributeNames = (queries: (KvsQueryOperation | undefined)[]): Record<string, string> | undefined => {\n  const names: Record<string, string> = {};\n\n  for (const query of queries) {\n    if (!query) {\n      continue;\n    }\n\n    for (const condition of flattenKvsQueryConditions(query)) {\n      names[getItemName(condition.key)] = condition.key;\n    }\n  }\n\n  return Object.keys(names).length > 0 ? names : undefined;\n};\n"]}

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildExpressionAttributeValues.d.ts

@@ -0,0 +1,8 @@
+import { KvsQueryOperation } from 'quidproquo-core';
+import { AttributeValue } from '@aws-sdk/client-dynamodb';
+/**
+ * Collect the :placeholder -> AttributeValue map for every value referenced by
+ * the given query expressions. Returns undefined (not null) when empty so it
+ * can feed the optional ExpressionAttributeValues SDK field directly.
+ */
+export declare const buildExpressionAttributeValues: (queries: (KvsQueryOperation | undefined)[]) => Record<string, AttributeValue> | undefined;

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildExpressionAttributeValues.js

@@ -0,0 +1,35 @@
+import { KvsQueryOperationType } from 'quidproquo-core';
+import { buildAttributeValue } from './buildAttributeValue';
+import { flattenKvsQueryConditions } from './flattenKvsQueryConditions';
+import { getValueName } from './getValueName';
+// IN renders one placeholder per element, every other operation references
+// its value(s) whole; the collected values must mirror that exactly or
+// DynamoDB rejects the expression.
+const getConditionValues = (condition) => {
+    if (condition.operation === KvsQueryOperationType.In && Array.isArray(condition.valueA)) {
+        return condition.valueA;
+    }
+    return [condition.valueA, condition.valueB];
+};
+/**
+ * Collect the :placeholder -> AttributeValue map for every value referenced by
+ * the given query expressions. Returns undefined (not null) when empty so it
+ * can feed the optional ExpressionAttributeValues SDK field directly.
+ */
+export const buildExpressionAttributeValues = (queries) => {
+    const values = {};
+    for (const query of queries) {
+        if (!query) {
+            continue;
+        }
+        for (const condition of flattenKvsQueryConditions(query)) {
+            for (const value of getConditionValues(condition)) {
+                if (value !== undefined) {
+                    values[getValueName(value)] = buildAttributeValue(value);
+                }
+            }
+        }
+    }
+    return Object.keys(values).length > 0 ? values : undefined;
+};
+//# sourceMappingURL=buildExpressionAttributeValues.js.map

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildExpressionAttributeValues.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildExpressionAttributeValues.js","sourceRoot":"","sources":["../../../../../src/logic/dynamo/qpqDynamoOrm/buildExpressionAttributeValues.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6D,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAInH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,2EAA2E;AAC3E,uEAAuE;AACvE,mCAAmC;AACnC,MAAM,kBAAkB,GAAG,CAAC,SAA4B,EAAuC,EAAE;IAC/F,IAAI,SAAS,CAAC,SAAS,KAAK,qBAAqB,CAAC,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QACxF,OAAO,SAAS,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;AAC9C,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,OAA0C,EAA8C,EAAE;IACvI,MAAM,MAAM,GAAmC,EAAE,CAAC;IAElD,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,SAAS;QACX,CAAC;QAED,KAAK,MAAM,SAAS,IAAI,yBAAyB,CAAC,KAAK,CAAC,EAAE,CAAC;YACzD,KAAK,MAAM,KAAK,IAAI,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;gBAClD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7D,CAAC,CAAC","sourcesContent":["import { KvsAdvancedDataType, KvsQueryCondition, KvsQueryOperation, KvsQueryOperationType } from 'quidproquo-core';\n\nimport { AttributeValue } from '@aws-sdk/client-dynamodb';\n\nimport { buildAttributeValue } from './buildAttributeValue';\nimport { flattenKvsQueryConditions } from './flattenKvsQueryConditions';\nimport { getValueName } from './getValueName';\n\n// IN renders one placeholder per element, every other operation references\n// its value(s) whole; the collected values must mirror that exactly or\n// DynamoDB rejects the expression.\nconst getConditionValues = (condition: KvsQueryCondition): (KvsAdvancedDataType | undefined)[] => {\n  if (condition.operation === KvsQueryOperationType.In && Array.isArray(condition.valueA)) {\n    return condition.valueA;\n  }\n\n  return [condition.valueA, condition.valueB];\n};\n\n/**\n * Collect the :placeholder -> AttributeValue map for every value referenced by\n * the given query expressions. Returns undefined (not null) when empty so it\n * can feed the optional ExpressionAttributeValues SDK field directly.\n */\nexport const buildExpressionAttributeValues = (queries: (KvsQueryOperation | undefined)[]): Record<string, AttributeValue> | undefined => {\n  const values: Record<string, AttributeValue> = {};\n\n  for (const query of queries) {\n    if (!query) {\n      continue;\n    }\n\n    for (const condition of flattenKvsQueryConditions(query)) {\n      for (const value of getConditionValues(condition)) {\n        if (value !== undefined) {\n          values[getValueName(value)] = buildAttributeValue(value);\n        }\n      }\n    }\n  }\n\n  return Object.keys(values).length > 0 ? values : undefined;\n};\n"]}

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildUpdateExpressionAttributeNames.d.ts

@@ -0,0 +1,7 @@
+import { KvsUpdate } from 'quidproquo-core';
+/**
+ * Collect the #placeholder -> attribute-name map for every string segment of
+ * every update's attribute path (numeric segments are list indexes and are
+ * rendered inline, not as names). Does not modify the given updates.
+ */
+export declare const buildUpdateExpressionAttributeNames: (updates: KvsUpdate) => Record<string, string>;

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildUpdateExpressionAttributeNames.js

@@ -0,0 +1,19 @@
+import { getItemName } from './getItemName';
+/**
+ * Collect the #placeholder -> attribute-name map for every string segment of
+ * every update's attribute path (numeric segments are list indexes and are
+ * rendered inline, not as names). Does not modify the given updates.
+ */
+export const buildUpdateExpressionAttributeNames = (updates) => {
+    const attributeNames = {};
+    for (const update of updates) {
+        const segments = Array.isArray(update.attributePath) ? update.attributePath : [update.attributePath];
+        for (const segment of segments) {
+            if (typeof segment === 'string') {
+                attributeNames[getItemName(segment)] = segment;
+            }
+        }
+    }
+    return attributeNames;
+};
+//# sourceMappingURL=buildUpdateExpressionAttributeNames.js.map

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildUpdateExpressionAttributeNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildUpdateExpressionAttributeNames.js","sourceRoot":"","sources":["../../../../../src/logic/dynamo/qpqDynamoOrm/buildUpdateExpressionAttributeNames.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;GAIG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,OAAkB,EAA0B,EAAE;IAChG,MAAM,cAAc,GAA2B,EAAE,CAAC;IAElD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAErG,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAChC,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC;YACjD,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC","sourcesContent":["import { KvsUpdate } from 'quidproquo-core';\n\nimport { getItemName } from './getItemName';\n\n/**\n * Collect the #placeholder -> attribute-name map for every string segment of\n * every update's attribute path (numeric segments are list indexes and are\n * rendered inline, not as names). Does not modify the given updates.\n */\nexport const buildUpdateExpressionAttributeNames = (updates: KvsUpdate): Record<string, string> => {\n  const attributeNames: Record<string, string> = {};\n\n  for (const update of updates) {\n    const segments = Array.isArray(update.attributePath) ? update.attributePath : [update.attributePath];\n\n    for (const segment of segments) {\n      if (typeof segment === 'string') {\n        attributeNames[getItemName(segment)] = segment;\n      }\n    }\n  }\n\n  return attributeNames;\n};\n"]}

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildUpdateExpressionAttributeValues.d.ts

@@ -0,0 +1,9 @@
+import { KvsUpdate } from 'quidproquo-core';
+import { AttributeValue } from '@aws-sdk/client-dynamodb';
+/**
+ * Collect the :placeholder -> AttributeValue map for every value (and
+ * Increment defaultValue) referenced by the given updates. Returns undefined
+ * (not null) when empty so it can feed the optional
+ * ExpressionAttributeValues SDK field directly.
+ */
+export declare const buildUpdateExpressionAttributeValues: (updates: KvsUpdate) => Record<string, AttributeValue> | undefined;

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildUpdateExpressionAttributeValues.js

@@ -0,0 +1,21 @@
+import { buildAttributeValue } from './buildAttributeValue';
+import { getValueName } from './getValueName';
+/**
+ * Collect the :placeholder -> AttributeValue map for every value (and
+ * Increment defaultValue) referenced by the given updates. Returns undefined
+ * (not null) when empty so it can feed the optional
+ * ExpressionAttributeValues SDK field directly.
+ */
+export const buildUpdateExpressionAttributeValues = (updates) => {
+    const attributeValues = {};
+    for (const update of updates) {
+        if (update.value !== undefined && update.value !== null) {
+            attributeValues[getValueName(update.value)] = buildAttributeValue(update.value);
+        }
+        if (update.defaultValue !== undefined && update.defaultValue !== null) {
+            attributeValues[getValueName(update.defaultValue)] = buildAttributeValue(update.defaultValue);
+        }
+    }
+    return Object.keys(attributeValues).length > 0 ? attributeValues : undefined;
+};
+//# sourceMappingURL=buildUpdateExpressionAttributeValues.js.map

package/lib/esm/logic/dynamo/qpqDynamoOrm/buildUpdateExpressionAttributeValues.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildUpdateExpressionAttributeValues.js","sourceRoot":"","sources":["../../../../../src/logic/dynamo/qpqDynamoOrm/buildUpdateExpressionAttributeValues.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC,OAAkB,EAA8C,EAAE;IACrH,MAAM,eAAe,GAAmC,EAAE,CAAC;IAE3D,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;YACxD,eAAe,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAClF,CAAC;QAED,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,IAAI,MAAM,CAAC,YAAY,KAAK,IAAI,EAAE,CAAC;YACtE,eAAe,CAAC,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,mBAAmB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAChG,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;AAC/E,CAAC,CAAC","sourcesContent":["import { KvsUpdate } from 'quidproquo-core';\n\nimport { AttributeValue } from '@aws-sdk/client-dynamodb';\n\nimport { buildAttributeValue } from './buildAttributeValue';\nimport { getValueName } from './getValueName';\n\n/**\n * Collect the :placeholder -> AttributeValue map for every value (and\n * Increment defaultValue) referenced by the given updates. Returns undefined\n * (not null) when empty so it can feed the optional\n * ExpressionAttributeValues SDK field directly.\n */\nexport const buildUpdateExpressionAttributeValues = (updates: KvsUpdate): Record<string, AttributeValue> | undefined => {\n  const attributeValues: Record<string, AttributeValue> = {};\n\n  for (const update of updates) {\n    if (update.value !== undefined && update.value !== null) {\n      attributeValues[getValueName(update.value)] = buildAttributeValue(update.value);\n    }\n\n    if (update.defaultValue !== undefined && update.defaultValue !== null) {\n      attributeValues[getValueName(update.defaultValue)] = buildAttributeValue(update.defaultValue);\n    }\n  }\n\n  return Object.keys(attributeValues).length > 0 ? attributeValues : undefined;\n};\n"]}

package/lib/esm/logic/dynamo/qpqDynamoOrm/flattenKvsQueryConditions.d.ts

@@ -0,0 +1,3 @@
+import { KvsQueryCondition, KvsQueryOperation } from 'quidproquo-core';
+/** Flatten a query tree into its leaf conditions, in traversal order. */
+export declare const flattenKvsQueryConditions: (query: KvsQueryOperation) => KvsQueryCondition[];

package/lib/esm/logic/dynamo/qpqDynamoOrm/flattenKvsQueryConditions.js

@@ -0,0 +1,13 @@
+import { isKvsLogicalOperator } from './isKvsLogicalOperator';
+import { isKvsQueryCondition } from './isKvsQueryCondition';
+/** Flatten a query tree into its leaf conditions, in traversal order. */
+export const flattenKvsQueryConditions = (query) => {
+    if (isKvsQueryCondition(query)) {
+        return [query];
+    }
+    if (isKvsLogicalOperator(query)) {
+        return query.conditions.flatMap(flattenKvsQueryConditions);
+    }
+    return [];
+};
+//# sourceMappingURL=flattenKvsQueryConditions.js.map

package/lib/esm/logic/dynamo/qpqDynamoOrm/flattenKvsQueryConditions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flattenKvsQueryConditions.js","sourceRoot":"","sources":["../../../../../src/logic/dynamo/qpqDynamoOrm/flattenKvsQueryConditions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,yEAAyE;AACzE,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,KAAwB,EAAuB,EAAE;IACzF,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,oBAAoB,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC","sourcesContent":["import { KvsQueryCondition, KvsQueryOperation } from 'quidproquo-core';\n\nimport { isKvsLogicalOperator } from './isKvsLogicalOperator';\nimport { isKvsQueryCondition } from './isKvsQueryCondition';\n\n/** Flatten a query tree into its leaf conditions, in traversal order. */\nexport const flattenKvsQueryConditions = (query: KvsQueryOperation): KvsQueryCondition[] => {\n  if (isKvsQueryCondition(query)) {\n    return [query];\n  }\n  if (isKvsLogicalOperator(query)) {\n    return query.conditions.flatMap(flattenKvsQueryConditions);\n  }\n  return [];\n};\n"]}

package/lib/esm/logic/dynamo/qpqDynamoOrm/getDynamoTableIndexByConfigAndQuery.d.ts

@@ -1,2 +1,7 @@
-import { KeyValueStoreQPQConfigSetting, KvsQueryOperation } from 'quidproquo-core';
-export declare const getDynamoTableIndexByConfigAndQuery: <T extends object = any>(setting: KeyValueStoreQPQConfigSetting, query: KvsQueryOperation) => string | undefined;
+import { KeyValueStoreQPQConfigSetting, KvsQueryOperation, Nullable } from 'quidproquo-core';
+/**
+ * Pick the GSI that can serve the query, or null to query the primary table.
+ * Returns the GSI's partition key name, which is also its index name (the CDK
+ * construct names each GSI after its partition key).
+ */
+export declare const getDynamoTableIndexByConfigAndQuery: (setting: KeyValueStoreQPQConfigSetting, query: KvsQueryOperation) => Nullable<string>;

package/lib/esm/logic/dynamo/qpqDynamoOrm/getDynamoTableIndexByConfigAndQuery.js

@@ -1,28 +1,19 @@
-import { isKvsLogicalOperator, isKvsQueryCondition } from './buildDynamoQuery';
+import { flattenKvsQueryConditions } from './flattenKvsQueryConditions';
+/**
+ * Pick the GSI that can serve the query, or null to query the primary table.
+ * Returns the GSI's partition key name, which is also its index name (the CDK
+ * construct names each GSI after its partition key).
+ */
 export const getDynamoTableIndexByConfigAndQuery = (setting, query) => {
-    // Function to extract keys from a query
-    const extractKeysFromQuery = (query) => {
-        if (isKvsQueryCondition(query)) {
-            return [query.key];
-        }
-        else if (isKvsLogicalOperator(query)) {
-            return query.conditions.flatMap(extractKeysFromQuery);
-        }
-        return [];
-    };
-    const queriedKeys = extractKeysFromQuery(query);
-    // If the query includes the primary sort key, the primary table is a direct match —
-    // prefer it over any GSI so we never land on a GSI with a non-SK condition.
+    const queriedKeys = flattenKvsQueryConditions(query).map((condition) => condition.key);
+    // If the query includes the primary sort key, the primary table is a direct
+    // match: prefer it over any GSI so we never land on a GSI with a non-SK
+    // condition.
     const primarySortKey = setting.sortKeys[0]?.key;
     if (primarySortKey && queriedKeys.includes(primarySortKey)) {
-        return undefined;
+        return null;
     }
-    // Find a GSI whose partition key is in the query.
-    for (const index of setting.indexes) {
-        if (queriedKeys.includes(index.partitionKey.key)) {
-            return index.partitionKey.key;
-        }
-    }
-    return undefined;
+    const matchingIndex = setting.indexes.find((index) => queriedKeys.includes(index.partitionKey.key));
+    return matchingIndex ? matchingIndex.partitionKey.key : null;
 };
 //# sourceMappingURL=getDynamoTableIndexByConfigAndQuery.js.map