sofa-api 0.16.3 → 0.17.0

package/logger.d.ts

@@ -1,6 +1,6 @@
-export declare const logger: {
-    error: (...args: any[]) => void;
-    warn: (...args: any[]) => void;
-    info: (...args: any[]) => void;
-    debug: (...args: any[]) => void;
-};
+export declare const logger: {
+    error: (...args: any[]) => void;
+    warn: (...args: any[]) => void;
+    info: (...args: any[]) => void;
+    debug: (...args: any[]) => void;
+};

package/open-api/index.d.ts

@@ -1,26 +1,26 @@
-import { GraphQLSchema } from 'graphql';
-import { RouteInfo } from '../types';
-import { OpenAPIV3 } from 'openapi-types';
-export declare function OpenAPI({ schema, info, servers, components, security, tags, customScalars, }: {
-    schema: GraphQLSchema;
-    info: OpenAPIV3.InfoObject;
-    servers?: OpenAPIV3.ServerObject[];
-    components?: Record<string, any>;
-    security?: OpenAPIV3.SecurityRequirementObject[];
-    tags?: OpenAPIV3.TagObject[];
-    /**
-     * Override mapping of custom scalars to OpenAPI
-     * @example
-     * ```js
-     * {
-     *   Date: { type: "string",  format: "date" }
-     * }
-     * ```
-     */
-    customScalars?: Record<string, any>;
-}): {
-    addRoute(info: RouteInfo, config?: {
-        basePath?: string;
-    }): void;
-    get(): OpenAPIV3.Document<{}>;
-};
+import { GraphQLSchema } from 'graphql';
+import { RouteInfo } from '../types';
+import { OpenAPIV3 } from 'openapi-types';
+export declare function OpenAPI({ schema, info, servers, components, security, tags, customScalars, }: {
+    schema: GraphQLSchema;
+    info: OpenAPIV3.InfoObject;
+    servers?: OpenAPIV3.ServerObject[];
+    components?: Record<string, any>;
+    security?: OpenAPIV3.SecurityRequirementObject[];
+    tags?: OpenAPIV3.TagObject[];
+    /**
+     * Override mapping of custom scalars to OpenAPI
+     * @example
+     * ```js
+     * {
+     *   Date: { type: "string",  format: "date" }
+     * }
+     * ```
+     */
+    customScalars?: Record<string, any>;
+}): {
+    addRoute(info: RouteInfo, config?: {
+        basePath?: string;
+    }): void;
+    get(): OpenAPIV3.Document<{}>;
+};

package/open-api/operations.d.ts

@@ -1,11 +1,29 @@
-import { DocumentNode, GraphQLSchema } from 'graphql';
-import { OpenAPIV3 } from 'openapi-types';
-export declare function buildPathFromOperation({ url, schema, operation, useRequestBody, tags, description, customScalars, }: {
-    url: string;
-    schema: GraphQLSchema;
-    operation: DocumentNode;
-    useRequestBody: boolean;
-    tags?: string[];
-    description?: string;
-    customScalars: Record<string, any>;
-}): OpenAPIV3.OperationObject;
+import { DocumentNode, GraphQLSchema, OperationDefinitionNode, TypeNode, VariableDefinitionNode } from 'graphql';
+import { OpenAPIV3 } from 'openapi-types';
+export declare function buildPathFromOperation({ url, schema, operation, useRequestBody, tags, description, customScalars, }: {
+    url: string;
+    schema: GraphQLSchema;
+    operation: DocumentNode;
+    useRequestBody: boolean;
+    tags?: string[];
+    description?: string;
+    customScalars: Record<string, any>;
+}): OpenAPIV3.OperationObject;
+export declare function resolveRequestBody(variables: ReadonlyArray<VariableDefinitionNode> | undefined, schema: GraphQLSchema, operation: OperationDefinitionNode, opts: {
+    customScalars: Record<string, any>;
+    enumTypes: Record<string, any>;
+}): {};
+export declare function resolveParamSchema(type: TypeNode, opts: {
+    customScalars: Record<string, any>;
+    enumTypes: Record<string, any>;
+}): any;
+export declare function resolveResponse({ schema, operation, opts, }: {
+    schema: GraphQLSchema;
+    operation: OperationDefinitionNode;
+    opts: {
+        customScalars: Record<string, any>;
+        enumTypes: Record<string, any>;
+    };
+}): any;
+export declare function isInPath(url: string, param: string): boolean;
+export declare function resolveVariableDescription(schema: GraphQLSchema, operation: OperationDefinitionNode, variable: VariableDefinitionNode): string | undefined;

package/open-api/types.d.ts

@@ -1,7 +1,7 @@
-import { GraphQLObjectType, GraphQLInputObjectType, GraphQLType } from 'graphql';
-export declare function buildSchemaObjectFromType(type: GraphQLObjectType | GraphQLInputObjectType, opts: {
-    customScalars: Record<string, any>;
-}): any;
-export declare function resolveFieldType(type: GraphQLType, opts: {
-    customScalars: Record<string, any>;
-}): any;
+import { GraphQLObjectType, GraphQLInputObjectType, GraphQLType } from 'graphql';
+export declare function buildSchemaObjectFromType(type: GraphQLObjectType | GraphQLInputObjectType, opts: {
+    customScalars: Record<string, any>;
+}): any;
+export declare function resolveFieldType(type: GraphQLType, opts: {
+    customScalars: Record<string, any>;
+}): any;

package/open-api/utils.d.ts

@@ -1,3 +1,3 @@
-export declare function mapToPrimitive(type: string): any;
-export declare function mapToRef(type: string): string;
-export declare function normalizePathParamForOpenAPI(path: string): string;
+export declare function mapToPrimitive(type: string): any;
+export declare function mapToRef(type: string): string;
+export declare function normalizePathParamForOpenAPI(path: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sofa-api",
-  "version": "0.16.3",
+  "version": "0.17.0",
   "description": "Create REST APIs with GraphQL",
   "sideEffects": false,
   "peerDependencies": {
@@ -8,9 +8,9 @@
   },
   "dependencies": {
     "@graphql-tools/utils": "^9.2.0",
-    "@whatwg-node/fetch": "^0.6.6",
-    "@whatwg-node/router": "^0.2.0",
+    "@whatwg-node/fetch": "^0.8.0",
     "ansi-colors": "^4.1.3",
+    "fets": "^0.1.4",
     "openapi-types": "^12.1.0",
     "param-case": "^3.0.4",
     "title-case": "^3.0.3",
@@ -49,4 +49,4 @@
     },
     "./package.json": "./package.json"
   }
-}
+}

package/parse.d.ts

@@ -1,6 +1,6 @@
-import { VariableDefinitionNode, GraphQLSchema } from 'graphql';
-export declare function parseVariable({ value, variable, schema, }: {
-    value: any;
-    variable: VariableDefinitionNode;
-    schema: GraphQLSchema;
-}): any;
+import { VariableDefinitionNode, GraphQLSchema } from 'graphql';
+export declare function parseVariable({ value, variable, schema, }: {
+    value: any;
+    variable: VariableDefinitionNode;
+    schema: GraphQLSchema;
+}): any;

package/router.d.ts

@@ -1,13 +1,16 @@
-import type { Sofa } from './sofa';
-import { Router } from '@whatwg-node/router';
-export type ErrorHandler = (errors: ReadonlyArray<any>) => Response;
-declare module 'graphql' {
-    interface GraphQLHTTPErrorExtensions {
-        status?: number;
-        headers?: Record<string, string>;
-    }
-    interface GraphQLErrorExtensions {
-        http?: GraphQLHTTPErrorExtensions;
-    }
-}
-export declare function createRouter(sofa: Sofa): Router<{}>;
+import type { Sofa } from './sofa';
+import { Response, Router } from 'fets';
+export type ErrorHandler = (errors: ReadonlyArray<any>) => Response;
+declare module 'graphql' {
+    interface GraphQLHTTPErrorExtensions {
+        spec?: boolean;
+        status?: number;
+        headers?: Record<string, string>;
+    }
+    interface GraphQLErrorExtensions {
+        http?: GraphQLHTTPErrorExtensions;
+    }
+}
+export declare function createRouter(sofa: Sofa): Router<any, {}, {
+    [TKey: string]: never;
+}>;

package/sofa.d.ts

@@ -1,50 +1,58 @@
-import { GraphQLSchema, subscribe, execute } from 'graphql';
-import { Ignore, OnRoute, Method, ContextFn, ContextValue } from './types';
-import { ErrorHandler } from './router';
-interface RouteConfig {
-    method?: Method;
-    path?: string;
-    responseStatus?: number;
-    tags?: string[];
-    description?: string;
-}
-export interface Route {
-    method: Method;
-    path: string;
-    responseStatus: number;
-}
-export interface SofaConfig {
-    basePath: string;
-    schema: GraphQLSchema;
-    execute?: typeof execute;
-    subscribe?: typeof subscribe;
-    /**
-     * Treats an Object with an ID as not a model.
-     * @example ["User", "Message.author"]
-     */
-    ignore?: Ignore;
-    onRoute?: OnRoute;
-    depthLimit?: number;
-    errorHandler?: ErrorHandler;
-    /**
-     * Overwrites the default HTTP route.
-     */
-    routes?: Record<string, RouteConfig>;
-    context?: ContextFn | ContextValue;
-}
-export interface Sofa {
-    basePath: string;
-    schema: GraphQLSchema;
-    models: string[];
-    ignore: Ignore;
-    depthLimit: number;
-    routes?: Record<string, RouteConfig>;
-    execute: typeof execute;
-    subscribe: typeof subscribe;
-    onRoute?: OnRoute;
-    errorHandler?: ErrorHandler;
-    contextFactory: ContextFn;
-}
-export declare function createSofa(config: SofaConfig): Sofa;
-export declare function isContextFn(context: any): context is ContextFn;
-export {};
+import { GraphQLSchema, subscribe, execute } from 'graphql';
+import { Ignore, ContextFn, ContextValue } from './types';
+import { ErrorHandler } from './router';
+import { HTTPMethod, StatusCode } from 'fets/typings/typed-fetch';
+export interface RouteConfig {
+    method?: HTTPMethod;
+    path?: string;
+    responseStatus?: StatusCode;
+    tags?: string[];
+    description?: string;
+}
+export interface Route {
+    method: HTTPMethod;
+    path: string;
+    responseStatus: StatusCode;
+}
+export interface SofaConfig {
+    basePath: string;
+    schema: GraphQLSchema;
+    execute?: typeof execute;
+    subscribe?: typeof subscribe;
+    /**
+     * Treats an Object with an ID as not a model.
+     * @example ["User", "Message.author"]
+     */
+    ignore?: Ignore;
+    depthLimit?: number;
+    errorHandler?: ErrorHandler;
+    /**
+     * Overwrites the default HTTP route.
+     */
+    routes?: Record<string, RouteConfig>;
+    context?: ContextFn | ContextValue;
+    customScalars?: Record<string, any>;
+    enumTypes?: Record<string, any>;
+    title?: string;
+    version?: string;
+    description?: string;
+}
+export interface Sofa {
+    basePath: string;
+    schema: GraphQLSchema;
+    models: string[];
+    ignore: Ignore;
+    depthLimit: number;
+    routes?: Record<string, RouteConfig>;
+    execute: typeof execute;
+    subscribe: typeof subscribe;
+    errorHandler?: ErrorHandler;
+    contextFactory: ContextFn;
+    customScalars: Record<string, any>;
+    enumTypes: Record<string, any>;
+    title?: string;
+    version?: string;
+    description?: string;
+}
+export declare function createSofa(config: SofaConfig): Sofa;
+export declare function isContextFn(context: any): context is ContextFn;

package/subscriptions.d.ts

@@ -1,33 +1,33 @@
-import { ExecutionResult } from 'graphql';
-import type { ContextValue } from './types';
-import type { Sofa } from './sofa';
-export type ID = string;
-export type SubscriptionFieldName = string;
-export interface StartSubscriptionEvent {
-    subscription: SubscriptionFieldName;
-    variables: any;
-    url: string;
-}
-export interface UpdateSubscriptionEvent {
-    id: ID;
-    variables: any;
-}
-export interface StopSubscriptionResponse {
-    id: ID;
-}
-export declare class SubscriptionManager {
-    private sofa;
-    private operations;
-    private clients;
-    constructor(sofa: Sofa);
-    start(event: StartSubscriptionEvent, contextValue: ContextValue): Promise<ExecutionResult<import("graphql/jsutils/ObjMap").ObjMap<unknown>, import("graphql/jsutils/ObjMap").ObjMap<unknown>> | {
-        id: string;
-    }>;
-    stop(id: ID): Promise<StopSubscriptionResponse>;
-    update(event: UpdateSubscriptionEvent, contextValue: ContextValue): Promise<ExecutionResult<import("graphql/jsutils/ObjMap").ObjMap<unknown>, import("graphql/jsutils/ObjMap").ObjMap<unknown>> | {
-        id: string;
-    }>;
-    private execute;
-    private sendData;
-    private buildOperations;
-}
+import { ExecutionResult } from 'graphql';
+import type { ContextValue } from './types';
+import type { Sofa } from './sofa';
+export type ID = string;
+export type SubscriptionFieldName = string;
+export interface StartSubscriptionEvent {
+    subscription: SubscriptionFieldName;
+    variables: any;
+    url: string;
+}
+export interface UpdateSubscriptionEvent {
+    id: ID;
+    variables: any;
+}
+export interface StopSubscriptionResponse {
+    id: ID;
+}
+export declare class SubscriptionManager {
+    private sofa;
+    private operations;
+    private clients;
+    constructor(sofa: Sofa);
+    start(event: StartSubscriptionEvent, contextValue: ContextValue): Promise<ExecutionResult<import("graphql/jsutils/ObjMap").ObjMap<unknown>, import("graphql/jsutils/ObjMap").ObjMap<unknown>> | {
+        id: `${string}-${string}-${string}-${string}-${string}`;
+    }>;
+    stop(id: ID): Promise<StopSubscriptionResponse>;
+    update(event: UpdateSubscriptionEvent, contextValue: ContextValue): Promise<ExecutionResult<import("graphql/jsutils/ObjMap").ObjMap<unknown>, import("graphql/jsutils/ObjMap").ObjMap<unknown>> | {
+        id: `${string}-${string}-${string}-${string}-${string}`;
+    }>;
+    private execute;
+    private sendData;
+    private buildOperations;
+}

package/types.d.ts

@@ -1,16 +1,15 @@
-import { DocumentNode } from 'graphql';
-export type ContextValue = Record<string, any>;
-export type Ignore = string[];
-export type Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
-export interface RouteInfo {
-    document: DocumentNode;
-    path: string;
-    method: Method;
-    tags?: string[];
-    description?: string;
-}
-export type OnRoute = (info: RouteInfo) => void;
-export type ContextFn = (serverContext: DefaultSofaServerContext) => Promise<ContextValue> | ContextValue;
-export type DefaultSofaServerContext = {
-    request: Request;
-};
+import { HTTPMethod } from 'fets/typings/typed-fetch';
+import { DocumentNode } from 'graphql';
+export type ContextValue = Record<string, any>;
+export type Ignore = string[];
+export interface RouteInfo {
+    document: DocumentNode;
+    path: string;
+    method: HTTPMethod;
+    tags?: string[];
+    description?: string;
+}
+export type ContextFn = (serverContext: DefaultSofaServerContext) => Promise<ContextValue> | ContextValue;
+export type DefaultSofaServerContext = {
+    request: Request;
+};