sofa-api 0.15.2 → 0.15.4

package/index.js

@@ -713,7 +713,8 @@ function resolveFieldType(type, opts) {
 
 function buildPathFromOperation({ url, schema, operation, useRequestBody, tags, description, customScalars, }) {
     const info = getOperationInfo(operation);
-    const summary = resolveSummary(schema, info.operation);
+    const enumTypes = resolveEnumTypes(schema);
+    const summary = resolveDescription(schema, info.operation);
     return Object.assign(Object.assign({ tags,
         description,
         summary, operationId: info.name }, (useRequestBody
@@ -721,15 +722,13 @@ function buildPathFromOperation({ url, schema, operation, useRequestBody, tags,
             requestBody: {
                 content: {
                     'application/json': {
-                        schema: resolveRequestBody(info.operation.variableDefinitions, {
-                            customScalars,
-                        }),
+                        schema: resolveRequestBody(info.operation.variableDefinitions, schema, info.operation, { customScalars, enumTypes }),
                     },
                 },
             },
         }
         : {
-            parameters: resolveParameters(url, info.operation.variableDefinitions, { customScalars }),
+            parameters: resolveParameters(url, info.operation.variableDefinitions, schema, info.operation, { customScalars, enumTypes }),
         })), { responses: {
             200: {
                 description: summary,
@@ -738,14 +737,25 @@ function buildPathFromOperation({ url, schema, operation, useRequestBody, tags,
                         schema: resolveResponse({
                             schema,
                             operation: info.operation,
-                            customScalars,
+                            opts: { customScalars, enumTypes },
                         }),
                     },
                 },
             },
         } });
 }
-function resolveParameters(url, variables, opts) {
+function resolveEnumTypes(schema) {
+    const enumTypes = Object.values(schema.getTypeMap())
+        .filter(graphql.isEnumType);
+    return Object.fromEntries(enumTypes.map((type) => [
+        type.name,
+        {
+            type: 'string',
+            enum: type.getValues().map((value) => value.name),
+        },
+    ]));
+}
+function resolveParameters(url, variables, schema, operation, opts) {
     if (!variables) {
         return [];
     }
@@ -755,10 +765,11 @@ function resolveParameters(url, variables, opts) {
             name: variable.variable.name.value,
             required: variable.type.kind === graphql.Kind.NON_NULL_TYPE,
             schema: resolveParamSchema(variable.type, opts),
+            description: resolveVariableDescription(schema, operation, variable),
         };
     });
 }
-function resolveRequestBody(variables, opts) {
+function resolveRequestBody(variables, schema, operation, opts) {
     if (!variables) {
         return {};
     }
@@ -768,7 +779,7 @@ function resolveRequestBody(variables, opts) {
         if (variable.type.kind === graphql.Kind.NON_NULL_TYPE) {
             required.push(variable.variable.name.value);
         }
-        properties[variable.variable.name.value] = resolveParamSchema(variable.type, opts);
+        properties[variable.variable.name.value] = Object.assign(Object.assign({}, resolveParamSchema(variable.type, opts)), { description: resolveVariableDescription(schema, operation, variable) });
     });
     return Object.assign({ type: 'object', properties }, (required.length ? { required } : {}));
 }
@@ -787,45 +798,51 @@ function resolveParamSchema(type, opts) {
     }
     const primitive = mapToPrimitive(type.name.value);
     return (primitive ||
-        opts.customScalars[type.name.value] || {
-        $ref: mapToRef(type.name.value),
-    });
+        opts.customScalars[type.name.value] ||
+        opts.enumTypes[type.name.value] || { $ref: mapToRef(type.name.value) });
 }
-function resolveResponse({ schema, operation, customScalars, }) {
+function resolveResponse({ schema, operation, opts, }) {
     const operationType = operation.operation;
     const rootField = operation.selectionSet.selections[0];
     if (rootField.kind === graphql.Kind.FIELD) {
         if (operationType === 'query') {
             const queryType = schema.getQueryType();
             const field = queryType.getFields()[rootField.name.value];
-            return resolveFieldType(field.type, { customScalars });
+            return resolveFieldType(field.type, opts);
         }
         if (operationType === 'mutation') {
             const mutationType = schema.getMutationType();
             const field = mutationType.getFields()[rootField.name.value];
-            return resolveFieldType(field.type, { customScalars });
+            return resolveFieldType(field.type, opts);
         }
     }
 }
 function isInPath(url, param) {
     return url.indexOf(`{${param}}`) !== -1;
 }
-function resolveSummary(schema, operation) {
+function getOperationFieldNode(schema, operation) {
     const selection = operation.selectionSet.selections[0];
     const fieldName = selection.name.value;
     const typeDefinition = schema.getType(titleCase.titleCase(operation.operation));
     if (!typeDefinition) {
-        return '';
+        return undefined;
     }
     const definitionNode = typeDefinition.astNode || graphql.parse(graphql.printType(typeDefinition)).definitions[0];
     if (!isObjectTypeDefinitionNode(definitionNode)) {
-        return '';
+        return undefined;
     }
-    const fieldNode = definitionNode.fields.find((field) => field.name.value === fieldName);
-    const descriptionDefinition = fieldNode && fieldNode.description;
-    return descriptionDefinition && descriptionDefinition.value
-        ? descriptionDefinition.value
-        : '';
+    return definitionNode.fields.find((field) => field.name.value === fieldName);
+}
+function resolveDescription(schema, operation) {
+    var _a;
+    const fieldNode = getOperationFieldNode(schema, operation);
+    return ((_a = fieldNode === null || fieldNode === void 0 ? void 0 : fieldNode.description) === null || _a === void 0 ? void 0 : _a.value) || '';
+}
+function resolveVariableDescription(schema, operation, variable) {
+    var _a, _b;
+    const fieldNode = getOperationFieldNode(schema, operation);
+    const argument = (_a = fieldNode === null || fieldNode === void 0 ? void 0 : fieldNode.arguments) === null || _a === void 0 ? void 0 : _a.find((arg) => arg.name.value === variable.variable.name.value);
+    return (_b = argument === null || argument === void 0 ? void 0 : argument.description) === null || _b === void 0 ? void 0 : _b.value;
 }
 function isObjectTypeDefinitionNode(node) {
     return node.kind === graphql.Kind.OBJECT_TYPE_DEFINITION;

package/index.mjs

@@ -707,7 +707,8 @@ function resolveFieldType(type, opts) {
 
 function buildPathFromOperation({ url, schema, operation, useRequestBody, tags, description, customScalars, }) {
     const info = getOperationInfo(operation);
-    const summary = resolveSummary(schema, info.operation);
+    const enumTypes = resolveEnumTypes(schema);
+    const summary = resolveDescription(schema, info.operation);
     return Object.assign(Object.assign({ tags,
         description,
         summary, operationId: info.name }, (useRequestBody
@@ -715,15 +716,13 @@ function buildPathFromOperation({ url, schema, operation, useRequestBody, tags,
             requestBody: {
                 content: {
                     'application/json': {
-                        schema: resolveRequestBody(info.operation.variableDefinitions, {
-                            customScalars,
-                        }),
+                        schema: resolveRequestBody(info.operation.variableDefinitions, schema, info.operation, { customScalars, enumTypes }),
                     },
                 },
             },
         }
         : {
-            parameters: resolveParameters(url, info.operation.variableDefinitions, { customScalars }),
+            parameters: resolveParameters(url, info.operation.variableDefinitions, schema, info.operation, { customScalars, enumTypes }),
         })), { responses: {
             200: {
                 description: summary,
@@ -732,14 +731,25 @@ function buildPathFromOperation({ url, schema, operation, useRequestBody, tags,
                         schema: resolveResponse({
                             schema,
                             operation: info.operation,
-                            customScalars,
+                            opts: { customScalars, enumTypes },
                         }),
                     },
                 },
             },
         } });
 }
-function resolveParameters(url, variables, opts) {
+function resolveEnumTypes(schema) {
+    const enumTypes = Object.values(schema.getTypeMap())
+        .filter(isEnumType);
+    return Object.fromEntries(enumTypes.map((type) => [
+        type.name,
+        {
+            type: 'string',
+            enum: type.getValues().map((value) => value.name),
+        },
+    ]));
+}
+function resolveParameters(url, variables, schema, operation, opts) {
     if (!variables) {
         return [];
     }
@@ -749,10 +759,11 @@ function resolveParameters(url, variables, opts) {
             name: variable.variable.name.value,
             required: variable.type.kind === Kind.NON_NULL_TYPE,
             schema: resolveParamSchema(variable.type, opts),
+            description: resolveVariableDescription(schema, operation, variable),
         };
     });
 }
-function resolveRequestBody(variables, opts) {
+function resolveRequestBody(variables, schema, operation, opts) {
     if (!variables) {
         return {};
     }
@@ -762,7 +773,7 @@ function resolveRequestBody(variables, opts) {
         if (variable.type.kind === Kind.NON_NULL_TYPE) {
             required.push(variable.variable.name.value);
         }
-        properties[variable.variable.name.value] = resolveParamSchema(variable.type, opts);
+        properties[variable.variable.name.value] = Object.assign(Object.assign({}, resolveParamSchema(variable.type, opts)), { description: resolveVariableDescription(schema, operation, variable) });
     });
     return Object.assign({ type: 'object', properties }, (required.length ? { required } : {}));
 }
@@ -781,45 +792,51 @@ function resolveParamSchema(type, opts) {
     }
     const primitive = mapToPrimitive(type.name.value);
     return (primitive ||
-        opts.customScalars[type.name.value] || {
-        $ref: mapToRef(type.name.value),
-    });
+        opts.customScalars[type.name.value] ||
+        opts.enumTypes[type.name.value] || { $ref: mapToRef(type.name.value) });
 }
-function resolveResponse({ schema, operation, customScalars, }) {
+function resolveResponse({ schema, operation, opts, }) {
     const operationType = operation.operation;
     const rootField = operation.selectionSet.selections[0];
     if (rootField.kind === Kind.FIELD) {
         if (operationType === 'query') {
             const queryType = schema.getQueryType();
             const field = queryType.getFields()[rootField.name.value];
-            return resolveFieldType(field.type, { customScalars });
+            return resolveFieldType(field.type, opts);
         }
         if (operationType === 'mutation') {
             const mutationType = schema.getMutationType();
             const field = mutationType.getFields()[rootField.name.value];
-            return resolveFieldType(field.type, { customScalars });
+            return resolveFieldType(field.type, opts);
         }
     }
 }
 function isInPath(url, param) {
     return url.indexOf(`{${param}}`) !== -1;
 }
-function resolveSummary(schema, operation) {
+function getOperationFieldNode(schema, operation) {
     const selection = operation.selectionSet.selections[0];
     const fieldName = selection.name.value;
     const typeDefinition = schema.getType(titleCase(operation.operation));
     if (!typeDefinition) {
-        return '';
+        return undefined;
     }
     const definitionNode = typeDefinition.astNode || parse(printType(typeDefinition)).definitions[0];
     if (!isObjectTypeDefinitionNode(definitionNode)) {
-        return '';
+        return undefined;
     }
-    const fieldNode = definitionNode.fields.find((field) => field.name.value === fieldName);
-    const descriptionDefinition = fieldNode && fieldNode.description;
-    return descriptionDefinition && descriptionDefinition.value
-        ? descriptionDefinition.value
-        : '';
+    return definitionNode.fields.find((field) => field.name.value === fieldName);
+}
+function resolveDescription(schema, operation) {
+    var _a;
+    const fieldNode = getOperationFieldNode(schema, operation);
+    return ((_a = fieldNode === null || fieldNode === void 0 ? void 0 : fieldNode.description) === null || _a === void 0 ? void 0 : _a.value) || '';
+}
+function resolveVariableDescription(schema, operation, variable) {
+    var _a, _b;
+    const fieldNode = getOperationFieldNode(schema, operation);
+    const argument = (_a = fieldNode === null || fieldNode === void 0 ? void 0 : fieldNode.arguments) === null || _a === void 0 ? void 0 : _a.find((arg) => arg.name.value === variable.variable.name.value);
+    return (_b = argument === null || argument === void 0 ? void 0 : argument.description) === null || _b === void 0 ? void 0 : _b.value;
 }
 function isObjectTypeDefinitionNode(node) {
     return node.kind === Kind.OBJECT_TYPE_DEFINITION;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "sofa-api",
-  "version": "0.15.2",
+  "version": "0.15.4",
   "description": "Create REST APIs with GraphQL",
   "sideEffects": false,
   "peerDependencies": {
     "graphql": "^0.13.2 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@graphql-tools/utils": "9.1.3",
+    "@graphql-tools/utils": "9.1.4",
     "@whatwg-node/fetch": "^0.6.0",
     "@whatwg-node/router": "^0.1.2",
     "ansi-colors": "4.1.3",