sanity-plugin-internationalized-array 5.0.0-canary.1 → 5.0.0

package/README.md

@@ -368,6 +368,30 @@ Use a backwards compatible query until your migration is ready and has been exec
 }
 ```
 
+If you use AI agents in your code, you can copy [this skill](../../.claude/skills/i18n-array-groq-query-migration/SKILL.md) to your project to guide your agents and help you with the migration.
+
+Use this pre migration prompt
+
+```text
+Use the project skill `i18n-array-groq-query-migration` to update this repo's GROQ queries for `sanity-plugin-internationalized-array` v5.
+
+Goal:
+- Detect all query patterns where language is read from `_key` (for example `_key == "en"` or `_key == $language`).
+- Keep the same language expression used in each query.
+
+Mode: PRE-MIGRATION (backwards-compatible)
+- Replace `_key == <languageExpr>` with `language == <languageExpr> || _key == <languageExpr>`.
+
+What to do:
+1) Scan the codebase for all relevant GROQ queries.
+2) Update the files in place.
+3) Exclude unrelated `_key` uses that are not language matching.
+4) Return a concise report with:
+   - files changed
+   - before/after snippets
+   - any ambiguous matches needing manual review.
+```
+
 ### 3. Data migration
 
 The package exports a migration helper that you can run with the [migration CLI](https://www.sanity.io/docs/cli-reference/cli-migration).
@@ -404,13 +428,62 @@ And update `@sanity/document-internationalization` to `v6`
 
 Previously we updated the GROQ queries to support both locations for the language field. Once migration is complete, update the GROQ queries again to only use `language` and remove the dependency on `_key`.
 
-```diff
+```groq
 *[_type == "person"] {
--  "greeting": greeting[language == "en" || _key == "en"][0].value
-+  "greeting": greeting[language == "en"][0].value
+  "greeting": greeting[language == "en"][0].value
 }
 ```
 
+If you use AI agents in your code, you can automate this with the project skill at `.cursor/skills/i18n-array-groq-query-migration/SKILL.md`.
+
+### Ask your AI agent to help you
+
+```text
+# Migrate internationalized-array to v5 and document-internationalization to v6
+Create and present a plan first, then wait for user confirmation before making changes.
+
+Before running any migration steps, ask the user to create a backup and confirm it is complete. Do not proceed until backup confirmation is received.
+
+Use this context:
+- Document internationalization (v5 -> v6): https://github.com/sanity-io/plugins/blob/main/plugins/%40sanity/document-internationalization/README.md#migrating-to-v6
+- Internationalized array README: https://github.com/sanity-io/plugins/blob/main/plugins/sanity-plugin-internationalized-array/README.md
+- Skill source to copy from: https://github.com/sanity-io/plugins/blob/main/.claude/skills/i18n-array-groq-query-migration/SKILL.md
+
+Then execute this workflow:
+## Pre migration:
+1) Copy the `i18n-array-groq-query-migration` skill file from the provided source URL into the relevant local project skill location.
+2) Use the project skill `i18n-array-groq-query-migration` in PRE-MIGRATION mode and update all legacy GROQ filters from:
+   `_key == <languageExpr>`
+   to:
+   `language == <languageExpr> || _key == <languageExpr>`
+3) Keep the same `<languageExpr>` in each query, edit files in place, and report changed files plus any ambiguous cases.
+4) Add a pause here, the user should deploy this changes with the queries updated before continuing with the migration, request confirmation on this step.
+
+## Migration:
+5) Update the packages to the new versions.
+6) Identify schema types that need updates by scanning schemas where internationalization is used, specifically document types that contain fields with `type` matching `internationalizedArray*`.
+7) Create the migration file following the internationalized array migration guidance, using the discovered document types in the previous step.
+8) If `@sanity/document-internationalization` is used, include `translation.metadata` in the migration document types and plan for upgrading `@sanity/document-internationalization` to `v6`.
+9) Ask the user to run the migration as dry run first, then non-dry-run only after confirmation.
+10) Stop and ask the user to confirm the migration completed successfully before proceeding to post-migration query cleanup.
+11) Ask the user to deploy the changes.
+
+## Post migration.
+11) After migration is confirmed complete, use the project skill in POST-MIGRATION mode.
+12) Update all GROQ queries from:
+   `language == <languageExpr> || _key == <languageExpr>`
+   to:
+   `language == <languageExpr>`
+13) Keep the same `<languageExpr>` in each query, edit files in place, and report changed files plus any ambiguous cases.
+
+Report:
+- The approved plan
+- Backup confirmation status
+- Changed query files
+- Discovered schema types for migration
+- The created migration file path and summary of what it migrates
+```
+
 ## Usage with language filter
 
 The plugin now includes built-in integration with `@sanity/language-filter`.

package/dist/index.d.ts

@@ -1,6 +1,5 @@
-import * as sanity0 from "sanity";
-import { FieldDefinition, Rule, RuleTypeConstraint, SanityClient } from "sanity";
-import { FilterFieldFunction } from "@sanity/language-filter";
+import * as sanity from "sanity";
+import { FieldDefinition, FieldMember, FieldsetState, ObjectSchemaType, Rule, RuleTypeConstraint, SanityClient } from "sanity";
 type Language = {
   id: Intl.UnicodeBCP47LocaleIdentifier;
   title: string;
@@ -137,6 +136,16 @@ type PluginConfig = {
    * @defaultValue 'code'
    * */
   languageDisplay?: LanguageDisplay;
+  /**
+   * @internal
+   * Function to determine if the plugin layout and root input should be included for a given document type.
+   * @defaultValue (documentType) => documentType !== 'translation.metadata'
+   * @example
+   * {
+   *   includeForDocumentType: (documentType) => documentType === 'translation.metadata'
+   * }
+   */
+  includeForDocumentType?: (documentType: string) => boolean;
   /**
    * Configure the language filter for the plugin by providing the document types that should show the filter.
    * ```tsx
@@ -176,11 +185,11 @@ declare const clear: () => void;
  * ```
  */
 declare const LANGUAGE_FIELD_NAME: "language";
-declare const internationalizedArray: sanity0.Plugin<PluginConfig>;
+declare const internationalizedArray: sanity.Plugin<PluginConfig>;
 /**
  * Default filter function for the internationalized array field.
  * It filter the field base on the `language` value of the object.
  */
-declare const internationalizedArrayLanguageFilter: FilterFieldFunction;
+declare const internationalizedArrayLanguageFilter: (enclosingType: ObjectSchemaType, _member: FieldMember | FieldsetState, selectedLanguageIds: string[], parentValue: Record<string, unknown> | undefined, languages: Language[]) => boolean;
 export { AllowedType, ArrayConfig, InternationalizedArrayItem, LANGUAGE_FIELD_NAME, Language, LanguageCallback, LanguageDisplay, PluginConfig, Value, clear, internationalizedArray, internationalizedArrayLanguageFilter, isInternationalizedArrayItemType };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/cache.ts","../src/constants.ts","../src/plugin.tsx","../src/utils/internationalizedArrayLanguageFilter.ts"],"mappings":";;;KAEY,QAAA;EACV,EAAA,EAAI,IAAA,CAAK,4BAAA;EACT,KAAA;AAAA;AAAA,KAGU,WAAA;AAAA,KAEA,WAAA;EACV,IAAA;EACA,IAAA,EAAM,WAAA;EACN,SAAA,EAAW,QAAA;EACX,KAAA;EACA,KAAA;EACA,MAAA;EACA,QAAA;EACA,UAAA,GAAa,IAAA,GAAO,IAAA;EACpB,KAAA;IAAA,CAAU,GAAA;IAAuB,OAAA;MAAA,CAAW,GAAA;IAAA;EAAA;AAAA;;;;KAMlC,KAAA;EACV,IAAA,UARwB;EAUxB,QAAA;EACA,KAAA;AAAA;AAAA,iBAGc,gCAAA,CACd,IAAA,WACC,IAAA,IAAQ,0BAAA;AAAA,KAIC,0BAAA;EACV,IAAA;EACA,KAAA,GAAQ,CAAA,EAxBR;EA0BA,QAAA;EAxBA;;;EA4BA,KAAA;AAAA;AAAA,KAGU,gBAAA,IACV,MAAA,EAAQ,YAAA,EACR,aAAA,EAAe,MAAA,sBACZ,OAAA,CAAQ,QAAA;AAAA,KAED,eAAA;AAAA,KAEA,YAAA;EArC6C;AAMzD;;;EAoCE,UAAA;EAnCA;;;;;AAMF;;;;;;;EA0CE,MAAA,GAAS,MAAA;EAxC0B;AAIrC;;;;;;;;;;;;AAWA;;;;;;;;;;;;;;EAqDE,SAAA,EAAW,QAAA,KAAa,gBAAA;EAlDL;;AAErB;;;;;AAEA;EAuDE,gBAAA;;;;;;;;;;;;;;;;;;;;;;;;EAyBA,UAAA,YAAsB,kBAAA,GAAqB,eAAA;EA2BzC;;;;EAtBF,eAAA;EClGD;;;;EDuGC,YAAA;EExHW;;;;EF6HX,eAAA,GAAkB,eAAA;;AGvIpB;;;;;;ACPA;;;EJyJE,cAAA;IACE,aAAA;EAAA;AAAA;AAAA,cC1HS,KAAA;;;;ADtCb;;;;;;;;;;AAKA;;;;;AAEA;;;;;cEgBa,mBAAA;AAAA,cCVA,sBAAA,EAAsB,OAAA,CAAA,MAAA,CAAA,YAAA;;;;AHbnC;cIMa,oCAAA,EAAsC,mBAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/cache.ts","../src/constants.ts","../src/plugin.tsx","../src/utils/internationalizedArrayLanguageFilter.ts"],"mappings":";;KAEY,QAAA;EACV,EAAA,EAAI,IAAA,CAAK,4BAAA;EACT,KAAA;AAAA;AAAA,KAGU,WAAA;AAAA,KAEA,WAAA;EACV,IAAA;EACA,IAAA,EAAM,WAAA;EACN,SAAA,EAAW,QAAA;EACX,KAAA;EACA,KAAA;EACA,MAAA;EACA,QAAA;EACA,UAAA,GAAa,IAAA,GAAO,IAAA;EACpB,KAAA;IAAA,CAAU,GAAA;IAAuB,OAAA;MAAA,CAAW,GAAA;IAAA;EAAA;AAAA;;;;KAMlC,KAAA;EACV,IAAA,UAfA;EAiBA,QAAA;EACA,KAAA;AAAA;AAAA,iBAGc,gCAAA,CACd,IAAA,WACC,IAAA,IAAQ,0BAAA;AAAA,KAIC,0BAAA;EACV,IAAA;EACA,KAAA,GAAQ,CAAA,EAvBR;EAyBA,QAAA;EAxBa;;;EA4Bb,KAAA;AAAA;AAAA,KAGU,gBAAA,IACV,MAAA,EAAQ,YAAA,EACR,aAAA,EAAe,MAAA,sBACZ,OAAA,CAAQ,QAAA;AAAA,KAED,eAAA;AAAA,KAEA,YAAA;EA/BA;;;;EAoCV,UAAA;EAjCA;;;;AAIF;;;;;;;;EA0CE,MAAA,GAAS,MAAA;EApCC;;;;;;;;;;;;AAWZ;;;;;;;;;;;;;;;EAqDE,SAAA,EAAW,QAAA,KAAa,gBAAA;EAlDL;AAErB;;;;;AAEA;;EAuDE,gBAAA;EArCS;;;;;;;;;;;;;;;;;;;;;;;EA8DT,UAAA,YAAsB,kBAAA,GAAqB,eAAA;EAoC3C;;;;EA/BA,eAAA;EC/GW;;;;EDoHX,YAAA;;AExHF;;;EF6HE,eAAA,GAAkB,eAAA;EE7HkC;;ACZtD;;;;;;ACJA;EJuJE,sBAAA,IAA0B,YAAA;;;;;;;;;;;EAW1B,cAAA;IACE,aAAA;EAAA;AAAA;AAAA,cC/IS,KAAA;;;AD3Bb;;;;;;;;;;AAKA;;;;;AAEA;;;;;;cEgBa,mBAAA;AAAA,cCZA,sBAAA,EAAsB,MAAA,CAAA,MAAA,CAAA,YAAA;;AHXnC;;;cIOa,oCAAA,GACX,aAAA,EAAe,gBAAA,EACf,OAAA,EAAS,WAAA,GAAc,aAAA,EACvB,mBAAA,YACA,WAAA,EAAa,MAAA,+BACb,SAAA,EAAW,QAAA"}