sanity-plugin-internationalized-array 1.5.0 → 1.6.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Simeon Griggs
+Copyright (c) 2023 Sanity.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -76,6 +76,32 @@ languages: async () => {
 }
 ```
 
+The async function contains a configured Sanity Client in the first parameter, allowing you to store Language options as documents. Your query should return an array of objects with an `id` and `title`.
+
+```ts
+languages: async (client) => {
+  const response = await client.fetch(`*[_type == "language"]{ id, title }`)
+  return response
+},
+```
+
+Additionally, you can "pick" fields from a document, to pass into the query. For example, if you have a concept of "Markets" where only certain language fields are required in certain markets.
+
+In this example, each language document has an array of strings called `markets` to declare where that language can be used. And the document being authored has a single `market` field.
+
+```ts
+select: {
+  market: 'market'
+},
+languages: async (client, {market = ``}) => {
+  const response = await client.fetch(
+    `*[_type == "language" && $market in markets]{ id, title }`,
+    {market}
+  )
+  return response
+},
+```
+
 ## Using more complex field types
 
 For more control over the `value` field, you can pass a schema definition into the `fieldTypes` array.

package/lib/{src/index.d.ts → index.d.ts}

@@ -1,10 +1,16 @@
 import type {ArraySchemaType} from 'sanity'
+import type {FieldDefinition} from 'sanity'
 import {Plugin as Plugin_2} from 'sanity'
 import type {Rule} from 'sanity'
 import type {RuleTypeConstraint} from 'sanity'
 import type {SanityClient} from 'sanity'
 
-export declare type AllowedType = 'string' | 'number' | 'boolean' | 'text' | 'reference'
+export declare type AllowedType =
+  | 'string'
+  | 'number'
+  | 'boolean'
+  | 'text'
+  | 'reference'
 
 export declare type ArrayConfig = {
   name: string
@@ -25,7 +31,8 @@ export declare type ArrayConfig = {
 
 export declare type ArraySchemaWithLanguageOptions = ArraySchemaType & {
   options: {
-    languages: Language[] | ((client: SanityClient) => Promise<Language[]>)
+    select?: Record<string, string>
+    languages: Language[] | LanguageCallback
     apiVersion: string
   }
 }
@@ -39,12 +46,30 @@ export declare type Language = {
   title: string
 }
 
+export declare type LanguageCallback = (
+  client: SanityClient,
+  selectedValue: Record<string, unknown>
+) => Promise<Language[]>
+
 export declare 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
@@ -72,7 +97,7 @@ export declare 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
@@ -96,7 +121,7 @@ export declare type PluginConfig = {
    * }
    * ```
    */
-  fieldTypes: (string | RuleTypeConstraint)[]
+  fieldTypes: (string | RuleTypeConstraint | FieldDefinition)[]
 }
 
 export declare type Value = {