sofa-api 0.18.2 → 0.18.5

package/cjs/ast.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOperationInfo = void 0;
+exports.getOperationInfo = getOperationInfo;
 const graphql_1 = require("graphql");
 function getOperationInfo(doc) {
     const op = (0, graphql_1.getOperationAST)(doc, null);
@@ -13,4 +13,3 @@ function getOperationInfo(doc) {
         variables: op.variableDefinitions || [],
     };
 }
-exports.getOperationInfo = getOperationInfo;

package/cjs/common.js

@@ -1,12 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNil = exports.convertName = void 0;
+exports.convertName = convertName;
+exports.isNil = isNil;
 const param_case_1 = require("param-case");
 function convertName(name) {
     return (0, param_case_1.paramCase)(name);
 }
-exports.convertName = convertName;
 function isNil(val) {
     return val == null;
 }
-exports.isNil = isNil;

package/cjs/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useSofa = exports.OpenAPI = void 0;
+exports.OpenAPI = void 0;
+exports.useSofa = useSofa;
 const router_1 = require("./router");
 const sofa_1 = require("./sofa");
 var open_api_1 = require("./open-api");
@@ -8,4 +9,3 @@ Object.defineProperty(exports, "OpenAPI", { enumerable: true, get: function () {
 function useSofa(config) {
     return (0, router_1.createRouter)((0, sofa_1.createSofa)(config));
 }
-exports.useSofa = useSofa;

package/cjs/open-api/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenAPI = void 0;
+exports.OpenAPI = OpenAPI;
 const graphql_1 = require("graphql");
 const types_1 = require("./types");
 const operations_1 = require("./operations");
@@ -59,4 +59,3 @@ function OpenAPI({ schema, info, servers, components, security, tags, customScal
         },
     };
 }
-exports.OpenAPI = OpenAPI;

package/cjs/open-api/operations.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveVariableDescription = exports.isInPath = exports.resolveResponse = exports.resolveParamSchema = exports.resolveRequestBody = exports.buildPathFromOperation = void 0;
+exports.buildPathFromOperation = buildPathFromOperation;
+exports.resolveRequestBody = resolveRequestBody;
+exports.resolveParamSchema = resolveParamSchema;
+exports.resolveResponse = resolveResponse;
+exports.isInPath = isInPath;
+exports.resolveVariableDescription = resolveVariableDescription;
 const graphql_1 = require("graphql");
 const ast_1 = require("../ast");
 const utils_1 = require("./utils");
@@ -48,7 +53,6 @@ function buildPathFromOperation({ url, schema, operation, useRequestBody, tags,
         },
     };
 }
-exports.buildPathFromOperation = buildPathFromOperation;
 function resolveEnumTypes(schema) {
     const enumTypes = Object.values(schema.getTypeMap())
         .filter(graphql_1.isEnumType);
@@ -95,7 +99,6 @@ function resolveRequestBody(variables, schema, operation, opts) {
         ...(required.length ? { required } : {}),
     };
 }
-exports.resolveRequestBody = resolveRequestBody;
 // array -> [type]
 // type -> $ref
 // scalar -> swagger primitive
@@ -114,7 +117,6 @@ function resolveParamSchema(type, opts) {
         opts.customScalars[type.name.value] ||
         opts.enumTypes[type.name.value] || { $ref: (0, utils_1.mapToRef)(type.name.value) });
 }
-exports.resolveParamSchema = resolveParamSchema;
 function resolveResponse({ schema, operation, opts, }) {
     const operationType = operation.operation;
     const rootField = operation.selectionSet.selections[0];
@@ -131,11 +133,9 @@ function resolveResponse({ schema, operation, opts, }) {
         }
     }
 }
-exports.resolveResponse = resolveResponse;
 function isInPath(url, param) {
     return url.includes(`:${param}`) || url.includes(`{${param}}`);
 }
-exports.isInPath = isInPath;
 function getOperationFieldNode(schema, operation) {
     const selection = operation.selectionSet.selections[0];
     const fieldName = selection.name.value;
@@ -158,7 +158,6 @@ function resolveVariableDescription(schema, operation, variable) {
     const argument = fieldNode?.arguments?.find((arg) => arg.name.value === variable.variable.name.value);
     return argument?.description?.value;
 }
-exports.resolveVariableDescription = resolveVariableDescription;
 function isObjectTypeDefinitionNode(node) {
     return node.kind === graphql_1.Kind.OBJECT_TYPE_DEFINITION;
 }

package/cjs/open-api/types.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveFieldType = exports.buildSchemaObjectFromType = void 0;
+exports.buildSchemaObjectFromType = buildSchemaObjectFromType;
+exports.resolveFieldType = resolveFieldType;
 const graphql_1 = require("graphql");
 const utils_1 = require("./utils");
 function buildSchemaObjectFromType(type, opts) {
@@ -24,7 +25,6 @@ function buildSchemaObjectFromType(type, opts) {
         ...(type.description ? { description: type.description } : {}),
     };
 }
-exports.buildSchemaObjectFromType = buildSchemaObjectFromType;
 function resolveField(field, opts) {
     return resolveFieldType(field.type, opts);
 }
@@ -69,4 +69,3 @@ function resolveFieldType(type, opts) {
         type: 'object',
     };
 }
-exports.resolveFieldType = resolveFieldType;

package/cjs/open-api/utils.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizePathParamForOpenAPI = exports.mapToRef = exports.mapToPrimitive = void 0;
+exports.mapToPrimitive = mapToPrimitive;
+exports.mapToRef = mapToRef;
+exports.normalizePathParamForOpenAPI = normalizePathParamForOpenAPI;
 function mapToPrimitive(type) {
     const formatMap = {
         Int: {
@@ -25,11 +27,9 @@ function mapToPrimitive(type) {
         return formatMap[type];
     }
 }
-exports.mapToPrimitive = mapToPrimitive;
 function mapToRef(type) {
     return `#/components/schemas/${type}`;
 }
-exports.mapToRef = mapToRef;
 function normalizePathParamForOpenAPI(path) {
     const pathParts = path.split('/');
     const normalizedPathParts = pathParts.map((part) => {
@@ -40,4 +40,3 @@ function normalizePathParamForOpenAPI(path) {
     });
     return normalizedPathParts.join('/');
 }
-exports.normalizePathParamForOpenAPI = normalizePathParamForOpenAPI;

package/cjs/parse.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseVariable = void 0;
+exports.parseVariable = parseVariable;
 const graphql_1 = require("graphql");
 const common_js_1 = require("./common.js");
 function parseVariable({ value, variable, schema, }) {
@@ -13,7 +13,6 @@ function parseVariable({ value, variable, schema, }) {
         schema,
     });
 }
-exports.parseVariable = parseVariable;
 function resolveVariable({ value, type, schema, }) {
     if (type.kind === graphql_1.Kind.NAMED_TYPE) {
         const namedType = schema.getType(type.name.value);

package/cjs/router.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRouter = void 0;
+exports.createRouter = createRouter;
 const graphql_1 = require("graphql");
 const utils_1 = require("@graphql-tools/utils");
 const ast_js_1 = require("./ast.js");
@@ -54,11 +54,19 @@ function createRouter(sofa) {
     const types = sofa.schema.getTypeMap();
     for (const typeName in types) {
         const type = types[typeName];
-        if (((0, graphql_1.isObjectType)(type) || (0, graphql_1.isInputObjectType)(type)) &&
-            !(0, graphql_1.isIntrospectionType)(type)) {
-            sofa.openAPI.components.schemas[typeName] = (0, types_js_1.buildSchemaObjectFromType)(type, {
-                customScalars: sofa.customScalars,
-            });
+        if (!(0, graphql_1.isIntrospectionType)(type)) {
+            if (((0, graphql_1.isObjectType)(type) || (0, graphql_1.isInputObjectType)(type))) {
+                sofa.openAPI.components.schemas[typeName] = (0, types_js_1.buildSchemaObjectFromType)(type, {
+                    customScalars: sofa.customScalars,
+                });
+            }
+            else if ((0, graphql_1.isEnumType)(type)) {
+                sofa.openAPI.components.schemas[typeName] = {
+                    title: type.name,
+                    type: 'string',
+                    enum: type.getValues().map((value) => value.name),
+                };
+            }
         }
     }
     const router = (0, fets_1.createRouter)({
@@ -149,7 +157,6 @@ function createRouter(sofa) {
     });
     return router;
 }
-exports.createRouter = createRouter;
 function createQueryRoute({ sofa, router, fieldName, }) {
     logger_js_1.logger.debug(`[Router] Creating ${fieldName} query`);
     const queryType = sofa.schema.getQueryType();
@@ -203,10 +210,12 @@ function createQueryRoute({ sofa, router, fieldName, }) {
 }
 function getRouteSchemas({ method, path, info, sofa, responseStatus, }) {
     const params = {
+        type: 'object',
         properties: {},
         required: [],
     };
     const query = {
+        type: 'object',
         properties: {},
         required: [],
     };

package/cjs/sofa.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isContextFn = exports.createSofa = void 0;
+exports.createSofa = createSofa;
+exports.isContextFn = isContextFn;
 const graphql_1 = require("graphql");
 const common_js_1 = require("./common.js");
 const logger_js_1 = require("./logger.js");
@@ -33,11 +34,9 @@ function createSofa(config) {
         ...config,
     };
 }
-exports.createSofa = createSofa;
 function isContextFn(context) {
     return typeof context === 'function';
 }
-exports.isContextFn = isContextFn;
 // Objects and Unions are the only things that are used to define return types
 // and both might contain an ID
 // We don't treat Unions as models because

package/esm/router.js

@@ -1,4 +1,4 @@
-import { isObjectType, isNonNullType, Kind, isIntrospectionType, isInputObjectType, } from 'graphql';
+import { isObjectType, isNonNullType, Kind, isIntrospectionType, isInputObjectType, isEnumType, } from 'graphql';
 import { buildOperationNodeForField, createGraphQLError } from '@graphql-tools/utils';
 import { getOperationInfo } from './ast.js';
 import { convertName } from './common';
@@ -51,11 +51,19 @@ export function createRouter(sofa) {
     const types = sofa.schema.getTypeMap();
     for (const typeName in types) {
         const type = types[typeName];
-        if ((isObjectType(type) || isInputObjectType(type)) &&
-            !isIntrospectionType(type)) {
-            sofa.openAPI.components.schemas[typeName] = buildSchemaObjectFromType(type, {
-                customScalars: sofa.customScalars,
-            });
+        if (!isIntrospectionType(type)) {
+            if ((isObjectType(type) || isInputObjectType(type))) {
+                sofa.openAPI.components.schemas[typeName] = buildSchemaObjectFromType(type, {
+                    customScalars: sofa.customScalars,
+                });
+            }
+            else if (isEnumType(type)) {
+                sofa.openAPI.components.schemas[typeName] = {
+                    title: type.name,
+                    type: 'string',
+                    enum: type.getValues().map((value) => value.name),
+                };
+            }
         }
     }
     const router = createRouterInstance({
@@ -199,10 +207,12 @@ function createQueryRoute({ sofa, router, fieldName, }) {
 }
 function getRouteSchemas({ method, path, info, sofa, responseStatus, }) {
     const params = {
+        type: 'object',
         properties: {},
         required: [],
     };
     const query = {
+        type: 'object',
         properties: {},
         required: [],
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sofa-api",
-  "version": "0.18.2",
+  "version": "0.18.5",
   "description": "Create REST APIs with GraphQL",
   "sideEffects": false,
   "peerDependencies": {
@@ -9,7 +9,7 @@
   "dependencies": {
     "@graphql-tools/utils": "^10.0.0",
     "@whatwg-node/fetch": "^0.9.14",
-    "fets": "^0.7.0",
+    "fets": "^0.8.0",
     "ansi-colors": "^4.1.3",
     "openapi-types": "^12.1.0",
     "param-case": "^3.0.4",

package/typings/types.d.cts

@@ -13,3 +13,8 @@ export type ContextFn = (serverContext: DefaultSofaServerContext) => Promise<Con
 export type DefaultSofaServerContext = {
     request: Request;
 };
+export interface ObjectJSONSchema {
+    type: 'object';
+    properties: Record<string, any>;
+    required: string[];
+}

package/typings/types.d.ts

@@ -13,3 +13,8 @@ export type ContextFn = (serverContext: DefaultSofaServerContext) => Promise<Con
 export type DefaultSofaServerContext = {
     request: Request;
 };
+export interface ObjectJSONSchema {
+    type: 'object';
+    properties: Record<string, any>;
+    required: string[];
+}