@aws-amplify/api 5.3.4-api-v6.29 → 5.3.4-api-v6-models.34

package/lib/API.js

@@ -5,6 +5,11 @@ var tslib_1 = require("tslib");
 var internals_1 = require("@aws-amplify/api-graphql/internals");
 var core_1 = require("@aws-amplify/core");
 var InternalAPI_1 = require("./internals/InternalAPI");
+var APIClient_1 = require("./APIClient");
+/*
+    await post.comments()
+        => await graphql()
+*/
 var logger = new core_1.ConsoleLogger('API');
 /**
  * @deprecated
@@ -37,38 +42,76 @@ var APIClass = /** @class */ (function (_super) {
         var _loop_1 = function (model) {
             var name_1 = model.name;
             client.models[name_1] = {};
-            Object.entries(graphQLOperationsInfo).forEach(function (_a) {
+            Object.entries(APIClient_1.graphQLOperationsInfo).forEach(function (_a) {
                 var _b = tslib_1.__read(_a, 2), key = _b[0], operationPrefix = _b[1].operationPrefix;
                 var operation = key;
-                // e.g. clients.models.Todo.update
-                client.models[name_1][operationPrefix] = function (arg) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                    var query, variables, res, _a, key_1;
-                    return tslib_1.__generator(this, function (_b) {
-                        switch (_b.label) {
-                            case 0:
-                                query = generateGraphQLDocument(model, operation);
-                                variables = buildGraphQLVariables(model, operation, arg);
-                                return [4 /*yield*/, this.graphql({
-                                        query: query,
-                                        variables: variables,
-                                    })];
-                            case 1:
-                                res = (_b.sent());
-                                // flatten response
-                                if (res.data !== undefined) {
-                                    _a = tslib_1.__read(Object.keys(res.data), 1), key_1 = _a[0];
-                                    if (res.data[key_1].items) {
-                                        return [2 /*return*/, res.data[key_1].items];
+                if (operation === 'LIST') {
+                    client.models[name_1][operationPrefix] = function (args) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+                        var query, variables, res, _a, key_1, flattenedResult, initialized;
+                        return tslib_1.__generator(this, function (_b) {
+                            switch (_b.label) {
+                                case 0:
+                                    query = (0, APIClient_1.generateGraphQLDocument)(modelIntrospection.models, name_1, 'LIST', args);
+                                    variables = (0, APIClient_1.buildGraphQLVariables)(model, 'LIST', args);
+                                    console.log('API list', query, variables);
+                                    return [4 /*yield*/, this.graphql({
+                                            query: query,
+                                            variables: variables,
+                                        })];
+                                case 1:
+                                    res = (_b.sent());
+                                    // flatten response
+                                    if (res.data !== undefined) {
+                                        _a = tslib_1.__read(Object.keys(res.data), 1), key_1 = _a[0];
+                                        if (res.data[key_1].items) {
+                                            flattenedResult = res.data[key_1].items;
+                                            // don't init if custom selection set
+                                            if (args === null || args === void 0 ? void 0 : args.selectionSet) {
+                                                return [2 /*return*/, flattenedResult];
+                                            }
+                                            else {
+                                                initialized = (0, APIClient_1.initializeModel)(client, name_1, flattenedResult, modelIntrospection);
+                                                return [2 /*return*/, initialized];
+                                            }
+                                        }
+                                        return [2 /*return*/, res.data[key_1]];
                                     }
-                                    return [2 /*return*/, res.data[key_1]];
-                                }
-                                return [2 /*return*/, res];
-                        }
-                    });
-                }); };
+                                    return [2 /*return*/, res];
+                            }
+                        });
+                    }); };
+                }
+                else {
+                    client.models[name_1][operationPrefix] = function (arg, options) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+                        var query, variables, res, _a, key_2, _b, initialized;
+                        return tslib_1.__generator(this, function (_c) {
+                            switch (_c.label) {
+                                case 0:
+                                    query = (0, APIClient_1.generateGraphQLDocument)(modelIntrospection.models, name_1, operation);
+                                    variables = (0, APIClient_1.buildGraphQLVariables)(model, operation, arg);
+                                    console.log("API ".concat(operationPrefix), query, variables);
+                                    return [4 /*yield*/, this.graphql({
+                                            query: query,
+                                            variables: variables,
+                                        })];
+                                case 1:
+                                    res = (_c.sent());
+                                    // flatten response
+                                    if (res.data !== undefined) {
+                                        _a = tslib_1.__read(Object.keys(res.data), 1), key_2 = _a[0];
+                                        _b = tslib_1.__read((0, APIClient_1.initializeModel)(client, name_1, [res.data[key_2]], modelIntrospection), 1), initialized = _b[0];
+                                        return [2 /*return*/, initialized];
+                                    }
+                                    return [2 /*return*/, res];
+                            }
+                        });
+                    }); };
+                }
             });
         };
         try {
+            // TODO: refactor this to use separate methods for each CRUDL.
+            // Doesn't make sense to gen the methods dynamically given the different args and return values
             for (var _b = tslib_1.__values(Object.values(modelIntrospection.models)), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var model = _c.value;
                 _loop_1(model);
@@ -86,109 +129,5 @@ var APIClass = /** @class */ (function (_super) {
     return APIClass;
 }(InternalAPI_1.InternalAPIClass));
 exports.APIClass = APIClass;
-var graphQLOperationsInfo = {
-    CREATE: { operationPrefix: 'create', usePlural: false },
-    READ: { operationPrefix: 'get', usePlural: false },
-    UPDATE: { operationPrefix: 'update', usePlural: false },
-    DELETE: { operationPrefix: 'delete', usePlural: false },
-    LIST: { operationPrefix: 'list', usePlural: true },
-};
-var graphQLDocumentsCache = new Map();
-function generateGraphQLDocument(modelDefinition, modelOperation) {
-    var _a;
-    var _b, _c;
-    var name = modelDefinition.name, pluralName = modelDefinition.pluralName, fields = modelDefinition.fields, _d = modelDefinition.primaryKeyInfo, isCustomPrimaryKey = _d.isCustomPrimaryKey, primaryKeyFieldName = _d.primaryKeyFieldName, sortKeyFieldNames = _d.sortKeyFieldNames;
-    var _e = graphQLOperationsInfo[modelOperation], operationPrefix = _e.operationPrefix, usePlural = _e.usePlural;
-    var fromCache = (_b = graphQLDocumentsCache.get(name)) === null || _b === void 0 ? void 0 : _b.get(modelOperation);
-    if (fromCache !== undefined) {
-        return fromCache;
-    }
-    if (!graphQLDocumentsCache.has(name)) {
-        graphQLDocumentsCache.set(name, new Map());
-    }
-    var graphQLFieldName = "".concat(operationPrefix).concat(usePlural ? pluralName : name);
-    var graphQLOperationType;
-    var graphQLSelectionSet;
-    var graphQLArguments;
-    var selectionSetFields = Object.values(fields)
-        .map(function (_a) {
-        var type = _a.type, name = _a.name;
-        return typeof type === 'string' && name;
-    }) // Only scalars for now
-        .filter(Boolean)
-        .join(' ');
-    switch (modelOperation) {
-        case 'CREATE':
-        case 'UPDATE':
-        case 'DELETE':
-            graphQLArguments !== null && graphQLArguments !== void 0 ? graphQLArguments : (graphQLArguments = {
-                input: "".concat(operationPrefix.charAt(0).toLocaleUpperCase() +
-                    operationPrefix.slice(1)).concat(name, "Input!"),
-            });
-            graphQLOperationType !== null && graphQLOperationType !== void 0 ? graphQLOperationType : (graphQLOperationType = 'mutation');
-        case 'READ':
-            graphQLArguments !== null && graphQLArguments !== void 0 ? graphQLArguments : (graphQLArguments = isCustomPrimaryKey
-                ? tslib_1.__spreadArray([primaryKeyFieldName], tslib_1.__read(sortKeyFieldNames), false).reduce(function (acc, fieldName) {
-                    acc[fieldName] = fields[fieldName].type;
-                    return acc;
-                }, {})
-                : (_a = {},
-                    _a[primaryKeyFieldName] = "".concat(fields[primaryKeyFieldName].type, "!"),
-                    _a));
-            graphQLSelectionSet !== null && graphQLSelectionSet !== void 0 ? graphQLSelectionSet : (graphQLSelectionSet = selectionSetFields);
-        case 'LIST':
-            graphQLOperationType !== null && graphQLOperationType !== void 0 ? graphQLOperationType : (graphQLOperationType = 'query');
-            graphQLSelectionSet !== null && graphQLSelectionSet !== void 0 ? graphQLSelectionSet : (graphQLSelectionSet = "items { ".concat(selectionSetFields, " }"));
-    }
-    var graphQLDocument = "".concat(graphQLOperationType).concat(graphQLArguments
-        ? "(".concat(Object.entries(graphQLArguments).map(function (_a) {
-            var _b = tslib_1.__read(_a, 2), fieldName = _b[0], type = _b[1];
-            return "$".concat(fieldName, ": ").concat(type);
-        }), ")")
-        : '', " { ").concat(graphQLFieldName).concat(graphQLArguments
-        ? "(".concat(Object.keys(graphQLArguments).map(function (fieldName) { return "".concat(fieldName, ": $").concat(fieldName); }), ")")
-        : '', " { ").concat(graphQLSelectionSet, " } }");
-    (_c = graphQLDocumentsCache.get(name)) === null || _c === void 0 ? void 0 : _c.set(modelOperation, graphQLDocument);
-    return graphQLDocument;
-}
-function buildGraphQLVariables(modelDefinition, operation, arg) {
-    var _a;
-    var fields = modelDefinition.fields, _b = modelDefinition.primaryKeyInfo, isCustomPrimaryKey = _b.isCustomPrimaryKey, primaryKeyFieldName = _b.primaryKeyFieldName, sortKeyFieldNames = _b.sortKeyFieldNames;
-    var variables = {};
-    switch (operation) {
-        case 'CREATE':
-            variables = { input: arg };
-            break;
-        case 'UPDATE':
-            // readonly fields are not  updated
-            variables = {
-                input: Object.fromEntries(Object.entries(arg).filter(function (_a) {
-                    var _b = tslib_1.__read(_a, 1), fieldName = _b[0];
-                    var isReadOnly = fields[fieldName].isReadOnly;
-                    return !isReadOnly;
-                })),
-            };
-            break;
-        case 'READ':
-        case 'DELETE':
-            // only identifiers are sent
-            variables = isCustomPrimaryKey
-                ? tslib_1.__spreadArray([primaryKeyFieldName], tslib_1.__read(sortKeyFieldNames), false).reduce(function (acc, fieldName) {
-                    acc[fieldName] = arg[fieldName];
-                    return acc;
-                }, {})
-                : (_a = {}, _a[primaryKeyFieldName] = arg[primaryKeyFieldName], _a);
-            if (operation === 'DELETE') {
-                variables = { input: variables };
-            }
-            break;
-        case 'LIST':
-            break;
-        default:
-            var exhaustiveCheck = operation;
-            throw new Error("Unhandled operation case: ".concat(exhaustiveCheck));
-    }
-    return variables;
-}
 exports.API = new APIClass(null);
 core_1.Amplify.register(exports.API);

package/lib/APIClient.d.ts

@@ -0,0 +1,31 @@
+type ListArgs = {
+    selectionSet?: string[];
+    filter?: {};
+};
+export declare function initializeModel(client: any, modelName: string, result: any[], modelIntrospection: any): any[];
+export declare const graphQLOperationsInfo: {
+    CREATE: {
+        operationPrefix: "create";
+        usePlural: boolean;
+    };
+    READ: {
+        operationPrefix: "get";
+        usePlural: boolean;
+    };
+    UPDATE: {
+        operationPrefix: "update";
+        usePlural: boolean;
+    };
+    DELETE: {
+        operationPrefix: "delete";
+        usePlural: boolean;
+    };
+    LIST: {
+        operationPrefix: "list";
+        usePlural: boolean;
+    };
+};
+export type ModelOperation = keyof typeof graphQLOperationsInfo;
+export declare function generateGraphQLDocument(modelIntrospection: any, modelName: string, modelOperation: ModelOperation, listArgs?: ListArgs): string;
+export declare function buildGraphQLVariables(modelDefinition: any, operation: ModelOperation, arg: any): object;
+export {};

package/lib/APIClient.js

@@ -0,0 +1,224 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildGraphQLVariables = exports.generateGraphQLDocument = exports.graphQLOperationsInfo = exports.initializeModel = void 0;
+var tslib_1 = require("tslib");
+// TODO: this should accept single result to support CRUD methods; create helper for array/list
+function initializeModel(client, modelName, result, modelIntrospection) {
+    var _this = this;
+    var introModel = modelIntrospection.models[modelName];
+    var introModelFields = introModel.fields;
+    var modelFields = Object.entries(introModelFields)
+        .filter(function (_a) {
+        var _b = tslib_1.__read(_a, 2), _ = _b[0], field = _b[1];
+        return typeof field.type !== 'string';
+    })
+        .map(function (_a) {
+        var _b = tslib_1.__read(_a, 1), fieldName = _b[0];
+        return fieldName;
+    });
+    return result.map(function (record) {
+        var e_1, _a;
+        var initialized = {};
+        var _loop_1 = function (field) {
+            var relatedModel = introModelFields[field].type.model;
+            var connectionField = introModelFields[field].association.associatedWith;
+            // TODO: support sort key
+            var parentPk = introModel.primaryKeyInfo.primaryKeyFieldName;
+            initialized[field] = function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+                var _a;
+                return tslib_1.__generator(this, function (_b) {
+                    return [2 /*return*/, client.models[relatedModel].list({
+                            filter: (_a = {}, _a[connectionField] = { eq: record[parentPk] }, _a),
+                        })];
+                });
+            }); };
+        };
+        try {
+            for (var modelFields_1 = tslib_1.__values(modelFields), modelFields_1_1 = modelFields_1.next(); !modelFields_1_1.done; modelFields_1_1 = modelFields_1.next()) {
+                var field = modelFields_1_1.value;
+                _loop_1(field);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (modelFields_1_1 && !modelFields_1_1.done && (_a = modelFields_1.return)) _a.call(modelFields_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return tslib_1.__assign(tslib_1.__assign({}, record), initialized);
+    });
+}
+exports.initializeModel = initializeModel;
+exports.graphQLOperationsInfo = {
+    CREATE: { operationPrefix: 'create', usePlural: false },
+    READ: { operationPrefix: 'get', usePlural: false },
+    UPDATE: { operationPrefix: 'update', usePlural: false },
+    DELETE: { operationPrefix: 'delete', usePlural: false },
+    LIST: { operationPrefix: 'list', usePlural: true },
+};
+var graphQLDocumentsCache = new Map();
+var SELECTION_SET_ALL_NESTED = '*';
+function defaultSelectionSetForModel(modelDefinition) {
+    var fields = modelDefinition.fields;
+    return Object.values(fields)
+        .map(function (_a) {
+        var type = _a.type, name = _a.name;
+        return typeof type === 'string' && name;
+    }) // Default selection set omits model fields
+        .filter(Boolean)
+        .join(' ');
+}
+function generateSelectionSet(modelIntrospection, modelName, selectionSet) {
+    var e_2, _a;
+    var _b, _c, _d;
+    var modelDefinition = modelIntrospection[modelName];
+    var fields = modelDefinition.fields;
+    if (!selectionSet) {
+        return defaultSelectionSetForModel(modelDefinition);
+    }
+    var selSet = [];
+    try {
+        for (var selectionSet_1 = tslib_1.__values(selectionSet), selectionSet_1_1 = selectionSet_1.next(); !selectionSet_1_1.done; selectionSet_1_1 = selectionSet_1.next()) {
+            var f = selectionSet_1_1.value;
+            var nested = f.includes('.');
+            if (nested) {
+                var _e = tslib_1.__read(f.split('.'), 2), modelFieldName = _e[0], selectedField = _e[1];
+                var relatedModel = (_c = (_b = fields[modelFieldName]) === null || _b === void 0 ? void 0 : _b.type) === null || _c === void 0 ? void 0 : _c.model;
+                if (!relatedModel) {
+                    // TODO: may need to change this to support custom types
+                    throw Error("".concat(modelFieldName, " is not a model field"));
+                }
+                if (selectedField === SELECTION_SET_ALL_NESTED) {
+                    var relatedModelDefinition = modelIntrospection[relatedModel];
+                    var defaultSelectionSet = defaultSelectionSetForModel(relatedModelDefinition);
+                    if ((_d = fields[modelFieldName]) === null || _d === void 0 ? void 0 : _d.isArray) {
+                        selSet.push("".concat(modelFieldName, " { items { ").concat(defaultSelectionSet, " } }"));
+                    }
+                    else {
+                        selSet.push("".concat(modelFieldName, " { ").concat(defaultSelectionSet, " }"));
+                    }
+                }
+            }
+            else {
+                var exists = Boolean(fields[f]);
+                if (!exists) {
+                    throw Error("".concat(f, " is not a field of model ").concat(modelName));
+                }
+                selSet.push(f);
+            }
+        }
+    }
+    catch (e_2_1) { e_2 = { error: e_2_1 }; }
+    finally {
+        try {
+            if (selectionSet_1_1 && !selectionSet_1_1.done && (_a = selectionSet_1.return)) _a.call(selectionSet_1);
+        }
+        finally { if (e_2) throw e_2.error; }
+    }
+    return selSet.join(' ');
+}
+function generateGraphQLDocument(modelIntrospection, modelName, modelOperation, listArgs) {
+    var _a;
+    var _b, _c;
+    var modelDefinition = modelIntrospection[modelName];
+    var name = modelDefinition.name, pluralName = modelDefinition.pluralName, fields = modelDefinition.fields, _d = modelDefinition.primaryKeyInfo, isCustomPrimaryKey = _d.isCustomPrimaryKey, primaryKeyFieldName = _d.primaryKeyFieldName, sortKeyFieldNames = _d.sortKeyFieldNames;
+    var _e = exports.graphQLOperationsInfo[modelOperation], operationPrefix = _e.operationPrefix, usePlural = _e.usePlural;
+    var selectionSet = (listArgs || {}).selectionSet;
+    var fromCache = (_b = graphQLDocumentsCache.get(name)) === null || _b === void 0 ? void 0 : _b.get(modelOperation);
+    if (fromCache !== undefined) {
+        return fromCache;
+    }
+    if (!graphQLDocumentsCache.has(name)) {
+        graphQLDocumentsCache.set(name, new Map());
+    }
+    var graphQLFieldName = "".concat(operationPrefix).concat(usePlural ? pluralName : name);
+    var graphQLOperationType;
+    var graphQLSelectionSet;
+    var graphQLArguments;
+    var selectionSetFields = generateSelectionSet(modelIntrospection, modelName, selectionSet);
+    console.log('generated sel set', selectionSetFields);
+    switch (modelOperation) {
+        case 'CREATE':
+        case 'UPDATE':
+        case 'DELETE':
+            graphQLArguments !== null && graphQLArguments !== void 0 ? graphQLArguments : (graphQLArguments = {
+                input: "".concat(operationPrefix.charAt(0).toLocaleUpperCase() +
+                    operationPrefix.slice(1)).concat(name, "Input!"),
+            });
+            graphQLOperationType !== null && graphQLOperationType !== void 0 ? graphQLOperationType : (graphQLOperationType = 'mutation');
+        case 'READ':
+            graphQLArguments !== null && graphQLArguments !== void 0 ? graphQLArguments : (graphQLArguments = isCustomPrimaryKey
+                ? tslib_1.__spreadArray([primaryKeyFieldName], tslib_1.__read(sortKeyFieldNames), false).reduce(function (acc, fieldName) {
+                    acc[fieldName] = fields[fieldName].type;
+                    return acc;
+                }, {})
+                : (_a = {},
+                    _a[primaryKeyFieldName] = "".concat(fields[primaryKeyFieldName].type, "!"),
+                    _a));
+            graphQLSelectionSet !== null && graphQLSelectionSet !== void 0 ? graphQLSelectionSet : (graphQLSelectionSet = selectionSetFields);
+        case 'LIST':
+            graphQLArguments !== null && graphQLArguments !== void 0 ? graphQLArguments : (graphQLArguments = {
+                filter: "Model".concat(name, "FilterInput"),
+            });
+            graphQLOperationType !== null && graphQLOperationType !== void 0 ? graphQLOperationType : (graphQLOperationType = 'query');
+            graphQLSelectionSet !== null && graphQLSelectionSet !== void 0 ? graphQLSelectionSet : (graphQLSelectionSet = "items { ".concat(selectionSetFields, " }"));
+    }
+    var graphQLDocument = "".concat(graphQLOperationType).concat(graphQLArguments
+        ? "(".concat(Object.entries(graphQLArguments).map(function (_a) {
+            var _b = tslib_1.__read(_a, 2), fieldName = _b[0], type = _b[1];
+            return "$".concat(fieldName, ": ").concat(type);
+        }), ")")
+        : '', " { ").concat(graphQLFieldName).concat(graphQLArguments
+        ? "(".concat(Object.keys(graphQLArguments).map(function (fieldName) { return "".concat(fieldName, ": $").concat(fieldName); }), ")")
+        : '', " { ").concat(graphQLSelectionSet, " } }");
+    (_c = graphQLDocumentsCache.get(name)) === null || _c === void 0 ? void 0 : _c.set(modelOperation, graphQLDocument);
+    return graphQLDocument;
+}
+exports.generateGraphQLDocument = generateGraphQLDocument;
+function buildGraphQLVariables(modelDefinition, operation, arg) {
+    var _a;
+    var fields = modelDefinition.fields, _b = modelDefinition.primaryKeyInfo, isCustomPrimaryKey = _b.isCustomPrimaryKey, primaryKeyFieldName = _b.primaryKeyFieldName, sortKeyFieldNames = _b.sortKeyFieldNames;
+    var variables = {};
+    // TODO: process input
+    switch (operation) {
+        case 'CREATE':
+            variables = { input: arg };
+            break;
+        case 'UPDATE':
+            // readonly fields are not  updated
+            variables = {
+                input: Object.fromEntries(Object.entries(arg).filter(function (_a) {
+                    var _b = tslib_1.__read(_a, 1), fieldName = _b[0];
+                    var isReadOnly = fields[fieldName].isReadOnly;
+                    return !isReadOnly;
+                })),
+            };
+            break;
+        case 'READ':
+        case 'DELETE':
+            // only identifiers are sent
+            variables = isCustomPrimaryKey
+                ? tslib_1.__spreadArray([primaryKeyFieldName], tslib_1.__read(sortKeyFieldNames), false).reduce(function (acc, fieldName) {
+                    acc[fieldName] = arg[fieldName];
+                    return acc;
+                }, {})
+                : (_a = {}, _a[primaryKeyFieldName] = arg[primaryKeyFieldName], _a);
+            if (operation === 'DELETE') {
+                variables = { input: variables };
+            }
+            break;
+        case 'LIST':
+            if (arg === null || arg === void 0 ? void 0 : arg.filter) {
+                variables = { filter: arg.filter };
+            }
+            break;
+        default:
+            var exhaustiveCheck = operation;
+            throw new Error("Unhandled operation case: ".concat(exhaustiveCheck));
+    }
+    return variables;
+}
+exports.buildGraphQLVariables = buildGraphQLVariables;