@orion-js/graphql 3.11.15 → 3.12.0

package/dist/index.d.ts

@@ -0,0 +1,116 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import { ApolloServerOptions } from '@apollo/server';
+import { express } from '@orion-js/http';
+import { GlobalResolversMap, Model, ModelResolversMap } from '@orion-js/models';
+import { GlobalResolverResolve, ModelResolver as ModelResolverType, ModelResolverResolve, Resolver, ResolverMiddleware, ResolverOptions } from '@orion-js/resolvers';
+import { Schema } from '@orion-js/schema';
+import * as GraphQL from 'graphql';
+import { PubSubEngine } from 'graphql-subscriptions';
+
+export declare class OrionSubscription<TParams = any, ReturnType = any> {
+	name: string;
+	params: object;
+	subscribe: (callParams: object, viewer: object) => {};
+	returns: ReturnType;
+	publish: (params: TParams, data: ReturnType) => Promise<void>;
+}
+export type CreateOrionSubscriptionFunction = <T = any, ReturnType = any>(options: OrionSubscriptionOptions) => OrionSubscription<T, ReturnType>;
+export interface OrionSubscriptionsMap {
+	[key: string]: OrionSubscription;
+}
+export interface OrionSubscriptionOptions extends Omit<ResolverOptions, "resolve"> {
+	name?: string;
+}
+declare const createSubscription: CreateOrionSubscriptionFunction;
+export type ExecuteGraphQLCache = (req: express.Request, res: express.Response, viewer: object, executeQuery: () => Promise<string>) => Promise<string>;
+export interface ModelsResolversMap {
+	[key: string]: ModelResolversMap;
+}
+export type SchemaOmits = "schema" | "schemaHash" | "context" | "useGraphiql";
+export interface StartGraphQLOptions extends Omit<ApolloServerOptions<any>, SchemaOmits> {
+	/**
+	 * A map with all the global resolvers
+	 */
+	resolvers: GlobalResolversMap;
+	/**
+	 * A map with all the model resolvers. You must only add the models that you want to extend with resolvers.
+	 */
+	modelResolvers?: ModelsResolversMap;
+	/**
+	 * A Map with all global subscriptions
+	 */
+	subscriptions?: OrionSubscriptionsMap;
+	/**
+	 * A function that executes the http level cache of graphql queries
+	 */
+	/**
+	 * Should use GraphiQL. Default to true
+	 */
+	useGraphiql?: boolean;
+	/**
+	 * Pass another express app
+	 */
+	app?: express.Application;
+	/**
+	 * The pubsub provider to use. Default to the single server pubsub.
+	 * If you are using multiple servers you must pass a pubsub provider like RedisPubSub
+	 */
+	pubsub?: PubSubEngine;
+}
+declare function _default(options: StartGraphQLOptions): Promise<void>;
+declare function _default$1(apolloOptions: ApolloServerOptions<any>, options: StartGraphQLOptions): void;
+declare const _default$2: {
+	params: import("@orion-js/resolvers").Resolver<({ mutation, name }: any, viewer: any) => Promise<{
+		resolver: import("@orion-js/models").Resolver<import("@orion-js/models").GlobalResolverResolve, undefined>;
+		name: any;
+	}>, undefined>;
+};
+declare const _default$3: Model<any>;
+export function serializeSchema(params: any): Promise<Schema>;
+declare function getBasicQuery(field: any): Promise<any>;
+export declare function Resolvers(): ClassDecorator;
+export interface GlobalResolverPropertyDescriptor extends Omit<PropertyDecorator, "value"> {
+	value?: GlobalResolverResolve;
+}
+export declare function Query(options?: Omit<ResolverOptions<any>, "resolve" | "mutation">): (target: any, propertyKey: string, descriptor: GlobalResolverPropertyDescriptor) => void;
+export declare function Mutation(options?: Omit<ResolverOptions<any>, "resolve" | "mutation">): (target: any, propertyKey: string, descriptor: GlobalResolverPropertyDescriptor) => void;
+export declare function getServiceResolvers(target: any): {
+	[key: string]: Resolver<GlobalResolverResolve>;
+};
+export interface ModelResolverPropertyDescriptor extends Omit<PropertyDecorator, "value"> {
+	value?: ModelResolverResolve;
+}
+export declare function ModelResolver(options?: Omit<ResolverOptions<any>, "resolve" | "middlewares">): (target: any, propertyKey: string, descriptor: ModelResolverPropertyDescriptor) => void;
+export interface ModelResolversOptions {
+	modelName?: string;
+}
+export declare function ModelResolvers(typedSchema: any, options?: ModelResolversOptions): ClassDecorator;
+export declare function getServiceModelResolvers(target: any): {
+	[key: string]: {
+		[key: string]: ModelResolverType<GlobalResolverResolve>;
+	};
+};
+export declare function Subscriptions(): ClassDecorator;
+export declare function Subscription<T = any, ReturnType = any>(options: OrionSubscriptionOptions): (object: any, propertyName: string, index?: number) => void;
+export declare function getServiceSubscriptions(target: any): {
+	[key: string]: OrionSubscription;
+};
+export declare function getTargetMetadata(target: any, propertyKey: string, metadataKey: string): any;
+export declare const UseMiddleware: (metadata: ResolverMiddleware) => (target: any, propertyKey: string, descriptor: GlobalResolverPropertyDescriptor | ModelResolverPropertyDescriptor) => void;
+export declare const ResolverParams: (metadata: any) => (target: any, propertyKey: string, descriptor: GlobalResolverPropertyDescriptor | ModelResolverPropertyDescriptor) => void;
+export declare const ResolverReturns: (metadata: any) => (target: any, propertyKey: string, descriptor: GlobalResolverPropertyDescriptor | ModelResolverPropertyDescriptor) => void;
+export declare const getWebsockerViewer: (connectionParams: any) => Promise<any>;
+export declare const setGetWebsockerViewer: (getViewerFunc: (connectionParams: any) => any) => void;
+
+export {
+	GraphQL,
+	_default as startGraphQL,
+	_default$1 as startGraphiQL,
+	_default$2 as resolversSchemas,
+	_default$3 as ResolverParamsInfo,
+	createSubscription as subscription,
+	getBasicQuery as getBasicResultQuery,
+};
+
+export {};