sofa-api 0.12.0 → 0.14.0

package/README.md

@@ -150,7 +150,7 @@ Sofa allows you to cutomize the http method, path and response status. For examp
 ```typescript
 api.use(
   '/api',
-  sofa({
+  useSofa({
     schema,
     routes: {
       'Query.feed': { method: 'POST' },
@@ -341,7 +341,7 @@ app.use(
 writeFileSync('./swagger.json', JSON.stringify(openApi.get(), null, 2));
 ```
 
-OpenAPI (Swagger) with custom tags, summary and description  
+OpenAPI (Swagger) with custom tags, summary and description
 
 ```ts
 const openApi = OpenAPI({

package/index.js

@@ -297,12 +297,11 @@ function createRouter(sofa) {
     router.post('/webhook', (request, serverContext) => tslib.__awaiter(this, void 0, void 0, function* () {
         const { subscription, variables, url } = yield request.json();
         try {
-            const contextValue = yield sofa.contextFactory(serverContext);
             const result = yield subscriptionManager.start({
                 subscription,
                 variables,
                 url,
-            }, contextValue);
+            }, Object.assign(Object.assign({}, serverContext), { request }));
             return new fetch.Response(JSON.stringify(result), {
                 status: 200,
                 statusText: 'OK',
@@ -324,7 +323,8 @@ function createRouter(sofa) {
         const body = yield request.json();
         const variables = body.variables;
         try {
-            const contextValue = yield sofa.contextFactory(serverContext);
+            const sofaServerContext = Object.assign(Object.assign({}, serverContext), { request });
+            const contextValue = yield sofa.contextFactory(sofaServerContext);
             const result = yield subscriptionManager.update({
                 id,
                 variables,
@@ -367,7 +367,7 @@ function createRouter(sofa) {
     return router;
 }
 function createQueryRoute({ sofa, router, fieldName, }) {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g;
     logger.debug(`[Router] Creating ${fieldName} query`);
     const queryType = sofa.schema.getQueryType();
     const operationNode = utils.buildOperationNodeForField({
@@ -402,13 +402,14 @@ function createQueryRoute({ sofa, router, fieldName, }) {
         path: route.path,
         method: route.method.toUpperCase(),
         tags: (_e = routeConfig === null || routeConfig === void 0 ? void 0 : routeConfig.tags) !== null && _e !== void 0 ? _e : [],
-        description: (_f = routeConfig === null || routeConfig === void 0 ? void 0 : routeConfig.description) !== null && _f !== void 0 ? _f : '',
+        description: (_g = (_f = routeConfig === null || routeConfig === void 0 ? void 0 : routeConfig.description) !== null && _f !== void 0 ? _f : field.description) !== null && _g !== void 0 ? _g : '',
     };
 }
 function createMutationRoute({ sofa, router, fieldName, }) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e, _f;
     logger.debug(`[Router] Creating ${fieldName} mutation`);
     const mutationType = sofa.schema.getMutationType();
+    const field = mutationType.getFields()[fieldName];
     const operationNode = utils.buildOperationNodeForField({
         kind: 'mutation',
         schema: sofa.schema,
@@ -437,7 +438,7 @@ function createMutationRoute({ sofa, router, fieldName, }) {
         path,
         method,
         tags: (routeConfig === null || routeConfig === void 0 ? void 0 : routeConfig.tags) || [],
-        description: (routeConfig === null || routeConfig === void 0 ? void 0 : routeConfig.description) || '',
+        description: (_f = (_e = routeConfig === null || routeConfig === void 0 ? void 0 : routeConfig.description) !== null && _e !== void 0 ? _e : field.description) !== null && _f !== void 0 ? _f : '',
     };
 }
 function useHandler(config) {
@@ -469,7 +470,8 @@ function useHandler(config) {
             }
             return Object.assign(Object.assign({}, variables), { [name]: value });
         }, {});
-        const contextValue = yield sofa.contextFactory(serverContext);
+        const sofaServerContext = Object.assign(Object.assign({}, serverContext), { request });
+        const contextValue = yield sofa.contextFactory(sofaServerContext);
         const result = yield sofa.execute({
             schema: sofa.schema,
             document: operation,
@@ -479,8 +481,9 @@ function useHandler(config) {
         });
         if (result.errors) {
             const defaultErrorHandler = (errors) => {
-                return new fetch.Response(errors[0], {
+                return new fetch.Response(JSON.stringify(errors[0]), {
                     status: 500,
+                    headers: { 'Content-Type': 'application/json' },
                 });
             };
             const errorHandler = sofa.errorHandler || defaultErrorHandler;
@@ -642,6 +645,7 @@ function resolveField(field, opts) {
 // type -> $ref
 // scalar -> swagger primitive
 function resolveFieldType(type, opts) {
+    var _a;
     if (graphql.isNonNullType(type)) {
         return resolveFieldType(type.ofType, opts);
     }
@@ -658,9 +662,11 @@ function resolveFieldType(type, opts) {
     }
     if (graphql.isScalarType(type)) {
         return (mapToPrimitive(type.name) ||
-            opts.customScalars[type.name] || {
-            type: 'object',
-        });
+            opts.customScalars[type.name] ||
+            ((_a = type.extensions) === null || _a === void 0 ? void 0 : _a.jsonSchema)
+            || {
+                type: 'object',
+            });
     }
     if (graphql.isEnumType(type)) {
         return {
@@ -683,13 +689,15 @@ function buildPathFromOperation({ url, schema, operation, useRequestBody, tags,
             requestBody: {
                 content: {
                     'application/json': {
-                        schema: resolveRequestBody(info.operation.variableDefinitions),
+                        schema: resolveRequestBody(info.operation.variableDefinitions, {
+                            customScalars,
+                        }),
                     },
                 },
             },
         }
         : {
-            parameters: resolveParameters(url, info.operation.variableDefinitions),
+            parameters: resolveParameters(url, info.operation.variableDefinitions, { customScalars }),
         })), { responses: {
             200: {
                 description: summary,
@@ -705,7 +713,7 @@ function buildPathFromOperation({ url, schema, operation, useRequestBody, tags,
             },
         } });
 }
-function resolveParameters(url, variables) {
+function resolveParameters(url, variables, opts) {
     if (!variables) {
         return [];
     }
@@ -714,11 +722,11 @@ function resolveParameters(url, variables) {
             in: isInPath(url, variable.variable.name.value) ? 'path' : 'query',
             name: variable.variable.name.value,
             required: variable.type.kind === graphql.Kind.NON_NULL_TYPE,
-            schema: resolveParamSchema(variable.type),
+            schema: resolveParamSchema(variable.type, opts),
         };
     });
 }
-function resolveRequestBody(variables) {
+function resolveRequestBody(variables, opts) {
     if (!variables) {
         return {};
     }
@@ -728,25 +736,26 @@ function resolveRequestBody(variables) {
         if (variable.type.kind === graphql.Kind.NON_NULL_TYPE) {
             required.push(variable.variable.name.value);
         }
-        properties[variable.variable.name.value] = resolveParamSchema(variable.type);
+        properties[variable.variable.name.value] = resolveParamSchema(variable.type, opts);
     });
     return Object.assign({ type: 'object', properties }, (required.length ? { required } : {}));
 }
 // array -> [type]
 // type -> $ref
 // scalar -> swagger primitive
-function resolveParamSchema(type) {
+function resolveParamSchema(type, opts) {
     if (type.kind === graphql.Kind.NON_NULL_TYPE) {
-        return resolveParamSchema(type.type);
+        return resolveParamSchema(type.type, opts);
     }
     if (type.kind === graphql.Kind.LIST_TYPE) {
         return {
             type: 'array',
-            items: resolveParamSchema(type.type),
+            items: resolveParamSchema(type.type, opts),
         };
     }
     const primitive = mapToPrimitive(type.name.value);
-    return (primitive || {
+    return (primitive ||
+        opts.customScalars[type.name.value] || {
         $ref: mapToRef(type.name.value),
     });
 }

package/index.mjs

@@ -291,12 +291,11 @@ function createRouter(sofa) {
     router.post('/webhook', (request, serverContext) => __awaiter(this, void 0, void 0, function* () {
         const { subscription, variables, url } = yield request.json();
         try {
-            const contextValue = yield sofa.contextFactory(serverContext);
             const result = yield subscriptionManager.start({
                 subscription,
                 variables,
                 url,
-            }, contextValue);
+            }, Object.assign(Object.assign({}, serverContext), { request }));
             return new Response(JSON.stringify(result), {
                 status: 200,
                 statusText: 'OK',
@@ -318,7 +317,8 @@ function createRouter(sofa) {
         const body = yield request.json();
         const variables = body.variables;
         try {
-            const contextValue = yield sofa.contextFactory(serverContext);
+            const sofaServerContext = Object.assign(Object.assign({}, serverContext), { request });
+            const contextValue = yield sofa.contextFactory(sofaServerContext);
             const result = yield subscriptionManager.update({
                 id,
                 variables,
@@ -361,7 +361,7 @@ function createRouter(sofa) {
     return router;
 }
 function createQueryRoute({ sofa, router, fieldName, }) {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g;
     logger.debug(`[Router] Creating ${fieldName} query`);
     const queryType = sofa.schema.getQueryType();
     const operationNode = buildOperationNodeForField({
@@ -396,13 +396,14 @@ function createQueryRoute({ sofa, router, fieldName, }) {
         path: route.path,
         method: route.method.toUpperCase(),
         tags: (_e = routeConfig === null || routeConfig === void 0 ? void 0 : routeConfig.tags) !== null && _e !== void 0 ? _e : [],
-        description: (_f = routeConfig === null || routeConfig === void 0 ? void 0 : routeConfig.description) !== null && _f !== void 0 ? _f : '',
+        description: (_g = (_f = routeConfig === null || routeConfig === void 0 ? void 0 : routeConfig.description) !== null && _f !== void 0 ? _f : field.description) !== null && _g !== void 0 ? _g : '',
     };
 }
 function createMutationRoute({ sofa, router, fieldName, }) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e, _f;
     logger.debug(`[Router] Creating ${fieldName} mutation`);
     const mutationType = sofa.schema.getMutationType();
+    const field = mutationType.getFields()[fieldName];
     const operationNode = buildOperationNodeForField({
         kind: 'mutation',
         schema: sofa.schema,
@@ -431,7 +432,7 @@ function createMutationRoute({ sofa, router, fieldName, }) {
         path,
         method,
         tags: (routeConfig === null || routeConfig === void 0 ? void 0 : routeConfig.tags) || [],
-        description: (routeConfig === null || routeConfig === void 0 ? void 0 : routeConfig.description) || '',
+        description: (_f = (_e = routeConfig === null || routeConfig === void 0 ? void 0 : routeConfig.description) !== null && _e !== void 0 ? _e : field.description) !== null && _f !== void 0 ? _f : '',
     };
 }
 function useHandler(config) {
@@ -463,7 +464,8 @@ function useHandler(config) {
             }
             return Object.assign(Object.assign({}, variables), { [name]: value });
         }, {});
-        const contextValue = yield sofa.contextFactory(serverContext);
+        const sofaServerContext = Object.assign(Object.assign({}, serverContext), { request });
+        const contextValue = yield sofa.contextFactory(sofaServerContext);
         const result = yield sofa.execute({
             schema: sofa.schema,
             document: operation,
@@ -473,8 +475,9 @@ function useHandler(config) {
         });
         if (result.errors) {
             const defaultErrorHandler = (errors) => {
-                return new Response(errors[0], {
+                return new Response(JSON.stringify(errors[0]), {
                     status: 500,
+                    headers: { 'Content-Type': 'application/json' },
                 });
             };
             const errorHandler = sofa.errorHandler || defaultErrorHandler;
@@ -636,6 +639,7 @@ function resolveField(field, opts) {
 // type -> $ref
 // scalar -> swagger primitive
 function resolveFieldType(type, opts) {
+    var _a;
     if (isNonNullType(type)) {
         return resolveFieldType(type.ofType, opts);
     }
@@ -652,9 +656,11 @@ function resolveFieldType(type, opts) {
     }
     if (isScalarType(type)) {
         return (mapToPrimitive(type.name) ||
-            opts.customScalars[type.name] || {
-            type: 'object',
-        });
+            opts.customScalars[type.name] ||
+            ((_a = type.extensions) === null || _a === void 0 ? void 0 : _a.jsonSchema)
+            || {
+                type: 'object',
+            });
     }
     if (isEnumType(type)) {
         return {
@@ -677,13 +683,15 @@ function buildPathFromOperation({ url, schema, operation, useRequestBody, tags,
             requestBody: {
                 content: {
                     'application/json': {
-                        schema: resolveRequestBody(info.operation.variableDefinitions),
+                        schema: resolveRequestBody(info.operation.variableDefinitions, {
+                            customScalars,
+                        }),
                     },
                 },
             },
         }
         : {
-            parameters: resolveParameters(url, info.operation.variableDefinitions),
+            parameters: resolveParameters(url, info.operation.variableDefinitions, { customScalars }),
         })), { responses: {
             200: {
                 description: summary,
@@ -699,7 +707,7 @@ function buildPathFromOperation({ url, schema, operation, useRequestBody, tags,
             },
         } });
 }
-function resolveParameters(url, variables) {
+function resolveParameters(url, variables, opts) {
     if (!variables) {
         return [];
     }
@@ -708,11 +716,11 @@ function resolveParameters(url, variables) {
             in: isInPath(url, variable.variable.name.value) ? 'path' : 'query',
             name: variable.variable.name.value,
             required: variable.type.kind === Kind.NON_NULL_TYPE,
-            schema: resolveParamSchema(variable.type),
+            schema: resolveParamSchema(variable.type, opts),
         };
     });
 }
-function resolveRequestBody(variables) {
+function resolveRequestBody(variables, opts) {
     if (!variables) {
         return {};
     }
@@ -722,25 +730,26 @@ function resolveRequestBody(variables) {
         if (variable.type.kind === Kind.NON_NULL_TYPE) {
             required.push(variable.variable.name.value);
         }
-        properties[variable.variable.name.value] = resolveParamSchema(variable.type);
+        properties[variable.variable.name.value] = resolveParamSchema(variable.type, opts);
     });
     return Object.assign({ type: 'object', properties }, (required.length ? { required } : {}));
 }
 // array -> [type]
 // type -> $ref
 // scalar -> swagger primitive
-function resolveParamSchema(type) {
+function resolveParamSchema(type, opts) {
     if (type.kind === Kind.NON_NULL_TYPE) {
-        return resolveParamSchema(type.type);
+        return resolveParamSchema(type.type, opts);
     }
     if (type.kind === Kind.LIST_TYPE) {
         return {
             type: 'array',
-            items: resolveParamSchema(type.type),
+            items: resolveParamSchema(type.type, opts),
         };
     }
     const primitive = mapToPrimitive(type.name.value);
-    return (primitive || {
+    return (primitive ||
+        opts.customScalars[type.name.value] || {
         $ref: mapToRef(type.name.value),
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sofa-api",
-  "version": "0.12.0",
+  "version": "0.14.0",
   "description": "Create REST APIs with GraphQL",
   "sideEffects": false,
   "peerDependencies": {
@@ -8,9 +8,9 @@
   },
   "dependencies": {
     "@graphql-tools/utils": "8.12.0",
-    "ansi-colors": "4.1.3",
     "@whatwg-node/fetch": "^0.4.3",
     "@whatwg-node/server": "^0.4.1",
+    "ansi-colors": "4.1.3",
     "itty-router": "^2.6.1",
     "openapi-types": "12.0.2",
     "param-case": "3.0.4",

package/types.d.ts

@@ -1,3 +1,4 @@
+import { DefaultServerAdapterContext } from '@whatwg-node/server';
 import { DocumentNode } from 'graphql';
 export declare type ContextValue = Record<string, any>;
 export declare type Ignore = string[];
@@ -10,7 +11,7 @@ export interface RouteInfo {
     description?: string;
 }
 export declare type OnRoute = (info: RouteInfo) => void;
-export declare type ContextFn = (init: {
-    req: any;
-    res: any;
-}) => Promise<ContextValue> | ContextValue;
+export declare type ContextFn = (serverContext: DefaultSofaServerContext) => Promise<ContextValue> | ContextValue;
+export declare type DefaultSofaServerContext = DefaultServerAdapterContext & {
+    request: Request;
+};