sanity-plugin-internationalized-array 1.5.0 → 1.6.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sanity-plugin-internationalized-array",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "description": "Store localized fields in an array to save on attributes",
   "keywords": [
     "sanity",
@@ -15,13 +15,13 @@
     "url": "git@github.com:SimeonGriggs/sanity-plugin-internationalized-array.git"
   },
   "license": "MIT",
-  "author": "Simeon Griggs <simeon@sanity.io>",
+  "author": "Sanity.io <hello@sanity.io>",
   "exports": {
     ".": {
-      "types": "./lib/src/index.d.ts",
+      "types": "./lib/index.d.ts",
       "source": "./src/index.ts",
-      "import": "./lib/index.esm.js",
       "require": "./lib/index.js",
+      "import": "./lib/index.esm.js",
       "default": "./lib/index.esm.js"
     },
     "./package.json": "./package.json"
@@ -29,60 +29,75 @@
   "main": "./lib/index.js",
   "module": "./lib/index.esm.js",
   "source": "./src/index.ts",
-  "types": "./lib/src/index.d.ts",
+  "types": "./lib/index.d.ts",
   "files": [
-    "src",
     "lib",
-    "v2-incompatible.js",
-    "sanity.json"
+    "sanity.json",
+    "src",
+    "v2-incompatible.js"
   ],
   "scripts": {
     "prebuild": "npm run clean && plugin-kit verify-package --silent && pkg-utils",
-    "build": "pkg-utils build",
+    "build": "run-s clean && plugin-kit verify-package --silent && pkg-utils build --strict && pkg-utils --strict",
     "clean": "rimraf lib",
+    "format": "prettier --write --cache --ignore-unknown .",
     "link-watch": "plugin-kit link-watch",
     "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
     "prepare": "husky install",
-    "prepublishOnly": "npm run build",
-    "watch": "pkg-utils watch"
+    "prepublishOnly": "run-s build",
+    "watch": "pkg-utils watch --strict"
   },
   "dependencies": {
-    "@sanity/icons": "^2.0.0",
+    "@sanity/icons": "^2.2.2",
     "@sanity/incompatible-plugin": "^1.0.4",
-    "@sanity/ui": "^1.0.0",
+    "@sanity/ui": "^1.2.2",
+    "fast-deep-equal": "^3.1.3",
+    "lodash.get": "^4.4.2",
     "suspend-react": "^0.0.8"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.3.0",
-    "@commitlint/config-conventional": "^17.3.0",
-    "@sanity/pkg-utils": "^1.18.0",
-    "@sanity/plugin-kit": "^2.1.17",
-    "@sanity/semantic-release-preset": "^2.0.2",
+    "@commitlint/cli": "^17.4.4",
+    "@commitlint/config-conventional": "^17.4.4",
+    "@sanity/pkg-utils": "^2.2.4",
+    "@sanity/plugin-kit": "^3.1.4",
+    "@sanity/semantic-release-preset": "^4.0.1",
+    "@types/react": "^18.0.27",
     "@types/styled-components": "^5.1.26",
-    "@typescript-eslint/eslint-plugin": "^5.44.0",
-    "@typescript-eslint/parser": "^5.44.0",
-    "eslint": "^8.28.0",
-    "eslint-config-prettier": "^8.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
+    "eslint": "^8.33.0",
+    "eslint-config-prettier": "^8.6.0",
     "eslint-config-sanity": "^6.0.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-react": "^7.31.11",
+    "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "husky": "^8.0.2",
-    "lint-staged": "^13.0.4",
-    "prettier": "^2.8.0",
-    "prettier-plugin-packagejson": "^2.3.0",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.2.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.8.4",
+    "prettier-plugin-packagejson": "^2.4.2",
     "react": "^18",
-    "rimraf": "^3.0.2",
-    "sanity": "3.0.0-rc.3",
-    "styled-components": "^5.3.6",
-    "typescript": "^4.9.3"
+    "react-dom": "^18",
+    "react-is": "^18",
+    "rimraf": "^4.1.2",
+    "sanity": "^3.3.1",
+    "semantic-release": "^20.1.0",
+    "typescript": "^4.9.5"
   },
   "peerDependencies": {
+    "@sanity/ui": "^1.2.2",
     "react": "^18",
-    "sanity": "dev-preview || 3.0.0-rc.3 || ^3.0.0",
-    "styled-components": "^5.2"
+    "sanity": "^3.0.0",
+    "styled-components": "^5.3.6"
   },
   "engines": {
     "node": ">=14"
+  },
+  "sanityPlugin": {
+    "verifyPackage": {
+      "eslintImports": false
+    }
   }
 }

package/src/cache.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
 
 import * as suspend from 'suspend-react'
+
 import type {Language} from './types'
 
 export const namespace = 'sanity-plugin-internationalized-array'
@@ -15,4 +16,5 @@ export const preload = (fn: () => Promise<Language[]>) =>
 export const clear = () => suspend.clear([version, namespace])
 
 // https://github.com/pmndrs/suspend-react#peeking-into-entries-outside-of-suspense
-export const peek = () => suspend.peek([version, namespace]) as Language[] | undefined
+export const peek = (selectedValue: Record<string, unknown>) =>
+  suspend.peek([version, namespace, selectedValue]) as Language[] | undefined

package/src/components/InternationalizedArray.tsx

@@ -1,45 +1,61 @@
-import React, {Fragment, useCallback, useEffect, useMemo} from 'react'
+import {AddIcon} from '@sanity/icons'
+import {Button, Grid, Stack, useToast} from '@sanity/ui'
+import equal from 'fast-deep-equal'
+import {useCallback, useDeferredValue, useEffect, useMemo} from 'react'
 import {
+  ArrayOfObjectsInputProps,
+  ArrayOfObjectsItem,
+  ArrayOfObjectsItemMember,
   insert,
   set,
   setIfMissing,
-  ArrayOfObjectsItemMember,
-  ArrayOfObjectsItem,
-  ArrayOfObjectsInputProps,
   useClient,
+  useFormBuilder,
 } from 'sanity'
-import {Button, Grid, Stack, useToast} from '@sanity/ui'
-import {AddIcon} from '@sanity/icons'
 import {suspend} from 'suspend-react'
 
-import type {Value, ArraySchemaWithLanguageOptions} from '../types'
+import {namespace, version} from '../cache'
+import type {ArraySchemaWithLanguageOptions, Value} from '../types'
 import Feedback from './Feedback'
+import {getSelectedValue} from './getSelectedValue'
 // TODO: Move this provider to the root component
 import {LanguageProvider} from './languageContext'
-import {namespace, version} from '../cache'
 
 export type InternationalizedArrayProps = ArrayOfObjectsInputProps<
   Value,
   ArraySchemaWithLanguageOptions
 >
 
-export default function InternationalizedArray(props: InternationalizedArrayProps) {
+export default function InternationalizedArray(
+  props: InternationalizedArrayProps
+) {
   const {members, value, schemaType, onChange} = props
-  const readOnly = typeof schemaType.readOnly === 'boolean' ? schemaType.readOnly : false
+  const readOnly =
+    typeof schemaType.readOnly === 'boolean' ? schemaType.readOnly : false
   const {options} = schemaType
   const toast = useToast()
+  const {value: document} = useFormBuilder()
+  const deferredDocument = useDeferredValue(document)
+  const selectedValue = useMemo(
+    () => getSelectedValue(options.select, deferredDocument),
+    [options.select, deferredDocument]
+  )
 
   const {apiVersion} = options
   const client = useClient({apiVersion})
   const languages = Array.isArray(options.languages)
     ? options.languages
-    : // eslint-disable-next-line require-await
-      suspend(async () => {
-        if (typeof options.languages === 'function') {
-          return options.languages(client)
-        }
-        return options.languages
-      }, [version, namespace])
+    : suspend(
+        // eslint-disable-next-line require-await
+        async () => {
+          if (typeof options.languages === 'function') {
+            return options.languages(client, selectedValue)
+          }
+          return options.languages
+        },
+        [version, namespace, selectedValue],
+        {equal}
+      )
 
   const handleAddLanguage = useCallback(
     (languageId?: string) => {
@@ -148,13 +164,16 @@ export default function InternationalizedArray(props: InternationalizedArrayProp
     }
 
     return value
-      .map((v, vIndex) => (vIndex === languagesInUse.findIndex((l) => l.id === v._key) ? null : v))
+      .map((v, vIndex) =>
+        vIndex === languagesInUse.findIndex((l) => l.id === v._key) ? null : v
+      )
       .filter(Boolean)
   }, [value, languagesInUse])
 
   const languagesAreValid = useMemo(
     () =>
-      !languages?.length || (languages?.length && languages.every((item) => item.id && item.title)),
+      !languages?.length ||
+      (languages?.length && languages.every((item) => item.id && item.title)),
     [languages]
   )
 
@@ -218,7 +237,10 @@ export default function InternationalizedArray(props: InternationalizedArrayProp
                     tone="primary"
                     mode="ghost"
                     fontSize={1}
-                    disabled={readOnly || Boolean(value?.find((item) => item._key === language.id))}
+                    disabled={
+                      readOnly ||
+                      Boolean(value?.find((item) => item._key === language.id))
+                    }
                     text={language.id.toUpperCase()}
                     icon={AddIcon}
                     onClick={() => handleAddLanguage(language.id)}
@@ -229,13 +251,17 @@ export default function InternationalizedArray(props: InternationalizedArrayProp
             <Button
               tone="primary"
               mode="ghost"
-              disabled={readOnly || (value && value?.length >= languages?.length)}
+              disabled={
+                readOnly || (value && value?.length >= languages?.length)
+              }
               icon={AddIcon}
               text={
                 // eslint-disable-next-line no-nested-ternary
                 value?.length
                   ? `Add missing ${
-                      languages.length - value.length === 1 ? `language` : `languages`
+                      languages.length - value.length === 1
+                        ? `language`
+                        : `languages`
                     }`
                   : languages.length === 1
                   ? `Add ${languages[0].title} Field`

package/src/components/Preload.tsx

@@ -7,10 +7,10 @@ export default memo(function Preload(
   props: Required<Pick<PluginConfig, 'apiVersion' | 'languages'>>
 ) {
   const client = useClient({apiVersion: props.apiVersion})
-  if (!Array.isArray(peek())) {
+  if (!Array.isArray(peek({}))) {
     // eslint-disable-next-line require-await
     preload(async () =>
-      Array.isArray(props.languages) ? props.languages : props.languages(client)
+      Array.isArray(props.languages) ? props.languages : props.languages(client, {})
     )
   }
 

package/src/components/Table.tsx

@@ -1,6 +1,6 @@
+import {Box, BoxProps, Card, CardProps} from '@sanity/ui'
 import React from 'react'
 import styled, {css} from 'styled-components'
-import {Box, BoxProps, Card, CardProps} from '@sanity/ui'
 
 // Wrappers required because of bug with passing down "as" prop
 // https://github.com/styled-components/styled-components/issues/2449

package/src/components/getSelectedValue.ts

@@ -0,0 +1,31 @@
+import {get} from 'lodash'
+
+export const getSelectedValue = (
+  select: Record<string, string> | undefined,
+  document:
+    | {
+        [x: string]: unknown
+      }
+    | undefined
+): Record<string, unknown> => {
+  if (!select || !document) {
+    return {}
+  }
+
+  const selection: Record<string, string> = select || {}
+  const selectedValue: Record<string, unknown> = {}
+  for (const [key, path] of Object.entries(selection)) {
+    let value = get(document, path)
+    if (Array.isArray(value)) {
+      // If there are references in the array, ensure they have `_ref` set, otherwise they are considered empty and can safely be ignored
+      value = value.filter((item) =>
+        typeof item === 'object'
+          ? item?._type === 'reference' && '_ref' in item
+          : true
+      )
+    }
+    selectedValue[key] = value
+  }
+
+  return selectedValue
+}

package/src/components/getToneFromValidation.ts

@@ -1,7 +1,9 @@
 import {CardTone} from '@sanity/ui'
 import {FormNodeValidation} from 'sanity'
 
-export function getToneFromValidation(validations: FormNodeValidation[]): CardTone | undefined {
+export function getToneFromValidation(
+  validations: FormNodeValidation[]
+): CardTone | undefined {
   if (!validations?.length) {
     return undefined
   }

package/src/plugin.tsx

@@ -11,7 +11,7 @@ const CONFIG_DEFAULT: PluginConfig = {
 }
 
 export const internationalizedArray = definePlugin<PluginConfig>((config = CONFIG_DEFAULT) => {
-  const {apiVersion = '2022-11-27', languages, fieldTypes} = {...CONFIG_DEFAULT, ...config}
+  const {apiVersion = '2022-11-27', select, languages, fieldTypes} = {...CONFIG_DEFAULT, ...config}
 
   return {
     name: 'sanity-plugin-internationalized-array',
@@ -30,7 +30,7 @@ export const internationalizedArray = definePlugin<PluginConfig>((config = CONFI
         },
     schema: {
       types: [
-        ...fieldTypes.map((type) => array({type, apiVersion, languages})),
+        ...fieldTypes.map((type) => array({type, apiVersion, select, languages})),
         ...fieldTypes.map((type) => object({type})),
       ],
     },

package/src/schema/array.ts

@@ -1,19 +1,21 @@
 /* eslint-disable no-nested-ternary */
-import {defineField, type FieldDefinition, type Rule, type SanityClient} from 'sanity'
-import {peek} from '../cache'
+import {defineField, type FieldDefinition, type Rule} from 'sanity'
 
+import {peek} from '../cache'
 import {createFieldName} from '../components/createFieldName'
+import {getSelectedValue} from '../components/getSelectedValue'
 import InternationalizedArray from '../components/InternationalizedArray'
-import {Language, Value} from '../types'
+import {Language, LanguageCallback, Value} from '../types'
 
 type ArrayFactoryConfig = {
   apiVersion: string
-  languages: Language[] | ((client: SanityClient) => Promise<Language[]>)
+  select?: Record<string, string>
+  languages: Language[] | LanguageCallback
   type: string | FieldDefinition
 }
 
 export default (config: ArrayFactoryConfig): FieldDefinition<'array'> => {
-  const {apiVersion, languages, type} = config
+  const {apiVersion, select, languages, type} = config
   const typeName = typeof type === `string` ? type : type.name
   const arrayName = createFieldName(typeName)
   const objectName = createFieldName(typeName, true)
@@ -22,14 +24,12 @@ export default (config: ArrayFactoryConfig): FieldDefinition<'array'> => {
     name: arrayName,
     title: 'Internationalized array',
     type: 'array',
-    // TODO: Resolve this typing issue with the outer component
-    // @ts-ignore
     components: {
       input: InternationalizedArray,
     },
-    options: {apiVersion, languages},
+    options: {apiVersion, select, languages},
     // TODO: Resolve this typing issue with the inner object
-    // @ts-ignore
+    // @ts-expect-error
     of: [
       defineField({
         ...(typeof type === 'string' ? {} : type),
@@ -43,21 +43,29 @@ export default (config: ArrayFactoryConfig): FieldDefinition<'array'> => {
           return true
         }
 
+        const selectedValue = getSelectedValue(select, context.document)
         const client = context.getClient({apiVersion})
-        const contextLanguages: Language[] = Array.isArray(context?.type?.options?.languages)
+        const contextLanguages: Language[] = Array.isArray(
+          context?.type?.options?.languages
+        )
           ? context!.type!.options.languages
-          : Array.isArray(peek())
-          ? peek()
-          : await context?.type?.options.languages(client)
+          : Array.isArray(peek(selectedValue))
+          ? peek(selectedValue)
+          : await context?.type?.options.languages(client, selectedValue)
 
         if (value && value.length > contextLanguages.length) {
           return `Cannot be more than ${
-            contextLanguages.length === 1 ? `1 item` : `${contextLanguages.length} items`
+            contextLanguages.length === 1
+              ? `1 item`
+              : `${contextLanguages.length} items`
           }`
         }
 
         const nonLanguageKeys = value?.length
-          ? value.filter((item) => !contextLanguages.find((language) => item._key === language.id))
+          ? value.filter(
+              (item) =>
+                !contextLanguages.find((language) => item._key === language.id)
+            )
           : []
         if (nonLanguageKeys.length) {
           return {

package/src/schema/object.ts

@@ -17,26 +17,20 @@ export default (config: ObjectFactoryConfig): FieldDefinition<'object'> => {
     name: objectName,
     title: `Internationalized array ${type}`,
     type: 'object',
-    // TODO: Resolve this typing issue with the return type
-    // @ts-ignore
     components: {
-      // TODO: Resolve this typing issue with the outer component
-      // @ts-ignore
       item: InternationalizedInput,
     },
     // TODO: Address this typing issue with the inner object
-    // @ts-ignore
+    // @ts-expect-error
     fields: [
       typeof type === `string`
         ? // Define a simple field if all we have is the name as a string
           defineField({
             name: 'value',
             type,
-            // TODO: Address this typing issue with components on a dynamic `type`
-            // @ts-ignore
             components: {
               // TODO: Address this typing issue with the inner object
-              // @ts-ignore
+              // @ts-expect-error
               field: InternationalizedField,
             },
           })

package/src/types.ts

@@ -1,4 +1,10 @@
-import type {Rule, ArraySchemaType, RuleTypeConstraint, SanityClient} from 'sanity'
+import type {
+  ArraySchemaType,
+  FieldDefinition,
+  Rule,
+  RuleTypeConstraint,
+  SanityClient,
+} from 'sanity'
 
 export type Language = {
   id: Intl.UnicodeBCP47LocaleIdentifier
@@ -24,12 +30,30 @@ export type Value = {
   value?: string
 }
 
+export type LanguageCallback = (
+  client: SanityClient,
+  selectedValue: Record<string, unknown>
+) => Promise<Language[]>
+
 export type PluginConfig = {
   /**
    * https://www.sanity.io/docs/api-versioning
    * @defaultValue '2022-11-27'
    */
   apiVersion?: string
+  /**
+   * Specify fields that should be available in the language callback:
+   * ```tsx
+   * {
+   *   select: {
+   *     markets: 'markets'
+   *   },
+   *   languages: (client, {markets}) =>
+   *     query.fetch(groq`*[_type == "language" && market in $markets]{id,title}`, {markets})
+   * }
+   * ```
+   */
+  select?: Record<string, string>
   /**
    * You can give it an array of language definitions:
    * ```tsx
@@ -57,7 +81,7 @@ export type PluginConfig = {
    * }
    * ```
    */
-  languages: Language[] | ((client: SanityClient) => Promise<Language[]>)
+  languages: Language[] | LanguageCallback
   /**
    * Can be a string matching core field types, as well as custom ones:
    * ```tsx
@@ -81,12 +105,13 @@ export type PluginConfig = {
    * }
    * ```
    */
-  fieldTypes: (string | RuleTypeConstraint)[]
+  fieldTypes: (string | RuleTypeConstraint | FieldDefinition)[]
 }
 
 export type ArraySchemaWithLanguageOptions = ArraySchemaType & {
   options: {
-    languages: Language[] | ((client: SanityClient) => Promise<Language[]>)
+    select?: Record<string, string>
+    languages: Language[] | LanguageCallback
     apiVersion: string
   }
 }