sanity-plugin-internationalized-array 1.6.0 → 1.6.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 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

@@ -1,12 +1,12 @@
 > This is the **Sanity Studio v3 version** of sanity-plugin-internationalized-array.
 >
-> For the v2 version, please refer to the [v2-branch](https://github.com/SimeonGriggs/sanity-plugin-internationalized-array/tree/studio-v2).
+> For the v2 version, please refer to the [v2-branch](https://github.com/sanity-io/sanity-plugin-internationalized-array/tree/studio-v2).
 
 # sanity-plugin-internationalized-array
 
 A helper function that renders a custom input component for writing localized fields of content into an array.
 
-![Screenshot of an internationalized input](./img/screenshot.png)
+![Screenshot of an internationalized input](./img/internationalized-array.png)
 
 ## Installation
 
@@ -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.
@@ -135,7 +161,7 @@ Using GROQ filters you can query for a specific language key like so:
 
 ## Migrate from objects to arrays
 
-[See the migration script](https://github.com/SimeonGriggs/sanity-plugin-internationalized-array/blob/main/migrations/transformObjectToArray.js) inside `./migrations/transformObjectToArray.js` of this Repo.
+[See the migration script](https://github.com/sanity-io/sanity-plugin-internationalized-array/blob/main/migrations/transformObjectToArray.js) inside `./migrations/transformObjectToArray.js` of this Repo.
 
 Follow the instructions inside the script and set the `_type` and field name you wish to target.
 
@@ -196,7 +222,7 @@ on how to run this plugin with hotreload in the studio.
 
 ### Release new version
 
-Run ["CI & Release" workflow](https://github.com/SimeonGriggs/sanity-plugin-internationalized-array/actions/workflows/main.yml).
+Run ["CI & Release" workflow](https://github.com/sanity-io/sanity-plugin-internationalized-array/actions/workflows/main.yml).
 Make sure to select the main branch and check "Release new version".
 
 Semantic release will only release on configured branches, so it is safe to run release on any branch.

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

@@ -5,7 +5,12 @@ 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