@rxdi/graphql-pubsub 0.7.180 → 0.7.182

package/dist/decorators/subscribe/subscribe.d.ts

@@ -1,2 +1,50 @@
-import { ResolverFn, FilterFn } from 'graphql-subscriptions';
-export declare function Subscribe<T>(asyncIteratorFunction: ResolverFn | AsyncIterator<T>, filterFn?: FilterFn): Function;
+import { ResolverFn } from 'graphql-subscriptions';
+/**
+ * @Subscribe annotation
+ * @param asyncIteratorFunction accepts ResolverFn or AsyncIterator<T>
+ *
+ * Can be imported from "graphql-subscriptions" package as function "withFilter"
+ *
+ ```typescript
+
+import { PubSubService } from '@rxdi/graphql-pubsub';
+import { withFilter } from 'graphql-subscriptions'
+
+@Controller<GraphQLControllerOptions>()
+export class ChatController {
+  constructor(
+    private pubsub: PubSubService,
+  ) {}
+
+  @Subscribe(
+    withFilter(
+      (self: ChatController) => self.pubsub.asyncIterator('MySubscriptionChannel'),
+      async (
+        message: IChatMessage,
+        {id}: {id: string},
+        context: GraphqlContext,
+      ) => {
+        // If you want to notify subscribed clients return true
+        // usefull when you want to check if this user has rights to access this pubsub queue
+        // Check something with payload arguments provided as id
+        // This id can be defined in @Subscription({ id: { type:... }})
+        return true
+      }
+    )
+  )
+  @Subscription({
+    id: {
+      type: new GraphQLNonNull(GraphQLString)
+    }
+  })
+  async mySubscription(payload: any) {
+    return message;
+  }
+
+  publisher() {
+    this.pubsub.publish('MySubscriptionChannel', { id: 'my-id' });
+  }
+}
+```
+ */
+export declare function Subscribe<T>(asyncIteratorFunction: ResolverFn | AsyncIterator<T>): Function;

package/dist/decorators/subscribe/subscribe.js

@@ -1,7 +1,55 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Subscribe = void 0;
-function Subscribe(asyncIteratorFunction, filterFn) {
+/**
+ * @Subscribe annotation
+ * @param asyncIteratorFunction accepts ResolverFn or AsyncIterator<T>
+ *
+ * Can be imported from "graphql-subscriptions" package as function "withFilter"
+ *
+ ```typescript
+
+import { PubSubService } from '@rxdi/graphql-pubsub';
+import { withFilter } from 'graphql-subscriptions'
+
+@Controller<GraphQLControllerOptions>()
+export class ChatController {
+  constructor(
+    private pubsub: PubSubService,
+  ) {}
+
+  @Subscribe(
+    withFilter(
+      (self: ChatController) => self.pubsub.asyncIterator('MySubscriptionChannel'),
+      async (
+        message: IChatMessage,
+        {id}: {id: string},
+        context: GraphqlContext,
+      ) => {
+        // If you want to notify subscribed clients return true
+        // usefull when you want to check if this user has rights to access this pubsub queue
+        // Check something with payload arguments provided as id
+        // This id can be defined in @Subscription({ id: { type:... }})
+        return true
+      }
+    )
+  )
+  @Subscription({
+    id: {
+      type: new GraphQLNonNull(GraphQLString)
+    }
+  })
+  async mySubscription(payload: any) {
+    return message;
+  }
+
+  publisher() {
+    this.pubsub.publish('MySubscriptionChannel', { id: 'my-id' });
+  }
+}
+```
+ */
+function Subscribe(asyncIteratorFunction) {
     const subscribe = { subscribe: asyncIteratorFunction };
     return (t, propKey, desc) => {
         const descriptor = desc;

package/dist/decorators/subscription/subscription.d.ts

@@ -1 +1,19 @@
-export declare function Subscription(options?: any): (t: any, propKey: string, descriptor: TypedPropertyDescriptor<any>) => TypedPropertyDescriptor<any>;
+import { GraphQLInputFieldConfigMap } from 'graphql';
+/**
+ * @Subscription annotation is creating GraphQLInputObjectType dynamically
+ * @param fields parameter is type GraphQLInputFieldConfigMap
+ * @param meta parameter has "description" field which is then added to the new GraphQLInputObjectType
+ *
+ * "input" param is actually "fields" param inside the dynamically generated GraphQLInputObjectType
+ *
+ * ```typescript
+ *   new GraphQLInputObjectType({
+ *    name: 'Taken from the descriptor name automatically',
+ *    description: 'Taken from "meta.description" field'
+ *    fields: input,
+ *   })
+ * ```
+ */
+export declare function Subscription(fields?: GraphQLInputFieldConfigMap, meta?: {
+    description?: string;
+}): (t: any, propKey: string, descriptor: TypedPropertyDescriptor<any>) => TypedPropertyDescriptor<any>;

package/dist/decorators/subscription/subscription.js

@@ -1,7 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Subscription = void 0;
-function Subscription(options) {
+/**
+ * @Subscription annotation is creating GraphQLInputObjectType dynamically
+ * @param fields parameter is type GraphQLInputFieldConfigMap
+ * @param meta parameter has "description" field which is then added to the new GraphQLInputObjectType
+ *
+ * "input" param is actually "fields" param inside the dynamically generated GraphQLInputObjectType
+ *
+ * ```typescript
+ *   new GraphQLInputObjectType({
+ *    name: 'Taken from the descriptor name automatically',
+ *    description: 'Taken from "meta.description" field'
+ *    fields: input,
+ *   })
+ * ```
+ */
+function Subscription(fields, meta) {
     return (t, propKey, descriptor) => {
         const originalMethod = descriptor.value;
         const target = t;
@@ -9,9 +24,10 @@ function Subscription(options) {
         descriptor.value = function (...args) {
             const returnValue = Object.create({});
             returnValue.resolve = originalMethod;
-            returnValue.args = options ? options : null;
+            returnValue.args = fields ? fields : null;
             returnValue.method_type = 'subscription';
             returnValue.method_name = propertyKey;
+            returnValue.description = meta ? meta.description : null;
             returnValue.target = target;
             return returnValue;
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rxdi/graphql-pubsub",
-  "version": "0.7.180",
+  "version": "0.7.182",
   "repository": {
     "type": "git",
     "url": "https://github.com/rxdi/graphql-pubsub"
@@ -30,16 +30,16 @@
   },
   "homepage": "https://github.com/rxdi/graphql-pubsub#readme",
   "dependencies": {
-    "@rxdi/graphql-rabbitmq-subscriptions": "^0.7.179",
+    "@rxdi/graphql-rabbitmq-subscriptions": "^0.7.181",
     "@apollo/client": "^3.7.3",
     "graphql-request": "^1.8.2",
     "subscriptions-transport-ws": "^0.9.19",
     "ws": "6.2.1"
   },
   "devDependencies": {
-    "@rxdi/core": "^0.7.179",
-    "@rxdi/graphql": "^0.7.179",
-    "@rxdi/hapi": "^0.7.179",
+    "@rxdi/core": "^0.7.181",
+    "@rxdi/graphql": "^0.7.181",
+    "@rxdi/hapi": "^0.7.181",
     "@types/graphql": "^14.5.0",
     "@types/hapi": "^18.0.4",
     "@types/jest": "^24.0.22",