@sanity/client 4.0.0-alpha.esm.5 → 4.0.0
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/LICENSE +1 -1
- package/README.md +23 -16
- package/dist/{browser/sanityClient.js → sanityClient.browser.mjs} +305 -1513
- package/dist/sanityClient.browser.mjs.map +7 -0
- package/index.js +7 -0
- package/lib/assets/assetsClient.js +100 -141
- package/lib/auth/authClient.js +20 -35
- package/lib/config.js +21 -43
- package/lib/data/dataMethods.js +32 -55
- package/lib/data/encodeQueryString.js +9 -15
- package/lib/data/listen.js +24 -53
- package/lib/data/patch.js +114 -167
- package/lib/data/transaction.js +95 -139
- package/lib/datasets/datasetsClient.js +31 -56
- package/lib/generateHelpUrl.js +11 -0
- package/lib/http/browserMiddleware.js +4 -3
- package/lib/http/errors.js +9 -15
- package/lib/http/nodeMiddleware.js +6 -10
- package/lib/http/queryString.js +4 -7
- package/lib/http/request.js +14 -28
- package/lib/http/requestOptions.js +7 -10
- package/lib/projects/projectsClient.js +19 -34
- package/lib/sanityClient.js +98 -153
- package/lib/users/usersClient.js +14 -27
- package/lib/util/defaults.js +6 -8
- package/lib/util/getSelection.js +3 -5
- package/lib/util/observable.js +0 -3
- package/lib/util/once.js +4 -6
- package/lib/util/pick.js +4 -6
- package/lib/validators.js +0 -26
- package/lib/warnings.js +9 -13
- package/package.json +49 -38
- package/sanityClient.d.ts +254 -92
- package/umd/sanityClient.js +165 -103
- package/umd/sanityClient.min.js +1 -1
- package/dist/node/sanityClient.js +0 -969
- package/src/assets/assetsClient.js +0 -132
- package/src/auth/authClient.js +0 -13
- package/src/config.js +0 -93
- package/src/data/dataMethods.js +0 -182
- package/src/data/encodeQueryString.js +0 -18
- package/src/data/listen.js +0 -159
- package/src/data/patch.js +0 -119
- package/src/data/transaction.js +0 -103
- package/src/datasets/datasetsClient.js +0 -28
- package/src/http/browserMiddleware.js +0 -1
- package/src/http/errors.js +0 -53
- package/src/http/nodeMiddleware.js +0 -11
- package/src/http/queryString.js +0 -10
- package/src/http/request.js +0 -50
- package/src/http/requestOptions.js +0 -29
- package/src/projects/projectsClient.js +0 -13
- package/src/sanityClient.js +0 -124
- package/src/users/usersClient.js +0 -9
- package/src/util/defaults.js +0 -9
- package/src/util/getSelection.js +0 -17
- package/src/util/observable.js +0 -6
- package/src/util/once.js +0 -12
- package/src/util/pick.js +0 -9
- package/src/validators.js +0 -76
- package/src/warnings.js +0 -25
- package/test/client.test.js +0 -2561
- package/test/encodeQueryString.test.js +0 -38
- package/test/fixtures/horsehead-nebula.jpg +0 -0
- package/test/fixtures/pdf-sample.pdf +0 -0
- package/test/helpers/sseServer.js +0 -27
- package/test/listen.test.js +0 -207
- package/test/warnings.test.disabled.js +0 -84
package/sanityClient.d.ts
CHANGED
|
@@ -12,6 +12,7 @@ export type AssetMetadataType =
|
|
|
12
12
|
export type DatasetAclMode = 'public' | 'private' | 'custom'
|
|
13
13
|
export type ListenVisibility = 'sync' | 'async' | 'query'
|
|
14
14
|
export type ListenEventName = 'mutation' | 'welcome' | 'reconnect'
|
|
15
|
+
export type MutationOperation = 'create' | 'delete' | 'update' | 'none'
|
|
15
16
|
|
|
16
17
|
export interface ResponseEvent<T = unknown> {
|
|
17
18
|
type: 'response'
|
|
@@ -34,7 +35,7 @@ export interface ProgressEvent {
|
|
|
34
35
|
|
|
35
36
|
type AttributeSet = {[key: string]: any}
|
|
36
37
|
type QueryParams = {[key: string]: any}
|
|
37
|
-
type MutationSelection = {query: string} | {id: string}
|
|
38
|
+
type MutationSelection = {query: string; params?: QueryParams} | {id: string}
|
|
38
39
|
type SanityReference = {_ref: string}
|
|
39
40
|
|
|
40
41
|
interface RawRequestOptions {
|
|
@@ -204,7 +205,7 @@ export type PatchBuilder = (patch: Patch) => Patch
|
|
|
204
205
|
|
|
205
206
|
export type PatchMutationOperation = PatchOperations & MutationSelection
|
|
206
207
|
|
|
207
|
-
export type Mutation<R
|
|
208
|
+
export type Mutation<R extends Record<string, any> = Record<string, any>> =
|
|
208
209
|
| {create: SanityDocumentStub<R>}
|
|
209
210
|
| {createOrReplace: IdentifiedSanityDocumentStub<R>}
|
|
210
211
|
| {createIfNotExists: IdentifiedSanityDocumentStub<R>}
|
|
@@ -214,23 +215,16 @@ export type Mutation<R = any> =
|
|
|
214
215
|
export interface SingleMutationResult {
|
|
215
216
|
transactionId: string
|
|
216
217
|
documentId: string
|
|
217
|
-
results: {id: string}[]
|
|
218
|
+
results: {id: string; operation: MutationOperation}[]
|
|
218
219
|
}
|
|
219
220
|
|
|
220
221
|
export interface MultipleMutationResult {
|
|
221
222
|
transactionId: string
|
|
222
223
|
documentIds: string[]
|
|
223
|
-
results: {id: string}[]
|
|
224
|
+
results: {id: string; operation: MutationOperation}[]
|
|
224
225
|
}
|
|
225
226
|
|
|
226
|
-
export class
|
|
227
|
-
constructor(documentId: string, operations?: PatchOperations, client?: SanityClient)
|
|
228
|
-
|
|
229
|
-
/**
|
|
230
|
-
* Clones the patch
|
|
231
|
-
*/
|
|
232
|
-
clone(): Patch
|
|
233
|
-
|
|
227
|
+
export abstract class BasePatch {
|
|
234
228
|
/**
|
|
235
229
|
* DEPRECATED: Don't use.
|
|
236
230
|
* The operation is added to the current patch, ready to be commited by `commit()`
|
|
@@ -338,19 +332,37 @@ export class Patch {
|
|
|
338
332
|
*/
|
|
339
333
|
toJSON(): PatchMutationOperation
|
|
340
334
|
|
|
335
|
+
/**
|
|
336
|
+
* Clears the patch of all operations
|
|
337
|
+
*/
|
|
338
|
+
reset(): this
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
export class Patch extends BasePatch {
|
|
342
|
+
constructor(documentId: string, operations?: PatchOperations, client?: SanityClient)
|
|
343
|
+
|
|
344
|
+
/**
|
|
345
|
+
* Clones the patch
|
|
346
|
+
*/
|
|
347
|
+
clone(): Patch
|
|
348
|
+
|
|
341
349
|
/**
|
|
342
350
|
* Commit the patch, returning a promise that resolves to the first patched document
|
|
343
351
|
*
|
|
344
352
|
* @param options Options for the mutation operation
|
|
345
353
|
*/
|
|
346
|
-
commit<R
|
|
354
|
+
commit<R extends Record<string, any> = Record<string, any>>(
|
|
355
|
+
options: FirstDocumentMutationOptions
|
|
356
|
+
): Promise<SanityDocument<R>>
|
|
347
357
|
|
|
348
358
|
/**
|
|
349
359
|
* Commit the patch, returning a promise that resolves to an array of the mutated documents
|
|
350
360
|
*
|
|
351
361
|
* @param options Options for the mutation operation
|
|
352
362
|
*/
|
|
353
|
-
commit<R
|
|
363
|
+
commit<R extends Record<string, any> = Record<string, any>>(
|
|
364
|
+
options: AllDocumentsMutationOptions
|
|
365
|
+
): Promise<SanityDocument<R>[]>
|
|
354
366
|
|
|
355
367
|
/**
|
|
356
368
|
* Commit the patch, returning a promise that resolves to a mutation result object
|
|
@@ -371,25 +383,69 @@ export class Patch {
|
|
|
371
383
|
*
|
|
372
384
|
* @param options Options for the mutation operation
|
|
373
385
|
*/
|
|
374
|
-
commit<R
|
|
386
|
+
commit<R extends Record<string, any> = Record<string, any>>(
|
|
387
|
+
options?: BaseMutationOptions
|
|
388
|
+
): Promise<SanityDocument<R>>
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
export class ObservablePatch extends BasePatch {
|
|
392
|
+
constructor(documentId: string, operations?: PatchOperations, client?: ObservableSanityClient)
|
|
375
393
|
|
|
376
394
|
/**
|
|
377
|
-
*
|
|
395
|
+
* Clones the patch
|
|
378
396
|
*/
|
|
379
|
-
|
|
380
|
-
}
|
|
397
|
+
clone(): ObservablePatch
|
|
381
398
|
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
399
|
+
/**
|
|
400
|
+
* Commit the patch, returning an observable that produces the first patched document
|
|
401
|
+
*
|
|
402
|
+
* @param options Options for the mutation operation
|
|
403
|
+
*/
|
|
404
|
+
commit<R extends Record<string, any> = Record<string, any>>(
|
|
405
|
+
options: FirstDocumentMutationOptions
|
|
406
|
+
): Observable<SanityDocument<R>>
|
|
407
|
+
|
|
408
|
+
/**
|
|
409
|
+
* Commit the patch, returning an observable that produces an array of the mutated documents
|
|
410
|
+
*
|
|
411
|
+
* @param options Options for the mutation operation
|
|
412
|
+
*/
|
|
413
|
+
commit<R extends Record<string, any> = Record<string, any>>(
|
|
414
|
+
options: AllDocumentsMutationOptions
|
|
415
|
+
): Observable<SanityDocument<R>[]>
|
|
416
|
+
|
|
417
|
+
/**
|
|
418
|
+
* Commit the patch, returning an observable that produces a mutation result object
|
|
419
|
+
*
|
|
420
|
+
* @param options Options for the mutation operation
|
|
421
|
+
*/
|
|
422
|
+
commit(options: FirstDocumentIdMutationOptions): Observable<SingleMutationResult>
|
|
385
423
|
|
|
424
|
+
/**
|
|
425
|
+
* Commit the patch, returning an observable that produces a mutation result object
|
|
426
|
+
*
|
|
427
|
+
* @param options Options for the mutation operation
|
|
428
|
+
*/
|
|
429
|
+
commit(options: AllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
|
|
430
|
+
|
|
431
|
+
/**
|
|
432
|
+
* Commit the patch, returning an observable that produces the first patched document
|
|
433
|
+
*
|
|
434
|
+
* @param options Options for the mutation operation
|
|
435
|
+
*/
|
|
436
|
+
commit<R extends Record<string, any> = Record<string, any>>(
|
|
437
|
+
options?: BaseMutationOptions
|
|
438
|
+
): Observable<SanityDocument<R>>
|
|
439
|
+
}
|
|
440
|
+
|
|
441
|
+
export abstract class BaseTransaction {
|
|
386
442
|
/**
|
|
387
443
|
* Creates a new Sanity document. If `_id` is provided and already exists, the mutation will fail. If no `_id` is given, one will automatically be generated by the database.
|
|
388
444
|
* The operation is added to the current transaction, ready to be commited by `commit()`
|
|
389
445
|
*
|
|
390
446
|
* @param doc Document to create. Requires a `_type` property.
|
|
391
447
|
*/
|
|
392
|
-
create<R = any
|
|
448
|
+
create<R extends Record<string, any> = Record<string, any>>(doc: SanityDocumentStub<R>): this
|
|
393
449
|
|
|
394
450
|
/**
|
|
395
451
|
* Creates a new Sanity document. If a document with the same `_id` already exists, the create operation will be ignored.
|
|
@@ -397,7 +453,9 @@ export class Transaction {
|
|
|
397
453
|
*
|
|
398
454
|
* @param doc Document to create if it does not already exist. Requires `_id` and `_type` properties.
|
|
399
455
|
*/
|
|
400
|
-
createIfNotExists<R
|
|
456
|
+
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
|
|
457
|
+
doc: IdentifiedSanityDocumentStub<R>
|
|
458
|
+
): this
|
|
401
459
|
|
|
402
460
|
/**
|
|
403
461
|
* Creates a new Sanity document, or replaces an existing one if the same `_id` is already used.
|
|
@@ -405,7 +463,9 @@ export class Transaction {
|
|
|
405
463
|
*
|
|
406
464
|
* @param doc Document to create or replace. Requires `_id` and `_type` properties.
|
|
407
465
|
*/
|
|
408
|
-
createOrReplace<R
|
|
466
|
+
createOrReplace<R extends Record<string, any> = Record<string, any>>(
|
|
467
|
+
doc: IdentifiedSanityDocumentStub<R>
|
|
468
|
+
): this
|
|
409
469
|
|
|
410
470
|
/**
|
|
411
471
|
* Deletes the document with the given document ID
|
|
@@ -451,19 +511,37 @@ export class Transaction {
|
|
|
451
511
|
*/
|
|
452
512
|
toJSON(): Mutation[]
|
|
453
513
|
|
|
514
|
+
/**
|
|
515
|
+
* Clears the transaction of all operations
|
|
516
|
+
*/
|
|
517
|
+
reset(): this
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
export class Transaction extends BaseTransaction {
|
|
521
|
+
constructor(operations?: Mutation[], client?: SanityClient, transactionId?: string)
|
|
522
|
+
|
|
523
|
+
/**
|
|
524
|
+
* Clones the transaction
|
|
525
|
+
*/
|
|
526
|
+
clone(): Transaction
|
|
527
|
+
|
|
454
528
|
/**
|
|
455
529
|
* Commit the transaction, returning a promise that resolves to the first mutated document
|
|
456
530
|
*
|
|
457
531
|
* @param options Options for the mutation operation
|
|
458
532
|
*/
|
|
459
|
-
commit<R
|
|
533
|
+
commit<R extends Record<string, any>>(
|
|
534
|
+
options: TransactionFirstDocumentMutationOptions
|
|
535
|
+
): Promise<SanityDocument<R>>
|
|
460
536
|
|
|
461
537
|
/**
|
|
462
538
|
* Commit the transaction, returning a promise that resolves to an array of the mutated documents
|
|
463
539
|
*
|
|
464
540
|
* @param options Options for the mutation operation
|
|
465
541
|
*/
|
|
466
|
-
commit<R
|
|
542
|
+
commit<R extends Record<string, any>>(
|
|
543
|
+
options: TransactionAllDocumentsMutationOptions
|
|
544
|
+
): Promise<SanityDocument<R>[]>
|
|
467
545
|
|
|
468
546
|
/**
|
|
469
547
|
* Commit the transaction, returning a promise that resolves to a mutation result object
|
|
@@ -485,11 +563,54 @@ export class Transaction {
|
|
|
485
563
|
* @param options Options for the mutation operation
|
|
486
564
|
*/
|
|
487
565
|
commit(options?: BaseMutationOptions): Promise<MultipleMutationResult>
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
export class ObservableTransaction extends BaseTransaction {
|
|
569
|
+
constructor(operations?: Mutation[], client?: ObservableSanityClient, transactionId?: string)
|
|
488
570
|
|
|
489
571
|
/**
|
|
490
|
-
*
|
|
572
|
+
* Clones the transaction
|
|
491
573
|
*/
|
|
492
|
-
|
|
574
|
+
clone(): ObservableTransaction
|
|
575
|
+
|
|
576
|
+
/**
|
|
577
|
+
* Commit the transaction, returning an observable that produces the first mutated document
|
|
578
|
+
*
|
|
579
|
+
* @param options Options for the mutation operation
|
|
580
|
+
*/
|
|
581
|
+
commit<R extends Record<string, any>>(
|
|
582
|
+
options: TransactionFirstDocumentMutationOptions
|
|
583
|
+
): Observable<SanityDocument<R>>
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* Commit the transaction, returning an observable that produces an array of the mutated documents
|
|
587
|
+
*
|
|
588
|
+
* @param options Options for the mutation operation
|
|
589
|
+
*/
|
|
590
|
+
commit<R extends Record<string, any>>(
|
|
591
|
+
options: TransactionAllDocumentsMutationOptions
|
|
592
|
+
): Observable<SanityDocument<R>[]>
|
|
593
|
+
|
|
594
|
+
/**
|
|
595
|
+
* Commit the transaction, returning an observable that produces a mutation result object
|
|
596
|
+
*
|
|
597
|
+
* @param options Options for the mutation operation
|
|
598
|
+
*/
|
|
599
|
+
commit(options: TransactionFirstDocumentIdMutationOptions): Observable<SingleMutationResult>
|
|
600
|
+
|
|
601
|
+
/**
|
|
602
|
+
* Commit the transaction, returning an observable that produces a mutation result object
|
|
603
|
+
*
|
|
604
|
+
* @param options Options for the mutation operation
|
|
605
|
+
*/
|
|
606
|
+
commit(options: TransactionAllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
|
|
607
|
+
|
|
608
|
+
/**
|
|
609
|
+
* Commit the transaction, returning an observable that produces a mutation result object
|
|
610
|
+
*
|
|
611
|
+
* @param options Options for the mutation operation
|
|
612
|
+
*/
|
|
613
|
+
commit(options?: BaseMutationOptions): Observable<MultipleMutationResult>
|
|
493
614
|
}
|
|
494
615
|
|
|
495
616
|
export interface ClientConfig {
|
|
@@ -503,6 +624,7 @@ export interface ClientConfig {
|
|
|
503
624
|
requestTagPrefix?: string
|
|
504
625
|
ignoreBrowserTokenWarning?: boolean
|
|
505
626
|
withCredentials?: boolean
|
|
627
|
+
allowReconfigure?: boolean
|
|
506
628
|
timeout?: number
|
|
507
629
|
|
|
508
630
|
/**
|
|
@@ -545,7 +667,7 @@ type BaseMutationOptions = RequestOptions & {
|
|
|
545
667
|
skipCrossDatasetReferenceValidation?: boolean
|
|
546
668
|
}
|
|
547
669
|
|
|
548
|
-
export type MutationEvent<R
|
|
670
|
+
export type MutationEvent<R extends Record<string, any> = Record<string, any>> = {
|
|
549
671
|
type: 'mutation'
|
|
550
672
|
documentId: string
|
|
551
673
|
eventId: string
|
|
@@ -580,7 +702,7 @@ export type WelcomeEvent = {
|
|
|
580
702
|
type: 'welcome'
|
|
581
703
|
}
|
|
582
704
|
|
|
583
|
-
export type ListenEvent<R
|
|
705
|
+
export type ListenEvent<R extends Record<string, any>> =
|
|
584
706
|
| MutationEvent<R>
|
|
585
707
|
| ChannelErrorEvent
|
|
586
708
|
| DisconnectEvent
|
|
@@ -1014,7 +1136,7 @@ export class ObservableSanityClient {
|
|
|
1014
1136
|
* @param id Document ID to fetch
|
|
1015
1137
|
* @param options Request options
|
|
1016
1138
|
*/
|
|
1017
|
-
getDocument<R = any
|
|
1139
|
+
getDocument<R extends Record<string, any> = Record<string, any>>(
|
|
1018
1140
|
id: string,
|
|
1019
1141
|
options?: {tag?: string}
|
|
1020
1142
|
): Observable<SanityDocument<R> | undefined>
|
|
@@ -1028,7 +1150,7 @@ export class ObservableSanityClient {
|
|
|
1028
1150
|
* @param ids Document IDs to fetch
|
|
1029
1151
|
* @param options Request options
|
|
1030
1152
|
*/
|
|
1031
|
-
getDocuments<R = any
|
|
1153
|
+
getDocuments<R extends Record<string, any> = Record<string, any>>(
|
|
1032
1154
|
ids: string[],
|
|
1033
1155
|
options?: {tag?: string}
|
|
1034
1156
|
): Observable<(SanityDocument<R> | null)[]>
|
|
@@ -1040,7 +1162,7 @@ export class ObservableSanityClient {
|
|
|
1040
1162
|
* @param document Document to create
|
|
1041
1163
|
* @param options Mutation options
|
|
1042
1164
|
*/
|
|
1043
|
-
create<R = any
|
|
1165
|
+
create<R extends Record<string, any> = Record<string, any>>(
|
|
1044
1166
|
document: SanityDocumentStub<R>,
|
|
1045
1167
|
options: FirstDocumentMutationOptions
|
|
1046
1168
|
): Observable<SanityDocument<R>>
|
|
@@ -1052,7 +1174,7 @@ export class ObservableSanityClient {
|
|
|
1052
1174
|
* @param document Document to create
|
|
1053
1175
|
* @param options Mutation options
|
|
1054
1176
|
*/
|
|
1055
|
-
create<R = any
|
|
1177
|
+
create<R extends Record<string, any> = Record<string, any>>(
|
|
1056
1178
|
document: SanityDocumentStub<R>,
|
|
1057
1179
|
options: AllDocumentsMutationOptions
|
|
1058
1180
|
): Observable<SanityDocument<R>[]>
|
|
@@ -1064,7 +1186,7 @@ export class ObservableSanityClient {
|
|
|
1064
1186
|
* @param document Document to create
|
|
1065
1187
|
* @param options Mutation options
|
|
1066
1188
|
*/
|
|
1067
|
-
create<R = any
|
|
1189
|
+
create<R extends Record<string, any> = Record<string, any>>(
|
|
1068
1190
|
document: SanityDocumentStub<R>,
|
|
1069
1191
|
options: FirstDocumentIdMutationOptions
|
|
1070
1192
|
): Observable<SingleMutationResult>
|
|
@@ -1076,7 +1198,7 @@ export class ObservableSanityClient {
|
|
|
1076
1198
|
* @param document Document to create
|
|
1077
1199
|
* @param options Mutation options
|
|
1078
1200
|
*/
|
|
1079
|
-
create<R = any
|
|
1201
|
+
create<R extends Record<string, any> = Record<string, any>>(
|
|
1080
1202
|
document: SanityDocumentStub<R>,
|
|
1081
1203
|
options: AllDocumentIdsMutationOptions
|
|
1082
1204
|
): Observable<MultipleMutationResult>
|
|
@@ -1088,7 +1210,7 @@ export class ObservableSanityClient {
|
|
|
1088
1210
|
* @param document Document to create
|
|
1089
1211
|
* @param options Mutation options
|
|
1090
1212
|
*/
|
|
1091
|
-
create<R = any
|
|
1213
|
+
create<R extends Record<string, any> = Record<string, any>>(
|
|
1092
1214
|
document: SanityDocumentStub<R>,
|
|
1093
1215
|
options?: BaseMutationOptions
|
|
1094
1216
|
): Observable<SanityDocument<R>>
|
|
@@ -1100,7 +1222,7 @@ export class ObservableSanityClient {
|
|
|
1100
1222
|
* @param document Document to create
|
|
1101
1223
|
* @param options Mutation options
|
|
1102
1224
|
*/
|
|
1103
|
-
createIfNotExists<R = any
|
|
1225
|
+
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
|
|
1104
1226
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1105
1227
|
options: FirstDocumentMutationOptions
|
|
1106
1228
|
): Observable<SanityDocument<R>>
|
|
@@ -1112,7 +1234,7 @@ export class ObservableSanityClient {
|
|
|
1112
1234
|
* @param document Document to create
|
|
1113
1235
|
* @param options Mutation options
|
|
1114
1236
|
*/
|
|
1115
|
-
createIfNotExists<R = any
|
|
1237
|
+
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
|
|
1116
1238
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1117
1239
|
options: AllDocumentsMutationOptions
|
|
1118
1240
|
): Observable<SanityDocument<R>[]>
|
|
@@ -1124,7 +1246,7 @@ export class ObservableSanityClient {
|
|
|
1124
1246
|
* @param document Document to create
|
|
1125
1247
|
* @param options Mutation options
|
|
1126
1248
|
*/
|
|
1127
|
-
createIfNotExists<R = any
|
|
1249
|
+
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
|
|
1128
1250
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1129
1251
|
options: FirstDocumentIdMutationOptions
|
|
1130
1252
|
): Observable<SingleMutationResult>
|
|
@@ -1136,7 +1258,7 @@ export class ObservableSanityClient {
|
|
|
1136
1258
|
* @param document Document to create
|
|
1137
1259
|
* @param options Mutation options
|
|
1138
1260
|
*/
|
|
1139
|
-
createIfNotExists<R = any
|
|
1261
|
+
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
|
|
1140
1262
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1141
1263
|
options: AllDocumentIdsMutationOptions
|
|
1142
1264
|
): Observable<MultipleMutationResult>
|
|
@@ -1148,7 +1270,7 @@ export class ObservableSanityClient {
|
|
|
1148
1270
|
* @param document Document to create
|
|
1149
1271
|
* @param options Mutation options
|
|
1150
1272
|
*/
|
|
1151
|
-
createIfNotExists<R = any
|
|
1273
|
+
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
|
|
1152
1274
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1153
1275
|
options?: BaseMutationOptions
|
|
1154
1276
|
): Observable<SanityDocument<R>>
|
|
@@ -1160,7 +1282,7 @@ export class ObservableSanityClient {
|
|
|
1160
1282
|
* @param document Document to either create or replace
|
|
1161
1283
|
* @param options Mutation options
|
|
1162
1284
|
*/
|
|
1163
|
-
createOrReplace<R = any
|
|
1285
|
+
createOrReplace<R extends Record<string, any> = Record<string, any>>(
|
|
1164
1286
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1165
1287
|
options: FirstDocumentMutationOptions
|
|
1166
1288
|
): Observable<SanityDocument<R>>
|
|
@@ -1172,7 +1294,7 @@ export class ObservableSanityClient {
|
|
|
1172
1294
|
* @param document Document to either create or replace
|
|
1173
1295
|
* @param options Mutation options
|
|
1174
1296
|
*/
|
|
1175
|
-
createOrReplace<R = any
|
|
1297
|
+
createOrReplace<R extends Record<string, any> = Record<string, any>>(
|
|
1176
1298
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1177
1299
|
options: AllDocumentsMutationOptions
|
|
1178
1300
|
): Observable<SanityDocument<R>[]>
|
|
@@ -1184,7 +1306,7 @@ export class ObservableSanityClient {
|
|
|
1184
1306
|
* @param document Document to either create or replace
|
|
1185
1307
|
* @param options Mutation options
|
|
1186
1308
|
*/
|
|
1187
|
-
createOrReplace<R = any
|
|
1309
|
+
createOrReplace<R extends Record<string, any> = Record<string, any>>(
|
|
1188
1310
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1189
1311
|
options: FirstDocumentIdMutationOptions
|
|
1190
1312
|
): Observable<SingleMutationResult>
|
|
@@ -1196,7 +1318,7 @@ export class ObservableSanityClient {
|
|
|
1196
1318
|
* @param document Document to either create or replace
|
|
1197
1319
|
* @param options Mutation options
|
|
1198
1320
|
*/
|
|
1199
|
-
createOrReplace<R = any
|
|
1321
|
+
createOrReplace<R extends Record<string, any> = Record<string, any>>(
|
|
1200
1322
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1201
1323
|
options: AllDocumentIdsMutationOptions
|
|
1202
1324
|
): Observable<MultipleMutationResult>
|
|
@@ -1208,7 +1330,7 @@ export class ObservableSanityClient {
|
|
|
1208
1330
|
* @param document Document to either create or replace
|
|
1209
1331
|
* @param options Mutation options
|
|
1210
1332
|
*/
|
|
1211
|
-
createOrReplace<R = any
|
|
1333
|
+
createOrReplace<R extends Record<string, any> = Record<string, any>>(
|
|
1212
1334
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1213
1335
|
options?: BaseMutationOptions
|
|
1214
1336
|
): Observable<SanityDocument<R>>
|
|
@@ -1220,7 +1342,10 @@ export class ObservableSanityClient {
|
|
|
1220
1342
|
* @param id Document ID to delete
|
|
1221
1343
|
* @param options Options for the mutation
|
|
1222
1344
|
*/
|
|
1223
|
-
delete<R
|
|
1345
|
+
delete<R extends Record<string, any> = Record<string, any>>(
|
|
1346
|
+
id: string,
|
|
1347
|
+
options: FirstDocumentMutationOptions
|
|
1348
|
+
): Observable<SanityDocument<R>>
|
|
1224
1349
|
|
|
1225
1350
|
/**
|
|
1226
1351
|
* Deletes a document with the given document ID.
|
|
@@ -1229,7 +1354,10 @@ export class ObservableSanityClient {
|
|
|
1229
1354
|
* @param id Document ID to delete
|
|
1230
1355
|
* @param options Options for the mutation
|
|
1231
1356
|
*/
|
|
1232
|
-
delete<R
|
|
1357
|
+
delete<R extends Record<string, any> = Record<string, any>>(
|
|
1358
|
+
id: string,
|
|
1359
|
+
options: AllDocumentsMutationOptions
|
|
1360
|
+
): Observable<SanityDocument<R>[]>
|
|
1233
1361
|
|
|
1234
1362
|
/**
|
|
1235
1363
|
* Deletes a document with the given document ID.
|
|
@@ -1256,7 +1384,10 @@ export class ObservableSanityClient {
|
|
|
1256
1384
|
* @param id Document ID to delete
|
|
1257
1385
|
* @param options Options for the mutation
|
|
1258
1386
|
*/
|
|
1259
|
-
delete<R
|
|
1387
|
+
delete<R extends Record<string, any> = Record<string, any>>(
|
|
1388
|
+
id: string,
|
|
1389
|
+
options?: BaseMutationOptions
|
|
1390
|
+
): Observable<SanityDocument<R>>
|
|
1260
1391
|
|
|
1261
1392
|
/**
|
|
1262
1393
|
* Deletes one or more documents matching the given query or document ID.
|
|
@@ -1265,7 +1396,7 @@ export class ObservableSanityClient {
|
|
|
1265
1396
|
* @param selection An object with either an `id` or `query` key defining what to delete
|
|
1266
1397
|
* @param options Options for the mutation
|
|
1267
1398
|
*/
|
|
1268
|
-
delete<R = any
|
|
1399
|
+
delete<R extends Record<string, any> = Record<string, any>>(
|
|
1269
1400
|
selection: MutationSelection,
|
|
1270
1401
|
options: FirstDocumentMutationOptions
|
|
1271
1402
|
): Observable<SanityDocument<R>>
|
|
@@ -1277,7 +1408,7 @@ export class ObservableSanityClient {
|
|
|
1277
1408
|
* @param selection An object with either an `id` or `query` key defining what to delete
|
|
1278
1409
|
* @param options Options for the mutation
|
|
1279
1410
|
*/
|
|
1280
|
-
delete<R = any
|
|
1411
|
+
delete<R extends Record<string, any> = Record<string, any>>(
|
|
1281
1412
|
selection: MutationSelection,
|
|
1282
1413
|
options: AllDocumentsMutationOptions
|
|
1283
1414
|
): Observable<SanityDocument<R>[]>
|
|
@@ -1313,7 +1444,7 @@ export class ObservableSanityClient {
|
|
|
1313
1444
|
* @param selection An object with either an `id` or `query` key defining what to delete
|
|
1314
1445
|
* @param options Options for the mutation
|
|
1315
1446
|
*/
|
|
1316
|
-
delete<R = any
|
|
1447
|
+
delete<R extends Record<string, any> = Record<string, any>>(
|
|
1317
1448
|
selection: MutationSelection,
|
|
1318
1449
|
options?: BaseMutationOptions
|
|
1319
1450
|
): Observable<SanityDocument<R>>
|
|
@@ -1325,7 +1456,7 @@ export class ObservableSanityClient {
|
|
|
1325
1456
|
* @param operations Mutation operations to execute
|
|
1326
1457
|
* @param options Mutation options
|
|
1327
1458
|
*/
|
|
1328
|
-
mutate<R = any
|
|
1459
|
+
mutate<R extends Record<string, any> = Record<string, any>>(
|
|
1329
1460
|
operations: Mutation<R>[] | Patch | Transaction,
|
|
1330
1461
|
options: FirstDocumentMutationOptions
|
|
1331
1462
|
): Observable<SanityDocument<R>>
|
|
@@ -1337,7 +1468,7 @@ export class ObservableSanityClient {
|
|
|
1337
1468
|
* @param operations Mutation operations to execute
|
|
1338
1469
|
* @param options Mutation options
|
|
1339
1470
|
*/
|
|
1340
|
-
mutate<R = any
|
|
1471
|
+
mutate<R extends Record<string, any> = Record<string, any>>(
|
|
1341
1472
|
operations: Mutation<R>[] | Patch | Transaction,
|
|
1342
1473
|
options: AllDocumentsMutationOptions
|
|
1343
1474
|
): Observable<SanityDocument<R>[]>
|
|
@@ -1349,7 +1480,7 @@ export class ObservableSanityClient {
|
|
|
1349
1480
|
* @param operations Mutation operations to execute
|
|
1350
1481
|
* @param options Mutation options
|
|
1351
1482
|
*/
|
|
1352
|
-
mutate<R = any
|
|
1483
|
+
mutate<R extends Record<string, any> = Record<string, any>>(
|
|
1353
1484
|
operations: Mutation<R>[] | Patch | Transaction,
|
|
1354
1485
|
options: FirstDocumentIdMutationOptions
|
|
1355
1486
|
): Observable<SingleMutationResult>
|
|
@@ -1361,7 +1492,7 @@ export class ObservableSanityClient {
|
|
|
1361
1492
|
* @param operations Mutation operations to execute
|
|
1362
1493
|
* @param options Mutation options
|
|
1363
1494
|
*/
|
|
1364
|
-
mutate<R = any
|
|
1495
|
+
mutate<R extends Record<string, any> = Record<string, any>>(
|
|
1365
1496
|
operations: Mutation<R>[] | Patch | Transaction,
|
|
1366
1497
|
options: AllDocumentIdsMutationOptions
|
|
1367
1498
|
): Observable<MultipleMutationResult>
|
|
@@ -1373,7 +1504,7 @@ export class ObservableSanityClient {
|
|
|
1373
1504
|
* @param operations Mutation operations to execute
|
|
1374
1505
|
* @param options Mutation options
|
|
1375
1506
|
*/
|
|
1376
|
-
mutate<R = any
|
|
1507
|
+
mutate<R extends Record<string, any> = Record<string, any>>(
|
|
1377
1508
|
operations: Mutation<R>[] | Patch | Transaction,
|
|
1378
1509
|
options?: BaseMutationOptions
|
|
1379
1510
|
): Observable<SanityDocument<R>>
|
|
@@ -1384,14 +1515,16 @@ export class ObservableSanityClient {
|
|
|
1384
1515
|
* @param documentId Document ID to patch
|
|
1385
1516
|
* @param operations Optional object of patch operations to initialize the patch instance with
|
|
1386
1517
|
*/
|
|
1387
|
-
patch(documentId: string | MutationSelection, operations?: PatchOperations):
|
|
1518
|
+
patch(documentId: string | MutationSelection, operations?: PatchOperations): ObservablePatch
|
|
1388
1519
|
|
|
1389
1520
|
/**
|
|
1390
1521
|
* Create a new transaction of mutations
|
|
1391
1522
|
*
|
|
1392
1523
|
* @param operations Optional array of mutation operations to initialize the transaction instance with
|
|
1393
1524
|
*/
|
|
1394
|
-
transaction<R
|
|
1525
|
+
transaction<R extends Record<string, any> = Record<string, any>>(
|
|
1526
|
+
operations?: Mutation<R>[]
|
|
1527
|
+
): ObservableTransaction
|
|
1395
1528
|
|
|
1396
1529
|
// "Internals", should generally not be used externally
|
|
1397
1530
|
/**
|
|
@@ -1608,7 +1741,10 @@ export interface SanityClient {
|
|
|
1608
1741
|
* @param params Optional query parameters
|
|
1609
1742
|
* @param options Listener options
|
|
1610
1743
|
*/
|
|
1611
|
-
listen<R
|
|
1744
|
+
listen<R extends Record<string, any> = Record<string, any>>(
|
|
1745
|
+
query: string,
|
|
1746
|
+
params?: QueryParams
|
|
1747
|
+
): Observable<MutationEvent<R>>
|
|
1612
1748
|
|
|
1613
1749
|
/**
|
|
1614
1750
|
* Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.
|
|
@@ -1617,7 +1753,7 @@ export interface SanityClient {
|
|
|
1617
1753
|
* @param params Optional query parameters
|
|
1618
1754
|
* @param options Listener options
|
|
1619
1755
|
*/
|
|
1620
|
-
listen<R = any
|
|
1756
|
+
listen<R extends Record<string, any> = Record<string, any>>(
|
|
1621
1757
|
query: string,
|
|
1622
1758
|
params?: QueryParams,
|
|
1623
1759
|
options?: ListenOptions
|
|
@@ -1670,7 +1806,10 @@ export interface SanityClient {
|
|
|
1670
1806
|
* @param id Document ID to fetch
|
|
1671
1807
|
* @param options Request options
|
|
1672
1808
|
*/
|
|
1673
|
-
getDocument<R
|
|
1809
|
+
getDocument<R extends Record<string, any> = Record<string, any>>(
|
|
1810
|
+
id: string,
|
|
1811
|
+
options?: {tag?: string}
|
|
1812
|
+
): Promise<SanityDocument<R> | undefined>
|
|
1674
1813
|
|
|
1675
1814
|
/**
|
|
1676
1815
|
* Fetch multiple documents in one request.
|
|
@@ -1681,7 +1820,7 @@ export interface SanityClient {
|
|
|
1681
1820
|
* @param ids Document IDs to fetch
|
|
1682
1821
|
* @param options Request options
|
|
1683
1822
|
*/
|
|
1684
|
-
getDocuments<R = any
|
|
1823
|
+
getDocuments<R extends Record<string, any> = Record<string, any>>(
|
|
1685
1824
|
ids: string[],
|
|
1686
1825
|
options?: {tag?: string}
|
|
1687
1826
|
): Promise<(SanityDocument<R> | null)[]>
|
|
@@ -1693,7 +1832,7 @@ export interface SanityClient {
|
|
|
1693
1832
|
* @param document Document to create
|
|
1694
1833
|
* @param options Mutation options
|
|
1695
1834
|
*/
|
|
1696
|
-
create<R = any
|
|
1835
|
+
create<R extends Record<string, any> = Record<string, any>>(
|
|
1697
1836
|
document: SanityDocumentStub<R>,
|
|
1698
1837
|
options: FirstDocumentMutationOptions
|
|
1699
1838
|
): Promise<SanityDocument<R>>
|
|
@@ -1705,7 +1844,7 @@ export interface SanityClient {
|
|
|
1705
1844
|
* @param document Document to create
|
|
1706
1845
|
* @param options Mutation options
|
|
1707
1846
|
*/
|
|
1708
|
-
create<R = any
|
|
1847
|
+
create<R extends Record<string, any> = Record<string, any>>(
|
|
1709
1848
|
document: SanityDocumentStub<R>,
|
|
1710
1849
|
options: AllDocumentsMutationOptions
|
|
1711
1850
|
): Promise<SanityDocument<R>[]>
|
|
@@ -1717,7 +1856,7 @@ export interface SanityClient {
|
|
|
1717
1856
|
* @param document Document to create
|
|
1718
1857
|
* @param options Mutation options
|
|
1719
1858
|
*/
|
|
1720
|
-
create<R = any
|
|
1859
|
+
create<R extends Record<string, any> = Record<string, any>>(
|
|
1721
1860
|
document: SanityDocumentStub<R>,
|
|
1722
1861
|
options: FirstDocumentIdMutationOptions
|
|
1723
1862
|
): Promise<SingleMutationResult>
|
|
@@ -1729,7 +1868,7 @@ export interface SanityClient {
|
|
|
1729
1868
|
* @param document Document to create
|
|
1730
1869
|
* @param options Mutation options
|
|
1731
1870
|
*/
|
|
1732
|
-
create<R = any
|
|
1871
|
+
create<R extends Record<string, any> = Record<string, any>>(
|
|
1733
1872
|
document: SanityDocumentStub<R>,
|
|
1734
1873
|
options: AllDocumentIdsMutationOptions
|
|
1735
1874
|
): Promise<MultipleMutationResult>
|
|
@@ -1741,7 +1880,7 @@ export interface SanityClient {
|
|
|
1741
1880
|
* @param document Document to create
|
|
1742
1881
|
* @param options Mutation options
|
|
1743
1882
|
*/
|
|
1744
|
-
create<R = any
|
|
1883
|
+
create<R extends Record<string, any> = Record<string, any>>(
|
|
1745
1884
|
document: SanityDocumentStub<R>,
|
|
1746
1885
|
options?: BaseMutationOptions
|
|
1747
1886
|
): Promise<SanityDocument<R>>
|
|
@@ -1753,7 +1892,7 @@ export interface SanityClient {
|
|
|
1753
1892
|
* @param document Document to create
|
|
1754
1893
|
* @param options Mutation options
|
|
1755
1894
|
*/
|
|
1756
|
-
createIfNotExists<R = any
|
|
1895
|
+
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
|
|
1757
1896
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1758
1897
|
options: FirstDocumentMutationOptions
|
|
1759
1898
|
): Promise<SanityDocument<R>>
|
|
@@ -1765,7 +1904,7 @@ export interface SanityClient {
|
|
|
1765
1904
|
* @param document Document to create
|
|
1766
1905
|
* @param options Mutation options
|
|
1767
1906
|
*/
|
|
1768
|
-
createIfNotExists<R = any
|
|
1907
|
+
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
|
|
1769
1908
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1770
1909
|
options: AllDocumentsMutationOptions
|
|
1771
1910
|
): Promise<SanityDocument<R>[]>
|
|
@@ -1777,7 +1916,7 @@ export interface SanityClient {
|
|
|
1777
1916
|
* @param document Document to create
|
|
1778
1917
|
* @param options Mutation options
|
|
1779
1918
|
*/
|
|
1780
|
-
createIfNotExists<R = any
|
|
1919
|
+
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
|
|
1781
1920
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1782
1921
|
options: FirstDocumentIdMutationOptions
|
|
1783
1922
|
): Promise<SingleMutationResult>
|
|
@@ -1789,7 +1928,7 @@ export interface SanityClient {
|
|
|
1789
1928
|
* @param document Document to create
|
|
1790
1929
|
* @param options Mutation options
|
|
1791
1930
|
*/
|
|
1792
|
-
createIfNotExists<R = any
|
|
1931
|
+
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
|
|
1793
1932
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1794
1933
|
options: AllDocumentIdsMutationOptions
|
|
1795
1934
|
): Promise<MultipleMutationResult>
|
|
@@ -1801,7 +1940,7 @@ export interface SanityClient {
|
|
|
1801
1940
|
* @param document Document to create
|
|
1802
1941
|
* @param options Mutation options
|
|
1803
1942
|
*/
|
|
1804
|
-
createIfNotExists<R = any
|
|
1943
|
+
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
|
|
1805
1944
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1806
1945
|
options?: BaseMutationOptions
|
|
1807
1946
|
): Promise<SanityDocument<R>>
|
|
@@ -1813,7 +1952,7 @@ export interface SanityClient {
|
|
|
1813
1952
|
* @param document Document to either create or replace
|
|
1814
1953
|
* @param options Mutation options
|
|
1815
1954
|
*/
|
|
1816
|
-
createOrReplace<R = any
|
|
1955
|
+
createOrReplace<R extends Record<string, any> = Record<string, any>>(
|
|
1817
1956
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1818
1957
|
options: FirstDocumentMutationOptions
|
|
1819
1958
|
): Promise<SanityDocument<R>>
|
|
@@ -1825,7 +1964,7 @@ export interface SanityClient {
|
|
|
1825
1964
|
* @param document Document to either create or replace
|
|
1826
1965
|
* @param options Mutation options
|
|
1827
1966
|
*/
|
|
1828
|
-
createOrReplace<R = any
|
|
1967
|
+
createOrReplace<R extends Record<string, any> = Record<string, any>>(
|
|
1829
1968
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1830
1969
|
options: AllDocumentsMutationOptions
|
|
1831
1970
|
): Promise<SanityDocument<R>[]>
|
|
@@ -1837,7 +1976,7 @@ export interface SanityClient {
|
|
|
1837
1976
|
* @param document Document to either create or replace
|
|
1838
1977
|
* @param options Mutation options
|
|
1839
1978
|
*/
|
|
1840
|
-
createOrReplace<R = any
|
|
1979
|
+
createOrReplace<R extends Record<string, any> = Record<string, any>>(
|
|
1841
1980
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1842
1981
|
options: FirstDocumentIdMutationOptions
|
|
1843
1982
|
): Promise<SingleMutationResult>
|
|
@@ -1849,7 +1988,7 @@ export interface SanityClient {
|
|
|
1849
1988
|
* @param document Document to either create or replace
|
|
1850
1989
|
* @param options Mutation options
|
|
1851
1990
|
*/
|
|
1852
|
-
createOrReplace<R = any
|
|
1991
|
+
createOrReplace<R extends Record<string, any> = Record<string, any>>(
|
|
1853
1992
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1854
1993
|
options: AllDocumentIdsMutationOptions
|
|
1855
1994
|
): Promise<MultipleMutationResult>
|
|
@@ -1861,7 +2000,7 @@ export interface SanityClient {
|
|
|
1861
2000
|
* @param document Document to either create or replace
|
|
1862
2001
|
* @param options Mutation options
|
|
1863
2002
|
*/
|
|
1864
|
-
createOrReplace<R = any
|
|
2003
|
+
createOrReplace<R extends Record<string, any> = Record<string, any>>(
|
|
1865
2004
|
document: IdentifiedSanityDocumentStub<R>,
|
|
1866
2005
|
options?: BaseMutationOptions
|
|
1867
2006
|
): Promise<SanityDocument<R>>
|
|
@@ -1873,7 +2012,10 @@ export interface SanityClient {
|
|
|
1873
2012
|
* @param id Document ID to delete
|
|
1874
2013
|
* @param options Options for the mutation
|
|
1875
2014
|
*/
|
|
1876
|
-
delete<R
|
|
2015
|
+
delete<R extends Record<string, any> = Record<string, any>>(
|
|
2016
|
+
id: string,
|
|
2017
|
+
options: FirstDocumentMutationOptions
|
|
2018
|
+
): Promise<SanityDocument<R>>
|
|
1877
2019
|
|
|
1878
2020
|
/**
|
|
1879
2021
|
* Deletes a document with the given document ID.
|
|
@@ -1882,7 +2024,10 @@ export interface SanityClient {
|
|
|
1882
2024
|
* @param id Document ID to delete
|
|
1883
2025
|
* @param options Options for the mutation
|
|
1884
2026
|
*/
|
|
1885
|
-
delete<R
|
|
2027
|
+
delete<R extends Record<string, any> = Record<string, any>>(
|
|
2028
|
+
id: string,
|
|
2029
|
+
options: AllDocumentsMutationOptions
|
|
2030
|
+
): Promise<SanityDocument<R>[]>
|
|
1886
2031
|
|
|
1887
2032
|
/**
|
|
1888
2033
|
* Deletes a document with the given document ID.
|
|
@@ -1909,7 +2054,10 @@ export interface SanityClient {
|
|
|
1909
2054
|
* @param id Document ID to delete
|
|
1910
2055
|
* @param options Options for the mutation
|
|
1911
2056
|
*/
|
|
1912
|
-
delete<R
|
|
2057
|
+
delete<R extends Record<string, any> = Record<string, any>>(
|
|
2058
|
+
id: string,
|
|
2059
|
+
options?: BaseMutationOptions
|
|
2060
|
+
): Promise<SanityDocument<R>>
|
|
1913
2061
|
|
|
1914
2062
|
/**
|
|
1915
2063
|
* Deletes one or more documents matching the given query or document ID.
|
|
@@ -1918,7 +2066,7 @@ export interface SanityClient {
|
|
|
1918
2066
|
* @param selection An object with either an `id` or `query` key defining what to delete
|
|
1919
2067
|
* @param options Options for the mutation
|
|
1920
2068
|
*/
|
|
1921
|
-
delete<R = any
|
|
2069
|
+
delete<R extends Record<string, any> = Record<string, any>>(
|
|
1922
2070
|
selection: MutationSelection,
|
|
1923
2071
|
options: FirstDocumentMutationOptions
|
|
1924
2072
|
): Promise<SanityDocument<R>>
|
|
@@ -1930,7 +2078,7 @@ export interface SanityClient {
|
|
|
1930
2078
|
* @param selection An object with either an `id` or `query` key defining what to delete
|
|
1931
2079
|
* @param options Options for the mutation
|
|
1932
2080
|
*/
|
|
1933
|
-
delete<R = any
|
|
2081
|
+
delete<R extends Record<string, any> = Record<string, any>>(
|
|
1934
2082
|
selection: MutationSelection,
|
|
1935
2083
|
options: AllDocumentsMutationOptions
|
|
1936
2084
|
): Promise<SanityDocument<R>[]>
|
|
@@ -1966,7 +2114,7 @@ export interface SanityClient {
|
|
|
1966
2114
|
* @param selection An object with either an `id` or `query` key defining what to delete
|
|
1967
2115
|
* @param options Options for the mutation
|
|
1968
2116
|
*/
|
|
1969
|
-
delete<R = any
|
|
2117
|
+
delete<R extends Record<string, any> = Record<string, any>>(
|
|
1970
2118
|
selection: MutationSelection,
|
|
1971
2119
|
options?: BaseMutationOptions
|
|
1972
2120
|
): Promise<SanityDocument<R>>
|
|
@@ -1978,7 +2126,7 @@ export interface SanityClient {
|
|
|
1978
2126
|
* @param operations Mutation operations to execute
|
|
1979
2127
|
* @param options Mutation options
|
|
1980
2128
|
*/
|
|
1981
|
-
mutate<R = any
|
|
2129
|
+
mutate<R extends Record<string, any> = Record<string, any>>(
|
|
1982
2130
|
operations: Mutation<R>[] | Patch | Transaction,
|
|
1983
2131
|
options: FirstDocumentMutationOptions
|
|
1984
2132
|
): Promise<SanityDocument<R>>
|
|
@@ -1990,7 +2138,7 @@ export interface SanityClient {
|
|
|
1990
2138
|
* @param operations Mutation operations to execute
|
|
1991
2139
|
* @param options Mutation options
|
|
1992
2140
|
*/
|
|
1993
|
-
mutate<R = any
|
|
2141
|
+
mutate<R extends Record<string, any> = Record<string, any>>(
|
|
1994
2142
|
operations: Mutation<R>[] | Patch | Transaction,
|
|
1995
2143
|
options: AllDocumentsMutationOptions
|
|
1996
2144
|
): Promise<SanityDocument<R>[]>
|
|
@@ -2002,7 +2150,7 @@ export interface SanityClient {
|
|
|
2002
2150
|
* @param operations Mutation operations to execute
|
|
2003
2151
|
* @param options Mutation options
|
|
2004
2152
|
*/
|
|
2005
|
-
mutate<R = any
|
|
2153
|
+
mutate<R extends Record<string, any> = Record<string, any>>(
|
|
2006
2154
|
operations: Mutation<R>[] | Patch | Transaction,
|
|
2007
2155
|
options: FirstDocumentIdMutationOptions
|
|
2008
2156
|
): Promise<SingleMutationResult>
|
|
@@ -2014,7 +2162,7 @@ export interface SanityClient {
|
|
|
2014
2162
|
* @param operations Mutation operations to execute
|
|
2015
2163
|
* @param options Mutation options
|
|
2016
2164
|
*/
|
|
2017
|
-
mutate<R
|
|
2165
|
+
mutate<R extends Record<string, any>>(
|
|
2018
2166
|
operations: Mutation<R>[] | Patch | Transaction,
|
|
2019
2167
|
options: AllDocumentIdsMutationOptions
|
|
2020
2168
|
): Promise<MultipleMutationResult>
|
|
@@ -2026,7 +2174,7 @@ export interface SanityClient {
|
|
|
2026
2174
|
* @param operations Mutation operations to execute
|
|
2027
2175
|
* @param options Mutation options
|
|
2028
2176
|
*/
|
|
2029
|
-
mutate<R = any
|
|
2177
|
+
mutate<R extends Record<string, any> = Record<string, any>>(
|
|
2030
2178
|
operations: Mutation<R>[] | Patch | Transaction,
|
|
2031
2179
|
options?: BaseMutationOptions
|
|
2032
2180
|
): Promise<SanityDocument<R>>
|
|
@@ -2044,7 +2192,9 @@ export interface SanityClient {
|
|
|
2044
2192
|
*
|
|
2045
2193
|
* @param operations Optional array of mutation operations to initialize the transaction instance with
|
|
2046
2194
|
*/
|
|
2047
|
-
transaction<R
|
|
2195
|
+
transaction<R extends Record<string, any> = Record<string, any>>(
|
|
2196
|
+
operations?: Mutation<R>[]
|
|
2197
|
+
): Transaction
|
|
2048
2198
|
|
|
2049
2199
|
// "Internals", should generally not be used externally
|
|
2050
2200
|
/**
|
|
@@ -2091,4 +2241,16 @@ export interface SanityClient {
|
|
|
2091
2241
|
dataRequest(endpoint: string, body: unknown, options?: BaseMutationOptions): Promise<any>
|
|
2092
2242
|
}
|
|
2093
2243
|
|
|
2094
|
-
export
|
|
2244
|
+
export interface ClientConstructor {
|
|
2245
|
+
Patch: typeof Patch
|
|
2246
|
+
Transaction: typeof Transaction
|
|
2247
|
+
ClientError: typeof ClientError
|
|
2248
|
+
ServerError: typeof ServerError
|
|
2249
|
+
requester: GetItRequester
|
|
2250
|
+
|
|
2251
|
+
new (config: ClientConfig): SanityClient
|
|
2252
|
+
(config: ClientConfig): SanityClient
|
|
2253
|
+
}
|
|
2254
|
+
|
|
2255
|
+
declare const SanityClientConstructor: ClientConstructor
|
|
2256
|
+
export default SanityClientConstructor
|