@webda/graphql 4.0.0-beta.1 → 4.0.0-beta.3

package/lib/graphql.d.ts

@@ -1,170 +0,0 @@
-import { Application, CoreModel, CoreModelDefinition, DeepPartial, DomainService, DomainServiceParameters, ModelGraph, WebContext } from "@webda/core";
-import * as WebdaQL from "@webda/ql";
-import { FieldNode, GraphQLFieldConfig, GraphQLResolveInfo, GraphQLSchema, GraphQLType, ThunkObjMap } from "graphql";
-import { Handler } from "graphql-http";
-import { Server as GraphQLWSServer } from "graphql-ws";
-import { JSONSchema7 } from "json-schema";
-import { WebSocketServer } from "ws";
-export interface GraphQLContextExtension {
-    /**
-     * Get the current count of operation for this request
-     */
-    count?: number;
-}
-/**
- * Parameters for the GraphQL service
- */
-export declare class GraphQLParameters extends DomainServiceParameters {
-    /**
-     * Max number of requests allowed within a graphql query or mutation
-     *
-     * @default 10
-     */
-    maxOperationsPerRequest: number;
-    /**
-     * User model to expose
-     * @default User
-     */
-    userModel: string;
-    /**
-     * Expose current user in the context with me
-     * @default true
-     */
-    exposeMe: boolean;
-    /**
-     * Expose the schema
-     */
-    exposeGraphiQL: boolean;
-    /**
-     * Expose a aggregation of all available subscriptions
-     */
-    globalSubscription: boolean;
-    constructor(params: any);
-}
-/**
- * Implement a GraphQL service
- *
- * It will expose all your exposed models as GraphQL types
- * Dynamically generate the schema
- *
- * @WebdaModda
- */
-export declare class GraphQLService<T extends GraphQLParameters = GraphQLParameters> extends DomainService<T> {
-    schema: GraphQLSchema;
-    handler: Handler;
-    modelsMap: {};
-    app: Application;
-    wss: WebSocketServer;
-    wsHandler: GraphQLWSServer;
-    modelListeners: any;
-    loadParameters(params: DeepPartial<T>): GraphQLParameters;
-    /**
-     *
-     * @param prop
-     * @param definitions
-     * @returns
-     */
-    getJsonSchemaDefinition(prop: JSONSchema7, definitions?: {}): JSONSchema7;
-    /**
-     *
-     * @param schema
-     * @param defaultName
-     * @returns
-     */
-    getGraphQLSchemaFromSchema(schema: JSONSchema7, defaultName: string, input?: boolean): {
-        type: GraphQLType;
-        description?: string;
-    };
-    /**
-     * Add the GraphQL schema results
-     * @param type
-     * @returns
-     */
-    getGraphQLQueryResult(type: any): any;
-    /**
-     *
-     * @param schema
-     * @param defaultName
-     * @param webdaGraph
-     * @returns
-     */
-    getGraphQLFieldsFromSchema(schema: JSONSchema7, defaultName: string, webdaGraph?: ModelGraph, input?: boolean): any;
-    /**
-     * Load model with filter on attributes
-     * @param knownFieldsOrId
-     * @param model
-     * @param context
-     * @param info
-     * @returns
-     */
-    loadModelInstance(knownFieldsOrId: string | {
-        uuid: string;
-        [key: string]: any;
-    }, model: CoreModelDefinition, context: WebContext, info?: FieldNode, filter?: WebdaQL.PartialValidator): Promise<CoreModel | {
-        [key: string]: any;
-        uuid: string;
-    }>;
-    /**
-     * Count the number of operations done with graphql
-     * @param context
-     */
-    countOperation(context: WebContext, increment?: number): void;
-    resolve(): this;
-    /**
-     * Generate GraphQL schema
-     */
-    generateSchema(): void;
-    /**
-     * Return the events to subscribe to
-     * @param info
-     * @returns
-     */
-    getSubscribedEvents(info: GraphQLResolveInfo): string[];
-    /**
-     *
-     * @param model
-     * @param arg1
-     * @param context
-     * @returns
-     */
-    registerAsyncIteratorQuery(model: CoreModelDefinition<CoreModel>, plural: string, query: string, context: any): Promise<AsyncIterator<any>>;
-    /**
-     *
-     * @param model
-     * @param uuid
-     * @param context
-     * @returns
-     */
-    registerAsyncIterator(model: CoreModelDefinition<CoreModel>, uuid: any, context: any, identifier?: string): Promise<AsyncIterator<any>>;
-    /**
-     *
-     * @param model
-     * @param uuid
-     * @param context
-     * @returns
-     */
-    registerAsyncEventIterator(model: CoreModelDefinition<CoreModel>, uuid: string | null, events: string[], context: any, identifier: string): Promise<AsyncIterator<any>>;
-    /**
-     *
-     * @param rootFields
-     * @param mutation
-     * @returns
-     */
-    getGraphQLSchema(rootFields: ThunkObjMap<GraphQLFieldConfig<any, any, any>>, mutations?: ThunkObjMap<GraphQLFieldConfig<any, any, any>>, subscription?: ThunkObjMap<GraphQLFieldConfig<any, any, any>>): GraphQLSchema;
-    /**
-     * @override
-     */
-    init(): Promise<this>;
-    handleModel(model: CoreModelDefinition<CoreModel>, name: string, context: any): boolean;
-    /**
-     * Serve schema and graphqli
-     * @params ctx
-     */
-    schemaRoute(ctx: WebContext<any>): Promise<void>;
-    /**
-     * Endpoint for the GraphQL schema
-     * @param ctx
-     * @returns
-     */
-    endpoint(ctx: WebContext<any>): Promise<void>;
-}