adds check for language

Q42 · Jul 12, 2024 · b9220f4 · b9220f4
1 parent 0135586
commit b9220f4
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 28 deletions.
diff --git a/src/client.ts b/src/client.ts
@@ -1,7 +1,7 @@
 import { SanityClient } from 'sanity';
 
 import { getAllPageMetadata } from './helpers/page-tree';
-import { getRawPageMetadataQuery } from './queries';
+import { getAllRawPageMetadataQuery } from './queries';
 import { PageMetadata, PageTreeConfig } from './types';
 
 export type { PageMetadata } from './types';
@@ -25,7 +25,7 @@ class PageTreeClient {
   }
 
   public async getAllPageMetadata(): Promise<PageMetadata[]> {
-    const rawPageMetadata = await this.client.fetch(getRawPageMetadataQuery(this.config));
+    const rawPageMetadata = await this.client.fetch(getAllRawPageMetadataQuery(this.config));
     return getAllPageMetadata(this.config, rawPageMetadata);
   }
 }
diff --git a/src/hooks/usePageTree.ts b/src/hooks/usePageTree.ts
@@ -2,11 +2,11 @@ import { useMemo } from 'react';
 import { useListeningQuery } from 'sanity-plugin-utils';
 
 import { mapRawPageMetadatasToPageTree } from '../helpers/page-tree';
-import { getRawPageMetadataQuery } from '../queries';
+import { getAllRawPageMetadataQuery } from '../queries';
 import { PageTreeConfig, RawPageMetadata } from '../types';
 
 export const usePageTree = (config: PageTreeConfig) => {
-  const { data, loading } = useListeningQuery<RawPageMetadata[]>(getRawPageMetadataQuery(config), {
+  const { data, loading } = useListeningQuery<RawPageMetadata[]>(getAllRawPageMetadataQuery(config), {
     options: { apiVersion: config.apiVersion },
   });
 

diff --git a/src/hooks/usePageTreeItem.ts b/src/hooks/usePageTreeItem.ts
@@ -3,11 +3,11 @@ import { useMemo } from 'react';
 import { useListeningQuery } from 'sanity-plugin-utils';
 
 import { getAllPageMetadata } from '../helpers/page-tree';
-import { getRawPageMetadataQuery } from '../queries';
+import { getAllRawPageMetadataQuery } from '../queries';
 import { PageTreeConfig, RawPageMetadata } from '../types';
 
 export const usePageTreeItem = (documentId: string, config: PageTreeConfig, perspective?: ClientPerspective) => {
-  const { data, loading } = useListeningQuery<RawPageMetadata[]>(getRawPageMetadataQuery(config), {
+  const { data, loading } = useListeningQuery<RawPageMetadata[]>(getAllRawPageMetadataQuery(config), {
     options: { apiVersion: config.apiVersion, perspective },
   });
 

diff --git a/src/next.ts b/src/next.ts
@@ -1,7 +1,7 @@
 import { FilteredResponseQueryOptions, SanityClient } from 'next-sanity';
 
 import { getAllPageMetadata } from './helpers/page-tree';
-import { getRawPageMetadataQuery } from './queries';
+import { getAllRawPageMetadataQuery } from './queries';
 import { PageMetadata, PageTreeConfig } from './types';
 
 export type { PageMetadata } from './types';
@@ -29,7 +29,7 @@ class NextPageTreeClient {
 
   public async getAllPageMetadata(): Promise<PageMetadata[]> {
     const rawPageMetadata = await this.client.fetch(
-      getRawPageMetadataQuery(this.config),
+      getAllRawPageMetadataQuery(this.config),
       undefined,
       this.defaultSanityFetchOptions ?? {},
     );

diff --git a/src/queries/index.ts b/src/queries/index.ts
@@ -1,18 +1,23 @@
 import { getLanguageFieldName } from '../helpers/config';
 import { PageTreeConfig } from '../types';
 
-export const getRawPageMetadataQuery = (config: PageTreeConfig) => `*[_type in [${Object.values(config.pageSchemaTypes)
+export const getAllRawPageMetadataQuery = (config: PageTreeConfig) => `*[_type in [${Object.values(
+  config.pageSchemaTypes,
+)
   .map(key => `"${key}"`)
   .join(', ')}]]{
+    ${rawPageMetadataFragment(config)}
+  }`;
+
+export const getRawPageMetadataQuery = (documentId: string, config: PageTreeConfig) => `*[_id == "${documentId}"]{
+  ${rawPageMetadataFragment(config)}
+}`;
+
+export const rawPageMetadataFragment = (config: PageTreeConfig) => `
     _id,
     _type,
     _updatedAt,
     parent,
     slug,
     title,
-    ${getLanguageFieldName(config) ?? ''}
-  }`;
-
-export const getDocumentTypeQuery = (documentId: string) => `*[_id == "${documentId}"]{
-  _type
-}`;
+    ${getLanguageFieldName(config) ?? ''}`;
diff --git a/src/types.ts b/src/types.ts
@@ -60,6 +60,8 @@ export type PageTreeConfig = {
     supportedLanguages: string[];
     /* Optional field name of the language field, defaults to "language" */
     languageFieldName?: string;
+    /* Adds validation check to ensure that the language of the document matches the language of the parent document. Default: false */
+    documentLanguageShouldMatchParent?: boolean;
   };
 };
 

diff --git a/src/validators/parent-validator.ts b/src/validators/parent-validator.ts
@@ -1,20 +1,17 @@
 import { Reference, ValidationContext } from 'sanity';
 
-import { getDocumentTypeQuery } from '../queries';
+import { getLanguageFieldName } from '../helpers/config';
+import { getRawPageMetadataQuery } from '../queries';
 import { PageTreeConfig, RawPageMetadata, SanityRef } from '../types';
 
 /**
  * Validates that the slug is unique within the parent page and therefore that entire the path is unique.
  */
 export const allowedParentValidator =
   (config: PageTreeConfig, ownType: string) =>
-  async (selectedParent: Reference | undefined, context: ValidationContext) => {
+  async (selectedParentRef: Reference | undefined, context: ValidationContext) => {
     const allowedParents = config.allowedParents?.[ownType];
 
-    if (allowedParents === undefined) {
-      return true;
-    }
-
     const parentRef = context.document?.parent as SanityRef | undefined;
     if (!parentRef) {
       return true;
@@ -27,15 +24,24 @@ export const allowedParentValidator =
     }
 
     const client = context.getClient({ apiVersion: config.apiVersion });
-    const selectedParentType = (await client.fetch<Pick<RawPageMetadata, '_type'>[]>(getDocumentTypeQuery(parentId)))[0]
-      ?._type;
+    const selectedParent = (await client.fetch<RawPageMetadata[]>(getRawPageMetadataQuery(parentId, config)))?.[0];
 
-    if (!selectedParentType) {
+    if (!selectedParent._type) {
       return 'Unable to check the type of the selected parent.';
     }
 
-    if (!allowedParents.includes(selectedParentType)) {
-      return `The parent of type "${selectedParentType}" is not allowed for this type of document.`;
+    if (allowedParents && !allowedParents.includes(selectedParent._type)) {
+      return `The parent of type "${selectedParent._type}" is not allowed for this type of document.`;
+    }
+
+    if (config.documentInternationalization?.documentLanguageShouldMatchParent) {
+      const languageFieldName = getLanguageFieldName(config);
+      const language = context.document?.[languageFieldName];
+      const parentLanguage = selectedParent?.[languageFieldName];
+
+      if (language !== parentLanguage) {
+        return 'The language of the parent must match the language of the document.';
+      }
     }
 
     return true;

diff --git a/src/validators/slug-validator.ts b/src/validators/slug-validator.ts
@@ -1,7 +1,7 @@
 import { SlugValue, ValidationContext } from 'sanity';
 
 import { DRAFTS_PREFIX } from '../helpers/page-tree';
-import { getRawPageMetadataQuery } from '../queries';
+import { getAllRawPageMetadataQuery } from '../queries';
 import { PageTreeConfig, RawPageMetadata, SanityRef } from '../types';
 import { getSanityDocumentId } from '../utils/sanity';
 
@@ -17,7 +17,7 @@ export const slugValidator =
       return true;
     }
 
-    const allPages = await client.fetch<RawPageMetadata[]>(getRawPageMetadataQuery(config));
+    const allPages = await client.fetch<RawPageMetadata[]>(getAllRawPageMetadataQuery(config));
     const siblingPages = allPages.filter(page => page.parent?._ref === parentRef._ref);
 
     const siblingPagesWithSameSlug = siblingPages