@orion-js/graphql 4.3.1 → 4.4.0

package/dist/service/subscription.d.ts

@@ -0,0 +1,6 @@
+import { OrionSubscription } from '../types/subscription';
+export declare function Subscriptions(): (target: any, context: ClassDecoratorContext<any>) => void;
+export declare function Subscription(): (method: any, context: ClassFieldDecoratorContext) => any;
+export declare function getServiceSubscriptions(target: any): {
+    [key: string]: OrionSubscription;
+};

package/dist/startGraphQL.d.ts

@@ -0,0 +1,2 @@
+import { StartGraphQLOptions } from './types/startGraphQL';
+export default function (options: StartGraphQLOptions): Promise<void>;

package/dist/startGraphiQL.d.ts

@@ -0,0 +1,3 @@
+import { StartGraphQLOptions } from './types/startGraphQL';
+import { ApolloServerOptions } from '@apollo/server';
+export default function (apolloOptions: ApolloServerOptions<any>, options: StartGraphQLOptions): void;

package/dist/startWebsocket.d.ts

@@ -0,0 +1,11 @@
+import { StartGraphQLOptions } from './types/startGraphQL';
+import { ApolloServerOptions } from '@apollo/server';
+export default function (apolloOptions: ApolloServerOptions<any>, options: StartGraphQLOptions, 
+/**
+ * For testing purposes
+ */
+wsServer?: any): {
+    serverWillStart(): Promise<{
+        drainServer(): Promise<void>;
+    }>;
+}[];

package/dist/subscription/getChannelName.d.ts

@@ -0,0 +1 @@
+export default function (name: string, params: any): string;

package/dist/subscription/index.d.ts

@@ -0,0 +1,3 @@
+import { CreateOrionSubscriptionFunction } from '../types/subscription';
+declare const createSubscription: CreateOrionSubscriptionFunction;
+export default createSubscription;

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+import './subscription';
+export * from './startGraphQL';
+export * from './subscription';

package/dist/types/startGraphQL.d.ts

@@ -0,0 +1,51 @@
+import { GlobalResolversMap, ModelResolversMap } from '@orion-js/models';
+import { express } from '@orion-js/http';
+import { OrionSubscriptionsMap } from './subscription';
+import { PubSubEngine } from 'graphql-subscriptions';
+import { ApolloServerOptions } from '@apollo/server';
+export type ExecuteGraphQLCache = (req: express.Request, res: express.Response, viewer: object, executeQuery: () => Promise<string>) => Promise<string>;
+export interface ModelsResolversMap {
+    [key: string]: ModelResolversMap;
+}
+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;
+    /**
+     * Path to the graphql endpoint. Default to /graphql
+     */
+    path?: string;
+    /**
+     * Body parser options for the graphql endpoint.
+     */
+    bodyParserOptions?: {
+        limit?: number | string | undefined;
+    };
+}
+export {};

package/dist/types/subscription.d.ts

@@ -0,0 +1,23 @@
+import { ResolverOptions } from '@orion-js/resolvers';
+import { InferSchemaType, SchemaFieldType } from '@orion-js/schema';
+export declare class OrionSubscription<TParamsSchema extends SchemaFieldType = SchemaFieldType, TReturnsSchema extends SchemaFieldType = SchemaFieldType> {
+    name: string;
+    params: TParamsSchema;
+    subscribe: (callParams: InferSchemaType<TParamsSchema>, viewer: InferSchemaType<TReturnsSchema>) => {};
+    returns: TReturnsSchema;
+    publish: (params: InferSchemaType<TParamsSchema>, data: InferSchemaType<TReturnsSchema>) => Promise<void>;
+}
+export type CreateOrionSubscriptionFunction = <TParamsSchema extends SchemaFieldType = SchemaFieldType, TReturnsSchema extends SchemaFieldType = SchemaFieldType, TViewer = any>(options: OrionSubscriptionOptions<TParamsSchema, TReturnsSchema, TViewer>) => OrionSubscription<TParamsSchema, TReturnsSchema>;
+export interface OrionSubscriptionsMap {
+    [key: string]: OrionSubscription;
+}
+export type OrionSubscriptionOptions<TParamsSchema extends SchemaFieldType = SchemaFieldType, TReturnsSchema extends SchemaFieldType = SchemaFieldType, TViewer = any> = Omit<ResolverOptions<TParamsSchema, TReturnsSchema, TViewer>, 'resolve'> & {
+    /**
+     * This function is used to check if the user can subscribe to the subscription.
+     * If not provided, the subscription will be public.
+     * @param params - The parameters of the subscription.
+     * @param viewer - The viewer of the subscription.
+     * @returns true if the user can subscribe to the subscription, false otherwise.
+     */
+    canSubscribe?: (params: InferSchemaType<TParamsSchema>, viewer: TViewer) => Promise<boolean>;
+};

package/dist/websockerViewer.d.ts

@@ -0,0 +1,2 @@
+export declare const getWebsockerViewer: (connectionParams: any) => Promise<any>;
+export declare const setGetWebsockerViewer: (getViewerFunc: (connectionParams: any) => any) => void;

package/package.json

@@ -1,27 +1,20 @@
 {
   "name": "@orion-js/graphql",
-  "version": "4.3.1",
+  "version": "4.4.0",
   "main": "./dist/index.cjs",
   "author": "nicolaslopezj",
   "license": "MIT",
-  "scripts": {
-    "test": "bun test",
-    "prepare": "bun run build",
-    "clean": "rm -rf ./dist",
-    "build": "tsup",
-    "dev": "tsup --watch"
-  },
   "dependencies": {
     "@apollo/server": "^4.3.0",
     "@graphql-tools/schema": "^9.0.12",
-    "@orion-js/env": "4.3.0",
-    "@orion-js/helpers": "4.3.0",
-    "@orion-js/http": "4.3.1",
-    "@orion-js/models": "4.3.0",
-    "@orion-js/resolvers": "4.3.0",
-    "@orion-js/schema": "4.3.0",
-    "@orion-js/services": "4.3.0",
-    "@orion-js/typed-model": "4.3.0",
+    "@orion-js/env": "4.4.0",
+    "@orion-js/helpers": "4.4.0",
+    "@orion-js/http": "4.4.0",
+    "@orion-js/models": "4.4.0",
+    "@orion-js/resolvers": "4.4.0",
+    "@orion-js/schema": "4.4.0",
+    "@orion-js/services": "4.4.0",
+    "@orion-js/typed-model": "4.4.0",
     "graphql-scalars": "^1.24.1",
     "graphql-subscriptions": "2.0.0",
     "graphql-tag": "^2.12.6",
@@ -38,10 +31,10 @@
     "supertest": "^6.3.3",
     "superwstest": "^2.0.3",
     "tsup": "^8.0.1",
-    "typescript": "^5.4.5"
+    "typescript": "^7.0.2"
   },
   "peerDependencies": {
-    "@orion-js/logger": "4.3.0",
+    "@orion-js/logger": "4.4.0",
     "graphql": "*"
   },
   "publishConfig": {
@@ -58,5 +51,11 @@
   },
   "files": [
     "dist"
-  ]
-}
+  ],
+  "scripts": {
+    "test": "bun test",
+    "clean": "rm -rf ./dist",
+    "build": "tsup && bun run ../../scripts/emit-declarations.ts",
+    "dev": "tsup --watch"
+  }
+}

package/dist/index.d.cts

@@ -1,172 +0,0 @@
-import * as _orion_js_resolvers from '@orion-js/resolvers';
-import { ResolverOptions, GlobalResolverOptions, GlobalResolver, ModelResolver as ModelResolver$1, ResolverMiddleware } from '@orion-js/resolvers';
-export { createResolver } from '@orion-js/resolvers';
-import * as _orion_js_schema from '@orion-js/schema';
-import { SchemaFieldType, InferSchemaType, Schema, SchemaWithMetadata, SchemaNode, SchemaInAnyOrionForm } from '@orion-js/schema';
-import { ModelResolversMap, GlobalResolversMap } from '@orion-js/models';
-import { express } from '@orion-js/http';
-import { PubSubEngine } from 'graphql-subscriptions';
-import { ApolloServerOptions } from '@apollo/server';
-import * as graphql from 'graphql';
-export { graphql as GraphQL };
-
-declare class OrionSubscription<TParamsSchema extends SchemaFieldType = SchemaFieldType, TReturnsSchema extends SchemaFieldType = SchemaFieldType> {
-    name: string;
-    params: TParamsSchema;
-    subscribe: (callParams: InferSchemaType<TParamsSchema>, viewer: InferSchemaType<TReturnsSchema>) => {};
-    returns: TReturnsSchema;
-    publish: (params: InferSchemaType<TParamsSchema>, data: InferSchemaType<TReturnsSchema>) => Promise<void>;
-}
-type CreateOrionSubscriptionFunction = <TParamsSchema extends SchemaFieldType = SchemaFieldType, TReturnsSchema extends SchemaFieldType = SchemaFieldType, TViewer = any>(options: OrionSubscriptionOptions<TParamsSchema, TReturnsSchema, TViewer>) => OrionSubscription<TParamsSchema, TReturnsSchema>;
-interface OrionSubscriptionsMap {
-    [key: string]: OrionSubscription;
-}
-type OrionSubscriptionOptions<TParamsSchema extends SchemaFieldType = SchemaFieldType, TReturnsSchema extends SchemaFieldType = SchemaFieldType, TViewer = any> = Omit<ResolverOptions<TParamsSchema, TReturnsSchema, TViewer>, 'resolve'> & {
-    /**
-     * This function is used to check if the user can subscribe to the subscription.
-     * If not provided, the subscription will be public.
-     * @param params - The parameters of the subscription.
-     * @param viewer - The viewer of the subscription.
-     * @returns true if the user can subscribe to the subscription, false otherwise.
-     */
-    canSubscribe?: (params: InferSchemaType<TParamsSchema>, viewer: TViewer) => Promise<boolean>;
-};
-
-type ExecuteGraphQLCache = (req: express.Request, res: express.Response, viewer: object, executeQuery: () => Promise<string>) => Promise<string>;
-interface ModelsResolversMap {
-    [key: string]: ModelResolversMap;
-}
-type SchemaOmits = 'schema' | 'schemaHash' | 'context' | 'useGraphiql';
-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;
-    /**
-     * Path to the graphql endpoint. Default to /graphql
-     */
-    path?: string;
-    /**
-     * Body parser options for the graphql endpoint.
-     */
-    bodyParserOptions?: {
-        limit?: number | string | undefined;
-    };
-}
-
-declare const createSubscription$1: CreateOrionSubscriptionFunction;
-
-declare function export_default$1(options: StartGraphQLOptions): Promise<void>;
-
-declare function export_default(apolloOptions: ApolloServerOptions<any>, options: StartGraphQLOptions): void;
-
-declare const _default$1: {
-    params: _orion_js_resolvers.GlobalResolver<{
-        name: {
-            type: "ID";
-        };
-        mutation: {
-            type: BooleanConstructor;
-        };
-    }, {
-        name: {
-            type: "string";
-        };
-        params: {
-            type: "blackbox";
-        };
-        result: {
-            type: "string";
-        };
-        basicResultQuery: {
-            type: "string";
-        };
-    }, any, any>;
-};
-
-declare const _default: {
-    name: {
-        type: "string";
-    };
-    params: {
-        type: "blackbox";
-    };
-    result: {
-        type: "string";
-    };
-    basicResultQuery: {
-        type: "string";
-    };
-};
-
-declare function serializeSchema(params: Schema): Promise<SchemaWithMetadata>;
-
-declare function getBasicQuery(field: SchemaNode): Promise<string>;
-
-declare const createQuery: <TParams extends SchemaFieldType = any, TReturns extends SchemaFieldType = any, TViewer = any, TInfo = any>(options: GlobalResolverOptions<TParams, TReturns, TViewer, TInfo>) => GlobalResolver<TParams, TReturns, TViewer, TInfo>;
-declare const createMutation: <TParams extends SchemaFieldType = any, TReturns extends SchemaFieldType = any, TViewer = any, TInfo = any>(options: Omit<GlobalResolverOptions<TParams, TReturns, TViewer, TInfo>, "mutation">) => GlobalResolver<TParams, TReturns, TViewer, TInfo>;
-declare const internalResolversMetadata: WeakMap<any, Record<string, any>>;
-declare function Resolvers(): (target: any, context: ClassDecoratorContext<any>) => void;
-declare function Query(): (method: any, context: ClassFieldDecoratorContext | ClassMethodDecoratorContext) => any;
-declare function Query(options?: Omit<ResolverOptions<any>, 'resolve' | 'mutation'>): (method: any, context: ClassMethodDecoratorContext) => any;
-declare function Mutation(): (method: any, context: ClassFieldDecoratorContext | ClassMethodDecoratorContext) => any;
-declare function Mutation(options?: Omit<ResolverOptions<any>, 'resolve' | 'mutation'>): (method: any, context: ClassMethodDecoratorContext) => any;
-declare function registerPendingResolver(propertyKey: string, setup: (instance: any) => any): void;
-declare function getServiceResolvers(target: any): {
-    [key: string]: GlobalResolver<any, any, any, any>;
-};
-
-declare const createModelResolver: <TItem = any, TParams extends _orion_js_schema.SchemaFieldType = any, TReturns extends _orion_js_schema.SchemaFieldType = any, TViewer = any, TInfo = any>(options: _orion_js_resolvers.ModelResolverOptions<TItem, TParams, TReturns, TViewer, TInfo>) => ModelResolver$1<TItem, TParams, TReturns, TViewer, TInfo>;
-interface ModelResolversOptions {
-    modelName?: string;
-}
-declare function ModelResolvers(typedSchema: any, options?: ModelResolversOptions): (target: any, context: ClassDecoratorContext<any>) => void;
-declare function ModelResolver(): (method: any, context: ClassFieldDecoratorContext | ClassMethodDecoratorContext) => any;
-declare function ModelResolver(options?: Omit<ResolverOptions<any>, 'resolve' | 'middlewares'>): (method: any, context: ClassMethodDecoratorContext) => any;
-declare function getServiceModelResolvers(target: any): {
-    [key: string]: {
-        [key: string]: ModelResolver$1;
-    };
-};
-
-declare function Subscriptions(): (target: any, context: ClassDecoratorContext<any>) => void;
-declare function Subscription(): (method: any, context: ClassFieldDecoratorContext) => any;
-declare function getServiceSubscriptions(target: any): {
-    [key: string]: OrionSubscription;
-};
-
-declare function getTargetMetadata(target: any, propertyKey: string, metadataKey: string): any;
-declare function UseMiddleware<TMiddleware extends ResolverMiddleware, This>(params: TMiddleware): (method: any, context: ClassMethodDecoratorContext<This, typeof method>) => any;
-declare function ResolverParams<TParams extends SchemaInAnyOrionForm, This>(params: TParams): (method: any, context: ClassMethodDecoratorContext<This, typeof method>) => any;
-declare function ResolverReturns<This>(returns: any): (method: any, context: ClassMethodDecoratorContext<This, typeof method>) => any;
-
-declare const getWebsockerViewer: (connectionParams: any) => Promise<any>;
-declare const setGetWebsockerViewer: (getViewerFunc: (connectionParams: any) => any) => void;
-
-declare const createSubscription: CreateOrionSubscriptionFunction;
-
-export { type CreateOrionSubscriptionFunction, type ExecuteGraphQLCache, ModelResolver, ModelResolvers, type ModelResolversOptions, type ModelsResolversMap, Mutation, OrionSubscription, type OrionSubscriptionOptions, type OrionSubscriptionsMap, Query, ResolverParams, _default as ResolverParamsInfo, ResolverReturns, Resolvers, type StartGraphQLOptions, Subscription, Subscriptions, UseMiddleware, createModelResolver, createMutation, createQuery, createSubscription, getBasicQuery as getBasicResultQuery, getServiceModelResolvers, getServiceResolvers, getServiceSubscriptions, getTargetMetadata, getWebsockerViewer, internalResolversMetadata, registerPendingResolver, _default$1 as resolversSchemas, serializeSchema, setGetWebsockerViewer, export_default$1 as startGraphQL, export_default as startGraphiQL, createSubscription$1 as subscription };