feat/promotions: API Changes

packages/api-plugin-promotions/src/queries/promotions.js

@@ -1,22 +1,19 @@
 /**
  * @summary return a possibly filtered list of promotions
  * @param {Object} context - The application context
- * @param {Object} input - The filters
+ * @param {String} shopId - The shopId to query for
+ * @param {Object} filter - optional filter parameters
  * @return {Promise<Promotions>} - A list of promotions
  */
-export default async function promotions(context, input) {
-  const { shopId, enabled, startDate, endDate } = input;
+export default async function promotions(context, shopId, filter) {
+  const { enabled } = filter;
   const { collections: { Promotions } } = context;
-  const filter = {
-    shopId
-  };
+
 
   // because enabled could be false we need to check for undefined
   if (typeof enabled !== "undefined") {
     filter.enabled = enabled;
   }
-
-  if (startDate) filter.startDate = startDate;
-  if (endDate) filter.endDate = endDate;
+  filter.shopId = shopId;
   return Promotions.find(filter);
 }

packages/api-plugin-promotions/src/resolvers/Query/promotions.js

@@ -2,7 +2,7 @@ import getPaginatedResponse from "@reactioncommerce/api-utils/graphql/getPaginat
 import wasFieldRequested from "@reactioncommerce/api-utils/graphql/wasFieldRequested.js";
 
 /**
- * @summary Query for a list of products
+ * @summary Query for a list of promotions
  * @param {Object} _ - unused
  * @param {Object} args - an object of all arguments that were sent by the client
  * @param {String} args.shopId - id of user to query
@@ -11,15 +11,9 @@ import wasFieldRequested from "@reactioncommerce/api-utils/graphql/wasFieldReque
  * @returns {Promise<Object>} Products
  */
 export default async function promotions(_, args, context, info) {
-  const { input } = args;
-  const { shopId, enabled, startDate, endDate, ...connectionArgs } = input;
+  const { shopId, filter, ...connectionArgs } = args;
   await context.validatePermissions("reaction:legacy:promotions", "read", { shopId });
-  const query = await context.queries.promotions(context, {
-    shopId,
-    enabled,
-    startDate,
-    endDate
-  });
+  const query = await context.queries.promotions(context, shopId, filter);
 
   return getPaginatedResponse(query, connectionArgs, {
     includeHasNextPage: wasFieldRequested("pageInfo.hasNextPage", info),

packages/api-plugin-promotions/src/schemas/schema.graphql

@@ -229,8 +229,33 @@ extend type Query {
   ): Promotion
 }
 
+
+
 extend type Query {
   promotions(
-    input: PromotionFilter
-  ): PromotionConnection
+    "Shop ID"
+    shopId: ID!
+
+    "Return only results that come after this cursor. Use this with `first` to specify the number of results to return."
+    after: ConnectionCursor,
+
+    "Return only results that come before this cursor. Use this with `last` to specify the number of results to return."
+    before: ConnectionCursor,
+
+    "Return at most this many results. This parameter may be used with either `after` or `offset` parameters."
+    first: ConnectionLimitInt,
+
+    "Return at most this many results. This parameter may be used with the `before` parameter."
+    last: ConnectionLimitInt,
+
+    "Return only results that come after the Nth result. This parameter may be used with the `first` parameter."
+    offset: Int,
+
+    filter: PromotionFilter
+
+    sortBy: String
+
+    sortOrder: String
+
+  ): PromotionConnection!
 }