@jaypie/constructs 1.2.42 → 1.2.43

package/dist/esm/JaypieDynamoDb.d.ts

@@ -6,25 +6,23 @@ export interface JaypieDynamoDbProps extends Omit<dynamodb.TablePropsV2, "global
     /**
      * Configure GSIs for the table using @jaypie/fabric IndexDefinition format.
      * - `undefined`: No GSIs (default)
-     * - Array of IndexDefinition: Use the specified indexes
+     * - Array of IndexDefinition: Use the specified indexes (prefer fabricIndex())
      *
      * @example
      * // No GSIs (default)
      * new JaypieDynamoDb(this, "myTable");
      *
      * @example
-     * // With custom indexes
+     * // With fabricIndex-shaped indexes
+     * import { fabricIndex } from "@jaypie/fabric";
      * new JaypieDynamoDb(this, "myTable", {
-     *   indexes: [
-     *     { pk: ["scope", "model"], sk: ["sequence"] },
-     *     { pk: ["scope", "model", "type"], sk: ["sequence"], sparse: true },
-     *   ],
+     *   indexes: [fabricIndex(), fabricIndex("alias"), fabricIndex("xid")],
      * });
      */
     indexes?: IndexDefinition[];
     /**
      * Partition key attribute definition.
-     * @default { name: "model", type: AttributeType.STRING }
+     * @default { name: "id", type: AttributeType.STRING }
      */
     partitionKey?: dynamodb.Attribute;
     /**
@@ -40,8 +38,8 @@ export interface JaypieDynamoDbProps extends Omit<dynamodb.TablePropsV2, "global
      */
     service?: string;
     /**
-     * Sort key attribute definition.
-     * @default { name: "id", type: AttributeType.STRING }
+     * Sort key attribute definition. Defaults to `undefined` (no sort key) —
+     * the Jaypie single-table pattern uses `id` as a unique partition key.
      */
     sortKey?: dynamodb.Attribute;
     /**
@@ -53,8 +51,7 @@ export interface JaypieDynamoDbProps extends Omit<dynamodb.TablePropsV2, "global
  * DynamoDB table with Jaypie single-table design patterns.
  *
  * Creates a table with:
- * - Partition key: `model` (String)
- * - Sort key: `id` (String)
+ * - Partition key: `id` (String), no sort key
  * - Billing: PAY_PER_REQUEST (on-demand)
  * - Removal policy: RETAIN in production, DESTROY otherwise
  * - No GSIs by default (use `indexes` prop to add them)
@@ -65,13 +62,11 @@ export interface JaypieDynamoDbProps extends Omit<dynamodb.TablePropsV2, "global
  * const table = new JaypieDynamoDb(this, "myApp");
  *
  * @example
- * // With explicit table name (overrides CDK-generated name)
+ * // With fabricIndex() for GSIs
+ * import { fabricIndex } from "@jaypie/fabric";
  * const table = new JaypieDynamoDb(this, "MyTable", {
  *   tableName: "custom-table-name",
- *   indexes: [
- *     { pk: ["scope", "model"] },
- *     { pk: ["scope", "model", "type"], sparse: true },
- *   ],
+ *   indexes: [fabricIndex(), fabricIndex("alias"), fabricIndex("xid")],
  * });
  */
 export declare class JaypieDynamoDb extends Construct implements dynamodb.ITableV2 {

package/dist/esm/index.js

@@ -26,7 +26,7 @@ import * as cloudfront from 'aws-cdk-lib/aws-cloudfront';
 import * as origins from 'aws-cdk-lib/aws-cloudfront-origins';
 import * as wafv2 from 'aws-cdk-lib/aws-wafv2';
 import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
-import { generateIndexName, DEFAULT_SORT_KEY } from '@jaypie/fabric';
+import { getGsiAttributeNames } from '@jaypie/fabric';
 import * as cr from 'aws-cdk-lib/custom-resources';
 import { Nextjs } from 'cdk-nextjs-standalone';
 import * as path from 'path';
@@ -2895,41 +2895,39 @@ class JaypieDnsRecord extends Construct {
     }
 }
 
-//
-//
-// Constants
-//
-/** Composite key separator used in GSI partition keys */
-const SEPARATOR = "#";
 //
 //
 // Helper Functions
 //
 /**
- * Convert IndexDefinition[] from @jaypie/fabric to CDK GlobalSecondaryIndexPropsV2[]
+ * Convert IndexDefinition[] from @jaypie/fabric to CDK GlobalSecondaryIndexPropsV2[].
  *
- * @param indexes - Array of IndexDefinition from @jaypie/fabric
- * @returns Array of CDK GlobalSecondaryIndexPropsV2
+ * Uses `getGsiAttributeNames` as the single source of truth so runtime writes
+ * and CDK provisioning agree on attribute names. Composite sk indexes
+ * (sk.length > 1) get a dedicated STRING `{indexName}Sk` attribute; single-field
+ * sk indexes reference the field directly (STRING in the general case, NUMBER
+ * for the legacy `sequence` name).
  */
 function indexesToGsi(indexes) {
     return indexes.map((index) => {
-        // Generate index name from pk fields if not provided
-        const indexName = index.name ?? generateIndexName(index.pk);
-        // Sort key defaults to ["sequence"] if not provided
-        const skFields = index.sk ?? DEFAULT_SORT_KEY;
+        const { pk, sk } = getGsiAttributeNames(index);
+        let sortKey;
+        if (sk) {
+            if (sk === "sequence") {
+                sortKey = { name: "sequence", type: dynamodb.AttributeType.NUMBER };
+            }
+            else {
+                sortKey = { name: sk, type: dynamodb.AttributeType.STRING };
+            }
+        }
         return {
-            indexName,
+            indexName: pk,
             partitionKey: {
-                name: indexName,
+                name: pk,
                 type: dynamodb.AttributeType.STRING,
             },
             projectionType: dynamodb.ProjectionType.ALL,
-            sortKey: skFields.length === 1 && skFields[0] === "sequence"
-                ? { name: "sequence", type: dynamodb.AttributeType.NUMBER }
-                : {
-                    name: skFields.join(SEPARATOR),
-                    type: dynamodb.AttributeType.STRING,
-                },
+            ...(sortKey && { sortKey }),
         };
     });
 }
@@ -2941,8 +2939,7 @@ function indexesToGsi(indexes) {
  * DynamoDB table with Jaypie single-table design patterns.
  *
  * Creates a table with:
- * - Partition key: `model` (String)
- * - Sort key: `id` (String)
+ * - Partition key: `id` (String), no sort key
  * - Billing: PAY_PER_REQUEST (on-demand)
  * - Removal policy: RETAIN in production, DESTROY otherwise
  * - No GSIs by default (use `indexes` prop to add them)
@@ -2953,13 +2950,11 @@ function indexesToGsi(indexes) {
  * const table = new JaypieDynamoDb(this, "myApp");
  *
  * @example
- * // With explicit table name (overrides CDK-generated name)
+ * // With fabricIndex() for GSIs
+ * import { fabricIndex } from "@jaypie/fabric";
  * const table = new JaypieDynamoDb(this, "MyTable", {
  *   tableName: "custom-table-name",
- *   indexes: [
- *     { pk: ["scope", "model"] },
- *     { pk: ["scope", "model", "type"], sparse: true },
- *   ],
+ *   indexes: [fabricIndex(), fabricIndex("alias"), fabricIndex("xid")],
  * });
  */
 class JaypieDynamoDb extends Construct {
@@ -2971,11 +2966,11 @@ class JaypieDynamoDb extends Construct {
         const constructId = isShorthand ? `JaypieDynamoDb-${id}` : id;
         super(scope, constructId);
         const { billing = dynamodb.Billing.onDemand(), indexes, partitionKey = {
-            name: "model",
+            name: "id",
             type: dynamodb.AttributeType.STRING,
         }, project, removalPolicy = isProductionEnv()
             ? RemovalPolicy.RETAIN
-            : RemovalPolicy.DESTROY, roleTag = CDK$2.ROLE.STORAGE, service, sortKey = { name: "id", type: dynamodb.AttributeType.STRING }, vendorTag, ...restProps } = props;
+            : RemovalPolicy.DESTROY, roleTag = CDK$2.ROLE.STORAGE, service, sortKey, vendorTag, ...restProps } = props;
         // Convert IndexDefinition[] to CDK GSI props
         const globalSecondaryIndexes = indexes ? indexesToGsi(indexes) : undefined;
         this._table = new dynamodb.TableV2(this, "Table", {
@@ -2983,7 +2978,7 @@ class JaypieDynamoDb extends Construct {
             globalSecondaryIndexes,
             partitionKey,
             removalPolicy,
-            sortKey,
+            ...(sortKey && { sortKey }),
             ...restProps,
         });
         // Apply tags