@aws-amplify/api-graphql 4.0.17-unstable.e316a2e.0 → 4.0.18-experimental-lerna-test.d2b0b08.55

package/dist/cjs/internals/APIClient.js

@@ -1,11 +1,9 @@
 'use strict';
 
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCustomHeaders = exports.authModeParams = exports.normalizeMutationInput = exports.buildGraphQLVariables = exports.generateGraphQLDocument = exports.generateSelectionSet = exports.selectionSetIRToString = exports.customSelectionSetToIR = exports.graphQLOperationsInfo = exports.initializeModel = exports.flattenItems = void 0;
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-const resolveOwnerFields_1 = require("../utils/resolveOwnerFields");
+exports.getCustomHeaders = exports.authModeParams = exports.normalizeMutationInput = exports.buildGraphQLVariables = exports.generateGraphQLDocument = exports.generateSelectionSet = exports.selectionSetIRToString = exports.customSelectionSetToIR = exports.defaultSelectionSetForNonModelWithIR = exports.graphQLOperationsInfo = exports.initializeModel = exports.flattenItems = void 0;
 const types_1 = require("../types");
+const resolveOwnerFields_1 = require("../utils/resolveOwnerFields");
 const connectionType = {
     HAS_ONE: 'HAS_ONE',
     HAS_MANY: 'HAS_MANY',
@@ -54,14 +52,17 @@ function initializeModel(client, modelName, result, modelIntrospection, authMode
                 'associatedWith' in modelField.association) {
                 connectionFields = modelField.association.associatedWith;
             }
-            let targetNames = [];
+            const targetNames = [];
             if (modelField.association && 'targetNames' in modelField.association) {
-                targetNames = modelField.association.targetNames;
+                targetNames.push(...modelField.association.targetNames);
             }
             switch (relationType) {
                 case connectionType.HAS_ONE:
-                case connectionType.BELONGS_TO:
-                    const sortKeyValues = relatedModelSKFieldNames.reduce((acc, curVal) => {
+                case connectionType.BELONGS_TO: {
+                    const sortKeyValues = relatedModelSKFieldNames.reduce(
+                    // TODO(Eslint): is this implementation correct?
+                    // eslint-disable-next-line array-callback-return
+                    (acc, curVal) => {
                         if (record[curVal]) {
                             return (acc[curVal] = record[curVal]);
                         }
@@ -95,7 +96,8 @@ function initializeModel(client, modelName, result, modelIntrospection, authMode
                         };
                     }
                     break;
-                case connectionType.HAS_MANY:
+                }
+                case connectionType.HAS_MANY: {
                     const parentPk = introModel.primaryKeyInfo.primaryKeyFieldName;
                     const parentSK = introModel.primaryKeyInfo.sortKeyFieldNames;
                     // M:N check - TODO: refactor
@@ -178,6 +180,7 @@ function initializeModel(client, modelName, result, modelIntrospection, authMode
                         };
                     }
                     break;
+                }
             }
         }
         return { ...record, ...initializedRelationalFields };
@@ -197,15 +200,47 @@ exports.graphQLOperationsInfo = {
     OBSERVE_QUERY: { operationPrefix: 'observeQuery', usePlural: false },
 };
 const SELECTION_SET_WILDCARD = '*';
+function defaultSelectionSetForNonModelWithIR(nonModelDefinition, modelIntrospection) {
+    const { fields } = nonModelDefinition;
+    const mappedFields = Object.values(fields)
+        .map(({ type, name }) => {
+        if (typeof type.enum === 'string') {
+            return [name, FIELD_IR];
+        }
+        if (typeof type.nonModel === 'string') {
+            return [
+                name,
+                defaultSelectionSetForNonModelWithIR(modelIntrospection.nonModels[type.nonModel], modelIntrospection),
+            ];
+        }
+        if (typeof type === 'string') {
+            return [name, FIELD_IR];
+        }
+        return undefined;
+    })
+        .filter((pair) => pair !== undefined);
+    return Object.fromEntries(mappedFields);
+}
+exports.defaultSelectionSetForNonModelWithIR = defaultSelectionSetForNonModelWithIR;
 function defaultSelectionSetForModel(modelDefinition) {
     // fields that are explicitly part of the graphql schema; not
     // inferred from owner auth rules.
     const { fields } = modelDefinition;
     const explicitFields = Object.values(fields)
         // Default selection set omits model fields
-        .map(({ type, name }) => (typeof type === 'string' ||
-        (typeof type === 'object' && typeof type?.enum === 'string')) &&
-        name)
+        .map(({ type, name }) => {
+        if (typeof type === 'string')
+            return name;
+        if (typeof type === 'object') {
+            if (typeof type?.enum === 'string') {
+                return name;
+            }
+            else if (typeof type?.nonModel === 'string') {
+                return `${name}.${SELECTION_SET_WILDCARD}`;
+            }
+        }
+        return undefined;
+    })
         .filter(Boolean);
     // fields used for owner auth rules that may or may not also
     // be explicit on the model.
@@ -232,52 +267,86 @@ const FIELD_IR = '';
  * }
  * ```
  */
-function customSelectionSetToIR(modelDefinitions, modelName, selectionSet) {
-    const dotNotationToObject = (path, modelName) => {
+function customSelectionSetToIR(modelIntrospection, modelName, selectionSet) {
+    const dotNotationToObject = (path, modelOrNonModelName) => {
         const [fieldName, ...rest] = path.split('.');
-        let result = {};
-        if (rest.length === 0) {
-            result = { [fieldName]: FIELD_IR };
+        const nested = rest[0];
+        const modelOrNonModelDefinition = modelIntrospection.models[modelOrNonModelName] ??
+            modelIntrospection.nonModels[modelOrNonModelName];
+        const modelOrNonModelFields = modelOrNonModelDefinition?.fields;
+        const relatedModel = modelOrNonModelFields?.[fieldName]?.type?.model;
+        const relatedModelDefinition = modelIntrospection.models[relatedModel];
+        const relatedNonModel = modelOrNonModelFields?.[fieldName]?.type?.nonModel;
+        const relatedNonModelDefinition = modelIntrospection.nonModels[relatedNonModel];
+        const isModelOrNonModelOrFieldType = relatedModelDefinition
+            ? 'model'
+            : relatedNonModelDefinition
+                ? 'nonModel'
+                : 'field';
+        if (isModelOrNonModelOrFieldType === 'nonModel') {
+            let result = {};
+            if (!nested) {
+                throw Error(`${fieldName} must declare a wildcard (*) or a field of custom type ${relatedNonModel}`);
+            }
+            if (nested === SELECTION_SET_WILDCARD) {
+                result = {
+                    [fieldName]: defaultSelectionSetForNonModelWithIR(relatedNonModelDefinition, modelIntrospection),
+                };
+            }
+            else {
+                result = {
+                    [fieldName]: dotNotationToObject(rest.join('.'), relatedNonModel),
+                };
+            }
+            return result;
         }
-        else {
-            const nested = rest[0];
-            const modelDefinition = modelDefinitions[modelName];
-            const modelFields = modelDefinition.fields;
-            const relatedModel = modelFields[fieldName]?.type
-                ?.model;
-            if (!relatedModel) {
-                // TODO: may need to change this to support custom types
-                throw Error(`${fieldName} is not a model field`);
+        else if (isModelOrNonModelOrFieldType === 'model') {
+            let result = {};
+            if (!nested) {
+                throw Error(`${fieldName} must declare a wildcard (*) or a field of model ${relatedModel}`);
             }
             if (nested === SELECTION_SET_WILDCARD) {
-                const relatedModelDefinition = modelDefinitions[relatedModel];
+                const nestedRelatedModelDefinition = modelIntrospection.models[relatedModel];
                 result = {
-                    [fieldName]: defaultSelectionSetIR(relatedModelDefinition),
+                    [fieldName]: modelsDefaultSelectionSetIR(nestedRelatedModelDefinition),
                 };
             }
             else {
-                const exists = Boolean(modelFields[fieldName]);
-                if (!exists) {
-                    throw Error(`${fieldName} is not a field of model ${modelName}`);
-                }
                 result = {
                     [fieldName]: dotNotationToObject(rest.join('.'), relatedModel),
                 };
             }
-            if (modelFields[fieldName]?.isArray) {
+            if (modelOrNonModelFields[fieldName]?.isArray) {
                 result = {
                     [fieldName]: {
                         items: result[fieldName],
                     },
                 };
             }
+            return result;
+        }
+        else {
+            const modelField = modelOrNonModelFields?.[fieldName];
+            const nonModelDefinition = modelIntrospection.nonModels[modelOrNonModelName];
+            const nonModelField = nonModelDefinition?.fields?.[fieldName];
+            if (!nonModelDefinition) {
+                const isOwnerField = (0, resolveOwnerFields_1.resolveOwnerFields)(modelOrNonModelDefinition).includes(fieldName);
+                if (!modelField && !isOwnerField) {
+                    throw Error(`${fieldName} is not a field of model ${modelOrNonModelName}`);
+                }
+            }
+            else {
+                if (!nonModelField) {
+                    throw Error(`${fieldName} is not a field of custom type ${modelOrNonModelName}`);
+                }
+            }
+            return { [fieldName]: FIELD_IR };
         }
-        return result;
     };
     return selectionSet.reduce((resultObj, path) => deepMergeSelectionSetObjects(dotNotationToObject(path, modelName), resultObj), {});
 }
 exports.customSelectionSetToIR = customSelectionSetToIR;
-const defaultSelectionSetIR = (relatedModelDefinition) => {
+const modelsDefaultSelectionSetIR = (relatedModelDefinition) => {
     const defaultSelectionSet = defaultSelectionSetForModel(relatedModelDefinition);
     const reduced = defaultSelectionSet.reduce((acc, curVal) => {
         acc[curVal] = FIELD_IR;
@@ -330,9 +399,10 @@ function deepMergeSelectionSetObjects(source, target) {
     const isObject = (obj) => obj && typeof obj === 'object';
     for (const key in source) {
         // This verification avoids 'Prototype Pollution' issue
-        if (!source.hasOwnProperty(key))
+        if (!Object.prototype.hasOwnProperty.call(source, key))
             continue;
-        if (target.hasOwnProperty(key) && isObject(target[key])) {
+        if (Object.prototype.hasOwnProperty.call(target, key) &&
+            isObject(target[key])) {
             deepMergeSelectionSetObjects(source[key], target[key]);
         }
         else {
@@ -341,18 +411,15 @@ function deepMergeSelectionSetObjects(source, target) {
     }
     return target;
 }
-function generateSelectionSet(modelDefinitions, modelName, selectionSet) {
-    const modelDefinition = modelDefinitions[modelName];
-    if (!selectionSet) {
-        return defaultSelectionSetForModel(modelDefinition).join(' ');
-    }
-    const selSetIr = customSelectionSetToIR(modelDefinitions, modelName, selectionSet);
+function generateSelectionSet(modelIntrospection, modelName, selectionSet) {
+    const modelDefinition = modelIntrospection.models[modelName];
+    const selSetIr = customSelectionSetToIR(modelIntrospection, modelName, selectionSet ?? defaultSelectionSetForModel(modelDefinition));
     const selSetString = selectionSetIRToString(selSetIr);
     return selSetString;
 }
 exports.generateSelectionSet = generateSelectionSet;
-function generateGraphQLDocument(modelDefinitions, modelName, modelOperation, listArgs, indexMeta) {
-    const modelDefinition = modelDefinitions[modelName];
+function generateGraphQLDocument(modelIntrospection, modelName, modelOperation, listArgs, indexMeta) {
+    const modelDefinition = modelIntrospection.models[modelName];
     const { name, pluralName, fields, primaryKeyInfo: { isCustomPrimaryKey, primaryKeyFieldName, sortKeyFieldNames, }, } = modelDefinition;
     const { operationPrefix, usePlural } = exports.graphQLOperationsInfo[modelOperation];
     const { selectionSet } = listArgs || {};
@@ -377,11 +444,10 @@ function generateGraphQLDocument(modelDefinitions, modelName, modelOperation, li
     else {
         throw new Error('Error generating GraphQL Document - invalid operation name');
     }
-    console.log('indexQueryArgs', indexQueryArgs);
     let graphQLOperationType;
     let graphQLSelectionSet;
     let graphQLArguments;
-    const selectionSetFields = generateSelectionSet(modelDefinitions, modelName, selectionSet);
+    const selectionSetFields = generateSelectionSet(modelIntrospection, modelName, selectionSet);
     switch (modelOperation) {
         case 'CREATE':
         case 'UPDATE':
@@ -392,6 +458,8 @@ function generateGraphQLDocument(modelDefinitions, modelName, modelOperation, li
                         operationPrefix.slice(1)}${name}Input!`,
                 });
             graphQLOperationType ?? (graphQLOperationType = 'mutation');
+        // TODO(Eslint): this this case clause correct without the break statement?
+        // eslint-disable-next-line no-fallthrough
         case 'READ':
             graphQLArguments ??
                 (graphQLArguments = isCustomPrimaryKey
@@ -403,27 +471,40 @@ function generateGraphQLDocument(modelDefinitions, modelName, modelOperation, li
                         [primaryKeyFieldName]: `${fields[primaryKeyFieldName].type}!`,
                     });
             graphQLSelectionSet ?? (graphQLSelectionSet = selectionSetFields);
+        // TODO(Eslint): this this case clause correct without the break statement?
+        // eslint-disable-next-line no-fallthrough
         case 'LIST':
             graphQLArguments ??
                 (graphQLArguments = {
                     filter: `Model${name}FilterInput`,
+                    ...(sortKeyFieldNames.length > 0
+                        ? [primaryKeyFieldName, ...sortKeyFieldNames].reduce((acc, fieldName) => {
+                            acc[fieldName] = `${fields[fieldName].type}`;
+                            return acc;
+                        }, { sortDirection: 'ModelSortDirection' })
+                        : []),
                     limit: 'Int',
                     nextToken: 'String',
                 });
             graphQLOperationType ?? (graphQLOperationType = 'query');
             graphQLSelectionSet ??
                 (graphQLSelectionSet = `items { ${selectionSetFields} } nextToken __typename`);
+        // TODO(Eslint): this this case clause correct without the break statement?
+        // eslint-disable-next-line no-fallthrough
         case 'INDEX_QUERY':
             graphQLArguments ??
                 (graphQLArguments = {
                     ...indexQueryArgs,
                     filter: `Model${name}FilterInput`,
+                    sortDirection: 'ModelSortDirection',
                     limit: 'Int',
                     nextToken: 'String',
                 });
             graphQLOperationType ?? (graphQLOperationType = 'query');
             graphQLSelectionSet ??
                 (graphQLSelectionSet = `items { ${selectionSetFields} } nextToken __typename`);
+        // TODO(Eslint): this this case clause correct without the break statement?
+        // eslint-disable-next-line no-fallthrough
         case 'ONCREATE':
         case 'ONUPDATE':
         case 'ONDELETE':
@@ -439,9 +520,9 @@ function generateGraphQLDocument(modelDefinitions, modelName, modelOperation, li
             throw new Error('Internal error: Attempted to generate graphql document for observeQuery. Please report this error.');
     }
     const graphQLDocument = `${graphQLOperationType}${graphQLArguments
-        ? `(${Object.entries(graphQLArguments).map(([fieldName, type]) => `\$${fieldName}: ${type}`)})`
+        ? `(${Object.entries(graphQLArguments).map(([fieldName, type]) => `$${fieldName}: ${type}`)})`
         : ''} { ${graphQLFieldName}${graphQLArguments
-        ? `(${Object.keys(graphQLArguments).map(fieldName => `${fieldName}: \$${fieldName}`)})`
+        ? `(${Object.keys(graphQLArguments).map(fieldName => `${fieldName}: $${fieldName}`)})`
         : ''} { ${graphQLSelectionSet} } }`;
     return graphQLDocument;
 }
@@ -488,6 +569,10 @@ function buildGraphQLVariables(modelDefinition, operation, arg, modelIntrospecti
             if (arg?.filter) {
                 variables.filter = arg.filter;
             }
+            if (arg?.sortDirection) {
+                variables.sortDirection = arg.sortDirection;
+                variables[primaryKeyFieldName] = arg[primaryKeyFieldName];
+            }
             if (arg?.nextToken) {
                 variables.nextToken = arg.nextToken;
             }
@@ -495,7 +580,7 @@ function buildGraphQLVariables(modelDefinition, operation, arg, modelIntrospecti
                 variables.limit = arg.limit;
             }
             break;
-        case 'INDEX_QUERY':
+        case 'INDEX_QUERY': {
             const { pk, sk = [] } = indexMeta;
             variables[pk] = arg[pk];
             for (const skField of sk) {
@@ -504,6 +589,9 @@ function buildGraphQLVariables(modelDefinition, operation, arg, modelIntrospecti
             if (arg?.filter) {
                 variables.filter = arg.filter;
             }
+            if (arg?.sortDirection) {
+                variables.sortDirection = arg.sortDirection;
+            }
             if (arg?.nextToken) {
                 variables.nextToken = arg.nextToken;
             }
@@ -511,6 +599,7 @@ function buildGraphQLVariables(modelDefinition, operation, arg, modelIntrospecti
                 variables.limit = arg.limit;
             }
             break;
+        }
         case 'ONCREATE':
         case 'ONUPDATE':
         case 'ONDELETE':
@@ -520,9 +609,10 @@ function buildGraphQLVariables(modelDefinition, operation, arg, modelIntrospecti
             break;
         case 'OBSERVE_QUERY':
             throw new Error('Internal error: Attempted to build variables for observeQuery. Please report this error.');
-        default:
+        default: {
             const exhaustiveCheck = operation;
             throw new Error(`Unhandled operation case: ${exhaustiveCheck}`);
+        }
     }
     return variables;
 }
@@ -585,7 +675,7 @@ exports.normalizeMutationInput = normalizeMutationInput;
  * as a fallback.
  *
  * @param client Configured client from `generateClient`
- * @param options Args/Options obect from call site.
+ * @param options Args/Options object from call site.
  * @returns
  */
 function authModeParams(client, options = {}) {
@@ -597,9 +687,9 @@ function authModeParams(client, options = {}) {
 exports.authModeParams = authModeParams;
 /**
  * Retrieves custom headers from either the client or request options.
- * @param {client} V6Client | V6ClientSSRRequest | V6ClientSSRCookies - for extracting client headers
- * @param {requestHeaders} [CustomHeaders] - request headers
- * @returns {CustomHeaders} - custom headers
+ * @param client V6Client | V6ClientSSRRequest | V6ClientSSRCookies - for extracting client headers
+ * @param requestHeaders {@link CustomHeaders} - request headers
+ * @returns custom headers as {@link CustomHeaders}
  */
 function getCustomHeaders(client, requestHeaders) {
     let headers = client[types_1.__headers] || {};