feat(graphql): add publicationState filter support (#23)

* feat(slugController): add publicationState as a query parameter (#23)

* feat(graphql): add publicationState as an arg to graphql type (#24)

* chore(README): update readme (#25)

* feat(graphql): refactor publicationState query

* chore(README): update readme to include previewState example for GraphQL

* feat(graphql): update server/utils/isValidFindSlugParams.js

Co-authored-by: daedalus <[email protected]>

* chore(readme): update readme with suggested changes

Co-authored-by: daedalus <[email protected]>

* feat(graphql): apply suggestions from code review in types

Co-authored-by: daedalus <[email protected]>

* feat(graphql): include lodash check based on requested changes

* fix(graphql): contentType not defined in lodash check

Co-authored-by: Dominik Dewitz <[email protected]>
Co-authored-by: daedalus <[email protected]>

Author: 3 people

README.md

@@ -82,7 +82,7 @@ Any time the respective content types have an entity created or updated the slug
 
 ### Find One by Slug
 
-Hitting the `/api/slugify/slugs/:modelName/:slug` endpoint for any configured content types will return the entity type that matches the slug in the url.
+Hitting the `/api/slugify/slugs/:modelName/:slug` endpoint for any configured content types will return the entity type that matches the slug in the url. Additionally the endpoint accepts any of the parameters that can be added to the routes built into Strapi.
 
 **IMPORTANT** The modelName is case sensitive and must match exactly with the name defined in the configuration.
 
@@ -120,6 +120,25 @@ await fetch(`${API_URL}/api/slugify/slugs/article/lorem-ipsum-dolor`);
 }
 ```
 
+Additionally  if `draftAndPublish` is enabled for the content-type a `publicationState` arg can be passed to the GraphQL query that accepts either `preview` or `live` as input.
+
+**IMPORTANT** Please beware that the request for an entry in `preview` will return both draft entries & published entries as per Strapi default.
+
+```graphql
+{
+  findSlug(modelName:"article",slug:"lorem-ipsum-dolor",publicationState:"preview"){
+    ... on ArticleEntityResponse{
+      data{
+        id
+        attributes{
+          title
+        }
+      }
+    }
+  }
+}
+```
+
 ### Example Response
 
 If an article with the slug of `lorem-ipsum-dolor` exists the response will look the same as a single entity response

server/graphql/types.js

@@ -47,16 +47,18 @@ const getCustomTypes = (strapi, nexus) => {
 					args: {
 						modelName: nexus.stringArg('The model name of the content type'),
 						slug: nexus.stringArg('The slug to query for'),
+						publicationState: nexus.stringArg('The publication state of the entry')
 					},
 					resolve: async (_parent, args, ctx) => {
 						const { models } = getPluginService(strapi, 'settingsService').get();
-						const { modelName, slug } = args;
+						const { modelName, slug, publicationState } = args;
 						const { auth } = ctx.state;
 
 						isValidFindSlugParams({
 							modelName,
 							slug,
 							models,
+							publicationState
 						});
 
 						const { uid, field, contentType } = models[modelName];
@@ -70,10 +72,10 @@ const getCustomTypes = (strapi, nexus) => {
 							},
 						};
 
-						// only return published entries
+						// only return published entries by default if content type has draftAndPublish enabled
 						if (_.get(contentType, ['options', 'draftAndPublish'], false)) {
-							query.publicationState = 'live';
-						}
+							query.publicationState = publicationState || 'live';
+						} 
 
 						const data = await getPluginService(strapi, 'slugService').findOne(uid, query);
 						const sanitizedEntity = await sanitizeOutput(data, contentType, auth);

server/utils/isValidFindSlugParams.js

@@ -1,11 +1,13 @@
 const { ValidationError } = require('@strapi/utils/lib/errors');
+const _ = require('lodash');
 
 const isValidFindSlugParams = (params) => {
 	if (!params) {
 		throw new ValidationError('A model and slug must be provided.');
 	}
 
-	const { modelName, slug, models } = params;
+	const { modelName, slug, models, publicationState } = params;
+	const model = models[modelName];
 
 	if (!modelName) {
 		throw new ValidationError('A model name path variable is required.');
@@ -15,7 +17,9 @@ const isValidFindSlugParams = (params) => {
 		throw new ValidationError('A slug path variable is required.');
 	}
 
-	const model = models[modelName];
+	if (_.get(model, ['contentType', 'options', 'draftAndPublish'], false) && publicationState) {
+		throw new ValidationError('Filtering by publication state is only supported for content types that have Draft and Publish enabled.')
+	}
 
 	// ensure valid model is passed
 	if (!model) {