@sanity/assist 6.1.8 → 6.1.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/dist/index.d.ts +5 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4703 -4385
- package/dist/index.js.map +1 -1
- package/package.json +6 -7
package/README.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
- [Table of contents](#table-of-contents)
|
|
6
6
|
- [About Sanity AI Assist](#about-sanity-ai-assist)
|
|
7
7
|
- [Installation](#installation)
|
|
8
|
+
- [Build errors about missing icon exports](#build-errors-about-missing-icon-exports)
|
|
8
9
|
- [Setup](#setup)
|
|
9
10
|
- [Add the plugin](#add-the-plugin)
|
|
10
11
|
- [Enabling the AI Assist API](#enabling-the-ai-assist-api)
|
|
@@ -57,6 +58,30 @@ npm install @sanity/assist sanity@latest
|
|
|
57
58
|
|
|
58
59
|
This plugin requires `sanity` version `3.26` or greater.
|
|
59
60
|
|
|
61
|
+
### Build errors about missing icon exports
|
|
62
|
+
|
|
63
|
+
This plugin depends on `@sanity/icons` v5, which [removed the per-icon exports from the package root](https://github.com/sanity-io/icons/releases/tag/v5.0.0): every icon now lives on its own export path. If `sanity build` or `sanity dev` fails with an error like
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
[MISSING_EXPORT] "CopyIcon" is not exported by "node_modules/@sanity/icons/dist/index.js"
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
the file referenced by the error still imports icons from the package root — usually the studio's own schema or structure code, or another dependency that has not been updated yet. Update those imports to the per-icon export paths:
|
|
70
|
+
|
|
71
|
+
```diff
|
|
72
|
+
- import {CopyIcon, ListIcon} from '@sanity/icons'
|
|
73
|
+
+ import {CopyIcon} from '@sanity/icons/Copy'
|
|
74
|
+
+ import {ListIcon} from '@sanity/icons/List'
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Also make sure `@sanity/icons` is declared in the studio's own `package.json` when studio code imports it; which copy an undeclared import resolves to depends on package manager hoisting, and can change when installing or upgrading plugins.
|
|
78
|
+
|
|
79
|
+
If you cannot update the importing code right away (for example when it lives in a third-party package), pin `@sanity/icons` to v4 in the studio's own `package.json` until it catches up — v4 supports both import styles:
|
|
80
|
+
|
|
81
|
+
```sh
|
|
82
|
+
npm install @sanity/icons@4
|
|
83
|
+
```
|
|
84
|
+
|
|
60
85
|
## Setup
|
|
61
86
|
|
|
62
87
|
> **Note:** AI Assist is available for all projects on the Growth plan and up.
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { SanityClient } from "
|
|
2
|
-
import {
|
|
1
|
+
import { CurrentUser, DocumentFieldActionDivider, DocumentFieldActionGroup, DocumentFieldActionItem, ObjectSchemaType, Path, SanityClient, SanityDocumentLike, SchemaType } from "sanity";
|
|
2
|
+
import { SanityClient as SanityClient$1 } from "@sanity/client";
|
|
3
3
|
import { AgentActionPath } from "@sanity/client/stega";
|
|
4
4
|
import { PortableTextBlock, PortableTextMarkDefinition, PortableTextSpan } from "@portabletext/types";
|
|
5
5
|
interface AssistConfig {
|
|
@@ -234,7 +234,7 @@ interface TranslationOutput {
|
|
|
234
234
|
outputPath: Path;
|
|
235
235
|
}
|
|
236
236
|
type TranslationOutputsFunction = (documentMember: DocumentMember, enclosingType: SchemaType, translateFromLanguageId: string, translateToLanguageIds: string[]) => TranslationOutput[] | undefined;
|
|
237
|
-
type LanguageCallback = (client: SanityClient
|
|
237
|
+
type LanguageCallback = (client: SanityClient, selectedLanguageParams: Record<string, unknown>) => Promise<Language[]>;
|
|
238
238
|
interface FieldTranslationConfig {
|
|
239
239
|
/**
|
|
240
240
|
* `documentTypes` should be an array of strings where each entry must match a name from your document schemas.
|
|
@@ -363,7 +363,7 @@ interface DocumentTranslationConfig {
|
|
|
363
363
|
interface TranslateStyleguideContext {
|
|
364
364
|
documentId: string;
|
|
365
365
|
schemaType: ObjectSchemaType;
|
|
366
|
-
client: SanityClient
|
|
366
|
+
client: SanityClient;
|
|
367
367
|
/**
|
|
368
368
|
* Only provided for field translations
|
|
369
369
|
*/
|
|
@@ -462,7 +462,7 @@ interface AssistPluginConfig {
|
|
|
462
462
|
/**
|
|
463
463
|
* @internal
|
|
464
464
|
*/
|
|
465
|
-
__customApiClient?: (defaultClient: SanityClient) => SanityClient;
|
|
465
|
+
__customApiClient?: (defaultClient: SanityClient$1) => SanityClient$1;
|
|
466
466
|
/**
|
|
467
467
|
* @internal
|
|
468
468
|
*/
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/assistTypes.ts","../src/fieldActions/customFieldActions.tsx","../src/translate/types.ts","../src/types.ts","../src/plugin.tsx","../src/schemas/serialize/SchemTypeTool.tsx","../src/schemas/typeDefExtensions.ts","../src/translate/paths.ts","../src/fieldActions/useUserInput.ts","../src/helpers/typeUtils.ts"],"mappings":";;;;UAEiB,YAAA;;;;AAAjB;;;;;;;;;;;AAiDa;AAGb;;EAlCE,cAAA,IAAkB,OAAA,EAAS,qBAAA,KAA0B,cAAc;EAoCpC;;;;;;AAAA;AAGjC;;;;AAsBU;;ACvDV;;EDWE,YAAA;ECVqB;;;;;;AAEf;AAGR;;;;;EDmBE,WAAA;AAAA;AAAA,UAGe,qBAAA;EACf,IAAA,EAAM,WAAA;EACN,eAAA,EAAiB,cAAc;AAAA;AAAA,UAGhB,cAAA;ECJf;;;;;;;;;EDcA,MAAA;EC8EA;;;;;AAU6B;AAG/B;;;;ED/EE,QAAQ;AAAA;AAAA,UCvDO,0BAAA;EACf,IAAA,EAAM,eAAe;EACrB,QAAA;EACA,MAAA;AAAA;AAAA,UAGe,sBAAA;EDZoD;;;;ECiBnE,UAAA;EDAA;;;AAcW;AAGb;;;;;;;;;AAEiC;AAGjC;;;ECJE,mBAAA;ED0BQ;;ACvDV;;EAmCE,kBAAA,EAAoB,gBAAA;EAlCC;;;;;;EA0CrB,gBAAA,QAAwB,kBAAA;EArCT;;;;;EA4Cf,mBAAA,QAA2B,0BAAA;EA6CrB;;;;;;;;;;;;;;;;;;;;;EAtBN,QAAA;EA6DU;;;;;;;;;;;;AAGkB;AAE9B;;;;;;;EA5CE,IAAA,EAAM,eAAA;EA4C4B;;;;;AAIJ;AAGhC;;;;;;;;;;;;;AAQkC;AAKlC;;;;EAtCE,UAAA,EAAY,UAAA;EAwCX;;;;;;;;EA9BD,gBAAA,GAAmB,UAAA;AAAA;AAAA,KAGT,qBAAA,GACR,qBAAA,GACA,sBAAA,GACA,0BAAA;AAAA,KAEQ,qBAAA,GAAwB,IAAA,CAClC,uBAAA;EAGA,QAAA,eAAuB,OAAA;AAAA;AAAA,KAGb,sBAAA,GAAyB,IAAA,CACnC,wBAAA;EA2B0C;;;;EApB1C,QAAA,GAAW,qBAAA;AAAA;AAAA,iBAKG,uBAAA,CACd,MAAA,EAAQ,IAAA,CAAK,qBAAA,YACZ,qBAAA;AAAA,iBAOa,wBAAA,IAA4B,0BAA0B;AAAA,iBAMtD,4BAAA,CACd,KAAA,EAAO,IAAA,CAAK,sBAAA,YACX,sBAAA;AAAA,UCxMc,QAAA;EACf,EAAA;EACA,KAAK;AAAA;AAAA,UAGU,cAAA;EACf,UAAA,EAAY,UAAA;EACZ,IAAA,EAAM,IAAI;EACV,IAAA;EACA,KAAA;EACA,WAAA;AAAA;AAAA,UAGe,iBAAA;EFsBf;EEpBA,EAAA;EACA,UAAA,EAAY,IAAI;AAAA;AAAA,KAGN,0BAAA,IACV,cAAA,EAAgB,cAAA,EAChB,aAAA,EAAe,UAAA,EACf,uBAAA,UACA,sBAAA,eACG,iBAAA;AAAA,KAEO,gBAAA,IACV,MAAA,EAAQ,
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/assistTypes.ts","../src/fieldActions/customFieldActions.tsx","../src/translate/types.ts","../src/types.ts","../src/plugin.tsx","../src/schemas/serialize/SchemTypeTool.tsx","../src/schemas/typeDefExtensions.ts","../src/translate/paths.ts","../src/fieldActions/useUserInput.ts","../src/helpers/typeUtils.ts"],"mappings":";;;;UAEiB,YAAA;;;;AAAjB;;;;;;;;;;;AAiDa;AAGb;;EAlCE,cAAA,IAAkB,OAAA,EAAS,qBAAA,KAA0B,cAAc;EAoCpC;;;;;;AAAA;AAGjC;;;;AAsBU;;ACvDV;;EDWE,YAAA;ECVqB;;;;;;AAEf;AAGR;;;;;EDmBE,WAAA;AAAA;AAAA,UAGe,qBAAA;EACf,IAAA,EAAM,WAAA;EACN,eAAA,EAAiB,cAAc;AAAA;AAAA,UAGhB,cAAA;ECJf;;;;;;;;;EDcA,MAAA;EC8EA;;;;;AAU6B;AAG/B;;;;ED/EE,QAAQ;AAAA;AAAA,UCvDO,0BAAA;EACf,IAAA,EAAM,eAAe;EACrB,QAAA;EACA,MAAA;AAAA;AAAA,UAGe,sBAAA;EDZoD;;;;ECiBnE,UAAA;EDAA;;;AAcW;AAGb;;;;;;;;;AAEiC;AAGjC;;;ECJE,mBAAA;ED0BQ;;ACvDV;;EAmCE,kBAAA,EAAoB,gBAAA;EAlCC;;;;;;EA0CrB,gBAAA,QAAwB,kBAAA;EArCT;;;;;EA4Cf,mBAAA,QAA2B,0BAAA;EA6CrB;;;;;;;;;;;;;;;;;;;;;EAtBN,QAAA;EA6DU;;;;;;;;;;;;AAGkB;AAE9B;;;;;;;EA5CE,IAAA,EAAM,eAAA;EA4C4B;;;;;AAIJ;AAGhC;;;;;;;;;;;;;AAQkC;AAKlC;;;;EAtCE,UAAA,EAAY,UAAA;EAwCX;;;;;;;;EA9BD,gBAAA,GAAmB,UAAA;AAAA;AAAA,KAGT,qBAAA,GACR,qBAAA,GACA,sBAAA,GACA,0BAAA;AAAA,KAEQ,qBAAA,GAAwB,IAAA,CAClC,uBAAA;EAGA,QAAA,eAAuB,OAAA;AAAA;AAAA,KAGb,sBAAA,GAAyB,IAAA,CACnC,wBAAA;EA2B0C;;;;EApB1C,QAAA,GAAW,qBAAA;AAAA;AAAA,iBAKG,uBAAA,CACd,MAAA,EAAQ,IAAA,CAAK,qBAAA,YACZ,qBAAA;AAAA,iBAOa,wBAAA,IAA4B,0BAA0B;AAAA,iBAMtD,4BAAA,CACd,KAAA,EAAO,IAAA,CAAK,sBAAA,YACX,sBAAA;AAAA,UCxMc,QAAA;EACf,EAAA;EACA,KAAK;AAAA;AAAA,UAGU,cAAA;EACf,UAAA,EAAY,UAAA;EACZ,IAAA,EAAM,IAAI;EACV,IAAA;EACA,KAAA;EACA,WAAA;AAAA;AAAA,UAGe,iBAAA;EFsBf;EEpBA,EAAA;EACA,UAAA,EAAY,IAAI;AAAA;AAAA,KAGN,0BAAA,IACV,cAAA,EAAgB,cAAA,EAChB,aAAA,EAAe,UAAA,EACf,uBAAA,UACA,sBAAA,eACG,iBAAA;AAAA,KAEO,gBAAA,IACV,MAAA,EAAQ,YAAA,EACR,sBAAA,EAAwB,MAAA,sBACrB,OAAA,CAAQ,QAAA;AAAA,UAEI,sBAAA;EFuBgB;;;;;EEjB/B,aAAA;EFiB+B;AAGjC;;;;AAsBU;;EEjCR,SAAA,EAAW,QAAA,KAAa,gBAAA;EDtBiB;;;;;EC6BzC,UAAA;ED1BA;;AAAM;AAGR;;;;;;;;;;;;ECwCE,oBAAA,GAAuB,MAAA;EDXvB;;;;;;;;;;;;;;AAgG6B;AAG/B;;;;;;;;;;;;AAG8B;AAE9B;;;;;;;;;;;;;AAIgC;AAGhC;;;;;;;;;;EC9CE,kBAAA,GAAqB,0BAAA;EDsDV;;AAAqB;AAKlC;;;;;;;;;EC7CE,YAAA;AAAA;AAAA,UAGe,yBAAA;ED4CO;AAAA;AAOxB;;;;AAAsE;AAMtE;;EC/CE,aAAA;EDgDY;;;;;;;;ECtCZ,aAAa;AAAA;AAAA,UAGE,0BAAA;EACf,UAAA;EACA,UAAA,EAAY,gBAAA;EACZ,MAAA,EAAQ,YAAA;;;AArKH;EAyKL,aAAA,GAAgB,IAAA;AAAA;AAAA,KAGN,mBAAA,cAEN,OAAA,EAAS,0BAAA,KAA+B,OAAO;AAAA,UAEpC,iBAAA;EA5Kf;;;EAgLA,KAAA,GAAQ,sBAAA;EA9KR;;;EAkLA,QAAA,GAAW,yBAAA;EAhLA;AAGb;;;;;;EAqLE,UAAA,GAAa,mBAAA;AAAA;AAAA,cClLF,iBAAA;AAAA,cACA,0BAAA;AAAA,cACA,sBAAA;AAAA,cAGA,uBAAA;AAAA,cASA,mBAAA;AAAA,cACA,kBAAA;AAAA,UAyCI,iBAAA;EACf,IAAA;EACA,MAAA,GAAS,eAAA;EAET,KAAA;EFTwB;;;EEaxB,IAAA;EFuCA;;;EElCA,MAAA,IAAU,eAAA,GAAkB,cAAA;AAAA;AAAA,UAGb,WAAA;EACf,IAAA;EACA,YAAA,GAAe,iBAAiB;AAAA;AAAA,UAGjB,YAAA;EACf,MAAA,GAAS,WAAW;AAAA;AAAA,UA8BL,QAAA,SAAiB,0BAA0B;EAC1D,KAAA,SAAc,sBAAA;EACd,IAAA;AAAA;AAAA,UAGe,YAAA;EACf,KAAA,SAAc,0BAA0B;EACxC,SAAA;IACE,KAAA;IACA,IAAA;EAAA;AAAA;AAAA,UAIa,cAAA;EACf,KAAA,SAAc,iBAAiB;EAC/B,IAAA;EACA,OAAA;EACA,WAAA;AAAA;AAAA,KAGU,iBAAA,GAAoB,gBAAA,GAAmB,QAAA,GAAW,cAAA,GAAiB,YAAA;AAAA,KACnE,eAAA,GAAkB,IAAA,CAC5B,iBAAA,QAAyB,iBAAA;EAEtB,KAAA;AAAA;AAAA,UA0DY,eAAA;EACf,KAAA,SAAc,mBAAmB;EACjC,IAAA;EAEA,YAAA;AAAA;AAAA,UAGe,cAAA;EACf,KAAA,SAAc,kBAAkB;EAChC,IAAA;EAEA,IAAA;EAEA,YAAA;AAAA;AAAA,UCpMe,kBAAA;EACf,SAAA,GAAY,iBAAA;;;;EAKZ,MAAA,GAAS,YAAA;EAET,YAAA;IACE,KAAA;IJGF;;;IICE,eAAA,IAAmB,KAAA,EAAO,sBAAA,MAA4B,qBAAA;EAAA;EJgBpB;;;EIVpC,iBAAA,IAAqB,aAAA,EAAe,cAAA,KAAiB,cAAA;EJW/C;;;EINN,SAAA,GAAY,MAAA,SAAe,YAAA;AAAA;AAAA,cAGhB,MAAA,mBAAM,MAAA,QAAA,kBAAA;AAAA,iBCvCH,cAAA,oBAAc,GAAA,CAAA,OAAA;AAAA,UCXb,aAAA;EACf,QAAA;mEAEE,OAAA;INHa;;;;IMSb,eAAA;EAAA;AAAA;AAAA;EAAA,UAKQ,YAAA,SAAqB,aAAA;EAAA,UACrB,YAAA,SAAqB,aAAA;EAAA,UACrB,cAAA,SAAuB,aAAA;EAAA,UACvB,4BAAA,SAAqC,aAAA;EAAA,UACrC,WAAA,SAAoB,aAAA;EAAA,UACpB,eAAA,SAAwB,aAAA;EAAA,UACxB,eAAA,SAAwB,aAAA;EAAA,UACxB,WAAA,SAAoB,aAAA;EAAA,UACpB,eAAA,SAAwB,aAAA;EAAA,UACxB,YAAA;IACR,QAAA,GAAW,aAAA;MLAE;;;;;;;;;AAGT;AAGR;;;;;;;;;;;;;;;;;;;;;;;;MK6BM,qBAAA;MLgGe;;AAAU;AAG/B;;;;;;;;;;;;AAG8B;AAE9B;;;;;;;;;;;;;AAIgC;MK5E1B,qBAAA;QAGM,IAAA;QL4EsB;;;;;;QKrEtB,mBAAA;MAAA;IAAA;EAAA;EAAA,UAIA,aAAA,SAAsB,aAAA;EAAA,UACtB,aAAA,SAAsB,aAAA;EAAA,UACtB,oBAAA;IACR,QAAA;ML4EM,+DK1EJ,OAAA;ML2EkB;;;;MKrElB,eAAA;IAAA;EAAA;EAAA,UAGM,WAAA,SAAoB,aAAA;EAAA,UACpB,aAAA,SAAsB,aAAA;EAAA,UACtB,WAAA,SAAoB,aAAA;EAAA,UACpB,UAAA,SAAmB,aAAA;EAAA,UACnB,YAAA,SAAqB,aAAA;AAAA;AAAA,cCUpB,sBAAA,EAAwB,0BAsDpC;AAAA,KC3LW,YAAA,IAAgB,IAAA;;;;EAI1B,KAAA;ERJe;;;EQQf,MAAA,EAAQ,WAAA;AAAA,MACJ,OAAA,CAAQ,iBAAA;;;;UAKG,WAAA;ERmCf;;AAAW;EQ/BX,EAAA;ERkCoC;;;EQ9BpC,KAAA;ER+BM;;;EQ3BN,WAAA;AAAA;AAAA,KAGU,iBAAA;ER4BmB;;;EQxB7B,KAAA,EAAO,WAAW;;APTpB;;EOcE,MAAA;AAAA;;;;;;APXM;AAGR;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6H+B;AAG/B;;;;;;;;;;;;AAG8B;AAE9B;;;;;;;;;;;;;iBO9DgB,YAAA,IAAgB,YAAY;;;;ARrG5C;;;iBSUgB,MAAA,CAAO,UAAA,EAAY,UAAU,EAAE,QAAA"}
|