@aws-amplify/data-schema 1.23.0 → 1.24.0

package/dist/cjs/ModelIndex.js

@@ -10,6 +10,8 @@ function _modelIndex(partitionKeyFieldName) {
         sortKeys: [],
         indexName: '',
         queryField: '',
+        projectionType: 'ALL',
+        nonKeyAttributes: undefined,
     };
     const builder = {
         sortKeys(sortKeys) {
@@ -24,6 +26,13 @@ function _modelIndex(partitionKeyFieldName) {
             data.queryField = field;
             return this;
         },
+        projection(type, ...args) {
+            data.projectionType = type;
+            if (type === 'INCLUDE') {
+                data.nonKeyAttributes = args[0];
+            }
+            return this;
+        },
         ...(0, util_1.brand)(brandName),
     };
     return { ...builder, data };

package/dist/cjs/ModelIndex.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelIndex.js","sources":["../../src/ModelIndex.ts"],"sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.modelIndex = modelIndex;\nconst util_1 = require(\"./util\");\nconst brandName = 'modelIndexType';\nfunction _modelIndex(partitionKeyFieldName) {\n    const data = {\n        partitionKey: partitionKeyFieldName,\n        sortKeys: [],\n        indexName: '',\n        queryField: '',\n    };\n    const builder = {\n        sortKeys(sortKeys) {\n            data.sortKeys = sortKeys;\n            return this;\n        },\n        name(name) {\n            data.indexName = name;\n            return this;\n        },\n        queryField(field) {\n            data.queryField = field;\n            return this;\n        },\n        ...(0, util_1.brand)(brandName),\n    };\n    return { ...builder, data };\n}\nfunction modelIndex(partitionKeyFieldName) {\n    return _modelIndex(partitionKeyFieldName);\n}\n"],"names":[],"mappings":";;AACA,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC7D,OAAO,CAAC,UAAU,GAAG,UAAU;AAC/B,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;AAChC,MAAM,SAAS,GAAG,gBAAgB;AAClC,SAAS,WAAW,CAAC,qBAAqB,EAAE;AAC5C,IAAI,MAAM,IAAI,GAAG;AACjB,QAAQ,YAAY,EAAE,qBAAqB;AAC3C,QAAQ,QAAQ,EAAE,EAAE;AACpB,QAAQ,SAAS,EAAE,EAAE;AACrB,QAAQ,UAAU,EAAE,EAAE;AACtB,KAAK;AACL,IAAI,MAAM,OAAO,GAAG;AACpB,QAAQ,QAAQ,CAAC,QAAQ,EAAE;AAC3B,YAAY,IAAI,CAAC,QAAQ,GAAG,QAAQ;AACpC,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,IAAI,CAAC,IAAI,EAAE;AACnB,YAAY,IAAI,CAAC,SAAS,GAAG,IAAI;AACjC,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,UAAU,CAAC,KAAK,EAAE;AAC1B,YAAY,IAAI,CAAC,UAAU,GAAG,KAAK;AACnC,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC;AACvC,KAAK;AACL,IAAI,OAAO,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE;AAC/B;AACA,SAAS,UAAU,CAAC,qBAAqB,EAAE;AAC3C,IAAI,OAAO,WAAW,CAAC,qBAAqB,CAAC;AAC7C;;"}
+{"version":3,"file":"ModelIndex.js","sources":["../../src/ModelIndex.ts"],"sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.modelIndex = modelIndex;\nconst util_1 = require(\"./util\");\nconst brandName = 'modelIndexType';\nfunction _modelIndex(partitionKeyFieldName) {\n    const data = {\n        partitionKey: partitionKeyFieldName,\n        sortKeys: [],\n        indexName: '',\n        queryField: '',\n        projectionType: 'ALL',\n        nonKeyAttributes: undefined,\n    };\n    const builder = {\n        sortKeys(sortKeys) {\n            data.sortKeys = sortKeys;\n            return this;\n        },\n        name(name) {\n            data.indexName = name;\n            return this;\n        },\n        queryField(field) {\n            data.queryField = field;\n            return this;\n        },\n        projection(type, ...args) {\n            data.projectionType = type;\n            if (type === 'INCLUDE') {\n                data.nonKeyAttributes = args[0];\n            }\n            return this;\n        },\n        ...(0, util_1.brand)(brandName),\n    };\n    return { ...builder, data };\n}\nfunction modelIndex(partitionKeyFieldName) {\n    return _modelIndex(partitionKeyFieldName);\n}\n"],"names":[],"mappings":";;AACA,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC7D,OAAO,CAAC,UAAU,GAAG,UAAU;AAC/B,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;AAChC,MAAM,SAAS,GAAG,gBAAgB;AAClC,SAAS,WAAW,CAAC,qBAAqB,EAAE;AAC5C,IAAI,MAAM,IAAI,GAAG;AACjB,QAAQ,YAAY,EAAE,qBAAqB;AAC3C,QAAQ,QAAQ,EAAE,EAAE;AACpB,QAAQ,SAAS,EAAE,EAAE;AACrB,QAAQ,UAAU,EAAE,EAAE;AACtB,QAAQ,cAAc,EAAE,KAAK;AAC7B,QAAQ,gBAAgB,EAAE,SAAS;AACnC,KAAK;AACL,IAAI,MAAM,OAAO,GAAG;AACpB,QAAQ,QAAQ,CAAC,QAAQ,EAAE;AAC3B,YAAY,IAAI,CAAC,QAAQ,GAAG,QAAQ;AACpC,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,IAAI,CAAC,IAAI,EAAE;AACnB,YAAY,IAAI,CAAC,SAAS,GAAG,IAAI;AACjC,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,UAAU,CAAC,KAAK,EAAE;AAC1B,YAAY,IAAI,CAAC,UAAU,GAAG,KAAK;AACnC,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,UAAU,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE;AAClC,YAAY,IAAI,CAAC,cAAc,GAAG,IAAI;AACtC,YAAY,IAAI,IAAI,KAAK,SAAS,EAAE;AACpC,gBAAgB,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC,CAAC;AAC/C;AACA,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC;AACvC,KAAK;AACL,IAAI,OAAO,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE;AAC/B;AACA,SAAS,UAAU,CAAC,qBAAqB,EAAE;AAC3C,IAAI,OAAO,WAAW,CAAC,qBAAqB,CAAC;AAC7C;;"}

package/dist/cjs/SchemaProcessor.js

@@ -735,7 +735,7 @@ const secondaryIndexDefaultQueryField = (modelName, pk, sk) => {
  * and the value is an array of transformed Amplify @index directives with all supplied attributes
  */
 const transformedSecondaryIndexesForModel = (modelName, secondaryIndexes, modelFields, getRefType) => {
-    const indexDirectiveWithAttributes = (partitionKey, sortKeys, indexName, queryField) => {
+    const indexDirectiveWithAttributes = (partitionKey, sortKeys, indexName, queryField, projectionType, nonKeyAttributes) => {
         for (const keyName of [partitionKey, ...sortKeys]) {
             const field = modelFields[keyName];
             if (isRefField(field)) {
@@ -745,7 +745,7 @@ const transformedSecondaryIndexesForModel = (modelName, secondaryIndexes, modelF
                 }
             }
         }
-        if (!sortKeys.length && !indexName && !queryField && queryField !== null) {
+        if (!sortKeys.length && !indexName && !queryField && queryField !== null && !projectionType) {
             return `@index(queryField: "${secondaryIndexDefaultQueryField(modelName, partitionKey)}")`;
         }
         const attributes = [];
@@ -764,11 +764,21 @@ const transformedSecondaryIndexesForModel = (modelName, secondaryIndexes, modelF
         else {
             attributes.push(`queryField: "${secondaryIndexDefaultQueryField(modelName, partitionKey, sortKeys)}"`);
         }
+        // Add projection attributes if specified
+        if (projectionType && projectionType !== 'ALL') {
+            if (projectionType === 'KEYS_ONLY') {
+                attributes.push(`projection: { type: KEYS_ONLY }`);
+            }
+            else if (projectionType === 'INCLUDE' && nonKeyAttributes?.length) {
+                const nonKeyAttrsStr = nonKeyAttributes.map(attr => `"${attr}"`).join(', ');
+                attributes.push(`projection: { type: INCLUDE, nonKeyAttributes: [${nonKeyAttrsStr}] }`);
+            }
+        }
         return `@index(${attributes.join(', ')})`;
     };
-    return secondaryIndexes.reduce((acc, { data: { partitionKey, sortKeys, indexName, queryField } }) => {
+    return secondaryIndexes.reduce((acc, { data: { partitionKey, sortKeys, indexName, queryField, projectionType, nonKeyAttributes } }) => {
         acc[partitionKey] = acc[partitionKey] || [];
-        acc[partitionKey].push(indexDirectiveWithAttributes(partitionKey, sortKeys, indexName, queryField));
+        acc[partitionKey].push(indexDirectiveWithAttributes(partitionKey, sortKeys, indexName, queryField, projectionType, nonKeyAttributes));
         return acc;
     }, {});
 };