feat: related field status query param (#600)

* feat: related field status query param

* chore: fix tests

Author: mateusz-kleszcz

README.md

@@ -363,8 +363,13 @@ Plugin supports both **REST API** and **GraphQL API** exposed by Strapi.
   > `https://localhost:1337/api/navigation/render/njx99iv4p4txuqp307ye8625?menu=true`
 
 - `path` - String value for querying navigation items by its path:
+
   > `https://localhost:1337/api/navigation/render/njx99iv4p4txuqp307ye8625?path=/home/about-us`
 
+- `status` - Enum value representing the status of the related entity that should be returned. Can be set to `draft` or `published`. The default value is `published`:
+
+  > `https://localhost:1337/api/navigation/render/njx99iv4p4txuqp307ye8625?status=draft`
+
 ### REST API
 
 `GET <host>/api/navigation/?locale=<locale>&orderBy=<orderBy>&orderDirection=<orderDirection>`

server/src/controllers/client.ts

@@ -43,6 +43,7 @@ export default function clientController(context: { strapi: Core.Strapi }) {
         path: rootPath,
         locale,
         populate,
+        status = 'published',
       } = renderQuerySchema.parse(query);
       const idOrSlug = z.string().parse(params.idOrSlug);
 
@@ -63,14 +64,15 @@ export default function clientController(context: { strapi: Core.Strapi }) {
                   : populate
           )
         ),
+        status
       });
     },
 
     async renderChild(ctx: KoaContext) {
       const { params, query = {} } = ctx;
-      const { type, menu: menuOnly, locale } = renderChildQueryParams.parse(query);
+      const { type, menu: menuOnly, locale, status = 'published' } = renderChildQueryParams.parse(query);
 
-      const idOrSlug = z.string().parse(params.documentId);
+      const idOrSlug = z.string().parse(params.idOrSlug);
       const childUIKey = z.string().parse(params.childUIKey);
 
       return await this.getService().renderChildren({
@@ -79,6 +81,7 @@ export default function clientController(context: { strapi: Core.Strapi }) {
         type,
         menuOnly: menuOnly === 'true',
         locale,
+        status
       });
     },
   };

server/src/controllers/validators.ts

@@ -12,6 +12,8 @@ export const readAllQuerySchema = z.object({
 
 export const renderTypeSchema = z.enum(['FLAT', 'TREE', 'RFR']);
 
+export const statusSchema = z.enum(['draft', 'published']);
+
 export const populateSchema = z.union([z.boolean(), z.string(), z.string().array(), z.undefined()]);
 
 export const renderQuerySchema = z.object({
@@ -20,12 +22,14 @@ export const renderQuerySchema = z.object({
   path: z.string().optional(),
   locale: z.string().optional(),
   populate: populateSchema.optional(),
+  status: statusSchema.optional(),
 });
 
 export const renderChildQueryParams = z.object({
   type: renderTypeSchema.optional(),
   menu: booleanStringSchema.optional(),
   locale: z.string().optional(),
+  status: statusSchema.optional(),
 });
 
 export const fillFromOtherLocaleParams = z.object({

server/src/services/client/client.ts

@@ -239,6 +239,7 @@ const clientService = (context: { strapi: Core.Strapi }) => ({
     rootPath,
     type = 'FLAT',
     wrapRelated,
+    status = 'published',
   }: RenderTypeInput) {
     const adminService = getPluginService(context, 'admin');
     const commonService = getPluginService(context, 'common');
@@ -288,6 +289,7 @@ const clientService = (context: { strapi: Core.Strapi }) => ({
         master: navigation,
         navigationItems,
         populate,
+        status,
       });
 
       const { contentTypes, contentTypesNameFields, additionalFields } = await adminService.config({
@@ -471,6 +473,7 @@ const clientService = (context: { strapi: Core.Strapi }) => ({
     menuOnly,
     type = 'FLAT',
     wrapRelated,
+    status,
   }: RenderChildrenInput) {
     const criteria = { $or: [{ documentId: idOrSlug }, { slug: idOrSlug }] };
     const filter = type === 'FLAT' ? undefined : childUIKey;
@@ -486,6 +489,7 @@ const clientService = (context: { strapi: Core.Strapi }) => ({
       filter,
       wrapRelated,
       locale,
+      status,
     });
   },
 
@@ -497,6 +501,7 @@ const clientService = (context: { strapi: Core.Strapi }) => ({
     rootPath,
     type = 'FLAT',
     wrapRelated,
+    status,
   }: RenderInput) {
     const criteria = { $or: [{ documentId: idOrSlug }, { slug: idOrSlug }] };
     const itemCriteria = menuOnly ? { menuAttached: true } : {};
@@ -509,6 +514,7 @@ const clientService = (context: { strapi: Core.Strapi }) => ({
       wrapRelated,
       locale,
       populate,
+      status,
     });
   },
 });

server/src/services/client/types.ts

@@ -58,6 +58,7 @@ export interface RenderTypeInput {
   wrapRelated?: boolean;
   populate?: PopulateQueryParam;
   locale?: string;
+  status?: 'draft' | 'published';
 }
 
 export interface RenderChildrenInput {
@@ -67,6 +68,7 @@ export interface RenderChildrenInput {
   menuOnly?: boolean;
   wrapRelated?: boolean;
   locale?: string;
+  status?: 'draft' | 'published';
 }
 
 export interface RenderInput {
@@ -77,4 +79,5 @@ export interface RenderInput {
   wrapRelated?: boolean;
   populate?: PopulateQueryParam;
   locale?: string;
+  status?: 'draft' | 'published';
 }

server/src/services/common/common.ts

@@ -61,6 +61,7 @@ const commonService = (context: { strapi: Core.Strapi }) => ({
     navigationItems,
     parent,
     populate,
+    status = 'published',
   }: MapToNavigationItemDTOInput): Promise<NavigationItemDTO[]> {
     const result: NavigationItemDTO[] = [];
 
@@ -79,15 +80,12 @@ const commonService = (context: { strapi: Core.Strapi }) => ({
 
         const fieldsToPopulate = config.contentTypesPopulate[item.related.__type];
 
-        if (!fieldsToPopulate?.length) {
-          return item;
-        }
-
         const repository = getGenericRepository({ strapi }, item.related.__type as UID.ContentType);
+
         const related = await repository.findById(
           item.related.documentId,
           fieldsToPopulate,
-          'published',
+          status,
           {
             locale,
           }
@@ -116,6 +114,7 @@ const commonService = (context: { strapi: Core.Strapi }) => ({
           master,
           parent: base as NavigationItemDTO,
           locale,
+          status,
         }),
       } as NavigationItemDTO);
     }

server/src/services/common/types.ts

@@ -29,6 +29,7 @@ export interface MapToNavigationItemDTOInput {
   master?: Omit<NavigationDTO, 'items'>;
   parent?: NavigationItemDTO;
   locale?: string;
+  status?: 'draft' | 'published';
 }
 
 export interface CreateBranchInput {

server/tests/controllers/client.test.ts

@@ -203,7 +203,7 @@ describe('Navigation', () => {
           const navigationItem = getMockNavigationItem();
           const renderChildren = jest.fn();
           const mockClientService = asProxy<ClientService>({ renderChildren });
-          const documentId = faker.string.uuid();
+          const idOrSlug = faker.string.uuid();
           const childUIKey = faker.string.sample(10);
           const type = faker.helpers.arrayElement(['FLAT', 'TREE', 'RFR']);
           const menu = faker.datatype.boolean().toString();
@@ -217,7 +217,7 @@ describe('Navigation', () => {
           // When
           const result = await clientController.renderChild(
             asProxy<KoaContext>({
-              params: { documentId, childUIKey },
+              params: { idOrSlug, childUIKey },
               query: {
                 type,
                 menu,