@aws-amplify/data-schema 1.22.2 → 1.24.0

package/dist/cjs/ai/ModelType.js

@@ -19,6 +19,10 @@ const supportedModelsLookup = {
     'Claude 3.7 Sonnet': 'anthropic.claude-3-7-sonnet-20250219-v1:0',
     'Claude Opus 4': 'anthropic.claude-opus-4-20250514-v1:0',
     'Claude Sonnet 4': 'anthropic.claude-sonnet-4-20250514-v1:0',
+    // Claude 4.5 models (require global inference profiles)
+    'Claude Haiku 4.5': 'global.anthropic.claude-haiku-4-5-20251001-v1:0',
+    'Claude Sonnet 4.5': 'global.anthropic.claude-sonnet-4-5-20250929-v1:0',
+    'Claude Opus 4.5': 'global.anthropic.claude-opus-4-5-20251101-v1:0',
     // Cohere models
     'Cohere Command R': 'cohere.command-r-v1:0',
     'Cohere Command R+': 'cohere.command-r-plus-v1:0',

package/dist/cjs/ai/ModelType.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelType.js","sources":["../../../src/ai/ModelType.ts"],"sourcesContent":["\"use strict\";\n// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.model = model;\nconst supportedModelsLookup = {\n    // Amazon Nova models\n    'Amazon Nova Pro': 'amazon.nova-pro-v1:0',\n    'Amazon Nova Lite': 'amazon.nova-lite-v1:0',\n    'Amazon Nova Micro': 'amazon.nova-micro-v1:0',\n    // Anthropic models\n    'Claude 3 Haiku': 'anthropic.claude-3-haiku-20240307-v1:0',\n    'Claude 3 Opus': 'anthropic.claude-3-opus-20240229-v1:0',\n    'Claude 3 Sonnet': 'anthropic.claude-3-sonnet-20240229-v1:0',\n    'Claude 3.5 Haiku': 'anthropic.claude-3-5-haiku-20241022-v1:0',\n    'Claude 3.5 Sonnet': 'anthropic.claude-3-5-sonnet-20240620-v1:0',\n    'Claude 3.5 Sonnet v2': 'anthropic.claude-3-5-sonnet-20241022-v2:0',\n    'Claude 3.7 Sonnet': 'anthropic.claude-3-7-sonnet-20250219-v1:0',\n    'Claude Opus 4': 'anthropic.claude-opus-4-20250514-v1:0',\n    'Claude Sonnet 4': 'anthropic.claude-sonnet-4-20250514-v1:0',\n    // Cohere models\n    'Cohere Command R': 'cohere.command-r-v1:0',\n    'Cohere Command R+': 'cohere.command-r-plus-v1:0',\n    // Meta models\n    'Llama 3.1 8B Instruct': 'meta.llama3-1-8b-instruct-v1:0',\n    'Llama 3.1 70B Instruct': 'meta.llama3-1-70b-instruct-v1:0',\n    'Llama 3.1 405B Instruct': 'meta.llama3-1-405b-instruct-v1:0',\n    // Mistral AI models\n    'Mistral Large': 'mistral.mistral-large-2402-v1:0',\n    'Mistral Large 2': 'mistral.mistral-large-2407-v1:0',\n    'Mistral Small': 'mistral.mistral-small-2402-v1:0',\n};\n/**\n * Bedrock models currently supporting Converse API and Tool use\n * @see {@link https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html#conversation-inference-supported-models-features}\n */\nfunction model(modelName) {\n    return {\n        resourcePath: supportedModelsLookup[modelName],\n    };\n}\n"],"names":[],"mappings":";;AACA;AACA;AACA,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC7D,OAAO,CAAC,KAAK,GAAG,KAAK;AACrB,MAAM,qBAAqB,GAAG;AAC9B;AACA,IAAI,iBAAiB,EAAE,sBAAsB;AAC7C,IAAI,kBAAkB,EAAE,uBAAuB;AAC/C,IAAI,mBAAmB,EAAE,wBAAwB;AACjD;AACA,IAAI,gBAAgB,EAAE,wCAAwC;AAC9D,IAAI,eAAe,EAAE,uCAAuC;AAC5D,IAAI,iBAAiB,EAAE,yCAAyC;AAChE,IAAI,kBAAkB,EAAE,0CAA0C;AAClE,IAAI,mBAAmB,EAAE,2CAA2C;AACpE,IAAI,sBAAsB,EAAE,2CAA2C;AACvE,IAAI,mBAAmB,EAAE,2CAA2C;AACpE,IAAI,eAAe,EAAE,uCAAuC;AAC5D,IAAI,iBAAiB,EAAE,yCAAyC;AAChE;AACA,IAAI,kBAAkB,EAAE,uBAAuB;AAC/C,IAAI,mBAAmB,EAAE,4BAA4B;AACrD;AACA,IAAI,uBAAuB,EAAE,gCAAgC;AAC7D,IAAI,wBAAwB,EAAE,iCAAiC;AAC/D,IAAI,yBAAyB,EAAE,kCAAkC;AACjE;AACA,IAAI,eAAe,EAAE,iCAAiC;AACtD,IAAI,iBAAiB,EAAE,iCAAiC;AACxD,IAAI,eAAe,EAAE,iCAAiC;AACtD,CAAC;AACD;AACA;AACA;AACA;AACA,SAAS,KAAK,CAAC,SAAS,EAAE;AAC1B,IAAI,OAAO;AACX,QAAQ,YAAY,EAAE,qBAAqB,CAAC,SAAS,CAAC;AACtD,KAAK;AACL;;"}
+{"version":3,"file":"ModelType.js","sources":["../../../src/ai/ModelType.ts"],"sourcesContent":["\"use strict\";\n// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.model = model;\nconst supportedModelsLookup = {\n    // Amazon Nova models\n    'Amazon Nova Pro': 'amazon.nova-pro-v1:0',\n    'Amazon Nova Lite': 'amazon.nova-lite-v1:0',\n    'Amazon Nova Micro': 'amazon.nova-micro-v1:0',\n    // Anthropic models\n    'Claude 3 Haiku': 'anthropic.claude-3-haiku-20240307-v1:0',\n    'Claude 3 Opus': 'anthropic.claude-3-opus-20240229-v1:0',\n    'Claude 3 Sonnet': 'anthropic.claude-3-sonnet-20240229-v1:0',\n    'Claude 3.5 Haiku': 'anthropic.claude-3-5-haiku-20241022-v1:0',\n    'Claude 3.5 Sonnet': 'anthropic.claude-3-5-sonnet-20240620-v1:0',\n    'Claude 3.5 Sonnet v2': 'anthropic.claude-3-5-sonnet-20241022-v2:0',\n    'Claude 3.7 Sonnet': 'anthropic.claude-3-7-sonnet-20250219-v1:0',\n    'Claude Opus 4': 'anthropic.claude-opus-4-20250514-v1:0',\n    'Claude Sonnet 4': 'anthropic.claude-sonnet-4-20250514-v1:0',\n    // Claude 4.5 models (require global inference profiles)\n    'Claude Haiku 4.5': 'global.anthropic.claude-haiku-4-5-20251001-v1:0',\n    'Claude Sonnet 4.5': 'global.anthropic.claude-sonnet-4-5-20250929-v1:0',\n    'Claude Opus 4.5': 'global.anthropic.claude-opus-4-5-20251101-v1:0',\n    // Cohere models\n    'Cohere Command R': 'cohere.command-r-v1:0',\n    'Cohere Command R+': 'cohere.command-r-plus-v1:0',\n    // Meta models\n    'Llama 3.1 8B Instruct': 'meta.llama3-1-8b-instruct-v1:0',\n    'Llama 3.1 70B Instruct': 'meta.llama3-1-70b-instruct-v1:0',\n    'Llama 3.1 405B Instruct': 'meta.llama3-1-405b-instruct-v1:0',\n    // Mistral AI models\n    'Mistral Large': 'mistral.mistral-large-2402-v1:0',\n    'Mistral Large 2': 'mistral.mistral-large-2407-v1:0',\n    'Mistral Small': 'mistral.mistral-small-2402-v1:0',\n};\n/**\n * Bedrock models currently supporting Converse API and Tool use\n * @see {@link https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html#conversation-inference-supported-models-features}\n */\nfunction model(modelName) {\n    return {\n        resourcePath: supportedModelsLookup[modelName],\n    };\n}\n"],"names":[],"mappings":";;AACA;AACA;AACA,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC7D,OAAO,CAAC,KAAK,GAAG,KAAK;AACrB,MAAM,qBAAqB,GAAG;AAC9B;AACA,IAAI,iBAAiB,EAAE,sBAAsB;AAC7C,IAAI,kBAAkB,EAAE,uBAAuB;AAC/C,IAAI,mBAAmB,EAAE,wBAAwB;AACjD;AACA,IAAI,gBAAgB,EAAE,wCAAwC;AAC9D,IAAI,eAAe,EAAE,uCAAuC;AAC5D,IAAI,iBAAiB,EAAE,yCAAyC;AAChE,IAAI,kBAAkB,EAAE,0CAA0C;AAClE,IAAI,mBAAmB,EAAE,2CAA2C;AACpE,IAAI,sBAAsB,EAAE,2CAA2C;AACvE,IAAI,mBAAmB,EAAE,2CAA2C;AACpE,IAAI,eAAe,EAAE,uCAAuC;AAC5D,IAAI,iBAAiB,EAAE,yCAAyC;AAChE;AACA,IAAI,kBAAkB,EAAE,iDAAiD;AACzE,IAAI,mBAAmB,EAAE,kDAAkD;AAC3E,IAAI,iBAAiB,EAAE,gDAAgD;AACvE;AACA,IAAI,kBAAkB,EAAE,uBAAuB;AAC/C,IAAI,mBAAmB,EAAE,4BAA4B;AACrD;AACA,IAAI,uBAAuB,EAAE,gCAAgC;AAC7D,IAAI,wBAAwB,EAAE,iCAAiC;AAC/D,IAAI,yBAAyB,EAAE,kCAAkC;AACjE;AACA,IAAI,eAAe,EAAE,iCAAiC;AACtD,IAAI,iBAAiB,EAAE,iCAAiC;AACxD,IAAI,eAAe,EAAE,iCAAiC;AACtD,CAAC;AACD;AACA;AACA;AACA;AACA,SAAS,KAAK,CAAC,SAAS,EAAE;AAC1B,IAAI,OAAO;AACX,QAAQ,YAAY,EAAE,qBAAqB,CAAC,SAAS,CAAC;AACtD,KAAK;AACL;;"}

package/dist/esm/ModelIndex.d.ts

@@ -1,10 +1,24 @@
 import { Brand } from './util';
 declare const brandName = "modelIndexType";
+/**
+ * DynamoDB Global Secondary Index (GSI) projection types.
+ * - `KEYS_ONLY`: Only the index and primary keys are projected into the index.
+ * - `INCLUDE`: In addition to the attributes in KEYS_ONLY, includes specified non-key attributes.
+ * - `ALL`: All attributes from the base table are projected into the index.
+ */
+export type GSIProjectionType = 'KEYS_ONLY' | 'INCLUDE' | 'ALL';
+/**
+ * Configuration data for a model's secondary index.
+ */
 export type ModelIndexData = {
     partitionKey: string;
     sortKeys: readonly unknown[];
     indexName: string;
     queryField: string | null;
+    /** The projection type for the GSI. Defaults to 'ALL' if not specified. */
+    projectionType?: GSIProjectionType;
+    /** Non-key attributes to include when projectionType is 'INCLUDE'. */
+    nonKeyAttributes?: readonly string[];
 };
 export type InternalModelIndexType = ModelIndexType<any, any, any, any> & {
     data: ModelIndexData;
@@ -13,6 +27,7 @@ export type ModelIndexType<ModelFieldKeys extends string, PK, SK = readonly [],
     sortKeys<FieldKeys extends ModelFieldKeys = ModelFieldKeys, const SK extends ReadonlyArray<Exclude<FieldKeys, PK>> = readonly []>(sortKeys: SK): ModelIndexType<FieldKeys, PK, SK, QueryField, K | 'sortKeys'>;
     name(name: string): ModelIndexType<ModelFieldKeys, PK, SK, QueryField, K | 'name'>;
     queryField<QF extends string | null = never, MF extends ModelFieldKeys = ModelFieldKeys>(field: QF): ModelIndexType<MF, PK, SK, QF, K | 'queryField'>;
+    projection<PT extends GSIProjectionType, NKA extends PT extends 'INCLUDE' ? readonly string[] : never = never>(type: PT, ...args: PT extends 'INCLUDE' ? [nonKeyAttributes: NKA] : []): ModelIndexType<ModelFieldKeys, PK, SK, QueryField, K | 'projection'>;
 }, K> & Brand<typeof brandName>;
 export declare function modelIndex<ModelFieldKeys extends string, PK extends ModelFieldKeys, SK = readonly [], QueryField = never>(partitionKeyFieldName: PK): ModelIndexType<ModelFieldKeys, PK, SK, QueryField, never>;
 export {};

package/dist/esm/ModelIndex.mjs

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

package/dist/esm/ModelIndex.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ModelIndex.mjs","sources":["../../src/ModelIndex.ts"],"sourcesContent":["import { brand } from './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        ...brand(brandName),\n    };\n    return { ...builder, data };\n}\nexport function modelIndex(partitionKeyFieldName) {\n    return _modelIndex(partitionKeyFieldName);\n}\n"],"names":[],"mappings":";;AACA,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,KAAK,CAAC,SAAS,CAAC;AAC3B,KAAK;AACL,IAAI,OAAO,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE;AAC/B;AACO,SAAS,UAAU,CAAC,qBAAqB,EAAE;AAClD,IAAI,OAAO,WAAW,CAAC,qBAAqB,CAAC;AAC7C;;;;"}
+{"version":3,"file":"ModelIndex.mjs","sources":["../../src/ModelIndex.ts"],"sourcesContent":["import { brand } from './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        ...brand(brandName),\n    };\n    return { ...builder, data };\n}\nexport function modelIndex(partitionKeyFieldName) {\n    return _modelIndex(partitionKeyFieldName);\n}\n"],"names":[],"mappings":";;AACA,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,KAAK,CAAC,SAAS,CAAC;AAC3B,KAAK;AACL,IAAI,OAAO,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE;AAC/B;AACO,SAAS,UAAU,CAAC,qBAAqB,EAAE;AAClD,IAAI,OAAO,WAAW,CAAC,qBAAqB,CAAC;AAC7C;;;;"}

package/dist/esm/SchemaProcessor.mjs

@@ -730,7 +730,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)) {
@@ -740,7 +740,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 = [];
@@ -759,11 +759,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;
     }, {});
 };